'\" t
.\"     Title: ocf_heartbeat_nfsnotify
.\"    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: 03/20/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_NFSNOT" "7" "03/20/2024" "resource-agents UNKNOWN" "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_nfsnotify \- sm\-notify reboot notifications
.SH "SYNOPSIS"
.HP \w'\fBnfsnotify\fR\ 'u
\fBnfsnotify\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This agent sends NFSv3 reboot notifications to clients which informs clients to reclaim locks\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBsource_host\fR
.RS 4
Comma separated list of floating IP addresses or host names that clients use to access the nfs service\&. This will be used to set the source address and mon_name of the SN_NOTIFY reboot notifications\&.
.sp
(optional, string, no default)
.RE
.PP
\fBnotify_args\fR
.RS 4
Additional arguments to send to the sm\-notify command\&. By default this agent will always set sm\-notify\*(Aqs \*(Aq\-f\*(Aq option\&. When the source_host option is set, the \*(Aq\-v\*(Aq option will be used automatically to set the proper source address\&. Any additional sm\-notify arguments set with this option will be used in addition to the previous default arguments\&.
.sp
(optional, string, default "false")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 90s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 90s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 90s\&. Suggested interval: 30s\&.
.RE
.PP
\fBreload\fR
.RS 4
Suggested minimum timeout: 90s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a nfsnotify resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_nfsnotify ocf:heartbeat:nfsnotify \e
  op monitor timeout="90s" interval="30s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a nfsnotify resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_nfsnotify ocf:heartbeat:nfsnotify \e
  op monitor timeout="90s" interval="30s" depth="0" 
.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
