'\" t
.\"     Title: ocf_heartbeat_asterisk
.\"    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_ASTERI" "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_asterisk \- Manages an Asterisk PBX
.SH "SYNOPSIS"
.HP \w'\fBasterisk\fR\ 'u
\fBasterisk\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource agent for the Asterisk PBX\&. May manage an Asterisk PBX telephony system or a clone set that forms an Asterisk distributed device setup\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBbinary\fR
.RS 4
Location of the Asterisk PBX server binary
.sp
(optional, string, default "asterisk")
.RE
.PP
\fBcanary_binary\fR
.RS 4
Location of the Asterisk PBX Canary server binary
.sp
(optional, string, default "astcanary")
.RE
.PP
\fBconfig\fR
.RS 4
The Asterisk PBX configuration file
.sp
(optional, string, default "/etc/asterisk/asterisk\&.conf")
.RE
.PP
\fBuser\fR
.RS 4
User running Asterisk PBX daemon
.sp
(optional, string, default "asterisk")
.RE
.PP
\fBgroup\fR
.RS 4
Group running Asterisk PBX daemon (for logfile and directory permissions)
.sp
(optional, string, default "asterisk")
.RE
.PP
\fBadditional_parameters\fR
.RS 4
Additional parameters which are passed to the Asterisk PBX on startup (e\&.g\&. \-L <load> or \-M <value>)\&.
.sp
(optional, string, default "\-g \-vvv")
.RE
.PP
\fBrealtime\fR
.RS 4
Determines whether the Asterisk PBX daemon will be run with realtime priority or not\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBmaxfiles\fR
.RS 4
Determines how many files the Asterisk PBX is allowed to open at a time\&. Helps to fix the \*(AqToo many open files\*(Aq error message\&.
.sp
(optional, integer, default
8192)
.RE
.PP
\fBmonitor_sipuri\fR
.RS 4
A SIP URI to check when monitoring\&. During monitor, the agent will attempt to do a SIP OPTIONS request against this URI\&. Requires the sipsak utility to be present and executable\&. If unset, the agent does no SIP URI monitoring\&.
.sp
(optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 20\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30\&. Suggested interval: 20\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a asterisk resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_asterisk ocf:heartbeat:asterisk \e
  op monitor timeout="30" interval="20" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a asterisk resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_asterisk ocf:heartbeat:asterisk \e
  op monitor timeout="30" interval="20" 
.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