MML Command Reference

This chapter describes each of the MML commands you can use with the Cisco media gateway controller (MGC). MML is used to configure your MGC, add components to your system, retrieve information about system components, and perform logging and tracing. For information on starting MML and using MML commands, see the Cisco Media Gateway Controller Software Release 7 Provisioning Guide. The command descriptions in this chapter are arranged in alphabetical order. This chapter contains the following sections:

MML Command Overview

This overview describes MML command syntax, conventions used with MML commands, and responses expected from MML.

MML Command Guidelines

MML commands use the following syntax:

command_name:[target][, target][, target. . .][:Parameter_List][;comments]

When entering MML commands, remember the following:

Command names are not case-sensitive.
Neither keywords nor value strings need to be enclosed in quotation marks.
Use only one MML command on each line.
Anything entered after a semicolon (;) is treated as a comment. This is primarily useful for MML command scripts.
Do not use punctuation (such as the period character) for target names; for example, do not use test.log as a logging destination.

TimeSaver To repeat the last MML command you entered, use the up arrow. To scroll through all previous MML commands, continue to use the up (and down) arrow. To modify and reenter a previously entered command, use the up arrow to display the command and then the left arrows and right arrows, Backspace, Delete, and alphanumeric keys to edit the command. Press Enter to reenter the command.

See the Cisco Media Gateway Controller Software Release 7 Provisioning Guide for instructions on starting an MML session and using MML to configure the Cisco MGC.

MML Command Conventions

Conventions used in MML commands are described in this section.

Backus-Naur Conventions

MML commands use the Backus-Naur symbols shown in Table 1-1.
Table 1-1: MML Backus-Naur Conventions

Symbol Description

|

A pipe. Either the preceding symbol or the succeeding symbol may occur, but not both in succession.

[ ]

These brackets enclose an optional parameter.

{ | }

Either the preceding symbol or the succeeding symbol may occur, but not both in succession. There may be more than two symbols and pipes.

< >

This symbol encloses a symbol specifier.

Bellcore TL1 Conventions

The structure of MML is based on the Telcordia (Bellcore) TL1 standard (TR-NWT-831, Operations Application Message - Operations Applications Messages, Issue 3). Therefore, MML commands can be interpreted and monitored through a network's TL1 interface. The TL1 symbols shown in Table 1-2 are used in MML.
Table 1-2: MML Bellcore TL1 Conventions

Symbol Description

:

A parameter separator.

::

An empty parameter block.

&

Arguments are grouped together so that one parameter may convey several arguments.

;

End of command (optional). Anything on the same line after this symbol is treated as a comment.

Wildcards in MML Commands

Some MML commands support the use of wildcards. For Release 7.4, wildcards are available only as either postfix or prefix to MML names. The syntax for using wildcards with MML commands is as follows:

<MML command name>:<*><part of TID MML name><*>:[optional parameters]

For example, there are two ways to retrieve admin states of trunk groups using wildcards, RTRV-ADM-STATE:TG* retrieves the admin state of all trunk groups with MML names starting with "TG". Similarly, RTRV-ADM-STATE:*GP retrieves the admin state of all trunk groups with MML names ending with "GP".

For Release 7.4, the commands supported are as follows:

ACK-ALM
CLR-ALM
RTRV-ADM-STATE
RTRV-DEST
RTRV-SC
RTRV-TC
SET-ADM-STATE
SET-DEST-STATE
SET-SC-STATE

MML Responses

Messages that MML can display are described in this section.

MML Status Messages

After you enter an MML command, the system performs the task you requested and returns a status message. Table 1-3 lists the MML status messages and descriptions.

Table 1-3: MML Status Messages

Status Meaning Definition

COMPLD

Completed

MML received a response from the subsystem on which it performed the action.

Note A completed response does not always signify successful completion. A completed response can be returned on invalid components, such as alarms.

RTRV

Retrieve

Retrieve and display the contents of the specified file.

SUCC

Successful

Successful completion.

SWDC

Waiting for Dependency

Status message---Waiting for dependent processes to start.

SWDT

Waiting for Dependency

Status message---Waiting for dependent processes to stop. This is not an error. Enter the RTRV-SOFTW command to see when the dependent processes have stopped.

MML Error Messages

MML displays error messages if a command cannot be performed. Table 1-4 lists the MML error messages and descriptions.

Table 1-4: MML Error Message Descriptions

Error Code Meaning Definition

DENY

Command denied

The command is recognized, but the system does not allow you to perform the requested function.

ICNV

Input command not valid

The MML command is not recognized.

IDNV

Input data not valid

An unknown parameter was entered.

Example:

mml> RESET-CIC:dpc2:cic5 Virtual Switch Controller 2000-01-03 15:22:48 M RTRV IDNV "dpc2" /* Input, Data Not Valid */ ;

IISP

Input syntax error

An incorrect syntax was used.

Example:

mml> RESET-CIC:dpc9,cic22 Virtual Switch Controller - VSC-01 2000-01-12 M RTRV IISP reset-cic:dpc9, /* Input, Syntax Error */ ;

IITA

Invalid target

The requested operation cannot be performed on the network element component, or the component does not exist in the system.

Example:

mml> RESET-CIC:dpc9:CIC=10 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV IITA "dpc9" /* Input, Invalid Target */ ;

IPRM

Input parameter missing

An expected parameter cannot be found.

SABT

Status abort

The command did not finish in the time allocated.

SCNF

Status not found

There are problems with the engine.

SNVS

State not in valid state

The requested operation failed because the component is not configured to accept the operation. It is possible that the component is already performing the operation or is already in the desired state.

SNSP

State not supported

This operation is not supported by the component.

SROF

Status requested operation failed

The requested operation failed on the component.

MML Commands

This section describes each of the MML commands.

ACK-ALM---Acknowledge Alarm

Purpose:

This MML command is used to acknowledge that an alarm category on a component is recognized but the alarm is not cleared. If this is the last current alarm of a specific severity, then the associated alarm relay is turned off.

Format:

ack-alm:<comp>:"<alm cat>"

Description:

comp---The component that is generating the alarm. Components are described in the "Components, Processes, and Properties.". Use the PROV-RTRV:all command described on page 1-22 to retrieve a list of system components.
alm cat---The alarm category, or the text that appears in the body of the alarm. Use the RTRV-ALMS command described on page 1-28 to retrieve all active alarms. Also see the "Alarm/Event Categories" section.

Note The alarm category is case sensitive and it must be in quotation marks.

Example:

The following example acknowledges a Config Fail alarm for the I/O channel manager process:

mml> ACK-ALM:IOCM-01:"Config Fail"
Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 
M  COMPLD
   ;

Comments:

The format of alarm category name must be the same as the format of the alarm category name retrieved using the RTRV-ALMS command (which is why the alarm category must be in uppercase). See the "Alarm/Event Categories" section to check alarm category message syntax.

This alarm allows wildcarding.

BLK-CIC---Block a Circuit or a Circuit Range

Purpose:	This MML command blocks a circuit or range of circuits from carrying calls.
Format:	blk-cic:<point code>:CIC=<number>[,RNG=<slaves>]
Description:	point code---MML component name of a destination point code created with PROV-ADD:ptcode. number---A valid circuit identification code. slaves---A number such that number+slaves is a valid circuit identification code (CIC). All circuits between number and number+range are blocked.
Example:	The MML command shown in the following example blocks CIC 5 and the next 10 CICs on the destination point code dpc1: mml> BLK-CIC:dpc1:CIC=5,RNG=10 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "dpc1" ;
Comments:	Enter the RTRV-TC:all command (or RTRV-CIC command) to see whether CICs were blocked. Blocking a single CIC causes a BLA message to be sent to the destination SSP. Blocking a range of CICs causes a GBL message to be sent to the destination SSP. The range option only can be used to block CICs within a given trunk (T1 or E1). To unblock a CIC, use the UNBLK-CIC command.

CHG-DPL---Update Customer-Specific Number Manipulation Tables

Purpose:	This MML command updates customer-specific number manipulation tables based on the supplied customer group ID (previously called the virtual private network (vnet) ID).
Format:	chg-dpl::CUSTGRPID="<customer group ID>"
Description:	customer group id---The identifier (customer group ID). This is also called the vnet ID. It is a four-character alphanumeric field. It is not validated by MML.
Example:	The MML command shown in the following example updates the number tables for a customer with a customer group ID of 1005: mml> CHG-DPL::1005
Error Code:	None.
Comments:	This command is being phased out in release 7.4. Cisco recommends that the PROV-CPY command be used instead.

CHG-LOG---Change Log

Purpose:	This MML command is used to set or reset the logging level of an active process. Monitored and passive processes are not affected.
Format:	chg-log:<proc>:<log level> chg-log:all:<log level>
Description:	all---Applies change to all known processes. See "Components, Processes, and Properties"for a list of processes and process groups. log level---Sets the logging level for the specified process. Logging levels are as follows: EMR---Emergency level messages (highest level). CRT---Critical level messages. ALR---System is unusable messages. WRN---Warning condition messages. ERR---Error condition messages. TRC---Trace messages. INF---Informational messages. NOT---Notify level messages. DBG---Debug-level messages (lowest level). confirm---Use the confirm parameter when changing logging level to DBG. proc---Process name. Applies change to a specific active process.
Example:	The MML command shown in the following example changes the logging level of the measurements manager process to ERR: mml> CHG-LOG:MM-01:ERR Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "MM-01" ;
Comments:	This command is being phased out in release 7.4. Cisco recommends that the SET-LOG command be used instead. The process manager (PM-01) is not included in in the "all" parameter, as this is a special process. To change the logging level of PM-01, it must be used individually, for example, CHG-LOG:PM-01:DBG The mappings from the pre-Release 7.4 log levels to Release 7.4 log levels re shown in Table 1-5.

Table 1-5: Mappings to Release 7.4 Logging Levels

Old Logging Levels NEW Logging Levels

EMR (emergency)

CRIT (critical)

CR (critical)

CRIT (critical)

ALR (alert)

CRIT (critical)

WRN (warning)

WARN (warning)

ERR (error)

ERR (error)

TRC (trace)

TRACE (trace)

INF (informational)

INFO (informational)

NOT (notice)

INFO (informational)

DBG (debug)

DEBUG (debug)

.

Old Logging Levels	NEW Logging Levels
EMR (emergency)	CRIT (critical)
CR (critical)	CRIT (critical)
ALR (alert)	CRIT (critical)
WRN (warning)	WARN (warning)
ERR (error)	ERR (error)
TRC (trace)	TRACE (trace)
INF (informational)	INFO (informational)
NOT (notice)	INFO (informational)
DBG (debug)	DEBUG (debug)

CLR-ALM---Clear Alarm Component Category

Purpose:	This MML command clears an alarm category for a component.
Format:	clr-alm:<comp>:"<alm cat>"
Description:	comp---The component generating the alarm. Components are described in the "Components, Processes, and Properties.". Use the PROV-RTRV:all command described on page 1-22 to retrieve a list of system components. alm cat---The alarm category, or the text that appears in the body of the alarm. For a description of alarm categories, refer to Cisco Media Gateway Controller Software Release 7 Operations, Maintenance, and Troubleshooting Guide, Appendix A.
Example:	The MML command shown in the following example clears the PC UNAVAIL alarm on the component stp3: mml> CLR-ALM:stp3:"PC UNAVAIL" Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD ;
Comments:	The alarm category must match the format shown in the alarm when it is retrieved using the RTRV-ALMS command. It is case sensitive. See the "Alarm/Event Categories" section to check alarm category message syntax. This alarm allows wildcarding.

CLR-MEAS---Reset a Measurement Category

Purpose:	This MML command resets a measurement category of a component.
Format:	clr-meas:<comp>:"<meas cat>"
Description:	comp---The component being measured. Components are described in "Components, Processes, and Properties." Use the PROV-RTRV:all command described on page 1-22 to retrieve a list of system components. meas cat---Logical identifier that selects the measurement category. For a description of measurement categories, Refer to Cisco Media Gateway Controller Software Release 7 Operations, Maintenance, and Troubleshooting Guide, Appendix A.
Example:	The MML command shown in the following example resets the line-interface-severely-errored seconds measurement category on component stp3: mml> CLR-MEAS:stp3:"LIF: SES" Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD ;

CLR-TCAP-TRANS---Clear TCAP Transactions

Purpose:	This MML command clears all transaction capabilities application part (TCAP) transactions that are older than the specified period.
Format:	clr-tcap-trans::T=<number>
Description:	number---The time period, in seconds, after which you want to clear TCAP transactions.
Example:	The MML command shown in the following example clears all TCAP transactions that are older than 60 seconds: mml> CLR-TCAP-TRANS::T=60 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "TCAP-01:CLRD=0" ;

DIAGLOG---Diagnostics Log

Purpose:	This MML command starts and stops event logging into a diagnostics log.
Format:	diaglog:<file name>:START\|STOP
Description:	file name---The user-defined name of the log file. Do not use punctuation, such as the period character (.), to create a suffix. The default logging directory is $BASEDIR/var/log, where $BASEDIR is specified at installation.
Example:	The MML command shown in the following example starts logging into the diagnostics log named test: `mml>` DIAGLOG:test:start Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD ;
Comments:	Refer to "System Messages" for more information about log files.

H---Display History

Purpose:	This MML command redisplays a command or a series of commands, depending on a specified number or range. If no number is specified, the last command is displayed.
Format:	h[::<number>[,<number>]]
Description:	number---(First number entered) specifies the first command to redisplay. number---(Second number entered) specifies a range of commands to display.
Example:	The MML command shown in the following example displays the last successful command entered: mml> H Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "RTRV-TC:ALL" /* command 1 / ; The following command displays the third previous successful command you entered: mml> H::3* Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "RTRV-TC:ALL" /* command 3 / ; The following command displays the second through fifth previous successful commands you entered: mml> H::2,5* Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "RTRV-SC:ALL" /* command 5 / "RTRV-SOFTW:ALL" / command 4 / "RTRV-TC:ALL" / command 3 / "STP-AUD" / command 2 */ ;

HELP---Open the Help File

Purpose:	This MML command provides either a list of MML commands, descriptions, and values (if no parameter is given), or a description of a particular command (if the command name is entered as a parameter).
Format:	help[:<command name>]
Example:	The MML command shown in the following example displays help for a specific comand: mml> HELP:SET-LOG Virtual Switch Controller - VSC-03 2000-03-20 10:04:28 M RTRV SET-LOG -- Set Logging Levels ----------------------------- Purpose: This MML command is used to set the logging level of a process or all processes. Format: set-log:<proc>:<log level> set-log:all:<log level> Description: * proc -- The various actively and passively monitored processes running on the MGC. Use the RTRV-SOFTW:ALL command to display all processes. * log level -- Sets the logging level for the specified process. Logging levels are as follows: - CRIT -- Critical level messages. - DEBUG -- Debug-level messages (lowest level). - ERR -- Error condition messages. - INFO -- Informational messages. - WARN -- Warning condition messages. - TRACE -- Trace messages. Example: The MML command shown in the following example retrieves the logging level of the ENG-01 process: mml> RTRV-LOG:ENG-01 Virtual Switch Controller - VSC-01 2000-01-16 09:38:03 M RTRV "ENG-01:DEBUG" ; Comments: This command command was introduced in Release 7.4. For information concerning backward compatibility, use the HELP:CHG-LOG command. Note: DSKM-01 and LOG-01, the disk monitor and log server processes, respectively, do not make use of log levels and therefore do not accept log-level change requests. ;
Example:	The MML command shown in the following example displays the help file displayed if no parameter is entered: mml> HELP Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV Available commands (in alphabetical order): ack-alm:<comp>:"<alm cat>" Acknowledges an alarm category on a component blk-cic:<point code>:CIC=<number>[,RNG=<slaves>] Blocks a circuit or a circuit range chg-dpl::CUSTGRPID="<customer group ID>" Reloads a dialing plan chg-log:<proc>:<log level> Sets logging level of an active process, monitored and passive processes are not affected. logLevel can be: DBG \| INF \| NOT \| WRN \| ERR \| CRT \| ALR \| EMR \| TRC chg-log:all:<log level> Sets logging level for all processes. logLevel can be: DBG \| INF \| NOT \| WRN \| ERR \| CRT \| ALR \| EMR \| TRC clr-alm:<comp>:"<alm cat>" Clears an alarm category on a component clr-meas:<comp>:"<meas cat>" Resets a measurement category on a component clr-tcap-trans::T=<number> Clears all TCAP transactions older than value of T in seconds diaglog:<file name>:START\|STOP Starts/stops diagnostics log h[::<number>[,<number>]] Displays a history of commands for a specified backward number or range; the last command by default help[:<command name>] Displays the list of MML commands or the help information on a specified command numan-add:<comp>:custgrpid=<cust group ID>,<param name>=<param value>,... Adds an element to a dial plan table numan-dlt:<comp>:custgrpid=<cust group ID> Deletes an element from a dial plan table numan-ed:<comp>:custgrpid=<cust group ID>,<param name>=<param value>,... Edits an element in a dial plan table numan-rtrv:<comp>:custgrpid=<cust group ID> Retrieves an element from a dial plan table numan-rtrv:<comp>:custgrpid=<cust group ID>,"all" Retrives all elements from a dial plan table prov-add:<comp>:name=<MML name>,<param name>=<param value>,... Adds the component prov-cpy Commits provisioning data prov-dlt:<comp>:name=<MML name> Deletes the component prov-dply Deploys provisioning data
	prov-ed:<comp>:name=<MML name>,<param name>=<param value>,... Modifies the component attributes prov-rtrv:<comp>:name=<MML name> Retrieves the component attributes prov-rtrv:all Retrieves all the components prov-rtrv:rttrnkgrp:"all" Retrieves all route trunk group information prov-rtrv:rttrnk:"all" Retrieves all route trunk information prov-rtrv:rtlist:"all" Retrieves all route list information prov-rtrv:session Retrieves provisioning session information prov-rtrv:variants Retrieves all variants prov-sta::srcver=<version>,dstver=<version> Starts a provisioning session prov-stp Stops the provisioning session prov-sync Synchronizes provisioning data prov-exp:<tid>:dirname=<export directory name> Exports provisioning data query-cic:<point code>:CIC=<number>[,RNG=<slaves>][,RSLV] Performs a circuit query for a circuit or a circuit range with an optional RESOLVE parameter quit Ends the session r[::<number>] Repeats a previously entered command with a specified backward number; the last command by default reset-cic:<point code>:CIC=<number>[,RNG=<slaves>] Resets a circuit or a circuit range rtrv-alms Displays all active alarms rtrv-alms::CONT Displays all active alarms and listens for alarm events until Ctrl-C rtrv-asn:<aux sig path> Displays attributes of an ASP rtrv-aud-gw:<sig path MGCP> Retrieves result of an auditing process of a gateway rtrv-aud-gw:all Retrieves results of auditing processes of all gateways rtrv-cfg:<cfg table> Displays contents of a configuration table where table can be: alarmCategories \| components \| componentTypes measCategories \| services \| tables rtrv-cic:<point code>:CIC=<number>[,RNG=<slaves>] Retrieves bearer channels of a point code rtrv-ctr:<comp>:"<meas cat>" Retrieves a measurement of a component rtrv-dest:<point code> Retrieves state of a destination (point code) rtrv-dest:<sig path> Retrieves state of a destination (signaling path) rtrv-dest:all Retrieves state of all destinations: point codes and signaling paths rtrv-eqpt:<IO card> Retrieves service state of an I/O card rtrv-eqpt:all Retrieves service states of all I/O cards rtrv-lnk-ctr:<C7 link/set> Retrieves all measurements of a link or link set rtrv-lnk-ctr:all Retrieves all measurements of all links rtrv-log:all Displays logging level of all processes rtrv-log:<proc> Displays logging level of a process rtrv-lset:<C7 link set> Displays state of a link set rtrv-lssn:all Displays state of local SSN rtrv-mml Displays all active MML sessions rtrv-ne Displays attributes of the Network Element
	rtrv-ovld Displays overload level and number of messages in a queue rtrv-rssn:all Displays state of remote SSN rtrv-rte:<point code> Retrieves all SS7 routes for a point code rtrv-rte:all Retrieves SS7 routes for all point codes rtrv-sc:<sig channel> Displays attributes of a signaling channel rtrv-sc:<C7 link set> Displays attributes of a link set rtrv-sc:all Displays attributes of all signaling channels and link sets rtrv-softw:<proc> Displays status of a process or process group rtrv-softw:all Displays status of all known processes rtrv-sp-ctr:<point code> Retrieves all measurements of a point code rtrv-sp-ctr:all Retrieves all measurements of all point codes rtrv-spc:<point code> Retrieves route set of a point code rtrv-spc:all Retrieves route sets of all point codes rtrv-ss7-slt:<C7 link> Retrieves result of an MTP SLT test on a link rtrv-ss7-srt:<point code>:LSET="<C7 link/set>" Retrieves result of an MTP SRT test on a point code rtrv-tc:<sig path>&<sig path>... Displays state of bearers per signaling path(s) rtrv-tc:all Displays state of all bearers rtrv-tc-held:<sig path>&<sig path>... Displays state of bearers per signaling path(s), held by gateway rtrv-tc-held:all Displays state of all bearers, held by gateway rtrv-tcap-trans Displays number of active TCAP transactions set-asn-state:<aux sig path>:IS\|OOS Changes service state of an ASP set-dest-state:<sig path>:IS\|OOS... Changes service state of signaling path set-eqpt-state:<IO card>:IS\|OOS Changes service state of an I/O card set-lnk-state:<C7 link/set>:IS\|OOS\|INH\|UNH Changes service state of a link or a linkset set-log:<proc>:<log level> Sets logging level for process <proc> set-log:all:<log level> Sets logging level for all processes. logLevel can be: DEBUG \| TRACE \| INFO \| WARN \| ERR \| CRIT set-lssn-state::SSN=<number>,IS\|OOS Changes service state of a local SSN set-sc-state:<sig path>:IS\|OOS\|FOOS Changes service state of a signal path or a link set-sc-state:<line>:IS\|OOS\|FOOS\|INH\|UNH Changes service state of all signal paths/links on an entire line/linkset set-spc-state:<point code>:IS\|OOS... Changes service state of a point code snd:ext:<string> Sends a message to an external process snd:ext:"help" Displays a list of commands available for an external process (provided by external process, not MML) sta-aud Starts auditing process sta-aud-gw:<sig path MGCP> Starts auditing process of a gateway sta-aud-gw:all Starts auditing processes of all gateways
	sta-sc-trc:<sig path>:params Starts tracing on a signal path or a point code, optional params are: prd=<number> duration of tracing in seconds, log="filename" output file name in the ./var/trace directory sta-softw:<proc> Starts a process or process group sta-ss7-slt:<C7 link> Starts an MTP SLT test on a link sta-ss7-srt:<point code>:LSET="<C7 link/set>" Starts an MTP SRT test on a point code sta-tcap-trc Starts TCAP tracing stp-aud Stops auditing process stp-call:<sig channel>\|<point code>[:TC=<number>] Stops call(s) in progress for a specified signaling channel or destination point code; by default, all traffic channels are affected stp-sc-trc:<sig path> Stops tracing on a signal path stp-sc-trc:all Stops tracing on all signal paths stp-softw:<proc>:[kill] Stops a process or all processes in a group stp-softw:all:[kill] Shuts down the platform and applications except for Process Manager stp-tcap-trc Stops TCAP tracing sw-over::CONFIRM Forces a switchover to a stand-by platform tst-cot:<point code>:CIC=<number> Performs a COT test on a circuit unblk-cic:<point code>:CIC=<number>[,RNG=<slaves>] Unblocks a circuit or a circuit range vld-cic:<point code>:CIC=<number> Performs a circuit validation ;
Comments:	New commands were added in Release 7.4. For a list of the commands on systems earlier than 7.4, enter the bare HELP command on those systems.

NUMAN---ADD

Purpose:	This MML command adds an element to a dial-plan table.
Format:	numan-add:<comp>:custgrpid=<cust group ID>,<param name>=<param value>,...
Description:	Refer to Cisco Media Gateway Controller Software Release 7 Provisioning Guide for a description of using the NUMAN-ADD command for dial-plan provisioning. Refer to "Components, Processes, and Properties," for a description of components, parameter names, parameter descriptions, and parameter values.
Example:	The MML command that follows is used in building a digit modification table: `mml>` numan_add:digmodstring:custgrpid="T001",index=1,digitstring="703484"

NUMAN---DLT

Purpose:	This MML command deletes an element from a dial-plan table.
Format:	numan-dlt:<comp>:custgrpid=<cust group ID>
Description:	Refer to "Components, Processes, and Properties," for a description of components, parameter names, parameter descriptions, and parameter values.
Example:	The MML command that follows deletes an element from a dial plan table. `mml>` numan-dlt:resultset:custgrpid="T001",name="ra4"

NUMAN---ED

Purpose:	This MML command edits an element in a dial-plan table.
Format:	numan-ed:<comp>:custgrpid=<cust group ID>,<param name>=<param value>,...
Description:	Refer to Cisco Media Gateway Controller Software Release 7 Provisioning Guide for a description of using the NUMAN commands for dial-plan provisioning. Refer to "Components, Processes, and Properties," for a description of components, parameter names, parameter descriptions, and parameter values.
Example:	The MML command that follows edits a dial modification table. `mml> numan-ed:npi:custgrpid="T001",npiblock=1,setname="ra2"`

NUMAN---RTRV

Purpose:	This MML command retrieves an element or all elements from a dial-plan table.
Format:	numan-rtrv:<comp>:custgrpid=<cust group ID> numan-rtrv:<comp>:custgrpid=<cust group ID>,"all"
Description:	Refer to "Components, Processes, and Properties," for a description of components, parameter names, parameter descriptions, and parameter values.
Example:	The MML command that follows verifies an element in a dial-plan table. mml> numan-rtrv:dialplan:"all" Virtual Switch Controller - VSC-01 2000-02-01 13:23:36 M RTRV "session=active:dialplan" /* CustGrpId --------- V123 */ ;

PROV-ADD---Add Provisioning Component

Purpose:	This MML command adds a component to the MGC configuration.
Format:	prov-add:<comp>:name=<MML name>,<param name>=<param value>,...
Description:	comp---MML component type name for the type of configuration you are creating. The componnent type must match one of the component types listed in "Components, Processes, and Properties." MML name---MML component name for the new object you are creating (as many as ten characters). param name---The name of a valid configuration parameter for the specified component type. These parameter names are listed in "Components, Processes, and Properties." param value---The value you want to assign to the parameter. To define more than one parameter, enter additional param name=value descriptions on the command line.
Example:	The MML command shown in the following example adds a point code with the MML name of "opc", a component description of "point code for CP1," a netaddr parameter of 0.0.1, and a netind of two: mml> PROV-ADD:ptcode:NAME="opc", DESC="Point code of CP1", netaddr="0.0.1", netind=2 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "ptcode" ;
Comments:	Refer to Cisco Media Gateway Controller Software Release 7 Provisioning Guide for a description of using the PROV commands for provisioning. Refer to "Components, Processes, and Properties," for a description of components, parameter names, parameter descriptions, and parameter values.

PROV-CPY---Commit Provisioning Data

Purpose:

This MML command copies configuration settings from the current provisioning session to the local MGC the commands are running on in a single MGC configuration, and this activates the configuration. This command terminates the current provisioning session, if successful, and fails if there is no active provisioning session.

Note The difference between the PROV-CPY command and the PROV-DPLY command is that the PROV-DPLY command applies the configuration changes to dual MGC configurations, while the PROV-CPY command applies the configuration changes to single-controller configurations, that is the MGC you are configuring.

Format:

PROV-CPY

Example:

The MML command shown in the following example copies the configuration changes from the current session to the (single) MGC you are configuring.

mml> PROV-CPY

Comments:

Refer to Cisco Media Gateway Controller Software Release 7 Provisioning Guide for a description of using the PROV commands for provisioning. Refer to "Components, Processes, and Properties," for a description of components, parameter names, parameter descriptions, and parameter values.

PROV-DLT---Delete Components or Parameters

Purpose:	This MML command deletes a provisioned component.
Format:	prov-dlt:<comp>:name=<MML name>
Description:	comp---MML component type name for the type of component you are modifying. The entered parameter must match one of the component types listed in "Components, Processes, and Properties." MML name---MML component name for the component you are modifying.
Example:	The MML command shown in the following example deletes the point code component "opc": mml> PROV-DLT:ptcode:NAME="opc" Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "ptcode" ;
Comments:	Refer to Cisco Media Gateway Controller Software Release 7 Provisioning Guide for a description of using the PROV commands for provisioning. Refer to "Components, Processes, and Properties," for a description of components, parameter names, parameter descriptions, and parameter values.

PROV-DPLY---Deploy Provisioning Data

Purpose:

This MML command copies configuration settings from the current provisioning session to both MGCs in a dual-MGC configuration, and this activates the configuration. This command terminates the current provisioning session, if successful, and fails if there is no active provisioning session.

Format:

PROV-DPLY

Example:

The MML command shown in the following example copies the configuration from the current session to both MGCs:

mml> PROV-DPLY

Comments:

PROV-ED---Modify Provisioned Component

Purpose:

This MML command modifies a provisioned component.

Note Only those parameters that need to be modified must be entered.

Format:

prov-ed:<comp>:name=<MML name>,<param name>=<param value>,...

Description:

comp---MML component type name for the type of component you are modifying. The entered parameter must match one of the component types listed in "Components, Processes, and Properties."
MML name---MML component name for the component you are modifying. You cannot change the component name.
param name---The name of each configuration parameter you want to change. The parameter names must be valid for the specified component type. These parameter names are listed in "Components, Processes, and Properties."
param value---The new value you want to assign to the parameter.

Note To modify more than one parameter, enter additional param name=value descriptions on the command line.

Example:

The MML command shown in the following example changes the description of the provisioned point code "opc":

mml> PROV-ED:ptcode:NAME="opc", DESC="Point code for this SSP"
Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 
M  COMPLD
   "ptcode"
   ;

Comments:

PROV-EXP---Exports Provisioning Data

Purpose:	This MML command exports the current configuration of the VSC in MML-command form to a file or files. This allows for a system to be primed with a cloned configuration from an existing system or to be restored to a baseline configuration. The exported data can be imported using MML's batch feature. (Refer to Cisco Media Gateway Controller Software Release 7 Provisioning Guide for information concerning MML's batch feature)
Format:	prov-exp:<tid>:dirname=<export directory name>
Description:	tid--- Types of data. These can be: config---Core configuration data (Signaling Paths, SS7 nodes), including trunks and trunkgroup definitions routing---Routing plans numan---Dial plans export directory name---Name of the directory to which the data is exported. This directory is a sub-directory within the cust_specific directory established at installation.
Example:	The MML command shown in the this example saves the following files in the saved config directory: config.mml export_trunks.dat (optionally created if trunks are defined) export_trkgrp.dat (optionally created if trunk groups are defined) routing.mml <custGrpID>.mml (any number of these depending on number of dialplans defined) mml> prov-exp:all:dirname=saved_config Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD To import all configuration data from the directory saved_config exported by this command, use the UNIX commands shown, in the following order, which executes MML in batch mode: mml -b $BASEDIR/etc/cust_specific/saved_config/config.mml mml -b $BASEDIR/etc/cust_specific/saved_config/routing.mml mml -b $BASEDIR/etc/cust_specific/saved_config/<CustGrpID>.mml
Comment:	This command command was introduced in Release 7.4.

PROV-RTRV---Retrieve Provisioning Information

Purpose:	This MML command retrieves information about an existing provisioning session.
Format:	prov-rtrv:<comp>:name=<MML name> prov-rtrv:all prov-rtrv:<comp>:"all" prov-rtrv:rttrnkgrp:"all" prov-rtrv:rttrnk:"all" prov-rtrv:rtlist:"all" prov-rtrv:session prov-rtrv:variants
Description:	all---Displays all components that have been provisioned. A provisioning session is not required. session---Displays information about the provisioning session. rttrnkgrp---Displays information about route trunk groups. rttrnk---Displays information about route trunks. rttrnkgrp---Displays information about route lists. variants---Displays a list of the signaling protocols this configuration supports. A provisioning session is not required. comp---Use this command form when you want to display information about a single component. Enter the MML component type name for the type of component you are modifying. The entered parameter must match one of the component types listed in "Components, Processes, and Properties." MML name---MML component name for the component you want to display.
Example:	The MML command shown in the following example displays information about the point code "opc": mml> PROV-RTRV:ptcode:NAME="opc" Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "ptcode" /* NAME = opc DESC = pc for CP1 NETADDR = 0.0.8 NETIND = 2 */ ;
Comments:	Refer to Cisco Media Gateway Controller Software Release 7 Provisioning Guide for a description of using the PROV commands for provisioning. Refer to "Components, Processes, and Properties," for a description of components, parameter names, parameter descriptions, and parameter values. If the quotation marks are not used, the following error message is displayed: /* Input, Invalid Data Parameter */

PROV-STA---Start Provisioning Session

Purpose:

This MML command establishes a provisioning session. The data files are copied from the source version to the destination version. The data files are also locked to prevent other users from making changes.

If there is no active session, you can start a new session. If there is an active session, you can view the active configuration, but you are blocked from performing other actions.

Format:

prov-sta::srcver=<version>,dstver=<version>

Description:

srcver=version---Selects a specific configuration version as the source for configuration changes. The srcVersionNumber variable represents a directory stored in $BASEDIR/etc/CONFIG_LIB. In place of the configuration version, you can also enter:
- new---Specifies a new default session configuration; no existing source configuration is used.
- active---Selects the active configuration as the source for configuration changes.
dstver=version---Specifies the output version number and directory for the configuration session results. The destVersionNumber variable represents a directory stored in $BASEDIR/etc/CONFIG_LIB.

Note A version number is not required within the directory names listed above, but it does help you keep track of different configuration versions.

If the source and destination filenames are the same, the new configuration overwrites the new configuration. It is a good practice to copy an existing configuration instead of overwriting it. This gives you an easy way to return to a known configuration if there are problems with the new configuration. The new configuration should never be the destination session.

If the source configuration specified is new, the software does not allow you to overwrite an existing configuration.

Example:

The MML command shown in the following example starts a provisioning session and creates a new configuration named ver1:

mml> PROV-STA::SRCVER="new", DSTVER="ver1"
Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 
M  COMPLD
   "PROV-STA"
   ;

The MML command shown in the following example starts a provisioning session, opens the existing configuration named ver1, and overwrites that configuration:

mml> PROV-STA::SRCVER="ver1", DSTVER="ver1"

The MML command shown in the following example starts a provisioning session, opens the existing configuration named ver1, and saves the updated configuration as ver2:

mml> PROV-STA::SRCVER="ver1", DSTVER="ver2"

Comments:

PROV-STP---Stop Provisioning Session

Purpose:

This MML command terminates either a specified or the current provisioning session, saves the configuration, and releases the lock on the configuration data files.

Note This command does not activate the new configuration. Use the PROV-CPY or PROV-DPLY commands to activate the configuration.

Format:

PROV-STP
PROV-STP:<SESSION NAME>:CONFIRM

Description:

session name--- Use the RTRV-MML command to display active MML sessions.
confirm---If no confirm option is entered, the command is rejected and you are notified via a message of the potential performance impact of this command.

Example:

The MML command hown in the following exampleterminates the current provisioning session.

mml> PROV-STP
Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 
M  COMPLD
   "PROV-STP"
   ;

PROV-SYNC---Synchronize Provisioning Data

Purpose:

This MML command copies the active configuration from the active MGC to the standby MGC, ensuring that both media gateway controllers are using the same configuration.

Format:

PROV-SYNC

Example:

The MML command shown in the following example copies the configuration from the active MGC to the standby MGC:

mml> PROV-SYNC

QUERY-CIC---Execute Circuit Query

Purpose:	This MML command executes a circuit status query for a circuit or a circuit range.
Format:	query-cic:<point code>:CIC=<number>[,RNG=<slaves>][,RSLV]
Description:	point code--- MML component name of a point code created with PROV-ADD. number---A valid circuit identification code (CIC). slaves---A number such that number+slaves is a valid CIC. All circuits between number and number+slaves are queried. RSLV---If this parameter is on, the system attempts to resolve differences between the MGC's CIC state and the switch's CIC state.
Example:	The MML command shown in the following example queries CICs 20-24 on the destination point code dpc2. In this example, CIC=24 is a case in which the local primary state and secondary state differ. mml> QUERY-CIC:dpc2:CIC=20,RNG=4 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "dpc2:CIC=20;PST=IS;SST=IDLE" "dpc2:CIC=21;PST=IS;SST=IDLE" "dpc2:CIC=22;PST=IS;SST=IDLE" "dpc2:CIC=23;PST=IS;SST=IDLE" "dpc2:CIC=24;LPST=OOS;LSST=IDLE_LOC_BLOC," "dpc2:RPST=IS;RSST=IDLE" ;

QUIT---End Session

Purpose:	This MML command ends the MML session.
Format:	QUIT
Example:	mml> QUIT >

R---Repeat Previously Entered Command

Purpose:	This MML command repeats a previously entered command.
Format:	r[::<number>]
Description:	number---The command to repeat. For example, a value of 3 repeats the command issued before the last two commands. The default value is 1, which repeats the last command.
Example:	The MML command shown in the following example repeats the last command (this is the same as using the up arrow): mml> R The MML command shown in the following example repeats the third to the last command: mml> R::3

RESET-CIC---Reset a Circuit or A Circuit Range

Purpose:	This MML command resets or activates a circuit or a range of circuits.
Format:	reset-cic:<point code>:CIC=<number>[,RNG=<slaves>]
Description:	point code---MML component name of a destination point code created with PROV-ADD. number---A valid circuit identification code (CIC). slaves---A number such that number+slave is a valid CIC. All circuits between number and number +slaves are reset.
Example:	The MML command shown in the following example resets CICs 1-24 on destination point code dpc2: mml> RESET-CIC:dpc2:CIC=1,RNG=23 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "dpc2" ;

RTRV-ADMIN-STATE---Retrieve Administrative State

Purpose:	This MML command provides the following summary report: Inferred target state If all circuits are locked, the inferred target admin-state is locked If at least one circuit is unlocked, the inferred target admin-state is unlocked If mixture of locked and shutdown, the inferred target admin-state is shutdown Number of bearer channels that are in locking state. Number of bearer channels that are in unlocked state. Number of bearer channels that are in shutdown state.
Format:	rtrv-admin-state:<mgc> rtrv-admin-state:<gway> rtrv-admin-state:<trkGrp> rtrv-admin-state:<sigPath> rtrv-admin-state:<sigPath>:span=x rtrv-admin-state:<sigPath>:span=x,BC=y[,RNG=z] rtrv-admin-state:<sigPath>:CIC=x[,RNG=y]
Description:	Target parameters are as follows: MGC---Corresponding MML name of media gateway controller. GWAY---Corresponding MML name for media gateway. Not all media gateway types are applicable. Supported types are CU, MUX, MGW, and AVM external nodes. trkGrp---trkGrp is applicable only for time-division multiplexing (TDM). Allow the corresponding MML name for component type "0020" sigPath---Corresponding MML name for any of the following component types. Signaling path of in-band TDM up to MUX and then time switched to TDM media and sent to MGC . Signaling path of in-band TDM signaling up to CU and then encapsulated and sent over ip to the MGC. Signaling path of in-band TDM signaling up to NAS and then converted to NI2 and sent to VSC over IP (that is, FE box<-sig/tdm->NAS<-NI2/ip-> VSC). Signaling path or routeset associated with SS7 destination PC. Signaling path for EISUP. span : spanId is a 16-bit value that identifies an ISDN/PRI physical cable. BC---A numeric value that identifies the non ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC. CIC---A numeric value which identifies the ISUP circuit identification code number. RNG---The range of either bearer channel or circuit identification code.
Example:	The following example retrieves for dpc1 the primary state (PST=), the number of bearer channels in locked state (LOCK=), the number of bearer channels in unlocked state (UNLOCK=), and the number of bearer channels in shutdown state (SHUTDOWN=). mml> rtrv-admin-state:dpc1 Virtual Switch Controller - VSC-03 2000-02-17 14:27:52 M COMPLD "dpc1:PST=UNLOCK,LOCK=0,UNLOCK=384,SHUTDOWN=0" ;
Comment:	This command command was introduced in Release 7.4. This alarm allows wildcarding.

RTRV-ALMS---Retrieve Active Alarms

Purpose:	This MML command displays all active alarms.
Format:	RTRV-ALMS RTRV-ALMS::CONT
Description:	CONT---Tells the system to display alarm events until Ctrl-C is entered.
Example:	The MML command shown in the following example displays the names of all active alarms: mml> RTRV-ALMS Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "IOCM-01: 1999-09-30 15:54:05.891," "IOCM-01:ALM=\"Config Fail\",SEV=MN" "FOD-01: 1999-09-30 15:54:01.211," "FOD-01:ALM=\"FailoverPeerLost\",SEV=MJ" "dpc1: 1999-09-30 15:54:04.223,ALM=\"PC UNAVAIL\",SEV=MJ" "dpc2: 1999-09-30 15:54:04.229,ALM=\"PC UNAVAIL\",SEV=MJ" "dpc3: 1999-09-30 15:54:03.382,ALM=\"PC UNAVAIL\",SEV=MJ" "dpc5: 1999-09-30 15:54:04.243,ALM=\"PC UNAVAIL\",SEV=MJ" "ls1link2: 1999-09-30 15:54:03.808,ALM=\"SC FAIL\",SEV=MJ" "ls2link2: 1999-09-30 15:54:04.119,ALM=\"SC FAIL\",SEV=MJ" "ls3link1: 1999-09-30 15:54:04.121," "ls3link1:ALM=\"Config Fail\",SEV=MN" "ls3link2: 1999-09-30 15:54:04.131," "ls3link2:ALM=\"Config Fail\",SEV=MN" "ls3link2: 1999-09-30 15:54:04.132,ALM=\"SC FAIL\",SEV=MJ" "ls5link1: 1999-09-30 15:54:04.150," "ls5link1:ALM=\"Config Fail\",SEV=MN" "ls5link1: 1999-09-30 15:54:04.151,ALM=\"SC FAIL\",SEV=MJ" ;
	The MML command shown in the following example displays the names of active alarms and new alarm events until you press Ctrl-C: mml> RTRV-ALMS::cont Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "IOCM-01: 1999-09-30 15:54:27.892," "IOCM-01:ALM=\"Config Fail\",SEV=MN" "FOD-01: 1999-09-30 15:54:01.211," "FOD-01:ALM=\"FailoverPeerLost\",SEV=MJ" "dpc1: 1999-09-30 15:54:04.223,ALM=\"PC UNAVAIL\",SEV=MJ" "dpc2: 1999-09-30 15:54:04.229,ALM=\"PC UNAVAIL\",SEV=MJ" "dpc3: 1999-09-30 15:54:03.382,ALM=\"PC UNAVAIL\",SEV=MJ" "dpc5: 1999-09-30 15:54:04.243,ALM=\"PC UNAVAIL\",SEV=MJ" "ls3link1: 1999-09-30 15:54:04.121," "ls3link1:ALM=\"Config Fail\",SEV=MN" "ls3link2: 1999-09-30 15:54:04.131," "ls3link2:ALM=\"Config Fail\",SEV=MN" "ls3link2: 1999-09-30 15:54:04.132,ALM=\"SC FAIL\",SEV=MJ" "ls5link1: 1999-09-30 15:54:04.150," "ls5link1:ALM=\"Config Fail\",SEV=MN" "ls5link1: 1999-09-30 15:54:04.151,ALM=\"SC FAIL\",SEV=MJ" ; /* Listening for alarm events... (Ctrl-C to stop) / Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 * "dpc1:ALM=\"PC UNAVAIL\",STATE=CLEARED" ; Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 "dpc2:ALM=\"PC UNAVAIL\",STATE=CLEARED" ; Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 A "ls1link1:ALM=\"CHAN BAD TOT 15\",STATE=CLEARED" ; Ctrl-C** ^C/* Ctrl-C pressed */ mml>

RTRV-ASN---Retrieve Attributes of an Auxiliary Signaling Path

Purpose:	This MML command displays the attributes of an auxiliary signaling path (ASP).
Format:	rtrv-asn:<aux sig path>
Description:	aux sig path---Auxiliary signaling path.
Example:	`mml>` RTRV-ASN:IOCC-ASP
Error Code:	None.
Comments:	This command is not supported in Release 7.4(7).

RTRV-AUDIT-GW---Start Auditing of MGCP Gateway

Purpose:	This MML command retrieves the auditing of an MGCP gateway started by the STA-AUDIT-GW command.
Format:	rtrv-aud-gw:<sig path MGCP> rtrv-aud-gw:all
Description:	sig path MGCP---MGCP signaling path created with the PROV-ADD MGC command.
Example:	mml> RTRV-AUDIT-GW:T-1-16 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD ;

RTRV-CFG---Retrieve Configuration Table

Purpose:	This MML command displays the contents of a configuration table.
Format:	rtrv-cfg:<cfg table>
Description:	cfg table---The configuration table to display. The possible configuration tables can be Alarm categories Components ComponentTypes Measurement categories Services Tables
Example:	mml> rtrv-cfg:components Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "VSC-22: KEY=00010001," "VSC-22: PARENT=00000000, DESCR=Virtual Switch Controller" "CFGG-01: KEY=00020001," "CFGG-01: PARENT=00010001, DESCR=Config Mgr Subsystem" "ALGG-01: KEY=00020002," "ALGG-01: PARENT=00010001, DESCR=Alarm Mgr Subsystem" "MSGG-01: KEY=00020003," "MSGG-01: PARENT=00010001, DESCR=Measurement Mgr Subsystem" "ENGG-01: KEY=00020004," "ENGG-01: PARENT=00010001, DESCR=Engine Subsystem" "IOSG-01: KEY=00020005, PARENT=00010001, DESCR=IO Subsystem" "LOGM-01: KEY=00020006," "LOGM-01: PARENT=00010001, DESCR=Log Manager Subsystem" "XEG-01: KEY=00020007," "XEG-01: PARENT=00010001," "XEG-01: DESCR=Execution Environment Daemons" "PFMG-01: KEY=00020008," "PFMG-01: PARENT=00010001, DESCR=Platform Monitoring" "FTG-01: KEY=00020009," "FTG-01: PARENT=00010001, DESCR=Failover Group" "SNMPG-01: KEY=0002000a, PARENT=00010001, DESCR=SNMP Group" "CFM-01: KEY=00030001," "CFM-01: PARENT=00020007, DESCR=Config Manager" "ALM-01: KEY=00030002," "ALM-01: PARENT=00020007, DESCR=Alarm Manager" "MM-01: KEY=00030003," "MM-01: PARENT=00020007, DESCR=Measurement Manager" "AMDMPR-01: KEY=00030004," "AMDMPR-01: PARENT=00020007, DESCR=Alarm & Measurement Dumper" "CDRDMPR-01: KEY=00030005, PARENT=00020007, DESCR=CDR Dumper" "DSKM-01: KEY=00030006," "DSKM-01: PARENT=00020008, DESCR=Disk Space Monitor" "MMDB-01: KEY=00030007," "MMDB-01: PARENT=00020007, DESCR=TimesTen DataBase Process" "POM-01: KEY=00030008," "POM-01: PARENT=00020007," "POM-01: DESCR=Provisioning Object Manager" "MEASAGT: KEY=00030009," "MEASAGT: PARENT=0002000a, DESCR=Measurements SNMP Agent" "OPERSAGT: KEY=0003000a," "OPERSAGT: PARENT=0002000a, DESCR=Operational SNMP Agent" "PROVSAGT: KEY=0003000b," "PROVSAGT: PARENT=0002000a, DESCR=Provisioning SNMP Agent" "CMSAlarm: KEY=0003000c," "CMSAlarm: PARENT=00020007, DESCR=CMS Alarm Manager" "Replic-01: KEY=0003000d," "Replic-01: PARENT=00020004, DESCR=Replicator Controller" "ENG-01: KEY=0003000e, PARENT=00020004, DESCR=Engine" "IOCM-01: KEY=0003000f," "IOCM-01: PARENT=00020005, DESCR=IOS Channel Manager" "TCAP-01: KEY=00030010," "TCAP-01: PARENT=00020005," "TCAP-01: DESCR=TCAP and SCCP protocol handler" "IOCC-ASP: KEY=00030011," "IOCC-ASP: PARENT=00020005," "IOCC-ASP: DESCR=IOS Channel Controller - ASP" "FOD-01: KEY=00030012," "FOD-01: PARENT=0002000a, DESCR=Failover Controller"
	"IOCC-PRIIP: KEY=00030013," "IOCC-PRIIP: PARENT=00020005," "IOCC-PRIIP: DESCR=IOS ChannelController - ISDNPRI over IP " "IOCC-ANSI1: KEY=00030014, PARENT=00020005, DESCR=00130001" "CPU-01: KEY=00040001, PARENT=00010001, DESCR=CPU 1" "DISK-01: KEY=00040003, PARENT=00010001, DESCR=Hard Disk #1" "DISK-02: KEY=00040004, PARENT=00010001, DESCR=Hard Disk #2" "encard1: KEY=00050001," "encard1: PARENT=00010001, DESCR=Ethernet Card 1" "encard2: KEY=00050002," "encard2: PARENT=00010001, DESCR=Ethernet Card 2" "enetif1: KEY=00060001," "enetif1: PARENT=00050001," "enetif1: DESCR=Ethernet Interface for Card 1" "enetif2: KEY=00060002," "enetif2: PARENT=00050002," "enetif2: DESCR=Ethernet Interface for Card 2" "ls01: KEY=00080001," "ls01: PARENT=001e0001," "ls01: DESCR=Link Set from MGC to STPA" "ls02: KEY=00080002," "ls02: PARENT=001e0002," "ls02: DESCR=Link Set from MGC to STPB" "CPARM: KEY=00090001," "CPARM: PARENT=00010001, DESCR=XECfgParm.dat" "TABLE: KEY=00090002, PARENT=00010001, DESCR=tables.dat" "CTYPE: KEY=00090003," "CTYPE: PARENT=00010001, DESCR=compTypes.dat" "COMP: KEY=00090004," "COMP: PARENT=00010001, DESCR=components.dat" "ACAT: KEY=00090005," "ACAT: PARENT=00010001, DESCR=alarmCats.dat" "DEPND: KEY=00090006," "DEPND: PARENT=00010001, DESCR=dependencies.dat" "MCAT: KEY=00090007, PARENT=00010001, DESCR=measCats.dat" "PGRP: KEY=00090008," "PGRP: PARENT=00010001, DESCR=procGroups.dat" "PROC: KEY=00090009," "PROC: PARENT=00010001, DESCR=processes.dat" "SRVC: KEY=0009000a, PARENT=00010001, DESCR=services.dat" "SIGS: KEY=0009000b, PARENT=00010001, DESCR=sigPath.dat" "DPC: KEY=0009000c, PARENT=00010001, DESCR=dpc.dat" "ROUTE: KEY=0009000d, PARENT=00010001, DESCR=routes.dat" "SNMPM: KEY=0009000e, PARENT=00010001, DESCR=snmpmgr.dat" "ALOG: KEY=000a0001, PARENT=00010001, DESCR=Alarm Log" "CLOG: KEY=000a0002, PARENT=00010001, DESCR=Command Log" "MLOG: KEY=000a0003," "MLOG: PARENT=00010001, DESCR=Measurement Log" "DLOG: KEY=000a0004, PARENT=00010001, DESCR=Debug Log" "PM-01: KEY=000b0001," "PM-01: PARENT=00010001, DESCR=Process Manager" "MML-01: KEY=000c0001, PARENT=00010001, DESCR=MML #1" "MML-02: KEY=000c0002, PARENT=00010001, DESCR=MML #2" "MML-03: KEY=000c0003, PARENT=00010001, DESCR=MML #3" "MML-04: KEY=000c0004, PARENT=00010001, DESCR=MML #4" "MML-05: KEY=000c0005, PARENT=00010001, DESCR=MML #5" "MML-06: KEY=000c0006, PARENT=00010001, DESCR=MML #6" "MML-07: KEY=000c0007, PARENT=00010001, DESCR=MML #7" "MML-08: KEY=000c0008, PARENT=00010001, DESCR=MML #8" "MML-09: KEY=000c0009, PARENT=00010001, DESCR=MML #9" "MML-10: KEY=000c000a, PARENT=00010001, DESCR=MML #10" "MML-11: KEY=000c000b, PARENT=00010001, DESCR=MML #11"
	"MML-12: KEY=000c000c, PARENT=00010001, DESCR=MML #12" "ASP: KEY=000e0000," "ASP: PARENT=00010001, DESCR=ASN connection" "iplink1: KEY=00100001," "iplink1: PARENT=00140001, DESCR=IP Link for NAS1" "iplink2: KEY=00100002," "iplink2: PARENT=00140002, DESCR=IP Link for NAS 2" "iplink3: KEY=00100003," "iplink3: PARENT=00140003, DESCR=IP Link for NAS 3" "ss7route1: KEY=00110001," "ss7route1: PARENT=00010001," "ss7route1: DESCR=Route 1 to PSTN Switch A via LS1" "ss7route2: KEY=00110002," "ss7route2: PARENT=00010001," "ss7route2: DESCR=Route 2 to PSTN Switch A via LS2" "opc: KEY=00130001," "opc: PARENT=00010001, DESCR=Origination Point Code" "dpc1: KEY=00130002," "dpc1: PARENT=00010001, DESCR=DPC of PSTN Switch A" "signas1: KEY=00140001," "signas1: PARENT=00160002, DESCR=Signaling Service for NAS1" "signas2: KEY=00140002," "signas2: PARENT=00160003, DESCR=Signaling Service for NAS2" "signas3: KEY=00140003," "signas3: PARENT=00160004, DESCR=Signaling Service for NAS3" "ss7sigsvc: KEY=00150001," "ss7sigsvc: PARENT=00130002," "ss7sigsvc: DESCR=SS7 Service to PSTN Switch A" "nas1: KEY=00160002, PARENT=00010001, DESCR=NAS1" "nas2: KEY=00160003, PARENT=00010001, DESCR=NAS2" "nas3: KEY=00160004, PARENT=00010001, DESCR=NAS3" "switcha: KEY=00160005," "switcha: PARENT=00010001, DESCR=PSTN Switch A" "SNMPMGR-01: KEY=00170001, PARENT=0003000a, DESCR=Manager001" "c7iplink1: KEY=001d0001," "c7iplink1: PARENT=00080001, DESCR=Link 1 in Link Set 1" "c7iplink2: KEY=001d0002," "c7iplink2: PARENT=00080001, DESCR=Link 2 in Link Set 1" "c7iplink3: KEY=001d0003," "c7iplink3: PARENT=00080002, DESCR=Link 1 in Link Set 2" "c7iplnk4: KEY=001d0004," "c7iplnk4: PARENT=00080002, DESCR=Link 2 in Link Set 2" "apc1: KEY=001e0001, PARENT=00010001, DESCR=APC for STPA" "apc2: KEY=001e0002, PARENT=00010001, DESCR=APC for STPB" "ss7subsys1: KEY=001f0001," "ss7subsys1: PARENT=00010001, DESCR=Route from STPA to STPB" "ss7subsys2: KEY=001f0002," "ss7subsys2: PARENT=00010001, DESCR=Route from STPB to STPA" "Cust-Files: KEY=00210001," "Cust-Files: PARENT=00010001, DESCR=Customer specific files" "SS7-ANSI: KEY=00250001," "SS7-ANSI: PARENT=00010001, DESCR=SS7-ANSI Protocol Family" "SS7-ITU: KEY=00260001," "SS7-ITU: PARENT=00010001, DESCR=SS7-ITU Protocol Family" "SS7-China: KEY=00270001," "SS7-China: PARENT=00010001, DESCR=SS7-China Protocol Family" "SS7-NTT: KEY=00280001," "SS7-NTT: PARENT=00010001, DESCR=SS7-NTT Protocol Family" "ISDNPRI: KEY=00290001," "ISDNPRI: PARENT=00010001, DESCR=ISDNPRI Protocol Family" "DPNSS: KEY=002a0001," "DPNSS: PARENT=00010001, DESCR=DPNSS Protocol Family"
	"SGCP: KEY=002b0001," "SGCP: PARENT=00010001, DESCR=SGCP Protocol Family" "EISUP: KEY=002c0001," "EISUP: PARENT=00010001," "EISUP: DESCR=Extended ISUP Protocol Family" "PRIIP: KEY=002f0001," "PRIIP: PARENT=00010001," "PRIIP: DESCR=ISDNPRI over IP Protocol Family" "A-MBD: KEY=00300001, PARENT=00010001, DESCR=" "B-MBD: KEY=00300002, PARENT=00010001, DESCR=" "A-DSK: KEY=00300003, PARENT=00010001, DESCR=" "B-DSK: KEY=00300004, PARENT=00010001, DESCR=" "A-DSK0: KEY=00300005, PARENT=00010001, DESCR=" "A-DSK1: KEY=00300006, PARENT=00010001, DESCR=" "A-DSK2: KEY=00300007, PARENT=00010001, DESCR=" "A-DSK3: KEY=00300008, PARENT=00010001, DESCR=" "A-DSK4: KEY=00300009, PARENT=00010001, DESCR=" "A-DSK5: KEY=0030000a, PARENT=00010001, DESCR=" "B-DSK0: KEY=0030000b, PARENT=00010001, DESCR=" "B-DSK1: KEY=0030000c, PARENT=00010001, DESCR=" "B-DSK2: KEY=0030000d, PARENT=00010001, DESCR=" "B-DSK3: KEY=0030000e, PARENT=00010001, DESCR=" "B-DSK4: KEY=0030000f, PARENT=00010001, DESCR=" "B-DSK5: KEY=00300010, PARENT=00010001, DESCR=" "A-RMM: KEY=00300011, PARENT=00010001, DESCR=" "B-RMM: KEY=00300012, PARENT=00010001, DESCR=" "A-PCI0: KEY=00300015, PARENT=00010001, DESCR=" "A-PCI1: KEY=00300016, PARENT=00010001, DESCR=" "A-PCI2: KEY=00300017, PARENT=00010001, DESCR=" "A-PCI3: KEY=00300018, PARENT=00010001, DESCR=" "A-PCI4: KEY=00300019, PARENT=00010001, DESCR=" "A-PCI5: KEY=0030001a, PARENT=00010001, DESCR=" "A-PCI6: KEY=0030001b, PARENT=00010001, DESCR=" "B-PCI0: KEY=0030001c, PARENT=00010001, DESCR=" "B-PCI1: KEY=0030001d, PARENT=00010001, DESCR=" "B-PCI2: KEY=0030001e, PARENT=00010001, DESCR=" "B-PCI3: KEY=0030001f, PARENT=00010001, DESCR=" "B-PCI4: KEY=00300020, PARENT=00010001, DESCR=" "B-PCI5: KEY=00300021, PARENT=00010001, DESCR=" "B-PCI6: KEY=00300022, PARENT=00010001, DESCR=" "A-CPU: KEY=00300023, PARENT=00010001, DESCR=" "A-PSU0: KEY=00300024, PARENT=00010001, DESCR=" "A-PSU1: KEY=00300025, PARENT=00010001, DESCR=" "A-PSU2: KEY=00300026, PARENT=00010001, DESCR=" "B-PSU0: KEY=00300027, PARENT=00010001, DESCR=" "B-PSU1: KEY=00300028, PARENT=00010001, DESCR=" "B-PSU2: KEY=00300029, PARENT=00010001, DESCR=" "B-CPU: KEY=0030002a, PARENT=00010001, DESCR=" "SS7-UK: KEY=00320001," "SS7-UK: PARENT=00010001, DESCR=BT SS7-ITU Protocol Family" "TCAPOverIP: KEY=00360001," "TCAPOverIP: PARENT=00010001," "TCAPOverIP: DESCR=tcap over ip protocol Family" "MGCP: KEY=00380001," "MGCP: PARENT=00010001, DESCR=MGCP Protocol Family" "BTNUP: KEY=003c0001," "BTNUP: PARENT=00010001," "BTNUP: DESCR=BTNUP SS7-ITU Protocol Variant" ;
Comments:	Currently, the cfgTable in this command differs from the cfgTable used in the change configuration command. The following are valid target tables: alarmCategories components componentTypes services measCategories tables dfltcfgparms---Default configuration parameters

RTRV-CIC---Retrieve Bearer Channels

Purpose:	This MML command retrieves bearer-channel information for one or more circuits that are identified by a destination point code.
Format:	rtrv-cic:<point code>:CIC=<number>[,RNG=<slaves>]
Description:	point code---MML component name of a point code provisioning component. number---A valid circuit identification code (CIC). slaves---A number such that number+slaves is a valid CIC. All circuits between number and number+slaves are displayed.
Example:	The MML command shown in the following example retrieves bearer channel information for CICs 10-15 on destination point code dpc29; mml> RTRV-CIC:dpc1:cic=10,rng=5 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "dpc1:CIC=10,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=11,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=12,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=13,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=14,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=15,PST=IS,CALL=IDLE,BLK=NONE" ; mml>

RTRV-CTR---Retrieve Measurement Counter

Purpose:	This MML command displays a measurement counter for a component.
Format:	rtrv-ctr:<comp>:"<meas cat>"
Description:	comp---The MML name of the component you want to examine. Components are described in Table 1-6. Use the PROV-RTRV:all command described on page 1-22 to retrieve a list of system components. meas cat---Logical identifier that selects the measurement category or measurement group. For a list of measurement categories, Refer to Cisco Media Gateway Controller Release 7 Operations, Maintenance, and Troubleshooting Guide, Appendix A.
Example:	The MML command shown in the following example displays measurement counters for the component ALGG-01. mml> rtrv-ctr:ALGG-01:"LIF: SES" Virtual Switch Controller 1999-02-18 15:38:50 M RTRV "ALGG-01:CAT=\"LIF: SES\",BCKT=\"b_prof_std15\",VAL=1000" "ALGG-01:CAT=\"LIF: SES\",BCKT=\"b_prof_std60\",VAL=2000" "ALGG-01:CAT=\"LIF: SES\",BCKT=\"b_prof_std24\",VAL=2000" ;

Table 1-6: MML Components

MML Group Name Component Name Component Types

ALL-COUNTERS

Any Component

LIF-GROUP

TMDLink and C7IPLink

x0010 and x001d

SC-GROUP

Tdmlnks supporting DPNSS or ISDN PRI

x0010

DL-GROUP

Adaptor/Card for TDM

x0005

ASP-GROUP

N/A

x00e0

SP-GROUP

All Signal Services

x0007, x0013, x0014, x0018, x0019,x001b, x001c, x0034, x0035

C7LNK-GROUP

LinkSet

x0008

C7SP-GROUP

PointCode and Adjacent Point Code

x0013, x001e

TpPRILinkStatTable

Facility Associated Signaling (FAS) Signaling Service

x0007

ISUP-GROUP

PointCode supporting ISUP

x0013

TUP-GROUP

PointCode supporting TUP

x0013

NUP-GROUP

PointCode supporting NUP

x0013

OVL-GROUP

Network element root id

x00010001

STATE-GROUP

Network element root id

x00010001

TCAP-GROUP

Network element root id

x00010001

SCCP-GROUP

Network element root id

x00010001

RTRV-DEST---Retrieve Destination

Purpose:	This MML command retrieves information about one or more destinations.
Format:	rtrv-dest:<point code> rtrv-dest:<sig path> rtrv-dest:all
Description:	point code---MML component name of a point code provisioning component. sig path---The MML name of the logical signaling channel for which you want to display information. These should be sig path DSS IP or sig path NAS entities. Refer to "Components, Processes, and Properties." all---Displays information about all external point codes and signal paths.
Example:	The MML command shown in the following example retrieves the destination of point code dpc1: mml> RTRV-DEST:dpc1 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "dpc1:PKG=SS7-ANSI,ASSOC=UNK,PST=IS" ;
Comments:	This command supports wildcarding.

RTRV-EQPT---Retrieve Service State of a Component

Purpose:	This MML command retrieves the service state of a component.
Format:	rtrv-eqpt:<IO card> rtrv-eqpt:all
Description:	IO Card---The IO card whose service state is to be viewed. Components are described in the Cisco Media Gateway Controller Software Release 7 Provisioning Guide. Use the PROV-RTRV:all command described on page 1-22 to retrieve a list of system components.
Example:	The MML command shown in the following example retrieves the service state of the component atm1: mml> RTRV-EQPT:atm1 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV IS ;

RTRV-LNK-CTR---Retrieve SS7/C7 Link Measurements

Purpose:	The MML command shown in the following example displays the measurements for a single link or for all links. It returns all measurements for one link, for every link configured in the specified linkset, or for every linkset. The measurements are displayed in the same format as in RTRV-CTR.
Format:	RTRV-LNK-CTR:<C7 link/set> RTRV-LNK-CTR:all
Description:	<C7 link/set>---The provisioning component C7 link, TDM link used in a linkset, or linkset. Refer to "Components, Processes, and Properties" for a description of C7 linksets. Use the RTRV-LSET command described on page 1-40 to retrieve a list of linksets .all---Displays the measurements for all links.
Example:	The MML command shown in the following example displays the measurements for linkset1: mml> RTRV-LNK-CTR:ls1 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "ls1link1:CAT=\"SC: XMIT FRM TOT\"," "ls1link1:BCKT=\"b_prof_std15\",VAL=0" "ls1link1:CAT=\"SC: XMIT FRM TOT\"," "ls1link1:BCKT=\"b_prof_std60\",VAL=0" "ls1link1:CAT=\"SC: XMIT FRM TOT\"," "ls1link1:BCKT=\"b_prof_std24\",VAL=0" "ls1link1:CAT=\"SC: RCV FRM TOT\"," "ls1link1:BCKT=\"b_prof_std15\",VAL=0" "ls1link1:CAT=\"SC: RCV FRM TOT\"," "ls1link1:BCKT=\"b_prof_std60\",VAL=0" "ls1link1:CAT=\"SC: RCV FRM TOT\"," "ls1link1:BCKT=\"b_prof_std24\",VAL=0" "ls1link1:CAT=\"SC: RCV BAD CRC\"," "ls1link1:BCKT=\"b_prof_std15\",VAL=0" "ls1link1:CAT=\"SC: RCV BAD CRC\"," "ls1link1:BCKT=\"b_prof_std60\",VAL=0" "ls1link1:CAT=\"SC: RCV BAD CRC\"," "ls1link1:BCKT=\"b_prof_std24\",VAL=0" "ls1link1:CAT=\"SC: RCV BAD TOT\"," "ls1link1:BCKT=\"b_chR_btot15\",VAL=0" "ls1link1:CAT=\"SC: RCV BAD TOT\"," "ls1link1:BCKT=\"b_chR_btot60\",VAL=0" "ls1link1:CAT=\"SC: RCV BAD TOT\"," "ls1link1:BCKT=\"b_chR_btot24\",VAL=0" "ls1link1:CAT=\"C7LNK: RCV SU ERR\"," "ls1link1:BCKT=\"b_prof_ss7_230\",VAL=0"
	"ls1link1:CAT=\"C7LNK: XMIT SIO TOT\"," "ls1link1:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link1:CAT=\"C7LNK: RCV SIO TOT\"," "ls1link1:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link1:CAT=\"C7LNK: DUR IS\"," "ls1link1:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link1:CAT=\"C7LNK: DUR UNAVAIL\"," "ls1link1:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link1:CAT=\"C7LNK: MSU DROP-CONG\"," "ls1link1:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link2:CAT=\"SC: XMIT FRM TOT\"," "ls1link2:CAT=\"SC: RCV FRM TOT\"," "ls1link2:BCKT=\"b_prof_std24\",VAL=0" "ls1link2:CAT=\"SC: RCV BAD CRC\"," "ls1link2:BCKT=\"b_prof_std15\",VAL=0" "ls1link2:CAT=\"SC: RCV BAD CRC\"," "ls1link2:BCKT=\"b_prof_std60\",VAL=0" "ls1link2:CAT=\"SC: RCV BAD CRC\"," "ls1link2:BCKT=\"b_prof_std24\",VAL=0" "ls1link2:CAT=\"SC: RCV BAD TOT\"," "ls1link2:BCKT=\"b_chR_btot15\",VAL=0" "ls1link2:CAT=\"SC: RCV BAD TOT\"," "ls1link2:BCKT=\"b_chR_btot60\",VAL=0" "ls1link2:CAT=\"SC: RCV BAD TOT\"," "ls1link2:BCKT=\"b_chR_btot24\",VAL=0" "ls1link2:CAT=\"C7LNK: RCV SU ERR\"," "ls1link2:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link2:CAT=\"C7LNK: XMIT SIO TOT\"," "ls1link2:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link2:CAT=\"C7LNK: DUR IS\"," "ls1link2:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link2:CAT=\"C7LNK: DUR UNAVAIL\"," "ls1link2:BCKT=\"b_prof_ss7_230\",VAL=0" "ls1link2:CAT=\"C7LNK: MSU DROP-CONG\"," "ls1link2:BCKT=\"b_prof_ss7_230\",VAL=0" ;

RTRV-LOG---Retrieve Log

Purpose:	This MML command is used to display the logging level of a process or all processes.
Format:	rtrv-log:all rtrv-log:<proc>
Description:	all---Displays the logging levels of all processes proc---The various actively and passively monitored processes running on the MGC. Refer to the command, SET-LOGSet Logging Levels for a list of logging levels. Use the RTRV-SOFTW:ALL command to display all processes. Also refer to Appendix "Components, Processes, and Properties""Processes" section for more information.
Example:	The MML command shown in the following example retrieves the logging level of the process manager (PM-01) process: mml> RTRV-LOG:PM-01 Virtual Switch Controller - VSC-01 2000-01-16 09:38:03 M RTRV "PM-01:DEBUG" ;
Comment:	This command was introduced in Release 7.4. The process manager (PM-01) is not included in the "all" parameter, as this is a special process. To retrieve the logging level of PM-01, it must be used individually, as in the example above. For the 7.4 release, two processes do not currently support log-level commands: DSKM-01 and LOG-01. For these two processes, the following message will be returned: /Function not supported/

RTRV-LSET---Retrieve Linkset Service State

Purpose:	This MML command is used to retrieve the service state of a linkset. It displays the service state as IS (In-Service), OOS (Out-of-Service), or MOOS (Manually Out-of-Service).
Format:	rtrv-lnk-ctr:<linkset>
Description:	<linkset>---The provisioning component C7 link, TDM link used in a linkset, or linkset. Refer to "Components, Processes, and Properties" for a description of linksets. .
Example:	The MML command shown in the following example retrieves the service state of linkset ls1: mml> RTRV-LSET:ls1 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV MOOS ;

RTRV-LSSN---Retrieve State of All Local SSNs

Purpose:	This MML command displays the state of all local SSNs (LSSNs).
Format:	RTRV-LSSN:all
Example:	mml> RTRV-LSSN:all Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "TCAP-01:SSN=1,PST=IS" "TCAP-01:SSN=2,PST=OOS" ;

RTRV-MML---Retrieve Active MML Sessions

Purpose:	This MML command displays all active MML sessions, their session numbers, and the user IDs of the session originators.
Format:	RTRV-MML
Example:	mml> RTRV-MML Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV mml5:guest ;

RTRV-NE---Retrieve Network Element Attributes

Purpose:

This MML command displays information about the MGC hardware, software, and current state (active or standby).

Format:

RTRV-NE

Example:

mml> RTRV-NE
Virtual Switch Controller - VSC-01 2000-01-12 12:00:47
M  RTRV
   "Type:VSC"
   "Hardware platform:sun4u sparc SUNW,Ultra-30"
   "Vendor:"Cisco Systems, Inc.""
   "Location:Virtual Switch Controller - VSC-01"
   "Version:"7.3(10).r2""
   "Platform State:ACTIVE"
   ;

RTRV-OVLD---Retrieve Overload Level

Purpose:	This MML command displays the overload level and number of messages in a queue.
Format:	RTRV-OVLD
Example:	`mml>` RTRV-OVLD Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "ENGG-01: OVLD=0,MSGQ=0" ;

RTRV-RSSN---Retrieve State of All Remote SSNs

Purpose:

This MML command displays the state of all remote SSNs (RSSNs).

Format:

RTRV-RSSN:all

Example:

mml> RTRV-RSSN:all
Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 
M  RTRV
   "stp1:PC=007.007.007,SSN=1,PST=OOS"
   "stp2:PC=008.008.008,SSN=1,PST=OOS"
   "stp3:PC=009.009.009,SSN=2,PST=OOS"
   ;

RTRV-RTE---Retrieve Route

Purpose:

This MML command retrieves all SS7 routes for a point code, or SS7 routes for all point codes.

Format:

rtrv-rte:<point code>
rtrv-rte:all

Description:

point code---The MML component name of a point code.

Example:

The MML command shown in the following example retrieves the routes for destination point code PC-002:

mml> RTRV-RTE:PC-002
Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 
M RTRV
PC-002:LS01,APC=000.028.007,PRIO=1,PST=IS,SST=NA

Note PC-002 is the target, LS01 is the linkset ID, APC=000.0028.007 is the adjacent point code, and PRIO is the priority set for the routes.

Comments:

Route state attributes with definitions are as follows:

IS---In-Service (Available).
OOS---Out-of-Service (Unavailable).
PRHB---Prohibited.
RSTR---Restricted.

RTRV-SC---Retrieve Signaling Channel Attributes

Purpose:	This MML command displays the names and attributes of one signaling channel and linkset or all signaling channels and linksets.
Format:	rtrv-sc:<sig channel> rtrv-sc:<C7 linkset> rtrv-sc:all
Description:	all---Displays information on all signaling channels and linksets. sig channel---The MML name of a provisioning component, TDM link, C7 link, or IP link. C7 linkset---The MML name of a linkset.
Example:	The MML command shown in the following example displays the names and attributes of all signaling channels and linksets: `mml>` RTRV-SC:all Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "ls1link1:ls1,LID=0:IS" /* link 1 of ls1 to va-2600-29 / "ls1link2:ls1,LID=1:IS" / link 2 of ls1 to va-2600-30 / "ls2link1:ls2,LID=0:IS" / link 1 of ls2 to va-2600-29 / "ls2link2:ls2,LID=1:IS" / link 2 of ls2 to va-2600-30 / "ls3link1:ls3,LID=0:OOS" / link 1 of ls3 to va-2600-31 / "ls3link2:ls3,LID=1:OOS" / link 2 of ls3 to va-2600-31 / "ls5link1:ls5,LID=0:OOS,STBY" / link 2 of ls3 to va-2600-31 */
Comments:	Signaling channel state attributes with definitions are as follows: IS---In-Service. INB---Install Busy OOS---Out-of-Service. BLOCKED---Blocked. STBY---Standby. LINH---Locally Inhibited (SS7 link). COOS---Commanded Out-of-Service (user set the signal channel to an OOS state). CONF---Configuration Error. RINH---Remotely Inhibited (SS7 link). This command supports wildcarding.

R TRV-SOFTW---Retrieve Software Status for a Process

Purpose:	This MML command displays the status of one process or all processes.
Format:	rtrv-softw:<proc> rtrv-softw:all
Description:	proc---The MML name of a process or process group. all---Displays the status of all processes.
Example:	The MML command shown in the following example displays the status of all processes and process groups: mml> RTRV-SOFTW:all Virtual Switch Controller - VSC-02 2000-01-17 11:37:23 M RTRV "CFM-01:RUNNING ACTIVE" "ALM-01:RUNNING ACTIVE" "MM-01:RUNNING ACTIVE" "AMDMPR-01:RUNNING ACTIVE" "CDRDMPR-01:RUNNING ACTIVE" "DSKM-01:RUNNING IN N/A STATE" "MMDB-01:RUNNING IN N/A STATE" "POM-01:RUNNING ACTIVE" "MEASAGT:RUNNING ACTIVE" "OPERSAGT:RUNNING ACTIVE" "PROVSAGT:RUNNING ACTIVE" "PRIL3-1:RUNNING IN N/A STATE" "Replic-01:RUNNING ACTIVE" "ENG-01:RUNNING ACTIVE" "IOCM-01:RUNNING ACTIVE" "TCAP-01:RUNNING IN N/A STATE" "IOCC-ASP:RUNNING IN N/A STATE" "FOD-01:RUNNING IN N/A STATE" "MGCP-1:RUNNING IN N/A STATE" "EISUP-1:RUNNING IN N/A STATE" "SS7-A-1:RUNNING IN N/A STATE" "SS7-I-1:RUNNING IN N/A STATE" ;

RTRV-SP-CTR---Retrieve SS7/C7 Signaling Point Measurements

Purpose:	This MML command returns measurement data for one SS7 signaling point or for all SS7 signaling points. The measurements are displayed in the same format as for RTRV-CTR.
Format:	rtrv-sp-ctr:<point code> rtrv-sp-ctr:all
Description:	point code---The MML component name of a single provisioning component point code. Note that RTRV-CTR:<point code>:<group> is a related command. all---Displays measurements for all signaling points.
Example:	The MML command shown in the following example retrieves all measurements for point code dpc1: `mml>` RTRV-SP-CTR:dpc1 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "dpc1:CAT=\"SP: cInit in\",BCKT=\"b_prof_std15\",VAL=0" "dpc1:CAT=\"SP: cInit in\",BCKT=\"b_prof_std60\",VAL=0" "dpc1:CAT=\"SP: cInit in\",BCKT=\"b_prof_std24\",VAL=3" "dpc1:CAT=\"SP: cInit out\",BCKT=\"b_prof_std15\",VAL=0" "dpc1:CAT=\"SP: cInit out\",BCKT=\"b_prof_std60\",VAL=0" "dpc1:CAT=\"SP: cInit out\",BCKT=\"b_prof_std24\",VAL=0" "dpc1:CAT=\"SP: PDU in\",BCKT=\"b_prof_std15\",VAL=0" "dpc1:CAT=\"SP: PDU in\",BCKT=\"b_prof_std60\",VAL=0" "dpc1:CAT=\"SP: PDU in\",BCKT=\"b_prof_std24\",VAL=3" "dpc1:CAT=\"SP: PDU out\",BCKT=\"b_prof_std15\",VAL=0" "dpc1:CAT=\"SP: PDU out\",BCKT=\"b_prof_std60\",VAL=0" "dpc1:CAT=\"SP: PDU out\",BCKT=\"b_prof_std24\",VAL=3" "dpc1:CAT=\"C7SP: SP DUR UNAVAIL\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"C7SP: SP DUR UNAVAIL\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"C7SP: XMIT MSU DROP/RTE\"," "dpc1:BCKT=\"b_prof_ss7_230\",VAL=0" "dpc1:CAT=\"ISUP: XMIT MSG TOT\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: XMIT MSG TOT\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"ISUP: RCV MSG TOT\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: RCV MSG TOT\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"ISUP: XMIT ACM TOT\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: XMIT ACM TOT\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"ISUP: RCV ACM TOT\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: RCV ACM TOT\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"ISUP: XMIT ANM TOT\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: XMIT ANM TOT\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"ISUP: RCV ANM TOT\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: RCV ANM TOT\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"ISUP: UNEX MSG TOT\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: UNEX MSG TOT\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"ISUP: UNREC MSG TOT\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: UNREC MSG TOT\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" "dpc1:CAT=\"ISUP: CHAN MATE UNAVAILABLE\"," "dpc1:BCKT=\"b_prof_ss75\",VAL=0" "dpc1:CAT=\"ISUP: CHAN MATE UNAVAILABLE\"," "dpc1:BCKT=\"b_prof_ss730\",VAL=0" ;

RTRV-SPC---Retrieve Point Code

Purpose:	This MML command displays the route set for one provisioning component point code or the route sets of all point codes.
Format:	rtrv-spc:<point code> rtrv-spc:all
Description:	point code---The MML component name of a provisioning component point code. All---Displays information for all destination point codes.
Example:	The MML command shown in the following example retrieves a list of all destination point codes: mml> RTRV-SPC:all Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "dpc1:DPC=012.012.012,DNW=2:OPC=011.011.011:IS" "dpc2:DPC=013.013.013,DNW=2:OPC=011.011.011:IS" "dpc3:DPC=014.014.014,DNW=2:OPC=011.011.011:AOOS" "dpc5:DPC=111.111.111,DNW=2:OPC=011.011.011:AOOS" "stp1:DPC=007.007.007,DNW=2:OPC=011.011.011:IS" "stp2:DPC=008.008.008,DNW=2:OPC=011.011.011:IS" "stp3:DPC=009.009.009,DNW=2:OPC=011.011.011:AOOS" ;

RTRV-SS7-SLT---Retrieve SS7 SLT Test Results

Purpose:	This MML command retrieves the results of a Japanese signaling link test. The rtrv result has three cases: TEST PASSED, TEST FAILED and TEST RUNNING.
Format:	rtrv-ss7-slt:<C7 link>
Description:	C7 link---The MML component name of a signaling channel configured for Japanese SS7. (Refer to "Components, Processes, and Properties.")
Example:	The MML command shown in the following example retrieves a signaling link test started by the command sta-ss7-slt:ls1link1: mml> rtrv-ss7-slt:ls1link1 Virtual Switch Controller - VSC-01 2000-01-12 15:18:41 M RTRV "ls1link1:TEST PASSED; COMPLETED 15:18:34" ;

RTRV-SS7-SRT---Retrieve SS7 SRT Test Results

Purpose:	This MML command retrieves the results of a Japanese signaling route test on a point code. The rtrv result has three cases: TEST PASSED, TEST FAILED and TEST RUNNING.
Format:	rtrv-ss7-srt:<point code>:LSET="<C7 link/set>"
Description:	point code---The MML component name of an adjacent point code or destination point code configured for Japanese SS7. C7 link/set---The MML provisioning component name of a linkset or C7 IP link or TDM link used in a linkset.
Example:	The MML command shown in the following example retrieves a signaling route test run with the command rtrv-ss7-srt:dpc1:LSET="ls1". mml> rtrv-ss7-srt:dpc1:LSET="ls1" Virtual Switch Controller - VSC-01 2000-01-12 15:20:09 M RTRV "dpc1:TEST FAILED; TEST TIMEOUT; COMPLETED 15:20:01" ; In this example, the test has failed. The reasons for failure may include the following: TEST TIMEOUT LINK INACTIVE LINKSET INACTIVE ROUTE UNAVAILABLE INVALID TEST PATTERN INVALID SLC FLOW CONTROL ON UNKNOWN REASON

RTRV-TC---Retrieve Bearer States

Purpose:	This MML command displays the state of bearers for one signaling path or for all signaling paths.
Format:	rtrv-tc:<sig path>&<sig path>... rtrv-tc:all
Description:	sig path---Logical signaling destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path. Refer to "Components, Processes, and Properties." all---Displays the bearer states for all signaling paths.
Example:	mml> RTRV-TC:all Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "dpc1:CIC=1,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=2,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=3,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=4,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=5,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=6,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=7,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=8,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=9,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=10,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=11,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=12,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=13,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=14,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=15,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=16,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=17,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=18,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=19,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=20,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=21,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=22,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=23,PST=IS,CALL=IDLE,BLK=NONE" "dpc1:CIC=24,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=1,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=2,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=3,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=4,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=5,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=6,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=7,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=8,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=9,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=10,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=11,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=12,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=13,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=14,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=15,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=16,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=17,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=18,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=19,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=20,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=21,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=22,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=23,PST=IS,CALL=IDLE,BLK=NONE" "dpc2:CIC=24,PST=IS,CALL=IDLE,BLK=NONE" "dpc5:CIC=1,PST=OOS,CALL=IDLE,BLK=NONE" "dpc5:CIC=2,PST=OOS,CALL=IDLE,BLK=NONE" "dpc5:CIC=3,PST=OOS,CALL=IDLE,BLK=NONE" "dpc5:CIC=4,PST=OOS,CALL=IDLE,BLK=NONE" "dpc5:CIC=5,PST=OOS,CALL=IDLE,BLK=NONE" ;
Comments:	This command supports wildcarding.

RTRV-T-HELD---Retrieve States of Bearers Held By Gateway

Purpose:	This MML command displays the state of bearers per signaling path held by gateway, or all bearers held by gateway.
Format:	rtrv-tc-held:<sig path>&<sig path>... rtrv-tc-held:all
Description:	sig path---Logical signaling destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path. Refer to "Components, Processes, and Properties." all---Displays the bearer states for all signaling paths.
Example:	mml> RTRV-TC-HELD:dpc1 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "dpc1" ;
Comment:	This command command was introduced in Release 7.4.

RTRV-TCAP-TRANS---Retrieve TCAP Transactions

Purpose:	This MML command displays the number of active TCAP transactions.
Format:	RTRV-TCAP-TRANS
Example:	mml> RTRV-TCAP-TRANS Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "TCAP-01:TRANS=0" ;

SET-ADMIN-STATE---Set Administrative State

Purpose:	This MML command locks the use of resources for future call creation or unlocks bearer channel resources to make them available for future call creation. A resource can be specified as an entire MGC, a gateway, a signaling path, a trunk group, a span, or an individual trunk. Use this command also to unlock a set resource.
Format:	set-admin-state:<mgc>:lock\|unlock set-admin-state:<gway>:lock\|unlock set-admin-state:<trkGrp>:lock\|unlock set-admin-state:<sigPath>:lock\|unlock set-admin-state:<sigPath>:span=x:lock\|unlock set-admin-state:<sigPath>:span=x,BC=y[,RNG=z]:lock\|unlock set-admin-state:<sigPath>:CIC=x[,RNG=y]:lock\|unlock
Description:	Target parameters are as follows: MGC---Corresponding MML name of media gateway controller. GWAY---Corresponding MML name for media gateway. Not all media gateway types are applicable. Supported types are CU, MUX, MGW, and AVM external nodes. trkGrp---trkGrp is applicable only for time-division multiplexing (TDM). Allow the corresponding MML name for component type "0020" sigPath---Corresponding MML name for any of the following component types. Signaling path of in-band TDM up to MUX and then time switched to TDM media and sent to MGC . Signaling path of in-band TDM signaling up to CU and then encapsulated and sent over ip to the MGC. Signaling path of in-band TDM signaling up to NAS and then converted to NI2 and sent to VSC over IP (that is, FE box<-sig/tdm->NAS<-NI2/ip-> VSC). Signaling path or routeset associated with SS7 destination PC. Signaling path for EISUP. span : spanId is a 16-bit value that identifies an ISDN/PRI physical cable. BC---A numeric value that identifies the non ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC. CIC---A numeric value which identifies the ISUP circuit identification code number. RNG---The range of either bearer channel or circuit identification code.
Example:	mml> set-admin-state:PC-2-2-2-2 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 "pc-2-2-2-2" ;
Comment:	This command command was introduced in Release 7.4. This command supports wildcarding.

SET-ASN-STATE---Set Service State of Auxiliary Signaling Path

Purpose:	This MML command changes the service state of an Auxialiary Signaling Path (ASP) to IS (in service) or OOS (out of service).
Format:	set-asn-state:<aux sig path>:IS\|OOS
Descriptions:	aux sig path---Component name of an existing signaling path.
Example:	`mml>` SET-ASN-STATE:ASP:OOS
Error Code:	None.
Comments:	This command is no longer supported in Release 7.0.

SET-DEST-STATE---Set Service State of a Signaling Path

Purpose:	This MML command changes the service state of a DSS IP or NAS signaling path to IS (in service) or OOS (out of service).
Format:	set-dest-state:<sig path>:IS\|OOS...
Descriptions:	sigpath--- Signaling path. This is the logical signaling destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path. Refer to "Components, Processes, and Properties."
Example:	`mml>` SET-DEST-STATE:ASP:OOS
Error Code:	None.
Comments:	This command supports wildcarding.

SET-EQPT-STATE---Change the Service State of a Card

Purpose:	This MML command changes the service state of an MGC I/O card to in-service (IS) or out-of-service(OOS).
Format:	SET-EQPT-STATE:card:state:IS\|OOS
Description:	card---MML provisioned component name of an I/O card, as provisioned with PROV-ADD. state---IS or OOS.
Example:	The MML command shown in the following example sets the Ethernet card Ether1 to OOS: `mml>` SET-EQPT-STATE:Ether1:OOS Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "Ether1" ;

SET-LNK-STATE---Set Link or linkset Service State

Purpose:	This MML command is used to set the service state of a link or linkset to in service (IS), out of service (OOS), inhibit SS7 link (INH), or (uninhibit SS7 link (UNH).
Format:	set-lnk-state:<C7 link/set>:IS\|OOS\|INH\|UNH
Description:	C7 link/set---MML component name of a link or a linkset, such as a provisioned component, a C7 IP link or a TDM link in a linkset. Use the PROV-RTRV:all command described on page 1-22 to retrieve a list of system components.
Example:	The MML command shown in the following example sets linkset1 and its links to Out-of-Service: `mml>` SET-LNK-STATE:ls1:OOS Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "ls1link1" "ls1link2" ;

SET-LOG---Set Logging Levels

Purpose:	This MML command is used to set the logging level of a process or all processes.
Format:	set-log:<proc>:<log level> set-log:all:<log level>
Description:	proc---The various actively and passively monitored processes running on the MGC. Use the RTRV-SOFTW:ALL command to display all processes. Refer to "Components, Processes, and Properties," for more information about processes. log level---Sets the logging level for the specified process. Logging levels are as follows: CRIT---Critical level messages. ERR---Error condition messages. WARN---Warning condition messages. INFO---Informational messages. TRACE---Trace messages. DEBUG---Debug-level messages (lowest level). A CONFIRM parameter is required for the DEBUG log level. Do not set this log level unless directed to by the TAC. Logging at any given level implies upper levels are included. In other words, setting the INFO logging level also sets the WARN, ERR, and CRIT levels. The order of the levels shown above can also be viewed as a verbosity level, in that at CRIT, there is the least information logged while at DEBUG there is the most information logged.
Example:	The MML command shown in the following example retrieves the logging level of the DSKM-01 process: mml> SET-LOG:PM-01:DEBUG Virtual Switch Controller - VSC-01 2000-01-16 09:38:03 M CMPLD "PM-01:DEBUG" ;
Comment:	This command command was introduced in Release 7.4 and replaces the CHG-LOG command. The process manager (PM-01) is not included in in the "all" parameter, as this is a special process. To set the logging level of PM-01, it must be used individually, as in the example above. Also, the DSKM-01 and LOG-01 (the disk monitor and log server processes, respectively) do not accept log-level change requests.

SET-LSSN-STATE---Set State of Local SSN

Purpose:	This MML command sets the state of a local SSN to IS or OOS.
Format:	set-lssn-state::SSN=<number>,IS\|OOS
Description:	number---The SSN number, as defined in the provisioned component SS7 subsystem. Refer to "Components, Processes, and Properties." state---Set to IS or OOS.
Example:	The MML command shown in the following example sets the ssn1 to OOS: mml> SET-LSSN-STATE::ssn=1,OOS Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "TCAP-01" ;

SET-SC-STATE---Set Signaling Channel State

Purpose:	This MML command changes the service state of a signaling path of a link, or changes the service state of all signaling paths or links on an entire line or linkset
Format:	set-sc-state:<sig path>:IS\|OOS\|FOOS set-sc-state:<line>:IS\|OOS\|FOOS\|INH\|UNH
Description:	sig path---The MML name of the desired logical signaling channel. These should be sig path DSS IP or sig path NAS entities. Refer to "Components, Processes, and Properties." line---Signaling point code state: IS---Places a signaling point code in service. OOS---Takes a signaling point code out of service. FOOS---Forces a signaling point code out of service. INH---inhibit SS7 link. UNH---uninhibit SS7 link.
Example:	The MML command shown in the following example changes the service state of lsetaslc1 to OOS: mml>set-sc-state:lsetaslc1:oos Virtual Switch Controller 1999-09-28 17:09:43 M COMPLD "lsetaslc1"
Comment:	This command command was introduced in Release 7.4. This command supports wildcarding.

SET-SPC-STATE---Set Signaling Point Code State

Purpose:	This MML command changes the service state of a signaling point code to IS or OOS.
Format:	set-spc-state:<point code>:IS\|OOS...
Description:	point code---Signaling point code. state---Signaling point code state: IS---Places a signaling point code in service. OOS---Takes a signaling point code out of service.
Example:	The MML command shown in the following example changes the service state of stp1 to OOS (out of service): mml> SET-SPC-STATE:stp1:oos Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "stp1" ;

SND---Send Message to External Process

Purpose:	This MML command sends command-line text to an external process. MML displays the response, if any.
Format:	snd:ext:<string>
Description:	string---The text of the message.
Example:	The MML command shown in the following example sends a string to be interpreted as a command (assuming that the external process understands the ls command) mml> *SND:EXT:"ls .txt"**
Error Code:	None.
Comments:	This command is no longer supported in Release 7.0.

STA-AUD---Start Auditing Process

Purpose:	This MML command starts the auditing process. To stop the auditing process, enter the STP-AUD command. Audit log files can be found in the$BASEDIR/var/ directory.
Format:	STA-AUD
Description:	No parameters required.
Example:	mml> STA-AUD Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "ENGG-01" ;

STA-AUDIT-GW---Start Auditing of MGCP Gateway

Purpose:	This MML command starts the auditing of an MGCP gateway. There is no stop command at this time. The output of this audit is retrieved by issuing the RTRV-AUDIT-GW command.
Format:	sta-aud-gw:<sig path MGCP> sta-aud-gw:all
Description:	sig path MGCP---MGCP signaling path created with the PROV-ADD MGC command.
Example:	mml> STA-AUDIT-GW:T-1-16 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD ;

STA-SC-TRC---Start Trace

Purpose:	This MML command starts a protocol conversion trace on a signal path or a point code.
Format:	sta-sc-trc:<sig path>:[log="filenameprefix"][,prd=n],confirm sta-sc-trc:<sig path>:span=x[,rng=y][log="filenameprefix"]{prd=n] sta-sc-trc:<sig path>:span=x[[.tc=y],rng=z][log="filenameprefix"]{prd=n] sta-sc-trc:<trkgrp>:[log="filenameprefix"]{prd=n],confirm sta-sc-trc:<trkgrp>:trk=x[,rng=y][log="filenameprefix"]{prd=n]
Description:	sig path---This is the logical signaling destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path. Refer to "Components, Processes, and Properties." log=filenameprefix---The trace files are created and written to a file whose name can vary, depending on how the command is invoked. (A system log message is generated for each trace started. The filenames created as part of the STA-SC-TRC command are contained in the log messages.) If the log= parameter is used, then the value of this parameter is treated as a prefix in the filename. For example: For STA-SC-TRC:<TRKGRP>:LOG="trace1" the filename would be: trace1_<trkgrp>_<sig path>_yyyymmddhhmmss.btr where yyyymmddhhmmss in the filename represents the time (GMT) at which the file is created. All trace files have an extension of ".btr" The trace files are output to the $BASEDIR/var/trace directory. If no LOG parameter is used, default filenames are used for each sta-sc-trc command. For example: For STA-SC-TRC:<TRKGRP>:CONFIRM the filename would be: <trkgrp>_<sig path>_yyyymmddhhmmss.btr For STA-SC-TRC<SIG PATH>:CONFIRM the filename would be: <sig path>_yyyymmddhhmmss.btr prd=n---Trace period in seconds. At the expiration of this period, the system discontinues PDU collection on the signaling path and closes the log file. In the absence of this parameter being supplied, the default period is set to 1800 seconds (30 minutes), at which time the trace automatically will be stopped. confirm---If no confirm option is entered, the command is rejected and you are notified via a message of the potential performance impact of this command. This is required for a sig path level trace or a trkgrp level trace due to the potential performance impact of tacing at these levels. span---The span ID. This is an integer value denoting the traffic channel for the sig path (NFAS only). rng---Range. When used with "span=x" rng=y is an optional range of spans beginning with x and continuing for y spans. When used with "tc=y" rng=z is an optional range of traffic channels beginning with y and continuing for z traffic channels. When used with "trk=x" rng=y is an optional range of contiguous trunks to trace starting with trunk x and ending with trunk y. tc---The traffic channel of interest in integer form. trkgrp---Logical trunk group of interest. Refer to "Components, Processes, and Properties," for more information. trk---Trunk number. This is either a trunk number within the trunk group of interest or the starting trunk of a range. On successful completion, all PDU (protocol data unit) traffic on the path is captured to a log file. This MML command succeeds regardless of the service state of the path.
Example:	The MML command shown in the following example starts a capture session for all PDUs going through the signaling path identified as T-1-16 and stores the trace log in the $BASEDIR/var/trace/T-1-16_yyyymmddyyhhmmss.log file: `mml>` STA-SC-TRC:T-1-16 The MML command shown in the following example starts a capture session for the signaling path identified as T-2-18. It runs for 600 seconds (10 min.) and stores the output in /var/trace/test_yyyymmddyyhhmmss.trc: `mml>` STA-SC-TRC:T-2-18:log=test.trc,prd=600
Error Code:	COMPLD---Path has started tracing. SNVS---Error opening the file; trace cannot be performed because the path is already being traced.

STA-SOFTW---Start a Process or a Process Group

Purpose:	This MML command starts a process or a process group.
Format:	sta-softw:<proc>
Description:	proc---A process, a process group, as shown: procName---Logical identifier for the process. groupName---Logical identifier for the process group.
Example:	The MML command shown in the following example starts the alarm manager process: `mml>` STA-SOFTW:ALM-01 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "ALM-01" ;

STA-SS7-SLT---Start MTP SLT Test On a Link

Purpose:	This MML command starts a signaling link test on a link configured for Japanese SS7.
Format:	sta-ss7-slt:<C7 link>
Description:	C7 link---The MML component name of a signaling channel. (Linkset, C7 IP link, or TDM link used in a linkset. Refer to "Components, Processes, and Properties.")
Example:	The MML command shown in the following example starts a signaling link test on link ls1link1. The result of this test is retrieved by the command rtrv-ss7-slt:ls1link1. `mml>` STA-SS7-SLT:slt:ls1link1 Virtual Switch Controller - VSC-01 2000-01-12 15:18:34 M RTRV "ls1link1" ;

STA-SS7-SRT---Start MTP SRT Test On a Point Code

Purpose:	This MML command starts an MTP signaling route test on a point code configured for Japanese SS7.
Format:	sta-ss7-srt:<point code>:LSET="<C7 link/set>"
Description:	point code---The MML component name of a single point code. C7 link/set---The provisioning component C7 link, TDM link used in a linkset, or linkset. Refer to "Components, Processes, and Properties" for a description of C7 linksets. Use the RTRV-LSET command described on page 1-40 to retrieve a list of linksets.
Example:	The MML command shown in the following example starts a signaling route test on point code dpc1 for with C7 linkset ls1. The result of this test is retrieved by the command rtrv-ss7-srt:dpc1:LSET="ls1". `mml>` STA-SS7-SRT:dpc1:LSET-"ls1" Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "dpc1" ;

STA-TCAP-TRC---Start TCAP Tracing

Purpose:	This MML command starts TCAP tracing.
Format:	STA-TCAP-TRC
Example:	mml> STA-TCAP-TRC Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "TCAP-01" ;

STP-AUD---Stop Auditing Process

Purpose:	This MML command stops the auditing process started with the STA-AUD command.
Format:	STP-AUD
Example:	mml> STP-AUD Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "ENGG-01" ;

STP-CALL---Stop Calls

Purpose:	This MML command stops calls in progress for a specified signalling channel or destination point code. By default, all traffic channels are affected.
Format:	STP-CALL:<mgc> STP-CALL:<gway> STP-CALL:<trkGrp> STP-CALL:<sigPath> STP-CALL:<sigPath>:span=x STP-CALL:<sigPath>:span=x,BC=y[,RNG=z] STP-CALL:<sigPath>:CIC=x[,RNG=y]
Description:	Target parameters are as follows: MGC---Corresponding MML name of media gateway controller. GWAY---Corresponding MML name for media gateway. Not all media gateway types are applicable. Supported types are CU, MUX, MGW, and AVM external nodes. trkGrp---trkGrp is applicable only for time-division multiplexing (TDM). Allow the corresponding MML name for component type "0020" sigPath---Corresponding MML name for any of the following component types. Signaling path of in-band TDM up to MUX and then time switched to TDM media and sent to MGC . Signaling path of in-band TDM signaling up to CU and then encapsulated and sent over ip to the MGC. Signaling path of in-band TDM signaling up to NAS and then converted to NI2 and sent to VSC over IP (that is, FE box<-sig/tdm->NAS<-NI2/ip-> VSC). Signaling path or routeset associated with SS7 destination PC. Signaling path for EISUP. span : spanId is a 16-bit value that identifies an ISDN/PRI physical cable. BC---A numeric value that identifies the non ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC. CIC---A numeric value which identifies the ISUP circuit identification code number. RNG---The range of either bearer channel or circuit identification code.
Example:	mml> STP-CALL:PC-2-2-2-2 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 ;

STP-SC-TRC---Stop One or All Traces

Purpose:	This MML command stops a protocol conversion trace session on one signal path or on all signal paths.
Format:	stp-sc-trc:<sig path> stp-sc-trc:<trkgrp> stp-sc-trc:all
Description:	sig path---Logical identifier for a signaling path. Refer to "Components, Processes, and Properties." trkgrp---Logical identifier for a trunk group. Refer to "Components, Processes, and Properties." all---Stops all traces.
Example:	The MML command shown in the following example stops a capture session on the path identified as T-1-1: `mml>` STP-SC-TRC:T-1-1 The MML command shown in the following example stops all active capture sessions: `mml>` STP-SC-TRC:all Media Gateway Controller 2000-03-21 15:28:03 M COMPLD "ALL:Trace stopped for the following files: ../var/trace/_dpc1_20000321152752.btr " ;

STP-SOFTW---Stop Process or Process Group

Purpose:	This MML command stops a process, a process group, or all processes (except the process manager).
Format:	stp-softw:<proc>:[kill] stp-softw:all:[kill]
Description:	all---Stops all processes. CONFIRM---Use the confirm parameter when stopping all processes. proc---Logical identifier for a process or a process group. KILL---Stops processes regardless of the state of dependent processes.
Example:	The MML command shown in the following example stops the Cisco I/O channel manager process regardless of the operational state of the dependent processes: `mml>` STP-SOFTW:IOCM-01:KILL The MML command shown in the following example shuts down the software except for the process manager: `mml>` STP-SOFTW:all:confirm Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD SWDT "ALL" /* Status, Waiting for Dependent Processes to Stop This is not an error, run rtrv-softw to see when all desired processes have stopped */ ;
Comments:	In a dual MGC configuration, the STP-SOFTW:all command does not shut down both controllers because the failover daemon immediately restarts procM. To shut down the active MGC in a dual configuration, follow the procedures described in Cisco Media Gateway Controller Release 7 Provisioning Guide. Similarly, STP-SW:PM-01 does not stop the process manager. Use the command RTRV-SOFTW:ALL to show all component names available as targets for this command.

S TP-TCAP-TRC---Stop TCAP Tracing

Purpose:	This MML command stops TCAP tracing that has been started with the STA-TCAP-TRC command.
Format:	STP-TCAP-TRC
Example:	mml> STP-TCAP-TRC Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV "TCAP-01" ;

SW-OVR---Manual Switchover

Purpose:	This MML command enables a switchover from an active to a standby system.
Format:	SW-OVR::CONFIRM
Example:	mml> SW-OVR::CONFIRM Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD ;

TST-COT---Manual COT

Purpose:	This MML command executes a continuity test on a specified remote switch circuit.
Format:	tst-cot:<point code>:CIC=<number>
Description:	point code---MML component name of a provisioning component point code. CIC=number---A numeric value that identifies the ISUP circuit identification code number.
Example:	mml> TST-COT:dpc1:CIC=5 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD ;

UNBLK-CIC---Unblock a Circuit or a Circuit Range

Purpose:	This MML command unblocks a circuit or a range of circuits that have been blocked with the BLK-CIC command.
Format:	unblk-cic:<point code>:CIC=<number>[,RNG=<slaves>]
Description:	point code---MML component name of a provisioning component point code. number---A valid circuit identification code (CIC). slaves---A number such that number+slaves is a valid CIC. All circuits between number and number+range are unblocked. The range should not span trunks. For example, to unblock all of the CICs from 60 through 90, the number would be 60 and the slaves would be 30. You would enter the following command: mml> UNBLK-CIC:dpc1:CIC=60, RNG=30 This unblocks CIC 60 and the next 30 CICs.
Example:	The MML command shown in the following example unblocks CICs 5-15 for destination point code dpc1: mml> UNBLK-CIC:dpc1:CIC=5,RNG=10 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M COMPLD "dpc1" ;

VLD-CIC---Validate a Circuit

Purpose:	This MML command validates a circuit on a specified point code and CIC.
Format:	vld-cic:<point code>:CIC=<number>
Description:	point code---MML component name of a provisioning component point code. number---A valid circuit identification code.
Example:	mml> VLD-CIC:PC7:CIC=36

Symbol	Description
\|	A pipe. Either the preceding symbol or the succeeding symbol may occur, but not both in succession.
[ ]	These brackets enclose an optional parameter.
{ \| }	Either the preceding symbol or the succeeding symbol may occur, but not both in succession. There may be more than two symbols and pipes.
< >	This symbol encloses a symbol specifier.

Symbol	Description
:	A parameter separator.
::	An empty parameter block.
&	Arguments are grouped together so that one parameter may convey several arguments.
;	End of command (optional). Anything on the same line after this symbol is treated as a comment.

Error Code	Meaning	Definition
DENY	Command denied	The command is recognized, but the system does not allow you to perform the requested function.
ICNV	Input command not valid	The MML command is not recognized.
IDNV	Input data not valid	An unknown parameter was entered. Example: mml> RESET-CIC:dpc2:cic5 Virtual Switch Controller 2000-01-03 15:22:48 M RTRV IDNV "dpc2" /* Input, Data Not Valid */ ;
IISP	Input syntax error	An incorrect syntax was used. Example: mml> RESET-CIC:dpc9,cic22 Virtual Switch Controller - VSC-01 2000-01-12 M RTRV IISP reset-cic:dpc9, /* Input, Syntax Error */ ;
IITA	Invalid target	The requested operation cannot be performed on the network element component, or the component does not exist in the system. Example: mml> RESET-CIC:dpc9:CIC=10 Virtual Switch Controller - VSC-01 2000-01-12 15:19:51 M RTRV IITA "dpc9" /* Input, Invalid Target */ ;
IPRM	Input parameter missing	An expected parameter cannot be found.
SABT	Status abort	The command did not finish in the time allocated.
SCNF	Status not found	There are problems with the engine.
SNVS	State not in valid state	The requested operation failed because the component is not configured to accept the operation. It is possible that the component is already performing the operation or is already in the desired state.
SNSP	State not supported	This operation is not supported by the component.
SROF	Status requested operation failed	The requested operation failed on the component.

MML Group Name	Component Name	Component Types
ALL-COUNTERS	Any Component
LIF-GROUP	TMDLink and C7IPLink	x0010 and x001d
SC-GROUP	Tdmlnks supporting DPNSS or ISDN PRI	x0010
DL-GROUP	Adaptor/Card for TDM	x0005
ASP-GROUP	N/A	x00e0
SP-GROUP	All Signal Services	x0007, x0013, x0014, x0018, x0019,x001b, x001c, x0034, x0035
C7LNK-GROUP	LinkSet	x0008
C7SP-GROUP	PointCode and Adjacent Point Code	x0013, x001e
TpPRILinkStatTable	Facility Associated Signaling (FAS) Signaling Service	x0007
ISUP-GROUP	PointCode supporting ISUP	x0013
TUP-GROUP	PointCode supporting TUP	x0013
NUP-GROUP	PointCode supporting NUP	x0013
OVL-GROUP	Network element root id	x00010001
STATE-GROUP	Network element root id	x00010001
TCAP-GROUP	Network element root id	x00010001
SCCP-GROUP	Network element root id	x00010001

Table of Contents

MML Command Reference