|
|
This appendix provides MML command definitions for end users for the operation of TransPath system software on a Sun Enterprise 450 server running Solaris 2.5.1.
This appendix is intended for two different audiences: the system administrator and the system operator. The system administrator manages the high end host administrative functions, such as maintaining parameters, granting group and user IDs, and administrating the TransPath system directory. The system operator is familiar with telecommunication protocols, basic computer software operation, computer terminology and concepts, hierarchical file systems, common UNIX shell commands, and log and system configurations.
| Typeface | Description | Examples |
|---|---|---|
| Command names, file and directory names, and on screen computer output. | rtrv-alms |
| Replaceable file name, real name, or value. | rtrv-cfg:<cfg table> |
AaBbCc123 | Book titles, new words, terms, or words to be emphasized. | TransPath System Installation Guide. |
| | A pipe. Either the preceding symbol or the succeeding symbol may occur, but not both in succession. |
[ ] | These brackets enclose an optional parameter. |
{ | } | |
< > | This symbol encloses a symbol specifier. |
: | A parameter separator. |
:: | An empty parameter block. |
| Arguments are grouped together so that one parameter may convey several arguments. |
; | End of command. |
| Complete | This status return is verifying that the operation was completed successfully. |
| Retrieve | Retrieve and display the contents of the specified file. |
| Successful | Successful completion. |
| Waiting for dependency | A status message: Waiting for dependent processes to start. |
| Waiting for dependency | A status message: Waiting for dependent processes to stop. This is not an error. Run |
| Command not valid | The MML command was not recognized. |
| Input: data not valid | An unknown parameter has been entered. |
| Input: syntax error | A syntax error: Incorrect syntax was used |
| Invalid target | The requested operation cannot be performed on the network element component or the component does not exist in the system. |
| Input parameter missing | The expected parameter cannot be found. |
| Status abort | Command to complete the execution in the maximum measure. |
| 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. |
| State not supported | This operation is not supported by the component. |
| MML Command | Description |
|---|---|
ACK-ALM:<comp>:"<alm cat>" | Acknowledges that an alarm is recognized, but not cleared. |
BLK-CIC:<pointcode>:CIC=<number> | Blocks a circuit or a range of circuits from carrying calls. |
CHG-CFG:<cfg table>&<cfg table> | Re-loads tables where table can be the following: |
CHG-DPL:VNETID:TBL=<table>[,VER=0..9] | Reloads a dialing plan, where table can be the following: |
CHG-LOG:<proc>:<log level> | Sets logging level of an active process, monitored and passive processes are not affected. |
CHG-LOG:ALL:<log level> | Sets logging level for all processes. |
CLR-ALM:<comp>:"<alm cat>" | Clears an alarm category on a component. |
CLR-MEAS:<comp>:"<meas cat>" | Resets a measurement category on a component. |
DIAGLOG:<full file name>:{START | STOP} | Starts/stops diagnostics log. |
H[::<number>[,<number>]] | Displays history of commands for a specified backward number or range; the last command by default. |
HELP | Displays the list of MML commands. |
QUIT | Ends the session. |
R[::<number>] | Repeats a previously entered command with a specified backward number; the last command by default. |
RESET-CIC:<point code>:CIC=<number>[,RNG=<slaves>] | Resets a circuit or a circuit range. |
RTRV-ALMS | Displays all active alarms. |
RTRV-ALMS::CONT | Displays all active alarms and listens for alarm events until Ctrl-C. |
RTRV-ASN:<aux sign path> | Displays attributes of an ASP. |
RTRV-CFG:<cfg table> | Display contents of a configuration table where table can be the following: |
RTRV-CIC:<point code>:CIC=<number>[,RNG=<slaves>] | Retrieves bearer channels of a point code. |
RTRV-CTR:<comp>:"<meas cat>" | Retrieves a measurement of a component. |
RTRV-DEST:<point code> | Retrieves state of a destination (point code). |
RTRV-DEST:<sig path> | Retrieves state of a destination (signaling path). |
RTRV-DEST:ALL | Retrieves state of all destinations: point codes and signaling paths. |
RTRV-EQPT:<IO card> | Retrieves service state of an I/O card. |
RTRV-LNK-CTR:<C7 link/set> | Retrieves all measurements of a link or link set. |
RTRV-LNK-CTR:ALL | Retrieves all measurements of all links. |
RTRV-LSET:<C7 link set> | Displays state of a link set. |
RTRV-MML | Displays all active MML sessions. |
RTRV-NE | Displays attributes of the network element. |
RTRV-RTE:<point code> | Retrieves all route sets of a point code. |
RTRV-SC:<sig channel> | Displays attributes of a signaling channel. |
RTRV-SC:<C7 link set> | Displays attributes of a link set. |
RTRV-SC:ALL | Displays attributes of all signaling channels and link sets. |
RTRV-SOFTW:<proc> | Displays status of a process or process group. |
RTRV-SOFTW:ALL | Displays status of all known processes. |
RTRV-SP-CTR:<point code> | Retrieves all measurements of a point code. |
RTRV-SP-CTR:ALL | Retrieves all measurements of all point codes. |
RTRV-SPC:<point code> | Retrieves route set of a point code. |
RTRV-SPC:ALL | Retrieves route sets of all point codes. |
RTRV-TC:<sigPath>&<sigPath> | Displays state of bearers per signaling path(s). |
RTRV-TC:ALL | Displays state of all bearers. |
SET-ASN-STATE:<aux sig path>:IS | OOS | Changes service state of an ASP. |
SET_EQPT_STATE:<IO card>:IS | OOS | Changes service state of an I/O card. |
SET-LNK-STATE:<C7 link/set>:state | Changes state of a link or a link set; state can be the following: |
SET-SC-STATE:<line>:IS | OOS | Changes service state of all signal paths on an entire line. |
STA-SC-TRC:<sig path>:params | Starts tracing on a signal path or a point code, optional params are the following: |
STA-SOFTW:<proc> | Starts a process or process group. |
STP-CALL:<sig channel>|<point code>[:TC=<number>] | Stops calls in progress for a specified signaling channel or destination point code; by default, all traffic channels are affected. |
STP-SC-TRC:<sig path> | Stops tracing on a signal path. |
STP-SC-TRC:ALL | Stops tracing on all signal paths. |
STP-SOFTW:<proc>:[KILL] | Stop a process or all processes in a group. |
STP-SOFTW:ALL:[KILL] | Shuts down the platform and applications except for process manager. |
STP-SOFTW:PM-01:CONFIRM[,KILL] | Shuts down process manager. |
UNBLK-CIC:<point code>:CIC=<number>[,RNG=<slaves>] | Unblocks a circuit or a circuit range. |
This command initializes an idle MML session by using a session ID variable. Use the following command string:
$BASEDIR/bin/mml
The user must be a member of the TransPath System group in order to have full control over TransPath system operations. If a particular session ID is already in use, then a different session can be selected using the -s option. Upon successful launch of the MML Session, you will receive the following MML prompt:
mml>
mml -s [x]
[x] is the session number.
This MML command will initialize an idle MML session by using ID # 4:
>mml -s 4;
None
None
This MML command ends the session.
QUIT
Exits the session in progress
mml> QUIT
None
None
This MML command is used to open the help file.
HELP
Provides information on the topic selected.
mml> HELP
The contents of the HELP file are displayed. See the "MML Command List" section .
None
This MML command displays the attributes of the network element.
RTRV-NE
Displays the attributes of the network element.
This MML command displays the name and attributes for the network element.
mml> RTRV-NE
None
None
This MML command is used to acknowledge that an alarm 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 most current alarm of a certain severity, then the associated alarm relay is turned off.
ACK-ALM:<almCategoryID>:<almCategoryName>
Logical identifier to indicate alarm category.
<almCategoryID>
This MML command acknowledges that support has failed.
None
None
This MML command clears an alarm category for a component.
clr-alm:<compTypeName>:<almCategoryName>
<compTypeName> | Logical identifier used to select a specific component category. |
<almCategoryName> | Logical identifier used to select the measurement category. |
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"
None
None
This MML command displays all active alarms.
RTRV-ALMS; RTRV-ALMS::CONT
| Displays all active alarms. |
| Logical identifier for all known active alarms. Listens for alarm events until Ctrl-C is entered. |
This MML command displays the names of the active alarms.
This MML command displays the names of all active alarms and listens for alarm events until the following command is entered:
Ctrl-C mml> RTRV-ALMS::CONT
SABT alarm manager is not running.
None
This MML command displays a measurement counter of a component.
RTRV-CTR:<compTypeName>:<measCategoryName>
Displays the measurement counter of a component.
This MML command displays the name and attributes for the Measurement Counter.
mml> RTRV-CTR:T-1-1:"RCVR"
None
None
This MML command resets a measurement category of a component.
CLR-MEAS::<compTypeName>:<measCategoryName>
| Logical identifier used to select a specific component. |
| Logical identifier used to select the measurement category. |
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"
None
None
This MML command starts a protocol conversion trace on a signal path.
STA-SC-TRC:<sig path>:<parms>;
Upon successful completion, all PDU traffic on the path is captured to a log file. This MML command succeeds regardless of the service state of the path.
| Logical identifier for the signaling path. |
| One or more of these optional parameters. |
| Capture period in seconds. At the expiration of this period, the system discontinues PDU collection on the signaling path and close the log file. This defaults to "forever" effectively until the craft person enters an MML command to stop tracing on the signaling path. |
| File where the captured PDUs are stored. This file is automatically created by the TransPath system and stored in the trace directory. If this value is not present the TransPath system opens a file with the default name of LOG. <sig path>log |
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;
| Path has commenced tracing. |
| Trace cannot be performed because the path is already being traced. |
None
This MML command stops protocol conversion trace on a signal path or all signal paths.
STP-SC-TRC:<sigPathID>; STP-SC-TRC:ALL
< | Logical identifier for the signaling path. |
ALL | Logical identifier for all signaling paths currently being traced. |
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;
| Trace cannot be performed because the path is already being traced. |
None
This MML command displays the contents of a configuration table, where the table can be one of the following: Components, alarmCats, or measCats.
RTRV-CFG:<cfg table>
| Logical identifier to display the contents of a configuration table. |
This MML command displays the contents of the alarm categories configuration file.
mml> RTRV-CFG:alarmCategories
None
Currently the <return cfg table> is different from the <cfg table> used in the change configuration command. There will be more in the future. The following are valid targets:
alarmCategories components componentTypes measCategories services tables
This MML command re-loads the contents of one or more configuration tables.
CHG-CFG<table>
| Logical identifier for re-loading the contents of one or more configuration tables. |
This MML command reloads the contents of the components and sigPath configuration files.
This MML command reloads the contents of the sigPath configuration file.
mml> chg-cfg:sigPath
SNSP
The following are valid targets:
alarmCategories auxSigPath bearChan buckets components componentTypes dmprSink measCategories measProfiles physLineIF processes procGroups services sigChanDev sigPath tables thresholds
This MML command starts a process, all processes, or a process group.
STA-SOFTW:<procName> STA-SOFTW:<groupName>
<procName> | Logical identifier for the process. |
<groupName> | Logical identifier for the process group. |
This MML command starts the alarm manager process.
mml> STA-SOFTW:ALM-01
| Status abort. Command did not complete in allocated time. |
| Waiting for dependency to start. |
None
This MML command stops a process or all processes in a group.
STP-SOFTW:<procName>:[KILL] STP-SOFTW:<groupName>:[KILL] STP-SOFTW:ALL
<procName> | Logical identifier for the process. |
<groupName> | Logical identifier for the process group. |
ALL | Logical identifier for all processes and applications except for the process manager. |
This MML command stops the IOS 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;
| Status abort. Command did not complete in allocated time. |
| Waiting for dependency to start. |
In a Dual-Sun configuration, STP-SOFTW:ALL will not shut down the TransPath System application (the failover daemon will immediately restart procM). The proper shutdown procedures should be followed.
This MML command displays the status of a process.
RTRV-SOFTW:<procName> RTRV-SOFTW:<groupName> RTRV-SOFTW:ALL
<procName> | Logical identifier to display the status of a process. |
<groupName> | Logical identifier to display the status of a process. |
| Logical identifier for all known processes. |
This MML command displays the status of the process identified as LMCC-2.
mml> RTRV-SOFTW:IOCC-2;
| Status abort. Command did not complete in allocated time. Waiting for dependency to start. |
None
This MML command displays the names and attributes of the signaling channel.
RTRV-SC:{<sc id>|<lset id>|}
RTRV-SC:ALL
<sc id> | Signaling channel ID. |
<lset id> | Link set ID. |
| Logical identifier for all known signaling channels. |
mml> RTRV-SC:all
mml>rtrv-sc:all
LPC Release P1.01 1998-01-21 18:25:05
M RTRV
LS-01-01:LS-01,LID=0:IS
LS-01-01:LS-01,LID=1:OOS,LINH LS-02-01:LS-02,LID=0:IS LS-02-02:LS-02,LID=1:IS SC-01:SP-01,LID=0:OOS,COOS SC-02:SP-02,LID=0:IS
| In service |
| Out of service |
| Line inhibited |
| Customer out of service (client set the signal channel in an OOS state) |
None
None
This MML command changes the service state of a channel.
SET-SC-STATE:<sigPathID>:{IS|OOS|FOOS|SUSPEND}
<sigPathID> | Logical identifier for the signaling channel. |
| Option to place a signal channel in service. |
| Option to take a signal channel out of service. If the channel is carrying a call, the channel is removed from service after the call completes. |
| If a customer sets one of their channels OOS (out of service), the state is displayed for that channel (x) after the call completes. |
| Option chosen to force a signal channel out of service. If the channel is carrying a call, the call is immediately terminated. |
| Option chosen to halt processing on a channel for a time. This state is canceled when |
This MML command changes the service state of T-2-6 signaling channel from In-Service to Out-Of-Service.
| Channel is not in a valid state. |
None
This MML command is used to set or reset the logging level of an active process.
chg-log:<procName>:<logLevel>; chg-log:all:<logLevel>
< | Logical identifier used to select a specific active process. |
< | Logical identifier used to set the logging level for the active process. |
| Logical identifier for all known processes. |
This MML command sets or resets the alarm manager process to the logging level WRN.
mml> chg-log:WRN:logLevel
| This is returned when a process cannot change its logging level via the MML interface. |
None
This MML command is used to set the service state of a link or link set.
SET-LNK-STATE:<target>:<state>;
< | |
< | |
This MML command sets the service state of a link to OOS.
mml> SET-LNK-STATE:TP01:OOS
None.
None, returns a completion status when successfully completed.
This MML command is used to retrieve the service state of a link.
RTRV-LSET: <target>
< | |
This MML command retrieves the service state of link set TP10.
mml> RTRV-LSET: TP10
None, returns Service State (one of the strings IS, OOS, MOOS) of a link set.
None
This MML command is used to block a circuit or range of circuits from carrying calls.
BLK-CIC: <target>: CIC=<number>, [RNG=<number>]
< | |
| A valid CIC. |
| A number that makes CIC+RNG a valid CIC. |
This MML command blocks circuit 005L.
mml> BLK-CIC:005L:279
None, returns a result code when successfully completed.
None
This MML command makes blocked circuits available to carry calls.
UNBLK-CIC: <target>: CIC=<number>, [RNG=<number>]
< | |
| A valid CIC. |
| A number that makes |
This MML command unblocks circuit 005L.
mml> UNBLK-CIC:005L:279
None, returns a result code when successfully completed.
None
This MML command makes blocked circuit(s) available to carry calls.
RESET-CIC: <target>: CIC=<number>, [RNG=<number>]
< | |
| A valid CIC. |
| A number that makes |
This MML command resets circuit 005L.
mml> RESET-CIC:PC-1-2-3-2:CIC=279,RNG=5
None, returns a result code when successfully completed.
None
This MML command generates the measurements for a link.
RTRV-LNK-CTR: <target> :
< | |
This MML command generates the measurement for link TP01.
mml> RTRV-LNK-CTR: TP01
None, returns all measurements for a link, every link configured in the specified link set, or every link set if "ALL" is the target. The measurements are displayed in the same format as in RTRV-CTR.
None
This MML command returns all measurements for the indicated signaling point (SP) or every SP if "ALL" is the target. The measurements are displayed in the same format as in RTRV-CTR.
RTRV-SP-CTR: <target>
< | |
This MML command retrieves all measurements for SP023.
mml> RTRV-SP-CTR:SP023
None, returns a result code when successfully completed.
None
This MML command resets a cage card.
SET-EQPT-STATE: <target>:<state>
<target> | |
<state> | IS, OOS, or RESET (RESET is ignored in this release). |
This MML command sets card C0041 to Out-of-Service.
mml> SET-EQPT-STATE:C0041:OOS
None, returns a completion status when successfully completed.
None
This MML command starts and stops logging into a diagnostics log.
diaglog:<full file name>:{START|STOP}
This MML command sets card C0041 to Out-of-Service.
mml> diaglog:mml.log:START
None - returns a completion status when successfully completed.
None
This MML command retrieves information about destinations.
<dest id>:=<pc id>|<sigpath id>
Enter the Destination ID, its associated destination point code ID, and signal path ID.
This MML command request to retrieve the route for a specific destination point code ID.
000.028.003 = destination ID PC-002 = destination point code ID SP-01 = signal path ID
M RTRV 000.028.003:PKG=SS7,ASSOC=000.028.003:IS
<dest id>:PKG=<protocol>,ASSOC=<dest id>,<state>
None
None
This MML command retrieves attributes for destination point codes.
rtrv-spc:{<dpc id>|all}
Enter the destination point code ID and the all argument.
This MML command initiates a request to retrieve the route for a specific destination point code ID.
rtrv-spc: all
all= <argument>
mml> rtrv-sp:all TransPath System: TransPath System2 1998-01-21 17:37:03 M RTRV PC-002:DPC=000.028.002,DNW=0:OPC=000.028.007:IS PC-003:DPC=000.028.003,DNW=0:OPC=000.028.008:OOS
None
None
This MML command retrieves all routes to a destination point code.
rtrv-rte{<dpc id>}
Displays the route of the destination point code.
This MML command initiates a request to retrieve the route for a specific destination point code ID.
PC-002 is the destination point code ID.
M RTRV PC-002:LS01,APC=000.028.007,PRIO=1
<dpc id>:<lset id>,<apc num>,<priority>
None
None
This MML command updates customer specific number manipulation tables based on the supplied vnetID.
The user must be a member of TransPath system group in order to have full control over TransPath system operations. If a particular session ID is already in use, then a different session can be selected using the -s option. Upon successful launch of the MML session, you will receive the following MML prompt:
mml>
CHG-DPL:vnetID:TBL=<table>[ ,VER=<version>]
vnetID is the identifier (customer ID), not validated by MML table is the identifier, one of the keywords DigitTree, ResultTable, DigModStrings, All (case sensitive).
Version is a number from 0 to 9 (currently only zero (0) is supported).
CHG-DPL:1005:DigitTree:8
None
None
A TransPath system network element is capable of autonomously producing messages via the MML interface for alerting managers of internal state changes. These messages can be alarm reports of internal failures or informational reports indicating an aberrant event.
These messages follow the Bellcore TL1 autonomous message format.
^^^<site id> <YY-MM-DD> <hh-mm-ss> <severity>^<alm cat> ^^^"<comp>:<params>" ^^^/* <comment> */ ;
The identifiers are to be entered in the following format:
< | TransPath system identification. |
< | Year, month, day of event. |
< | Hour, minute, second of event. |
< | Severity of event. This is a two character indicator with the following meanings: *C Critical alarm ** Major alarm *^ Minor alarm A^ Informational message |
< | Alarm category (type of event being reported). |
< | Component ID upon which the event is being reported. |
< | Supplemental parameters used to further clarify alarm. |
< | Supplemental comment used to indicate cause or appropriate action. |
|
|