1OCF_HEARTBEAT_NFSSER(7) OCF resource agents OCF_HEARTBEAT_NFSSER(7)
2
6 ocf_heartbeat_nfsserver - Manages an NFS server
7
9 nfsserver [start | stop | monitor | meta-data | validate-all]
10
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
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 (optional, string, default "auto detected")
27 nfsv4_only
29 Run in NFSv4 only mode (rpc-statd and rpcbind services masked).
30 (optional, boolean, default false)
32 nfs_no_notify
34 Do not send reboot notifications to NFSv3 clients during server
35 startup.
36 (optional, boolean, default false)
38 nfs_notify_foreground
40 Keeps the sm-notify attached to its controlling terminal and
41 running in the foreground.
42 (optional, boolean, default false)
44 nfs_smnotify_retry_time
46 Specifies the length of sm-notify retry time, in minutes, to
47 continue retrying notifications to unresponsive hosts. If this
48 option is not specified, sm-notify attempts to send notifications
49 for 15 minutes. Specifying a value of 0 causes sm-notify to
50 continue sending notifications to unresponsive peers until it is
51 manually killed.
52 (optional, integer, no default)
54 nfs_server_scope
56 RFC8881, 8.4.2.1 State Reclaim:
57 If the server scope is different, the client should not attempt to
59 reclaim locks. In this situation, no lock reclaim is possible. Any
60 attempt to re-obtain the locks with non-reclaim operations is
61 problematic since there is no guarantee that the existing
62 filehandles will be recognized by the new server, or that if
63 recognized, they denote the same objects. It is best to treat the
64 locks as having been revoked by the reconfiguration event.
65 For lock reclaim to even be attempted, we have to define and set
67 the same server scope for NFSD on all cluster nodes in the NFS
68 failover cluster.
69 This agent won't "guess" a suitable server scope name for you, you
71 need to explicitly specify this. But without it, NFSv4 lock reclaim
72 after failover won't work properly. Suggested value: the failover
73 "service IP".
74 (optional, string, no default)
76 nfs_ip
78 Comma separated list of floating IP addresses used to access the
79 nfs service
80 (optional, string, no default)
82 nfs_shared_infodir
84 The nfsserver resource agent will save nfs related information in
85 this specific directory. And this directory must be able to
86 fail-over before nfsserver itself.
87 (optional, string, no default)
89 rpcpipefs_dir
91 The mount point for the sunrpc file system. Default is
92 /var/lib/nfs/rpc_pipefs. This script will mount (bind)
93 nfs_shared_infodir on /var/lib/nfs/ (cannot be changed), and this
94 script will mount the sunrpc file system on /var/lib/nfs/rpc_pipefs
95 (default, can be changed by this parameter). If you want to move
96 only rpc_pipefs/ (e.g. to keep rpc_pipefs/ local) from default,
97 please set this value.
98 (optional, string, default "/var/lib/nfs/rpc_pipefs")
100 nfsd_args
102 Specifies what arguments to pass to the nfs daemon on startup. View
103 the rpc.nfsd man page for information on what arguments are
104 available. Note that setting this value will override all settings
105 placed in the local /etc/sysconfig/nfs file.
106 (optional, string, no default)
108 lockd_udp_port
110 The udp port lockd should listen on. Note that setting this value
111 will override all settings placed in the local /etc/sysconfig/nfs
112 file.
113 (optional, integer, no default)
115 lockd_tcp_port
117 The tcp port lockd should listen on. Note that setting this value
118 will override all settings placed in the local /etc/sysconfig/nfs
119 file.
120 (optional, integer, no default)
122 statd_outgoing_port
124 The source port number sm-notify uses when sending reboot
125 notifications. Note that setting this value will override all
126 settings placed in the local /etc/sysconfig/nfs file.
127 (optional, integer, no default)
129 statd_port
131 The port number used for RPC listener sockets. Note that setting
132 this value will override all settings placed in the local
133 /etc/sysconfig/nfs file.
134 (optional, integer, no default)
136 mountd_port
138 The port number used for rpc.mountd listener sockets. Note that
139 setting this value will override all settings placed in the local
140 /etc/sysconfig/nfs file.
141 (optional, integer, no default)
143 rquotad_port
145 The port number used for rpc.rquotad. Note that setting this value
146 will override all settings placed in the local /etc/sysconfig/nfs
147 file.
148 (optional, integer, no default)
150
152 This resource agent supports the following actions (operations):
153 start
155 Starts the resource. Suggested minimum timeout: 40s.
156 stop
158 Stops the resource. Suggested minimum timeout: 20s.
159 monitor
161 Performs a detailed status check. Suggested minimum timeout: 20s.
162 Suggested interval: 10s.
163 meta-data
165 Retrieves resource agent metadata (internal use only). Suggested
166 minimum timeout: 5s.
167 validate-all
169 Performs a validation of the resource configuration. Suggested
170 minimum timeout: 30s.
171
173 The following is an example configuration for a nfsserver resource
174 using the crm(8) shell:
175 primitive p_nfsserver ocf:heartbeat:nfsserver \
177 op monitor depth="0" timeout="20s" interval="10s"
178
180 The following is an example configuration for a nfsserver resource
181 using pcs(8)
182 pcs resource create p_nfsserver ocf:heartbeat:nfsserver \
184 op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
185
187 http://clusterlabs.org/
188
190 ClusterLabs contributors (see the resource agent source for information
191 about individual authors)
192resource-agents UNKNOWN 10/11/2023 OCF_HEARTBEAT_NFSSER(7)