Table Of Contents
3.2 TL1 Commands by Card (ONS 15454)
3.3 TL1 Commands by Card (ONS 15327)
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.14 COPY-IOSCFG: Copy IOS Config File
3.4.16 DISC-TACC: Disconnect Test Access
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.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.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.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.46 ED-SYNCN: Edit Synchronization
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.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.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.80 OPR-PROTNSW-<OCN_TYPE>: Operate Protection Switch (OC3, OC12, OC48, OC192)
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.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.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.107 REPT SW: Report Switch
3.4.108 RLS-EXT-CONT: Release External Control
3.4.110 RLS-PROTNSW-<OCN_TYPE>: Release Protection Switch (OC3, OC12, OC48, OC192)
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.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.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.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.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.168 RTRV-PROTNSW-CLNT: Retrieve Protection Switch Client
3.4.169 RTRV-PROTNSW-VT1: Retrieve Protection Switch VT1
3.4.171 RTRV-SYNCN: Retrieve Synchronization
3.4.172 RTRV-T1: Retrieve T1 Facility
3.4.174 RTRV-TACC: Retrieve Test Access
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.187 SET-ATTR-CONT: Set Attribute Control
3.4.188 SET-ATTR-ENV: Set Attribute Environment
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
3.2 TL1 Commands by Card (ONS 15454)
3.3 TL1 Commands by Card (ONS 15327)
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 DescriptionCategory
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-SECUInput 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 DescriptionCategory
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-TODInput 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 DescriptionCategory
Log
Security
Retrieve
Related Messages
INH-MSG-DBCHG
REPT DBCHG
RTRV-LOGInput 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 DescriptionCategory
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-SECUInput 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 DescriptionCategory
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 DescriptionCategory
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-EQPTInput 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 DescriptionCategory
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-EQPTInput 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 DescriptionCategory
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-EQPTInput 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 DescriptionCategory
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-TODInput 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.
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 DescriptionCategory
Security
Security
Retrieve
Related Messages
ACT-USER
CANC
DLT-USER-SECU
ED-PID
ED-USER-SECU
ENT-USER-SECU
REPT EVT SECU
RTRV-USER-SECUInput 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> DescriptionCategory
Test Access
Security
Maintenance
Related Messages
CONN-TACC-<MODE_TACC>
DISC_TACC
RTRV-TACCInput 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> DescriptionCategory
Test Access
Security
Provisioning
Related Messages
CHG-ACCMD-<CHG-ACCMD>
DISC-TACC
RTRV-TACCInput 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 DescriptionCategory
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 DescriptionCategory
Software Download
Security
Superuser
Related Messages
APPLY
REPT EVT FXFRInput 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 DescriptionCategory
Test Access
Security
Provisioning
Related Messages
CHG-ACCMD-<MOD_TACC>
CONN-TACC-<MOD_TACC>
RTRV-TACCInput 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 DescriptionCategory
BLSR
Security
Provisioning
Related Messages
ED-BLSR RTRV-ALM-RING
ENT-BLSR RTRV-BLSR
REPT ALM RING RTRV-COND-RING
REPT EVT RINGInput 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>;

