ocf_heartbeat_exportfs(7)

1OCF_HEARTBEAT_EXPORT(7)       OCF resource agents      OCF_HEARTBEAT_EXPORT(7)
2
3
4

NAME

6       ocf_heartbeat_exportfs - Manages NFS exports
7

SYNOPSIS

9       exportfs [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

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

SUPPORTED PARAMETERS

18       clientspec
19           The client specification allowing remote machines to mount the
20           directory (or directories) over NFS.
21
22           (required, string, no default)
23
24       options
25           The options to pass to exportfs for the exported directory or
26           directories.
27
28           (optional, string, no default)
29
30       directory
31           The directory or directories to be exported using NFS. Multiple
32           directories are separated by white space.
33
34           (required, string, no default)
35
36       fsid
37           The fsid option to pass to exportfs. This can be a unique positive
38           integer, a UUID (assuredly sans comma characters), or the special
39           string "root" which is functionally identical to numeric fsid of 0.
40           If multiple directories are being exported, then they are assigned
41           ids sequentially starting with this fsid (fsid, fsid+1, fsid+2,
42           ...). Obviously, in that case the fsid must be an integer. 0 (root)
43           identifies the export as the root of an NFSv4 pseudofilesystem --
44           avoid this setting unless you understand its special status. This
45           value will override any fsid provided via the options parameter.
46
47           (unique, required, string, no default)
48
49       unlock_on_stop
50           Relinquish NFS locks associated with this filesystem when the
51           resource stops. Enabling this parameter is highly recommended
52           unless the path exported by this exportfs resource is also exported
53           by a different resource.
54
55           Note: Unlocking is only possible on Linux systems where
56           /proc/fs/nfsd/unlock_filesystem exists and is writable. If your
57           system does not fulfill this requirement (on account of having an
58           nonrecent kernel, for example), you may set this parameter to 0 to
59           silence the associated warning.
60
61           (optional, boolean, default 1)
62
63       wait_for_leasetime_on_stop
64           When stopping (unexporting), wait out the NFSv4 lease time. Only
65           after all leases have expired does the NFS kernel server relinquish
66           all server-side handles on the exported filesystem. If this
67           exportfs resource manages an export that resides on a mount point
68           designed to fail over along with the NFS export itself, then
69           enabling this parameter will ensure such failover is working
70           properly. Note that when this parameter is set, your stop timeout
71           MUST accommodate for the wait period. This parameter is safe to
72           disable if none of your NFS clients are using NFS version 4 or
73           later.
74
75           (optional, boolean, default 0)
76
77       rmtab_backup
78           Back up those entries from the NFS rmtab that apply to the exported
79           directory, to the specified backup file. The filename is
80           interpreted as relative to the exported directory. This backup is
81           required if clients are connecting to the export via NFSv3 over
82           TCP. Note that a configured monitor operation is required for this
83           functionality.
84
85           To disable rmtab backups, set this parameter to the special string
86           "none".
87
88           (optional, string, default ".rmtab")
89

SUPPORTED ACTIONS

91       This resource agent supports the following actions (operations):
92
93       start
94           Starts the resource. Suggested minimum timeout: 40s.
95
96       stop
97           Stops the resource. Suggested minimum timeout: 120s.
98
99       monitor
100           Performs a detailed status check. Suggested minimum timeout: 20s.
101           Suggested interval: 10s.
102
103       meta-data
104           Retrieves resource agent metadata (internal use only). Suggested
105           minimum timeout: 5s.
106
107       validate-all
108           Performs a validation of the resource configuration. Suggested
109           minimum timeout: 30s.
110

EXAMPLE CRM SHELL

112       The following is an example configuration for a exportfs resource using
113       the crm(8) shell:
114
115           primitive p_exportfs ocf:heartbeat:exportfs \
116             params \
117               clientspec=string \
118               directory=string \
119               fsid=string \
120             op monitor depth="0" timeout="20s" interval="10s"
121

EXAMPLE PCS

123       The following is an example configuration for a exportfs resource using
124       pcs(8)
125
126           pcs resource create p_exportfs ocf:heartbeat:exportfs \
127             clientspec=string \
128             directory=string \
129             fsid=string \
130             op monitor depth="0" timeout="20s" interval="10s"
131

AUTHOR

136       ClusterLabs contributors (see the resource agent source for information
137       about individual authors)
138
139
140
141resource-agents UNKNOWN           03/14/2019           OCF_HEARTBEAT_EXPORT(7)