CLI Commander
From Taridium
The CLI commander is available as of ipbx v.2.1
Contents |
Overview
The CLI commander provides access to the Asterisk (core telephony application) CLI through the web interface. It provides a subset of commands and is intended for advanced users. As with all CLI interactions, certain commands can cause the interruption of ongoing calls.
Using the CLI commander
Command completion is available via the TAB button on Firefox, Opera, Safari and Chrome browsers for the commands outlined below. The last five commands can be easily repeated by using the blinds at the top of the window.
Available CLI Commands
Command Summary for Asterisk 1.4
abort halt Cancel a running halt agent logoff Sets an agent offline agent show Show status of agents agent show online Show all online agents agi debug Enable AGI debugging agi debug off Disable AGI debugging agi dumphtml Dumps a list of agi commands in html format agi show List AGI commands or specific help cdr mysql status Show connection status of cdr_mysql cdr status Display the CDR status core clear profile Clear profiling info core set debug channel Enable/disable debugging on a channel core set debug Set level of debug chattiness core set debug off Turns off debug chattiness core set global Set global dialplan variable core set verbose Set level of verboseness core show applications Shows registered dialplan applications core show application Describe a specific dialplan application core show audio codecs Displays a list of audio codecs core show channels 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 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 List versions of files used to build Asterisk core show functions Shows registered dialplan functions core show function Describe a specific dialplan function core show globals Show global dialplan variables core show hints Show dialplan hints core show image codecs Displays a list of image codecs 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 switches Show alternative switches core show threads Show running threads core show translation Display translation matrix core show uptime Show uptime information core show version Display version info core show video codecs Displays a list of video codecs core show warranty Show the warranty (if any) for this copy of Asterisk dahdi destroy channel Destroy a channel dahdi restart Fully restart DAHDI channels dahdi show cadences List cadences dahdi show channels Show active DAHDI channels dahdi show channel Show information on a channel dahdi show status Show all DAHDI cards status 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 add extension Add new extension into context dialplan add ignorepat Add new ignore pattern dialplan add include Include context in other context 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 Remove a specified include from context dialplan show Show dialplan dnsmgr refresh Performs an immediate refresh dnsmgr reload Reloads the DNS manager configuration dnsmgr status Display the DNS manager status dundi debug Enable DUNDi debugging dundi flush Flush DUNDi cache dundi lookup Lookup a number in DUNDi dundi no debug Disable DUNDi debugging dundi no store history Disable DUNDi historic records dundi precache Precache a number in DUNDi dundi query Query a DUNDi EID dundi show entityid Display Global Entity ID dundi show mappings Show DUNDi mappings dundi show peers Show defined DUNDi peers dundi show peer Show info on a specific DUNDi peer dundi show precache Show DUNDi precache dundi show requests Show DUNDi requests dundi show trans Show active DUNDi transactions dundi store history Enable DUNDi historic records feature show Lists configured features file convert Convert audio file group show channels Display active channels with group(s) help Display help list, or specific help on a command http show status Display HTTP server status iax2 provision Provision an IAX device iax2 prune realtime Prune a cached realtime lookup iax2 reload Reload IAX configuration iax2 set debug Enable IAX debugging iax2 set debug jb Enable IAX jitterbuffer debugging iax2 set debug jb off Disable IAX jitterbuffer debugging iax2 set debug off Disable IAX debugging iax2 set debug trunk Enable IAX trunk debugging iax2 set debug trunk off Disable IAX trunk debugging iax2 show cache Display IAX cached dialplan iax2 show channels List active IAX channels iax2 show firmware List available IAX firmwares iax2 show netstats List active IAX channel netstats iax2 show peers List defined IAX peers iax2 show peer 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 List defined IAX users iax2 test losspct Set IAX2 incoming frame loss percentage 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 show channels List configured log channels 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 meetme Execute a command on a conference or conferee mixmonitor Execute a MixMonitor command. module load Load a module by name module reload Reload configuration module show List modules and info module show like List modules and info module unload Unload a module by name moh reload Music On Hold moh show classes List MOH classes moh show files List MOH file-based classes no debug channel originate Originate a call pri debug span Enables PRI debugging on a span pri intense debug span Enables REALLY INTENSE PRI debugging pri no debug span Disables 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 version of libpri pri unset debug file Ends PRI debug output to file queue add member Add a channel to a specified queue queue remove member Removes a channel from a specified queue queue show Show status of a specified queue realtime load Used to print out RealTime variables. realtime mysql status Shows connection information for the MySQL RealTime driver realtime update Used to update RealTime variables. restart gracefully Restart Asterisk gracefully restart now Restart Asterisk immediately restart when convenient Restart Asterisk at empty call volume rtcp debug ip Enable RTCP debugging on IP rtcp debug Enable RTCP debugging rtcp debug off Disable RTCP debugging rtcp stats Enable RTCP stats rtcp stats off Disable RTCP stats rtp debug ip Enable RTP debugging on IP rtp debug Enable RTP debugging rtp debug off Disable RTP debugging say load set/show the say mode show parkedcalls Lists parked calls show queues sip history Enable SIP history sip history off Disable SIP history sip notify Send a notify packet to a SIP peer sip prune realtime Prune cached Realtime object(s) sip prune realtime peer Prune cached Realtime peer(s) sip prune realtime user Prune cached Realtime user(s) sip reload Reload SIP configuration sip set debug Enable SIP debugging sip set debug ip Enable SIP debugging on IP sip set debug off Disable SIP debugging sip set debug peer Enable SIP debugging on Peername sip show channels List 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 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 settings Show SIP global settings sip show subscriptions List active SIP subscriptions sip show users List defined SIP users sip show user Show details on specific SIP user skinny reset Reset Skinny device(s) skinny set debug Enable Skinny debugging skinny set debug off Disable Skinny debugging skinny show devices List defined Skinny devices skinny show lines List defined Skinny lines per device sla show stations Show SLA Stations sla show trunks Show SLA Trunks soft hangup Request a hangup on a given channel stop gracefully Gracefully shut down Asterisk stop now Shut down Asterisk immediately stop when convenient Shut down Asterisk at empty call volume stun debug Enable STUN debugging stun debug off Disable STUN debugging transcoder show Display DAHDI transcoder utilization. udptl debug Enable UDPTL debugging udptl debug ip Enable UDPTL debugging on IP udptl debug off Disable UDPTL debugging voicemail show users List defined voicemail boxes voicemail show zones List zone message formats
Command Summary for Asterisk 1.6
ael reload Reload AEL configuration ael set debug {read|tokens|mac Enable AEL debugging flags agent logoff Sets an agent offline agent show Show status of agents agent show online Show all online agents 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 List AGI commands or specific help cdr mysql status Show connection status of cdr_mysql cdr show status Display the CDR status core abort shutdown Cancel a running shutdown core clear profile Clear profiling info core restart gracefully Restart Asterisk gracefully core restart now Restart Asterisk immediately core restart when convenient Restart Asterisk at empty call volume core set chanvar Set a channel variable core set debug channel Enable/disable debugging on a channel core set {debug|verbose} [off| Set level of debug/verbose chattiness core set global Set global dialplan variable 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 globals Show global dialplan variables 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 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 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 [trunkgrou 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 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 devstate change Change a custom device state devstate list List currently known custom device states dialplan add extension Add new extension into context dialplan add ignorepat Add new ignore pattern dialplan add include Include context in other context 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 Remove a specified include from context dialplan save Save dialplan dialplan set extenpatternmatch Use the Old extension pattern matching algorithm. dialplan set extenpatternmatch Use the New extension pattern matching algorithm. dialplan show Show dialplan dnsmgr refresh Performs an immediate refresh dnsmgr reload Reloads the DNS manager configuration dnsmgr status Display the DNS manager status dundi flush [stats] Flush DUNDi cache dundi lookup Lookup a number in DUNDi dundi precache Precache a number in DUNDi dundi query Query a DUNDi EID dundi set debug {on|off} Enable/Disable DUNDi debugging dundi show entityid Display Global Entity ID dundi show mappings Show DUNDi mappings dundi show peers [registered|i Show defined DUNDi peers dundi show peer Show info on a specific DUNDi peer dundi show precache Show DUNDi precache dundi show requests Show DUNDi requests dundi show trans Show active DUNDi transactions dundi store history {on|off} Enable/Disable DUNDi historic records features reload Reloads configured features features show Lists configured features file convert Convert audio file group show channels Display active channels with group(s) help Display help list, or specific help on a command http show status Display HTTP server status iax2 provision Provision an IAX device iax2 prune realtime Prune a cached realtime lookup iax2 reload Reload IAX configuration iax2 set debug {on|off} 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 peer Show details on specific IAX peer iax2 show peers List defined IAX peers 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 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 show channels List configured log channels manager debug [on|off] Show, enable, disable debugging of the manager code manager reload Reload manager configurations 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 meetme Execute a command on a conference or conferee mgcp audit endpoint 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) originate Originate a call parkedcalls show List currently parked calls phoneprov show routes Show registered phoneprov http routes pri debug span Enables PRI debugging on a span pri intensive debug span Enables REALLY INTENSE PRI debugging pri no debug span Disables 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 unset debug file Ends PRI debug output to file queue add member Add a channel to a specified queue queue remove member Removes a channel from a specified queue queue rules reload Reload the rules defined in queuerules.conf queue rules show Show the rules defined in queuerules.conf 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 realtime load Used to print out RealTime variables. realtime mysql status Shows connection information for the MySQL RealTime driver realtime update Used to update RealTime variables. 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 sip notify Send a notify packet to a SIP peer sip prune realtime [peer|user| Prune cached Realtime users/peers 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|subscriptio List active SIP channels/subscriptions 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 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 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 skinny reset Reset Skinny device(s) skinny set debug {on|off} Enable/Disable Skinny debugging skinny show devices List defined Skinny devices skinny show device List Skinny device information skinny show lines List defined Skinny lines per device skinny show line List Skinny line information skinny show settings List global Skinny settings sla show stations Show SLA Stations sla show trunks Show SLA Trunks soft hangup Request a hangup on a given channel stun set debug {on|off} Enable/Disable STUN debugging 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