Asterisk CLI
The Asterisk CLI page allows you to execute Asterisk commands.
To execute an Asterisk CLI command, perform the following steps:
- From the PBX tab, select PBX Tools
- From the left side column, select Asterisk CLI
- Enter the command you want to execute in the Command field
- Press the Execute button (or Enter) to execute the command. The output is presented on the page.
You can use the command “help” to display a list of all available Asterisk CLI commands.
Reboot a Phone
To reboot a phone remotely during troubleshooting or to ensure it has downloaded the latest firmware and configuration data, you can enter the following text in the Command field:
ucx reboot peer 269 |
Note that the reboot peer xxx command can be used on XSTIM digital and IP phones.
Call Forwarding
To configure Call Forwarding All Calls on extension 221 and forward them to extension 269 you can enter the following text in the Command field:
database put CF 221 269 |
Show all phones with a Custom Context
To show all extensions that have been configured with a Custom Context
database showkey ccontext |
After clicking Execute, the UCX will respond with a list similar to the following:
Show the time since the last Asterisk restart
To show the time since the Telephony process was last restarted.
core show uptime |
MDSE CLI
The MDSE CLI page allows you to input MDSE commands and execute them.
To execute a MDSE command, preform the following steps:
- From the PBX tab, select PBX Tools
- From the left side column, select MDSE CLI
- Enter the command you want to execute in the Command field
- Press the Execute button (or Enter) to execute the command. The output is presented on the page.
You can use the command “help” to display a list of all available MDSE CLI commands.
To get help for a specific command, enter the command “help :<command>, <n>” where <n> is the number of arguments that the command takes.
For example: “help :alarms, 0” or “help :fmver, 1”.
Command | Description |
---|---|
help command, arity | Help for an individual command. For example: help :statu, 4 |
alarms | return a string of all active alarms |
cardunits loop, shelf, card | returns the active card units |
config | show the current configuration |
config_mgcs | get the list of configured mgcs |
crashd tn | crash a device |
devices cabinet | returns devices for a given cabinet |
disable_all_audit cabinet | disable audit on all digital sets |
disable_audit tn | disable digital set audit |
disc loop, shelf, card | disable card |
disu loop, shelf, card, unit | disable unit |
dsp_active cabinet | Dsps available for cabinet? |
dsp_conn cabinet | returns the dsp connection server pid |
enable_all_audit cabinet | enable audit on all digital sets |
enable_audit tn | enable digital set audit |
enllsh loop, shelf | enable loop shelf |
enlu loop, shelf, card, unit | enable unit |
free_all_dtr_units cabinet, tn | free all busy dtr units |
free_all_tds_units cabinet, tn | free all busy tds units |
fwver tn | Firmware version |
fwver loop, shelf | Firmware version of all units on a cabinet |
fwver loop, shelf, card | Firmware version of all units on a card |
fwver loop, shelf, card, unit | Firmware version |
get_busy_dsp cabinet | get list of busy dsp units from the tn_manager |
get_busy_dtr cabinet | get list of busy dtr units from the tn_manager |
get_busy_tds cabinet | get list of busy tds units from the tn_manager |
get_busy_units cabinet | get list of busy units from the tn_manager |
get_devices item | get list of all devices for item [:tdm, :dset, :aset] with data |
get_units cabinet | get list of units from the tn_manager by cabinet and type |
hb_statc cabinet | show status of an mgc hb state machine |
hex value | convert to hex |
idc loop, shelf, card | print card id |
inittime | return the mdse initialize time |
inittime tn_or_list | returns the device initialize time for a given packed tn |
inittime loop, shelf | returns the device initialize time for a given loop and shelf |
inittime loop, shelf, card | returns the device initialize time for a given card |
inittime loop, shelf, card, unit | returns the device initialize time for a unpacked tn |
is_traced pid | check if item is traced |
iunistim tn, decoded | simulate receiving a decoded unistim message to a device |
log_cat | show the current logging category levels |
log_cat category | set the log category |
log_category_list | show all log categories |
log_clear | reset the log levels back to their defaults |
log_clear_cat category | clear a log category |
log_level | get the current log level |
log_level level | set log level |
log_show | show the logging levels |
loopunits loop, shelf | returns the active units on a cabinet |
mark | Write a default message to the logger |
mark message | write a mark message to the logger |
mgc_status cabinet | returns the status of mgc registration with UCX |
pid list | returns the pid of a list |
pid item, tn | get pid of item [:device, :dset, :ssd_server] |
pidd tn | returns the pid of a device |
pidtn tn | returns the pid of a dsetsm |
pidu tn | get pid of unistim client for a tn |
print_alarms | print current alarms |
psm tn_or_list | print state machine data for a given tn |
psm loop, shelf, card_list | print state machine data of a card |
psm loop, shelf, card, unit_list | print state machine data of a unit |
psma | print state machine data for all active sets |
resetc loop, shelf, card | reset card |
ssd tn, ssd2 | send a ssd message to the mgc |
ssd_full cabinet, ssds_or_list | send full 4 word ssd message |
ssd_server cabinet | get pid and state of an ssd server |
stat_lsh | status of all cabinets |
stat_lsh cabinet | status of specific cabinet by cabinet |
stat_lsh loop, shelf | status of specific cabinet by loop and shelf |
statc loop, shelf, card | stat card |
statcards cabinet | print the status of install line cards |
statcl cabinet | returns the status of a cardlan server |
statd tn | returns the device sm status of a tn |
statdsp cabinet | returns the status of a dsp connection server |
statmgc | returns the MgcManager state |
statp pid | get the status of a process |
stattn tn | returns the dset status of a tn |
statu tn | status of a unit |
statu loop, shelf, card, unit | status of a unit |
trace pid_or_tn | enable tracing |
trace loop, shelf, card | trace phone for a given card |
trace loop, shelf, card, unit | trace phone for a given card |
trace_clear | clear all traces |
trace_clear pid_or_list | clear trace |
trace_list | return list of traces |
tracing enable | enable/disable the tracing configuration |
uptime | return the mdse uptime |
uptime tn_or_list | returns the device uptime of a tn |
uptime loop, shelf | returns the device uptime for a loop and shelf |
uptime loop, shelf, card | returns the device uptime of a given card |
uptime loop, shelf, card, unit | returns the device uptime of a unpacked tn |
Configuration File Editor
The Configuration File Editor page allows you to edit UCX configuration files.
To display and edit a configuration file, perform the following steps:
- From the PBX tab, select PBX Tools
- From the left side column, select Configuration File Editor
- Press the Show Filter button
- Enter a partial file name in the File field and press the Filter button (to limit the number of presented files)
- Press a link in the File Name column to open the corresponding configuration file
To end the file editing mode and return to the main page, select the << Back link.
To save changes made to the file, select the Save button.
To reload the configuration (apply configuration changes), select the Reload Configuration button. This operation does not restart the server.
Configuration File Editor Example
Activate the Built-in mini-HTTP server for Asterisk AMI use
This example shows the editing of the manager.conf file in order to activate the Builtin miniHTTP server that can be used in conjunction with the Asterisk AMI interface. The actual configuration settings to use the interface are managed in the PBX / Settings / Advanced Settings page which are described in Advanced Settings. However, in order to use the miniHTTP server it must be activated by editing the manager.conf file.
- Navigate to the PBX / PBX Tools page, select Configuration File Editor from the left-hand menu, click on Show Filter (steps 1 through 4 from above)
- Enter manager.conf in the Filter field and click Filter
- Click on manager.conf in the results list.
- Enter the text webenabled = yes at the bottom of the [general] section of the file.
- Click Save
- Click Reload Configuration
Text to Wav
The Text to Wav page is a text to speech conversion utility.
To convert text into an audio file, perform the following steps:
- From the PBX tab, select PBX Tools
- From the left side column, select Text to Wav
- Enter the desired text into the Text to Convert: text box
- Select the format for the audio file, using either wav or gsm radio button
- Press Generate Audio File to create the audio file. The file will be saved in your browser’s default download folder.
Festival
The Festival page allows you to turn on or off the Festival service (Text-to-Speech engine).
To change the state of the Festival service, perform the following steps:
- From the PBX tab, select PBX Tools
- From the left side column, select Festival
- Use the Status slider to switch the service to the desired state
Enhanced Archive
Enhanced Archive is a licensed application. This page will not appear if your license does not include the application.
To configure the Enhanced Archive application, perform the following steps:
- From the PBX tab, select PBX Tools
- From the left side column, select Enhanced Archive
- In the Schedule field, the default value is Disabled, this setting indicates the Enhanced Archive is disabled
- To enable the Enhanced Archive application, select Hourly or Daily from the pull-down list
- If Daily is selected, you can select the Hour (in 24 hour time format) to perform the archive
- Enter the FTP Server IP Address, User ID and Password
- Press the Save button to complete the configuration
To check the status of the backups, perform the following steps:
- Open UCX Administration
- From the Support tab, select System Log Files
- From the pull-down menu, select ucx_earchive.log