Commands For Operations, Maintenance, and Troubleshooting: ACK-ALM-Acknowledge Alarm

CH A P T E R
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-ALMAcknowledge 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.
ack-alm:<comp> ack-alm:<comp>:<alm cat> ack-alm:<comp>:<alm sev>
Syntax:
Input Description:
compThe component that is generating the alarm. Components are described in Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. See the RTRV-CTRRetrieve Measurement Counter section on page 3-21 to retrieve a list of system components. This value can also be ALL for all components. If a component is used but no alarm category or severity is used, all alarms for the component are acknowledged. alm catThe alarm category, or the text that appears in the body of the alarm. See the RTRV-ALMSRetrieve Active Alarms section on page 3-11 to retrieve all active alarms. alm sevThe alarm severity, as it appears in the body of the alarm. See the RTRV-ALMSRetrieve Active Alarms section on page 3-11 to retrieve all active alarms.
Note
The terms for alarm category and severity are case sensitive, and they must be in quotation marks.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference OL-1116-24
3-1
Chapter 3 BLK-CICBlock a Circuit or a Circuit Range
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-CICBlock a Circuit or a Circuit Range

Purpose: Syntax: Input Description: Blocks a circuit or range of circuits from carrying calls.
blk-cic:<sig path>:CIC=<number>[,RNG=<range>]
sig pathMML component name of a signal path created with the prov-add:sigpath command. numberA valid circuit identification code (CIC). rangeA 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.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
3-2
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting CLR-MEASReset a Measurement Category
CLR-MEASReset a Measurement Category

Purpose: Syntax: Input Description: Resets a measurement category of a component.
clr-meas:<comp>:<meas cat>
compThe component being measured. See the RTRV-CALLIMRetrieves the Call Limiting Function Status section on page 3-16 to retrieve a list of system components. meas catLogical identifier that selects the measurement category. 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 M COMPLD ; - MGC-01 2000-01-12 15:19:51
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-TRANSClear TCAP Transactions

Purpose: Clears all transaction capabilities application part (TCAP) transactions that are older than the specified period.
clr-tcap-trans::T=<number>
Syntax: Input Description:
TThe 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 ;
3-3
Chapter 3 DIAGLOGDiagnostics Log
DIAGLOGDiagnostics Log
Purpose: Syntax: Input Description: Starts and stops event logging into a diagnostics log.
diaglog:<file name>:START | STOP
file nameThe 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 | STOPInstructs 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 M COMPLD ; - MGC-01 2000-01-12 15:19:51
Comments:
See Cisco PGW 2200 Softswitch Release 9 Messages Reference Guide for more information about log files.
KILL-CALLTerminate 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
3-4
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting PRT-CALLPrint Call
Input Description:
sigpathMML name of the SS7 or ISDN-PRI signal path associated with the stuck CIC. targetMML name of the media gateway controller, gateway, or trunk group associated with the stuck span and bearer channel. spanNumber of the affected span. BCNumber of the affected bearer channel. RNGNumber that represents a range of affected bearer channels or CICs. CICNumber of the affected Circuit Identification Code. CIDUnique 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-CALLPrint Call
Purpose: Syntax: Prints diagnostic information about an active call to a log file.
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>
3-5
Chapter 3 PRT-CALLPrint Call
Input Description:
sigpathCorresponding 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
cicThe ISUP circuit identification code number. spanspanId is a 16-bit value that identifies an ISDN/PRI physical cable. bcThe non-ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC. cidUnique call identifier. logThe 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. evtReserved 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
3-6
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting QUERY-CICExecute Circuit Query
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-CICExecute 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.
query-cic:<sig path>:CIC=<number>[,RNG=<range>][,RSLV]
sig pathMML component name of a signal path created with PROV-ADD. numberA valid CIC. rangeA number such that number + range is a valid CIC. All circuits between number and number + range are queried. rslvFor 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" ;
3-7
Chapter 3 RESET-CICReset a Circuit or a Circuit Range
Output Description:
CICCircuit identification code. LPSTPrimary state.

ISIn service. OOSOut of service. TRNSTransient; the state is currently being changed.
LSSTLocal secondary state.

N/ANot available. UNEQUIPPEDUnequipped. IC_BUSYIncoming is busy. IC_BUSY_LOC_BLOCIncoming is busy, blocked locally. IC_BUSY_REM_BLOCIncoming is busy, blocked remotely. IC_BUSY_BOTH_BLOCIncoming is busy, blocked both remotely and
locally.
OG_BUSYOutgoing is busy. OG_BUSY_LOC_BLOCOutgoing is busy, blocked locally. OG_BUSY_REM_BLOCOutgoing is busy, blocked remotely. OG_BUSY_BOTH_BLOCOutgoing is busy, blocked both remotely and
locally.
IDLEThe circuit is idle, available for use. IDLE_LOC_BLOCIdle, blocked locally. IDLE_REM_BLOCIdle, blocked remotely. IDLE_BOTH_BLOCIdle, blocked both locally and remotely.
RPSTRemote primary state (states are same as LPST, above). RSSTRemote 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-CICReset a Circuit or a Circuit Range

Purpose: Syntax: Input Description: Resets or activates a circuit or a range of circuits.
reset-cic:<sig path>:CIC=<number>[,RNG=<range>]
sig pathMML component name of a signal path created with PROV-ADD. numberA valid circuit identification code (CIC). rangeA number such that number + range is a valid CIC. All circuits between number and number +range are reset.
3-8
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-ADMIN-STATERetrieve Administrative State
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-STATERetrieve 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]
3-9
Chapter 3 RTRV-ADMIN-STATERetrieve Administrative State
Input Description:
Target parameters are as follows:

mgcCorresponding MML name of media gateway controller. gwayCorresponding MML name for media gateway. Not all media gateway types are applicable. Supported types are CU, MUX, MGW, and AVM external nodes. trkgrptrkGrp 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

and sent to the Cisco PGW 2200 Softswitch

over IP to the Cisco PGW 2200 Softswitch

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
spanA 16-bit value that identifies an ISDN/PRI physical cable. bcThe non-ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC. cicThe ISUP circuit identification code number. rngThe range of either bearer channels or circuit identification codes. PSTPrimary administrative state:
LOCKLocked state UNLOCKUnlocked state SHUTDOWNShutdown state
Output Description:
LOCKNumber of bearer channels in locked state. UNLOCKNumber of bearer channels in unlocked state. SHUTDOWNNumber of bearer channels in shutdown state.
3-10
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-ALMSRetrieve Active Alarms
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-ALMSRetrieve Active Alarms

Purpose: Syntax: Input Description: Output Description: Displays all active alarms.
rtrv-alms rtrv-alms::cont
contTells the system to display alarm events until Ctrl-C is pressed.
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
3-11
Chapter 3 RTRV-ALMSRetrieve Active Alarms
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" ;
3-12
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-ASSOCIATIONDisplay State of SCTP Association
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-ASSOCIATIONDisplay State of SCTP Association

Purpose: Syntax: Input Description: Displays the primary and secondary states of an SCTP association.
rtrv-association:assoc_name rtrv-association:all
Assoc_nameMML name of a previously configured SCTP association. AllAll associations
3-13
Chapter 3 RTRV-AUD-GWRetrieve Auditing of MGCP Gateway
Output Description:
SCTP AssociationMML name of SCTP association specified. PSTPrimary state; valid values are:
INBInstalled busy; association has been created but has not yet been
commanded IN or OOS with the set-association command.

ISIn service OOSOut of service
SSTSecondary state; valid values are:

COOSCommanded out of service STBYThe local platform state is standby CONFOut 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:
RTRV-AUD-GWRetrieve 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)
rtrv-aud-gw:<sig path MGCP> rtrv-aud-gw:all
sig path MGCPRetrieves the auditing of an MGCP signal path created with the PROV-ADD:MGC command. allRetrieves the auditing of all MGCPs.
Output Description:
PASSThe 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.
FAILThe audit was unsuccessful.

<text>This is text returned from the IOCC. It can include endpoint name,
connection IDs, or other text explaining the result.
3-14
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-C7LNKRetrieve Attributes of a Linkset
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-C7LNKRetrieve Attributes of a Linkset

Purpose: Syntax: Input Description: Retrieves the attributes of a link or a linkset.
rtrv-c7lnk:<C7 linkset|C7 link> rtrv-c7lnk:all
c7 linksetThe 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-LSETRetrieve Linkset Service State section on page 3-33, to retrieve a list of linksets. allRetrieves the attributes of all links and linksets.
3-15
Chapter 3 RTRV-CALLIMRetrieves the Call Limiting Function Status
Output Description:
LIDLink or linkset ID PSTPrimary state; valid values are:

AOOSThe system has taken the resource out of service INBInstalled busy (resource has been created but not yet commanded IS or
OOS via the SET-C7LNK command)

ISIn service COOSCommanded out of service FOOSForced out of service OOSOut of service TRNSTransient; the state is currently being changed UNKUnknown
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:
RTRV-CALLIMRetrieves 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.
rtrv-callim
Syntax: Output Description: Example:
ENABLE | DISABLEInstructs the Cisco PGW 2200 Softswitch to either enable or disable call limiting. 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 "ENGG-01:ENABLE" ; RTRV
Comments:
3-16
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-CALLINFODisplay Call IDs of EISUP/SIP
RTRV-CALLINFODisplay 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.
rtrv-callinfo:target:[all|eisup|sip|ip|TDM]| [,calltime=minutes] [,detail]
targetMML name of the media gateway controller, gateway, or trunk group associated with the call. allDisplays 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.
eisupDisplays EISUP-to-EISUP calls from the target. sipDisplays SIP-to-SIP calls from the target. ipDisplays SIP, EISUP, or H323 calls from the target. TDMDisplays all SIP-to-TDM protocol calls, including SS7, ISDN, DPNSS, and QSIG calls from the target. calltimeDisplays 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. detailDisplays the To and From numbers.
3-17
Chapter 3 RTRV-CALLINFODisplay Call IDs of EISUP/SIP
Examples:
mml> mml> mml> mml>
rtrv-callinfo:eisup-sigpath:all rtrv-callinfo:eisup-sigpath:ip rtrv-callinfo:all:timerperiod=120 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"
3-18
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-CFGRetrieve Configuration Table
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-CFGRetrieve Configuration Table

Comments This command is no longer supported. The command prov-rtrv replaces it.
RTRV-CICRetrieve Bearer Channels

Purpose: Retrieves bearer channel information for one or more circuits that are identified by a signal path.
rtrv-cic:<sig path>:cic=<number>[,rng=<range>]
sig pathMML component name of a signal path component. numberA valid circuit identification code (CIC). rangeA number such that number + range is a valid CIC. All circuits between number and number + range are displayed.
3-19
Chapter 3 RTRV-CICRetrieve Bearer Channels
Output Description:
<SIG PATH>MML component name of a signal path component. CICCircuit identification code. PSTPrimary state.
ISIn service. OOSOut of service.
CALLCall state.
IDLECircuit is idle, available for use. OOSOut of service. ISIn service
GW_STATState of the gateway.

CARRIER_FAILURECarrier has failed. GW_HELDThe call has been held at the gateway. CXN_ISThe connection is in service. CXN_OOS_ACTIVEThe connection is out of service on the active
system.
CXN_OOS_STANDBYThe connection is out of service on the standby
system.
INTERFACE_DISABLED
BLKBlocking state
GATEWAYLocally blocked because of a gateway event (for example,
RSIP or a group service message).

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

LOCMANBlocked manually by MML. This is removable by the
UNBLK-CIC or RESET-CIC command.

LOCUNKLocally 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.)
NONEThere is no block on the CIC. DS0 is available for use. REMAUTORemotely auto blocked. REMMANRemotely manually blocked.
3-20
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-CTRRetrieve Measurement Counter
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-CTRRetrieve Measurement Counter

Purpose: Syntax: Input Description: Displays a measurement counter for a component.
rtrv-ctr:<comp>:"<meas cat>"
compThe MML name of the component you want to examine. Use the prov-rtrv command described in the PROV-RTRVRetrieve Provisioning Information section on page 2-13 to retrieve a list of system components. meas catLogical identifier that selects the measurement category or measurement group. For a list of measurement categories, see the RTRV-CALLIMRetrieves the Call Limiting Function Status section on page 3-16 to retrieve a list of measurement categories. For descriptions of measurements, see Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. <COMP>Component CATMeasurement category BCKTBucket, which is the measurement interval defined as 15 minutes, 60 minutes, or 24 hours VALValue measured
Output Description:
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:
3-21
Chapter 3 RTRV-DCHANRetrieve D-Channel Status
RTRV-DCHANRetrieve D-Channel Status

Purpose: Syntax: Input Description: Displays attributes of a D-channel or all D-channels.
rtrv-dchan:<D channel | fas link> rtrv-dchan:all
dchannelD-channel. fas linkFacility associated signaling service or signaling past a particular destination when you use either ISDN-PRI or DPNSS. allDisplays attributes of all D-channels. LIDLink ID. PRIPriority rate interface priority; this is an integer, either 0 or 1. STBYThis is the standby D-channel. PSTThis is the primary D-channel. Valid values are:
AOOSThe system has taken the resource out of service. INBInstalled busy (resource has been created but not yet commanded IS or
Output Description:
OOS by the SET-DCHAN command).

ISIn service. MOOSManually taken out of service. OOSOut of service. TRNSTransient; the state is currently being changed. UNKUnknown.
3-22
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-DESTRetrieve Destination
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:
RTRV-DESTRetrieve Destination
Purpose: Syntax: Input Description: Retrieves information about one or more destinations.
rtrv-dest:<sig path> rtrv-dest:all
sig pathThe 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. allDisplays information about all external point codes and signal paths.
3-23
Chapter 3 RTRV-DESTRetrieve Destination
Output Description:
<SIG PATH>Signal path PKGProtocol family ASSOCAssociated channels

UNKUnknown. SWITCHEDThe destination is switched, not associated. <CHANNEL>The channel with which the destination is associated.
PSTPrimary state; valid values are:

AOOSThe system has taken it out of service. INBInstalled busy (resource has been created but not yet commanded IS
or OOS by the SET-DEST-STATE command).

SSTSecondary state valid values are:

UNDUndefined CRTECreated DLTDeleted CISCommanded in service COOSCommanded out of service FLDFailed RSTORestored RSTReset CONGCongestion FOOSForced out of service CINHCommanded to the inhibited state CUINHCommanded to the uninhibited state CEACommanded into emergency alignment EISEngine in service EOOSEngine 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.
3-24
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-DNS-INFORetrieve DNS Cache
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-INFORetrieve DNS Cache

Purpose: Syntax: Input Description: Output Description: Retrieves information from a domain name server (DNS) cache.
rtrv-dns-info:<sip-sig path>
sig path sipMML name of SIP signal path.
<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
3-25
Chapter 3 RTRV-EQPTRetrieve Service State of a Component
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-EQPTRetrieve Service State of a Component

Comments: This command is no longer supported.
RTRV-H248:CNTXS:SIGPATHRetrieve 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.
rtrv-h248:cntxs:sigpath=h248-sigpath-name",cntxid="all/context id"
sigpath-nameName of the H.248 signal path, the route of a signal channel that carries signaling data. cntxidContext 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:
3-26
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-IPLNKRetrieve Attributes of an IP Link
RTRV-IPLNKRetrieve Attributes of an IP Link

Purpose: Syntax: Input Description: Output Description: Displays the attributes of an NAS, MGCP, SIP, or EISUP IP link.
RTRV-IPLNK:<IP LINK> RTRV-IPLINK:all
<IP LINK>MML component name of a previously configured IP link. allDisplays the measurements for all links. <PARENT NAME>IP link name. <PST>Primary state; valid values are:
OOS by the SET-IPLNK command).

ISIn service. COOSCommanded out of service. FOOSForced out of service. OOSOut of service. OFF_DUTYRedundant link. TRNSTransient; the state is currently being changed. UNKUnknown.
3-27
Chapter 3 RTRV-IPLNKRetrieve Attributes of an IP Link
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:
3-28
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-IPROUTEDisplay Primary and Secondary States of an IP Route
RTRV-IPROUTEDisplay Primary and Secondary States of an IP Route

Purpose: Syntax: Input Description: Output Description: Displays the primary and secondary states of an IP route.
rtrv-iproute:ip_route_name rtrv-iproute:all
Ip_route_nameMML name of a previously configured IP route. AllRetrieves the primary state of all IP routes.
IP routeMML name of the specified IP route. PSTPrimary state; valid values are:

COOSCommanded out of service STBYThe local platform state is standby OFF_DUTYThe link is available for use but is not currently being used. CONFThe 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:
3-29
Chapter 3 RTRV-LICSDISPLAY LICENSES
RTRV-LICSDISPLAY 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.
rtrv-lics:base rtrv-lics:Interface rtrv-lics:configure rtrv-lics:runtime rtrv-lics:SBEinterface rtrv-lics:TimesTen License rtrv-lics:all
Syntax:
Input Description:
baseBase license information interfaceInterface license information configureConfiguration TDM Ports license information runtimeRun-time license information allAll license information EntitledIndicates if the interface is licensed and the number of licenses. UsedIndicates if the interface is used and the number of licenses provisioned. AvailableIndicates the number of unused licenses. Run-time license
Entitled license numberNumber of licenses Current usageRuntime 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)
Output Description:
3-30
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-LOCLABEL
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:
RTRV-LOCLABEL
Purpose: Syntax: Displays the measurements of a location label.
rtrv-loclabel:loclabel name rtrv-loclabel:all rtrv-loclabel:all:percent=number
Input Description:
loclabel nameRetrieves the measurements of a location label. AllRetrieves the measurements of all location labels All:percent=numberRetrieves the measurements for all location labels that used labels within the percentage. loc1location label name. loc2defined call limit number loc3active call number</syntax>
Output Description:
3-31
Chapter 3 RTRV-LOG
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:
RTRV-LOG
Purpose: Syntax: Input Description: Displays the logging level of a process or of all processes.
rtrv-log:all rtrv-log:<proc>
allDisplays the logging levels of all processes. procThe various actively and passively monitored processes running on the Cisco PGW 2200 Softswitch. See the SET-LOGSet Logging Levels section on page 3-66 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
CRITCritical WARNWarning ERRError TRACETrace INFOInformational DEBUGDebug
3-32
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-LSETRetrieve Linkset Service State
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 M RTRV "PM-01:DEBUG" ; - MGC-01 2000-01-16 09:38:03
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-LSETRetrieve Linkset Service State

Purpose: Syntax: Input Description: Retrieves the service state of a linkset.
rtrv-lset:<linkset>
<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-RTRVRetrieve Provisioning Information section on page 2-13, for a list of linksets. AOOSThe system has taken the resource out of service. INBInstalled busy (resource has been created but not yet commanded IS or OOS by the set-dest command). ISIn service. MOOSManually taken out of service. OOSOut of service. TRNSTransient; the state is currently being changed. UNKUnknown.
Output Description:
Example:
The MML command shown in the following example retrieves the service state of linkset ls1:
mml> RTRV-LSET:ls1 Media Gateway Controller M RTRV MOOS ; - MGC-01 2000-01-12 15:19:51
Comments:
3-33
Chapter 3 RTRV-LSSNRetrieve State of All Local SSNs
RTRV-LSSNRetrieve State of All Local SSNs

Purpose: Syntax: Output Description: Displays the state of all local SSNs (LSSNs).
rtrv-lssn:all
<process>Name of process <lssn>Name of local subsystem number pstPrimary state

isIn service oosOut 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:
RTRV-MMLRetrieve Active MML Sessions

Purpose: Displays all active MML sessions, their session numbers, and the user IDs of the session originators.
rtrv-mml
Syntax: Output Description:
MML1Session number
<username>UNIX username of session owner
MML2Session 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 M RTRV mml5:guest ; - MGC-01 2000-01-12 15:19:51
Comments:
3-34
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-NERetrieve Network Element Attributes
RTRV-NERetrieve Network Element Attributes

Purpose: Displays information about the Cisco PGW 2200 Softswitch hardware, software, and current state (active or standby).
RTRV-NE
TypeType of controller. Hardware PlatformHardware platform. VendorCisco PGW 2200 Softswitch vendor. LocationController machine name. VersionController software version. Platform StateUse of controller.
ACTIVEThe controller in use. STANDBYThe 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:
RTRV-NE-HEALTHRetrieve 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.
rtrv-ne-health rtrv-ne-health::sys rtrv-ne-health::callp rtrv-ne-health::load rtrv-ne-health::all
Syntax:
3-35
Chapter 3 RTRV-NE-HEALTHRetrieve Network Element Health
Input Description:
sysRetrieves the top-level status of the Cisco PGW 2200 Softswitch host and the number of active alarms, arranging the alarms in order of severity. callpRetrieves:
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
loadRetrieves:
MCL CPU utilization Free memory Percentage of used disk space by partition
allAll of the above indicators. MEMORY:REALTotal amount of physical memory that can be allocated for use by processes. (It does not include memory reserved for use by the kernel.) MEMORY:FREEAmount of unallocated physical memory. MEMORY: SWAP IN USEAmount of swap area on the disk that is being used. MEMORY: SWAP FREEAmount of swap area on the disk that is still available. CPU STATESFractions of the total available computing resources. These must total 100 percent.
IDLEPercentage of CPU resources available USERPercentage consumed by users KERNELPercentage used by the kernel IOWAITPercentage used by the input-output wait process SWAPPercentage of CPU used in swap activity
Output Description:
CALL: SIPLicRej TOT SIP call rejected because of run-time license management. CALL: H323LicRej TOTH323 call rejected because of run-time license management. CALL: TDMLicRej TOTTDM call rejectedbecause of run-time license management.
3-36
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-NE-HEALTHRetrieve Network Element Health
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, 0.0% swap ; 6.7% user, 11.2% kernel, 1.6% iowait,
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" ;
3-37
Chapter 3 RTRV-OVLDRetrieve Overload Level
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-OVLDRetrieve Overload Level

Purpose: Displays the machine congestion level, congestion reason, and number of messages rejected caused by far end congestion.
rtrv-ovld
<COMPONENT>MML component name MCLMachine 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 ;
3-38
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-RASERVER (Release 9.7(3))
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.
rtrv-raserver:name=server-name
Syntax: Input Description: Output Description:
server-nameThe name of the RADIUS accounting server for which you want to display status. ISIn service ISOff duty OOSOut 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-RSSNRetrieve State of All Remote SSNs

Purpose: Syntax: Displays the state of all remote SSNs (RSSNs).
rtrv-rssn:all
3-39
Chapter 3 RTRV-RTERetrieve Route
Output Description:
<link>Name of link <RSSN>Remote subsystem number PCPoint code(s) SSNSubsystem number PSTPrimary state
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-RTERetrieve Route
Purpose: Syntax: Input Description: Retrieves all SS7 routes for a point code or for all point codes.
rtrv-rte:<dpc name> rtrv-rte:all
dpc nameThe MML component name of a destination point code allRetrieves all SS7 routes for all point codes
3-40
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-SC-TRCRetrieve Names of Open Signal Channel Traces
Output Description:
<PC>Target point code <LINKSET>Linkset ID APCAdjacent point code PRIOPriority set for the routes PSTPrimary state; valid values are:
AOOSThe system has taken the resource out of service. INBInstalled busy (resource has been created but not yet commanded IS
or OOS by the SET-DEST command).


NACause not available. LINSLinkset failure. PRHBC7 prohibited (PGW has received a transfer-prohibited message or
TFP from the STP).

RSTRC7 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:
RTRV-SC-TRCRetrieve 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-TRCStart Trace section on page 3-73 and the STP-SC-TRCStop One or All Traces section on page 3-80 for information on starting and stopping traces.
rtrv-sc-trc rtrv-sc-trc::stopreason
Syntax:
3-41
Chapter 3 RTRV-SGPDisplay the Primary and Secondary States of an SGP
Output Description: Example:
Names of all files currently open for traces in progress.
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:
RTRV-SGPDisplay the Primary and Secondary States of an SGP

Purpose: Syntax: Input Description: Output Description: Displays the primary and secondary states of one or all SS7 SGPs.
rtrv-sgp:sgp_name rtrv-sgp:all
Isgpe_nameMML name of a previously configured SGP. allRetrieves the primary state of all SGPs.
IP routeMML name of the specified IP route. PSTPrimary state; valid values are:
INBInstalled busy (resource is being created, its state has not been
determined yet).
ISIn service. OOSOut of service.

STBYThe local platform state is standby. CONFThe 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:
3-42
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-SIPDisplay Call IDs of SIP Calls
RTRV-SIPDisplay Call IDs of SIP Calls

Comments: This command is no longer supported. The command prov-callinfo replaces it.
RTRV-SOFTWRetrieve Software Status for a Process

Purpose: Syntax: Input Description: Output Description: Displays the status of one process or all processes.
rtrv-softw:<proc> rtrv-softw:all
procThe MML name of a process or process group. allDisplays the status of all processes. <PROCESS>Process name STATUS OF PROCESS
UNKNOWNState of the process is unknown. STOPPEDProcess is not running. INITProcess is being initialized. INIT CMPLInitialization has been completed. CUT WAITCutover has occurred, waiting. (This state is momentary and
unlikely to be seen.)
RUNNINGProcess is running. LOCKEDProcess is locked. CUT MASTERProcess is the master in a cutover situation. (This state is
momentary and unlikely to be seen.)

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

TERMProcess is terminating. RUNNING ACTIVEProcess is running on the active system. RUNNING STANDBYProcess is running on the standby system. RUNNING OOSProcess is running, but out of service. RUNNING IN N/A STATEProcess is running, but in a not available state.
3-43
Chapter 3 RTRV-SPCRetrieve Point Code
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:
RTRV-SPCRetrieve Point Code

Purpose: Displays the route set for one provisioning component point code or the route sets of all point codes.
rtrv-spc:<sigpath> rtrv-spc:all
sig pathThe MML component name of a provisioning component signal path. allDisplays information for all signal paths.
3-44
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-SP-CTRRetrieve SS7/C7 Signaling Point Measurements
Output Description:
SIG PATHThe MML component name of a provisioning component signal path. DPCDestination point code DNWNetwork indicator OPCOriginating point code <PST>Primary state; valid values are:
OOS by the SET-SPC command).

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:
RTRV-SP-CTRRetrieve 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.
rtrv-sp-ctr:<ss7 service> rtrv-sp-ctr:all
ss7 serviceThe MML component name of a single SS7 signal service. allDisplays measurements for all signal points.
Note
RTRV-CTR:<ss7 service>:<group> is a related command.
3-45
Chapter 3 RTRV-SS7-SLTRetrieve SS7 SLT Test Results
Output Description:
<COMP>Component. CATMeasurement category. For a list of measurement categories, see meascategories in the RTRV-CALLIMRetrieves the Call Limiting Function Status section on page 3-16. For descriptions of measurements, see Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. INTMeasurement interval. VALValue measured.
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:
RTRV-SS7-SLTRetrieve SS7 SLT Test Results

Purpose: Syntax: Input Description: Retrieves the results of a signal link test.
rtrv-ss7-slt:<C7 link>
c7 linkThe 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.
3-46
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-SS7-SRTRetrieve SS7 SRT Test Results
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:
RTRV-SS7-SRTRetrieve 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.
rtrv-ss7-srt:<ss7path>:LSET="<C7 link/set>"
ss7pathThe MML component name of an adjacent ss7path configured for Japanese SS7. C7 link/setThe MML provisioning component name of a linkset or C7 IP link or TDM link used in a linkset.
3-47
Chapter 3 RTRV-SS7-SRTRetrieve SS7 SRT Test Results
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:
3-48
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-TCRetrieve Bearer States
RTRV-TCRetrieve Bearer States

Purpose: Syntax: Adds a filter to the rtrv-tc command so that it can display available bearer states.
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:
allDisplays the bearer states for all signal paths. sigpathLogical 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.
callDisplays the status of the call: IDLE, IN, or OUT (call direction). pstDisplays the primary states such as AOOS. usedDisplays only the CICs for currently active calls. STATDisplays 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.
3-49
Chapter 3 RTRV-TCRetrieve Bearer States
Output Description:
<SIGPATH>MML component name of a signal path CICCircuit identification code PSTPrimary state; valid values are:
AOOSThe resource has been taken out of service by the system. INBInstalled busy (resource has been created but not yet commanded IS

CALLCall state; valid values are:

IDLECircuit is idle, available for use. OUTOut of service. INIn 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_STATState of the gateway; valid values are:
system.
system.
3-50
OL-1116-24
Chapter 3
BLKBlocking state; valid values are


LOCAUTOHardware blocking type; the circuit is blocked, by an external

UNBLK-CIC or the RESET-CIC command.

potential software problem. A circuit has become blocked but the software did not track the cause of the blocking.)
NONEThere is no block on the CIC. DS0 is available for use. REMAUTORemotely auto blocked. REMMANRemotely blocked manually. Note
All the BLK valid values, except for LOCMAN and NONE, are only applicable to SS7 sigpath. 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_STAThe call start time.
Note
3-51
Chapter 3 RTRV-TCRetrieve Bearer States
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" ;
3-52
OL-1116-24
Chapter 3
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"
3-53
Chapter 3 RTRV-TCAP-TRANSRetrieve TCAP Transactions
Comments:
Performance Impact Category: C; avoid issuing RTRV-TC:ALL for large configurations. This command supports wildcarding.
RTRV-TCAP-TRANSRetrieve TCAP Transactions

Purpose: Syntax: Output Description: Example: Displays the number of active TCAP transactions.
rtrv-tcap-trans
<TCAP name>The TCAP name. TRANSNumber of active transactions.
The MML command shown in the following example displays the number of active TCAP transactions:
mml> RTRV-TCAP-TRANS Media Gateway Controller M RTRV "TCAP-01:TRANS=0" ; - MGC-01 2000-01-12 15:19:51
Comments:
RTRV-TC-HELDRetrieve 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-TCRetrieve Bearer States section on page 3-49 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.
rtrv-tc-held:<sig path>&<sig path>... rtrv-tc-held:all
sig pathLogical 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. allDisplays the bearer states for all signal paths.
3-54
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-TC-HELDRetrieve States of Bearer Channels Held by Gateway
Output Description:
<POINT CODE>MML component name of a point code provisioning component CICCircuit identification code PSTPrimary state; valid values are:
AOOSThe system has taken the resource out of service. INBInstalled busy (resource has been created but not yet commanded IS

CALLCall state; valid values are:

IDLECircuit is idle, available for use. OOSOut of service. ISIn service.
GW_STATState of the gateway; valid values are:

system.
system.
BLKBlocking state; valid values are:


LOCAUTOHardware blocking type; the circuit is blocked by an external

UNBLK-CIC or RESET-CIC command.

potential software problem. A circuit has become blocked, but the software did not track the cause of the blocking.)
NONEThere is no block on the CIC. DS0 is available for use. REMAUTORemotely auto blocked. REMMANRemotely blocked manually.
3-55
Chapter 3 RTRV-THRESRetrieve Threshold Values
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 M RTRV dpc1 ; - MGC-01 2000-01-12 15:19:51
Comments:
This command accepts wildcarding.
RTRV-THRESRetrieve Threshold Values

Purpose: Syntax: Input Description: Retrieves threshold settings for measurement categories.
rtrv-thres::<meas cat>
meas catLogical identifier that selects the measurement category. For a list of measurement categories, see meascategories in the RTRV-CALLIMRetrieves the Call Limiting Function Status section on page 3-16. INTERVALTime interval. TYPEThreshold type. CLRTHRESThreshold at which alarm is cleared. ALMTHRESThreshold at which alarm is set. ALMAlarm category.
Output Description:
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:
3-56
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting RTRV-VIRT-TCRetrieve DPNSS Virtual Bearer Channel Status (Release 9.6(1) and 9.7(3))
RTRV-VIRT-TCRetrieve 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.
rtrv-virt-tc:dpnss-path
VTCThe virtual channel number. CALLThe status of the call: IDLE, IN, or OUT (call direction). PSTPrimary state; valid values are
AOOSThe resource has been taken out of service by the system. INBInstalled busy (resource has been created but not yet commanded IS

BLKBlocking state
NONEThere is no block on the CIC. DS0 is available for use.
TRANSNumber 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 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
3-57
Chapter 3 SET-ADMIN-STATESet Administrative State
SET-ADMIN-STATESet 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.
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
Syntax:
3-58
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting SET-ADMIN-STATESet Administrative State
Input Description:

mgcCorresponding MML name of the Cisco PGW 2200 Softswitch. gwayCorresponding MML name for the media gateway. Not all media gateway types are applicable. Supported types are CU, MUX, MGW, and AVM external nodes. trkgrpApplicable only for time-division multiplexing (TDM). Use the corresponding MML name for component type "0020". When specifying the trunk group number, enter the prefix tg-. Example: set-admin-state:tg-404:lock sigpathCorresponding MML name for any of the following component types:
Note
and sent to the Cisco PGW 2200 Softswitch.

over IP to the Cisco PGW 2200 Softswitch.

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.
spanA 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. bcA numeric value that identifies the non-ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC. cicA numeric value that identifies the ISUP CIC number. rngThe range of either bearer channel or CIC. lockBearer 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. unlockBearer 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. resetClears 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.
3-59
Chapter 3 SET-ADMIN-STATESet Administrative State
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
3-60
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting SET-ADMIN-STATESet Administrative State
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.
3-61
Chapter 3 SET-ASSOCIATIONChanging SCTP Association Primary State
SET-ASSOCIATIONChanging SCTP Association Primary State

Purpose: Syntax: Input Description: Changes the primary state of an SCTP association.
set-association:assoc_name:PST[,confirm]
assoc_nameMML name of a previously configured SCTP association. PSTDesired primary state; valid values are IS, OOS, or FOOS confirmVerify 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:
SET-C7LNKChange 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).
set-c7lnk:<c7 ip or tdm ss7 link>:is|oos|foos|unh|inh
c7 ip or tdm ss7 linkThis is the logical signal link, such as SS7 point code, FAS path, IP FAS path, or DPNSS path. isIn service oosOut of service foosForced out of service unhUninhibit SS7 link inhInhibit 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.
3-62
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting SET-CALLIMSets the Call Limiting Function
SET-CALLIMSets the Call Limiting Function

Purpose: Sets the MGCP Scripting Support on the PGW 2200 feature for the whole Cisco PGW 2200 Softswitch.
set-callim:lim_status
lim_statusSets the MGCP Scripting Support on the PGW 2200 function for the Cisco PGW 2200 Softswitch to enabled or disabled. enable | disableInstructs the Cisco PGW 2200 Softswitch to either enable or disable call limiting.
Output Description: Example:
Varies
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 "ENGG-01" ;
RTRV
Comments:
SET-DCHANChange the Service State of a D-Channel Link

Purpose: Syntax: Input Description: Changes the service state of a D-channel link to IS (in service) or OOS (out of service).
set-dchan:<fas link | d-channel>:is|oos
fas linkMML name of the fas link. isIn service. oosOut of service.
3-63
Chapter 3 SET-DESTSet the Service State of a Signal Path
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-DESTSet 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).
set-dest:<sig path>:IS|OOS
sig pathSignal path. This is the logical signaling destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path.

isIn service. oosOut 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.
3-64
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting SET-IPLNKChange the Service State of an IP Link
SET-IPLNKChange 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.
set-iplnk:<ip link>:is|oos|foos set-iplnk:<mgcp-ip link>:is|oos|foos:confirm set-iplnk:ip link:PST,<confirm>
Syntax:
Input Description:
Ip linkMML component name of a previously configured IP link. PSTDesired primary state:

ISIn service OOSOut of service FOOSForced out of service
Note
ConfirmEnter this parameter when the PST is changed to OOS or FOOS 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-IPROUTEChanging IP Route Primary State

Purpose: Syntax: Changes the primary and secondary states of an IP route.
set-iproute:ip_route_name:pst[,confirm]
3-65
Chapter 3 SET-LOGSet Logging Levels
Input Description:
IP_rout_nameMML name of a previously configured IP route. PSTDesired primary state; valid values are IS, OOS, or FOOS ConfirmMust 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:
SET-LOGSet Logging Levels

Purpose: Syntax: Input Description: Sets the logging level of a process or of all processes.
set-log:<proc>:<log level> set-log:all:<log level>,confirm
procThe various actively and passively monitored processes running on the Cisco PGW 2200 Softswitch. Use the RTRV-SOFTW:ALL command to display all processes. log levelSets the logging level for the specified process. Logging levels are as follows:
critCritical level messages. errError condition messages. warnWarning condition messages. infoInformational messages. traceTrace messages. debugDebug-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.
3-66
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting SET-LSSN-STATESet State of Local SSN
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-STATESet State of Local SSN

Purpose: Syntax: Input Description: Sets the state of a local SSN to IS or OOS.
set-lssn-state::<SSN>,IS|OOS
<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. ISIn service OOSOut 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.
3-67
Chapter 3 SET-SPCSet Signal Point Code State
SET-SPCSet Signal Point Code State

Purpose: Syntax: Input Description: Changes the service state of a signal point code to IS or OOS.
set-spc:<point code>:IS|OOS...
point codeSignal point code. ISIn service OOSOut 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 M COMPLD "stp1" ; - MGC-01 2000-01-12 15:19:51
Comments:
SET-THRESSet 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.
SET-THRES::CAT=<Meas Cat>, INTERVAL=<SECONDS>,THRES=<VALUE>
catLogical identifier that specifies the measurement category. For a list of measurement categories, use the prov-rtrv MML command. intervalMeasurement interval. thresThreshold 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:
3-68
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting SNDSend Message to External Process
SNDSend Message to External Process

Comments: This command is no longer supported.
STA-ABN-TRCStart Abnormal Trace

Purpose: Prints the state machine global variable of a particular call, as well as external event information, to a file.
sta-abn-trc:<sigpath|all>[,log=<xyz>][,prd=n],confirm

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

and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP->Cisco PGW 2200 Softswitch)
allIndicates 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. logThe 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. prdThe 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. confirmIf 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" ;
3-69
Chapter 3 STA-AUDStart Auditing Process
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-AUDStart Auditing Process

Purpose: Starts the auditing process on all calls. The auditing process stops automatically when it is completed.
sta-aud
Syntax: Example:
The MML command shown in the following example starts the auditing process on all calls:
mml> STA-AUD Media Gateway Controller M RTRV "ENGG-01" ; - MGC-01 2000-01-12 15:19:51
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-CICStart CIC State Auditing Process

Purpose: Syntax: Input Description: Start a CIC audit.
sta-aud-cic
staStart audAudit cicCircuit
3-70
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting STA-AUD-GWStart Auditing of MGCP Gateway
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-GWStart 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). This command works only on gateways that support the Simple Resource Coordination Protocol (SRCP).
Note
sta-aud-gw:<sig path MGCP> sta-aud-gw:all
sig path MGCPMGCP signal path created with the PROV-ADD MGC command. allAll 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 M COMPLD ; - MGC-01 2000-01-12 15:19:51
Comments:
STA-AUD-H248Start Audit of H.248 Gateway (Release 9.7(3))

Purpose: Syntax: Starts an audit of an H.248 gateway.
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"
3-71
Chapter 3 STA-DNS-INFOStart Retrieve Process of DNS Cache
Input Description:
cntxIdFor sta-aud-h248:terms:sigpath can be ALL or a specified context ID. Use 0 to specify NULL context ID. cntxIdFor sta-aud-h248:cntxs:sigpath can be specified context ID. ALL context ID or 0 context ID is not allowed. termIdCan 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-INFOStart Retrieve Process of DNS Cache

Purpose: Starts the retrieve process of DNS cache information. The information is retrieved with the RTRV-DNS-INFO command.
sta-dns-info:<sig path sip>:<param>
Syntax: Input Description: Example:
sig path sipMML name of SIP signal path paramURL | cache entry number | null string
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:
STA-DNS-PURGEStart Purge of DNS Cache

Purpose: Syntax: Input Description: Starts the purge of a DNS cache.
sta-dns-purge:<sig path sip>
sig path SIPMML name of the SIP signal path.
3-72
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting STA-SC-TRCStart Trace
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-TRCStart 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=callingparty number][,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
3-73
Chapter 3 STA-SC-TRCStart Trace
Input Description:
sigpathLogical signal destination, such as SS7 point code, FAS path, IP FAS path, or DPNSS path. spanSpan 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. rngRange. 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. tcTraffic channel of interest in integer (range is 0 to 65535) form. It is used with rng, span, and sigpath. anumberOriginal/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. bnumberOriginal/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. causevalueThe internal cause value. Range is 1 to 300. incompleteoverlapnumberIncomplete-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. durationCall 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. mclMCL. 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. autostopStop 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. prdTrace period in seconds. Range is 0 to 2147483. Default value is 1800. Stops the trace when the call trace running time reaches this value. confirmIf 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. trunkgroupLogical trunk group of interest. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information. When specifying the trunk group number, enter the prefix tg-. Example: sta-sc-trc:tg-404:log="test"prd=60,confirm
Note
3-74
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting STA-SC-TRCStart Trace
logLogfile 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.
trkTrunk 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
3-75
Chapter 3 STA-SS7-SLTStart MTP SLT Test on a Link
Error Code:
COMPLDPath has started tracing. SNVSError 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-SLTStart MTP SLT Test on a Link

Purpose: Syntax: Input Description: Example: Starts an MTP signal link test on a link.
sta-ss7-slt:<c7 link>
c7 linkThe MML component name of a signal channel (linkset, C7 IP link, or TDM link used in a linkset).
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-SRTStart MTP SRT Test on an SS7PATH

Purpose: Syntax: Input Description: Starts an MTP signal route test on an ss7path configured for Japanese SS7.
sta-ss7-srt:<ss7path>:lset="<c7 linkset>"
ss7pathThe MML component name of an ss7path. c7 linksetThe provisioning component C7 link, TDM link used in a linkset, or linkset.
3-76
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting STA-TCAP-TRCStart TCAP Tracing
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-TRCStart TCAP Tracing

Purpose: Syntax: Example: Starts TCAP tracing.
STA-TCAP-TRC
The MML command shown in the following example starts TCAP tracing:
mml> STA-TCAP-TRC Media Gateway Controller M RTRV "TCAP-01" ; - MGC-01 2000-01-12 15:19:51
Comments:
STP-ABN-TRCStop Abnormal Trace

Purpose: Syntax: Stops abnormal calls tracing initiated by the STA-ABN-TRC command.
stp-abn-trc:<sigpath|all>
3-77
Chapter 3 STP-AUDStop Auditing Process
Input Description:

media and sent to Cisco PGW 2200 Softswitch


and sent to the Cisco MGC over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP->MGC)

allIndicates 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-AUDStop Auditing Process

Purpose: Syntax: Example: Stops the auditing process started with the STA-AUD command.
STP-AUD
The MML command shown in the following example stops all auditing processes started with the STA-AUD command:
mml> STP-AUD Media Gateway Controller M RTRV "ENGG-01" ;
- MGC-01 2000-01-12 15:19:51
Comments:
3-78
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting STP-CALLStop Calls
STP-CALLStop 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.
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
Syntax:
Input Description:

mgcCorresponding MML name of the Cisco PGW 2200 Softswitch. gwayCorresponding MML name for the media gateway. Not all media gateway types are applicable. Supported types are CU, MUX, MGW, and AVM external nodes. trkgrpApplicable 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

media and sent to the Cisco PGW 2200 Softswitch


and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE box<-sig/tdm->NAS<-NI2/IP-> MGC)
spanspanId is a 16-bit value that identifies an ISDN/PRI physical cable. bcNumeric value that identifies the non-ISUP bearer channel number. BC is used for non-ISUP trunks; otherwise use CIC. cicNumeric value that identifies the ISUP circuit identification code number. rngRange of either the bearer channel or the CIC.
3-79
Chapter 3 STP-SC-TRCStop One or All Traces
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:
STP-SC-TRCStop One or All Traces

Purpose: Syntax: Stops a protocol conversion trace session on one signal path or on all signal paths.
stp-sc-trc:<sig path> stp-sc-trc:<trkgrp> stp-sc-trc:all
Input Description:
sig pathLogical identifier for a signal path. trkgrpLogical identifier for a trunk group. When specifying the trunk group number, enter the prefix tg-. Example: stp-sc-trc:tg-404
allStops 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:
STP-TCAP-TRCStop TCAP Tracing

Purpose: Stops TCAP tracing that has been started with the STA-TCAP-TRC command.
3-80
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting SW-OVERManual Switchover
Syntax: Example:
stp-tcap-trc
The MML command shown in the following example stops TCAP tracing:
mml> STP-TCAP-TRC Media Gateway Controller M RTRV "TCAP-01" ;
- MGC-01 2000-01-12 15:19:51
SW-OVERManual Switchover
Purpose: Enables a switchover from an active to a standby system. You cannot use the sw-over command when the provisioning is new.
sw-over::confirm
Syntax: 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 M COMPLD ;
- MGC-01 2000-01-12 15:19:51
Comments:
Performance Impact Category: D. Established calls are retained on forced switchover, and calls that are currently being set up may be dropped.
TST-COTManual COT
Purpose: Syntax: Input Description: Executes a continuity test on a specified remote switch circuit.
tst-cot:<sigpath>:CIC=<number>
sigpathMML component name of a provisioning component signal path. cic=numberA numeric value that identifies the ISUP circuit identification code number.
3-81
Chapter 3 UNBLK-CICUnblock a Circuit or a Circuit Range
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-CICUnblock a Circuit or a Circuit Range

Purpose: Unblocks a circuit or a range of circuits that have been blocked with the BLK-CIC command.
unblk-cic:<sigpath>:cic=<number>[,rng=<range>]
sigpathMML component name of a provisioning component signal path. numberA valid circuit identification code (CIC). rangeA 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:
VLD-CICValidate 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>
3-82
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting VLD-CICValidate a Circuit
Input Description: Example:
sigpathMML component name of a signal path associated with the CIC. numberA valid circuit identification code.
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:
3-83
Chapter 3 VLD-CICValidate a Circuit
Output Description:
LOC: Values associated with the Cisco PGW 2200 Softswitch. REM: Values associated with the destination exchange. Valid values for these fields are:
GRPCircuit group carrier indicator. The values in these fields should be the same in the LOC and REM lines. Valid values are:
UNKUnknown circuit group carrier type ANLAnalog circuit group carrier type DIGDigital circuit group carrier type ANDAnalog and digital circuit group carrier type
SEIZDouble 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:
NONENo 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.

ODDOdd circuit control. When one line is set to ODD, the other should be
set to EVEN.
ALMAlarm carrier indicator. The values in these fields should be the same in the LOC and REM lines. Valid values for this field are:
UNKUnknown alarm carrier SOFTSoftware alarm carrier HARDHardware alarm carrier
COTContinuity check requirements indicator. The values in these fields should be the same in the LOC and REM lines. Valid values are:
UNKUnknown continuity check requirements NONENo continuity check requirements STATStatistical continuity check requirements PERCPer call continuity check requirements
3-84
OL-1116-24
Chapter 3
Commands for Operations, Maintenance, and Troubleshooting VLD-CICValidate a Circuit
TRKTrunk 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_CLLICommon 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_CLLICLLI 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.
3-85
Chapter 3 VLD-CICValidate a Circuit
3-86
OL-1116-24

Commands For Operations, Maintenance, and Troubleshooting: ACK-ALM-Acknowledge Alarm

Încărcat de

Informații document

Descriere originală:

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Commands For Operations, Maintenance, and Troubleshooting: ACK-ALM-Acknowledge Alarm

Încărcat de

Drepturi de autor:

Formate disponibile

CH A P T E R

Commands for Operations, Maintenance, and Troubleshooting

Cisco PGW 2200 Softswitch Release 9 MML Command Reference OL-1116-24

Chapter 3 BLK-CICBlock a Circuit or a Circuit Range

Commands for Operations, Maintenance, and Troubleshooting

BLK-CICBlock a Circuit or a Circuit Range

Cisco PGW 2200 Softswitch Release 9 MML Command Reference

Commands for Operations, Maintenance, and Troubleshooting CLR-MEASReset a Measurement Category

CLR-MEASReset a Measurement Category

CLR-TCAP-TRANSClear TCAP Transactions

Syntax: Input Description:

Cisco PGW 2200 Softswitch Release 9 MML Command Reference OL-1116-24

Chapter 3 DIAGLOGDiagnostics Log

Commands for Operations, Maintenance, and Troubleshooting

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

Cisco PGW 2200 Softswitch Release 9 MML Command Reference

Commands for Operations, Maintenance, and Troubleshooting PRT-CALLPrint Call

Cisco PGW 2200 Softswitch Release 9 MML Command Reference OL-1116-24

Chapter 3 PRT-CALLPrint Call

Commands for Operations, Maintenance, and Troubleshooting

sigpathCorresponding MML name for any of the following component types:

and sent to Cisco PGW 2200 Softswitch

over IP to the Cisco PGW 2200 Softswitch

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

Cisco PGW 2200 Softswitch Release 9 MML Command Reference

Commands for Operations, Maintenance, and Troubleshooting QUERY-CICExecute Circuit Query

Performance Impact Category: C This command allows wildcards on signal paths.

QUERY-CICExecute Circuit Query

Syntax: Input Description:

Cisco PGW 2200 Softswitch Release 9 MML Command Reference OL-1116-24

Chapter 3 RESET-CICReset a Circuit or a Circuit Range

Commands for Operations, Maintenance, and Troubleshooting

CICCircuit identification code. LPSTPrimary state.

LSSTLocal secondary state.

RESET-CICReset a Circuit or a Circuit Range

Cisco PGW 2200 Softswitch Release 9 MML Command Reference

Commands for Operations, Maintenance, and Troubleshooting RTRV-ADMIN-STATERetrieve Administrative State

Performance Impact Category: B

RTRV-ADMIN-STATERetrieve Administrative State

Inferred target state:

state is shut down.

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]

Cisco PGW 2200 Softswitch Release 9 MML Command Reference OL-1116-24

Chapter 3 RTRV-ADMIN-STATERetrieve Administrative State

Commands for Operations, Maintenance, and Troubleshooting

Target parameters are as follows:

sigpathCorresponding MML name for any of the following component types:

and sent to the Cisco PGW 2200 Softswitch

over IP to the Cisco PGW 2200 Softswitch

Cisco PGW 2200 Softswitch Release 9 MML Command Reference

Commands for Operations, Maintenance, and Troubleshooting RTRV-ALMSRetrieve Active Alarms

Performance Impact Category: C This command allows wildcarding.

RTRV-ALMSRetrieve Active Alarms

contTells the system to display alarm events until Ctrl-C is pressed.

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

Cisco PGW 2200 Softswitch Release 9 MML Command Reference OL-1116-24

Chapter 3 RTRV-ALMSRetrieve Active Alarms

Commands for Operations, Maintenance, and Troubleshooting

Cisco PGW 2200 Softswitch Release 9 MML Command Reference

Performance Impact Category: A

RTRV-ASSOCIATIONDisplay State of SCTP Association

Assoc_nameMML name of a previously configured SCTP association. AllAll associations