Cisco ONS 15454 TL1 Command Guide, Release 3.2
Chapter 3, TL1 Command Descriptions

Table Of Contents

TL1 Command Descriptions

3.1 TL1 Commands by Category

3.2 TL1 Commands by Card

3.3 TL1 Commands, Categories and Cards

3.4 TL1 Commands

3.4.1 ACT-USER: Activate User

3.4.2 ALW-MSG-ALL: Allow Event All

3.4.3 ALW-SWDX-EQPT: Allow Switch Duplex Equipment

3.4.4 ALW-SWTOPROTN-EQPT: Allow Switch to Protection Equipment

3.4.5 ALW-SWTOWKG-EQPT: Allow Switch to Working Equipment

3.4.6 CANC: Cancel

3.4.7 CANC-USER: Cancel User

3.4.8 CHG-ACCMD-<MOD_TACC>: Change Access Mode (DS1, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, T1, T3, VT1)

3.4.9 CONN-TACC-<MOD_TACC>: Connect TACC (DS1, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, T1, T3, VT1)

3.4.10 DISC-TACC: Disconnect TACC

3.4.11 DLT-CRS-<STS_PATH>: Delete Cross Connection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.12 DLT-CRS-VT1: Delete Virtual Tributary Cross Connect

3.4.13 DLT-EQPT: Delete Equipment

3.4.14 DLT-FFP-<OCN_TYPE>: Delete Facilities Protection Group (OC3, OC12, OC48, OC192)

3.4.15 DLT-USER-SECU: Delete User Security

3.4.16 ED-<OCN_TYPE>: Edit (OC3, OC12, OC48, OC192)

3.4.17 ED-<STS_PATH>: Edit (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.18 ED-BITS: Edit Building Integrated Timing Supply

3.4.19 ED-BLSR: Edit Bidirectional Line Switched Ring

3.4.20 ED-DAT: Edit Date and Time

3.4.21 ED-DS1: Edit DS1 Layer of DS3XM

3.4.22 ED-EC1: Edit Electrical Carrier

3.4.23 ED-EQPT: Edit Equipment

3.4.24 ED-FFP-<OCN_TYPE>: Edit Facilities Protection Group (OC3, OC12, OC48, OC192)

3.4.25 ED-G1000: Edit G1000

3.4.26 ED-NE-GEN: Edit Network Element GEN

3.4.27 ED-NE-SYNCN: Edit Network Element Synchronization

3.4.28 ED-PID: Edit Password

3.4.29 ED-SYNCN: Edit Synchronization

3.4.30 ED-T1: Edit T1 Facility

3.4.31 ED-T3: Edit T3 Facility

3.4.32 ED-USER-SECU: Edit User Security

3.4.33 ED-VT1: Edit Virtual Tributary

3.4.34 ENT-CRS-<STS_PATH>: Enter Cross Connect (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.35 ENT-CRS-VT1: Enter Virtual Tributary Cross Connection

3.4.36 ENT-EQPT: Enter Equipment

3.4.37 ENT-FFP-<OCN_TYPE>: Enter Facilities Protection Group (OC3, OC12, OC48, OC192)

3.4.38 ENT-USER-SECU: Enter User Security

3.4.39 EX-SW-<OCN_BLSR>: Operate Protection Switch (OC12, OC48, OC192)

3.4.40 INH-MSG-ALL: Inhibit Message All

3.4.41 INH-SWDX-EQPT: Inhibit Switch Duplex Equipment

3.4.42 INH-SWTOPROTN-EQPT: Inhibit Switch to Protection Equipment

3.4.43 INH-SWTOWKG-EQPT: Inhibit Switch to Working Equipment

3.4.44 INIT-REG-<MOD2>: Initialize Register (DS1, EC1, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.45 INIT-SYS: Initialize System

3.4.46 OPR-EXT-CONT: Operate External Control

3.4.47 OPR-LPBK-<MOD2_IO>: Operate Loopback (DS1, EC1, G1000, OC3, OC12, OC48, OC192, T1, T3)

3.4.48 OPR-PROTNSW-<OCN_TYPE>: Operate Protection Switch (OC3, OC12, OC48, OC192)

3.4.49 OPR-PROTNSW-<STS_PATH>: Operate Protection Switch (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.50 OPR-PROTNSW-VT1: Operate Virtual Tributary Protection Switch

3.4.51 OPR-SYNCNSW: Operate Synchronization Switch

3.4.52 REPT ALM <MOD2ALM>: Report Alarm (DS1, E100, E1000, EC1, G1000, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.53 REPT ALM BITS: Report Alarm Building Integrated Timing Supply

3.4.54 REPT ALM COM: Report Alarm COM

3.4.55 REPT ALM ENV: Report Alarm Environment

3.4.56 REPT ALM EQPT: Report Alarm Equipment

3.4.57 REPT ALM RING: Report Alarm Ring

3.4.58 REPT ALM SYNCN: Report Alarm Synchronization

3.4.59 REPT DBCHG: Report Change

3.4.60 REPT EVT <MOD2ALM>: Report Event (DS1, E100, E1000, EC1, G1000, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.61 REPT EVT BITS: Report Event BITS

3.4.62 REPT EVT ENV: Report Event Environment

3.4.63 REPT EVT EQPT: Report Event Equipment

3.4.64 REPT EVT RING: Report Event Ring

3.4.65 REPT EVT SECU: Report Event Security

3.4.66 REPT EVT SYNCN: Report Event Synchronization

3.4.67 REPT SW: Report Switch

3.4.68 RLS-EXT-CONT: Release External Control

3.4.69 RLS-LPBK-<MOD2_IO>: Release Loopback (DS1, EC1, G1000, OC3, OC12, OC48, OC192, T1, T3)

3.4.70 RLS-PROTNSW-<OCN_TYPE>: Release Protection Switch (OC3, OC12, OC48, OC192)

3.4.71 RLS-PROTNSW-<STS_PATH>: Release Protection Switch (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.72 RLS-PROTNSW-VT1: Release Virtual Tributary Protection Switch

3.4.73 RLS-SYNCNSW: Release Synchronization Switch

3.4.74 RMV-<MOD_PORT>: Remove (EC1, G1000, OC3, OC12, OC48, OC192, T1, T3)

3.4.75 RST-<MOD_PORT>: Restore (EC1,G1000, OC3, OC12, OC48, OC192, T1, T3)

3.4.76 RTRV-<OCN_TYPE>: Retrieve (OC3, OC12, OC48, OC192)

3.4.77 RTRV-<STS_PATH>: Retrieve (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.78 RTRV-ALM-<MOD2ALM>:Retrieve Alarm (DS1, E100, E1000, EC1, G1000, OC3, OC12, OC48, OC192, STS1, STS3C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.79 RTRV-ALM-ALL: Retrieve Alarm All

3.4.80 RTRV-ALM-BITS: Retrieve Alarm Building Integrated Timing Supply

3.4.81 RTRV-ALM-ENV: Retrieve Alarm Environment

3.4.82 RTRV-ALM-EQPT: Retrieve Alarm Equipment

3.4.83 RTRV-ALM-SYNCN: Retrieve Alarm Synchronization

3.4.84 RTRV-ATTR-CONT: Retrieve Attribute Control

3.4.85 RTRV-ATTR-ENV: Retrieve Attribute Environment

3.4.86 RTRV-BITS: Retrieve Building Integrated Timing Supply

3.4.87 RTRV-BLSR: Retrieve Bidirectional Line Switched Ring

3.4.88 RTRV-COND-<MOD2ALM>: Retrieve Condition (DS1, E100, E1000, EC1, G1000, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.89 RTRV-COND-ALL: Retrieve Condition All

3.4.90 RTRV-COND-BITS: Retrieve Condition Building Integrated Timing Supply

3.4.91 RTRV-COND-ENV: Retrieve Condition Environment

3.4.92 RTRV-COND-EQPT: Retrieve Condition Equipment

3.4.93 RTRV-COND-SYNCN: Retrieve Condition Synchronization

3.4.94 RTRV-CRS-<STS_PATH>: Retrieve Cross Connect (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.95 RTRV-CRS-VT1: Retrieve Virtual Tributary Cross Connect

3.4.96 RTRV-DS1: Retrieve DS1 Layer of DS3XM

3.4.97 RTRV-EC1: Retrieve EC1

3.4.98 RTRV-EQPT: Retrieve Equipment

3.4.99 RTRV-EXT-CONT: Retrieve External Control

3.4.100 RTRV-FFP-<OCN_TYPE>: Retrieve Facility Protection Group (OC3, OC12, OC48, OC192)

3.4.101 RTRV-G1000: Retrieve G1000

3.4.102 RTRV-HDR: Retrieve Header

3.4.103 RTRV-INV: Retrieve Inventory

3.4.104 RTRV-LOG: Retrieve Log

3.4.105 RTRV-NE-GEN: Retrieve Network Element General

3.4.106 RTRV-NE-IPMAP: Retrieve Network Element IPMAP

3.4.107 RTRV-NE-SYNCN: Retrieve Network Element Synchronization

3.4.108 RTRV-PM-<MOD2>: Retrieve Performance (DS1, EC1, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.109 RTRV-PMMODE-<STS_PATH>: Retrieve Performance Mode of PM Data Collection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.110 RTRV-PTHTRC-<STS_PATH>: Retrieve Path Trace (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.111 RTRV-SYNCN: Retrieve Synchronization

3.4.112 RTRV-T1: Retrieve T1 Facility

3.4.113 RTRV-T3: Retrieve T3

3.4.114 RTRV-TH-<MOD2>: Retrieve Threshold (DS1, EC1, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.115 RTRV-TOD: Retrieve Time of Day

3.4.116 RTRV-VT1: Retrieve Virtual Tributary

3.4.117 SET-ATTR-CONT: Set Attribute Control

3.4.118 SET-ATTR-ENV: Set Attribute Environment

3.4.119 SET-PMMODE-<STS_PATH>: Set Performance Mode of PM Data Collection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.120 SET-TH-<MOD2>: Set Threshold (DS1, EC1, OC3, OC12,OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C,T1, T3, VT1)

3.4.121 SET-TOD: Set Time of Day

3.4.122 SW-DX-EQPT: Switch Duplex Equipment

3.4.123 SW-TOPROTN-EQPT: Switch to Protection Equipment

3.4.124 SW-TOWKG-EQPT: Switch to Working Equipment


TL1 Command Descriptions


This chapter provides specific information on TL1 commands and autonomous messages for the Cisco ONS 15454, Release 3.2, including:

TL1 commands by category

TL1 commands by card

TL1 commands, categories and cards

TL1 commands

For information on command components, such as parameters, see "TL1 Command Components."

3.1 TL1 Commands by Category

Table 3-1 TL1 Commands by Category 

Category
Command or Autonomous Message

BLSR

ED-BLSR
REPT ALM RING
REPT EVT RING
RTRV-BLSR

Cross Connections

DLT-CRS-<STS_PATH>
DLT-CRS-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1

Environmental Alarms and Controls

OPR-EXT-CONT
REPT ALM ENV
REPT EVT ENV
RLS-EXT-CONT
RTRV-ALM-ENV
RTRV-ATTR-CONT
RTRV-ATTR-ENV
RTRV-COND-ENV
RTRV-EXT-CONT
SET-ATTR-CONT
SET-ATTR-ENV

Equipment

ALW-SWDX-EQPT
ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
DLT-EQPT
ED-EQPT
ENT-EQPT
INH-SWDX-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
REPT ALM EQPT
REPT EVT EQPT
RTRV-ALM-EQPT
RTRV-COND-EQPT
RTRV-EQPT
SW-DX-EQPT
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

Fault

REPT ALM <MOD2ALM>
REPT ALM COM
REPT EVT <MOD2ALM>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL

Log

REPT DBCHG
RTRV-LOG

Performance

INIT-REG-<MOD2>
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

Ports

ED-<OCN_TYPE>
ED-DS1
ED-EC1
ED-G1000
ED-T1
ED-T3
RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<OCN_TYPE>
RTRV-DS1
RTRV-EC1
RTRV-G1000
RTRV-T1
RTRV-T3

Security

ACT-USER
CANC
CANC-USER
DLT-USER-SECU
ED-PID
ED-USER-SECU
ENT-USER-SECU
REPT EVT SECU

SONET Line Protection

DLT-FFP-<OCN_TYPE>
ED-FFP-<OCN_TYPE>
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
OPR-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<OCN_TYPE>
RTRV-FFP-<OCN_TYPE>

STS and VT Paths

ED-<STS_PATH>
ED-VT1
RTRV-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-VT1

Synchronization

ED-BITS
ED-NE-SYNCN
ED-SYNCN
OPR-SYNCNSW
REPT ALM BITS
REPT ALM SYNCN
REPT EVT BITS
REPT EVT SYNCN
RLS-SYNCNSW
RTRV-ALM-BITS
RTRV-ALM-SYNCN
RTRV-BITS
RTRV-COND-BITS
RTRV-COND-SYNCN
RTRV-NE-SYNCN
RTRV-SYNCN

System

ALW-MSG-ALL
ED-DAT
ED-NE-GEN
INH-MSG-ALL
INIT-SYS
RTRV-HDR
RTRV-INV
RTRV-NE-GEN
RTRV-NE-IPMAP
RTRV-TOD
SET-TOD

Test Access

CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC

Testing

OPR-LPBK-<MOD2_IO>
RLS-LPBK-<MOD2_IO>

UPSR Switching

OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
REPT SW
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1


3.2 TL1 Commands by Card

Table 3-2 TL1 Commands by Card 

Card
Command or Autonomous Message

G1000

DLT-CRS-<STS_PATH>
DLT-EQPT
ED-<STS_PATH>
ED-G1000
ENT-CRS-<STS_PATH>
ENT-EQPT
INIT-SYS
OPR-LPBK-<MOD2_IO>
OPR-PROTNSW-<STS_PATH>
REPT ALM EQPT
REPT ALM <MOD2ALM>
REPT EVT EQPT
REPT EVT <MOD2ALM>
RLS-LPBK-<MOD2_IO>
RLS-PROTNSW-<STS_PATH>

RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-ALM-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-COND-<MOD2ALM>
RTRV-CRS-<STS_PATH>
RTRV-EQPT
RTRV-G1000
RTRV-INV
RTRV-PTHTRC-<STS_PATH>
RTRV-<STS_PATH>
SET-PMMODE-<STS_PATH>

EC1

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
ED-<STS_PATH>
ED-EC1
ED-EQPT
ED-VT1
ENT-CRS-<STS_PATH>
ENT-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RLS-LPBK-<MOD2_IO>

RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-EC1
RTRV-EQPT
RTRV-INV
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

     

DS1

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
ED-<STS_PATH>
ED-EQPT
ED-T1
ED-VT1
ENT-CRS-<STS_PATH>
ENT-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RLS-LPBK-<MOD2_IO>

RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-EQPT
RTRV-INV
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-T1
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

DS1N

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
ED-<STS_PATH>
ED-EQPT
ED-T1
ED-VT1
ENT-CRS-<STS_PATH>
ENT-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RLS-LPBK-<MOD2_IO>

RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-EQPT
RTRV-INV
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-T1
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

DS3

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-EQPT
ED-<STS_PATH>
ED-EQPT
ED-T3
ENT-CRS-<STS_PATH>
ENT-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RLS-LPBK-<MOD2_IO>

RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-EQPT
RTRV-INV
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-T3
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

DS3N

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-EQPT
ED-<STS_PATH>
ED-EQPT
ED-T3
ENT-CRS-<STS_PATH>
ENT-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RLS-LPBK-<MOD2_IO>

RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-EQPT
RTRV-INV
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-T3
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

DS3E

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-EQPT
ED-<STS_PATH>
ED-EQPT
ED-T3
ENT-CRS-<STS_PATH>
ENT-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RLS-LPBK-<MOD2_IO>

RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-EQPT
RTRV-INV
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-T3
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

DS3NE

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-EQPT
ED-<STS_PATH>
ED-EQPT
ED-T3
ENT-CRS-<STS_PATH>
ENT-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RLS-LPBK-<MOD2_IO>

RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-EQPT
RTRV-INV
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-T3
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

DS3XM

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
ED-<STS_PATH>
ED-DS1
ED-EQPT
ED-T3
ED-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
ENT-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT

RLS-LPBK-<MOD2_IO>
RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-DS1
RTRV-EQPT
RTRV-INV
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

OC3

CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
DLT-FFP-<OCN_TYPE>
ED-<OCN_TYPE>
ED-<STS_PATH>
ED-FFP-<OCN_TYPE>
ED-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
ENT-EQPT
ENT-FFP-<OCN_TYPE>
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
OPR-PROTNSW-<OCN_TYPE>
OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
OPR-SYNCNSW
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT ALM SYNCN
REPT EVT <MOD2ALM>
REPT EVT EQPT
REPT EVT SYNCN
RLS-LPBK-<MOD2_IO>

RLS-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1
RLS-SYNCSW
RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<OCN_TYPE>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-ALM-SYNCN
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-EQPT
RTRV-FFP-<OCN_TYPE>
RTRV-INV
RTRV-NE-IPMAP
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

OC12

CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
DLT-FFP-<OCN_TYPE>
ED-<OCN_TYPE>
ED-<STS_PATH>
ED-BLSR
ED-FFP-<OCN_TYPE>
ED-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
ENT-EQPT
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
OPR-PROTNSW-<OCN_TYPE>
OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
OPR-SYNCNSW
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT ALM RING
REPT ALM SYNCN
REPT EVT <MOD2ALM>
REPT EVT EQPT
REPT EVT RING

REPT EVT SYNCN
RLS-LPBK-<MOD2_IO>
RLS-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1
RLS-SYNCSW
RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<OCN_TYPE>
RTRV-<STS_PATH>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-ALM-SYNCN
RTRV-ALM-<MOD2ALM>
RTRV-BLSR
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-EQPT
RTRV-FFP-<OCN_TYPE>
RTRV-INV
RTRV-NE-IPMAP
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

OC48

CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
DLT-FFP-<OCN_TYPE>
ED-<OCN_TYPE>
ED-<STS_PATH>
ED-BLSR
ED-FFP-<OCN_TYPE>
ED-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
ENT-EQPT
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
OPR-PROTNSW-<OCN_TYPE>
OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
OPR-SYNCNSW
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT ALM RING
REPT ALM SYNCN
REPT EVT <MOD2ALM>
REPT EVT EQPT
REPT EVT RING

REPT EVT SYNCN
RLS-LPBK-<MOD2_IO>
RLS-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1
RLS-SYNCSW
RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<OCN_TYPE>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-ALM-SYNCN
RTRV-BLSR
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-EQPT
RTRV-FFP-<OCN_TYPE>
RTRV-INV
RTRV-NE-IPMAP
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

OC48AS

CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
DLT-FFP-<OCN_TYPE>
ED-<OCN_TYPE>
ED-<STS_PATH>
ED-BLSR
ED-FFP-<OCN_TYPE>
ED-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
ENT-EQPT
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
OPR-PROTNSW-<OCN_TYPE>
OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
OPR-SYNCNSW
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT ALM RING
REPT ALM SYNCN
REPT EVT <MOD2ALM>
REPT EVT EQPT
REPT EVT RING

REPT EVT SYNCN
RLS-LPBK-<MOD2_IO>
RLS-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1
RLS-SYNCSW
RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<OCN_TYPE>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-ALM-SYNCN
RTRV-BLSR
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-EQPT
RTRV-FFP-<OCN_TYPE>
RTRV-INV
RTRV-NE-IPMAP
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

OC192

CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
DISC-TACC
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
DLT-EQPT
DLT-FFP-<OCN_TYPE>
ED-<OCN_TYPE>
ED-<STS_PATH>
ED-BLSR
ED-FFP-<OCN_TYPE>
ED-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
ENT-EQPT
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
INIT-REG-<MOD2>
INIT-SYS
OPR-LPBK-<MOD2_IO>
OPR-PROTNSW-<OCN_TYPE>
OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
OPR-SYNCNSW
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT ALM RING
REPT ALM SYNCN
REPT EVT <MOD2ALM>
REPT EVT EQPT
REPT EVT RING

REPT EVT SYNCN
RLS-LPBK-<MOD2_IO>
RLS-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1
RLS-SYNCSW
RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<OCN_TYPE>
RTRV-<STS_PATH>
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-ALM-SYNCN
RTRV-BLSR
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1
RTRV-EQPT
RTRV-FFP-<OCN_TYPE>
RTRV-INV
RTRV-NE-IPMAP
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-TH-<MOD2>
RTRV-VT1
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

E100T

DLT-EQPT
ENT-EQPT
INIT-SYS
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-EQPT
RTRV-INV

E1000

DLT-EQPT
ENT-EQPT
INIT-SYS
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-EQPT
RTRV-INV

TCC+

DLT-EQPT
ED-BITS
ED-NE-GEN
ED-NE-SYNCN
ED-SYNCN
ENT-EQPT
INIT-SYS
OPR-SYNCNSW
REPT ALM <MOD2ALM>
REPT ALM BITS
REPT ALM EQPT
REPT ALM SYNCN
REPT EVT <MOD2ALM>
REPT EVT BITS
REPT EVT EQPT
REPT EVT SYNCN

RLS-SYNCSW
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-BITS
RTRV-ALM-EQPT
RTRV-ALM-SYNCN
RTRV-BITS
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-BITS
RTRV-COND-EQPT
RTRV-EQPT
RTRV-INV
RTRV-NE-GEN
RTRV-NE-SYNCN
RTRV-SYNCN

XC

ALW-SWDX-EQPT
DLT-EQPT
ENT-EQPT
INH-SWDX-EQPT
INIT-SYS
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
REPT SW

RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-EQPT
RTRV-INV
SW-DX-EQPT

XCVT

ALW-SWDX-EQPT
DLT-EQPT
ENT-EQPT
INH-SWDX-EQPT
INIT-SYS
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
REPT SW

RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-EQPT
RTRV-INV
SW-DX-EQPT

XC10G

ALW-SWDX-EQPT
DLT-EQPT
ENT-EQPT
INH-SWDX-EQPT
INIT-SYS
REPT ALM <MOD2ALM>
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT EQPT
REPT SW

RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-EQPT
RTRV-EQPT
RTRV-INV
SW-DX-EQPT

AIC

DLT-EQPT
ENT-EQPT
INIT-SYS
OPR-EXT-CONT
REPT ALM <MOD2ALM>
REPT ALM ENV
REPT ALM EQPT
REPT EVT <MOD2ALM>
REPT EVT ENV
REPT EVT EQPT
RLS-EXT-CONT
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL

RTRV-ALM-ENV
RTRV-ALM-EQPT
RTRV-ATTR-CONT
RTRV-ATTR-ENV
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL
RTRV-COND-ENV
RTRV-COND-EQPT
RTRV-EQPT
RTRV-EXT CONT
RTRV-INV
SET-ATTR-CONT
SET-ATTR-ENV


3.3 TL1 Commands, Categories and Cards

Table 3-3 TL1 Commands, Categories and Cards 

Command or
Autonomous Message
Category
Card(s)

ACT-USER

Security

ALW-MSG-ALL

System

ALW-SWDX-EQPT

Equipment

XC, XCVT, XC10G

ALW-SWTOPROTN-EQPT

Equipment

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM

ALW-SWTOWKG-EQPT

Equipment

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM

CANC

Security

CANC-USER

Security

CHG-ACCMD-<MOD_TACC>

Test Access

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

CONN-TACC-<MOD_TACC>

Test Access

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

DISC-TACC

Test Access

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

DLT-CRS-<STS_PATH>

Cross Connection

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

DLT-CRS-VT1

Cross Connection

EC1, DS1, DS1N, DS3XM, OC3, OC12, OC48, OC48AS, OC192

DLT-EQPT

Equipment

All cards

DLT-FFP-<OCN_TYPE>

SONET Line Protection

OC3, OC12, OC48, OC48AS, OC192

DLT-USER-SECU

Security

ED-<OCN_TYPE>

Ports

OC3, OC12, OC48, OC48AS, OC192

ED-<STS_PATH>

STS and VT Paths

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

ED-BITS

Synchronization

TCC+

ED-BLSR

Cross Connection

OC12, OC48, OC48AS, OC192

ED-DAT

System

ED-DS1

Ports

DS3XM

ED-EC1

Ports

EC1

ED-EQPT

Equipment

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM

ED-FFP-<OCN_TYPE>

SONET Line Protection

OC3, OC12, OC48, OC48AS, OC192

ED-NE-GEN

System

TCC+

ED-NE-SYNCN

Synchronization

TCC+

ED-PID

Security

ED-SYNCN

Synchronization

TCC+

ED-T1

Ports

DS1, DS1N

ED-T3

Ports

DS3, DS3N, DS3E, DS3NE, DS3XM

ED-USER-SECU

Security

ED-VT1

STS and VT Paths

EC1, DS1, DS1N, DS3XM, OC3, OC12, OC48, OC48AS, OC192

ENT-CRS-<STS_PATH>

Cross Connection

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

ENT-CRS-VT1

Cross Connection

DS3XM, OC3, OC12, OC48, OC48AS, OC192

ENT-EQPT

Equipment

All cards

ENT-FFP-<OCN_TYPE>

SONET Line Protection

OC3, OC12, OC48, OC48AS, OC192

ENT-USER-SECU

Security

EX-SW-<OCN_BLSR>

SONET Line Protection

OC12, OC48, OC48AS, OC192

INH-MSG-ALL

System

INH-SWDX-EQPT

Equipment

XC, XCVT, XC10G

INH-SWTOPROTN-EQPT

Equipment

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM

INH-SWTOWKG-EQPT

Equipment

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM

INIT-REG-<MOD2>

Performance

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

INIT-SYS

System

All cards

OPR-EXT-CONT

Environmental Alarms and Controls

AIC

OPR-LPBK-<MOD2_IO>

Testing

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS,OC192

OPR-PROTNSW-<OCN_TYPE>

SONET Line Protection

OC3, OC12, OC48, OC48AS,OC192

OPR-PROTNSW-<STS_PATH>

UPSR Switching

OC3, OC12, OC48, OC48AS, OC192

OPR-PROTNSW-VT1

UPSR Switching

OC3, OC12, OC48, OC48AS,OC192

OPR-SYNCNSW

Synchronization

OC3, OC12, OC48, OC48AS,OC192, TCC+

REPT ALM <MOD2ALM>

Fault

All cards

REPT ALM BITS

Synchronization

TCC+

REPT ALM COM

Fault

REPT ALM ENV

Environmental Alarms and Controls

AIC

REPT ALM EQPT

Equipment

All cards

REPT ALM RING

BLSR

OC12, OC48, OC48AS, OC192

REPT ALM SYNCN

Synchronization

OC3, OC12, OC48, OC48AS,OC192, TCC+

REPT DBCHG

Log

REPT EVT <MOD2ALM>

Fault

All cards

REPT EVT BITS

Synchronization

TCC+

REPT EVT ENV

Environmental Alarms and Controls

AIC

REPT EVT EQPT

Equipment

All cards

REPT EVT RING

BLSR

OC12, OC48, OC48AS, OC192

REPT EVT SECU

Security

REPT EVT SYNCN

Synchronization

OC3, OC12, OC48, OC48AS, OC192, TCC+

REPT SW

Protection

XC, XCVT, XC10G

RLS-EXT-CONT

Environmental Alarms and Controls

AIC

RLS-LPBK-<MOD2_IO>

Testing

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RLS-PROTNSW-<OCN_TYPE>

SONET Line Protection

OC3, OC12, OC48, OC48AS, OC192

RLS-PROTNSW-<STS_PATH>

UPSR Switching

OC3, OC12, OC48, OC48AS, OC192

RLS-PROTNSW-VT1

UPSR Switching

OC3, OC12, OC48, OC48AS, OC192

RLS-SYNCNSW

Synchronization

OC3, OC12, OC48, OC48AS, OC192, TCC+

RMV-<MOD_PORT>

Ports

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RST-<MOD_PORT>

Ports

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RTRV-<OCN_TYPE>

Ports

OC3, OC12, OC48, OC48AS, OC192

RTRV-<STS_PATH>

STS and VT Paths

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RTRV-ALM-<MOD2ALM>

Fault

All cards

RTRV-ALM-ALL

Fault

All cards

RTRV-ALM-BITS

Synchronization

TCC+

RTRV-ALM-ENV

Environmental Alarms and Controls

AIC

RTRV-ALM-EQPT

Equipment

All cards

RTRV-ALM-SYNCN

Synchronization

OC3, OC12, OC48, OC48AS, OC192, TCC+

RTRV-ATTR-CONT

Environmental Alarms and Controls

AIC

RTRV-ATTR-ENV

Environmental Alarms and Controls

AIC

RTRV-BITS

Synchronization

TCC+

RTRV-BLSR

SONET Line Protection

OC12, OC48, OC48AS, OC192

RTRV-COND-<MOD2ALM>

Fault

All cards

RTRV-COND-ALL

Fault

All cards

RTRV-COND-BITS

Synchronization

TCC+

RTRV-COND-ENV

Environmental Alarms and Controls

AIC

RTRV-COND-EQPT

Equipment

All cards

RTRV-COND-SYNCN

Synchronization

TCC+

RTRV-CRS-<STS_PATH>

Cross Connection

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RTRV-CRS-VT1

Cross Connection

EC1, DS1, DS1N, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RTRV-DS1

Ports

DS3XM

RTRV-EC1

Ports

EC1

RTRV-EQPT

Equipment

All cards

RTRV-EXT-CONT

Environmental Alarms and Controls

AIC

RTRV-FFP-<OCN_TYPE>

SONET Line Protection

OC3, OC12, OC48, OC48AS, OC192

RTRV-HDR

System

RTRV-INV

System

All cards

RTRV-LOG

Log

RTRV-NE-GEN

System

TCC+

RTRV-NE-IPMAP

System

OC3, OC12, OC48, OC48AS, OC192

RTRV-NE-SYNCN

Synchronization

TCC+

RTRV-PM-<MOD2>

Performance

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RTRV-PMMODE-<STS_PATH>

Performance

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RTRV-PTHTRC-<STS_PATH>

STS and VT Paths

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC48AS, OC192

RTRV-SYNCN

Synchronization

TCC+

RTRV-T1

Ports

DS1, DS1N

RTRV-T3

Ports

DS3, DS3N, DS3E, DS3NE

RTRV-TH-<MOD2>

Performance

EC1, DS1, DS1N, DS3XM, OC3, OC12, OC48, OC48AS, OC192

RTRV-TOD

System

RTRV-VT1

STS and VT Paths

EC1, DS1, DS1N, DS3XM, OC3, OC12, OC48, OC48AS, OC192

SET-ATTR-CONT

Environmental Alarms and Controls

AIC

SET-ATTR-ENV

Environmental Alarms and Controls

AIC

SET-PMMODE-<STS_PATH>

Performance

G1000, EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

SET-TH-<MOD2>

Performance

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, OC3, OC12, OC48, OC48AS, OC192

SET-TOD

System

SW-DX-EQPT

Equipment

XC, XCVT, XC10G

SW-TOPROTN-EQPT

Equipment

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM

SW-TOWKG-EQPT

Equipment

EC1, DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM


3.4 TL1 Commands

The commands and autonomous messages used in the Cisco ONS 15454, Release 3.2 are described in detail in this section and are listed alphabetically according to the first alpha character of the command string.

Each TL1 command must be less than or equal to 255 characters. Any command larger than 255 characters must be split into multiple commands. For example, if you use the ED-<STS_PATH> command to edit the J1 EXPTRC/TRC message, UPSR attributes, and TACC attributes and the command exceeds 255 characters the command will not be processed. You must use multiple ED-<STS_PATH> commands instead.


Note The AID of any TL1 line mode command is a mandatory field in this TL1 release.



Note TL1 commands that are entered incorrectly are not completed.


3.4.1 ACT-USER: Activate User

This command is used to set-up a session with the Network Element (NE).

Notes:

1. Passwords are visible on-screen when entered for the ENT-USER-SECU and ACT-USER commands. Cisco recommends that you close any windows containing sensitive information after exiting a TL1 session.

2. In this release, the ACT-USER command does not return the date and time of the last session established by the UID or the number of unsuccessful session attempts since the last session.

Section
ACT-USER Description 

Category

Security

Security

N/A

Related Messages

CANC
CANC-USER
DLT-USER-SECU
ED-PID
ED-USER-SECU
ENT-USER-SECU
REPT EVT SECU

Input Format

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

where:

<UID> is the user identifier and is a string; <UID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, %. <UID> must not be null.

<PID> is the user login password and is a string; <PID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, % where at least two characters are non-alphabetic and at least one character is a special character (+, #, or %). <PID> must not be null.

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character CTC-entered <UID> and <PID> are not valid TL1 <UID> and <TID>. For example, if issuing an ACT-USER command using the CTC-entered <UID> that is greater than 10 characters long, TL1 will respond with a DENY (Cannot login) error message.

Example

Input

ACT-USER:PETALUMA:TERRI:100::MYPASSWD;

Errors

This message generates all the default errors


3.4.2 ALW-MSG-ALL: Allow Event All

This command instructs the NE to enter a mode in which all the REPT ALM and REPT EVT autonomous messages are transmitted. See the INH-MSG-ALL command to inhibit these autonomous messages. When a TL1 session starts, the REPT ALM and REPT EVT messages are allowed by default.


Note If this command is issued twice in the same session, the SAAL (Status, Already Allowed) error message will be returned. The optional fields in the e block are not supported.


Section
ALW-MSG-ALL Description 

Category

System

Security

Retrieve

Related Messages

ED-DAT
ED-NE-GEN
ED-NE-SYNCN
INH-MSG-ALL
INIT-SYS
RTRV-HDR
RTRV-INV
RTRV-NE-GEN
RTRV-NE-IPMAP
RTRV-NE-SYNCN
RTRV-TOD
SET-TOD

Input Format

ALW-MSG-ALL:[<TID>]::<CTAG>[::,,];

Example

Input

ALW-MSG-ALL:PETALUMA::549;

Errors

This message generates all the default errors


3.4.3 ALW-SWDX-EQPT: Allow Switch Duplex Equipment

This command instructs an NE to allow automatic or manual switching on a duplex system containing duplexed or redundant equipment. To inhibit an NE switching to duplex, use the INH-SWDX-EQPT command.

ALW-SWDX-EQPT is not used for SONET line or electrical card protection switching. For SONET line or path protection switching commands, see OPR-PROTNSW and RLS-PROTNSW commands. For the electrical card protection switching, see SW-TOWKG-EQPT and SW-TOPROTN-EQPT commands.


Note This command applies to the XC or XCVT equipment unit only in this release.


Section
ALW-SWDX-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWTOPROTN-EQPT REPT ALM EQPT
ALW-SWTOWKG-EQPT REPT EVT EQPT
DLT-EQPT RTRV-ALM-EQPT
ED-EQPT RTRV-COND-EQPT
ENT-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT
INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format

ALW-SWDX-EQPT:[<TID>]:<AID>:<CTAG>[::];

where:

<AID> is the XC/XCVT equipment AID from the "EQPT" section

Example

Input

ALW-SWDX-EQPT:CISCO:SLOT-8:1234;

Errors

This message generates all the default errors


3.4.4 ALW-SWTOPROTN-EQPT: Allow Switch to Protection Equipment

This command instructs the NE to allow automatic or manual switching of an equipment unit back to a protection status. Use the INH-SWTOPROTN-EQPT command to inhibit an NE from switching to protection.

ALW-SWTOPROTN-EQPT is used for non-SONET line cards (e.g. DS1, DS3, DS3XM, and EC1). DS1 and DS3 cards have 1:1 and 1:N equipment protection. DS3XM and EC1 cards have only 1:1 equipment protection. When this command is given to a working unit, the working unit will be allowed to switch to the protection unit. When this command is given to a protection unit, any working unit in the protection group is allowed to switch to the protection unit.

The standing condition of INHSWPR on the unit specified by the AID will be cleared.

Notes:

1. This command only supports one value of the <DIRN> parameter - BTH. A command with any other value is considered an incorrect use of the command. An IDNV (Input, Data Not Valid) error message should be responsed.

2. This command is not used for the common control (TCC+ or XC/XCVT) cards. A command on a common control card will receive an IIAC (Input, Invalid Access Identifier) error message. To use the common control card switching commands, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

3. This command is not used for SONET (OCN) cards. A command on a SONET card will receive an IIAC (Input, Invalid Access identifier) error message. To use a SONET card switching command, use OPR-PROTNSW and RLS-PROTNSW commands.

4. If this command is used on a card that is not in a protection group, the SNVS (Status, Not in Valid State) error message should be responsed.

5. If this command is used on a card that is not in the inhibit state, the SAAL (Status, Already Allowed) error message should be responsed.

6. The following situation(s) are allowed and will not generate any error response: Sending this command to missing cards so long as none of the previous error conditions apply.

Section
ALW-SWTOPROTN-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT REPT ALM EQPT
ALW-SWTOWKG-EQPT REPT EVT EQPT
DLT-EQPT RTRV-ALM-EQPT
ED-EQPT RTRV-COND-EQPT
ENT-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TORPROTN-EQPT
INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format

ALW-SWTOPROTN-EQPT:[<TID>]:<AID>:<CTAG>[::<DIRN>];

where:

<AID> The parameter can either be the protection unit for which carrying traffic is to be allowed (release of lockout) or the working unit for which switching to protect is to be allowed (release of lock on); <AID> is from the "EQPT" section.

<DIRN> is the direction of the switching. The command only supports one value of the <DIRN> parameter - BTH. This parameter defaults to BTH; valid values for <DIRN> are shown in the "DIRECTION" section.

Example

Input

ALW-SWTOPROTN-EQPT:CISCO:SLOT-2:123::BTH;

Errors

This message generates all the default errors


3.4.5 ALW-SWTOWKG-EQPT: Allow Switch to Working Equipment

This command instructs the NE to allow automatic or manual switching of an equipment unit back to a working status. Use the INH-SWTOWKG-EQPT command to inhibit an NE from switching to working. ALW-SWTOWKG-EQPT is used for non-SONET line cards (e.g. DS1, DS3, DS3XM, and EC1). DS1 and DS3 cards have 1:1 and 1:N equipment protection. DS3XM and EC1 cards have only 1:1 equipment protection. When this command is given to a working unit, the working unit will be allowed to carry traffic. When this command is given to a protection unit, the protection unit will be allowed to switch back to the working unit currently protected as long as the working unit has not raised INHSWWKG.

In the case of revertive protection, the traffic will switch immediately from the protection unit to the working unit regardless of the reversion time setting. In the case of non-revertive protection, the protection unit will continue to carry the traffic.

The standing condition of INHSWWKG on the unit specified by the AID will be cleared.

Notes:

1. This command only supports one value of the <DIRN> parameter - BTH. A command with any other value is considered an incorrect use of the command. An IDNV (Input, Data Not Valid) error message should be responsed.

2. This command is not used for the common control (TCC+ or XC/XCVT) cards. A command on a common control card will receive an IIAC (Input, Invalid Access Identifier) error message. To use the common control card switching commands, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

3. This command is not used for SONET (OCN) cards. A command on a SONET card will receive an IIAC (Input, Invalid Access Identifier) error message. To use a SONET card switching command, use the OPR-PROTNSW and RLS-PROTNSW commands.

4. If this command is used on a card that is not in a protection group, the SNVS (Status, Not in Valid State) error message should be responsed.

5. If this command is used on a card that is not in the inhibit state, the SAAL (Status, Already Allowed) error message should be responsed.

6. The following situation(s) are allowed and will not generate any error response: Sending this command to missing cards so long as none of the previous error conditions apply.

Section
ALW-SWTOWKG-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT REPT ALM EQPT
ALW-SWTOPROTN-EQPT REPT EVT EQPT
DLT-EQPT RTRV-ALM-EQPT
ED-EQPT RTRV-COND-EQPT
ENT-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT
INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format

ALW-SWTOWKG-EQPT:[<TID>]:<AID>:<CTAG>[::<DIRN>];

where:

<AID> This parameter can either be the protection unit for which switching back to working is to be allowed (release of lock on) or the working unit for which carrying traffic is to be allowed (release of lockout); <AID> is from the "EQPT" section.

<DIRN> is the direction of the switching. The command only supports one value of the <DIRN> parameter - BTH. This parameter defaults to BTH; valid values for <DIRN> are shown in the "DIRECTION" section.

Example

Input

ALW-SWTOWKG-EQPT:CISCO:SLOT-2:123::BTH;

Errors

This message generates all the default errors


3.4.6 CANC: Cancel

Reports the occurrence of a session timeout event. CANC is an autonomous message transmitted by the NE to a user when a session established by that user is terminated because no messages were exchanged for a long period of time, a timeout. The timeout period is set based on the user's privilege. The superuser [SUPER] has the timeout period of 15 minutes. The Provision user [PROV] has the timeout period of 30 minutes. The Maintenance [MAINT] user has the timeout period of 60 minutes.

When a timeout occurs, the corresponding port drops and the next session initiation at that port requires the regular login procedure.

Section
CANC Description 

Category

Security

Security

Retrieve

Related Messages

ACT-USER
CANC-USER
DLT-USER-SECU
ED-PID
ED-USER-SECU
ENT-USER-SECU
REPT EVT SECU

Output Format

SID DATE TIME
A ATAG CANC
"<UID>"
;

where:

<UID> refers to the user's identification whose session is terminated due to timeout; <UID> is a string.

Example

Output

TID-000 1998-06-20 14:30:00
A 001 CANC
"CISCO15"

;


3.4.7 CANC-USER: Cancel User

This command logs a user out of an active session with the NE.

Section
CANC-USER Description 

Category

Security

Security

Retrieve

Related Messages

ACT-USER
CANC
DLT-USER-SECU
ED-PID
ED-USER-SECU
ENT-USER-SECU
REPT EVT SECU

Input Format

CANC-USER:[<TID>]:<USERID>:<CTAG>;

where:

<USERID> identifies the user to the system; <USERID> defaults to the login UID and is a string; <USERID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, %.

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character CTC-entered <UID> and <PID> are not valid TL1 <UID> and <TID>. For example, if issuing an ACT-USER command using the CTC-entered <UID> that is greater than 10 characters long, TL1 will respond with a DENY (Cannot login) error message.

Example

Input

CANC-USER:PETALUMA:TERRI:101;

Errors

This message generates all the default errors


3.4.8 CHG-ACCMD-<MOD_TACC>: Change Access Mode (DS1, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, T1, T3, VT1)

This command changes the test access (TACC) mode for the circuit being tested. For more information on TACC, refer to the "Test Access" section on page 1-9.

This may be a change from monitoring the data to inserting data into the STS. This command can only be applied to an existing (test access path) TAP connection.

Notes:

1. If there is no TAP connection, a DENY error message will be returned.

2. If a requested condition already exists, a SRCN error message will be returned.

3. If a requested access configuration is invalid, a SRAC error message will be returned

4. If a requested TAP does not exist, a RTEN error message is returned.

Section
CHG-ACCMD-<MOD_TACC> Description 

Category

Test Access

Security

Maintenance

Related Messages

CONN-TACC-<MODE_TACC>
DISC_TACC

Input Format

CHG-ACCMD-<MOD_TACC>:[<TID>]:<TAP>:<CTAG>::<MD>;

where:

<TAP> indicates the test access path number selected by the NE. The TAP is used to identify all messages between the TSC and NE until the access path is released. The TAP number must be an integer with a range of 1 to 999; <TAP> is a number from the "TAP" section.

Note This command only changes a single TAP at a time.

<MD> indicates the test access mode (SPLTE, SPLTF, LOOPE, AND LOOPF require an external QRS input signal); valid values for <MD> are shown in the "TACC_MODE" section

Example

Input

CHG-ACCMD-STS1:CISCO:8:123::MONE;

Errors

This message generates all the default errors


3.4.9 CONN-TACC-<MOD_TACC>: Connect TACC (DS1, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, T1, T3, VT1)

This command connects the STS or VT defined by AID to the STS or VT specified by the TAP number. For more information on TACC, refer to the "Test Access" section on page 1-9.

Notes:

1. If all TAPs are busy, a RABY error message will be returned.

2. If a requested TAP is busy, a RTBY error message will be returned.

3. If a requested TAP does not exist, a RTEN error message will be returned.

4. If a circuit is already connected to another TAP, a SCAT error message will be returned.

5. If a requested condition already exists, a SRCN error message will be returned.

6. If the AID is invalid, a IIAC (Input, Invalid Access Identifier) error message will be returned.

7. If an access is not supported, an EANS error message will be returned.

8. If a requested access configuration is invalid, a SRAC error message will be returned.

Section
CONN-TACC-<MOD_TACC> Description 

Category

Test Access

Security

Provisioning

Related Messages

CHG-ACCMD-<CHG-ACCMD>
DISC-TACC

Input Format

CONN-TACC-<MOD_TACC>:[<TID>]:<AID>:<CTAG>::<TAP>:MD=<MD>;

where:

<AID> is an access identifier. <AID> format is the modifier AID format in the ALL AID list. <AID> is the AID from the "ALL" section.

<TAP> indicates the test access path number selected by the NE. The TAP is used to identify all messages between the TSC and the NE until the access path is released. The TAP number must be an integer with a range of 1 to 999. <TAP> is a number from the "TAP" section.

<MD> indicates the test access mode (SPLTE, SPLTF, LOOPE and LOOPF require an external QRS input signal); valid values for <MD> are shown in the "TACC_MODE" section.

Output Format

SID DATE TIME
M CTAG COMPLD
"<TAP>"
;

where:

<TAP> indicates the test access path number selected by the NE. The <TAP> is used to identify all messages between the TSC and NE until the access path is released. The TAP number must be an integer with a range of 1 - 999; <TAP> is a number of the "TAP" section.

Example

Input

CONN-TACC-STS1:CISCO:STS-2-4:123::8:MD=MONE;

Output

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"8"
;

Errors

This message generates all the default errors


3.4.10 DISC-TACC: Disconnect TACC

This command disconnects the TAP and puts the connection back to its original state (no splits). For more information on TACC, refer to the "Test Access" section on page 1-9.

Notes:

1. If you send this command to an already disconnected connection, a SADC error message is returned.

2. If the system cannot release TAP, an SRTN error message is returned.

Section
DISC-TACC Description 

Category

Test Access

Security

Provisioning

Related Messages

CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>

Input Format

DISC-TACC:[<TID>]:<TAP>:<CTAG>;

where:

<TAP> indicates the test access path number selected by the NE. The TAP is used to identify all messages between the TSC and the NE until the access path is released. The TAP number must be an integer with a range of 1 - 999; <TAP> is a number of the "TAP" section.

Note This command only disconnects a single TAP at a time.

Example

Input

DISC-TACC:CISCO:8:123;

Errors

This message generates all the default errors


3.4.11 DLT-CRS-<STS_PATH>: Delete Cross Connection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command deletes a cross connection between STS paths. STS paths are specified using their STS AID.

Notes:

1. The fields after CTAG (trailing colons) are optional.

2. For the 1-way cross connections the AIDs must be in the same order as originally entered; for the 2-way cross connections, either order will work.

3. This command does not support deleting multiple STS cross connections.

4. Using "&" in the AID field of this command can delete an UPSR STS cross connection.

The following command is used to delete a 1-way selector or 2-way selector and bridge with:

from points: f1, f2

to points: t1

DLT-CRS-{STS_PATH}:[<TID>]:f1&f2,t1:<CTAG>;

The following command is used to delete a 1-way bridge or 2-way selector and bridge with:

from point: f1

to points: t1, t2

DLT-CRS-{STS_PATH}:[<TID>]:f1,t1&t2:<CTAG>;

The following command is used to delete a 1-way or 2-way subtending UPSR connection with:

from point: f1, f2

to points: t1, t2

DLT-CRS-{STS_PATH}:[<TID>]:f1&f2,t1&t2:<CTAG>;

The AID format in the deletion command is the same as the AID format in the retrieved response message. For example, if the output of any retrieved AID is "F1&F2,T1:CCT,STS3C", the deletion command with the AID format (F1&F2,T1) is required to delete this cross connection.

5. All a&b AIDs in the TL1 cross connection command are in the format of WorkingAid&ProtectAid.

6. You can experience some implementation behavior problems if additional drops have been added to the connection object.

Section
DLT-CRS-<STS_PATH> Description 

Category

Cross Connection

Security

Provisioning

Related Messages

DLT-CRS-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1

Input Format

DLT-CRS-<STS_PATH>:[<TID>]:<FROM>,<TO>:<CTAG>[:::];

where:

<FROM> indicates an identifier at one end of the STS cross connection; <FROM> is the AID from the "STS" section.

<TO> indicates an identifier at the other end of the STS cross connection; <TO> is the AID from the "STS" section.

Note A facility AID of FAC-{1-6,12-17}-{1-4} is allowed as the <FROM> or <TO> portions of the cross connect for a G1000-4 card.

Example

Input

DLT-CRS-STS12C:VINBURG:STS-1-1, STS-12-1:102;

Errors

This message generates all the default errors


3.4.12 DLT-CRS-VT1: Delete Virtual Tributary Cross Connect

This command deletes the VT1 cross connections.

Notes:

1. The fields after CTAG (trailing colons) are the optional.

2. For the 1-way cross connections the AIDs must be in same order as originally entered; for the 2-way either order will work.

3. This command does not support deleting multiple VT cross connections.

4. Using "&" in the AID field of this command can delete an UPSR VT cross connection.

The following command is used to delete a 1-way selector or 2-way selector and bridge with:

from points: f1, f2

to points: t1

DLT-CRS-VT1:[<TID>]:f1&f2,t1:<CTAG>;

The following command is used to delete a 1-way bridge or 2-way selector and bridge with:

from point: f1

to points: t1, t2

DLT-CRS-VT1:[<TID>]:f1,t1&t2:<CTAG>;

The following command is used to delete a 1-way subtending UPSR connection or 2-way subtending UPSR connection with:

from points: f1, f2

to points: t1, t2

DLT-CRS-VT1:[<TID>]:f1&f2,t1&t2:<CTAG>;

The AID format in the deletion command is the same as the AID format in the retrieved response message. For example, if the output of any retrieved AID is "F1&F2,T1:CCT", the deletion command with the AID format (F1&F2,T1) is required to delete this cross connection.

5. All a&b AIDs in the TL1 cross connection command are in the format of WorkingAid&ProtectAid.

6. You can experience some implementation behavior problems if additional drops have been added to the connection object.

Section
DLT-CRS-VT1 Description 

Category

Cross Connections

Security

Provisioning

Related Messages

DLT-CRS-<STS_PATH>
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1

Input Format

DLT-CRS-VT1:[<TID>]:<FROM>,<TO>:<CTAG>[:::];

where:

<FROM> indicates an identifier at one end of the VT cross connection; <FROM> is the AID from the "VT1_5" section.

<TO> indicates an identifier at the other end of the VT cross connection; <TO> is the AID from the "VT1_5" section.

Example

Input

DLT-CRS-VT1:CISCO:VT1-2-3-7-2,VT1-4-4-5-2:1234;

Errors

This message generates all the default errors


3.4.13 DLT-EQPT: Delete Equipment

This command deletes a card from a slot in the NE.

This command removes the card type and attributes that were entered for a particular slot. If any facilities are assigned, they are deleted too. The command will be denied if the card is part of a protection group or has a cross-connect end-point.

To delete a card that is part of a protection group, it has to be removed from the protection group first via ED-EQPT.

Error conditions for deleting equipment may be:

1. For a card in a protection group that has a cross connection, DCC or is a synchronization source, the SPLD (Equipment in use) error message will be returned.

2. If a card is not provisioned, an error message will be returned.

Section
DLT-EQPT Description 

Category

Equipment

Security

Provisioning

Related Messages

ALW-SWDX-EQPT REPT ALM EQPT
ALW-SWTOPROTN-EQPT REPT EVT EQPT
ALW-SWTOWKG-EQPT RTRV-ALM-EQPT
ED-EQPT RTRV-COND-EQPT
ENT-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT
INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format

DLT-EQPT:[<TID>]:<AID>:<CTAG>[:::];

where:

<AID> is the equipment unit (slot) to act on and is the AID from the "EQPT" section.

Example

Input

DLT-EQPT:SONOMA:SLOT-1:104;

Errors

This message generates all the default errors


3.4.14 DLT-FFP-<OCN_TYPE>: Delete Facilities Protection Group (OC3, OC12, OC48, OC192)

This command deletes an OCN facility protection group in the 1+1 architecture.


Note If the protection group does not exist, an error message will be returned.


Section
DLT-FFP-<OCN_TYPE> Description 

Category

SONET Line Protection

Security

Provisioning

Related Messages

ED-FFP-<OCN_TYPE>
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
OPR-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<OCN_TYPE>
RTRV-FFP-<OCN_TYPE>

Input Format

DLT-FFP-<OCN_TYPE>:[<TID>]:<WORK>,<PROTECT>:<CTAG>[:::];

where:

<WORK> identifies the working facility and is the AID from the "FACILITY" section.

<PROTECT> identifies the protect facility and is the AID "FACILITY" section.

Example

Input

DLT-FFP-OC3:PETALUMA:FAC-2-1,FAC-1-1:1;

Errors

This message generates all the default errors


3.4.15 DLT-USER-SECU: Delete User Security

This command deletes a user and can only be performed by a Superuser. Privilege levels are described in the ENT-USER-SECU command.

If this command is executed while the user is logged on, the current session for that user continues. Once the user logs out, the same USERID cannot be used to log in again.

Section
DLT-USER-SECU Description 

Category

Security

Security

Superuser

Related Messages

ACT-USER
CANC
CANC-USER
ED-PID
ED-USER-SECU
ENT-USER-SECU
REPT EVT SECU

Input Format

DLT-USER-SECU:[<TID>]:<UID>:<CTAG>;

where:

<UID> is the user identifier and is a string; <UID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, %.

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character CTC-entered <UID> and <PID> are not valid TL1 <UID> and <TID>. For example, if issuing an ACT-USER command using the CTC-entered <UID> that is greater than 10 characters long, TL1 will respond with a DENY (Cannot login) error message.

Example

Input

DLT-USER-SECU:PETALUMA:CISCO15:123;

Errors

This message generates all the default errors


3.4.16 ED-<OCN_TYPE>: Edit (OC3, OC12, OC48, OC192)

This command edits the attributes (i.e. service parameters) and state of an OC-N facility. Allowable states for a facility are Out of Service (OOS) and In Service (IS).

The DCC is bridged to both working and protect in a 1+1 configuration. On the receive side, the active one is selected for DCC. The DCC is provisioned on the working port only in a 1+1 configuration.

All lines in a 1+1 or BLSR must have the same mode. If you change the mode of a line that is in 1+1 or BLSR, an error message will be returned.

Section
ED-<OCN_TYPE> Description 

Category

Ports

Security

Provisioning

Related Messages

ED-DS1
ED-EC1
ED-G1000
ED-T1
ED-T3
RMV-<MOD_PORT>
RST-<MOD_PORT>
RTRV-<OCN_TYPE>
RTRV-DS1
RTRV-EC1
RTRV-G1000
RTRV-T1
RTRV-T3

Input Format

ED-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>:::[DCC=<DCC>,]
[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,]
[PJMON=<PJMON>,][SFBER=<SFBER>,][SDBER=<SDBER>,]
[MODE=<MODE>,][MUX=<MUX>][:<PST>];

where:

<AID> is the access identifier from the "FACILITY" section

<DCC> identifies an OC-N port DCC connection; valid values for <DCC> are shown in the "SDCC_MODE" section

<SYNCMSG> indicates if sync status messaging is enabled or disabled on the facility; valid values for <SYNCMSG> are shown in the "ON_OFF" section

<SENDDUS> indicates that the facility will send out the DUS (do not use for synchronization) value as the sync status message for that facility; valid values are shown in the "ON_OFF" section

<PJMON> identifies an OC-N port PJMON with a value range of [0, highest STS number for the sonet card]; <PJMON> is an integer

<SFBER> identifies an OC-N port SFBER; valid values for <SFBER> are shown in the "SF_BER" section

<SDBER> identifies an OC-N port SDBER; valid values for <SDBER> are shown in the "SD_BER" section

<MODE> identifies an OC-N port mode (e.g. SONET or SDH); valid values for <MODE> are shown in the "OPTICAL_MODE" section

<MUX> K3/Z2 muxponder setting (Y=a muxponder is present); valid values for <MUX> are shown in the "MUX_TYPE" section

<PST> identifies the primary state of an OC-N port state (e.g. IS or OOS); valid values for <PST> are shown in the "PST" section

Example

Input

ED-OC48:PENNGROVE:FAC-6-1:114:::DCC=Y,SYNCMSG=Y,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SONET,MUX=Y:IS;

Errors

This message generates all the default errors


3.4.17 ED-<STS_PATH>: Edit (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command edits the attributes associated with an STS path.

The SFBER, SDBER, RVRTV, and RVTM parameters only apply to UPSR.

The path trace message is a 64 character string including the terminating CR (carriage return) and LF (line feed) that is transported in the J1 byte of the SONET STS Path overhead. Both the EXPTRC and TRC string can be provisioned by user with up to 62 character string.

The EXPTRC indicates the contents of the expected incoming path trace are provisioned by the user. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.

The path trace mode has three modes: OFF, MANUAL, and AUTO. The path trace mode defaults to OFF. The MANUAL mode performs the comparison of the received string with the user-entered expected string. The AUTO mode performs the comparison of the present received string with an expected string set to a previously received string. If there is a mismatch, TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.

The TACC parameter edits an existing single STS or VT and changes it to a test access path. When an editing command on TACC is executed, it assigns the STS for the first 2WAY test access connection and STS=1 as the second 2WAY connection. For STS3C and STS12C, the next available STS of the same width is chosen. For more information on TACC, refer to the "Test Access" section on page 1-9.

J1 is implemented on the DS1/DS1N, DS3, DS3E/DS3NE, DS3XM, EC1, OC3, OC48AS and OC192 cards.

DS3/DS3N, OC12, OC48, E100T, and E1000 cards do not support path trace.

DS1/DS1N, DS3E/DS3NE, and DS3XM support both TRC and EXPTRC in the ED-STS-PATH command.

EC1, OC3, OC48AS, and OC192 only support EXPTRC in the ED-STS-PATH command.


Note Each TL1 command must be less than or equal to 255 characters. Any command larger than 255 characters must be split into multiple commands. For example, if you use the ED-<STS_PATH> command to edit the J1 EXPTRC/TRC message, UPSR attributes, and TACC attributes and the command exceeds 255 characters the command will not be processed. You must use multiple ED-<STS_PATH> commands instead.


Error conditions:

1. If sending this command to edit SFBER or SDBER or RVRTV or RVTM for the non UPSR STS path, an error message (cross-connect does not have UPSR path selector) will be returned.

2. If sending this command to edit the EXPTRC string with the AUTO path trace mode (TRCMODE=AUTO), an error message (incompatible parameter values for exptrc and TRCMODE) will be returned.

3. If sending this command to edit TRC on any card other than DS3(N)E, DS1(N), and DS3XM cards, an error message (TRC-not allowed for monitor paths. Incorrect card type.) will be returned.

4. This command is allowed to edit EXPTRC on DS1(N), DS3(N)E, DS3XM, EC1, OC3, OC48AS, and OC192 cards.

5. If sending this command to edit both TACC and any other attribute(s), the (Parameters Not compatible) error message will be returned.

6. This command is only allowed when there are no circuits/cross connections (no UPSR connections) on that AID.

7. If sending this command to edit TACC on an AID with circuits or cross connections, an error message (VT in Use) will be returned.

8. TACC creation will also be denied on the protect ports/cards.

Section
ED-<STS_PATH> Description 

Category

STS and VT Paths

Security

Provisioning

Related Messages

ED-VT1
RTRV-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>
RTRV-VT1

Input Format

ED-<STS_PATH>:[<TID>]:<AID>:<CTAG>:::[SFBER=<SFBER>,]
[SDBER=<SDBER>,][RVRTV=<RVRTV>,][RVTM=<RVTM>,]
[EXPTRC=<EXPTRC>,][TRC=<TRC>,][TRCMODE=<TRCMODE>,]
[TACC=<TACC>][:];

where:

<AID> is the access identifier from the "STS" section

<SFBER> identifies an STS path SFBER which only applies to UPSR; valid values for <SFBER> are shown in the "SF_BER" section

<SDBER> identifies an STS path SDBER which only applies to UPSR; valid values for <SDBER> are shown in the "SD_BER" section

<RVRTV> identifies a revertive mode which only applies to UPSR; valid values for <RVRTV> are shown in the "ON_OFF" section and <RVRTV> is optional

<RVTM> identifies a revertive time which only applies to UPSR; <RVTM> is not allowed to be set while <RVRTV> is N (non-revertive mode). Valid values for <RVTM> are shown in the "REVERTIVE_TIME" section and <RVTM> is optional

<EXPTRC> indicates the expected path trace message (J1) contents. The EXPTRC is any 64 character string, including the terminating CR (carriage return) and LF (line feed); <EXPTRC> is a string

<TRC> identifies the path trace message to be transmitted. The TRC is any combination of 64 characters, including the terminating CR and LF. The trace byte (J1) continuously transmits a 64 byte string, one byte at a time. A null value defaults to the NE transmitting null characters (Hex 00); <TRC> is a string

<TRCMODE> indicates the path trace mode, and defaults to the OFF mode; valid values for <TRCMODE> are shown in the "TRCMODE" section

<TACC> defines the STS as a test access port with a selected unique TAP number. The TAP number ranges from 0-999. When TACC is 0, the TAP is deleted.

Example

Input

ED-STS1:FERNDALE:STS-2-4:115:::SFBER=1E-3,SDBER=1E-5,RVRTV=Y,
RVTM=1.0,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
TRCMODE=OFF,TACC=8;

Errors

This message generates all the default errors


3.4.18 ED-BITS: Edit Building Integrated Timing Supply

This command edits the BITS reference attributes.

Section
ED-BITS Description 

Category

Synchronization

Security

Provisioning

Related Messages

ED-NE-SYNCN
ED-SYNCN
OPR-SYNCNSW
REPT ALM BITS
REPT ALM SYNCN
REPT EVT BITS
REPT EVT SYNCN
RLS-SYNCNSW
RTRV-ALM-BITS
RTRV-ALM-SYNCN
RTRV-BITS
RTRV-COND-BITS
RTRV-COND-SYNCN
RTRV-NE-SYNCN
RTRV-SYNCN

Input Format

ED-BITS:[<TID>]:<AID>:<CTAG>:::[LINECDE=<LINECDE>,]
[FMT=<FMT>,][SYNCMSG=<SYNCMSG>][:<PST>];

where:

<AID> is the access identifier from the "BITS" section

<LINECDE> is the line code; valid values for <LINECDE> are shown in the "LINE_CODE" section

<FMT> is the frame format; valid values for <FMT> are shown in the "FRAME_FORMAT" section

<SYNCMSG> indicates if this BITS facility supports synchronization status messaging; <SYNCMSG> defaults to on (Y) and valid values are shown in the "ON_OFF" section

<PST> is the state; valid values for <PST> are shown in the "PST" section

Example

Input

ED-BITS:SONOMA:BITS-2:779:::LINECDE=AMI,FMT=ESF,
SYNCMSG=Y:IS;

Errors

This message generates all the default errors


3.4.19 ED-BLSR: Edit Bidirectional Line Switched Ring

This command edits the BLSR attributes.

Notes:

1. Only the RVRTV, RVTM, SRVRTV, SRVTM attributes can be edited for the 4-Fiber BLSR.

2. Only the RVRTV and RVTM attributes can be edited for the 2-Fiber BLSR.

Error conditions:

1. If there is a system error, an SDBE (Status, Internal Data Base Error) error message will be returned.

2. If the NE returns nothing for the required BLSR (BLSR number, AID), a SRQN (Status, Invalid Request) error message will be returned.

3. If sending this command to modify any attribute other than RVRTV, RVTM, SRVRTV, and SRVTM on the 4-Fiber BLSR, an IDNV (Input, Data Not Valid) error message will be returned.

4. If sending this command to modify any attribute other than RVRTV and RVTM on the 2-Fiber BLSR, an IDNV (Input, Data Not Valid) error message will be returned.

5. If sending this command to modify RVTM while RVRTV is in non-revertive mode or SRVTM while SRVRTV is in non-revertive mode, an ICNV (Input, Command Not Valid) error message will be returned.

Section
ED-BLSR Description 

Category

BLSR

Security

Provisioning

Related Messages

RTRV-BLSR

Input Format

ED-BLSR:[<TID>]:<AID>:<CTAG>:::[RVRTV=<RVRTV>,]
[RVTM=<RVTM>,][SRVRTV=<SRVRTV>,][SRVTM=<SRVTM>][:];

where:

<AID> identifies the BLSR of the NE and is from the "BLSR" section (the AID "ALL" is not allowed for edition BLSR)

<RVRTV> identifies the revertive mode and valid values are shown in the "ON_OFF" section

<RVTM> identifies the revertive time and is not allowed to be set while <RVRTV> is N (non-revertive mode); valid values for <RVTM> are shown in the "REVERTIVE_TIME" section

<SRVRTV> identifies the span revertive mode for 4F BLSR only and valid values are shown in the "ON_OFF" section

<SRVTM> identifies the span revertive time for 4F BLSR only and is not allowed to be set while <SRVRTV> is N (non-revertive mode); valid values for <SRVTM> are shown in the "REVERTIVE_TIME" section

Example

Input

ED-BLSR:PETALUMA:BLSR-43:123:::RVRTV=Y,RVTM=2.0,SRVRTV=Y,
SRVTM=5.0;

Errors

This message generates all the default errors


3.4.20 ED-DAT: Edit Date and Time

This command edits the date and the time

Section
ED-DAT Description 

Category

System

Security

Provisioning

Related Messages

ALM-MSG-ALL
ED-NE-GEN
ED-NE-SYNCN
INH-MSG-ALL
INIT-SYS
RTRV-HDR
RTRV-INV
RTRV-NE-GEN
RTRV-NE-IPMAP
RTRV-NE-SYNCN
RTRV-TOD
SET-TOD

Input Format

ED-DAT:[<TID>]::<CTAG>::[<DATE>],[<TIME>];

where:

<DATE> identifies the date and is a string

<TIME> identifies the time and is a string

Example

Input

ED-DAT:CISCO::1234::99-12-21,14-35-15;

Errors

This message generates all the default errors


3.4.21 ED-DS1: Edit DS1 Layer of DS3XM

This command edits the test access attributes on the DS3XM card at the DS1 layer.


Note This command is not allowed if the card is a protecting card.


Section
ED-DS1 Description 

Category

Ports

Security

Provisioning

Related Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>
ED-EC1 RTRV-DS1
ED-G1000 RTRV-EC1
ED-T1 RTRV-G1000
ED-T3 RTRV-T1
RMV-<MOD_PORT> RTRV-T3
RST-<MOD-PORT>

Input Format

ED-DS1:[<TID>]:<AID>:<CTAG>[:::TACC=<TACC>];

where:

<AID> is the access identifier of a DS1 layer entity on the DS3XM card and is from the "DS1" section

<TACC> defines the DS1 as a test access path with a selected unique TAP number. The TAP number ranges from 0-999. When TACC is 0, the TAP is deleted.

Example

Input

ED-DS1:PETALUMA:DS1-2-6-12:123:::TACC=8;

Errors

This message generates all the default errors


3.4.22 ED-EC1: Edit Electrical Carrier

This command edits the attributes of an EC1.


Note This command is not allowed if the card is a protecting card.


Section
ED-EC1 Description 

Category

Ports

Security

Provisioning

Related Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>
ED-DS1 RTRV-DS1
ED-G1000 RTRV-EC1
ED-T1 RTRV-G1000
ED-T3 RTRV-T1
RMV-<MOD_PORT> RTRV-T3
RST-<MOD_PORT>

Input Format

ED-EC1:[<TID>]:<AID>:<CTAG>:::[PJMON=<PJMON>,][LBO=<LBO>]
[:<PST>];

where:

<AID> is the facility AID of an EC1 port and is from the "FACILITY" section

<PJMON> is the SONET pointer number (0 or 1) of an EC1 port and is an integer

<LBO> is the line build out value of an EC1 port; valid values for <LBO> are shown in the "E_LBO" section

<PST> is the state of an EC1 port; valid values for <PST> are shown in the "PST" section

Example

Input

ED-EC1:CISCO:FAC-1-1:123:::PJMON=0,LBO=0-225:IS;

Errors

This message generates all the default errors


3.4.23 ED-EQPT: Edit Equipment

This command edits the attributes for a given equipment slot in the NE. If the card is in an equipment slot, this command is allowed only on the working AID.

The PROTID parameter indicates the unique identifier of the protection group (the protect card). "NULL" is a special value of the PROTID parameter and indicates absence of a protection group. For 1:1 protection type, RVRTV and RVTM parameters can be changed. For 1:1 protection type, if the PROTID parameter is entered as "NULL", the protection group is deleted.

ED-EQPT:[<TID>]:SLOT-2:<CTAG>:::PROTID=NULL;

For 1:N protection type, if the PROTID is "NULL", the AIDs in the list are removed from the protection group. If all the working cards are in the AID list, the protection group is deleted.

Example: if Slot-1, Slot-2 and Slot-4 were the only working cards in the protection group. The following command will remove Slot-4 from the protection group:

ED-EQPT:[<TID>]:SLOT-4:<CTAG>:::PROTID=NULL;

The protection group still has Slot-1 and Slot-2 as working cards.

Following command will remove all the other working cards in the above example and consequently, delete the protection group itself:

ED-EQPT:[<TID>]:SLOT-2&SLOT-1:<CTAG>:::PROTID=NULL;

In summary, the ED-EQPT command can be successfully executed on an already provisioned card to add a working card to or remove one from a protection group. This command is not valid on a protect card. Only cards can be added to or removed from a protection group. Protection type is immutable and is determined at the time of creation of a protection group (while adding the first working card). Once provisioned, the equipment type can not be edited either.

Examples of adding an existing card to a protection group via ED-EQPT command:

1:1 protection group

ED-EQPT::SLOT-2:12:::PROTID=SLOT-1,RVRTV=Y,RVTM=9.0;

1:1 protection group

ED-EQPT::SLOT-2:12:::PROTID=SLOT-3,PRTYPE=1-N,RVTM=6.5;

Error conditions for editing 1:1 or 1:N protection group may be:

1. Editing the PRTYPE or PROTID (non-NULL value) parameters.

2. Editing RVRTV or RVTM when no protection group exists.

3. Editing RVRTV for 1:N protection.

4. Editing RVTM (revertive time) when RVRTV (revertive mode) = N for 1:1 protection.

5. Failed to remove, currently switched to protect.

Section
ED-EQPT Description 

Category

Equipment

Security

Provisioning

Related Messages

ALW-SWDX-EQPT REPT ALM EQPT
ALW-SWTOPROTN-EQPT REPT EVT EQPT
ALW-SWTOWKG-EQPT RTRV-ALM-EQPT
DLT-EQPT RTRV-COND-EQPT
ENT-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT
INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format

ED-EQPT:[<TID>]:<AID>:<CTAG>:::[PROTID=<PROTID>,]
[PRTYPE=<PRTYPE>,][RVRTV=<RVRTV>,][RVTM=<RVTM>][:];

where:

<AID> is the access identifier from the "EQPT" section

<PROTID> is the protecting card slot number of the protection group. <PROTID> accepts Slot 1, 3, 5, 13, 15, and 17 for 1:1 and Slot 3, and 15 for 1:N protection. <PROTID> is the AID from the "PRSLOT" section

<PRTYPE> is the protection group type; valid values for <PRTYPE> are shown in the "PROTECTION_GROUP" section

<RVRTV> is the revertive mode: valid values for <RVRTV> are shown in the "ON_OFF" section

<RVTM> is the revertive time; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section

Example

Input

ED-EQPT:CISCO:SLOT-2:123:::PROTID=SLOT-1,PRTYPE=1-1,RVRTV=Y,
RVTM=9.0;

Errors

This message generates all the default errors


3.4.24 ED-FFP-<OCN_TYPE>: Edit Facilities Protection Group (OC3, OC12, OC48, OC192)

This command edits the optical facility protection.

Notes:

1. This command can be used on both protecting and working AIDs.

2. If you provision the revertive time under the non-revertive mode, an error will be returned.

Section
ED-FFP-<OCN_TYPE> Description 

Category

SONET Line Protection

Security

Provisioning

Related Messages

DLT-FFP-<OCN_TYPE>
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
OPR-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<OCN_TYPE>
RTRV-FFP-<OCN_TYPE>

Input Format

ED-FFP-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>:::[PROTID=<PROTID>,]
[RVRTV=<RVRTV>,][RVTM=<RVTM>,][PSDIRN=<PSDIRN>][:];

where:

<AID> is the facility AID from the "FACILITY" section

<PROTID> is the protection group identifier (protection group name) and is a string; <PROTID> can have a maximum of 32 characters

<RVRTV> identifies a revertive mode; valid values for <RVRTV> are shown in the "ON_OFF" section

<RVTM> identifies a revertive time; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section

<PSDIRN> identifies the switching mode; valid values for <PSDIRN> are shown in the "UNI_BI" section

Example

Input

ED-FFP-OC3:PETALUMA:FAC-1-1:1:::PROTID=PROT_NAME,RVRTV=Y,
RVTM=1.0,PSDIRN=BI;

Errors

This message generates all the default errors


3.4.25 ED-G1000: Edit G1000

This command modifies the attributes related to a G1000 port.

Section
ED-EC1 Description 

Category

Ports

Security

Provisioning

Related Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>
ED-DS1 RTRV-DS1
ED-EC1 RTRV-EC1
ED-T1 RTRV-G1000
ED-T3 RTRV-T1
RMV-<MOD_PORT> RTRV-T3
RST-<MOD_PORT>

Input Format

ED-G1000:[<TID>]:<AID>:<CTAG>:::[MFS=<MFS>,][FLOW=<FLOW>]
[:<PST>];

where:

<AID> is the facility AID of a G1000 port and is from the "FACILITY" section

<MFS> is the maximum frame size; valid values for <MFS> are shown in the "MFS_TYPE" section

<FLOW> is the link auto negotiation value; valid values for <FLOW> are shown in the "ON_OFF" section

<PST> is the state of a G1000 port; valid values for <PST> are shown in the "PST" section

Example

Input

ED-G1000:TID:FAC-1-1:CTAG:::MFS=1548,FLOW=Y:IS;

Errors

This message generates all the default errors


3.4.26 ED-NE-GEN: Edit Network Element GEN

This command edits the general node attributes of the NE.

Notes:

1. Only the IPADDR, IPMASK, DEFRTR and node name can be modified with this command.

2. The node name can be a maximum of 20 characters. If the entered name exceeds 20 characters, an IPNV (Node Name Too Long) error message is returned.

Section
ED-NE-GEN Description 

Category

System

Security

Superuser

Related Messages

ALW-MSG-ALL RTRV-INV
ED-DAT RTRV-NE-GEN
ED-NE-SYNCN RTRV-NE-IPMAP
INH-MSG-ALL RTRV-NE-SYNCN
INIT-SYS RTRV-TOD
RTRV-HDR SET-TOD

Input Format

ED-NE-GEN:[<TID>]::<CTAG>:::[NAME=<NAME>,][IPADDR=<IPADDR>,]
[IPMASK=<IPMASK>,][DEFRTR=<DEFRTR>];

where:

<NAME> indicates the node name and is a string

<IPADDR> indicates the node IP address and is a string

<IPMASK> indicates the node IP mask and is a string

<DEFRTR> indicates the node default router and is a string

Example

Input

ED-NE-GEN:CISCO::123:::NAME=NODENAME,IPADDR=192.168.100.52,
IPMASK=255.255.255.0,DEFRTR=192.168.100.1;

Errors

This message generates all the default errors


3.4.27 ED-NE-SYNCN: Edit Network Element Synchronization

This command edits the synchronization attributes of the NE.

Notes:

1. Although mixed mode timing is supported in this release, it is not recommended. See the "Mixed Mode Timing Support" section on page 1-7 for more information.

2. The existing external and line modes have the same functionality in all 3.x releases:

External mode: the node derives its timing from the BITS inputs.

Line mode: the node derives its timing from the SONET line(s).

Mixed mode: the node derives its timing from the BITS input or SONET lines.

Section
ED-NE-SYNCN Description 

Category

Synchronization

Security

Provisioning

Related Messages

ALW-MSG-ALL RTRV-ALM-BITS
ED-BITS RTRV-ALM-SYNCN
ED-DAT RTRV-BITS
ED-NE-GEN RTRV-COND-BITS
ED-SYNCN RTRV-COND-SYNCN
INH-MSG-ALL RTRV-HDR
INIT-SYS RTRV-INV
OPR-SYNCNSW RTRV-NE-GEN
REPT ALM BITS RTRV-NE-IPMAP
REPT ALM SYNCN RTRV-NE-SYNCN
REPT EVT BITS RTRV-SYNCN
REPT EVT SYNCN RTRV-TOD
RLS-SYNCNSW SET-TOD

Input Format

ED-NE-SYNCN:[<TID>]::<CTAG>:::[TMMD=<TMMD>,]
[SSMGEN=<SSMGEN>,][QRES=<QRES>,][RVRTV=<RVRTV>,]
[RVTM=<RVTM>];

where:

<TMMD> is the timing mode; valid values for <TMMD> are shown in the "TIMING_MODE" section

<SSMGEN> is the SSM message set; valid values for <SSMGEN> are shown in the "SYNC_GENERATION" section

<QRES> is the quality of the RES; valid values for <QRES> are shown in the "SYNC_QUALITY_LEVEL" section

<RVRTV> is the revertive mode; valid values for <RVRTV> are shown in the "ON_OFF" section

<RVTM> is the revertive time; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section

Example

Input

ED-NE-SYNCN:CISCO::123:::TMMD=LINE,SSMGEN=GEN1,
QRES=ABOVE-PRS,RVRTV=Y,RVTM=8.0;

Errors

This message generates all the default errors


3.4.28 ED-PID: Edit Password

This command allows a user to change their own password.

The password cannot be null. It will be echoed as clear text as the message is parsed only after the complete message is entered and terminated.

Notes:

1. The password will not appear in the TL1 log on the NE.

2. You must use the ED-USER-SECU command to change the empty password (Superuser CISCO15 default empty password) to a non-empty, valid password. The ED-PID command cannot be used to change the empty password to a valid password.

3. If you use the ED-PID command to change the password while providing an incorrect old password (including an empty password), both ED-PID and ED-USER-SECU commands will be broken and cannot be used to edit passwords in the current TL1 session. You must exit the TL1 session and login again to perform a valid edit password function by using the ED-PID or ED-USER-SECU commands.

Section
ED-PID Description 

Category

Security

Security

Retrieve

Related Messages

ACT-USER
CANC
CANC-USER
DLT-USER-SECU
ED-USER-SECU
ENT-USER-SECU
REPT EVT SECU

Input Format

ED-PID:[<TID>]:<UID>:<CTAG>::<OLDPID>,<NEWPID>;

where:

<UID> is the user identifier and is a string; <UID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, %.

<OLDPID> is the old password and is a string.

<NEWPID> is the user login password and is a string; <NEWPID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, % where at least two characters are non-alphabetic and at least one character is a special character (+, #, or %).

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character CTC-entered <UID> and <PID> are not valid TL1 <UID> and <TID>. For example, if issuing an ACT-USER command using the CTC-entered <UID> that is greater than 10 characters long, TL1 will respond with a DENY (Cannot login) error message.

Example

Input

ED-PID:CISCO:UID:123::OLDPID,NEWPID;

Errors

This message generates all the default errors


3.4.29 ED-SYNCN: Edit Synchronization

This command edits the synchronization reference list used to determine the sources for the NE's reference clock and the BITS output clock. For each clock, up to three synchronization sources may be specified (e.g., PRIMARY, SECOND, THIRD).To view or edit the system timing mode, use the RTRV-NE-SYNCN or ED-NE-SYNCN commands.


Note To retrieve/set the timing mode, SSM message Set or Quality of RES information, use the RTRV-NE-SYNCN and ED-NE-SYNCN commands.


Section
ED-SYNCN Description 

Category

Synchronization

Security

Provisioning

Related Messages

ED-BITS RTRV-ALM-BITS
ED-NE-SYNCN RTRV-ALM-SYNCN
OPR-SYNCNSW RTRV-BITS
REPT ALM BITS RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-SYNCN
REPT EVT BITS RTRV-NE-SYNCN
REPT EVT SYNCN RTRV-SYNCN
RLS-SYNCNSW

Input Format

ED-SYNCN:[<TID>]:<AID>:<CTAG>:::[PRI=<PRI>,][SEC=<SEC>,]
[THIRD=<THIRD>][:];

where:

<AID> is the synchronization reference to be modified and is from the "SYNC_REF" section

<PRI> is the primary reference of the synchronization and is the AID from the "SYN_SRC" section

<SEC> is the secondary reference of the synchronization and is the AID from the "SYN_SRC" section

<THIRD> is the third reference of the synchronization and is the AID from the "SYN_SRC" section

Example

Input

ED-SYNCN:BOYES:SYNC-NE:112:::PRI=INTERNAL,SEC=INTERNAL,
THIRD=INTERNAL;

Errors

This message generates all the default errors


3.4.30 ED-T1: Edit T1 Facility

This command edits the attributes related to a DS1/T1 port.

Notes:

1. This command is not allowed if the card is a protecting card.

2. If sending this command to edit TACC and any other attribute(s), and the port having the cross connection, the (Parameters Not compatible) error message will be returned.

3. Editing TACC via an ED-xxx command is only allowed when there is no circuit/cross connection on this port. Otherwise, and error message (VT in Use) will be returned.

4. TACC creation will also be denied on the protect ports/cards.

Section
ED-T1 Description 

Category

Ports

Security

Provisioning

Related Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>
ED-DS1 RTRV-DS1
ED-EC1 RTRV-EC1
ED-G1000 RTRV-G1000
ED-T3 RTRV-T1
RMV-<MOD_PORT> RTRV-T3
RST-<MOD_PORT>

Input Format

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

where:

<AID> is the access identifier from the "FACILITY" section

<LINECDE> is the line coding; valid values for <LINECDE> are shown in the "LINE_CODE" section

<FMT> is the frame format; valid values for <FMT> are shown in the "FRAME_FORMAT" section

<LBO> is the line build out; valid values for <LBO> are shown in the "LINE_BUILDOUT" section

<TACC> defines the STS as a test access port with a selected unique TAP number. The TAP number ranges from 0-999. When TACC is 0, the TAP is deleted; <TACC> is an integer.

<PST> is the state; valid values for <PST> are shown in the "PST" section

Example

Input

ED-T1:CISCO:FAC-2-1:1223:::LINECDE=AMI,FMT=ESF,LBO=0-131,
TACC=8:IS;

Errors

This message generates all the default errors


3.4.31 ED-T3: Edit T3 Facility

This command edits the attributes related to a DS3/T3 port.

Notes:

1. This command is not allowed if the card is a protecting card.

2. Both FMT and Line code are not supported for T3/DS3 facility. They are supported on both the DS3XM and DS3E card. The unframed value of the framing format is only supported on the DS3E facility.

3. Sending this command to edit FMT, or Line code on an unsupported card will return an IDNV error message.

4. If sending this command to edit TACC and any other attribute(s), and the port having the cross connection, the (Parameters Not compatible) error message will be returned.

5. Editing TACC via an ED-xxx command is only allowed when there is no circuit/cross connection on this port. Otherwise, and error message (VT in Use) will be returned.

6. TACC creation will also be denied on the protect ports/cards.

Section
ED-T3 Description 

Category

Ports

Security

Provisioning

Related Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>
ED-DS1 RTRV-DS1
ED-EC1 RTRV-EC1
ED-G1000 RTRV-G1000
ED-T1 RTRV-T1
RMV-<MOD_PORT> RTRV-T3
RST-<MOD_PORT>

Input Format

ED-T3:[<TID>]:<AID>:<CTAG>:::[FMT=<FMT>,][LINECDE=<LINECDE>,]
[LBO=<LBO>,][TACC=<TACC>][:<PST>];

where:

<AID> is the facility AID from the "FACILITY" section

<FMT> is the frame format and the unframed value of the framing format is only supported for the DS3E; valid values for <FMT> are shown in the "DS_LINE_TYPE" section

<LINECDE> is the line code; valid values for <LINECDE> are shown in the "DS_LINE_CODE" section

<LBO> is the line buildout; valid values for <LBO> are shown in the "E_LBO" section

<TACC> defines the STS as a test access port with a selected unique TAP number. The TAP number ranges from 0-999. When TACC is 0, the TAP is deleted; <TACC> is an integer

<PST> is the primary state; valid values for <PST> are shown in the "PST" section

Example

Input

ED-T3:CISCO:FAC-1-2:123:::FMT=C-BIT,LINECDE=B3ZS,LBO=0-225:IS;

Errors

This message generates all the default errors


3.4.32 ED-USER-SECU: Edit User Security

This command edits a user's privileges, password, or ID. Only a Superuser may perform this operation. Privilege levels are described in the ENT-USER-SECU command.

Notes:

1. If the password is changed with this command, the password should be blanked out in the TL1 log.

2. You must use the ED-USER-SECU command to change the empty password (Superuser CISCO15 default humpy password) to a non-empty, valid password. The ED-PID command cannot be used to change the empty password to a valid password.

3. If you use the ED-PID command to change the password while providing an incorrect old password (including an empty password), both ED-PID and ED-USER-SECU commands will be broken and cannot be used to edit passwords in the current TL1 session. You must exit the TL1 session and login again to perform a valid edit password function by using the ED-PID or ED-USER-SECU commands.

Section
ED-USER-SECU Description 

Category

Security

Security

Superuser

Related Messages

ACT-USER
CANC
CANC-USER
DLT-USER-SECU
ED-PID
ENT-USER-SECU
REPT EVT SECU

Input Format

ED-USER-SECU:[<TID>]:<UID>:<CTAG>::<NEWUID>,<NEWPID>,,
<UAP>[:];

where:

<UID> is the user identifier and is a string; <UID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, %.

<NEWUID> is the new user identifier and is a string. The <NEWUID> must be a minimum of six, maximum of ten, alphanumeric and special characters;
+, #, %.

<NEWPID> is the new password. The <NEWPID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, % where at least two characters are non-alphabetic and at least one character is a special character (+, #, or %).

<UAP> is the user access privilege; valid values for <UAP> are shown in the "PRIVILEGE" section

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character CTC-entered <UID> and <PID> are not valid TL1 <UID> and <TID>. For example, if issuing an ACT-USER command using the CTC-entered <UID> that is greater than 10 characters long, TL1 will respond with a DENY (Cannot login) error message.

Example

Input

ED-USER-SECU:PETALUMA:CISCO15:123::NEWUID,NEWPID,,MAINT;

Errors

This message generates all the default errors


3.4.33 ED-VT1: Edit Virtual Tributary

This command edits the attributes associated with a VT1 path.

Both RVRTV and RVTM parameters only apply to UPSR.

The TACC parameter edits an existing single VT and changes it to a test access path. The command assigns another VT as part of the same TAP for the second connection. The second VT is arrived at by incrementing the VT group by one and keeping the VT number the same.

Error conditions:

1. Sending this command to edit RVRTV or RVTM for the non UPSR VT path, an error message will be returned.

2. If sending this command to edit both TACC and any other attribute(s), the (Parameters Not compatible) error message will be returned.

3. This command is only allowed whenever there are no circuits/cross connections (no UPSR connections) on that AID.

4. If sending this command to edit TACC on an AID with circuits or cross connections, an error message (VT in Use) will be returned.

5. TACC creation will also be denied on the protect ports/cards.

Section
ED-VT1 Description 

Category

STS and VT Paths

Security

Provisioning

Related Messages

ED-<STS_PATH>
RTRV-<STS_PATH>
RTRV-PTHTRC-<STS_PATH
RTRV-VT1

Input Format

ED-VT1:[<TID>]:<AID>:<CTAG>:::[RVRTV=<RVRTV>,][RVTM=<RVTM>,]
[TACC=<TACC>];

where:

<AID> is the access identifier from the "VT1_5" section and must not be null

<RVRTV> identifies a revertive mode which only applies to UPSR; valid values for <RVRTV> are shown in the "ON_OFF" section and <RVRTV> is optional

<RVTM> identifies a revertive time which only applies to UPSR. <RVTM> is not allowed to be set while <RVRTV> is N (non-Revertive mode); valid values for <RVTM> are shown in the "REVERTIVE_TIME" section

<TACC> defines the VT as a test access path with a selected unique TAP number. The TAP number ranges from 0-999. When TACC is 0, the TAP is deleted.

Example

Input

ED-VT1:CISCO:VT1-2-3-1-4:123:::TACC=8; to create a TAP, or ED-VT1:CISCO:VT1-2-3-1-4:123:::RVRTV=Y,RVTM=1.0,TACC=8; to edit UPSR cross-connects.

Errors

This message generates all the default errors


3.4.34 ENT-CRS-<STS_PATH>: Enter Cross Connect (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command creates an STS cross connection with a cross connection type (CCT).

When a UPSR cross connection is created, the path presented by the first AID is configured to be the preferred path. For example, the AID (f1) of the cross connection (created by ENT-CRS-STS1::f1&f2,t1:123;) is the preferred path.

Notes:

1. The default cross connection type is 2WAY.

2. If a path is already in a connection, it cannot be in another connection even if the other is a 1WAY and the new one will be 1WAY the other direction.

3. This command does not support creating multiple STS cross connections.

4. The UPSR cross STS connection can be created by using "&" in the AID fields of this command.

The following command is used to create a 1WAY selector or 2WAY selector and bridge with:

from points: f1, f2

to points: t1

ENT-CRS-{STS_PATH}:[<TID>]:f1&f2,t1:<CTAG>::[<CCT>];

The following command is used to create a 1WAY bridge or 2WAY selector and bridge with:

from point: f1

to points: t1, t2

ENT-CRS-{STS_PATH}:[<TID>]:f1,t1&t2:<CTAG>::[<CCT>];

The following command is used to create a 1WAY subtending UPSR connection or 2WAY subtending UPSR connection with:

from point: f1, f2

to points: t1, t2

ENT-CRS-{STS_PATH}:[<TID>]:f1&f2,t1&t2:<CTAG>::[<CCT>];

The following command is used to create a 2WAY selector and bridge with:

from point: f1,f2 (f1 is the working side, f2 is the protect side)

nbsp;selector points: s1, s2 (s1 is the working side, s2 is the protect side)

ENT-CRS-{STS_PATH}:[<]:f1&f2,s1&s2:::2WAY;

5. All a&b AIDs in the TL1 cross connection command are in the format of WorkingAid&ProtectAid.

Section
ENT-CRS-<STS_PATH> Description 

Category

Cross Connections

Security

Provisioning

Related Messages

DLT-CRS-<STS_PATH>
DLT-CRS-VT1
ENT-CRS-VT1
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1

Input Format

ENT-CRS-<STS_PATH>:[<TID>]:<FROM>,<TO>:<CTAG>::[<CCT>][::];

where:

<FROM> indicates an identifier at one end of the STS cross connection and is the AID from the "STS" section

<TO> indicates an identifier at the other end of the STS cross connection and is the AID from the "STS" section

<CCT> identifies the cross connection type; valid values for <CCT> are shown in the "CCT" section

Note A facility AID of FAC-{1-6,12-17}-{1-4} is allowed as the <FROM> or <TO> portions of the cross connect for a G1000-4 card. For UPSR cross connections, the FAC aid should not be used in conjunction with the "&" syntax, so <FROM> or <TO> AIDs such as "STS-1-1&FAC-5-1" or "FAC-1-1&FAC-2-1" or "FAC-3-1&STS-2-1" should not be used. However, if the <FROM> or <TO> AID uses multiple STS aids, then the other AID of the cross connection can be a single FAC AID and "STS-1-1&STS-2-1,FAC-5-1" and "FAC-5-1,STS-1-1&STS-2-1" are allowed.

Example

Input

ENT-CRS-STS1:BODEGA:STS-5-1,STS-12-5:116::2WAY;

Errors

This message generates all the default errors


3.4.35 ENT-CRS-VT1: Enter Virtual Tributary Cross Connection

This command creates a VT1 cross connect. When a UPSR cross connection is created, the path presented by the first AID is configured to be the preferred path. For example, the first AID (f1) of the cross connection (created by ENT-CRS-VT1::f1&f2,t1:123;) is the preferred path.

Notes:

1. The default cross connection type is 2WAY.

2. If a path is already in a connection, it cannot be in another connection even if the other is a 1WAY and the new one will be 1WAY the other direction.

3. This command does not support creating multiple VT cross connections.

4. The UPSR VT cross connection can be created by using "&" in the AID fields of this command.

The following command is used to create a 1WAY selector or 2WAY selector and bridge with:

from points: f1, f2

to points: t1

ENT-CRS-VT1:[<TID>]:f1&f2,t1:<CTAG>::[<CCT>];

The following command is used to create a 1WAY bridge or 2WAY selector and bridge with:

from point: f1

to points: t1, t2

ENT-CRS-VT1:[<TID>]:f1,t1&t2:<CTAG>::[<CCT>];

The following command is used to create a 1WAY subtending UPSR connection or 2WAY subtending UPSR connection with:

from point: f1, f2

to points: t1, t2

ENT-CRS-VT1:[<TID>]:f1&f2,t1&t2:<CTAG>::[<CCT>];

The following command is used to create a 2WAY selector and bridge with:

from points: f1, f2 (f1 is the working side, f2 is the protect side)

selector points: s1, s2 (s1 is the working side, s2 is the protect side)

ENT-CRS-VT1:[<]:f1&f2,s1&s2:::2-way;

5. All a&b AIDs in the TL1 cross connection command are in the format of WorkingAid&ProtectAid.

Section
ENT-CRS-VT1 Description 

Category

Cross Connections

Security

Provisioning

Related Messages

DLT-CRS-<STS_PATH>
DLT-CRS-VT1
ENT-CRS-<STS_PATH>
RTRV-CRS-<STS_PATH>
RTRV-CRS-VT1

Input Format

ENT-CRS-VT1:[<TID>]:<FROM>,<TO>:<CTAG>::[<CCT>][::];

where:

<FROM> indicates an identifier at one end of the VT cross connection and is the AID from the "VT1_5" section

<TO> indicates an identifier at the other end of the VT cross connection and is the AID from the "VT1_5" section

<CCT> identifies the cross connection type; valid values for <CCT> are shown in the "CCT" section

Example

Input

ENT-CRS-VT1:CISCO:VT1-2-3-7-2,VT1-4-4-5-2:1234::1WAY;

Errors

This message generates all the default errors


3.4.36 ENT-EQPT: Enter Equipment

This command enters the card type and attributes for a given equipment slot in the NE. It also automatically enters all facilities supported by the card, assigning default values to all port and path attributes.

The command supports optional parameters RVTM (revertive time), RVRTV (revertive behavior), PROTID (unique protection id) and PRTYPE (protection type) for configuring the card in an equipment protection group. PRTYPE can be 1:1 and 1:N. These parameters can only be entered for a working AID. The protect card must already be provisioned before creating the protection group.

1:1 protection involves the odd slot protecting the even slot. The work-protect pair is as follows (2-1, 4-3, 6-5, 16-17, 14-15, 12-13). DS1, DS3, DS3XM, DS3N, DS3E, EC1 and other electrical cards support 1:1 protection. The value of PROTID is the protecting slot and is of the form "slot-x". This command creates a 1:1 protection group. If the command has the optional parameters for creating a protection group and the protection group cannot be created due to an error condition, provisioning of the equipment fails.

The PROTID slot must be provisioned first.

To create 1:1 with the ENT-EQPT command, the working card should not be provisioned first, so the AID type field should be presented in ENT-EQPT for the AID on this <AID>.

The following is an example for a 1:1 protection group:

ENT-EQPT:[<TID>]:SLOT-1:<CTAG>::DS1;

ENT-EQPT:[<TID>]:SLOT-2:<CTAG>::DS1:PROTID=SLOT-1,PRTYPE=1-1,RVTM=5.0,
RVRTV=Y;

1:N protection is always revertive. For 1:N protection, the protect slot can only be Slot 3 or Slot 15. For protect card in Slot 3, the working cards can be in any of the slots on Bank A. Slot 15 is for protection in Bank B. A DSXN (DS1N or DS3N) card must be provisioned in the protect slot. A 1:1 protection cannot be upgraded to 1:N protection. This command creates a 1:N protection group or adds a new card to an existing 1:N protection group. Multiple working AIDs can be entered in a protection group.

The following is an example of provisioning a 1:N protection group with the ENT-EQPT command:

ENT-EQPT:[<TID>]:SLOT-3:<CTAG>::DS1N;

ENT-EQPT:[<TID>]:SLOT-2&SLOT-1:<CTAG>::DS1:PROTID=SLOT-3,PRTYPE=1-N;

The following is an example of provisioning a 1:N protection group with the ED-EQPT command:

ENT-EQPT:[<TID>]:SLOT-1&SLOT-2:<CTAG>::DS1;

ENT-EQPT:[<TID>]:SLOT-3:<CTAG>::DS1N;

ED-EQPT:[<TID>]:SLOT-2&SLOT-1:<CTAG>:::PROTID=SLOT-1,PRTYPE=1-N;

If the provisioning fails for some AIDs, PRTL responses will be provided indicating failed AIDs. If the provisioning fails for all the AIDs, a DENY response will be provided. For both CMPLD and PRTL responses on creating protection group query, the protection group has been created for the successful AID(s) query.

The following is an example for 1:N protection. RVRTV parameter is not valid for 1:N protection.

ENT-EQPT:[<TID]>:SLOT-2:<CTAG>:::PROTID=SLOT-3,PRTYPE=1-N,RVTM=5.0;

In summary, the ENT-EQPT command provisions an equipment successfully on an empty slot if the equipment type is compatible with the slot number. This command can have the optional parameters in the "f" block to provision a card as working card. It has the effect of adding the protection behavior at the time of provisioning itself. For the protection provisioning to succeed, the protect card should have already been provisioned. Trying to execute ENT-EQPT to provision a protection group on an already provisioned card will result in an error.

An example to provision a 1:1 protection group.

ENT-EQPT::SLOT-1:12::DS3; // provision the protect card

ENT-EQPT::SLOT-2:12::DS3:PROTID=SLOT-1,RVRTV=Y,RVTM=8.0; //provision a card and add it to the protection group.

An example to provision a 1:N protection group.

ENT-EQPT::SLOT-3:12::DS3N; //provision the protect card

ENT-EQPT::SLOT-1:12::DS3:PROTID=SLOT-3,RVTM=7.5,PRTYPE=1-N; //provision a card and add it to protection group.

Sending this command to provision a DS3NE card on Slot 1,2,4,5,6,12,13,14,16,or 17, the DS3E card type is presented.

Error conditions for creating 1:1 or 1:N protection groups are:

1. AID sent to non-working slot. The working cards must be in even slots for 1:1 and in the same bank for 1:N and not in Slot 3 or Slot 15.

2. Invalid AID chosen for protection slot.

3. Working AID is already in protection group.

4. AID is a protect AID.

5. The protect card has a circuit.

6. The equipment type does not match with the allowed AID.

7. The slot is already provisioned.

8. The protecting slot is not provisioned.

9. Multiple working AIDs for 1:1 protection.

Section
ENT-EQPT Description 

Category

Equipment

Security

Provisioning

Related Messages

ALW-SWDX-EQPT REPT ALM EQPT
ALW-SWTOPROTN-EQPT REPT EVT EQPT
ALW-SWTOWKG-EQPT RTRV-ALM-EQPT
DLT-EQPT RTRV-COND-EQPT
ED-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT
INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format

ENT-EQPT:[<TID>]:<AID>:<CTAG>::[<AIDTYPE>]:[PROTID=<PROTID>,]
[PRTYPE=<PRTYPE>,][RVRTV=<RVRTV>,][RVTM=<RVTM>][:];

where:

<AID> is the access identifier from the "EQPT" section

<AIDTYPE> is the AID card type; valid values for <AIDTYPE> are shown in the "EQUIPMENT_TYPE" section

<PROTID> is the protecting card slot identifier of the protection group and is the AID from the "PRSLOT" section

<PRTYPE> is the protection group type; valid values for <PRTYPE> are shown in the "PROTECTION_GROUP" section

valid values for <RVRTV> are shown in the "ON_OFF" section

<RVTM> is the revertive time; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section

Example

Input

ENT-EQPT:PETALUMA:SLOT-12:118::DS1:PROTID=SLOT-13,
PRTYPE=1-1,RVRTV=Y,RVTM=8.5:;

Errors

This message generates all the default errors


3.4.37 ENT-FFP-<OCN_TYPE>: Enter Facilities Protection Group (OC3, OC12, OC48, OC192)

This command creates an optical 1+1 protection.

Notes:

1. Protect AID must not be provisioned with traffic.

2. Work AID can be provisioned with traffic.

3. PROTID is a string and can have a maximum length of 32 characters.

4. If you provision the revertive time under the non-revertive mode, an error will be returned.

Section
ENT-FFP-<OCN_TYPE> Description 

Category

SONET Line Protection

Security

Provisioning

Related Messages

DLT-FFP-<OCN_TYPE>
ED-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
OPR-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<OCN_TYPE>
RTRV-FFP-<OCN_TYPE>

Input Format

ENT-FFP-<OCN_TYPE>:[<TID>]:<WORK>,<PROTECT>:
<CTAG>:::[PROTID=<PROTID>,][RVRTV=<RVRTV>,][RVTM=<RVTM>,]
[PSDIRN=<PSDIRN>][:];

where:

<WORK> identifies a working port and is the AID from the "FACILITY" section

<PROTECT> identifies a protection port and is the AID from the "FACILITY" section

<PROTID> is the protection group identifier (protection group name); <PROTID> defaults to the protecting port of the protection group, it is a string and can have a maximum length of 32 characters

<RVRTV> identifies the revertive mode and defaults to N (non-revertive mode); valid values for <RVRTV> are shown in the "ON_OFF" section

<RVTM> identifies the revertive time and defaults to 5.0 minutes; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section

<PSDIRN> identifies the switching mode and defaults to UNI; valid values for <PSDIRN> are shown in the "UNI_BI" section

Example

Input

ENT-FFP-OC3:PETALUMA:FAC-2-1,FAC-1-1:1:::PROTID=PROT_NAME,
RVRTV=Y,RVTM=1.0,PSDIRN=BI;

Errors

This message generates all the default errors


3.4.38 ENT-USER-SECU: Enter User Security


Note Passwords are visible on-screen when entered for the ENT-USER-SECU and ACT-USER commands. Cisco recommends that you close any windows containing sensitive information after exiting a TL1 session.


This command adds a user account. Only a Superuser can do this. Each user is configured as being at one of these four privilege levels:

1. Retrieve [RTRV]: Users possessing this security level can retrieve information from the node, but cannot modify anything. The idle time for Retrieve is unlimited.

2. Maintenance [MAINT]: Users possessing this security level can retrieve information from the node and perform limited maintenance operations such as card resets, Manual/Force/Lockout on cross-connects or in protection groups, and BLSR ring maintenance. The idle time for Maintenance is 60 minutes.

3. Provisioning [PROV]: Users possessing this security level can perform all maintenance actions, and all provisioning actions except those restricted to superusers. The idle time for Provisioning is 30 minutes.

4. Superuser [SUPER]: Users possessing this security level can perform all PROV user actions, plus creating/deleting user security profiles, setting basic system parameters such as time/date, node name, and IP address, doing database backup & restore. The idle time for Superuser is 15 minutes.

Section
ENT-USER-SECU Description 

Category

Security

Security

Superuser

Related Messages

ACT-USER
CANC
CANC-USER
DLT-USER-SECU
ED-PID
ED-USER-SECU
REPT EVT SECU

Input Format

ENT-USER-SECU:[<TID>]:<UID>:<CTAG>::<PID>,,<UAP>[:];

where:

<UID> is the user identifier and is a string; <UID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, %.

<PID> is the user login password and is a string; <PID> must be a minimum of six, maximum of ten, alphanumeric and special characters; +, #, % where at least two characters are non-alphabetic and at least one character is a special character (+, #, or %).

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character CTC-entered <UID> and <PID> are not valid TL1 <UID> and <TID>. For example, if issuing an ACT-USER command using the CTC-entered <UID> that is greater than 10 characters long, TL1 will respond with a DENY (Cannot login) error message.

<UAP> is the user access privilege value; valid values for <UAP> are shown in the "PRIVILEGE" section

Example

Input

ENT-USER-SECU:PETALUMA:CISCO15:123::PSWD,,MAINT;

Errors

This message generates all the default errors


3.4.39 EX-SW-<OCN_BLSR>: Operate Protection Switch (OC12, OC48, OC192)

This command instructs an NE to exercise the algorithm for switching from a working facility to a protection facility without actually performing a switch. It is assumed that the facility being exercised is the working unit. The exercise switching success or failure result will be indicated by an automatic alarm.

Exercise switch for the SONET protection line is not supported in this release. If sending this command to the protection unit, an error message will be returned. In addition to all normal INPUT, EQUIPAGE, PRIVILEGE error codes, the following error codes are also included in this command:

SNVS (Status, Not in Valid State)

SROF (Status, Requested Operation Failed)

SSRD (Status, Switch Request Denied)

Section
EX-SW-<OCN_TYPE> Description 

Category

SONET Line Protection

Security

Maintenance

Related Messages

DLT-FFP-<OCN_TYPE>
ED-FFP-<OCN_TYPE>
ENT-FFP-<OCN_TYPE>
OPR-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<OCN_TYPE>
RTRV-FFP-<OCN_TYPE>

Input Format

EX-SW-<OCN_BLSR>:[<TID>]:<AID>:<CTAG>[::<ST>];

where:

<AID> identifies the facility in the NE to which the switch request is directed. <AID> is from the "FACILITY" section.

<ST> is the BLSR switch type. the switch type is optional and for BLSR protection switch only. <ST> defaults to RING switch type and valid values are shown in the "SWITCH_TYPE" section.

Example

Input

EX-SW-OC48:CISCO:FAC-12-1:123::SPAN;

Errors

This message generates all the default errors


3.4.40 INH-MSG-ALL: Inhibit Message All

This command instructs the NE to enter a mode in which all REPT ALM and REPT EVT autonomous messages are prevented from being transmitted. See the ALW-MSG-ALL to resume these autonomous messages. When a TL1 session starts, the REPT ALM and REPT EVT messages are allowed by default.


Note If this command is used twice in the same session, the SAIN (already inhibited) error message will be returned.


Section
INH-MSG-ALL Description 

Category

System

Security

Retrieve

Related Messages

ALW-MSG-ALL RTRV-INV
ED-DAT RTRV-NE-GEN
ED-NE-GEN RTRV-NE-IPMAP
ED-NE-SYNCN RTRV-NE-SYNCN
INIT-SYS RTRV-TOD
RTRV-HDR SET-TOD

Input Format

INH-MSG-ALL:[<TID>]::<CTAG>[::,,];

Example

Input

INH-MSG-ALL:PETALUMA::550;

Errors

This message generates all the default errors


3.4.41 INH-SWDX-EQPT: Inhibit Switch Duplex Equipment

This command instructs the NE to inhibit automatic or manual switching on a system containing duplex equipment. Use the ALW-SWDX-EQPT command to release the inhibit. This command is not used for SONET line protection switching. For SONET line/path protection switching commands, use the OPR-PROTNSW and RLS-PROTNSW commands. This command is not used for 1:1 and 1:N equipment protection switching, use ALW-SWTOPROTN, ALW-SWTOWKG, INH-SWTOPROTN, INH-SWTOWKG commands.

Notes:

1. This command is applied for XC or XCVT equipment units only in this release.

2. When sending this command to a TCC+ card, an error message will occur because the NE treats the TCC+ as a non-revertive protection group without user control.

Section
INH-SWDX-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT REPT ALM EQPT
ALW-SWTOPROTN-EQPT REPT EVT EQPT
ALW-SWTOWKG-EQPT RTRV-ALM-EQPT
DLT-EQPT RTRV-COND-EQPT
ED-EQPT RTRV-EQPT
ENT-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT
INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format

INH-SWDX-EQPT:[<TID>]:<AID>:<CTAG>[::];

where:

<AID> is the XC/XCVT equipment AID (Slot 8 or Slot 10) from the "EQPT" section

Example

Input

INH-SWDX-EQPT:CISCO:SLOT-1:1234;

Errors

This message generates all the default errors


3.4.42 INH-SWTOPROTN-EQPT: Inhibit Switch to Protection Equipment

This command instructs the NE to inhibit automatic or manual switching of an equipment unit to protection. Use the ALW-SWTOPROTN-EQPT command to release the inhibit.

INH-SWTOPROTN-EQPT is used for non-SONET line cards (e.g. DS1, DS3, DS3XM and EC1 cards). DS1 and DS3 cards have 1:1 and 1:N equipment protection. DS3XM and EC1 cards have only 1:1 equipment protection. When performing a lockout with this command, the traffic will be switched from the unit specified by the AID, unless the working unit being protected has failed or is missing. When performing a lock on with this command and the working unit specified in the AID is in standby, sending this command will also initiate a traffic switch. When traffic is locked on a working unit or locked out of the protection unit with this command, the protection unit will not carry traffic, even if the working unit is pulled from the system.

Sending this command to a working unit in a 1:N protection group does not prevent a protection switch from another working unit in the same protection group. All the working units must be sent this command to prevent a protection switch. If the command is sent only to a subset of the working units, only those working units will have traffic locked on.

The inhibit state is persistent over TCC+ side switches and removal/reboot of all the units in the protection group. The inhibit state can, but does not have to be persistent over a complete power cycle of the NE.

The unit specified by the AID will raise the condition of INHSWPR when this command is sent.

Notes:

1. This command only supports one value of the <DIRN> parameter - BTH. A command with any other value is considered an incorrect use of the command. An IDNV (Input, Data Not Valid) error message should be responsed.

2. This command is not used for the common control (TCC+ or XC/XCVT) cards. A command on a common control card will receive an IIAC (Input, Invalid Access Identifier) error message. To use the common control card switching commands, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

3. This command is not used for SONET (OCN) cards. A command on a SONET card will receive an IIAC (Input, Invalid Access Identifier) error message. To use a SONET card switching command, use the OPR-PROTNSW and RLS-PROTNSW commands.

4. If this command is used on a card that is not in a protection group, the SNVS (Status, Not in Valid State) error message should be received.

5. If this command is used on a card that is already in the inhibit state, the SAIN (Status, Already Inhibited) error message should be received.

6. If sending the inhibit switch to protection command to a working card when the protect card in the same protection group has already raised the condition of INHSWWKG, the SPLD (Status, Protection unit Locked) error message should be responsed.

7. If sending the inhibit switch to protection command to the protect card when a working card in the same protection group has already raised the condition of INHSWWKG, the SWLD (Status, Working unit Locked) error message should be responsed.

8. Sending the inhibit switch to protection command to an active protect card when the peer working card is failed or missing, the SWFA (Status, Working unit Failed) error message should be responsed.

9. The following situation(s) are allowed and will not generate any error response: Sending this command to missing cards as long as none of the previous error conditions apply.

Section
INH-SWTOPROTN-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT REPT ALM EQPT
ALW-SWTOPROTN-EQPT REPT EVT EQPT
ALW-SWTOWKG-EQPT RTRV-ALM-EQPT
DLT-EQPT RTRV-COND-EQPT
ED-EQPT RTRV-EQPT
ENT-EQPT SW-DX-EQPT
INH-SWDX-EQPT SW-TOPROTN-EQPT
INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format

INH-SWTOPROTN-EQPT:[<TID>]:<AID>:<CTAG>[::<DIRN>];

where:

<AID> This parameter can either be the working unit for which switching to protection is inhibited (lock on) or the protection unit for which carrying traffic is to be inhibited (lockout); <AID> is from the "EQPT" section

<DIRN> is the direction of the switching. The command only supports one value of the <DIRN> parameter - BTH. This parameter defaults to BTH; valid values for <DIRN> are shown in the DIRECTION

Example

Input

INH-SWTOPROTN-EQPT:CISCO:SLOT-2:123::BTH;

Errors

This message generates all the default errors


3.4.43 INH-SWTOWKG-EQPT: Inhibit Switch to Working Equipment

This command instructs the NE to inhibit automatic or manual switching of an equipment unit back to the working unit. Use the ALW-SWTOWKG-EQPT command to release the inhibit.

INH-SWTOWKG-EQPT is used for non-SONET line cards (e.g. DS1, DS3, DS3XM and EC1 cards). DS1 and DS3 cards have 1:1 and 1:N equipment protection. DS3XM and EC1 cards have only 1:1 equipment protection. When performing a lockout with this command, the traffic will be switched from the unit specified by the AID, unless the protection unit has failed or is missing. When performing a lock-on with this command and the protection unit specified in the AID is in standby, sending this command will initiate a traffic switch only when there is one working card in the protection group. In the case where there is more than one working card in the protection group, an error will be generated (see error conditions below). When traffic is locked on the protection unit or locked out of a working unit with this command, the working unit will not carry traffic, even if the protection unit is pulled from the system.

The inhibit state is persistent over TCC+ side switches and removal/reboot of all the units in the protection group. The inhibit state can but does not have to be persistent over a complete power cycle of the NE.

The unit specified by the AID will raise the condition of INHSWWKG when this command is sent.

Notes:

1. The command only supports one value of the <DIRN> parameter - BTH. A command with any other value is considered an incorrect use of the command. An IDNV (Input, Data Not Valid) error message should be responsed.

2. This command is not used for the common control (TCC+ or XC/XCVT) cards. A command on a common control card will receive an IIAC (Input, Invalid Access Identifier) error message. To use the common control card switching commands, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

3. This command is not used for SONET (OCN) cards. A command on a SONET card will receive an IIAC (Input, Invalid Access Identifier) error message. To use a SONET card switching command, use the OPR-PROTNSW and RLS-PROTNSW commands.

4. If this command is used on a card that is not in a protection group, the SNVS (Status, Not in Valid State) error message should be received.

5. If this command is used on a card that is already in the inhibit state, the SAIN (Status, Already Inhibited) error message should be received.

6. If sending this command to a working card when the protect card in the same protection group has already raised the condition of INHSWPR, the SPLD (Status, Protection unit Locked) error message should be received.

7. If sending the INH-SWTOWKG command to a protect card when a working card in the same protection group has already raised the condition of INHSWPR, the SWLD (Status, Working unit Locked) error message should be responsed.

8. If sending the INH-SWTOWKG command to an active working card when the protect card has failed or is missing, the SPFA (Status, Protection unit Failed) error message should be received.

9. If sending the INH-SWTOWKG command to an active working card when the protect card is already carrying traffic (this only occurs in a 1:N protection group with N greater than one), the SNVS (Status, Not in Valid State) error message should be received.

10. The following situation is allowed and will not generate any error response: Sending this command to missing cards as long as none of the previous error conditions apply.

Section
INH-SWTOWKG-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT REPT ALM EQPT
ALW-SWTOPROTN-EQPT REPT EVT EQPT
ALW-SWTOWKG-EQPT RTRV-ALM-EQPT
DLT-EQPT RTRV-COND-EQPT
ED-EQPT RTRV-EQPT
ENT-EQPT SW-DX-EQPT
INH-SWDX-EQPT SW-TOPROTN-EQPT
INH-SWTOPROTN-EQPT SW-TOWKG-EQPT

Input Format

INH-SWTOWKG-EQPT:[<TID>]:<AID>:<CTAG>[::<DIRN>];

where:

<AID> This parameter can either be the protection unit for which switching back to working is inhibited (lock on) or the working unit for which carrying traffic is to be inhibited (lockout); <AID> is from the "EQPT" section

<DIRN> is the direction of the switching. The command only supports one value of the <DIRN> parameter - BTH. This parameter defaults to BTH; valid values for <DIRN> are shown in the DIRECTION

Example

Input

INH-SWTOWKG-EQPT:CISCO:SLOT-2:123::BTH;

Errors

This message generates all the default errors


3.4.44 INIT-REG-<MOD2>: Initialize Register (DS1, EC1, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

This command initializes the performance monitoring (PM) registers.

Section
INIT-REG-<MOD2> Description 

Category

Performance

Security

Maintenance

Related Messages

RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

Input Format

INIT-REG-<MOD2>:[<TID>]:<AID>:<CTAG>::,,[<LOCN>],,[<TMPER>][,,];

where:

<AID> is the access identifier. All the STS, VT1_5, facility and DS1 AIDs are supported; <AID> is from the "ALL" section

<LOCN> indicates the location, in reference to the entity identified by the AID, from which the PM value is being retrieved; valid values for <LOCN> are shown in the "LOCATION" section

<TMPER> indicates the accumulation time period for the PM information; valid values for <TMPER> are shown in the "TMPER" section. A null value of <TMPER> defaults to 15-MIN.

Example

Input

INIT-REG-OC3:CISCO:FAC-1-1:1234::,,NEND,,15-MIN;

Errors

This message generates all the default errors


3.4.45 INIT-SYS: Initialize System

This command instructs the NE to initialize the specified card and its associated subsystem(s).

Notes:

1. The SLOT-ALL AID and the list AID are not allowed in this command.

2. Only one level of restart is supported in this command.

3. It is important that the standby TCC+ should be up and running fully standby before this command is sent on the active TCC+ for a period of time. During this time, the system is vulnerable to traffic outages caused by timing disruptions or other causes.

Section
INIT-SYS Description 

Category

System

Security

Maintenance

Related Messages

ALW-MSG-ALL RTRV-INV
ED-DAT RTRV-NE-GEN
ED-NE-GEN RTRV-NE-IPMAP
ED-NE-SYNCN RTRV-NE-SYNCN
INH-MSG-ALL RTRV-TOD
RTRV-HDR SET-TOD

Input Format

INIT-SYS:[<TID>]:<AID>:<CTAG>[::];

where:

<AID> is the access identifier of the equipment unit or slot and is from the "EQPT" section

Example

Input

INIT-SYS:HOTWATER:SLOT-8:201;

Errors

This message generates all the default errors


3.4.46 OPR-EXT-CONT: Operate External Control

This command operates an external control and closes the external control contact.

Notes:

1. The duration is not supported, it defaults to CONTS.

2. In an automatic state, the contact could be opened or closed depending on the provisioned trigger. Therefore, issuing an OPR-EXT-CONT command followed by a RLS-EXT-CONT command might not produce any contact state change.

Section
OPR-EXT-CONT Description 

Category

Environmental Alarms and Controls

Security

Maintenance

Related Messages

REPT ALM ENV RTRV-ATTR-ENV
REPT EVT ENV RTRV-COND-ENV
RLS-EXT-CONT RTRV-EXT-CONT
RTRV-ALM-ENV SET-ATTR-CONT
RTRV-ATTR-CONT SET-ATTR-ENV

Input Format

OPR-EXT-CONT:[<TID>]:<AID>:<CTAG>::[<CONTTYPE>],[<DUR>];

where:

<AID> is the access identifier from the "ENV" section and must not be null

<CONTTYPE> is the type of control; valid values for <CONTTYPE> are shown in the "CONTTYPE" section

<DUR> is the duration of the external control release, it is not supported and a null value defaults to CONTS; valid values for <DUR> are shown in the "DURATION" section

Example

Input

OPR-EXT-CONT:CISCO:ENV-OUT-2:123::AIRCOND,CONTS;

Errors

This message generates all the default errors


3.4.47 OPR-LPBK-<MOD2_IO>: Operate Loopback (DS1, EC1, G1000, OC3, OC12, OC48, OC192, T1, T3)

This command operates a signal loopback on an I/O card.

Notes:

1. The optional [<LPBKTYPE>] defaults to FACILITY in this command.

2. The TERMINAL loopback type is not supported for the DS1 line of a DS3XM card.

Section
OPR-LPBK-<MOD2_IO> Description 

Category

Testing

Security

Maintenance

Related Messages

RLS-LPBK-<MOD2_IO>

Input Format

OPR-LPBK-<MOD2_IO>:[<TID>]:<AID>:<CTAG>::,,,[<LPBKTYPE>];

where:

<AID> is the access identifier. The <AID> is only supported for FACILITY and DS1; <AID> is from the "ALL" section

<LPBKTYPE> indicates the loopback type; valid values for <LPBKTYPE> are shown in the "LPBK_TYPE" section

Example

Input

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

Errors

This message generates all the default errors


3.4.48 OPR-PROTNSW-<OCN_TYPE>: Operate Protection Switch (OC3, OC12, OC48, OC192)

This command instructs the NE to initiate a SONET line protection switch request. User switch requests initiated with this command remain active until they are released via the RLS-PROTNSW-OCN command or are overridden by a higher priority protection switch request.

The switch commands; MAN (Manual Switch), FRCD (Forced Switch) and LOCKOUT (Lockout) are supported by the ONS 15454.

Manual Switch of Protection Line (to Working Line). If the AID identifies the protection line, then (only in the 1+1 architecture) service will be transferred from the protection line to the working line, unless a request of equal or higher priority is in effect.

Manual Switch of Working Line (to Protection Line). If the AID identifies a working line, then service will be switched from the working line to the protection line unless a request of equal or higher priority is in effect.

Force Switch of Protection Line (to Working Line). If the AID identifies the protection line, then (only in the 1+1 architecture) service will be transferred from the protection line to the working line unless a request of equal or higher priority is in effect.

Force Switch of Working Line (to Protection Line). If the AID identifies a working line, then service will be transferred from the working line to the protection line unless a request of equal or higher priority is in effect. A lockout of protection and a signal fail of protection line have higher priority than this switch command.

Lockout of Protection Line. If the AID identifies the protection line, this switch command will prevent the working line from switching to protection line. If the working line is already on protection, then the working line will be switched back to its original working line.

Lockout of Protection Line. If the AID identifies protection line, this switch command will prevent the working line from switching to protection line. If the working line is already on protection, then the working line will be switched back from protection line to its original working line.

Notes:

1. This command is not used for the common control (TCC+ or XC/XCVT) cards. A query on a common control card will generate an IIAC (Input, Invalid Access Identifier) error message. To use this command on the common control card switching commands, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

2. Sending this command on non-SONET (OCN) cards, an IIAC (Input, Invalid Access Identifier) error message should be received. To query on a non-SONET card switching command, use the ALW-SWTOPROTN/SWTOWKG-EQPT and INH-SWTOPROTN/SWTOWKG-EQPT commands.

3. When sending this command to query on a card that is not in a protection group, the SNVS (Status, Not in Valid State) error message should be received.

4. When sending this command to a working card that is failed or missing, the SWFA (Status, Working unit Failed) error message should be received.

5. When sending this command to a protect card that is failed or missing, the SPFA (Status, Protection unit Failed) error message should be received.

6. When sending this command to a card that is already in protection with a higher priority, the SSRD (Status, Switch Request Denied) error message should be received.

7. Sending this command to an OCN line with a switching mode that is already in mode, will return a SAMS (Already in the Maintenance State) error message.

8. To view current PROTNSW operation on a facility in a two-fiber BLSR configuration, you need to issue two separate commands; RTRV-BLSR and RTRV-COND-ALL. RTRV-BLSR determines the facility for EASTWORK and WESTWORK, for example:

RTRV-BLSR:::C0; 
RTRV-BLSR:::C0; IP C0 
< 
   vadv-o7 1970-01-01 19:10:39 
M C3 COMPLD 
   "BLSR-45::RINGID=45,NODEID=1,MODE=2F,RVRTV=Y,RVTM=5.0,EASTWORK=FAC-13-1, 
   WESTWORK=FAC-12-1," 
;

From the East or West facilities, you can determine the actual facilities, for example, using RTRV-COND-ALL:::C4, you can see the available PROTNSW operate status for the facilities:

RTRV-COND-ALL:::C4; 
RTRV-COND-ALL:::C4;IP C4 
< 
   vadv-07 1970-01-01 19:12:59 
M C4 COMPLD 
   "FAC-13-1,OC48:NA,RING-SW-EAST ,NSA,,,,,\"Ring Switch is active on the East Side\"" 
   "FAC-12-1,OC48:NA,FORCED-REQ-RING,NSA,,,,,\"Force switch request on ring\"" 
   "FAC-13-1,OCN48:NA,MANUAL-REQ-RING,NSA,,,,,\"Manual switch request on Ring\" 
;

In above examples, through RTRV-COND-ALL, you will know that FAC-12-1 and FAC-13-1 have PRTNSW status FORCED-REQ-RING and MANUAL-REQ-RING.

Section
OPR-PROTNSW-<OCN_TYPE> Description 

Category

SONET Line Protection

Security

Maintenance

Related Messages

DLT-FFP-<OCN_TYPE>
ED-FFP-<OCN_TYPE>
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
RLS-PROTNSW-<OCN_TYPE>
RTRV-FFP-<OCN_TYPE>

Input Format

OPR-PROTNSW-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>::<SC>,[<ST>];

where:

<AID> identifies the facility in the NE to which the switch request is directed and is from the "FACILITY" section

<SC> is the switch command on the facility; valid values for <SC> are shown in the "SWITCH" section

<ST> is the BLSR switch type. The switch type is optional, and for BLSR protection switch only. <ST> defaults to RING switch type and valid values are shown in the "SWITCH_TYPE" section

Example

Input

OPR-PROTNSW-OC48:CHICKALUMA:FAC-6-1:204::LOCKOUT,SPAN;

Errors

This message generates all the default errors


3.4.49 OPR-PROTNSW-<STS_PATH>: Operate Protection Switch (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command instructs a SONET NE to initiate a SONET path protection (UPSR) switch request. User switch requests initiated with this command (forced switch, lockout, and manual switch) remain active until they are released through the RLS-PROTNSW-<STS_PATH> command or overridden by a higher priority protection switch request.

Notes:

1. This command applies to UPSR configuration only.

2. The VTAID should be working or protect AID only.

3. Sending this command on the Drop AID, a DENY (Invalid AID, should use working/protect AID) message will be returned.

Section
OPR-PROTNSW-<STS_PATH> Description 

Category

UPSR Switching

Security

Maintenance

Related Messages

OPR-PROTNSW-VT1
REPT SW
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1

Input Format

OPR-PROTNSW-<STS_PATH>:[<TID>]:<AID>:<CTAG>::<SC>[:];

where:

<AID> identifies the entity in the NE to which the switch request is directed and is from the "STS" section

<SC> is the switch command that is to be initiated on the paths; valid values for <SC> are shown in the "SWITCH" section

Example

Input

OPR-PROTNSW-STS1:CISCO:STS-2-1:123::MAN;

Errors

This message generates all the default errors


3.4.50 OPR-PROTNSW-VT1: Operate Virtual Tributary Protection Switch

This command instructs a SONET NE to initiate a SONET path protection (UPSR) switch request. User switch requests initiated with this command (forced switch, lockout, and manual switch) remain active until they are released through the RLS-PROTNSW-VT1 command or overridden by a higher priority protection switch request.

Notes:

1. This command applies to UPSR configuration only.

2. The VTAID should be working or protect AID only.

3. Sending this command on the Drop AID, a DENY (Invalid AID, should use working/protect AID) message will be returned.

Section
OPR-PROTNSW-VT1 Description 

Category

UPSR Switching

Security

Maintenance

Related Messages

OPR-PROTNSW-<STS_PATH>
REPT SW
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1

Input Format

OPR-PROTNSW-VT1:[<TID>]:<AID>:<CTAG>::<SC>[:];

where:

<AID> identifies the entity in the NE to which the switch request is directed and is from the "VT1_5" section

<SC> is the switch command that is to be initiated on the paths; valid values for <SC> are shown in the "SWITCH" section

Example

Input

OPR-PROTNSW-VT1:CISCO:VT1-5-2-4-1:123::MAN;

Errors

This message generates all the default errors


3.4.51 OPR-SYNCNSW: Operate Synchronization Switch

This command forces the NE to switch to the reference specified by the synchronization reference number if the reference supplied is valid, otherwise the command will fail.

The Operate Synchronization Switches are released by the RLS-SYNCNSW command or are overridden by a synchronization reference failure.

Once the switch is effective, an event "MANSWTOPRI", Manual Switch to Primary (or Secondary ...) Reference, will be raised

.

Section
OPR-SYNCNSW Description 

Category

Synchronization

Security

Maintenance

Related Messages

ED-BITS RTRV-ALM-BITS
ED-NE-SYNCN RTRV-ALM-SYNCN
ED-SYNCN RTRV-BITS
REPT ALM BITS RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-SYNCN
REPT EVT SYNCN RTRV-NE-SYNCN
RLS-SYNCNSW RTRV-SYNCN

Input Format

OPR-SYNCNSW:[<TID>]:[<AID>]:<CTAG>::<SWITCHTO>;

where:

<AID> is the access identifier from the "SYNC_REF" section. A null value of <AID> defaults to SYNC-NE.

<SWITCHTO> identifies the new synchronization reference that will be used and is the AID from the "SYNCSW" section

Example

Input

OPR-SYNCNSW:CISCO:SYNC-NE:3::PRI;

Errors

This message generates all the default errors


3.4.52 REPT ALM <MOD2ALM>: Report Alarm (DS1, E100, E1000, EC1, G1000, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

Reports an alarm condition against a facility or a path.

Section
REPT ALM <MOD2ALM> Description 

Category

Fault

Security

Retrieve

Related Messages

REPT ALM BITS RTRV-ALM-ENV
REPT ALM COM RTRV-ALM-EQPT
REPT ALM ENV RTRV-ALM-SYNCN
REPT ALM EQPT RTRV-COND-<MOD2ALM>
REPT ALM RING RTRV-COND-ALL
REPT ALM SYNCN RTRV-COND-BITS
RTRV-ALM-<MOD2ALM> RTRV-COND-ENV
RTRV-ALM-ALL RTRV-COND-EQPT
RTRV-ALM-BITS RTRV-COND-SYNCN

Output Format

SID DATE TIME
** ATAG REPT ALM <MOD2ALM>
"<AID>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<CONDDESR>],
[<AIDDET>]"
;

where:

<AID> is the access identifier

<NTFCNCDE> indicates a 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> indicates an alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

<AIDDET> specifies the AID type; valid values for <AIDDET> are shown in the "EQPT_TYPE" section, <AIDDET> is optional

Example

Output

TID-000 1998-06-20 14:30:00
** 001 REPT ALM DS1
"FAC-2-1:MJ,LOS,SA,,,,:\"LOSS OF SIGNAL\",OC12"
;


3.4.53 REPT ALM BITS: Report Alarm Building Integrated Timing Supply

Reports an alarm condition on a BITS facility.

Section
REPT ALM BITS Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RTRV-ALM-ALL
ED-NE-SYNCN RTRV-ALM-BITS
ED-SYNCN RTRV-ALM-ENV
OPR-SYNCNSW RTRV-ALM-EQPT
REPT ALM <MOD2ALM> RTRV-ALM-SYNCN
REPT ALM COM RTRV-BITS
REPT ALM ENV RTRV-COND-<MOD2ALM>
REPT ALM EQPT RTRV-COND-ALL
REPT ALM RING RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-ENV
REPT EVT BITS RTRV-COND-EQPT
REPT EVT SYNCN RTRV-COND-SYNCN
RLS-SYNCNSW RTRV-NE-SYNCN
RTRV-ALM-<MOD2ALM> RTRV-SYNCN

Output Format

SID DATE TIME
** ATAG REPT ALM BITS
"<AID>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<CONDDESR>]"
;

where:

<AID> is the access identifier from the "BITS" section

<NTFCNCDE> identifies a 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> indicates an alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
** 001 REPT ALM BITS
"BITS-1:MJ,SYNC,SA,,,,:\"LOSS OF TIMING\""
;


3.4.54 REPT ALM COM: Report Alarm COM

Reports an alarm condition when an AID cannot be given, for example, a fan failure is reported using this message.

Section
REPT ALM COM Description 

Category

Fault

Security

Retrieve

Related Messages

REPT ALM <MOD2ALM> RTRV-ALM-ENV
REPT ALM BITS RTRV-ALM-EQPT
REPT ALM ENV RTRV-ALM-SYNCN
REPT ALM EQPT RTRV-COND-<MOD2ALM>
REPT ALM RING RTRV-COND-ALL
REPT ALM SYNCN RTRV-COND-BITS
RTRV-ALM-<MOD2ALM> RTRV-COND-ENV
RTRV-ALM-ALL RTRV-COND-EQPT
RTRV-ALM-BITS RTRV-COND-SYNCN

Output Format

SID DATE TIME
** ATAG REPT ALM COM
"[<AID>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<CONDDESR>]"
;

where:

<AID> indicates the alarm without AID; <AID> is a string and is optional

<NTFCNCDE> indicates a notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> indicates an alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
** 001 REPT ALM COM
"COM:MJ,FAN,NSA,,,,:\"FAN FAILURE\""
;


3.4.55 REPT ALM ENV: Report Alarm Environment

Reports a customer-defined condition on an environmental alarm input.

Section
REPT ALM ENV Description 

Category

Environmental Alarms and Controls

Security

Retrieve

Related Messages

OPR-EXT-CONT RTRV-ALM-EQPT
REPT ALM <MOD2ALM> RTRV-ALM-SYNCN
REPT ALM BITS RTRV-ATTR-CONT
REPT ALM COM RTRV-ATTR-ENV
REPT ALM EQPT RTRV-COND-<MOD2ALM>
REPT ALM RING RTRV-COND-ALL
REPT ALM SYNCN RTRV-COND-BITS
REPT EVT ENV RTRV-COND-ENV
RLS-EXT-CONT RTRV-COND-EQPT
RTRV-ALM-<MOD2ALM> RTRV-COND-SYNCN
RTRV-ALM-ALL RTRV-EXT-CONT
RTRV-ALM-BITS SET-ATTR-CONT
RTRV-ALM-ENV SET-ATTR-ENV

Output Format

SID DATE TIME
** ATAG REPT ALM ENV
"<AID>:<NTFCNCDE>,<ALMTYPE>,,,[<CONDDESR>]"
;

where:

<AID> identifies an environmental input and is from the "ENV" section

<NTFCNCDE> identifies a 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<ALMTYPE> abbreviated code identifying the alarm; valid values for <ALMTYPE> are shown in the "ENV_ALM" section

<CONDDESR> is the alarm message; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
** 001 REPT ALM ENV
"ENV-IN-1:MJ,OPENDR,,,\"OPEN DOOR\""
;


3.4.56 REPT ALM EQPT: Report Alarm Equipment

Reports an alarm condition against an equipment unit or slot.

Section
REPT ALM EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT RTRV-ALM-<MOD2ALM>
ALW-SWTOPROTN-EQPT RTRV-ALM-ALL
ALW-SWTOWKG-EQPT RTRV-ALM-BITS
DLT-EQPT RTRV-ALM-ENV
ED-EQPT RTRV-ALM-EQPT
ENT-EQPT RTRV-ALM-SYNCN
INH-SWDX-EQPT RTRV-COND-<MOD2ALM>
INH-SWTOPROTN-EQPT RTRV-COND-ALL
INH-SWTOWKG-EQPT RTRV-COND-BITS
REPT ALM <MOD2ALM> RTRV-COND-ENV
REPT ALM BITS RTRV-COND-EQPT
REPT ALM COM RTRV-COND-SYNCN
REPT ALM ENV RTRV-EQPT
REPT ALM RING SW-DX-EQPT
REPT ALM SYNCN SW-TOPROTN-EQPT
REPT EVT EQPT SW-TOWKG-EQPT

Output Format

SID DATE TIME
** ATAG REPT ALM EQPT
"<AID>:<NTFCNCDE>,<CONDITION>,<SRVEFF>,,,,:[<CONDDESR>],
[<AIDDET>]"
;

where:

<AID> is the equipment AID SLOT-{1-17} from the "EQPT" section

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDITION> is the type of alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

<AIDDET> specifies the type of AID; valid values for <AIDDET> are shown in the "EQPT_TYPE" section, <AIDDET> is optional

Example

Output

TID-000 1998-06-20 14:30:00
** 001 REPT ALM EQPT
"SLOT-7:MJ,CONTR,NSA,,,,:\"CONTROLLER FAILURE\",TCC"
;


3.4.57 REPT ALM RING: Report Alarm Ring

Reports an alarm condition against a ring object for BLSR.

Section
REPT ALM RING Description 

Category

BLSR

Security

Retrieve

Related Messages

REPT ALM <MOD2ALM> RTRV-ALM-ENV
REPT ALM BITS RTRV-ALM-EQPT
REPT ALM COM RTRV-ALM-SYNCN
REPT ALM ENV RTRV-COND-<MOD2ALM>
REPT ALM EQPT RTRV-COND-ALL
REPT ALM SYNCN RTRV-COND-BITS
RTRV-ALM-<MOD2ALM> RTRV-COND-ENV
RTRV-ALM-ALL RTRV-COND-EQPT
RTRV-ALM-BITS RTRV-COND-SYNCN

Output Format

SID DATE TIME
** ATAG REPT ALM RING
"<AID>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<CONDDESR>]"
;

where:

<AID> identifies a BLSR ring ID with alarm condition; <AID> is a string.

<NTFCNCDE> indicates a 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> indicates a BLSR ring alarm; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
** 001 REPT ALM RING
"RING-999:MJ,PRC-DUPID,SA,,,,:\"DUPLICATE NODE ID\","
;


3.4.58 REPT ALM SYNCN: Report Alarm Synchronization

Reports an alarm condition against a synchronization reference.

Section
REPT ALM SYNCN Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RTRV-ALM-ALL
ED-NE-SYNCN RTRV-ALM-BITS
ED-SYNCN RTRV-ALM-ENV
OPR-SYNCNSW RTRV-ALM-EQPT
REPT ALM <MOD2ALM> RTRV-ALM-SYNCN
REPT ALM BITS RTRV-BITS
REPT ALM COM RTRV-COND-<MOD2ALM>
REPT ALM ENV RTRV-COND-ALL
REPT ALM EQPT RTRV-COND-BITS
REPT ALM RING RTRV-COND-ENV
REPT EVT BITS RTRV-COND-EQPT
REPT EVT SYNCN RTRV-COND-SYNCN
RLS-SYNCNSW RTRV-NE-SYNC
RTRV-ALM-<MOD2ALM> RTRV-SYNCN

Output Format

SID DATE TIME
** ATAG REPT ALM SYNCN
"<AID>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<CONDDESR>]"
;

where:

<AID> identifies a synchronization reference with alarm condition and is from the "SYNC_REF" section

<NTFCNCDE> indicates a 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> indicates an alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
** 001 REPT ALM SYNCN
"SYNC-NE:MJ,MAN,SA,,,,:\"MANUAL SWITCH\","
;


3.4.59 REPT DBCHG: Report Change

Reports any changes on the NE that result from:

1. TL1 provisioning commands or their GUI equivalents containing the verbs: ALW, DLT, ED, ENT, INH, INIT, OPR, RLS, SET, and SW (for example, DLT-EQPT,ENT-CRS-STS1)

2. External event such as a board insertion.

Section
REPT DBCHG Description 

Category

Log

Security

Retrieve

Related Messages

RTRV-LOG

Output Format

SID DATE TIME
A ATAG REPT DBCHG
"TIME=<TIME>,DATE=<DATE>,[SOURCE=<SOURCE>,]
[USERID=<USERID>,]DBCHGSEQ=<DBCHGSEQ>:<COMMAND>:<AID>"
;

where:

<TIME> is the time of the message triggered by the NE; <TIME> is a time.

<DATE> is the date of the message triggered by the NE; <DATE> is a date.

<SOURCE> is an input command CTAG if present; <SOURCE> is an integer and is optional.

<USERID> is the user name or user identifier; <USERID> is a string and is optional.

<DBCHGSEQ> is a sequential number of the DBCHG message; <DBCHGSEQ> is an integer.

<COMMAND> is the input command or substitute; <COMMAND> is a string.

<AID> is the AID(s) or substitute; <AID> is a string.

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT DBCHG
"TIME=14-35-46,DATE=99-07-28,SOURCE=123,USERID=CISCO15,
DBCHGSEQ=456:ENT-CRS-VT1:VT1-4-2-6-4"
;


3.4.60 REPT EVT <MOD2ALM>: Report Event (DS1, E100, E1000, EC1, G1000, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

Reports the occurrence of a non-alarmed event.

Section
REPT EVT <MOD2ALM> Description 

Category

Fault

Security

Retrieve

Related Messages

REPT ALM <MOD2ALM> REPT EVT EQPT
REPT ALM BITS REPT EVT RING
REPT ALM COM REPT EVT SECU
REPT ALM ENV REPT EVT SYNCN
REPT ALM EQPT RTRV-ALM-<MOD2ALM>
REPT ALM RING RTRV-ALM-ALL
REPT ALM SYNCN RTRV-COND-ALL

Output Format

SID DATE TIME
A ATAG REPT EVT <MOD2ALM>
"<AID>:<CONDTYPE>,[<CONDEFF>],,,[<LOCN>],,[<MONVAL>],
[<THLEV>],[<TMPER>]:[<CONDDESR>],[<AIDDET>]"
;

where:

<AID> indicates an event with the condition type and is from the "ALL" section

<CONDTYPE> indicates an event with the condition type and is a string

<CONDEFF> is the effect of the condition on the NE; valid values for <CONDEFF> are shown in the "COND_EFF" section, <CONDEFF> is optional

<LOCN> indicates the location; valid values for <LOCN> are shown in the "LOCATION" section, <LOCN> is optional

<MONVAL> is the monitored value; <MONVAL> is an integer and is optional

<THLEV> is the threshold value; <THLEV> is an integer and is optional

<TMPER> is the accumulation time period for the PM information; valid values for <TMPER> are shown in the "TMPER" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

<AIDDET> specifies the type of AID; valid values for <AIDDET> are shown in the "EQPT_TYPE" section, <AIDDET> is optional

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT EVT DS1
"FAC-5-1:WKSWPR,TC,,,FEND,,12,13,15-MIN:\"WORKING SWITCH TO
PROTECTION\",OC48"
;


3.4.61 REPT EVT BITS: Report Event BITS

Reports the occurrence of a non-alarmed event against a BITS facility.

Section
REPT EVT BITS Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RTRV-ALM-BITS
ED-NE-SYNCN RTRV-ALM-SYNCN
ED-SYNCN RTRV-BITS
OPR-SYNCNSW RTRV-COND-BITS
REPT ALM BITS RTRV-COND-SYNCN
REPT ALM SYNCN RTRV-NE-SYNCN
REPT EVT SYNCN RTRV-SYNCN
RLS-SYNCNSW

Output Format

SID DATE TIME
A ATAG REPT EVT BITS
"<AID>:<CONDTYPE>,[<CONDEFF>],,,,,,,:[<CONDDESR>]"
;

where:

<AID> identifies a BITS facility with the condition and is from the "BITS" section

<CONDTYPE> indicates a condition type and the valid values are shown in the "CONDITION" section

<CONDEFF> indicates an effect of the condition on the NE; valid values for are shown in the "COND_EFF" section, <CONDEFF> is optional

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT EVT BITS
"BITS-1:SSM-STU,TC,,,,,,,:\"SYNCHRONIZED - TRACEABILITY UNKNOWN""
;


3.4.62 REPT EVT ENV: Report Event Environment

Reports the occurrence of a non-alarmed event against an environment alarm input.

Section
REPT EVT ENV Description 

Category

Environmental Alarms and Controls

Security

Retrieve

Related Messages

OPR-EXT-CONT RTRV-ATTR-ENV
REPT ALM ENV RTRV-COND-ENV
RLS-EXT-CONT RTRV-EXT-CONT
RTRV-ALM-ENV SET-ATTR-CONT
RTRV-ATTR-CONT SET-ATTR-ENV

Output Format

SID DATE TIME
A ATAG REPT EVT ENV
"<AID>:<ALMTYPE>,[<CONDEFF>],,,,,,,:[<CONDDESR>]"
;

where:

<AID> identifies an environmental input and is from the "ENV" section

<ALMTYPE> an abbreviated code identifying the alarm and the valid values are shown in the "ENV_ALM" section

<CONDEFF> indicates an effect of the condition on the NE; valid values for <CONDEFF> are shown in the "COND_EFF" section, <CONDEFF> is optional

<CONDDESR> is an alarm message; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT EVT ENV
"ENV-IN-2:OPENDR,TC,,,,,,,:\"OPEN DOOR\""
;


3.4.63 REPT EVT EQPT: Report Event Equipment

Reports the occurrence of a non-alarmed event against an equipment unit or slot.

Section
REPT EVT EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT INH-SWTOWKG-EQPT
ALW-SWTOPROTN-EQPT REPT ALM EQPT
ALW-SWTOWKG-EQPT RTRV-ALM-EQPT
DLT-EQPT RTRV-COND-EQPT
ED-EQPT RTRV-EQPT
ENT-EQPT SW-DX-EQPT
INH-SWDX-EQPT SW-TOPROTN-EQPT
INH-SWTOPROTN-EQPT SW-TOWKG-EQPT

Output Format

SID DATE TIME
A ATAG REPT EVT EQPT
"<AID>:<CONDTYPE>,[<CONDEFF>],,,,,,,:[<CONDDESR>],
[<AIDDET>]"
;

where:

<AID> indicates an equipment AID SLOT-{1-17} and is from the "EQPT" section

<CONDTYPE> indicates an event condition type; <CONDTYPE> defaults to EQPT and the valid values are shown in the "CONDITION" section

<CONDEFF> indicates an effect of the condition on the NE; valid values for <CONDEFF> are shown in the "COND_EFF" section, <CONDEFF> is optional

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

<AIDDET> specifies the type of AID; valid values for <AIDDET> are shown in the "EQPT_TYPE" section, <AIDDET> is optional

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT EVT EQPT
"SLOT-7:PLUGIN,TC,,,,,,,:\"EQUIPMENT PLUG-IN\",TCC"
;


3.4.64 REPT EVT RING: Report Event Ring

Reports the occurrence of a non-alarmed event against a ring object for BLSR.

Section
REPT EVT RING Description 

Category

BLSR

Security

Retrieve

Related Messages

ED-BLSR
RTRV-BLSR
REPT ALM RING

Output Format

SID DATE TIME
A ATAG REPT EVT RING
"<AID>:<CONDTYPE>,[<CONDEFF>],,,,,,,:[<CONDDESR>]"
;

where:

<AID> identifies an event with condition type; <AID> is a string.

<CONDTYPE> indicates an event condition type; valid values for <CONDTYPE> are shown in the "CONDITION" section

<CONDEFF> is the effect of the condition on the NE; valid values for <CONDEFF> are shown in the "COND_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT EVT RING
"RING-88:BLSR-RESYNC,TC,,,,,,,:\"BLSR TABLES RESYNCHRONIZED\","
;


3.4.65 REPT EVT SECU: Report Event Security

Reports the occurrence of a non-alarmed security even against the NE.

Based on TR-NWT-000835 in TR-NWT-000835 and the AID of the security alarm should be the Connection Identifier (CID) which is not supported in this release. The COM or UID is an acceptable substitute for the AID here. CID's will be supported in a future release.

For the rule of single failure, single message/alarm, the security alarm will not be reported as
REPT ALM COM, because it is reported as REPT ALM SECU.

Because the NE sends this security message as a transient message, to make all TL1 autonomous messages consistent, the TL1 agent reports the security message into REPT EVT SECU.

Section
REPT EVT SECU Description 

Category

Security

Security

Retrieve

Related Messages

ACT-USER
CANC
CANC-USER
DLT-USER-SECU
ED-PID
ED-USER-SECU
ENT-USER-SECU

Output Format

SID DATE TIME
A ATAG REPT EVT SECU
"<AID>:<CONDTYPE>,[<CONDEFF>],,,,,,,:[<CONDDESR>]"
;

where:

<AID> identifies an entity with the condition and defaults to "COM"; <AID> is a string

<CONDTYPE> is the condition type and valid values are shown in the "CONDITION" section

<CONDEFF> indicates an effect of the condition on the NE and valid values are shown in the "COND_EFF" section; <CONDEFF> is optional

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT EVT SECU
"COM:INTRUSION,TC,,,,,,,:\"SECURITY-INVALID LOGIN
(SEE AUDIT TRIAL)\""
;


3.4.66 REPT EVT SYNCN: Report Event Synchronization

Reports the occurrence of a non-alarmed event against a synchronization entity.

Section
REPT EVT SYNCN Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RTRV-ALM-BITS
ED-NE-SYNCN RTRV-ALM-SYNCN
ED-SYNCN RTRV-BITS
OPR-SYNCNSW RTRV-COND-BITS
REPT ALM BITS RTRV-COND-SYNCN
REPT ALM SYNCN RTRV-NE-SYNCN
REPT EVT BITS RTRV-SYNCN
RLS-SYNCNSW

Output Format

SID DATE TIME
A ATAG REPT EVT SYNCN
"<AID>:<CONDTYPE>,[<CONDEFF>],,,,,,,:[<CONDDESR>],
[<AIDDET>]"
;

where:

<AID> identifies the synchronization entity with the condition and is from the "SYNC_REF" section

<CONDTYPE> indicates the condition type; <CONDTYPE> defaults to SYNCN and the valid values are shown in the "CONDITION" section

<CONDEFF> indicates the effect of the condition on the NE; valid values for <CONDEFF> are shown in the "COND_EFF" section, <CONDEFF> is optional

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

<AIDDET> specifies the type of AID; valid values for <AIDDET> are shown in the "EQPT_TYPE" section, <AIDDET> is optional

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT EVT SYNCN
"SYNC-NE:SWTOINT,SC,,,,,,,:\"SWITCH TO INTERNAL CLOCK\",TCC"
;


3.4.67 REPT SW: Report Switch

Reports the autonomous switching of an active unit in a duplex equipment pair to the standby state and its mate to the active state. An automatic report for the occurrence or clearance of an alarm or event that triggers the switch may be associated with the message.

Section
REPT SW Description 

Category

UPSR Switching

Security

Retrieve

Related Messages

OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1

Output Format

SID DATE TIME
A ATAG REPT SW
"<ACTID>,<STDBYID>"
;

where:

<ACTID> identifies the equipment unit that has been placed in the active state. Parameter grouping shall not be used with this parameter; <ACTID> is the AID from the "EQPT" section

<STDBYID> identifies the equipment unit that was placed in the standby state. Parameter grouping shall not be used with this parameter; <STDBYID> is the AID from the "EQPT" section

Example

Output

TID-000 1998-06-20 14:30:00
A 001 REPT SW
"SLOT-8,SLOT-10"
;


3.4.68 RLS-EXT-CONT: Release External Control

This command is used to release a forced contact state and returns the control of the contact to an AUTOMATIC control state. In AUTOMATIC control state, the contact could be opened or closed depending on triggers that may or may not be provisioned in the NE. Therefore, issuing an RLS might not produce any contact state change.

The NE defaults to having no triggers provisioned for external controls which consequently produces default open contacts. An NE with this default provisioning will always produce an open contact with a RLS-EXT-CONT command.

Notes:

1. The duration is not supported, it defaults to CONTS.

2. In an automatic state, the contact could be opened or closed depending on the provisioned trigger. Therefore, issuing an OPR-EXT-CONT command followed by an RLS-EXT-CONT command might not produce any contact state change.

Section
RLS-EXT-CONT Description 

Category

Environmental Alarms and Controls

Security

Maintenance

Related Messages

OPR-EXT-CONT RTRV-ATTR-ENV
REPT ALM ENV RTRV-COND-ENV
REPT EVT ENV RTRV-EXT-CONT
RTRV-ALM-ENV SET-ATTR-CONT
RTRV-ATTR-CONT SET-ATTR-ENV

Input Format

RLS-EXT-CONT:[<TID>]:<AID>:<CTAG>[::,];

where:

<AID> identifies the external control being released and is from the "ENV" section

Example

Input

RLS-EXT-CONT:CISCO:ENV-OUT-2:123;

Errors

This message generates all the default errors


3.4.69 RLS-LPBK-<MOD2_IO>: Release Loopback (DS1, EC1, G1000, OC3, OC12, OC48, OC192, T1, T3)

This command releases a signal loopback on an I/O card.

Notes:

1. The optional [<LPBKTYPE>] field defaults to the current existing loopback type.

2. The TERMINAL loopback type is not supported for a DS3XM card.

Section
RLS-LPBK-<MOD2_IO> Description 

Category

Testing

Security

Maintenance

Related Messages

OPR-LPBK-<MOD2_IO>

Input Format

RLS-LPBK-<MOD2_IO>:[<TID>]:<AID>:<CTAG>::,,,[<LPBKTYPE>];

where:

<AID> is the access identifier. The <AID> is only supported for FACILITY and DS1; <AID> is from the "ALL" section

<LPBKTYPE> indicates the loopback type; valid values for <LPBKTYPE> are shown in the "LPBK_TYPE" section

Example

Input

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

Errors

This message generates all the default errors


3.4.70 RLS-PROTNSW-<OCN_TYPE>: Release Protection Switch (OC3, OC12, OC48, OC192)

This command instructs a SONET NE to release a SONET line protection switch request.

The release of a protection switch request is applicable only to the OPR-PROTNSW protection switch commands, the user-initiated switch protection commands.

Notes:

1. This command is not used for the common control (TCC+ or XC/XCVT) cards. Sending a command on a common control card will generate an IIAC (Input, Invalid Access Identifier) error message. To query the common control card switching commands, use SW-DX-EQPT, ALW-SWDX-EQPT commands.

2. When sending this command on non-SONET (OCN) cards, an IIAC (Input, Invalid Access Identifier) error message should be responsed. To use this command on a non-SONET card switching command, use ALW-SWTOPROTN/SWTOWKG-EQPT and INH-SWTOPROTN/SWTOWKG-EQPT commands.

3. When sending this command to query on a card that is not in a protection group, the SNVS (Status, Not in Valid State) error message should be responsed.

4. When sending this command to a working card that is failed or missing, the SWFA (Status, Working unit Failed) error message should be responsed.

5. When sending this command to a protect card that is failed or missing, the SPFA (Status, Protection unit Failed) error message should be responsed.

6. When sending this command to a card that is not in protection, the SNPR (Status, Not in Protection State) error message should be responsed.

7. Sending this command to an OCN line that is already in clear mode will return a SAMS (Already in Clear Maintenance State) error message.

Section
RLS-PROTNSW-<OCN_TYPE> Description 

Category

SONET Line Protection

Security

Maintenance

Related Messages

DLT-FFP-<OCN_TYPE>
ED-FFP-<OCN_TYPE>
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_TYPE>
OPR-PROTNSW-<OCN_TYPE>
RTRV-FFP-<OCN_TYPE>

Input Format

RLS-PROTNSW-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::];

where:

<AID> identifies the facility in the NE to which the switch request is directed and is from the "FACILITY" section

Example

Input

RLS-PROTNSW-OC48:CHICKALUMA:FAC-6-1:209;

Errors

This message generates all the default errors


3.4.71 RLS-PROTNSW-<STS_PATH>: Release Protection Switch (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command instructs a SONET NE to release (clear) a SONET path protection switch request that was established with the OPR-PROTNSW-<STS_PATH> command. This command assumes that only one user-initiated switch is active per AID.

Notes:

1. This command applies to UPSR configuration only.

2. The VTAID should be working or protect AID only.

3. Sending this command on the Drop AID, a DENY (Invalid AID, should use working/protect AID) message will be returned.

Section
RLS-PROTNSW-<STS_PATH> Description 

Category

UPSR Switching

Security

Maintenance

Related Messages

OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
REPT SW
RLS-PROTNSW-VT1

Input Format

RLS-PROTNSW-<STS_PATH>:[<TID>]:<AID>:<CTAG>[::];

where:

<AID> identifies the entity in the NE to which the switch request is directed and is from the "STS" section

Example

Input

RLS-PROTNSW-STS1:CISCO:STS-2-1:123;

Errors

This message generates all the default errors


3.4.72 RLS-PROTNSW-VT1: Release Virtual Tributary Protection Switch

This command instructs a SONET NE to release a SONET path protection switch request that was established with the OPR-PROTNSW-VT1 command. This command assumes that only one user-initiated switch is active per AID.

Notes:

1. This command applies to UPSR configuration only.

2. The VTAID should be working or protect AID only.

3. Sending this command on the Drop AID, a DENY (Invalid AID, should use working/protect AID) message will be returned.

Section
RLS-PROTNSW-VT1 Description 

Category

UPSR Switching

Security

Maintenance

Related Messages

OPR-PROTNSW-<STS_PATH>
OPR-PROTNSW-VT1
REPT SW
RLS-PROTNSW-<STS_PATH>

Input Format

RLS-PROTNSW-VT1:[<TID>]:<AID>:<CTAG>[::];

where:

<AID> identifies the entity in the NE to which the switch request is directed and is from the "VT1_5" section

Example

Input

RLS-PROTNSW-VT1:CISCO:VT1-4-2-3-1:123;

Errors

This message generates all the default errors


3.4.73 RLS-SYNCNSW: Release Synchronization Switch

This command releases the previous synchronization reference provided by the OPR-SYNCNSW command. The timing reverts back to its previous mode.

In a non-revertive system, the use of the RLS-SYNCNSW command may not be appropriate. All the switching between synchronization references should be initiated with the OPR-SYNCNSW command.

Once a switch is in effect, a minor alarm "MANSWTOPRI", Manual Switch to Primary Reference (or Secondary...), will be raised.

Section
RLS-SYNCNSW Description 

Category

Synchronization

Security

Maintenance

Related Messages

ED-BITS RTRV-ALM-BITS
ED-NE-SYNCN RTRV-ALM-SYNCN
ED-SYNCN RTRV-BITS
OPR-SYNCNSW RTRV-COND-BITS
REPT ALM BITS RTRV-COND-SYNCN
REPT ALM SYNCN RTRV-NE-SYNCN
REPT EVT BITS RTRV-SYNCN
REPT EVT SYNCN

Input Format

RLS-SYNCNSW:[<TID>]:[<AID>]:<CTAG>;

where:

<AID> is the access identifier from the "SYNC_REF" section. A null value of AID defaults to SYNC-NE.

Example

Input

RLS-SYNCNSW:CISCO:SYNC-NE:3;

Errors

This message generates all the default errors


3.4.74 RMV-<MOD_PORT>: Remove (EC1, G1000, OC3, OC12, OC48, OC192, T1, T3)

This command removes a facility from service.

Section
RMV-<MOD_PORT> Description 

Category

Ports

Security

Maintenance

Related Messages

ED-<OCN_TYPE> RTRV-T1
ED-DS1 RTRV-T3
ED-EC1 RTRV-<OCN_TYPE>
ED-G1000 RTRV-DS1
ED-T1 RTRV-EC1
ED-T3 RTRV-G1000
RST <MOD_PORT>

Input Format

RMV-<MOD_PORT>:[<TID>]:<AID>:<CTAG>[::];

where:

<AID> is the access identifier from the "FACILITY" section

Example

Input

RMV-EC1:CISCO:FAC-1-1:1234;

Errors

This message generates all the default errors


3.4.75 RST-<MOD_PORT>: Restore (EC1,G1000, OC3, OC12, OC48, OC192, T1, T3)

This command provisions a facility in service.

Section
RST-<MOD_PORT> Description 

Category

Ports

Security

Maintenance

Related Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>
ED-DS1 RTRV-DS1
ED-EC1 RTRV-EC1
ED-G1000 RTRV-G1000
ED-T1 RTRV-T1
ED-T3 RTRV-T3
RMV-<MOD_PORT>

Input Format

RST-<MOD_PORT>:[<TID>]:<AID>:<CTAG>[::];

where:

<AID> is the access identifier from the "FACILITY" section

Example

Input

RST-EC1:CISCO:FAC-1-1:1234;

Errors

This message generates all the default errors


3.4.76 RTRV-<OCN_TYPE>: Retrieve (OC3, OC12, OC48, OC192)

This command retrieves the attributes (i.e. service parameters) and the state of an OC-N facility.

Both RINGID and BLSRTYPE identify the OCN port connected with a BLSR. These attributes are only presented for the OC12, OC48, OC192 ports within a BLSR connection. The RTRV-BLSR command with the AID RINGID, can provide more information on this BLSR.


Note This command does not show the WVLEN attribute if the OCN port has zero value on WVLELN.


Section
RTRV-<OCN_TYPE> Description 

Category

Ports

Security

Retrieve

Related Messages

ED-<OCN_TYPE> RST-<MOD_PORT>
ED-DS1 RTRV-DS1
ED-EC1 RTRV-EC1
ED-G1000 RTRV-G1000
ED-T1 RTRV-T1
ED-T3 RTRV-T3
RMV-<MOD_PORT>

Input Format

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

where:

<AID> is the access identifier from the "FACILITY" section and must not be null.

Input Example

RTRV-OC48:PENNGROVE:FAC-6-1:236;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>,][TMGREF=<TMGREF>,]
[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,][PJMON=<PJMON>,]
[SFBER=<SFBER>,][SDBER=<SDBER>,][MODE=<MODE>,]
[WVLEN=<WVLEN>,][RINGID=<RINGID>,][BLSRTYPE=<BLSRTYPE>,]
[MUX=<MUX>]:[<PST>]"
;

where:

<AID> is the access identifier from the "FACILITY" section

<ROLE> identifies the OCN port role (e.g. WORK or PROT); valid values for <ROLE> are shown in the "SIDE" section, <ROLE> is optional

<STATUS> identifies the OCN port status (e.g. Active or Standby); valid values for <STATUS> are shown in the "STATUS" section, <STATUS> is optional

<DCC> identifies the OCN port DCC connection; valid values for <DCC> are shown in the "ON_OFF" section, <DCC> is optional

<TMGREF> identifies if the OCN port has timing reference; valid values for <TMGREF> are shown in the "ON_OFF" section, <TMGREF> is optional

<SYNCMSG> indicates if sync status messaging is enabled or disabled on the facility; <SYNCMSG> defaults to Y and the valid values are shown in the "ON_OFF" section

<SENDDUS> indicates that the facility will send out the DUS (do not use for synchronization) value as the sync status message for that facility; <senddonotuse> defaults to N and the valid values are shown in the "ON_OFF" section. <SENDDUS> is optional

<PJMON> identifies the OCN port PJMON; <PJMON> defaults to 0 (zero), is an integer and is optional

<SFBER> identifies the OCN port SFBER and defaults to 1E-4; valid values for <SFBER> are shown in the "SF_BER" section, <SFBER> is optional

<SDBER> identifies the OCN port SDBER and defaults to 1E-7; valid values for <SDBER> are shown in the "SD_BER" section, <SDBER> is optional

<MODE> identifies the OCN port mode (e.g. SONET, SDH); valid values for <MODE> are shown in the "OPTICAL_MODE" section, <MODE> is optional

<WVLEN> identifies the OCN port wavelength; <WVLEN> is wavelength in nm (nanometer) for unit, e.g. WVLEN=1310.00 means it operates at 1310 nm in the DWM application. <WVLEN> is a Float and is optional

<RINGID> identifies the BLSR ring id with which the port is connected. The <RINGID> ranges from 0 to 9999; <RINGID> is an integer and is optional

Output Format (continued)

<BLSRTYPE> identifies the BLSR type with which the port is connected; valid values for <BLSRTYPE> are shown in the "BLSR_TYPE" section and <BLSRTYPE> is optional.

<MUX> K3/Z2 muxponder setting (Y= a muxponder is present). Valid values for <MUX> are shown in the "MUX_TYPE" section; <MUX> is optional.

<PST> identifies the OCN port state (e.g. IS or OOS); <PST> defaults to OOS and valid values for <PST> are shown in the "PST" section, <PST> is optional.

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:DCC=N,TMGREF=N,SYNCMSG=Y,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SONET,WVLEN=1310.00,
RINGID=43,BLSRTYPE=WESTWORK,MUX=Y:OOS"
;

Errors

This message generates all the default errors


3.4.77 RTRV-<STS_PATH>: Retrieve (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command retrieves the attributes associated with an STS path.

The SFBER, SDBER, RVRTV, and RVTM parameters only apply to UPSR.

The path trace message is a 64 character string including the terminating CR (carriage return) and LF (line feed) that is transported in the J1 byte of the SONET STS Path overhead.

The EXPTRC indicates the contents of the expected incoming path trace are provisioned by the user in the ED-STS_PATH command. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.

The path trace mode has three modes: OFF, MANUAL, and AUTO. The mode defaults to OFF. The MANUAL mode performs the comparison of the received string with the user entered expected string. The AUTO mode performs the comparison of the present received string with an expected string set to a previously received string. If there is a mismatch, TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.

When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user entered string. When an expected string is queried under the AUTO path trace mode, the expected string is a copy of the acquired received string or NULL if the string has not been acquired.

When the incoming string is queried under the OFF path trace mode, the incoming string is a NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is a copy of the received string or NULL if the string has not been received.

J1 is implemented on the DS1/DS1N, DS3, DS3E/DS3NE, DS3XM, EC1, OC3, OC48AS and OC192.

Section
RTRV-<STS_PATH> Description 

Category

STS and VT Paths

Security

Retrieve

Related Messages

ED-<STS_PATH>
ED-VT1
RTRV-PTHTRC-<STS_PATH>
RTRV-VT1

Input Format

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

where:

<AID> is the AID from the "STS" section and must not be null

Input Example

RTRV-STS1:FERNDALE:STS-2-4:238;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>,][SFBER=<SFBER>,][SDBER=<SDBER>,]
[RVRTV=<RVRTV>,][RVTM=<RVTM>,][EXPTRC=<EXPTRC>,]
[TRC=<TRC>,][INCTRC=<INCTRC>,][TRCMODE=<TRCMODE>,]
[TACC=<TACC>]"
;

where:

<AID> is the access identifier from the "STS" section

<LEVEL> indicates the rate of the cross connected channel; valid values for <LEVEL> are shown in the "STS_PATH" section, <LEVEL> is optional

<SFBER> identifies the STS path SFBER which only applies to UPSR; <SFBER> defaults to 1E-4 and valid values are shown in the "SF_BER" section, <SFBER> is optional

<SDBER> identifies the STS path SDBER which only applies to UPSR; <SDBER> defaults to 1E-6 and valid values are shown in the "SD_BER" section, <SDBER> is optional

<RVRTV> identifies a revertive mode which only applies to UPSR and defaults to N (non-revertive mode); valid values for <RVRTV> are shown in the "ON_OFF" section and <RVRTV> is optional

<RVTM> identifies a revertive time which only applies to UPSR and defaults to empty because <RVRTV> is N when a UPSR STSp is created; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section and <RVTM> is optional

<EXPTRC> indicates the expected path trace message (J1) contents. The EXPTRC is any 64 character string, including the terminating CR (carriage return) and LF (line feed); <EXPTRC> is a string and is optional

<TRC> identifies the path trace message to be transmitted. The TRC is any combination of 64 characters, including the terminating CR (carriage return) and LF (line feed). The trace byte (J1) continuously transmits a 64 byte string, one byte at a time. A null value defaults to the NE transmitting null characters (Hex 00); <TRC> is a string and is optional

<INCTRC> identifies the incoming path trace message contents. The INCTRC is any combination of 64 characters; <INCTRC> is a string and is optional

<TRCMODE> indicates the path trace mode, and defaults to the OFF mode; valid values for <TRCMODE> are shown in the "TRCMODE" section and <TRCMODE> is optional

<TACC> defines the STS as a test access port with a selected unique TAP number. The TAP number ranges from 0-999; <TACC> is optional.

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-2-4::LEVEL=STS1,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,
RVTM=1.0,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TACC=8"
;

Errors

This message generates all the default errors


3.4.78 RTRV-ALM-<MOD2ALM>:Retrieve Alarm (DS1, E100, E1000, EC1, G1000, OC3, OC12, OC48, OC192, STS1, STS3C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

Instructs the NE to retrieve and send the current status of its alarm conditions. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.

Notes:

1. VT1-n-n-n replaces PS_VT1-n-n-n for VT1 alarms AID.

2. The [<AIDTYPE>] shows STS1 for STS alarms.

Section
RTRV-ALM-<MOD2ALM> Description 

Category

Fault

Security

Retrieve

Related Messages

REPT ALM <MOD2ALM> RTRV-ALM-ENV
REPT ALM BITS RTRV-ALM-EQPT
REPT ALM COM RTRV-ALM-SYNCN
REPT ALM ENV RTRV-COND-<MOD2ALM>
REPT ALM EQPT RTRV-COND-ALL
REPT ALM RING RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-ENV
RTRV-ALM-ALL RTRV-COND-EQPT
RTRV-ALM-BITS RTRV-COND-SYNCN

Input Format

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

where:

<AID> is the access identifier from the "ALL" section and must not be null

<NTFCNCDE> is the 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

Input Example

RTRV-ALM-OC12:ELDRIDGE:FAC-5-1:225::MN,SD,SA;

Output Format

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

where:

<AID> is the access identifier from the "ALL" section

<AIDTYPE> is the type of access identifier; valid values for <AIDTYPE> are shown in the "MOD2ALM" section, <AIDTYPE> is optional

<NTFCNCDE> is the 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESCR> is a string and is optional

Output Example

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

Errors

This message generates all the default errors


3.4.79 RTRV-ALM-ALL: Retrieve Alarm All

This command instructs the NE to retrieve and send the current status of all active alarm conditions. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.

According to GR-833, the RTRV-ALM-ALL command only reports EQPT, RING, COM, and rr (T1, T3, OCN, EC1, STSN, VT1, and DS1) alarms.

To retrieve all the NE alarms, issue all of the following commands:

RTRV-ALM-ALL
RTRV-ALM-ENV
RTRV-ALM-BITS
RTRV-ALM-SYNCN

Section
RTRV-ALM-ALL Description 

Category

Fault

Security

Retrieve

Related Messages

REPT ALM <MOD2ALM> RTRV-ALM-ENV
REPT ALM BITS RTRV-ALM-EQPT
REPT ALM COM RTRV-ALM-SYNCN
REPT ALM ENV RTRV-COND-<MOD2ALM>
REPT ALM EQPT RTRV-COND-ALL
REPT ALM RING RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-ENV
RTRV-ALM-<MOD2ALM> RTRV-COND-EQPT
RTRV-ALM-BITS RTRV-COND-SYNCN

Input Format

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

where:

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDITION> is the type of alarm condition; valid values for <CONDITION> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

Input Example

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

Output Format

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

where:

<AID> is the identifier that has an alarm condition and is from the "ALL" section, <AID> is optional

<AIDTYPE> is the type of access identifier; valid values for <AIDTYPE> are shown in the "MOD2B" section, <AIDTYPE> is optional

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the single type of alarm condition being reported on this particular line; valid values are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

<AIDDET> is the supplementary equipment identification; valid values for <AIDDET> are shown in the "EQPT_TYPE" section, <AIDDET> is optional

Output Example

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

Errors

This message generates all the default errors


3.4.80 RTRV-ALM-BITS: Retrieve Alarm Building Integrated Timing Supply

This command instructs the NE to retrieve and send the current status of its alarm conditions associated with the BITS facility. The alarm condition or severity retrieved is specified using the input parameters as a filter.

Section
RTRV-ALM-BITS Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RTRV-ALM-<MOD2ALM>
ED-NE-SYNCN RTRV-ALM-ALL
ED-SYNCN RTRV-ALM-ENV
OPR-SYNCNSW RTRV-ALM-EQPT
REPT ALM <MOD2ALM> RTRV-ALM-SYNCN
REPT ALM BITS RTRV-BITS
REPT ALM COM RTRV-COND-<MOD2ALM>
REPT ALM ENV RTRV-COND-ALL
REPT ALM EQPT RTRV-COND-BITS
REPT ALM RING RTRV-COND-ENV
REPT ALM SYNCN RTRV-COND-EQPT
REPT EVT BITS RTRV-COND-SYNCN
REPT EVT SYNCN RTRV-NE-SYNCN
RLS-SYNCNSW RTRV-SYNCN

Input Format

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

where:

<AID> is the identifier that has an alarm condition and is from the AID "BITS" section; <AID> must not be null

<NTFCNCDE> is the 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

Input Example

RTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;

Output Format

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

where:

<AID> is the identifier that has an alarm condition and is from the "BITS" section

<AIDTYPE> is the type of access identifier; valid values for <AIDTYPE> are shown in the "MOD2B" section and <AIDTYPE> is optional

<NTFCNCDE> is the 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESR> is the condition description; <CONDDESR> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,:BITS,CR,LOS,SA,,,,:\"LOSS OF SIGNAL\","
;

Errors

This message generates all the default errors


3.4.81 RTRV-ALM-ENV: Retrieve Alarm Environment

This command retrieves the environmental alarms.

Section
RTRV-ALM-ENV Description 

Category

Environmental Alarms and Controls

Security

Retrieve

Related Messages

OPR-EXT-CONT RTRV-ALM-EQPT
REPT ALM <MOD2ALM> RTRV-ALM-SYNCN
REPT ALM BITS RTRV-ATTR-CONT
REPT ALM COM RTRV-ATTR-ENV
REPT ALM ENV RTRV-COND-<MOD2ALM>
REPT ALM EQPT RTRV-COND-ALL
REPT ALM RING RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-ENV
REPT EVT ENV RTRV-COND-EQPT
RLS-EXT-CONT RTRV-COND-SYNCN
RTRV-ALM-<MOD2ALM> RTRV-EXT-CONT
RTRV-ALM-ALL SET-ATTR-CONT
RTRV-ALM-BITS SET-ATTR-ENV

Input Format

RTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NOTIFCODE>],
[<ALMTYPE>];

where:

<AID> is the access identifier from the "ENV" section; <AID> must not be null

<NOTIFCODE> is the notification; valid values for <NOTIFCODE> are shown in the "NOTIF_CODE" section

<ALMTYPE> is the alarm type for the environmental alarm; valid values for <ALMTYPE> are shown in the "ENV_ALM" section

Input Example

RTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,,,[<CONDDESR>]"
;

where:

<AID> is the access identifier from the "ENV" section

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<ALMTYPE> is the alarm type for the environmental alarm; valid values for <ALMTYPE> are shown in the "ENV_ALM" section

<CONDDESR> is the alarm message; <CONDDESR> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,,,\"OPEN DOOR\""
;

Errors

This message generates all the default errors


3.4.82 RTRV-ALM-EQPT: Retrieve Alarm Equipment

This command instructs the NE to retrieve and send the current status of its alarm conditions associated with the equipment units. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.

Section
RTRV-ALM-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT REPT EVT EQPT
ALW-SWTOPROTN-EQPT RTRV-ALM-<MOD2ALM>
ALW-SWTOWKG-EQPT RTRV-ALM-ALL
DLT-EQPT RTRV-ALM-BITS
ED-EQPT RTRV-ALM-ENV
ENT-EQPT RTRV-ALM-SYNCN
INH-SWDX-EQPT RTRV-COND-<MOD2ALM>
INH-SWTOPROTN-EQPT RTRV-COND-ALL
INH-SWTOWKG-EQPT RTRV-COND-BITS
REPT ALM <MOD2ALM> RTRV-COND-ENV
REPT ALM BITS RTRV-COND-EQPT
REPT ALM COM RTRV-COND-SYNCN
REPT ALM ENV RTRV-EQPT
REPT ALM EQPT SW-DX-EQPT
REPT ALM RING SW-TOPROTN-EQPT
REPT ALM SYNCN SW-TOWKG-EQPT

Input Format

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

where:

<AID> is the identifier that has an alarm condition and is from the "EQPT" section; <AID> must not be null

<NTFCNCDE> is the 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

Input Example

RTRV-ALM-EQPT:TWOROCK:SLOT-7:227::MJ,HITEMP,NSA;

Output Format

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

where:

<AID> is the identifier that has an alarm condition and is from the "EQPT" section; <AID> is optional

valid values for <AIDTYPE> are shown in the "MOD2B" section; <AIDTYPE> is optional

<NTFCNCDE> is the 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESCR> is the condition description; <CONDDESCR> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-7,EQPT:MJ,HITEMP,NSA,,,,:\"HI TEMPERATURE\","
;

Errors

This message generates all the default errors


3.4.83 RTRV-ALM-SYNCN: Retrieve Alarm Synchronization

This command instructs the NE to retrieve and send the current status of its alarm conditions associated with a synchronization facility. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.

Section
RTRV-ALM-SYNCN Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RTRV-ALM-<MOD2ALM>
ED-NE-SYNCN RTRV-ALM-ALL
ED-SYNCN RTRV-ALM-BITS
OPR-SYNCNSW RTRV-ALM-ENV
REPT ALM <MOD2ALM> RTRV-ALM-EQPT
REPT ALM BITS RTRV-BITS
REPT ALM COM RTRV-COND-<MOD2ALM>
REPT ALM ENV RTRV-COND-ALL
REPT ALM EQPT RTRV-COND-BITS
REPT ALM RING RTRV-COND-ENV
REPT ALM SYNCN RTRV-COND-EQPT
REPT EVT BITS RTRV-COND-SYNCN
REPT EVT SYNCN RTRV-NE-SYNCN
RLS-SYNCNSW RTRV-SYNCN

Input Format

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

where:

<AID> identifies the access identifier from the "SYN" section, <AID> is listable and must not be null

<NTFCNCDE> is the 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

Input Example

RTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;

Output Format

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

where:

<AID> is the identifier that has an alarm condition and is from the "SYN" section

<AIDTYPE> is the type of access identifier: valid values for <AIDTYPE> are shown in the "MOD2B" section and <AIDTYPE> is optional

<NTFCNCDE> is the 2-letter notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<CONDTYPE> is the alarm condition; valid values for <CONDTYPE> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<CONDDESCR> is the condition description; <CONDDESCR> is a string and is optional

Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:CR,FAILTOSW,SA,,,,:\"FAILURE TO SWITCH TO
PROTECTION\","
;

Errors

This message generates all the default errors


3.4.84 RTRV-ATTR-CONT: Retrieve Attribute Control

This command instructs the NE to send the attributes associated with an external control. These attributes are used when an external control is operated or released. To set these attributes, use the SET-ATTR-CONT command.

Section
RTRV-ATTR-CONT Description 

Category

Environmental Alarms and Controls

Security

Retrieve

Related Messages

OPR-EXT-CONT RTRV-ATTR-ENV
REPT ALM ENV RTRV-COND-ENV
REPT EVT ENV RTRV-EXT-CONT
RLS-EXT-CONT SET-ATTR-CONT
RTRV-ALM-ENV SET-ATTR-ENV

Input Format

RTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];

where:

<AID> identifies the external control for which attributes are being set; <AID> is from the "ENV" section and must not be null

<CONTTYPE> is the type of external control; valid values for <CONTTYPE> are shown in the "CONTTYPE" section, <CONTTYPE> is optional

Input Example

RTRV-ATTR-CONT:CISCO:ENV-OUT-2:123::AIRCOND;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>]"
;

where:

<AID> identifies the external control for which attributes are being set and is from the "ENV" section

<CONTTYPE> is the type of external control; valid values for <CONTTYPE> are shown in the "CONTTYPE" section and <CONTTYPE> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND"
;

Errors

This message generates all the default errors


3.4.85 RTRV-ATTR-ENV: Retrieve Attribute Environment

This command retrieves the attributes associated with an environmental alarm.

Section
RTRV-ATTR-ENV Description 

Category

Environmental Alarms and Controls

Security

Retrieve

Related Messages

OPR-EXT-CONT RTRV-ATTR-CONT
REPT ALM ENV RTRV-COND-ENV
REPT EVT ENV RTRV-EXT-CONT
RLS-EXT-CONT SET-ATTR-CONT
RTRV-ALM-ENV SET-ATTR-ENV

Input Format

RTRV-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],
[<ALMTYPE>];

where:

<AID> is the access identifier from the "ENV" section and must not be null

<NTFCNCDE> is the notification code for the environmental alarm; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<ALMTYPE> is the alarm type for the environmental alarm; valid values for <ALMTYPE> are shown in the "ENV_ALM" section

Input Example

RTRV-ATTR-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:[<NTFCNCDE>],[<ALMTYPE>],[<CONDDESR>]"
;

where:

<AID> is the access identifier from the "ENV" section

<NTFCNCDE> is the notification code for the environmental alarm; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section, <NTFCNCDE> is optional

<ALMTYPE> is the alarm type for the environmental alarm; valid values for <ALMTYPE> are shown in the "ENV_ALM" section, <ALMTYPE> is optional

<CONDDESR> is the alarm description; <CONDDESR> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,\"OPEN DOOR\""
;

Errors

This message generates all the default errors


3.4.86 RTRV-BITS: Retrieve Building Integrated Timing Supply

This command retrieves the BITS configuration command.

Section
RTRV-BITS Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RLS-SYNCNSW
ED-NE-SYNCN RTRV-ALM-BITS
ED-SYNCN RTRV-ALM-SYNCN
OPR-SYNCNSW RTRV-COND-BITS
REPT ALM BITS RTRV-COND-SYNCN
REPT ALM SYNCN RTRV-NE-SYNCN
REPT EVT BITS RTRV-SYNCN
REPT EVT SYNCN

Input Format

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

where:

<AID> is the bit access identifier from the "BITS" section and must not be null

Input Example

RTRV-BITS:SONOMA:BITS-1:782;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],
[SYNCMSG=<SYNCMSG>]:[<PST>]"
;

where:

<AID> is the access identifier from the "BITS" section

<LINECDE> is the line code; valid values for <LINECDE> are shown in the "LINE_CODE" section, <LINECDE> is optional

<FMT> is the frame format; valid values for <FMT> are shown in the "FRAME_FORMAT" section, <FMT> is optional

<SYNCMSG> indicates a sync messaging; <SYNCMSG> defaults to (Y) and valid values are shown in the "ON_OFF" section, <SYNCMSG> is optional

<PST> is the state; valid values for <PST> are shown in the "PST" section, <PST> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1::LINECDE=AMI,FMT=ESF,SYNCMSG=Y:IS"
;

Errors

This message generates all the default errors


3.4.87 RTRV-BLSR: Retrieve Bidirectional Line Switched Ring

This command retrieves the BLSR information of the NE. A two-fiber or four-fiber BLSR can be retrieved.

Output examples:

2F BLSR
"BLSR-12::RINGID=12,NODEID=2,MODE=2F,RVRTV=Y,RVTM=5.0, 
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1" 

4F BLSR 
"BLSR-43::RINGID=43,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,
SRVRTV=Y,SRVTM=5.0,EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,
EASTPROT=FAC-12-1,WESTPROT=FAC-13-1"

Error conditions:

1. Only ALL, null, or single "BLSR-#" in the AID in is allowed in this command.

2. A null AID defaults to the AID of ALL.

3. If the system fails on getting IOR, a SDBE (Status, Internal Data Base Error) error message will be returned.

4. If the NE does not have BSLR, the TL1 session will return the "COMPLD" with empty information to the user. Data error will be returned.

Section
RTRV-BLSR Description 

Category

BLSR

Security

Retrieve

Related Messages

ED-BLSR

Input Format

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

where:

<AID> identifies the BLSR of the NE. Only ALL, NULL, or single "BLSR-#" in <AID> is allowed; <AID> is from the "BLSR" section. A null value is equivalent to ALL.

Input Example

RTRV-BLSR:PETALUMA:ALL:123;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[RINGID=<RINGID>,][NODEID=<NODEID>,][MODE=<MODE>,]
[RVRTV=<RVRTV>,] [RVTM=<RVTM>,][SRVRTV=<SRVRTV>,]
[SRVTM=<SRVTM>,][EASTWORK=<EASTWORK>,]
[WESTWORK=<WESTWORK>,][EASTPROT=<EASTPROT>,]
[WESTPROT=<WESTPROT>]"

;

where:

<AID> identifies the BLSR of the NE and is from the "BLSR" section

<RINGID> identifies the BLSR ring ID of the NE and ranges from 0 to 9999; <RINGID> is an integer and is optional

<NODEID> identifies the BLSR node ID of the NE and ranges from 0 to 31; <NODEID> is an integer and is optional

<MODE> identifies the BLSR mode and can be 2-fiber or 4-fiber; valid values for <MODE> are shown in the "BLSR_MODE" section

<RVRTV> identifies the revertive mode and valid values for <RVRTV> are shown in the "ON_OFF" section

<RVTM> identifies the revertive time and is not allowed to be set while <RVRTV> is N; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section and <RVTM> is optional

<SRVRTV> identifies the span revertive mode for 4F BLSR only; valid values for <SRVRTV> are shown in the "ON_OFF" section and <SRVRTV> is optional

<SRVTM> identifies the span revertive time for 4F BLSR only and is not allowed to be set while <SRVTV> is N; valid values for <SRVTM> are shown in the "REVERTIVE_TIME" section

<EASTWORK> identifies the east working facility and is the AID from the "FACILITY" section; <EASTWORK> is optional

<WESTWORK> identifies the west working facility and is the AID from the "FACILITY" section; <WESTWORK> is optional

<EASTPROT> identifies the east protecting facility and is the AID from the "FACILITY" section; <EASTPROT> is optional

<WESTPROT> identifies the west protecting facility and is the AID from the "FACILITY" section; <WESTPROT> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BLSR-43::RINGID=43,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,
SRVRTV=Y,SRVTM=5.0,EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,
EASTPROT=FAC-12-1,WESTPROT=FAC-13-1"

;

Errors

This message generates all the default errors


3.4.88 RTRV-COND-<MOD2ALM>: Retrieve Condition (DS1, E100, E1000, EC1, G1000, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

This command retrieves the current standing condition and state associated with an entity.

Section
RTRV-COND-<MOD2ALM> Description 

Category

Fault

Security

Retrieve

Related Messages

REPT ALM <MOD2ALM> RTRV-ALM-BITS
REPT ALM BITS RTRV-ALM-ENV
REPT ALM COM RTRV-ALM-EQPT
REPT ALM ENV RTRV-ALM-SYNCN
REPT ALM EQPT RTRV-COND-ALL
REPT ALM RING RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-ENV
RTRV-ALM-<MOD2ALM> RTRV-COND-EQPT
RTRV-ALM-ALL RTRV-COND-SYNCN

Input Format

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

where:

<AID> is the identifier that has an alarm condition; <AID> is from the "ALL" section and must not be null

<TYPEREQ> is the type of condition to be retrieved; valid values for <TYPEREQ> are shown in the "CONDITION" section

Input Example

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

Output Format

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

where:

<AID> is the identifier that has an alarm condition and is from the "ALL" section

<AIDTYPE> specifies the type of condition to be retrieved; valid values for <AIDTYPE> are shown in the "MOD2ALM" section, <AIDTYPE> is optional

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section, <NTFCNCDE> is optional

<TYPEREQ> is the condition itself; valid values for <TYPEREQ> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section, <SRVEFF> is optional

<CONDDESCR> is the condition description; <CONDDESCR> is a string and is optional

Output Example

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

Errors

This message generates all the default errors


3.4.89 RTRV-COND-ALL: Retrieve Condition All

This command retrieves the current standing condition for all entities.

According to GR-833, the RTRV-COND-ALL command only reports EQPT, RING, COM, and rr (T1, T3, OCN, EC1, STSN, VT1, and DS1) alarms.

To retrieve all the NE conditions, issue all of the following commands:

RTRV-COND-ALL
RTRV-COND-ENV
RTRV-COND-BITS
RTRV-COND-SYNCN

RTRV-COND-ALL does not return all conditions that are returned by other, more specific RTRV-COND commands. Instead it just returns a subset of those conditions. This is a requirement from section 6.2.1.8.4 of GR-253-CORE. The specific requirements are R6-288, R6-289 and R6-290. Section 6.2.1.8.4 states a retrieval that returns ALL conditions from a node (RTRV-COND-ALL) must omit any conditions that are "same root cause" as other raised conditions. The section also states any retrieval of a subset of the conditions from a node, regardless of how the subsetting occurs, should not omit these "same root cause" conditions. RTRV-COND-STS1, for example, must include "same root cause" conditions in the set it returns, while RTRV-COND-ALL must not.

Section
RTRV-COND-ALL Description 

Category

Fault

Security

Retrieve

Related Messages

REPT ALM <MOD2ALM> RTRV-ALM-BITS
REPT ALM BITS RTRV-ALM-ENV
REPT ALM COM RTRV-ALM-EQPT
REPT ALM ENV RTRV-ALM-SYNCN
REPT ALM EQPT RTRV-COND-<MOD2ALM>
REPT ALM RING RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-ENV
RTRV-ALM-<MOD2ALM> RTRV-COND-EQPT
RTRV-ALM-ALL RTRV-COND-SYNCN

Input Format

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

where:

<TYPEREQ> is the type of condition to be retrieved; valid values for <TYPEREQ> are shown in the "CONDITION" section

Input Example

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

Output Format

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

where:

<AID> is the identifier that has an alarm condition; <AID> is from the "ALL" section

<AIDTYPE> is the type of access identifier; valid values for <AIDTYPE> are shown in the "MOD2B" section, <AIDTYPE> is optional

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section, <NTFCNCDE> is optional

<TYPEREQ> is the type of condition to be retrieved; valid values for <TYPEREQ> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section, <SRVEFF> is optional

<CONDDESCR> is the condition description; <CONDDESCR> is a string and is optional

Output Example

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

Errors

This message generates all the default errors


3.4.90 RTRV-COND-BITS: Retrieve Condition Building Integrated Timing Supply

This command retrieves the standing conditions on BITS.

Section
RTRV-COND-BITS Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RTRV-ALM-<MOD2ALM>
ED-NE-SYNCN RTRV-ALM-ALL
ED-SYNCN RTRV-ALM-BITS
OPR-SYNCNSW RTRV-ALM-ENV
REPT ALM <MOD2ALM> RTRV-ALM-EQPT
REPT ALM BITS RTRV-ALM-SYNCN
REPT ALM COM RTRV-BITS
REPT ALM ENV RTRV-COND-<MOD2ALM>
REPT ALM EQPT RTRV-COND-ALL
REPT ALM RING RTRV-COND-ENV
REPT ALM SYNCN RTRV-COND-EQPT
REPT EVT BITS RTRV-COND-SYNCN
REPT EVT SYNCN RTRV-NE-SYNCN
RLS-SYNCNSW RTRV-SYNCN

Input Format

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

where:

<AID> is the access identifier from the "BITS" section and must not be null

<TYPEREQ> is the type of condition to be retrieved; valid values for <TYPEREQ> are shown in the "CONDITION" section

Input Example

RTRV-COND-BITS:TID:BITS-1:229::LOS;

Output Format

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

where:

<AID> is an identifier that has an alarm condition and is from the "BITS" section

<AIDTYPE> is the type of AID. It is always reported as BITS; valid values for <AIDTYPE> are shown in the "MOD2B" section, <AIDTYPE> is optional

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section, <NTFCNCDE> is optional

<TYPEREQ> is the type of condition to be retrieved; valid values for <TYPEREQ> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section, <SRVEFF> is optional

<CONDDESCR> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,,,,,\"LOS OF SIGNAL\""
;

Errors

This message generates all the default errors


3.4.91 RTRV-COND-ENV: Retrieve Condition Environment

This command retrieves the environmental conditions.

Section
RTRV-COND-ENV Description 

Category

Environmental Alarms and Controls

Security

Retrieve

Related Messages

OPR-EXT-CONT RTRV-ALM-ENV
REPT ALM <MOD2ALM> RTRV-ALM-EQPT
REPT ALM BITS RTRV-ALM-SYNCN
REPT ALM COM RTRV-ATTR-CONT
REPT ALM ENV RTRV-ATTR-ENV
REPT ALM EQPT RTRV-COND-<MOD2ALM>
REPT ALM RING RTRV-COND-ALL
REPT ALM SYNCN RTRV-COND-BITS
REPT EVT ENV RTRV-COND-EQPT
RLS-EXT-CONT RTRV-COND-SYNCN
RTRV-ALM-<MOD2ALM> RTRV-EXT-CONT
RTRV-ALM-ALL SET-ATTR-CONT
RTRV-ALM-BITS SET-ATTR-ENV

Input Format

RTRV-COND-ENV:[<TID>]:<AID>:<CTAG>::[<NOTIFCODE>],
[<ENVALM>][,,,];

where:

<AID> is the identifier from the "ENV" section and must not be null

<NOTIFCODE> is the notification code; valid values for <NOTIFCODE> are shown in the "NOTIF_CODE" section. A null value is equivalent to ALL.

<ENVALM> is the alarm type for the environmental condition; valid values for <ENVALM> are shown in the "ENV_ALM" section. A null value is equivalent to ALL.

Input Example

RTRV-COND-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;

Output Format

SID DATE TIME
M CTAG COMPLD
"<ENV>:<NOTIFCODE>,<ENVALM>,,,,,,[<DNFIELD>]"

;

where:

<ENV> is the access identifier that has an environmental condition and is from the "ENV" section

<NOTIFCODE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<ENVALM> is the type of condition to be retrieved; valid values for <ENVALM> are shown in the "ENV_ALM" section

<DNFIELD> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,,,,,,\"OPEN DOOR\""
;

Errors

This message generates all the default errors


3.4.92 RTRV-COND-EQPT: Retrieve Condition Equipment

This command retrieves the condition equipment.

Section
RTRV-COND-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT REPT EVT EQPT
ALW-SWTOPROTN-EQPT RTRV-ALM-<MOD2ALM>
ALW-SWTOWKG-EQPT RTRV-ALM-ALL
DLT-EQPT RTRV-ALM-BITS
ED-EQPT RTRV-ALM-ENV
ENT-EQPT RTRV-ALM-EQPT
INH-SWDX-EQPT RTRV-ALM-SYNCN
INH-SWTOPROTN-EQPT RTRV-COND-<MOD2ALM>
INH-SWTOWKG-EQPT RTRV-COND-ALL
REPT ALM <MOD2ALM> RTRV-COND-BITS
REPT ALM BITS RTRV-COND-ENV
REPT ALM COM RTRV-COND-SYNCN
REPT ALM ENV RTRV-EQPT
REPT ALM EQPT SW-DX-EQPT
REPT ALM RING SW-TOPROTN-EQPT
REPT ALM SYNCN SW-TOWKG-EQPT

Input Format

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

where:

<AID> is an identifier that has an alarm condition; <AID> is from the "EQPT" section and must not be null

<TYPEREQ> is the type of condition to be retrieved; valid values for <TYPEREQ> are shown in the "CONDITION" section

Input Example

RTRV-COND-EQPT:TID:SLOT-1:229::LOS;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREQ>,[<SRVEFF>],,,,,
[<CONDDESCR>]"

;

where:

<AID> is the identifier that has an alarm condition and is from the "EQPT" section

<AIDTYPE> is the type of the AID. It is always reported as EQPT for the equipment condition; valid values for <AIDTYPE> are shown in the "MOD2B" section, <AIDTYPE> is optional

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section, <NTFCNCDE> is optional

<TYPEREQ> is the type of condition to be retrieved; valid values for <TYPEREQ> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section, <SRVEFF> is optional

<CONDDESCR> is the condition description; <CONDDESCR> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-1,EQPT:CR,LOS,SA,,,,,\"LOS OF SIGNAL\""
;

Errors

This message generates all the default errors


3.4.93 RTRV-COND-SYNCN: Retrieve Condition Synchronization

This command retrieves the synchronization condition.

Section
RTRV-COND-SYNCN Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RTRV-ALM-<MOD2ALM>
ED-NE-SYNCN RTRV-ALM-ALL
ED-SYNCN RTRV-ALM-BITS
OPR-SYNCNSW RTRV-ALM-ENV
REPT ALM <MOD2ALM> RTRV-ALM-EQPT
REPT ALM BITS RTRV-ALM-SYNCN
REPT ALM COM RTRV-BITS
REPT ALM ENV RTRV-COND-<MOD2ALM>
REPT ALM EQPT RTRV-COND-ALL
REPT ALM RING RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-ENV
REPT EVT SECU RTRV-COND-EQPT
REPT EVT BITS RTRV-NE-SYNCN
RLS-SYNCNSW RTRV-SYNCN

Input Format

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

where:

<AID> is the identifier that has an alarm condition; <AID> is from the "SYN" section and must not be null

<TYPEREQ> is the type of condition to be retrieved; valid values are shown in the "CONDITION" section

Input Format

RTRV-COND-SYNCN:TID:SYNC-NE:229::LOS;

Output Format

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

where:

<AID> is the identifier that has an alarm condition and is from the "SYN" section

<AIDTYPE> is the type of AID. It is always reported as SYNCN; valid values for <AIDTYPE> are shown in the "MOD2B" section, <AIDTYPE> is optional

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section, <NTFCNCDE> is optional

<TYPEREQ> is the type of condition to be retrieved; valid values for <TYPEREQ> are shown in the "CONDITION" section

<SRVEFF> is the effect on service caused by the alarm condition; valid values for <SRVEFF> are shown in the "SERV_EFF" section, <SRVEFF> is optional

<CONDDESCR> is the condition description; <CONDDESCR> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:MJ,FRNGSYNC,SA,,,,,\"FREE RUNNING
SYNCHRONIZATION MODE\""
;

Errors

This message generates all the default errors


3.4.94 RTRV-CRS-<STS_PATH>: Retrieve Cross Connect (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command retrieves any connections associated with the entered AID(s) or AID range. The information on both ends is returned along with the type of connection.

Notes:

1. The UPSR STS cross connection can be retrieved by using "&" in the AID fields of this command.

To retrieve a 1-way selector or 2-way selector and bridge cross connection with:

from points: f1, f2

to points: t1

the output will be:

1-way

"f1&f2,t1:CCT,STS3C"

2-way

If retrieved on point f1 or f2, the output format is the same as the 1-way output.

If retrieved on point t1, the output will be:

"t1,f1&f2:CCT,STS3C"

To retrieve a 1-way bridge or 2-way selector and bridge cross connection with:

from point: f1

to points: t1, t2

the output will be:

1-way

"f1,t1&t2:CCT,STS3C"

2-way

"t1&t2,f1:CCT,STS3C"

To retrieve a 1-way subtending UPSR connection or 2-way subtending UPSR cross connection with:

from point: f1, f2

to points: t1, t2

the output will be:

1-way:

"f1&f2,t1&t2:CCT,STS3C"

2-way:

If retrieved on point f1 or f2, the output format is the same as the 1-way output.

If retrieved on point t1 or t2, the output will be:

"t1&t2,f1&f2:CCT,STS3C"

To retrieve a 2-way selector and bridge cross connection with:

ENT-CRS-<STS_PATH>::F1&F2,S1&S2:8::2WAY;

from points: f1, f2 (f1 is the working side, f2 is the protect side)

selector: s1, s2 (s1 is the working side, s2 is the protect side)

the output will be:

If retrieved on point f1 or f2, the output will be:

"f1&f2,s1&s2:CCT,STS3C"

If retrieved on selector s1 or s2, the output will be:

"s1&s2,f1&f2:CCT,STS3C"

2. All a&b AIDs in the TL1 cross connection command are in the format of WorkingAid&ProtectAid.

3. This does not include STS for the RTRV-CRS command because "STS" is not a standard designator as defined by GR-833 A-2.

Section
RTRV-CRS-<STS_PATH> Description 

Category

Cross Connections

Security

Retrieve

Related Messages

DLT-CRS-<STS_PATH>
DLT-CRS-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
RTRV-CRS-VT1

Input Format

RTRV-CRS-<STS_PATH>:[<TID>]:<AID>:<CTAG>[::::];

where:

<AID> identifies STS to check for connection membership. The STS_PATH does not include STS for the RTRV-CRS command because STS is not a standard designator as defined by GR-833 A-2. <AID> is from the "STS" section and must not be null

Input Example

RTRV-CRS-STS3C:KENWOOD:STS-6-1:223;

Output Format

SID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>:<CCT>,<LEVEL>"
;

where:

<FROM> identifies an entity at one end of the STS cross connection and is the AID from the "STS" section

<TO> identifies an entity at the other end of the STS cross connection and is the AID from the "STS" section

<CCT> identifies the cross connection type; valid values for <CCT> are shown in the "CCT" section

<LEVEL> indicates the rate of the cross connected channel; valid values for <LEVEL> are shown in the "STS_PATH" section

Note A facility AID of FAC-{1-6,12-17}-{1-4} is allowed as the <FROM> or <TO> portions of the cross connect for a G1000-4 card.

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-6-1,STS-12-4:2WAY,STS3C"
;

Errors

This message generates all the default errors


3.4.95 RTRV-CRS-VT1: Retrieve Virtual Tributary Cross Connect

This command retrieves the VT cross-connection information.

Notes:

1. The UPSR VT cross connection can be retrieved by using "&" in the AID fields of this command.

To retrieve a 1-way selector or 2-way selector and bridge cross connection with:

from points: f1, f2

to points: t1

the output will be:

1-way:

"f1&f2,t1:CCT,1WAY"

2-way:

If retrieved on point f1 or f2, the output form is the same as the 1-way output.

If retrieved on T1, the output will be:

"t1,f1&f2:CCT"

To retrieve a 1-way bridge or 2-way selector and bridge cross connection with:

from point: f1

to points: t1, t2

the output will be:

1-way:

"f1,t1&t2:CCT,1WAY"

2-way:

"t1&t2,f1:CCT"

To retrieve a 1-way subtending UPSR connection or 2-way subtending UPSR cross connection with:

from point: f1, f2

to points: t1, t2

the output will be:

1-way:

"f1&f2,t1&t2:CCT,1WAY"

2-way:

If retrieved on point f1 or f2, the output format is the same as the 1-way output.

If retrieved on point t1 or t2, the output will be:

"t1&t2,f1&f2:CCT"

To retrieve a 2-way selector bridge cross connection with:

ENT-CRS-VT1::F1&F2,S1&S2:123::2WAY;

from points f1, f2 (f1 is the working side, f2 is the protect side)

selector: s1, s2 (s1 is the working side, s2 is the protect side)

the output will be:

If retrieved on point f1 or f2, the output will be:

"f1&f2,s1&s2:CCT"

If retrieved on selector s1 or s2, the output will be:

"s1&s2,f1&f2:CCT"

2. All a&b AIDs in the TL1 cross connection command are in the format of WorkingAid&ProtectAid.

Section
RTRV-CRS-VT1 Description 

Category

Cross Connections

Security

Retrieve

Related Messages

DLT-CRS-<STS_PATH>
DLT-CRS-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
RTRV-CRS-<STS_PATH>

Input Format

RTRV-CRS-VT1:[<TID>]:<AID>:<CTAG>[::::];

where:

<AID> identifies VT to check for connection membership; <AID> is from the "VT1_5" section and must not be null

Input Example

RTRV-CRS-VT1:CISCO:VT1-1-1-1-1:1234;

Output Format

SID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>:<CCT>"
;

where:

<FROM> indicates an identifier at one end of the VT cross connection and is the AID from the "VT1_5" section

<TO> indicates an identifier at the other end of the VT cross connection and is the AID from the "VT1_5" section

<CCT> identifies the cross connection type; valid values for <CCT> are shown in the "CCT" section

Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VT1-1-1-1-1,VT1-4-4-5-2:1WAY"
;

Errors

This message generates all the default errors


3.4.96 RTRV-DS1: Retrieve DS1 Layer of DS3XM

This command retrieves the test access attributes on the DS3XM card at the DS1 layer.

Section
RTRV-DS1 Description 

Category

Ports

Security

Retrieve

Related Messages

ED-<OCN_TYPE> RST-<MOD_PORT>
ED-DS1 RTRV-<OCN_TYPE>
ED-EC1 RTRV-EC1
ED-G1000 RTRV-G1000
ED-T1 RTRV-T1
ED-T3 RTRV-T3
RMV-<MOD_PORT>

Input Format

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

where:

<AID> is the access identifier of a DS1 layer entity on the DS3XM card; <AID> is from the "DS1" section and must not be null

Input Example

RTRV-DS1:PETALUMA:DS1-2-6-12:123;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[TACC=<TACC>]"
;

where:

<AID> is the access identifier from the "DS1" section

<TACC> defines the STS as a test access port with a selected unique TAP number. The TAP number ranges from 0-999; <TACC> is an integer and is optional.

Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"DS1-2-6-12::TACC=8"
;

Errors

This message generates all the default errors


3.4.97 RTRV-EC1: Retrieve EC1

This command retrieves the facility status of an EC1 card.

Section
RTRV-EC1 Description 

Category

Ports

Security

Retrieve

Related Messages

ED-<OCN_TYPE> RST-<MOD_PORT>
ED-DS1 RTRV-<OCN_TYPE>
ED-EC1 RTRV-DS1
ED-G1000 RTRV-G1000
ED-T1 RTRV-T1
ED-T3 RTRV-T3
RMV-<MOD_PORT>

Input Format

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

where:

<AID> is the access identifier from the "FACILITY" section and must not be null

Input Example

RTRV-EC1:CISCO:FAC-1-1:1234;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[PJMON=<pjmon>,][LBO=<LBO>,][RXEQUAL=<RXEQUAL>]:
[<PST>]"
;

where:

<AID> is the facility AID of an EC1 port and is from the "FACILITY" section

<PJMON> is the SONET pointer monitor attribute of an EC1 port and defaults to 0 (zero); <PJMON> is an integer and is optional

<LBO> is the line build-out value of an EC1 port; valid values for <LBO> are shown in the "E_LBO" section, <LBO> is optional

<RXEQUAL> is the Rx Equalization attribute of an EC1 port and is always in Y (enabled) state; valid values for <RXEQUAL> are shown in the "ON_OFF" section, <RXEQUAL> is optional

<PST> is the state of an EC1 port; valid values for <PST> are shown in the "PST" section, <PST> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::PJMON=0,LBO=0-225,RXEQUAL=Y:IS"
;

Errors

This message generates all the default errors


3.4.98 RTRV-EQPT: Retrieve Equipment

This command retrieves the data and state parameters associated with an equipment unit.

This command returns the PRTYPE, PROTID, RVTM and RVRTV parameters for a card inside of a protection group by the following scenario:

1. A working AID/card within a 1:1 protection group, the PRTYPE, PROTID, RVTM and RVRTV attributes will be displayed.

2. A protection AID/card within 1:1 protection group, the PRTYPE, RVTM and RVRTV attributes will be displayed.

3. A working AID/card within 1:N protection group, the PRTYPE, PROTID, RVTM and RVRTV=Y attributes will be displayed.

4. A protection AID/card within 1:1 protection group, the PRTYPE, RVTM and RVRTV=Y attributes will be displayed.

5. An unprotected AID/card, the AIDtype, equip (equip/unequip), status (act/standby), and state (IS/OOS).

Error conditions:

1. The equipment is not provisioned.

Section
RTRV-EQPT Description 

Category

Equipment

Security

Retrieve

Related Messages

ALW-SWDX-EQPT INH-SWTOWKG-EQPT
ALW-SWTOPROTN-EQPT REPT ALM EQPT
ALW-SWTOWKG-EQPT REPT EVT EQPT
DLT-EQPT RTRV-ALM-EQPT
ED-EQPT RTRV-COND-EQPT
ENT-EQPT SW-DX-EQPT
INH-SWDX-EQPT SW-TOPROTN-EQPT
INH-SWTOPROTN-EQPT SW-TOWKG-EQPT

Input Format

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

where:

<AID> is the access identifier from the "EQPT" section and must not be null.

Input Example

RTRV-EQPT:MIRABEL:SLOT-12:230;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:<AIDTYPE>,<EQUIP>,[<ROLE>],[<STATUS>]:
[PROTID=<PROTID>,][PRTYPE=<PRTYPE>,][RVRTV=<RVRTV>,]
[RVTM=<RVTM>,][CARDNAME=<CARDNAME>]:[<PST>]"
;

where:

<AID> is the equipment unit identifier and is from the "EQPT" section

<AIDTYPE> is the type of AID; valid values for <AIDTYPE> are shown in the "EQPT_TYPE" section

<EQUIP> indicates if the equipment unit is physically present; valid values for <EQUIP> are shown in the "EQUIP" section

<ROLE> indicates if the card is the working unit or the protecting unit; valid values for <ROLE> are shown in the "SIDE" section, <ROLE> is optional

<STATUS> indicates the status; valid values for <STATUS> are shown in the "STATUS" section, <STATUS> is optional

<PROTID> indicates the protecting identifier; <PROTID> is the AID "PRSLOT" section and is optional

<PRTYPE> indicates the protection type; valid values for <PRTYPE> are shown in the "PROTECTION_GROUP" section, <PRTYPE> is optional

<RVRTV> indicates the revertive mode; valid values for <RVRTV> are shown in the "ON_OFF" section, <RVRTV> is optional

<RVTM> indicates the revertive time; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section, <RVTM> is optional

<CARDNAME> indicates the card name from the hardware. It will be empty for the preprovisioned card; <CARDNAME> is a string and is optional

<PST> indicates the state; valid values for <PST> are shown in the "PST" section, <PST> is optional

Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-12:DS1,EQUIP,,ACT:PROTID=SLOT-13,PRTYPE=1-1,
RVRTV=Y,RVTM=8.5,CARDNAME=DESCRIPTION:IS"
;

Errors

This message generates all the default errors


3.4.99 RTRV-EXT-CONT: Retrieve External Control

This command instructs the NE to report the control state of an external control. The command can be used to audit the result of an OPR-EXT-CONT or a RLS-EXT-CONT command.

Notes:

1. If the conttype is null, the existing conttype on this AID will be returned.

2. The duration is not supported, it defaults to CONTS.

Section
RTRV-EXT-CONT Description 

Category

Environmental Alarms and Controls

Security

Retrieve

Related Messages

OPR-EXT-CONT RTRV-ATTR-CONT
REPT ALM ENV RTRV-ATTR-ENV
REPT EVT ENV RTRV-COND-ENV
RLS-EXT-CONT SET-ATTR-CONT
RTRV-ALM-ENV SET-ATTR-ENV

Input Format

RTRV-EXT-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];

where:

<AID> is the access identifier from the "ENV" section and must not be null

<CONTTYPE> is of type CONTTYPE and is optional

Input Example

RTRV-EXT-CONT:CISCO:ENV-OUT-2:123::AIRCOND;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>],<DUR>,[<CONTSTATE>]"
;

where:

<AID> identifies the external control for which control state is being retrieved and is from the "ENV" section

<CONTTYPE> is the type of control for which control state is being retrieved; valid values for <CONTTYPE> are shown in the "CONTTYPE" section, <CONTTYPE> is optional

<DUR> is the duration for which the external control can be operated; valid values for <DUR> are shown in the "DURATION" section

<CONTSTATE> is the control of the external control; valid values for <CONTSTATE> are shown in the "ENV_CRTL_MODE" section, <CONTSTATE> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND,CONTS,OPEN"
;

Errors

This message generates all the default errors


3.4.100 RTRV-FFP-<OCN_TYPE>: Retrieve Facility Protection Group (OC3, OC12, OC48, OC192)

This command retrieves the optical facility protection information.

Section
RTRV-FFP-<OCN_TYPE> Description 

Category

SONET Line Protection

Security

Retrieve

Related Messages

DLT-FFP-<OCN_TYPE>
ED-FFP-<OCN_TYPE>
ENT-FFP-<OCN_TYPE>
EX-SW-<OCN_BLSR>
OPR-PROTNSW-<OCN_TYPE>
RLS-PROTNSW-<OCN_TYPE>

Input Format

RTRV-FFP-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];

where:

<AID> is the optical facility AID from the "FACILITY" section and must not be null

Input Example

RTRV-FFP-OC3:PETALUMA:FAC-1-1:1;

Output Format

SID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>::[PROTID=<PROTID>,][RVRTV=<RVRTV>,]
[RVTM=<RVTM>,][PSDIRN=<PSDIRN>]"
;

where:

<WORK> identifies the working port and is the AID from the "FACILITY" section

<PROTECT> identifies the protection port and is the AID from the "FACILITY" section

<PROTID> is the protection group identifier (protection group name). It defaults to the protecting port of the protection group; <PROTID> is a string, it is optional and can have a maximum length of 32 characters

<RVRTV> identifies the revertive mode and defaults to N (non-revertive mode); valid values for <RVRTV> are shown in the "ON_OFF" section, <RVRTV> is optional

<RVTM> identifies the revertive time and defaults to 5.0 minutes; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section, <RVTM> is optional

<PSDIRN> indicates the switch mode and defaults to UNI. valid values for <PSDIRN> are shown in the "UNI_BI" section, <PSDIRN> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,FAC-1-1::PROTID=PROT_NAME,RVRTV=Y,RVTM=1.0,
PSDIRN=BI"
;

Errors

This message generates all the default errors


3.4.101 RTRV-G1000: Retrieve G1000

This command retrieves the facility status of a G1000 port.

Section
RTRV-G1000 Description 

Category

Ports

Security

Retrieve

Related Messages

ED-<OCN_TYPE> RST-<MOD_PORT>
ED-DS1 RTRV_<OCN_TYPE>
ED-EC1 RTRV-DS1
ED-G1000 RTRV-EC1
ED-T1 RTRV-T1
ED-T3 RTRV-T3
RMV-<MOD_PORT>

Input Format

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

where:

<AID> is the access identifier of a G1000 port; <AID> is from the "FACILITY" section and must not be null

Input Example

RTRV-G1000:TID:FAC-1-1:CTAG;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[MFS=<MFS>,][FLOW=<FLOW>,][LAN=<LAN>,]
[OPTICS=<OPTICS>]:[<PST>]"
;

where:

<AID> is the access identifier of a G1000 port and is from the "FACILITY" section

<MFS> is the maximum frame size and valid values are shown in the "MFS_TYPE" section; <MFS> is optional

<FLOW> is the link auto negotiation value and valid values are shown in the "ON_OFF" section; <FLOW> is optional

<LAN> is the type of flow control and valid values are shown in the "FLOW" section; <LAN> is optional

<OPTICS> is the type of gigabyte Ethernet optics in place. Valid values for <OPTICS> are shown in the "OPTICS" section; <OPTICS> is optional

<PST> is a state of a G1000 port and valid values are shown in the "PST" section; <PST> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::MFS=9032,FLOW=N,LAN=ASYMMETRIC,OPTICS=UNKNOWN:
OOS"
;

Errors

This message generates all the default errors


3.4.102 RTRV-HDR: Retrieve Header

This command instructs the NE to return the header of a TL1 response message. Used by TL1 clients to determine if the link to the NE is still active and if the NE is responding to commands.

Section
RTRV-HDR Description 

Category

System

Security

Retrieve

Related Messages

ALW-MSG-ALL RTRV-INV
ED-DAT RTRV-NE-GEN
ED-NE-GEN RTRV-NE-IPMAP
ED-NE-SYNCN RTRV-NE-SYNCN
INH-MSG-ALL RTRV-TOD
INIT-SYS SET-TOD

Input Format

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

Input Example

RTRV-HDR:SONOMA::232;

Errors

This message generates all the default errors


3.4.103 RTRV-INV: Retrieve Inventory

This command queries the NE and returns a listing of the equipment inventory. For each unit in the system, it identifies the unit's firmware numbers and the unit's CLEI code.


Note The ALL AID can be used to retrieve AIP, BP, FAN, and all slot inventory information on the NE.


.

Section
RTRV-INV Description 

Category

System

Security

Retrieve

Related Messages

ALW-MSG-ALL RTRV-HDR
ED-DAT RTRV-NE-GEN
ED-NE-GEN RTRV-NE-IPMAP
ED-NE-SYNCN RTRV-NE-SYNCN
INH-MSG-ALL RTRV-TOD
INIT-SYS SET-TOD

Input Format

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

where:

<AID> is the access identifier from the "EQPT" section and must not be null

Input Example

RTRV-INV:OCCIDENTAL:SLOT-15:301;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[PN=<PN>,][HWREV=<HWREV>,]
[FWREV=<FWREV>,][SN=<SN>,][CLEI=<CLEI>]"
;

where:

<AID> is the access identifier from the "EQPT" section

<AIDTYPE> specifies the type of AID; <AIDTYPE> is a string of the actual equipment type

<PN> is the HW part number; <PN> is a string and is optional

<HWREV> is the HW Rev; <HWREV> is a string and is optional

<FWREV> is the firmware Rev; <FWREV> is a string and is optional

<SN> is the serial number; <SN> is a string and is optional

<CLEI> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-15,OC3-IR-4::PN=87-31-00002,HWREV=004K,
FWREV=76-99-00009-004A,SN=013510,CLEI=NOCLEI"
;

Errors

This message generates all the default errors


3.4.104 RTRV-LOG: Retrieve Log

This command retrieves the alarm log of the NE.


Note The only option reported for LOGNM is ALARM.


Section
RTRV-LOG Description 

Category

Log

Security

Superuser

Related Messages

REPT DBCHG

Input Format

RTRV-LOG:[<TID>]::<CTAG>::<LOGNM>;

where:

<LOGNM> is the log name - ALARM; <LOGNM> is a string and must not be null

Input Example

RTRV-LOG:CISCO::123::ALARM;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>,<ALMNUMBER>:CURRENT=<CURRENT>,
[PREVIOUS=<PREVIOUS>,]<CONDITION>,<SRVEFF>,
[TIME=<OCRTIME>,][DATE=<OCRDAT>]:<ALMDESCR>"
;

where:

<AID> is the access identifier from the "ALL" section

<ALMNUMBER> is the alarm number of the log and is an integer

<CURRENT> is the current severity; valid values for <CURRENT> are shown in the "NOTIF_CODE" section

<PREVIOUS> is the previous severity; valid values for <PREVIOUS> are shown in the "COND_EFF" section, <PREVIOUS> is optional

<CONDITION> is the condition; valid values for <CONDITION> are shown in the "CONDITION" section

<SRVEFF> is the service effect; valid values for <SRVEFF> are shown in the "SERV_EFF" section

<OCRTIME> is the time an alarm is triggered; <OCRTIME> is a Time and is optional

<OCRDAT> is the date an alarm is triggered; <OCRDAT> is a Date and is optional

<ALMDESCR> is the alarm description and is a string

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,18:CURRENT=MJ,PREVIOUS=CL,EOC,NSA,TIME=16-33-04,
DATE=1971-02-03:\"SDCC TERMINATION FAILURE\""
;

Errors

This message generates all the default errors


3.4.105 RTRV-NE-GEN: Retrieve Network Element General

This command is used to retrieve the general NE attributes.

Section
RTRV-NE-GEN Description 

Category

System

Security

Retrieve

Related Messages

ALW-MSG-ALL RTRV-HDR
ED-DAT RTRV-INV
ED-NE-GEN RTRV-NE-IPMAP
ED-NE-SYNCN RTRV-NE-SYNCN
INH-MSG-ALL RTRV-TOD
INIT-SYS SET-TOD

Input Format

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

Input Example

RTRV-NE-GEN:CISCO::123;

Output Format

SID DATE TIME
M CTAG COMPLD
"[IPADDR=<IPADDR>,][IPMASK=<IPMASK>,][DEFRTR=<DEFRTR>,]
[NAME=<NAME>,][SWVER=<SWVER>,][LOAD=<LOAD>]"
;

where:

<IPADDR> indicates the node IP address; <IPADDR> is a string and is optional

<IPMASK> indicates the node IP mask; <IPMASK> is a string and is optional

<DEFRTR> indicates the node default router; <DEFRTR> is a string and is optional

<NAME> is the node name. The maximum name size is 20 characters; <name> is a string and is optional

<SWVER> is the software version; <SWVER> is a string and is optional

<LOAD> is the load version; <LOAD> is a string and is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"IPADDR=192.168.100.52,IPMASK=255.255.255.0,
DEFRTR=192.168.100.1,NAME=NODENAME,SWVER=2.01.03,
LOAD=02.13-E09A-08.15"

;

Errors

This message generates all the default errors


3.4.106 RTRV-NE-IPMAP: Retrieve Network Element IPMAP

This command is used to retrieve a list of all nodes that are DCC connected.

Section
RTRV-NE-IPMAP Description 

Category

System

Security

Retrieve

Related Messages

ALW-MSG-ALL RTRV-HDR
ED-DAT RTRV-INV
ED-NE-GEN RTRV-NE-GEN
ED-NE-SYNCN RTRV-NE-SYNCN
INH-MSG-ALL RTRV-TOD
INIT-SYS SET-TOD

Input Format

RTRV-NE-IPMAP:[<TID>]:[<AID>]:<CTAG>;

where:

<AID> is the port of an NE carrying a DCC connection; <AID> is from the "FACILITY" section and a null value defaults to the whole NE

Input Example

RTRV-NE-IPMAP:CISCO:FAC-12-1:123;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:<IPADDR>"
;

where:

<AID> is the port of an NE carrying a DCC connection and is from the "FACILITY" section

<IPADDR> is the IP address and is a string

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-12-1:172.20.208.225"

;

Errors

This message generates all the default errors


3.4.107 RTRV-NE-SYNCN: Retrieve Network Element Synchronization

This command is used to retrieve the synchronization attributes of the NE.

Notes:

1. Although mixed mode timing is supported in this release, it is not recommended. See the "Mixed Mode Timing Support" section on page 1-7 for more information.

2. The existing external and line modes have the same functionality in all 3.x releases:

External mode: the node derives its timing from the BITS inputs.

Line mode: the node derives its timing from the SONET line(s).

Mixed mode: the node derives its timing from the BITS input or SONET lines.

Section
RTRV-NE-SYNCN Description 

Category

Synchronization

Security

Retrieve

Related Messages

ALW-MSG-ALL RLS-SYNCNSW
ED-BITS RTRV-ALM-BITS
ED-DAT RTRV-ALM-SYNCN
ED-NE-GEN RTRV-BITS
ED-NE-SYNCN RTRV-COND-BITS
ED-SYNCN RTRV-COND-SYNCN
INH-MSG-ALL RTRV-HDR
INIT-SYS RTRV-INV
OPR-SYNCNSW RTRV-NE-GEN
REPT ALM BITS RTRV-NE IPMAP
REPT ALM SYNCN RTRV-SYNCN
REPT EVT BITS RTRV-TOD
REPT EVT SYNCN SET-TOD

Input Format

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

Input Example

RTRV-NE-SYNCN:CISCO::123;

Output Format

SID DATE TIME
M CTAG COMPLD
"::[TMMD=<TMMD>,][SSMGEN=<SSMGEN>,][QRES=<QRES>,]
[RVRTV=<RVRTV>,][RVTM=<RVTM>]"
;

where:

<TMMD> is the timing mode; valid values for <TMMD> are shown in the "TIMING_MODE" section, <TMMD> is optional

<SSMGEN> is the SSM generator; valid values for <SSMGEN> are shown in the "SYNC_GENERATION" section, <SSMGEN> is optional

<QRES> is the quality of RES; valid values for <QRES> are shown in the "SYNC_QUALITY_LEVEL" section, <QRES> is optional

<RVRTV> is the revertive mode; valid values for <RVRTV> are shown in the "ON_OFF" section, <RVRTV> is optional

<RVTM> is the revertive time; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section, <RVTM> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"::TMMD=LINE,SSMGEN=GEN1,QRES=ABOVE-PRS,RVRTV=Y,
RVTM=8.0"

;

Errors

This message generates all the default errors


3.4.108 RTRV-PM-<MOD2>: Retrieve Performance (DS1, EC1, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

This command retrieves the values of PM parameters for a specified card type.

<MONTYPE>, <MONLEV>, <MONDAT> and <MONTM> are supported in this release.

This command can be used to retrieve present and historical PM values for 1-day retrieving.

This command can be used to retrieve current time and previous (8 hours) history PM values for 15-min retrieving.

Notes:

1. If the <TMPER> is 1-DAY, <MONTM> is not applicable (null). The command will not ignore the <MONTM> if the command input parameter <TMPER> is 1-DAY.

2. A null value for MONLEV defaults to 1-UP.

3. A null value for MONDAT defaults to the current date (MM-DD).

4. A null value for MONTM defaults to the current time (HH-MM).

Section
RTRV-PM-<MOD2> Description 

Category

Performance

Security

Retrieve

Related Messages

INIT-REG-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

Input Format

RTRV-PM-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],
[<MONLEV>],[<LOCN>],,[<TMPER>],[<MONDAT>],[<MONTM>];

where:

<AID> is the access identifier. All the STS, VT1_5, FACILITY and DS1 AIDs are supported; <AID> is from the "ALL" section and must not be null

<MONTYPE> indicates the type of the monitored parameter; valid values for <MONTYPE> are shown in the "ALL_MONTYPE" section

<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 valid values fro DIRN are shown in the "DIRN" section. A null value for <MONLEV> defaults to 1-UP. <MONLEV> is a string.

<LOCN> indicates the location; valid values for <LOCN> are shown in the "LOCATION" section

<TMPER> indicates the accumulation time period for the PM information; valid values for <TMPER> are shown in the "TMPER" section

<MONDAT> is the beginning date of the PM or storage register period specified in <TMPER>. The format of MONDAT 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 for MONDAT defaults to the current date (MM-DD). <MONDAT> is a date.

<MONTM> is the beginning time of the day of the PM or storage register period specified in <TMPER>. The format for MONTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0-59. A null value for MONTM defaults to the current time (HH-MM). <MONTM> is a time.

Input Example

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

Output Format

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

where:

<AID> is the access identifier from the "ALL" section

<AIDTYPE> specifies the type of AID; valid values for <AIDTYPE> are shown in the "MOD2B" section, <AIDTYPE> is optional

<MONTYPE> indicates the type of monitored parameter; valid values for <MONTYPE> are shown in the "ALL_MONTYPE" section

<MONVAL> is the measured value of the monitored parameter and is an integer

<VLDTY> is the validity indicator of historical monitoring information; valid values for <VLDTY> are shown in the "VALIDITY" section, <VLDTY> is optional

<LOCN> indicates the location; valid values for <LOCN> are shown in the "LOCATION" section, <LOCN> is optional

<DIRN> is the direction of PM relative to the entity identified by the AID; valid values for <DIRN> are shown in the "DIRECTION" section, <DIRN> is optional

<TMPER> indicates the accumulation time period for the PM information; valid values for <TMPER> are shown in the "TMPER" section, <TMPER> is optional

<MONDAT> is the beginning date of the PM or storage register period specified in <TMPER>. The format of MONDAT 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 for MONDAT defaults to the current date (MM-DD). <MONDAT> is a date.

<MONTM> is the beginning time of the day of the PM or storage register period specified in <TMPER>. The format for MONTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0-59. A null value for MONTM defaults to the current time (HH-MM). <MONTM> is a time.

Output Example

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

Errors

This message generates all the default errors


3.4.109 RTRV-PMMODE-<STS_PATH>: Retrieve Performance Mode of PM Data Collection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command instructs a SONET NE to send the type of PM mode that has been previously set in the NE. This command can be used to identify whether the PM parameters are Section, Line or Path type, and to identify whether or not the PM are being collected by the NE.

This command returns the categories that are enabled only.

The PM mode and state of an entity is set by using the SET-PMMODE command.

Notes:

1. This near end monitoring of the intermediate-path PM (IPPM) only supports OC-3, OC-12, OC-48, OC-48AS, OC-192, and EC-1 on STS Path.

2. The far end PM data collection is not supported by the current ONS 15454, at this time of preparation of this document.

3. This release of software will support only the Path (P) mode type PM parameters with this command, that is, this command will not be applicable for Line (L) and Section (S) mode types. It should be noted that the PM monitoring for Line (L) and Section (S) are supported by the ONS 15454, and the storing PM data is always performed.

4. This command only returns the categories that are enabled (pmstate is ON), and does not return the categories that are disabled (pmstate is OFF).

Section
RTRV-PMMODE-<STS_PATH> Description 

Category

Performance

Security

Retrieve

Related Messages

INIT-REG-<MOD2>
RTRV-PM-<MOD2>
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

Input Format

RTRV-PMMODE-<STS_PATH>:[<TID>]:<AID>:<CTAG>::<LOCN>;

where:

<AID> identifies the entity from where the PM mode is being retrieved; <AID> is from the "STS" section and must not be null

<LOCN> identifies the location from where the PM mode is being retrieved and valid values for <LOCN> are shown in the "LOCATION" section; <LOCN> must not be null

Input Example

RTRV-PMMODE-STS1:CISCO:STS-4-2:123::NEND;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:[<LOCN>],<MODETYPE>"
;

where:

<AID> identifies the entity from where the PM mode is being retrieved; <AID> is from the "STS" section

<LOCN> identifies the location from where the PM mode is being retrieved; valid values for <LOCN> are shown in the "LOCATION" section and <LOCN> must not be null

<MODETYPE> identifies whether or not the PM mode type is turned on or off; valid values for <MODETYPE> are shown in the "PM_MODE" section

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-4-2:NEND,P"
;

Errors

This message generates all the default errors


3.4.110 RTRV-PTHTRC-<STS_PATH>: Retrieve Path Trace (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command instructs a SONET NE to retrieve the contents of the SONET path trace message that is transported in the J1 byte of the SONET STS Path.

The path trace message is a 64-character string with the last two characters reserved for the terminating CR (carriage return) and the LF (line feed). The message can be an incoming path trace message, an expected incoming path trace message, or an outgoing path trace message which is inserted into the path overhead of the outgoing signal.

The path trace mode has three modes: OFF, MANUAL, and AUTO. The path trace mode defaults to OFF mode. The MANUAL mode performs the comparison of the received string with the user-entered expected string. The AUTO mode performs the comparison of the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.

When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user-entered string. When an expected string is queried under the AUTO path trace mode, the expected string is a copy of the acquired received string or NULL if the string has not been acquired.

When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is a copy of the received string or NULL if the string has not been received.

When the transmitted string is queried under the OFF, MANUAL or AUTO path trace mode, the transmitted string is the provisioned transmit string.

Notes:

1. A null value for the <MSGTYPE> defaults to INCTRC.

2. Only the NEND of the locn value is supported. A null value of the locn defaults to NEND.

3. Sending a FEND of the locn with this command, an "unsupported locn value" error message should be presented.

Section
RTRV-PTHTRC-<STS_PATH> Description 

Category

STS and VT Paths

Security

Retrieve

Related Messages

ED-<STS_PATH>
ED-VT1
RTRV-<STS_PATH>
RTRV-VT1

Input Format

RTRV-PTHTRC-<STS_PATH>:[<TID>]:<AID>:<CTAG>::[<MSGTYPE>]
[:<LOCN>];

where:

<AID> is the access identifier from the "STS" section and must not be null

<MSGTYPE> is the type of trace message to be retrieved; valid values for <MSGTYPE> are shown in the "MSGTYPE" section and a null value defaults to INCTRC

<LOCN> is the location of the trace message; valid values for <LOCN> are shown in the "LOCATION" section.

Input Example

RTRV-PTHTRC-STS1:CISCO:STS-2-1:123::EXPTRC:NEND;

Output Format

SID DATE TIME
M CTAG COMPLD
"<TRACMSG>"
;

where:

<TRACMSG> is the Path Trace message returned to the requester. The message should be up 64 ASCII characters in length.The user is allowed to enter up to 62 ASCII characters, the last two characters are reserved for the terminating CR (carriage return) and LF (line feed); <TRACMSG> is a string

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"TRACMSG"
;

Errors

This message generates all the default errors


3.4.111 RTRV-SYNCN: Retrieve Synchronization

This command retrieves the synchronization reference list used to determine the sources for the NE's reference clock and the BITS output clock. For each clock, up to three synchronization sources may be specified (e.g. PRIMARY, SECOND, THIRD).

Notes:

1. To retrieve/set the timing mode, SSM message Set or Quality of RES information, use the RTRV-NE-SYNCN and ED-NE-SYNCN commands.

2. The output example shown here is under line timing mode.

Section
RTRV-SYNCN Description 

Category

Synchronization

Security

Retrieve

Related Messages

ED-BITS RLS-SYNCNSW
ED-NE-SYNCN RTRV-ALM-BITS
ED-SYNCN RTRV-ALM-SYNCN
OPR-SYNCNSW RTRV-BITS
REPT ALM BITS RTRV-COND-BITS
REPT ALM SYNCN RTRV-COND-SYNCN
REPT EVT BITS RTRV-NE-SYNCN
REPT EVT SYNCN

Input Format

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

where:

<AID> identifies the synchronization reference to retrieve; <AID> is from the "SYNC_REF" section, is listable and must not be null

Input Example

RTRV-SYNCN:BOYES:SYNC-NE:234;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>:<REF>,<REFVAL>,[<QRES>],[<STATUS>]"
;

where:

<AID> is the synchronization reference to be modified and is from the "SYNC_REF" section

<REF> is the rank of the synchronization reference and is the AID from the "SYNCSW" section

<REFVAL> is the value of the synchronization reference and is the AID from the "SYN_SRC" section

<QRES> is the quality of the RES; valid values for <QRES> are shown in the "SYNC_QUALITY_LEVEL" section, <QRES> is optional

<STATUS> is the active status of the synchronization source; valid values for <STATUS> are shown in the "STATUS" section, <STATUS> is optional

Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE:PRI,FAC-1-2,PRS,ACT"
;

Errors

This message generates all the default errors


3.4.112 RTRV-T1: Retrieve T1 Facility

This command retrieves the DS-1 facilities configuration.

Section
RTRV-T1 Description 

Category

Ports

Security

Retrieve

Related Messages

ED-<OCN_TYPE> RST <MOD_PORT>
ED-DS1 RTRV-<OCN_TYPE>
ED-EC1 RTRV-DS1
ED-G1000 RTRV-EC1
ED-T1 RTRV-G1000
ED-T3 RTRV-T3
RMV <MOD_PORT>

Input Format

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

where:

<AID> is the access identifier; <AID> is the AID from the "FACILITY" section and must not be null

Input Example

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

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[LINECDE=<LINECDE>,][FMT=<FMT>,][LBO=<LBO>,]
[TACC=<TACC>]:[<PST>]"
;

where:

<AID> is the access identifier from the "FACILITY" section

<LINECDE> is the line code; valid values for <LINECDE> are shown in the "LINE_CODE" section, <LINECDE> is optional

<FMT> is the frame format; valid values for <FMT> are shown in the "FRAME_FORMAT" section, <FMT> is optional

<LBO> is the line buildout; valid values for <LBO> are shown in the "LINE_BUILDOUT" section, <LBO> is optional

<TACC> defines the STS as a test access port with a selected unique TAP number. The TAP number ranges from 0-999; <TACC> is optional.

<PST> is the state; valid values for <PST> are shown in the "PST" section, <PST> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1::LINECDE=AMI,FMT=ESF,LBO=0-131,TACC=8:OOS"
;

Errors

This message generates all the default errors


3.4.113 RTRV-T3: Retrieve T3

This command retrieves the facility properties of a DS3 and a DS3XM card.

Notes:

1. CTC can set the FMT attribute of a DS3(N)E line to autoprovision to set the framing based on the framing is coming in. This would result in the FMT field being blanked out for a few seconds blanked forever for a preprovisioned DS3(N)E card on CTC.

2. The autoprovision is not considered a valid DS3 framing type. It is used only to trigger an autosense and subsequent autoprovisioning of a valid DS3 framing type (unframed, M23, C-BIT).

3. TL1 does not have the autoprovision mode according to GR-199. TL1 maps/returns the autoprovision to be the unframed framing type.

Section
RTRV-T3 Description 

Category

Ports

Security

Retrieve

Related Messages

ED-<OCN_TYPE> RST-<MOD_PORT>
ED-DS1 RTRV-<OCN_TYPE>
ED-EC1 RTRV-DS1
ED-G1000 RTRV-EC1
ED-T1 RTRV-G1000
ED-T3 RTRV-T1
RMV-<MOD_PORT>

Input Format

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

where:

<AID> is the access identifier from the "FACILITY" section and must not be null

Input Example

RTRV-T3:CISCO:FAC-1-2:123;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[FMT=<FMT>,][LINECDE=<LINECDE>,][LBO=<LBO>,]
[TACC=<TACC>]:[<PST>]"
;

where:

<AID> is the access identifier from the "FACILITY" section

<FMT> is the frame format; valid values for <FMT> are shown in the "DS_LINE_TYPE" section, <FMT> is optional

<LINECDE> is the line code; valid values for <LINECDE> are shown in the "DS_LINE_CODE" section, <LINECDE> is optional

<LBO> is the line buildout; valid values for <LBO> are shown in the "E_LBO" section, <LBO> is optional

<TACC> defines the STS as a test access port with a selected unique TAP number. The TAP number ranges from 0-999; <TACC> is optional

<PST> is the state; valid values for <PST> are shown in the "PST" section, <PST> is optional

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-2::FMT=C-BIT,LINECDE=B3ZS,LBO=0-225,TACC=8:IS"
;

Errors

This message generates all the default errors


3.4.114 RTRV-TH-<MOD2>: Retrieve Threshold (DS1, EC1, OC3, OC12, OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

This command retrieves the threshold level of one or more monitored parameters.

Section
RTRV-TH-<MOD2> Description 

Category

Performance

Security

Retrieve

Related Messages

INIT-REG-<MOD2>
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

Input Format

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

where:

<AID> is the access identifier from the "ALL" section and must not be null

<MONTYPE> is the monitored type and defaults to CVL; valid values for <MONTYPE> are shown in the "ALL_MONTYPE" section

<LOCN> is the location; valid values for <LOCN> are shown in the "LOCATION" section

<TMPER> indicates the accumulation time period for the PM information; valid values for <TMPER> are shown in the "TMPER" section

Input Example

RTRV-TH-T3:CISCO:FAC-1-3:1234::CVL,NEND,15-MIN;

Output Format

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

where:

<AID> is the access identifier from the "ALL" section

<AIDTYPE> specifies the type of AID; valid values for <AIDTYPE> are shown in the "MOD2B" section, <AIDTYPE> is optional

<MONTYPE> indicates the monitored type; valid values for <MONTYPE> are shown in the "ALL_MONTYPE" section

<LOCN> is the location; valid values for <LOCN> are shown in the "LOCATION" section, <LOCN> is optional

<THLEV> is the threshold value and is an integer

<TMPER> is the accumulation time period for the PM information; valid values for <TMPER> are shown in the "TMPER" section, <TMPER> is optional

Output Example

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

Errors

This message generates all the default errors


3.4.115 RTRV-TOD: Retrieve Time of Day

This command queries the NE and displays the system date and time at the instant when the command was executed. The time returned is in Coordinated Universal Time (UTC).

Section
RTRV-TOD Description 

Category

System

Security

Retrieve

Related Messages

ALW-MSG-ALL RTRV-HDR
ED-DAT RTRV-INV
ED-NE-GEN RTRV-NE-GEN
ED-NE-SYNCN RTRV-NE-IPMAP
INH-MSG-ALL RTRV-NE-SYNCN
INIT-SYS SET-TOD

Input Format

RTRV-TOD:[<TID>]::<CTAG>;

Input Example

RTRV-TOD:CAZADERO::230;

Output Format

SID DATE TIME
M CTAG COMPLD
"<YEAR>,<MONTH>,<DAY>,<HOUR>,<MINUTE>,<SECOND>,
<TMTYPE>"
;

where:

<YEAR> is the current calendar year and is a string

<MONTH> is the month of the year and ranges from 01 to 12; <MONTH> is a string

<DAY> is the day of the month and ranges from 01 to 31; <DAY> is a string

<HOUR> is the hour of the day and ranges from 00 to 23; <HOUR> is a string

<MINUTE> is the minute of the hour and ranges from 00 to 59; <MINUTE> is a string

<SECOND> is the second of the minute and ranges from 00 to 59; <SECOND> is a string

<TMTYPE> identifies the time zone and is a string

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"1998,05,08,17,01,33,UTC"
;

Errors

This message generates all the default errors


3.4.116 RTRV-VT1: Retrieve Virtual Tributary

This command retrieves the attributes associated with a VT1 path.


Note Both RVRTV and RVTM parameters only apply to UPSR.


Section
RTRV-VT1 Description 

Category

STS and VT Paths

Security

Retrieve

Related Messages

ED-<STS_PATH>
ED-VT1
RTRV-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>

Input Format

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

where:

<AID> is the access identifier from the "VT1_5" section and must not be null

Input Example

RTRV-VT1:CISCO:VT1-2-4-1-2:123;

Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>::[RVRTV=<RVRTV>,][RVTM=<RVTM>,][TACC=<TACC>]"

;

where:

<AID> is the access identifier from the "VT1_5" section and must not be null

<RVRTV> identifies the revertive mode which only applies to UPSR and defaults to N (non-revertive mode); valid values for <RVRTV> are shown in the "ON_OFF" section and <RVRTV> is optional

<RVTM> identifies the revertive time which only applies to UPSR and defaults to empty because <RVRTV> is N when UPSR VT1 is created. Valid values for <RVTM> are shown in the "REVERTIVE_TIME" section and <RVTM> is optional.

<TACC> defines the STS as a test access port with a selected unique TAP number. The TAP number ranges from 0-999; <TACC> is optional.

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VT1-2-4-1-2::RVRTV=Y,RVTM=1.0,TACC=8"

;

Errors

This message generates all the default errors


3.4.117 SET-ATTR-CONT: Set Attribute Control

This command instructs the NE to set the attributes associated with an external control. The attributes are used when an external control is operated or released. To send the attributes, use the RTRV-ATTR-CONT command.

Section
SET-ATTR-CONT Description 

Category

Environmental Alarms and Controls

Security

Provisioning

Related Messages

OPR-EXT-CONT RTRV-ATTR-CONT
REPT ALM ENV RTRV-ATTR-ENV
REPT EVT ENV RTRV-COND-ENV
RLS-EXT-CONT RTRV-EXT-CONT
RTRV-ALM-ENV SET-ATTR-ENV

Input Format

SET-ATTR-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];

where:

<AID> identifies the external control for which attributes are being retrieved and is from the "ENV" section

<CONTTYPE> is the type of external control for which the attribute is being retrieved; valid values for <CONTTYPE> are shown in the "CONTTYPE" section. A null value of <CONTTYPE> defaults to MISC.

Input Example

SET-ATTR-CONT:CISCO:ENV-OUT-1:123::AIRCOND;

Errors

This message generates all the default errors


3.4.118 SET-ATTR-ENV: Set Attribute Environment

This command sets the attributes associated with an external control.

Section
SET-ATTR-ENV Description 

Category

Environmental Alarms and Controls

Security

Provisioning

Related Messages

OPR-EXT-CONT RTRV-ATTR-CONT
REPT ALM ENV RTRV-ATTR-ENV
REPT EVT ENV RTRV-COND-ENV
RLS-EXT-CONT RTRV-EXT-CONT
RTRV-ALM-ENV SET-ATTR-CONT

Input Format

SET-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>],
[<ALMMSG>];

where:

<AID> is the access identifier from the "ENV" section and must not be null

<NTFCNCDE> is the notification code; valid values for <NTFCNCDE> are shown in the "NOTIF_CODE" section

<ALMTYPE> is the type for the environmental alarm; valid values for <ALMTYPE> are shown in the "ENV_ALM" section

<ALMMSG> is the alarm message and is a string

Input Example

SET-ATTR-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR,\"OPEN DOOR\";

Errors

This message generates all the default errors


3.4.119 SET-PMMODE-<STS_PATH>: Set Performance Mode of PM Data Collection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

This command instructs a SONET NE to set the mode and to turn on or off the mode of the PM data collection. The Cisco ONS 15454 is capable of collecting and storing section, line and path PM data.

The PM mode and state of an entity are retrieved by using the RTRV-PMMODE command.

Notes:

1. This near end monitoring of the intermediate-path PM (IPPM) only supports for OC-3, OC-12, OC-48, OC-48AS, OC-192, and EC-1 on STS Path.

2. The far end PM data collection is not supported by the current ONS 15454, at this time of preparation of this document.

3. This release of software will support only the Path (P) mode type PM parameters with this command, that is, this command will not be applicable for Line (L) and Section (S) mode types. It should be noted that the PM monitoring for Line (L) and Section (S) are supported by the ONS 15454, and the storing PM data is always performed.

Section
RTRV-PMMODE-<STS_PATH> Description 

Category

Performance

Security

Provisioning

Related Messages

INIT-REG-<MOD2>
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-TH-<MOD2>
SET-TH-<MOD2>

Input Format

SET-PMMODE-<STS_PATH>:[<TID>]:<AID>:<CTAG>::<LOCN>,
<MODETYPE>,[<PMSTATE>];

where:

<AID> identifies the entity from where the PM mode is being set; <AID> is from the "STS" section and must not be null

<LOCN> identifies the location from where the PM mode is to be set and only supports near end PM data collection; valid values for <LOCN> are shown in the "LOCATION" section; <LOCN> must not be null

<MODETYPE> identifies the type of PM parameters; only the Path (P) PM parameter is supported and valid values for <MODETYPE> are shown in the "PM_MODE" section

<PMSTATE> directs the named PM mode type to turn on or off and a null value defaults to On; valid values for <PMSTATE> are shown in the "PM_STATE" section

Input Example

SET-PMMODE-STS1:CISCO:STS-4-2:123::NEND,P,ON;

Errors

This message generates all the default errors


3.4.120 SET-TH-<MOD2>: Set Threshold (DS1, EC1, OC3, OC12,OC48, OC192, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C,T1, T3, VT1)

This command sets the threshold of PM parameters.

Section
SET-TH-<MOD2> Description 

Category

Performance

Security

Provisioning

Related Messages

INIT-REG-<MOD2>
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-TH-<MOD2>
SET-PMMODE-<STS_PATH>

Input Format

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

where:

<AID> indicates the access identifier. All the STS, VT1, FACILITY and DS1 AIDs are supported and <AID> is from the "ALL" section

<MONTYPE> is the monitored value; valid values for <MONTYPE> are shown in the "ALL_MONTYPE" section

<THLEV> is the threshold value and is an integer

<LOCN> is the location; valid values for <LOCN> are shown in the "LOCATION" section

<TMPER> is the accumulation time period for the PM information; valid values for <TMPER> are shown in the "TMPER" section

Input Example

SET-TH-T3:CISCO:FAC-1-1:123::CVL,12,NEND,,15-MIN;

Errors

This message generates all the default errors


3.4.121 SET-TOD: Set Time of Day

This command sets the system date and time for the NE. The year should be entered using four digits while the hour should be entered using a 24-hour time period (i.e. military time).

Section
SET-TOD Description 

Category

System

Security

Provisioning

Related Messages

ALW-MSG-ALL RTRV-HDR
ED-DAT RTRV-INV
ED-NE-GEN RTRV-NE-GEN
ED-NE-SYNCN RTRV-NE-IPMAP
INH-MSG-ALL RTRV-NE-SYNCN
INIT-SYS RTRV-TOD

Input Format

SET-TOD:[<TID>]::<CTAG>::<YEAR>,<MONTH>,<DAY>,<HOUR>,
<MINUTE>,<SECOND>,[<DIFFERENCE>][:DST=<DST>];

where:

<YEAR> is the current calendar year and is an integer

<MONTH> is the month of the year and ranges from 01 to 12; <MONTH> is an integer

<DAY> is the day of the month and ranges from 01 to 31; <DAY> is an integer

<HOUR> is the hour of the day and ranges from 00 to 24; <HOUR> is an integer

<MINUTE> is the minute of the hour and ranges from 00 to 60; <MINUTE> is an integer

<SECOND> is the second of the minute and ranges from 00 to 59; second is an integer

<DIFFERENCE> is the number of minutes off UTC and is an integer

<DST> identifies if the time is a Daylight Saving Time (Y) or not (N); valid values for <DST> are shown in the "ON_OFF" section

Input Example

SET-TOD:CAZADERO::240::1998,05,08,13,18,55,480:DST=Y;

Errors

This message generates all the default errors


3.4.122 SW-DX-EQPT: Switch Duplex Equipment

This command switches an XC/XCVT card with the mate card within the NE.


Note If sending a mode parameter with a value other than NORM, FRCD, or NULL, the IDNV (Input, Data Not Valid) error message will be returned.


Section
SW-DX-EQPT Description 

Category

Equipment

Security

Maintenance

Related Messages

ALW-SWDX-EQPT INH-SWTOWKG-EQPT
ALW-SWTOPROTN-EQPT REPT ALM EQPT
ALW-SWTOWKG-EQPT REPT EVT EQPT
DLT-EQPT RTRV-ALM-EQPT
ED-EQPT RTRV-COND-EQPT
ENT-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-TOPROTN-EQPT
INH-SWTOPROTN-EQPT SW-TOWKG-EQPT

Input Format

SW-DX-EQPT:[<TID>]:<AID>:<CTAG>::[<MODE>][,];

where:

<AID> identifies the equipment (XC/XCVT) unit in the NE that is to be switched with its mate unit; <AID> is from the "EQPT" section

<MODE> is the mode in which the command is to be implemented. This parameter will only support the NORM and FRCD values. The NULL value for <MODE> will default to NORM. Sending the FRCD value for <MODE> will generate the same switching behavior as sending the NORM value. Valid values for <MODE> are shown in the "CMD_MODE" section

Input Example

SW-DX-EQPT:CISCO:SLOT-1:123::FRCD;

Errors

This message generates all the default errors


3.4.123 SW-TOPROTN-EQPT: Switch to Protection Equipment

This command instructs the NE to perform an equipment unit protection switch. This command is used for non-SONET line cards (e.g. DS1, DS3, DS3XM, and EC1). DS1 and DS3 cards have 1:1 and 1:N equipment protection. DS3XM and EC1 cards have only 1:1 equipment protection.

This command will switch the traffic from the working card specified in the AID to the protect card.

There is a priority for the switch to protection command. In a 1:N protection group with N > 1, consider two working cards - A and B. Card A is switched to the protect card with the SW-TOPROTN command. If card B is pulled from the system, the protect card will carry the traffic of card B and card A will raise the FAILTOSW condition and carry traffic. When card B is replaced and the revert timer expires, card B will carry traffic and card A will switch to the protect card. The FAILTOSW condition on card A will be cleared. Note:1:N protection groups in the system are always revertive.

In a revertive protection group, the unit specified by the AID will raise the standing condition of WKSWPR if the command were executed without an error. In a non-revertive protection group, the unit specified by the AID will raise the transient condition of WKSWPR if the command were executed without an error.

Notes:

1. The default PROTID is the protecting unit if there is only one protection unit per protection group in the NE, otherwise a DENY error message should be responsed.

2. This command only supports one value of the <DIRN> parameter - BTH or null. A command with any other value is considered an incorrect use of the command. An IDNV (Input, Data Not Valid) error message should be responsed

3. This command is not used for the common control (TCC+ or XC/XCVT) cards. A command on a common control card will generate an IIAC (Input, Invalid Access Identifier) error message. To use the common control card switching commands, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

4. This command is not used for SONET (OCN) cards. A command on a SONET card will generate an IIAC (Input, Invalid Access Identifier) error message. To use a SONET card switching command, use the OPR-PROTNSW and RLS-PROTNSW commands.

5. If this command is used on a card that is not in a protection group, the SNVS (Status, Not in Valid State) error message should be responsed.

6. If this command is sent to a missing working card, the SWFA (Status, Working Unit Failed) error message should be responsed.

7. If this command is used on a protection card, the IIAC (Input, Invalid Access Identifier) error message should be responsed.

8. If sending a mode parameter with a value other than NORM, FRCD, or null, the IDNV (Input, Data Not Valid) error message should be responsed.

9. If sending the SW-TOPROTN command to a working card when the working card has raised INHSWPR, the SWLD (Status, Working Unit Locked) error message should be responsed.

10. If sending the SW-TOPROTN command to a working card when the protection card has raised INHSWPR, the SPLD (Status, Protection Unit Locked) error message should be responsed.

11. If sending the SW-TOPROTN command to an active working card when the protect card is already carrying traffic. This only occurs in a 1:N protection group with N greater than one, the SNVS (Status, Not in Valid State) error message should be responsed.

12. If sending the SW-TOPROTN command to an active working card when the protect card is failed or missing, the SPFA (Status, Protection Unit Failed) error message should be responsed.

13. If sending this command to a standby working card, the SNVS (Status, Not in Valid State) error message should be responsed.

Section
SW-TOPROTN-EQPT Description 

Category

Equipment

Security

Maintenance

Related Messages

ALW-SWDX-EQPT INH-SWTOWKG-EQPT
ALW-SWTOPROTN-EQPT REPT ALM EQPT
ALW-SWTOWKG-EQPT REPT EVT EQPT
DLT-EQPT RTRV-ALM-EQPT
ED-EQPT RTRV-COND-EQPT
ENT-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TOWKG-EQPT

Input Format

SW-TOPROTN-EQPT:[<TID>]:<AID>:<CTAG>::[<MODE>],[<PROTID>],
[<DIRN>];

where:

<AID> is the parameter that specifies the working unit which will have traffic switched to protection and is from the "EQPT" section

<MODE> is the parameter that will only support the NORM and FRCD values. The null value for <MODE> will default to NORM. Sending the FRCD value for <MODE> will generate the same switching behavior as sending the NORM value. Valid values for <MODE> are shown in the "CMD_MODE" section

<PROTID> identifies the protection unit to be switched when there is more than one protection unit within the NE; <PROTID> is the AID from the "PRSLOT" section

<DIRN> is the direction of transmission in which switching is to be made. The command only supports one value of the <DIRN> parameter - BTH. This parameter defaults to BTH; valid values for <DIRN> are shown in the "DIRECTION" section

Input Example

SW-TOPROTN-EQPT:CISCO:SLOT-1:123::FRCD,SLOT-3,BTH;

Errors

This message generates all the default errors


3.4.124 SW-TOWKG-EQPT: Switch to Working Equipment

This command instructs the NE to switch the protected working unit back to working unit.

This command is used for non-SONET line cards (e.g. DS1, DS3, DS3XM, and EC1). DS1 and DS3 cards have 1:1 and 1:N equipment protection. DS3XM and EC1 cards have only 1:1 equipment protection. cards.

This command will switch the traffic from the protection card to the working card specified by the AID.

In a revertive protection group, the unit specified by the AID will clear the standing condition of WKSWPR if the command were executed without an error. In a non-revertive protection group, the unit specified by the AID will raise the transient condition of WKSWBK if the command were executed without an error.

Notes:

1. This command only supports one value of the <DIRN> parameter - BTH or null. A command with any other value is considered an incorrect use of the command. An IDNV (Input, Data Not Valid) error message should be responsed

2. This command is not used for the common control (TCC+ or XC/XCVT) cards. A command on a common control card will generate an IIAC (Input, Invalid Access Identifier) error message. To use the common control card switching commands, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

3. This command is not used for SONET (OCN) cards. A command on a SONET card will generate an IIAC (Input, Invalid Access Identifier) error message. To use a SONET card switching command, use the OPR-PROTNSW and RLS-PROTNSW commands.

4. If this command is used on a card that is not in a protection group, the SNVS (Status, Not in Valid State) error message should be responsed.

5. If this command is sent to a missing working card, the SWFA (Status, Working Unit Failed) error message should be responsed.

6. If this command is used on a protection card, the IIAC (Input, Invalid Access Identifier) error message should be responsed.

7. If sending a mode parameter with a value other than NORM, FRCD, or null, the IDNV (Input, Data Not Valid) error message should be responsed.

8. If sending the SW-TOWKG command to a working card when the working card has raised INHSWWKG, the SWLD (Status, Working Unit Locked) error message should be responsed.

9. If sending the SW-TOWKG command to a working card when the protection card has raised INHSWWKG, the SPLD (Status, Protection Unit Locked) error message should be responsed.

10. If sending the SW-TOWKG command to an active working card, the SNVS (Status, Not in Valid State) error message should be responsed.

Section
SW-TOWKG-EQPT Description 

Category

Equipment

Security

Maintenance

Related Messages

ALW-SWDX-EQPT INH-SWTOWKG-EQPT
ALW-SWTOPROTN-EQPT REPT ALM EQPT
ALW-SWTOWKG-EQPT REPT EVT EQPT
DLT-EQPT RTRV-ALM-EQPT
ED-EQPT RTRV-COND-EQPT
ENT-EQPT RTRV-EQPT
INH-SWDX-EQPT SW-DX-EQPT
INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT

Input Format

SW-TOWKG-EQPT:[<TID>]:<AID>:<CTAG>::[<MODE>],[<DIRN>];

where:

<AID> is the parameter that identifies the working unit that is to be released from protection. The AID should be the working unit AID for this command. <AID> is from the "PRSLOT" section

<MODE> is the parameter that will only support the NORM and FRCD values. The null value will default to NORM. Sending the FRCD value will generate the same switching behavior as sending the NORM value. Valid values for <MODE> are shown in the "CMD_MODE" section

<DIRN> is the direction of transmission in which switching is to be made. The command only supports one value of the <DIRN> parameter - BTH. This parameter defaults to BTH; valid values for <DIRN> are shown in the "DIRECTION" section

Input Example

SW-TOWKG-EQPT:CISCO:SLOT-2:123::FRCD,BTH;

Errors

This message generates all the default errors