ocf_heartbeat_nfsserver(7)

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 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/nfs, or detect a systemd unit-file to
24           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_ip
51           Comma separated list of floating IP addresses used to access the
52           nfs service
53
54           (optional, string, no default)
55
56       nfsd_args
57           Specifies what arguments to pass to the nfs daemon on startup. View
58           the rpc.nfsd man page for information on what arguments are
59           available. Note that setting this value will override all settings
60           placed in the local /etc/sysconfig/nfs file.
61
62           (optional, string, no default)
63
64       lockd_udp_port
65           The udp port lockd should listen on. Note that setting this value
66           will override all settings placed in the local /etc/sysconfig/nfs
67           file.
68
69           (optional, integer, no default)
70
71       lockd_tcp_port
72           The tcp port lockd should listen on. Note that setting this value
73           will override all settings placed in the local /etc/sysconfig/nfs
74           file.
75
76           (optional, integer, no default)
77
78       statd_outgoing_port
79           The source port number sm-notify uses when sending reboot
80           notifications. Note that setting this value will override all
81           settings placed in the local /etc/sysconfig/nfs file.
82
83           (optional, integer, no default)
84
85       statd_port
86           The port number used for RPC listener sockets. Note that setting
87           this value will override all settings placed in the local
88           /etc/sysconfig/nfs file.
89
90           (optional, integer, no default)
91
92       mountd_port
93           The port number used for rpc.mountd listener sockets. Note that
94           setting this value will override all settings placed in the local
95           /etc/sysconfig/nfs file.
96
97           (optional, integer, no default)
98
99       rquotad_port
100           The port number used for rpc.rquotad. Note that setting this value
101           will override all settings placed in the local /etc/sysconfig/nfs
102           file.
103
104           (optional, integer, no default)
105
106       nfs_shared_infodir
107           The nfsserver resource agent will save nfs related information in
108           this specific directory. And this directory must be able to
109           fail-over before nfsserver itself.
110
111           (optional, string, no default)
112
113       rpcpipefs_dir
114           The mount point for the sunrpc file system. Default is
115           /var/lib/nfs/rpc_pipefs. This script will mount (bind)
116           nfs_shared_infodir on /var/lib/nfs/ (cannot be changed), and this
117           script will mount the sunrpc file system on /var/lib/nfs/rpc_pipefs
118           (default, can be changed by this parameter). If you want to move
119           only rpc_pipefs/ (e.g. to keep rpc_pipefs/ local) from default,
120           please set this value.
121
122           (optional, string, default "/var/lib/nfs/rpc_pipefs")
123

SUPPORTED ACTIONS

125       This resource agent supports the following actions (operations):
126
127       start
128           Starts the resource. Suggested minimum timeout: 40.
129
130       stop
131           Stops the resource. Suggested minimum timeout: 20s.
132
133       monitor
134           Performs a detailed status check. Suggested minimum timeout: 20s.
135           Suggested interval: 10.
136
137       meta-data
138           Retrieves resource agent metadata (internal use only). Suggested
139           minimum timeout: 5.
140
141       validate-all
142           Performs a validation of the resource configuration. Suggested
143           minimum timeout: 30.
144

EXAMPLE

146       The following is an example configuration for a nfsserver resource
147       using the crm(8) shell:
148
149           primitive p_nfsserver ocf:heartbeat:nfsserver \
150             op monitor depth="0" timeout="20s" interval="10"
151

AUTHOR

156       Linux-HA contributors (see the resource agent source for information
157       about individual authors)
158
159
160
161resource-agents 3.9.2             03/24/2017           OCF_HEARTBEAT_NFSSER(7)