This section lists TL1 alarms, commands, and autonomous messages supported by the Cisco ONS 15454. For more information about TL1, refer to Telcordia document GR833-CORE, Network Maintenance: Network Element and Transport Surveillance Messages.
11.2 Craft Interface
The TCC/TCC+ has two built-in interface ports for accessing the ONS 15454. With one RJ-45 craft interface browser LAN connection you can access the system using a standard browser interface. While using the browser interface, you can perform local and remote Operations, Administration, Maintenance and Provisioning (OAM&P) functions and open a VT100 emulation window to enter TL1 commands. If a browser is not available, you can access the system using a nine- pin RS-232 port. The RS-232 port supports VT100 emulation such that TL1 commands may be entered directly without a browser.
To access the ONS 15454 TL1 commands using a Telnet session over a craft interface or a Local Access Network (LAN) connection (TCC/TCC+ front panel or backplane pins), you must use port number 2361. At a command prompt, start the Telnet session by typing:
telnet <Node IP Address> 2361 [Enter]
11.4 Alarms
This section lists TL1 alarms supported by the ONS 15454. Each alarm list includes a description, service affect criteria, and severity. Refer to Chapter 9, "CTC Alarms," for fault recovery procedures. The following alarm types are listed:
•Equipment Alarms
•SONET Optical Carrier, level n (OC-N) Alarms
•Digital Signal, level 1 (DS-1) Alarms
•Digital Signal, level 3 (DS-3) Alarms
•Synchronous Transport Signal (STS) Alarms
•Virtual Tributary (VT) Termination Alarms
•Building Integrated Timing Supply (BITS) Alarms
•Network Element (NE) Synchronous Reference Alarms
11.4.1 Equipment Alarms
Table 11-1 Equipment Alarms
EQPT alarm
Card/Mode
Severity (Active/ Standby)
SA/NSA (Active/ Standby)
Description
INT
all
any mode
CR/MN
SA/NSA
Internal board Failure
IMPROPRMVL
all
any mode
CR/MN
SA/NSA
Board is provisioned and has been unplugged
MEA
all
any mode
MN/MN
NSA/NSA
Mismatch in between the physical equipment type and the provisioned equipment type
FAILTOSW- PATH
TCC,TCC+,XC,DS-3
any mode
MJ/MN
SA/NSA
Failure to perform an equipment protection switch
POWERFAIL
all
any mode
CR/MN
NSA/NSA
Power Failure on the node
MANUAL
TCC,TCC+,XC,DS-3
any mode
MN/MN
NSA/NSA
Operator Manual switch severity active
FORCED
TCC,TCC+,XC,DS-3
any mode
MN/MN
NSA/NSA
Operator Force switch severity active
DIAGFAIL
all
any mode
CR/MN
NSA/NSA
Equipment diagnostic failure
HITEMP
TCC,TCC+
Any mode
CR/CR
NSA/NSA
Excessive temperature - operating still maintaining normal operations
FAN
all
any mode
CR/MI
NSA/NSA
Fan operation failure
PWRRESTART
all
any mode
MI/MI
NSA/NSA
Power restart
AUTORESET
all
any mode
MI/MI
NSA/NSA
Automatic reset
MANRESET
TCC,TCC+
any mode
MI/MI
NSA/NSA
Manual reset
INIT
TCC,TCC+
any mod
MI/MI
NSA/NSA
Initialization initiated
SWTRANSFER
TCC,TCC+
any mod
MI/MI
NSA/NSA
Software download in progress
CONTBUS-A-X
IO,XC
any mode
MJ/MN
NSA/NSA
TCC/TCC+ card in Slot 7 has lost communication with the card in Slot X
CONTBUS-A-8
IO,XC
any mode
MJ/MN
NSA/NSA
Main processor on the TCC/TCC+ card in Slot 7 has lost communication with the coprocessor on the second TCC/TCC+ card in Slot 11
CONTBUS-B-X
IO,XC
any mode
MJ/MN
NSA/NSA
TCC/TCC+ card in Slot 11 has lost communication with the card in Slot X
CONTBUS-B-8
IO,XC
any mode
MJ/MN
NSA/NSA
Main processor on the TCC/TCC+ card in Slot 11 has lost communication with the processor on the second TCC/TCC+ card in Slot 7
CTNEQPT-PBXPROT
I/O, XC/XCVT
CR/MN
SA/NSA
Failure of the main payload between the XC/XCVT card in Slot 10 and the reporting I/O card in Slot X
CTNEQPT-PBXWORK
I/O, XC/XCVT
CR/MN
SA/NSA
Failure of the main payload bus between the active XC/XCVT card in Slot 8 and the reporting I/O card in Slot X
11.4.2 OC-N Alarms
Table 11-2 OC-N Alarms
OC-n alarm
Card/Mode
Severity (Active/
Standby)
SA/NSA
(Active/
Standby)
Description
LOS
OC-3, OC-12, OC-48
any mode
CR/MN
SA/NSA
Loss of Signal alarm
LOF
OC-3,OC-12, OC-48
any mode
CR/MN
SA/NSA
Loss of Frame alarm
AIS-L
OC-3,OC-12, OC-48
any mode
MN/MN
SA/NSA
Alarm Indication Signal Line alarm
RFI-L
OC-3,OC-12, OC-48
any mode
MN/MN
NSA/NSA
Remote Failure Indication Line alarm
SFBER
OC-3,OC-12, OC-48,
any mode
CR/MN
SA/NSA
Signal fail error rate alarm
SDBER
OC-3,OC-12, OC-48
any mode
MN/MN
SA/NSA
Signal degrade error rate alarm
FAILTOSW-RNG
OC-3,OC-12, OC-48
2F BLSR mode
MJ/MN
SA/NSA
Failure to perform a two-fiber BLSR ring switch
FAILTOSW-SPAN
OC-3,OC-12, OC-48
linear mode
MJ/MN
SA/NSA
Failure to perform a Linear APS 1+1 switch
MANUAL-REQ
OC-3,OC-12, OC-482
2F BLSR mode
MN/MN
NSA/NSA
Manual Ring Switch Severity active
FORCED-REQ
OC-3,OC-12, OC-48
2F BLSR mode
MN/MN
SA/NSA
Force Ring Switch Severity active
LOCKOUTOFPR- RING
OC-3,OC-12, OC-482
2F BLSR mode
MN/MN
SA/NSA
Lockout of Protection Channel Switch Severity active
MANUAL-SPAN
OC-3,OC-12, OC-48
linear mode
MN/MN
NSA/NSA
Manual Span Switch Severity active
FORCED-SPAN
OC-3,OC-12, OC-482
linear mode
MN/MN
SA/NSA
Force Span switch Severity active
LOCKOUT-SPAN
OC-3,OC-12, OC-48
linear mode
MN/MN
SA/NSA
Lockout Span Switch Severity active
APSB
OC-3,OC-12, OC-48
linear mode
MJ/MN
SA/NSA
Automatic Protection Switching (APS) byte failure
APSCM
OC-3,OC-12, OC-48
linear mode
MJ/MN
SA/NSA
APS Channel Mismatch failure
APSMM
OC-3,OC-12, OC-48
linear mode
MJ/MN
SA/NSA
APS Mode Mismatch failure
APSFERPFAIL
MN/MN
NSA/NSA
APS channel far-end protection line failure
EOC
MJ/MN
NSA/NSA
Data communication channel failure
SQUELCH
OC-12,OC-48
2F BLSR mode
MJ/MN
SA/NSA
Squelching in progress
INCON
OC-12,OC-48
2F BLSR mode
MJ/MN
SA/NSA
Inconsistent APS code
APSCIMP
OC-12,OC-48
2F BLSR mode
MJ/MN
SA/NSA
Improper SONET Automatic Protect Switch code
NODEMIS
OC-12,OC-48
2F BLSR mode
MJ/MN
SA/NSA
Node Id mismatch failure
DFLTK
OC-12,OC-48
2F BLSR mode
MN/MN
NSA/NSA
Default K byte transmitted
CONNLOS
TCC/TCC+
2F BLSR mode
MJ/MN
NSA/NSA
Inter-node connectivity lost in two-fiber BLSR configuration
ALS
CR/MN
NSA/NSA
Automatic laser shut down
LPBKTERMIN
OC-3,OC-12, OC-48
any mode
MJ/MI
SA/NSA
Terminal loopback active
LPBKFACILITY
OC-3, OC-12, OC-48
any mode
MJ/MI
SA/NSA
Facility loopback active
11.4.3 DS-3 Alarms
Table 11-3 DS-3 Alarms
DS-3 alarm
Card/Mode
Severity (Active)
SA/NSA (Active)
Description
PEERMISSM
DS-3
any mode
MJ
SA
Peer state mismatch
LOS
DS-3
any mode
CR
SA
Loss of signal alarm
LPBK
DS-3
any mode
MJ
SA
Loopback active
IDLE
DS-3
any mode
MJ
SA
DS-3 idle condition
RAI
DS-3
any mode
MN
SA
Remote alarm indication
DS3MANTERM- LPBK
DS-3
any mode
MJ
SA
Loopback terminal
DS3MANFAC LPBK
DS-3
any mode
MJ
SA
Loopback facility
DS3FELPBK
DS-3
any mode
MJ
SA
Loopback due to Far-End Alarm Condition (FEAC) command
DS2FELPBK
DS-3
any mode
MJ
SA
DS-2 loopback command sent to far-end
DS1FELPBK
DS-3
any mode
MJ
SA
DS- 1 loopback due to FEAC command
DS3FELPBK
DS-3
any mode
MJ
SA
DS-3 loopback due to FEAC command
DS3FELPBKCMD
DS-3
any mode
MJ
SA
DS-3 loopback command sent to far-end
FE-EQPT-FAIL-SA
DS-3
any mode
MJ
SA
Far-end DS-3 equipment fail service-affecting
FE-LOS
DS-3
any mode
MJ
SA
Far-end loss of signal
FE-LOF
DS-3
any mode
MJ
SA
Far-end loss of frame
FE-AIS
DS-3
any mode
MJ
SA
Far-end alarm indication signal
FE-IDLE
DS-3
any mode
MJ
SA
Far-end idle
FE-EQPT-NSA
DS-3
any mode
MJ
SA
Far-end DS-3 equipment fail non-service affecting
DS3FECMNEQPT
FAIL
DS-3
any mode
MJ
SA
Far-end common equipment fail non-service affecting
Manual switch of working facility equipment to protection
FORCED
STS Termination on DS-3 card
any mode
MN/MN
NSA/NSA
Working facility/equipment forced to switch to protection
11.4.6 VT Termination Alarms
Table 11-6 VT Termination Alarms
VT Term alarm
Card/Mode
Severity (Active/ Standby)
SA/NSA (Active/ Standby)
Description
LOP
STS Monitor any mode
MJ/MN
SA/NSA
Loss of pointer alarm
AIS
VT Termination on DS-1 card any mode
MJ/MN
SA/NSA
VT Alarm Indication Signal alarm
UNEQP
VT Termination on DS-1 card any mode
MJ/MN
SA/NSA
VT Unequipped alarm
RFI
VT Termination on DS-1 card any mode
MN/MN
SA/NSA
VT Remote Failure Indication alarm
PLM
VT Termination on DS-1 card any mode
MN/MN
SA/NSA
VT Payload Label Mismatch alarm
SFBER
MJ/MN
SA/NSA
BER threshold passed for signal failure
SDBER
MJ/MN
SA/NSA
BER threshold passed for signal degrade
11.4.7 BITS Alarms
Table 11-7 Bits Alarms
BITS alarm
Card/Mode
Severity (Active/ Standby)
SA/NSA (Active/ Standby)
Description
LOS
Bits on
TCC/TCC+ card any mode
MJ/MN
SA/NSA
Loss of Signal alarm
LOF
Bits on
TCC/TCC+ card any mode
MJ/MN
SA/NSA
Loss of Frame alarm
AIS
Bits on
TCC/TCC+ card any mode
MJ/MN
SA/NSA
Alarm Indication Signal alarm
11.4.8 Network Element Synch Ref Alarms
Table 11-8 Synch Ref Alarms
neSynchRef alarm
Card/Mode
Severity (Active/ Standby)
SA/NSA
Description
SYNCPRI
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Primary Synchronization reference failure alarm
SYNCSEC
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Secondary Synchronization reference failure alarm
SYNCTHIRD
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Third Synchronization reference failure alarm
HLDOVRSYNC
neSynchRef on
TCC/TCC+ card any mode
MJ/MN
SA/NSA
Holdover Synchronization alarm
FRNGSYNC
neSynchRef on
TCC/TCC+ card any mode
MJ/MN
SA/NSA
Free Run Synchronization alarm
MANUAL
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Operator-initiated synchronization switch
FASTSTART
Fast start
Synch node
No
No Alarm
Fast Start Synchronization alarm
MANSWTOPRI
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Synchronization switch to primary reference
MANSWTOSEC
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Synchronization switch to second reference
MANSWTOTHID
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Synchronization switch to third reference
SWTOPRI
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Synchronization switch to primary reference
SWTOSEC
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Synchronization switch to second reference
SWTOTHIRD
neSynchRef on
TCC/TCC+ card any mode
MN/MN
NSA/NSA
Synchronization switch to third reference
11.5 Autonomous Messages
The autonomous TL1 messages are included in the TL1 Command Description section, and the messages are listed alphabetically. Figure 11-1 shows the autonomous alarm message format. Autonomous Message Tag (ATAG) is used for message sequencing. The number is incremented by one for each autonomous message sent by the ONS 15454. The ONS 15454 uses whole numbers 0000 to 9999.
Figure 11-1 Autonomous Alarm Message Format
11.6 Performance Monitoring
Performance information is continuously monitored and stored in individual Performance Monitoring (PM) registers. This information can be retrieved upon request or when a preset threshold is exceeded. lists PM Statistics by board.
11.6.1 Performance Monitoring Statistics
Table 11-9 PM Statistics
PM Statistics by Board
Special Qualifications
Source
DS-1
DS-3
DS-3 XM
OC-3/12/48
EC-1
Sonet Section Stats
CV-S
(not supported yet)
B1
ES-S
(not supported yet)
B1
SES-S
(not supported yet)
B1
SEFS-S
B1
X
X
Sonet Line Stats
CV-L
B2
X
X
ES-L
B2
X
X
SES-L
X
X
UAS-L
X
X
FC-L
X
X
PSC
X
PSD
X
STS PJ
Non-terminated STS only
H1, H2
PPJC-PDET
Positive detected at input
X
X
NPJC-PDET
Negative detected at input
X
X
PPJC-PGEN
Positive generated
X
X
NPJC-PGEN
Negative generated
X
X
Far End
CV-L FE
K2
X
X
ES-L FE
K2
X
X
SES-L FE
K2
X
X
UAS-L FE
K2
X
X
FC-L FE
K2
X
X
Sonet Path Stats
CV-P
B3
X
X
X
ES-P
X
X
X
SES-P
X
X
X
UAS-P
X
X
X
FC-P
VT PJ
Far End
Supplied by XCON
CV-P FE
From XCON
X
ES-P FE
From XCON
X
SES-P FE
From XCON
X
UAS-P FE
From XCON
X
FC-P FE
VT Path Stats
VT terminated circuits only
CV-V
X
X
ES-V
X
X
SES-V
X
X
UAS-V
X
X
FC-V
Far End
CV-V FE
X
X
ES-V FE
X
X
SES-V FE
X
X
UAS-V FE
X
X
FC-V FE
DS-n Stats
DS-n Line
CV-L
X
X
X
X
ES-L
X
X
X
X
LOSS-L
X
SES-L
X
X
X
X
DS-3 Path
P Bit Stats
M13 & C Bit Framing
AISS-P
X
CVP-0
X
ESP-P
X
SASP-P
X
SESP-P
X
UASP-P
X
CP Bit Stats
C Bit Framing ONLY
CVCP-P
X
ESCP-P
X
SASCP-P
X
SESCP-P
X
UASCP-P
X
Far End
CVCP-P FE
X
ESCP-P FE
X
SASCP-P FE
X
SESCP-P FE
X
UASCP-P FE
X
DS-1 Path
CV-P RX
X
AISS-P RX
X
X
ES-P RX
X
X
SAS-P RX
X
X
SES-P RX
X
X
UAS-P RX
X
X
CV-P TX
X
X
AISS-P TX
X
X
ES-P TX
X
X
SAS-P TX
X
X
SES-P TX
X
X
UAS-P TX
X
X
11.7 TL1 Command Syntax
TL1 commands conform to the following syntax:
a:b:c::d:e: ... z;
where:
"a" is the Command Code
"b" is the Target Identifier (TID)
"c" is the Access Identifier (AID) or the User Identifier (UID)
"d" is the Correlation Tag (CTAG)
"e: ... z;" are the other positions required for various commands
The TID, AID, and CTAG route and control the TL1 command. Other parameters provide additional messages required to complete the action requested by the command.
The TID is a unique name given to each system when it is installed. The name identifies the particular NE (in this case, the ONS 15454), to which each command is directed. Each TID can have a maximum of 20 alpha-numeric characters. To establish the TID for a ONS 15454 node, use the Network Element Name option of the Network Element Configuration menu.
The AID is an access code used to identify and address specific objects within the ONS 15454. These objects include individual pieces of equipment, transport spans, access tributaries, and other objects.
The CTAG is a unique identifier given to each input command by the operator. When the ONS 15454 system responds to a specific command, it includes the command's CTAG in the reply. This eliminates discrepancies about what response corresponds to what command. Valid CTAG values include strings of up to six characters comprised of identifiers (alphanumeric, beginning with a letter) or decimal numerals (a string of decimal digits with an optional non-trailing ".").
11.8 TL1 Command Privilege Map
The following table specifies command access privileges.
Table 11-10 Command Access
Command
Superuser
Provision
Maintenance
Retrieve
DLT-USER-SECU
X
ED-DAT
X
ED-USER-SECU
X
ENT-USER-SECU
X
SET-TOD
X
X
DLT-*-*
X
X
ED-*-*
X
X
ENT-*-*
X
X
SET-*-*
X
X
INIT-*-*
X
X
X
OPR-*-*
X
X
X
RLS-*-*
X
X
X
RMV-*-*
X
X
X
RST-*-*
X
X
X
SW-*-*
X
X
X
ALW-*-*
X
X
X
X
INH-*-*
X
X
X
X
REPT * *
X
X
X
X
RTRV-*-*
X
X
X
X
CANC-*-*
X
X
X
X
ACT-*-*
X
X
X
X
ED-PD
X
X
X
X
User security levels also limit the amount of time a user can leave the system idle before the TL1 session is locked to prevent unauthorized users from making changes. Higher security levels have shorter idle times. shows security levels and their idle times
This section lists TL1 commands supported by the ONS 15454. Each listing includes a description, input format, input parameters (instructions within a command), and input example. The descriptions are alphabetical according to the first alpha character of the command string.
Note The TL1 input command string size should equal and less than 1023 characters from either a TL1 telnet session or CTC. Any TL1 input string larger than 1023 characters will cause the active TCC to reset.
Note TL1 commands not entered correctly are not completed.
11.11.1 ACT-USER: Activate User
This command allows you to log in to the Network Element (NE).
Section
Description
Category
System
Security
Read Only
Related Messages
ALW-MSG-ALL
CANC-USER
DLT-USER-SECU
ED-DAT
ED-PID
ED-USER-SECU
ENT-USER-SECU
INH-MSG-ALL
INIT-SYS
RTRV-HDR
Input Format
ACT-USER:[TID]:<userid>:[CTAG]::<passwd>;
where:
•userid identifies the user to the system and is a String
•passwdis the user's private password and is a String
Example
Input
ACT-USER:PETALUMA:TERRI:100::MYPASSWD;
Errors
This message generates all the default errors
11.11.2 ALW-MSG-ALL: Allow Message All
This command instructs the NE to enter a mode in which all automatic messages are transmitted.
Section
Description
Category
System
Security
N/A
Related Messages
ACT-USER
CANC-USER
ED-DAT
INH-MSG-ALL
INIT-SYS
RTRV-HDR
Input Format
ALW-MSG-ALL:[TID]::[CTAG]::,,;
Example
Input
ALW-MSG-ALL:PETALUMA::549::,,;
Errors
This message generates all the default errors
11.11.3 CANC-USER: Cancel User
This command logs a user off of the NE.
Section
Description
Category
System
Security
Read Only
Related Messages
ACT-USER
ALW-MSG-ALL
DLT-USER-SECU
ED-DAT
ED-PID
ED-USER-SECU
ENT-USER-SECU
INH-MSG-ALL
INIT-SYS
RTRV-HDR
Input Format
CANC-USER:[TID]:[<userid>]:[CTAG];
where:
•userid identifies the user to the system and is a String
•from is the source aid of the vt connection and is the AID vt1_5
•to is the destination aid of the crs vt connection and is the AID vt1_5
Example
Input
DLT-CRS-VT1:CISCO:VT1-2-3-1,VT1-4-4-1:1234:::;
Errors
This message generates all the default errors
11.11.7 DLT-EQPT: Delete Equipment
This command deletes a card from the NE. It removes the card type and attributes that were entered for a particular slot. If any facilities are assigned, they are also deleted as long as they do not contain any cross-connect end-points, the cards are not in a protection group and they are not in SDCC termination. If any of the above descriptions exist, the command will be denied.
Section
Description
Category
Equipment
Security
N/A
Related Messages
DLT-FFP-EQPT RLS-PROTNSW-EQPT
ED-FFP-EQPT RTRV-ALM-EQPT
ENT-EQPT RTRV-COND-EQPT
ENT-FFP-EQPT RTRV-EQPT
OPR-PROTNSW-EQPT RTRV-FFP-EQPT
REPT ALM EQPT SW-DX-EQPT
REPT EVT EQPT
Input Format
DLT-EQPT:[TID]:<eqpt_aid>:[CTAG];
where:
•equip_aid is the AID eqpt
Example
Input
DLT-EQPT:SONOMA:SLOT-1:104;
Errors
This message generates all the default errors
11.11.8 DLT-FFP-<OCN_TYPE>: Delete Facilities Protection Group (OC3, OC12, OC48)
This command deletes a linear protected group on optical cards.
Section
Description
Category
Facility Protection
Security
N/A
Related Messages
N/A
Input Format
DLT-FFP-<OCN_TYPE>:[TID]:<work>,<protect>:[CTAG];
where:
•work is the working equipment and the AID facility
•protect is the protection equipment and the AID facility
This command deletes an equipment protection group.
Section
Description
Category
Equipment
Security
N/A
Related Messages
DLT-EQPT RLS-PROTNSW-EQPT
ED-FFP-EQPT RTRV-ALM-EQPT
ENT-EQPT RTRV-COND-EQPT
ENT-FFP-EQPT RTRV-EQPT
OPR-PROTNSW-EQPT RTRV-FFP-EQPT
REPT ALM EQPT SW-DX-EQPT
REPT EVT EQPT
Input Format
DLT-FFP-EQPT:[TID]:<work>,<protect>:[CTAG];
where:
•work is the AID eqpt
•protect is the AID eqpt
Example
Input
DLT-FFP-EQPT:PETALUMA:SLOT-2,SLOT-1:1;
Errors
This message generates all the default errors
11.11.10 DLT-USER-SECU: Delete User Security
This command removes a user and can only be used by an administrator. The AID block contains the user identifier. If this command is executed while the user is logged on, the current session for that user continues. Once the user logs out, the same userid cannot be used to log in again. This command is defined in TR-835.
Section
Description
Category
Security
Security
Admin
Related Messages
ACT-USER
CANC-USER
ED-PID
ED-USER-SECU
ENT-USER-SECU
Input Format
DLT-USER-SECU:[TID]:<username>:[CTAG];
where:
•username is a String
Example
Input
DLT-USER-SECU:CISCO:UID:123;
Errors
This message generates all the default errors
11.11.11 ED-<OCN_TYPE>: Edit (OC3, OC12, OC48)
This command modifies the attributes (i.e. service parameters) and state of an OC-N facility. Allowable states for a facility are Out of Service (OOS) and In Service (IS).
This command modifies attributes of an STS-level cross-connect. Under certain circumstances, you may change the cross-connect type (e.g. from 1WAY to 2WAY).
This command modifies the attributes of the NE system such as changing the node's identity (e.g. IP address), external interfaces (e.g. LAN ports), and major modes of operation (e.g. SONET vs. SDH).
This command allows a user to change their own password. Other user identification and access changes may only be made by a superuser. This command is defined in TR-835.
Note The password cannot be null. It will be echoed as clear text as the message is parsed and only after the complete message is entered and terminated.
Note The password should not appear in the TL1 log on the NE.
This command modifies 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 (for example, PRIMARY, SECOND, THIRD).
This command edits a user's privileges, password, or ID. Only a user with R/W admin privileges may perform this operation. Privilege levels are described in the ENT-USER-SECU: Enter User Security command. This command is defined in TR-835.
Note If the password is changed with this command, the password should be blanked out in the TL1 log.
This command puts a facility or an aid in service.
Note ENT-DS1/STS1/STS3C/STS12C/STS48C/VT1 are not supported in Release 2.2.1.
Section
Description
Category
Other
Security
Admin
Related Messages
N/A
Input Format
ENT-<MOD2>:[TID]:<aid>:[CTAG];
where:
•aid is the aid to be put in service and is the AID ALL
Example
Input
ENT-OC3:CISCO:FAC-1-1:1243;
Errors
This message generates all the default errors
11.11.27 ENT-CRS-<STS_PATH>: Enter Cross Connect (STS1, STS3C, STS12C)
This command creates an STS cross-connect between two or more STS paths. Rather than create each individual unidirectional connection singularly, this command accepts cross-connection types (CCT) that identify aggregate cross-connects based on their function in the network. To enter a cross-connect, the facilities that support the STS paths must be either in service or out of service assigned. If a cross-connect (XC) card is not present in the system or if the paths have incompatible payload types, the request is denied.
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.
Section
Description
Category
Equipment
Security
Admin
Related Messages
DLT-EQPT RLS-PROTNSW-EQPT
DLT-FFP-EQPT RTRV-ALM-EQPT
ED-FFP-EQPT RTRV-COND-EQPT
ENT-FFP-EQPT RTRV-EQPT
OPR-PROTNSW-EQPT RTRV-FFP-EQPT
REPT ALM EQPT SW-DX-EQPT
REPT EVT EQPT
Input Format
ENT-EQPT:[TID]:<eqpt>:[CTAG]::<eqpt_type>;
where:
•eqpt is the AID eqpt
•eqpt_type is of type EQUIPMENT_TYPE
Example
Input
ENT-EQPT:PETALUMA:SLOT-12:118::OC12;
Errors
This message generates all the default errors
11.11.30 ENT-FFP-<OCN_TYPE>: Enter Facilities Protection Group (OC3, OC12, OC48)
This command initializes the performance monitoring registers.
Section
Description
Category
Performance
Security
Read/Write
Related Messages
RTRV-PM-<MOD2>
RTRV-TH-<MOD2>
SET-TH-<MOD2>
Input Format
INIT-REG-<MOD2>:[TID]:<aid>:[CTAG]::,,,,<tmpr>,,;
where:
•aid is the AID facility
•tmpr is of type TMPR
Example
Input
INIT-REG-OC3:TID:FAC-1-1:1234::,,,,15MIN,,;
Errors
This message generates all the default errors
11.11.35 INIT-SYS: Initialize System
This command instructs the NE to initialize the specified card and its associated subsystem(s). The command supports various levels of restart, called phases, ranging from a warm start to a cold start.
Note In Release 2.2.1 this command only resets equipment. The phase parameter is not supported in this release.
Section
Description
Category
System
Security
Read/Write
Related Messages
ACT-USER
ALW-MSG-ALL
CANC-USER
ED-DAT
INH-MSG-ALL
RTRV-HDR
Input Format
INIT-SYS:[TID]:<eqpt_aid>:[CTAG]::[<phase>];
where:
•eqpt-aid is the AID eqpt
•phase is the level of initialization to take place; the higher the number the stronger the reset, A phase=1 is a warm start and A phase=10 is a cold start; phase is an Integer
This command instructs the NE to initiate a SONET line protection switch request. User switch requests initiated with this command remain active until they are released via the RLS-PROTNSW-OCN command or are overridden by a higher priority protection switch request.
This command retrieves the parameters of an OC-N facility.
Section
Description
Category
Other
Security
Read Only
Related Messages
N/A
Input Format
RTRV-<OCN_TYPE>:[TID]:<fac_aid>:[CTAG]::::;
where:
•fac_aid is the AID facility and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<fac_aid>:[SDCC=<sdcc>],[TMERGF=<tmgref>],[SPNWTR=<spnwtr>], [PJMON=<pjmon>],[SFBER=<sfber>],[SDBER=<sdber>], [MODE=<mode>],[WVLEN=<wvlen>]:<pst>,,<role>,<status>" ;
where:
•fac_aid is the AID facility
•sdcc is of type SDCC_MODE and is optional
•tmgrefis of type TMG_REF and is optional
•spnwtr is of type REVERTIVE_TIME and is optional
•pjmon is an Integer and is optional
•sfber is of type SF_BER and is optional
•sdber is of type SD_BER and is optional
•mode is of type OPTICAL-MODE. mode is optional
•wvlen is the optical signal wavelength in nanometers; it is a Float and is optional
Instructs the network to retrieve and send the current status of its alarm conditions. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.
•ntfcnde is the 2-letter notification code and is of type NOTIF_CODE; a null value is equivalent to "ALL"
•condition is a type of alarm condition and is of type CONDITION; condition is listable and a null value is equivalent to "ALL"
•serveff of type SERV_EFF and a null value is equivalent to "ALL"
Output Format
SID DATE TIME M CTAG COMPLD "<aid>,<type>:<ntfcnde>,<condition>,<srveff>,,,,:<desc>" ;
where:
•aid is the AID facility
•type specifies the type of OC-N facility associated with the facility AID; type is of type MOD2ALM
•ntfcnde is the 2-letter notification code and is of type NOTIF_CODE
•condition is a type of alarm condition and is of type CONDITION
•srveff is the type of effect on service caused by the alarm condition and is of type SERV_EFF
•desc is a String
Example
Input
RTRV-ALM-OC12:ELDRIDGE:FAC-6-1:255::MN,SD,SA,,,;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "FAC-6-1,OC12:MJ,SD,SA,,,,:\"BER AT SIGNAL DEGRADE LEVEL\"," ;
Errors
This message generates all the default errors
11.11.64 RTRV-ALM-ALL: Retrieve Alarm All
This command instructs the NE to retrieve and send the current status of all active alarm conditions. The alarm condition or severity retrieved is specified using the input parameters as a filter.
Section
Description
Category
Fault
Security
Read Only
Related Messages
REPT ALM <MOD2ALM> RTRV-ALM-BITS
REPT ALM BITS RTRV-ALM-ENV
REPT ALM ENV RTRV-ALM-EQPT
REPT ALM EQPT RTRV-ALM-SYNCN
REPT ALM SYNCNRTRV-COND-<MOD2ALM>
REPT EVT <MOD2ALM> RTRV-COND-ALL
REPT EVT EQPTRTRV-COND-BITS
REPT EVT SYNCN RTRV-COND-EQPT
RTRV-ALM-<MOD2ALM> RTRV-COND-SYNCN
Input Format
RTRV-ALM-ALL:[TID]::[CTAG]::,,,,,;
Output Format
SID DATE TIME M CTAG COMPLD "<aid>,<aid_type>:<notifCode>,<condition1>,<servEff>,,,,,:<dnField>" ;
where:
•aid is the aid where the alarm took place and d is the AID ALL
•aid_type is of type MOD2
•notifCode is of type NOTIF_CODE
•condition1 is of type CONDITION
•servEff is a service-affecting alarm and is of type SERV_EFF
•dsField is a String
Example
Input
RTRV-ALM-ALL:COTATI::229::,,,,,;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "SLOT-2,EQPT:MN,PWRRESTART,NSA,,,,,:\"POWERFAIL RESTART\"," ;
Errors
This message generates all the default errors
11.11.65 RTRV-ALM-BITS: Retrieve Alarm Building Integrated Timing Supply
This command instructs the NE to retrieve and send the current status of its alarm conditions associated with the BITS facility. The alarm condition or severity retrieved is specified using the input parameters as a filter.
•env is the AID env and is listable; a null value is equivalent to "ALL"
•notifCode is of type NOTIF_CODE and a null value is equivalent to "ALL"
•envAlm is of type ENV_ALM and a null value is equivalent to "ALL"
Output Format
SID DATE TIME M CTAG COMPLD "<env>:<notifCode>,<envAlm>,,,[<desc>]" ;
where:
•env is the AID env
•notifCode is of type NOTIF_CODE
•envAlm is of type ENV_ALM
•desc is a String
Example
Input
RTRV-ALM-ENV:CISCO-1:ENV-IN-1:123::MJ,OPENDR;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "ENV-IN-1:MJ,OPENDR,,,\"OPEN DOOR\"" ;
Errors
This message generates all the default errors
11.11.67 RTRV-ALM-EQPT: Retrieve Alarm Equipment
This command instructs the NE to retrieve and send the current status of its equipment-unit alarm conditions. The alarm condition or severity retrieved is specified using the input parameters as a filter.
Instructs the NE to retrieve and send the current status of its alarm conditions associated with a synchronization facility. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.
•facility is the facility aid and is the AID facility; a null value is equivalent to "ALL"
•condition is the requested condition, if not set=> we want all the conditions for the specified facility; condition is of type CONDITION and a null value is equivalent to "ALL"
Output Format
SID DATE TIME M CTAG COMPLD "<facility>,<eqptType>:[<notifcode>],<condition>,[<servEff>],,,,,, [<desc>]" ;
where:
•facility is the facility aid and is the AID facility
•eqptType is of type EQPT_TYPE
•notifCode is the notification code; notifCode is of type NOTIF_CODE and is optional
•condition is the condition itself and is of type CONDITION
•servEff is of type SERV_EFF and is optional
•desc is the condition description; desc is a String and is optional
Example
Input
RTRV-COND-T3:TID:FAC-2-1:229::LOS,,,;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "FAC-2-1,DS3-12:CR,LOS,SA,,,,,,\"LOS OF SIGNAL\"" ;
Errors
This message generates all the default errors
11.11.71 RTRV-COND-ALL: Retrieve Condition All
This command instructs the NE to retrieve the current standing condition for all entities.
Section
Description
Category
Fault
Security
Read Only
Related Messages
REPT ALM <MOD2ALM> RTRV-ALM-ALL
REPT ALM BITS RTRV-ALM-BITS
REPT ALM ENV RTRV-ALM-ENV
REPT ALM EQPTRTRV-ALM-EQPT
REPT ALM SYNCN RTRV-ALM-SYNCN
REPT EVT <MOD2ALM> RTRV-COND-<MOD2ALM>
REPT EVT EQPT RTRV-COND-BITS
REPT EVT SYNCN RTRV-COND-EQPT
RTRV-ALM-<MOD2ALM> RTRV-COND-SYNCN
Input Format
RTRV-COND-ALL:[TID]::[CTAG]::[<condition>],::;
where:
•condition is of type CONDITION and a null value is equivalent to "ALL"
Output Format
SID DATE TIME M CTAG COMPLD "<facility>,[<aid_type>]:[<notifCode>],<condition>,[<servEff>],,,,,, [<desc>]" ;
where:
•facility is the AID facility
•aid_type is of type MOD2B and is optional
•notifCode is of type NOTIF_CODE and is optional
•condition is of type CONDITION
•servEff is of type SERV_EFF and is optional
•desc is a String and is optional
Example
Input
RTRV-COND-ALL::TID::229::LOS,,,:
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "FAC-2-1,OC3:CR,LOS,SA,,,,,,\"LOS OF SIGNAL\"" ;
Errors
This message generates all the default errors
11.11.72 RTRV-COND-BITS: Retrieve Condition Building Integrated Timing Supply
This command instructs the NE to retrieve the standing conditions on BITS.
This command retrieves any connections associated with the Access Identifiers entered. FROM and TO information is returned along with the type of connection.
Section
Description
Category
Cross Connect
Security
Read Only
Related Messages
DLT-CRS-<STS_PATH>
DLT-CRS-VT1
ED-CRS-<STS_PATH>
ED-CRS-VT1
ENT-CRS-<STS_PATH>
ENT-CRS-VT1
RTRV-CRS-VT1
Input Format
RTRV-CRS-<STS_PATH>:[TID]:<sts_ep>:[CTAG]::,,,;
where:
•sts_ep is the AID sts and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<crs_ep>,<crs_ep1>:<cct>" ;
where:
•crs_ep is the AID sts
•crs_ep1 is the AID sts
•cct is the cross connect type and is of type CCT
Example
Input
RTRV-CRS-STS3C:KENWOOD:STS-6-1:223::::;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "STS-6-1,STS-12-4:2WAY" ;
This command retrieves the facility status of an EC-1 card.
Section
Description
Category
Other
Security
Read Only
Related Messages
N/A
Input Format
RTRV-EC1:[TID]:<fac>:[CTAG]::::;
where:
•fac is the facility aid and is the AID facility; fac must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<fac>:PJMON=<pjmon>,LBO=<lbo>:PST=<pst>" ;
where:
•fac is the facility aid and is the AID facility
•pjmon is the SONET pointer monitor and is an Integer
•lbo is line buildout and is of type E_LBO
•pst is the primary service state and is of type PST
Example
Input
RTRV-EC1:CISCO:FAC-1-1:1234::::;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "FAC-1-1:PJMON=0,LBO=0-225:PST=IS" ;
Errors
This message generates all the default errors
11.11.78 RTRV-EQPT: Retrieve Equipment
This command retrieves the data and state parameters associated with an equipment unit.
Section
Description
Category
Equipment
Security
Read Only
Related Messages
DLT-EQPT REPT EVT EQPT
DLT-FFP-EQPT RLS-PROTNSW-EQPT
ED-FFP-EQPT RTRV-ALM-EQPT
ENT-EQPT RTRV-COND-EQPT
ENT-FFP-EQPT RTRV-FFP-EQPT
OPR-PROTNSW-EQPT SW-DX-EQPT
REPT ALM EQPT
Input Format
RTRV-EQPT:[TID]:<eqpt_aid>:[CTAG]::::;
where:
•eqpt_aid is the AID eqpt and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<eqpt_aid>:[<eqpt_type>]:[WTR=<wtr>],[NAME=<name>]:<state>, <equip>,[<role>],[<status>]" ;
where:
•eqpt_aid is the AID eqpt
•eqpt_type is the type of card in the slot; eqpt_type is of type EQPT_TYPE and is optional
•wtr is an Integer and is optional
•name is a String and is optional
•state is of type PST
•equip indicates if the equipment unit is physically present and is of type EQUIP.
•role indicates if the card is a working unit or the protecting unit; role is of type SIDE and is optional
•status is of type STATUS and is optional
Example
Input
RTRV-EQPT:MIRABEL:SLOT-12:230::::;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "SLOT-12:OC12:WTR=99,NAME=DESCRIPTION:IS,EQUIP,,ACT" ;
Errors
This message generates all the default errors
11.11.79 RTRV-FFP-<OCN_TYPE>: Retrieve Facilities Protection Group (OC3, OC12, OC48)
This command retrieves the optical facility protection information.
Section
Description
Category
Facility Protection
Security
Read Only
Related Messages
N/A
Input Format
RTRV-FFP-<OCN_TYPE>:[TID]:<facility>:[CTAG];
where:
•facility is the AID facility and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<work>,<protect>:NAME=<name>,RVTT=<revertiveType>, RVTM=<revertiveTime>,BSWM=<bswMode>" ;
where:
•work is the AID facility
•protect is the AID facility
•name is the protection name and is a String
•revertiveType is the revertive type and e is of type REVERTIVE_TYPE
•revertiveTime is the revertive time and is of type REVERTIVE_TIME
•bswMode specifies if it is a bidirectional switch mode and is of type ON_OFF
Example
Input
RTRV-FFP-OC3:PETALUMA:FAC-3-1:1;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "FAC-3-1,FAC-4-1:NAME=PROT_NAME,RVTT=R,RVTM=1.0, BSWM=OFF" ;
Errors
This message generates all the default errors
11.11.80 RTRV-FFP-EQPT: Retrieve Facilities Protection Group Equipment
This command retrieves the equipment protection information.
Section
Description
Category
Equipment
Security
Read Only
Related Messages
DLT-EQPT REPT EVT EQPT
DLT-FFP-EQPT RLS-PROTNSW-EQPT
ED-FFP-EQPT RTRV-ALM-EQPT
ENT-EQPT RTRV-COND-EQPT
ENT-FFP-EQPT RTRV-EQPT
OPR-PROTNSW-EQPT SW-DX-EQPT
REPT ALM EQPT
Input Format
RTRV-FFP-EQPT:[TID]:<eqpt>:[CTAG];
where:
•eqpt is the AID eqpt and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<work>,<protect>:PRT=<protectionGroup>,NAME=<name>, RVTT=<revertiveType>,RVTM=<revertiveTime>,BSWM=<bswMode>" ;
where:
•work is the working slot aid and is the AID eqpt
•protect is the protection slot aid and is the AID eqpt
•protectionGroup is the protection group and is of type PROTECTION_GROUP
•name is the protection name and is a String
•revertiveType is of type REVERTIVE_TYPE
•revertiveTime is of type REVERTIVE_TIME
Example
Input
RTRV-FFP-EQPT:PETALUMA:SLOT-16:1;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "SLOT-16,SLOT-17:PRT=1-1,NAME=PROT_NAME,RVTT=R,RVTM=1.0" ;
Errors
This message generates all the default errors
11.11.81 RTRV-HDR: Retrieve Header
This command instructs the NE to return the header of a TL1 response message. Used by TL1 clients to determine if the link to the NE is still active and if the NE is responding to commands.
Section
Description
Category
System
Security
Read Only
Related Messages
ACT-USER
ALW-MSG-ALL
CANC-USER
ED-DAT
INH-MSG-ALL
INIT-SYS
Input Format
RTRV-HDR:[TID]::[CTAG];
Example
Input
RTRV-HDR:SONOMA::232;
Errors
This message generates all the default errors
11.11.82 RTRV-INV: Retrieve Inventory
This command queries the NE and returns a listing of the equipment inventory. For each unit in the system, it identifies the unit's hardware version and revision numbers, firmware version, and the unit's CLEI code.
Section
Description
Category
Other
Security
Read Only
Related Messages
N/A
Input Format
RTRV-INV:[TID]:<eqpt_aid>:[CTAG]::,,;
where:
eqpt_aid is the AID eqpt and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<eqpt_aid>,<eqptType>:[PN=<pn>],[HWVER=<hwver>], [FWVER=<fwver>],[SN=<sn>],[CLEI=<clei>]" ;
where:
•eqpt_aid is the AID eqpt
• eqpt_type is of type EQPT_TYPE
•pn is a String and is optional
•hwveris a String and is optional
•fwver is a String and is optional
•sn is an integer and is optional
•clei is a String and is optional
Example
Input
RTRV-INV:OCCIDENTAL:SLOT-15:301::::;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "SLOT-15,OC3-IR-4:PN=87-00002,HWVER=004K, FWVER=76-99-00009-004A,SN=013510,CLEI=NOCLEI" ;
Errors
This message generates all the default errors
11.11.83 RTRV-LOG: Retrieve Log
This command retrieves the alarm log of the NE.
Section
Description
Category
Log
Security
Read Only
Related Messages
N/A
Input Format
RTRV-LOG:[TID]::[CTAG];
Output Format
SID DATE TIME M CTAG COMPLD "<aid>,<seq>:CURRENT=<current>,[PREVIOUS=<previous>], <condition>,servEff>,[TIME=<time>],DATE=<date>:<desc>" ;
This command retrieves the attributes of the NE system such as the node identity (e.g. IP address), external interfaces (e.g. LAN ports), and major modes of operation (e.g. SONET vs. SDH).
Section
Description
Category
Other
Security
Read Only
Related Messages
N/A
Input Format
RTRV-NE:[TID]::[CTAG]::::;
Output Format
SID DATE TIME M CTAG COMPLD "IPADDR=<ipaddr>,IPMASK=<ipmask>,DEFRTR=<defrtr>, EXTLAN=<extlan>,INTLAN=<intlan>,RTRMDE=<rtrmode>, STM=<stm>,NODEID=<nodeid>,EXTRNG=<ext_ring>, RNGWTR=<rngwtr>,TMMD=<timing_mode>,SSMG=<sync_gen>, NSQL=<sync_quality_level>" ;
where:
•ipaddr is the IP address of the NE on the local LAN and is a String
•ipmask is the IP Mask used to identify the sub-net on which the NE resides; ipmask is a String
•defrtr is the IP address of the default router and is a String
•extlan is of type EXT_LAN
•intlan is of type EXT_LAN
•rtrmode is of type EXT_LAN
•stm is of type OPTICAL_MODE
•nodeid is the Node ID of the NE in the BLSR and is an Integer
•ext_ring is the node/ring that supports the extended K1/K2/K3 protocol for more than 16 nodes per BLSR; ext_ring is of type EXT_RING
•rngwtr is an Integer
•timing_mode is of type TIMING_MODE
•sync_gen is of type SYNC_GENERATION
•sync_quality_level is of type SYNC_QUALITY_LEVEL
Example
Input
RTRV-NE:LAKEVILLE::233::::;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "IPADDR=192.168.100.52,IPMASK=255.255.255.0, DEFRTR=192.168.100.1,EXTLAN=OFF,INTLAN=OFF, RTRMDE=OFF,STM=SONET,NODEID=3,EXTRNG=N,RNGWTR=99, TMMD=LINE,SSMG=GEN1,NSQL=ABOVE-PRS"
This command retrieves the performance monitoring for specified card type.
Note Release 2.2.1 does not support the 48C value.
Section
Description
Category
Performance
Security
Read Only
Related Messages
INIT-REG-<MOD2>
RTRV-TH-<MOD2>
SET-TH-<MOD2>
Input Format
RTRV-PM-<MOD2>:[TID]:<aid>:[CTAG]::,,,,<tmpr>,,;
where:
•aid is the AID ALL and must not be null
•tmpr is of type TMPR and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<aid>:<montype>,<monval>,<validity>,<location>,<tmpr>,<direction>" ;
where:
•aid is the AID ALL
•montype is the monitored type ex CVL, ESL and is of type ALL_MONTYPE
•monval is the monitored value and l is an Integer
•validity is of type VALIDITY
•location is the location far-end, near-end or both; location is of type LOCATION
•tmpr is the time period 15 min, 1 hour or 1 day; tmpr is of type TMPR
•direction is the direction receive, transmit or both; direction is of type DIRECTION
Example
Input
RTRV-PM-T1:TID:AID:123::,,,,15MIN,,;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "AID:CVL,21,COMPL,FEND,15MIN,RCV,," ;
Errors
This message generates all the default errors
11.11.86 RTRV-SYNCN: Retrieve SYNCN
This command retrieves the synchronization reference list used to determine the sources for the NE's reference clock and the BITS output clock. For each clock, up to three synchronization sources may be specified (e.g. PRIMARY, SECOND,THIRD).
Section
Description
Category
Synchronization
Security
Read Only
Related Messages
ED-SYNCN
OPR-SYNCNCSW
REPT ALM SYNCN
REPT EVT SYNCN
RTRV-ALM-SYNCN
RTRV-COND-SYNCN
Input Format
RTRV-SYNCN:[TID]:<sync_aid>:[CTAG]::::;
where:
•sync_aid identifies the synchronization reference to retrieve and is the AID sync_ref; sync_ref is listable and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<sync_aid>:PRIMARY=<primary>,SECOND=<second>,THIRD=<third>" ;
where:
•sync_aid is the synchronization reference to be modified and is the AID sync_ref
•primary is the AID syn_src
•second is the AID syn_src
•third is the AID syn_src
Example
Input
RTRV-SYNCN:BOYES:SYNC-NE:234::::;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "SYNC-NE:PRIMARY=FAC-1-2,SECOND=FAC-2-2,THIRD=FAC-3-2;" ;
Errors
This message generates all the default errors
11.11.87 RTRV-T1: Retrieve T1
This command retrieves the DS-1 facilities configuration.
Section
Description
Category
Other
Security
Read Only
Related Messages
ED-T1
ED-T3
OPR-LPBK-T1
OPR-LPBK-T3
RLS-LPBK-T1
RLS-LPBK-T3
RTRV-T3
Input Format
RTRV-T1:[TID]:<aid>:[CTAG]::::;
where:
•aid is the AID facility and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<aid>:STATE=<pst>,ID=<id>,LNCDE=<line_code>, FRMF=<fame_format>,LBO=<line_buildout>" ;
where:
•aid is the AID facility
•pst is of type PST
•id is a String
•line_code is of type LINE_CODE
•frame_format is of type FRAME_FORMAT
•line_buildout is of type LINE_BUILDOUT
Example
Input
RTRV-T1:TID:AID:1223::::;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "AID:STATE=OOS,ID=CISCO,LNCDE=AMI,FRMF=ESF,LBO=0-131" ;
Errors
This message generates all the default errors
11.11.88 RTRV-T3: Retrieve T3
This command retrieves the facilities properties of a DS-3 and a DS-3 transmux card.
Section
Description
Category
Other
Security
Read Only
Related Messages
ED-T1
ED-T3
OPR-LPBK-T1
OPR-LPBK-T3
RLS-LPBK-T1
RLS-LPBK-T3
RTRV-T1
Input Format
RTRV-T3:[TID]:<facility>:[CTAG]::::;
where:
•facility is the facility aid FAC-[SLOT]-[1..6] or FAC-[SLOT]-[1..12]; facility is the AID facility and must not be null
Output Format
SID DATE TIME M CTAG COMPLD "<facility>:LNTYPE=<lineType>,[LNCODE=<lineCode>],LBO=<lbo>: PST=<pst>" ;
where:
•facility is the facility aid FAC-[SLOT]-[1..6] or FAC-[SLOT]-[1..12] and is the AID facility.
•lineType is the port line type and is of type DS_LINE_TYPE
•lineCode is the port one code; lineCode is of type DS_LINE_CODE and is optional
•lbo is the circuit line buildout and is of type E_LBO
•pst is of type PST
Example
Input
RTRV-T3:CISCO:FAC-1-2:123::::;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "FAC-1-2:LNTYPE=C-BIT,LNCODE=B3ZS,LBO=0-225:PST=IS" ;
•facility is the aid type and is the AID ALL; facility must not be null
•allMontype is the monitored type and is of type ALL_MONTYPE; allMontype must not be null
•location is the location and is of type LOCATION; a null value is equivalent to "ALL"
•tmpr is the time period and is of type TMPR; a null value is equivalent to "ALL"
Output Format
SID DATE TIME M CTAG COMPLD "<facility>,[<eqptType>]:<allMontype>,[<location>],,<thval>,[<tmpr>]" ;
where:
•facility is the aid and is the AID ALL
•eqptType is of type EQPT_TYPE and is optional
•allMontype is the monitored type and is of type ALL_MONTYPE
•location is the location and is of type location; location is optional
•thVal is the threshold value and is an Integer
•tmpr is the time period and is of type TMPR; tmpr is optional
Example
Input
RTRV-TH-T3:CISCO:FAC-1-3:1234::CVL,FEND,15MIN;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "FAC-1-3,DS3-12:CVL,FEND,,1,15MIN" ;
Errors
This message generates all the default errors
11.11.90 RTRV-TOD: Retrieve Time of Day
This command queries the NE and displays the system date and time at the instant when the command was executed. The time returned is in Coordinated Universal Time (UTC).
Section
Description
Category
Other
Security
Read Only
Related Messages
N/A
Input Format
RTRV-TOD:[TID]::[CTAG];
Output Format
SID DATE TIME M CTAG COMPLD "<year>,<month>,<day>,<hour>,<minute>,<second>,,<tmtype>" ;
where:
•year is an Integer
•month is an Integer
•day is an Integer
•hour is an Integer
•minute is an Integer
•second is an Integer
•tmtype is a String
Example
Input
RTRV-TOD:CAZADERO::230;
Output
TID-000 98-06-20 14-30-00 M 001 COMPLD "1998,05,08,17,01,33,,UTC" ;
•allMontype is the monitored value and is of type ALL_MONTYPE
•thVal is the threshold value and is an Integer
•location is the location and is of type LOCATION
•tmpr is the time period and is of type TMPR
Example
Input
SET-TH-T3:CISCO:FAC-1-1:123::CVL,12,NEND,,15MIN;
Errors
This message generates all the default errors
11.11.92 SET-TOD: Set Time of Day
This command sets the system date and time for the NE. The year should be entered using four digits while the hour should be entered using a 24-hour time period (i.e. military time).
This command instructs the NE to switch duplex equipment.
Section
Description
Category
Equipment
Security
N/A
Related Messages
DLT-EQPT REPT EVT EQPT
DLT-FFP-EQPT RLS-PROTNSW-EQPT
ED-FFP-EQPT RTRV-ALM-EQPT
ENT-EQPT RTRV-COND-EQPT
ENT-FFP-EQPT RTRV-EQPT
OPR-PROTNSW-EQPT RTRV-FFP-EQPT
REPT ALM EQPT
Input Format
SW-DX-EQPT:[TID]:<eqpt>:[CTAG]::[<dxModeOp>],;
where:
•eqpt is the AID eqpt
•dxModeOp is of type DX_MODE_OP
Example
Input
SW-DX-EQPT:CISCO:SLOT-1:123::FRCD,;
Errors
This message generates all the default errors
11.12 Access Identifiers
The Access Identification code (AID) directs an input command to its intended physical or data entity inside the NE. Equipment Modules and facilities are typical examples of entities addressed by the access code.
Table 11-13 Access Identifiers
AID
Patterns
bits
BITS-ALL
BITS-{1,2}
ds-1
DS1-{1-6,12-17}-{1-6}-{1-28}
env
ENV-IN-{1-4}
eqpt
SLOT-{1-17}
SLOT-{1-6,12-17}
facility
FAC-{1-6,12-17}-1
FAC-{1-6,12-17}-{1-12}
FAC-{1-6,12-17}-{1-14}
FAC-{1-6,12-17}-{1-4}
FAC-{1-6,12-17}-{1-6}
FAC-{5,6,12,13}-1
sts
STS-{1-6,12-17}-1
STS-{1-6,12-17}-{1,4,7,10-46}
STS-{1-6,12-17}-{1-12}
STS-{1-6,12-17}-{1-6}
STS-{5,6,12,13}-{1,13,25,37}
STS-{5,6,12,13}-{1,4,7,10-46}
STS-{5,6,12,13}-{1-48}
STS-{5,6,12,13}-{1}
syn_src
FAC-{1-6,12-17}-1
FAC-{1-6,12-17}-{1-4}
FAC-{5,6,12,13}-1
INTERNAL
SYNC-NE
SYNC-{BITS1,BITS2}
sync_ref
SYNC-NE
SYNC-{BITS1,BITS2}
vt1_5
VT1-{1-6,12-17}-1-{1-14}
VT1-{1-6,12-17}-{1-12}-{1-28}
VT1-{1-6,12-17}-{1-6}-{1-28}
VT1-{5,6,12,13}-{1-48}-{1-28}
11.12.1 bits
Table 11-14 bits
Pattern
Description
BITS-ALL
BITS-1 and BITS-2
BITS-{1,2}
Individual BITS AID
11.12.2 ds-1
Used to access the DS-1 frame layer of the DS3XM-6
This section provides a description of all message parameter types defined for the TL1 messages used in the ONS 15454. The TL1 message descriptions frequently refer to this section.
11.13.1 ATAG Description
The Autonomous Message Tag (ATAG) is used for message sequencing. The number is incremented by one for each autonomous message sent by the ONS 15454. The ONS 15454 uses whole numbers 0000 to 9999.
11.13.2 CTAG Description
The Correlation tag is included in each command by the user and is repeated by the ONS 15454 in the response to allow the user to associate the command and response messages.
Note The valid values for a ctag are decimal numbers with a maximum of 6 digits in Release 2.2.1.
11.13.3 TID Description
The Target Identifier is the name of the NE where the command is addressed. TID is the Telcordia name for the system.
11.13.4 ALL_MONTYPE
Monitoring type list
Table 11-23 ALL_MONTYPE Values
ALL_MONTYPE Values
Description
AISSP
Alarm Indication Signal Seconds-Path
CVCPP
Coding Violations - CP-Bit Path
CVL
Coding Violations - Line
CVP
Coding Violations - Path
CVV
Coding Violations - Section
ESCPP
Errored Seconds - CP-Bit Path
ESL
Errored Seconds - Line
ESP
Errored Seconds - Path
ESV
Errored Seconds - VT Path
FCL
Failure Count - Line
FCP
Failure Count - Path
LOSSL
Loss of Signal Seconds - Line
NPJC-PDET
PPJC-PDET:Negative Pointer Justification
NPJC-PGEN
PPJC-PDEN:Negative Pointer Justification
PPJC-PDET
PPJC-PDET:Positive Pointer Justification
PPJC-PGEN
PPJC-PDEN:Positive Pointer Justification
PSC
Protection Switching Count
PSD
Protection Switching Duration
SASCPP
Severely Errored Framing/AIS Second - CP-Bit Path
SASP
Severely Errored Framing/AIS Seconds
SEFS
Severely Errored Framing Seconds
SESCPP
Severely Errored Second - CP-Bit Path
SESL
Severely Errored Second - Line
SESP
Severely Errored Second - Path
SESV
Severely Errored Second - VT Path
UASCPP
Unavailable Second - CP-Bit Path
UASL
Unavailable Second - Line
UASP
Unavailable Second - Path
UASV
Unavailable Second - VT Path
11.13.5 ALL_THR
Threshold list
Table 11-24 ALL_THR Value
ALL_THR Values
Description
T-AISSP
Alarm Indication Signal Seconds-Path
T-CVCPP
Coding Violations - CP-Bit Path
T-CVL
Coding Violations - Line
T-CVP
Coding Violations - Path
T-CVS
Coding Violations - Section
T-CVV
Coding Violations - VT Path
T-ESCPP
Errored Seconds - CP-Bit Path
T-ESL
Errored Seconds - Line
T-ESP
Errored Seconds - Path
T-ESS
Errored Seconds - Section
T-ESV
Errored Seconds - VT Path
T-FCL
Failure Count - Line
T-FCP
Failure Count - Path
T-LOSSL
Loss of Signal Seconds - Line
T-PJNEG
PPJC-PDET:Negative Pointer Justification
T-PJNEG-GEN
PPJC-PGEN:Negative Pointer Justification
T-PJPOS
PPJC-PDET:Positive Pointer Justification
T-PJPOS-GEN
PPJC-PGEN:Positive Pointer Justification
T-PSC
Protection Switching Count
T-PSD
Protection Switching Duration
T-SASCPP
Severely Errored Framing/AIS Second - CP-Bit Path
T-SASP
Severely Errored Framing/AIS Seconds
T-SEFS
Severely Errored Framing Seconds
T-SESCPP
Severely Errored Second - CP-Bit Path
T-SESL
Severely Errored Second - Line
T-SESP
Severely Errored Second - Path
T-SESS
Severely Errored Second - Section
T-SESV
Severely Errored Second - VT Path
T-UASCPP
Unavailable Second - CP-Bit Path
T-UASL
Unavailable Second - Line
T-UASP
Unavailable Second - Path
T-UASV
Unavailable Second - VT Path
11.13.6 CCT
Defines the type of cross-connect to be created.
Table 11-25 CCT Values
CCT Values
Description
1WAY
A unidirectional connection from a source tributary to a destination tributary
2WAY
A bidirectional connection between the two tributaries
MON
Monitored cross connection
11.13.7 COND_EFF
The affected unit's condition
Table 11-26 COND_EFF Values
COND_EFF Values
Description
CL
Standing condition cleared
SC
Standing condition raised
TC
Transient condition
11.13.8 CONDITION
The condition type of the alarm indication
Table 11-27 CONDITION Values
CONDITION Values
Description
ACOMAN
Alarm cutoff is in manual mode
AIS
External failure - Incoming - Alarm Indication Signal
AIS-L
External failure - Incoming - Alarm Indication Signal - Line
AIS-P
External failure - Incoming - Alarm Indication Signal - Path
Internal hardware - Control Equipment -Working memory failure
WKSWBK
Recovery action - Working facility/equipment switched back to working
WKSWPR
Recovery action - Working facility/equipment switched to protection unit
WRMRESTART
Recovery action - Warm Restart
WTR
Recovery action - SONET line is in Wait To Restore state
11.13.9 DIRECTION
Transmit and receive directions
Table 11-28 DIRECTION Values
DIRECTION Values
Description
BTH
Both transmit and receive directions
RCV
Receive direction only
TRMT
Transmit direction only
11.13.10 DS3_FMT
Indicates a DS-3 digital signal format
Table 11-29 DS3_FMT Values
DS3_FMT Values
Description
ASYNC
The DS-3 digital signal format is ASYNC
CBIT
The DS-3 digital signal format is C-BIT
SYNC
The DS-3 digital signal format is SYNC
UNFR
The DS-3 digital signal format is unframed
11.13.11 DS_LINE_CODE
DS-123 Line Code
Table 11-30 DS_LINE_CODE Values
DS_LINE_CODE Values
Description
B3ZS
Bipolar with Three-Zero Substitution
11.13.12 DS_LINE_TYPE
DS-123 Line type
Table 11-31 DS_LINE_TYPE Values
DS_LINE_TYPE Values
Description
C-BIT
C-BIT line type applies to DS3XM card
M23
M23 line type applies to DS3XM card
UNFRAMED
Line Type is Unframed
11.13.13 DX_MODE_OP
Duplex switch operation mode
Table 11-32 DX_MODE_OP Values
DX_MODE_OP Values
Description
FRCD
Forced Switch
MAN
Manual Switch
11.13.14 E_LBO
Electrical signal line buildout
Table 11-33 E_LBO Values
E_LBO Values
Description
0-225
Electrical signal buildout range is 0-255
226-450
Electrical signal buildout range is 255-450
11.13.15 ENV_ALM
Environmental alarm types as defined by Telcordia GR-833-CORE, Issue 2, November 1996, Appendix F.
Table 11-34 ENV_ALM Values
ENV_ALM Values
Description
AIRCOMPR
Air compressor failure
AIRCOND
Air conditioning failure
AIRDRYR
Air dryer failure
BATDSCHRG
Battery discharging
BATTERY
Battery failure
CLFAN
Cooling fan failure
CPMAJOR
Centralized power major failure
CPMINOR
Centralized power minor failure
ENGINE
Engine failure
ENGOPRG
Engine operating
EXPLGS
Explosive gas
FIRDETR
Fire detector failure
FIRE
Fire
FLOOD
Flood
FUSE
Fuse failure
GEN
Generator failure
HIAIR
High airflow
HIHUM
High humidity
HITEMP
High temperature
HIWTR
High water
INTRUDER
Intrusion
LWBATVG
Low battery voltage
LWFUEL
Low fuel
LWHUM
Low humidity
LWPRES
Low cable pressure
LWTEMP
Low temperature
LWWTR
Low water
MISC
Miscellaneous
OPENDR
Open door
POWER
Commercial power failure
PUMP
Pump failure
PWR-48
48 Volt power supply failure
RECT
Rectifier failure
RECTHI
Rectifier high voltage
RECTLO
Rectifier low voltage
SMOKE
Smoke
TOXICGAS
Toxic gas
VENTN
Ventilation system failure
11.13.16 ENV_CTL
Environmental control types as defined by Telcordia GR-833-CORE, Issue 2, November 1996, Appendix G.
Table 11-35 ENV_CTL Values
ENV_CTL Values
Description
AIRCOND
Air conditioning
ENGINE
Engine
FAN
Fan
GEN
Generator
HEAT
Heat
LIGHT
Light
MISC
Miscellaneous
SPKLR
Sprinkler
11.13.17 EQPT_TYPE
Identifies the type of equipment being provisioned into a slot.
Table 11-36 EQPT_TYPE Values
EQPT_TYPE Values
Description
AIC
The Alarm Interface Controller Card is an optional card which expands system management capabilities for the customer defined alarm I/O and orderwire functionality
DCC
The Data Communications Channel communicates network management information
DS1-14
A 14 port interface card supporting DS-1 facilities
DS1N-14
A 14 port interface card supporting DS-1 facilities
DS3-12
A 12 port interface card supporting DS-3 facilities
DS3CR-12
Cost reduced DS-3
DS3N-12
A 12 port interface card supporting DS-3 facilities
DS3XM-6
An interface card that converts six framed DS-3 network connections to 28x6 or 168 VT1.5s
E1000T-2
A two port interface card supporting 1000 Base T ethernet facilities
E100T-12
A 12 port interface card supporting 100 Base T ethernet facilities
EC1-12
A 12 port interface card supporting EC-1 facilities
EC1N-12
A 12 port interface card supporting EC-1 facilities
OC-12
An interface card that supports one or more OC-12 (622Mbs) optical facilities
OC12-IR-1
An interface card that supports one intermediate range OC-12 (622Mbs) optical facilities
OC12-LR-1
An interface card that supports one long range OC-12 (622Mbs) optical facilities
OC12-SR-1
An interface card that supports one short range OC-12 (622Mbs) optical facilities
OC192-LR-1
An interface card that supports one or more long range OC-192 optical facilities
OC-3
An interface card that supports multiple OC-3 (155Mbs) optical facilities
OC3-IR-4
An interface card that supports four intermediate range OC-3 (155Mbs) optical facilities
OC3-SR-4
An interface card that supports four short range OC-3 (155Mbs) optical facilities
OC-48
An interface card that supports one or more OC-48 (10Gbs) optical facilities
OC48-IR-1
An interface card that supports one intermediate range OC-48 (10Gbs) optical facilities
OC48-LR-1
An interface card that supports one long range OC-48 (10Gbs) optical facilities
OC48-SR-1
An interface card that supports one short range OC-48 (10Gbs) optical facilities
TCC
The Timing, Communication and Control card
TCC+
The Timing, Communication and Control+ card
XC
A Cross-Connect card
XC-192
A Cross-Connect card
XC-VT
A Cross-Connect card
11.13.18 EQUIP
Indicates the presence of a plug-in unit
Table 11-37 EQUIP Values
EQUIP Values
Description
EQUIP
The unit is Equipped - present
UNEQUIP
The unit is Unequipped - absent
11.13.19 EQUIPMENT_TYPE
Table 11-38 EQUIPMENT_TYPE Values
EQUIPMENT_TYPE Values
Description
AIC
AIC card
DS-1
DS-1 card
DS-1N
DS-1N card
DS-3
DS-3 card
DS-3N
DS-3N card
DS3XM
DS3XM card
E-100T
E-100T card
E-1000T
E-1000T card
EC-1
EC-1 card
EC-1N
EC-1N card
OC-12
OC-12 card
OC-3
OC-3 card
OC-48
OC-48 card
TCC
TCC card
TCC+
TCC+ card
XC-STS
XC-STS card
XC-VT
XC-VT card
11.13.20 EXT_RING
Indicates if the ring supports the extended K1/K2/K3 protocol.
Table 11-39 EXT_RING Values
EXT_RING Values
Description
N
Indicates the Ring does not support the extended K1/K2/K3 protocol
Y
Indicates the Ring does support the extended K1/K2/K3 protocol
11.13.21 FRAME_FORMAT
The frame format for a T1 port
Table 11-40 FRAME_FORMAT Values
FRAME_FORMAT Values
Description
D4
Frame format is D4
ESF
Frame format is ESF
UNFRAMED
Frame format is unframed
11.13.22 LINE_BUILDOUT
Table 11-41 LINE_BUILDOUT Values
LINE_BUILDOUT Values
Description
0-131
Line buildout range is 0-131
132-262
Line buildout range is 132-262
263-393
Line buildout range is 263-393
394-524
Line buildout range is 394-524
525-655
Line buildout range is 525-655
11.13.23 LINE_CODE
Table 11-42 LINE_CODE Values
LINE_CODE Values
Description
AMI
Line code value is AMI
B8ZS
Line code value is B8ZS (Bipolar with Eight-Zero Substitution)
11.13.24 LOCATION
Identifies the location where the action is to take place
Table 11-43 LOCATION Values
LOCATION Values
Description
FEND
Action occurs on the Far End of the facility
NEND
Action occurs on the Near End of the facility
11.13.25 LPBK_TYPE
Indicates the type of loopback that is to be operated or released
Table 11-44 LPBK_TYPE Values
LPBK_TYPE Values
Description
FACILITY
A type of loopback that connects the incoming received signal immediately following the optical-to-electrical conversion (before descrambling) to the associated transmitter in the return direction
TERMINAL
A loopback that connects the signal that is about to be transmitted (after scrambling but before the electrical-to-optical conversion) is connected to the associated, incoming receiver
11.13.26 MOD2
A generic object type
Table 11-45 MOD2 Values
MOD2 Values
Description
DS-1
DS-1 facility on DS3XM
EC-1
EC-1 facility
OC-12
OC-12 facility
OC-3
OC-3 facility
OC-48
OC-48 facility
STS-1
STS path
STS-12C
STS path
STS-3C
STS path
STS-48C
STS path
T1
DS-1 facility
T3
DS-3 facility
VT1
VT1 path
11.13.27 MOD2ALM
Alarm type for certain generic TL1 commands
Table 11-46 MOD2ALM Values
MOD2ALM Values
Description
DS-1
DS-1 alarm
E-100
E-100 alarm
E-1000
E-1000 alarm
EC-1
EC-1 alarm
OC-12
OC-12 alarm
OC-3
OC-3 alarm
OC-48
OC-48 alarm
STS-1
STS-1 alarm
STS-12C
STS-12C alarm
STS-3C
STS-3C alarm
STS-48C
STS-48C alarm
T1
T1 alarm
T3
T3 alarm
VT1
VT1 alarm
11.13.28 MOD2B
Alarm type for certain generic TL1 commands
Table 11-47 MOD2B Values
MOD2B Values
Description
BITS
BITS alarm
COMM
COMM alarm
DS-1
DS-1 alarm
E-100
E-100 alarm
E-1000
E-1000 alarm
EC-1
EC-1 alarm
ENV
ENV alarm
EQPT
EQPT alarm
OC-12
OC-12 alarm
OC-3
OC-3 alarm
OC-48
OC-48 alarm
STS-1
STS alarm
STS-12C
STS alarm
STS-3C
STS alarm
STS-48C
STS alarm
SYNCN
SYNCN alarm
T1
T1 alarm
T3
T3 alarm
TCC
TCC alarm
TCC+
TCC+ alarm
VT1
VT alarm
11.13.29 MODIFIER
Modifier for certain TL1 commands that are generic in their syntax
Table 11-48 MODIFIER Values
MODIFIER Values
Description
BITS
BITS command modifier
EQPT
Equipment command modifier
OC-12
OC-12 command modifier
OC-3
OC-3 command modifier
OC-48
OC-48 command modifier
STS-1
STS-1 command modifier
STS-12C
STS-12c command modifier
STS-3C
STS-3c command modifier
SYNCN
Synchronization command modifier
T3
T3/DS-3 command modifier
11.13.30 NOTIF_CODE
The 2-character Notification Code associated with an autonomous message
Table 11-49 NOTIF_CODE Values
NOTIF_CODE Values
Description
CL
The condition causing the alarm has Cleared
CR
A Critical alarm
MJ
A Major alarm
MN
A Minor alarm
NA
The condition is Not Alarmed
NR
The alarm is not reported
11.13.31 OCN_MONTYPE
OCN monitor type
Table 11-50 OCN_MONTYPE Values
OCN_MONTYPE Values
Description
CVL
Coding Violation - Line
ESL
Errored Second - Line
PJNEG
PPJC-PDET:Negative Pointer Justification
PJPOS
PPJC-PGEN:Negative Pointer Justification
PSC
Protection Switching Count
PSD
Protection Switching Duration
SEFS
Severely Errored Framing Seconds
UASL
Unavailable Second - Line
11.13.32 OCN_TYPE
Modifier used to differentiate the various levels of OC-N in the ENT/ED/DLT commands
Table 11-51 OCN_TYPE Values
OCN_TYPE Values
Description
OC-12
Optical Carrier level-12 (622Mbs)
OC-3
Optical Carrier level-3 (155Mbs)
OC-48
Optical Carrier level-48 (2.4Gbs)
11.13.33 ON_OFF
Disable or Enable Mode
Table 11-52 ON_OFF Values
ON_OFF Values
Description
OFF
Mode is disabled
ON
Mode is enabled
11.13.34 OPTICAL_MODE
Table 11-53 OPTICAL_MODE Values
OPTICAL_MODE Values
Description
SDH
The SDH optical mode the European format
SONET
The SONET optical mode the American format
11.13.35 PRIVILEGE
Security level
Table 11-54 PRIVILEGE Values
PRIVILEGE Values
Description
MAINT
Maintenance Security Level
PROV
Provision Security Level
RTRV
Retrieve Security Level
SUPER
Superuser Security Level
11.13.36 PROT_MOD_OP
Protection switch operation mode
Table 11-55 PROT_MOD_OP Values
PROT_MOD_OP Values
Description
FRCD
Force switch operation mode
MAN
Manual switch operation mode
11.13.37 PROTECTION_GROUP
Table 11-56 PROTECTION_GROUP Values
PROTECTION_GROUP Values
Description
1-1
1 to 1 protection group
1-N
1 to N protection group
11.13.38 PST
Primary State of the entity (e.g. facility)
Table 11-57 PST Values
PST Values
Description
IS
In-service
OOS
Out-of-Service
11.13.39 REVERTIVE_TIME
Table 11-58 REVERTIVE_TIME Values
REVERTIVE_TIME Values
Description
0.0 - 12.0
Revertive time is 0.0 to 12.0 minutes
11.13.40 REVERTIVE_TYPE
Table 11-59 REVERTIVE_TYPE Values
REVERTIVE_TYPE Values
Description
NR
Revertive type is disabled
R
Revertive type is enabled
11.13.41 RNG_TYPE
Defines the type of ring that is to be deployed for this path
Table 11-60 RNG_TYPE Values
RNG_TYPE Values
Description
BLSR2
2-Fiber Bidirectional Line Switched Ring
BLSR4
4-Fiber Bidirectional Line Switched Ring
UPSR
Unidirectional Path Switched Ring
11.13.42 SD_BER
The threshold for declaring Signal Degrade on a facility or path
Table 11-61 SD_BER Values
SD_BER Values
Description
1E-5 - 1E-9
SDBER is the 1E-5 to 1E-9
11.13.43 SDCC_MODE
Enables or disables the Section Data Communications Channel (SDCC) for the specified facility
Table 11-62 SDCC_MODE Values
SDCC_MODE Values
Description
N
Section Data Communications Channel is disabled for this facility
Y
Section Data Communications Channel is enabled for this facility
11.13.44 SERV_EFF
Indicates the effect of the alarm on service
Table 11-63 SERV_EFF Values
SERV_EFF Values
Description
NSA
The condition is Non-Service Affecting
SA
The condition is Service Affecting
11.13.45 SF_BER
The threshold for declaring Signal Failure on a facility or path
Table 11-64 SF_BER Values
SF_BER Values
Description
1E-3 - 1E-5
SFBER is the 1E-3 to 1E-5
11.13.46 SIDE
The role the unit is playing in the protection group
Table 11-65 SIDE Values
SIDE Values
Description
PROT
The entity is the protection unit in the protection group
WORK
The entity is a working unit in the protection group
11.13.47 STATE
The provisioned state of the equipment unit or facility
Table 11-66 STATE Values
STATE Values
Description
IS
The entity is InService
OOS-AS
The entity is Out-Of-Service and Assigned
OOS-UAS
The entity is Out-Of-Service and UnAssigned
11.13.48 STATUS
Indicates whether the unit in the pair is Active or Standby
Table 11-67 Status Values
STATUS Values
Description
ACT
The entity is the Active unit in the protection group
NA
Status is unavailable
STBY
The entity is the standby unit in the protection group
11.13.49 STM_TYPE
The Synchronous Transport Mode of the NE
Table 11-68 STM_TYPE Values
STM_TYPE Values
Description
SDH
The NE is operating in Synchronous Digital Hierarchy mode
SONET
The NE is operating in Synchronous Optical NETwork mode
11.13.50 STS_MONTYPE
Table 11-69 STS_MONOTYPE Values
STS_MONTYPE Values
Description
CVP
Coding Violation - P
ESP
Errored Second - Path
SESP
Severely Errored Second - Path
UASP
Unavailable Second - Path
11.13.51 STS_PATH
Modifier for some of the STS commands
Table 11-70 STS_PATH Values
STS_PATH Values
Description
STS-1
Synchronous Transport Signal level-1 (51Mbs)
STS-12C
Synchronous Transport Signal level-12 Concatenated (622Mbs)
STS-3C
Synchronous Transport Signal level-3 Concatenated (155Mbs)
11.13.52 SWITCH
The type of switch to be initiated
Table 11-71 SWITCH Values
SWITCH Values
Description
FRCD
Force a switch unless another FRCD or LOCKOUT is in effect
LOCKOUT
Locks the facility out of switching. The system cannot switch to the protect facility to carry service
MAN
Requests a manual switch of the facility
11.13.53 SYNC_GENERATION
Synchronization status message set generation
Table 11-72 SYNC_GENERATION Values
SYNC_GENERATION Values
Description
GEN1
First generation SSM set
GEN2
Second generation SSM set
11.13.54 SYNC_MODE
Table 11-73 SYNC_MODE Values
SYNC_MODE Values
Description
FRNG
Reset operation mode
FST
Reset operation mode
HLDOVR
Reset operation mode
NORM
Reset operation mode
11.13.55 SYNC_QUALITY_LEVEL
Reserved for network synchronization quality level
Table 11-74 SYNC_QUALITY_LEVEL Values
SYNC_QUALITY_LEVEL Values
Description
ABOVE-PRS
Better than Primary Reference Source
ABOVE-SMC
Between SMC and ST3
ABOVE-ST2
Between ST2 and STU
ABOVE-ST3
Between ST3 and ST2
ABOVE-ST3E
Between ST3E and TNC
ABOVE-ST4
Between ST4 and ST3
ABOVE-STU
Between STU and PRS
ABOVE-TNC
Between TNC and PRS
BELOW-ST4
Below ST4 but still usable
SAME-AS-DUS
Disable the RES message by equating it to DUS
11.13.56 TIMING_MODE
Timing mode for the current node
Table 11-75 TIMING_MODE Values
TIMING_MODE Values
Description
EXTERNAL
The node derives its clock from the BITS input
LINE
The node derives its clock from the SONET lines
11.13.57 TMG_REF
Identifies whether or not this entity is the Timing Reference for its group. For equipment, it identifies the facility that is supplying the timing reference. For interface groups, it identifies the card that is supplying the main timing reference.
Table 11-76 TMG_REF Values
TMG_REF Values
Description
N
This facility or card is not a timing reference
Y
This facility or card is a timing reference
11.13.58 TMPR
Performance parameter
Table 11-77 TMPR Values
TMPR Values
Description
15MIN
Performance Parameter Accumulation Interval Length - Every 15 Minutes
1DAY
Performance Parameter Accumulation Interval Length - Every 24 Hours
11.13.59 USE_DST
Identifies whether Daylight Saving Time is recognized in the area where this NE is deployed
Table 11-78 USE_DST Values
USE_DST Values
Description
N
Daylight Saving Time is not recognized
Y
Daylight Saving Time is recognized
11.13.60 VALIDITY
Response validity
Table 11-79 VALIDITY Values
VALIDITY Values
Description
COMPL
Complete Response
PRTL
Partial Response
11.13.61 Performance Monitoring Parameters by Line Type
Table 11-80 Performance Monitoring Parameters by Line Type
OC-n
T1
T3
STS
VT1.5
CVL
Y
Y
Y
CVP
Y
Y
Y
CVS
Y
CVV
Y
ESL
Y
Y
Y
ESP
Y
Y
Y
ESS
Y
ESV
Y
FCP
Y
FCL
Y
PJNEG
Y
PJPOS
Y
PSC
Y
PSD
Y
SASP
Y
Y
SEFS
Y
SESL
Y
Y
Y
SESP
Y
Y
Y
SESS
Y
SESV
Y
UASL
Y
UASP
Y
Y
Y
UASV
Y
AISSP
Y
Y
CVCPP
Y
ESCPP
Y
LOSSL
Y
SASCPP
Y
SESCPP
Y
UASCPP
Y
11.14 Errors
Errors may be generated by any command or command response message. The format of an error message is as follows:
sid date time M ctag DENY <errcde> /* <errmsg> */ ;
Table 11-81 Error Codes
Error Code
(errcde)
Error Type
Error Message (errmsg)
EANS
EQUIPAGE
Access Not Supported
EATN
EQUIPAGE
Not Valid for Access Type
EFON
EQUIPAGE
Feature Option Not Provided
EN2T
EQUIPAGE
Not 2-Wire Terminate and Leave
ENAC
EQUIPAGE
Not Equipped with Alarm Cutoff
ENAD
EQUIPAGE
Not Equipped with Audit Capability
ENAR
EQUIPAGE
Not Equipped with Automatic Reconfiguration
ENAT
EQUIPAGE
Request Not Valid for Access Type
ENDG
EQUIPAGE
Not Equipped with Diagnostic Capability
ENDS
EQUIPAGE
Not Equipped with Duplex Switching
ENEA
EQUIPAGE
Not Equipped with Error Analysis Capability
ENEQ
EQUIPAGE
Not Equipped
ENEX
EQUIPAGE
Not Equipped with Exercise Capability
ENFE
EQUIPAGE
Feature Not Provided
ENFL
EQUIPAGE
Not Equipped for Fault Locating
ENHN
EQUIPAGE
Not Hybrid Network
ENMB
EQUIPAGE
Not Multipoint Bridge
ENMD
EQUIPAGE
Not Equipped with Memory Device
ENPM
EQUIPAGE
Not Equipped for Performance Monitoring
ENPS
EQUIPAGE
Not Equipped with Protection Switching
ENRE
EQUIPAGE
Not Recognized Equipage
ENRI
EQUIPAGE
Not Equipped for Retrieving Specified Information
ENRS
EQUIPAGE
Not Equipped for Restoration
ENSA
EQUIPAGE
Not Equipped for Scheduling Audit
ENSG
EQUIPAGE
Not Software Generic
ENSI
EQUIPAGE
Not Equipped for Setting Specified Information
ENSS
EQUIPAGE
Not Equipped with Synchronization Switching
ENTL
EQUIPAGE
Not Terminate and Leave
ERLC
EQUIPAGE
Red-Lined Circuit
ERNS
EQUIPAGE
RTU Does Not Support Command
ESPG
EQUIPAGE
Software Program
ETNS
EQUIPAGE
TSC Does Not Support Command
FNCR
FAULT
NE Failure - Circuit Restored to Last Condition - Monitor or Terminate
FNDT
FAULT
No Dial Tone Detected
FNEC
FAULT
NTE Has Lost 8-KHZ Byte Clock
FNSC
FAULT
NTE Has Lost 16-KHZ Byte Clock
FRCE
FAULT
RTU Component or Configuration Error
FRDA
FAULT
RTU Does Not Answer the Call
FREC
FAULT
RTU Eight KHZ Byte Clock Lost
FRNR
FAULT
RTU Does Not Reply
IBEX
INPUT
Block Extra
IBMS
INPUT
Block Missing
IBNC
INPUT
Block Not Consistent
ICNV
INPUT
Command Not Valid
IDMS
INPUT
Data Missing
IDNC
INPUT
Data Not Consistent
IDNV
INPUT
Data Not Valid
IDRG
INPUT
Data Range Error
IIAC
INPUT
Invalid Access Identifier (AID)
IICM
INPUT
Invalid Command
IICT
INPUT
Invalid Correlation Tag
IIDT
INPUT
Invalid Data Parameter
IIFM
INPUT
Invalid Data Format
IIPG
INPUT
Invalid Parameter Grouping
IISP
INPUT
Invalid Syntax or Punctuation
IITA
INPUT
Invalid Target Identifier
INAC
INPUT
Access Number Not Correct
INUP
INPUT
Non-Null Unimplemented Parameter
IPEX
INPUT
Parameter Extra
IPMS
INPUT
Parameter Missing
IPNC
INPUT
Parameter Not Consistent
IPNV
INPUT
Parameter Not Valid
ISCH
INPUT
Syntax Invalid Character
ISPC
INPUT
Syntax Punctuation
ITSN
INPUT
Invalid/Inactive Test Session Number
PICC
PRIVILEGE
Illegal Command Code
PIMA
PRIVILEGE
Invalid Memory Address
PIMF
PRIVILEGE
Invalid Memory File
PIUC
PRIVILEGE
Illegal Privilege Code
PLNA
PRIVILEGE
Login Not Active
RABY
RESOURCE
All Taps Busy
RALB
RESOURCE
All Units of Requested Type are Busy
RANB
RESOURCE
Access Network Busy
RCBY
RESOURCE
Circuit Busy
RCIN
RESOURCE
Requested Circuit ID Does Not Exist
RNAN
RESOURCE
Requested NE Access Number Does Not Exist
RNAU
RESOURCE
Requested NE Access Number Unassigned
RNBY
RESOURCE
NE is Busy
RRCP
RESOURCE
Unit Specified by Routing Code Busy
RRNG
RESOURCE
Requested Changes Exceeds Range
RTBY
RESOURCE
Requested Tap Busy
RTEN
RESOURCE
Requested Tab Does Not Exist
RTUB
RESOURCE
Test Unit Busy
SAAL
STATUS
Already Allowed
SAAS
STATUS
Already Assigned
SABT
STATUS
Aborted
SACS
STATUS
Access Unit Cannot Sync on Facility Signal
SADC
STATUS
Already Disconnected
SADS
STATUS
Access Unit in Diagnostic State
SAIN
STATUS
Already Inhibited
SAIS
STATUS
Already In-Service
SAMS
STATUS
Already in Maintenance State
SAOP
STATUS
Already Operated
SAOS
STATUS
Already Out-of-Service
SAPF
STATUS
Access Path Continuity Check Failed
SAPR
STATUS
Already in Protection State
SARB
STATUS
All Resources Busy
SATF
STATUS
Automatic Test Failed
SCAT
STATUS
Circuit is Already Connected to Another Tap
SCBS
STATUS
Channel Busy
SCIS
STATUS
Circuit in Split Condition
SCNA
STATUS
Command Not Able to be Aborted
SCNF
STATUS
Command Not Found
SCNS
STATUS
Circuit Not in Split Condition
SCOS
STATUS
Channel Out-of-Service
SCSD
STATUS
Can't Split DS0B Circuit
SCSN
STATUS
Invalid Command Sequence
SDAS
STATUS
Diagnosis Already Started
SDBE
STATUS
Internal Data Base Error
SDFA
STATUS
Duplex Unit Failed
SDLD
STATUS
Duplex Unit Locked
SDNA
STATUS
Dumple Unit Not Available
SDNC
STATUS
Input Data is Not Consistent With NE Data
SDNR
STATUS
Data Not Ready
SDNS
STATUS
Diagnosis Not Started Yet
SEOS
STATUS
NTE is Out-of-Service
SFAS
STATUS
Fault Locating Already Started
SFNS
STATUS
Fault Locating Not Started yet
SFYA
STATUS
Facility Reports Yellow Alarm
SLNS
STATUS
Log Not Started Yet
SLOS
STATUS
TSC to RTU Link Out-of-Service
SNCC
STATUS
Not Cross-Connected
SNCN
STATUS
NTE Unable to Execute Command
SNDS
STATUS
NTE is in a Diagnostic State
SNIM
STATUS
NTE Access Complete, Circuit was in Monitor State
SNIS
STATUS
Not in Service
SNML
STATUS
No Monitor Line Established
SNNB
STATUS
NTE Could Not Sync on DS0B Signal
SNNS
STATUS
NTE Could Not Sync on DS-1 Signal
SNOS
STATUS
NTE is Out-of-Service
SNPR
STATUS
Not in Protection State
SNRM
STATUS
System Not in Restoration Mode
SNRS
STATUS
Not Reserved
SNSR
STATUS
No Switch Request Outstanding
SNVS
STATUS
Not in Valid State
SNYA
STATUS
NTE has Detected a Yellow Alarm
SOSE
STATUS
Operating System Error
SOST
STATUS
Out-of-Service, Testing
SPFA
STATUS
Protection Unit Failed
SPLD
STATUS
Protection Unit Locked
SPNA
STATUS
Process Not Able to be Aborted
SPNF
STATUS
Process Not Found
SRAC
STATUS
Requested Access Configuration is Invalid
SRAN
STATUS
Unable to Release Access System
SRCI
STATUS
Requested Command(s) Inhibited
SRCN
STATUS
Requested Condition Already Exists
SROF
STATUS
Requested Operation Failed
SROS
STATUS
Required RTU Out of Service
SRQN
STATUS
Invalid Request
SRTN
STATUS
Unable to Release Tap
SRTO
STATUS
Reply Timeout Occurred
SSCE
STATUS
Systemic (SNIDER) Communications Error
SSNG
STATUS
Subrate Selected is Incorrect
SSNP
STATUS
Speed Selected is Incorrect
SSNQ
STATUS
Test Signal Not QRS
SSRD
STATUS
Switch Request Denied
SSRE
STATUS
System Resources Exceeded
STAB
STATUS
Test Aborted
STLC
STATUS
Tap Unable to Locate Channel
STNO
STATUS
TSC/RTU to TAU Link Out of service
STOS
STATUS
Test Access Unit Out of Service
STTI
STATUS
Tap Idle
SWFA
STATUS
Working Unit Failed
SWLD
STATUS
Working Unit Locked
11.15 Echo
In order to improve telnet functionality for automated systems, the echo function was been turned off in Release 2.1.0. This change is transparent to users running standard UNIX-compliant telnet clients; however, PC users may need to change their client setup to enable "local echo." This is normally accomplished by a pull-down menu or a preference attribute.
To test the local echo on your PC client, use the RTRV-HDR command. If you receive a response but no data, set local echo ON.
Feedback
Equipment Alarms
