1OCF_HEARTBEAT_EXPORT(7) OCF resource agents OCF_HEARTBEAT_EXPORT(7)
2
6 ocf_heartbeat_exportfs - Manages NFS exports
7
9 exportfs [start | stop | monitor | meta-data | validate-all]
10
12 Exportfs uses the exportfs command to add/remove nfs exports. It does
13 NOT manage the nfs server daemon. It depends on Linux specific NFS
14 implementation details, so is considered not portable to other
15 platforms yet.
16
18 clientspec
19 The client specification allowing remote machines to mount the
20 directory over NFS.
21 (required, string, no default)
23 options
25 The options to pass to exportfs for the exported directory.
26 (optional, string, no default)
28 directory
30 The directory which you wish to export using NFS.
31 (required, string, no default)
33 fsid
35 The fsid option to pass to exportfs. This can be a unique positive
36 integer, a UUID, or the special string "root" which is functionally
37 identical to numeric fsid of 0. 0 (root) identifies the export as
38 the root of an NFSv4 pseudofilesystem -- avoid this setting unless
39 you understand its special status. This value will override any
40 fsid provided via the options parameter.
41 (unique, required, string, no default)
43 unlock_on_stop
45 Relinquish NFS locks associated with this filesystem when the
46 resource stops. Enabling this parameter is highly recommended
47 unless the path exported by this exportfs resource is also exported
48 by a different resource.
49 Note: Unlocking is only possible on Linux systems where
51 /proc/fs/nfsd/unlock_filesystem exists and is writable. If your
52 system does not fulfill this requirement (on account of having an
53 nonrecent kernel, for example), you may set this parameter to 0 to
54 silence the associated warning.
55 (optional, boolean, default 0)
57 wait_for_leasetime_on_stop
59 When stopping (unexporting), wait out the NFSv4 lease time. Only
60 after all leases have expired does the NFS kernel server relinquish
61 all server-side handles on the exported filesystem. If this
62 exportfs resource manages an export that resides on a mount point
63 designed to fail over along with the NFS export itself, then
64 enabling this parameter will ensure such failover is working
65 properly. Note that when this parameter is set, your stop timeout
66 MUST accommodate for the wait period. This parameter is safe to
67 disable if none of your NFS clients are using NFS version 4 or
68 later.
69 (optional, boolean, default 0)
71 rmtab_backup
73 Back up those entries from the NFS rmtab that apply to the exported
74 directory, to the specified backup file. The filename is
75 interpreted as relative to the exported directory. This backup is
76 required if clients are connecting to the export via NFSv3 over
77 TCP. Note that a configured monitor operation is required for this
78 functionality.
79 To disable rmtab backups, set this parameter to the special string
81 "none".
82 (optional, string, default ".rmtab")
84
86 This resource agent supports the following actions (operations):
87 start
89 Starts the resource. Suggested minimum timeout: 40.
90 stop
92 Stops the resource. Suggested minimum timeout: 120.
93 monitor
95 Performs a detailed status check. Suggested minimum timeout: 20.
96 Suggested interval: 10.
97 meta-data
99 Retrieves resource agent metadata (internal use only). Suggested
100 minimum timeout: 5.
101 validate-all
103 Performs a validation of the resource configuration. Suggested
104 minimum timeout: 30.
105
107 The following is an example configuration for a exportfs resource using
108 the crm(8) shell:
109 primitive p_exportfs ocf:heartbeat:exportfs \
111 params \
112 clientspec=string \
113 directory=string \
114 fsid=string \
115 op monitor depth="0" timeout="20" interval="10"
116
118 http://www.linux-ha.org/wiki/exportfs_(resource_agent)
119
121 Linux-HA contributors (see the resource agent source for information
122 about individual authors)
123resource-agents 3.9.2 03/24/2017 OCF_HEARTBEAT_EXPORT(7)