Cisco ONS 15454 and Cisco ONS 15327 TL1 for Beginners, Release 3.0 to Release 4.6

Table Of Contents

Cisco ONS 15454 and Cisco ONS 15327 TL1 for Beginners

Obtaining Documentation

Cisco.com

Documentation CD-ROM

Ordering Documentation

Documentation Feedback

Obtaining Technical Assistance

Cisco TAC Website

Opening a TAC Case

TAC Case Priority Definitions

Obtaining Additional Publications and Information

What is TL1?

TL1 Message Types and Examples

Connect to TL1

Launch CTC and Open a TL1 Session

Telnet to Open a TL1 Session

Use a Craft Interface to Open a TL1 Session

Log Into TL1

Command Actions and Categories

Ten Basic Commands

Log Out of TL1

Quick Start Guide

Cisco ONS 15454 and Cisco ONS 15327 TL1 for Beginners

---

1 Obtaining Documentation

---

Note The terms "Unidirectional Path Switched Ring" and "UPSR" may appear in Cisco literature. These terms do not refer to using Cisco ONS 15xxx products in a unidirectional path switched ring configuration. Rather, these terms, as well as "Path Protected Mesh Network" and "PPMN," refer generally to Cisco's path protection feature, which may be used in any topological network configuration. Cisco does not recommend using its path protection feature in any particular topological network configuration.

---

Cisco provides several ways to obtain documentation, technical assistance, and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com

You can access the most current Cisco documentation on the World Wide Web at this URL:

http://www.cisco.com/univercd/home/home.htm

You can access the Cisco website at this URL:

http://www.cisco.com

International Cisco websites can be accessed from this URL:

http://www.cisco.com/public/countries_languages.shtml

Documentation CD-ROM

Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which may have shipped with your product. The Documentation CD-ROM is updated regularly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual or quarterly subscription.

Registered Cisco.com users can order a single Documentation CD-ROM (product number DOC-CONDOCCD=) through the Cisco Ordering tool:

http://www.cisco.com/en/US/partner/ordering/ordering_place_order_ordering_tool_launch.html

All users can order annual or quarterly subscriptions through the online Subscription Store:

http://www.cisco.com/go/subscription

Click Subscriptions & Promotional Materials in the left navigation bar.

Ordering Documentation

You can find instructions for ordering documentation at this URL:

http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm

You can order Cisco documentation in these ways:

•Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Networking Products MarketPlace:

http://www.cisco.com/en/US/partner/ordering/index.shtml

•Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, USA) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).

2 Documentation Feedback

You can submit e-mail comments about technical documentation to bug-doc@cisco.com.

You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address:

Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883

We appreciate your comments.

3 Obtaining Technical Assistance

For all customers, partners, resellers, and distributors who hold valid Cisco service contracts, the Cisco Technical Assistance Center (TAC) provides 24-hour-a-day, award-winning technical support services, online and over the phone. Cisco.com features the Cisco TAC website as an online starting point for technical assistance. If you do not hold a valid Cisco service contract, please contact your reseller.

Cisco TAC Website

The Cisco TAC website provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The Cisco TAC website is available 24 hours a day, 365 days a year. The Cisco TAC website is located at this URL:

http://www.cisco.com/tac

Accessing all the tools on the Cisco TAC website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a login ID or password, register at this URL:

http://tools.cisco.com/RPF/register/register.do

Opening a TAC Case

Using the online TAC Case Open Tool is the fastest way to open P3 and P4 cases. (P3 and P4 cases are those in which your network is minimally impaired or for which you require product information.) After you describe your situation, the TAC Case Open Tool automatically recommends resources for an immediate solution. If your issue is not resolved using the recommended resources, your case will be assigned to a Cisco TAC engineer. The online TAC Case Open Tool is located at this URL:

http://www.cisco.com/tac/caseopen

For P1 or P2 cases (P1 and P2 cases are those in which your production network is down or severely degraded) or if you do not have Internet access, contact Cisco TAC by telephone. Cisco TAC engineers are assigned immediately to P1 and P2 cases to help keep your business operations running smoothly.

To open a case by telephone, use one of the following numbers:

Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553-2447

For a complete listing of Cisco TAC contacts, go to this URL:

http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml

TAC Case Priority Definitions

To ensure that all cases are reported in a standard format, Cisco has established case priority definitions.

Priority 1 (P1)—Your network is "down" or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.

Priority 2 (P2)—Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.

Priority 3 (P3)—Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels.

Priority 4 (P4)—You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.

4 Obtaining Additional Publications and Information

Information about Cisco products, technologies, and network solutions is available from various online and printed sources.

•The Cisco Product Catalog describes the networking products offered by Cisco Systems, as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:

http://www.cisco.com/en/US/products/products_catalog_links_launch.html

•Cisco Press publishes a wide range of general networking, training and certification titles. Both new and experienced users will benefit from these publications. For current Cisco Press titles and other information, go to Cisco Press online at this URL:

http://www.ciscopress.com

•Packet magazine is the Cisco quarterly publication that provides the latest networking trends, technology breakthroughs, and Cisco products and solutions to help industry professionals get the most from their networking investment. Included are networking deployment and troubleshooting tips, configuration examples, customer case studies, tutorials and training, certification information, and links to numerous in-depth online resources. You can access Packet magazine at this URL:

http://www.cisco.com/packet

•iQ Magazine is the Cisco bimonthly publication that delivers the latest information about Internet business strategies for executives. You can access iQ Magazine at this URL:

http://www.cisco.com/go/iqmagazine

•Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL:

http://www.cisco.com/en/US/about/ac123/ac147/about_cisco_the_internet_protocol_journal.html

•Training—Cisco offers world-class networking training. Current offerings in network training are listed at this URL:

http://www.cisco.com/en/US/learning/index.html

5 What is TL1?

Transaction Language 1 (TL1) is a set of ASCII (American Standard Code for Information Interchange)-based instructions, or messages, that an operations support system (OSS) uses to manage a network element (NE) and its resources. TL1 provides a standard set of messages that can be used for communicating between operating systems and NEs, and personnel and NEs.

6 TL1 Message Types and Examples

There are two main types of standards-defined TL1 messages: command/responses and autonomous messages.

1. Command/Responses—These are initiated by a user and provide two parts: a request to the NE to set or get information, and a response from the NE containing completion or status codes and requested information. Request, or input messages are used to issue the request portions of command messages to the NE. Command messages are often referred to as command/response messages, where the request portion is an input message (OSS to NE) and the response portion is an output message (NE to OSS).

a. Set information—The simplest type of messages are those that set information or instruct the NE to perform an action and return only a result with no data in the response:

Example: ENT-CRS-<STS_PATH> to create an STS cross-connection

b. Get information—Some TL1 commands get information or request information be returned from the NE.

Example: RTRV-ALM-ALL to show the current status of all active alarm conditions

c. Response message—The response portion of a command message correlates to a particular request message. If a command is successful, the NE sends a response message containing the COMPLD code.

Example:     
   sv192-DATA-461 2003-08-05 10:35:17

M  123 COMPLD

;

If a command fails, the NE sends an error response which includes the DENY code and may or may not contain an error message.

Example:     
   sv192-DATA-461 2003-08-05 10:35:17

M  123 DENY

;

The following list shows standard responses:

COMPLD—Completed

DENY—TL1 command failed

PRTL—Partially successful response. The requested action can be completed for some of the specified AIDs but not for all of them.

RTRV—The response is successful but is lengthy and is being returned in multiple parts. Each part has a RTRV response code, but the final response has a COMPLD response code.

d. Response acknowledgment—Responses may also include intermediate acknowledgment messages. Brief messages that update the user as to the status of a given command are called acknowledgments. When a command has been sent to the NE and the NE will take longer than two seconds to respond, the NE sends an acknowledgment message to be followed later by the full response. The Cisco ONS 15454 and Cisco ONS 15327 support only the IP response.

Example: IP 123 
          >

The following list shows standard acknowledgment codes:

IP—In progress

2. Autonomous events—These are events, alarmed or otherwise, that are generated by the NE as a result of a condition in the NE, such as an alarm condition, a change in status, or a change in the information in the database.

Example: REPT-ALM

For information on specific command and autonomous message syntax, refer to the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide.

7 Connect to TL1

The first step in using TL1 is to connect to TL1. You only have to connect to TL1 one time per session. A session is a related set of communication transactions between two or more network devices. There are three ways to connect to TL1: via CTC, telnet, or craft interface. Perform one of the following procedures to connect to TL1.

Launch CTC and Open a TL1 Session

---

Step 1 From the PC connected to the ONS 15454/15327, start Netscape or Internet Explorer.

Step 2 Enter the ONS 15454/15327 IP address of the node you want to communicate with in the Netscape or Internet Explorer Web address (URL) field.

Step 3 Log into the CTC. The IP address at the title bar should match the IP address of the node you entered in Step 2.

Step 4 Once logged into the CTC, click Tools > Open TL1 Connection.

Step 5 Choose the node you want to communicate with from the Select Node dialog box.

Step 6 Click OK.

A TL1 interface window opens. There are three sub-windows in the TL1 interface window: Request history, Message log, and TL1 request. Type commands in the TL1 request window. You will see responses in the Message log window. The Request history window allows you to recall previous commands by clicking on them.

Step 7 Verify that the Connect button is selected (grayed out).

Step 8 You are ready to log into TL1. Follow the steps in the "Log Into TL1" section.

---

Telnet to Open a TL1 Session

To access TL1 commands in a telnet session over a craft interface or a LAN connection (TCC or XTC card front panel or backplane pins) you can choose from several ports. Port number 3082 is a raw TCP/IP port; it will not echo and it will not prompt the user. Port number 3083 is a telnet port that uses the telnet protocol and associated telnet escape sequences. Port number 2361 is supported for backward compatibility with earlier releases and has the same behavior as Port 3083 (telnet port). Use the following procedure with PCs running Windows operating systems.

---

Note TCC represents the TCC, TCC+, or TCC2 card, as determined by software release.

---

---

Step 1 At the DOS prompt, type cmd and press Enter. (The same steps can also be done from a Unix prompt).

Step 2 At the DOS command prompt type:

TELNET <NODE IP ADDRESS OR NODE NAME> <PORT NUMBER> and press Enter.

The Node IP address or Node Name refers to the IP address or Node Name of the node you want to communicate with. Port number is the port (2361, 3082, or 3083) where TL1 commands are understood. If the connection is successful, a screen opens with a prompt.

Step 3 You are ready to log into TL1. Follow the steps in the "Log Into TL1" section.

---

Note When the semicolon is typed, the command is issued immediately.

---

---

Use a Craft Interface to Open a TL1 Session

The TCC and XTC cards have two built-in interface ports for accessing the ONS 15454/15327. With one RJ-45 LAN connection you can access the system using a standard browser interface. In the browser interface, you can perform local and remote Operations, Administration, Maintenance, and Provisioning (OAM&P) functions and open a VT100 emulation window to enter TL1 commands. If a browser is not available, you can access the system using a nine-pin RS-232 port. The RS-232 port supports VT100 emulation such that TL1 commands may be entered directly without a browser.

---

Step 1 Connect the serial cable to the RS-232 port on the active TCC or XTC card.

Step 2 Configure the terminal emulation software (Hyperterminal):

a. Terminal emulation = vt100

b. Bits per second = 9600

c. Parity = None

d. Stop BITS = 1

e. Flow control = None

Step 3 Press Enter. An angle bracket prompt (>) appears.

Step 4 You are ready to log into TL1. Follow the steps in the "Log Into TL1" section.

---

Note When the semicolon is typed, the command is issued immediately.

---

---

8 Log Into TL1

Once you have connected to TL1, you must log into TL1 in order to issue commands. Logging into TL1 only has to be done once per session.

---

Step 1 Issue the ACT-USER command:

Input Format:

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

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•UID is your user ID

•CTAG is any non-blank character series that does not have to be unique

•PID is your password

Input Example:

ACT-USER::CISCO15:1234::MYPASSWD;

Step 2 Confirm you receive a COMPLD response to indicate the command was completed successfully.

Response Example:

TID001 03-07-22 02:45:12

M 1234 COMPLD

;

---

9 Command Actions and Categories

When you have connected and logged into a TL1 session, you are ready to begin issuing TL1 commands and autonomous messages. TL1 commands and autonomous messages can be used to accomplish a variety of actions. Determining the correct command or autonomous message you need begins with identifying what action you want to perform. The first part of every command and autonomous message helps identify the action that command or autonomous message performs as shown in Table 1.

Table 1 TL1 Command and Autonomous Message Actions

Commands or Autonomous Messages That Begin With	Generally Do This	Command Example
ACT-	Activate	ACT-USER
ALW-	Allow	ALW-MSG-ALL
APPLY	Apply	APPLY
CANC (autonomous message)	Report	CANC (reports a cancelled session)
CANC-	Cancel	CANC-USER
CHG-	Change	CHG-ACCMD-<MOD_TACC>
CLR-	Clear	CLR-COND-SECU
CONN-	Connect	CONN-TACC-<MOD_TACC>
COPY-	Copy	COPY-IOSCFG
DISC-	Disconnect	DISC-TACC
DLT-	Delete	DLT-BLSR
ED-	Edit/Change	ED-BITS
ENT-	Enter/Create	ENT-BLSR
EX-	Exercise	EX-SW-<OCN_BLSR>
INH-	Inhibit	INH-MSG-ALL
INIT-	Initialize	INIT-SYS
OPR-	Operate/Create	OPR-LNK
REPT (autonomous message)	Report	REPT ALM ENV
RLS-	Release	RLS-EXT-CONT
RMV-	Remove	RMV-<MOD2_IO>
RST-	Restore	RST-<MOD2_IO>
RTRV-	Retrieve	RTRV-COND-RING
SCHED-	Schedule	SCHED-PMREPT-<MOD2>
SET-	Set	SET-ATTR-ENV
SW-	Switch	SW-DX-EQPT

To further determine which command or autonomous message you need, identify what category the action applies to (i.e. BLSR, Cross Connections). In the Cisco ONS 15454 and 15327 TL1 Command Guide, commands and autonomous messages are categorized based on the area of the NE that they effect. For example, if you want to create, edit, or delete a cross-connection, you will find the available commands in the Cross Connections category. Table 2 shows some examples of actions, categories, and commands that apply to the Cisco ONS 15454 and Cisco ONS 15327. For a complete list of categories, commands and autonomous messages, refer to the Cisco ONS 15454 and 15327 TL1 Command Guide.

Table 2 Some TL1 Category Examples

If You Want to	Look in this Category	Applicable Command or Autonomous Message
Create a 2-fiber or 4-fiber BLSR	BLSR	ENT-BLSR
Delete a cross-connection on a VT path	Cross Connections	DLT-CRS-<VT_PATH>
Set the attributes of the air conditioner	Environment Alarms and Controls	SET-ATTR-CONT
Delete a card from the NE	Equipment	DLT-EQPT
Lockout a user from the NE	Security	INH-USER-SECU
See the alarms on a BITS	Synchronization	REPT ALM BITS
Change the date on the NE	System	ED-DAT
Disconnect a test access path/point	Test Access	DISC-TACC
Perform a path protection switch on an STS path	Path Protection Switching	OPR-PROTNSW-<STS_PATH>
Release a path protection protection switch on an STS path	Path Protection Switching	RLS-PROTNSW-<STS_PATH>

In the "Ten Basic Commands" section, there are ten commands listed in detail to help get you started entering TL1 commands.

10 Ten Basic Commands

This section lists ten basic commands to help you get started. You must be connected and logged into a TL1 session. After you issue a command, confirm you receive a COMPLD response to indicate the command was completed successfully.

---

Note If you receive a DENY response, first check the syntax you entered for accuracy. If you entered the command correctly, refer to the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide for more information about that particular command and its components.

---

•To change configuration information on a DS1 port see ED-T1

•To retrieve configuration information about a DS1 port see RTRV-T1

•To retrieve all alarms on a specific DS1 port see RTRV-ALM-T1

•To retrieve all conditions on a specific DS1 port see RTRV-COND-T1

•To retrieve all alarms on a system see RTRV-ALM-ALL

•To retrieve all conditions on a system see RTRV-COND-ALL

•To retrieve actual PM values on a DS1 port see RTRV-PM-T1

•To retrieve the thresholds in place for a DS1 port see RTRV-TH-T1

•To create a loopback see OPR-LPBK-T1

•To release a loopback see RLS-LPBK-T1

---

Note When you are finished using TL1 remember to log out. Follow the steps in the "Log Out of TL1" section to log out.

---

For complete TL1 documentation, refer to the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide. For a command quick reference guide, refer to the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Quick Reference Guide.

1. ED-T1

Use the ED-T1 command to change configuration information on a DS1 port. ED-T1 is from the Ports category.

Input Format:

ED-T1:[<TID>]:<AID>:<CTAG>:::[LINECDE=<LINECDE>,][FMT=<FMT>,][LBO=<LBO>,]
[TACC=<TACC>,][SOAK=<SOAK>,][SFBER=<SFBER>,][SDBER=<SDBER>]:[<PST>],[<SST>];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•AID is FAC-{1-6,12-17}-{1-14} to indicate slot and port

•CTAG is any non-blank character series that does not have to be unique

•LINECDE is a line code. Values are AMI or B8ZS

•FMT is a frame format. Values are D4, ESF, or unframed.

•LBO is a line build out. Values are 0-131, 132-262, 263-393, 394-524, or 525-655

•TACC defines the STS as a test access port with a selected unique TAP number. The TAP number is in the range of 0, 1-999. When TACC is 0 (zero), the TAP is deleted.

•SOAK - OOS-AINS to IS transition soak time as measured in 15 minute intervals, so a value of 4 translates to a soak time of 1 hour. The allowable range is 0-192 intervals (maximum of 48 hours)

•<SFBER> identifies port SFBER; valid values are 1E-3-1E-5

•<SDBER> identifies port SDBER; valid values are 1E-5-1E-9

•PST is primary state. Values are IS or OOS

•SST is secondary state. Values are MT or AINS

Input Example:

ED-T1:CISCO:FAC-2-1:1223:::LINECDE=AMI,FMT=ESF,LBO=0-131,TACC=8,SOAK=10,
SFBER=1E-4,SDBER=1E-6:OOS,AINS;

2. RTRV-T1

Use the RTRV-T1 command to retrieve configuration information on a DS1 port. RTRV-T1 is from the Ports category.

Input Format:

RTRV-T1:[<TID>]:<AID>:<CTAG>[::::];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•AID is FAC-{1-6,12-17}-{1-14} to indicate slot and port

•CTAG is any non-blank character series that does not have to be unique

Input Example:

RTRV-T1:TID:FAC-2-1:1223;

3. RTRV-ALM-T1

Use the RTRV-ALM-T1 command to retrieve all alarms on a specific DS1 port. The RTRV-ALM-T1 command is listed as RTRV-ALM-<MOD2ALM> in the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide. T1 is just one of the options you can enter. RTRV-ALM-T1 is from the Fault category.

Input Format:

RTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•AID is FAC-{1-6,12-17}-{1-14} to indicate slot and port

•CTAG is any non-blank character series that does not have to be unique

•NTFCNCDE is the 2-letter notification code. Values are CR (critical), MJ (major), MN (minor), NA (not alarmed), and NR (not reported)

•CONDTYPE is the alarm condition

•SRVEFF is the effect on service caused by the alarm condition. Values are NSA (not service affecting) or SA (service affecting)

Input Example:

RTRV-ALM-T1::FAC-2-3:X::MN,PWRRESTART,NSA;

Response Format:

SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>]"
;

•AID shows the port in question

•AIDTYPE shows the type of the port

•NTFCNCDE is the 2-letter notification code. Values are CR (critical), MJ (major), MN (minor), NA (not alarmed), and NR (not reported)

•CONDTYPE is the type of alarm condition

•SRVEFF is the effect on service caused by the alarm condition. Values are NSA (not service affecting) or SA (service affecting)

•DESC is a condition description

Response Example:

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1,OC12:MJ,SD,SA,,,,:\"BER AT SIGNAL DEGRADE LEVEL\","
;

4. RTRV-COND-T1

Use the RTRV-COND-T1 command to retrieve all conditions on a specific DS1 port. The RTRV-COND-T1 command is listed as RTRV-COND-<MOD2ALM> in the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide. T1 is just one of the options you can enter. RTRV-COND-T1 is from the Fault category.

Input Format:

RTRV-COND-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•AID is FAC-{1-6,12-17}-{1-14} to indicate slot and port

•CTAG is any non-blank character series that does not have to be unique

•TYPEREQ is the type of condition to be retrieved. A null value is equivalent to ALL

Input Example:

RTRV-COND-T1:TID:FAC-2-1:229::LOS;

Response Format:

SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;

•AID shows the port in question

•AIDTYPE shows the type of the port

•NTFCNCDE is the 2-letter notification code. Values are CR (critical), MJ (major), MN (minor), NA (not alarmed), and NR (not reported)

•TYPEREP is the condition itself

•SRVEFF is the effect on service caused by the alarm condition. Values are NSA (not service affecting) or SA (service affecting)

•OCRDAT is a date and is optional

•OCRTM is a time and is optional

•DESC is a condition description

Response Example:

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,T1:CR,LOS,SA,01-01,16-00-20,,,\"LOS OF SIGNAL\""
;

5. RTRV-ALM-ALL

Use the RTRV-ALM-ALL command to retrieve all of the alarms on the system. RTRV-ALM-ALL is from the Fault category.

Input Format:

RTRV-ALM-ALL:[<TID>]::<CTAG>::[<NTFCNCDE>],[<CONDITION>],[<SRVEFF>][,,,];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•CTAG is any non-blank character series that does not have to be unique

•NTFCNCDE is the 2-letter notification code. Values are CR (critical), MJ (major), MN (minor), NA (not alarmed), and NR (not reported)

•CONDITION is the type of alarm condition

•SRVEFF is the effect on service caused by the alarm condition. Values are NSA (not service affecting) or SA (service affecting)

Input Example:

RTRV-ALM-ALL:COTATI::229::MN,PWRRESTART,NSA;

Response Format:

SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>],[<AIDDET>]"
;

•AID shows the port in question

•AIDTYPE shows the type of the port

•NTFCNCDE is the 2-letter notification code. Values are CR (critical), MJ (major), MN (minor), NA (not alarmed), and NR (not reported)

•CONDTYPE is the type of alarm condition

•SRVEFF is the effect on service caused by the alarm condition. Values are NSA (not service affecting) or SA (service affecting)

•DESC is a condition description

•AIDDET is the supplementary equipment identification

Response Example:

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2,EQPT:MN,PWRRESTART,NSA,,,,:\"POWER FAIL RESTART\",DS1-14"
;

6. RTRV-COND-ALL

Use the RTRV-COND-ALL command to retrieve all of the conditions on the system. RTRV-COND-ALL is from the Fault category.

Input Format:

RTRV-COND-ALL:[<TID>]::<CTAG>::[<TYPEREQ>][,,,];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•CTAG is any non-blank character series that does not have to be unique

•TYPEREQ is the type of condition to be retrieved. A null value is equivalent to ALL

Input Example:

RTRV-COND-ALL:TID::229::LOS;

Response Format:

SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;

•AID shows the port in question

•AIDTYPE shows the type of the port

•NTFCNCDE is the 2-letter notification code. Values are CR (critical), MJ (major), MN (minor), NA (not alarmed), and NR (not reported)

•TYPEREP is the condition itself

•SRVEFF is the effect on service caused by the alarm condition. Values are NSA (not service affecting) or SA (service affecting)

•OCRDAT is a date and is optional

•OCRTM is a time and is optional

•DESC is a condition description

Response Example:

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,OC3:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;

7. RTRV-PM-T1

Use the RTRV-PM-T1 command to retrieve actual performance monitoring values on a DS1 port. The RTRV-PM-T1 command is listed as RTRV-PM-<MOD2> in the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide. T1 is just one of the options you can enter. RTRV-PM-T1 is from the Performance category.

Input Format:

RTRV-PM-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<MONLEV>],[<LOCN>],
[<DIRN>],[<TMPER>],[<DATE>],[<TIME>];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•AID is FAC-{1-6,12-17}-{1-14} to indicate slot and port

•CTAG is any non-blank character series that does not have to be unique

•MONTYPE is a monitored type. A null value is equivalent to ALL.

•MONLEV specifies the discriminating level for the requested monitored parameter. MONLEV is in the format of LEVEL-DIRN where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of DIRN. A null value defaults to 1-UP which means it only shows values 1 and higher

•LOCN indicates the location. A null value defaults to NEND

•DIRN is the direction of PM relative to the entity identified by the AID. DIRN defaults to ALL which means that the command retrieves all the registers irrespective of the PM direction. Values are BTH (both), RCV (receive), and TRMT (transmit)

•TMPER is the accumulation time period for the PM information. A null value defaults to 15-MIN

•DATE is the beginning date of the PM or storage register period specified in TMPER. DATE is MM-DD where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. A null value defaults to the current date.

•TIME is the beginning time of day of the PM or storage register period specified in TMPER. TIME is HH-MM where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. A null value defaults to the current time (HH-MM).

Input Example:

RTRV-PM-T1:TID:FAC-2-1:123::CVL,10-UP,NEND,BTH,15-MIN,04-11,12-45;

Response Format:

SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],[<DIRN>],
[<TMPER>],[<MONDAT>],[<MONTM>]"
;

•AID shows the port in question

•AIDTYPE shows the type of the port

•MONTYPE shows the threshold type

•MONVAL shows the value

•VLDTY indicates if a full and complete PM value was returned

•LOCN indicates the location

•DIRN is the direction

•TMPER is the accumulation time period

•MONDAT is the date

•MONTM is the time

Response Example:

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,DS1-14:CVL,21,COMPL,NEND,BTN,15-MIN,04-11,12-45"
;

8. RTRV-TH-T1

Use the RTRV-TH-T1 command to retrieve the thresholds in place for a DS1 port. The RTRV-TH-T1 command is listed as RTRV-TH-<MOD2> in the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide. T1 is just one of the options you can enter. RTRV-TH-T1 is from the Performance category.

Input Format:

RTRV-TH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<LOCN>],<TMPER>[::];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•AID is FAC-{1-6,12-17}-{1-14} to indicate slot and port

•CTAG is any non-blank character series that does not have to be unique

•MONTYPE is a monitored type. A null value is equivalent to ALL

•LOCN is the location. A null value defaults to NEND. Values are NEND (near end) or FEND (far end)

•TMPER indicates the accumulation time period. A null value defaults to 15-MIN

Input Examples:

RTRV-TH-T1:CISCO:FAC-1-3:1234::CVL,NEND,15-MIN;
to retrieve the NEND CVL 15-MIN threshold on the third DS1 port on the DS1 card in Slot 1.

RTRV-TH-T1:CISCO:FAC-1-3:1234::ALL,NEND,15-MIN;
to retrieve ALL NEND 15-MIN thresholds on the third DS1 port on the DS1 card in Slot 1.

Response Format:

SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,[<LOCN>],,<THLEV>,[<TMPER>]"
;

•AID is the access identifier ALL

•AIDTYPE specifies the type of AID

•MONTYPE indicates the monitored type

•LOCN is a location

•THLEV is the threshold value

•TMPER is the accumulation time period for the PM information

Output Example:

TID-0001998-06-20 14:30:00
M 001 COMPLD
"FAC-1-3,DS1:CVL,NEND,,1,15-MIN"
;

9. OPR-LPBK-T1

Use the OPR-LPBK-T1 command to establish a loopback. The OPR-LPBK-T1 command is listed as OPR-LPBK-<MOD2> in the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide. T1 is just one of the options you can enter. OPR-LPBK-T1 is from the Testing category.

---

Note Port should be in OOS-MT (not IS) when establishing a loopback.

---

Input Format:

OPR-LPBK-<MOD2>:[<TID>]:<SRC>:<CTAG>::,,,[<LPBKTYPE>];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•SRC is an access identifier. Valid values are facility, DS1, and STS

•CTAG is any non-blank character series that does not have to be unique

•LPBKTYPE is a loopback type and is optional. LPBKTYPE can be FACILITY or TERMINAL

Input Example:

OPR-LPBK-T1:PTREYES:DS1-4-1-2-13:203::,,,FACILITY;

10. RLS-LPBK-T1

Use the RLS-LPBK-T1 command to release a loopback. The RLS-LPBK-T1 command is listed as RLS-LPBK-<MOD2> in the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide. T1 is just one of the options you can enter. RLS-LPBK-T1 is from the Testing category.

Input Format:

RLS-LPBK-<MOD2>:[<TID>]:<SRC>:<CTAG>::,,,[<LPBKTYPE>];

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•SRC is an access identifier. Valid values are facility, DS1, and STS

•CTAG is any non-blank character series that does not have to be unique

•LPBKTYPE is a loopback type and is optional. LPBKTYPE can be FACILITY or TERMINAL

Input Example:

RLS-LPBK-DS1:PTREYES:DS1-4-1-2-13:203::,,,FACILITY;

11 Log Out of TL1

When you are finished using TL1, you must log out of the session. Logging out of TL1 only has to be done once per session.

---

Step 1 If you logged into TL1 via CTC, you must log out by pressing the Disconnect button or by issuing the CANC-USER command as shown in the following steps.

If you logged into TL1 via Telnet or craft interface, you must log out by issuing the CANC-USER command.

Input Format:

CANC-USER:[TID]:[UID]:CTAG;

•TID is the name of the node you want to access. If you only want to query the node you connected to leave the TID blank

•UID is your user ID

•CTAG is any non-blank character series that does not have to be unique

Input Example:

CANC-USER::CISCO15:X;

Step 2 Confirm you receive a COMPLD response to indicate the command was completed successfully.

Response Example:

TID001 03-07-22 02:45:12

M X COMPLD

;

---