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

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

118       The following is an example configuration for a exportfs resource using
119       the crm(8) shell:
120
121           primitive p_exportfs ocf:heartbeat:exportfs \
122             params \
123               clientspec=string \
124               directory=string \
125               fsid=string \
126             op monitor depth="0" timeout="20s" interval="10s"
127

EXAMPLE PCS

129       The following is an example configuration for a exportfs resource using
130       pcs(8)
131
132           pcs resource create p_exportfs ocf:heartbeat:exportfs \
133             clientspec=string \
134             directory=string \
135             fsid=string \
136             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
137

AUTHOR

142       ClusterLabs contributors (see the resource agent source for information
143       about individual authors)
144
145
146
147resource-agents UNKNOWN           01/25/2023           OCF_HEARTBEAT_EXPORT(7)