'\" t .\" Title: ocf_heartbeat_exportfs .\" Author: ClusterLabs contributors (see the resource agent source for information about individual authors) .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 04/13/2023 .\" Manual: OCF resource agents .\" Source: resource-agents 4.12.0-2 .\" Language: English .\" .TH "OCF_HEARTBEAT_EXPORT" "7" "04/13/2023" "resource-agents 4.12.0-2" "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_exportfs \- Manages NFS exports .SH "SYNOPSIS" .HP \w'\fBexportfs\fR\ 'u \fBexportfs\fR [start | stop | monitor | meta\-data | validate\-all] .SH "DESCRIPTION" .PP Exportfs uses the exportfs command to add/remove nfs exports\&. It does NOT manage the nfs server daemon\&. It depends on Linux specific NFS implementation details, so is considered not portable to other platforms yet\&. .SH "SUPPORTED PARAMETERS" .PP \fBclientspec\fR .RS 4 The client specification allowing remote machines to mount the directory (or directories) over NFS\&. .sp Note: it follows the format defined in "man exportfs"\&. For example, in the use case to export the directory(\-ies) for multiple subnets, please do config a dedicated primitive for each subnet CIDR ip address, and do not attempt to use multiple CIDR ip addresses in a space separated list, like in /etc/exports\&. .sp (required, string, no default) .RE .PP \fBoptions\fR .RS 4 The options to pass to exportfs for the exported directory or directories\&. .sp (optional, string, no default) .RE .PP \fBdirectory\fR .RS 4 The directory or directories to be exported using NFS\&. Multiple directories are separated by white space\&. .sp (required, string, no default) .RE .PP \fBfsid\fR .RS 4 The fsid option to pass to exportfs\&. This can be a unique positive integer, a UUID (assuredly sans comma characters), or the special string "root" which is functionally identical to numeric fsid of 0\&. If multiple directories are being exported, then they are assigned ids sequentially starting with this fsid (fsid, fsid+1, fsid+2, \&.\&.\&.)\&. Obviously, in that case the fsid must be an integer\&. 0 (root) identifies the export as the root of an NFSv4 pseudofilesystem \-\- avoid this setting unless you understand its special status\&. This value will override any fsid provided via the options parameter\&. .sp (required, string, no default) .RE .PP \fBunlock_on_stop\fR .RS 4 Relinquish NFS locks associated with this filesystem when the resource stops\&. Enabling this parameter is highly recommended unless the path exported by this exportfs resource is also exported by a different resource\&. .sp Note: Unlocking is only possible on Linux systems where /proc/fs/nfsd/unlock_filesystem exists and is writable\&. If your system does not fulfill this requirement (on account of having an nonrecent kernel, for example), you may set this parameter to 0 to silence the associated warning\&. .sp (optional, boolean, default 1) .RE .PP \fBwait_for_leasetime_on_stop\fR .RS 4 When stopping (unexporting), wait out the NFSv4 lease time\&. Only after all leases have expired does the NFS kernel server relinquish all server\-side handles on the exported filesystem\&. If this exportfs resource manages an export that resides on a mount point designed to fail over along with the NFS export itself, then enabling this parameter will ensure such failover is working properly\&. Note that when this parameter is set, your stop timeout MUST accommodate for the wait period\&. This parameter is safe to disable if none of your NFS clients are using NFS version 4 or later\&. .sp (optional, boolean, default 0) .RE .PP \fBrmtab_backup\fR .RS 4 Back up those entries from the NFS rmtab that apply to the exported directory, to the specified backup file\&. The filename is interpreted as relative to the exported directory\&. This backup is required if clients are connecting to the export via NFSv3 over TCP\&. Note that a configured monitor operation is required for this functionality\&. .sp To disable rmtab backups, set this parameter to the special string "none"\&. .sp (optional, string, default "\&.rmtab") .RE .SH "SUPPORTED ACTIONS" .PP This resource agent supports the following actions (operations): .PP \fBstart\fR .RS 4 Starts the resource\&. Suggested minimum timeout: 40s\&. .RE .PP \fBstop\fR .RS 4 Stops the resource\&. Suggested minimum timeout: 120s\&. .RE .PP \fBmonitor\fR .RS 4 Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&. .RE .PP \fBmeta\-data\fR .RS 4 Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&. .RE .PP \fBvalidate\-all\fR .RS 4 Performs a validation of the resource configuration\&. Suggested minimum timeout: 30s\&. .RE .SH "EXAMPLE CRM SHELL" .PP The following is an example configuration for a exportfs resource using the \fBcrm\fR(8) shell: .sp .if n \{\ .RS 4 .\} .nf primitive p_exportfs ocf:heartbeat:exportfs \e params \e clientspec=\fIstring\fR \e directory=\fIstring\fR \e fsid=\fIstring\fR \e op monitor depth="0" timeout="20s" interval="10s" .fi .if n \{\ .RE .\} .SH "EXAMPLE PCS" .PP The following is an example configuration for a exportfs resource using \fBpcs\fR(8) .sp .if n \{\ .RS 4 .\} .nf pcs resource create p_exportfs ocf:heartbeat:exportfs \e clientspec=\fIstring\fR \e directory=\fIstring\fR \e fsid=\fIstring\fR \e op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s" .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