{"id":822,"date":"2024-01-27T21:10:54","date_gmt":"2024-01-27T20:10:54","guid":{"rendered":"https:\/\/www.homeserver.lu\/?p=822"},"modified":"2024-01-27T21:10:54","modified_gmt":"2024-01-27T20:10:54","slug":"asterisk-commands","status":"publish","type":"post","link":"https:\/\/www.homeserver.lu\/?p=822","title":{"rendered":"Asterisk commands"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\">Asterisk command line tool<\/h2>\n\n\n\n<p>In a SSH shell, enter the asterisk command line by:<\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-bash\" data-lang=\"Bash\"><code>asterisk -rvvv<\/code><\/pre><\/div>\n\n\n\n<p>All SIP Trunk commands at a glance:<\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-plain\"><code>freepbx*CLI&gt; core show help\n!                              -- Execute a shell command\nacl show                       -- Show a named ACL or list all named ACLs\naeap show client               -- Show AEAP client configuration by id\naeap show clients              -- Show all AEAP client configurations\nael reload                     -- Reload AEL configuration\nael set debug {read|tokens|macros|contexts|off} -- Enable AEL debugging flags\nagi dump html                  -- Dumps a list of AGI commands in HTML format\nagi exec                       -- Add AGI command to a channel in Async AGI\nagi set debug [on|off]         -- Enable\/Disable AGI debugging\nagi show commands [topic]      -- List AGI commands or specific help\naoc set debug                  -- enable cli debugging of AOC messages\nari mkpasswd                   -- Encrypts a password\nari set debug                  -- Enable\/disable debugging of an ARI application\nari show apps                  -- List registered ARI applications\nari show app                   -- Display details of a registered ARI application\nari show status                -- Show ARI settings\nari show users                 -- List ARI users\nari show user                  -- List single ARI user\nbridge kick                    -- Kick a channel from a bridge\nbridge show all                -- List all bridges\nbridge show                    -- Show information about a bridge\nbridge technology show         -- List registered bridge technologies\nbridge technology {suspend|unsuspend} -- Suspend\/unsuspend a bridge technology\ncc cancel [core|all]           -- Kill a CC transaction\ncc report status               -- Reports CC stats\ncdr set debug [on|off]         -- Enable debugging in the CDR engine\ncdr show active                -- Display active CDRs for channels\ncdr show status                -- Display the CDR status\ncdr submit                     -- Posts all pending batched CDR data\ncel show status                -- Display the CEL status\nchannel originate              -- Originate a call\nchannel redirect               -- Redirect a call\nchannel request hangup         -- Request a hangup on a given channel\ncli check permissions          -- Try a permissions config for a user\ncli reload permissions         -- Reload CLI permissions config\ncli show permissions           -- Show CLI permissions\nconfbridge kick                -- Kick participants out of conference bridges.\nconfbridge list                -- List conference bridges and participants.\nconfbridge lock                -- Lock a conference.\nconfbridge mute                -- Mute participants.\nconfbridge record start        -- Start recording a conference\nconfbridge record stop         -- Stop recording a conference.\nconfbridge show menu           -- Show a conference menu\nconfbridge show menus          -- Show a list of conference menus\nconfbridge show profile bridge -- Show a conference bridge profile.\nconfbridge show profile bridges -- Show a list of conference bridge profiles.\nconfbridge show profile user   -- Show a conference user profile.\nconfbridge show profile users  -- Show a list of conference user profiles.\nconfbridge unlock              -- Unlock a conference.\nconfbridge unmute              -- Unmute participants.\nconfig list                    -- Show all files that have loaded a configuration file\nconfig reload                  -- Force a reload on modules using a particular configuration file\nconfig show help               -- Show configuration help for a module\ncore abort shutdown            -- Cancel a running shutdown\ncore clear profile             -- Clear profiling info\ncore ping taskprocessor        -- Ping a named task processor\ncore reload                    -- Global reload\ncore reset taskprocessor       -- Reset a named task processor&#39;s stats\ncore reset taskprocessors      -- Reset all task processors&#39; stats\ncore restart gracefully        -- Restart Asterisk gracefully\ncore restart now               -- Restart Asterisk immediately\ncore restart when convenient   -- Restart Asterisk at empty call volume\ncore set debug category        -- Enable\/disable debugging categories\ncore set debug                 -- Set level of debug chattiness\ncore set debug channel         -- Enable\/disable debugging on a channel\ncore set trace                 -- Set level of trace chattiness\ncore set verbose               -- Set level of verbose chattiness\ncore show applications [like|describing] -- Shows registered dialplan applications\ncore show application          -- Describe a specific dialplan application\ncore show calls [uptime]       -- Display information on calls\ncore show channels [concise|verbose|count] -- Display information on channels\ncore show channeltypes         -- List available channel types\ncore show channeltype          -- Give more details on that channel type\ncore show channel              -- Display information on a specific channel\ncore show codecs [audio|video|image|text] -- Displays a list of registered codecs\ncore show codec                -- Shows a specific codec\ncore show config mappings      -- Display config mappings (file names to config engines)\ncore show file formats         -- Displays file formats\ncore show functions [like]     -- Shows registered dialplan functions\ncore show function             -- Describe a specific dialplan function\ncore show hanguphandlers all   -- Show hangup handlers of all channels\ncore show hanguphandlers       -- Show hangup handlers of a specified channel\ncore show help                 -- Display help list, or specific help on a command\ncore show hints                -- Show dialplan hints\ncore show hint                 -- Show dialplan hint\ncore show image formats        -- Displays image formats\ncore show license              -- Show the license(s) for this copy of Asterisk\ncore show profile              -- Display profiling info\ncore show settings             -- Show some core settings\ncore show sounds               -- Shows available sounds\ncore show sound                -- Shows details about a specific sound\ncore show switches             -- Show alternative switches\ncore show sysinfo              -- Show System Information\ncore show taskprocessor alerted subsystems -- List task processor subsystems in alert\ncore show taskprocessors [like] -- List instantiated task processors and statistics\ncore show threads              -- Show running threads\ncore show translation          -- Display translation matrix\ncore show uptime [seconds]     -- Show uptime information\ncore show version              -- Display version info\ncore show warranty             -- Show the warranty (if any) for this copy of Asterisk\ncore stop gracefully           -- Gracefully shut down Asterisk\ncore stop now                  -- Shut down Asterisk immediately\ncore stop when convenient      -- Shut down Asterisk at empty call volume\ncore waitfullybooted           -- Wait for Asterisk to be fully booted\ndahdi create channels          -- Create channels\ndahdi destroy channels         -- Destroy channels\ndahdi restart                  -- Fully restart DAHDI channels\ndahdi set dnd                  -- Sets\/resets DND (Do Not Disturb) mode on a channel\ndahdi set hwgain {rx|tx}       -- Set hardware gain on a channel\ndahdi set swgain {rx|tx}       -- Set software gain on a channel\ndahdi show cadences            -- List cadences\ndahdi show channels [group|context] -- Show active DAHDI channels\ndahdi show channel             -- Show information on a channel\ndahdi show status              -- Show all DAHDI cards status\ndahdi show version             -- Show the DAHDI version in use\ndatabase del                   -- Removes database key\/value\ndatabase deltree               -- Removes database keytree\/values\ndatabase get                   -- Gets database value\ndatabase put                   -- Adds\/updates database value\ndatabase query                 -- Run a user-specified query on the astdb\ndatabase show                  -- Shows database contents\ndatabase showkey               -- Shows database contents\ndevstate change                -- Change a custom device state\ndevstate list                  -- List currently known custom device states\ndialplan add extension         -- Add new extension into context\ndialplan add ignorepat         -- Add new ignore pattern\ndialplan add include           -- Include context in other context\ndialplan debug                 -- Show fast extension pattern matching data structures\ndialplan eval function         -- Evaluate dialplan function\ndialplan locks show            -- List func_lock locks.\ndialplan reload                -- Reload extensions and *only* extensions\ndialplan remove context        -- Remove a specified context\ndialplan remove extension      -- Remove a specified extension\ndialplan remove ignorepat      -- Remove ignore pattern from context\ndialplan remove include        -- Remove a specified include from context\ndialplan set chanvar           -- Set a channel variable\ndialplan set extenpatternmatchnew false -- Use the Old extension pattern matching algorithm.\ndialplan set extenpatternmatchnew true -- Use the New extension pattern matching algorithm.\ndialplan set global            -- Set global dialplan variable\ndialplan show                  -- Show dialplan\ndialplan show chanvar          -- Show channel variables\ndialplan show globals          -- Show global dialplan variables\ndnsmgr refresh                 -- Performs an immediate refresh\ndnsmgr reload                  -- Reloads the DNS manager configuration\ndnsmgr status                  -- Display the DNS manager status\nfax set debug {on|off}         -- Enable\/Disable FAX debugging on new FAX sessions\nfax show capabilities          -- Show the capabilities of the registered FAX technology modules\nfax show session               -- Show the status of the named FAX sessions\nfax show sessions              -- Show the current FAX sessions\nfax show settings              -- Show the global settings and defaults of both the FAX core and technology modules\nfax show stats                 -- Summarize FAX session history\nfax show version               -- Show versions of FAX For Asterisk components\nfeatures show                  -- Lists configured features\nfile convert                   -- Convert audio file\ng729 show hostid               -- Show G.729 Host-ID\ng729 show licenses             -- Show G.729 Licenses and Usage\ng729 show version              -- Show G.729 Module Version\ngroup show channels            -- Display active channels with group(s)\nhttp show status               -- Display HTTP server status\niax2 provision                 -- Provision an IAX device\niax2 prune realtime            -- Prune a cached realtime lookup\niax2 reload                    -- Reload IAX configuration\niax2 set debug {on|off|peer}   -- Enable\/Disable IAX debugging\niax2 set debug jb {on|off}     -- Enable\/Disable IAX jitterbuffer debugging\niax2 set debug trunk {on|off}  -- Enable\/Disable IAX trunk debugging\niax2 set mtu                   -- Set the IAX systemwide trunking MTU\niax2 show cache                -- Display IAX cached dialplan\niax2 show callnumber usage     -- Show current entries in IP call number limit table\niax2 show channels             -- List active IAX channels\niax2 show firmware             -- List available IAX firmware\niax2 show netstats             -- List active IAX channel netstats\niax2 show peer                 -- Show details on specific IAX peer\niax2 show peers                -- List defined IAX peers\niax2 show provisioning         -- Display iax provisioning\niax2 show registry             -- Display IAX registration status\niax2 show stats                -- Display IAX statistics\niax2 show threads              -- Display IAX helper thread info\niax2 show users [like]         -- List defined IAX users\niax2 test losspct              -- Set IAX2 incoming frame loss percentage\niax2 unregister                -- Unregister (force expiration) an IAX2 peer from the registry\nindication add                 -- Add the given indication to the country\nindication remove              -- Remove the given indication from the country\nindication show                -- Display a list of all countries\/indications\nkeys init                      -- Initialize RSA key passcodes\nkeys show                      -- Displays RSA key information\nlocal show channels            -- List status of local channels\nlogger add channel             -- Adds a new logging channel\nlogger mute                    -- Toggle logging output to a console\nlogger reload                  -- Reopens the log files\nlogger remove channel          -- Removes a logging channel\nlogger rotate                  -- Rotates and reopens the log files\nlogger set level {DEBUG|TRACE|NOTICE|WARNING|ERROR|VERBOSE|DTMF} {on|off} -- Enables\/Disables a specific logging level for this console\nlogger show channels           -- List configured log channels\nlogger show levels             -- List configured log levels\nmalloc trim                    -- Return excess memory to the OS\nmanager reload                 -- Reload manager configurations\nmanager set debug [on|off]     -- Show, enable, disable debugging of the manager code\nmanager show command           -- Show a manager interface command\nmanager show commands          -- List manager interface commands\nmanager show connected         -- List connected manager interface users\nmanager show eventq            -- List manager interface queued events\nmanager show events            -- List manager interface events\nmanager show event             -- Show a manager interface event\nmanager show settings          -- Show manager global settings\nmanager show users             -- List configured manager users\nmanager show user              -- Display information on a specific manager user\nmedia cache create             -- Create an item in the media cache\nmedia cache delete             -- Remove an item from the media cache\nmedia cache refresh            -- Refresh an item in the media cache\nmedia cache show all           -- Show all items in the media cache\nmedia cache show               -- Show a single item in the media cache\nmeetme kick                    -- Kick a conference or a user in a conference.\nmeetme list                    -- List all conferences or a specific conference.\nmeetme {lock|unlock}           -- Lock or unlock a conference to new users.\nmeetme {mute|unmute}           -- Mute or unmute a conference or a user in a conference.\nmfcr2 call files [on|off]      -- Enable\/Disable MFC\/R2 call files\nmfcr2 destroy link             -- Destroy given MFC\/R2 link\nmfcr2 set blocked              -- Reset MFC\/R2 channel forcing it to BLOCKED\nmfcr2 set debug                -- Set MFC\/R2 channel logging level\nmfcr2 set idle                 -- Reset MFC\/R2 channel forcing it to IDLE\nmfcr2 show channels [group|context] -- Show MFC\/R2 channels\nmfcr2 show links               -- Show MFC\/R2 links\nmfcr2 show variants            -- Show supported MFC\/R2 variants\nmfcr2 show version             -- Show OpenR2 library version\nmixmonitor {start|stop|list}   -- Execute a MixMonitor command\nmodule load                    -- Load a module by name\nmodule refresh                 -- Completely unloads and loads a module by name\nmodule reload                  -- Reload configuration for a module\nmodule show [like]             -- List modules and info\nmodule unload                  -- Unload a module by name\nmoh reload                     -- Reload MusicOnHold\nmoh show classes               -- List MusicOnHold classes\nmoh show files                 -- List MusicOnHold file-based classes\nmoh unregister class           -- Unregister realtime MusicOnHold class\nno debug channel               -- Disable debugging on channel(s)\nodbc show                      -- List ODBC DSN(s)\nparking show                   -- Show a parking lot or a list of all parking lots.\npjproject set log level {default|0|1|2|3|4|5|6} -- Set the maximum active pjproject logging level\npjproject show buildopts       -- Show the compiled config of the pjproject in use\npjproject show log level       -- Show the maximum active pjproject logging level\npjproject show log mappings    -- Show pjproject to Asterisk log mappings\npjsip dump endpt               -- Dump the res_pjsip endpt internals\npjsip export config_wizard primitives [to] -- Export config wizard primitives\npjsip list aors                -- List PJSIP Aors\npjsip list auths               -- List PJSIP Auths\npjsip list channels            -- List PJSIP Channels\npjsip list ciphers             -- List available OpenSSL cipher names\npjsip list contacts            -- List PJSIP Contacts\npjsip list endpoints           -- List PJSIP Endpoints\npjsip list identifies          -- List PJSIP Identifies\npjsip list registrations       -- List PJSIP Registrations\npjsip list subscriptions {inbound|outbound} [like] -- List active inbound\/outbound subscriptions\npjsip list transports          -- List PJSIP Transports\npjsip qualify                  -- Send an OPTIONS request to a PJSIP endpoint\npjsip reload qualify aor       -- Synchronize the PJSIP Aor qualify options\npjsip reload qualify endpoint  -- Synchronize the qualify options for all Aors on the PJSIP endpoint\npjsip send notify              -- Send a NOTIFY request to a SIP endpoint\npjsip send register            -- Registers an outbound registration target\npjsip send unregister          -- Unregisters outbound registration target\npjsip set history {on|off|clear} -- Enable\/Disable PJSIP History\npjsip set logger {on|off|host|add|method|methodadd|verbose|pcap} -- Enable\/Disable PJSIP Logger Output\npjsip show aors                -- Show PJSIP Aors\npjsip show aor                 -- Show PJSIP Aor\npjsip show auths               -- Show PJSIP Auths\npjsip show auth                -- Show PJSIP Auth\npjsip show channels            -- Show PJSIP Channels\npjsip show channel             -- Show PJSIP Channel\npjsip show channelstats        -- Show PJSIP Channel Stats\npjsip show contacts            -- Show PJSIP Contacts\npjsip show contact             -- Show PJSIP Contact\npjsip show endpoints           -- Show PJSIP Endpoints\npjsip show endpoint            -- Show PJSIP Endpoint\npjsip show history             -- Display PJSIP History\npjsip show identifiers         -- List registered endpoint identifiers\npjsip show identifies          -- Show PJSIP Identifies\npjsip show identify            -- Show PJSIP Identify\npjsip show qualify aor         -- Show the PJSIP Aor current qualify options\npjsip show qualify endpoint    -- Show the current qualify options for all Aors on the PJSIP endpoint\npjsip show registrations       -- Show PJSIP Registrations\npjsip show registration        -- Show PJSIP Registration\npjsip show scheduled_tasks     -- Show pjsip scheduled tasks\npjsip show settings            -- Show global and system configuration options\npjsip show subscription {inbound|outbound} -- Show active subscription details\npjsip show subscriptions {inbound|outbound} [like] -- Show active inbound\/outbound subscriptions\npjsip show transport-monitors  -- Show pjsip transport monitors\npjsip show transports          -- Show PJSIP Transports\npjsip show transport           -- Show PJSIP Transport\npjsip show unidentified_requests -- Show PJSIP Unidentified Requests\npjsip show version             -- Show the version of pjproject in use\npresencestate change           -- Change a custom presence state\npresencestate list             -- List currently know custom presence states\npri destroy span               -- Destroy a PRI span\npri service disable channel    -- Remove a channel from service\npri service enable channel     -- Return a channel to service\npri set debug {on|off|hex|intense|0|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15} span -- Enables PRI debugging on a span\npri set debug file             -- Sends PRI debug output to the specified file\npri show channels              -- Displays PRI channel information\npri show debug                 -- Displays current PRI debug settings\npri show spans                 -- Displays PRI span information\npri show span                  -- Displays PRI span information\npri show version               -- Displays libpri version\nqueue add member               -- Add a channel to a specified queue\nqueue priority caller          -- Change priority caller on queue\nqueue reload {parameters|members|rules|all} -- Reload queues, members, queue rules, or parameters\nqueue remove member            -- Removes a channel from a specified queue\nqueue reset stats              -- Reset statistics for a queue\nqueue set penalty              -- Set penalty for a channel of a specified queue\nqueue set ringinuse            -- Set ringinuse for a channel of a specified queue\nqueue show                     -- Show status of a specified queue\nqueue show rules               -- Show the rules defined in queuerules.conf\nqueue {pause|unpause} member   -- Pause or unpause a queue member\nrealtime destroy               -- Delete a row from a RealTime database\nrealtime load                  -- Used to print out RealTime variables.\nrealtime mysql cache           -- Shows cached tables within the MySQL realtime driver\nrealtime mysql status          -- Shows connection information for the MySQL RealTime driver\nrealtime store                 -- Store a new row into a RealTime database\nrealtime update                -- Used to update RealTime variables.\nrealtime update2               -- Used to test the RealTime update2 method\nrtcp set debug {on|off|ip}     -- Enable\/Disable RTCP debugging\nrtcp set stats {on|off}        -- Enable\/Disable RTCP stats\nrtp set debug {on|off|ip}      -- Enable\/Disable RTP debugging\nrtp show settings              -- Display RTP settings\nsay load [new|old]             -- Set or show the say mode\nsiren14 show version           -- Show Siren14 Module Version\nsiren7 show version            -- Show Siren7 Module Version\nsla show stations              -- Show SLA Stations\nsla show trunks                -- Show SLA Trunks\nsorcery memory cache dump      -- Dump all objects within a sorcery memory cache\nsorcery memory cache expire    -- Expire a specific object or ALL objects within a sorcery memory cache\nsorcery memory cache populate  -- Clear and populate the sorcery memory cache with objects from the backend\nsorcery memory cache show      -- Show sorcery memory cache information\nsorcery memory cache stale     -- Mark a specific object or ALL objects as stale within a sorcery memory cache\nss7 mtp3                       -- Send an NET MNG message\nss7 reset cic                  -- Resets the given CIC\nss7 reset group                -- Resets the given CIC range\nss7 restart mtp3               -- Restart a link\nss7 set debug {on|off} linkset -- Enables SS7 debugging on a linkset\nss7 {block|unblock} cic        -- Blocks\/Unblocks the given CIC\nss7 {reset|block|unblock} linkset -- Resets\/Blocks\/Unblocks all CICs on a linkset\nss7 {block|unblock} group      -- Blocks\/Unblocks the given CIC range\nss7 show calls                 -- Show ss7 calls\nss7 show channels              -- Displays SS7 channel information\nss7 show cics                  -- Show cics on a linkset\nss7 show linkset               -- Shows the status of a linkset\nss7 show version               -- Displays libss7 version\nstasis show topics             -- Show all topics\nstasis show topic              -- Show topic\nstir_shaken show certificate   -- Show stir\/shaken certificate configuration by id\nstir_shaken show certificates  -- Show all stir\/shaken certificate configurations\nstir_shaken show general       -- Show stir\/shaken general configuration\nstir_shaken show profile       -- Show stir\/shaken profile by id\nstir_shaken show profiles      -- Show all stir\/shaken profiles\nstir_shaken show store         -- Show stir\/shaken store configuration by id\nstun set debug {on|off}        -- Enable\/Disable STUN debugging\ntiming test                    -- Run a timing test\ntranscoder show                -- Display DAHDI transcoder utilization.\nudptl set debug {on|off|ip}    -- Enable\/Disable UDPTL debugging\nudptl show config              -- Show UDPTL config options\nulimit                         -- Set or show process resource limits\nvoicemail forward              -- Forward message to another folder\nvoicemail move                 -- Move message to another folder\nvoicemail reload               -- Reload voicemail configuration\nvoicemail remove               -- Remove message\nvoicemail show aliases         -- List mailbox aliases\nvoicemail show mailbox         -- Display a mailbox&#39;s content details\nvoicemail show users [for]     -- List defined voicemail boxes\nvoicemail show zones           -- List zone message formats\nxmldoc dump                    -- Dump the XML docs to the specified file\nxmldoc reload                  -- Reload the XML docs<\/code><\/pre><\/div>\n\n\n\n<p>Activate \/ deactivate SIP trunk logger<\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-plain\"><code>pjsip set logger on\npjsip set logger off<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Asterisk command line tool In a SSH shell, enter the asterisk command line by: All SIP Trunk commands at a glance: Activate \/ deactivate SIP trunk logger<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[41],"tags":[],"class_list":["post-822","post","type-post","status-publish","format-standard","hentry","category-asterisk"],"acf":[],"_links":{"self":[{"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=\/wp\/v2\/posts\/822","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=822"}],"version-history":[{"count":6,"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=\/wp\/v2\/posts\/822\/revisions"}],"predecessor-version":[{"id":828,"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=\/wp\/v2\/posts\/822\/revisions\/828"}],"wp:attachment":[{"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=822"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=822"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.homeserver.lu\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=822"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}