MML Commands

Man Machine Language (MML) enables you to configure and manage your telephony controller. You use MML to retrieve and manage alarms, measurements, and logs. You can also use MML to troubleshoot your system. The MML commands help you obtain detailed measurement information about network elements such as your signaling links, signaling paths, and signaling channels. You can set up the logging levels for all of your active processes. These logging levels tell the telephony controller at what level of severity it should begin making log entries for capturing information about the alarms being generated by the processes.

You also use MML to load configuration data in your telephony controller after you have made changes using the configuration tool or a text editor. You can also use MML to change the service state of your network elements. For example, you can reset links or take them out of service.

Multiple users can use MML simultaneously. The structure of MML is based on the Bellcore TL1 standard. Therefore, MML commands can be interpreted and monitored through the TL1 interfaces in your network.

This appendix describes how to start using MML, how to interpret MML displays and messages, and how to use the MML commands.

B.2 Getting Started with MML

B.2.1 Starting MML

To use MML, you must be a member of the transpath group and you must have the correct UNIX shell environment variables. See the "Setting Up the Transpath Group and Users" section for instructions on setting up the transpath group; see the "Setting Up Your UNIX Shell Environment Variables" section for instructions on setting up your UNIX shell environment variables.

Note When MML is started, it looks in the /etc/group file to see if the user is in the transpath group. If the new username was not added to the transpath group in the /etc/group file, that user will have "monitor" access and will not be able to use certain MML commands. If the user is in the transpath group, the user will have "monitor and control access" and will have full MML access.

To start an MML session, perform the following steps:

Step 1 Log in to the signaling node and change to any subdirectory under /opt/TransPath (for example, /opt/Transpath/bin).

Step 2 Enter the following command:

mml

If you receive an error message that sessions are already in use, enter the following command:

mml -s < session number>

Use any number from 2 to 12 and repeat until you find a vacant session. After successfully entering MML, the prompt changes to:

mml>

To determine if other sessions are in use before entering MML, enter:

ls /opt/TransPath/var

If other sessions are in use, you will see a list of files similar to the following:

mml_input<1>LOCK
mml_input<2>LOCK
mml_input<3>LOCK

If other users are running MML sessions, choose a number that does not appear as locked for your session. In the previous example, you would enter mml -s 4 (or any other unlocked number) to start another MML session.

The UNIX prompt changes to mml>.

The following example shows starting an MML session.

UNIX (r) SYSTEM V Release 4.0 (ms-scl)
Login: scuser
Password:
Last login: Wed Oct 14 16:23:45from 171.70.249.252
Sun Microsystems Inc. SunOS 5.5.1 Generic May 1996
ms-sc1% cd /opt/TransPath/etc
ms-sc1% mml
(c) Copyright 1997, LightSpeed International, Inc.  USA, All Rights Reserved
This software is an unpublished Confidential Work of LightSpeed
International, Inc.,and the copyright statement hereon does not constitute
publication for the general public. This software is LightSpeed Licensed
Proprietary Information and possession and use of this software is
authorized only in compliance with an End User License Agreement.
mml>

Figure B-1 shows how to start an MML session.

Figure B-1: START MML - Starting an MML Session

B.2.2 Quitting MML

To quit an MML session, enter the following:

mml> QUIT

Figure B-2 shows how to stop an MML session.

Figure B-2: STOP MML - Stopping an MML Session

B.2.3 Getting Help in MML

MML is delivered with an online help feature. This command displays a list of valid system commands and an explanation of their use. To display the online help, start an MML session and enter the following command:

HELP

The system displays the MML command list.

B.2.4 MML Command Syntax

The MML command syntax is command:target:attribute. For example, in the following MML command:

SET-SC-STATE:T-2-6:IS

the command (SET-SC-STATE) sets the signaling channel service state for the target (signaling channel T-2-6) to an in-service state (IS). In the following MML command:

SET-SC-STATE:T-2-6:OOS

you are setting the same target (signaling channel T-2-6) to an out-of-service state.

Note MML is not case sensitive; commands can be entered in either upper or lower case.

TimeSaver MML allows you to repeat previously entered commands. In an MML session, enter R to repeat the last command. Enter R::number to repeat the commands specified by the number. For example, if you entered R::5, the system would repeat the last 5 MML commands.

B.3 Understanding MML Displays and Messages

While you are using MML, you may request information, view responses to commands you have entered, and receive automatically-generated status messages. The following subsections describe the service states reported in messages, typical command response messages, and the format of automatically-generated messages.

B.3.1 Telephony Controller Service States

Many MML commands display status reports that list the state of one or more of the components within or attached to the telephony controller. The component states adhere to the operations flows and state conditions defined in the Generic Service State (GSS) model. Figure B-3 shows the GSS model.

Figure B-3: Generic Service State Model

B.3.1.1 Service State Definitions

Service state definitions are partitioned into two levels: primary and secondary. The primary service state defines the availability of a resource within the telephony controller. The secondary service state gives an indication of why the resource is in the primary state. Multiple secondary states may exist in a resource. For example, a C7 link may be in an out-of-service (OOS) state because of Local Inhibit and Supporting Entity Failure. When the Supporting Entity Failure clears, the link must stay in the OOS state because it is inhibited. For each state, the MML symbol is enclosed in parenthesis.

Table B-1 through Table B-3 explain in further detail the states and transitions shown in the service state model.

B.3.1.2 Primary States

Table B-1: Primary Service States
Service State Description

Undefined

Entity does not exist in the network element (NE) configuration. This is the start state of all entities.

Install Busy (INB)

Entity has just been created but has not been commanded in-service or out-of-service.

In-Service (IS)

Entity is fully operational and capable of providing service to a requesting entity. For example, a C7 link can provide service to the conversion engine.

Out-of-Service (OOS)

Entity is not providing service to a requesting entity. There may be multiple reasons for the entity to be in the OOS state.

Table B-1 lists the 4 primary service states.

Table B-1: **Primary Service States**
Service State	Description
Undefined	Entity does not exist in the network element (NE) configuration. This is the start state of all entities.
Install Busy (INB)	Entity has just been created but has not been commanded in-service or out-of-service.
In-Service (IS)	Entity is fully operational and capable of providing service to a requesting entity. For example, a C7 link can provide service to the conversion engine.
Out-of-Service (OOS)	Entity is not providing service to a requesting entity. There may be multiple reasons for the entity to be in the OOS state.

B.3.1.3 Secondary States

Table B-2: Secondary Service States
Service State Description

Commanded OOS (COOS)

A resource is OOS because you entered the OOS command.

Configuration Failure (CONF)

A resource is OOS because its provisioning information is inconsistent.

Local Inhibit (LINH)

This applies to an SS7 link only. It is not providing service because it is locally inhibited.

Remote Inhibit (RINH)

This applies to an SS7 link only. It is not providing service because it is remotely inhibited.

OOS Pending (OOSPEND)

This is available for IS only. It means the entity is waiting for existing calls to clear before going OOS. No new calls will be accepted.

Supporting Entity Failure (SUPPENT)

This means that the entity has failed because a supporting entity has failed. For example, a signal channel state is OOS:SUPPENT because its line or card has failed.

Table B-2 lists the 6 secondary service states.

**Table B-2: Secondary Service States**
Service State	Description
Commanded OOS (COOS)	A resource is OOS because you entered the OOS command.
Configuration Failure (CONF)	A resource is OOS because its provisioning information is inconsistent.
Local Inhibit (LINH)	This applies to an SS7 link only. It is not providing service because it is locally inhibited.
Remote Inhibit (RINH)	This applies to an SS7 link only. It is not providing service because it is remotely inhibited.
OOS Pending (OOSPEND)	This is available for IS only. It means the entity is waiting for existing calls to clear before going OOS. No new calls will be accepted.
Supporting Entity Failure (SUPPENT)	This means that the entity has failed because a supporting entity has failed. For example, a signal channel state is OOS:SUPPENT because its line or card has failed.

B.3.1.4 Transition Event Definitions

Table B-3: Transition Event Definitions
Event Definition

Create

The entity has just been created in the network element (NE) database because of one of the following reasons:

Default creation (for example, network element object must always exist).

Entity presence is automatically recognized (for example, physical card exists in system).

Explicit management command (for example, MML command to create entity).

Note Use the configuration tool command to create new components..

Delete

The entity has just been deleted from the NE database. All subsequent operations to this entity will be rejected.
Note Use the configuration tool command to delete components. This transition is performed only if the entity was in the OOS state with a secondary state of Commanded OOS.

Cause IS

Transition towards the IS state will occur when all causes for the OOS state have been resolved.

Cause OOS

Transition to the OOS state has occurred for one of many reasons. Some causes are specific to a type of entity such as:

Configuration failure

Supporting entity failure

Supporting entity commanded OOS

Commanded OOS

Failure

Local inhibit (C7 signal links only)

Remote inhibit (C7 signal links only)

Congestion (C7 signal link only)

Cause IS = Commanded IS---User has requested that the entity be taken in-service

Cause OOS = Commanded OOS---User has requested the entity be taken out-of-service

Table B-3 lists the transition events and definitions.

**Table B-3: Transition Event Definitions**
Event	Definition
Create	The entity has just been created in the network element (NE) database because of one of the following reasons: Default creation (for example, network element object must always exist). Entity presence is automatically recognized (for example, physical card exists in system). Explicit management command (for example, MML command to create entity). Note Use the configuration tool command to create new components..
Delete	The entity has just been deleted from the NE database. All subsequent operations to this entity will be rejected. Note Use the configuration tool command to delete components. This transition is performed only if the entity was in the OOS state with a secondary state of Commanded OOS.
Cause IS	Transition towards the IS state will occur when all causes for the OOS state have been resolved.
Cause OOS	Transition to the OOS state has occurred for one of many reasons. Some causes are specific to a type of entity such as: Configuration failure Supporting entity failure Supporting entity commanded OOS Commanded OOS Failure Local inhibit (C7 signal links only) Remote inhibit (C7 signal links only) Congestion (C7 signal link only) Cause IS = Commanded IS---User has requested that the entity be taken in-service Cause OOS = Commanded OOS---User has requested the entity be taken out-of-service

B.3.2 MML Status Messages and Error Codes

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

Status	Meaning	Definition
COMPLD	Completed	The operation was completed successfully.
RTRV	Retrieve	Retrieve and display the contents of the specified file.
SUCC	Successful	Successful completion.
SWDC	Waiting for Dependency	Status message---Waiting for dependent processes to start.
SWDT	Waiting for Dependency	Status message---Waiting for dependent processes to stop. This is not an error. Enter the RTRV-SOFTW command to see when all desired processes have stopped.

Table B-4: MML Status Messages

Status Meaning Definition

COMPLD

Completed

The operation was completed successfully.

RTRV

Retrieve

Retrieve and display the contents of the specified file.

SUCC

Successful

Successful completion.

SWDC

Waiting for Dependency

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

SWDT

Waiting for Dependency

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

Sometimes when an MML command is entered into the system, it may not work as expected. The system then returns an error code. Table B-5 lists the MML error codes and descriptions.

Error Code	Meaning	Definition
DENY	Command denied.	Denied due to invalid command, unrecognized command, unknown parameters, or invalid target.
ICNV	Command not valid	The MML command was not recognized.
IDNV	Input data not valid	An unknown parameter has been entered.
IISP	Input syntax error	Syntax Error---An incorrect syntax was used.
IITA	Invalid target	The requested operation cannot be performed on the network element component or the component does not exist in the system.
IPRAM	Input parameter missing	The expected parameter cannot be found.
SABT	Status abort	Status abort; the command did not complete in allocated time.
SNVS	State not in valid state	The requested operation failed because the component is not configured to accept the operation. It is possible the component is already performing the operation or already in the desired state.
SNSP	State not supported	This operation is not supported by the component.

Table B-5: MML Error Code Descriptions

Error Code Meaning Definition

DENY

Command denied.

Denied due to invalid command, unrecognized command, unknown parameters, or invalid target.

ICNV

Command not valid

The MML command was not recognized.

IDNV

Input data not valid

An unknown parameter has been entered.

IISP

Input syntax error

Syntax Error---An incorrect syntax was used.

IITA

Invalid target

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

IPRAM

Input parameter missing

The expected parameter cannot be found.

SABT

Status abort

Status abort; the command did not complete in allocated time.

SNVS

State not in valid state

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

SNSP

State not supported

This operation is not supported by the component.

B.3.3 Automatically-Generated Status Messages

Automatically-generated messages, which are also called autonomous messages, are messages that MML displays when you are using MML. These messages can be alarm reports of internal failures or informational reports indicating an atypical event. These messages follow the Bellcore TL1 autonomous message format.

^^^systemId YY-MM-DD hh-mm-ss
severity^almCat
^^^"comp:params"
^^^/* comment */
;

Table B-6 defines each of the display components. To learn more about an alarm, you can use an MML command to retrieve additional information. You can retrieve the status of all alarms, or you can use the information in the display to request only the information for a specific alarm.

Table B-6: Autonomous Message Component Descriptions
Autonomous Message Element Description

systemId

Telephony controller system identification.

YY-MM-DD

Year, month, day of event.

hh-mm-ss

Hour, minute, second of event.

severity

Severity of event. This is a two character indicator with the following meanings:

*C Critical alarm

** Major alarm

*^ Minor alarm

A^ Informational message

almCat

Alarm category (type of event being reported).

comp

Component ID on which the event is being reported.

params

Supplemental parameters used to further clarify alarm.

comment

Supplemental comment used to indicate cause or appropriate action.

**Table B-6: Autonomous Message Component Descriptions**
Autonomous Message Element	Description
systemId	Telephony controller system identification.
YY-MM-DD	Year, month, day of event.
hh-mm-ss	Hour, minute, second of event.
severity	Severity of event. This is a two character indicator with the following meanings: `C` Critical alarm `` Major alarm `^` Minor alarm `A^` Informational message
almCat	Alarm category (type of event being reported).
comp	Component ID on which the event is being reported.
params	Supplemental parameters used to further clarify alarm.
comment	Supplemental comment used to indicate cause or appropriate action.

B.4 MML Commands

Table B-7 through Table B-18 show lists of MML commands and descriptions, organized by subject. These tables also include the page number of the MML command example, if one is provided in this appendix.

The MML commands are organized as follows:

General MML Commands
MML Call Processing Commands
- General
- ASP
- Block
- Link
MML Maintenance Commands
- General
- Configuration
- Logging
- Measurement
- Processing
- Trace
MML Alarm Commands

Command	Description	Example
H::number[,number]	Displays history of commands for a specified backward number or range; the last command by default.	-
HELP	Displays a list of MML commands.	B-17
QUIT	Ends the session.	-
R::number	Repeats a previously entered command with a specified backward number; the last command by default.	-
RTRV-MML	Displays all active MML sessions.	-

Command	Description	Example
RTRV-CIC:pointCode: CIC=number[,RNG=slaves]	Retrieves bearer channels of a point code.	-
RTRV-DEST:all RTRV-DEST:pointCode RTRV-DEST:sigPath	Retrieves the destination of all components or a single point code or signaling path.	B-19
RTRV-LSET:C7linkSet	Displays state of a C7 link set.	B-20
RTRV-OVLD	Displays overload level and number of messages in a queue.	-
RTRV-RTE:pointCode	Retrieves all route sets of a point code.	-
RTRV-SC:all RTRV-SC:sigChannel RTRV-SC:C7linkSet	Displays attributes of all signaling channels and link sets or a single signaling channel or link set.	B-21
RTRV-SPC:all RTRV-SPC:pointCode	Retrieves route set of all point codes or a single point code.	B-22
RTRV-TC:all RTRV-TC:sigPath[&sigPath]	Displays state of all bearers or bearers per signaling path(s).	-
STP-CALL:sigChannel pointCode [:TC=number]	Stops calls in progress for a specified signaling channel or destination point code. Note By default, all traffic channels are affected.	-

Command	Description	Example
RTRV-ASN:auxSigPath	Displays attributes of an auxiliary signal path (ASP).	-
SET-ASN-STATE:auxSigPath:state	Changes service state of an ASP to either in-service (IS) or out-of-service (OOS).	-

Table B-7:

Command Description Example

H::number[,number]
Displays history of commands for a specified backward number or range; the last command by default.

-

HELP
Displays a list of MML commands.

B-17

QUIT
Ends the session.

-

R::number
Repeats a previously entered command with a specified backward number; the last command by default.

-

RTRV-MML
Displays all active MML sessions.

-

General MML Commands
Table B-8:

Command Description Example

RTRV-CIC:pointCode: CIC=number[,RNG=slaves]
Retrieves bearer channels of a point code.

-

RTRV-DEST:all RTRV-DEST:pointCode RTRV-DEST:sigPath
Retrieves the destination of all components or a single point code or signaling path.

B-19

RTRV-LSET:C7linkSet
Displays state of a C7 link set.

B-20

RTRV-OVLD
Displays overload level and number of messages in a queue.

-

RTRV-RTE:pointCode
Retrieves all route sets of a point code.

-

RTRV-SC:all RTRV-SC:sigChannel
RTRV-SC:C7linkSet
Displays attributes of all signaling channels and link sets or a single signaling channel or link set.

B-21

RTRV-SPC:all RTRV-SPC:pointCode
Retrieves route set of all point codes or a single point code.

B-22

RTRV-TC:all RTRV-TC:sigPath[&sigPath]
Displays state of all bearers or bearers per signaling path(s).

-

STP-CALL:sigChannel pointCode
[:TC=number]
Stops calls in progress for a specified signaling channel or destination point code.
Note By default, all traffic channels are affected.
-

MML Call Processing---General Commands
Table B-9:

Command Description Example

RTRV-ASN:auxSigPath
Displays attributes of an auxiliary signal path (ASP).

-

SET-ASN-STATE:auxSigPath:state
Changes service state of an ASP to either in-service (IS) or out-of-service (OOS).

-

MML Call Processing---ASP Commands

Table B-10: MML Call Processing---Block Commands
Command Description Example

BLK-CIC:pointCode:CIC=start
[,RNG=range]
Blocks a circuit or a range of circuits from carrying calls.

B-13

UNBLK-CIC:pointCode: CIC=start[,RNG=range]
Unblocks a circuit or circuit range.

B-26

RESET-CIC:pointCode:CIC=start
[,RNG=range]
Resets a circuit or a circuit range.

-

**Table B-10: MML Call Processing---Block Commands**
Command	Description	Example
BLK-CIC:pointCode:CIC=start [,RNG=range]	Blocks a circuit or a range of circuits from carrying calls.	B-13
UNBLK-CIC:pointCode: CIC=start[,RNG=range]	Unblocks a circuit or circuit range.	B-26
RESET-CIC:pointCode:CIC=start [,RNG=range]	Resets a circuit or a circuit range.	-

Table B-11: MML Call Processing---Link Commands
Command Description Example

SET_EQPT_STATE:IOcard:state
Changes service state of an I/O card to either in-service (IS) or out-of-service (OOS).

B-23

SET-LNK-STATE:C7link/set:state
Changes state of a C7 link or a link set to:

IS---In-service

OOS---Out-of-service

INH---Inhibited

UNH---Uninhibited

B-23

SET-SC-STATE:sigPath:state SET-SC-STATE:line:state
Changes service state of a single signal path or all signal paths/links on an entire link set to:

IS---In-service

OOS---Out-of-service

FOOS---Forced Out-of-service

INH---Inhibited

UNH---Uninhibited

B-24

**Table B-11: MML Call Processing---Link Commands**
Command	Description	Example
SET_EQPT_STATE:IOcard:state	Changes service state of an I/O card to either in-service (IS) or out-of-service (OOS).	B-23
SET-LNK-STATE:C7link/set:state	Changes state of a C7 link or a link set to: IS---In-service OOS---Out-of-service INH---Inhibited UNH---Uninhibited	B-23
SET-SC-STATE:sigPath:state SET-SC-STATE:line:state	Changes service state of a single signal path or all signal paths/links on an entire link set to: IS---In-service OOS---Out-of-service FOOS---Forced Out-of-service INH---Inhibited UNH---Uninhibited	B-24

Table B-12: MML Maintenance---General Commands
Command Description Example

RTRV-EQPT:IOcard
Retrieves service state of an I/O card.

RTRV-LNK-CTR:all RTRV-LNK-CTR:C7link/set
Retrieves all measurements of all links or a single C7 link or link set.

B-20

RTRV-NE
Displays attributes of the network element.

B-21

RTRV-SOFTW:all RTRV-SOFTW:proc
Displays status of all processes or a single process or process group.

B-22

RTRV-SP-CTR:all RTRV-SP-CTR:pointCode
Retrieves all measurements of a all point codes or a single point code.

B-22

**Table B-12: MML Maintenance---General Commands**
Command	Description	Example
RTRV-EQPT:IOcard	Retrieves service state of an I/O card.
RTRV-LNK-CTR:all RTRV-LNK-CTR:C7link/set	Retrieves all measurements of all links or a single C7 link or link set.	B-20
RTRV-NE	Displays attributes of the network element.	B-21
RTRV-SOFTW:all RTRV-SOFTW:proc	Displays status of all processes or a single process or process group.	B-22
RTRV-SP-CTR:all RTRV-SP-CTR:pointCode	Retrieves all measurements of a all point codes or a single point code.	B-22

Table B-13: MML Maintenance---Configuration Commands
Command Description Example

CHG-CFG:cfgTable&cfgTable
Reloads the tables listed in RTRV-CFG-TABLES.

B-14

CHG-DPL:VNETID
Reloads a dialing plan.

B-15

CHG-LOG:all:logLevel CHG-LOG:proc:logLevel
Sets logging level of an active process or all active processes to:

DBG = Debug-level messages (lowest level)

INF = Informational messages

NOT = Notify message

WRN = Warning conditions

ERR = Error conditions

CRT = Critical conditions

ALR = System is unusable

EMR = Emergency level (highest level)

Monitored and passive processes are not affected.

B-15

CLR-MEAS:comp:\"measCat\"
Resets a measurement category on a component.

B-16

RTRV-CFG:cfgTable
Display contents of a configuration table where table can be:

alarmCategories

components

componentTypes

measCategories

services

tables

-

**Table B-13: MML Maintenance---Configuration Commands**
Command	Description	Example
CHG-CFG:cfgTable&cfgTable	Reloads the tables listed in RTRV-CFG-TABLES.	B-14
CHG-DPL:VNETID	Reloads a dialing plan.	B-15
CHG-LOG:all:logLevel CHG-LOG:proc:logLevel	Sets logging level of an active process or all active processes to: DBG = Debug-level messages (lowest level) INF = Informational messages NOT = Notify message WRN = Warning conditions ERR = Error conditions CRT = Critical conditions ALR = System is unusable EMR = Emergency level (highest level) Monitored and passive processes are not affected.	B-15
CLR-MEAS:comp:\"measCat\"	Resets a measurement category on a component.	B-16
RTRV-CFG:cfgTable	Display contents of a configuration table where table can be: alarmCategories components componentTypes measCategories services tables	-

Table B-14: MML Maintenance---Logging Commands
Command Description Example

DIAGLOG:filename:start DIAGLOG:filename:stop
Starts or stops the diagnostics log.

B-17

**Table B-14: MML Maintenance---Logging Commands**
Command	Description	Example
DIAGLOG:filename:start DIAGLOG:filename:stop	Starts or stops the diagnostics log.	B-17

Table B-15: MML Maintenance---Measurement Commands
Command Description Example

RTRV-CTR:comp:"measCat" RTRV-CTR:pointCode:"measCat"
Retrieves a measurement of a component or point code.

B-18

CLR-MEAS:comp:\"measCat\"
Resets a measurement category on a component.

B-16

**Table B-15: MML Maintenance---Measurement Commands**
Command	Description	Example
RTRV-CTR:comp:"measCat" RTRV-CTR:pointCode:"measCat"	Retrieves a measurement of a component or point code.	B-18
CLR-MEAS:comp:\"measCat\"	Resets a measurement category on a component.	B-16

Table B-16: MML Maintenance---Processing Commands
Command Description Example

STA-SOFTW:proc
Starts a process or process group.

B-25

STP-SOFTW:proc:[KILL] STP-SOFTW:all:[KILL] STP-SOFTW:PM-01:CONFIRM[,KILL]
Stops a process, stops all processes (except the process manager), and stops the process manager.

B-26

**Table B-16: MML Maintenance---Processing Commands**
Command	Description	Example
STA-SOFTW:proc	Starts a process or process group.	B-25
STP-SOFTW:proc:[KILL] STP-SOFTW:all:[KILL] STP-SOFTW:PM-01:CONFIRM[,KILL]	Stops a process, stops all processes (except the process manager), and stops the process manager.	B-26

Table B-17: MML Maintenance---Trace Commands
Command Description Example

STA-SC-TRC:sigPath:params
Starts tracing on a signal path or a point code. Optional parameters are:

prd = <number>---Tracing period in seconds.

log = \"filename\"---Output filename in the ./var/trace directory.

B-24

RTRV-TRC
Displays all active traces.

-

STP-SC-TRC:all STP-SC-TRC:sigPath
Stops tracing a single signal path or all signal paths.

B-25

**Table B-17: MML Maintenance---Trace Commands**
Command	Description	Example
STA-SC-TRC:sigPath:params	Starts tracing on a signal path or a point code. Optional parameters are: prd = <number>---Tracing period in seconds. log = \"filename\"---Output filename in the ./var/trace directory.	B-24
RTRV-TRC	Displays all active traces.	-
STP-SC-TRC:all STP-SC-TRC:sigPath	Stops tracing a single signal path or all signal paths.	B-25

Table B-18: MML Alarm Commands
Command Description Example

ACK-ALM:comp:\"almCat\"
Acknowledges an alarm category on a component as recognized, but not cleared.

B-13

CLR-ALM:comp:\"almCat\"
Clears an alarm category on a component.

B-16

RTRV-ALMS
Displays all active alarms.

B-18

RTRV-ALMS::CONT
Displays all active alarms and listens for alarm events until you enter Ctrl-c.

B-18

**Table B-18: MML Alarm Commands**
Command	Description	Example
ACK-ALM:comp:\"almCat\"	Acknowledges an alarm category on a component as recognized, but not cleared.	B-13
CLR-ALM:comp:\"almCat\"	Clears an alarm category on a component.	B-16
RTRV-ALMS	Displays all active alarms.	B-18
RTRV-ALMS::CONT	Displays all active alarms and listens for alarm events until you enter Ctrl-c.	B-18

B.5 MML Commands Examples

B.5.1 ACK-ALM --- Acknowledge Alarm

Purpose:

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

Format:

ACK-ALM:comp:"almCat"

Descriptions:

comp---The component from which the alarm is generating.

almCat---The logical identifier to indicate the alarm category.

Note When the alarm category is entered, it must be entered in uppercase and must be in quotation marks. The alarm category is case sensitive.

Example:

This MML command acknowledges a minor alarm for signaling path T-2-6 which is generating a manual out-of-service alarm.

mml> ACK-ALM:DC-10-2:"SC CONFIG FAIL"

Response:

mml> ACK-ALM:DC-10-2:"SC CONFIG FAIL" TransPath: tp02 VSC2700 1999-03-10 12:04:12 M COMPLD ;

Error Code:

None.

Comments:

None.

Purpose:	This MML command is used to acknowledge that an alarm category on a component is recognized, but not cleared. When this command is received by the alarm manager, the associated alarm is removed from a maintained list. If this is the last current alarm of a specific severity, then the associated alarm relay is turned off.
Format:	ACK-ALM:comp:"almCat"
Descriptions:	comp---The component from which the alarm is generating. almCat---The logical identifier to indicate the alarm category. Note When the alarm category is entered, it must be entered in uppercase and must be in quotation marks. The alarm category is case sensitive.
Example:	This MML command acknowledges a minor alarm for signaling path T-2-6 which is generating a manual out-of-service alarm. `mml> ACK-ALM:DC-10-2:"SC CONFIG FAIL"`
Response:	`mml> ACK-ALM:DC-10-2:"SC CONFIG FAIL"` `TransPath: tp02 VSC2700 1999-03-10 12:04:12` `M COMPLD` `;`
Error Code:	None.
Comments:	None.

B.5.2 BLK-CIC --- Block a Circuit or A Circuit Range

Purpose:

This MML command is used to block a circuit or range of circuits from carrying calls.

Format:

BLK-CIC:target: CIC=start[, RNG=range]

Descriptions:

target---Component name of a point code.

start---A valid circuit identification code.

range---A number that indicates all the CICs from CIC to (CIC+RNG) inclusive are to be blocked. For example, to block all of the CICs from 60 to 90, the CIC number would be 60 and the RNG number would be 30. You would enter the following command:

mml> BLK-CIC:pointCode:CIC=60, RNG=30
This blocks the CIC 60 and the next 30 CICs. If you enter a range that exceeds 31 from the initial CIC, the system returns an error message that you are out of range.

Example:

This MML command blocks CIC 279 for point code 3-213-7-3.

mml> BLK-CIC:PC-3-213-7-3:CIC=279

Error Code:

None. Returns a result code when successfully completed.

Comments:

None.

Purpose:	This MML command is used to block a circuit or range of circuits from carrying calls.
Format:	BLK-CIC:target: CIC=start[, RNG=range]
Descriptions:	target---Component name of a point code. start---A valid circuit identification code. range---A number that indicates all the CICs from CIC to (CIC+RNG) inclusive are to be blocked. For example, to block all of the CICs from 60 to 90, the CIC number would be 60 and the RNG number would be 30. You would enter the following command: mml> BLK-CIC:pointCode:CIC=60, RNG=30 This blocks the CIC 60 and the next 30 CICs. If you enter a range that exceeds 31 from the initial CIC, the system returns an error message that you are out of range.
Example:	This MML command blocks CIC 279 for point code 3-213-7-3. mml> BLK-CIC:PC-3-213-7-3:CIC=279
Error Code:	None. Returns a result code when successfully completed.
Comments:	None.

B.5.3 CHG-CFG---Change Configuration Table(s)

Purpose:

This MML command reloads the contents of one or more configuration tables.

Format:

CHG-CFG:table:confirm
NoteThe confirm parameter is necessary if updating tables that affect call processing. These include:
sigPath

sigChanDev

Descriptions:

table---Logical identifier for reloading the contents of one or more configuration tables.

Example:

This MML command reloads the contents of the sigPath configuration files.

mml> CHG-CFG:buckets

Response:

mml> CHG-CFG:buckets TransPath: tp02 VSC2700 1999-03-10 12:12:23 M COMPLD "buckets" /* Affected Signaling Channel will be set in an INB state */ ;

Error Code:

SNSP

Comments:

The following are valid targets:

sigPath

sigChanDev

components

auxSigPath

alarmCategories

componentTypes

buckets

bearChan

measCategories

measProfiles

tables

thresholds

dmprSink

physLineIF

procGroups

processes

services

Purpose:	This MML command reloads the contents of one or more configuration tables.
Format:	CHG-CFG:table:confirm NoteThe confirm parameter is necessary if updating tables that affect call processing. These include: sigPath sigChanDev
Descriptions:	table---Logical identifier for reloading the contents of one or more configuration tables.
Example:	This MML command reloads the contents of the sigPath configuration files. mml> CHG-CFG:buckets
Response:	mml> CHG-CFG:buckets TransPath: tp02 VSC2700 1999-03-10 12:12:23 M COMPLD "buckets" /* Affected Signaling Channel will be set in an INB state */ ;
Error Code:	SNSP
Comments:	The following are valid targets: sigPath sigChanDev components auxSigPath alarmCategories componentTypes buckets bearChan measCategories measProfiles tables thresholds dmprSink physLineIF procGroups processes services

B.5.4 CHG-DPL---Update Customer Specific Number Manipulation Tables

Purpose:

This MML command updates customer-specific number manipulation tables based on the supplied vnet ID.

Format:

CHG-DPL:vnetID

Description:

vnetID---the identifier (customer ID) not validated by MML.

Example:

mml> CHG-DPL:1005

Error Code:

None.

Comments:

None.

Purpose:	This MML command updates customer-specific number manipulation tables based on the supplied vnet ID.
Format:	CHG-DPL:vnetID
Description:	vnetID---the identifier (customer ID) not validated by MML.
Example:	mml> CHG-DPL:1005
Error Code:	None.
Comments:	None.

B.5.5 CHG-LOG---Change Log

Purpose:

This MML command is used to set or reset the logging level of an active process. Monitored and passive processes are not affected.

Format:

CHG-LOG:procName:logLevel CHG-LOG:all:logLevel

Descriptions:

all---Logical identifiers for all known processes.

procName---Logical identifier used to select a specific active process.

logLevel---Logical identifier used to set the logging level for the active process. Logging levels:

DBG---Debug-level messages (lowest level message).

INF---Informational messages.

NOT---Notify level messages.

WRN---Warning condition messages.

ERR---Error condition messages.

CRT---Critical level messages.

ALR---System is unusable messages.

EMR---Emergency level messages (highest level message).

Example:

This MML command sets or resets all processes to the logging level WRN.

mml> CHG-LOG:all:WRN

Error Code:

SNSP State Not Supported---This is returned when a process cannot change its logging level via the MML interface.

Comments:

None.

Purpose:	This MML command is used to set or reset the logging level of an active process. Monitored and passive processes are not affected.
Format:	CHG-LOG:procName:logLevel CHG-LOG:all:logLevel
Descriptions:	all---Logical identifiers for all known processes. procName---Logical identifier used to select a specific active process. logLevel---Logical identifier used to set the logging level for the active process. Logging levels: DBG---Debug-level messages (lowest level message). INF---Informational messages. NOT---Notify level messages. WRN---Warning condition messages. ERR---Error condition messages. CRT---Critical level messages. ALR---System is unusable messages. EMR---Emergency level messages (highest level message).
Example:	This MML command sets or resets all processes to the logging level WRN. `mml>` CHG-LOG:all:WRN
Error Code:	SNSP State Not Supported---This is returned when a process cannot change its logging level via the MML interface.
Comments:	None.

B.5.6 CLR-ALM---Clear Alarm Component Category

Purpose:

This MML command clears an alarm category for a component.

Format:

CLR-ALM:compTypeName:almCategoryName

Description:

compTypeName---Logical identifier used to select a specific component category.

almCategoryName---Logical identifier used to select the measurement category.

Example:

This MML command clears the alarm category Line Interface Severely Errored Seconds---15 minute count of the component Line Interface 1.

mml> CLR-ALM:L-1:"LIF SES-15"

Error Code:

None.

Comments:

None.

Purpose:	This MML command clears an alarm category for a component.
Format:	CLR-ALM:compTypeName:almCategoryName
Description:	compTypeName---Logical identifier used to select a specific component category. almCategoryName---Logical identifier used to select the measurement category.
Example:	This MML command clears the alarm category Line Interface Severely Errored Seconds---15 minute count of the component Line Interface 1. `mml>` CLR-ALM:L-1:"LIF SES-15"
Error Code:	None.
Comments:	None.

B.5.7 CLR-MEAS---Reset a Measurement Category

Purpose:

This MML command resets a measurement category of a component.

Format:

CLR-MEAS::compTypeName:measCategoryName

Description:

compTypeName---Logical identifier used to select a specific component.

measCategoryName---Logical identifier used to select the measurement category.

Example:

This MML command resets the measurement category for signaling channel reset for the component T-1-1.

mml> CLR-MEAS:: T-1-1:"SC-RCVR"

Error Code:

None.

Comments:

None.

B.5.8 DIAGLOG---Diagnostics Log

Purpose:

This MML command starts and stops logging into a diagnostics log.

Format:

DIAGLOG:filename:start DIAGLOG:filename:stop

Example:

This MML command starts logging into the diagnostics log named mml.log.

mml> DIAGLOG:mml.log:start

Error Code:

None. Returns a completion status when successfully completed.

Comments:

None.

B.5.9 HELP---Open the Help File

Purpose:

This MML command opens the help file.

Format:

HELP

Description:

Provides information on the topic selected.

Example:

mml> HELP

Error Code:

The contents of the HELP file are displayed. (See Table B-5.)

Comments:

None.

B.5.10 RESET-CIC---Reset a Circuit or A Circuit Range

Purpose:

This MML command makes circuit(s) which have been blocked available to carry calls.

Format:

RESET-CIC: target: CIC=start[, RNG=range]

Descriptions:

target--- Component name of a point code.

start---A valid circuit interrupt code.

range---A number such that CIC+RNG is a valid CIC.

Example:

This MML command resets circuit 005L.

mml> RESET-CIC:PC-1-2-3-2:CIC=279,RNG=5

Error Code:

None. Returns a result code when successfully completed.

Comments:

None.

B.5.11 RTRV-ALMS---Retrieve Active Alarms

Purpose:

This MML command displays all active alarms.

Format:

RTRV-ALMS RTRV-ALMS::CONT

Description:

CONT---Logical identifier for all known active alarms; listens for alarm events until Ctrl-c is entered.

Example:

This MML command displays the names of the active alarms.

mml> RTRV-ALMS
This MML command displays the names of all active alarms and listens for alarm events until you enter Ctrl-c.

mml> RTRV-ALMS::CONT

Error Code:

SABT---alarm manager is not running.

Comments:

None.

B.5.12 RTRV-CTR---Retrieve Measurement Counter

Purpose:

This MML command displays a measurement counter of a component.

Format:

RTRV-CTR:compTypeName:measCategoryName

Description:

Displays the measurement counter of a component.

Example:

This MML command displays the name and attributes for the measurement counter.

mml> RTRV-CTR:T-1-1:"RCVR"

Error Code:

None.

Comments:

None.

B.5.13 RTRV-CFG---Retrieve Configuration Table

Purpose:

This MML command displays the contents of a configuration table, where the table can be Components, alarmCats, or measCats.

Format:

RTRV-CFG:cfgTable

Description:

cfg table---Logical identifier to display the contents of a configuration table.

Example:

This MML command displays the contents of the alarm categories configuration file.

mml> RTRV-CFG:alarmCategories

Error Code:

None.

Comments:

Currently the cfgTable in this command is different from the cfgTable used in the change configuration command. The following are valid target tables:

alarmCategories

components

componentTypes

services

measCategories

tables

dfltcfgparms (default configuration parameters)

B.5.14 RTRV-DEST---Retrieve Destination

Purpose:

This MML command retrieves information about destinations.

Format:

RTRV-DEST:all RTRV-DEST:pointCode RTRV-DEST:sigPath

Descriptions:

Retrieves the destinations of all components or a single point code or signaling path.

Example:

This MML command retrieves the destination of a single point code:

mml> RTRV-DEST:PC-1-1-1-2

Response Format:

M RTRV "PC-1-1-1-2:PKG=SS7-ANSI,ASSOC=SP1-IP SP2-IP,PST=IS"
where PC-1-1-1-2 is the target; PKG=SS7-ANSI is the protocol; ASSOC=SP1-IP SP2-IP is the destination id; and PST=IS is the state (in service).

Error Code:

None.

Comments:

None.

B.5.15 RTRV-RTE---Retrieve Route

Purpose:

This MML command retrieves all routes to a destination point code.

Format:

RTRV-RTE:destinationPointCode

Description:

Displays the route of a destination point code ID.

Example:

This MML command retrieves the route for destination point code PC-002.

mml> RTRV-RTE:PC-002

Response Format:

M RTRV PC-002:LS01,APC=000.028.007,PRIO=1
where PC-002 is the target; LS01 is the link set ID; APC=000.0028.007 is the adjacent point code; and PRIO is the priority set for the routes.

Error Code:

None.

Comments:

None.

B.5.16 RTRV-LNK-CTR---Retrieve C7 Link Measurements

Purpose:

This MML command displays the measurements for a link.

Format:

RTRV-LNK-CTR:all RTRV-LNK-CTR:target

Descriptions:

target---Component name of a link or a link set or every link set.

Example:

This MML command generates the measurement for link TP01.

mml> RTRV-LNK-CTR: TP01

Error Code:

None. Returns all measurements for a link, every link configured in the specified link set, or every link set. The measurements are displayed in the same format as in RTRV-CTR.

Comments:

None.

B.5.17 RTRV-LSET---Retrieve Link Set Characteristics

Purpose:

This MML command is used to retrieve the service state of a link set.

Format:

RTRV-LSET: target

Descriptions:

target---Component name of a link.

Example:

This MML command retrieves the service state of link set TP10.

mml> RTRV-LSET: TP10

Error Code:

None. Displays link set service state as in-service (IS), out-of-service (OOS), or Manually out-of-service (MOOS).

Comments:

None.

B.5.18 RTRV-NE---Retrieve Network Element Attributes

Purpose:

This MML command displays the attributes of the network element.

Format:

RTRV-NE

Description:

Displays the attributes of the network element.

Example:

This MML command displays the name and attributes for the network element:

mml> RTRV-NE

Error Code:

None.

Comments:

None.

B.5.19 RTRV-SC---Retrieve Signaling Channel(s) Attributes

Purpose:

This MML command displays the names and attributes of signaling channels.

Format:

RTRV-SC:all RTRV-SC:sigChannel RTRV-SC:C7linkSet

Description:

Displays the attributes of all signaling channels and link sets or a single signaling channel or link set.

Example:

mml> RTRV-SC:all

Response Format:

mml> rtrv-sc:all TransPath: SC22 VA-BLACK/TAN (SC2200) 1999-02-10 11:52:48 M RTRV "DC-4-0:LS-4,LID=0:IS" /* DC-4-0: A-link to STP 1.1.4 */ "DC-3-0:LS-3,LID=0:IS" /* DC-3-0: A-link to STP 1.1.3 */ "DC-1-1:LS-1,LID=1:OOS" /* DC-1-1: F-links to Switch */ "DC-1-0:LS-1,LID=0:IS" /* DC-1-0: F-links to Switch */ "SC1-NAS1:SP1-IP,LID=0:IS" /* SC1-NAS1: Sig Channel 1 for IP Sig Path NAS1 */ "SC1-NAS2:SP2-IP,LID=0:OOS" /* SC1-NAS2: Sig Channel 1 for IP Sig Path NAS2 */
Signaling Channel State Attributes with Definitions

IS---In-service.

INB---Install Busy

OOS---Out-of-service.

LINH---Line Inhibited.

COOS---Customer out-of-service (customer set the signal channel in an OOS state).

Error Code:

None.

Comments:

None.

B.5.20 RTRV-SOFTW---Retrieve Software Status for a Specific Process

Purpose:

This MML command displays the status of a process.

Format:

RTRV-SOFTW:all RTRV-SOFTW:procName RTRV-SOFTW:groupName

Description:

procName---Logical identifier to display the status of a process.

groupName---Logical identifier to display the status of a process group.

Example:

This MML command displays the status of the process identified as LMCC-2.

mml> RTRV-SOFTW:LMCC-2

Error Code:

SABT---Status Abort: command did not complete in allocated time.

Comments:

None.

B.5.21 RTRV-SP-CTR---Retrieve C7 Signaling Point Measurements

Purpose:

This MML command returns all measurements for the indicated signaling point (SP) or every SP. The measurements are displayed in the same format as in RTRV-CTR.

Format:

RTRV-SP-CTR:all RTRV-SP-CTR:target

Descriptions:

target---Component name of a signaling point.

Example:

This MML command retrieves all measurements for SP023.

mml> RTRV-SP-CTR:SP023

Error Code:

None. Returns a result code when successfully completed.

Comments:

None.

B.5.22 RTRV-SPC---Retrieve Point Code

Purpose:

This MML command retrieves a destination point code's attributes.

Format:

RTRV-SPC:all RTRV-SPC:pointCode

Description:

Retrieve the signaling point code for a specific destination point code or all destination point codes.

Example:

This MML command retrieves the route for all destination point code IDs.

mml> RTRV-SPC: all

Response Format:

TransPath: SC22 VA-BLACK/TAN (SC2200) 1999-02-10 11:59:14 M RTRV "PC-1-1-1-2:DPC=001.001.001,DNW=2:OPC=001.001.005:IS" "PC-1-1-3-2:DPC=001.001.003,DNW=2:OPC=001.001.005:IS" "PC-1-1-4-2:DPC=001.001.004,DNW=2:OPC=001.001.005:IS" ;M RTRV

Error Code:

None.

Comments:

None.

B.5.23 SET-EQPT-STATE---Change Card's Service State

Purpose:

This MML command resets a cage card.

Format:

SET-EQPT-STATE:target:state

Descriptions:

target---Component name of an existing I/O card.

state---IS, OOS, or RESET (RESET is ignored in this release).

Example:

This MML command sets card C0041 to out-of-service.

mml> SET-EQPT-STATE:C0041:OOS

Error Code:

None. Returns a completion status when successfully completed.

Comments:

None.

B.5.24 SET-LNK-STATE---Set Link or Link Set Service State

Purpose:

This MML command is used to set the service state of a link or link set.

Format:

SET-LNK-STATE:target:state

Descriptions:

target---Component name of a link or link set.

state---IS, OOS, or INH

Example:

This MML command sets the service state of a link to OOS:

mml> SET-LNK-STATE:TP01:OOS

Error Code:

None. Returns a completion status when successfully executed.

Comments:

None.

B.5.25 SET-SC-STATE---Set Signaling Channel State

Purpose:

This MML command changes the service state of a channel.

Format:

SET-SC-STATE:sigPath:state

Descriptions:

sigPath---Logical identifier for the signaling channel.

state---Signaling channel states:

IS---Option to place a signal channel in-service.

OOS---Option to take a signal channel out-of-service. If the channel is carrying a call, after the call completes, the channel is removed from service.

COOS---If a customer sets one of their channels OOS (out-of-service), when the state is displayed for that channel it displays COOS, customer out-of-service.

FOOS---Option chosen to force a signal channel Out-Service. If the channel is carrying a call, the call is immediately terminated.

SUSPEND---Option chosen to halt processing on a channel for a specific time. This state is canceled when IS is entered as the SET-SC-STATE option.

Example:

This MML command changes the service state of T-2-6 signaling channel from in-service to out-of-service.

mml> SET-SC-STATE:T-2-6:OOS

Error Code

SNVS---Channel was not in a valid state.

Comments:

None.

B.5.26 STA-SC-TRC---Start Trace

Purpose:

This MML command starts a protocol conversion trace on a signal path.

Format:

mml> STA-SC-TRC:sigPath[:params]

Description:

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

sigPath---Logical identifier for the signaling path.

params---One or more of these optional parameters:

prd = <number>---Capture period in seconds. At the expiration of this period, the system discontinues PDU collection on the signaling path and closes the log file. This defaults to forever and remains open until you enter an MML command to stop tracing on the signaling path.

log = \"filename"\---File where the captured PDUs are stored that is automatically created by the signaling software and stored in the trace directory. If this value is not present, the signaling node opens a file with the default name of LOG.

Example:

This MML command starts a capture session for all PDUs going through the signaling path identified as: <T-1-16>. It stores the trace log in /var/trace/T-1-16.log.

mml> STA-SC-TRC:T-1-16;

This MML command starts a capture session for the signaling path identified as: T-2-18.

It runs for 600 seconds (10 minutes) and stores the output in, /var/trace/Victor23.trc.

mml> STA-SC-TRC:T-2-18:log="Victor23.trc",prd=600;

Error Code:

COMPLD---Path has started tracing.

SNVS---Error opening file; trace cannot be performed because the path is already being traced.

Comments:

None

B.5.27 STA-SOFTW---Start a Process or Start a Process Group

Purpose:

This MML command starts a process, all processes, or a process group.

Format:
STA-SOFTW:procName STA-SOFTW:groupName

Description:

procName---Logical identifier for the process.

groupName---Logical identifier for the process group.

Example:

This MML command starts the alarm manager process.

mml> STA-SOFTW:ALM-01

Error Code:

SABT---Status abort; command did not complete in allocated time.

SWDC---Waiting for dependency to start.

Comments:

None.

B.5.28 STP-SC-TRC---Stop Trace or Stop All Traces

Purpose:

This MML command stops protocol conversion trace on a signal path or all signal paths.

Format:

STP-SC-TRC:all STP-SC-TRC:sigPath

Description:

sig path---Logical identifier for the signaling path.

Example:

This MML command stops a capture session on the path identified as T-1-1.

mml> STP-SC-TRC:T-1-1

This MML command stops all active capture sessions.

mml> STP-SC-TRC:ALL

Error Code:

SNVS---Trace cannot be performed because the path is already being traced.

Comments:

None.

B.5.29 STP-SOFTW---Stop Process or Process Group

Purpose:

This MML command stops a process, a process group, or all processes (except the process manager)

Format:

STP-SOFTW:all STP-SOFTW:procName:[KILL] STP-SOFTW:groupName:[KILL]

Description:

procName---Logical identifier for the process.

groupName---Logical identifier for the process group.

Example:

This MML command stops the Cisco I/O channel manager process regardless of the operational state of the dependent processes.

mml> STP-SOFTW:IOCM-01:KILL
This MML command shuts down the platform and applications except for the process manager.

mml> STP-SOFTW:ALL

Error Code:

SABT---Status abort; command did not complete in allocated time.

SWDT---Waiting for dependency to start.

Comments:

In a dual configuration STP-SOFTW:ALL will not shut down the telephony controller software as the failover daemon will immediately restart procM. To shut down the active telephony controller in a dual configuration, follow the procedures in described in the "Stopping the System" section.

B.5.30 UNBLK-CIC---Unblock a Circuit or a Circuit Range

Purpose:

This MML command makes circuits that have been blocked available to carry calls.

Format:

UNBLK-CIC:target: CIC=start[, RNG=range]

Descriptions:

target---Component name of a point code.

start---A valid circuit identification code.

range---A number that indicates all the CICs from CIC to (CIC+RNG) inclusive are to be unblocked. For example, to unblock all of the CICs from 60 to 90, the CIC number would be 60 and the RNG number would be 30. You would enter the following command:

mml> UNBLK-CIC:point code:CIC=60, RNG=30
This unblocks the CIC 60 and the next 30 CICs. If you enter a range that exceeds 31 from the initial CIC, the system returns an error message that you are out of range.

Example:

This MML command unblocks CIC 279 for point code 3-213-7-3.

mml> UNBLK-CIC:PC-3-213-7-3:CIC=279

Error Code:

None. Returns a result code when successfully completed.

Comments:

None.

Purpose:	This MML command resets a measurement category of a component.
Format:	CLR-MEAS::compTypeName:measCategoryName
Description:	compTypeName---Logical identifier used to select a specific component. measCategoryName---Logical identifier used to select the measurement category.
Example:	This MML command resets the measurement category for signaling channel reset for the component T-1-1. mml> CLR-MEAS:: T-1-1:"SC-RCVR"
Error Code:	None.
Comments:	None.

Purpose:	This MML command starts and stops logging into a diagnostics log.
Format:	DIAGLOG:filename:start DIAGLOG:filename:stop
Example:	This MML command starts logging into the diagnostics log named mml.log. `mml>` DIAGLOG:mml.log:start
Error Code:	None. Returns a completion status when successfully completed.
Comments:	None.

Purpose:	This MML command opens the help file.
Format:	HELP
Description:	Provides information on the topic selected.
Example:	mml> HELP
Error Code:	The contents of the HELP file are displayed. (See Table B-5.)
Comments:	None.

Purpose:	This MML command makes circuit(s) which have been blocked available to carry calls.
Format:	RESET-CIC: target: CIC=start[, RNG=range]
Descriptions:	target--- Component name of a point code. start---A valid circuit interrupt code. range---A number such that CIC+RNG is a valid CIC.
Example:	This MML command resets circuit 005L. `mml>` RESET-CIC:PC-1-2-3-2:CIC=279,RNG=5
Error Code:	None. Returns a result code when successfully completed.
Comments:	None.

Purpose:	This MML command displays all active alarms.
Format:	RTRV-ALMS RTRV-ALMS::CONT
Description:	CONT---Logical identifier for all known active alarms; listens for alarm events until Ctrl-c is entered.
Example:	This MML command displays the names of the active alarms. mml> RTRV-ALMS This MML command displays the names of all active alarms and listens for alarm events until you enter Ctrl-c. mml> RTRV-ALMS::CONT
Error Code:	SABT---alarm manager is not running.
Comments:	None.

Purpose:	This MML command displays a measurement counter of a component.
Format:	RTRV-CTR:compTypeName:measCategoryName
Description:	Displays the measurement counter of a component.
Example:	This MML command displays the name and attributes for the measurement counter. `mml>` RTRV-CTR:T-1-1:"RCVR"
Error Code:	None.
Comments:	None.

Purpose:	This MML command displays the contents of a configuration table, where the table can be Components, alarmCats, or measCats.
Format:	RTRV-CFG:cfgTable
Description:	cfg table---Logical identifier to display the contents of a configuration table.
Example:	This MML command displays the contents of the alarm categories configuration file. `mml>` RTRV-CFG:alarmCategories
Error Code:	None.
Comments:	Currently the cfgTable in this command is different from the cfgTable used in the change configuration command. The following are valid target tables: alarmCategories components componentTypes services measCategories tables dfltcfgparms (default configuration parameters)

Purpose:	This MML command retrieves information about destinations.
Format:	RTRV-DEST:all RTRV-DEST:pointCode RTRV-DEST:sigPath
Descriptions:	Retrieves the destinations of all components or a single point code or signaling path.
Example:	This MML command retrieves the destination of a single point code: mml> RTRV-DEST:PC-1-1-1-2
Response Format:	M RTRV "PC-1-1-1-2:PKG=SS7-ANSI,ASSOC=SP1-IP SP2-IP,PST=IS" where PC-1-1-1-2 is the target; PKG=SS7-ANSI is the protocol; ASSOC=SP1-IP SP2-IP is the destination id; and PST=IS is the state (in service).
Error Code:	None.
Comments:	None.

Purpose:	This MML command retrieves all routes to a destination point code.
Format:	RTRV-RTE:destinationPointCode
Description:	Displays the route of a destination point code ID.
Example:	This MML command retrieves the route for destination point code PC-002. mml> RTRV-RTE:PC-002
Response Format:	M RTRV PC-002:LS01,APC=000.028.007,PRIO=1 where PC-002 is the target; LS01 is the link set ID; APC=000.0028.007 is the adjacent point code; and PRIO is the priority set for the routes.
Error Code:	None.
Comments:	None.

Purpose:	This MML command displays the measurements for a link.
Format:	RTRV-LNK-CTR:all RTRV-LNK-CTR:target
Descriptions:	target---Component name of a link or a link set or every link set.
Example:	This MML command generates the measurement for link TP01. mml> RTRV-LNK-CTR: TP01
Error Code:	None. Returns all measurements for a link, every link configured in the specified link set, or every link set. The measurements are displayed in the same format as in RTRV-CTR.
Comments:	None.

Purpose:	This MML command is used to retrieve the service state of a link set.
Format:	RTRV-LSET: target
Descriptions:	target---Component name of a link.
Example:	This MML command retrieves the service state of link set TP10. `mml>` RTRV-LSET: TP10
Error Code:	None. Displays link set service state as in-service (IS), out-of-service (OOS), or Manually out-of-service (MOOS).
Comments:	None.

Purpose:	This MML command displays the attributes of the network element.
Format:	RTRV-NE
Description:	Displays the attributes of the network element.
Example:	This MML command displays the name and attributes for the network element: `mml>` RTRV-NE
Error Code:	None.
Comments:	None.

Purpose:	This MML command displays the names and attributes of signaling channels.
Format:	RTRV-SC:all RTRV-SC:sigChannel RTRV-SC:C7linkSet
Description:	Displays the attributes of all signaling channels and link sets or a single signaling channel or link set.
Example:	`mml>` RTRV-SC:all
Response Format:	`mml> rtrv-sc:all` `TransPath: SC22 VA-BLACK/TAN (SC2200) 1999-02-10 11:52:48` `M RTRV` `"DC-4-0:LS-4,LID=0:IS"` `/* DC-4-0: A-link to STP 1.1.4 /` `"DC-3-0:LS-3,LID=0:IS"` `/ DC-3-0: A-link to STP 1.1.3 /` `"DC-1-1:LS-1,LID=1:OOS"` `/ DC-1-1: F-links to Switch /` `"DC-1-0:LS-1,LID=0:IS"` `/ DC-1-0: F-links to Switch /` `"SC1-NAS1:SP1-IP,LID=0:IS"` `/ SC1-NAS1: Sig Channel 1 for IP Sig Path NAS1 /` `"SC1-NAS2:SP2-IP,LID=0:OOS"` `/ SC1-NAS2: Sig Channel 1 for IP Sig Path NAS2 /` Signaling Channel State Attributes with Definitions IS---In-service. INB---Install Busy OOS---Out-of-service. LINH---Line Inhibited. COOS*---Customer out-of-service (customer set the signal channel in an OOS state).
Error Code:	None.
Comments:	None.

Purpose:	This MML command displays the status of a process.
Format:	RTRV-SOFTW:all RTRV-SOFTW:procName RTRV-SOFTW:groupName
Description:	procName---Logical identifier to display the status of a process. groupName---Logical identifier to display the status of a process group.
Example:	This MML command displays the status of the process identified as LMCC-2. mml> RTRV-SOFTW:LMCC-2
Error Code:	SABT---Status Abort: command did not complete in allocated time.
Comments:	None.

Purpose:	This MML command returns all measurements for the indicated signaling point (SP) or every SP. The measurements are displayed in the same format as in RTRV-CTR.
Format:	RTRV-SP-CTR:all RTRV-SP-CTR:target
Descriptions:	target---Component name of a signaling point.
Example:	This MML command retrieves all measurements for SP023. `mml>` RTRV-SP-CTR:SP023
Error Code:	None. Returns a result code when successfully completed.
Comments:	None.

Purpose:	This MML command retrieves a destination point code's attributes.
Format:	RTRV-SPC:all RTRV-SPC:pointCode
Description:	Retrieve the signaling point code for a specific destination point code or all destination point codes.
Example:	This MML command retrieves the route for all destination point code IDs. mml> RTRV-SPC: all
Response Format:	`TransPath: SC22 VA-BLACK/TAN (SC2200) 1999-02-10 11:59:14` `M RTRV` `"PC-1-1-1-2:DPC=001.001.001,DNW=2:OPC=001.001.005:IS"` `"PC-1-1-3-2:DPC=001.001.003,DNW=2:OPC=001.001.005:IS"` `"PC-1-1-4-2:DPC=001.001.004,DNW=2:OPC=001.001.005:IS"` `;M RTRV`
Error Code:	None.
Comments:	None.

Purpose:	This MML command resets a cage card.
Format:	SET-EQPT-STATE:target:state
Descriptions:	target---Component name of an existing I/O card. state---IS, OOS, or RESET (RESET is ignored in this release).
Example:	This MML command sets card C0041 to out-of-service. `mml>` SET-EQPT-STATE:C0041:OOS
Error Code:	None. Returns a completion status when successfully completed.
Comments:	None.

Purpose:	This MML command is used to set the service state of a link or link set.
Format:	SET-LNK-STATE:target:state
Descriptions:	target---Component name of a link or link set. state---IS, OOS, or INH
Example:	This MML command sets the service state of a link to OOS: mml> SET-LNK-STATE:TP01:OOS
Error Code:	None. Returns a completion status when successfully executed.
Comments:	None.

Purpose:	This MML command changes the service state of a channel.
Format:	SET-SC-STATE:sigPath:state
Descriptions:	sigPath---Logical identifier for the signaling channel. state---Signaling channel states: IS---Option to place a signal channel in-service. OOS---Option to take a signal channel out-of-service. If the channel is carrying a call, after the call completes, the channel is removed from service. COOS---If a customer sets one of their channels OOS (out-of-service), when the state is displayed for that channel it displays COOS, customer out-of-service. FOOS---Option chosen to force a signal channel Out-Service. If the channel is carrying a call, the call is immediately terminated. SUSPEND---Option chosen to halt processing on a channel for a specific time. This state is canceled when IS is entered as the SET-SC-STATE option.
Example:	This MML command changes the service state of T-2-6 signaling channel from in-service to out-of-service. mml> SET-SC-STATE:T-2-6:OOS
Error Code	SNVS---Channel was not in a valid state.
Comments:	None.

Purpose:	This MML command starts a protocol conversion trace on a signal path.
Format:	mml> STA-SC-TRC:sigPath[:params]
Description:	On successful completion, all PDU (protocol data units) traffic on the path is captured to a log file. This MML command succeeds regardless of the service state of the path. sigPath---Logical identifier for the signaling path. params---One or more of these optional parameters: prd = <number>---Capture period in seconds. At the expiration of this period, the system discontinues PDU collection on the signaling path and closes the log file. This defaults to forever and remains open until you enter an MML command to stop tracing on the signaling path. log = \"filename"\---File where the captured PDUs are stored that is automatically created by the signaling software and stored in the trace directory. If this value is not present, the signaling node opens a file with the default name of LOG.
Example:	This MML command starts a capture session for all PDUs going through the signaling path identified as: <T-1-16>. It stores the trace log in /var/trace/T-1-16.log. `mml>` STA-SC-TRC:T-1-16; This MML command starts a capture session for the signaling path identified as: T-2-18. It runs for 600 seconds (10 minutes) and stores the output in, /var/trace/Victor23.trc. `mml>` STA-SC-TRC:T-2-18:log="Victor23.trc",prd=600;
Error Code:	COMPLD---Path has started tracing. SNVS---Error opening file; trace cannot be performed because the path is already being traced.
Comments:	None

Table of Contents

MML Commands

Purpose:	This MML command starts a process, all processes, or a process group.
Format:	STA-SOFTW:procName STA-SOFTW:groupName
Description:	procName---Logical identifier for the process. groupName---Logical identifier for the process group.
Example:	This MML command starts the alarm manager process. `mml>` STA-SOFTW:ALM-01
Error Code:	SABT---Status abort; command did not complete in allocated time. SWDC---Waiting for dependency to start.
Comments:	None.

Purpose:	This MML command stops protocol conversion trace on a signal path or all signal paths.
Format:	STP-SC-TRC:all STP-SC-TRC:sigPath
Description:	sig path---Logical identifier for the signaling path.
Example:	This MML command stops a capture session on the path identified as T-1-1. `mml>` STP-SC-TRC:T-1-1 This MML command stops all active capture sessions. `mml>` STP-SC-TRC:ALL
Error Code:	SNVS---Trace cannot be performed because the path is already being traced.
Comments:	None.

Purpose:	This MML command stops a process, a process group, or all processes (except the process manager)
Format:	STP-SOFTW:all STP-SOFTW:procName:[KILL] STP-SOFTW:groupName:[KILL]
Description:	procName---Logical identifier for the process. groupName---Logical identifier for the process group.
Example:	This MML command stops the Cisco I/O channel manager process regardless of the operational state of the dependent processes. `mml>` STP-SOFTW:IOCM-01:KILL This MML command shuts down the platform and applications except for the process manager. `mml>` STP-SOFTW:ALL
Error Code:	SABT---Status abort; command did not complete in allocated time. SWDT---Waiting for dependency to start.
Comments:	In a dual configuration STP-SOFTW:ALL will not shut down the telephony controller software as the failover daemon will immediately restart procM. To shut down the active telephony controller in a dual configuration, follow the procedures in described in the "Stopping the System" section.

Purpose:	This MML command makes circuits that have been blocked available to carry calls.
Format:	UNBLK-CIC:target: CIC=start[, RNG=range]
Descriptions:	target---Component name of a point code. start---A valid circuit identification code. range---A number that indicates all the CICs from CIC to (CIC+RNG) inclusive are to be unblocked. For example, to unblock all of the CICs from 60 to 90, the CIC number would be 60 and the RNG number would be 30. You would enter the following command: mml> UNBLK-CIC:point code:CIC=60, RNG=30 This unblocks the CIC 60 and the next 30 CICs. If you enter a range that exceeds 31 from the initial CIC, the system returns an error message that you are out of range.
Example:	This MML command unblocks CIC 279 for point code 3-213-7-3. `mml>` UNBLK-CIC:PC-3-213-7-3:CIC=279
Error Code:	None. Returns a result code when successfully completed.
Comments:	None.