|
Table Of Contents
4.1.3 Environmental Alarms and Controls
4.3.79 SYNC_CLOCK_REF_QUALITY_LEVEL
TL1 Command Components
This chapter describes the components of TL1 commands and autonomous messages for the Cisco ONS 15454 and the Cisco ONS 15327, Release 3.3, including:
•TL1 default values
•Access identifiers (AIDs)
•Parameter types
4.1 TL1 Default Values
4.1.1 BLSR
4.1.2 Cross Connections
Table 4-2 Cross Connections
Cross Connections DefaultCCT
2WAY for both STSp and VT1 cross connections
4.1.3 Environmental Alarms and Controls
4.1.4 Equipment
4.1.5 Performance
4.1.6 Ports
4.1.7 SONET Line Protection
4.1.8 STS and VT Paths
4.1.9 Synchronization
4.2 Access Identifiers
The AID code 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.
4.2.1 ALL
4.2.2 CrossConnectID
(ONS 15454 only)
4.2.3 PRSLOT
(ONS 15454 only)
Valid protection slots for the electrical cards
4.2.4 BITS
4.2.4.1 BITS for ONS 15454
AID for BITS
Table 4-13 BITS for ONS 15454
Pattern DescriptionBITS-ALL
BITS AIDS of both BITS-1 and BITS-2 in the RTRV-BITS
commandBITS-{1,2}
Individual BITS AID
4.2.4.2 BITS for ONS 15327
AID for BITS
Table 4-14 BITS for ONS 15327
Pattern DescriptionBITS-ALL
BITS AIDS of both BITS-1 and BITS-2 in the RTRV-BITS
commandBITS-{1,2}
Individual BITS AID
4.2.5 BLSR
4.2.5.1 BLSR for ONS 15454
BLSR AIDs are used to access the specific BLSR of the NE.
Table 4-15 BLSR for ONS 15454
Pattern DescriptionALL
The whole BLSR of the NE
BLSR-{0-9999}
Individual BLSR of the NE
4.2.5.2 BLSR for ONS 15327
BLSR AIDs are used to access the specific BLSR of the NE.
Table 4-16 BLSR for ONS 15327
Pattern DescriptionALL
The whole BLSR of the NE
BLSR-ALL
The whole BLSR of the NE
BLSR-{0-9999}
Individual BLSR of the NE
4.2.6 DS1
(ONS 15454 only)
Used to access the DS-1 frame layer of the DS3XM.
Table 4-17 DS1 for ONS 15454
Pattern DescriptionDS1-{1-6,12-17}-{1-6}-{1-28}
(ONS 15454 only)DS1 AID for the DX3XM card
4.2.7 ENV
4.2.7.1 ENV for ONS 15454
The environmental AID for the AIC card
Table 4-18 ENV for ONS 15454
Pattern DescriptionENV-{IN,OUT}-{1-4}
6 Input, 2 OutputEnvironmental alarm AID. "IN" is used for environmental AID, "OUT" is used for control AID.
4.2.7.2 ENV for ONS 15327
The environmental components within the XTC card.
Table 4-19 ENV for ONS 15327
Pattern DescriptionENV-{IN,OUT}-{1-6}
4 Input, 4 OutputEnvironmental alarm AID. "IN" is used for environmental AID, "OUT" is used for control AID.
4.2.8 EQPT
4.2.8.1 EQPT for ONS 15454
Equipment AIDs are used to access specific cards. The OC48/OC192 cards can only use the high speed slots (Slot 5, Slot 6, Slot 12, Slot 13).
4.2.8.2 EQPT for ONS 15327
Equipment AIDs are used to access specific cards. The I/O cards can only use the I/O slots (Slots 1-4). Slots 5a nd 6 are reserved for the XTC cards and Slots 7 and 8 are reserved for MIC cards.
Table 4-21 EQPT for ONS 15327
Pattern DescriptionSLOT-ALL
All of the NE equipment AIDs
SLOT-{1-8}
Individual equipment AID of an NE
4.2.9 FACILITY
4.2.9.1 FACILITY for ONS 15454
Facilities AIDs are used to access specific ports.
4.2.9.2 FACILITY for ONS 15327
Facilities AIDs are used to access specific ports.
4.2.10 STS
4.2.10.1 STS for ONS 15454
SONET frame-level AID set
4.2.10.2 STS for ONS 15327
SONET frame-level AID set
4.2.11 SYN
4.2.11.1 SYN for ONS 15454
Synchronization AIDs
4.2.11.2 SYN for ONS 15327
Synchronization AIDs
4.2.12 SYN_SRC
4.2.12.1 SYN_SRC for ONS 15454
Synchronization source
4.2.12.2 SYN_SRC for ONS 15327
Synchronization source
4.2.13 SYNC_REF
4.2.13.1 SYNC_REF for ONS 15454
Synchronization AIDs
Table 4-30 SYNC_REF for ONS 15454
Pattern DescriptionSYNC-ALL
NE, BITS1 and BITS2 sync AIDs used for the RTRV-SYNCN command only
SYNC-NE
NE sync AID
SYNC-{BITS1,BITS2}
BITS1 and BITS2 sync AIDs
4.2.13.2 SYNC_REF for ONS 15327
Synchronization AIDs
Table 4-31 SYNC_REF for ONS 15327
Pattern DescriptionSYNC-ALL
NE, BITS1 and BITS2 sync AIDs used for the RTRV-SYNCN command only
SYNC-NE
NE sync AID
SYNC-{BITS1,BITS2}
BITS1 and BITS2 sync AIDs
4.2.14 SYNCSW
4.2.14.1 SYNCSW for ONS 15454
New synchronization reference that will be used
4.2.14.2 SYNCSW for ONS 15327
New synchronization reference that will be used
4.2.15 TAP
4.2.15.1 TAP for ONS 15454
Test access path AID which indicates the TAP number
4.2.15.2 TAP for ONS 15327
Test access path AID which indicates the TAP number
4.2.16 VT1_5
4.2.16.1 VT1_5 for ONS 15454
Virtual termination AIDs
4.2.16.2 VT1_5 for ONS 15327
Virtual termination AIDs
4.3 Parameter Types
This section provides a description of all message parameter types defined for the TL1 messages used in the ONS 15454 and ONS 15327. The TL1 message descriptions frequently refer to this section.
4.3.1 ATAG Description
The ATAG is used for message sequencing. The number is incremented by one for each autonomous message sent by the NE. The ONS 15454 and ONS 15327 use whole numbers 0000 to 9999.
4.3.2 CTAG Description
The CTAG is included in each command by the user and is repeated by the
NE in the response to allow the user to associate the command and response messages.
Note The valid values for a CTAG are strings of up to 6 characters comprised of identifiers (alphanumeric, beginning with a letter) or decimal numerals (a string of decimal digits with an optional non-trailing ".").
4.3.3 TID Description
The TID is the name of the NE where the command is addressed. TID is the Telcordia name for the system.
4.3.4 Parameter Notes
1. If a parameter is set to a value that is inconsistent with something already in the database, and that value is not changed to a consistent value then the command will be denied.
2. If a parameter is set to a value that is consistent with what is already in the database, but another parameter in the same command is incompatible, then the command will be denied.
3. The correct way to issue a command where parameters may be in conflict is to:
a. First issue that command and change all relevant parameters to compatible values,
b. Then issue the command again to change the target values.
For example, OC-N is syncmsg=y, to change SDH to y, ED-OCN needs to be called to set syncmsg=N, then called again to set SDH=y.
4. The attribute defaults have also been presented under RTRV commands, and they can be retrieved only if the RTRV commands follow the card/entity original provision.
5. The default for an optional field of an ED command is either the provisioned default value or the last provisioned value in the previous ED command.
4.3.5 ALL_MONTYPE
Monitoring type list
4.3.6 ALL_THR
Threshold list
4.3.7 BITS_LineBuildOut
BITS Line buildout
4.3.8 BLSR_MODE
BLSR mode
4.3.9 BLSR_TYPE
BLSR type of an OCN port
4.3.10 CCT
Defines the type of cross-connect to be created
4.3.11 CMD_MODE
Command mode is used to force the system to execute a given command regardless of any standing conditions. Normal mode is the default behavior for all commands but the user may specify FRCD to force the system to override a state in which the command would normally be denied.
4.3.12 COND_EFF
The affected unit's condition
Table 4-45 COND_EFF Values
COND_EFF Values DescriptionCL
Standing condition cleared
SC
Standing condition raised
TC
Transient condition
4.3.13 CONDITION
The condition type of the alarm indication
4.3.14 CONT_MODE
Current state of environmental control
Table 4-47 CONT_MODE Values
CONT_MODE Values DescriptionOPR
Indicates that the environment control state is CLOSE
RLS
Indicates that the environment control state is OPEN
4.3.15 CONTTYPE
The Environmental control types as defined by Telcordia GR-833-CORE, Issue 2, November 1996, Appendix G.
Table 4-48 CONTTYPE Values
CONTTYPE Values DescriptionAIRCOND
Air conditioning
ENGINE
Engine
FAN
Fan
GEN
Generator
HEAT
Heat
LIGHT
Light
MISC
Miscellaneous
SPKLR
Sprinkler
4.3.16 CRS_TYPE
Indicates the cross-connection type
Table 4-49 CRS_TYPE Values
CRS_TYPE Values DescriptionSTS
Indicates all the STS cross connections
VT
Indicates all the VT1 cross connections
4.3.17 DIRECTION
Transmit and receive directions
Table 4-50 DIRECTION Values
DIRECTION Values DescriptionBTH
Both transmit and receive directions
RCV
Receive direction only
TRMT
Transmit direction only
4.3.18 DIRN
Specifies the discriminating level for the requested monitored parameter
4.3.19 DS3_FMT
Indicates a DS3 digital signal format
4.3.20 DS_LINE_CODE
DS123 Line Code
Table 4-53 DS_LINE_CODE Values
DS_LINE_CODE Values DescriptionB3ZS
Bipolar with Three-Zero Substitution
4.3.21 DS_LINE_TYPE
DS123 Line type
4.3.22 DURATION
Duration
4.3.23 E_LBO
Electrical signal line buildout
Table 4-56 E_LBO Values
E_LBO Values Description0-225
Electrical signal buildout range is 0-225
226-450
Electrical signal buildout range is 226-450
4.3.24 ENV_ALM
Environmental alarm types as defined by Telcordia GR-833-CORE, Issue 2, November 1996, Appendix F.
4.3.25 ENV_CRTL_MODE
Current state of the environmental control
Table 4-58 ENV_CRTL_MODE Values
ENV_CRTL_MODE Values DescriptionCLOSE
Environmental control state is closed
OPEN
Environmental control state is opened
4.3.26 EQPT_TYPE
Identifies the type of equipment being provisioned into a slot
4.3.27 EQUIP
Indicates the presence of a plug-in unit
Table 4-60 EQUIP Values
EQUIP Values DescriptionEQUIP
The unit is Equipped - present
UNEQUIP
The unit is Unequipped - absent
4.3.28 EQUIPMENT_TYPE
Equipment type
4.3.29 EXT_RING
Indicates if the ring supports the extended K1/K2/K3 protocol
Table 4-62 EXT_RING Values
EXT_RING Values DescriptionN
Indicates the Ring does not support the extended K1/K2/K3 protocol
Y
Indicates the Ring does support the extended K1/K2/K3 protocol
4.3.30 FLOW
Indicates the type of flow control that has been negotiated for an Ethernet port
Table 4-63 FLOW Values
FLOW Values DescriptionASYMMETRIC
Asymmetric flow control
NONE
No flow control
4.3.31 FRAME_FORMAT
The frame format for a T1 port
Table 4-64 FRAME_FORMAT Values
FRAME_FORMAT Values DescriptionD4
Frame format is D4
ESF
Frame format is ESF
UNFRAMED
Frame format is unframed
4.3.32 LINE_BUILDOUT
Line buildout
4.3.33 LINE_CODE
Line code
Table 4-66 LINE_CODE Values
LINE_CODE Values DescriptionAMI
Line code value is AMI
B8ZS
Line code value is B8ZS (Bipolar with Three-Zero Substitution)
4.3.34 LOCATION
Identifies the location where the action is to take place
Table 4-67 LOCATION Values
LOCATION Values DescriptionFEND
Action occurs on the Far End of the facility
NEND
Action occurs on the Near End of the facility
4.3.35 LPBK_TYPE
Indicates the type of loopback that is to be operated or released
4.3.36 MFS_TYPE
Indicates the maximum frame size used by an Ethernet card
Table 4-69 MFS_TYPE Values
MFS_TYPE Values Description1548
Normal frame size
JUMBO
Jumbo frame size
4.3.37 MOD2
Line/Path Modifier
4.3.38 MOD2_IO
Facility/Line Modifier
4.3.39 MOD2ALM
Alarm type for certain generic TL1 commands
4.3.40 MOD2B
Alarm type for certain generic TL1 commands
4.3.41 MOD_PATH
STS/VT Path Modifier
4.3.42 MOD_PORT
Move from MOD2_IO without DS1
Table 4-75 MOD_PORT Values
MOD_PORT Values DescriptionEC1
EC1 port
G1000
G1000 port
OC3
OC3 port
OC12
OC12 port
OC48
OC48 port
OC192
OC192 port
T1
T1/DS1 port
T3
T3/DS3 port
4.3.43 MOD_TACC
Test Access Modifier
4.3.44 MODIFIER
Modifier for certain TL1 commands that are generic in syntax
4.3.45 MODULE_OP
Module operation mode
4.3.46 MSGTYPE
Type of trace message
Table 4-79 MSGTYPE Values
MSGTYPE Values DescriptionEXPTRC
Expected incoming Path trace message
INCTRC
Incoming Path trace message
TRC
Outgoing Path trace message
4.3.47 MUX_TYPE
BLSR Extension Byte
Table 4-80 MUX_TYPE Values
MUX_TYPE Values DescriptionE2
E2 Byte (orderwire)
F1
F1 Byte (user)
K3
K3 Byte
Z2
Z2 Byte
4.3.48 NOTIF_CODE
The 2-character Notification Code associated with an autonomous message
4.3.49 OCN_4F
Modifier used to differentiate the various levels of OC-N in 4F BLSR
Table 4-82 OCN_4F Values
OCN_4F Values DescriptionOC48
Optical Carrier level-48 (2.4Gbs)
OC192
Optical Carrier level-192 (10Gbs)
4.3.50 OCN_BLSR
Modifier used to differentiate the various levels of OC-N in BLSR
Table 4-83 OCN_BLSR Values
OCN_BLSR Values DescriptionOC12
Optical Carrier level-12 (662Mbs)
OC48
Optical Carrier level-48 (2.4Gbs)
OC192
Optical Carrier level-192 (10Gbs)
4.3.51 OCN_MONTYPE
OCN monitor type
4.3.52 OCN_TYPE
Modifier used to differentiate the various levels of OC-N in the ENT/ED/DLT/RTRV commands
4.3.53 ON_OFF
Disable or Enable an attribute
4.3.54 OPTICAL_MODE
The facility optical mode
Table 4-87 OPTICAL_MODE Values
OPTICAL_MODE Values DescriptionSDH
The SDH optical mode the European format
SONET
The SONET optical mode the American format
4.3.55 OPTICS
The type of gigabyte Ethernet optics in place
Table 4-88 OPTICS Values
OPTICS Values Description1000_BASE_LX
1000 Base LX
1000_BASE_SX
1000 Base SX
1000_BASE_ZX
1000 Base ZX
UNKNOWN
Unknown Optical Type
UNPLUGGED
Unplugged
4.3.56 PM_MODE
Identifies the type of PM parameters. Only P type is supported.
4.3.57 PM_STATE
Directs the named PM mode type - path (P) state
4.3.58 PRIVILEGE
Security level
Table 4-91 PRIVILEGE Values
PRIVILEGE Values DescriptionMAINT
Maintenance security level
PROV
Provisioning security level
RTRV
Retrieve security level
SUPER
Superuser security level
4.3.59 PRODUCT_TYPE
Product (NE) type
Table 4-92 PRODUCT_TYPE Values
PRODUCT_TYPE Values Description15327
Cisco ONS 15327 NE
15454
Cisco ONS 15454 NE
UNKNOWN
Unknown product type
4.3.60 PROTECTION_GROUP
Protection group type
Table 4-93 PROTECTION_GROUP Values
PROTECTION_GROUP Values Description1-1
1 to 1 protection group
1-N
1 to N protection group
4.3.61 PST
Primary State. This parameter indicates the current overall service condition of an entity.
4.3.62 PSTQ
Primary State Qualifier. This parameter qualifies PST. If the entity is in-service, PSTQ indicates whether it is totally or partially in service. If the entity is out-of-service, PSTQ indicates whether this is due to an external management command or is determined by the NE itself based on an event that occurred in the NE.
4.3.63 REVERTIVE_TIME
Revertive time
Table 4-96 REVERTIVE_TIME Values
REVERTIVE_TIME Values Description0.5 - 12.0
Revertive time is 0.5 to 12.0 minutes
4.3.64 RNG_TYPE
Defines the type of ring that is to be deployed for this path
Table 4-97 RNG_TYPE Values
RNG_TYPE Values DescriptionBLSR2
2-Fiber Bidirectional Line Switched Ring
BLSR4
4-Fiber Bidirectional Line Switched Ring
UPSR
Unidirectional Path Switched Ring
4.3.65 SD_BER
The threshold for declaring Signal Degrade on a facility or path
4.3.66 SDCC_MODE
Enables or disables the Section Data Communications Channel (SDCC) for the specified facility
Table 4-99 SDCC_MODE Values
SDCC_MODE Values DescriptionN
Section Data Communications Channel is disabled for this facility
Y
Section Data Communications Channel is enabled for this facility
4.3.67 SERV_EFF
Indicates the effect of the alarm on service
Table 4-100 SERV_EFF Values
SERV_EFF Values DescriptionNSA
The condition is Non-Service Affecting
SA
The condition is Service Affecting
4.3.68 SF_BER
The threshold for declaring Signal Failure on a facility or path
4.3.69 SIDE
The role the unit is playing in the protection group
Table 4-102 SIDE Values
SIDE Values DescriptionPROT
The entity is the protection unit in the protection group
WORK
The entity is a working unit in the protection group
4.3.70 SST
Secondary State. This parameter provides additional information pertaining to PST and PSTQ. Values for this state included here are a subset of the list in the GR document.
4.3.71 STATE
The provisioned state of the equipment unit or facility
According to the Telcordia State Model which describes the current state of an NE defined in GR-1093-CORE, the ONS 15454's Equipment state is mapped (roughly) to the Telcordia State Model.
The optional [ ] field in the autonomous messages REPT RMV EQPT and REPT RST EQPT can be populated with the values below.
The [ ] field is populated by the combination of the PST-PSTQ-SST. For the REPT RMV rr and REPT RST rr, the optional [ ] field will be populated with just PST.
4.3.72 STATUS
Indicates whether the unit in the protection pair is active or standby
Table 4-105 STATUS Values
STATUS Values DescriptionACT
The entity is the active unit on the shelf
NA
Status is unavailable
STBY
The entity is the standby unit on the shelf
4.3.73 STM_TYPE
The Synchronous Transport Mode of the NE
Table 4-106 STM_TYPE Values
STM_TYPE Values DescriptionSDH
The NE is operating in Synchronous Digital Hierarchy mode
SONET
The NE is operating in Synchronous Optical Network mode
4.3.74 STS_MAP
The payload mapping of a terminated STS path
Table 4-107 STS_MAP Values
STS_MAP Values DescriptionASYNC
The STS path is carrying an Asynchronous DS3 payload
ATM
The STS path is carrying ATM cells
NONE
The STS path is not terminated
4.3.75 STS_MONTYPE
STS Monitor Type
Table 4-108 STS_MONTYPE Values
STS_MONTYPE Values DescriptionCVP
Coding Violation - P
ESP
Errored Second - Path
SESP
Severely Errored Second - Path
UASP
Unavailable Second - Path
4.3.76 STS_PATH
Modifier for some of the STS commands. This table does not include STS for the RTRV-CRS command, because STS is not a standard designator.
4.3.77 SWITCH
The type of switch to be initiated
4.3.78 SWITCH_TYPE
BLSR switch type
Table 4-111 SWITCH_TYPE Values
SWITCH_TYPE Values DescriptionRING
BLSR ring switch type
SPAN
BLSR span switch type
4.3.79 SYNC_CLOCK_REF_QUALITY_LEVEL
Clock Source Quality Level
4.3.80 SYNC_GENERATION
Synchronization status message set generation
Table 4-113 SYNC_GENERATION Values
SYNC_GENERATION Values DescriptionGEN1
First generation SSM set
GEN2
Second generation SSM set
4.3.81 SYNC_MODE
Synchronization mode
Table 4-114 SYNC_MODE Values
SYNC_MODE Values DescriptionFRNG
Reset operation mode
FST
Reset operation mode
HLDOVR
Reset operation mode
NORM
Reset operation mode
4.3.82 SYNC_QUALITY_LEVEL
Reserved for network synchronization quality level
4.3.83 T1_MONTYPE
T1 monitor type
4.3.84 T3_MONTYPE
T3 monitor type
Table 4-117 T3_MONTYPE Values
T3_MONTYPE Values DescriptionCVL
Coding Violation - Line
ESL
Errored Second - Line
SESL
Severely Errored Second - Line
4.3.85 TACC_MODE
Test access mode
4.3.86 TIMING_MODE
Timing mode for the current node
4.3.87 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 4-120 TMG_REF Values
TMG_REF Values DescriptionN
This facility or card is not a timing reference
Y
This facility or card is a timing reference
4.3.88 TMPER
Performance parameter
4.3.89 TRCMODE
Path Trace Mode
4.3.90 UNI_BI
Unidirectional and Bidirectional switch operations
Table 4-123 UNI_BI Values
UNI_BI Values DescriptionBI
Bidirectional protection switching
UNI
Unidirectional protection switching
4.3.91 USE_DST
Identifies whether Daylight Saving Time is recognized in the area where this NE is deployed.
Table 4-124 USE_DST Values
USE_DST Values DescriptionN
Daylight Saving Time is not recognized
Y
Daylight Saving Time is recognized
4.3.92 VALIDITY
Response validity
Table 4-125 VALIDITY Values
VALIDITY Values DescriptionCOMPL
Complete Response
PRTL
Partial Response
4.3.93 VT1_5_MONTYPE
VT1_5 Monitor Type
Posted: Fri Feb 22 12:31:46 PST 2008
All contents are Copyright © 1992--2008 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.