Server Online Help Information
There is online help available through PBX in a Flash server. Two important sources of information is the Linux command line and the Asterisk PBX command line.
Linux Command Line Help
If you type help at the Linux command line, you will get all sorts of interesting information. Unfortunately, it is only useful if you want to create command line macros or scripts. The help that is of importance to the Asterisk administrator is found using the help-pbx command. At the Linux prompt, type help-pbx:
root@pbx:~ $ help-pbx ******************************************************************************** * PBX in a Flash Help Menu Date 121107 Version 1.2.0 Page 1 * ******************************************************************************** * Command * Description * ******************************************************************************** * config * Set the local time zone and keyboard type * * netconfig * Configure ethernet interface * * install-netconfig * Reinstalls netconfig which is deleted by Centos 5.1 * * passwd-master * Fixes fpbx/webmin and sets passwds maint/amp/meetme * * passwd-maint * Set password for maint - web GUI * * passwd-amp * Set password for wwwadmin * * passwd-meetme * Set password for Web MeetMe * * passwd * Set root password for console login * * install-ZAPHFC * Install ISDN/RDSI - QuadBRI DuoBRI(edit file)& HFC * * enable-iptables * Turn on IPTABLES (You need to configure it!) * * disable-iptables * Turns off IPTABLES (for Freepbx problems) * * genzaptelconf * Auto-configure Zaptel cards * * asterisk -vr * Asterisk CLI * ******************************************************************************** * Tap the ENTER key for the next page or Ctrl-C to exit * ******************************************************************************** ******************************************************************************** * PBX in a Flash Help Menu Date 121107 Version 1.2.0 Page 2 * ******************************************************************************** * Command * Description * ******************************************************************************** * setup-aastra * Create a aastra.cfg in /tftpboot * * setup-cisco * Create a SIPDefault.cnf in /tftpboot * * setup-grandstream * Setup for autoconfiguration of Grandstream * * setup-linksys * Create Linksys default files in /tftpboot * * setup-polycom * Create Polycom default files in /tftpboot * * setup-mail * Configure sendmail * * setup-tftp * Install and set up tftp server * * setup-samba * Setup samba windows <> linux file sharing * * install-a2billing * Set-up A2Billing <> VoIP & TDM billing platform * * update-source * Updates all of the digium source * * update-scripts * Updates this screen and installs the latest scripts * * update-fixes * This fixes minor problems with PIAF until next ver * ******************************************************************************** root@pbx:~ $
Asterisk CLI Help
The Asterisk CLI help has a lot of useful information, unfortunately, when you run the help command, the information scrolls so fast you can't read it. If you use Putty for connecting to your Asterisk PBX from a remote WinXP client, you would be able to scroll backwards. To view the help information, type help at the Asterisk CLI:
pbx*CLI> help ! Execute a shell command abort halt Cancel a running halt ael debug contexts Enable AEL contexts debug (does nothing) ael debug macros Enable AEL macros debug (does nothing) ael debug read Enable AEL read debug (does nothing) ael debug tokens Enable AEL tokens debug (does nothing) ael nodebug Disable AEL debug messages ael reload Reload AEL configuration 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 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 reload Reloads the DNS manager configuration dnsmgr status Display the DNS manager status 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 mgcp audit endpoint Audit specified MGCP endpoint mgcp reload Reload MGCP configuration mgcp set debug Enable MGCP debugging mgcp set debug off Disable MGCP debugging mgcp show endpoints List defined MGCP endpoints 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 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 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 Zaptel 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 zap destroy channel Destroy a channel zap restart Fully restart zaptel channels zap show cadences List cadences zap show channels Show active zapata channels zap show channel Show information on a channel zap show status Show all Zaptel cards status
