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

NAME

6       ocf_heartbeat_nfsserver - Manages an NFS server
7

SYNOPSIS

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

DESCRIPTION

12       Nfsserver helps one to manage the Linux nfs server as a failover-able
13       resource in Linux-HA. It depends on Linux specific NFS implementation
14       details, so is considered not portable to other platforms yet.
15

SUPPORTED PARAMETERS

17       nfs_init_script
18           The default init script shipped with the Linux distro. The
19           nfsserver resource agent offloads the start/stop/monitor work to
20           the init script because the procedure to start/stop/monitor
21           nfsserver varies on different Linux distro. In the event that this
22           option is not set, this agent will attempt to use an init script at
23           this location, /etc/init.d/nfsserver, or detect a systemd unit-file
24           to use in the event that no init script is detected.
25
26           (optional, string, default "auto detected")
27
28       nfs_no_notify
29           Do not send reboot notifications to NFSv3 clients during server
30           startup.
31
32           (optional, boolean, default false)
33
34       nfs_notify_foreground
35           Keeps the sm-notify attached to its controlling terminal and
36           running in the foreground.
37
38           (optional, boolean, default false)
39
40       nfs_smnotify_retry_time
41           Specifies the length of sm-notify retry time, in minutes, to
42           continue retrying notifications to unresponsive hosts. If this
43           option is not specified, sm-notify attempts to send notifications
44           for 15 minutes. Specifying a value of 0 causes sm-notify to
45           continue sending notifications to unresponsive peers until it is
46           manually killed.
47
48           (optional, integer, no default)
49
50       nfs_server_scope
51           RFC8881, 8.4.2.1 State Reclaim:
52
53           If the server scope is different, the client should not attempt to
54           reclaim locks. In this situation, no lock reclaim is possible. Any
55           attempt to re-obtain the locks with non-reclaim operations is
56           problematic since there is no guarantee that the existing
57           filehandles will be recognized by the new server, or that if
58           recognized, they denote the same objects. It is best to treat the
59           locks as having been revoked by the reconfiguration event.
60
61           For lock reclaim to even be attempted, we have to define and set
62           the same server scope for NFSD on all cluster nodes in the NFS
63           failover cluster.
64
65           This agent won't "guess" a suitable server scope name for you, you
66           need to explicitly specify this. But without it, NFSv4 lock reclaim
67           after failover won't work properly. Suggested value: the failover
68           "service IP".
69
70           (optional, string, no default)
71
72       nfs_ip
73           Comma separated list of floating IP addresses used to access the
74           nfs service
75
76           (optional, string, no default)
77
78       nfs_shared_infodir
79           The nfsserver resource agent will save nfs related information in
80           this specific directory. And this directory must be able to
81           fail-over before nfsserver itself.
82
83           (optional, string, no default)
84
85       rpcpipefs_dir
86           The mount point for the sunrpc file system. Default is
87           /var/lib/nfs/rpc_pipefs. This script will mount (bind)
88           nfs_shared_infodir on /var/lib/nfs/ (cannot be changed), and this
89           script will mount the sunrpc file system on /var/lib/nfs/rpc_pipefs
90           (default, can be changed by this parameter). If you want to move
91           only rpc_pipefs/ (e.g. to keep rpc_pipefs/ local) from default,
92           please set this value.
93
94           (optional, string, default "/var/lib/nfs/rpc_pipefs")
95
96       nfsd_args
97           Specifies what arguments to pass to the nfs daemon on startup. View
98           the rpc.nfsd man page for information on what arguments are
99           available. Note that setting this value will override all settings
100           placed in the local /etc/sysconfig/nfs file.
101
102           (optional, string, no default)
103
104       lockd_udp_port
105           The udp port lockd should listen on. Note that setting this value
106           will override all settings placed in the local /etc/sysconfig/nfs
107           file.
108
109           (optional, integer, no default)
110
111       lockd_tcp_port
112           The tcp port lockd should listen on. Note that setting this value
113           will override all settings placed in the local /etc/sysconfig/nfs
114           file.
115
116           (optional, integer, no default)
117
118       statd_outgoing_port
119           The source port number sm-notify uses when sending reboot
120           notifications. Note that setting this value will override all
121           settings placed in the local /etc/sysconfig/nfs file.
122
123           (optional, integer, no default)
124
125       statd_port
126           The port number used for RPC listener sockets. Note that setting
127           this value will override all settings placed in the local
128           /etc/sysconfig/nfs file.
129
130           (optional, integer, no default)
131
132       mountd_port
133           The port number used for rpc.mountd listener sockets. Note that
134           setting this value will override all settings placed in the local
135           /etc/sysconfig/nfs file.
136
137           (optional, integer, no default)
138
139       rquotad_port
140           The port number used for rpc.rquotad. Note that setting this value
141           will override all settings placed in the local /etc/sysconfig/nfs
142           file.
143
144           (optional, integer, no default)
145

SUPPORTED ACTIONS

147       This resource agent supports the following actions (operations):
148
149       start
150           Starts the resource. Suggested minimum timeout: 40s.
151
152       stop
153           Stops the resource. Suggested minimum timeout: 20s.
154
155       monitor
156           Performs a detailed status check. Suggested minimum timeout: 20s.
157           Suggested interval: 10s.
158
159       meta-data
160           Retrieves resource agent metadata (internal use only). Suggested
161           minimum timeout: 5s.
162
163       validate-all
164           Performs a validation of the resource configuration. Suggested
165           minimum timeout: 30s.
166

EXAMPLE CRM SHELL

168       The following is an example configuration for a nfsserver resource
169       using the crm(8) shell:
170
171           primitive p_nfsserver ocf:heartbeat:nfsserver \
172             op monitor depth="0" timeout="20s" interval="10s"
173

EXAMPLE PCS

175       The following is an example configuration for a nfsserver resource
176       using pcs(8)
177
178           pcs resource create p_nfsserver ocf:heartbeat:nfsserver \
179             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
180

SEE ALSO

182       http://clusterlabs.org/
183

AUTHOR

185       ClusterLabs contributors (see the resource agent source for information
186       about individual authors)
187
188
189
190resource-agents UNKNOWN           04/06/2022           OCF_HEARTBEAT_NFSSER(7)
Impressum