MDSE CLI
The MDSE CLI page allows you to execute MDSE commands.
To execute an MDSE CLI command, preform the following steps:
- Open UCX Administration
- From the PBX tab, select 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.
USEFUL TIP
You can use the command "help" to display a list of all available MDSE CLI commands.
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 |
UCX MDSE Log File
The MDSE Log File allows you to review log messages generated by the MDSE.
To view the MDSE log, preform the following steps:
- Open UCX Administration
- From the System tab, select Support
- In the pull down menu select ucx/mdse.log
