OCF_HEARTBEAT_NFSSER(7)

NAME
ocf_heartbeat_nfsserver - Manages an NFS server

SYNOPSIS

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

DESCRIPTION

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.

SUPPORTED PARAMETERS

nfs_init_script
    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.

    (optional, string, default "auto detected")

nfs_no_notify
    Do not send reboot notifications to NFSv3 clients during server startup.

    (optional, boolean, default false)

nfs_notify_foreground
    Keeps the sm-notify attached to its controlling terminal and running in the foreground.

    (optional, boolean, default false)

nfs_smnotify_retry_time
    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.

    (optional, integer, no default)

nfs_ip
    Comma separated list of floating IP addresses used to access the nfs service

    (optional, string, no default)

nfs_shared_infodir
    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.

    (optional, string, no default)

rpcpipefs_dir
    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.

    (optional, string, default "/var/lib/nfs/rpc_pipefs")

SUPPORTED ACTIONS

This resource agent supports the following actions (operations):

start
    Starts the resource. Suggested minimum timeout: 40s.

stop
    Stops the resource. Suggested minimum timeout: 20s.

monitor
    Performs a detailed status check. Suggested minimum timeout: 20s. Suggested interval: 10s.

meta-data
    Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

validate-all
    Performs a validation of the resource configuration. Suggested minimum timeout: 30s.

EXAMPLE CRM SHELL

The following is an example configuration for a nfsserver resource using the crm(8) shell:

    primitive p_nfsserver ocf:heartbeat:nfsserver \
      op monitor depth="0" timeout="20s" interval="10s"

EXAMPLE PCS

The following is an example configuration for a nfsserver resource using pcs(8)

    pcs resource create p_nfsserver ocf:heartbeat:nfsserver \
      op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"

SEE ALSO

http://clusterlabs.org/

AUTHOR

ClusterLabs contributors (see the resource agent source for information about individual authors)