'\" t
.\"     Title: ocf_heartbeat_pingd
.\"    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_PINGD" "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_pingd \- Monitors connectivity to specific hosts or IP addresses ("ping nodes") (deprecated)
.SH "SYNOPSIS"
.HP \w'\fBpingd\fR\ 'u
\fBpingd\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Deprecation warning: This agent is deprecated and may be removed from a future release\&. See the ocf:pacemaker:pingd resource agent for a supported alternative\&. \-\- This is a pingd Resource Agent\&. It records (in the CIB) the current number of ping nodes a node can connect to\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBpidfile\fR
.RS 4
PID file
.sp
(optional, string, default "/var/run/resource\-agents/pingd\-RESOURCE_ID")
.RE
.PP
\fBuser\fR
.RS 4
The user we want to run pingd as
.sp
(optional, string, default "root")
.RE
.PP
\fBdampen\fR
.RS 4
The time to wait (dampening) further changes occur
.sp
(optional, integer, default
1s)
.RE
.PP
\fBset\fR
.RS 4
The name of the instance_attributes set to place the value in\&. Rarely needs to be specified\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBname\fR
.RS 4
The name of the attributes to set\&. This is the name to be used in the constraints\&.
.sp
(optional, integer, default
RESOURCE_ID)
.RE
.PP
\fBsection\fR
.RS 4
The section place the value in\&. Rarely needs to be specified\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBmultiplier\fR
.RS 4
The number by which to multiply the number of connected ping nodes by
.sp
(optional, integer, no default)
.RE
.PP
\fBhost_list\fR
.RS 4
The list of ping nodes to count\&. Defaults to all configured ping nodes\&. Rarely needs to be specified\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBignore_deprecation\fR
.RS 4
If set to true, suppresses the deprecation warning for this agent\&.
.sp
(optional, boolean, 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: 20s\&.
.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: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a pingd resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_pingd ocf:heartbeat:pingd \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 pingd resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_pingd ocf:heartbeat:pingd \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