CLI Commands: Cheat Sheet

482 entries, compact print-friendly format

CLI Commands | AsteriskRecipes.com Cheat Sheet
Name Syntax Synopsis Since
! !<command> Executes a given shell command N/A
CLI Commands Quick Reference Quick reference for commonly used Asterisk CLI commands -- PJSIP, dialplan, channel, system, voicemail, queue, and debug...
_command matchesarray _command matchesarray "<line>" text This function is used internally to help with command completion and should. N/A
acl show acl show [name] Shows a list of named ACLs or lists all entries in a given named ACL. N/A
aeap show client aeap show client <id> Show the AEAP settings for a given client N/A
aeap show clients aeap show clients Show all configured AEAP clients N/A
ael reload ael reload Reloads AEL configuration. N/A
ael set debug {read|tokens|contexts|off} ael set debug {read|tokens|contexts|off} Enable AEL read, token, or context debugging, or disable all AEL debugging messages. N/A
agent logoff agent logoff <agent-id> [soft] Sets an agent as no longer logged in. N/A
agent show agent show <agent-id> Show information about the <agent-id> agent N/A
agent show all agent show all Provides summary information for all agents. N/A
agent show online agent show online Provides summary information for logged in agents. N/A
agi dump html agi dump html <filename> Dumps the AGI command list in HTML format to the given file. N/A
agi exec agi exec <channel name> <app and arguments> [id] Add AGI command to the execute queue of the specified channel in Async AGI N/A
agi set debug [on|off] agi set debug [on|off] Enables/disables dumping of AGI transactions for debugging purposes. N/A
agi show commands [topic] agi show commands [topic] <topic> When called with a topic as an argument, displays usage information on the given command. N/A
aoc set debug 'aoc set debug on' to enable aoc debug, 'aoc set debug off' to disable debug. N/A
ari mkpasswd ari mkpasswd <password> Encrypts a password for use in ari.conf Be aware that the password will be shown in the command line history. N/A
ari set debug ari set debug <application|all> <on|off> Enable or disable debugging on a specific application. N/A
ari show app ari show app <application> Provide detailed information about a registered application. N/A
ari show apps ari show apps Lists all registered applications. N/A
ari show outbound-websocket ari show outbound-websocket <connection id> Shows a specific ARI outbound websocket N/A
ari show outbound-websockets ari show outbound-websockets Shows all ARI outbound-websockets N/A
ari show status ari show status Shows all ARI settings N/A
ari show user ari show user <username> Shows a specific ARI user N/A
ari show users ari show users Shows all ARI users N/A
ari show websocket sessions ari show websocket sessions Shows all ARI websocket sessions N/A
ari shutdown websocket session ari shutdown websocket session <id> Shuts down ARI websocket session N/A
ari shutdown websocket sessions ari shutdown websocket sessions Shuts down all ARI websocket sessions N/A
ari start outbound-websocket ari start outbound-websocket <connection id> Starts a specific ARI outbound websocket N/A
astobj2 container check astobj2 container check <name> Perform a container integrity check on <name>. N/A
astobj2 container dump astobj2 container dump <name> Show contents of the container <name>. N/A
astobj2 container stats astobj2 container stats <name> Show statistics about the specified container <name>. N/A
astobj2 show stats astobj2 show stats Show astobj2 show stats N/A
astobj2 test astobj2 test <num> Runs astobj2 test. N/A
bridge destroy bridge destroy <bridge-id> Destroy the <bridge-id> bridge N/A
bridge kick bridge kick <bridge-id> <channel-name | all> Kick the <channel-name> channel out of the <bridge-id> bridge If all is specified as the channel name then all channels ... N/A
bridge show bridge show <bridge-id> Show information about the <bridge-id> bridge N/A
bridge show all bridge show all List all bridges N/A
bridge technology show bridge technology show List registered bridge technologies N/A
bridge technology {suspend|unsuspend} bridge technology {suspend|unsuspend} <technology-name> Suspend or unsuspend a bridge technology. N/A
calendar dump sched calendar dump sched Dump the calendar sched context N/A
calendar show calendar calendar show calendar <calendar name> Displays information about a calendar N/A
calendar show calendars calendar show calendars Lists all registered calendars. N/A
calendar show types calendar show types Lists all registered calendars types. N/A
cc cancel [core|all] cc cancel can be used in two ways. core ID equal to the specified core ID. N/A
cc report status cc report status Report the current status of any ongoing CC transactions N/A
cdr set debug [on|off] cdr set debug [on|off] Enable or disable extra debugging in the CDR Engine. N/A
cdr show active cdr show active [channel] Displays a summary of all Call Detail Records when [channel] is omitted; displays all of the Call Detail Records current... N/A
cdr show pgsql status cdr show pgsql status Shows current connection status for cdr_pgsql N/A
cdr show status cdr show status Displays the Call Detail Record engine system status. N/A
cdr submit cdr submit Posts all pending batched CDR data to the configured CDR backend engine modules. N/A
cel show status cel show status Displays the Channel Event Logging system status. N/A
channel dump frames channel dump frames <channel> List all frames queued to a channel. N/A
channel originate channel originate There are two ways to use this command. N/A
channel redirect channel redirect <channel> <[[context,]exten,]priority> Redirect an active channel to a specified extension. N/A
channel request hangup channel request hangup <all>|<channel> [<channel> ...] Request that one or more channels be hung up. N/A
cli check permissions cli check permissions {<username>|@<groupname>|<username>@<groupname>} [<command>] Check permissions config for a user@group or list the allowed commands for the specified user. N/A
cli reload permissions cli reload permissions Reload the 'cli_permissions.conf' file. N/A
cli show aliases cli show aliases Displays a list of aliased CLI commands. N/A
cli show permissions cli show permissions Shows CLI configured permissions. N/A
confbridge kick confbridge kick <conference> <channel> Kicks a channel out of the conference bridge. N/A
confbridge list confbridge list [<name>] Lists all currently active conference bridges or a specific conference bridge. N/A
confbridge lock confbridge lock <conference> Lock a conference. N/A
confbridge mute confbridge mute <conference> <channel> Mute a channel in a conference. N/A
confbridge record start confbridge record start <conference> <file> <file> is optional, Otherwise the bridge profile record file will be used. N/A
confbridge record stop confbridge record stop <conference> Stop a previously started recording. N/A
confbridge show menu confbridge show menu [<menu name>] N/A
confbridge show menus confbridge show profile menus N/A
confbridge show profile bridge confbridge show profile bridge <profile name> N/A
confbridge show profile bridges confbridge show profile bridges N/A
confbridge show profile user confbridge show profile user [<profile name>] N/A
confbridge show profile users confbridge show profile users N/A
confbridge unlock confbridge unlock <conference> Unlock a previously locked conference. N/A
confbridge unmute confbridge unmute <conference> <channel> Unmute a channel in a conference. N/A
config list config list Show all modules that have loaded a configuration file N/A
config reload config reload <filename.conf> Reloads all modules that reference <filename.conf> N/A
config show help config show help [<module> [<type> [<option>]]] Display detailed information about module configuration. N/A
console answer console answer Answers an incoming call on the console channel. N/A
console dial console dial [extension[@context]] Dials a given extension (and context if specified) N/A
console flash console flash Flashes the call currently placed on the console. N/A
console hangup console hangup Hangs up any call currently placed on the console. N/A
console list available console list available List all available devices. N/A
console list devices console list devices List all configured devices. N/A
console send text console send text <message> Sends a text message for display on the remote terminal. N/A
console {mute|unmute} console {mute|unmute} Mute/unmute the microphone. N/A
console {set|show} active console {set|show} active [<device>] Set or show the active console device for the Asterisk CLI. N/A
console {set|show} autoanswer [on|off] console {set|show} autoanswer [on|off] Enables or disables autoanswer feature. N/A
core abort shutdown core abort shutdown Causes Asterisk to abort an executing shutdown or restart, and resume normal call operations. N/A
core clear profile core clear profile clear profile information N/A
core eat memory core eat memory Eats all available memory so you can test if the system survives N/A
core ping taskprocessor core ping taskprocessor <taskprocessor> Displays the time required for a task to be processed N/A
core reload core reload Execute a global reload. N/A
core reset taskprocessor core reset taskprocessor <taskprocessor> Resets stats for the specified taskprocessor N/A
core reset taskprocessors core reset taskprocessors Resets stats for all taskprocessors N/A
core restart gracefully core restart gracefully Causes Asterisk to stop accepting new calls and exec() itself performing a cold restart when all active calls have ended... N/A
core restart now core restart now Causes Asterisk to hangup all calls and exec() itself performing a cold restart. N/A
core restart when convenient core restart when convenient Causes Asterisk to perform a cold restart when all active calls have ended. N/A
core set debug core set debug [atleast] <level> [module] core set debug off N/A
core set debug category core set debug category <category>[:<sublevel>] [category[:<sublevel] ...] core set debug category off [<category> [<category>] ...] N/A
core set debug channel core set debug channel <all|channel> [off] Enables/disables debugging on all or on a specific channel. N/A
core set trace core set trace [atleast] <level> [module] core set trace off N/A
core set verbose core set verbose [atleast] <level> [silent] core set verbose off N/A
core show application core show application <application> [<application> [<application> [...]]] Describes a particular application. N/A
core show applications [like|describing] core show applications [{like|describing} <text>] List applications which are currently available. N/A
core show calls [uptime] core show calls [uptime [seconds]] Lists number of currently active calls and total number of calls processed through PBX since last restart. N/A
core show channel core show channel <channel> Shows lots of information about the specified channel. N/A
core show channels [concise|verbose|count] core show channels [concise|verbose|count] Lists currently defined channels and some information about them. N/A
core show channeltype core show channeltype <name> Show details about the specified channel type, <name>. N/A
core show channeltypes core show channeltypes Lists available channel types registered in your Asterisk server. N/A
core show codec core show codec <number> Displays codec mapping N/A
core show codecs [audio|video|image|text] core show codecs [audio|video|image|text] Displays codec mapping N/A
core show config mappings core show config mappings Shows the filenames to config engines. N/A
core show device2extenstate core show device2extenstate Lists device state to extension state combinations. N/A
core show fd core show fd List all file descriptors currently in use and where each was opened, and with what command. N/A
core show file formats core show file formats Displays currently registered file formats (if any). N/A
core show function core show function <function> Describe a particular dialplan function. N/A
core show functions [like] core show functions [like <text>] List builtin functions, optionally only those matching a given string N/A
core show hanguphandlers core show hanguphandlers <channel> Show hangup handlers of a specified channel. N/A
core show hanguphandlers all core show hanguphandlers all Show hangup handlers for all channels. N/A
core show help core show help [topic] When called with a topic as an argument, displays usage information on the given command. N/A
core show hint core show hint <exten> List registered hint. N/A
core show hints core show hints List registered hints. N/A
core show image formats core show image formats Displays currently registered image formats (if any). N/A
core show license core show license Shows the license(s) for this copy of Asterisk. N/A
core show locks core show locks This command is for lock debugging. N/A
core show profile core show profile show profile information N/A
core show settings core show settings Show core misc settings N/A
core show sound core show sound [soundid] Shows information about the specified sound. N/A
core show sounds core show sounds Shows a listing of sound files available on the system. N/A
core show switches core show switches List registered switches N/A
core show sysinfo core show sysinfo List current system information. N/A
core show taskprocessor alerted subsystems core show taskprocessor alerted subsystems Shows a list of task processor subsystems that are currently alerted N/A
core show taskprocessor name core show taskprocessor name <taskprocessor> Displays detailed information about a specific taskprocessor, including all queued tasks and their origins (DEVMODE only... N/A
core show taskprocessors [like] core show taskprocessors [like keyword] Shows a list of instantiated task processors and their statistics N/A
core show threads core show threads List threads currently active in the system. N/A
core show translation 'core show translation' can be used in three ways. as the chart is being displayed. N/A
core show uptime [seconds] core show uptime [seconds] Shows Asterisk uptime information. N/A
core show version core show version Shows Asterisk version information. N/A
core show warranty core show warranty Shows the warranty (if any) for this copy of Asterisk. N/A
core stop gracefully core stop gracefully Causes Asterisk to not accept new calls, and exit when all active calls have terminated normally. N/A
core stop now core stop now Shuts down a running Asterisk immediately, hanging up all active calls . N/A
core stop when convenient core stop when convenient Causes Asterisk to perform a shutdown when all active calls have ended. N/A
core waitfullybooted core waitfullybooted Wait until Asterisk has fully booted. N/A
corosync ping corosync ping Send a test ping to the cluster. N/A
corosync show config corosync show config Show configuration loaded from res_corosync.conf N/A
corosync show members corosync show members Show corosync cluster members N/A
dahdi create channels dahdi create channels <from> [<to>] - a range of channels dahdi create channels new - add channels not yet created For ISDN and SS7 the range should include complete spans. N/A
dahdi destroy channels dahdi destroy channels <from_channel> [<to_channel>] DON'T USE THIS UNLESS YOU KNOW WHAT YOU ARE DOING. N/A
dahdi restart dahdi restart Restarts the DAHDI channels: destroys them all and then re-reads them from chan_dahdi.conf. N/A
dahdi set dnd dahdi set dnd <chan#> <on|off> Sets/resets DND (Do Not Disturb) mode on a channel. N/A
dahdi set hwgain {rx|tx} dahdi set hwgain <rx|tx> <chan#> <gain> Sets the hardware gain on a given channel and overrides the value provided at module loadtime. N/A
dahdi set mwi dahdi set mwi <chan#> <on|off|reset> Sets/unsets MWI (Message Waiting Indicator) manually on a channel. N/A
dahdi set swgain {rx|tx} dahdi set swgain <rx|tx> <chan#> <gain> Sets the software gain on a given channel and overrides the value provided at module loadtime. N/A
dahdi show cadences dahdi show cadences Shows all cadences currently defined N/A
dahdi show channel dahdi show channel <chan num> Detailed information about a given channel N/A
dahdi show channels [group|context] dahdi show channels [ group <group> | context <context> ] Shows a list of available channels with optional filtering <group> must be a number between 0 and 63 N/A
dahdi show status dahdi show status Shows a list of DAHDI cards with status N/A
dahdi show version dahdi show version Shows the DAHDI version in use N/A
database del database del <family> <key> Deletes an entry in the Asterisk database for a given family and key. N/A
database deltree database deltree <family> [keytree] separated by either a space or a slash. N/A
database get database get <family> <key> Retrieves an entry in the Asterisk database for a given family and key. N/A
database put database put <family> <key> <value> Adds or updates an entry in the Asterisk database for a given family, key, and value. N/A
database query database query "<SQL Statement>" Run a user-specified SQL query on the database. N/A
database show database show [family [keytree]] may be separated either by a space or by a slash. N/A
database showkey database showkey <keytree> Shows Asterisk database contents, restricted to a given key. N/A
devstate change devstate change <device> <state> Change a custom device to a new state. N/A
devstate list devstate list List all custom device states that have been set by using the DEVICE_STATE dialplan function. N/A
dialplan add extension dialplan add extension <exten>,<priority>,<app> into <context> [replace] This command will add the new extension into <context>. N/A
dialplan add ignorepat dialplan add ignorepat <pattern> into <context> This command adds a new ignore pattern into context <context> N/A
dialplan add include dialplan add include <context> into <context> Include a context in another context. N/A
dialplan debug dialplan debug [context] Show dialplan context Trie(s). N/A
dialplan eval function dialplan eval function <name(args)> Evaluate a dialplan function call A dummy channel is used to evaluate the function call, so only global variables should... N/A
dialplan exec application dialplan exec application <appname> [<args>] Execute a single dialplan application call for testing. N/A
dialplan locks show dialplan locks show List all locks known to func_lock, along with their current status. N/A
dialplan reload dialplan reload Reload extensions.conf without reloading any other modules. N/A
dialplan remove context dialplan remove context <context> Removes all extensions from a specified context. N/A
dialplan remove extension dialplan remove extension exten[/cid]@context [priority] Remove an extension from a given context. N/A
dialplan remove ignorepat dialplan remove ignorepat <pattern> from <context> This command removes an ignore pattern from context <context> N/A
dialplan remove include dialplan remove include <context> from <context> Remove an included context from another context. N/A
dialplan save dialplan save [/path/to/extension/file] Save dialplan created by pbx_config module. N/A
dialplan set chanvar dialplan set chanvar <channel> <varname> <value> Set channel variable <varname> to <value> N/A
dialplan set extenpatternmatchnew false dialplan set extenpatternmatchnew true|false Use the NEW extension pattern matching algorithm, true or false. N/A
dialplan set extenpatternmatchnew true dialplan set extenpatternmatchnew true|false Use the NEW extension pattern matching algorithm, true or false. N/A
dialplan set global dialplan set global <name> <value> Set global dialplan variable <name> to <value> N/A
dialplan show dialplan show [[exten@]context] Show dialplan N/A
dialplan show chanvar dialplan show chanvar <channel> List current channel variables and their values N/A
dialplan show globals dialplan show globals List current global dialplan variables and their values N/A
dnsmgr refresh dnsmgr refresh [pattern] Performs an immediate refresh of the managed DNS entries. N/A
dnsmgr reload dnsmgr reload Reloads the DNS manager configuration. N/A
dnsmgr status dnsmgr status Displays the DNS manager status. N/A
dundi flush [stats] dundi flush [stats] Flushes DUNDi answer cache, used primarily for debug. N/A
dundi lookup dundi lookup <number>[@context] [bypass] Lookup the given number within the given DUNDi context (or e164 if none is specified). N/A
dundi precache dundi precache <number>[@context] Lookup the given number within the given DUNDi context (or e164 if none is specified) and precaches the results to any u... N/A
dundi query dundi query <entity>[@context] Attempts to retrieve contact information for a specific DUNDi entity identifier (EID) within a given DUNDi context (or e... N/A
dundi set debug {on|off} dundi set debug {on|off} Enables/Disables dumping of DUNDi packets for debugging purposes N/A
dundi show cache dundi show cache Lists all DUNDi cache entries. N/A
dundi show entityid dundi show entityid Displays the global entityid for this host. N/A
dundi show hints dundi show hints Lists all DUNDi 'DONTASK' hints in the cache. N/A
dundi show mappings dundi show mappings Lists all known DUNDi mappings. N/A
dundi show peer dundi show peer [peer] Provide a detailed description of a specifid DUNDi peer. N/A
dundi show peers [registered|include|exclude|begin] dundi show peers [registered|include|exclude|begin] Lists all known DUNDi peers. N/A
dundi show precache dundi show precache Lists all known DUNDi scheduled precache updates. N/A
dundi show requests dundi show requests Lists all known pending DUNDi requests. N/A
dundi show trans dundi show trans Lists all known DUNDi transactions. N/A
dundi store history {on|off} dundi store history {on|off} Enables/Disables storing of DUNDi requests and times for debugging purposes N/A
fax set debug {on|off} fax set debug { on | off } Enable/Disable FAX debugging on new FAX sessions. N/A
fax show capabilities fax show capabilities Shows the capabilities of the registered FAX technology modules N/A
fax show session fax show session <session number> Shows status of the named FAX session N/A
fax show sessions fax show sessions Shows the current FAX sessions N/A
fax show settings fax show settings Show the global settings and defaults of both the FAX core and technology modules N/A
fax show stats fax show stats Shows a statistical summary of FAX transmissions N/A
fax show version fax show version Show versions of FAX For Asterisk components. N/A
features show features show Lists configured features N/A
file convert file convert <file_in> <file_out> Convert from file_in to file_out. N/A
geoloc list locations geoloc list locations [ like <pattern> ] List Geolocation Location Objects N/A
geoloc list profiles geoloc list profiles [ like <pattern> ] List Geolocation Profile Objects N/A
geoloc reload geoloc reload Reload Geolocation Configuration N/A
geoloc show gml_shape_defs geoloc show gml_shape_defs Show the GML Shape definitions. N/A
geoloc show profiles geoloc show profiles [ like <pattern> ] List Geolocation Profile Objects N/A
group show channels group show channels [pattern] Lists all currently active channels with channel group(s) specified. N/A
http show status http show status Lists status of internal HTTP engine N/A
iax2 provision iax2 provision <host> <template> [forced] Provisions the given peer or IP address using a template matching either 'template' or '*' if the template is not found. N/A
iax2 prune realtime iax2 prune realtime [<peername>|all] Prunes object(s) from the cache N/A
iax2 reload iax2 reload Reloads IAX configuration from iax.conf N/A
iax2 set debug jb {on|off} iax2 set debug jb {on|off} Enables/Disables jitterbuffer debugging information N/A
iax2 set debug trunk {on|off} iax2 set debug trunk {on|off} Enables/Disables debugging of IAX trunking N/A
iax2 set debug {on|off|peer} iax2 set debug {on|off|peer peername} Enables/Disables dumping of IAX packets for debugging purposes. N/A
iax2 set mtu iax2 set mtu <value> Set the system-wide IAX IP mtu to <value> bytes net or zero to disable. N/A
iax2 show cache iax2 show cache Display currently cached IAX Dialplan results. N/A
iax2 show callnumber usage iax2 show callnumber usage [IP address] Shows current IP addresses which are consuming iax2 call numbers N/A
iax2 show channels iax2 show channels Lists all currently active IAX channels. N/A
iax2 show firmware iax2 show firmware Lists all known IAX firmware images. N/A
iax2 show netstats iax2 show netstats Lists network status for all currently active IAX channels. N/A
iax2 show peer iax2 show peer <name> Display details on specific IAX peer N/A
iax2 show peers iax2 show peers [registered] [like <pattern>] Lists all known IAX2 peers. N/A
iax2 show provisioning iax2 show provisioning [template] Lists all known IAX provisioning templates or a specific one if specified. N/A
iax2 show registry iax2 show registry Lists all registration requests and status. N/A
iax2 show stats iax2 show stats Display statistics on IAX channel driver. N/A
iax2 show threads iax2 show threads Lists status of IAX helper threads N/A
iax2 show users [like] iax2 show users [like <pattern>] Lists all known IAX2 users. N/A
iax2 test jitter iax2 test jitter <ms> <pct> For testing, simulate maximum jitter of +/- <ms> on <pct> percentage of packets. N/A
iax2 test late iax2 test late <ms> For testing, count the next frame as <ms> ms late N/A
iax2 test losspct iax2 test losspct <percentage> For testing, throws away <percentage> percent of incoming packets N/A
iax2 test resync iax2 test resync <ms> For testing, adjust all future frames by <ms> ms N/A
iax2 unregister iax2 unregister <peername> Unregister (force expiration) an IAX2 peer from the registry. N/A
indication add indication add <country> <indication> "<tonelist>" Add the given indication to the country. N/A
indication remove indication remove <country> [indication] Remove the given indication from the country. N/A
indication show indication show [<country> ...] Display either a condensed summary of all countries and indications, or a more verbose list of indications for the speci... N/A
keys init keys init Initializes private keys (by reading in pass code from the user) N/A
keys show keys show Displays information about RSA keys known by Asterisk N/A
local show channels local show channels Provides summary information on active local proxy channels. N/A
logger add channel logger add channel <name> <levels> Adds a temporary logger channel. N/A
logger filter changroup logger filter changroup <group> {on|off} Add or remove channel groups from log filtering. N/A
logger filter reset logger filter reset Reset the logger filter. N/A
logger filter show logger filter show Show current logger filtering settings. N/A
logger mute logger mute Disables logging output to the current console, making it possible to gather information without being disturbed by scro... N/A
logger reload logger reload [<alt-conf>] Reloads the logger subsystem state. N/A
logger remove channel logger remove channel <name> Removes a temporary logger channel. N/A
logger rotate logger rotate Rotates and Reopens the log files. N/A
logger set level {DEBUG|TRACE|NOTICE|WARNING|ERROR|VERBOSE|DTMF} {on|off} logger set level {DEBUG|TRACE|NOTICE|WARNING|ERROR|VERBOSE|DTMF} {on|off} Set a specific log level to enabled/disabled for this console. N/A
logger show channels logger show channels List configured logger channels. N/A
logger show levels logger show levels List configured logger levels. N/A
malloc trim malloc trim Try to give excess memory back to the OS. N/A
manager kick session manager kick session <file descriptor> Kick an active Asterisk Manager Interface session N/A
manager reload manager reload Reloads the manager configuration. N/A
manager set debug [on|off] manager set debug [on|off] Show, enable, disable debugging of the manager code. N/A
manager show command manager show command <actionname> [<actionname> [<actionname> [...]]] Shows the detailed description for a specific Asterisk manager interface command. N/A
manager show commands manager show commands Prints a listing of all the available Asterisk manager interface commands. N/A
manager show connected manager show connected Prints a listing of the users that are currently connected to the Asterisk manager interface. N/A
manager show event manager show event <eventname> Provides a detailed description a Manager interface event. N/A
manager show eventq manager show eventq Prints a listing of all events pending in the Asterisk manger event queue. N/A
manager show events manager show events Prints a listing of the available Asterisk manager interface events. N/A
manager show settings manager show settings Provides detailed list of the configuration of the Manager. N/A
manager show user manager show user <user> Display all information related to the manager user specified. N/A
manager show users manager show users Prints a listing of all managers that are currently configured on that system. N/A
media cache create media cache create <uri> <file> Create an item in the media cache by associating a local media file with some URI. N/A
media cache delete media cache delete <uri> Delete an item from the media cache. N/A
media cache refresh media cache refresh <uri> Ask for a refresh of a particular URI. N/A
media cache show media cache show <uri> Display all information about a particular item in the media cache. N/A
media cache show all media cache show all Display a summary of all current items in the media cache. N/A
meetme kick meetme kick <confno> all|<userno> Kick a conference or a user in a conference. N/A
meetme list meetme list [<confno>] [concise] List all conferences or a specific conference. N/A
meetme {lock|unlock} meetme lock|unlock <confno> Lock or unlock a conference to new users. N/A
meetme {mute|unmute} meetme mute|unmute <confno> all|<userno> Mute or unmute a conference or a user in a conference. N/A
memory atexit list {on|off} memory atexit list {on|off} Enable dumping a list of still allocated memory segments at exit. N/A
memory atexit summary {off|byline|byfunc|byfile} memory atexit summary {off|byline|byfunc|byfile} Summary of still allocated memory segments at exit options. N/A
memory backtrace {on|off} memory backtrace {on|off} Enable dumping an allocation backtrace with memory diagnostics. N/A
memory show allocations memory show allocations [<file>|anomalies] Dumps a list of segments of allocated memory. N/A
memory show summary memory show summary [<file>] Summarizes heap memory allocations by file, or optionally by line if a file is specified. N/A
mfcr2 call files [on|off] mfcr2 call files [on|off] <channel> Enable call files creation on the specified channel. N/A
mfcr2 destroy link mfcr2 destroy link <index-number> Destroys D-channel of link and its B-channels. N/A
mfcr2 set blocked mfcr2 set blocked <channel> DON'T USE THIS UNLESS YOU KNOW WHAT YOU ARE DOING. N/A
mfcr2 set debug mfcr2 set debug <loglevel> <channel> Set a new logging level for the specified channel. N/A
mfcr2 set idle mfcr2 set idle <channel> DON'T USE THIS UNLESS YOU KNOW WHAT YOU ARE DOING. N/A
mfcr2 show channels [group|context] mfcr2 show channels [group <group> | context <context>] Shows the DAHDI channels configured with MFC/R2 signaling. N/A
mfcr2 show links mfcr2 show links Shows the DAHDI MFC/R2 links. N/A
mfcr2 show variants mfcr2 show variants Shows the list of MFC/R2 variants supported. N/A
mfcr2 show version mfcr2 show version Shows the version of the OpenR2 library being used. N/A
minivm list accounts [for] minivm list accounts [for <domain>] Lists all mailboxes currently set up N/A
minivm list templates minivm list templates Lists message templates for e-mail, paging and IM N/A
minivm list zones minivm list zones Lists zone message formats N/A
minivm reload minivm reload Reload mini-voicemail configuration and reset statistics N/A
minivm show settings minivm show settings Display Mini-Voicemail general settings N/A
minivm show stats minivm show stats Display Mini-Voicemail counters N/A
mixmonitor {start|stop|list} mixmonitor start <chan_name> [args] The optional arguments are passed to the MixMonitor application. N/A
mobile cusd mobile cusd <device ID> <command> Send cusd <command> to the rfcomm port on the device with the specified <device ID>. N/A
mobile rfcomm mobile rfcomm <device ID> <command> Send <command> to the rfcomm port on the device with the specified <device ID>. N/A
mobile search mobile search Searches for Bluetooth Cell / Mobile devices in range. N/A
mobile show devices mobile show devices Shows the state of Bluetooth Cell / Mobile devices. N/A
module load module load <module name> Loads the specified module into Asterisk. N/A
module refresh module refresh <module name> [recursively] Unloads and loads the specified module into Asterisk. N/A
module reload module reload [module ...] Reloads configuration files for all listed modules which support reloading, or for all supported modules if none are lis... N/A
module show [like] module show [like keyword] Shows Asterisk modules currently in use, and usage statistics. N/A
module unload module unload [-f|-h] <module_1> [<module_2> ... ] Unloads the specified module from Asterisk. N/A
moh reload moh reload Reloads the MusicOnHold module. N/A
moh show classes moh show classes Lists all MusicOnHold classes. N/A
moh show files moh show files Lists all loaded file-based MusicOnHold classes and their files. N/A
moh unregister class moh unregister class <class> Unregisters a realtime moh class. N/A
mwi delete all mwi delete all Delete all external MWI mailboxes. N/A
mwi delete like mwi delete like <pattern> Delete external MWI mailboxes matching a regular expression. N/A
mwi delete mailbox mwi delete mailbox <mailbox_id> Delete a specific external MWI mailbox. N/A
mwi list all mwi list all List all external MWI mailboxes. N/A
mwi list like mwi list like <pattern> List external MWI mailboxes matching a regular expression. N/A
mwi show mailbox mwi show mailbox <mailbox_id> Show a specific external MWI mailbox. N/A
mwi update mailbox mwi update mailbox <mailbox_id> [<new> [<old>]] Update a specific external MWI mailbox. N/A
odbc read odbc read <name> <args> [exec] Evaluates the SQL provided in the ODBC function <name>, and optionally executes the function. N/A
odbc show odbc show [class] List settings of a particular ODBC class or, if not specified, all classes. N/A
odbc write odbc write <name> <args> <value> [exec] Evaluates the SQL provided in the ODBC function <name>, and optionally executes the function. N/A
ooh323 reload ooh323 reload Reload OOH323 config. N/A
ooh323 set debug [off] ooh323 set debug [off] Enables/Disables debugging of OOH323 channel driver N/A
ooh323 show config ooh323 show config Shows global configuration of H.323 channel driver N/A
ooh323 show gk ooh323 show gk Shows Gatekeeper connection state N/A
ooh323 show peer ooh323 show peer <name> List details of specific OOH323 peer. N/A
ooh323 show peers ooh323 show peers Lists all known OOH323 peers. N/A
ooh323 show user ooh323 show user <name> List details of specific OOH323 user. N/A
ooh323 show users ooh323 show users Lists all known OOH323 users. N/A
parking show parking show [name] Shows a list of parking lots or details of a specific parking lot. N/A
phoneprov show routes phoneprov show routes Lists all registered phoneprov http routes. N/A
pjproject set log level {default|0|1|2|3|4|5|6} pjproject set log level {default|<level>} Set the maximum active pjproject logging level. N/A
pjproject show buildopts pjproject show buildopts Show the compile time config of the pjproject that Asterisk is running against. N/A
pjproject show log level pjproject show log level Show the current maximum active pjproject logging level. N/A
pjproject show log mappings pjproject show log mappings Show pjproject to Asterisk log mappings N/A
pjsip dump endpt [details] pjsip dump endpt [details] Dump the res_pjsip endpt internals. N/A
pjsip export config_wizard primitives [to] pjsip export config_wizard primitives [ to <filename ] Export the config_wizard objects as pjsip primitives to the console or to <filename> N/A
pjsip list ciphers pjsip list ciphers List available OpenSSL cipher names. N/A
pjsip list subscriptions {inbound|outbound} [like] pjsip list subscriptions {inbound|outbound} [like] The regex selects output lines that match. N/A
pjsip qualify pjsip qualify <endpoint> Send a SIP OPTIONS request to all contacts on the endpoint. N/A
pjsip reload qualify aor pjsip reload qualify aor <id> Synchronize the PJSIP Aor qualify options. N/A
pjsip reload qualify endpoint pjsip reload qualify endpoint <id> Synchronize the qualify options for all Aors on the PJSIP endpoint. N/A
pjsip send notify pjsip send notify <type> {endpoint|uri|channel} <peer> [<peer>...] Send a NOTIFY request to an endpoint Message types are defined in pjsip_notify.conf N/A
pjsip send register pjsip send register <registration> | *all Unregisters the specified (or all) outbound registration(s) then starts registration(s) and schedules re-registrations. N/A
pjsip send unregister pjsip send unregister <registration> | *all Unregisters the specified (or all) outbound registration(s) and stops future registration attempts. N/A
pjsip set history {on|off|clear} pjsip set history {on|off|clear} Enables/disables/clears the PJSIP history. N/A
pjsip set logger {on|off|host|add|method|methodadd|verbose|pcap} pjsip set logger {on|off|host <name/subnet>|add <name/subnet>|method <method>|methodadd <method>|verbose <on/off>|pcap <filename>} Enables or disabling logging of SIP packets read on ports bound to PJSIP transports either globally or enables logging f... N/A
pjsip show history pjsip show history [entry <num>|where [...]] Displays the currently collected history or an entry within the history. N/A
pjsip show identifiers pjsip show identifiers List all registered endpoint identifiers N/A
pjsip show qualify aor pjsip show qualify aor <id> Show the PJSIP Aor current qualify options. N/A
pjsip show qualify endpoint pjsip show qualify endpoint <id> Show the current qualify options for all Aors on the PJSIP endpoint. N/A
pjsip show scheduled_tasks pjsip show scheduled_tasks [ like <pattern> ] Show scheduled pjsip tasks N/A
pjsip show settings pjsip show settings Show global and system configuration options N/A
pjsip show subscription {inbound|outbound} pjsip show subscription {inbound|outbound} N/A
pjsip show subscriptions {inbound|outbound} [like] pjsip show subscriptions {inbound|outbound} [like] The regex selects a subscriptions output that matches. N/A
pjsip show transport-monitors pjsip show transport-monitors [ like <pattern> ] Show pjsip transport monitors N/A
pjsip show version pjsip show version Show the version of pjproject that res_pjsip is running against N/A
presencestate change presencestate change <entity> <state>[,<subtype>[,message[,options]]] Change a custom presence to a new state. N/A
presencestate list presencestate list List all custom presence states that have been set by using the PRESENCE_STATE dialplan function. N/A
pri destroy span pri destroy span <span> Destroys D-channel of span and its B-channels. N/A
pri service disable channel pri service disable channel <chan num> [<interface id>] Send an AT&T / NFAS / CCS ANSI T1.607 maintenance message to remove a channel from service, with optional interface id a... N/A
pri service enable channel pri service enable channel <channel> [<interface id>] Send an AT&T / NFAS / CCS ANSI T1.607 maintenance message to restore a channel to service, with optional interface id as... N/A
pri set debug file pri set debug file [output-file] Sends PRI debug output to the specified output file N/A
pri set debug {on|off|hex|intense|0|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15} span pri set debug {<level>|on|off|hex|intense} span <span> Enables debugging on a given PRI span Level is a bitmap of the following values: 1 General debugging incl. N/A
pri show channels pri show channels Displays PRI channel information such as the current mapping of DAHDI B channels to Asterisk channel names and which cal... N/A
pri show debug pri show debug Show the debug state of pri spans N/A
pri show span pri show span <span> Displays PRI Information on a given PRI span N/A
pri show spans pri show spans Displays PRI span information N/A
pri show version pri show version Show libpri version information N/A
prometheus show metrics prometheus show metrics Displays the current metrics and their values, without counting as an actual scrape. N/A
prometheus show status prometheus show status Displays the status of metrics collection. N/A
queue add member queue add member <dial string> to <queue> [penalty <penalty> [as <membername> [state_interface <interface> [paused <reason>]]]] Add a dial string (Such as a channel,e.g. N/A
queue priority caller queue priority caller <channel> on <queue> to <priority> [immediate] Change the priority of a channel on a queue, optionally applying the change in relation to existing callers. N/A
queue reload {parameters|members|rules|all} queue reload {parameters|members|rules|all} [<queuenames>] Reload queues. N/A
queue remove member queue remove member <channel> from <queue> Remove a specific channel from a queue. N/A
queue reset stats queue reset stats [<queuenames>] Issuing this command will reset statistics for <queuenames>, or for all queues if no queue is specified. N/A
queue set penalty queue set penalty <penalty> on <interface> [in <queue>] Set a member's penalty in the queue specified. N/A
queue set ringinuse queue set ringinuse <yes/no> on <interface> [in <queue>] Set a member's ringinuse in the queue specified. N/A
queue show queue show Provides summary information on a specified queue. N/A
queue show rules queue show rules [rulename] Show the list of rules associated with rulename. N/A
queue {pause|unpause} member queue {pause|unpause} member <member> [queue <queue> [reason <reason>]] Pause or unpause a queue member. N/A
realtime destroy realtime destroy <family> <colmatch1> <valuematch1> [<colmatch2> <valuematch2> [... <colmatch5> <valuematch5>]] Remove a stored row using the RealTime driver. N/A
realtime load realtime load <family> <colmatch> <value> Prints out a list of variables using the RealTime driver. N/A
realtime mysql cache realtime mysql cache [<database> <table>] Shows table cache for the MySQL RealTime driver N/A
realtime mysql status realtime mysql status [<database>] Shows connection information for the MySQL RealTime driver N/A
realtime show ldap status realtime show ldap status Shows connection information for the LDAP RealTime driver N/A
realtime show pgsql cache realtime show pgsql cache [<table>] Shows table cache for the PostgreSQL RealTime driver N/A
realtime show pgsql status realtime show pgsql status Shows connection information for the PostgreSQL RealTime driver N/A
realtime store realtime store <family> <colname1> <value1> [<colname2> <value2> [... <colname5> <value5>]] Create a stored row using the RealTime driver. N/A
realtime update realtime update <family> <colmatch> <valuematch> <colupdate> <newvalue> Update a single variable using the RealTime driver. N/A
realtime update2 realtime update2 <family> <colmatch> <valuematch> [... <colmatch5> <valuematch5>] NULL <colupdate> <newvalue> Update a single variable, requiring one or more fields to match using the RealTime driver. N/A
remb set {send|receive} remb set {send|receive} <channel> <bitrate in bits> Set the REMB value which overwrites what we send or receive N/A
rtcp set debug {on|off|ip} rtcp set debug {on|off|ip host[:port]} Enable/Disable dumping of all RTCP packets. N/A
rtcp set stats {on|off} rtcp set stats {on|off} Enable/Disable dumping of RTCP stats. N/A
rtp drop rtp drop [stop|[<N> [random] incoming packets[ every <N> [random] {usec|msec|sec|min}][ on <ip[:port]>]] Drop RTP incoming packets. N/A
rtp set debug {on|off|ip} rtp set debug {on|off|ip host[:port]} Enable/Disable dumping of all RTP packets. N/A
rtp show settings rtp show settings Display RTP configuration settings N/A
say load [new|old] say load [new|old] N/A
skel show config skel show config List app_skel global config N/A
skel show games skel show games List app_skel active games N/A
skel show levels skel show levels List the app_skel levels N/A
sla show stations sla show stations This will list all stations defined in sla.conf N/A
sla show trunks sla show trunks This will list all trunks defined in sla.conf N/A
sorcery memory cache dump sorcery memory cache dump <name> Dump a list of the objects within the cache, listed by object identifier. N/A
sorcery memory cache expire sorcery memory cache expire <cache name> [object name] Expire a specific object or ALL objects within a sorcery memory cache. N/A
sorcery memory cache populate sorcery memory cache populate <cache name> Expire all objects in the cache and populate it with ALL objects from backend. N/A
sorcery memory cache show sorcery memory cache show <name> Show sorcery memory cache configuration and statistics. N/A
sorcery memory cache stale sorcery memory cache stale <cache name> [object name [reload]] Mark a specific object or ALL objects as stale in a sorcery memory cache. N/A
sorcery show settings sorcery show settings Show global configuration options N/A
ss7 mtp3 ss7 mtp3 <linkset> <slc> coo|coa|cbd|cba|eco|eca|tfp|tfa|lin|lun|lia|lua|lid|lfu <arg> Send a NET MNG message WARNING!!! N/A
ss7 reset cic ss7 reset cic <linkset> <dpc> <CIC> Send a RSC for the given CIC on the specified linkset N/A
ss7 reset group ss7 reset group <linkset> <dpc> <1st CIC> <range> Send a GRS for the given CIC range on the specified linkset N/A
ss7 restart mtp3 ss7 restart mtp3 <linkset> <slc> Restart link N/A
ss7 set debug {on|off} linkset ss7 set debug {on|off} linkset <linkset> Enables debugging on a given SS7 linkset N/A
ss7 show calls ss7 show calls <linkset> Show SS7 calls on the specified linkset N/A
ss7 show channels ss7 show channels Displays SS7 channel information at a glance. N/A
ss7 show cics ss7 show cics <linkset> [dpc] Shows the cics of an SS7 linkset. N/A
ss7 show linkset ss7 show linkset <span> Shows the status of an SS7 linkset. N/A
ss7 show version ss7 show version Show the libss7 version N/A
ss7 {block|unblock} cic ss7 {block|unblock} cic <linkset> <dpc> <CIC> Sends a remote {blocking|unblocking} request for the given CIC on the specified linkset N/A
ss7 {block|unblock} group ss7 {block|unblock} group <linkset> <dpc> <1st. CIC> <range> [H] Sends a remote {blocking|unblocking} request for CIC range on the specified linkset N/A
ss7 {reset|block|unblock} linkset ss7 {reset|block|unblock} linkset <linkset number> Sends a remote {reset|blocking|unblocking} request for all CICs on the given linkset N/A
stasis show topic stasis show topic <name> Show stasis topic detail info. N/A
stasis show topics stasis show topics Shows a list of topics N/A
stasis statistics show messages stasis statistics show messages Shows a list of message types and their general statistics N/A
stasis statistics show subscription stasis statistics show subscription <uniqueid> Show stasis subscription statistics. N/A
stasis statistics show subscriptions stasis statistics show subscriptions Shows a list of subscriptions and their general statistics N/A
stasis statistics show topic stasis statistics show topic <name> Show stasis topic statistics. N/A
stasis statistics show topics stasis statistics show topics Shows a list of topics and their general statistics N/A
stir_shaken show attestation stir_shaken show attestation Show the stir/shaken attestation settings N/A
stir_shaken show eprofile stir_shaken show eprofile <id> Show the stir/shaken eprofile settings for a given id N/A
stir_shaken show eprofiles stir_shaken show eprofiles Show all eprofiles for stir/shaken N/A
stir_shaken show profile stir_shaken show profile <id> Show the stir/shaken profile settings for a given id N/A
stir_shaken show profiles stir_shaken show profiles Show all profiles for stir/shaken N/A
stir_shaken show tn stir_shaken show tn <id> Show the settings for a given TN N/A
stir_shaken show tns stir_shaken show tns Show all attestation TNs N/A
stir_shaken show verification stir_shaken show verification Show the stir/shaken verification settings N/A
stir_shaken verify certificate_file stir_shaken verify certificate_file <certificate_file> [ <profile> ] Verify an external certificate file against the global or profile verification store N/A
stun set debug {on|off} stun set debug {on|off} Enable/Disable STUN (Simple Traversal of UDP through NATs) debugging N/A
stun show status stun show status List all known STUN servers and statuses. N/A
test execute test execute can be used in several ways. N/A
test generate results 'test generate results' Generates test results in either xml or txt format. N/A
test show registered 'test show registered' can be used in three ways. N/A
test show results test show results can be used in three ways 1. N/A
threadstorage show allocations threadstorage show allocations [<file>] Dumps a list of all thread-specific memory allocations, optionally limited to those from a specific file N/A
threadstorage show summary threadstorage show summary [<file>] Summarizes thread-specific memory allocations by file, or optionally by function, if a file is specified N/A
timing test timing test <rate> Test a timer with a specified rate, 50/sec by default. N/A
transcoder show transcoder show Displays channel utilization of DAHDI transcoder(s). N/A
udptl set debug {on|off|ip} udptl set debug {on|off|ip host[:port]} Enable or disable dumping of UDPTL packets. N/A
udptl show config udptl show config Display UDPTL configuration options N/A
ulimit ulimit {data|limit|file|memory|stack|time|processes|virtual|core|descriptors} [<num>] Shows or sets the corresponding resource limit. N/A
unistim reload unistim reload Reloads UNISTIM configuration from unistim.conf N/A
unistim send packet unistim send packet USTM/line@name hexa unistim send packet USTM/1000@hans 19040004 N/A
unistim set debug {on|off} unistim set debug Display debug messages. N/A
unistim show devices unistim show devices Lists all known Unistim devices. N/A
unistim show info unistim show info Dump internal structures. N/A
voicemail forward voicemail forward <from_mailbox> <from_context> <from_folder> <messageid> <to_mailbox> <to_context> <to_folder> Forward message <messageid> in mailbox <mailbox>@<context> <from_folder> to mailbox <mailbox>@<context> <to_folder> N/A
voicemail move voicemail move <mailbox> <context> <from_folder> <messageid> <to_folder> Move message <messageid> in mailbox <mailbox>&<context> from <from_folder> to <to_folder> N/A
voicemail reload voicemail reload Reload voicemail configuration N/A
voicemail remove voicemail remove <mailbox> <context> <from_folder> <messageid> Remove message <messageid> from <from_folder> in mailbox <mailbox>@<context> N/A
voicemail show aliases voicemail show aliases Lists mailbox aliases N/A
voicemail show mailbox voicemail show mailbox <mailbox> <context> Show contents of mailbox <mailbox>@<context> N/A
voicemail show users [for] voicemail show users [for <context>] Lists all mailboxes currently set up N/A
voicemail show zones voicemail show zones Lists zone message formats N/A
xmldoc dump xmldoc dump <filename> Dump XML documentation to a file N/A
xmldoc reload xmldoc reload Reload XML documentation N/A
xmpp create collection xmpp create collection <connection> <collection> Creates a PubSub collection node using the account as configured in xmpp.conf. N/A
xmpp create leaf xmpp create leaf <connection> <collection> <leaf> Creates a PubSub leaf node using the account as configured in xmpp.conf. N/A
xmpp delete node xmpp delete node <connection> <node> Deletes a node on PubSub server as configured in xmpp.conf. N/A
xmpp list nodes xmpp list nodes <connection> [collection] Lists the user's nodes on the respective connection ([connection] as configured in xmpp.conf.) N/A
xmpp purge nodes xmpp purge nodes <connection> <node> Purges nodes on PubSub server as configured in xmpp.conf. N/A
xmpp set debug {on|off} xmpp set debug {on|off} Enables/disables dumping of XMPP/Jabber packets for debugging purposes. N/A
xmpp show buddies xmpp show buddies Shows buddy lists of our clients N/A
xmpp show connections xmpp show connections Shows state of client and component connections N/A