ocf_heartbeat_asterisk(7)

1OCF_HEARTBEAT_ASTERI(7)       OCF resource agents      OCF_HEARTBEAT_ASTERI(7)
2
3
4

NAME

6       ocf_heartbeat_asterisk - Manages an Asterisk PBX
7

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

17       binary
18           Location of the Asterisk PBX server binary
19
20           (optional, string, default "asterisk")
21
22       canary_binary
23           Location of the Asterisk PBX Canary server binary
24
25           (optional, string, default "astcanary")
26
27       config
28           The Asterisk PBX configuration file
29
30           (optional, string, default "/etc/asterisk/asterisk.conf")
31
32       user
33           User running Asterisk PBX daemon
34
35           (optional, string, default "asterisk")
36
37       group
38           Group running Asterisk PBX daemon (for logfile and directory
39           permissions)
40
41           (optional, string, default "asterisk")
42
43       additional_parameters
44           Additional parameters which are passed to the Asterisk PBX on
45           startup (e.g. -L <load> or -M <value>).
46
47           (optional, string, default "-g -vvv")
48
49       realtime
50           Determines whether the Asterisk PBX daemon will be run with
51           realtime priority or not.
52
53           (optional, boolean, default false)
54
55       maxfiles
56           Determines how many files the Asterisk PBX is allowed to open at a
57           time. Helps to fix the 'Too many open files' error message.
58
59           (optional, integer, default 8192)
60
61       monitor_sipuri
62           A SIP URI to check when monitoring. During monitor, the agent will
63           attempt to do a SIP OPTIONS request against this URI. Requires the
64           sipsak utility to be present and executable. If unset, the agent
65           does no SIP URI monitoring.
66
67           (optional, string, no default)
68

SUPPORTED ACTIONS

70       This resource agent supports the following actions (operations):
71
72       start
73           Starts the resource. Suggested minimum timeout: 20s.
74
75       stop
76           Stops the resource. Suggested minimum timeout: 20s.
77
78       status
79           Performs a status check. Suggested minimum timeout: 20s.
80
81       monitor
82           Performs a detailed status check. Suggested minimum timeout: 30s.
83           Suggested interval: 20s.
84
85       validate-all
86           Performs a validation of the resource configuration. Suggested
87           minimum timeout: 5s.
88
89       meta-data
90           Retrieves resource agent metadata (internal use only). Suggested
91           minimum timeout: 5s.
92

EXAMPLE CRM SHELL

94       The following is an example configuration for a asterisk resource using
95       the crm(8) shell:
96
97           primitive p_asterisk ocf:heartbeat:asterisk \
98             op monitor timeout="30s" interval="20s"
99

EXAMPLE PCS

101       The following is an example configuration for a asterisk resource using
102       pcs(8)
103
104           pcs resource create p_asterisk ocf:heartbeat:asterisk \
105             op monitor timeout="30s" interval="20s"
106

AUTHOR

111       ClusterLabs contributors (see the resource agent source for information
112       about individual authors)
113
114
115
116resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_ASTERI(7)