Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, Release 4.0
Chapter 3, TL1 Command Descriptions
Downloads: This chapterpdf (PDF - 2.86MB) The complete bookPDF (PDF - 5.23MB) | Feedback

TL1 Command Descriptions

Table Of Contents

TL1 Command Descriptions

3.1 TL1 Commands by Category

3.2 TL1 Commands by Card (ONS 15454)

3.3 TL1 Commands by Card (ONS 15327)

3.4 TL1 Commands

3.4.1 ACT-USER: Activate User

3.4.2 ALW-MSG-ALL: Allow Message All

3.4.3 ALW-MSG-DBCHG: Allow Database Change Message

3.4.4 ALW-MSG-SECU: Allow Message Security

3.4.5 ALW-PMREPT-ALL: Allow Performance Report All

3.4.6 ALW-SWDX-EQPT: Allow Switch Duplex Equipment

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

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

3.4.9 APPLY: Apply

3.4.10 CANC: Cancel

3.4.11 CANC-USER: Cancel User

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

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

3.4.14 COPY-IOSCFG: Copy IOS Config File

3.4.15 COPY-RFILE: Copy RFILE

3.4.16 DISC-TACC: Disconnect Test Access

3.4.17 DLT-BLSR: Delete BLSR

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

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

3.4.20 DLT-EQPT: Delete Equipment

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

3.4.22 DLT-FFP-CLNT: Delete Facility Protection Group Client

3.4.23 DLT-UCP-CC: Delete Unified Control Plane Control Channel

3.4.24 DLT-UCP-IF: Delete Unified Control Plane Interface

3.4.25 DLT-UCP-NBR: Delete Unified Control Plane Neighbor

3.4.26 DLT-USER-SECU: Delete User Security

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

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

3.4.29 ED-BITS: Edit Building Integrated Timing Supply

3.4.30 ED-BLSR: Edit Bidirectional Line Switched Ring

3.4.31 ED-CLNT: Edit Client

3.4.32 ED-CRS-<STS_PATH>:ED CRS (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS 48C, STS192C)

3.4.33 ED-CRS-VT1: Edit Cross Connection VT1

3.4.34 ED-DAT: Edit Date and Time

3.4.35 ED-DS1: Edit DS1

3.4.36 ED-DWDM: Edit Dense Wavelength Division Multiplexing

3.4.37 ED-EC1: Edit Electrical Carrier

3.4.38 ED-EQPT: Edit Equipment

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

3.4.40 ED-FFP-CLNT: Edit Facility Protection Group Client

3.4.41 ED-G1000: Edit G1000

3.4.42 ED-NE-GEN: Edit Network Element General

3.4.43 ED-NE-SYNCN: Edit Network Element Synchronization

3.4.44 ED-OCH: Edit Optical Channel

3.4.45 ED-PID: Edit Password

3.4.46 ED-SYNCN: Edit Synchronization

3.4.47 ED-T1: Edit T1

3.4.48 ED-T3: Edit T3

3.4.49 ED-TRC-CLNT: Edit Trace Client

3.4.50 ED-TRC-OCH: Edit Trace Optical Channel Facilities

3.4.51 ED-UCP-CC: Edit Unified Control Plane Control Channel

3.4.52 ED-UCP-IF: Edit Unified Control Plane Interface

3.4.53 ED-UCP-NBR: Edit Unified Control Plane Neighbor

3.4.54 ED-UCP-NODE: Edit Unified Control Plane Node

3.4.55 ED-USER-SECU: Edit User Security

3.4.56 ED-VT1: Edit Virtual Tributary

3.4.57 ENT-BLSR: Enter BLSR

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

3.4.59 ENT-CRS-VT1: Enter STS Cross Connection VT1

3.4.60 ENT-EQPT: Enter Equipment

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

3.4.62 ENT-FFP-CLNT: Enter Facility Protection Group Client

3.4.63 ENT-UCP-CC: Enter Unified Control Plane Control Channel

3.4.64 ENT-UCP-IF: Enter Unified Control Plane Interface

3.4.65 ENT-UCP-NBR: Enter Unified Control Plane Neighbor

3.4.66 ENT-USER-SECU: Enter User Security

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

3.4.68 INH-MSG-ALL: Inhibit Message All

3.4.69 INH-MSG-DBCHG: Inhibit Database Change Message

3.4.70 INH-MSG-SECU: Inhibit Message Security

3.4.71 INH-PMREPT-ALL: Inhibit Performance Report All

3.4.72 INH-SWDX-EQPT: Inhibit Switch Duplex Equipment

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

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

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

3.4.76 INIT-SYS: Initialize System

3.4.77 OPR-ACO-ALL: Operate Alarm Cutoff All

3.4.78 OPR-EXT-CONT: Operate External Control

3.4.79 OPR-LPBK-<MOD2>: Operate Loopback (CLNT, DS1, EC1, OC12, OC192, OC3, OC48, OCH, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, VT1)

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

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

3.4.82 OPR-PROTNSW-CLNT: Operate Protection Switch Client

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

3.4.84 OPR-SYNCNSW: Operate Synchronization Switch

3.4.85 REPT ALM <MOD2ALM>: Report Alarm (CLNT, DS1, E100, E1000, EC1, FSTE, G1000, GIGE, OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VT1)

3.4.86 REPT ALM BITS: Report Alarm Building Integrated Timing Supply

3.4.87 REPT ALM COM: Report Alarm COM

3.4.88 REPT ALM ENV: Report Alarm Environment

3.4.89 REPT ALM EQPT: Report Alarm Equipment

3.4.90 REPT ALM RING: Report Alarm Ring

3.4.91 REPT ALM SYNCN: Report Alarm Synchronization

3.4.92 REPT ALM UCP: Report Alarm Unified Control Plane

3.4.93 REPT DBCHG: Report Database Change Message

3.4.94 REPT EVT <MOD2ALM>: Report Event (CLNT, DS1, E100, E1000, EC1, FSTE, G1000, GIGE, OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VT1)

3.4.95 REPT EVT BITS: Report Event BITS

3.4.96 REPT EVT COM: Report Event COM

3.4.97 REPT EVT ENV: Report Event Environment

3.4.98 REPT EVT EQPT: Report Event Equipment

3.4.99 REPT EVT FXFR: Report Event Software Download

3.4.100 REPT EVT IOSCFG: Report Event IOS Config File

3.4.101 REPT EVT RING: Report Event Ring

3.4.102 REPT EVT SECU: Report Event Security

3.4.103 REPT EVT SESSION: Report Event Session

3.4.104 REPT EVT SYNCN: Report Event Synchronization

3.4.105 REPT EVT UCP: Report Event Unified Control Plane

3.4.106 REPT PM <MOD2>: Report Performance Monitoring (CLNT, DS1, EC1, OC12, OC192, OC3, OC48, OCH, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, VT1)

3.4.107 REPT SW: Report Switch

3.4.108 RLS-EXT-CONT: Release External Control

3.4.109 RLS-LPBK-<MOD2>: Release Loopback (CLNT, DS1, EC1, OC12, OC192, OC3, OC48, OCH, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1,T3, VT1)

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

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

3.4.112 RLS-PROTNSW-CLNT: Release Protection Switch Client

3.4.113 RLS-PROTNSW-VT1: Release Protection Switch VT1

3.4.114 RLS-SYNCNSW: Release Synchronization Switch

3.4.115 RMV-<MOD2_IO>: Remove (CLNT, DS1, EC1, G1000, OC12, OC192, OC3, OC48, OCH, T1, T3)

3.4.116 RST-<MOD2_IO>: Restore (CLNT, DS1, EC1, G1000, OC12, OC192, OC3, OC48, OCH, T1, T3)

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

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

3.4.119 RTRV-ALM-<MOD2ALM>:Retrieve Alarm (CLNT, DS1, E100, E1000, EC1, FSTE, G1000, GIGE, OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VT1)

3.4.120 RTRV-ALM-ALL: Retrieve Alarm All

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

3.4.122 RTRV-ALM-ENV: Retrieve Alarm Environment

3.4.123 RTRV-ALM-EQPT: Retrieve Alarm Equipment

3.4.124 RTRV-ALM-RING: Retrieve Alarm Ring

3.4.125 RTRV-ALM-SYNCN: Retrieve Alarm Synchronization

3.4.126 RTRV-ALM-UCP: Retrieve Alarm Unified Control Plane

3.4.127 RTRV-ATTR-CONT: Retrieve Attribute Control

3.4.128 RTRV-ATTR-ENV: Retrieve Attribute Environment

3.4.129 RTRV-BITS: Retrieve Building Integrated Timing Supply

3.4.130 RTRV-BLSR: Retrieve Bidirectional Line Switched Ring

3.4.131 RTRV-CLNT: Retrieve Client

3.4.132 RTRV-COND-<MOD2ALM>: Retrieve Condition (CLNT, DS1, E100, E1000, EC1, FSTE, G1000, GIGE, OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VT1)

3.4.133 RTRV-COND-ALL: Retrieve Condition All

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

3.4.135 RTRV-COND-ENV: Retrieve Environmental Condition

3.4.136 RTRV-COND-EQPT: Retrieve Condition Equipment

3.4.137 RTRV-COND-RING: Retrieve Condition Ring

3.4.138 RTRV-COND-SYNCN: Retrieve Condition Synchronization

3.4.139 RTRV-COND-UCP: Retrieve Condition Unified Control Plane

3.4.140 RTRV-CRS: Retrieve Cross Connect

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

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

3.4.143 RTRV-DS1: Retrieve DS1

3.4.144 RTRV-DWDM: Retrieve Dense Wavelength Division Multiplexing

3.4.145 RTRV-EC1: Retrieve EC1

3.4.146 RTRV-EQPT: Retrieve Equipment

3.4.147 RTRV-EXT-CONT: Retrieve External Control

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

3.4.149 RTRV-FFP-CLNT: Retrieve Facility Protection Group Client

3.4.150 RTRV-FSTE: Retrieve Fast Ethernet

3.4.151 RTRV-G1000: Retrieve G1000 Facility

3.4.152 RTRV-GIGE: Retrieve Gigabit Ethernet

3.4.153 RTRV-HDR: Retrieve Header

3.4.154 RTRV-INV: Retrieve Inventory

3.4.155 RTRV-LOG: Retrieve Log

3.4.156 RTRV-MAP-NETWORK: Retrieve Map Network

3.4.157 RTRV-NE-GEN: Retrieve Network Element General

3.4.158 RTRV-NE-IPMAP: Retrieve Network Element IPMAP

3.4.159 RTRV-NE-SYNCN: Retrieve Network Element Synchronization

3.4.160 RTRV-OCH: Retrieve Optical Channel

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

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

3.4.163 RTRV-PMSCHED-<MOD2>:Retrieve Performance Monitoring Schedule (CLNT, DS1, EC1, OC3, OC12, OC48, OC192, OCH, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.164 RTRV-PMSCHED-ALL: Retrieve Performance Schedule All

3.4.165 RTRV-POS: Retrieve Packet Over SONET

3.4.166 RTRV-PROTNSW-<OCN_TYPE>: Retrieve Protection Switch (OC3, OC12, OC48, OC192)

3.4.167 RTRV-PROTNSW-<STS_PATH>: Retrieve Protection Switch (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C)

3.4.168 RTRV-PROTNSW-CLNT: Retrieve Protection Switch Client

3.4.169 RTRV-PROTNSW-VT1: Retrieve Protection Switch VT1

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

3.4.171 RTRV-SYNCN: Retrieve Synchronization

3.4.172 RTRV-T1: Retrieve T1 Facility

3.4.173 RTRV-T3: Retrieve T3

3.4.174 RTRV-TACC: Retrieve Test Access

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

3.4.176 RTRV-TOD: Retrieve Time of Day

3.4.177 RTRV-TRC-<OCN_BLSR>: Retrieve Trace Client (OC12, OC192, OC48)

3.4.178 RTRV-TRC-CLNT: Retrieve Trace Client

3.4.179 RTRV-TRC-OCH: Retrieve Trace Optical Channel

3.4.180 RTRV-UCP-CC: Retrieve Unified Control Plane Control Channel

3.4.181 RTRV-UCP-IF: Retrieve Unified Control Plane Interface

3.4.182 RTRV-UCP-NBR: Retrieve Unified Control Plane Neighbor

3.4.183 RTRV-UCP-NODE: Retrieve Unified Control Plane Node

3.4.184 RTRV-USER-SECU: Retrieve User Security

3.4.185 RTRV-VT1: Retrieve VT1

3.4.186 SCHED-PMREPT-<MOD2>: Schedule Performance Monitoring Report (CLNT, DS1, EC1, OC3, OC12, OC48, OC192, OCH, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

3.4.187 SET-ATTR-CONT: Set Attribute Control

3.4.188 SET-ATTR-ENV: Set Attribute Environment

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

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

3.4.191 SET-TOD: Set Time of Day

3.4.192 SW-DX-EQPT: Switch Duplex Equipment

3.4.193 SW-TOPROTN-EQPT: Switch to Protection Equipment

3.4.194 SW-TOWKG-EQPT: Switch to Working Equipment


TL1 Command Descriptions



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


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

TL1 commands by category

TL1 commands by card

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

DLT-BLSR
ED-BLSR
ENT-BLSR
EX-SW-<OCN_BLSR>
REPT EVT RING
RTRV-BLSR
RTRV-COND-RING
RTRV-TRC-<OCN_BLSR>

Cross Connections

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

DWDM (ONS 15454)

DLT-FFP-CLNT
ED-CLNT
ED-DWDM
ED-FFP-CLNT
ED-OCH
ED-TRC-CLNT
ED-TRC-OCH
ENT-FFP-CLNT
OPR-PROTNSW-CLNT
RLS-PROTNSW-CLNT
RTRV-CLNT
RTRV-DWDM
RTRV-FFP-CLNT
RTRV-OCH
RTRV-PROTNSW-CLNT
RTRV-TRC-CLNT
RTRV-TRC-OCH

Environment Alarms and Controls

OPR-ACO-ALL
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 ALM RING
REPT EVT <MOD2ALM>
REPT EVT COM
RTRV-ALM-<MOD2ALM>
RTRV-ALM-ALL
RTRV-ALM-RING
RTRV-COND-<MOD2ALM>
RTRV-COND-ALL

IOS

COPY-IOSCFG
REPT EVT IOSCFG

Log

ALW-MSG-DBCHG
INH-MSG-DBCHG
REPT DBCHG
RTRV-LOG

Network

RTRV-NE-IPMAP
RTRV-MAP-NETWORK

Performance

ALW-PMREPT-ALL
INH-PMREPT-ALL
INIT-REG-<MOD2>
REPT PM <MOD2>
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PMSCHED-<MOD2>
RTRV-PMSCHED-ALL
RTRV-TH-<MOD2>
SCHED-PMREPT-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

Ports

ED-<OCN_TYPE>
ED-DS1
ED-EC1
ED-G1000
ED-T1
ED-T3
INIT-REG-G1000
RMV-<MOD2_IO>
RST-<MOD2_IO>
RTRV-<OCN_TYPE>
RTRV-DS1
RTRV-EC1
RTRV-FSTE
RTRV-G1000
RTRV-GIGE
RTRV-POS
RTRV-T1
RTRV-T3

Security

ACT-USER
ALW-MSG-SECU
CANC
CANC-USER
DLT-USER-SECU
ED-PID
ED-USER-SECU
ENT-USER-SECU
INH-MSG-SECU
REPT EVT SECU
REPT EVT SESSION
RTRV-USER-SECU

SONET Line Protection

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

Software Download

APPLY
COPY-RFILE
REPT EVT FXFR

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-TOD
SET-TOD

Test Access

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

Testing

OPR-LPBK-<MOD2>
RLS-LPBK-<MOD2>

UCP

DLT-UCP-CC
DLT-UCP-IF
DLT-UCP-NBR
ED-UCP-CC
ED-UCP-IF
ED-UCP-NBR
ED-UCP-NODE
ENT-UCP-CC
ENT-UCP-IF
ENT-UCP-NBR
REPT ALM UCP
REPT EVT UCP
RTRV-ALM-UCP
RTRV-COND-UCP
RTRV-UCP-CC
RTRV-UCP-IF
RTRV-UCP-NBR
RTRV-UCP-NODE

UPSR Switching

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


3.2 TL1 Commands by Card (ONS 15454)

Table 3-2 TL1 Commands by Card (ONS 15454) 

 
G1000-4
ML1000-2
ML100T-12
EC1
DS1
DS1N
DS3
DS3N
DS3E
DS3NE
DS3XM
OC3
OC3-8
OC12
OC12-4
OC48
OC48AS
OC192
E100T
E1000T
TCC
XC
TCC2
XCVT
XC192
XCVXL
AICI
AIC
MXP
TXP

ACT-USER

                                                           

ALW-MSG-ALL

                                                           

ALW-MSG-DBCHG

                                                           

ALW-PMREPT-ALL

                                                           

ALW-SWDX-EQPT

                                         

X

 

X

X

         

ALW-SWTOPROTN-EQPT

     

X

X

X

X

X

X

X

X

                                     

ALW-SWTOWKG-EQPT

     

X

X

X

X

X

X

X

X

                                     

APPLY

                                         

X

 

X

           

CANC

                                                           

CANC-USER

                                                           

CHG-ACCMD-<CHG_ACCMD>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

CONN-TACC-<MOD_TACC>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

COPY-IOSCFG

 

X

X

                                                     

COPY-RFILE

                                       

X

 

X

             

DISC-TACC

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

DLT-BLSR

                         

X

X

X

X

X

                       

DLT-CRS-VT1

X

   

X

X

X

       

X

X

X

X

X

X

X

X

                       

DLT-CRS-<STS_PATH>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

DLT-EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

DLT-FFP-<OCN_TYPE>

                     

X

X

X

X

X

X

X

                       

DLT-FFP-CLNT

                                                       

X

X

DLT-UCP-CC

                     

X

X

X

X

X

X

X

                       

DLT-UCP-IF

                                                           

DLT-UCP-NBR

                                                           

DLT-USER-SECU

                                                           

ED-BITS

                                       

X

                 

ED-BLSR

                     

X

X

X

X

X

X

X

                       

ED-CRS-<STS_PATH>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

ED-CRS-VT1

                   

X

X

X

X

X

X

X

X

                       

ED-CLNT

                                                       

X

X

ED-DAT

                                                           

ED-DS1

                   

X

                                     

ED-DWDM

                                                       

X

X

ED-EC1

     

X

                                                   

ED-EQPT

     

X

X

X

X

X

X

X

X

                                     

ED-FFP-<OCN_TYPE>

                     

X

X

X

X

X

X

X

                       

ED-FFP-CLNT

                                                       

X

X

ED-G1000

X

                                                         

ED-NE-GEN

                                       

X

                 

ED-NE-SYNCN

                                       

X

                 

ED-OCH

                                                       

X

X

ED-PID

                                                           

ED-SYNCN

                                       

X

             

X

 

ED-T1

       

X

X

                                               

ED-T3

           

X

X

X

X

X

                                     

ED-TRC-CLNT

                                                       

X

X

ED-TRC-OCH

                                                       

X

X

ED-UCP-CC

                     

X

X

X

X

X

X

X

                       

ED-UCP-IF

                     

X

X

X

X

X

X

X

                       

ED-UCP-NBR

                                                           

ED-UCP-NODE

                                                           

ED-USER-SECU

                                                           

ED-VT1

     

X

X

X

       

X

X

X

X

X

X

X

X

                       

ED-<OCN_TYPE>

                     

X

X

X

X

X

X

X

                       

ED-<STS_PATH>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

ENT-BLSR

                         

X

X

X

X

X

                       

ENT-CRS-VT1

                   

X

X

X

X

X

X

X

X

                       

ENT-CRS-<STS_PATH>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

ENT-EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

ENT-FFP-<OCN_TYPE>

                     

X

X

X

X

X

X

X

                       

ENT-FFP-CLNT

                                                       

X

X

ENT-UCP-CC

                     

X

X

X

X

X

X

X

                       

ENT-UCP IF

                     

X

X

X

X

X

X

X

                       

ENT-UCP-NBR

                                                           

ENT-USER-SECU

                                                           

EX-SW-<OCN_BLSR>

                       

X

X

X

X

X

X

                       

INH-MSG-ALL

                                                           

INH-MSG-DBCHG

                                                           

INH-MSG-SECU

                                       

X

 

X

             

ING-PMREPT-ALL

                                                           

INH-SWDX-EQPT

                                         

X

 

X

X

         

INH-SWTOPROTN-EQPT

     

X

X

X

X

X

X

X

X

                                     

INH-SWTOWKG-EQPT

     

X

X

X

X

X

X

X

X

                                     

INIT-REG-<MOD2>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

INIT-REG-G1000

X

                                                         

INIT-REG-CLNT

                                                       

X

X

INIT-SYS

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

OPR-ACO-ALL

                                                   

X

X

   

OPR-EXT-CONT

                                                   

X

X

   

OPR-LPBK-<MOD2>

X

   

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

OPR-PROTNSW-VT1

                     

X

X

X

X

X

X

X

                       

OPR-PROTNSW-<OCN_TYPE>

                     

X

X

X

X

X

X

X

                       

OPR-PROTNSW-<STS_PATH>

                     

X

X

X

X

X

X

X

                       

OPR-PROTNSW-CLNT

                                                       

X

X

OPR-SYNCNSW

                     

X

X

X

X

X

X

X

   

X

                 

REPT ALM BITS

                                       

X

                 

REPT ALM COM

                                                           

REPT ALM ENV

                                                   

X

X

   

REPT ALM EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

REPT ALM RING

                         

X

X

X

X

X

                       

REPT ALM SYNCN

                     

X

X

X

X

X

X

X

   

X

                 

REPT ALM <MOD2ALM>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

REPT ALM UCP

                                                           

REPT DBCHG

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

REPT EVT BITS

                                       

X

                 

REPT EVT COM

                                                           

REPT EVT ENV

                                                   

X

X

   

REPT EVT FXFR

                                       

X

 

X

             

REPT EVT EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

REPT EVT IOSCFG

 

X

X

                                                     

REPT EVT RING

                         

X

X

X

X

X

                       

REPT EVT SECU

                                                           

REPT EVT SESSION

                                       

X

 

X

             

REPT EVT SYNCN

                     

X

X

X

X

X

X

X

   

X

                 

REPT EVT <MOD2ALM>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

REPT EVT UCP

                                                           

REPT PM <MOD2>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

REPT SW

                                         

X

 

X

X

         

RLS-EXT-CONT

                                                   

X

X

   

RLS-LPBK-<MOD2>

X

   

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

RLS-PROTNSW-CLNT

                                                       

X

X

RLS-PROTNSW-VT1

                     

X

X

X

X

X

X

X

                       

RLS-PROTNSW-<OCN_TYPE>

                     

X

X

X

X

X

X

X

                       

RLS-PROTNSW-<STS_PATH>

                     

X

X

X

X

X

X

X

                       

RLS-SYNCNSW

                     

X

X

X

X

X

X

X

     

X

               

RMV-<MOD2_IO>

X

   

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

RST-<MOD2_IO>

X

   

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

RTRV-ALM-ALL

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-ALM-BITS

                                       

X

                 

RTRV-ALM-ENV

                                                   

X

X

   

RTRV-ALM-EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-ALM-RING

                         

X

X

X

X

X

                       

RTRV-ALM-SYNCN

                     

X

X

X

X

X

X

X

   

X

                 

RTRV-ALM-<MOD2ALM>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-ALM-UCP

                                                           

RTRV-ATTR-CONT

                                                   

X

X

   

RTRV-ATTR-ENV

                                                   

X

X

   

RTRV-BITS

                                       

X

                 

RTRV-BLSR

                         

X

X

X

X

X

                       

RTRV-CKT-ORIG

                                                           

RTRV-CKT-TERM

                                                           

RTRV-CLNT

                                                       

X

X

RTRV-COND-ALL

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-COND-BITS

                                       

X

                 

RTRV-COND-ENV

                                                   

X

X

   

RTRV-COND-EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-COND-SYNCN

                                       

X

                 

RTRV-COND-<MOD2ALM>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-COND-RING

                         

X

X

X

X

X

                       

RTRV-COND-UCP

                                                           

RTRV-CRS

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

RTRV-CRS-VT1

     

X

X

X

       

X

X

X

X

X

X

X

X

                       

RTRV-CRS-<STS_PATH>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

RTRV-DWMD

                                                       

X

X

RTRV-EC1

     

X

                                                   

RTRV-DS1

                   

X

                                     

RTRV-EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-EXT-CONT

                                                   

X

X

   

RTRV-FFP-CLNT

                                                           

RTRV-FFP-<OCN_TYPE>

                     

X

X

X

X

X

X

X

                       

RTRV-FSTE

 

X

X

                                                     

RTRV-G1000

X

                                                         

RTRV-GIGE

 

X

X

                                                     

RTRV-HDR

                                                           

RTRV-INV

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-LOG

                                                           

RTRV-MAP-NETWORK

                                                           

RTRV-NE-GEN

                                       

X

                 

RTRV-NE-IPMAP

                     

X

X

X

X

X

X

X

                       

RTRV-NE-SYNCN

                                       

X

                 

RTRV-OCH

                                                       

X

X

RTRV-PM-<MOD2>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

RTRV-PMMODE-<STS_PATH>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

RTRV-PMSCHED-<MOD2>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

RTRV-PMSCHED-ALL

                                                       

X

X

RTRV-POS

 

X

X

                                                     

RTRV-PROTNSW-<OCN_TYPE>

                     

X

X

X

X

X

X

X

                       

RTRV-PROTNSW-<STS_PATH>

X

X

X

               

X

X

X

X

X

X

X

                       

RTRV-PROTNSW-CLNT

                                                       

X

X

RTRV-PROTNSW-VT1

                     

X

X

X

X

X

X

X

                       

RTRV-PTHTRC-<STS_PATH>

X

X

X

X

X

X

X

X

X

X

X

X

X

     

X

X

                       

RTRV-SYNCN

                                       

X

             

X

 

RTRV-TACC

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

RTRV-T1

       

X

X

                                               

RTRV-T3

           

X

X

X

X

                                       

RTRV-TH-<MOD2>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

RTRV-TOD

                                                           

RTRV-TRC-<OCN_BLSR>

                         

X

X

X

X

X

                       

RTRV-TRC-CLNT

                                                       

X

X

RTRV-TRC-OCH

                                                       

X

X

RTRV-VT1

     

X

X

X

       

X

X

X

X

 

X

X

X

                       

RTRV-<OCN_TYPE>

                   

X

X

X

X

X

X

X

X

                       

RTRV-<STS_PATH>

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

RTRV-UCP-CC

                   

X

X

X

X

X

X

X

X

                       

RTRV-UCP-IF

                   

X

X

X

X

X

X

X

X

                       

RTRV-UCP-NBR

                                                           

RTRV-UCP-NODE

                                                           

RTRV-USER-SECU

                                                           

SCHED-PMREPT-<MOD2>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

SET-ATTR-CONT

                                                   

X

X

   

SET-ATTR-ENV

                                                   

X

X

   

SET-PMMODE-<STS_PATH>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                       

SET-TH-<MOD2>

     

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

                   

X

X

SET-TOD

                                                           

SW-DX-EQPT

                                         

X

 

X

X

         

SW-TOPROTN-EQPT

     

X

X

X

X

X

X

X

X

                                     

SW-TOWKG-EQPT

     

X

X

X

X

X

X

X

X

                                     

3.3 TL1 Commands by Card (ONS 15327)

Table 3-3 TL1 Commands by Card (ONS 15327) 

 
XTC/DS1
XTC/DS3
OC3
OC12
OC48
E100T
E1000T
XTC
G1000-2
XTC/XCVT
XTC/AIC

ACT-USER

                     

ALW-MSG-ALL

                     

ALW-MSG-DBCHG

                     

ALW-PMREPT-ALL

                     

ALW-SWDX-EQPT

                     

ALW-SWTOPROTN-EQPT

                     

ALW-SWTOWKG-EQPT

                     

APPLY

             

X

     

CANC

                     

CANC-USER

                     

CHG-ACCMD-<CHG_ACCMD>

X

X

X

X

X

           

CONN-TACC-<MOD_TACC>

X

X

X

X

X

           

COPY-IOSCFG

                     

COPY-RFILE

             

X

     

DISC-TACC

X

X

X

X

X

           

DLT-BLSR

     

X

X

           

DLT-CRS-VT1

   

X

X

X

           

DLT-CRS-<STS_PATH>

X

X

X

X

X

           

DLT-EQPT

   

X

X

X

X

X

X

X

   

DLT-FFP-<OCN_TYPE>

   

X

X

X

           

DLT-USER-SECU

                     

ED-BITS

             

X

     

ED-BLSR

     

X

X

           

ED-CRS-<STS_PATH>

X

X

X

X

X

     

X

   

ED-CRS-VT1

   

X

X

X

           

ED-DAT

                     

ED-DS1

                     

ED-EC1

                     

ED-EQPT

X

X

                 

ED-FFP-<OCN_TYPE>

   

X

X

X

           

ED-G1000

               

X

   

ED-NE-GEN

             

X

     

ED-NE-SYNCN

             

X

     

ED-PID

                     

ED-SYNCN

             

X

     

ED-T1

X

                   

ED-T3

 

X

                 

ED-USER-SECU

                     

ED-VT1

X

 

X

X

X

           

ED-<OCN_TYPE>

   

X

X

X

           

ED-<STS_PATH>

X

X

X

X

X

     

X

   

ENT-BLSR

     

X

X

           

ENT-CRS-VT1

   

X

X

X

           

ENT-CRS-<STS_PATH>

X

X

X

X

X

     

X

   

ENT-EQPT

X

X

X

X

X

X

X

X

X

X

X

ENT-FFP-<OCN_TYPE>

   

X

X

X

           

ENT-USER-SECU

                     

EX-SW-<OCN_BLSR>

     

X

X

           

INH-MSG-ALL

                     

INH-MSG-DBCHG

                     

INH-MSG-SECU

             

X

     

INH-PMREPT-ALL

                     

INH-SWDX-EQPT

                 

X

 

INH-SWTOPROTN-EQPT

X

X

                 

INH-SWTOWKG-EQPT

X

X

                 

INIT-REG-<MOD2>

X

X

X

X

X

           

INIT-REG-G1000

               

X

   

INIT-SYS

X

X

X

X

X

X

X

X

X

X

X

OPR-ACO-ALL

             

X

     

OPR-EXT-CONT

                   

X

OPR-LPBK-<MOD2>

X

X

X

X

X

     

X

   

OPR-PROTNSW-VT1

   

X

X

X

           

OPR-PROTNSW-<OCN_TYPE>

   

X

X

X

           

OPR-PROTNSW-<STS_PATH>

   

X

X

X

           

OPR-SYNCNSW

   

X

X

X

   

X

     

REPT ALM BITS

             

X

     

REPT ALM COM

                     

REPT ALM ENV

                   

X

REPT ALM EQPT

X

X

X

X

X

X

X

X

X

X

X

REPT ALM RING

     

X

X

           

REPT ALM SYNCN

   

X

X

X

   

X

     

REP ALM <MOD2ALM>

X

X

X

X

X

X

X

X

X

X

X

REPT DBCHG

               

X

   

REPT EVT BITS

             

X

     

REPT EVT COM

                     

REPT EVT ENV

                   

X

REPT EVT EQPT

X

X

X

X

X

X

X

X

X

X

X

REPT EVT FXFR

             

X

     

REPT EVT RING

     

X

X

           

REPT EVT SECU

                     

REPT EVT SESSION

             

X

     

REPT EVT SYNCN

   

X

X

X

   

X

     

REPT EVT <MOD2ALM>

X

X

X

X

X

X

X

X

X

X

X

REPT PM <MOD2>

X

X

X

X

X

X

         

REPT SW

                 

X

 

RLS-EXT-CONT

                   

X

RLS-LPBK-<MOD2>

X

X

X

X

X

     

X

   

RLS-PROTNSW-VT1

   

X

X

X

           

RLS-PROTNSW-<OCN_TYPE>

   

X

X

X

           

RLS-PROTNSW-<STS_PATH>

   

X

X

X

           

RLS-SYNCNSW

   

X

X

X

   

X

     

RMV-<MOD2_IO>

X

X

X

X

X

     

X

   

RST-<MOD2_IO>

X

X

X

X

X

     

X

   

RTRV-ALM-ALL

X

X

X

X

X

X

X

X

X

X

X

RTRV-ALM-BITS

             

X

     

RTRV-ALM-ENV

                   

X

RTRV-ALM-EQPT

X

X

X

X

X

X

X

X

X

X

X

RTRV-ALM-RING

                     

RTRV-ALM-SYNCN

   

X

X

X

   

X

     

RTRV-ALM-<MOD2ALM>

X

X

X

X

X

X

X

X

X

X

X

RTRV-ATTR-CONT

                   

X

RTRV-ATTR-ENV

                   

X

RTRV-BITS

             

X

     

RTRV-BLSR

     

X

X

           

RTRV-COND-ALL

X

X

X

X

X

X

X

X

X

X

X

RTRV-COND-BITS

             

X

     

RTRV-COND-ENV

                   

X

RTRV-COND-EQPT

X

X

X

X

X

X

X

X

X

X

X

RTRV-COND-RING

                     

RTRV-COND-SYNCN

             

X

     

RTRV-COND-<MOD2ALM>

X

X

X

X

X

X

X

X

X

X

X

RTRV-CRS

X

X

X

X

X

     

X

   

RTRV-CRS-VT1

X

 

X

X

X

           

RTRV-CRS-<STS_PATH>

X

X

X

X

X

     

X

   

RTRV-EC1

                     

RTRV-DS1

                     

RTRV-EQPT

X

X

X

X

X

X

X

X

X

X

X

RTRV-EXT-CONT

                   

X

RTRV-FFP-<OCN_TYPE>

   

X

X

X

           

RTRV-G1000

               

X

   

RTRV-HDR

                     

RTRV-INV

X

X

X

X

X

X

X

X

X

X

X

RTRV-LOG

                     

RTRV-MAP-NETWORK

                     

RTRV-NE-GEN

             

X

     

RTRV-NE-IPMAP

   

X

X

X

           

RTRV-NE-SYNCN

             

X

     

RTRV-PM-<MOD2>

X

X

X

X

X

           

RTRV-PMMODE-<STS_PATH>

 

X

X

X

X

           

RTRV-PMSCHED-ALL

X

X

X

X

X

           

RTRV-PMSCHED-<MOD2>

X

X

X

X

X

           

RTRV-PROTNSW-VT1

   

X

X

X

           

RTRV-PROTNSW-<OCN_TYPE>

   

X

X

X

           

RTRV-PROTNSW-<STS_PATH>

   

X

X

X

           

RTRV-PTHTRC-<STS_PATH>

X

X

X

         

X

   

RTRV-SYNCN

             

X

     

RTRV-T1

X

                   

RTRV-T3

 

X

                 

RTRV-TACC

X

X

X

X

X

           

RTRV-TH-<MOD2>

X

X

X

X

X

           

RTRV-TOD

                     

RTRV-TRC-<OCN_BLSR>

     

X

X

           

RTRV-USER-SECU

                     

RTRV-VT1

X

 

X

X

X

           

RTRV-<OCN_TYPE>

   

X

X

X

           

RTRV-<STS_PATH>

X

X

X

X

X

     

X

   

SCHED-PMREPT-<MOD2>

                     

SET-ATTR-CONT

                   

X

SET-ATTR-ENV

                   

X

SET-PMMODE-<STS_PATH>

X

X

X

X

X

           

SET-TH-<MOD2>

X

X

X

X

X

           

SET-TOD

                     

SW-DX-EQPT

                 

X

 

SW-TOPROTN-EQPT

X

X

                 

SW-TOWKG-EQPT

X

X

                 

3.4 TL1 Commands

The commands and autonomous messages used for ONS 15454 and ONS 15327 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, path protection configuration 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 CTAG of any TL1 line mode command is a mandatory field in this TL1 release.



Note The AID definitions provided are supersets of the actual AID definitions.



Note TL1 commands that are entered incorrectly are not completed.



Note Starting with release 3.3 (R3.3), all TL1 commands will return the DENY error code without any additional error messages prior to a successful TL1 login (i.e., prior to a successful ACT-USER command). Releases earlier than R3.3 either return different error codes; for example, PLNA and IICT and also additional error messages; for example, Login Not Active.


3.4.1 ACT-USER: Activate User

This command set-ups a session with the Network Element (NE).

Notes:

1. Passwords are masked for the following security commands: ACT-USER, ED-PID, ENT-USER-SECU and ED-USER-SECU. Access to a TL1 session via any means will have the password masked. The CTC Request History and Message Log will also show the masked commands. When a password-masked command is re-issued by double-clicking the command from CTC Request History, the password will still be masked in the CTC Request History and Message Log. The actual password that was previously issued will be sent to the NE. To use a former command as a template only, single-click the command in CTC Request History. The command will be placed in the Command Request text box, where you can edit the appropriate fields prior to re-issuing it.

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.

3. This command is backwards compatible with userids and passwords from ONS 15454 2.X software versions according to the following rules:

ACT-USER:[TID]:[STRING]:CTAG::[STRING]

a. The syntax of the userid (first [STRING]) and the password (second [STRING]) are not checked.

b. Invalid syntax for both the userid and password is permitted, but the user can only log in if the userid/password match what is in the database.

c. The userid and password cannot exceed 10 characters.

4. For the ACT-USER command, it is required that no error code be transmitted except to convey that the login is granted or denied. Per TR-835, Appendix A, Section A.2:

"... the error codes corresponding to ACT ... do not apply to the ACT-USER command because this command requires that no error code be provided to the session request except to indicate that it has been denied. Before a session is established, a specific error code may reveal clues to an intruder attempting unauthorized entry."

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
RTRV-USER-SECU

Input Format

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

where:

<UID> is the user identifier; <UID> is any combination of up to 10 alphanumeric characters. <UID> is a string and must not be null

<PID> is the user password; <PID> is any combination of up to 10 alphanumeric characters. <PID> is a string and 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 <PID>

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.2 ALW-MSG-ALL: Allow Message 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

APPLY RTRV-HDR
COPY-RFILE RTRV-INV
ED-DAT RTRV-MAP-NETWORK
ED-NE-GEN RTRV-NE-GEN
ED-NE-SYNCN RTRV-NE-IPMAP
INH-MSG-ALL RTRV-NE-SYNCN
INIT-SYS RTRV-TOD
REPT EVT FXFR SET-TOD

Input Format

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

Input Example

ALW-MSG-ALL:PETALUMA::549;

Errors

Errors are listed in Table 7-30.


3.4.3 ALW-MSG-DBCHG: Allow Database Change Message

This command enables REPT DBCHG. When a TL1 session starts, the REPT DBCHG messages are not allowed by default.


Note This command is not defined in the GR.


Section
ALW-MSG-DBCHG Description 

Category

Log

Security

Retrieve

Related Messages

INH-MSG-DBCHG
REPT DBCHG
RTRV-LOG

Input Format

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

Input Example

ALW-MSG-DBCHG:CISCO::123;

Errors

Errors are listed in Table 7-30.


3.4.4 ALW-MSG-SECU: Allow Message Security

This command enables REPT EVT SECU and REPT ALM SECU

Section
ALW-MSG-SECU Description 

Category

Security

Security

Superuser

Related Messages

ACT-USER ENT-USER-SECU
CANC INH-MSG-SECU
CANC-USER REPT EVT SECU
DLT-USER-SECU REPT EVT SESSION
ED-PID RTRV-USER-SECU
ED-USER-SECU

Input Format

ALW-MSG-SECU:[<TID>]::<CTAG>;

Input Example

ALW-MSG-SECU:PETALUMA::123;

Errors

Errors are listed in Table 7-30.


3.4.5 ALW-PMREPT-ALL: Allow Performance Report All

This command resumes processing all the PM reports that are inhibited. The allowance of the PM reporting is session-based, which means the command is only effective to the TL1 session that issues this command. REPT PM messages are inhibited by default for a session.

Section
ALW-PMREPT-ALL Description 

Category

Performance

Security

Retrieve

Related Messages

INH-PMREPT-ALL RTRV-PMSCHED-ALL
INIT-REG-<MOD2> RTRV-TH-<MOD2>
REPT PM <MOD2> SCHED-PMREPT-<MOD2>
RTRV-PM-<MOD2> SET-PMMODE-<STS_PATH>
RTRV-PMMODE-<STS_PATH> SET-TH-<MOD2>
RTRV-PMSCHED-<MOD2>

Input Format

ALW-PMREPT-ALL:[<TID>]::<CTAG>;

Input Example

ALW-PMREPT-ALL:CISCONODE::123;

Errors

Errors are listed in Table 7-30.


3.4.6 ALW-SWDX-EQPT: Allow Switch Duplex Equipment

(Cisco ONS 15454 only)

This command allows 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 the SW-TOWKG-EQPT and SW-TOPROTN-EQPT commands.


Note This command applies to the XC, XCVT, or XC10G equipment units only in this release.


Section
ALW-SWDX-EQPT Description 

Category

Equipment

Security

Maintenance

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/XC10G equipment AID from the "EQPT" section

Input Example

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

Errors

Errors are listed in Table 7-30.


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

(Cisco ONS 15454 only)

This command allows 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+/TCC2 or XC/XCVT/XC10G) 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

Maintenance

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> This 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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

(Cisco ONS 15454 only)

This command allows 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. 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.

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+/TCC2 or XC/XCVT/XC10G) 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 as long as none of the previous error conditions apply.

Section
ALW-SWTOWKG-EQPT Description 

Category

Equipment

Security

Maintenance

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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.9 APPLY: Apply

This command activates or reverts a software load during a software upgrade or downgrade process.

Section
APPLY Description 

Category

Software Download

Security

Maintenance

Related Messages

ALW-MSG-ALL RTRV-HDR
COPY-RFILE RTRV-INV
ED-DAT RTRV-MAP-NETWORK
ED-NE-GEN RTRV-NE-GEN
ED-NE-SYNCN RTRV-NE-IPMAP
INH-MSG-ALL RTRV-NE-SYNCN
INIT-SYS RTRV-TOD
REPT EVT FXFR SET-TOD

Input Format

APPLY:[<TID>]::<CTAG>[::<MEM_SW_TYPE>];

where:

<MEM_SW_TYPE> indicates memory switch action during the software upgrade; valid values for <MEM_SW_TYPE> are shown in the "DL_TYPE" section

Input Example

APPLY:CISCO::123::ACT;

Errors

Errors are listed in Table 7-30.


3.4.10 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. There is a default timeout period based on the user's privilege/security level, and starting with Release 4.0 timeouts can be provisioned. The default timeouts based on privilege/security level are: 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, the Retrieve user [RTRV] has no timeout.

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
RTRV-USER-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 any combination of up to 10 alphanumeric characters. <UID> is a string

Output Example

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


3.4.11 CANC-USER: Cancel User

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


Note The USERID field of this command is a mandatory field.


For the CANC-USER command: CANC-USER:[TID]:[STRING]:CTAG

the syntax of the userid (fist [STRING]) is not checked. Invalid syntax for the userid is permitted and the userid must not exceed 10 characters.

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
RTRV-USER-SECU

Input Format

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

where:

<USERID> identifies the user to the system; <USERID> is any combination of up to 10 alphanumeric characters. <USERID> is a string

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 <PID>

Input Example

CANC-USER:PETALUMA:TERRI:101;

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

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-17.

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

For this command to be applicable, you must first create the TAP using the ED-<STS_PATH> or ED-VT1 commands

Notes:

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

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

3. If a requested access configuration is invalid, a SRAC error message is 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
RTRV-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 point is released. The <TAP> number must be an integer with a range of 1 to 999. <TAP> is a string

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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

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

The connection will exist only for the duration of the TL1 session, after which the TAP will be disconnected from the circuit before the session cancels out. For this command to be applicable, you must first create the TAP using the ED-<STS_PATH> or ED-VT1 commands.

Notes:

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

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

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

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

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

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

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

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

Section
CONN-TACC-<MOD_TACC> Description 

Category

Test Access

Security

Provisioning

Related Messages

CHG-ACCMD-<CHG-ACCMD>
DISC-TACC
RTRV-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. Only a single AID is supported in this command. <AID> is the AID from the "ALL" section. <AID> must not be null

<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 point is released. The <TAP> number must be an integer with a range of 1 to 999. A null <TAP> defaults to an appropriate <TAP> number selected by the NE. <TAP> is an integer and a null value is equivalent to ALL

<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. <MD> must not be null

Input Example

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

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 point is released. The <TAP> number must be an integer with a range of 1 - 999. A null <TAP> defaults to an appropriate <TAP> number selected by the NE. <TAP> is an integer

Output Example

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

Errors

Errors are listed in Table 7-30.


3.4.14 COPY-IOSCFG: Copy IOS Config File

(Cisco ONS 15454 only)

This command supports the following types of operations on the IOS configuration file of ML-series Ethernet cards:

1. Uploading of startup IOS configuration file from the network to the node.

FTP is the only protocol allowed for uploading. When doing this operation, the SRC field must be a FTP URL string specifying the user name and password for FTP authentication, and specifying the host and the directory to locate the startup config file from the network. The DEST field must be a string of "STARTUP".

2. Downloading of startup IOS configuration file from the node to the network.

FTP is the only protocol allowed for downloading. When doing this operation, the SRC field must be a string of "STARTUP". The DEST field must be a FTP URL string specifying the user name and password for FTP authentication, and specifying the host and the directory to store the startup config file.

Notes:

1. The IOS configuration file is unique for each ML-series card, and is specified by the SLOT number in the AID field of the command.

2. In the GNE/ENE environment, if the GNE firewall exists, the download (backup) of IOS configuration file via TL1 is not allowed. Any such attempt will receive a "Data Connection Error" from the GNE. For the upload of IOS configuration file via TL1, GNE will allow it to go through the firewall only if the file contains the header "! Cisco IOS config <text>". If the configuration file does not contain this header, GNE will block the uploading with "Data Connection Error".

3. The format of the FTP URL string used in the SRC or DEST field of the command is as follows:

In a non-firewall environment, the format of the URL should be
"FTP://[FTPUSER[:FTPPASSWORD]]@FTP_HOST_IP/PACKAGE_PATH" where:
<FTPUSER> is the userid to connect to the computer with the package file
<FTPPASSWORD> is the password used to connect to the computer with the package file
<FTP_HOST_IP> is the IP address of the computer with the package file, DNS lookup of hostnames is not supported
<PACKAGE_PATH> is the long path name to the package file


Note Note that USERID and PASSWORD are optional if the user does not need to log into the host computer. Also note that the password may be optional if the user does not need to log in. All the other portions of the URL are required, including the initial "FTP:\\" string.


In a firewall environment, the hostname should be replaced with a list of IP addresses each separated by a @ character. The first IP address should be for the machine where the package file is stored. Subsequent IP addresses should then be for firewall machines moving outwards towards the edge of the network, until the final IP address listed was the machine that outside users first access the network.

For example: if your topology is "FTP_HOST_IP <-> GNE3 <->GNE2 <-> GNE1 <-> ENE", your FTP URL will be: FTP://FTPUSER:FTPPASSWORD@FTP_HOST_IP@GNE3@GNE2@GNE1/PACKAGE_PATH

Section
COPY-IOSCFG Description 

Category

IOS

Security

Provisioning

Related Messages

REPT EVT IOSCFG

Input Format

COPY-IOSCFG:[<TID>]:<AID>:<CTAG>::SRC=<SRC>,DEST=<DEST>;

where:

<AID> specifies the slot number of the card where the IOS configuration file belongs and is from the AID "EQPT" section

<SRC> specifies where the IOS config file is copied from and is a string

<DEST> specifies where the IOS config file is copied to and is a string

Input Example

COPY-IOSCFG::SLOT-1:CTAG::SRC="LONG_FTP_PATH",DEST="STARTUP";

Errors

Errors are listed in Table 7-30.


3.4.15 COPY-RFILE: Copy RFILE

This command downloads a new software package from the location specified by the FTP URL. It is also used to backup and restore the system database.

Notes:

1. Userid is the userid to connect to the computer with the package file or system database.

2. Password is the password used to connect to the computer with the package file or system database.

3. Hostname is the hostname or IP address of the computer with the package file or system database.

4. Package_path is the long path name to the package file or system database.

5. Both the userid and password are optional if the user does not need to log into the host computer.

6. The password may be optional if the user does not need to log in.

7. All the other portions of the URL are required, including the initial "FTP://" string.

Example:

COPY-RFILE:TID:RFILE-PKG:703::TYPE=SWDL,SRC="FTP://USERID:
PASSWORD@HOSTIP:21/DIR1/DIR2/DIR3/PACKAGE.PKG";

Notes:

1. The SWDL type is used for software package uploads. The RFBU type is used for system database backups, and the RFR type is used for system database restores. The SRC input is required when the type is SWDL or RFR. The DEST input is needed when the type is RFBU. The SRC and DEST inputs cannot both be used in the same command.

2. FTP is the only allowed file transfer method.

3. The extended FTP URL syntax is required by the COPY-RFILE syntax.

4. Port number (21) is optional. 21 is the only supported Port Number. Leaving this field blank defaults to 21.

Section
COPY-RFILE Description 

Category

Software Download

Security

Superuser

Related Messages

APPLY
REPT EVT FXFR

Input Format

COPY-RFILE:[<TID>]:[<SRC>]:<CTAG>::TYPE=<XFERTYPE>,
[SRC=<SRC1>,][DEST=<DEST>];

where:

<SRC> is the type of file being transferred; <SRC> is the AID from the "RFILE" section

<XFERTYPE> is the file transfer protocol; valid values for <XFERTYPE> are shown in the "TX_TYPE" section

<SRC1> specifies the source of the file to be transferred. Only the FTP URL is supported. In a non-firewall environment the format of the URL should be: "FTP://[FTP_USER[:FTP_PASSWORD]]@
FTP_HOST_IP/PACKAGE_PATH"
where:

<FTP_USER> is the userid to connect to the computer with the package file

<FTP_PASSWORD> is the password used to connect to the computer with the package file

<FTP_HOST_IP> is the IP address of the computer with the package file, DNS lookup of hostnames is not supported

<PACKAGE_PATH> is the long path name to the package file

Note Userid and password are optional if the user does not need to log into the host computer. The password may be optional if the user does not need to log in. All the other portions of the URL are required, including the initial "FTP://" string.

In a firewall environment, the hostname should be replaced with a list of IP addresses each separated by a @ character. The first IP address should be for the machine where the package file is stored. Subsequent IP addresses should then be for firewall machines moving outwards towards the edge of the network, until the final IP address listed is the machine that outside users first access the network.

For example, if the topology is "FTP_HOST_IP <-> GNE3 <->GNE2 <-> GNE1 <-> ENE", the FTP URL is:

FTP://FTP_USER:FTP_PASSWORD@FTP_HOST_IP@GNE3@GNE2@
GNE1/PACKAGE_PATH

<SRC1> is a string.

<DEST> see <SRC1> above

Input Example

COPY-RFILE:HERNDON:RFILE-PKG:703::TYPE=SWDL,
SRC="LONG_FTP_PATH",DEST="LONG_FTP_PATH";

Errors

Errors are listed in Table 7-30.


3.4.16 DISC-TACC: Disconnect Test Access

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-17.

For this command to be applicable, you must first create the TAP using the ED-<STS_PATH> or ED-VT1 commands.

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.

3. Automatic disconnection of the STS/VT path from a TAP happens when the session that created the connection gets timed out or is terminated.

Section
DISC-TACC Description 

Category

Test Access

Security

Provisioning

Related Messages

CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
RTRV-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 point is released. The <TAP> number must be an integer with a range of 1- 999. This command only supports changing a single <TAP> number at a time. <TAP> is a string

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

Input Example

DISC-TACC:CISCO:8:123;

Errors

Errors are listed in Table 7-30.


3.4.17 DLT-BLSR: Delete BLSR

This command deletes the BLSR of the NE.

Error conditions:

1. If the system fails on getting IOR, a SDBE (Status, Internal Data Base Error) error message is returned.

2. If the NE returns nothing for the required BLSR (BLSR-# AID), a SRQN (Status, Invalid Request) error message is returned.

Section
DLT-BLSR Description 

Category

BLSR

Security

Provisioning

Related Messages

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

Input Format

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

where:

<AID> identifies the BLSR of the NE. "ALL" or "BLSR-ALL" AID is not allowed for editing BLSR. This command only supports a single BLSR AID. <AID> is the AID from the "BLSR" section

Input Example

DLT-BLSR:PETALUMA:BLSR-2:123;

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

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 path protection configuration STS cross-connection.

a. 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>;

b. 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>;

c. The following command is used to delete a 1-way or 2-way subtending path protection configuration connection with:

from point: F1, F2

to points: T1, T2

DLT-CRS-{STS_PATH}:[<TID>]:F1&F2,T1&T2:<CTAG>;

d. 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.

e. The following command is used to create a path protection configuration IDRI Cross-Connection:

ENT-CRS-{STS_PATH}:[<TID>]:A&B,C&D:<CTAG>::2WAYDC;

A-Path on ring X to which traffic from ring Y is bridged

B-Path on ring X to which traffic from the same ring is bridged

C-Path on ring Y to which traffic from ring X is bridged

D-Path on ring Y to which traffic from the same ring is bridged

A, B, C, and D have a positional meaning. Connection type 2WAYDC is used for path protection configuration IDRI cross-connections.

f. The following command is used to create a path protection configuration DRI Cross-Connection:

ENT-CRS-{STS_PATH}:[<TID>]:A&B,C:<CTAG>::2WAYDC;

A-Path on ring X to which traffic from ring Y is bridged

B-Path on ring X to which traffic from the same ring is bridged

C-Traffic to and from ring Y

A, B, C, and D have a positional meaning. Connection type 2WAYDC is used for path protection configuration DRI cross-connections.

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.

7. The facility AID is only valid for slots holding the G1000-4 card.

8. The virtual facility AID (VFAC) is only valid on slots holding an ML-series card.

9. A TL1 cross-connect that has been upgraded to a CTC circuit can no longer be managed by TL1. For example, if you issue a DLT-CRS-<STS_PATH> command to delete a circuit, you will see that the circuit still appears in CTC as "incomplete". The reason for this is because in addition to creating cross-connects (as TL1 does), CTC creates another object on the source node that stores network-level circuit attributes. CTC will continue to see that object after the cross-connect is deleted which is why it shows an incomplete circuit.

Section
DLT-CRS-<STS_PATH> Description 

Category

Cross Connections

Security

Provisioning

Related Messages

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

Input Format

DLT-CRS-<STS_PATH>:[<TID>]:<SRC>,<DST>:<CTAG>[:::];

where:

<SRC> is the AID from the "CrossConnectID" section

<DST> is the AID from the "CrossConnectID" section

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.19 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 the 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 path protection configuration VT cross-connection.

a. 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>;

b. 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>;

c. The following command is used to delete a 1-way subtending path protection configuration connection or 2-way subtending path protection configuration connection with:

from points: F1, F2

to points: T1, T2

DLT-CRS-VT1:[<TID>]:F1&F2,T1&T2:<CTAG>;

d. 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>
ED-CRS-<STS_PATH>
ED-CRS-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
RTRV-CRS
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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.20 DLT-EQPT: Delete Equipment

This command deletes a card from 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 using the ED-EQPT command.

Error conditions for deleting equipment may be:

1. If the equipment is in use which corresponds to some provisioning having been done on the equipment, the SPLD (Equipment in use) error message will be returned:

a. If it is belongs to a protection group that has a cross-connection.

b. If one of its ports has been provisioned as a DCC channel.

c. If one of its ports is being used for a synchronization source.

d. If the equipment has a Test Access Point (TAP).

e. If one of its ports is being used as a UCP Control Channel or Interface.

f. If one of its ports is provisioned for a BLSR.

g. If one of its ports is a part of a 1+1 protection group.

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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

This command deletes an OCN facility protection group in a 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>
RTRV-PROTNSW-<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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.22 DLT-FFP-CLNT: Delete Facility Protection Group Client

This command deletes Y cable protection on client facilities.

Section
DLT-FFP-CLNT Description 

Category

DWDM

Security

Provisioning

Related Messages

DLT-FFP-<OCN_TYPE> RLS-PROTNSW-<OCN_TYPE>
ED-CLNT RLS-PROTNSW-CLNT
ED-DWDM RTRV-CLNT
ED-FFP-<OCN_TYPE> RTRV-DWDM
ED-FFP-CLNT RTRV-FFP-<OCN_TYPE>
ED-OCH RTRV-FFP-CLNT
ED-TRC-CLNT RTRV-OCH
ED-TRC-OCH RTRV-PROTNSW-<OCN_TYPE>
ENT-FFP-<OCN_TYPE> RTRV-PROTNSW-CLNT
ENT-FFP-CLNT RTRV-TRC-CLNT
OPR-PROTNSW-<OCN_TYPE> RTRV-TRC-OCH
OPR-PROTNSW-CLNT

Input Format

DLT-FFP-CLNT:[<TID>]:<WORKAID>,<PROTAID>:<CTAG>[:::];

where:

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

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

Input Example

DLT-FFP-CLNT:CISCO:FAC-1-1,FAC-2-1:100;

Errors

Errors are listed in Table 7-30.


3.4.23 DLT-UCP-CC: Delete Unified Control Plane Control Channel

(Cisco ONS 15454 only)

This command deletes a UCP IP control channel.

1. If you send this command to a control channel that is in use, a SRQN (Status, Invalid Request) error message is returned.

2. If sending this command to delete an SDCC IPCC with a complete result, the SDCC of the specified SONET line is deleted (or disabled) automatically with a DB change reporting (if the DB change report is enabled).

3. If sending this command to delete an IPCC which is in use by a UCP Interface, an SROF (Delete UCP IPCC Failed - Object Is In Use) error message is returned.

Section
DLT-UCP-CC Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-IF ENT-UCP-NBR
DLT-UCP-NBR REPT ALM UCP
ED-UCP-CC REPT EVT UCP
ED-UCP-IF RTRV-ALM-UCP
ED-UCP-NBR RTRV-COND-UCP
ED-UCP-NODE RTRV-UCP-CC
ENT-UCP-CC RTRV-UCP-IF
ENT-UCP-IF RTRV-UCP-NBR

Input Format

DLT-UCP-CC:[<TID>]:<AID>:<CTAG>[::::];

where:

<AID> indicates an individual IPCC ID; <AID> is the AID from the "IPCC" section

Input Example

DLT-UCP-CC:CISCO:CC-9:CTAG;

Errors

Errors are listed in Table 7-30.


3.4.24 DLT-UCP-IF: Delete Unified Control Plane Interface

This command deletes a UCP interface.


Note If the UCP interface is not found or in use, a SRQN (Status, Invalid Request) error message is returned.


Section
DLT-UCP-IF Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC ENT-UCP-NBR
DLT-UCP-NBR REPT ALM UCP
ED-UCP-CC REPT EVT UCP
ED-UCP-IF RTRV-ALM-UCP
ED-UCP-NBR RTRV-COND-UCP
ED-UCP-NODE RTRV-UCP-CC
ENT-UCP-CC RTRV-UCP-IF
ENT-UCP-IF RTRV-UCP-NBR

Input Format

DLT-UCP-IF:[<TID>]:<AID>:<CTAG>[::::];

where:

<AID> indicates the interface port index of the data link; <AID> is the AID from the "FACILITY" section

Input Example

DLT-UCP-IF:CISCO:FAC-2-1:CTAG;

Errors

Errors are listed in Table 7-30.


3.4.25 DLT-UCP-NBR: Delete Unified Control Plane Neighbor

This command deletes a UCP neighbor.

Notes:

1. If the neighbor is in use, an SRQN (Status, Invalid Request) error message is returned.

2. If sending this command to delete a neighbor which is in use by IPCC, an SROF (Delete UCP neighbor Failed - Object Is In Use) error message is returned.

Section
DLT-UCP-NBR Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC ENT-UCP-NBR
DLT-UCP-IF REPT ALM UCP
ED-UCP-CC REPT EVT UCP
ED-UCP-IF RTRV-ALM-UCP
ED-UCP-NBR RTRV-COND-UCP
ED-UCP-NODE RTRV-UCP-CC
ENT-UCP-CC RTRV-UCP-IF
ENT-UCP-IF RTRV-UCP-NBR

Input Format

DLT-UCP-NBR:[<TID>]:<AID>:<CTAG>[::::];

where:

<AID> indicates an individual neighbor AID of the UCP; <AID> is the AID from the "NBR" section

Input Example

DLT-UCP-NBR:CISCO:NBR-8:CTAG;

Errors

Errors are listed in Table 7-30.


3.4.26 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.

This command cannot be used to delete a user that is currently logged on.

For the DLT-USER-SECU command:

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

the syntax of <UID> is not checked. The user is deleted if the <UID> exists in the database.

Notes:

1. A userid cannot be deleted when that user is logged in. If you try to delete a userid and the user is logged in, an error message indicating that the user is logged in will be received.

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
RTRV-USER-SECU

Input Format

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

where:

<UID> is the user identifier and is a string; <UID> is any combination of up to 10 alphanumeric 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 <PID>.

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

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), Out Of Service with Automatic In Service transitioning (OOS-AINS), Out Of Service for Maintenance (OOS-MT), and In Service (IS).

The DCC transmit 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 BLSR must have the same mode. If you change the mode of a line that is in a 1+1 BLSR, an error message will be returned.

UNI-C DCC provisioning notes:

1. The attributes DCC(Y/N) and mode (SONET/SDH) remain the same in the ED/RTRV-OCN commands when the DCC is used for UNI-C, in which case the port attribute UNIC is enables (UNIC=Y).

2. If the DCC is created under regular SONET provisioning, and this port is used by UNI-C, the port is converted as a UNI-C DCC automatically.

3. De-provisioning UNI-C IF/IB IPCC will free up DCC termination automatically.

4. The state of the T1 port cannot be changed to IS or OOS if a loopback has been operated upon the line.

Section
ED-<OCN_TYPE> Description 

Category

Ports

Security

Provisioning

Related Messages

ED-DS1
ED-EC1
ED-G1000
ED-T1
ED-T3
RMV-<MOD2_IO>
RST-<MOD2_IO>
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>,]
[SOAK=<SOAK>]:[<PST>],[<SST>];

where:

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

<DCC> identifies an OCN 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

Valid values for <MODE> are shown in the "OPTICAL_MODE" section

<MUX> BLSR Extension Byte (supported only on OC48AS cards); valid values for <MUX> are shown in the "MUX_TYPE" section

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

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

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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

This command edits the attributes associated with an STS path.

The SFBER, SDBER, RVRTV, and RVTM parameters only apply to path protection configuration.

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 point. When an editing command on TACC is executed, it assigns the STS for the first 2-way connection and STS=1 as the second 2-way 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-17.

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

DS3/DS3N, OC12, OC48, E100, 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, path protection configuration 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 An STS TAP created in a DS3XM card cannot be used to connect to an STS with a non-VT structured payload, for example, DS3. If created, traffic cannot be monitored.



Note An STS TAP created in a DS3 card cannot be used to connect to an STS with a non-DS3 payload, for example, VT structured. If created, traffic cannot be monitored.


Error conditions:

1. If sending this command to edit SFBER or SDBER or RVRTV or RVTM for the non path protection configuration STS path, an error message will be returned.

2. If sending this command to edit the EXPTRC string with the AUTO path trace mode (TRCMODE=AUTO), an error message 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. If sending this command to edit TACC on an AID with cross-connections, an error message (STS in Use) will be returned.

7. TACC creation will also be denied on the protect ports/cards for 1:1, 1:N, and 1+1.

8. The VFAC AID is only valid on slots containing an ML1000-2 or ML100T-12 card. TACC is not supported for the ML1000-2 or ML100T-12 cards.

9. After the BLSR switching, provisioning of the J1 trace string or trace mode is not allowed on the protection path.

10. TACC creation is allowed on PCA for two-fiber and four-fiber BLSR.

11. TACC is not supported on G1000/MXP/TXP/ML1000-2 and ML100T-12 cards.

Section
ED-<STS_PATH> Description 

Category

STS and VT Paths

Security

Provisioning

Related Messages

RTRV-<STS_PATH>
RTRV-PTHTRC-<STS_PATH>

Input Format

ED-<STS_PATH>:[<TID>]:<SRC>:<CTAG>:::[SFBER=<SFBER>,]
[SDBER=<SDBER>,][RVRTV=<RVRTV>,][RVTM=<RVTM>,]
[SWPDIP=<SWPDIP>,][HOLDOFFTIMER=<HOLDOFFTIMER>,]
[EXPTRC=<EXPTRC>,][TRC=<TRC>,][TRCMODE=<TRCMODE>,]
[TACC=<TACC>]:[<PST>],[<SST>];

where:

<SRC> is the access identifier from the "CrossConnectID" section

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

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

<RVRTV> identifies a revertive mode which only applies to path protection configuration; valid values for <RVRTV> are shown in the "ON_OFF" section

<RVTM> identifies a revertive time which only applies to path protection configuration; valid values for <RVTM> are shown in the "REVERTIVE_TIME" section. <RVTM> is not allowed to be set while <RVRTV> is N.

<SWPDIP> On-Off switch for path protection configuration Payload Defect Level switching. Valid values for <SWPDIP> are shown in the "ON_OFF" section

<HOLDOFFTIMER> Hold-off timer for path protection configuration DRI; <HOLDOFFTIMER> is an integer

<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> is the AID "TACC" section

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

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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.29 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 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 RTRV-SYNCN
RLS-SYNCNSW

Input Format

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

where:

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

<LINECDE> is a 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

<LBO> indicates BITS line build out. The default value is 0-133. Valid values for <LBO> are shown in the "BITS_LineBuildOut" section

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

<AISTHRSHLD> is the AIS Threshold. Valid values for <AISTHRSHLD> shown in the "SYNC_CLOCK_REF_QUALITY_LEVEL" section

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

Input Example

ED-BITS:SONOMA:BITS-2:779:::LINECDE=AMI,FMT=ESF,LBO=0-133,
SYNCMSG=Y,AISTHRSHLD=PRS:IS;

Errors

Errors are listed in Table 7-30.


3.4.30 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 the system fails on getting IOR, a SDBE (Status, Internal Data Base Error) error message will be returned.

2. If the NE returns nothing for the required BLSR (BLSR-#, 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 or RVTM on the 2-fiber BLSR, an IDNV (Input, Data Not Valid) error message will be returned.

5. Both RINGID and NODEID can be edited using the ED-BLSR command starting with Release 3.2.

Section
ED-BLSR Description 

Category

BLSR

Security

Provisioning

Related Messages

DLT-BLSR
ENT-BLSR
REPT ALM RING
REPT EVT RING
RTRV-ALM-RING
RTRV-BLSR
RTRV-COND-RING

Input Format

ED-BLSR:[<TID>]:<AID>:<CTAG>:::[RINGID=<RINGID>,]
[NODEID=<NODEID>,][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" or "BLSR ALL" is not allowed for editing BLSR). This command only supports a single BLSR AID

<RINGID> identifies the BLSR ring ID of the NE. It ranges from 0-9999. <RINGID> is an integer

<NODEID> identifies the BLSR node ID of the NE. It ranges from 0-31. <NODEID> is an integer

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

<RVTM> identifies the revertive time; 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; valid values for <SRVTM> are shown in the "REVERTIVE_TIME" section

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.31 ED-CLNT: Edit Client

This command edits client facility attributes.

See the "Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards" section on page 1-8 for specific MXP/TXP card provisioning rules.

Section
ED-CLNT Description 

Category

DWDM

Security

Provisioning

Related Messages

RTRV-CLNT
RTRV-ALM-CLNT
RTRV-COND-CLNT
RST-CLNT
RMV-CLNT
ED-DWDM
RTRV-DWDM

Input Format

ED-CLNT:[<TID>]:<AID>:<CTAG>:::[SFBER=<SFBER>,][SDBER=<SDBER>,][ALSMODE=<ALSMODE>,][ALSRCINT=<ALSRCINT>,]
[ALSRCPW=<ALSRCPW>,][COMM=<COMM>,][MACADDR=<MACADDR>,]
[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,][RLASER=<RLASER>][SOAK=<SOAK>]:[<PST>],[<SST>];

where:

<AID> is from the "FACILITY" section

<SFBER> identifies the SFBER for the SONET payload; valid values are shown in the "SF_BER" section

<SDBER> identifies the SDBER for the SONET payload; valid values are shown in the "SD_BER" section

<ALSMODE> indicates if the Automatic Laser Shutdown is enabled or disabled; valid values are shown in the "ALS_MODE" section

<ALSRCINT> indicates the ALS recovery interval. Range is 100-300 seconds; <ALSRCINT> is an integer

<ALSRCPW> indicates the ALS recovery pulse width. The range is 2-100 seconds, in increments of 100ms, e.g. 30.1; <ALSRCPW> is a float

<COMM> indicates if the GCC or DCC is enabled or disabled. The GCC can be enabled only if the digital wrapper has been enabled for the card. The default is NONE. Valid values are shown in the "COMM_TYPE" section. Rules for a MXP/TXP Client port are; only the DCC can be provisioned, if the termination mode is not transparent and the payload is SONET. On a MXP/TXP DWDM port, the DCC can be enabled only if the G.709 is not enabled and if the payload is SONET and the termination mode is not transparent. On a MXP/TXP DWDM port, the GCC can be enabled if there is no DCC and the G.709 flag is enabled.

<MACADDR> identifies the MAC address for the 10GEthernet payload; <MACADDR> is a string

<SYNCMSG> indicates that the facility be enabled to provide the synchronization clock. This does not apply to a TXP card. This applies to an MXP card, only if the payload is SONET and the card termination mode is as follows: TRANSPARENT - All Client ports are available for all timing selections. All Trunk ports are not available. Valid values are shown in the "ON_OFF" section
LINE - All ports are available for all-timing selections.

<SENDDUS> indicates that the facility send out a Do not Use for Sync message. This does not apply to a TXP card. This applies to an MXP card, only if the payload is SONET and the card termination mode is as follows: TRANSPARENT - All Client ports are available for all timing selections. All Trunk ports are not available.
LINE - All ports are available for all-timing selections. Valid values are shown in the "ON_OFF" section

Input Format (continued)

<RLASER> indicates if the laser should be restarted. This is applicable only if the ALSMODE is not automatic; valid values are shown in the "ON_OFF" section

<SOAK> OOS-AINS to IS transition soak time as measured in 15-minute intervals. A value of 4 translates to a soak time of one hour. The allowable range is 0-192 intervals (maximum of 48-hours). <SOAK> is an integer

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

<SST> secondary state; valid values are shown in the "SST" section

Input Example

ED-CLNT:CISCO:FAC-1-1:100:::SFBER=1E-4,SDBER=1E-5,ALSMODE=Y,
ALSRCINT=30,ALSRCPW=35.1,COMM=DCC,
MACADDR=00-0E-AA-BB-CC-FF,SYNCMSG=Y,SENDDUS=Y,RLASER=Y,
SOAK=10:OOS,AINS;

Errors

Errors are listed in Table 7-30.


3.4.32 ED-CRS-<STS_PATH>:ED CRS (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS 48C, STS192C)

This command edits the state of an STS cross-connection.

Section
ED-CRS-<STS_PATH> Description 

Category

Cross Connections

Security

Provisioning

Related Messages

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

Input Format

ED-CRS-<STS_PATH>:[<TID>]:<SRC>,<DST>:<CTAG>:::[ADD=<ADD>,]
[REMOVE=<REMOVE>]:[<PST>],[<SST>];

where:

<SRC> is the AID from the "CrossConnectID" section

<DST> is the AID from the "CrossConnectID" section

<ADD> is the AID from the "CrossConnectID" section

<REMOVE> is the AID from the "CrossConnectID" section

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

ED-CRS-STS1::STS-1-1-1,STS-2-1-1:1:::ADD=STS-13-1-1,
REMOVE=STS-2-1-1:OOS,AINS;

Errors

Errors are listed in Table 7-30.


3.4.33 ED-CRS-VT1: Edit Cross Connection VT1

This command edits a VT cross-connection.


Note It is not possible to use both ADD and REMOVE at the same time.


Section
ED-CRS-VT1 Description 

Category

Cross Connections

Security

Provisioning

Related Messages

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

Input Format

ED-CRS-VT1:[<TID>]:<SRC>,<DST>:<CTAG>::::[ADD=<ADD>,]
[REMOVE=<REMOVE>]:[<PST>],[<SST>];

where:

<SRC> is the AID from the "VT1_5" section

<DST> is the AID from the "VT1_5" section

<ADD> is the AID from the "VT1_5" section

<REMOVE> is the AID from the "VT1_5" section

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

ED-CRS-VT1::VT1-1-1-1-1-1,VT1-2-1-1-1-1:1:::ADD=VT1-3-1-1-1-1,
REMOVE=VT1-2-1-1-1-1:OOS,AINS;

Errors

Errors are listed in Table 7-30.


3.4.34 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 RTRV-HDR
APPLY RTRV-INV
COPY-RFILE RTRV-MAP-NETWORK
ED-NE-GEN RTRV-NE-GEN
ED-NE-SYNCN RTRV-NE-IPMAP
INH-MSG-ALL RTRV-NE-SYNCN
INIT-SYS RTRV-TOD
REPT EVT FXFR 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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.35 ED-DS1: Edit DS1

(Cisco ONS 15454 only)

This command edits the test access attribute for DS1 access on a DS3XM card.


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-<MOD2_IO> RTRV-T3
RST-<MOD2_IO>

Input Format

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

where:

<AID> is the access identifier of a DS1 access on the DS3XM card and is 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. When TACC is 0, the TAP is deleted. <TACC> is an integer

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.36 ED-DWDM: Edit Dense Wavelength Division Multiplexing

The command edits an already pre-provisioned/provisioned MXP/TXP card. It changes the operating parameters for the card.

The rules for provisioning a regeneration group are: a regeneration group can be created only between a pair of TXP cards. The peer slot should contain a card of the same type, and should not have an existing regeneration group for the same slot. The termination mode should be identical for the cards. All the client port level settings should be identical for the cards. Setting the PEERID=Null will remove an existing regeneration group. The two TXP cards should be set to transparent termination mode to successfully create a regeneration group.

The rules for provisioning the payload field are as follows: For a TXP card, the SONET/10GE (Ethernet) applies. The port has to be in OOS state for a payload change to be successful. There should be no Trace enabled for the port. To set the Payload to 10GE, the termination mode should already be in Transparent mode. Issue a separate ED-DWDM command to set it to Transparent mode prior to setting the payload to 10GE. The MXP card does not support 10GE payload. To change the payload type for the MXP card, all the ports should be in OOS state. The payload cannot be changed if any of the ports are a part of a Y cable protection group or are used as the timing source. There should be no DCC enabled on any ports.

See the "Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards" section on page 1-8 for specific MXP/TXP card provisioning rules.

Section
ED-DWDM Description 

Category

DWDM

Security

Provisioning

Related Messages

RTRV-DWDM

Input Format

ED-DWDM:[<TID>]:<AID>:<CTAG>:::[PEERID=<PEERID>,]
[TERMMODE=<TERMMODE>,][PAYLOAD=<PAYLOAD>,][PWL=<PWL>];

where:

<AID> is from the "EQPT" section

<PEERID> is from the "EQPT" section

<TERMMODE> indicates the termination mode of the card; valid values are shown in the "TERM_MODE" section

<PAYLOAD> is the type of payload carried; valid values are shown in the "PAYLOAD" section

<PWL> is the provisioned wavelength; valid values are shown in the "OPTICAL_WLEN" section

Input Example

ED-DWDM:VA454-22:SLOT-1:100:::PEERID=SLOT-2,TERMMODE=TRANS,
PAYLOAD=SONET,PWL=1546.52;

Errors

Errors are listed in Table 7-30.


3.4.37 ED-EC1: Edit Electrical Carrier

(Cisco ONS 15454 only)

This command edits the attributes of an EC1.

Notes:

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

2. The state of the T1 port cannot be changed to IS or OOS if a loopback has been operated upon the line.

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-<MOD2_IO> RTRV-T3
RST-<MOD2_IO>

Input Format

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

where:

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

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

Valid values for <LBO> are shown in the "E_LBO" section

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

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

ED-EC1:CISCO:FAC-1-1:123:::PJMON=0,LBO=0-225,SOAK=10:OOS,AINS;

Errors

Errors are listed in Table 7-30.


3.4.38 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.

The 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;

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 cannot be edited either.

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

1:1 protection group

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

1:N protection group

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

Error conditions for editing a 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. 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 an access identifier from the "EQPT" section

<PROTID> is the protecting card slot number of the protection group. <PROTID> is the AID from the "UCP" 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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

This command edits the optical facility protection.

Notes:

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

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>
RTRV-PROTNSW-<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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.40 ED-FFP-CLNT: Edit Facility Protection Group Client

This command edits a Y cable protection group on client facilities.

See the "Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards" section on page 1-8 for specific MXP/TXP card provisioning rules.

Section
ED-FFP-CLNT Description 

Category

DWDM

Security

Provisioning

Related Messages

RTRV-FFP-CLNT
OPR-PROTNSW-CLNT
RTRV-CLNT
RTRV-ALM-CLNT
RTRV-COND-CLNT
DLT-FFP-CLNT
ENT-FFP-CLNT

Input Format

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

where:

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

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

<RVRTV> identifies a revertive mode. The retrieve behavior defaults to N (non-revertive mode); valid values are shown in the "ON_OFF" section

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

<PSDIRN> identifies the switching mode and defaults to UNI. Release 4.0 MXP/TXP cards do not support BI-DIRECTIONAL switching. Valid values for <PSDIRN> are shown in the "UNI_BI" section

Input Example

ED-FFP-CLNT:CISCO:FAC-1-1:100:::PROTID=DC-METRO,RVRTV=N,
RVTM=1.0,PSDIRN=BI;

Errors

Errors are listed in Table 7-30.


3.4.41 ED-G1000: Edit G1000

(Cisco ONS 15454 only)

This command edits the attributes related to a G1000 port.


Note The state OOS-AINS is not supported on the G1000.


Section
ED-G1000 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-<MOD2_IO> RTRV-T3
RST-<MOD2_IO>

Input Format

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

where:

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

Valid values for <MFS> are shown in the "MFS_TYPE" section

Valid values for <FLOW> are shown in the "AWG_STATUS" section

<OPTICS> GBIC type; valid values are shown in the "OPTICS" section

<ALS> automatic laser shutdown; valid values are shown in the "ALS_RESTART" section

<TRANS> transponder mode; valid values are shown in the "TRANS_MODE" section

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

ED-G1000:TID:FAC-1-1:CTAG:::MFS=1548,FLOW=ON,OPTICS=COPPER,
ALS=AUTO_RESTART,TRANS=NONE:OOS,AINS;

Errors

Errors are listed in Table 7-30.


3.4.42 ED-NE-GEN: Edit Network Element General

This command edits the node attributes of the NE.

Notes:

1. Only the IPADDR, IPMASK, DEFRTR, IIOP PORT 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.

3. The feature of setting a timing source has been supported since ONS 15454 R3.2.

4. An existing timing source can be removed by setting the address to 0.0.0.0.

Section
ED-NE-GEN Description 

Category

System

Security

Superuser

Related Messages

ALW-MSG-ALL RTRV-HDR
APPLY RTRV-INV
COPY-RFILE RTRV-MAP-NETWORK
ED-DAT RTRV-NE-GEN
ED-NE-SYNCN RTRV-NE-IPMAP
INH-MSG-ALL RTRV-NE-SYNCN
INIT-SYS RTRV-TOD
REPT EVT FXFR SET-TOD

Input Format

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

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

<IIOPPORT> indicates the node IIOPPORT and is an integer

<NTP> indicates the node's NTP timing origin address and is a string

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.43 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-14 for more information.

2. The existing external and line modes have the same functionality in all ONS 15454 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 RLS-SYNCNSW
APPLY RTRV-ALM-BITS
COPY-RFILE RTRV-ALM-SYNCN
ED-BITS RTRV-BITS
ED-DAT RTRV-COND-BITS
ED-NE-GEN RTRV-COND-SYNCN
ED-SYNCN RTRV-HDR
INH-MSG-ALL RTRV-INV
INIT-SYS RTRV-MAP-NETWORK
OPR-SYNCNSW RTRV-NE-GEN
REPT ALM BITS RTRV-NE-IPMAP
REPT ALM SYNCN RTRV-NE-SYNCN
REPT EVT BITS RTRV-SYNCN
REPT EVT FXFR RTRV-TOD
REPT EVT SYNCN 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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.44 ED-OCH: Edit Optical Channel

Cisco ONS 15454 only for MXP and TXP cards.

This command edits the attributes (service parameters) and state of an OCH facility.

See the "Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards" section on page 1-8 for specific MXP/TXP card provisioning rules.

Section
ED-OCH Description 

Category

DWDM

Security

Provisioning

Related Messages

RTRV-OCH
RTRV-ALM-OCH
RTRV-COND-OCH
RST-OCH
RMV-OCH

Input Format

ED-OCH:[<TID>]:<AID>:<CTAG>:::[RDIRN=<RDIRN>,]
[EXPWLEN=<EXPWLEN>,][VOAATTN=<VOAATTN>,]
[VOAPWR=<VOAPWR>,][CALOPWR=<CALOPWR>,][SFBER=<SFBER>,]
[SDBER=<SDBER>,][ALSMODE=<ALSMODE>,][ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,][COMM=<COMM>,][GCCRATE=<GCCRATE>,]
[OSFBER=<OSFBER>,][OSDBER=<OSDBER>,][DWRAP=<DWRAP>,]
[FEC=<FEC>,][MACADDR=<MACADDR>,][SYNCMSG=<SYNCMSG>,]
[SENDDUS=<SENDDUS>,][RLASER=<RLASER>,][SOAK=<SOAK>]:
[<PST>],[<SST>];

where:

<AID> is an access identifier from the "CHANNEL" section

<RDIRN> applicable in a future release

<EXPWLEN> applicable in a future release

<VOAATTN> indicates the value of calibrated attenuation for the VOA. It is expressed in Dbm. The range is -24.0 to +2.0Dbm for MXP/TXP cards. <VOAATTN> is a float

<VOAPWR> applicable in a future release

<CALOPWR> applicable in a future release

<SFBER> identifies the SFBER for the SONET payload; valid values are shown in the "SF_BER" section

<SDBER> identifies the SDBER for the SONET payload; valid values are shown in the "SD_BER" section

<ALSMODE> indicates if the Automatic Laser Shutdown is enabled or disabled; valid values are shown in the "ALS_MODE" section

<ALSRCINT> indicates the ALS recovery interval. Range is 100-300 seconds; <ALSRCINT> is an integer

<ALSRCPW> indicates the ALS recovery pulse width. The range is 2-100 seconds, in increments of 100ms, e.g. 30.1; <ALSRCPW> is a float

<COMM> indicates if the GCC or DCC is enabled or disabled. The GCC can be enabled only if the digital wrapper has been enabled for the card. The default is NONE. Valid values are shown in the "COMM_TYPE" section. Rules for a MXP/TXP Client port are; only the DCC can be provisioned, if the termination mode is not transparent and the payload is SONET. On a MXP/TXP DWDM port, the DCC can be enabled only if the G.709 is not enabled and if the payload is SONET and the termination mode is not transparent. On a MXP/TXP DWDM port, the GCC can be enabled if there is no DCC and the G.709 flag is enabled.

<GCCRATE> indicates the data rate of the GCC traffic. Valid values are shown in the "GCCRATE" section. The default is 192Kbps. For MXP/TXP cards this applies only to the DWDM port. The 576K option is not supported for this release.

<OSFBER> identifies the SFBER for the OTN level. Applicable only if the G.709 is enabled; valid values are shown in the "SF_BER" section

Input Format (continued)

<OSDBER> identifies the SDBER for the OTN level. Applicable only if the G.709 is enabled; valid values are shown in the "SD_BER" section

<DWRAP> is the G.709 digital wrapper. It is either on or off. The system default is ON. For MXP/TXP, this applies only to the DWDM port. To enable G.709 there should be no GCC on the DWDM port. To disable G.709 there should be no GCC on the DWDM port. The FEC should be turned to off; valid values are shown in the "ON_OFF" section

<FEC> is the Forward Error Correction. It can be enabled only if the G.709 is turned ON. It is either on or off. The system default is ON. For MXP/TXP this applies only to the DWDM port. The FEC level PM and thresholds apply if the FEC is turned on; valid values are shown in the "ON_OFF" section

<MACADDR> identifies the MAC address for the 10GE payload; <MACADDR> is a string

<SYNCMSG> indicates that the facility be enabled to provide the synchronization clock. This does not apply to a TXP card. This applies to an MXP card, only if the payload is SONET and the card termination mode is as follows:
TRANSPARENT - All Client ports are available for all timing selections. All Trunk ports are not available.
LINE - All ports are available for all-timing selections.

<SENDDUS> indicates that the facility send out a Do not Use for Sync message. This does not apply to a TXP card. This applies to an MXP card, only if the payload is SONET/SDH and the card termination mode is as follows: TRANSPARENT - All Client ports are available for all timing selections. All Trunk ports are not available.
LINE - All ports are available for all-timing selections.
Valid values are shown in the "ON_OFF" section

<RLASER> indicates if the laser should be restarted. This is applicable only if the ALSMODE is not automatic; valid values are shown in the "ON_OFF" section

<SOAK> OOS-AINS to IS transition soak time as measured in 15-minute intervals. A value of 4 translates to a soak time of one hour. The allowable range is 0-192 intervals (maximum of 48-hours). <SOAK> is an integer

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

<SST> secondary state; valid values are shown in the "SST" section

Input Example

ED-OCH:CISCO:CHAN-6-2:114:::RDIRN=W-E,EXPWLEN=1530.32,
VOAATTN=2.5,VOAPWR=7.5,CALOPWR=0,SFBER=1E-5,SDBER=1E-6,
ALSMODE=Y,ALSRCINT=30,ALSRCPW=35.1,COMM=DCC,
GCCRATE=192K,OSFBER=1E-5,OSDBER=1E-6,DWRAP=Y,FEC=Y,
MACADDR=00-0E-AA-BB-CC-DD,SYNCMSG=N,SENDDUS=Y,RLASER=Y,
SOAK=10:OOS,AINS;

Errors

Errors are listed in Table 7-30.


3.4.45 ED-PID: Edit Password

This command allows a user to change his or her 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. Passwords are masked for the following security commands: ACT-USER, ED-PID, ENT-USER-SECU and ED-USER-SECU. Access to a TL1 session via any means will have the password masked. The CTC Request History and Message Log will also show the masked commands. When a password-masked command is re-issued by double-clicking the command from CTC Request History, the password will still be masked in the CTC Request History and Message Log. The actual password that was previously issued will be sent to the NE. To use a former command as a template only, single-click the command in CTC Request History. The command will be placed in the Command Request text box, where you can edit the appropriate fields prior to re-issuing it.

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

3. 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.

4. For the ED-PID command:

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

the syntax of <OLDPID> is not checked. The <NEWPID> is required to follow Telcordia standards (i.e., 10 characters maximum including 1 letter, 1 number, and any one of the following characters: #, %, or +). The <OLDPID> must match what is in the database.

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
RTRV-USER-SECU

Input Format

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

where:

<UID> is the user identifier and is a string; <UID> is any combination of up to 10 alphanumeric characters

<OLDPID> is the old password and is a string; <OLDPID> is any combination of up to 10 alphanumeric characters. The syntax of <OLDPID> is not checked for backwards compatibility

<NEWPID> is the user login password and is a string; <NEWPID> is a minimum of 6, maximum of 10 alphanumeric characters including at least one digit and one 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 <PID>.

Input Example

ED-PID:CISCO:UID:123::OLDPWD,NEWPWD;

Errors

Errors are listed in Table 7-30.


3.4.46 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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.47 ED-T1: Edit T1

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 and the port/VT does not have a test access point (TAP or TACC number). Otherwise, an error message (e.g. VT in Use) will be returned.

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

5. The state of the T1 port cannot be changed to IS or OOS if a loopback has been operated upon the line.

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-<MOD2_IO> RTRV-T3
RST-<MOD2_IO>

Input Format

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

where:

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

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

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

<LBO> is a 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.

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

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.48 ED-T3: Edit T3

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. If sending this command to edit TACC and any other attribute(s), and the port having the cross-connection or the port/VT has a test access point (TAP or TACC number), the (Parameters Not compatible) error message will be returned.

4. Editing TACC via an ED-xxx command is only allowed when there is no circuit/cross-connection on the port and the port/VT does not have a test access point (TAP or TACC number). Otherwise, an error message (e.g. VT in Use) will be returned.

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

6. The state of the T1 port cannot be changed to IS or OOS if a loopback has been operated upon the line.

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-<MOD2_IO> RTRV-T3
RST-<MOD2_IO>

Input Format

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

where:

<AID> indicates a facility AID from the "FACILITY" section

<FMT> is a 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 a line code; valid values for <LINECDE> are shown in the "DS_LINE_CODE" section

<LBO> is a 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

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

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

ED-T3:CISCO:FAC-1-2:123:::FMT=C-BIT,LINECDE=B3ZS,LBO=0-225,
TACC=8,SOAK=10:OOS,AINS;

Errors

Errors are listed in Table 7-30.


3.4.49 ED-TRC-CLNT: Edit Trace Client

This command edits trace-related attributes on client facilities.

See the "Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards" section on page 1-8 for specific MXP/TXP card provisioning rules.

Section
ED-TRC-CLNT Description 

Category

DWDM

Security

Provisioning

Related Messages

RTRV-TRC-CLNT
ED-DWDM
RTRV-DWDM
RTRV-CLNT

Input Format

ED-TRC-CLNT:[<TID>]:<SRC>:<CTAG>:::[EXPTRC=<EXPTRC>,]
[TRC=<TRC>,][TRCMODE=<TRCMODE>,]TRCLEVEL=<TRCLEVEL>,
[TRCFORMAT=<TRCFORMAT>];

where:

<SRC> is the AID from the "FACILITY" section and must not be null

<EXPTRC> indicates the expected path trace message (OTUK-path,J0-section, for example) contents. The <EXPTRC> is any 64-character string, including the termination CR (carriage return) and LF (line feed). <EXPTRC> is a string and a null value is equivalent to ALL

<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 (OTUK-path,J0-section, for example) 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 a null value is equivalent to ALL

<TRCMODE> identifies the trace mode and defaults to the OFF mode; valid values are shown in the "TRCMODE" section and a null value is equivalent to ALL

<TRCLEVEL> indicates the level of trace. A null value defaults to J0-Section SONET. This is the only applicable level for the client port. Valid values are shown in the "TRCLEVEL" section and a null value is equivalent to ALL

Valid values for <TRCFORMAT> are shown in the "TRCFORMAT" section. A null value is equivalent to ALL

Input Example

ED-TRC-CLNT:CISCO:FAC-6-1:10:::EXPTRC= "AAA",TRC="AAA",
TRCMODE=MAN,TRCLEVEL=PATH,TRCFORMAT=64-BYTE;

Errors

Errors are listed in Table 7-30.


3.4.50 ED-TRC-OCH: Edit Trace Optical Channel Facilities

The command edits trace-related optical channel facilities.

See the "Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards" section on page 1-8 for specific MXP/TXP card provisioning rules.

Section
ED-TRC-OCH Description 

Category

DWDM

Security

Provisioning

Related Messages

RTRV-TRC-OCH
RTRV-DWDM
ED-DWDM
RTRV-OCH

Input Format

ED-TRC-OCH:[<TID>]:<SRC>:<CTAG>:::[EXPTRC=<EXPTRC>,]
[TRC=<TRC>,][TRCMODE=<TRCMODE>,]TRCLEVEL=<TRCLEVEL>,
[TRCFORMAT=<TRCFORMAT>];

where:

<SRC> is the AID from the "CHANNEL" section and must not be null

<EXPTRC> indicates the expected path trace message (OTUK-path,J0-section, for example) contents. The <EXPTRC> is any 64-character string, including the termination CR (carriage return) and LF (line feed). <EXPTRC> is a string and a null value is equivalent to ALL

<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 (OTUK-path, J0-section, for example) 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 a null value is equivalent to ALL

<TRCMODE> identifies the trace mode and defaults to the OFF mode; valid values are shown in the "TRCMODE" section

<TRCLEVEL> indicates the level of trace. A null value defaults to J0 Section. If G.709 is not enabled and the payload is SONET/SDH, the only applicable level is SONET SECTION, which is the J0 byte. If the G.709 is enabled, the TTI monitoring is allowed on all PATH, and SEC. Valid values are shown in the "TRCLEVEL" section

Valid values for <TRCFORMAT> are shown in the "TRCFORMAT" section

Input Example

ED-TRC-OCH:CISCO:CHAN-6-2:10:::EXPTRC="AAA",TRC="AAA",
TRCMODE=MAN,TRCLEVEL=PATH,TRCFORMAT=64-BYTE;

Errors

Errors are listed in Table 7-30.


3.4.51 ED-UCP-CC: Edit Unified Control Plane Control Channel

(Cisco ONS 15454 only)

This command edits UCP IP control channel attributes.

Notes:

1. If sending this command with invalid data, an IIAC (Status, Invalid Data) error message is returned.

2. If sending this command to provision MTU, CRCMD, or both while the IPCC type is routed (CCTYPE=ROUTED), an IIAC (Routed CC Is Not Allowed to Provision MTU & CRCMD) error message is returned.

Section
ED-UCP-CC Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC REPT ALM UCP
DLT-UCP-IF REPT EVT UCP
DLT-UCP-NBR RTRV-ALM-UCP
ED-UCP-IF RTRV-COND-UCP
ED-UCP-NBR RTRV-UCP-CC
ED-UCP-NODE RTRV-UCP-IF
ENT-UCP-CC RTRV-UCP-NBR
ENT-UCP-IF RTRV-UCP-NODE
ENT-UCP-NBR

Input Format

ED-UCP-CC:[<TID>]:<AID>:<CTAG>:::[LOCALIPCC=<LOCALIPCC>,]
[REMOTEIPCC=<REMOTEIPCC>,][LMPHELLOINT=<LMPHELLOINT>,]
[LMPHELLODEADINT=<LMPHELLODEADINT>,][MTU=<MTU>,]
[CRCMD=<CRCMD>][:];

where:

<AID> indicates an individual IPCC ID; <AID> is the AID from the "IPCC" section

<LOCALIPCC> indicates the local IP address of the control channel and is a string

<REMOTEIPCC> indicates the remote IP address of the control channel and is a string

<LMPHELLOINT> indicates the LMP (line management protocol) interval (in milliseconds) and is an integer. It is the time between hello messages sent by this node.

<LMPHELLODEADINT> indicates the control channel time-out interval (in milliseconds) by the neighbor if the neighbor does not receive the hello message; <LMPHELLODEADINT> is an integer

<MTU> indicates the MTU size of this control channel and is an integer

<CRCMD> indicates the CRC mode for this control channel. It is applicable to IPCCs in SDCC type.Valid values for <CRCMD> are shown in the "UCP_CRC_MODE" section

Input Example

ED-UCP-CC:CISCO:CC-9:CTAG:::LOCALIPCC=172.20.209.31,
REMOTEIPCC=172.20.209.15,LMPHELLOINT=1,LMPHELLODEADINT=5,
MTU=1500,CRCMD=16-BIT;

Errors

Errors are listed in Table 7-30.


3.4.52 ED-UCP-IF: Edit Unified Control Plane Interface

(Cisco ONS 15454 only)

This command edits UCP interface attributes.


Note If you send invalid data with this command, an IIAC (Status, Invalid Data) error message is returned.


Section
ED-UCP-IF Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC REPT ALM UCP
DLT-UCP-IF REPT EVT UCP
DLT-UCP-NBR RTRV-ALM-UCP
ED-UCP-CC RTRV-COND-UCP
ED-UCP-NBR RTRV-UCP-CC
ED-UCP-NODE RTRV-UCP-IF
ENT-UCP-CC RTRV-UCP-NBR
ENT-UCP-IF RTRV-UCP-NODE
ENT-UCP-NBR

Input Format

ED-UCP-IF:[<TID>]:<AID>:<CTAG>:::[TNATYPE=<TNATYPE>,]
[TNAADDR=<TNAADDR>,][CORENETWORKID=<CORENETWORKID>][:];

where:

<AID> indicates the interface port index of the data link; <AID> is the AID from the "FACILITY" section

<TNATYPE> indicates the TNA (transport network administered) type; valid values for <TNATYPE> are shown in the "UCP_TNA_TYPE" section

<TNAADDR> indicates the TNA (transport network administered) IP address and is a string

<CORENETWORKID> is an integer

Input Example

ED-UCP-IF:CISCO:FAC-2-1:CTAG:::TNATYPE=IPV4,
TNAADDR=172.20.209.73,CORENETWORKID=9;

Errors

Errors are listed in Table 7-30.


3.4.53 ED-UCP-NBR: Edit Unified Control Plane Neighbor

(Cisco ONS 15454 only)

This command edits a UCP neighbor.

The default value of the node name can be overwritten by the TL1 user to a string in a maximum size of 20 characters. If the node name includes non-identified TL1 characters (e.g. space), the text string format with the double quotes is required.

Example:

ENT-UCP-NBR::NBR-18:CTAG:::NBRIX=18,NODEID=192.168.101.18,
NAME=NeibhgorName,NDEN=N,HELLOEN=Y,HELLOINT=5, REFREDEN=Y;

Notes:

1. If this command is sent twice or input with invalid data, a SRQN (Status, Invalid Request) error message is returned.

2. If sending this command without neighbor node name in the "NAME" field, an IIAC (Neighbor Name Cannot Be Empty) error message is returned.

3. If sending this command to set the hello interval while the RSVP hello is disabled, an IIAC (HELLOINT Is Not Allowed If HELLOEN Is Disabled) error message is returned.

Section
ED-UCP-NBR Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC REPT ALM UCP
DLT-UCP-IF REPT EVT UCP
DLT-UCP-NBR RTRV-ALM-UCP
ED-UCP-CC RTRV-COND-UCP
ED-UCP-IF RTRV-UCP-CC
ED-UCP-NODE RTRV-UCP-IF
ENT-UCP-CC RTRV-UCP-NBR
ENT-UCP-IF RTRV-UCP-NODE
ENT-UCP-NBR

Input Format

ED-UCP-NBR:[<TID>]:<AID>:<CTAG>:::[NAME=<NAME>,]
[HELLOEN=<HELLOEN>,][HELLOINT=<HELLOINT>,]
[REFREDEN=<REFREDEN>][:];

where:

<AID> indicates an individual neighbor index of the UCP. An available neighbor index will be assigned internally while sending this command without AID; <AID> is the AID from the "NBR" section

<NAME> indicates the neighbor node name. It defaults to the ASCII representation of the node ID in this command. The default value of this node name can be overwritten by the TL1 user to a string in a maximum size of 20 characters. If the node name includes non-identified TL1 characters (e.g. space), the text string format with the double quotes is required. Node name is a string. The default value is "defaults to the nodeid ASCII representation". <NAME> is a string. The default value is "the ASCII representation of the nodeid". <NAME> is a string

<HELLOEN> indicates if the RSVP hello enabled to this neighbor or not; valid values for <HELLOEN> are shown in the "ON_OFF" section

<HELLOINT> indicates the interval between hello messages to neighbor; <HELLOINT> is an integer

<REFREDEN> indicates if the refresh reduction is enabled or not; valid values for <REFREDEN> are shown in the "ON_OFF" section

Input Example

ED-UCP-NBR:CISCO:NBR-8:CTAG:::NAME=NODE-B,HELLOEN=Y,
HELLOINT=20,REFREDEN=N;

Errors

Errors are listed in Table 7-30.


3.4.54 ED-UCP-NODE: Edit Unified Control Plane Node

(Cisco ONS 15454 only)

This command edits the UCP node level attributes.

The nodeid is the unique number used to identify the local node in LMP, RSVP messages sent to the neighbors. It defaults to the local ethernet interface address (ISA).

The retry initial interval (in seconds) is used for that have been released by the net work side. This interval has a range of 60 seconds (1 minute) to 1800 seconds (30 minutes), with a default value of 180 seconds.

The retry max interval (in seconds) is used for released circuits. The node will back off exponentially from the initial retry interval to this maximum value of 600 seconds (10 minutes).

The restart time is used to be signaled to neighbors. It indicates the time taken by this node (in seconds) to restart. This timer has a range of 1 second to 10 seconds with a default of 5 seconds.

The recovery time is used to be signaled to neighbors. It indicates the time taken by this node (in seconds) to re-sync path, reservation state with a given neighbor. This timer has a range of 300 seconds (5 minutes) to 1800 seconds (30 minutes) and a default value of 600 seconds (10 minutes).

The transmit interval is used to retransmit un-acknowledged messages. This timer has a range of 1 second to 7 seconds with a default value of 1 second.

The refresh interval is used to refresh path, reservation state. This interval has a range of 30 seconds to 4060800 seconds (47 days) with a default value of 30 seconds.

The timeout RESV CONF interval is used to wait for a RESV CONF message in response to a RESV message. This interval has a range of 10-180 seconds with a default value of 60 seconds.

The Destination Deletion progress is a timeout interval while the destination is in the progress of cleanly deleting a call. This interval has a range of 1-180 seconds with a default value of 60 seconds.

Notes:

1. If the retry initial interval is set to zero, it will be interpreted as having the retry procedure disable.

2. The retry maximum interval has to be set to a higher value than the initial retry interval.

Section
ED-UCP-NODE Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC REPT ALM UCP
DLT-UCP-IF REPT EVT UCP
DLT-UCP-NBR RTRV-ALM-UCP
ED-UCP-CC RTRV-COND-UCP
ED-UCP-IF RTRV-UCP-CC
ED-UCP-NBR RTRV-UCP-IF
ENT-UCP-CC RTRV-UCP-NBR
ENT-UCP-IF RTRV-UCP-NODE
ENT-UCP-NBR

Input Format

ED-UCP-NODE:[<TID>]::<CTAG>:::[NODEID=<NODEID>,]
[INITRETRY=<INITRETRY>,][MAXRETRY=<MAXRETRY>,]
[RESTARTTM=<RESTARTTM>,][RECOVTM=<RECOVTM>,]
[RXMTINT=<RXMTINT>,][RFRSHINT=<RFRSHINT>,]
[RESVTIMEOUT=<RESVTIMEOUT>,]
[RESVCONFTIMEOUT=<RESVCONFTIMEOUT>,]
[SOURCEDIP=<SOURCEDIP>,][DESTINATIONDIP=<DESTINATIONDIP>][:];

where:

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

<INITRETRY> indicates the circuit retry initial interval (in seconds) and is an integer

<MAXRETRY> indicates the circuit maximum retry initial interval (in seconds) and is an integer

<RESTARTTM> indicates the restart time taken by this local node; <RESTARTTM> is an integer and the default value is 5 seconds.

<RECOVTM> indicates the circuit retry maximum interval (in seconds) and is an integer

<RXMTINT> indicates the interval for re-transmitting un-acknowledged messages and is an integer

<RFRSHINT> indicates the interval for refreshing path, reservation state and is an integer

<RESVTIMEOUT> indicates the timeout interval for waiting for a reservation message in response to a PATH message; <RESVTIMEOUT> is an integer

<RESVCONFTIMEOUT> indicates the timeout interval for waiting for a RESV CONF message in response to a RESV message; <RESVCONFTIMEOUT> is an integer

<SOURCEDIP> indicates the timeout interval of the SourceDip (Source Deletion in Progress) while the source is in the process of cleanly deleting a call; <SOURCEDIP> is an integer

<DESTINATIONDIP> indicates the timeout interval of the DestinationDip (Destination Deletion in Progress) while the destination is in the process of cleanly deleting a call; <DESTINATIONDIP> is an integer

Input Example

ED-UCP-NODE:CISCO::CTAG:::NODEID=192.168.100.52,INITRETRY=180,
MAXRETRY=600,RESTARTTM=5,RECOVTM=600,RXMTINT=1,
RFRSHINT=30,RESVTIMEOUT=60,RESVCONFTIMEOUT=60,
SOURCEDIP=60,DESTINATIONDIP=60;

Errors

Errors are listed in Table 7-30.


3.4.55 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. Passwords are masked for the following security commands: ACT-USER, ED-PID, ENT-USER-SECU and ED-USER-SECU. Access to a TL1 session via any means will have the password masked. The CTC Request History and Message Log will also show the masked commands. When a password-masked command is re-issued by double-clicking the command from CTC Request History, the password will still be masked in the CTC Request History and Message Log. The actual password that was previously issued will be sent to the NE. To use a former command as a template only, single-click the command in CTC Request History. The command will be placed in the Command Request text box, where you can edit the appropriate fields prior to re-issuing it.

2. The <UID> can be any combination of up to 10 alphanumeric characters.

3. The <PID> is a string of up to 10 characters where at least 2 are non-alphabetic with at least one special character (+, %, or #).

4. Although the CTC allows both <UID> and <PID> of up to 20 characters, the CTC-entered users (<UID>, <PID>) are not valid TL1 users (e.g., if issuing an ACT-USER command and using the CTC-entered <UID> that is greater than 10 characters long, TL1 will respond with DENY.

5. For the ED-USER-SECU command;

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

a. The syntax of <NEWPID> is checked.

b. If the <NEWPID> is specified, the syntax is checked.

c. The syntax of <UID> is not checked.

d. Old users can change their password without changing their userid, but the new password must meet the new requirements.

e. The <NEWPID> is required when changing the <USERID>.

Currently, when <NEWUID> is specified, <NEWPID> is not optional; however, it is possible to change a userid without changing the password by providing the same password. Users are not allowed to keep their old password if the old password does not meet the new syntax requirements; for example,

<USERID> = DODI2345
<PASSWORD> = DODI#234 /*PASSWORD ALREADY MEETS REQUIREMENTS*/

> ED-USER-SECU::DODI2345:1::DODI3456,DODI#234,,PROV;
ED-USER-SECU::DODI2345:1::DODI3456,DODI#234,,PROV;

TCCP 1970-01-02 13:15:35
M 1 COMPLD
;

<NEWUSERID> = DODI3456
<PASSWORD> = DODI#234
<USERID> = CISCO40
<PASSWORD> = CISCO40 /*PASSWORD DOES NOT MEET REQUIREMENTS*/

> ED-USER-SECU::CISCO40:1::CISCO40,,PROV;
ED-USER-SECU::CISCO40:1::CISCO40,,PROV;

TCCP 1970-01-02 13:14:24
M 1 DENY
IIFM
/* INVALID PASSWORD */
;

6. 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.

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
RTRV-USER-SECU

Input Format

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

where:

<UID> is the user identifier and is a string. The minimum <UID> size is 6, the maximum UID size is 10

<NEWUID> is the new user identifier and is a string. The minimum <UID> size is 6, the maximum PID size is 10

<NEWPID> is a new password and is a string; <NEWPID> is a minimum of 6, maximum of 10 alphanumeric characters including at least one digit and one special character (%, #, or +).

<UAP> is a 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 <PID>.

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.56 ED-VT1: Edit Virtual Tributary

This command edits the attributes associated with a VT1 path.

Both RVRTV and RVTM parameters only apply to path protection configuration.

The TACC parameter edits an existing single STS or VT and changes it to a test access point. When an editing command on TACC is executed, it assigns the STS for the first 2-way connection and STS=1 as the second 2-way connection.

Error conditions:

1. Sending this command to edit RVRTV or RVTM for the non-path protection configuration 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 path protection configuration connections) on that AID.

4. If sending this command to edit TACC on an AID with circuits or cross-connections, or if the port/VT has a test access point (TAP or TACC number), an error message (e.g., VT in Use) will be returned.

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

6. TACC creation is allowed on PCA for two-fiber and four-fiber BLSR.

7. TACC is not supported on G1000/MXP/TXP/ML1000-2 and ML100T-12 cards.

Section
ED-VT1 Description 

Category

STS and VT Paths

Security

Provisioning

Related Messages

RTRV-VT1

Input Format

ED-VT1:[<TID>]:<SRC>:<CTAG>:::[RVRTV=<RVRTV>,][RVTM=<RVTM>,]
[HOLDOFFTIMER=<HOLDOFFTIMER>,][TACC=<TACC>]:[<PST>],[<SST>];

where:

<SRC> is an access identifier from the "VT1_5" section

<RVRTV> identifies revertive mode which only applies to path protection configuration; valid values for <RVRTV> are shown in the "ON_OFF" section

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

<HOLDOFFTIMER> is an integer

<TACC> is the AID from the "TACC" section

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

ED-VT1:CISCO:VT1-2-1-3-1-4:123:::RVRTV=Y,RVTM=1.0,
HOLDOFFTIMER=2000,TACC=8:OOS,AINS;

Errors

Errors are listed in Table 7-30.


3.4.57 ENT-BLSR: Enter BLSR

This command creates either a two-fiber or four-fiber BLSR.

On successful creation of the BLSR, all cross-connections using the protection bandwidth of the BLSR will be automatically converted to PCA cross-connections.

<RINGID> defaults to AID number (# in the AID format of BLSR-#)

Input examples:

Four-fiber BLSR:

ENT-BLSR:PETALUMA:BLSR-2:123:::RINGID=2,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:;

Two-fiber BLSR:

ENT-BLSR:PETALUMA:BLSR-4:123:::RINGID=4,NODEID=6,MODE=2F,RVRTV=Y,RVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1:;

Error conditions:

1. If the system fails on getting IOR, a SDBE (Status, Internal Data Base Error) error message is returned.

2. If the NE returns nothing for the required BLSR (BLSR-# AID), a SRQN (Status, Invalid Request) error message is returned.

3. In RINGID is different from the AID number, a SDNC (Status, Input Ringid Is Not Consistent with NE Data) error message is returned.

4. Both <EASTPROT> and <WESTPROT> are optional, but required for 4-fiber BLSR creation.

5. Four-fiber BLSR is only supported on OC48 and OC192 cards. Two-fiber BLSR is only supported on OC12, OC48 and OC192 cards. Any attempt to create a BLSR on any other card combination results in a "BLSR Creation Failed" error message.

6. If sending this command to create 4-fiber BLSR on OC12 cards, or 2-fiber BLSR on OC3 cards, an IIAC (Input, Invalid work/prot port) error message will be returned.

7. If sending this command to create a BLSR on an NE that already has two BLSRs, a SRQN (BLSR Creation Failed) error message will be returned because one NE is only allowed to have two BLSRs in this release.

8. If sending this command to create a BLSR on a port with 1+1,a SRQN (BLSR Creation Failed) error message will be returned.

Section
ENT-BLSR Description 

Category

BLSR

Security

Provisioning

Related Messages

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

Input Format

ENT-BLSR:[<TID>]:<AID>:<CTAG>:::[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. "ALL" or "BLSR-ALL" AID is not allowed for editing BLSR. This command only supports a single BLSR AID. <AID> is the AID from the "BLSR" section

<RINGID> identifies the BLSR ring ID of the NE. It ranges from 0-9999. <RINGID> is an integer and the default value is "# of AID BLSR-#"

<NODEID> identifies the BLSR node ID of the NE and is an integer. It ranges from 0-31

<MODE> identifies the BLSR mode; valid values for <MODE> are shown in the "BLSR_MODE" section

<RVRTV> identifies the revertive mode and defaults to Y (revertive mode). Valid values for <RVRTV> are shown in the "ON_OFF" section. The default value is Y.

<RVTM> identifies the revertive time and defaults to 5.0. Valid values for <RVTM> are shown in the "REVERTIVE_TIME" section; the default value is 5.0

<SRVRTV> identifies the span revertive mode for 4-fiber BLSR only. <SRVRTV> defaults to Y (revertive mode); valid values are shown in the "ON_OFF" section. The default value is Y.

<SRVTM> identifies the span revertive time for 4-fiber BLSR only. <SRVTM> defaults to 5.0 and valid values are shown in the "REVERTIVE_TIME" section. The default value is 5.0

<EASTWORK> identifies the east working facility and is the AID from the "FACILITY" section

<WESTWORK> identifies the west working facility and is the AID from the "FACILITY" section

<EASTPROT identifies the east protecting facility and is the AID from the "FACILITY" section

<WESTPROT> identifies the west protecting facility and is the AID from the "FACILITY" section

Input Example

ENT-BLSR:PETALUMA:BLSR-2:123:::RINGID=2,NODEID=1,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

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

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

When a path protection configuration 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 2-way

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

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

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

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

from points: F1, F2

to points: T1

ENT-CRS-{STS_PATH}:[<TID>]:F1&F2,T1:<CTAG>::[<CCT>];

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

from point: F1

to points: T1, T2

ENT-CRS-{STS_PATH}:[<TID>]:F1,T1&T2:<CTAG>::[<CCT>];

c. The following command is used to create a 1-way subtending path protection configuration connection or 2-way subtending path protection configuration connection with:

from point: F1, F2

to points: T1, T2

ENT-CRS-{STS_PATH}:[<TID>]:F1&F2,T1&T2:<CTAG>::[<CCT>];

d. The following command is used to create a 2-way selector and bridge with:

from point: 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-{STS_PATH}:[<TID>]:F1&F2,S1&S2:<CTAG>::2WAY;

e. The following command is used to create a path protection configuration IDRI Cross-Connection:

ENT-CRS-{STS_PATH}:[<TID>]:A&B,C&D:<CTAG>::2WAYDC;

A-Path on ring X to which traffic from ring Y is bridged

B-Path on ring X to which traffic from the same ring is bridged

C-Path on ring Y to which traffic from ring X is bridged

D-Path on ring Y to which traffic from the same ring is bridged

A, B, C, and D have a positional meaning. Connection type 2WAYDC is used for path protection configuration IDRI cross-connections.

f. The following command is used to create a path protection configuration DRI Cross-Connection:

ENT-CRS-{STS_PATH}:[<TID>]:A&B,C:<CTAG>::2WAYDC;

A-Path on ring X to which traffic from ring Y is bridged

B-Path on ring X to which traffic from the same ring is bridged

C-Traffic to and from ring Y

A, B, C, and D have a positional meaning. Connection type 2WAYDC is used for path protection configuration DRI cross-connections.

5. All A&B AIDs in the TL1 cross-connection command are in the format of WorkingAID&ProtectAID.

6. To establish a cross-connection on a 2-fiber protection path or on a 4-fiber protection channel, the PCA connection type (1WAYPCA or 2WAYPCA) is required.

7. If you send a PCA cross-connection type on the non-PCA AIDs, the IIAC error message is returned.

8. If you send a non-PCA cross-connection type on the PCA AIDs, the IIAC error message is returned.

9. The facility AID is only valid on slots holding a G1000-4 card (ONS 15454).

10. The virtual facility AID (VFAC) is only valid on slots holding the ML-series card.

Section
ENT-CRS-<STS_PATH> Description 

Category

Cross Connections

Security

Provisioning

Related Messages

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

Input Format

ENT-CRS-<STS_PATH>:[<TID>]:<SRC>,<DST>:<CTAG>::[<CCT>]::
[<PST>],[<SST>];

where:

<SRC> is the AID from the "CrossConnectID" section

<DST> is the AID from the "CrossConnectID" section

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

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.59 ENT-CRS-VT1: Enter STS Cross Connection VT1

This command creates a VT1 cross connect. When a path protection configuration 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 2-way.

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

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

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

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

from points: F1, F2

to points: T1

ENT-CRS-VT1:[<TID>]:F1&F2,T1:<CTAG>::[<CCT>];

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

from point: F1

to points: T1, T2

ENT-CRS-VT1:[<TID>]:F1,T1&T2:<CTAG>::[<CCT>];

c. The following command is used to create a 1-way subtending path protection configuration connection or 2-way subtending path protection configuration connection with:

from point: F1, F2

to points: T1, T2

ENT-CRS-VT1:[<TID>]:F1&F2,T1&T2:<CTAG>::[<CCT>];

d. The following command is used to create a 2-way 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:[<TID>]:F1&F2,S1&S2:<CTAG>::2WAY;

5. All a&b AIDs in the TL1 cross-connection command are in the format of WorkingAID&ProtectAID.

6. To establish a cross-connection on a 2-fiber protection path or on a 4-fiber protection channel, the PCA connection type (1WAYPCA or 2WAYPCA) is required.

7. If you send a PCA cross-connection type on the non-PCA AIDs, an IIAC error message is returned.

8. If you send a non-PCA cross-connection type on the PCA AIDs, an IIAC error message is returned.

9. 1-way monitor cross-connects cannot be created. 1WAYMON value for CCT parameter is not supported. However, such cross-connects can be retrieved through the RTRV-CRS-VT1 and RTRV-CRS commands.

Section
ENT-CRS-VT1 Description 

Category

Cross Connections

Security

Provisioning

Related Messages

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

Input Format

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

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

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

<SST> secondary state; valid values for <SST> are shown in the "SST" section

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.60 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 facility 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 a 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. The RVRTV parameter is not valid for 1:N protection.

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

Both ENT-EQPT and ED-EQPT commands can provision all working AIDs (1-5) together for 1:N by using listed AIDs.

The ENT-EQPT command provisions a new card and adds it to the protection group. The ED-EQPT command adds the already provisioned cards to the protection group.

Protect AID should already be provisioned for either command because protection group parameters are not supported for the protect AID.

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 a 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.

Notes:

1. 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.

2. Sending this command to provision a DS3N card on Slot {1,2,4,5,6,12,13,14,16,17}, the DS3 card type is presented.

3. Sending this command to provision a DS1N card on Slot-{1,2,4,5,6,12,13,14,16,17}, the DS1 card type is presented.

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

1. AID sent to a 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 (ONS 15454).

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 an 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

<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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

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. In this release, 1+1 provisioning between an OC12-4 card and an OC12 card is allowed but is not correct. This provisioning will not be allowed in a future release.

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>
RTRV-PROTNSW-<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 AID of the protection group, it is a string and can have a maximum length of 32 characters.

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

<RVTM> identifies a 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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.62 ENT-FFP-CLNT: Enter Facility Protection Group Client

This command creates Y cable protection on client facilities

Notes:

1. A Y cable protection group can be created between the client ports of either two TXP cards or two MXP cards.

2. Y cable protection cannot be part of a regeneration group.

3. Only the working ports can be provisioned with DCC and timing reference (if DCC is present on a card, tat card cannot be a protect card).

4. The cards must have the same payload.

See the "Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards" section on page 1-8 for specific MXP/TXP card provisioning rules.

Section
ENT-FFP-CLNT Description 

Category

DWDM

Security

Provisioning

Related Messages

RTRV-FFP-CLNT
ED-FFP-CLNT
RTRV-DWDM
ED-DWDM
OPR-PROTNSW-CLNT
RLS-PROTNSW-CLNT
RTRV-COND-CLNT
RTRV-ALM-CLNT

Input Format

ENT-FFP-CLNT:[<TID>]:<WORKAID>,<PROTAID>:<CTAG>:::
[PROTTYPE=<PROTTYPE>,][PROTID=<PROTID>,][RVRTV=<RVRTV>,]
[RVTM=<RVTM>,][PSDIRN=<PSDIRN>][:];

where:

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

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

<PROTTYPE> identifies the type of facility protection; valid values are shown in the "PROTTYPE" section

<PROTID> protection group identifier (protection group name). Defaults to the protecting port AID of the protection group. Is is a string and can have a maximum length of 32 characters; <PROTID> is a string

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

<RVTM> identifies the revertive time. Defaults to 5.0 minutes; valid values are shown in the "REVERTIVE_TIME" section

<PSDIRN> identifies the switching mode and defaults to UNI. Release 4.0 MXP/TXP cards do not support BI-DIRECTIONAL switching. Valid values for <PSDIRN> are shown in the "UNI_BI" section

Input Example

ENT-FFP-CLNT:CISCO:FAC-1-1,FAC-2-1:100:::PROTTYPE=Y-CABLE,
PROTID=DC-METRO-1,RVRTV=Y,RVTM=1.0,PSDIRN=BI;

Errors

Errors are listed in Table 7-30.


3.4.63 ENT-UCP-CC: Enter Unified Control Plane Control Channel

(Cisco ONS 15454 only)

This command creates a UCP IP control channel.

If the CCTYPE is SCCC, the SDCC of the port should be created.

The LMP Hello parameters, CRC mode and MTU can be left NULL. The defaults will be assigned by the node.

The UCP remote cannot be provisioned by the user. The local CCID will be allocated by the node.

If the CCTYPE is routed, the remote IPCC defaults to its neighbor's nodeID.

Examples:

ENT-UCP-CC::CC-12:CTAG:::NBRIX=1,CCTYPE=SDCC,PORT=FAC-6-1,
LOCALCCID=12,LOCALIPCC=172.20.209.73,REMOTEIPCC=192.168.100.18,
LMPHELLOINT=2,LMPHELLODEADINT=6,MTU=1500,CRCMD=32-BIT;

ENT-UCP-CC::CC-15:CTAG:::NBRIX=8,CCTYPE=ROUTED,LOCALCCID=15,
LOCALIPCC=172.20.209.73,REMOTEIPCC=192.168.100.18,LMPHELLOINT=2,
LMPHELLODEADINT=6,MTU=1500,CRCMD=16-BIT;

ENT-UCP-CC::CC-16:CTAG:::NBRIX=8,CCTYPE=ROUTED,LOCALCCID=16,
LOCALIPCC=172.20.209.73,LMPHELLOINT=2,LMPHELLODEADINT=6,
MTU=1500,CRCMD=16-BIT;

Notes:

1. If this command is sent twice, or input with invalid data, a SRQN (Status, Invalid Request) error message is returned.

2. If sending this command to provision MTU, CRCMD, or both while the IPCC type is routed (CCTYPE=ROUTED), an IIAC (Routed CC Is Not Allowed to Provision MTU and CRCMD) error message is returned.

3. The LMPHELLODEADINT interval has to be larger than the hello interval and is normally set to 3 times the hello interval. Its range is 3 seconds to 30 seconds with a default of 15 seconds.

4. If sending this command to provision a ROUTED IPCC no matter if the neighbor discovery (NDEN) is Enabled or Disabled, the REMOTEIPCC has to be specified by the user with non zeros, otherwise, an error message will be returned.

5. If sending this command to provision an SDCC IPCC while the neighbor discovery (NDEN=Y) is Enabled, the REMOTEIPCC defaults to 0.0.0.0, and the user is not allowed to specify REMOTEIPCC, otherwise, and error message (SROF, Cannot specify Remote IPCC for SDCC-IPCC when ND is enabled) will be returned.

6. If sending this command to provision an SDCC IPCC while the neighbor discovery (NDEN=N) is Disabled, the REMOTEIPCC defaults to its neighbor's node ID (IP address).

7. If sending this command to provision an SDCC IPCC with a complete result, the SDCC of the specified SONET line is created (or enabled) automatically with a DB change reporting (if the DB change report is enabled).

8. If sending this command to provision more than 16 IPCC over one NE, a (Cannot create IPCC. Max. number (16) reached) error message is returned.

Section
ENT-UCP-CC Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC REPT ALM UCP
DLT-UCP-IF REPT EVT UCP
DLT-UCP-NBR RTRV-ALM-UCP
ED-UCP-CC RTRV-COND-UCP
ED-UCP-IF RTRV-UCP-CC
ED-UCP-NBR RTRV-UCP-IF
ED-UCP-NODE RTRV-UCP-NBR
ENT-UCP-IF RTRV-UCP-NODE
ENT-UCP-NBR

Input Format

ENT-UCP-CC:[<TID>]:[<AID>]:<CTAG>:::[NBRIX=<NBRIX>,]
[CCTYPE=<CCTYPE>,][PORT=<PORT>,][LOCALCCID=<LOCALCCID>,]
[LOCALIPCC=<LOCALIPCC>,][REMOTCCID=<REMOTECCID>,]
[REMOTEIPCC=<REMOTEIPCC>,][LMPHELLOINT=<LMPHELLOINT>,]
[LMPHELLODEADINT=<LMPHELLODEADINT>,][MTU=<MTU>,]
[CRCMD=<CRCMD>,][TUNMD=<TUNMD>][:];

where:

<AID> indicates an individual IPCC ID and is the AID from the "IPCC" section. The default value is "local IPCC ID"

<NBRIX> indicates a neighbor within the local node and is an integer

<CCTYPE> indicates the type of the control channel; valid values for <CCTYPE> are shown in the "UCP_IPCC_TYPE" section

<PORT> indicates the port which the control channel is configured, while the CCTYPE is the type of SDCC. <PORT> is the AID from the "FACILITY" section and the default value is "applicable only if it is SDCC type"

<LOCALCCID> indicates the local control channel ID and is an integer. The default value is "local UCP node id"

<LOCALIPCC> indicates the local IP address of the control channel and is a string. The default value is "local node id's node name"

<REMOTECCID> indicates the local control channel ID and is an integer. The default value is "zero (0) - undefined until discovery by LMP"

<REMOTEIPCC> indicates the remote IP address of the control channel and is a string. The default value is "0.0.0.0 - undefined for SDCC IPCC and discovered by LMP"

<LMPHELLOINT> indicates the LMP (line management protocol) interval (in milliseconds). It is the time between hello messages sent by this node, defaults to 5 (with the range of 1-10). <LMPHELLOINT> is an integer and the default value is "5 seconds - (1-10 seconds)"

<LMPHELLODEADINT> indicates the control channel time-out interval (in milliseconds) by the neighbor if the neighbor does not receive the hello message, and defaults to 15 (with the range of 3-30). This interval has to be at least as large as the hello interval and is normally set to 3 times the hello interval. It's range is 3-30 seconds with a default of 15 seconds. <LMPHELLODEADINT> is an integer and it's default value is "15 seconds - (3-30 seconds)"

<MTU> indicates the MTU size of this control channel. <MTU> is an integer and it's default value is "1500 bytes"

<CRCMD> indicates the CRC mode for this control channel. It is applicable to IPCCs in SDCC type. Valid values for <CRCMD> are shown in the "UCP_CRC_MODE" section

<TUNMD> indicates the IP Tunneling option. It defaults to disabled and valid values are shown in the "UCP_CC_TUN_MD" section

Input Example

ENT-UCP-CC:CISCO:CC-9:CTAG:::NBRIX=8,CCTYPE=SDCC,PORT=
FAC-2-1,LOCALCCID=9,LOCALIPCC=172.20.209.162,REMOTCCID=2,
REMOTEIPCC=172.20.209.73,LMPHELLOINT=1,LMPHELLODEADINT=5,
MTU=1500,CRCMD=16-BIT,TUNMD=DISABLED;

Errors

Errors are listed in Table 7-30.


3.4.64 ENT-UCP-IF: Enter Unified Control Plane Interface

(Cisco ONS 15454 only)

This command creates a UCP interface.

The CCID can be set to zero to request the use of any control channel to the neighbor for this UCP interface/data link.

The local interface ID (LOCALIFID) is used by LMP/RSVP (Line Management Protocol/Resource Reservation Protocol). If zero is passed in as the local Interface ID of the data link, then the node assigns a value for it. If the user specifies a non-zero value, then the node checks if that Interface ID is available and uses it.

If the UCP interface/data link control channel type is SDCC type, the local interface ID should be the same as CCID. Otherwise, an error message will be returned by the node.

The remote interface ID is allowed to be unspecified (by passing zero) if the NDEN is Enabled and there is a SDCC IPCC specified for this UPC Interface with the same Interface Index, or when Routed IPCC is used for this data link.

Examples:

ENT-UCP-IF::FAC-2-3:CTAG:::NBRIX=8,CCID=2,LOCALIFID=0,REMOTEIFID=4, TNATYPE=IPV4,TNAADDR=172.20.209.162,CORENETWORKID=3;

ENT-UCP-IF::FAC-2-4:CTAG:::NBRIX=8,CCID=1,LOCALIFID=0,REMOTEIFID=4,
TNATYPE=NSAP,TNAADDR=0102030405060708090A0B0C0D0E0F1011121314, CORENETWORKID=3;


Note If this command is sent twice, or inputs invalid data, a SRQN (Status, Invalid Request) error message is returned.


Section
ENT-UCP-IF Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC REPT ALM UCP
DLT-UCP-IF REPT EVT UCP
DLT-UCP-NBR RTRV-ALM-UCP
ED-UCP-CC RTRV-COND-UCP
ED-UCP-IF RTRV-UCP-CC
ED-UCP-NBR RTRV-UCP-IF
ED-UCP-NODE RTRV-UCP-NBR
ENT-UCP-CC RTRV-UCP-NODE
ENT-UCP-NBR

Input Format

ENT-UCP-IF:[<TID>]:<AID>:<CTAG>:::[NBRIX=<NBRIX>,][CCID=<CCID>,]
[LOCALIFID=<LOCALIFID>,][REMOTEIFID=<REMOTEIFID>,]
[TNATYPE=<TNATYPE>,][TNAADDR=<TNAADDR>,]
[CORENETWORKID=<CORENETWORKID>][:];

where:

<AID> indicates the interface port index of the data link and is the AID from the "FACILITY" section

<NBRIX> indicates a neighbor within the local node and is an integer

<CCID> indicates the control channel ID. It can be set to zero to request the use of any control channel to the neighbor for this UCP interface/ data link. <CCID> is an integer. A null value defaults to "any control channel to the neighbor"

<LOCALIFID> indicates the local interface ID used by LMP/RSVP (Line Management Protocol/Resource reservation Protocol). If this attribute value is assigned by the UI, it will be ignored. <LOCALIFID> is an integer

<REMOTEIFID> indicates the remote interface ID on the neighbor's side. If this attribute value is passed by UI, it will be ignored. <REMOTEIFID> is an integer

<TNATYPE> indicates the TNA (Transport Network Administered) type and defaults to IPv4. Valid values for <TNATYPE> are shown in the "UCP_TNA_TYPE" section. The default value is "IPv4"

<TNAADDR> indicates the TNA (Transport Network Administered) IP address and defaults to IPv4 0.0.0.0. <TNAADDR> is a string. The default value is "0"

<CORENETWORKID> indicates the core network ID and defaults to one (1). <CORENETWORKID> is an integer and the default value is "1"

Input Example

ENT-UCP-IF:CISCO:FAC-2-1:CTAG:::NBRIX=12,CCID=16,LOCALIFID=16,
REMOTEIFID=0,TNATYPE=IPV4,TNAADDR=172.20.209.162,
CORENETWORKID=7;

Errors

Errors are listed in Table 7-30.


3.4.65 ENT-UCP-NBR: Enter Unified Control Plane Neighbor

(Cisco ONS 15454 only)

This command creates a UCP neighbor.

The default value of the node name can be overwritten by the TL1 user to a string in a maximum size of 20 characters. If the node name includes non-identified TL1 characters (e.g. space), the text string format with the double quotes is required.

Notes:

1. If this command is sent twice or inputs invalid data, a SRQN (Status, Invalid Request) error message is returned.

2. If sending this command without neighbor node name in the "NAME" field, an IIAC (Neighbor Name Can Not be Empty) error message is returned.

3. If sending this command with nodeid while the neighbor discovery is enabled (NDEN=Y), an IIAC (NODEID Is Not Allowed If NDEN Is Enabled) error message is returned.

4. If sending this command to set the hello interval while the RSVP hello is disabled, an IIAC (HELLOINT Is Not Allowed If HELLOEN Is Disabled) error message is returned.

5. If provisioning a neighbor with disabled neighbor discovery (NDEN=N), and NULL nodeid, a SROF (UCP Neighbor's NodeID cannot be null when Neighbor Discovery is disabled) is returned.

6. If sending this command to create a neighbor with the neighbor node name string longer than 64 characters, an IIAC (Node Name Too Long) error message is returned.

Section
ENT-UCP-NBR Description 

Category

UCP

Security

Provisioning

Related Messages

DLT-UCP-CC REPT ALM UCP
DLT-UCP-IF REPT EVT UCP
DLT-UCP-NBR RTRV-ALM-UCP
ED-UCP-CC RTRV-COND-UCP
ED-UCP-IF RTRV-UCP-CC
ED-UCP-NBR RTRV-UCP-IF
ED-UCP-NODE RTRV-UCP-NBR
ENT-UCP-CC RTRV-UCP-NODE
ENT-UCP-IF

Input Format

ENT-UCP-NBR:[<TID>]:<AID>:<CTAG>:::[NBRIX=<NBRIX>,]
[NODEID=<NODEID>,]NAME=<NAME>,[NDEN=<NDEN>,]
[HELLOEN=<HELLOEN>,][HELLOINT=<HELLOINT>,]
[REFREDEN=<REFREDEN>,][NUMRXMTS=<NUMRXMTS>][:];

where:

<AID> indicates an individual neighbor index of the UCP. An available neighbor index will be assigned internally while sending this command without AID; <AID> is the AID from the "NBR" section

<NBRIX> indicates a neighbor within the local node. <NBRIX > is an integer and the default value is "the number of the AID (NBR-#). Or undefined zero (0)"
<NODEID> indicates the neighbor node ID as received in RSVP, LMP messages from that node and is a string

<NAME> indicates the neighbor node name, it has to be specified by the user. If the node name includes non-identified TL1 characters (e.g. space), the text string format with the double quotes is required. <NAME> is a string

<NDEN> indicates if the neighbor discovery is enabled or not for this neighbor and it defaults to enable (Y). The default value is "Y". Valid values for <NDEN> are shown in the "ON_OFF" section

<HELLOEN> indicates if the RSVP hello is enabled to this neighbor or not and defaults to enable (Y). The default value is "Y". Valid values for <HELLOEN> are shown in the "ON_OFF" section

<HELLOINT> indicates the interval between hello messages to neighbor and defaults to 5. The default value is "5". <HELLOINT> is an integer

<REFREDEN> indicates if the refresh reduction is enabled or not and defaults to enable (Y). The default value is "Y". Valid values for <REFREDEN> are shown in the "ON_OFF" section

<NUMRXMTS> indicates the maximum number of retransmits of each message and defaults to 3. The default value is "3". <NUMRXMTS> is an integer

Input Example

ENT-UCP-NBR:CISCO:NBR-8:CTAG:::NBRIX=8,NODEID=192.168.100.52,
NAME=NODE-A,NDEN=Y,HELLOEN=Y,HELLOINT=20,REFREDEN=Y,
NUMRXMTS=3;

Errors

Errors are listed in Table 7-30.


3.4.66 ENT-USER-SECU: Enter User Security

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 default 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 maintenance. The default 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 default 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 default idle time for Superuser is 15 minutes.

Notes:

1. Passwords are masked for the following security commands: ACT-USER, ED-PID, ENT-USER-SECU and ED-USER-SECU. Access to a TL1 session via any means will have the password masked. The CTC Request History and Message Log will also show the masked commands. When a password-masked command is re-issued by double-clicking the command from CTC Request History, the password will still be masked in the CTC Request History and Message Log. The actual password that was previously issued will be sent to the NE. To use a former command as a template only, single-click the command in CTC Request History. The command will be placed in the Command Request text box, where you can edit the appropriate fields prior to re-issuing it.

2. The <UID> can be any combination of up to 10 alphanumeric characters.

3. The <PID> is a string of up to 10 characters where at least 2 characters are non-alphabetic with at least one special character (+, %, or #).

4. Although the CTC allows both <UID> and <PID> of up to 20 characters, the CTC-entered users (<UID> and <PID>) may not be valid TL1 users (e.g. if issuing an ACT-USER command and using the CTC-entered <UID> that is greater than 10 characters long, TL1 will respond with DENY (Can't Login) error message.

5. The TL1 password security is enforced as follows:

a. The password <PID> cannot be the same as or contain the userid (UID), for example, if the userid is CISCO25 the password cannot be CISCO25#.

b. The password <PID> must have one non-alphabetic and one special (+, %, or #) character.

c. There is no password <PID> toggling; for example, if the current password is CISCO25#, the new password cannot be CISCO25#

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
RTRV-USER-SECU

Input Format

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

where:

<UID> is the user identifier. The minimum <UID> size is 6, the maximum <UID> size is 10; <UID> is a string.

<PID> is a string.

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

Input Example

ENT-USER-SECU:PETALUMA:CISCO15:123::PSWD11#,,MAINT;

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

This command exercises 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_BLSR> 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>
RTRV-PROTNSW-<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. <AID> must not be null.

<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. A null value is equivalent to ALL.

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.68 INH-MSG-ALL: Inhibit Message All

This command inhibits all REPT ALM and REPT EVT autonomous messages 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 is reported.


Section
INH-MSG-ALL Description 

Category

System

Security

Retrieve

Related Messages

ALW-MSG-ALL RTRV-HDR
APPLY RTRV-INV
COPY-RFILE RTRV-MAP-NETWORK
ED-DAT RTRV-NE-GEN
ED-NE-GEN RTRV-NE-IPMAP
ED-NE-SYNCN RTRV-NE-SYNCN
INIT-SYS RTRV-TOD
REPT EVT FXFR SET-TOD

Input Format

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

Input Example

INH-MSG-ALL:PETALUMA::550;

Errors

Errors are listed in Table 7-30.


3.4.69 INH-MSG-DBCHG: Inhibit Database Change Message

This command disables REPT DBCHG.

Section
INH-MSG-DBCHG Description 

Category

Log

Security

Retrieve

Related Messages

ALW-MSG-DBCHG
REPT DBCHG
RTRV-LOG

Input Format

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

Input Example

INH-MSG-DBCHG:CISCO::123;

Errors

Errors are listed in Table 7-30.


3.4.70 INH-MSG-SECU: Inhibit Message Security

This command inhibits the REPT EVT SECU and REPT ALM SECU messages.

Section
INH-MSG-SECU Description 

Category

Security

Security

Superuser

Related Messages

ACT-USER ED-USER-SECU
ALW-MSG-SECU ENT-USER-SECU
CANC REPT EVT SECU
CANC-USER REPT EVT SESSION
DLT-USER-SECU RTRV-USER-SECU
ED-PID

Input Format

INH-MSG-SECU:[<TID>]::<CTAG>;

Input Example

INH-MSG-SECU:PETALUMA::123;

Errors

Errors are listed in Table 7-30.


3.4.71 INH-PMREPT-ALL: Inhibit Performance Report All

This command inhibits all scheduled PM reporting. The inhibitance of the PM reporting is session-based, which means the command is only effective to the TL1 session that issues this command. By default, the scheduled PM reporting is inhibited by a TL1 session.

A TL1 session for which PM reports are inhibited will include an INHMSG-PMREPT condition when issuing TL1 command RTRV-COND-ALL.

Section
INH-PMREPT-ALL Description 

Category

Performance

Security

Retrieve

Related Messages

ALW-PMREPT-ALL RTRV-PMSCHED-ALL
INIT-REG-<MOD2> RTRV-TH-<MOD2>
REPT PM <MOD2> SCHED-PMREPT-<MOD2>
RTRV-PM-<MOD2> SET-PMMODE-<STS_PATH>
RTRV-PMMODE-<STS_PATH> SET-TH-<MOD2>
RTRV-PMSCHED-<MOD2>

Input Format

INH-PMREPT-ALL:[<TID>]::<CTAG>;

Input Example

INH-PMREPT-ALL:NE-NAME::123;

Errors

Errors are listed in Table 7-30.


3.4.72 INH-SWDX-EQPT: Inhibit Switch Duplex Equipment

(Cisco ONS 15454 only)

This command inhibits automatic or manual switching on a system containing duplex equipment. Use the ALW-SWDX 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 applies for XC, XCVT, or XC10G equipment units only in this release.

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

Section
INH-SWDX-EQPT Description 

Category

Equipment

Security

Maintenance

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/XC10G equipment AID (Slot 8 or Slot 10) from the "EQPT" section

Input Example

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

Errors

Errors are listed in Table 7-30.


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

(Cisco ONS 15454 only)

This command inhibits 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+/TCC2 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+/TCC2 or XC/XCVT/XC10G) 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

Maintenance

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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

(Cisco ONS 15454 only)

This command inhibits 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 lock-out 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+/TCC2 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+/TCC2 or XC/XCVT/XC10G) 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 SPAC (Status, Protection unit Active) 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

Maintenance

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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

This command initializes the performance monitoring (PM) registers.

Notes:

1. The time period is always the current time period, and the previous time period counts are not cleared; therefore, both <MONDAT> and <MONTM> are not supported in this command.

2. Both transmit and receive directions are allowed in DS1, other cards only support the receive direction.

Section
INIT-REG-<MOD2> Description 

Category

Performance

Security

Maintenance

Related Messages

ALW-PMREPT-ALL
INH-PMREPT-ALL
INIT-REG-G1000
REPT PM <MOD2>
RTRV-PM-<MOD2>
RTRV-PMMODE-<STS_PATH>
RTRV-PMSCHED-<MOD2>
RTRV-PMSCHED-ALL
RTRV-TH-<MOD2>
SCHED-PMREPT-<MOD2>
SET-PMMODE-<STS_PATH>
SET-TH-<MOD2>

Input Format

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

where:

<AID> is the access identifier. All the STS, VT1, 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, valid values for <LOCN> are shown in the "LOCATION" section

<DIRN> is the direction of PM relative to the entity identified by the AID. <DIRN> defaults to ALL, which means that the command initializes all the registers irrespective of the PM direction. Valid values for <DIRN> are shown in the "DIRECTION" 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. The default value is 15-MIN.

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.76 INIT-SYS: Initialize System

This command initializes 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+/TCC2 should be up and running fully standby before this command is sent on the active TCC+/TCC2 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-HDR
APPLY RTRV-INV
COPY-RFILE RTRV-MAP-NETWORK
ED-DAT RTRV-NE-GEN
ED-NE-GEN RTRV-NE-IPMAP
ED-NE-SYNCN RTRV-NE-SYNCN
INH-MSG-ALL RTRV-TOD
REPT EVT FXFR 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

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.77 OPR-ACO-ALL: Operate Alarm Cutoff All

This command cuts off the office audible alarm indication without changing the local alarm indications.

This command does not have any effect on future alarms at the NE, it directs the NE to provide conditioning only on those alarms that are currently active.

The ACO retires the Central Office (CO) alarm audible indicators without clearing the indicators that show the trouble still exists. There is no need for a RLS-ACO command.

Section
OPR-ACO-ALL Description 

Category

Environment 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
RLS-EXT-CONT SET-ATTR-CONT
RTRV-ALM-ENV SET-ATTR-ENV
RTRV-ATTR-CONT

Input Format

OPR-ACO-ALL:[<TID>]::<CTAG>;

Input Example

OPR-ACO-ALL:CISCO::123;

Errors

Errors are listed in Table 7-30.


3.4.78 OPR-EXT-CONT: Operate External Control

This command operates an external control and closes the external control contact. The control can be operated momentarily or continuously.

Notes:

1. The duration has two values in this release:

MNTRY: Momentary duration

CONTS: Continuos duration

2. In an automatic state, the contact could be opened or closed depending on the provisioned trigger.

3. RLS-EXT-CONT changes the state to automatic. Therefore, issuing an OPR-EXT-CONT command when the control is manually open and then issuing a RLS-EXT-CONT will not revert the state back to Manual Open.

4. A NULL value for the duration parameter defaults to MNTRY in this release.

5. The RLS-EXT-CONT is not allowed during the MNTRY duration, the command is allowed for the CONTS duration. The length of the MNTRY duration is set to be 2 seconds on Cisco ONS 15454.


Caution Do not turn on external controls that activate a potential danger; such as, sprinklers or other controls connected to possibly hazardous systems or equipment.

Section
OPR-EXT-CONT Description 

Category

Environment Alarms and Controls

Security

Maintenance

Related Messages

OPR-ACO-ALL 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
RTRV-ATTR-CONT

Input Format

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

where:

<AID> is the access identifier environment AID 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. A null value is equivalent to ALL.

Valid values for <DUR> are shown in the "DURATION" section. A null value is equivalent to ALL.

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.79 OPR-LPBK-<MOD2>: Operate Loopback (CLNT, DS1, EC1, OC12, OC192, OC3, OC48, OCH, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, VT1)

See Table 4-11 for supported modifiers by platform.

This command operates a signal loopback on an I/O card or on a cross-connect.

The optional [<LPBKTYPE>] defaults to FACILITY in this command if it is given to a port entity. It defaults to CRS if given to an STS entity.

Notes:

1. The value CRS for the LPBKTYPE parameter is applicable only for the STS modifier. The FACILITY and TERMINAL values are applicable to the ports.

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

3. Loopbacks are only allowed to be setup if the port/interface/STS_PATH is in OOS-MT or in OOS-AINS state.

4. Cross-connect loopbacks cannot be applied:

to the destination end of a 1WAY cross-connects

to non-optical boards

to VT1.5

if a a terminal/facility loopback is already applied

on a protect card in 1+1 (working mode)

5. A cross-connect loopback can be applied only on one STS path of a cross-connect.

Section
OPR-LPBK-<MOD2> Description 

Category

Testing

Security

Maintenance

Related Messages

RLS-LPBK-<MOD2>

Input Format

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

where:

<SRC> is an access identifier from the "DS1" section. Valid values for AID are facility, DS1, and STS.

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

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

This command initiates 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+/TCC2 or XC/XCVT/XC10G) 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 SROF (Protection Switching Failed) error message should be received.

5. When sending this command to a protect card that is failed or missing, the SROF (Protection Switching 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 get the protection switching state (manual, lockout, forced), use the RTRV-COND-ALL or RTRV-ALM-ALL commands.

9. If the far end of the same span has a higher protection switching state, for example, the near end is under Manual protection switching state, the far end is in the Forced protection switching state, the near end protection switching state will be preemptive and shown as APS_CLEAR switching state over the CTC/TL1 interface. The RTRV-PROTNSW-OCN command is used to retrieve the current switching state of a SONET line.

10. If sending this command with EXERCISE or APS_CLEAR switch operation, an error SROF (Invalid Protection Switch Operation) will be returned because these operations are not valid according to GR-833-CORE.

The EX-SW-<OCN_BLSR> is the correct command to perform the EXERCISE switch over the BLSR line.

11. Protection switch will be denied if SD/SF is already present on the switching path. If SD/SF is generated on the switching path after the switch is performed, the switch will be overwritten by the APS_CLEAR state. This does not apply for lockout of protection and forced switch which have higher priority than SD/SF.

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>
RTRV-PROTNSW-<OCN_TYPE>

Input Format

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

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 "SW" section

Valid values for <SWITCHTYPE> are shown in the "SWITCH_TYPE" section


Caution MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK do not apply to BLSR protection switching.

Input Example

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

Errors

Errors are listed in Table 7-30.


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

See Table 4-11 for supported modifiers by platform.

This command initiates a SONET path protection (path protection configuration) 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 path protection configuration configuration only.

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

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

4. To get the protection switching state (manual, lockout, forced), use the RTRV-COND-ALL or RTRV-ALM-ALL commands.

5. The GR-1400 does not allow the LOCKOUT_OF_WORKING on the path protection configuration WORKING path/AID. Sending this command on the path protection configuration WORKING path, a SROF (Invalid Protection Switch Operation) is returned.

6. If sending this command with EXERCISE or APS_CLEAR switch operation, an error SROF (Invalid Protection Switch Operation) will be returned because these operations are not valid according to GR-833-CORE.

7. Protection switch will be denied if SD/SF is already present on the switching path. If SD/SF is generated on the switching path after the switch is performed, the switch will be overwritten by the APS_CLEAR state. This does not apply for lockout of protection and forced switch which have higher priority than SD/SF.

Section
OPR-PROTNSW-<STS_PATH> Description 

Category

path protection configuration switching

Security

Maintenance

Related Messages

OPR-PROTNSW-VT1
REPT SW
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1
RTRV-PROTNSW-<STS_PATH>
RTRV-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 "SW" section

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.82 OPR-PROTNSW-CLNT: Operate Protection Switch Client

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

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

Manual Switch of Protection Line (to Working Line) -- If the AID identifies the protection line, then 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 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 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.

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.

If this command is used against pre-provisioned cards, the SROF (Protection Switching Failed) error will be returned.

Section
OPR-PROTNSW-CLNT Description 

Category

DWDM

Security

Maintenance

Related Messages

RLS-PROTNSW-CLNT
RTRV-FFP-CLNT
ED-FFP-CLNT
ED-DWDM
RTRV-DWDM
RTRV-COND-CLNT
RTRV-ALM-CLNT
RTRV-FFP-CLNT
ED-FFP-CLNT
ENT-FFP-CLNT

Input Format

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

where:

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

Valid values for <SC> are shown in the "SW" section

Input Example

OPR-PROTNSW-CLNT:CISCO:FAC-1-1:100::FRCD;

Errors

Errors are listed in Table 7-30.


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

This command initiates a SONET path protection 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 path protection configuration only.

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

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

4. To get protection switching state (manual, lockout, forced), use the RTRV-COND-ALL or RTRV-ALM-ALL commands.

5. The GR-1400 does not allow the LOCKOUT_OF_WORKING on the path protection configuration WORKING path/AID. Sending this command on the path protection configuration WORKING path, a SROF (Invalid Protection Switch Operation) is returned.

6. If sending this command with EXERCISE or APS_CLEAR switch operation, an error SROF (Invalid Protection Switch Operation) will be returned because these operations are not valid according to GR-833-CORE.

Sending this command with CLEAR switch operation is not a valid operation per GR-833, the NE will clear the state of the line. This behavior will be corrected in a future release.

Section
OPR-PROTNSW-VT1 Description 

Category

path protection configuration switching

Security

Maintenance

Related Messages

OPR-PROTNSW-<STS_PATH>
REPT SW
RLS-PROTNSW-<STS_PATH>
RLS-PROTNSW-VT1
RTRV-PROTNSW-<STS_PATH>
RTRV-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 "SW" section

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.84 OPR-SYNCNSW: Operate Synchronization Switch

This command initiates a switch to the reference specified by the synchronization reference number if the reference supplied is valid.

For manual types of switches the reference to which you want to switch should be of the same quality as the active reference source, otherwise the command will fail.

If you want to switch to a reference of lower quality, use the forced switch option.

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

Once the switch is effective, a minor alarm "MANSWTOPRI" (Manual Switch to Primary or Secondary Reference...) will be raised for Manual switches and alarms like "FRCDSWTOPRI" (Forced Switch to Primary or Secondary Reference...) will be raised for Forced switches.

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 BITS RTRV-NE-SYNCN
REPT EVT SYNCN RTRV-SYNCN
RLS-SYNCNSW

Input Format

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

where:

<AID> is the access identifier from the "SYNC_REF" section. THe default value is SYNC-NE.

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

<SC> is the switch command to be issued. Only manual (MAN) and forced (FRCD) switches are allowed for this command. Valid values for <SC> are shown in the "SW" section. The default value is "MAN"

Input Example

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

Errors

Errors are listed in Table 7-30.


3.4.85 REPT ALM <MOD2ALM>: Report Alarm (CLNT, DS1, E100, E1000, EC1, FSTE, G1000, GIGE, OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VT1)

See Table 4-11 for supported modifiers by platform.

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-EQPT
REPT ALM COM RTRV-ALM-RING
REPT ALM ENV RTRV-ALM-SYNCN
REPT ALM EQPT RTRV-ALM-UCP
REPT ALM RING RTRV-COND-<MOD2ALM>
REPT ALM SYNCN RTRV-COND-ALL
REPT ALM UCP RTRV-COND-BITS
REPT EVT COM RTRV-COND-ENV
RTRV-ALM-<MOD2ALM> RTRV-COND-EQPT
RTRV-ALM-ALL RTRV-COND-RING
RTRV-ALM-BITS RTRV-COND-SYNCN
RTRV-ALM-ENV RTRV-COND-UCP

Output Format

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

where:

<AID> is the access identifier from the "ALL" 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

<DESC> is the condition description; <DESC> 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

Output Example

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


3.4.86 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-BITS
ED-NE-SYNCN RTRV-ALM-ENV
ED-SYNCN RTRV-ALM-EQPT
OPR-SYNCNSW RTRV-ALM-RING
REPT ALM <MOD2ALM> RTRV-ALM-SYNCN
REPT ALM COM RTRV-ALM-UCP
REPT ALM ENV RTRV-BITS
REPT ALM EQPT RTRV-COND-<MOD2ALM>
REPT ALM RING RTRV-COND-ALL
REPT ALM SYNCN RTRV-COND-BITS
REPT ALM UCP RTRV-COND-ENV
REPT EVT BITS RTRV-COND-EQPT
REPT EVT COM RTRV-COND-RING
REPT EVT SYNCN RTRV-COND-SYNCN
RLS-SYNCNSW RTRV-COND-UCP
RTRV-ALM-<MOD2ALM> RTRV-NE-SYNCN
RTRV-ALM-ALL RTRV-SYNCN

Output Format

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

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

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

Output Example

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


3.4.87 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-EQPT
REPT ALM BITS RTRV-ALM-RING
REPT ALM ENV RTRV-ALM-SYNCN
REPT ALM EQPT RTRV-ALM-UCP
REPT ALM RING RTRV-COND-<MOD2ALM>
REPT ALM SYNCN RTRV-COND-ALL
REPT ALM UCP RTRV-COND-BITS
REPT EVT COM RTRV-COND-ENV
RTRV-ALM-<MOD2ALM> RTRV-COND-EQPT
RTRV-ALM-ALL RTRV-COND-RING
RTRV-ALM-BITS RTRV-COND-SYNCN
RTRV-ALM-ENV RTRV-COND-UCP

Output Format

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

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

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

Output Example

TID-000 1998-06-20 14:30:00
** 100.100 REPT ALM COM
"COM:MJ,FAN,NSA,,,,:\"FAN FAILURE\""
;


3.4.88 REPT ALM ENV: Report Alarm Environment

Reports a customer-defined condition on an environmental alarm input.

Section
REPT ALM ENV Description 

Category

Environment Alarms and Controls

Security

Retrieve

Related Messages

OPR-ACO-ALL RTRV-ALM-RING
OPR-EXT-CONT RTRV-ALM-SYNCN
REPT ALM <MOD2ALM> RTRV-ALM-UCP
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 ALM UCP RTRV-COND-ENV
REPT EVT COM RTRV-COND-EQPT
REPT EVT ENV RTRV-COND-RING
RLS-EXT-CONT RTRV-COND-SYNCN
RTRV-ALM-<MOD2ALM> RTRV-COND-UCP
RTRV-ALM-ALL RTRV-EXT-CONT
RTRV-ALM-BITS SET-ATTR-CONT
RTRV-ALM-ENV SET-ATTR-ENV
RTRV-ALM-EQPT

Output Format

SID DATE TIME
** ATAG REPT ALM ENV
"<AID>:<NTFCNCDE>,<ALMTYPE>,,,[<DESC>]"
;

<