FreePBX CLI Command Asterisk
FreePBX CLI Command Asterisk
For help in the CLI mode, use the core show help command (formerly help). To get
help on various applications you can use in the extensions.conf config file, use
the core show applications command (formerly show applications).
General commands:
----------------
!<command>: Executes a given shell command
abort halt: Cancel a running halt
add extension: Add new extension into context
add ignorepat: Add new ignore pattern
add indication: Add the given indication to the country
agent show: Show status of Asterisk Agents
debug channel: Enable debugging on a channel
dont include: Remove a specified include from context
help: Display help list, or specific help on a command
include context: Include context in another context
load: Load a dynamic module by name
logger reload: Reopen log files. Use after rotating the log files.
mixmonitor {start|stop|list}: Execute a MixMonitor command.
no debug channel: Disable debugging on a channel
originate: originate a call.
remove extension: Remove a specified extension
remove ignorepat: Remove ignore pattern from context
remove indication: Remove the given indication from the country
save dialplan: Overwrites your current extensions.conf file with an exported
version based on the current state of the dialplan. A backup copy of your old
extensions.conf is not saved. The initial values of global variables defined in the
[globals] category retain their previous initial values; the current values of
global variables are not written into the new extensions.conf. Using “save
dialplan” will result in losing any comments in your current extensions.conf.
dialplan save (1.4): BROKEN, doesn’t parse correctly. Overwrites your current
extensions.conf file with an exported version based on the current state of the
dialplan. A backup copy of your old extensions.conf is not saved. The initial
values of global variables defined in the [globals] category retain their previous
initial values; the current values of global variables are not written into the new
extensions.conf. Using “save dialplan” will result in losing any comments in your
current extensions.conf.
set verbose: Set level of verboseness
show applications: Shows registered applications
show application: Describe a specific application
show channel: Display information on a specific channel
show channels: Display information on channels
show codecs: Display information on codecs
show conferences: Show status of conferences
show dialplan: Show dialplan
show hints: Show registered hints
show image formats: Displays image formats
show indications: Show a list of all country/indications
show locals: Show status of local channels
show manager command: Show manager commands
show manager connect: Show connected manager users
show parkedcalls: Lists parked calls
show queues: Show status of queues, see details here
show switches: Show alternative switches
show translation: Display translation matrix
soft hangup: Request a hangup on a given channel – in Asterisk 1.6.2: “channel
request hangup <name>”
show voicemail users: List defined voicemail boxes
show voicemail zones: List zone message formats
devstate change: Change state of a custom device (new in Asterisk 1.6.0)
Server management
-----------------
restart gracefully: Restart Asterisk gracefully, i.e. stop receiving new calls and
restart at empty call volume
restart now: Restart Asterisk immediately
restart when convenient: Restart Asterisk at empty call volume
reload: Reload configuration
stop gracefully: Gracefully shut down Asterisk, i.e. stop receiving new calls and
shut down at empty call volume
stop now: Shut down Asterisk immediately
stop when convenient: Shut down Asterisk at empty call volume
dialplan reload: Reload extensions and only extensions (formerly extensions reload)
unload: Unload a dynamic module by name
show modules: List modules and info about them
show uptime: Show uptime information
show version: Display Asterisk version info
AGI commands
------------
show agi: Show AGI commands or specific help
dump agihtml: Dumps a list of agi command in html format
Database handling commands
database del: Removes database key/value
database deltree: Removes database keytree/values
database get: Gets database value
database put: Adds/updates database value
database show: Shows database contents
database showkey: Shows database contents: An alternative to showing keys by family
with database show, this command shows all the families with a particular key
The following commands are available if the channel is built with support for
libpri:
cat batch-file\
| awk ‘{printf “/usr/sbin/asterisk -r -x \”%s\”\n”, $0}’\
| sh
The above is very slow, though. A faster option is to use socat and write the
commands directly to the Asterisk socket.
#!/bin/sh
while read line
do
echo -n "$line"
sleep 0.001
done \
| socat STDIN UNIX-CONNECT:/var/run/asterisk/asterisk.ctl
Another version without socat :
#!/bin/sh
while read line; do
echo "$line" | tr '\n' '\0'
sleep 0.001
done | nc -U /var/run/asterisk/asterisk.ctl
The short sleep is only needed to guarantee that every line is written in a
separate write() call.
It will not print any output from any command, though, or even report an error. And
you’ll have to end your “programs” with a “quit” line.