Merged revisions 278023 via svnmerge from
[asterisk/asterisk.git] / configs / manager.conf.sample
1 ;
2 ; AMI - The Asterisk Manager Interface
3 ;
4 ; Third party application call management support and PBX event supervision
5 ;
6 ; This configuration file is read every time someone logs in
7 ;
8 ; Use the "manager show commands" at the CLI to list available manager commands
9 ; and their authorization levels.
10 ;
11 ; "manager show command <command>" will show a help text.
12 ;
13 ; ---------------------------- SECURITY NOTE -------------------------------
14 ; Note that you should not enable the AMI on a public IP address. If needed,
15 ; block this TCP port with iptables (or another FW software) and reach it
16 ; with IPsec, SSH, or SSL vpn tunnel.  You can also make the manager
17 ; interface available over http/https if Asterisk's http server is enabled in
18 ; http.conf and if both "enabled" and "webenabled" are set to yes in
19 ; this file.  Both default to no.  httptimeout provides the maximum
20 ; timeout in seconds before a web based session is discarded.  The
21 ; default is 60 seconds.
22 ;
23 [general]
24 enabled = no
25 ;webenabled = yes
26 port = 5038
27
28 ;httptimeout = 60
29 ; a) httptimeout sets the Max-Age of the http cookie
30 ; b) httptimeout is the amount of time the webserver waits
31 ;    on a action=waitevent request (actually its httptimeout-10)
32 ; c) httptimeout is also the amount of time the webserver keeps
33 ;    a http session alive after completing a successful action
34
35 bindaddr = 0.0.0.0
36
37 ; Parameters that control AMI over TLS. ("enabled" must be set too).
38 ; You can open a connection to this socket with e.g.
39 ;
40 ;       openssl s_client -connect my_host:5039
41 ;
42 ;tlsenable=no           ; set to YES to enable it
43 ;tlsbindport=5039               ; the port to bind to
44 ;tlsbindaddr=0.0.0.0            ; address to bind to, default to bindaddr
45 ;tlscertfile=/tmp/asterisk.pem  ; path to the certificate.
46 ;tlsprivatekey=/tmp/private.pem ; path to the private key, if no private given,
47                                 ; if no tlsprivatekey is given, default is to search
48                                                                 ; tlscertfile for private key.
49 ;tlscipher=<cipher string>      ; string specifying which SSL ciphers to use or not use
50 ;
51 ;allowmultiplelogin = yes               ; IF set to no, rejects manager logins that are already in use.
52 ;                               ; The default is yes.
53 ;
54 ;displayconnects = yes
55 ;
56 ; Add a Unix epoch timestamp to events (not action responses)
57 ;
58 ;timestampevents = yes
59
60 ;brokeneventsaction = yes   ; Restore previous behavior that caused the events
61                             ; action to not return a response in certain
62                             ; circumstances.  Defaults to 'no'.
63
64 ;
65 ; Display certain channel variables every time a channel-oriented
66 ; event is emitted:
67 ;
68 ;channelvars = var1,var2,var3
69
70 ; debug = on    ; enable some debugging info in AMI messages (default off).
71                 ; Also accessible through the "manager debug" CLI command.
72 ;[mark]
73 ;secret = mysecret
74 ;deny=0.0.0.0/0.0.0.0
75 ;permit=209.16.236.73/255.255.255.0
76 ;
77 ;eventfilter=Event: Newchannel
78 ;eventfilter=!Channel: DAHDI*
79 ; The eventfilter option is used to whitelist or blacklist events per user to be
80 ; reported with regular expressions and are allowed if both the regex matches
81 ; and the user has read access set below. Filters are assumed to be for whitelisting
82 ; unless preceeded by an exclamation point, which marks it as being black.
83 ; Evaluation of the filters is as follows:
84 ; - If no filters are configured all events are reported as normal.
85 ; - If there are white filters only: implied black all filter processed first,
86 ; then white filters.
87 ; - If there are black filters only: implied white all filter processed first,
88 ; then black filters.
89 ; - If there are both white and black filters: implied black all filter processed
90 ; first, then white filters, and lastly black filters.
91
92 ;
93 ; If the device connected via this user accepts input slowly,
94 ; the timeout for writes to it can be increased to keep it
95 ; from being disconnected (value is in milliseconds)
96 ;
97 ; writetimeout = 100
98 ;
99 ;displayconnects = yes  ; Display on CLI user login/logoff
100 ;
101 ; Authorization for various classes
102 ;
103 ; Read authorization permits you to receive asynchronous events, in general.
104 ; Write authorization permits you to send commands and get back responses.  The
105 ; following classes exist:
106 ;
107 ; all       - All event classes below (including any we may have missed).
108 ; system    - General information about the system and ability to run system
109 ;             management commands, such as Shutdown, Restart, and Reload.
110 ; call      - Information about channels and ability to set information in a
111 ;             running channel.
112 ; log       - Logging information.  Read-only.
113 ; verbose   - Verbose information.  Read-only.
114 ; agent     - Information about queues and agents and ability to add queue
115 ;             members to a queue.
116 ; user      - Permission to send and receive UserEvent.
117 ; config    - Ability to read and write configuration files.
118 ; command   - Permission to run CLI commands.  Write-only.
119 ; dtmf      - Receive DTMF events.  Read-only.
120 ; reporting - Ability to get information about the system.
121 ; cdr       - Output of cdr_manager, if loaded.  Read-only.
122 ; dialplan  - Receive NewExten and VarSet events.  Read-only.
123 ; originate - Permission to originate new calls.  Write-only.
124 ; agi       - Output AGI commands executed.  Input AGI command to execute.
125 ; cc        - Call Completion events.  Read-only.
126 ; aoc       - Permission to send Advice Of Charge messages and receive Advice
127 ;           - Of Charge events.
128 ;
129 ;read = system,call,log,verbose,agent,user,config,dtmf,reporting,cdr,dialplan
130 ;write = system,call,agent,user,config,command,reporting,originate
131