Cisco PGW 2200 Softswitch Release 9 MML Command Reference
Chapter 3 - Commands for Operations, Maintenance, and Troubleshooting
Downloads: This chapterpdf (PDF - 733.0KB) The complete bookPDF (PDF - 2.86MB) | Feedback

Table of Contents

Commands for Operations, Maintenance, and Troubleshooting

ACK-ALM—Acknowledge Alarm

BLK-CIC—Block a Circuit or a Circuit Range

CLR-MEAS— Reset a Measurement Category

CLR-TCAP-TRANS—Clear TCAP Transactions

DIAGLOG—Diagnostics Log

KILL-CALL—Terminate a Call

PRT-CALL—Print Call

QUERY-CIC— Execute Circuit Query

RESET-CIC— Reset a Circuit or a Circuit Range

RTRV-ADMIN-STATE— Retrieve Administrative State

RTRV-ALMS—Retrieve Active Alarms

RTRV-ASSOCIATION— Display State of SCTP Association

RTRV-AUD-GW— Retrieve Auditing of MGCP Gateway

RTRV-C7LNK— Retrieve Attributes of a Linkset

RTRV-CALLIM—Retrieves the Call Limiting Function Status

RTRV-CALLINFO—Display Call IDs of EISUP/SIP

RTRV-CFG—Retrieve Configuration Table

RTRV-CIC—Retrieve Bearer Channels

RTRV-CTR—Retrieve Measurement Counter

RTRV-DCHAN— Retrieve D-Channel Status

RTRV-DEST— Retrieve Destination

RTRV-DNS-INFO— Retrieve DNS Cache

RTRV-EQPT—Retrieve Service State of a Component

RTRV-H248:CNTXS:SIGPATH—Retrieve H.248 Sigpath Information (Release 9.7(3))

RTRV-IPLNK—Retrieve Attributes of an IP Link

RTRV-IPROUTE—Display Primary and Secondary States of an IP Route

RTRV-LICS— DISPLAY LICENSES

RTRV-LOCLABEL

RTRV-LOG

RTRV-LSET—Retrieve Linkset Service State

RTRV-LSSN— Retrieve State of All Local SSNs

RTRV-MML— Retrieve Active MML Sessions

RTRV-NE— Retrieve Network Element Attributes

RTRV-NE-HEALTH— Retrieve Network Element Health

RTRV-OVLD— Retrieve Overload Level

RTRV-RASERVER (Release 9.7(3))

RTRV-RSSN—Retrieve State of All Remote SSNs

RTRV-RTE— Retrieve Route

RTRV-SC-TRC— Retrieve Names of Open Signal Channel Traces

RTRV-SGP—Display the Primary and Secondary States of an SGP

RTRV-SIP—Display Call IDs of SIP Calls

RTRV-SOFTW—Retrieve Software Status for a Process

RTRV-SPC— Retrieve Point Code

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

RTRV-SS7-SLT— Retrieve SS7 SLT Test Results

RTRV-SS7-SRT— Retrieve SS7 SRT Test Results

RTRV-TC—Retrieve Bearer States

RTRV-TCAP-TRANS— Retrieve TCAP Transactions

RTRV-TC-HELD— Retrieve States of Bearer Channels Held by Gateway

RTRV-THRES— Retrieve Threshold Values

RTRV-VIRT-TC—Retrieve DPNSS Virtual Bearer Channel Status (Release 9.6(1) and 9.7(3))

SET-ADMIN-STATE— Set Administrative State

SET-ASSOCIATION— Changing SCTP Association Primary State

SET-C7LNK—Change the Service State of an SS7 Link

SET-CALLIM—Sets the Call Limiting Function

SET-DCHAN—Change the Service State of a D-Channel Link

SET-DEST—Set the Service State of a Signal Path

SET-IPLNK— Change the Service State of an IP Link

SET-IPROUTE—Changing IP Route Primary State

SET-LOG—Set Logging Levels

SET-LSSN-STATE— Set State of Local SSN

SET-SPC— Set Signal Point Code State

SET-THRES— Set Threshold Values

SND—Send Message to External Process

STA-ABN-TRC— Start Abnormal Trace

STA-AUD— Start Auditing Process

STA-AUD-CIC—Start CIC State Auditing Process

STA-AUD-GW— Start Auditing of MGCP Gateway

STA-AUD-H248—Start Audit of H.248 Gateway (Release 9.7(3))

STA-DNS-INFO— Start Retrieve Process of DNS Cache

STA-DNS-PURGE— Start Purge of DNS Cache

STA-SC-TRC—Start Trace

STA-SS7-SLT— Start MTP SLT Test on a Link

STA-SS7-SRT— Start MTP SRT Test on an SS7PATH

STA-TCAP-TRC— Start TCAP Tracing

STP-ABN-TRC— Stop Abnormal Trace

STP-AUD— Stop Auditing Process

STP-CALL— Stop Calls

STP-SC-TRC—Stop One or All Traces

STP-TCAP-TRC— Stop TCAP Tracing

SW-OVER— Manual Switchover

TST-COT— Manual COT

UNBLK-CIC—Unblock a Circuit or a Circuit Range

VLD-CIC—Validate a Circuit

Commands for Operations, Maintenance, and Troubleshooting

Revised: Aug 30, 2011, OL-1116-24

This chapter describes the Machine-Man Language (MML) commands for operations, maintenance, and troubleshooting on the Cisco PGW 2200 Softswitch Release 9.

ACK-ALM—Acknowledge Alarm

 

Purpose:

Acknowledges 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, the associated alarm relay is turned off.

Syntax:

ack-alm:<comp>
ack-alm:<comp>:”<alm cat>”
ack-alm:<comp>:”<alm sev>”

Input Description:


Note The terms for alarm category and severity are case sensitive, and they must be in quotation marks.


Example:

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

mml> ACK-ALM:IOCM-01:”CONFIG FAIL”
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
;

Comments:

Performance Impact Category: A

The format of the alarm category name must be the same as the format of the alarm category name retrieved with the RTRV-ALMS command (which is why the alarm category must be in uppercase).

This command allows wildcarding.

BLK-CIC—Block a Circuit or a Circuit Range

 

Purpose:

Blocks a circuit or range of circuits from carrying calls.

Syntax:

blk-cic:<sig path>:CIC=<number>[,RNG=<range>]

Input Description:

  • sig path —MML component name of a signal path created with the prov-add:sigpath command.
  • number —A valid circuit identification code (CIC).
  • range —A number such that number + range is a valid CIC. All circuits between number and number + range are blocked.

Example:

The MML command shown in the following example blocks CIC 1353 on signal path ss7svc1:

mml> BLK-CIC:ss7svc1:CIC=1353
MGC-01 - Media Gateway Controller 2001-02-08 10:21:11
M COMPLD
“ss7svc1”
;

Comments:

Performance Impact Category: B

Enter the RTRV-TC:ALL command (or the RTRV-CIC command) to see whether CICs were blocked.

Blocking a single CIC causes a BLO 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 can be used only to block CICs within a given trunk (T1 or E1).

To unblock a CIC, use the UNBLK-CIC command.

CLR-MEAS—Reset a Measurement Category

Purpose:

Resets a measurement category of a component.

Syntax:

clr-meas:<comp>:”<meas cat>”

Input Description:

To retrieve a current list of measurement categories, use the MML command prov-rtrv.

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
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
;

Comments:

Performance Impact Category: A

Components are described in Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. For a description of measurement categories, see Cisco PGW 2200 Softswitch Release 9 Operations, Maintenance, and Troubleshooting Guide.

CLR-TCAP-TRANS—Clear TCAP Transactions

 

Purpose:

Clears all transaction capabilities application part (TCAP) transactions that are older than the specified period.

Syntax:

clr-tcap-trans::T=<number>

Input Description:

T —The time period, in seconds, after which you should clear TCAP transactions. The integer range is 0 to 2147483647 in Release 9.7(3) and earlier releases.

In Release 9.8(1), the integer range is 3601 to 2147483647. In Release 9.8(1), if the value is set to less than 3601, the command is ignored.

Example:

The MML command shown in the following example clears all TCAP transactions that are older than 3601 seconds:

mml> CLR-TCAP-TRANS::T=3601
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
“TCAP-01:CLRD=0”
;

DIAGLOG—Diagnostics Log

 

Purpose :

Starts and stops event logging into a diagnostics log.

Syntax:

diaglog:<file name>:START | STOP

Input 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.
  • START | STOP—Instructs the Cisco PGW 2200 Softswitch whether to start or stop logging.

Example :

The MML command shown in the following example starts logging into the diagnostics log named test:

mml> DIAGLOG:test:start
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
;

Comments:

See Cisco PGW 2200 Softswitch Release 9 Messages Reference Guide for more information about log files.

KILL-CALL—Terminate a Call

Purpose :

Resolves a stuck or hung CIC associated with a single call instance or a range of calls on the Cisco PGW 2200 Softswitch. Forcefully releases a bearer channel associated with a single call instance that cannot be returned to the idle state with the reset-cic or stp-call commands.

Note This command only releases bearer channels locally on the Cisco PGW 2200 Softswitch. No SS7 messages are sent to the remote call side (destination point code or destination MGW).

Syntax:

kill-call:<sigpath>:CID=eisip_callid,nodeid=nodeid,confirm
kill-call:{sigpath|target}:[span=number,]confirm
kill-call:{sigpath|target}:[span=number,][BC=number,][RNG=number,]confirm
kill-call:{sigpath|target}:CIC=number of CIC,[RNG=number,]confirm
kill-call:{sigpath|target}:CID=sip call id,confirm

Input Description:

  • sigpath—MML name of the SS7 or ISDN-PRI signal path associated with the stuck CIC.
  • target—MML name of the media gateway controller, gateway, or trunk group associated with the stuck span and bearer channel.
  • span—Number of the affected span.
  • BC—Number of the affected bearer channel.
  • RNG—Number that represents a range of affected bearer channels or CICs.
  • CIC—Number of the affected Circuit Identification Code.
  • CID—Unique call identifier.

Example :

mml> KILL-CALL:eisup-sigpath:cid="454545",nodeid=28871553,confirm
mml> KILL-CALL:sip-sigpath: cid="ccdd33ee-423fdedd-55438954-1@172.22.119.215",confirm
mml> KILL-CALL:ss7svc1:CIC=1,confirm
mml> KILL-CALL:tg-4444:confirm
mml> KILL-CALL:sip-sigpath:CID=”ewrtdegdfg-eytergt-dfgd@cisco.com”, confirm

Comments:

Performance Impact Category: D

Before using this command, attempt to manually clear the call with the reset-cic and stp-call commands. See Cisco PGW 2200 SoftswitchRelease 9 Operations, Maintenance, and Troubleshooting Guide for information about resolving a stuck or hung CIC.

PRT-CALL—Print Call

 

Purpose:

Prints diagnostic information about an active call to a log file.

Syntax:

prt-call:{sigpath}:[CIC=number,|span=number,][BC=number,|CID=number,]
LOG=”log name”
prt-call:<sigpath>:CIC=<n>|span=<n>[bc=<n>][,LOG=<logname>][,EVT]]
prt-call:<sigpath>:CID=<eisup_callid>,nodeid=<nodeid>,LOG=<logname>

Input Description:

  • sigpath —Corresponding MML name for any of the following component types:

Signal path of in-band TDM up to MUX and then time switched to TDM media and sent to Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to CU and then encapsulated and sent over IP to the Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to NAS and then converted to NI2 and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP-> MGC)

Signal path or route set associated with the SS7 destination PC

Signal path for EISUP

  • cic—The ISUP circuit identification code number.
  • span—spanId is a 16-bit value that identifies an ISDN/PRI physical cable.
  • bc—The non-ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC.
  • cid—Unique call identifier.
  • log—The name of an ASCII log file to which the output is written. The name given in this parameter is used as a prefix to the actual name of the file, which includes the signal path name and date and time. If no log filename is provided, a default name consisting of the signal path and date and time is created. The extension of these log files is prt and the files are located in the ../var/trace directory.
  • evt —Reserved for future use.

Example:

The MML command shown in the following example prints information about hung calls to a file:

mml> PRT-CALL:DMS100-PC:CIC=124
Media Gateway Controller 2000-06-14 11:02:39
M COMPLD
"dms100-pc"
;

The output for this prt-call command is the file $BASEDIR/var/trace/pc_20000614110239.prt.

The MML command shown in the following example prints information about hung calls to a file:

mml> PRT-CALL:BH581-1:SPAN=0,BC=1
Media Gateway Controller 2000-06-14 11:10:22
M COMPLD
"bh581-1"
;

The MML command shown in the following example prints information about hung calls to a file:

mml> PRT-CALL:BH581-1:SPAN=0,BC=1,LOG="BH581-PRINT"
Media Gateway Controller 2000-06-14 11:10:59
M COMPLD
"bh581-1"
;

The output for this prt-call command is the file $BASEDIR/var/trace/bh581-print_bh581-1_20000614111059.prt

Example :

mml> prt-call:eisup-sigpath:cid="5954",nodeid=28871553,log="logname"
mml> prt-call:sip-sigpath:cid="ccdd33ee-423fdedd-55438954-1@172.22.119.215"
,log="logname"
mml> PRT-CALL:ss7svc1:cic=1,LOG=”log1”
mml> PRT-CALL:pri-sigpath:span=1,BC=2,LOG=”log2”
mml> PRT-CALL:sip-sigpath:CID=”kjhfqekugher-hdekjfh-fjkreh-ghf@cisco.com”,
LOG=”logsip”

Comments:

Performance Impact Category: C

This command allows wildcards on signal paths.

QUERY-CIC—Execute Circuit Query

 

Purpose:

Executes a circuit status query for a circuit or a circuit range.


Note Not all SS7 variants support the querying of circuit identification codes (CICs). If this command is executed on a signaling service that is configured for an SS7 variant that does not support the querying of CICs, an error code, SABT, is returned when the query operation times out.


Syntax:

query-cic:<sig path>:CIC=<number>[,RNG=<range>][,RSLV]

Input
Description:

  • sig path—MML component name of a signal path created with PROV-ADD.
  • number—A valid CIC.
  • range—A number such that number + range is a valid CIC. All circuits between number and number + range are queried.
  • rslv —For ANSI SS7 circuits, if this parameter is on, the system attempts to resolve differences between the Cisco PGW 2200 Softswitch CIC state and the remote switch CIC state. For ITU SS7 circuits, this parameter is ignored.

Example:

The MML command shown in the following example queries CICs 20 through 24 on the signal path. In this example, CIC=24 is a case in which the local primary state and secondary state differ.

mml> QUERY-CIC:ss7svc1:CIC=20,RNG=4
 
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"ss7svc1:CIC=20;LPST=IS;LSST=IDLE;RPST=IS;RSST=IDLE"
"ss7svc1:CIC=21;LPST=IS;LSST=IDLE;RPST=IS;RSST=IDLE"
"ss7svc1:CIC=22;LPST=IS;LSST=IDLE;RPST=IS;RSST=IDLE"
"ss7svc1:CIC=23;LPST=IS;LSST=IDLE;RPST=IS;RSST=IDLE"
"ss7svc1:CIC=24;LPST=OOS;LSST=IDLE_LOC_BLOC;RPST=IS;RSST=IDLE"
;

Output Description:

  • CIC—Circuit identification code.
  • LPST—Primary state.

IS—In service.

OOS—Out of service.

TRNS—Transient; the state is currently being changed.

  • LSST—Local secondary state.

N/A—Not available.

UNEQUIPPED—Unequipped.

IC_BUSY—Incoming is busy.

IC_BUSY_LOC_BLOC—Incoming is busy, blocked locally.

IC_BUSY_REM_BLOC—Incoming is busy, blocked remotely.

IC_BUSY_BOTH_BLOC—Incoming is busy, blocked both remotely and locally.

OG_BUSY—Outgoing is busy.

OG_BUSY_LOC_BLOC—Outgoing is busy, blocked locally.

OG_BUSY_REM_BLOC—Outgoing is busy, blocked remotely.

OG_BUSY_BOTH_BLOC—Outgoing is busy, blocked both remotely and locally.

IDLE—The circuit is idle, available for use.

IDLE_LOC_BLOC—Idle, blocked locally.

IDLE_REM_BLOC—Idle, blocked remotely.

IDLE_BOTH_BLOC—Idle, blocked both locally and remotely.

  • RPST—Remote primary state (states are same as LPST, above).
  • RSST—Remote secondary state (states are same as LSST, above).

Comments:

Performance Impact Category: B

If the remote states and local states are the same, only the remote states are shown in the output.

RESET-CIC—Reset a Circuit or a Circuit Range

 

Purpose:

Resets or activates a circuit or a range of circuits.

Syntax:

reset-cic:<sig path>:CIC=<number>[,RNG=<range>]

Input Description:

  • sig path MML component name of a signal path created with PROV-ADD.
  • number —A valid circuit identification code (CIC).
  • range —A number such that number + range is a valid CIC. All circuits between number and number +range are reset.

Example:

The MML command shown in the following example resets CICs 1000 to 1002 on signal path ss7svc1

mml> RESET-CIC:SS7SVC1:CIC=1000,RNG=2
MGC-01 - Media Gateway Controller 2001-02-08 12:36:47
M COMPLD
"ss7svc1"

Comments:

Performance Impact Category: B

RTRV-ADMIN-STATE—Retrieve Administrative State

 

Purpose:

Provides the following summary report:

  • Inferred target state:

If all circuits are locked, the inferred target administrative state is locked.

If at least one circuit is unlocked, the inferred target administrative state is unlocked.

If there is a mixture of locked and shutdown, the inferred target administrative state is shut down.

  • Number of bearer channels that are in locked state.
  • Number of bearer channels that are in unlocked state.
  • Number of bearer channels that are in shutdown state.

Syntax:

rtrv-admin-state:<mgc>
rtrv-admin-state:<gway>
rtrv-admin-state:<trkGrp>
rtrv-admin-state:<sig path>
rtrv-admin-state:<sigPath>:span=x
rtrv-admin-state:<sigPath>:span=x,BC=y[,RNG=z]
rtrv-admin-state:<sigPath>:CIC=x[,RNG=y]

Input 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".

Note When specifying the trunk group number, enter the prefix tg-.
Example: rtrv-admin-state:tg-404


  • sigpath—Corresponding MML name for any of the following component types:

Signal path of in-band TDM up to MUX and then time switched to TDM media and sent to the Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to CU and then encapsulated and sent over IP to the Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to NAS and then converted to NI2 and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP-> Cisco PGW 2200 Softswitch

Signal path or route set associated with SS7 destination PC

Signal path for EISUP

  • span—A 16-bit value that identifies an ISDN/PRI physical cable.
  • bc—The non-ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC.
  • cic—The ISUP circuit identification code number.
  • rng—The range of either bearer channels or circuit identification codes.

Output Description:

  • PST—Primary administrative state:

LOCK —Locked state

UNLOCK —Unlocked state

SHUTDOWN—Shutdown state

  • LOCK —Number of bearer channels in locked state.
  • UNLOCK —Number of bearer channels in unlocked state.
  • SHUTDOWN—Number of bearer channels in shutdown state.

Example:

The MML command shown in the following example retrieves for signal path ss7svc1 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:SS7SVC1
MGC-01 - Media Gateway Controller 2001-02-08 12:39:57
M COMPLD
"ss7svc1:PST=UNLOCK,LOCK=0,UNLOCK=1207,SHUTDOWN=0"
;

Comments:

Performance Impact Category: C

This command allows wildcarding.

RTRV-ALMS—Retrieve Active Alarms

Purpose:

Displays all active alarms.

Syntax:

rtrv-alms
rtrv-alms::cont

Input Description:

cont—Tells the system to display alarm events until Ctrl-C is pressed.

Output Description:

See Cisco PGW 2200 Softswitch Release 9 Messages Reference Guide for a description of each of the alarms and recommended actions.

Alarm severity levels (SEV=) are as follows:

  • Critical (CR)
  • Major (MJ)
  • Minor (MN)
  • Informational

Example:

The MML command shown in the following example displays the names of all active alarms:

mml> RTRV-ALMS
Media Gateway Controller - MGC-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"
;

Example:

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
Media Gateway Controller - MGC-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) */
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
** "dpc1:ALM=\"PC UNAVAIL\",STATE=CLEARED"
;
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
** "dpc2:ALM=\"PC UNAVAIL\",STATE=CLEARED"
;
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
A "ls1link1:ALM=\"CHAN BAD TOT 15\",STATE=CLEARED"
;
Ctrl-C
^C/* Ctrl-C pressed */
mml>

Comments:

Performance Impact Category: A

RTRV-ASSOCIATION—Display State of SCTP Association

 

Purpose:

Displays the primary and secondary states of an SCTP association.

Syntax:

rtrv-association:assoc_name
rtrv-association:all

Input Description:

  • Assoc_name —MML name of a previously configured SCTP association.
  • All —All associations

Output Description:

SCTP Association—MML name of SCTP association specified.

PST—Primary state; valid values are:

INB—Installed busy; association has been created but has not yet been commanded IN or OOS with the set-association command.

IS—In service

OOS—Out of service

SST—Secondary state; valid values are:

COOS—Commanded out of service

STBY—The local platform state is standby

CONF—Out of service because of a configuration failure

Example:

The MML command shown in the following example retrieves the state of all associations:

mml> rtrv-association:all
 
MGC-01 - Media Gateway Controller 2001-01-01 18:57:26
M RTRV
"assoc1:IS"
"assoc2:OOS,COOS"
;

Comments:

Performance Impact Category: A

RTRV-AUD-GW—Retrieve Auditing of MGCP Gateway

 

Purpose:

Retrieves the auditing of an MGCP gateway started by the STA-AUD-GW command.

Note The STA-AUDIT-GW and RTRV-AUDIT-GW commands are no longer supported as of Release 9.6(1)

Syntax:

rtrv-aud-gw:<sig path MGCP>
rtrv-aud-gw:all

Input Description:

sig path MGCP —Retrieves the auditing of an MGCP signal path created with the PROV-ADD:MGC command.

all—Retrieves the auditing of all MGCPs.

Output Description:

  • PASS—The audit was successful.

<text> —This is text returned from the Input-Output Channel Controller (IOCC). It can include endpoint name, connections ID, or other text explaining the result.

  • FAIL—The audit was unsuccessful.

<text> —This is text returned from the IOCC. It can include endpoint name, connection IDs, or other text explaining the result.

Example:

The MML command shown in the following example retrieves the results of an audit started on SP1-MGCP1:

mml> RTRV-AUD-GW:SP1-MGCP1
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
"SP1-MGCP1:Audit gw received at 2000-01-12 15:19:51
Audit GW PASSED
pass pn
pass pt - not alarmed
pass sl - not alarmed
pass nl
pass bp
pass cp
pass rp
pass nb
pass uc
pass ic
pass us
pass is"
;

Comments:

Performance Impact Category: C

RTRV-C7LNK—Retrieve Attributes of a Linkset

 

Purpose:

Retrieves the attributes of a link or a linkset.

Syntax:

rtrv-c7lnk:<C7 linkset|C7 link>
rtrv-c7lnk:all

Input Description:

  • c7 linkset —The provisioning component C7 link, aTDM link used in a linkset, or a linkset. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of C7 linksets. Use the RTRV-LSET command, described in the “RTRV-LSET—Retrieve Linkset Service State” section, to retrieve a list of linksets.
  • all—Retrieves the attributes of all links and linksets.

Output Description:

  • LID—Link or linkset ID
  • PST—Primary state; valid values are:

AOOS—The system has taken the resource out of service

INB—Installed busy (resource has been created but not yet commanded IS or OOS via the SET-C7LNK command)

IS—In service

COOS—Commanded out of service

FOOS—Forced out of service

OOS—Out of service

TRNS—Transient; the state is currently being changed

UNK—Unknown

Example:

The MML command shown in the following example retrieves the attributes of SS7 link 0 for linkset 1:

mml> RTRV-C7LNK:SS7LK0-1
MGC-01 - Media Gateway Controller 2000-11-19 21:28:45
M RTRV
"ss7lk0-1:lnkset1,LID=0:IS"
/* SS7 link 0 for lnkset1 to 2600-8 */
;

Comments:

Performance Impact Category: A

RTRV-CALLIM—Retrieves the Call Limiting Function Status

 

Purpose:

Retrieves the MGCP Scripting Support on the Cisco PGW 2200 Softswitch function status for the whole Cisco PGW 2200 Softswitch.

Syntax:

rtrv-callim

Output Description:

ENABLE | DISABLE —Instructs the Cisco PGW 2200 Softswitch to either enable or disable call limiting.

Example:

The MML command shown in the following example displays the state of this feature:

mml> rtrv-callim:
MGC-01 - Media Gateway Controller 2004-03-22 19:49:54.998 PST M RTRV
"ENGG-01:ENABLE"
;

Comments:

Performance Impact Category: A

RTRV-CALLINFO—Display Call IDs of EISUP/SIP

 

Purpose :

Displays the EISUP/SIP call IDs of all EISUP/SIP calls on the PGW system.This command replaces the rtrv-sip command.

Syntax:

rtrv-callinfo:target:[all|eisup|sip|ip|TDM]| [,calltime=minutes] [,detail]

Input Description:

  • target—MML name of the media gateway controller, gateway, or trunk group associated with the call.
  • all —Displays all calls from the target using EISUP/SIP protocols. Half calls can be retrieved with this option.

Note The Cisco PGW 2200 Softswitch can perform multi-leg services. A normal call has two call legs. Each call leg is a half call leg. When a new call leg is added by a service, a whole new call is created to handle this call leg. Call sides determine how to handle these call legs. After that, redundant call sides are deleted in one of more call instances. You may have the originating side of one call interworking with the terminating side of another. A special counting of these multi-leg calls is introduced to avoid that twice the number of calls in progress is counted when the actual traffic is 50% of the total call instances.


  • eisup —Displays EISUP-to-EISUP calls from the target.
  • sip —Displays SIP-to-SIP calls from the target.
  • ip —Displays SIP, EISUP, or H323 calls from the target.
  • TDM —Displays all SIP-to-TDM protocol calls, including SS7, ISDN, DPNSS, and QSIG calls from the target.
  • calltime —Displays calls that have been established on the system for at least the specified period, in minutes. For example, calltime=120 displays all calls established for 2 hours or more.
  • detail —Displays the To and From numbers.

Example s:

mml> rtrv-callinfo:eisup-sigpath:all
mml> rtrv-callinfo:eisup-sigpath:ip
mml> rtrv-callinfo:all:timerperiod=120
mml> rtrv-callinfo:sip:timerperiod=120,detail
 

when a call has video media, rtrv-callinfo:all:detail will has the following corresponding output:

mml> rtrv-callinfo:all:detail
Retrieving results. This could take a few moments...
MGC-01 - Media Gateway Controller 2009-12-22 02:01:46.946 EST
M RTRV
"sip-path:CallID=6,Call_Type=REAL,CgPN=1965,CdPN=6781955"
"sip-path:CALL_STA=2009-12-22 02:01:31 EST"
"sip-path:CID=d35b0680-b3016eca-29bba-8632000a@10.0.50.134"
"sip-path:CALL=IN,MediaIPAddr=10.0.50.81,MediaPort=20012,Codec=PCMU" "sip-path:VideoMediaIPAddr=10.0.50.81,VideoMediaPort=20014,VideoCodec=H264"
"sip-path:CID=d35b0680-b3016eca-29bba-8632000a@10.0.50.134"
"sip-path:CALL=OUT,MediaIPAddr=10.0.50.3,MediaPort=20024,Codec=PCMU" "sip-path:VideoMediaIPAddr=10.0.50.3,VideoMediaPort=20026,VideoCodec=H264"
 

If the call has no video media, the following output will display:

mml> rtrv-callinfo:all:detail
Retrieving results. This could take a few moments...
MGC-01 - Media Gateway Controller 2009-12-21 23:27:56.556 EST
M RTRV
"sip-path:CallID=9,Call_Type=REAL,CgPN=1965,CdPN=6781955"
"sip-path:CALL_STA=2009-12-21 23:27:41 EST"
"sip-path:CID=55d8cb80-b3014abc-2999b-8632000a@10.0.50.134"
"sip-path:CALL=IN,MediaIPAddr=10.0.50.81,MediaPort=20084,Codec=PCMA"
"sip-path:CID=6856b654-24130a6d-6e45d965-4@10.0.50.178"
"sip-path:CALL=OUT,MediaIPAddr=10.0.50.3,MediaPort=20094,Codec=PCMA"
 

When a call has transcoding service, different codecs are used on every call side. In the following example, codec on the originating leg is PCMA(g711a), and codec on the terminating leg is G729.

mml> rtrv-callinfo:all:detail
Retrieving results. This could take a few moments...
MGC-01 - Media Gateway Controller 2009-12-22 02:05:46.040 EST
M RTRV
"sip-path:CallID=8,Call_Type=REAL,CgPN=1965,CdPN=6781955"
"sip-path:CALL_STA=2009-12-22 02:05:33 EST"
"sip-path:CID=130b6b8c-4048e363-1158d881-6@10.0.50.178"
"sip-path:CALL=OUT,MediaIPAddr=10.0.182.2,MediaPort=16550,Codec=g729"
"sip-path:CID=6431e200-b3016fbd-29bcb-8632000a@10.0.50.134"
"sip-path:CALL=IN,MediaIPAddr=10.0.182.2,MediaPort=16544,Codec=pcma"
 

For SIP B2BUA, different call legs are supported for each call side in a call. In the following example, CID (Call ID to SIP) of originating side is different from that of the terminating side.

mml> rtrv-callinfo:all:detail
Retrieving results. This could take a few moments...
MGC-01 - Media Gateway Controller 2009-12-22 02:05:46.040 EST
M RTRV
"sip-path:CallID=8,Call_Type=REAL,CgPN=1965,CdPN=6781955"
"sip-path:CALL_STA=2009-12-22 02:05:33 EST"
"sip-path:CID=130b6b8c-4048e363-1158d881-6@10.0.50.178"
"sip-path:CALL=OUT,MediaIPAddr=10.0.182.2,MediaPort=16550,Codec=g729"
"sip-path:CID=6431e200-b3016fbd-29bcb-8632000a@10.0.50.134"
"sip-path:CALL=IN,MediaIPAddr=10.0.182.2,MediaPort=16544,Codec=pcma"
 

Comments:

Performance Impact Category: D

The RTRV-CALLINFO command enables you to display the call IDs of all EISUP/SIP calls on the system. Optional parameters enable you to display the To and From numbers or to display calls established longer than a specified time period. The PRT-CALL and KILL-CALL commands are updated to support EISUP-to-EISUP Calling.

RTRV-CFG—Retrieve Configuration Table

 

Comments

This command is no longer supported. The command prov-rtrv replaces it.

RTRV-CIC—Retrieve Bearer Channels

 

Purpose:

Retrieves bearer channel information for one or more circuits that are identified by a signal path.

Syntax:

rtrv-cic:<sig path>:cic=<number>[,rng=<range>]

Input Description:

  • sig path—MML component name of a signal path component.
  • number—A valid circuit identification code (CIC).
  • range—A number such that number + range is a valid CIC. All circuits between number and number + range are displayed.

Output Description:

  • <SIG PATH>—MML component name of a signal path component.
  • CIC—Circuit identification code.
  • PST—Primary state.

IS—In service.

OOS—Out of service.

  • CALL—Call state.

IDLE—Circuit is idle, available for use.

OOS—Out of service.

IS—In service

  • GW_STAT—State of the gateway.

CARRIER_FAILURE—Carrier has failed.

GW_HELD—The call has been held at the gateway.

CXN_IS—The connection is in service.

CXN_OOS_ACTIVE—The connection is out of service on the active system.

CXN_OOS_STANDBY—The connection is out of service on the standby system.

INTERFACE_DISABLED

  • BLK—Blocking state

GATEWAY—Locally blocked because of a gateway event (for example, RSIP or a group service message).

LOCAUTO—Hardware blocking type; the circuit is blocked by an external message generated by a network element outside the media gateway.

LOCMAN—Blocked manually by MML. This is removable by the UNBLK-CIC or RESET-CIC command.

LOCUNK—Locally blocked for unknown reasons. (This indicates a potential software problem. Acircuit has become blocked but the software did not track the cause of the blocking.)

NONE—There is no block on the CIC. DS0 is available for use.

REMAUTO—Remotely auto blocked.

REMMAN—Remotely manually blocked.

Example:

The MML command shown in the following example retrieves bearer channel information for CICs 276 through 281 on signal path SS7SVC1:

mml> RTRV-CIC:SS7SVC1:CIC=276,RNG=5
 
MGC-13 - Media Gateway Controller 2000-08-30 14:42:10
M RTRV
"ss7svc1:CIC=276,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=277,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=278,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=279,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=280,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=281,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
;

Comments:

Performance Impact Category: B, C; impact depends on number of CICs queried.

RTRV-CTR—Retrieve Measurement Counter

 

Purpose:

Displays a measurement counter for a component.

Syntax:

rtrv-ctr:<comp>:"<meas cat>"

Input Description:

Output Description:

  • <COMP>—Component
  • CAT—Measurement category
  • BCKT—Bucket, which is the measurement interval defined as 15 minutes, 60 minutes, or 24 hours
  • VAL—Value measured

Example:

The MML command shown in the following example displays measurement counters for the component ALGG-01:

mml> rtrv-ctr:ALGG-01
Media Gateway Controller 1999-02-18 15:38:50
M RTRV
"ALGG-01:CAT=\BCKT=\"b_prof_std15\",VAL=1000"
"ALGG-01:CAT=\BCKT=\"b_prof_std60\",VAL=2000"
"ALGG-01:CAT=\BCKT=\"b_prof_std24\",VAL=2000"
;

Comments:

Performance Impact Category: A

RTRV-DCHAN—Retrieve D-Channel Status

 

Purpose:

Displays attributes of a D-channel or all D-channels.

Syntax:

rtrv-dchan:<D channel | fas link>
rtrv-dchan:all

Input Description:

  • dchannel —D-channel.
  • fas link Facility associated signaling service or signaling past a particular destination when you use either ISDN-PRI or DPNSS.
  • all—Displays attributes of all D-channels.

Output Description:

  • LID—Link ID.
  • PRI—Priority rate interface priority; this is an integer, either 0 or 1.
  • STBY—This is the standby D-channel.
  • PST—This is the primary D-channel. Valid values are:

AOOS—The system has taken the resource out of service.

INB—Installed busy (resource has been created but not yet commanded IS or OOS by the SET-DCHAN command).

IS—In service.

MOOS—Manually taken out of service.

OOS—Out of service.

TRNS—Transient; the state is currently being changed.

UNK—Unknown.

Example:

The MML command shown in the following example displays the attributes of D-channel 1:

mml> RTRV-DCHAN:DCHAN-1
Media Gateway Controller 2000-06-05 16:42:56
M RTRV
"dchan-1:sigpath,LID=0:PRI,backup=dchan-2:STBY"
;
 

When the D-channel is associated with an FAS signaling path, the system returns a message similar to the following:

mml> rtrv-dchan:dchan-1
Media Gateway Controller 2000-03-26 20:26:18
M RTRV
"dchan-1:fas1,LID=0:IS"
;

In this response, fas1 is the signaling path, or a logical grouping of D-channels (equivalent to a linkset). The LID is the line identifier, or the logical line ID of the D-channel within the signaling path (equivalent to the SLC in SS7). IS is the primary service state of the D-channel.

When the D-channel is associated with an NFAS signaling path, the system returns a message similar to the following:

mml> rtrv-dchan:dchan-1
Media Gateway Controller 2000-03-26 20:26:18
M RTRV
"dchan-1:nfas1,LID=0:PRI,backup=dchan-2:STBY"
;

In this response, nfas1 is the signaling path, or a logical grouping of D-channels (equivalent to a linkset). The LID is the line identifier, or the logical line ID of the D-channel within the signaling path (equivalent to the SLC in SS7). The next field indicates whether the specified D-channel is the primary (PRI) channel or the standby (STBY). Finally, the backup field specifies the MML name of the D-channel that is configured as the backup to the specified D-channel.

Note Backup D-channels are not supported for QSIG/Q.931 Over BRI Backhaul D-channels.

Comments:

Performance Impact Category: A

RTRV-DEST—Retrieve Destination

 

Purpose:

Retrieves information about one or more destinations.

Syntax:

rtrv-dest:<sig path>
rtrv-dest:all

Input Description:

  • sig path —The MML name of the logical signal channel for which you want to display information. These should be signal path DSS IP, signal path NAS entities, or rapath.
  • all —Displays information about all external point codes and signal paths.

Output Description:

  • <SIG PATH>—Signal path
  • PKG—Protocol family
  • ASSOC—Associated channels

UNK—Unknown.

SWITCHED—The destination is switched, not associated.

<CHANNEL>—The channel with which the destination is associated.

  • PST—Primary state; valid values are:

AOOS—The system has taken it out of service.

INB—Installed busy (resource has been created but not yet commanded IS or OOS by the SET-DEST-STATE command).

IS—In service.

MOOS—Manually taken out of service.

OOS—Out of service.

TRNS—Transient; the state is currently being changed.

UNK—Unknown.

  • SST—Secondary state valid values are:

UND—Undefined

CRTE—Created

DLT—Deleted

CIS—Commanded in service

COOS—Commanded out of service

FLD—Failed

RSTO—Restored

RST—Reset

CONG—Congestion

FOOS—Forced out of service

CINH—Commanded to the inhibited state

CUINH—Commanded to the uninhibited state

CEA—Commanded into emergency alignment

EIS—Engine in service

EOOS—Engine out of service

Note If the rtrv-dest MML command is entered after a switchover has occurred, the state of some of the signaling services might be listed as undefined (UND). UND is the default state for a signaling service when the system starts. In this instance, UND indicates that the Cisco PGW 2200 Softswitch has not received a service state message for the associated signaling service since the switchover occurred. No user action is required.

Example:

The MML command shown in the following example retrieves the destination of signal path ss7svc1:

mml> RTRV-DEST:SS7SVC1
MGC-01 - Media Gateway Controller 2001-02-08 13:06:29
M RTRV
"ss7svc1:PKG=SS7-ANSI,ASSOC=SWITCHED,PST=IS,SST=RSTO"
;
 

The MML command shown in the following example retrieves the destination of racluster signal path:

mml> RTRV-DEST:racluster1
MGC-01 - Media Gateway Controller 2006-08-08 13:06:29
M RTRV
“racluster1:PKG=MGCP,ASSOC=SWITCHED,PST=IS,SST=RSTO”

Comments:

Performance Impact Category: C

This command supports wildcarding.

RTRV-DNS-INFO—Retrieve DNS Cache

 

Purpose:

Retrieves information from a domain name server (DNS) cache.

Syntax:

rtrv-dns-info:<sip-sig path>

Input Description:

  • sig path sip —MML name of SIP signal path.

Output Description:

  • <IO CARD>—Input/output card.
  • <DOMAIN NAME>—URL (universal resource locator)
  • <IP ADDRESS>—IP address
  • <TIME TO LIVE>—TTL
  • <CACHE ENTRY COUNT>—Cache size
  • <CACHE ENTRY COUNT>—Cache usage
  • <IP ADDRESS OF DNS SERVER 1>—DNS 1 address
  • <IP ADDRESS OF DNS SERVER 2>—DNS 2 address

Example:

The MML command in the following example presents DNS information for the SIP signal path:

mml> rtrv-dns-info:sip-sigpath
Media Gateway Controller - MGC-01 2000-12-30 14:27:48
M RTRV
/*
DNS 1 address 193.12.77.2
DNS 2 address 193.21.9.76
Cache size = 280
Cache usage = 81
Local TTL = 240
*/
;

Comments:

Performance Impact Category: A.

You must execute the STA-DNS-INFO command before using the RTRV-DNS-INFO command.

RTRV-EQPT—Retrieve Service State of a Component

 

Comments:

This command is no longer supported.

RTRV-H248:CNTXS:SIGPATH—Retrieve H.248 Sigpath Information (Release 9.7(3))

 

Purpose:

Displays all H.248 context information in one sigpath or all the terminations in each context.

Syntax:

rtrv-h248:cntxs:sigpath=”h248-sigpath-name",cntxid="all/context id"

Input Description:

  • sigpath-name Name of the H.248 signal path, the route of a signal channel that carries signaling data.
  • cntxid —Context ID.

Example:

The MML command shown in the following example displays all context information for the h248-sigpath-01 signal path:

mml> rtrv-h248:cntxs:sigpath=”h248-sigpath-01”,cntxid=”ll”

Comments:

Performance Impact Category: A

RTRV-IPLNK—Retrieve Attributes of an IP Link

 

Purpose:

Displays the attributes of an NAS, MGCP, SIP, or EISUP IP link.

Syntax:

RTRV-IPLNK:<IP LINK>
RTRV-IPLINK:all

Input Description:

  • <IP LINK>—MML component name of a previously configured IP link.
  • all —Displays the measurements for all links.

Output Description:

  • <PARENT NAME>—IP link name.
  • <PST>—Primary state; valid values are:

AOOS—The system has taken the resource out of service.

INB—Installed busy (resource has been created but not yet commanded IS or OOS by the SET-IPLNK command).

IS—In service.

COOS—Commanded out of service.

FOOS—Forced out of service.

OOS—Out of service.

OFF_DUTY—Redundant link.

TRNS—Transient; the state is currently being changed.

UNK—Unknown.

Example:

The MML command shown in the following example displays the measurements for all links:

mml> RTRV-IPLNK:ALL
MGC-01 - Media Gateway Controller 2001-01-01 18:57:26
M RTRV
"mgcplk3:IS"
"mgcplk4:IS"
"eisuplk2:IS"
"lnkmgx5-30:OOS"
"mgcplk381011:IS"
"mgcplk381012:IS"
"mgcplk381010:IS"
 

The MML command shown in the following example displays the measurements for all links on a standby mode:

mml> RTRV-IPLNK:ALL
MGC-01 - Media Gateway Controller 2003-06-16 14:47:33.390 EST
M RTRV
"lhsi-silver:IS"
"lsip1-venus-1:IS"
"lnk1-eisup-node2:OOS"
"lnk2-eisup-node2:OOS"
"lnk1-eisup-node3:IS"
"lnk2-eisup-node3:OOS"
"lnk3-eisup-node3:IS"
"lnk4-eisup-node3:OOS"
"mgcpsvc-5350-31-2:IS,OFF_DUTY"
"mgcplnk-5350-31-1:IS"
"mgcplnk-5350-30-2:IS,OFF_DUTY"
"mgcplnk-5350-30-1:IS"
"l5850-30-1:IS"
"l5850-30-2:IS,OFF_DUTY"
"l5850-31-2:IS"
"l5850-31-1:IS,OFF_DUTY"
"lsip2-venus-1:IS,OFF_DUTY"
"mgcpsvc-5350-32-1:IS"
 

The MML command shown in the following example retrieves the state of all IP links:

mml> rtrv-iplnk:all
MGC-01 - Media Gateway Controller 2003-01-07 09:36:38.485 EST
M RTRV
“nas1link1:IS”
“nas2link1:OOS”
“c7-slt1-1:IS”
“c7-slt2-1:IS”
 
mml> rtrv-iplnk:nas1link1
MGC-01 - Media Gateway Controller 2003-01-07 09:38:10.821 EST
M RTRV
“nas1link1:IS”
/*link 1 to nas*/

Comments:

Performance Impact Category: A

RTRV-IPROUTE—Display Primary and Secondary States of an IP Route

 

Purpose:

Displays the primary and secondary states of an IP route.

Syntax:

rtrv-iproute:ip_route_name
rtrv-iproute:all

Input Description:

  • Ip_route_name —MML name of a previously configured IP route.
  • All—Retrieves the primary state of all IP routes.

Output Description:

IP route—MML name of the specified IP route.

PST—Primary state; valid values are:

IS—In service

OOS—Out of service

SST—Secondary state; valid values are:

COOS—Commanded out of service

STBY—The local platform state is standby

OFF_DUTY—The link is available for use but is not currently being used.

CONF—The link is out of service because of a configuration failure.

Example:

The MML command shown in the following example retrieves the state of all IP routes:

mml> rtrv-iproute:all
MGC-01 - Media Gateway Controller 2002-06-25 15:13:40.983 EST
M RTRV
"iproute1:IS"
"iproute2:IS"

Comments:

Performance Impact Category: A

RTRV-LICS—DISPLAY LICENSES

 

Purpose:

Displays the number of licenses to which you are entitled, the number of these licenses that are currently used, and the number of free licenses that are available. This MML command runs on an active PGW and retrieves the license information. If you run it on a standby PGW, you can correctly retrieve only the base license information; other types of license are displayed as unentitled on a standby PGW.

Syntax:

rtrv-lics:base
rtrv-lics:Interface
rtrv-lics:configure
rtrv-lics:runtime
rtrv-lics:SBEinterface
rtrv-lics:TimesTen License
rtrv-lics:all

Input Description:

  • base —Base license information
  • interface —Interface license information
  • configure —Configuration TDM Ports license information
  • runtime —Run-time license information
  • all —All license information

Output Description:

  • Entitled —Indicates if the interface is licensed and the number of licenses.
  • Used —Indicates if the interface is used and the number of licenses provisioned.
  • Available —Indicates the number of unused licenses.
  • Run-time license

Entitled license number —Number of licenses

Current usage —Runtime counter of call legs

Peak usage (15 min) —Measurement of peak usage (15-minute span)

Peak usage (60 min) —Measurement of peak usage (60-minute span)

Peak usage (24 hours) —Measurement of peak usage (24-hour span)

Example:

The MML command shown in the following example displays all license information:

mml>rtrv-lics:all
 
-------------------------------------------------------------------------PGW Internal Lab License 9.8 permanent
------------------------------------------------------------------
Interface Name Entitled Provisioned
SS7Interface Y Y
PRIInterface Y N
PBXInterface Y Y
INAPInterface Y Y
LIInterface Y N/A
SBEInterface Y N/A
------------------------------------------------------------------
Configure TDM Ports Entitled Provisioned Available
Call Control 5000000 77 4999923
-------------------------------------------------------------------------------
TimesTen License Entitled Provisioned Available
10000 5000 5000
--------------------------------------------------------------------------------
Run Time License TDMPorts SIP H323
Entitled Number 5000000 5000000 5000000
Current Usage 0 0 0
Peak Usage(15 min) 0 0 0
-------------------------------------------------------------------------

Comments:

Performance Impact Category: A

RTRV-LOCLABEL

 

Purpose:

Displays the measurements of a location label.

Syntax:

rtrv-loclabel:loclabel name
rtrv-loclabel:all
rtrv-loclabel:all:percent=number

Input Description:

  • loclabel name —Retrieves the measurements of a location label.
  • All —Retrieves the measurements of all location labels
  • All:percent = number —Retrieves the measurements for all location labels that used labels within the percentage.

Output Description:

  • loc1—location label name.
  • loc2—defined call limit number
  • loc3—active call number</syntax>

Example:

The MML command that follows displays the measurements for all location labels:

mml> rtrv-loclabel:all
 
MGC-01 - Media Gateway Controller 2001-01-01 18:57:26
M RTRV
"loc1:LIMIT=100,ACTIVE=0"
“loc2:LIMIT=500,ACTIVE=400”
“loc3:LIMIT=1000,ACTIVE=50”</examples>

Comments:

Performance Impact Category: A

RTRV-LOG

 

Purpose:

Displays the logging level of a process or of all processes.

Syntax:

rtrv-log:all
rtrv-log:<proc>

Input Description:

  • all— Displays the logging levels of all processes.
  • proc —The various actively and passively monitored processes running on the Cisco PGW 2200 Softswitch. See the “SET-LOG—Set Logging Levels” section for a list of logging levels. Use the RTRV-SOFTW:ALL command to display all processes.

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information.

Output Description:

  • <PROCESS>—Process name

CRIT—Critical

WARN—Warning

ERR—Error

TRACE—Trace

INFO—Informational

DEBUG—Debug

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
Media Gateway Controller - MGC-01 2000-01-16 09:38:03
M RTRV
"PM-01:DEBUG"
;

Comments:

Performance Impact Category: A

The process manager (PM-01) is not included in the all parameter, because this is a special process. For the logging level of PM-01 to be retrieved, it must be used individually, as in the preceding example.

For the software Release 7.4, two processes do not support log-level commands: DSKM-01 and LOG-01. For these two processes, the following message is returned:

/*Function not supported*/

RTRV-LSET—Retrieve Linkset Service State

 

Purpose:

Retrieves the service state of a linkset.

Syntax:

rtrv-lset:<linkset>

Input Description:

  • <linkset>—The provisioning component C7 link, a TDM link used in a linkset, or a linkset. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of C7 linksets. Use the prov-rtrv command, described in the “PROV-RTRV—Retrieve Provisioning Information” section, for a list of linksets.

Output Description:

  • AOOS—The system has taken the resource out of service.
  • INB—Installed busy (resource has been created but not yet commanded IS or OOS by the set-dest command).
  • IS—In service.
  • MOOS—Manually taken out of service.
  • OOS—Out of service.
  • TRNS—Transient; the state is currently being changed.
  • UNK—Unknown.

Example:

The MML command shown in the following example retrieves the service state of linkset ls1:

mml> RTRV-LSET:ls1
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
MOOS
;

Comments:

Performance Impact Category: A

RTRV-LSSN—Retrieve State of All Local SSNs

 

Purpose:

Displays the state of all local SSNs (LSSNs).

Syntax:

rtrv-lssn:all

Output Description:

  • <process>—Name of process
  • <lssn>—Name of local subsystem number
  • pst—Primary state

is—In service

oos—Out of service

Example:

The MML command shown in the following example displays all local SSNs:

mml> RTRV-LSSN:all
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"TCAP-01:SSN=1,PST=IS"
"TCAP-01:SSN=2,PST=OOS"
;

Comments:

Performance Impact Category: A

RTRV-MML—Retrieve Active MML Sessions

 

Purpose:

Displays all active MML sessions, their session numbers, and the user IDs of the session originators.

Syntax:

rtrv-mml

Output Description:

  • MML1—Session number

<username>—UNIX username of session owner

  • MML2—Session number

<username>—UNIX username of session owner

Example:

The MML command shown in the following example shows all active MML sessions:

mml> RTRV-MML
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
mml5:guest
;

Comments:

Performance Impact Category: A

RTRV-NE—Retrieve Network Element Attributes

 

Purpose:

Displays information about the Cisco PGW 2200 Softswitch hardware, software, and current state (active or standby).

Syntax:

RTRV-NE

Output Description:

  • Type—Type of controller.
  • Hardware Platform—Hardware platform.
  • Vendor—Cisco PGW 2200 Softswitch vendor.
  • Location—Controller machine name.
  • Version—Controller software version.
  • Platform State—Use of controller.

ACTIVE—The controller in use.

STANDBY—The redundant controller.

Example:

The MML command shown in the following example displays information about the Cisco PGW 2200 Softswitch:

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

Comments:

Performance Impact Category: A

RTRV-NE-HEALTH—Retrieve Network Element Health

Purpose:

Displays the health information of the Cisco PGW 2200 Softswitch network element. This includes information about physical and virtual memory allocation, as well as CPU percentages showing the available computing resources, proc/memory utilization, machine congestion level, congestion reason, active alarm statistics, and call processing statistics.

Syntax:

rtrv-ne-health
rtrv-ne-health::sys
rtrv-ne-health::callp
rtrv-ne-health::load
rtrv-ne-health::all

Input Description:

  • sys—Retrieves the top-level status of the Cisco PGW 2200 Softswitch host and the number of active alarms, arranging the alarms in order of severity.
  • callp—Retrieves:

Machine congestion level (MCL)

Current number of calls in progress

Current call attempt rate over the previous few seconds

Number of successful calls over the last 15-, 60-, and 1440-minute collection intervals

Number of failed call setups over the last 15-, 60-, and 1440-minute collection intervals

  • load—Retrieves:

MCL

CPU utilization

Free memory

Percentage of used disk space by partition

  • all—All of the above indicators.

Output Description:

  • MEMORY:REAL—Total amount of physical memory that can be allocated for use by processes. (It does not include memory reserved for use by the kernel.)
  • MEMORY:FREE—Amount of unallocated physical memory.
  • MEMORY: SWAP IN USE—Amount of swap area on the disk that is being used.
  • MEMORY: SWAP FREE—Amount of swap area on the disk that is still available.
  • CPU STATES—Fractions of the total available computing resources. These must total 100 percent.

IDLE—Percentage of CPU resources available

USER—Percentage consumed by users

KERNEL—Percentage used by the kernel

IOWAIT—Percentage used by the input-output wait process

SWAP—Percentage of CPU used in swap activity

  • CALL: SIPLicRej TOT— SIP call rejected because of run-time license management.
  • CALL: H323LicRej TOT—H323 call rejected because of run-time license management.
  • CALL: TDMLicRej TOT—TDM call rejectedbecause of run-time license management.

Example:

The MML command shown in the following example retrieves the state of the Cisco PGW 2200 Softswitch network:

mml> RTRV-NE-HEALTH
MGC-01 - Media Gateway Controller 2000-06-07 12:47:44
M RTRV
Memory: 8192M real, 469M free, 214M swap in use, 1833M swap free
CPU states: 80.5% idle, 6.7% user, 11.2% kernel, 1.6% iowait,
0.0% swap
;

The command in the following example displays the status of the Cisco PGW 2200 Softswitch host and the number of active alarms listed in order of severity:

mml> RTRV-NE-HEALTH::SYS
Media Gateway Controller 2000-06-07 16:39:41
M RTRV
"Platform State:ACTIVE"
"2 critical, 4 major, 8 minor active alarms"
;

The command in the following example displays all the health information of the network element:

mml> RTRV-NE-HEALTH:ALL
MGC-01 - Media Gateway Controller 2005-03-14 17:44:55.336 PST
M COMPLD
"Platform State:ACTIVE"
"0 critical, 1 major, 0 minor active alarms"
"Machine Congestion Level = MCL 1, Reason: queue length"
"Current in progress calls = 7924, call attempts = 65 cps"
"CPU 0 Utilization = 50 % CPU 1 Utilization = 52 %"
"CPU 2 Utilization = 54 % CPU 3 Utilization = 49 %"
"Memory (KB): 14333880 Free virtual, 18827672 Total virtual, 16777216 Total real"
"Interval (minutes) 15 60 1440"
"CALL: SuccCall TOT 62689 62689 62689"
"CALL: FailCall TOT 113 113 113"
"Filesystem kbytes used avail capacity Mounted on"
"/dev/dsk/c1t0d0s0 1490047 159084 1271362 12% /"
"/dev/dsk/c1t0d0s5 66262523 43311518 22288380 67% /opt"
;

Example:

The command in the following example displays the status of the Cisco PGW 2200 Softswitch host and the number of calls rejected by license failure. If a call is rejected by license, the corresponding LicRej measurement is increased, and CALL: SuccCall TOT is increased. CALL: FailCall TOT is not increased, because there is no protocol outage for this call flow.

mml> RTRV-NE-HEALTH::ALL
MGC-01 - Media Gateway Controller 2006-05-18 08:21:02.581 EDT
M COMPLD
''Platform State:ACTIVE''
''0 critical, 19 major, 0 minor active alarms''
''Machine Congestion Level = MCL 0 (No Congestion), Reason: not applicable''
''Current in progress calls = 0, half calls = 0, full calls = 0, call attempts = 0 cps''
''CPU 0 Utilization = 0 % CPU 1 Utilization = 2 %''
''Memory (KB): 4921240 Free virtual, 6193264 Total virtual, 2096696 Total real''
''Interval (minutes) 15 60 1440''
''CALL: SuccCall TOT 0 0 0''
''CALL: FailCall TOT 0 0 0''
''CALL: SIPLicRej TOT 0 0 0''
''CALL: H323LicRej TOT 0 0 0''
''CALL: TDMLicRej TOT 0 0 0''
''Filesystem kbytes used avail capacity Mounted on''
''/dev/dsk/c0t2d0s0 1986446 467404 1459449 25% /''
''/dev/dsk/c0t2d0s5 57416722 11775209 45067346 21% /opt''
;

RTRV-OVLD—Retrieve Overload Level

 

Purpose:

Displays the machine congestion level, congestion reason, and number of messages rejected caused by far end congestion.

Syntax:

rtrv-ovld

Output Description:

  • <COMPONENT>—MML component name
  • MCL—Machine congestion level
  • Congestion Reason
  • Calls rejected

Example:

The MML command shown in the following example displays the congestion level and number of calls rejected:

mml> RTRV-OVLD
Media Gateway Controller - MGC-01 2006-01-12 15:19:51
M RTRV
"ENGG-01: MCL=0,Calls Rejected=10"
“tg-1000: Far End Congestion: Calls Rejected=5”
;

RTRV-RASERVER (Release 9.7(3))

 

Purpose:

Displays the status of one or more RADIUS servers. Only one RADIUS server can be in service at any given time.

Syntax:

rtrv-raserver:name=server-name

Input Description:

  • server-name —The name of the RADIUS accounting server for which you want to display status.

Output Description:

  • IS—In service
  • IS—Off duty
  • OOS—Out of service

Example:

mml> rtrv-raserver:raserver1
MGC-13 - Media Gateway Controller 2006-08-30 14:42:10
M RTRV
"raserver1, ST=IS "
;
mml> rtrv-raserver:all
MGC-13 - Media Gateway Controller 2003-08-30 14:42:10
M RTRV
“raserver1, ST=IS”
“raserver2, ST=IS,OFF_DUTY”
;

RTRV-RSSN—Retrieve State of All Remote SSNs

 

Purpose:

Displays the state of all remote SSNs (RSSNs).

Syntax:

rtrv-rssn:all

Output Description:

  • <link>—Name of link
  • <RSSN>—Remote subsystem number
  • PC—Point code(s)
  • SSN—Subsystem number
  • PST—Primary state

IS—In service

OOS—Out of service

Example:

The MML command in the following example displays the state of all remote SSNs:

mml> RTRV-RSSN:all
Media Gateway Controller - MGC-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 :

Retrieves all SS7 routes for a point code or for all point codes.

Syntax:

rtrv-rte:<dpc name>
rtrv-rte:all

Input Description:

  • dpc name —The MML component name of a destination point code
  • all—Retrieves all SS7 routes for all point codes

Output Description:

  • <PC>—Target point code
  • <LINKSET>—Linkset ID
  • APC—Adjacent point code
  • PRIO—Priority set for the routes
  • PST—Primary state; valid values are:

AOOS—The system has taken the resource out of service.

INB—Installed busy (resource has been created but not yet commanded IS or OOS by the SET-DEST command).

IS—In service.

MOOS—Manually taken out of service.

OOS—Out of service.

TRNS—Transient; the state is currently being changed.

UNK—Unknown.

  • SST—Secondary state; valid values are:

NA—Cause not available.

LINS—Linkset failure.

PRHB —C7 prohibited (PGW has received a transfer-prohibited message or TFP from the STP).

RSTR —C7 restricted (PGW has received a transfer-restricted message or TFR from the STP).

Example:

The MML command shown in the following example retrieves the routes for destination point code PC-002. The output shows that 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.

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

Comments:

Performance Impact Category: A

RTRV-SC-TRC—Retrieve Names of Open Signal Channel Traces

 

Purpose:

Displays the names of all files currently open for traces in progress or the stop reason of the last trace file. The three normal stop reasons are : MCL reaches, prd expires, and autostop. See the “STA-SC-TRC—Start Trace” section and the “STP-SC-TRC—Stop One or All Traces” section for information on starting and stopping traces.

Syntax:

rtrv-sc-trc
rtrv-sc-trc::stopreason

Output Description:

  • Names of all files currently open for traces in progress.

Example:

The MML command shown in the following example displays the filenames of open traces:

mml> RTRV-SC-TRC
Media Gateway Controller 2000-03-21 15:28:03
M RTRV
"RTRV-SC-TRC:Trace in progress for the following files:
../var/trace/_dpc1_19991221131108.btr
../var/trace/sigtest_dpc2_19991221131109.btr
"
;

Comments:

Performance Impact Category: B

RTRV-SGP—Display the Primary and Secondary States of an SGP

 

Purpose:

Displays the primary and secondary states of one or all SS7 SGPs.

Syntax:

rtrv-sgp:sgp_name
rtrv-sgp:all

Input Description:

  • Isgpe_name —MML name of a previously configured SGP.
  • all —Retrieves the primary state of all SGPs.

Output Description:

IP route—MML name of the specified IP route.

PST—Primary state; valid values are:

INB—Installed busy (resource is being created, its state has not been determined yet).

IS—In service.

OOS—Out of service.

SST—Secondary state; valid values are:

STBY—The local platform state is standby.

CONF—The link is out of service because of a configuration failure.

Example:

The MML command shown in the following example retrieves the state of all SGPs:

mml> rtrv-sgp:all
MGC-01 - Media Gateway Controller 2003-01-25 15:13:40.983 EST
M RTRV
"sgp1:IS"
"sgp2:IS"

Comments:

Performance Impact Category: A

RTRV-SIP—Display Call IDs of SIP Calls

Comments:

This command is no longer supported. The command prov-callinfo replaces it.

RTRV-SOFTW—Retrieve Software Status for a Process

 

Purpose:

Displays the status of one process or all processes.

Syntax:

rtrv-softw:<proc>
rtrv-softw:all

Input Description:

  • proc —The MML name of a process or process group.
  • all —Displays the status of all processes.

Output Description:

  • <PROCESS>—Process name
  • STATUS OF PROCESS

UNKNOWN—State of the process is unknown.

STOPPED—Process is not running.

INIT—Process is being initialized.

INIT CMPL—Initialization has been completed.

CUT WAIT—Cutover has occurred, waiting. (This state is momentary and unlikely to be seen.)

RUNNING—Process is running.

LOCKED—Process is locked.

CUT MASTER—Process is the master in a cutover situation. (This state is momentary and unlikely to be seen.)

CUT SLAVE—Process is the slave in a cutover situation. (This state is momentary and unlikely to be seen.)

TERM—Process is terminating.

RUNNING ACTIVE—Process is running on the active system.

RUNNING STANDBY—Process is running on the standby system.

RUNNING OOS—Process is running, but out of service.

RUNNING IN N/A STATE—Process is running, but in a not available state.

Example:

The MML command shown in the following example displays the status of all processes and process groups:

mml> RTRV-SOFTW:all
Media Gateway Controller - MGC-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"
;

Comments:

Performance Impact Category: A

RTRV-SPC—Retrieve Point Code

 

Purpose :

Displays the route set for one provisioning component point code or the route sets of all point codes.

Syntax:

rtrv-spc:<sigpath>
rtrv-spc:all

Input Description:

  • sig path —The MML component name of a provisioning component signal path.
  • all —Displays information for all signal paths.

Output Description:

  • SIG PATH —The MML component name of a provisioning component signal path.
  • DPC—Destination point code
  • DNW—Network indicator
  • OPC—Originating point code
  • <PST>—Primary state; valid values are:

AOOS—The system has taken the resource out of service.

INB—Installed busy (resource has been created but not yet commanded IS or OOS by the SET-SPC command).

IS—In service.

MOOS—Manually taken out of service.

OOS—Out of service.

TRNS—Transient; the state is currently being changed.

UNK—Unknown.

Example :

The MML command shown in the following example retrieves a list of all destination point codes:

mml> RTRV-SPC:all
Media Gateway Controller - MGC-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"
;

Comments:

Performance Impact Category: A

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

 

Purpose:

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.

Syntax:

rtrv-sp-ctr:<ss7 service>
rtrv-sp-ctr:all

Input Description:

  • ss7 service —The MML component name of a single SS7 signal service.
  • all —Displays measurements for all signal points.

Note RTRV-CTR:<ss7 service>:<group> is a related command.


Output Description:

Example:

The MML command shown in the following example retrieves all measurements for point code svc1:

mml> RTRV-SP-CTR:ss7svc1
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"ss7svc1:CAT=\"C7SP: XMIT MSU DROP/RTE\",INT=1800,V
"ss7svc1:CAT=\"ISUP: RCV CGBA TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV CGBA TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV RLC TOT\",INT=300,VAL=555"
"ss7svc1:CAT=\"ISUP: RCV RLC TOT\",INT=1800,VAL=203
"ss7svc1:CAT=\"ISUP: RCV CGB TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV CGB TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT PAM TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT PAM TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT CGBA TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT CGBA TOT\",INT=1800,VAL=0
"ss7svc1:CAT=\"ISUP: RCV CRM TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV CRM TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV REL TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV REL TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT CGUA TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT CGUA TOT\",INT=1800,VAL=0"
;

Comments:

Performance Impact Category: A

RTRV-SS7-SLT—Retrieve SS7 SLT Test Results

 

Purpose :

Retrieves the results of a signal link test.

Syntax:

rtrv-ss7-slt:<C7 link>

Input Description:

  • c7 link —The MML component name of a signal channel configured for SS7. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about configuring a signal channel.

Output Description:

  • <C7 LINK> —The MML component name of the C7 link where the test is performed.
  • TEST PASSED
  • TEST FAILED. Reasons for failure can be any of the following:

TEST TIMEOUT

LINK INACTIVE

LINKSET INACTIVE

ROUTE UNAVAILABLE

INVALID TEST PATTERN

INVALID SLC

FLOW CONTROL ON

UNKNOWN REASON

  • <COMPLETION TIME>.
  • TEST RUNNING.

Example :

The MML command shown in the following example retrieves a signal link test started by the command STA-SS7-SLT:LS1LINK1:

mml> RTRV-SS7-SLT:LS1LINK1
Media Gateway Controller - MGC-01 2000-01-12 15:18:41
M RTRV
"ls1link1:TEST PASSED; COMPLETED 15:18:34"
;

Comments:

Performance Impact Category: A

RTRV-SS7-SRT—Retrieve SS7 SRT Test Results

 

Purpose :

Retrieves the results of a Japanese signal route test on an ss7path. The rtrv result has three possibilities: TEST PASSED, TEST FAILED, and TEST RUNNING.

Syntax:

rtrv-ss7-srt:<ss7path>:LSET="<C7 link/set>"

Input Description:

  • ss7path —The MML component name of an adjacent ss7path 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.

Output Description:

  • <C7 LINK> —The MML component name of the C7 link the test is performed upon.
  • TEST PASSED
  • TEST FAILED (reasons for failure can be any of the following:)

TEST TIMEOUT

LINK INACTIVE

LINKSET INACTIVE

ROUTE UNAVAILABLE

INVALID TEST PATTERN

INVALID SLC

FLOW CONTROL ON

UNKNOWN REASON

  • <COMPLETION TIME>
  • TEST RUNNING

Example :

The MML command shown in the following example retrieves the results of a signal route test run with the command STA-SS7-SRT:SS7PATH1:LSET="LS1".

mml> RTRV-SS7-SRT:SS7PATH1:LSET="LS1"
Media Gateway Controller - MGC-01 2000-01-12 15:20:09
M RTRV
"ss7path1:TEST FAILED; TEST TIMEOUT; COMPLETED 15:20:01"
;

Comments:

Performance Impact Category: A

RTRV-TC—Retrieve Bearer States

 

Purpose:

Adds a filter to the rtrv-tc command so that it can display available bearer states.

Syntax:

rtrv-tc:all:[STAT]
rtrv-tc:tg:[STAT]
rtrv-tc:sigpath:[STAT]
rtrv-tc:tg:[[pst=value][,call=value][,gw_stat=value][,blk=value][,used]]
rtrv-tc:sigpath:[[pst=value][,call=value][,gw_stat=value][,blk=value] [,used]]

Input Description:

  • all —Displays the bearer states for all signal paths.
  • sigpath —Logical signal destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about signal destinations.

call—Displays the status of the call: IDLE, IN, or OUT (call direction).

pst—Displays the primary states such as AOOS.

used—Displays only the CICs for currently active calls.

STAT—Displays the number of CICs per trunk group, shows whether the CIC is coming into the system (IN) or is going out of the system (OUT), and indicates the block status of the active CICs.


Note If you issue the rtrv-tc command with the STAT parameter, you cannot add any other parameter to the command syntax. If you try to do it, the system will return an error message.


  • tg — Specifies a particular trunk group.

Output Description:

  • <SIGPATH>—MML component name of a signal path
  • CIC—Circuit identification code
  • PST—Primary state; valid values are:

AOOS—The resource has been taken out of service by the system.

INB—Installed busy (resource has been created but not yet commanded IS or OOS by the SET-DEST command).

IS—In service.

MOOS—Manually taken out of service.

OOS—Out of service.

TRNS—Transient; the state is currently being changed.

UNK—Unknown.

  • CALL—Call state; valid values are:

IDLE—Circuit is idle, available for use.

OUT—Out of service.

IN—In service.


Note If the Cisco PGW 2200 Softswitch sends out CGB, CGU, or GRS, because a group of CICs (such as a E1) is blocked, unblocked, or reset by gateway or MML command, a call will be created on the first CIC of the group and send the message out. The call remains in the CALL=IN status until it receives ACK from the remote side. This is an indication that the answer has not been received for the ISUP signalling message. If the remote side doesn't send ACK back and the call has been in CALL=IN status for a long time, you can use the kill-call command to restore the first CIC to CALL=IDLE state.


  • GW_STAT—State of the gateway; valid values are:

CARRIER_FAILURE—Carrier has failed.

GW_HELD—The call has been held at the gateway.

CXN_IS—The connection is in service.

CXN_OOS_ACTIVE—The connection is out of service on the active system.

CXN_OOS_STANDBY—The connection is out of service on the standby system.

  • BLK—Blocking state; valid values are

GATEWAY—Locally blocked because of a gateway event (for example, RSIP or a group service message).

LOCAUTO—Hardware blocking type; the circuit is blocked, by an external message generated by a network element outside the media gateway.

LOCMAN—Blocked manually by MML. This is removable by the UNBLK-CIC or the RESET-CIC command.

LOCUNK—Locally blocked for unknown reasons. (This indicates a potential software problem. A circuit has become blocked but the software did not track the cause of the blocking.)

NONE—There is no block on the CIC. DS0 is available for use.

REMAUTO—Remotely auto blocked.

REMMAN—Remotely blocked manually.

Note All the BLK valid values, except for LOCMAN and NONE, are only applicable to SS7 sigpath.

Note For PRI sigpath, the valid values of BLK are LOCMAN and NONE. For PRI path with NI or ATT_41459 variant, since Release 9.7(3) S27P27, REMMAN is also applicable.

  • CALL_STA—The call start time.

Example:

The MML command shown in the following example displays the bearer channels states for signal paths CIC1 to CIC62:

mml> rtrv-tc:ss7svc1:pst=OOS,call=IDLE,gw_stat=CXN_OOS_ACTIVE,blk=NONE
MGC-01 - Media Gateway Controller 2007-12-12 10:12:51.860 CST M RTRV
"ss7svc1:CIC=1,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=2,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=3,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=4,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=5,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=6,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=7,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=8,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=9,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=10,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=11,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=12,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=13,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=14,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=15,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=16,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=17,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=18,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
.
"ss7svc1:CIC=21,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=22,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=23,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=24,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=25,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=26,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=27,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=28,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=29,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
.
"ss7svc1:CIC=59,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=60,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=61,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=62,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
;

Example:

The MML command shown in the following example displays the bearer channel of a particular trunk group:

mml> rtrv-tc:tg-1001:
MGC-01 - Media Gateway Controller 2009-02-18 16:33:22.470 EST
M RTRV
"tg-1001:CIC=1,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=2,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=3,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=4,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=5,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=6,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
;
 

The MML command shown in the following example shows the information displayed when you issue the command and specify a particular trunk group and enter the STAT parameter:

mml> rtrv-tc:tg-1001:STAT
MGC-01 - Media Gateway Controller 2009-02-18 16:33:22.470 EST
M RTRV
"tg-1001:CSV=ss7path,CIC_NUM=31, NONE_BLOCK =29,BLOCK=2
IN=10,
OUT=6,
LOCAUTO=0
LOCMAN=1
GATWAY=1
REMAUTO=0
REMMAN=0
LOCUNK=0
 

The MML command shown in the following example shows the information displayed when you issue the command and specify a signaling path (in signaling nailed-up mode) and the STAT parameter:

mml> rtrv-tc:ss7path:STAT
MGC-01 - Media Gateway Controller 2009-02-18 16:33:22.470 EST
M RTRV
"ss7path:CIC_NUM=31, NONE_BLOCK =29,BLOCK=2
IN=10,
OUT=6,
LOCAUTO=0
LOCMAN=1
MATE_UNVAIL=1
REMAUTO=0
REMMAN=0
LOCUNK=0
 

The MML command shown in the following example displays the status of CICs on an ss7 signaling path:

mml> rtrv-tc:ss7path:USED
MGC-01 - Media Gateway Controller 2009-01-19 13:23:29.320 EST
M RTRV
"ss7path:CIC=1,PST=IS,CALL=IN,GW_STAT=CXN_IS,BLK=NONE,
CALL_STA=2009-01-19 13:20:30.219 CST"
"ss7path:CIC=3,PST=IS,CALL=OUT,GW_STAT=CXN_IS,BLK=NONE,
CALL_STA=2009-01-19 13:21:37.321 CST"

Comments:

Performance Impact Category: C; avoid issuing RTRV-TC:ALL for large configurations.

This command supports wildcarding.

RTRV-TCAP-TRANS—Retrieve TCAP Transactions

 

Purpose:

Displays the number of active TCAP transactions.

Syntax:

rtrv-tcap-trans

Output Description:

  • <TCAP name> —The TCAP name.
  • TRANS—Number of active transactions.

Example:

The MML command shown in the following example displays the number of active TCAP transactions:

mml> RTRV-TCAP-TRANS
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"TCAP-01:TRANS=0"
;

Comments:

Performance Impact Category: A

RTRV-TC-HELD—Retrieve States of Bearer Channels Held by Gateway


Note This command has been replaced by the rtrv-tc command for Releases 9.7(3) and 9.8(1). See the “RTRV-TC—Retrieve Bearer States” section for further information.


 

Purpose:

Displays the state of bearer channels per signal path held by gateway or it displays the states of all bearer channels held by gateway.

Syntax:

rtrv-tc-held:<sig path>&<sig path>...
rtrv-tc-held:all

Input Description:

  • sig path —Logical signal destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about signaling destinations.
  • all —Displays the bearer states for all signal paths.

Output Description:

  • <POINT CODE>—MML component name of a point code provisioning component
  • CIC—Circuit identification code
  • PST—Primary state; valid values are:

AOOS—The system has taken the resource out of service.

INB—Installed busy (resource has been created but not yet commanded IS or OOS by the SET-DEST command).

IS—In service.

MOOS—Manually taken out of service.

OOS—Out of service.

TRNS—Transient; the state is currently being changed.

UNK—Unknown.

  • CALL—Call state; valid values are:

IDLE—Circuit is idle, available for use.

OOS—Out of service.

IS—In service.

  • GW_STAT—State of the gateway; valid values are:

CARRIER_FAILURE—Carrier has failed.

GW_HELD—The call has been held at the gateway.

CXN_IS—The connection is in service.

CXN_OOS_ACTIVE—The connection is out of service on the active system.

CXN_OOS_STANDBY—The connection is out of service on the standby system.

  • BLK—Blocking state; valid values are:

GATEWAY—Locally blocked because of a gateway event (for example, RSIP or a group service message).

LOCAUTO—Hardware blocking type; the circuit is blocked by an external message generated by a network element outside the media gateway.

LOCMAN—Blocked manually by MML. This is removable by the UNBLK-CIC or RESET-CIC command.

LOCUNK—Locally blocked for unknown reasons. (This indicates a potential software problem. A circuit has become blocked, but the software did not track the cause of the blocking.)

NONE—There is no block on the CIC. DS0 is available for use.

REMAUTO—Remotely auto blocked.

REMMAN—Remotely blocked manually.

Example:

The MML command shown in the following example displays the state of bearer channels on signal path DPC1:

mml> RTRV-TC-HELD:dpc1
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
“dpc1”
;

Comments:

This command accepts wildcarding.

RTRV-THRES—Retrieve Threshold Values

 

Purpose:

Retrieves threshold settings for measurement categories.

Syntax:

rtrv-thres::<meas cat>

Input Description:

Output Description:

  • INTERVAL—Time interval.
  • TYPE—Threshold type.
  • CLRTHRES—Threshold at which alarm is cleared.
  • ALMTHRES—Threshold at which alarm is set.
  • ALM—Alarm category.

Example:

The MML command shown in the following example retrieves threshold settings for the line-interface-severely-errored seconds measurement category:

mml> rtrv-thres::"SIP: RETX MSG TOT"
MGC-01 - Media Gateway Controller 2008-10-24 01:40:57.770 EDT
M RTRV
"SIP: RETX MSG TOT"
":INT=1800,"
":type=upper,clrthres=100,almthres=125,alarmcat=\"SIP: RE-XMIT MSG TOT\""
;

Comments:

Performance Impact Category: A

RTRV-VIRT-TC—Retrieve DPNSS Virtual Bearer Channel Status (Release 9.6(1) and 9.7(3))

 

Purpose:

Displays the same output as the rtrv-tc command except that it eliminates the SPAN and GW_STAT fields.

Syntax:

rtrv-virt-tc:dpnss-path

Output Description:

  • VTC The virtual channel number.
  • CALL—The status of the call: IDLE, IN, or OUT (call direction).
  • PST—Primary state; valid values are

AOOS—The resource has been taken out of service by the system.

INB—Installed busy (resource has been created but not yet commanded IS or OOS by the SET-DEST command).

IS—In service.

MOOS—Manually taken out of service.

OOS—Out of service.

TRNS—Transient; the state is currently being changed.

UNK—Unknown.

  • BLK—Blocking state

NONE—There is no block on the CIC. DS0 is available for use.

  • TRANS—Number of active transactions.

Example:

The MML command shown in the following example displays information for a DPNSS virtual bearer channel:

mml> rtrv-virt-tc:dpnss-path-1:
 
MGC-01 - Media Gateway Controller 2009-01-19 13:36:14.202 CST
M RTRV
"dpnss-path-1:VTC=33,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=34,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=35,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=36,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=37,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=38,CALL=IDLE,PST=IS,BLK=NONE"

Comments:

Performance Impact Category: D

SET-ADMIN-STATE—Set Administrative State

 

Purpose:

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 Cisco PGW 2200 Softswitch, a gateway, a signal path, a trunk group, a span, or an individual trunk. Use this command also to unlock a set resource.

Syntax:

set-admin-state:<mgc>:lock|unlock|reset
set-admin-state:<gway>:lock|unlock|reset
set-admin-state:<trkgrp>:lock|unlock|reset
set-admin-state:<sigpath>:lock|unlock|reset
set-admin-state:<sigpath>:span=x:lock|unlock|reset
set-admin-state:<sigpath>:span=x,bc=y[,rng=z]:lock|unlock|reset
set-admin-state:<sigpath>:cic=x[,rng=y]:lock|unlock|reset

Input Description:

Target parameters are as follows:

  • mgc—Corresponding MML name of the Cisco PGW 2200 Softswitch.
  • gway—Corresponding MML name for the media gateway. Not all media gateway types are applicable. Supported types are CU, MUX, MGW, and AVM external nodes.
  • trkgrp—Applicable only for time-division multiplexing (TDM). Use the corresponding MML name for component type "0020".

Note When specifying the trunk group number, enter the prefix tg-.
Example: set-admin-state:tg-404:lock

  • sigpath—Corresponding MML name for any of the following component types:

Signal path of in-band TDM up to MUX and then time switched to TDM media and sent to the Cisco PGW 2200 Softswitch.

Signal path of in-band TDM signaling up to CU and then encapsulated and sent over IP to the Cisco PGW 2200 Softswitch.

Signal path of in-band TDM signaling up to NAS and then converted to NI2 and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP-> MGC).

Signal path or route set associated with the SS7 destination PC.

Signal path for EISUP.

  • span—A 16-bit value that identifies an ISDN/PRI physical cable. The span defaults to 0xFFFF if it is not in the parameter list of SET-ADMIN-STATE, the target signal path is a valid target for span, and a "bc" or "rng" parameter is specified.
  • 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 that identifies the ISUP CIC number.
  • rng—The range of either bearer channel or CIC.
  • lock—Bearer channel(s) are available for call processing. If bearer channel state is set to lock, calls go into pending state where calls remain up until one party voluntarily releases the call. New calls cannot use locked bearer channels.
  • unlock—Bearer channel(s) are unavailable for call processing. If the bearer channel state is set to unlock, the resource becomes available. New calls are allowed to use the unlocked bearer channels.
  • re set —Clears local and remote blocking and takes on the blocking view of remote side. This option is not permitted for span, BC or LISUP, FAS, IP, and Layer 3 signaling paths.

Example:

The MML command shown in the following example locks CICs 10 through 13 on dpc1:

mml> SET-ADMIN-STATE:DPC1:CIC=10,RNG=3,LOCK
MGC-01 - Media Gateway Controller 2000-09-12 13:59:30
M COMPLD
"dpc1"
;

The MML command shown in the following example clears local and remote blocking for dpc-inet2 and takes on the blocking view of the remote side:

mml> set-admin-state:dpc-inet2:reset,confirm
Media Gateway Controller 2000-06-20 11:21:57
M COMPLD
"dpc-inet2"
;

The MML command shown in the following example locks all bearer channels on nassrv1:

mml> set-admin-state:nassrv1:lock
Media Gateway Controller - MGC-02 2000-02-22 13:41:42
M COMPLD
"nassrv1"
;
 

Note In software Release 9.7(3) S27P27, an enhancement of the command set-admin-state was added. It enables local and remote blocking of bearer channels for the PRI sigpath with NI or ATT_41459 variant. And the Cisco PGW 2200 Softswitch sends out SERVICE message to inform the remote side of the block status of the channel.

The following shows an example of blocking a bearer channel for PRI path with NI or ATT_41459 variant:

1. The MML command shown in the following example blocks a bearer channel on the PRI sigpath ipfas-sh-daisy:

mml> set-admin-state:ipfas-sh-daisy:bc=1,span=65535,lock,confirm
 

2. The Cisco PGW 2200 Softswitch sends out a SERVICE message with status=OOS. The output of the following command shows the status of the PRI sigpath ipfas-sh-daisy:

mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IN,GW_STAT=CXN_IS,PST=IS,SPAN=65535, BLK=LOCMAN"
 

3. The Cisco PGW 2200 Softswitch receives a SERVICE ACK message. The output of the following command shows that the BLK of bearer channel is still LOCMAN:

mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535, BLK=LOCMAN"
 

The following shows an example of unblocking a bearer channel for PRI path with NI or ATT_41459 variant:

1. The MML command shown in the following example unblocks a bearer channel on the PRI sigpath ipfas-sh-daisy:

mml> set-admin-state:ipfas-sh-daisy:bc=1,span=65535,unlock,confirm
 

2. The Cisco PGW 2200 Softswitch sends out a SERVICE message with status=IN. The output of the following command shows the status of the PRI sigpath ipfas-sh-daisy:

mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IN,GW_STAT=CXN_IS,PST=IS,SPAN=65535, BLK=LOCMAN"
 

3. The Cisco PGW 2200 Softswitch receives a SERVICE ACK message. The output of the following command shows that the BLK of bearer channel is set to NONE:

mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535, BLK=NONE"
 

If the remote side blocks a bearer channel, the Cisco PGW 2200 Softswitch receives a SERVICE message with status=OOS. The output of the following command shows that the BLK of the bearer channel is set to REMMAN. The Cisco PGW 2200 Softswitch sends back a SERVICE ACK message with status=OOS.

mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,BLK=REMMAN"
 

If the remote side releases the bearer channel, the Cisco PGW 2200 Softswitch receives a SERVICE message with status=IS. The BLK of the bearer channel is set to NONE. The Cisco PGW 2200 Softswitch sends back a SERVICE ACK message with status=IS.

mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,BLK=NONE"
 

If a bearer channel is blocked both locally and remotely, the BLK of the bearer channel is set to LOCMAN+REMMAN:

mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535, BLK=LOCMAN+REMMAN"
 

When the remote side unblocks the bearer channel which is still locally blocked, BLK of bearer channel becomes LOCMAN. The Cisco PGW 2200 Softswitch sends out a SERVICE ACK message with status=OOS.

mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,BLK=LOCMAN"
 

Comments:

Performance Impact Category: B

This command supports wildcarding. A platform info log is generated every time the set-admin-state command is entered. One alarm is generated every time the set-admin-state command is entered at the Cisco PGW 2200 Softswitch gateway, signal path, or trunk group level.

SET-ASSOCIATION—Changing SCTP Association Primary State

 

Purpose:

Changes the primary state of an SCTP association.

Syntax:

set-association:assoc_name:PST[,confirm]

Input Description:

  • assoc_name —MML name of a previously configured SCTP association.
  • PST—Desired primary state; valid values are IS, OOS, or FOOS
  • confirm —Verify desired state. This parameter must be used when the primary state desired is OOS.

Example:

The MML command shown in the following example changes the primary state of an association to out of service:

mml> set-association:assoc1:OOS,confirm

Comments:

Performance Impact Category: A

SET-C7LNK—Change the Service State of an SS7 Link

 

Purpose:

Changes the service state of an SS7 link to IS (in service), OOS (out of service), FOOS (forced out of service), UNH (uninhibit SS7 link), or INH (inhibit SS7 link).

Syntax:

set-c7lnk:<c7 ip or tdm ss7 link>:is|oos|foos|unh|inh

Input Description:

  • c7 ip or tdm ss7 link —This is the logical signal link, such as SS7 point code, FAS path, IP FAS path, or DPNSS path.
  • is —In service
  • oos —Out of service
  • foos —Forced out of service
  • unh —Uninhibit SS7 link
  • inh —Inhibit SS7 link

Example:

The MML command shown in the following example sets the C7 IP link lnkset1 into service:

mml> SET-C7LNK:LNKSET1:IS
MGC-01 - Media Gateway Controller 2001-01-01 18:40:25
M COMPLD
"ss7lk0-1"
;

Comments:

Performance Impact Category: C

This command supports wildcarding. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about signal links.

SET-CALLIM—Sets the Call Limiting Function

 

Purpose:

Sets the MGCP Scripting Support on the PGW 2200 feature for the whole Cisco PGW 2200 Softswitch.

Syntax:

set-callim:lim_status

Input Description:

  • lim_status —Sets the MGCP Scripting Support on the PGW 2200 function for the Cisco PGW 2200 Softswitch to enabled or disabled.
  • enable | disable —Instructs the Cisco PGW 2200 Softswitch to either enable or disable call limiting.

Output Description:

Varies

Example:

The MML command shown in the following example enables call limiting:

mml> set-callim:enable
devmgc122 mml> set-callim:enable
MGC-01 - Media Gateway Controller 2004-03-22 19:40:47.595 PST M RTRV
"ENGG-01"
;

Comments:

Performance Impact Category: A

SET-DCHAN—Change the Service State of a D-Channel Link

 

Purpose:

Changes the service state of a D-channel link to IS (in service) or OOS (out of service).

Syntax:

set-dchan:<fas link | d-channel>:is|oos

Input Description:

  • fas link —MML name of the fas link.
  • is —In service.
  • oos —Out of service.

Example:

The MML command shown in the following example sets the service state of link DChan-1 to in service:

mml> SET-DCHAN:DCHAN-1:IS
MGC-01 - Media Gateway Controller 2001-01-01 18:40:25
M COMPLD
"dchan-1"
;

Comments:

Performance Impact Category: C

This command was introduced in software Release 9. It uses wildcarding. It replaces SET-SC-STATE.

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about provisioning D-channel links.

SET-DEST—Set the Service State of a Signal Path

 

Purpose:

Changes the service state of a DSS IP or NAS signal path to IS (in service) or OOS (out of service).

Syntax:

set-dest:<sig path>:IS|OOS

Input Description:

sig path —Signal path. This is the logical signaling destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path.

  • is —In service.
  • oos —Out of service.

Example:

The MML command shown in the following example sets the service state of ASP to out of service:

mml> SET-DEST:ASP:OOS

Comments:

Performance Impact Category: A

This command supports wildcarding.

First shut down the D channel on the NAS before issuing the command SET-DEST:NASLINK:OOS.

This command replaces the SET-DEST-STATE command in software Release 7.12 and earlier. Use the SET-IPLNK command to change the service state of a SIP, EISUP, or MGCP IP link to in-service (IS), out-of-service (OOS), or forced out-of-service (FOOS).

The set-dest command should be used only while you are dynamically reconfiguring the system. Do not use the set-dest command to take a signaling service OOS during a maintenance session, because all calls associated with the specified signaling service are dropped. You should instead use the blk-cic command to block the CICs associated with the signaling service when you need to perform maintenance.

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information.

SET-IPLNK—Change the Service State of an IP Link

 

Purpose:

Changes the service state of an MGCP, EISUP, or SIP IP link to the in-service (IS), out-of-service (OOS), or forced out-of-service (FOOS) state.

Syntax:

set-iplnk:<ip link>:is|oos|foos
set-iplnk:<mgcp-ip link>:is|oos|foos:confirm
set-iplnk:ip link:PST,<confirm>

Input Description:

  • Ip link —MML component name of a previously configured IP link.
  • PST—Desired primary state:

IS—In service

OOS—Out of service

FOOS—Forced out of service

  • Confirm—Enter this parameter when the PST is changed to OOS or FOOS

Note Do not issue this command for an Cisco PGW 2200 Softswitch host in Standby mode.

Example:

The MML command shown in the following example sets an IP link into service:

mml> SET-IPLNK:MGCPLK4:IS, confirm
MGC-01 - Media Gateway Controller 2001-01-01 18:59:03
M COMPLD
"mgcplk4"
;

The MML command shown in the following example changes the primary state of an IP link to out of service:

mml> set-iplnk:iplnk1:OOS,confirm
MGC-02 - Media Gateway Controller 2002-06-20 17:34:46.430 EST
M COMPLD
;

Comments:

Performance Impact Category: C

This command was introduced in software Release 9 and replaces SET-SC-STATE and SET-DEST-STATE. It uses wildcarding.

SET-IPROUTE—Changing IP Route Primary State

 

Purpose:

Changes the primary and secondary states of an IP route.

Syntax:

set-iproute:ip_route_name:pst[,confirm]

Input Description:

  • IP_rout_name —MML name of a previously configured IP route.
  • PST—Desired primary state; valid values are IS, OOS, or FOOS
  • Confirm—Must be used when you set the primary state to OOS to verify the new state. An IP route in any of the following states can be commanded OOS:

IS

OOS,CONF

OOS,OFF_DUTY

OOS,STBY.

Example:

The MML command shown in the following example changes the primary state of an IP route to OOS:

mml> set-iproute:iproute1:oos,confirm

Comments:

Performance Impact Category: A

SET-LOG—Set Logging Levels

 

Purpose:

Sets the logging level of a process or of all processes.

Syntax:

set-log:<proc>:<log level>
set-log:all:<log level>,confirm

Input Description:

  • proc —The various actively and passively monitored processes running on the Cisco PGW 2200 Softswitch. 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.

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 Cisco 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 an order of verbosity levels, in that at CRIT the least information is logged, and at DEBUG the most information is logged.

Example:

The MML command shown in the following example sets the logging level of PM-01 process to DEBUG:

mml> SET-LOG:PM-01:DEBUG
MGC-01 - Media Gateway Controller 2001-01-05 11:37:51
M COMPLD
"PM-01"
;

Comments:

Performance Impact Category: D; if logging level is set to DEBUG, TRACE, or INFO, call processing performance can be severely impacted.

This command was introduced in software Release 7.4 and replaces the CHG-LOG command.

The process manager (PM-01) is not included in the “all” parameter, because this is a special process. The logging level of PM-01 must be set individually, as in thepreceding example.

Also, DSKM-01 (the disk monitor process) does not accept log-level change requests.

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about processes.

SET-LSSN-STATE—Set State of Local SSN

 

Purpose:

Sets the state of a local SSN to IS or OOS.

Syntax:

set-lssn-state::<SSN>,IS|OOS

Input Description:

  • <ssn> —The SSN name, as defined in the provisioned component SS7 subsystem. Use the PROV-RTRV:SS7SUBSYS:"ALL" command's "Name" field to find a valid SSN name.
  • IS—In service
  • OOS—Out of service

Example:

The MML command shown in the following example sets the local SSN lnp to IS:

mml> SET-LSSN-STATE::LNP,IS
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"TCAP-01"
;

Comments:

Performance Impact Category: C

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about components.

SET-SPC—Set Signal Point Code State

 

Purpose:

Changes the service state of a signal point code to IS or OOS.

Syntax:

set-spc:<point code>:IS|OOS...

Input Description:

  • point code —Signal point code.
  • IS—In service
  • OOS—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:STP1:OOS
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
"stp1"
;

Comments:

Performance Impact Category: C

SET-THRES—Set Threshold Values

 

Purpose:

Changes the threshold settings for a measurement category for a particular interval to a new value.

Note This command can be used only to change a predefined threshold setting.

Syntax:

SET-THRES::CAT=”<Meas Cat>”, INTERVAL=<SECONDS>,THRES=<VALUE>

Input Description:

  • cat —Logical identifier that specifies the measurement category. For a list of measurement categories, use the prov-rtrv MML command.
  • interval—Measurement interval.
  • thres—Threshold at which an alarm is set.

Example:

The MML command shown in the following example sets the threshold values for the line-interface-severely-errored seconds measurement category to 1800 seconds and the threshold to 125:

mml> set-thres::cat="SIP: RETX MSG TOT",interval=1800, thres=125
MGC-01 - Media Gateway Controller 2008-10-24 01:40:37.543 EDT
M COMPLD
"SIP: RETX MSG TOT"
;

Comments:

Performance Impact Category: A

SND—Send Message to External Process

 

Comments:

This command is no longer supported.

STA-ABN-TRC—Start Abnormal Trace

 

Purpose:

Prints the state machine global variable of a particular call, as well as external event information, to a file.

Syntax:

sta-abn-trc:<sigpath|all>[,log=<xyz>][,prd=n],confirm

Input Description:

  • sigpath —Corresponding MML name for any of the following component types:

Signal path of in-band TDM up to MUX and then time switched to TDM media and sent to Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to CU and then encapsulated and sent over IP to the Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to NAS and then converted to NI2 and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP->Cisco PGW 2200 Softswitch)

Signal path or route set associated with SS7 destination PC

Signal path for EISUP

  • all —Indicates that the start trace command needs to be applied to the whole Cisco PGW 2200 Softswitch, in which case only one trace file is generated.
  • log —The log parameter accepts the name (xyz in this example) of an ASCII log file to which the output is written. The name given in this parameter is used as a prefix to the actual name of the file, which includes the signal path name and date and time. If no log filename is provided, a default name consisting of the signal path name and date and time is created. The extension of these log files is prt and they are located in the ../var/trace directory.
  • prd —The period, in seconds, for which this trace is enabled, during which time any abnormal calls are traced. If this optional parameter is not used, the period defaults to 30 seconds.
  • confirm—If no confirm option is entered, the command is rejected, and you are notified of the potential performance impact of this command.

Example:

The MML commands shown in the following examples print information about various abnormal calls:

mml> STA-ABN-TRC:ALL:CONFIRM
Media Gateway Controller 2000-05-26 07:02:11
M COMPLD
"all"
;
mml> STA-ABN-TRC:AM401A-PC:CONFIRM,TC=4
Media Gateway Controller 2000-05-26 07:14:06
M DENY
SROF
"am401a-pc:Trace active for the following file(s):
../var/trace/_20000526071406.abn
"
/* Component already exists */
;

Comments:

Performance Impact Category: B, C. Impact depends on how many abnormal calls are occurring and on the number of gateways configured.

This command accepts wildcards on signal paths.

STA-AUD—Start Auditing Process

 

Purpose:

Starts the auditing process on all calls. The auditing process stops automatically when it is completed.

Syntax:

sta-aud

Example:

The MML command shown in the following example starts the auditing process on all calls:

mml> STA-AUD
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"ENGG-01"
;

Comments:

Performance Impact Category: C.

If you suspect a stuck or hung CIC, see Cisco PGW 2200 Softswitch Release 9 Operations, Maintenance, and Troubleshooting Guide for information on troubleshooting the Cisco PGW 2200 Softswitch node.

STA-AUD-CIC—Start CIC State Auditing Process

 

Purpose :

Start a CIC audit.

Syntax:

sta-aud-cic

Input Description:

  • sta —Start
  • aud—Audit
  • cic —Circuit

Example :

mml> sta-aud-cic
MGC-01 - Media Gateway Controller 2004-08-13 10:05:27.997 EST
M COMPLD
"MGC-01"
;

Comments:

CDB 1071 is configurable in XECfgParm.dat if you add it in engine, CDRmessageType. If CDB 1110 is configured, CDB 1071 is suppressed.

STA-AUD-GW—Start Auditing of MGCP Gateway

 

Purpose:

Starts the auditing of an MGCP gateway. There is no stop command at this time. To retrieve the output of this audit, issue the RTRV-AUD-GW command.

Note The STA-AUDIT-GW and RTRV-AUDIT-GW commands are no longer supported as of Release 9.6(1).

Note This command works only on gateways that support the Simple Resource Coordination Protocol (SRCP).

Syntax:

sta-aud-gw:<sig path MGCP>
sta-aud-gw:all

Input Description:

  • sig path MGCP —MGCP signal path created with the PROV-ADD MGC command.
  • all—All MGCP gateways.

Example:

The MML command shown in the following example starts the auditing of T-1-16:

mml> STA-AUD-GW:T-1-16
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
;

Comments:

Performance Impact Category: C

STA-AUD-H248—Start Audit of H.248 Gateway (Release 9.7(3))

 

Purpose:

Starts an audit of an H.248 gateway.

Syntax:

sta-aud-h248:terms:sigpath=”h248_sigpath1”,cntxId=”Context_id", termId="termid"
sta-aud-h248:cntxs:sigpath="h248_sigpath1",cntxId="ContextId"
sta-aud-h248:gateway:sigpath="h248_sigpath1"

Input Description:

  • cntxId— For sta-aud-h248:terms:sigpath can be ALL or a specified context ID. Use 0 to specify NULL context ID.
  • cntxId— For sta-aud-h248:cntxs:sigpath can be specified context ID. ALL context ID or 0 context ID is not allowed.
  • termId— Can be a specified termination ID or a wildcard. If you use a wildcard, termId can have, at most, one “*”, for example, termId=“DS/OC3_1/T1_1/*” is allowed, but termId=“DS/OC3_1/*/*” is not allowed.

Example:

The MML command shown in the following example starts an audit on an H.248 gateway on sigpath H248-sigpath-01:

mml> sta-aud-h248:gateway:sigpath=”h248-sigpath-01”

Comments:

Performance Impact Category: C.

STA-DNS-INFO—Start Retrieve Process of DNS Cache

 

Purpose:

Starts the retrieve process of DNS cache information. The information is retrieved with the RTRV-DNS-INFO command.

Syntax:

sta-dns-info:<sig path sip>:<param>

Input Description:

  • sig path sip —MML name of SIP signal path
  • param—URL | cache entry number | null string

Example:

The MML command shown in the following example starts the retrieve process for SIP-sigPath:

mml> STA-DNS-INFO:SIP-SIGPATH:""
Media Gateway Controller - MGC-01 2000-12-30 14:27:48
M COMPLD
"sip-sigpath"
;

Comments:

Performance Impact Category: A

STA-DNS-PURGE—Start Purge of DNS Cache

 

Purpose:

Starts the purge of a DNS cache.

Syntax:

sta-dns-purge:<sig path sip>

Input Description:

  • sig path SIP —MML name of the SIP signal path.

Example:

The MML command shown in the following example starts a purge of the DNS cache for SIP-sigPath:

mml> STA-DNS-PURGE:SIP-SIGPATH
Media Gateway Controller - MGC-01 2000-12-30 14:27:48
M COMPLD
"sip-sigpath"
;

Comments:

Performance Impact Category: A.

You must execute the STA-DNS-INFO command before you use the STA-DNS-PURGE command.

STA-SC-TRC—Start Trace

Purpose:

Starts a protocol conversion trace on a signal path or a point code. You typically perform a trace when calls are failing, and the engine is the suspected source of the problem.

In Release 9.7(3), adds some enhanced functions to the original per call trace, including collecting per call trace on calling/called party number, adding MCL setting, capturing long duration calls, collecting call trace on cause value and fixing per call trace on a particular sigPath/Span/cic (or trunkgroup/trunk) combination.

Syntax:

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]
 

In the active node:

sta-sc-trc:<sigpath>:[span=x][,rng=y][,tc=z][,rng=w][,anubmer=”callingpartynumber”][,bnumber=”calledpartynumber”][,causevalue=c] [,incompleteoverlapnumber][,duration=d][,mcl=m][,autostop][,prd=n] [,log=”log”],confirm
sta-sc-trc:<trunkgroup>:[trk=x][,rng=y][,anubmer=”callingpartynumber"] [,bnumber=”calledpartynumber"][,causevalue=c][,incompleteoverlapnumber] [,duration=d][,mcl=m][,autostop][,prd=n][,log=”log"],confirm
 

In the standby node:

sta-sc-trc:<sigpath>:[span=x][,rng=y][,tc=z][,rng=w][,mcl=m][,prd=n] [,log=”log”],confirm
sta-sc-trc:<trunkgroup>:[trk=x][,rng=y][,mcl=m][,prd=n][,log=”log"],confirm

Input Description:

  • sigpath —Logical signal destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path.
  • span—Span ID. Span is used with rng and sigpath . It is the E1/T1 ID for NFAS-ISDN, ffff for SS7 and DPNSS; FAS-ISDN can use either a real value (range is 0 to 65535)or ffff, depending on the format of the channel identifier information element used by the switch or PBX. Hex >= 0 and <= ffff.
  • rng—Range. Range is 0 to 65535. Default value is 0. 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—Traffic channel of interest in integer (range is 0 to 65535) form. It is used with rng , span , and sigpath .
  • anumber —Original/pre-modified calling party number. Can be up to 32 digits. Possible digits are 0123456789abcdefABCDEF*. The anumber is supported with a wildcard (*) at the end.
  • bnumber —Original/pre-modified called party number. Can be up to 32 digits. Possible digits are 0123456789abcdefABCDEF*. The bnumber is supported with a wildcard (*) at the end.
  • causevalue —The internal cause value. Range is 1 to 300.
  • incompleteoverlapnumber— Incomplete-number overlap call. These overlap calls fail, but number is still not complete, and without enough number analysis result to decide whether to record them.
  • duration —Call duration in seconds. Range is 3600 to 2147483.The value must be not more than prd . If a call's duration is greater than this value, this trigger is matched. XECfgParm.dat adds one new parameter (CallNumberToWriteIntoTracefile) to limit the calls number (default is 200) to write their buffer into trace file while stopping the call trace.
  • mcl —MCL. Possible value: 1: stop trace once MCL reaches MCL1; 2: stop trace once MCL reaches MCL2; 3: stop trace once MCL reaches MCL3. 0: not stop trace when MCL occurs. Default value: 1.
  • autostop—Stop trace once any one required call trace (i.e. all input triggers are matched) is collected. Note: If trigger "duration" is input or none of trace triggers is input, autostop must not be input.
  • prd —Trace period in seconds. Range is 0 to 2147483. Default value is 1800. Stops the trace when the call trace running time reaches this value.
  • confirm—If no confirm option is entered, the command is rejected and you are notified in a message of the potential performance impact of this command. This is required for a signal path level trace or a trunk group level trace because of the potential performance impact of tracing at these levels.
  • trunkgroup—Logical trunk group of interest. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information.

Note When specifying the trunk group number, enter the prefix tg-.
Example: sta-sc-trc:tg-404:log="test"prd=60,confirm

 

  • log —Logfile name prefix. 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, 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 a ".btr" extension and 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.

  • trk—Trunk number. This is either a trunk number within the trunk group of interest or the starting trunk of a range.

Example:

Trace the call with calling number 7300 and called number 7000 at sigpath ss7svc6:

mml> sta-sc-trc:ss7svc6,anumber="7300",bnumber="7000",confirm
 

Trace the call with calling number 7300 and if this required call trace is collected then stop trace:

mml> sta-sc-trc:ss7svc6,anumber="7300",autostop,confirm
 

Trace the calls at sigpath ss7svc6 CIC=22~30 and stop trace when MCL reaches MCL2:

mml> sta-sc-trc:ss7svc6,span=65535,tc=22,rng=8,mcl=2,confirm
 

Trace the calls with internal cause value 44 at sigpath ss7svc6

mml> sta-sc-trc:ss7svc6,causevalue=44,confirm
 

Trace the calls that are set with overlap flag and called number is not complete but failed at sigpath ss7svc6:

mml> sta-sc-trc:ss7svc6,bnumber="7000",incompleteoverlapnumber, confirm
 

Trace the calls with call duration > 3 hours for 12 hours in trunkgroup tg-6006:

mml> sta-sc-trc:tg-6006,duration=10800,prd=43200,confirm
 

The MML command shown in the following example starts a capture session for all PDUs going through the signal 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 signal 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.

Comments:

Performance Impact Category: C, D. Impact depends on scope of trace.

On successful completion, all protocol data unit (PDU) traffic on the path is captured in a log file. This MML command succeeds regardless of the service state of the path.

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about signal destinations.

STA-SS7-SLT—Start MTP SLT Test on a Link

Purpose:

Starts an MTP signal link test on a link.

Syntax:

sta-ss7-slt:<c7 link>

Input Description:

  • c7 link —The MML component name of a signal channel (linkset, C7 IP link, or TDM link used in a linkset).

Example:

The MML command shown in the following example starts a signal 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
Media Gateway Controller - MGC-01 2000-01-12 15:18:34
M RTRV
"ls1link1"
;

Comments:

Performance Impact Category: A

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information about signal channels.

STA-SS7-SRT—Start MTP SRT Test on an SS7PATH

 

Purpose:

Starts an MTP signal route test on an ss7path configured for Japanese SS7.

Syntax:

sta-ss7-srt:<ss7path>:lset="<c7 linkset>"

Input Description:

  • ss7path —The MML component name of an ss7path.
  • c7 linkset —The provisioning component C7 link, TDM link used in a linkset, or linkset.

Example:

The MML command shown in the following example starts a signal route test on ss7path1 with C7 linkset ls1. The result of this test is retrieved by the command RTRV-SS7-SRT:SS7PATH1:LSET=“LS1”.

mml> STA-SS7-SRT:SS7PATH1:LSET-”LS1”
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"ss7path1"
;

Comments:

Performance Impact Category: A

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of C7 linksets. Use the RTRV-LSET command to retrieve a list of linksets.

STA-TCAP-TRC—Start TCAP Tracing

 

Purpose:

Starts TCAP tracing.

Syntax:

STA-TCAP-TRC

Example:

The MML command shown in the following example starts TCAP tracing:

mml> STA-TCAP-TRC
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"TCAP-01"
;

Comments:

Performance Impact Category: C

STP-ABN-TRC—Stop Abnormal Trace

 

Purpose:

Stops abnormal calls tracing initiated by the STA-ABN-TRC command.

Syntax:

stp-abn-trc:<sigpath|all>

Input Description:

  • sigpath —Corresponding MML name for any of the following component types:

Signal path of in-band TDM up to MUX and then time switched to TDM media and sent to Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to CU and then encapsulated and sent over IP to the Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to NAS and then converted to NI2 and sent to the Cisco MGC over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP->MGC)

Signal path or route set associated with SS7 destination PC

Signal path for EISUP

  • all —Indicates that all abnormal traces currently running on the Cisco PGW 2200 Softswitch are to be stopped.

Example:

The MML command shown in the following example stops all abnormal traces running on the Cisco PGW 2200 Softswitch:

mml> STP-ABN-TRC:ALL
Media Gateway Controller 2000-05-26 07:02:11
M COMPLD
"ALL:Trace stopped for the following files:
 
../var/trace/_20000526070211.abn
"
;

Comments:

Performance Impact Category: A

This command accepts wildcards on signal paths.

STP-AUD—Stop Auditing Process

 

Purpose:

Stops the auditing process started with the STA-AUD command.

Syntax:

STP-AUD

Example:

The MML command shown in the following example stops all auditing processes started with the STA-AUD command:

 
mml> STP-AUD
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"ENGG-01"
;

Comments:

Performance Impact Category: A

STP-CALL—Stop Calls

 

Purpose:

Stops calls in progress for a specified signal channel or destination point code. It first attempts to gracefully stop calls, and, if unsuccessful, it forcefully releases the calls. By default, all traffic channels are affected.

Syntax:

stp-call:<mgc>:confirm
stp-call:<gway>:confirm
stp-call:<trkgrp>:confirm
stp-call:<sigpath>:confirm
stp-call:<sigpath>:span=x,confirm
stp-call:<sigpath>:span=x,bc=y[,rng=z],confirm
stp-call:<sigpath>:cic=x[,rng=y],confirm

Input Description:

Target parameters are as follows:

  • mgc—Corresponding MML name of the Cisco PGW 2200 Softswitch.
  • gway—Corresponding MML name for the media gateway. Not all media gateway types are applicable. Supported types are CU, MUX, MGW, and AVM external nodes.
  • trkgrp—Applicable only for time-division multiplexing (TDM). Use the corresponding MML name for component type "0020".

Note When specifying the trunk group number, enter the prefix tg-.
Example: stp-call:tg-404:confirm


  • sigpath—Corresponding MML name for any of the following component types:

Signal path of in-band TDM up to MUX and then time switched to TDM media and sent to the Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to CU and then encapsulated and sent over IP to the Cisco PGW 2200 Softswitch

Signal path of in-band TDM signaling up to NAS and then converted to NI2 and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP-> MGC)

Signal path or route set associated with SS7 destination PC

Signal path for EISUP

  • span—spanId is a 16-bit value that identifies an ISDN/PRI physical cable.
  • bc—Numeric value that identifies the non-ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC.
  • cic—Numeric value that identifies the ISUP circuit identification code number.
  • rng—Range of either the bearer channel or the CIC.

Example:

The MML command shown in the following example stops calls in progress for signal channel PC-2-2-2-2:

mml> STP-CALL:PC-2-2-2-2:CONFIRM
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
;

Comments:

Performance Impact Category: C

STP-SC-TRC—Stop One or All Traces

Purpose:

Stops a protocol conversion trace session on one signal path or on all signal paths.

Syntax:

stp-sc-trc:<sig path>
stp-sc-trc:<trkgrp>
stp-sc-trc:all

Input Description:

  • sig path —Logical identifier for a signal path.
  • trkgrp —Logical identifier for a trunk group.

When specifying the trunk group number, enter the prefix tg-.
Example: stp-sc-trc:tg-404

  • all —Stops all traces.

Example:

The MML command shown in the following example stops a trace 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 trace 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
"
;

Comments:

Performance Impact Category: A

STP-TCAP-TRC—Stop TCAP Tracing

 

Purpose:

Stops TCAP tracing that has been started with the STA-TCAP-TRC command.

Syntax:

stp-tcap-trc

Example:

The MML command shown in the following example stops TCAP tracing:

 
mml> STP-TCAP-TRC
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"TCAP-01"
;

SW-OVER—Manual Switchover

 

Purpose:

Enables a switchover from an active to a standby system. You cannot use the sw-over command when the provisioning is new.

Syntax:

sw-over::confirm

Example:

The MML command shown in the following example enables a switchover from the active system to the standby system:

 
mml> SW-OVER::CONFIRM
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
;

Comments:

Performance Impact Category: D. Established calls are retained on forced switchover, and calls that are currently being set up may be dropped.

TST-COT—Manual COT

Purpose:

Executes a continuity test on a specified remote switch circuit.

Syntax:

tst-cot:<sigpath>:CIC=<number>

Input Description:

  • sigpath —MML component name of a provisioning component signal path.
  • cic=number—A numeric value that identifies the ISUP circuit identification code number.

Example:

The MML command shown in the following example executes a continuity test on C7S-01 CIC-5:

mml> TST-COT:C7S-01:CIC=5
Media Gateway Controller - MG-01 2000-01-12 15:19:51
M COMPLD
;

Comments:

Performance Impact Category: B.

If a continuity test fails, use the BLK-CIC command to block the CIC until the problem is identified and corrected. After a successful continuity test, use the UNBLK-CIC command to unblock the CIC.

UNBLK-CIC—Unblock a Circuit or a Circuit Range

 

Purpose:

Unblocks a circuit or a range of circuits that have been blocked with the BLK-CIC command.

Syntax:

unblk-cic:<sigpath>:cic=<number>[,rng=<range>]

Input Description:

  • sigpath —MML component name of a provisioning component signal path.
  • number —A valid circuit identification code (CIC).
  • range —A number such that number + range is a valid CIC. All circuits between number and number + range are unblocked. The range should not span trunks. For example, to unblock all the CICs from 60 through 90, the number would be 60 and the range would be 30.

Example:

The MML command shown in the following example unblocks CICs 5 through 15 for signal path ss7svc1:

mml> UNBLK-CIC:ss7svc1:CIC=5,RNG=10
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
"dpc1"
;

Comments:

Performance Impact Category: B

VLD-CIC—Validate a Circuit

 

Purpose:

Validates a circuit on a specified signal path and CIC.

Note In software releases prior to and including 9.3(2), this command is supported only for SS7PATHs running the ANSI protocol.

Syntax:

vld-cic:<sigpath>:cic=<number>

Input Description:

  • sigpath MML component name of a signal path associated with the CIC.
  • number —A valid circuit identification code.

Example:

The MML command shown in the following example validates a circuit on SS7SVC1 CIC-105:

 
ml> VLD-CIC:SS7SVC1:CIC=105
 
Media Gateway Controller - MGC-01 2000-03-07 09:35:19
M RTRV
“ss7svc1:CIC=105,PASSED”
;
 

Example:

The MML command shown in the following example shows the MML response for a circuit that has failed validation:

mml> VLD-CIC:SS7SVC1:CIC=1314
MGC-01 - Media Gateway Controller 2001-02-08 13:54:04
M RTRV
"ss7svc1:CIC=1314,FAIL"
;

Comments:

Performance Impact Category: B

Output Description:

LOC: Values associated with the Cisco PGW 2200 Softswitch.

REM: Values associated with the destination exchange. Valid values for these fields are:

  • GRP—Circuit group carrier indicator. The values in these fields should be the same in the LOC and REM lines. Valid values are:

UNK—Unknown circuit group carrier type

ANL—Analog circuit group carrier type

DIG—Digital circuit group carrier type

AND—Analog and digital circuit group carrier type

  • SEIZ—Double seizing indicator. The values for this field in the LOC line should be logically opposite to the value for the REM line. Valid values are:

NONE—No circuit control. When one line is set to NONE, the other should be set to ALL.

ALL— All circuit control. When one line is set to ALL, the other should be set to NONE.

EVEN— Even circuit control. When one line is set to EVEN, the other should be set to ODD.

ODD—Odd circuit control. When one line is set to ODD, the other should be set to EVEN.

  • ALM—Alarm carrier indicator. The values in these fields should be the same in the LOC and REM lines. Valid values for this field are:

UNK—Unknown alarm carrier

SOFT—Software alarm carrier

HARD—Hardware alarm carrier

  • COT—Continuity check requirements indicator. The values in these fields should be the same in the LOC and REM lines. Valid values are:

UNK—Unknown continuity check requirements

NONE—No continuity check requirements

STAT—Statistical continuity check requirements

PERC—Per call continuity check requirements

  • TRK—Trunk number. This field is always displayed in the LOC line. It is only displayed in the REM line when the circuit identification names for the Cisco PGW 2200 Softswitch and the destination exchange do not match.
  • A_CLLI—Common language location identifier (CLLI) for either the destination exchange or the Cisco PGW 2200 Softswitch. CLLIs for each are sorted alphanumerically, and the A_CLLI field is populated with the CLLI that is first alphanumerically. This field is always displayed in the LOC line. It is only displayed in the REM line when the circuit identification names for the Cisco PGW 2200 Softswitch and the destination exchange do not match.
  • Z_CLLI—CLLI code assigned to the Cisco PGW 2200 Softswitch for either the destination exchange or the Cisco PGW 2200 Softswitch. CLLIs for each are sorted alphanumerically, and the Z_CLLI field is populated with the CLLI that is last alphanumerically. This field is always displayed in the LOC line. It is only displayed in the REM line when the circuit identification names for the Cisco PGW 2200 Softswitch and the destination exchange do not match.