NAME

       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: 20s.

       stop
           Stops the resource. Suggested minimum timeout: 20s.

       status
           Performs a status check. Suggested minimum timeout: 20s.

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

       validate-all
           Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

       meta-data
           Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

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="30s" interval="20s"

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="30s" interval="20s"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

       ClusterLabs contributors (see the resource agent source for information about individual
       authors)