'\" t
.\"     Title: ocf_heartbeat_nfsserver
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_NFSSER" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_nfsserver \- Manages an NFS server
.SH "SYNOPSIS"
.HP \w'\fBnfsserver\fR\ 'u
\fBnfsserver\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Nfsserver helps one to manage the Linux nfs server as a failover\-able resource in Linux\-HA\&. It depends on Linux specific NFS implementation details, so is considered not portable to other platforms yet\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBnfs_init_script\fR
.RS 4
The default init script shipped with the Linux distro\&. The nfsserver resource agent offloads the start/stop/monitor work to the init script because the procedure to start/stop/monitor nfsserver varies on different Linux distro\&. In the event that this option is not set, this agent will attempt to use an init script at this location, /etc/init\&.d/nfsserver, or detect a systemd unit\-file to use in the event that no init script is detected\&.
.sp
(optional, string, default "auto detected")
.RE
.PP
\fBnfs_no_notify\fR
.RS 4
Do not send reboot notifications to NFSv3 clients during server startup\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBnfs_notify_foreground\fR
.RS 4
Keeps the sm\-notify attached to its controlling terminal and running in the foreground\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBnfs_smnotify_retry_time\fR
.RS 4
Specifies the length of sm\-notify retry time, in minutes, to continue retrying notifications to unresponsive hosts\&. If this option is not specified, sm\-notify attempts to send notifications for 15 minutes\&. Specifying a value of 0 causes sm\-notify to continue sending notifications to unresponsive peers until it is manually killed\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBnfs_ip\fR
.RS 4
Comma separated list of floating IP addresses used to access the nfs service
.sp
(optional, string, no default)
.RE
.PP
\fBnfs_shared_infodir\fR
.RS 4
The nfsserver resource agent will save nfs related information in this specific directory\&. And this directory must be able to fail\-over before nfsserver itself\&.
.sp
(optional, string, no default)
.RE
.PP
\fBrpcpipefs_dir\fR
.RS 4
The mount point for the sunrpc file system\&. Default is /var/lib/nfs/rpc_pipefs\&. This script will mount (bind) nfs_shared_infodir on /var/lib/nfs/ (cannot be changed), and this script will mount the sunrpc file system on /var/lib/nfs/rpc_pipefs (default, can be changed by this parameter)\&. If you want to move only rpc_pipefs/ (e\&.g\&. to keep rpc_pipefs/ local) from default, please set this value\&.
.sp
(optional, string, default "/var/lib/nfs/rpc_pipefs")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 40\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 30\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a nfsserver resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_nfsserver ocf:heartbeat:nfsserver \e
  op monitor depth="0" timeout="20s" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a nfsserver resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_nfsserver ocf:heartbeat:nfsserver \e
  op monitor depth="0" timeout="20s" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR