Asterisk CLI 1.6

The Asterisk command line interface (CLI) is reached by using the Linux shell command
asterisk -r

If you want debugging output, add one or many v_:s
asterisk -vvvvvr

The Asterisk server has to be running in the background for the CLI to start.

If you want to run a CLI command in a shell script, use the x option

asterisk -rx “logger reload”

For help in the CLI mode, use the core show help {command} command. To get help on various applications you can use in the extensions.conf config file, use the show applications command.

This list current as of build 1.6.2.19

General/Misc Commands

• !<command>: Execute a shell command
• ael reload: Reload AEL configuration
• ael set debug {read|tokens|mac}: Enable AEL debugging flags
• agi dump html: Dumps a list of AGI commands in HTML format
• agi exec: Add AGI command to a channel in Async AGI
• agi set debug {on|off}: Enable/Disable AGI debugging
• agi show commands {topic}: List AGI commands or specific help
• cdr show status: Display the CDR status
• channel originate: Originate a call
• channel redirect: Redirect a call
• channel request hangup: Request a hangup on a given channel
• cli check permissions: Try a permissions config for a user
• cli reload permissions: Reload CLI permissions config
• cli show aliases: Show CLI command aliases
• cli show permissions: Show CLI permissions
• config list: Show all files that have loaded a configuration file
• config reload: Force a reload on modules using a particular configuration file
• devstate change: Change a custom device state
• devstate list: List currently known custom device states
• dnsmgr refresh: Performs an immediate refresh
• dnsmgr reload: Reloads the DNS manager configuration
• dnsmgr status: Display the DNS manager status
• event dump cache: Dump the internal event cache (for debugging)
• features reload: Reloads configured features
• features show: Lists configured features
• file convert: Convert audio file
• group show channels: Display active channels with group(s)
• http show status: Display HTTP server status
• indication add: Add the given indication to the country
• indication remove: Remove the given indication from the country
• indication show: Display a list of all countries/indications
• keys init: Initialize RSA key passcodes
• keys show: Displays RSA key information
• local show channels: List status of local channels
• logger mute: Toggle logging output to a console
• logger reload: Reopens the log files
• logger rotate: Rotates and reopens the log files
• logger set level {DEBUG|NOTICE}: Enables/Disables a specific logging level for this console
• logger show channels: List configured log channels
• meetme {lock|unlock|mute|unmute}: Execute a command on a conference or conferee
• meetme list {concise}: List all or one conference
• mfcr2 call files {on|off}: Enable/Disable MFC/R2 call files
• mfcr2 set blocked: Reset MFC/R2 channel forcing it to BLOCKED
• mfcr2 set debug: Set MFC/R2 channel logging level
• mfcr2 set idle: Reset MFC/R2 channel forcing it to IDLE
• mfcr2 show channels {group|con}: Show MFC/R2 channels
• mfcr2 show variants: Show supported MFC/R2 variants
• mfcr2 show versions: Show OpenR2 library version
• mgcp audit endpoints: Audit specified MGCP endpoint
• mgcp reload: Reload MGCP configuration
• mgcp set debug {on|off}: Enable/Disable MGCP debugging
• mgcp show endpoints: List defined MGCP endpoints
• minivm list accounts: List defined mini-voicemail boxes
• minivm list templates: List message templates
• minivm list zones: List zone message formats
• minivm reload: Reload Mini-voicemail configuration
• minivm show settings: Show mini-voicemail general settings
• minivm show stats: Show some mini-voicemail statistics
• mixmonitor {start|stop}: Execute a MixMonitor command
• module load: Load a module by name
• module reload: Reload configuration
• module show {like}: List modules and info
• module unload: Unload a module by name
• moh reload: Reload MusicOnHold
• moh show classes: List MusicOnHold classes
• moh show files: List MusicOnHold file-based classes
• no debug channel: Disable debugging on channel(s)
• parkedcalls show: List currently parked calls
• phoneprov show routes: Show registered phoneprov http routes
• realtime destroy: Delete a row from a RealTime database
• realtime load: Used to print out RealTime variables.
• realtime store: Store a new row into a RealTime database
• realtime update: Used to update RealTime variables.
• realtime update2: Used to test the RealTime update2 method
• rtcp set debug {on|off|ip}: Enable/Disable RTCP debugging
• rtcp set stats {on|off}: Enable/Disable RTCP stats
• rtp set debug {on|off|ip}: Enable/Disable RTP debugging
• say load {new|old}: Set or show the say mode
• sla show stations: Show SLA Stations
• sla show trunks: Show SLA Trunks
• ss7 block cic: Blocks the given CIC
• ss7 block linkset: Blocks all CICs on a linkset
• ss7 set debug {on|off} linkset: Enables SS7 debugging on a linkset
• ss7 show linkset: Shows the status of a linkset
• ss7 show version: Displays libss7 version
• ss7 unblock cic: Unblocks the given CIC
• ss7 unblock linkset: Unblocks all CICs on a linkset
• stun set debug {on|off}: Enable/Disable STUN debugging
• timing test: Run a timing test
• transcoder show: Display DAHDI transcoder utilization.
• udptl set debug {on|off|ip}: Enable/Disable UDPTL debugging
• ulimit: Set or show process resource limits
• voicemail reload: Reload voicemail configuration
• voicemail show users: List defined voicemail boxes
• voicemail show zones: List zone message formats

Core Commands

• core abort shutdown: Cancel a running shutdown
• core clear profile: Clear profiling info
• core ping taskprocessor: Ping a named task processor
• core restart gracefully: Restart Asterisk gracefully
• core restart now: Restart Asterisk immediately
• core restart when convenient: Restart Asterisk at empty call volume
• core set debug channel: Enable/disable debugging on a channel
• core set {debug|verbose}: Set level of debug/verbose chattiness
• core show applications {like|d}: Shows registered dialplan applications
• core show application: Describe a specific dialplan application
• core show calls {uptime}: Display information on calls
• core show channels {concise|ve: Display information on channels
• core show channel: Display information on a specific channel
• core show channeltypes: List available channel types
• core show channeltype: Give more details on that channel type
• core show codecs {audio|video|: Displays a list of codecs
• core show codec: Shows a specific codec
• core show config mappings: Display config mappings (file names to config engines)
• core show file formats: Displays file formats
• core show file version {like}: List versions of files used to build Asterisk
• core show functions {like}: Shows registered dialplan functions
• core show function: Describe a specific dialplan function
• core show help: Display help list, or specific help on a command
• core show hints: Show dialplan hints
• core show hint: Show dialplan hint
• core show image formats: Displays image formats
• core show license: Show the license(s) for this copy of Asterisk
• core show profile: Display profiling info
• core show settings: Show some core settings
• core show switches: Show alternative switches
• core show sysinfo: Show System Information
• core show taskprocessors: List instantiated task processors and statistics
• core show threads: Show running threads
• core show translation {recalc}: Display translation matrix
• core show uptime {seconds}: Show uptime information
• core show version: Display version info
• core show warranty: Show the warranty (if any) for this copy of Asterisk
• core stop gracefully: Gracefully shut down Asterisk
• core stop now: Shut down Asterisk immediately
• core stop when convenient: Shut down Asterisk at empty call volume
• core waitfullybooted: Wait for Asterisk to be fully booted

dahdi Commands

• dahdi destroy channel: Destroy a channel
• dahdi restart: Fully restart DAHDI channels
• dahdi set dnd: Sets/resets DND (Do Not Disturb) mode on a channel
• dahdi set hwgain: Set hardware gain on a channel
• dahdi set swgain: Set software gain on a channel
• dahdi show cadences: List cadences
• dahdi show channels {trunkgroup}: Show active DAHDI channels
• dahdi show channel: Show information on a channel
• dahdi show status: Show all DAHDI cards status
• dahdi show version: Show the DAHDI version in use

Database 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

Dialplan Commands

• dialplan add extension: Add new extension into context
• dialplan add ignorepat: Add new ignore pattern
• dialplan add include: Include context in other context
• dialplan debug: Show fast extension pattern matching data structures
• dialplan reload: Reload extensions and *only* extensions
• dialplan remove extension: Remove a specified extension
• dialplan remove ignorepat: Remove ignore pattern from context
• dialplan remove include R: Remove a specified include from context
• dialplan set chanvar: Set a channel variable
• dialplan set extenpatternmatch: Use the Old extension pattern matching algorithm.
• dialplan set extenpatternmatch: Use the New extension pattern matching algorithm.
• dialplan set global: Set global dialplan variable
• dialplan show chanvar: Show channel variables
• dialplan show globals: Show global dialplan variables
• dialplan show: Show dialplan

Fax Commands

• fax set debug {on|off}: Enable/Disable FAX debugging on new FAX sessions
• fax set g711cap {on|off}: Enable/Disable G.711 session capture
• fax set t38cap {on|off}: Enable/Disable T.38 session capture
• fax show capabilities: Show the capabilities of the registered FAX technology modules
• fax show hostid: Display the Fax Host-ID
• fax show licenses: Show number of Fax licenses
• fax show session: Show the status of the named FAX sessions
• fax show sessions: Show the current FAX sessions
• fax show settings: Show the global settings and defaults of both the FAX core and technology modules
• fax show stats: Summarize FAX session history
• fax show version: Show versions of FAX For Asterisk components

IAX2 Commands

• iax2 provision: Provision an IAX device
• iax2 prune realtime: Prune a cached realtime lookup
• iax2 reload: Reload IAX configuration
• iax2 set debug {on|off|peer}: Enable/Disable IAX debugging
• iax2 set debug jb {on|off}: Enable/Disable IAX jitterbuffer debugging
• iax2 set debug trunk {on|off}: Enable/Disable IAX trunk debugging
• iax2 set mtu: Set the IAX systemwide trunking MTU
• iax2 show cache: Display IAX cached dialplan
• iax2 show callnumber usage: Show current entries in IP call number limit table
• iax2 show channels: List active IAX channels
• iax2 show firmware: List available IAX firmware
• iax2 show netstats: List active IAX channel netstats
• iax2 show peers {like}: Show details on specific IAX peer
• iax2 show provisioning: Display iax provisioning
• iax2 show registry: Display IAX registration status
• iax2 show stats: Display IAX statistics
• iax2 show threads: Display IAX helper thread info
• iax2 show users {like}: List defined IAX users
• iax2 test losspct: Set IAX2 incoming frame loss percentage
• iax2 unregister: Unregister (force expiration) an IAX2 peer from the registry

SIP Commands

• sip notify: Send a notify packet to a SIP peer
• sip prune realtime {peer|all}: Prune cached Realtime users/peers
• sip qualify peer: Send an OPTIONS packet to a peer
• sip reload: Reload SIP configuration
• sip set debug {on|off|ip|peer}: Enable/Disable SIP debugging
• sip set history {on|off}: Enable/Disable SIP history
• sip show {channels|subscription}: List active SIP channels or subscriptions
• sip show channelstats: List statistics for active SIP channels
• sip show channel: Show detailed SIP channel info
• sip show domains: List our local SIP domains
• sip show history: Show SIP dialog history
• sip show inuse: List all inuse/limits
• sip show mwi: Show MWI subscriptions
• sip show objects: List all SIP object allocations
• sip show peers: List defined SIP peers
• sip show peer: Show details on specific SIP peer
• sip show registry: List SIP registration status
• sip show sched: Present a report on the status of the sched queue
• sip show settings: Show SIP global settings
• sip show tcp: List TCP Connections
• sip show users: List defined SIP users
• sip show user: Show details on specific SIP user
• sip unregister: Unregister (force expiration) a SIP peer from the registry

PRI Commands

• pri set debug {on|off|0|1|2} s: Enables PRI debugging on a span
• pri set debug file: Sends PRI debug output to the specified file
• pri show debug: Displays current PRI debug settings
• pri show spans: Displays PRI Information
• pri show span: Displays PRI Information
• pri show version: Displays libpri version

Manager Commands

• manager reload: Reload manager configurations
• manager set debug {on|off}: Show, enable, disable debugging of the manager code
• manager show command: Show a manager interface command
• manager show commands: List manager interface commands
• manager show connected: List connected manager interface users
• manager show eventq: List manager interface queued events
• manager show users: List configured manager users
• manager show user: Display information on a specific manager user

Queue Commands

• queue add member: Add a channel to a specified queue
• queue reload {parameters|member: Reload queues, members, queue rules, or parameters
• queue remove member: Removes a channel from a specified queue
• queue reset stats: Reset statistics for a queue
• queue set penalty: Set penalty for a channel of a specified queue
• queue show: Show status of a specified queue
• queue {pause|unpause} member: Pause or unpause a queue member
• queue show rules: Show the rules defined in queuerules.conf