'\" t
.\"     Title: ocf_heartbeat_lvmlockd
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_LVMLOC" "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_lvmlockd \- This agent manages the lvmlockd daemon
.SH "SYNOPSIS"
.HP \w'\fBlvmlockd\fR\ 'u
\fBlvmlockd\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This agent manages the lvmlockd daemon\&. "lvmlockd" is like "clvmd"\&. Both are used by LVM commands to coordinate access to shared storage, but with different design and implementations\&. "lvmlockd" can use two lock managers: dlm and sanlock\&. This agent only supports "dlm + lvmlockd"\&. If dlm (or corosync) are already being used by other cluster software, you are advised to select dlm, then configure "controld" resource agent for dlm and this agent for "lvmlockd"\&. Otherwise, consider sanlock for "lvmlockd" if dlm/corosync is not required\&.
.PP
Using lvmlockd requires the settings in LVM configuration file (/etc/lvm/lvm\&.conf): "locking_type = 1" and "use_lvmlockd = 1"\&. This RA will change the settings respectively if needed\&.
.PP
For more information, refer to manpage lvmlockd\&.8\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBpidfile\fR
.RS 4
pid file
.sp
(optional, string, default "/run/lvmlockd\&.pid")
.RE
.PP
\fBsocket_path\fR
.RS 4
Set the socket path to listen on\&.
.sp
(optional, string, default "/run/lvm/lvmlockd\&.socket")
.RE
.PP
\fBsyslog_priority\fR
.RS 4
Write log messages from this level up to syslog\&.
.sp
(optional, string, default "warning")
.RE
.PP
\fBadopt\fR
.RS 4
Adopt locks from a previous instance of lvmlockd\&.
.sp
(optional, integer, default
1)
.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
\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 lvmlockd resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_lvmlockd ocf:heartbeat:lvmlockd \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 lvmlockd resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_lvmlockd ocf:heartbeat:lvmlockd \e
  op monitor timeout="90s" interval="30s" OCF_CHECK_LEVEL="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