OCF_HEARTBEAT_EXPORT(7) OCF resource agents OCF_HEARTBEAT_EXPORT(7)
NAME
ocf_heartbeat_exportfs - Manages NFS exports
SYNOPSIS
exportfs [start | stop | monitor | meta-data | validate-all]
DESCRIPTION
Exportfs uses the exportfs command to add/remove nfs exports. It does NOT manage the nfs server daemon. It depends on Linux specific NFS
implementation details, so is considered not portable to other platforms yet.
SUPPORTED PARAMETERS
clientspec
The client specification allowing remote machines to mount the directory over NFS.
(required, string, no default)
options
The options to pass to exportfs for the exported directory.
(optional, string, no default)
directory
The directory which you wish to export using NFS.
(required, string, no default)
fsid
The fsid option to pass to exportfs. This can be a unique positive integer, a UUID, or the special string "root" which is functionally
identical to numeric fsid of 0. 0 (root) identifies the export as the root of an NFSv4 pseudofilesystem -- avoid this setting unless
you understand its special status. This value will override any fsid provided via the options parameter.
(unique, required, string, no default)
unlock_on_stop
Relinquish NFS locks associated with this filesystem when the resource stops. Enabling this parameter is highly recommended unless the
path exported by this exportfs resource is also exported by a different resource.
(optional, boolean, default 0)
wait_for_leasetime_on_stop
When stopping (unexporting), wait out the NFSv4 lease time. Only after all leases have expired does the NFS kernel server relinquish
all server-side handles on the exported filesystem. If this exportfs resource manages an export that resides on a mount point designed
to fail over along with the NFS export itself, then enabling this parameter will ensure such failover is working properly. Note that
when this parameter is set, your stop timeout MUST accommodate for the wait period. This parameter is safe to disable if none of your
NFS clients are using NFS version 4 or later.
(optional, boolean, default 0)
rmtab_backup
Back up those entries from the NFS rmtab that apply to the exported directory, to the specified backup file. The filename is
interpreted as relative to the exported directory. This backup is required if clients are connecting to the export via NFSv3 over TCP.
Note that a configured monitor operation is required for this functionality.
To disable rmtab backups, set this parameter to the special string "none".
(optional, string, default ".rmtab")
SUPPORTED ACTIONS
This resource agent supports the following actions (operations):
start
Starts the resource. Suggested minimum timeout: 40.
stop
Stops the resource. Suggested minimum timeout: 10.
monitor
Performs a detailed status check. Suggested minimum timeout: 20. Suggested interval: 10.
meta-data
Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5.
validate-all
Performs a validation of the resource configuration. Suggested minimum timeout: 30.
EXAMPLE
The following is an example configuration for a exportfs resource using the crm(8) shell:
primitive p_exportfs ocf:heartbeat:exportfs
params
clientspec=string
directory=string
fsid=string
op monitor depth="0" timeout="20" interval="10"
SEE ALSO
http://www.linux-ha.org/wiki/exportfs_(resource_agent)
AUTHOR
Linux-HA contributors (see the resource agent source for information about individual authors)
resource-agents UNKNOWN 06/09/2014 OCF_HEARTBEAT_EXPORT(7)