ocf_heartbeat_asterisk man page

ocf_heartbeat_asterisk — Manages an Asterisk PBX

Synopsis

asterisk [start | stop | status | monitor | meta-data | validate-all]

Description

Resource agent for the Asterisk PBX. May manage an Asterisk PBX telephony system or a clone set that forms an Asterisk distributed device setup.

Supported Parameters

binary

Location of the Asterisk PBX server binary

(optional, string, default "asterisk")

canary_binary

Location of the Asterisk PBX Canary server binary

(optional, string, default "astcanary")

config

The Asterisk PBX configuration file

(optional, string, default "/etc/asterisk/asterisk.conf")

user

User running Asterisk PBX daemon

(optional, string, default "asterisk")

group

Group running Asterisk PBX daemon (for logfile and directory permissions)

(optional, string, default "asterisk")

additional_parameters

Additional parameters which are passed to the Asterisk PBX on startup (e.g. -L <load> or -M <value>).

(optional, string, default "-g -vvv")

realtime

Determines whether the Asterisk PBX daemon will be run with realtime priority or not.

(optional, boolean, default false)

maxfiles

Determines how many files the Asterisk PBX is allowed to open at a time. Helps to fix the 'Too many open files' error message.

(optional, integer, default 8192)

monitor_sipuri

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.

(optional, string, no default)

Supported Actions

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 20.

stop

Stops the resource. Suggested minimum timeout: 20.

status

Performs a status check. Suggested minimum timeout: 20.

monitor

Performs a detailed status check. Suggested minimum timeout: 30. Suggested interval: 20.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 5.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5.

Example Crm Shell

The following is an example configuration for a asterisk resource using the crm(8) shell:

primitive p_asterisk ocf:heartbeat:asterisk \
  op monitor timeout="30" interval="20"

Example Pcs

The following is an example configuration for a asterisk resource using pcs(8)

pcs resource create p_asterisk ocf:heartbeat:asterisk \
  op monitor timeout="30" interval="20"

See Also

http://www.linux-ha.org/wiki/asterisk_(…

Author

Linux-HA contributors (see the resource agent source for information about individual authors)

Info

02/09/2016 resource-agents UNKNOWN OCF resource agents