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
  27 port = 5038
  28 bindaddr = 0.0.0.0
  29
  30 ; Parameters that control AMI over TLS. ("enabled" must be set too).
  31 ; You can open a connection to this socket with e.g.
  32 ;
  33 ;       openssl s_client -connect my_host:5039
  34 ;
  35 ;tlsenable=no           ; set to YES to enable it
  36 ;tlsbindaddr=0.0.0.0:5039               ; address and port to bind to, default to bindaddr and port 5039
  37 ;tlscertfile=/tmp/asterisk.pem  ; path to the certificate.
  38 ;tlsprivatekey=/tmp/private.pem ; path to the private key, if no private given,
  39                                 ; if no tlsprivatekey is given, default is to search
  40                                                                 ; tlscertfile for private key.
  41 ;tlscipher=<cipher string>      ; string specifying which SSL ciphers to use or not use
  42 ;
  43 ;allowmultiplelogin = yes               ; IF set to no, rejects manager logins that are already in use.
  44 ;                               ; The default is yes.
  45 ;
  46 ;displayconnects = yes
  47 ;
  48 ; Add a Unix epoch timestamp to events (not action responses)
  49 ;
  50 ;timestampevents = yes
  51
  52 ;brokeneventsaction = yes   ; Restore previous behavior that caused the events
  53                             ; action to not return a response in certain
  54                             ; circumstances.  Defaults to 'no'.
  55
  56 ;
  57 ; Display certain channel variables every time a channel-oriented
  58 ; event is emitted:
  59 ;
  60 ;channelvars = var1,var2,var3
  61
  62 ; debug = on    ; enable some debugging info in AMI messages (default off).
  63                 ; Also accessible through the "manager debug" CLI command.
  64
  65 ; authtimeout specifies the maximum number of seconds a client has to
  66 ; authenticate.  If the client does not authenticate beofre this timeout
  67 ; expires, the client will be disconnected. (default: 30 seconds)
  68
  69 ;authtimeout = 30
  70
  71 ; authlimit specifies the maximum number of unauthenticated sessions that will
  72 ; be allowed to connect at any given time.
  73
  74 ;authlimit = 50
  75
  76 ;httptimeout = 60
  77 ; a) httptimeout sets the Max-Age of the http cookie
  78 ; b) httptimeout is the amount of time the webserver waits
  79 ;    on a action=waitevent request (actually its httptimeout-10)
  80 ; c) httptimeout is also the amount of time the webserver keeps
  81 ;    a http session alive after completing a successful action
  82
  83
  84 ;[mark]
  85 ;secret = mysecret
  86 ;deny=0.0.0.0/0.0.0.0
  87 ;permit=209.16.236.73/255.255.255.0
  88 ;acl=named_acl_example               ; use a named ACL from acl.conf
  89 ;
  90 ;
  91 ;setvar=PBXACCOUNT=edvina
  92 ; The setvar option defines channel variables that will be set when this account
  93 ; originates a call. You can define multiple setvar= commands for one manager
  94 ; user.
  95 ;
  96 ;eventfilter=Event: Newchannel
  97 ;eventfilter=!Channel: DAHDI*
  98 ; The eventfilter option is used to whitelist or blacklist events per user to be
  99 ; reported with regular expressions and are allowed if both the regex matches
 100 ; and the user has read access set below. Filters are assumed to be for whitelisting
 101 ; unless preceeded by an exclamation point, which marks it as being black.
 102 ; Evaluation of the filters is as follows:
 103 ; - If no filters are configured all events are reported as normal.
 104 ; - If there are white filters only: implied black all filter processed first,
 105 ; then white filters.
 106 ; - If there are black filters only: implied white all filter processed first,
 107 ; then black filters.
 108 ; - If there are both white and black filters: implied black all filter processed
 109 ; first, then white filters, and lastly black filters.
 110
 111 ;
 112 ; If the device connected via this user accepts input slowly,
 113 ; the timeout for writes to it can be increased to keep it
 114 ; from being disconnected (value is in milliseconds)
 115 ;
 116 ; writetimeout = 100
 117 ;
 118 ;displayconnects = yes  ; Display on CLI user login/logoff
 119 ;
 120 ; Authorization for various classes
 121 ;
 122 ; Read authorization permits you to receive asynchronous events, in general.
 123 ; Write authorization permits you to send commands and get back responses.  The
 124 ; following classes exist:
 125 ;
 126 ; all       - All event classes below (including any we may have missed).
 127 ; system    - General information about the system and ability to run system
 128 ;             management commands, such as Shutdown, Restart, and Reload.
 129 ; call      - Information about channels and ability to set information in a
 130 ;             running channel.
 131 ; log       - Logging information.  Read-only. (Defined but not yet used.)
 132 ; verbose   - Verbose information.  Read-only. (Defined but not yet used.)
 133 ; agent     - Information about queues and agents and ability to add queue
 134 ;             members to a queue.
 135 ; user      - Permission to send and receive UserEvent.
 136 ; config    - Ability to read and write configuration files.
 137 ; command   - Permission to run CLI commands.  Write-only.
 138 ; dtmf      - Receive DTMF events.  Read-only.
 139 ; reporting - Ability to get information about the system.
 140 ; cdr       - Output of cdr_manager, if loaded.  Read-only.
 141 ; dialplan  - Receive NewExten and VarSet events.  Read-only.
 142 ; originate - Permission to originate new calls.  Write-only.
 143 ; agi       - Output AGI commands executed.  Input AGI command to execute.
 144 ; cc        - Call Completion events.  Read-only.
 145 ; aoc       - Permission to send Advice Of Charge messages and receive Advice
 146 ;           - Of Charge events.
 147 ; test      - Ability to read TestEvent notifications sent to the Asterisk Test
 148 ;             Suite.  Note that this is only enabled when the TEST_FRAMEWORK
 149 ;             compiler flag is defined.
 150 ; message   - Permissions to send out of call messages. Write-only
 151 ;
 152 ;read = system,call,log,verbose,agent,user,config,dtmf,reporting,cdr,dialplan
 153 ;write = system,call,agent,user,config,command,reporting,originate,message
 154