Using Cisco Transport Manager GateWay

Overview of CTM GateWay/SNMP

Reference MIBs for Cisco ONS 15303

Reference MIBs for Cisco ONS 15304

Reference MIBs for Cisco ONS 15454

Starting and Stopping CTM GateWay/SNMP

Adding and Deleting a CTM GateWay/SNMP Host

Configuring SNMP for Network Elements

Configuring SNMP for the Cisco ONS 15303 or Cisco ONS 15304

Configuring SNMP for the Cisco ONS 15454

Overview of CTM GateWay/TL1

Using Cisco Transport Manager GateWay

This chapter provides an overview of the physical and logical connectivity to CTM GateWay and describes the Simple Network Management Protocol (SNMP) and Transaction Language One (TL1) commands supported in Release 2.0.

Cisco Transport Manager GateWay:

Is an architectural component that provides northbound EMS-to-NMS interface mediation.
Enables service providers to integrate CTM with their existing Operations Support Systems (OSSs) by using open standard interfaces.

Note In Release 2.0, Cisco offers TL1 (Cisco ONS 15303 and Cisco ONS 15454) and SNMP options for CTM GateWay.

Overview of CTM GateWay/SNMP

CTM GateWay/SNMP forwards SNMP traps to NMS interfaces.

SNMP is a network management protocol used almost exclusively in TCP/IP networks. SNMP lets you monitor and control network devices, manage configurations, collect statistics, check performance, and monitor security.

Note CTM GateWay SNMP reports all SNMP messages in Greenwich Mean Time (GMT).

The CTM GateWay/SNMP service is purely a trap forwarding mechanism. The CTM server acts as a relay station. All traps received by the CTM server are forwarded to each configured SNMP host. The delivery mechanism is UDP/IP, and assumed to be unreliable. However, the Cisco proprietary MIB supports guaranteed trap delivery by using sequential trap numbering. An OSS can detect a lost trap by a gap in the receive trap sequence numbers.

CTM GateWay/SNMP does not support south-bound SNMP relaying---SNMP SET, GET, and GETNEXT.

CTM GateWay/SNMP supports SNMP v1 or v2c for the Cisco ONS 15454 (depending on the NE configuration), and SNMP v1 for the Cisco ONS 1530x.

Reference MIBs for Cisco ONS 15303

Proprietary MIBs:

PAM-CHASSIS-MIB
PAM-SONET-MIB
PAM-DS1-MIB

Reference MIBs for Cisco ONS 15304

Proprietary MIBs:

PAM-CHASSIS-MIB
PAM-SDH-MIB
PAM-E1-MIB

Reference MIBs for Cisco ONS 15454

Standard MIBs:

System RFC 1907
SNMP RFC 1907
DS1 RFC 2495
DS3 RFC 2496
Interfaces RFC 2233
SONET RFC 2558
Bridge RFC 1493
Ether-like RFC 2358
Entity RFC 2037

Proprietary MIBs:

cerentRegistry.mib
cerentTC.mib
cerent454.mib

Figure 3-1 illustrates the CTM GateWay/SNMP communications architecture within a service provider's OSS environment.

Figure 3-1: CTM GateWay/SNMP Co mmun ications Architecture

Starting and Stopping CTM GateWay/SNMP

You can start and stop the CTM GateWay/SNMP service from the Server Control Panel window.

Step 1 Log in to the CTM client with administrator privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 Click the GW icon for GateWay/SNMP Service.

Step 4 On the GateWay/SNMP Service panel, click Start to start GateWay/SNMP, or Stop to stop the service.

Note GateWay/SNMP status appears in the Service Status field on the GateWay/SNMP Service panel.

Adding and Deleting a CTM GateWay/SNMP Host

You can configure up to 16 forwarding SNMP hosts for CTM GateWay/SNMP. (No duplication check is enforced.) To add an SNMP host:

Step 1 Start the GateWay/SNMP service.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 Click the GW icon for GateWay/SNMP Service.

Step 4 (Optional) To add an SNMP host:

a. In SNMP Hosts, enter the IP address of the SNMP forwarding host.

b. Click Add.

Step 5 (Optional) To delete an SNMP host:

a. Under SNMP Hosts, select the IP address of the host you want to delete.

b. Click Delete.

Step 6 Repeat Step 4 or Step 5 for each host you want to add or delete; then, click Save.

Configuring SNMP for Networ k Elements

You must configure SNMP for each network element that uses CTM GateWay/SNMP. The following sections provide procedures for configuring SNMP on the Cisco ONS 15303, Cisco ONS 15304, and Cisco ONS 15454. For additional information, refer to the network element user documentation.

Note When configuring SNMP on network elements, make sure that no other SNMP daemon is running on the designated CTM server host.

Configuring SNMP for the Cisco ONS 15303 or Cisco ONS 15304

Step 1 Log in to the Cisco ONS 15303 or Cisco ONS 15304 and enter configuration mode:

configure terminal

Step 2 At the prompt, enter the following commands:

snmp-server community public RW
snmp-server host CTM server IP address public
snmp-server packetsize 8192

Step 3 If the CTM server is connected on the Cisco ONS 15303 or Cisco ONS 15304 management port, set up an additional access list:

access-list 1 permit CTM server IP address

Configuring SNMP for the Cisco ONS 15454

Step 1 Log in to the Cisco Transport Controller (CTC).

Step 2 Choose Provisioning > SNMP > Create.

Step 3 Enter the following information:

IP Address: CTM server IP address
Community Name: public
UDP Port: 162
Trap Version: SNMPv1 or SNMPv2c
Max Traps per Second: 100

Step 4 Click OK.

Overview of CTM GateWay/TL1

CTM GateWay provides EMS-to-NMS interface mediation, allowing legacy OSSs to receive native TL1-based alarm, event, and performance monitoring reports from CTM.

TL1 is a standard man-machine language (MML) developed by Telcordia Technologies (formerly Bellcore) in the mid 1980s as a basis for interoperability across multivendor technologies. In a series of published standards, Telcordia defined the TL1 language and a number of messages specific to technology, such as transport and access NEs. As deployment of TL1-based NEs increased throughout North America, Telcordia and other vendors developed OSS software applications by using TL1 as the NE management protocol.

For Cisco ONS 15303s, the CTM GateWay/TL1 component application converts select SNMP-based traps and commands to a native TL1 format that complies with Telcordia specifications.

For Cisco ONS 15454s, CTM GateWay/TL1 forwards autonomous TL1 messages from the NEs to the OSS, and manages TL1 commands and responses between the OSS and the NEs.

Using CTM GateWay/TL1, service providers can use their existing TL1-based OSSs to manage Cisco ONS 15303 and Cisco ONS 15454 NEs in the CTM management domain without significant interface development.

Note CTM GateWay/TL1 reports all TL1 messages in Greenwich Mean Time (GMT).

Figure 3-2 illustrates the CTM GateWay/TL1 communications architecture within a service provider's OSS environment.

Figure 3-2: CTM GateWay/TL1 Co mmun ications Architecture

Modifying the CTM GateWay/TL1 C onfiguration

You can modify the CTM GateWay/TL1 configuration from the Server Control Panel window.

Set the username and password that OSS clients use to log in to the Cisco ONS 15454s.
Configure the progress frequency, response frequency, and alarm logic for Cisco ONS 15303s.

Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 On the CTM Server tree, click GateWay/TL1 Service.

Step 4 On the Global tab of the GateWay/TL1 property sheet, modify the Cisco ONS 15454 or Cisco ONS 15303 configuration; then, click Save.

Changes take effect immediately. You do not have to restart the CTM server.

Creating an OSS Client Profile

You can create up to four OSS client profiles for CTM GateWay/TL1 sessions with Cisco ONS 15454s. Each OSS profile defines CTM GateWay/TL1 parameters, such as OSS IP address, permissions, listener mode, and domain manager mode.

OSS client profiles are stored in the OSS Client Configuration table. You can view the table by choosing Administration > OSS Client Configuration Table in the Server Control Panel window.

Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 On the CTM Server tree, click GateWay/TL1 Service; then, select the OSS Clients tab.

Step 4 On the New subtab, enter the Cisco ONS 15454 OSS client properties; then, click Save.

A subtab with the new OSS profile name appears.

Creating an Event Forwarding Discriminator Profile

Each OSS client profile can include an event forwarding discriminator (EFD) profile, which allows you to filter the alarms and events that are forwarded to the OSS. CTM is delivered with 12 EFD profiles shown in Table 3-1.

Table 3-1: Even t Forwarding Discriminator Profiles

EFD NAME Event Type Alarm Severity TID AID

Alarm

Event

PM

Critical

Major

Minor

All Pass

X

X

X

X

X

X

All

All

Alarms Only

X

X

X

X

All

All

Events Only

X

n/a

n/a

n/a

All

All

PM Only

X

n/a

n/a

n/a

All

All

Alarms & Events

X

X

X

X

X

All

All

Critrical Alarms Only

X

X

All

All

Major Alarms Only

X

X

All

All

Minor Alarms Only

X

X

All

All

Major & Higher Alarms

X

X

X

All

All

Minor & Higher Alarms

X

X

X

X

All

All

Facility Alarms Only

X

X

X

X

All

Equipment Alarms Only

X

X

X

X

All

EFD NAME	Event Type	Alarm Severity	TID	AID
	Alarm	Event	PM	Critical	Major	Minor
All Pass	X	X	X	X	X	X	All	All
Alarms Only	X			X	X	X	All	All
Events Only		X		n/a	n/a	n/a	All	All
PM Only			X	n/a	n/a	n/a	All	All
Alarms & Events	X	X		X	X	X	All	All
Critrical Alarms Only	X			X			All	All
Major Alarms Only	X				X		All	All
Minor Alarms Only	X					X	All	All
Major & Higher Alarms	X			X	X		All	All
Minor & Higher Alarms	X			X	X	X	All	All
Facility Alarms Only	X			X	X	X	All
Equipment Alarms Only	X			X	X	X	All

Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 On the CTM Server tree, click GateWay/TL1 Service; then, select the OSS Clients tab.

EFD profiles are stored in the Event Forwarding Discriminator table. You can view the table by choosing Administration > EFD Table in the Server Control Panel window.

CTM GateWay/TL1 and O SS Connectivity

Connectivity between the OSS and CTM GateWay/TL1 is achieved by establishing a direct TCP/IP connection to the CTM server---by using Telnet, for example---and addressing the specific CTM GateWay/TL1 port. To enable this connection, start the CTM GateWay/TL1 service on the CTM server.

The CTM GateWay/TL1 port, either OSS-PORT or OSS-MUX, is assigned a unique number within the UNIX environment.

For Cisco ONS 15454 NEs, the number is:

: oss-port = 26715

For Cisco ONS 15303s, the number is:

: oss-mux = 26713

CTM GateWay/TL1 allows the OSS to connect to all NEs in the CTM management domain by using one TCP/IP socket connection. After establishing the socket connection---by using Telnet, for example---the OSS sends an ACT-USER TL1 command to log in to each NE as identified by its target identifier (TID). The TID is used to multiplex the single logical connection to the actual NEs managed by CTM.

The OSS-PORT and OSS-MUX ports support one logical connection per OSS. Each Cisco ONS 15303 or Cisco ONS 15454 can support up to four concurrent sessions.

To verify connectivity to the CTM server, the OSS can use a UNIX ping command to the CTM server's IP address. (If Domain Manager Mode is enabled, the OSS can also verify connectivity by issuing a RTRV-HDR command.) However, connectivity between the OSS and the CTM server does not guarantee that the CTM GateWay/TL1 service is operational. Assuming that the CTM GateWay/TL1 service is started, the OSS should also monitor the state of the TCP/IP port socket connection because it reflects the operational state of the CTM GateWay/TL1 service.

Connectivity Between the OSS and the NE

The OSS does not connect directly to a Cisco ONS 15303 or Cisco ONS 15454; rather, CTM acts as an agent to the OSS (manager) transparently. The OSS establishes a logical connection with CTM through the CTM GateWay/TL1 port and inherits connectivity with the entire NE management domain.

The OSS can monitor the connectivity state of each NE by using the RTRV-HDR TL1 command. This assumes that connectivity between the OSS and CTM is established. If the NE is available, a normal response is returned. If there is no response, communication with the target NE is lost.

Note The connectivity state between the OSS and CTM and the operational state of the CTM GateWay/TL1 service must be known before interpreting a nonresponse from a Cisco ONS 15303 or Cisco ONS 15454 as a loss of communication.

What Happens After Logging In to the NE?

After establishing a TCP/IP socket connection with CTM by using the CTM GateWay/TL1 port, the OSS sends an ACT-USER TL1 command to log in to each Cisco ONS 15303 or Cisco ONS 15454 as identified by its TID. To log in to an NE, the OSS must use a previously-configured username and password.

For information on configuring the Cisco ONS 15303, refer to the Cisco Optical Networking System 15303 Software Configuration Guide.

For information on configuring the Cisco ONS 15454, refer to the Cisco ONS 15454 User Documentation.

The NE authenticates the user ID (UID) and private identifier (PID), or password, passed within the ACT-USER command string. After the OSS logs in, all NE autonomous message reporting supported by CTM GateWay/TL1 is enabled by default as indicated by the Alarm Logic configuration parameter setting.

Command Rejection and Processing

If CTM GateWay/TL1 receives an invalid or unauthorized command, it returns a deny (DENY) response and associated error code to the OSS. After receiving a command, CTM GateWay/TL1 forwards a completed (COMPLD) response to the OSS. CTM GateWay/TL1 sends an in-progress (IP) response every two seconds until the command is processed and a COMPLD response is forwarded. For Cisco ONS 15303s, you can adjust the IP frequency by using the Progress Frequency parameter on the Server Control Panel's CTM GateWay/TL1 property sheet.

N etwork Element Security

To prevent unauthorized CTM GateWay/TL1 port users from gaining knowledge about the CTM management domain, CTM GateWay/TL1 returns a DENY response with no source identifier (SID) in the header. The DENY response with a suppressed SID is sent whenever:

an OSS addresses a Cisco ONS 15303 or Cisco ONS 15454 with which it has not previously established a login session, or,
an OSS passes an invalid or unknown TID.

If the OSS passes the correct TID but uses invalid or incorrect parameters in the ACT-USER command, CTM GateWay/TL1 responds with a standard DENY error message and associated error code.

You can change the default ACT-USER DENY setting so that the SID is not suppressed.

For Cisco ONS 15454s, change the ACT-USER DENY parameter in the OSS client profile from Yes to No. See "Creating an OSS Client Profile" section.
For Cisco ONS 15303s, use a UNIX editor to edit the following line in the file CTMServer.cfg:

: deny-act-user = yes
: By changing the default from yes to no, CTM GateWay/TL1 will not respond to an invalid or incorrect ACT-USER command.

Caution Do not change other parameters in CTMServer.cfg.

Cisco ONS 15303 Response Parameters

As described in the Telcordia Technologies (formerly Bellcore) GR-833-CORE, Issue 2, November 1996 specification, TL1 messages are defined by using positional syntax by default. This means that the value for each TL1 parameter is defined by its position within the message by using colons and commas as delimiters. The default configuration is indicated by the Response Parameters configuration parameter setting.

The following example illustrates a positional-based TL1 alarm message:

ONS1 99-06-01 15:30:45
*  999 REPT ALM ALL
   "T1-1:MN,GP,	NSA,06-01,15-30-40,NEND,RCV,,,:/* DS1 Signal Degrade */"
   "T1-3:MN,GP,NSA,06-01,15-30-40,NEND,RCV,,,:/* DS1 Signal Degrade */"
;

OSSs based on older Telcordia TL1 specifications use name-value pairs syntax. This means that the value for each TL1 parameter is paired with its parameter name within the message. Colons and commas are used as message delimiters.

The following example illustrates a name-value pair-based TL1 alarm message:

ONS1 99-06-01 15:30:45
*  999 REPT ALM ALL
   "T1-1:NFCNCDE=MN,CONDTYPE=GP,SRVEFF=NSA,OCRDAT=06-01,
OCRTM=15-30-40,LOCN=NEND,DIRN=RCV,,,:/* DS1 Signal Degrade */"
   "T1-3:NFCNCDE=MN,CONDTYPE=GP,SRVEFF=NSA,OCRDAT=06-01,
OCRTM=15-30-40,LOCN=NEND,DIRN=RCV,,,:/* DS1 Signal Degrade */"

Domain Manager Mode Commands and Responses

When you enable Domain Manager Mode in the OSS client profile (see the "Creating an OSS Client Profile" section), the OSS can use the following TL1 commands to communicate directly with CTM to gain information about the Cisco ONS 15454s that CTM manages:

ACT-USER
CANC-USER
RTRV-HDR
RTRV-NE

The following section describes the Domain Manager Mode commands in detail. For information about TL1 commands and responses that can be used in CTM GateWay/TL1 sessions with Cisco ONS 15454s, refer to the Cisco ONS 15454 User Documentation.

ACT-USE R

The OSS uses this command to activate (log in) the OSS to CTM.

Table 3-2: ACT-USER - Domain Manager Mode

Syntax Description

Input Format

ACT-USER:<TID>:<UID>:[<CTAG>]::<PID>;
where:

TID is the target identifier of the CTM server to which the command is directed (equivalent to source identifier [SID]): CTM (fixed).

UID is the OSS client user ID that is used to log in to the CTM server. Valid values are OSS, OSS1, OSS2, OSS3, and OSS4.

CTAG is the correlation tag used to correlate command and response messages.

PID is the private identifier, which is the CTM password assigned to the OSS client user ID: ROOT (fixed).

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf /* NOTICE: This is a private computer system. Unauthorized access or use may lead to prosecution. */ cr lf ;
where:

SID is the source identifier of the CTM server generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/"<ERROR TEXT>"/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Note The default error response to an invalid or incorrect TID field is as follows:

cr lf lf ^^^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ;

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

ACT-USER:CTM:OSS:1990::ROOT;
Normal Response

CTM 00-05-01 12:30:45 M 1990 COMPLD /* NOTICE: This is a private computer system. Unauthorized access or use may lead to prosecution. */ ;
Error Response (for a blank PID field)

CTM 00-05-01 12:30:45 M 1990 DENY IPMS ":PRMTR=PID" /* A required parameter is missing from an input command */ ;

CANC-USER

The OSS uses this command to cancel the OSS (log off) CTM session.

Table 3-3: CANC-USER - Domain Manager Mode

Syntax Description

Input Format

CANC-USER:<TID>:<UID>:[<CTAG>];
where:

TID is the target identifier of the CTM server to which the command is directed (equivalent to SID): CTM (fixed).

UID is the OSS client user ID that is used to log in to the CTM server. Valid values are OSS, OSS1, OSS2, OSS3, and OSS4.

CTAG is the correlation tag used to correlate command and response messages.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf ;
where:

SID is the source identifier of the CTM server generating the response message (equivalent to TID): CTM (fixed).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^"<ERROR TEXT>" cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

CANC-USER:CTM:OSS1:1991;
Normal Response

CTM 00-05-01 12:30:45 M 1991 COMPLD ;
Error Response (for user [OSS1] not logged on)

CTM 00-05-01 12:30:45 M 1990 DENY IPNV ":PRMTR=OSS1" /* A simple or compound parameter value appearing in an input command is invalid */ ;

R TRV-HDR

The OSS uses this command to retrieve the target identifier (TID) of the CTM server.

Table 3-4: RTRV-HDR - Domain Manager Mode

Syntax Description

Input Format

RTRV-HDR:<TID>::[<CTAG>];
where:

TID is the target identifier of the CTM server to which the command is directed (equivalent to SID): CTM (fixed).

CTAG is the correlation tag used to correlate command and response messages.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf ;
where:

SID is the source identifier of the CTM server generating the response message (equivalent to TID): CTM (fixed).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^"<ERROR TEXT>" cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

RTRV-HDR:CTM:1992;
Normal Response

CTM 00-05-01 12:30:45 M 1992 COMPLD ;

Error Response (for an invalid command)

CTM 00-05-01 12:30:45 M 1992 DENY ICNV /* The command verb or modifier is invalid */ ;

R TRV-NE

The OSS uses this command to retrieve information about Cisco ONS 15454 network elements managed by CTM.

Table 3-5: RTRV-NE - Domain Manager Mode

Syntax Description

Input Format

RTRV-NE:<TID>::[<CTAG>];
where:

TID is the target identifier of the CTM server to which the command is directed (equivalent to SID): CTM (fixed).

CTAG is the correlation tag used to correlate command and response messages.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME>^ cr lf M^^<CTAG>^COMPLD cr lf <RSPBLK>^+;
where:

SID is the source identifier of the CTM server generating the response (equivalent to TID): CTM (fixed).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

RSPBLK is the response block.

Note The message may contain zero or more occurrences of the response block, which has the following format:

^^^"<NEID>:<NEMOD>,<OPRNST>,<COMMST>,<ALMCNT>" cr lf
where:

NEID is the NE identifier equivalent to the source identifier (SID) of the NE managed by CTM.

NEMOD is the NE model of the NE managed by CTM: CISCO-ONS-15454.

OPRNST is the operational state of the NE managed by CTM. Valid values are IS and OOS.

COMMST is the communication state of the NE managed by CTM. Valid values are UNAVAIL and AVAIL.

ALMCNT is the total alarm count associated with all severity alarms that affect the NEs managed by CTM. The format is:

<{# of CR}-{# of MJ}-{# of MN}>

where:

CR = critical alarms, MJ = major alarms, and MN = minor alarms.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

RTRV-NE:CTM::1993;
Normal Response

CTM 00-05-01 12:30:45 M 1993^COMPLD "ONS1:CISCO-ONS-15454,IS,UNAVAIL,2-4-6" "ONS2:CISCO-ONS-15454,IS,AVAIL,3-5-7" ;
Error Response (for an invalid command)

CTM 00-05-01 12:30:45 M 1992 DENY ICNV /* The command verb or modifier is invalid */ ;

Cisco ONS 15303 TL1 Commands and Responses

CTM GateWay/TL1 Release 2.0 supports the following TL1 commands for the Cisco ONS 15303:

ACT-USER
ALW-MSG
CANC-USER
INH-MSG
RTRV-ALM
RTRV-HDR
RTRV-PM
SCHED-PMREPT

The following sections describe each TL1 command in detail.

ACT-USE R

Use this command to activate (log in) the user to the Cisco ONS 15303.

Table 3-6: ACT-USER

Syntax Description

Input Format

ACT-USER:<TID>:<UID>:[<CTAG>]::<PID>;
where:

TID is the target identifier of the NE to which the command is directed (equivalent to source identifier [SID]).

UID is the user ID that is used to log in to the NE.

CTAG is the correlation tag used to correlate command and response messages.

PID is the private identifier, which is the NE password assigned to the user ID.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf /* NOTICE: This is a private computer system. Unauthorized access or use may lead to prosecution. */ cr lf ;
where:

SID is the source identifier of the NE generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Note The default error response to an invalid or incorrect TID field is as follows:

cr lf lf ^^^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

ACT-USER:ONS1:SCOTT:1970::ROOT;
Normal Response

ONS1 99-07-20 12:30:45 M 1970 COMPLD /* NOTICE: This is a private computer system. Unauthorized access or use may lead to prosecution. */ ;
Error Response (for a blank PID field)

ONS1 99-07-20 12:30:45 M 1970 DENY IPMS ":PRMTR=PID" /* A required parameter is missing from an input command */ ;

ALW-M SG

Use this command to allow autonomous alarm and event message reporting.

Table 3-7: ALW-MSG

Syntax Description

Input Format

ALW-MSG-{EQPT | T1 | VT1 | STS1 | OC3 | ENET | ALL}: <TID>:[<AID>]:<CTAG>::[<NFCNCDE>];
where:

TID is the target identifier of the NE to which the command is directed (equivalent to SID).

AID is the access identifier that identifies an entity to which the command applies.

CTAG is the correlation tag used to correlate command and response messages.

NFCNCDE is the two-character notification code associated with a single alarm condition.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf ;
where:

SID is the source identifier of the NE generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

ALW-MSG-T1:ONS1:T1-1:1928::;
Normal Response

ONS1 99-03-31 18:40:15 M 1928 COMPLD ;
Error Response (for an invalid NFCNCDE field)

ONS1 99-03-31 18:40:15 M 1928 DENY IPNV ":PRMTR=NFCNCDE" /* A parameter name appearing in an input command is not valid */ ;

CANC-US ER

Use this command to cancel the user (log off) session.

Table 3-8: CANC-USER

Syntax Description

Input Format

CANC-USER:<TID>:<UID>:[<CTAG>];
where:

TID is the target identifier of the NE to which the command is directed (equivalent to SID).

UID is the user ID that is used to log in to the NE.

CTAG is the correlation tag used to correlate command and response messages.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf ;
where:

SID is the source identifier of the NE generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

CANC-USER:ONS1:JORDAN:1990;
Normal Response

ONS1 99-08-28 12:30:45 M 1990 COMPLD ;
Error Response (for user [Jordan] not logged on)

ONS1 99-08-28 12:30:45 M 1990 DENY IPNV ":PRMTR=JORDAN" /* A simple or compound parameter value appearing in an input command is invalid */ ;

INH-MS G

Use this command to inhibit autonomous alarm and event message reporting.

Table 3-9: INH-MSG

Syntax Description

Input Format

INH-MSG-{EQPT | T1 | VT1 | STS1 | OC3 | ENET | ALL}: <TID>:[<AID>]:<CTAG>::[<NFCNCDE>];
where:

TID is the target identifier of the NE to which the command is directed (equivalent to SID).

AID is the access identifier that identifies an entity to which the command applies.

CTAG is the correlation tag used to correlate command and response messages.

NFCNCDE is the two-character notification code associated with a single alarm condition.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf ;
where:

SID is the source identifier of the NE generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

INH-MSG-OC3:ONS1:OC3/A:1961::;
Normal Response

ONS1 99-06-30 19:30:15 M 1961 COMPLD ;
Error Response (for an AID type [for example, T1-1] that does not match MODIFIER2 [for example, OC3])

ONS1 99-06-30 19:30:15 M 1961 DENY IPNC ":PRMTR=INH-MSG-OC3&T1-1" /* Two valid parameter names appearing in an input command are mutually exclusive with each other */ ;

RTRV-AL M

Use this command to retrieve existing alarm messages.

Table 3-10: RTRV-ALM

Syntax Description

Input Format

RTRV-ALM-{EQPT | T1 | VT1 | STS1 | OC3 | ENET | ALL}: <TID>:[<AID>]:<CTAG>::[<NFCNCDE>],,[<SRVEFF>];
where:

TID is the target identifier of the NE to which the command is directed (equivalent to SID).

AID is the access identifier that identifies an entity to which the command applies.

CTAG is the correlation tag used to correlate command and response messages.

NFCNCDE is the two-character notification code associated with a single alarm condition.

SRVEFF is the service-affecting code that indicates the effect on service caused by the alarm condition.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^1^COMPLD cr lf <RSPBLK> + ;
where:

SID is the source identifier of the NE generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

RSPBLK is the response block.

Normal Response (continued)

Note The message may contain zero or more occurrences of the response block, which has the following format:

^^^"<AID>:<NFCNCDE>,<CONDTYPE>,<SRVEFF>,<OCRDAT>,<OCRTM>,<LOCN>,<DIRN>: /*<CONDDESCR>*/" cr lf
where:

AID is the access identifier that identifies an entity to which the command applies.

NFCNCDE is the two-character notification code associated with a single alarm condition.

SRVEFF is the service-affecting code that indicates the effect on service caused by the alarm condition.

OCRDAT is the date when the specific alarm condition occurred in MOY-DOM format.

OCRTM is the time of day when the specific alarm condition occurred in HOD-MOH format.

LOCN is the location where the monitored parameter originates, and refers to the entity identified by the AID.

DIRN is the direction to which the monitored parameter applies, and is relative to the entity identified by the AID.

CONDDESCR is the detailed text description of the condition.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

RTRV-ALM-ALL:ONS1::1931::,,;
Normal Response

ONS1 11-22-99 15:45:30 M 1931 COMPLD "OC3/B:MJ,LOS,NSA,11-22,15-36-01,,:/* OCN Loss of Signal */" "STS1-2/A:MJ,RFI-P,NSA,11-22,15-36-01,,:/* Path Remote Failure Indication */" "STS1-3/A:MJ,RFI-P,NSA,11-22,15-36-01,,:/* Path Remote Failure Indication */" "CHASSIS:MN,SYNCSEC,NSA,11-22,15-36-01,,:/* Secondary Reference Failed */" ;
Error Response (for an AID type [for example, T1-1] that does not match MODIFIER2 [for example, OC3])

ONS1 99-06-30 19:30:15 M 1961 DENY IPNC ":PRMTR=INH-MSG-OC3&AID" /* Two valid parameter names appearing in an input command are mutually exclusive with each other */ ;

RTRV-HD R

Use this command to retrieve the target identifier (TID) of the NE.

Table 3-11: RTRV-HDR

Syntax Description

Input Format

RTRV-HDR:<TID>::[<CTAG>];
where:

TID is the target identifier of the NE to which the command is directed (equivalent to SID).

CTAG is the correlation tag used to correlate command and response messages.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf ;
where:

SID is the source identifier of the NE generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

RTRV-HDR:ONS1::1973;
Normal Response

ONS1 99-07-20 12:30:45 M 1973 COMPLD ;
Error Response (for an invalid command)

ONS1 99-07-20 12:30:45 M 1973 DENY ICNV /* The command verb or modifier is invalid */ ;

RTRV-P M

Use this command to retrieve performance monitoring (PM) data.

Table 3-12: RTRV-PM

Syntax Description

Input Format

RTRV-PM-{T1 | VT1 | STS1 | OC3 | ALL}: <TID>:[<AID>]:<CTAG>::,,,,[<TMPER>],[<MONDAT>],[<MONTM>];
where:

TID is the target identifier of the NE to which the command is directed (equivalent to SID).

AID is the access identifier that identifies an entity to which the command applies.

CTAG is the correlation tag used to correlate command and response messages.

TMPER is the accumulation time period for the PM information.

MONDAT is the start date of the PM collection period in MOY-DOM format.

MONTM is the start time of the PM collection period in HOD-MOH format.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf <RSPBLK> + ;
where:

SID is the source identifier of the NE generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

RSPBLK is the response block.

Normal Response (continued)

Note The message may contain zero or more occurrences of the response block, which has the following format:

^^^"<AID>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER>,<MONDAT>, <MONTM>" cr lf
where:

AID is the access identifier that identifies an entity to which the command applies.

MONTYPE is the type of monitored parameter whose value is being requested or reported.

MONVAL is the measured value of the monitored parameter.

VLDTY is the validity for historical monitoring information, which indicates whether the information for the specified time period was accumulated over the entire time period or during a portion of the time period.

LOCN is the location where the monitored parameter originates, and refers to the entity identified by the AID.

DIRN is the direction to which the monitored parameter applies, and is relative to the entity identified by the AID.

TMPER is the accumulation time period for the PM information.

MONDAT is the start date of the PM collection period in MOY-DOM format.

MONTM is the start time of the PM collection period in HOD-MOH format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

RTRV-PM-OC3:ONS1:OC3/A:1961::;
Normal Response

ONS1 99-10-06 22:35:15 M 1961 COMPLD "OC3/A:ESS,0,,NEND,RCV,15-MIN,10-06,22-30-00" "OC3/A:SESS,0,,NEND,RCV,15-MIN,10-06,22-30-00" "OC3/A:SEFS-S,0,,NEND,RCV,15-MIN,10-06,22-30-00" "OC3/A:CVS,0,,NEND,RCV,15-MIN,10-06,22-30-00" ;
Error Response (for an invalid or unknown AID)

ONS1 99-10-06 12:35:15 M 1961 DENY IPNV ":PRMTR=AID" /* A parameter name appearing in an input command is not valid */ ;

SCHED-PMREP T

Use this command to schedule PM reporting.

Table 3-13: SCHED-PMREPT

Syntax Description

Input Format

SCHED-PMREPT-{T1 | VT1 | STS1 | OC3 | ALL}: <TID>:[<AID>]:<CTAG>::[<REPTINVL>],[<REPTSTATM>], [<NUMREPT>];
where:

TID is the target identifier of the NE to which the command is directed (equivalent to SID).

AID is the access identifier that identifies an entity to which the command applies.

CTAG is the correlation tag used to correlate command and response messages.

REPTINVL specifies how often a PM report will be generated and forwarded.

REPTSTATM is the starting time for the PM reporting schedule in HOD-MOH format.

NUMREPT is the number of PM reports that the schedule is expected to produce.

Note Only one PM reporting schedule is supported per NE.

Normal Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^COMPLD cr lf ;
where:

SID is the source identifier of the NE generating the response message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

Error Response

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf M^^<CTAG>^DENY cr lf ^^^<ERRCDE> cr lf ^^^"<ERROR DESCRIPTION>" cr lf ^^^/*<ERROR TEXT>*/ cr lf ;
where:

ERRCDE is the error code associated with the error response. See Table 3-18 for valid values.

ERROR DESCRIPTION is the supporting information for the error code (when applicable).

ERROR TEXT is the detailed text description of the condition.

Progress Response

IP^<CTAG>

Note If a normal or error response cannot be sent within two seconds of receiving an input command, the above in-progress (IP) acknowledgement is sent every two seconds until the processing is complete.

Example

Command

SCHED-PMREPT-OC3:ONS1:ONS-ALL:1997::30-MIN,12-00;
Normal Response

ONS1 99-07-29 12:30:45 M 1997 COMPLD ;
Error Response (for a memory allocation error)

ONS1 99-07-29 12:30:45 M 1997 DENY SSRE /* The execution of an action requested by an input command was aborted due to limitation of system resources */ ;

Cisco ONS 15303 TL1 Report s

CTM GateWay/TL1 Release 2.0 supports the following autonomous TL1 reports:

REPT ALM
REPT EVT
REPT PM

The following sections describe each report in detail.

REPT AL M

CTM GateWay/TL1 generates the report alarm message to report the occurrence of an alarmed NE event.

Table 3-14: REPT ALM

Report Format

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf <ALMCDE>^<ATAG>^REPT^ALM^{EQPT | T1 | VT1 | STS1 | OC3 | ENET | ALL} cr lf <RSPBLK> + ;
where:

SID is the source identifier of the NE generating the autonomous message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

ALMCDE is the alarm code that identifies the severity of the autonomous message.

ATAG is the automatic tag that is used to sequence autonomous messages.

RSPBLK is the response block.

Note The message must contain at least one occurrence of the response block, which has the following format sorted according to severity:

^^^"<AID>:<NFCNCDE>,<CONDTYPE>,<SRVEFF>,<OCRDAT>,<OCRTM>,<LOCN>,<DIRN>,,,: /*<CONDDESCR>*/" cr lf

where

AID is the access identifier that identifies an entity to which the command applies.

NFCNCDE is the two-character notification code associated with a single alarm condition.

CONDTYPE is the single type of condition being reported.

SRVEFF is the service-affecting code that indicates the effect on service caused by the alarm condition.

OCRDAT is the date when the specific alarm condition occurred in MOY-DOM format.

OCRTM is the time of day when the specific alarm condition occurred in HOD-MOH format.

LOCN is the location where the monitored parameter originates, and refers to the entity identified by the AID.

DIRN is the direction to which the monitored parameter applies, and is relative to the entity identified by the AID.

CONDDESCR is the detailed text description of the condition.

Example:

ONS1 99-06-30 12:30:45 *C 1691 REPT ALM OC3 "OC3/B:CR,LOS,SA,06-30,12-30-30,NEND,RCV,,,:/* OCN Loss of Signal */"
;

REPT EV T

CTM GateWay/TL1 generates the report event message to report the occurrence of a nonalarmed NE event.

Table 3-15: REPT EVT

Report Format

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf A^<ATAG>^REPT^EVT^{EQPT | T1 | VT1 | STS1 | OC3 | ENET | ALL} cr lf <RSPBLK> + ;
where:

SID is the source identifier of the NE generating the autonomous message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

ATAG is the automatic tag that is used to sequence autonomous messages.

RSPBLK is the response block.

Note The message must contain at least one occurrence of the response block, which has the following format:

^^^"<AID>:<CONDTYPE>,<CONDEFF>,<OCRDAT>,<OCRTM>,<LOCN>,<DIRN>, <MONVAL>,<THLEV>,<TMPER>:/*<CONDDESCR>*/" cr lf
where:

AID is the access identifier that identifies an entity to which the command applies.

CONDTYPE is the single type of condition being reported.

CONDEFF is the condition-affecting code associated with the autonomous message.

OCRDAT is the date when the specific alarm condition occurred in MOY-DOM format.

OCRTM is the time of day when the specific alarm condition occurred in HOD-MOH format.

LOCN is the location where the monitored parameter originates, and refers to the entity identified by the AID.

DIRN is the direction to which the monitored parameter applies, and is relative to the entity identified by the AID.

MONVAL is the measured value of the monitored parameter.

THLEV is the threshold level for the monitored parameter specified in CONDTYPE.

TMPER is the accumulation time period for the PM information.

CONDDESCR is the detailed text description of the condition.

Example:

ONS1 99-07-29 11:45:30 A 1961 REPT EVT T1 "T1-1:ESP,TC,07-29,11-45-25,NEND,,12,12,15-MIN:/* DS1 ES-P */"
;

REPT P M

CTM GateWay generates the report PM message to report the scheduled PM data collection results at the completion of an NE monitoring period.

Table 3-16: REPT PM

Report Format

cr lf lf ^^^<SID>^<DATE>^<TIME> cr lf A^<ATAG>^REPT^PM^{T1 | VT1 | STS1 | OC3 | ALL} cr lf <RSPBLK> + ;
where:

SID is the source identifier of the NE generating the autonomous message (equivalent to TID).

DATE is the current date in YY-MM-DD format.

TIME is the current time in HH:MM:SS format.

ATAG is the automatic tag that is used to sequence autonomous messages.

RSPBLK is the response block.

Note The message must contain at least one occurrence of the response block, which has the following format:

^^^"<AID>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER>,<MONDAT>, <MONTM>" cr lf

where:

AID is the access identifier that identifies an entity to which the command applies.

MONTYPE is the type of monitored parameter whose value is being requested or reported.

MONVAL is the measured value of the monitored parameter.

VLDTY is the validity for historical monitoring information, which indicates whether the information for the specified time period was accumulated over the entire time period or during a portion of the time period.

LOCN is the location where the monitored parameter originates, and refers to the entity identified by the AID.

DIRN is the direction to which the monitored parameter applies, and is relative to the entity identified by the AID.

TMPER is the accumulation time period for the PM information.

MONDAT is the start date of the PM collection period in MOY-DOM format.

MONTM is the start time of the PM collection period in HOD-MOH format.

Example:

ONS1 99-08-28 10:15:30 A 1619 REPT PM OC3 "OC3/A:ESS,0,,NEND,RCV,15-MIN,08-28,10-00-00" ;

TL1 Suppo rt Information

The following sections provide general TL1 support information for CTM GateWay/TL1. For information about Cisco ONS 15303 or Cisco ONS 15454 TL1 command usage, refer to that product's user documentation.

TL1 Command S ymbols

Table 3-17 outlines the conventions and notations used with TL1 specifications.

Table 3-17: TL1 Conventions and Not ations

Symbol Description

cr

A carriage return in American Standard Code for Information Interchange (ASCII).

lf

A line feed in ASCII.

^

A caret indicates that a blank must appear in the message.

Note For readability, some symbols are proceeded or followed by blank spaces rather than a caret. The blank spaces are not part of the message.

[ ]

One or more parameters enclosed within brackets indicates the parameters are optional. If a user enters an empty field (null) for an optional parameter, a default value is automatically substituted in the input field.

{ | }

A list of two or more parameters enclosed within braces { } and separated by a vertical bar ( | ) indicates that one (and only one) of the parameters must be selected from the list.

< >

Angle brackets enclose one or more parameters for which a value must be entered on the command line. The brackets are not transmitted.

+

A plus sign is a post-fix operator that indicates the proceeding symbol or group of symbols (enclosed in parentheses) may occur one or more times.

;

A semicolon marks the end of a message.

" "

A pair of quotation marks in format expressions is used to delimit an expression that can be parsed.

/* */

A pair of characters /* and */ is used to delimit free form text.

*

An asterisk indicates that the preceding symbol may occur zero or more times.

,

A comma separates parameters within a parameter block.

:

A colon separates parameter blocks within a command line.

\" \"

Escape quotes enclose user-defined messages.

<

The left angle bracket is the ready indicator used in a response to show that the target system is ready to accept new input.

>

The right angle bracket is the end of output character used to indicate that more data associated with the response will follow.

&

The grouping symbol & allows a group of values to be entered for a single parameter. The access identifier prefix (that is, T1-<1-8>) must be specified each time.

Example: T1-1&T1-5 equals "T1 Number 1 and Number 5."

&-

The grouping symbols &- allow a group of values to be entered for a single parameter. The access identifier prefix (that is, T1-<1-8>) is assumed to be the same type as the previous access identifier prefix type and must not be repeated each time.

Example: T1-1&5 equals "T1 Number 1 and Number 5."

&&

The ranging symbols && allow a range of values to be specified for a single parameter. The access identifier prefix (that is, T1-<1-8>) must be repeated each time in ascending order.

Example: T1-1&&T1-5 equals "T1 Number 1 through Number 5."

&&-

The ranging symbols && allow a range of values to be specified for a single parameter. The access identifier prefix (that is, T1-<1-8>) is assumed to be the same type as the previous access identifier prefix type and must not be repeated each time in ascending order.

Example: T1-1&&-5 equals "T1 Number 1 through Number 5."

Note Grouping and ranging symbols can be used an unlimited number of times, provided the overall description of the parameter specified in the TL1 command is less than 64 characters in length.

Error Cod es

Table 3-18 identifies the error codes that may be used in TL1 command responses.

Table 3-18: TL1 Error Codes

Error Code Definition Description

GNRN

Gateway not ready for network element

CTM GateWay/TL1 is not ready for the network element.

ICNV

Input, command not valid

The command verb or modifier is invalid.

IDNV

Input, data not valid

A simple or compound parameter value appearing in an input command is invalid.

IICM

Input, invalid command

Invalid command.

IICT

Invalid correlation tag

Invalid correlation tag.

IITA

Input, invalid TID

Invalid target identifier.

INUP

Invalid AID block

Invalid parameters length.

IDNV

Input, data not valid

Input data is not valid.

IPMS

Input, parameter missing

A required parameter is missing from an input command.

IPNC

Input, parameter not consistent

Two valid parameter names appearing in an input command are mutually exclusive.

Note The ACT-USER, CANC-USER, and RTRV-HDR commands do not support this error code.

IPNV

Input, parameter not valid

A parameter name appearing in an input command is not valid.

PLNA

Privileged login not active

Privileged login is not active.

SSRE

System resources exceeded

An action requested by an input command was canceled due to limited system resources.

SSTP

System stopped

An action requested by an input command was canceled due to limited system resources.

Cisco ONS 15303 TL1 Sup port Information

The following sections provide TL1 support information for the Cisco ONS 15303.

Access Identifiers

Three types of access identifiers pertain to the Cisco ONS 15303 NE:

Equipment access identifier
Facility access identifier
Internal facility access identifier

Table 3-19 provides a list of Cisco ONS 15303 equipment access identifiers.

Table 3-19: NE Equipment Access Identifiers

AID Mnemonics Description

CHASSIS

The chassis itself.

Note This access identifier is used by default when no other access identifier is appropriate for autonomous messages.

FAN_TRAY

The field-replaceable unit containing the fans.

FAN-<1-3>

A specific fan (for example, FAN-2).

FUSE/<A,B>

One of the two fuses (for example, FUSE/A).

SAM/<A,B>

The SONET Access Module (SAM) (for example, SAM/A).

Note No ranging is allowed for equipment access identifiers.

Table 3-20 provides a list of Cisco ONS 15303 facility access identifiers.

Table 3-20: NE Facility Access Identifiers

AID Mnemonics Description

ENET-<1-8>

The externally-connected Ethernet ports (for example, ENET-5).

OC3/<A,B>

The OC-3 access identifier (for example, OC3/A).

T1-<1-8>

The externally-connected T1 lines (for example, T1-7).

STS1-<1-3>/<A,B>

The STS-1 access identifier (for example, STS1-1/A).

VT1-<1-3>-<1-7>-<1-4>/<A,B>

The virtual tributary. The format is VT1-<STS#>-<VT_Group#>-VT/A or B (for example, VT1-1-6-3/A).

Table 3-21 provides a list of Cisco ONS 15303 internal facility access identifiers.

Table 3-21: NE Internal Facility Access Identifiers

AID Mnemonics Description

DS1-<1-24>

The internally-connected serial DS-1 ports that connect Ethernet ports to VTs (for example, DS-1-22).

Note If the cross-connection between the DS-1 and a given Ethernet port can be found, the alarm is reported against the Ethernet port.

MLPPP-<1-8>

The internally-connected multilink point-to-point protocol ports that connect Ethernet ports to VTs (for example, MLPPP-4).

Note If the cross-connection between the PPP and Ethernet ports can be found, the alarm is reported against the Ethernet port.

PPP-<1-24>

The internally-connected point-to-point protocol ports that connect Ethernet ports to VTs (for example, PPP-3).

Note If a cross-connection between the PPP and Ethernet ports can be found, the alarm is reported against the Ethernet port.

Note Internal facility access identifiers cannot be addressed by any CTM GateWay commands.

Condition Type Descriptions

Table 3-22 lists the different condition types in alphabetical order by access identifier.

Table 3-22: Condition Type Descript ions

AID Type Condition Type Condition Description

CHASSIS

ACOIMED

Alarm Cut Off Activated

AUTORESET

System Restarted

CONTBUS

Backplane Parity Error

CONTR

SAM Card Failed

CHASSIS

DATAFLT

Config DB Corrupted

DB Sync Failed

EOC

DCC Failure

EXTERR

Site Alarm 1

Site Alarm 2

FA

Fuse Failure

FRNGSYNC

Sync In Free Run

GP

Authentication Failure

Link Down (only applicable to the ENET-0 port)

Link UP (only applicable to the ENET-0 port)

SAM Card Inserted

SAM Card System ID Mismatch

Software Version Out-of-Sync between SAMs

System Alarm Detection Inhibited

HLDOVRSYNC

Sync In HoldOver

IMPROPRMVL

In Service SAM Card Removed

INHMSG

System Alarm Report Inhibited

INTERR

Ethernet Link Dropped

Fan Tray Removed

I/O Card Failed

MLPPP Signal Degrade

MLPPP Signal Failure

Multiple Fans Failed

One Fan Failed

Overheated

CHASSIS

INTERR

PPP Signal Failure

INTSFT

SAM Inter-Process Communication Failure

PROTNA

Protected SAM Card Not Equipped

PWR

Fan Power Failed

PWRRESTART

Cold Start

REPLUNITMISS

SAM Card Removed

SWTOINT

Sync Switched to Intermediate

SWTOPRI

Sync Switched to Primary

SWTOSEC

Sync Switched to Secondary

SYNCEQPT

Sync Hardware Failed

SYNCPRI

Primary Reference Failed

SYNCSEC

Secondary Reference Failed

SYNCSTATCHNG

SSM Switched to Primary

SSM Switched to Secondary

SYSBOOT

Warm Start

WKSWBK

SAM Switched to Side A

WKSWPR-1

SAM Switched to Side B

ENET

GP

Link Down

Link UP

OC3

AIS

Alarm Indication Signal

APSB

Protection Switch Byte Failed

APSCM

Channel Mismatch

APSMM

Mode Mismatch

FEPRLF

Far End Protection Failure

FRCDWKSWBK

Forced Switch

GP

Loss of Traffic

OC3

GP

Signal Degrade

INT

Hardware Failure

LOCKOUTOFPR

Lockout

LOF

Loss of Frame

LOS

Loss of Signal

LPBKFACILITY

Loopback

RFI

Remote Failure Indication

SFI

Signal Failure

WKSWPR

APS Switched to Protection

STS

AIS-P

Alarm Indication Signal

FACTERM

Hardware Failure

GP

Signal Degrade

LOP-P

Loss of Pointer

LPBKFACILITY

Loopback

PLM-P

Signal Label Mismatch

RFI-P

Remote Failure Indication

SFI

Signal Failure

TIM-P

Trace Identifier Mismatch

UNEQ-P

Unequipped

T1

AIS

Alarm Indication Signal

GP

Signal Degrade

LINETERM

Hardware Failure

LOF

Loss of Frame

LOS

Loss of Signal

LPBKLINE

Loopback

OSILINKERR

Data Link Failure

RFI

Remote Failure Indication

T1

SFI

Signal Failure

TRMT

Transmit Failure

TSA

Test

VT

AIS-V

Alarm Indication Signal

FACTERM

Hardware Failure

FRCDWKSWBK

VT Forced Switch

GP

Signal Degrade

VT Cross-Connect Loss of Traffic

LOCKOUTOFPR

VT Lockout

LOP-V

Loss Of Pointer

LPBKFACILITY

Loopback

MANWKSWBK

VT Manual switch

PLM-V

Signal Label Mismatch

PS

VT on Alternate Path

RFI-V

Remote Failure Indication

SFI

Signal Failure

SWEX

VT Switch Failed

UNEQ-V

Unequipped

WKSWBK

OCN APS Switched from Protection

VT Switched from Alternate

WKSWPR-1

OCN APS Switched from Working

VT Switched from Preferred

Monitored Type Descriptions

Table 3-23 lists the monitored type descriptions in alphabetical order by access identifier.

Table 3-23: Monitored Type Des criptions

AID Type Monitored Type Condition Description

OC3

CV

TCA for CV-S

CVL

TCA for CV-L

ES

TCA for ES-S

ESL

TCA for ES-L

SEFS

TCA for SEFS-S

SES

TCA for SES-S

SESL

TCA for SES-L

UASL

TCA for UAS-L

STS

CV

TCA for CV-P

ES

TCA for ES-P

SES

TCA for SES-P

UAS

TCA for UAS-P

T1

CVL

TCA for CV-L

CVP

TCA for CV-P (CRC-6)

ESL

TCA for ES-L

ESP

TCA for ES-P

SEFSP

TCA for SEFS-P

SESL

TCA for SES-L

SESP

TCA for SES-P

UASP

TCA for UAS-P

VT

CV

TCA for CV-V

ES

TCA for ES-V

VT

SES

TCA for SES-V

UAS

TCA for UAS-V

Parameter Definitions

Table 3-24 describes the parameter definitions.

Table 3-24: Parameter Definitions

Parameter Possible Values (default in bold text) Description

AID

CHASSIS

ENET

FAN_TRAY

FAN

FUSE

OC3

SAM

STS1

T1

VT1

ONS-ALL

Null

Refer to Table 3-19, Table 3-20, and Table 3-21 for access identifier mnemonics and descriptions. In general, the following rules apply to access identifiers:

When present, the command code modifier (EQPT, T1, VT1, STS1, OC3 ENET) specifies the typical format or type of access identifier.

Use of the command code modifier ALL means the command applies to the NE and all its subunits.

If the command code modifier is one of the allowed modifiers instead of ALL, AID cannot be null. If all units of a particular type need to be addressed, ONS-ALL can be used as a general representation.

The value of AID may be null where explicitly specified:

If the command code modifier is ALL, AID can be null and will default to all units in the NE. AID cannot be null with any other values for the command code modifier.

ALMCDE

*C

**

*^

A^

Critical alarm.

Major alarm.

Minor alarm.

Autonomous message.

ATAG

10 numeric characters

The automatic tag that is used to sequence autonomous alarm and event messages.

CONDDESCR

Character string

The detailed text description of the condition.

CONDEFF

SC

CL

TC

Standing condition.

Cleared condition.

Transient condition.

CONDTYPE

---

Refer to Table 3-22 for values.

CTAG

10 numeric characters

The correlation tag used to correlate command and response messages.

DATE

YY-MM-DD

The current date.

DIRN

TRMT

RCV

Null

Transmit direction only.

Receive direction only.

All applicable directions.

LOCN

NEND

FEND

Null

Near end.

Far end.

All applicable locations.

MONDAT

MOY-DOM

Null

The start date of the PM collection period where month of year (MOY) ranges from 01 to 12 and day of month (DOM) ranges from 01 to 31.

The current date.

MONTM

HOD-MOH

Null

The start time of the PM collection period where hour of day (HOD) ranges from 00 to 23 and minute of hour (MOH) ranges from 00 to 59.

Midnight (00-00).

MONTYPE

---

Refer to Table 3-23 for values.

MONVAL

<0-65535>

The measured value of the monitored parameter.

NFCNCDE

CR

MJ

MN

CL

Critical alarm.

Major alarm.

Minor alarm.

Cleared alarm.

NUMREPT

<0-65535>

Null

The number of PM reports that the schedule is expected to produce. A value of 0 is used to end any PM reporting schedule that was introduced by a previous command. If NUMREPT is null, the NE will initiate PM and remain in that schedule mode until the schedule changes.

Parameter grouping cannot be used with this parameter.

OCRDAT

MOY-DOM

The date when the specific alarm condition occurred.

OCRTM

HOD-MOH

The time of day when the specific alarm condition occurred.

PID

10 ASCII characters

The private identifier, which is the NE password.

REPTINVL

<1-1440>-MIN

<1-24>-HR

<1-31>-DAY

1-HR

Specifies how often a PM report will be generated and forwarded. The value specified should be greater than or equal to the value specified in TMPER within the same command. Minutes are rounded to the previous 15-minute boundary.

REPTSTATM

HOD-MOH

Null

The starting time for the PM reporting schedule where HOD (hour of day) ranges from 00 to 23 and MOH (minute of hour) ranges from 00 to 59.

The current time of day.

Parameter grouping cannot be used with this parameter.

RSPBLK

---

The response block.

SID

20 ASCII characters

The source identifier of the NE.

SRVEFF

SA

NSA

Null

Service-affecting condition; immediate action required.

Non-service-affecting condition; action required.

The effect on service is unknown or the SRVEFF parameter is not used.

When a null value is used in the Input Format with the RTRV-ALM command, alarm conditions for both SA and NSA are retrieved.

THLEV

<0-65535>

The threshold level for the monitored parameter specified in CONDTYPE.

TID

20 ASCII characters

The target identifier of the NE.

TIME

HH:MM:SS

The current time.

TMPER

<1-1440>-MIN

<1-24>-HR

1-DAY

Null

The accumulation time period for the PM information. Minutes are rounded to the previous 15-minute boundary.

Equivalent to 60-MIN or 1-HR.

UID

10 numeric characters

The user ID that is used to log in to the NE.

VLDTY

Null

Not supported.

AID Mnemonics	Description
ENET-<1-8>	The externally-connected Ethernet ports (for example, ENET-5).
OC3/<A,B>	The OC-3 access identifier (for example, OC3/A).
T1-<1-8>	The externally-connected T1 lines (for example, T1-7).
STS1-<1-3>/<A,B>	The STS-1 access identifier (for example, STS1-1/A).
VT1-<1-3>-<1-7>-<1-4>/<A,B>	The virtual tributary. The format is VT1-<STS#>-<VT_Group#>-VT/A or B (for example, VT1-1-6-3/A).

AID Type	Condition Type	Condition Description
CHASSIS	ACOIMED	`Alarm Cut Off Activated`
	AUTORESET	`System Restarted`
	CONTBUS	`Backplane Parity Error`
	CONTR	`SAM Card Failed`
CHASSIS	DATAFLT	`Config DB Corrupted`
		`DB Sync Failed`
	EOC	`DCC Failure`
	EXTERR	`Site Alarm 1`
		`Site Alarm 2`
	FA	`Fuse Failure`
	FRNGSYNC	`Sync In Free Run`
	GP	`Authentication Failure`
		`Link Down` (only applicable to the ENET-0 port)
		`Link UP` (only applicable to the ENET-0 port)
		`SAM Card Inserted`
		`SAM Card System ID Mismatch`
		`Software Version Out-of-Sync between SAMs`
		`System Alarm Detection Inhibited`
	HLDOVRSYNC	`Sync In HoldOver`
	IMPROPRMVL	`In Service SAM Card Removed`
	INHMSG	`System Alarm Report Inhibited`
	INTERR	`Ethernet Link Dropped`
		`Fan Tray Removed`
		`I/O Card Failed`
		`MLPPP Signal Degrade`
		`MLPPP Signal Failure`
		`Multiple Fans Failed`
		`One Fan Failed`
		`Overheated`
CHASSIS	INTERR	`PPP Signal Failure`
	INTSFT	`SAM Inter-Process Communication Failure`
	PROTNA	`Protected SAM Card Not Equipped`
	PWR	`Fan Power Failed`
	PWRRESTART	`Cold Start`
	REPLUNITMISS	`SAM Card Removed`
	SWTOINT	`Sync Switched to Intermediate`
	SWTOPRI	`Sync Switched to Primary`
	SWTOSEC	`Sync Switched to Secondary`
	SYNCEQPT	`Sync Hardware Failed`
	SYNCPRI	`Primary Reference Failed`
	SYNCSEC	`Secondary Reference Failed`
	SYNCSTATCHNG	`SSM Switched to Primary`
		`SSM Switched to Secondary`
	SYSBOOT	`Warm Start`
	WKSWBK	`SAM Switched to Side A`
	WKSWPR-1	`SAM Switched to Side B`
ENET	GP	`Link Down`
		`Link UP`
OC3	AIS	`Alarm Indication Signal`
	APSB	`Protection Switch Byte Failed`
	APSCM	`Channel Mismatch`
	APSMM	`Mode Mismatch`
	FEPRLF	`Far End Protection Failure`
	FRCDWKSWBK	`Forced Switch`
	GP	`Loss of Traffic`
OC3	GP	`Signal Degrade`
	INT	`Hardware Failure`
	LOCKOUTOFPR	`Lockout`
	LOF	`Loss of Frame`
	LOS	`Loss of Signal`
	LPBKFACILITY	`Loopback`
	RFI	`Remote Failure Indication`
	SFI	`Signal Failure`
	WKSWPR	`APS Switched to Protection`
STS	AIS-P	`Alarm Indication Signal`
	FACTERM	`Hardware Failure`
	GP	`Signal Degrade`
	LOP-P	`Loss of Pointer`
	LPBKFACILITY	`Loopback`
	PLM-P	`Signal Label Mismatch`
	RFI-P	`Remote Failure Indication`
	SFI	`Signal Failure`
	TIM-P	`Trace Identifier Mismatch`
	UNEQ-P	`Unequipped`
T1	AIS	`Alarm Indication Signal`
	GP	`Signal Degrade`
	LINETERM	`Hardware Failure`
	LOF	`Loss of Frame`
	LOS	`Loss of Signal`
	LPBKLINE	`Loopback`
	OSILINKERR	`Data Link Failure`
	RFI	`Remote Failure Indication`
T1	SFI	`Signal Failure`
	TRMT	`Transmit Failure`
	TSA	`Test`
VT	AIS-V	`Alarm Indication Signal`
	FACTERM	`Hardware Failure`
	FRCDWKSWBK	`VT Forced Switch`
	GP	`Signal Degrade`
		`VT Cross-Connect Loss of Traffic`
	LOCKOUTOFPR	`VT Lockout`
	LOP-V	`Loss Of Pointer`
	LPBKFACILITY	`Loopback`
	MANWKSWBK	`VT Manual switch`
	PLM-V	`Signal Label Mismatch`
	PS	`VT on Alternate Path`
	RFI-V	`Remote Failure Indication`
	SFI	`Signal Failure`
	SWEX	`VT Switch Failed`
	UNEQ-V	`Unequipped`
	WKSWBK	`OCN APS Switched from Protection`
		`VT Switched from Alternate`
	WKSWPR-1	`OCN APS Switched from Working`
		`VT Switched from Preferred`

AID Type	Monitored Type	Condition Description
OC3	CV	`TCA for CV-S`
	CVL	`TCA for CV-L`
	ES	`TCA for ES-S`
	ESL	`TCA for ES-L`
	SEFS	`TCA for SEFS-S`
	SES	`TCA for SES-S`
	SESL	`TCA for SES-L`
	UASL	`TCA for UAS-L`
STS	CV	`TCA for CV-P`
	ES	`TCA for ES-P`
	SES	`TCA for SES-P`
	UAS	`TCA for UAS-P`
T1	CVL	`TCA for CV-L`
	CVP	`TCA for CV-P (CRC-6)`
	ESL	`TCA for ES-L`
	ESP	`TCA for ES-P`
	SEFSP	`TCA for SEFS-P`
	SESL	`TCA for SES-L`
	SESP	`TCA for SES-P`
	UASP	`TCA for UAS-P`
VT	CV	`TCA for CV-V`
	ES	`TCA for ES-V`
VT	SES	`TCA for SES-V`
	UAS	`TCA for UAS-V`

Parameter	Possible Values (default in bold text)	Description
AID	CHASSIS ENET FAN_TRAY FAN FUSE OC3 SAM STS1 T1 VT1 ONS-ALL Null	Refer to Table 3-19, Table 3-20, and Table 3-21 for access identifier mnemonics and descriptions. In general, the following rules apply to access identifiers: When present, the command code modifier (EQPT, T1, VT1, STS1, OC3 ENET) specifies the typical format or type of access identifier. Use of the command code modifier ALL means the command applies to the NE and all its subunits. If the command code modifier is one of the allowed modifiers instead of ALL, AID cannot be null. If all units of a particular type need to be addressed, ONS-ALL can be used as a general representation. The value of AID may be null where explicitly specified: If the command code modifier is ALL, AID can be null and will default to all units in the NE. AID cannot be null with any other values for the command code modifier.
ALMCDE	C * *^ A^	Critical alarm. Major alarm. Minor alarm. Autonomous message.
ATAG	10 numeric characters	The automatic tag that is used to sequence autonomous alarm and event messages.
CONDDESCR	Character string	The detailed text description of the condition.
CONDEFF	SC CL TC	Standing condition. Cleared condition. Transient condition.
CONDTYPE	---	Refer to Table 3-22 for values.
CTAG	10 numeric characters	The correlation tag used to correlate command and response messages.
DATE	YY-MM-DD	The current date.
DIRN	TRMT RCV Null	Transmit direction only. Receive direction only. All applicable directions.
LOCN	NEND FEND Null	Near end. Far end. All applicable locations.
MONDAT	MOY-DOM Null	The start date of the PM collection period where month of year (MOY) ranges from 01 to 12 and day of month (DOM) ranges from 01 to 31. The current date.
MONTM	HOD-MOH Null	The start time of the PM collection period where hour of day (HOD) ranges from 00 to 23 and minute of hour (MOH) ranges from 00 to 59. Midnight (00-00).
MONTYPE	---	Refer to Table 3-23 for values.
MONVAL	<0-65535>	The measured value of the monitored parameter.
NFCNCDE	CR MJ MN CL	Critical alarm. Major alarm. Minor alarm. Cleared alarm.
NUMREPT	<0-65535> Null	The number of PM reports that the schedule is expected to produce. A value of 0 is used to end any PM reporting schedule that was introduced by a previous command. If NUMREPT is null, the NE will initiate PM and remain in that schedule mode until the schedule changes. Parameter grouping cannot be used with this parameter.
OCRDAT	MOY-DOM	The date when the specific alarm condition occurred.
OCRTM	HOD-MOH	The time of day when the specific alarm condition occurred.
PID	10 ASCII characters	The private identifier, which is the NE password.
REPTINVL	<1-1440>-MIN <1-24>-HR <1-31>-DAY 1-HR	Specifies how often a PM report will be generated and forwarded. The value specified should be greater than or equal to the value specified in TMPER within the same command. Minutes are rounded to the previous 15-minute boundary.
REPTSTATM	HOD-MOH Null	The starting time for the PM reporting schedule where HOD (hour of day) ranges from 00 to 23 and MOH (minute of hour) ranges from 00 to 59. The current time of day. Parameter grouping cannot be used with this parameter.
RSPBLK	---	The response block.
SID	20 ASCII characters	The source identifier of the NE.
SRVEFF	SA NSA Null	Service-affecting condition; immediate action required. Non-service-affecting condition; action required. The effect on service is unknown or the SRVEFF parameter is not used. When a null value is used in the Input Format with the RTRV-ALM command, alarm conditions for both SA and NSA are retrieved.
THLEV	<0-65535>	The threshold level for the monitored parameter specified in CONDTYPE.
TID	20 ASCII characters	The target identifier of the NE.
TIME	HH:MM:SS	The current time.
TMPER	<1-1440>-MIN <1-24>-HR 1-DAY Null	The accumulation time period for the PM information. Minutes are rounded to the previous 15-minute boundary. Equivalent to 60-MIN or 1-HR.
UID	10 numeric characters	The user ID that is used to log in to the NE.
VLDTY	Null	Not supported.

Table of Contents

Using Cisco Transport Manager GateWay