-
Cisco ONS 15454 SDH TL1 Command Guide, Release 6.0
-
About This Guide
-
Chapter 1, ACT Commands
-
Chapter 2, ALW Commands
-
Chapter 3, APPLY Commands
-
Chapter 4, CANC Commands
-
Chapter 5, CHG Commands
-
Chapter 6, CLR Commands
-
Chapter 7, CONN Commands
-
Chapter 8, COPY Commands
-
Chapter 9, DISC Commands
-
Chapter 10, DLT Commands
-
Chapter 11, ED Commands
-
Chapter 12, ENT Commands
-
Chapter 13, EX Commands
-
Chapter 14, INH Commands
-
Chapter 15, INIT Commands
-
Chapter 16, OPR Commands
-
Chapter 17, REPT Messages
-
Chapter 18, RLS Commands
-
Chapter 19, RMV Commands
-
Chapter 20, RST Commands
-
Chapter 21, RTRV Commands
-
Chapter 22, SCHED Commands
-
Chapter 23, SET Commands
-
Chapter 24, SW Commands
-
Chapter 25, Access Identifiers
-
Chapter 26, Conditions
-
Chapter 27, Modifiers
-
Table Of Contents
21.43 RTRV-FFP-<MOD2DWDMPAYLOAD>
21.74 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
RTRV Commands
This chapter provides RTRV (retrieve) commands for the Cisco ONS 15454 SDH.
21.1 RTRV-<MOD1FCPAYLOAD>
Retrieve (1GFC, 2GFC)
Usage Guidelines
This command retrieves the attributes related with the Fibre Channel port.
See Table 27-1 on page 27-1 for supported modifiers by platform.
Category
Ports
Security
Retrieve
Related Commands
Input Format
RTRV-<MOD1FCPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-1GFC:CISCO:FAC-6-1:888;
Input Parameters
Table 21-1 RTRV-<MOD1FCPAYLOAD> Input Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:LINKRATE=<LINKRATE>,LINKSTATE=<LINKSTATE>,
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,[<SST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFC,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,
NAME=\"FC PORT\",SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,
LOSSB=LR-1:LOCKED-ENABLED,MAINTENANCE"
;Output Parameters
Table 21-2 RTRV-<MOD1FCPAYLOAD> Output Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16
ROLE
The port role in a Y-cable protection scheme. Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
PROT
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
Port status in a Y-cable protection scheme. Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
LINKRATE
The actual rate running on the Fibre Channel port. It can differ from the payload type provisioned
Parameter type is LINKRATE—the link rate on a Fibre Channel port
•
The rate is 1 G Fibre Channel
•
The rate is 1 G FICON
•
The rate is 2 G Fibre Channel
•
The rate is 2 G FICON
•
The rate is unknown
•
The SFP is not plugged into the Fibre Channel port so the link rate cannot be detected
LINKSTATE
Link state
Parameter type is DIRN—specifies the discriminating level for the requested monitored parameter
•
Monitored parameter with values equal to or greater than the level of LEV will be reported
•
Monitored parameter with values equal or less than the value of LEV will be reported
LINKRCVRY
Link recovery
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
DISTEXTN
Distance extension. Optional
Parameter type is DISTANCE_EXTENSION—distance extension
•
Buffer to buffer flow control
•
No distance extension
LINKCREDITS
Number of link credits. Integer. Optional
MFS
Maximum frame size. Integer. Optional
ENCAP
Frame encapsulation type. Optional
Parameter type is ENCAP—frame encapsulation type
•
GFP frame mode
•
GFP transparent mode
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
NAME
Identifies the port name. String. Optional
SOAK
Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
FREQ
Parameter type is OPTICAL-WLEN—optical wavelength
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1530
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.2 RTRV-<MOD1FICONPAYLOAD>
Retrieve (1GFICON, 2 GFICON)
Usage Guidelines
This command returns Fibre-Channel-specific settings for ports that have been configured to carry FICON traffic using the ENT-FICON command. The MXP(P)-MR-2.5G card only supports the GFP-T frame type.
See Table 27-1 on page 27-1 for supported modifiers by platform.
Category
Ports
Security
Retrieve
Related Commands
Input Format
RTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-1GFICON:CISCO:FAC-1-1:123;
Input Parameters
Table 21-3 RTRV-<MOD1FICONPAYLOAD> Input Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[LINKRATE=<LINKRATE>],[LINKSTATE=<LINKSTATE>],
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,<SST>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFICON,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,NAME=\"FC PORT\",
SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,LOSSB=LR-1:LOCKED-ENABLED,
MAINTENANCE"
;Output Parameters
Table 21-4 RTRV-<MOD1FICONPAYLOAD> Output Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16
ROLE
The port role in a Y-cable protection scheme. Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
Port status in a Y-cable protection scheme. Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
LINKRATE
The actual rate running on the Fibre Channel port. It can differ from the payload type provisioned
Parameter type is LINKRATE—the link rate on a Fibre Channel port
•
The rate is 1 G Fibre Channel
•
The rate is 1 G FICON
•
The rate is 2 G Fibre Channel
•
The rate is 2 G FICON
•
The rate is unknown
•
The SFP is not plugged into the Fibre Channel port so the link rate cannot be detected
LINKSTATE
Link state
Parameter type is DIRN—specifies the discriminating level for the requested monitored parameter
•
Monitored parameter with values equal to or greater than the level of LEV will be reported
•
Monitored parameter with values equal or less than the value of LEV will be reported
LINKRCVRY
Link recovery
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
DISTEXTN
Distance extension. Optional
Parameter type is DISTANCE_EXTENSION—distance extension
•
Buffer to buffer flow control
•
No distance extension
LINKCREDITS
Number of link credits. Integer. Optional
MFS
Maximum frame size. Integer. Optional
ENCAP
Frame encapsulation type. Optional
Parameter type is ENCAP—frame encapsulation type
•
GFP frame mode
•
GFP transparent mode
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
NAME
Identifies the port name. String. Optional
SOAK
Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
FREQ
Parameter type is OPTICAL-WLEN—optical wavelength
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1530
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.3 RTRV-<MOD2DWDMPAYLOAD>
Retrieve (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, PASSTHRU)
Usage Guidelines
This command retrieves the configuration parameter of a DWDM client.
See Table 27-1 on page 27-1 for supported modifiers by platform.
Category
DWDM
Security
Retrieve
Related Commands
Input Format
RTRV-<MOD2DWDMPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-HDTV:MILAN:FAC-1-1:100;
Input Parameters
Table 21-5 RTRV-<MOD2DWDMPAYLOAD> Input Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDTYPE>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],
[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1,HDTV:,,WORK,ACT:NAME=\"NY PORT\",LBCL=10.0,OPT=10.0,OPR=10.0,
FREQ=1550,LOSSB=LR-1:Unlocked-Disabled,AutomaticInService"
;Output Parameters
Table 21-6 RTRV-<MOD2DWDMPAYLOAD> Output Parameters
AIDUNIONID
Access identifier from the "25.1.1 AidUnionId" section on page 25-6
AIDTYPE
A type of access identifier
Parameter type is MOD2DWDMPAYLOAD—payload types applicable to DWDM ports
•
10 gigabit Fibre Channel payload
•
10 gigabit Ethernet
•
1 gigabit Fibre Channel payload
•
1 gigabit FICON payload
•
2 gigabit Fibre Channel payload
•
2 gigabit FICON payload
•
D1Video payload
•
DV6000 payload
•
ETRCLO payload
•
Gigabit Ethernet payload
•
HDTV payload
•
ISC1 payload
•
ISC3 payload
•
Any pass through (2R) payload
ROLE
The port role in a Y-cable protection scheme. Optional
Parameter type is SIDE—the role the unit has in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
Port status in a Y-cable protection scheme. Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
NAME
Identifies the port name. String. Optional
LBCL
Displays the current value of the laser current. Float. Optional
OPT
Displays the current value of the transmitted optical power. Float. Optional
OPR
Displays the current value of the received optical power. Float. Optional
FREQ
Parameter type is OPTICAL-WLEN—optical wavelength
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1530
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.4 RTRV-<MOD_RING>
Retrieve Multiplex Section Shared Protection Ring
Usage Guidelines
This command retrieves the MS-SPRing information of the NE. A two-fiber or four-fiber MS-SPRing can be retrieved.
Output examples:
4F MS-SPRing
"MSSPR-N43AB::RINGID=N43AB,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,SRVRTV=Y,
SRVTM=5.0,EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,EASTPROT=FAC-12-1,
WESTPROT=FAC-13-1"2F MS-SPRing
"MSSPR-N12EF::RINGID=N12EF,NODEID=2,MODE=2F,RVRTV=Y,RVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1"Error conditions:
1.
2.
3.
4.
5.
6.
Category
MS-SPRing
Security
Retrieve
Related Commands
Input Format
RTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Input Example
RTRV-MSSPR:PETALUMA:ALL:123;
Input Parameters
Table 21-7 RTRV-<MOD_RING> Input Parameters
AID
Access identifier from the "25.1.2 AidUnionId1" section on page 25-7. Identifies the MS-SPRing of the NE. Only ALL, null or a list of MSSPR-# in AID are allowed. A null value is equivalent to ALL
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>]::[RINGID=<RINGID>],[NODEID=<NODEID>],[MODE=<MODE>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[SRVRTV=<SRVRTV>],[SRVTM=<SRVTM>],
[EASTWORK=<EASTWORK>],[WESTWORK=<WESTWORK>],[EASTPROT=<EASTPROT>],
[WESTPROT=<WESTPROT>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"MSSPR-43::RINGID=43,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,
SRVRTV=Y,SRVTM=5.0,EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,
EASTPROT=FAC-12-1,WESTPROT=FAC-13-1"
;Output Parameters
Table 21-8 RTRV-<MOD_RING> Output Parameters
AID
Access identifier from the "25.1.2 AidUnionId1" section on page 25-7. Identifies the MS-SPRing of the NE. Optional
RINGID
The MS-SPRing ID of the NE up to six characters. Valid characters are A-Z and 0-9. String. Optional
NODEID
The MS-SPRing node ID of the NE. NODEID ranges from 0 to 31. String. Optional
MODE
Mode with which the command is to be implemented. Identifies the MS-SPRing mode; either two-fiber or four-fiber. Optional
Parameter type is MSSPR_MODE—MS-SPRing mode
•
Two-fiber MS-SPRing
•
Four-fiber MS-SPRing
RVRTV
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. RVTM is not allowed to be set while "RVRTV" is N
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
SRVRTV
The span revertive mode for four-fiber MS-SPRing only
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
SRVTM
The span revertive time for four-fiber MS-SPRing only. SRVTM is not allowed to be set while SRVRTV is N
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
EASTWORK
East working facility. AID from the "25.1.11 FACILITY" section on page 25-16
WESTWORK
West working facility. AID from the "25.1.11 FACILITY" section on page 25-16
EASTPROT
East protecting facility. AID from the "25.1.11 FACILITY" section on page 25-16
WESTPROT
West protecting facility. AID from the "25.1.11 FACILITY" section on page 25-16
21.5 RTRV-<PATH>
Retrieve (VC3, VC44C, VC38C, VC464C, VC48C, STS36C, VC4, VC416C, VC42C, VC43C, VC11, VC12)
Usage Guidelines
This command retrieves the attributes associated with an VC path.
See Table 27-1 on page 27-1 for supported modifiers by platform.
Supported AIDs are: ALL, SLOT-N (N=1,2,...,ALL), and VC-specific AIDs
The SFBER, SDBER, RVRTV, RVTM, SWPDIP, HOLDOFFTIMER, and SNCPPTHSTATE parameters only apply to SNCP.
The path trace message is a 64 character string including the terminating CR (carriage return) and LF (line feed) that is transported in the J1 byte of the SDH VC Path overhead.
The EXPTRC indicates the contents of the expected incoming path trace that are provisioned by the user in the ED-VC_PATH command. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.
The path trace mode has three modes: OFF, MANUAL, and AUTO. The mode defaults to OFF. The MANUAL mode compares of the received string with the user entered expected string. The AUTO mode compares of the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.
When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string, or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user entered string. When an expected string is queried under the AUTO path trace mode, the expected string is either a copy of the acquired received string, or NULL if the string has not been acquired.
When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is either a copy of the received string, or NULL if the string has not been received.
J1 (EXPTRC) is implemented on the STM1, STM16AS, STM64, MRC-12 and STM64-XFP cards.
Note
•
•
•
•
•
•
Category
Paths
Security
Retrieve
Related Commands
DLT-CRS-<PATH>
ED-<MOD_PATH>
ED-CRS-<PATH>
ED-NE-PATH
ENT-CRS-<PATH>
OPR-PROTNSW-<PATH>
RLS-PROTNSW-<PATH>
RTRV-CRS-<PATH>
RTRV-NE-PATH
RTRV-PROTNSW-<PATH>
RTRV-PTHTRC-<PATH>
Input Format
RTRV-<PATH>:[<TID>]:<AID>:<CTAG>:::[MSSPRPTHTYPE=<MSSPRPTHTYPE>][:];
Input Example
RTRV-VC4:FERNDALE:VC4-2-1-4:238:::MSSPRPTHTYPE=NON-PCA;
Input Parameters
Table 21-9 RTRV-<PATH> Input Parameters
AID
Access identifier from the "25.1.8 CrossConnectId1" section on page 25-11. Must not be null
MSSPRPTHTYPE
The MS-SPRing path type (only if the port is on the MS-SPRing). Defaults to NON-PCA. Applicable only to VC-level paths in SDH. A null value defaults to NON-PCA
Parameter type is MSSPR_PTH_TYPE—MS-SPRing path type only if the port is on the MS-SPRing
•
The AID is on the working path, or the cross-connection card protection path
•
The AID is on the MS-SPRing PCA path
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[SWPDIP=<SWPDIP>],[HOLDOFFTIMER=<HOLDOFFTIMER>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],
[TRCMODE=<TRCMODE>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[SNCPPTHSTATE=<SNCPPTHSTATE>],[C2=<C2>],
[MSSPRPTHSTATE=<MSSPRPTHSTATE>]:<PST_PSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-2-1-4::LEVEL=VC3,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y,
HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TACC=8,TAPTYPE=DUAL,
SNCPPTHSTATE=ACT,C2=0X04,
MSSPRPTHSTATE=PROTPTHACT:UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;Output Parameters
Table 21-10 RTRV-<PATH> Output Parameters
AID
Access identifier from the "25.1.8 CrossConnectId1" section on page 25-11
LEVEL
The rate of the cross-connected channel. Applicable only to High-Order paths (VC4). Optional
Parameter type is PATH—modifier for path commands
•
Synchronous Transport Signal/Module Level-1 (51Mbs)
•
Synchronous Transport Signal/Module Level-12 Concatenated (622Mbs)
•
Synchronous Transport Signal/Module Level-18 Concatenated (933Mbps)
•
Synchronous Transport Signal/Module Level-192 Concatenated (9952 Mbs)
•
Synchronous Transport Signal/Module Level-24 Concatenated (1240 Mbs)
•
Synchronous Transport Signal/Module Signal Level-3 Concatenated (155 Mbs)
•
Synchronous Transport Signal/Module Level-48 Concatenated (2488 Mbs)
•
Synchronous Transport Signal/Module level-6 (310 Mbs)
•
Synchronous Transport Signal/Module Level-9 Concatenated (465 Mbs)
•
Virtual Tributary 2. Virtual Channel 12
SFBER
An VC path signal failure threshold which only applies to SNCP. Applicable only to High-Order paths. Defaults to 1E-4. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
An VC path signal degrade threshold which only applies to SNCP. Applicable only High-Order paths. Defaults 1E-6. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
RVRTV
Revertive mode. Only applies to SNCP. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. Only applies to SNCP
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
SWPDIP
Switch on PDI-P. Applicable only to VC-level paths (VCn). Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
HOLDOFFTIMER
Hold off timer. Integer. Optional
EXPTRC
Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR (carriage return) and LF (line feed). Applicable to VC-level paths (VCn). Defaults to NULL when SNCP path is created. String. Optional
TRC
The path trace message to be transmitted. The trace byte (J1) continuously transmits a 64-byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. A null value defaults to the NE transmitting null characters (Hex 00). Applicable to VC-level paths (VCn). String. Optional
INCTRC
The incoming path trace message contents. INCTRC is any combination of 64 characters. Applicable only to VC-level paths in (VCn). Defaults to Null when a SNCP path is created. String. Optional
TRCMODE
Path trace mode. Applicable only to VC-level paths (VCn). Defaults to OFF when a SNCP path is created. Optional
Parameter type is TRCMODE—trace mode
•
Use the previously received path trace string as the expected string (not applicable to MXP_2.5G_10G and TXP_MR_10G cards)
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP detected
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP detected
•
Turn off path trace capability. Nothing will be reported
TACC
Test access. Indicates whether the digroup being provisioned is to be used as a test access digroup. Defaults to N. Optional
TAPTYPE
TAP type. Optional
Parameter type is TAPTYPE—test access point type
•
Dual FAD
•
Single FAD
SNCPPTHSTATE
Indicates whether a given AID is the working or standby path of a SNCP cross-connect. Optional
Parameter type is STATUS—status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
C2
The c2 byte hex code. Applicable only to VC-level paths (VCn). Optional
Parameter type is C2_BYTE—c2 byte hex code
•
Unequipped
•
Equipped-Non Specific payload
•
VT-Structured VC-1 SPE
•
Locked VT mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-Over-SDH Mapping
•
VT-structured VC4-1 SPE with 1VTx payload defect
•
VT-structured VC4-1 SPE with 2VTx payload defects
•
VT-structured VC4-1 SPE with 3VTx payload defects
•
VT-structured VC4-1 SPE with 4VTx payload defects
•
VT-structured VC4-1 SPE with 5VTx payload defects
•
VT-structured VC4-1 SPE with 6VTx payload defects
•
VT-structured VC4-1 SPE with 7VTx payload defects
•
VT-structured VC4-1 SPE with 8VTx payload defects
•
VT-structured VC4-1 SPE with 9VTx payload defects
•
VT-structured VC4-1 SPE with 10VTx payload defects
•
VT-structured VC4-1 SPE with 11VTx payload defects
•
VT-structured VC4-1 SPE with 12VTx payload defects
•
VT-structured VC4-1 SPE with 13VTx payload defects
•
VT-structured VC4-1 SPE with 14VTx payload defects
•
VT-structured VC4-1 SPE with 15VTx payload defects
•
VT-structured VC4-1 SPE with 16VTx payload defects
•
VT-structured VC4-1 SPE with 17VTx payload defects
•
VT-structured VC4-1 SPE with 18VTx payload defects
•
VT-structured VC4-1 SPE with 19VTx payload defects
•
VT-structured VC4-1 SPE with 20VTx payload defects
•
VT-structured VC4-1 SPE with 21VTx payload defects
•
VT-structured VC4-1 SPE with 22VTx payload defects
•
VT-structured VC4-1 SPE with 23VTx payload defects
•
VT-structured VC4-1 SPE with 24VTx payload defects
•
VT-structured VC4-1 SPE with 25VTx payload defects
•
VT-structured VC4-1 SPE with 26VTx payload defects
•
VT-structured VC4-1 SPE with 27VTx payload defects
•
VT-structured VC4-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream
MSSPRPTHSTATE
The MS-SPRing path state only if the port is on the MS-SPRing. Applicable only to VC-level paths in SDH (VCn). Optional
Parameter type is MSSPR_PTH_STATE—the MS-SPRing path state only if the port is on the MS-SPRing
•
Indicates the MS-SPRing un-switched and its PCA path is in the active state
•
Indicates the MS-SPRing switched and its PCA path is in the standby state
•
Indicates the MS-SPRing switched and its protection path is in the active state
•
Indicates the MS-SPRing un-switched and its working path is in the active state
•
Indicates the MS-SPRing switched and its working path is in the standby state
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.6 RTRV-<STM_TYPE>
Retrieve (STM1, STM4, STM16, STM64)
Usage Guidelines
This command retrieves the attributes (such as, service parameters) and the state of an STM facility.
See Table 27-1 on page 27-1 for supported modifiers by platform.
Both RINGID and MSSPRTYPE identify the STM port connected with a MS-SPRing. These attributes are only presented for the STM4, STM16, STM64 ports within a MS-SPRing connection. The RTRV-<MOD_RING> command with the AID MSSPR-RINGID, can provide more information on this MS-SPRing.
Note
UNI-C DCC provisioning notes:
1.
2.
3.
4.
5.
6.
7.
Category
MS-SPRing
Security
Retrieve
Related Commands
Input Format
RTRV-<STM_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-STM16:PENNGROVE:FAC-6-1:236;
Input Parameters
Table 21-11 RTRV-<STM_TYPE> Input Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>],[AREA=<AREA>],[TMGREF=<TMGREF>],
[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],[PJMON=<PJMON>],
[SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],[WVLEN=<WVLEN>],
[RINGID=<RINGID>],[MSSPRTYPE=<MSSPRTYPE>],[MUX=<MUX>],[UNIC=<UNIC>],
[CCID=<CCID>],[NBRIX=<NBRIX>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],
[SSMRCV=<SSMRCV>],[OSPF=<OSPF>],[LDCC=<LDCC>],[NAME=<NAME>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[EXPTRC=<EXPTRC>],[TRC=<TRC>],
[TRCMODE=<TRCMODE>],[TRCFORMAT=<TRCFORMAT>],[ADMSSM=<ADMSSM>],
[SENDDUSFF=<SENDDUSFF>],[AISONLPBK=<AISONLPBK>],[FREQ=<FREQ>],
[LOSSB=<LOSSB>],[FOREIGNFEND=<FOREIGNFEND>],
[FOREIGNIPADDRESS=<FOREIGNIPADDRESS>],:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:DCC=Y,AREA=10.92.63.1,TMGREF=N,SYNCMSG=N,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SDH,WVLEN=1310.00,RINGID=43,
MSSPRTYPE=WESTWORK,MUX=E2,UNIC=Y,CCID=8,NBRIX=2,SOAK=52,
SOAKLEFT=12-25,SSMRCV=STU,OSPF=Y,LDCC=Y,
NAME=\"STM PORT\",LBCL=10.0,OPT=10.0,OPR=10.0,
EXPTRC="AAA",TRC="AAA",TRCMODE=MAN,TRCFORMAT=16-BYTE,ADMSSM=PRS,
SENDDUSFF=N,AISONLPBK=AIS_ON_LPBK_ALL,FREQ=1550,LOSSB=LR-1,
FOREIGNFEND=Y,FOREIGNIPADDRESS=10.92.63.44,UNLOCKED-DISABLED,
AUTOMATICINSERVICE"
;Output Parameters
Table 21-12 RTRV-<STM_TYPE> Output Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16
ROLE
An STM port role. Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
An STM port status. Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
DCC
Indicates whether or not the section DCC is to be used. Optional
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
AREA
Area ID. Shows up only if the DCC is enabled. String. Optional
TMGREF
The termination to be used, whether primary or secondary. Identifies if an STM port has a timing reference. Defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
SYNCMSG
Synchronization status message
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
SENDDUS
The facility will send the DUS (Don't use for Synchronization) value in 0x0f bits pattern as the synchronization status message for that facility. Defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
PJMON
(Optional) Identifies an STM port PJMON. PJMON is an integer. It defaults to 0 (zero). Set a valid VC4 number of the optical port.
Note
SFBER
An STM port signal failure threshold. Defaults to 1E-4. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
An STM port signal degrade threshold. Defaults 1E-7. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
MODE
STM port mode. Defaults to SDH. Optional
Parameter type is OPTICAL_MODE—the facility's optical mode
•
SDH/ETSI optical mode using European/International format
•
SONET/ANSI optical mode using the American format
WVLEN
An STM port wavelength in nanometer. For example, WVLEN=1310.00 means it operates at 1310 nm in the DWDM application. Float. Optional
RINGID
The MS-SPRing RINGID with which the port is connected. RINGID ranges from 0 to 9999. Integer. Optional
MSSPRTYPE
The MS-SPRing type with which the port is connected. Optional
Parameter type is MSSPR_TYPE—MS-SPRing type of an STM port
•
The STM port is an east protecting port
•
The STM port is an east working port
•
The STM port is an west protecting port
•
The STM port is an west working port
MUX
MS-SPRing extension byte. Optional
Parameter type is MUX_TYPE—MS-SPRing extension byte
•
E2 byte (orderwire)
•
F1 byte (user)
•
K3 byte
•
Z2 byte
SOAK
Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
SSMRCV
Displays the quality of the individual port. Optional
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SDH
•
Do Not Use For Synchronization
•
G811 Standard
•
Reserved For Network Synchronization Use
•
G812T Standard
•
Synchronized, Traceability Unknown
•
G812TL Standard
•
Synchronous Equipment Timing Source
OSPF
The Open Shortest Path First discovery. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
LDCC
The line DCC connection on the port. Optional
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
NAME
Name. String. Optional
LBCL
Displays the current value of the laser current. Float. Optional
OPT
Displays the current value of the transmitted optical power. OPT is only displayed for DWDM cards. Float. Optional
OPR
Received optical power. Float
EXPTRC
Expected path trace content. String. Optional
TRC
Path trace message to be transmitted. String. Optional
TRCMODE
Path trace mode. Applicable only to VC-level Paths in SDH (VCn). Defaults to the OFF mode. Optional
Parameter type is TRCMODE—trace mode
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Turn off path trace capability. Nothing will be reported
TRCFORMAT
Trace message size. Optional
Parameter type is TRCFORMAT—trace format
•
1 byte trace message
•
16 byte trace message
•
64 byte trace message
•
Enable an attribute
ADMSSM
SSM selectable value. Only displayed when SSM is disabled. Optional
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SDH
•
Do Not Use For Synchronization
•
G811 Standard
•
Reserved For Network Synchronization Use
•
G812T Standard
•
Synchronized, Traceability Unknown
•
G812TL Standard
•
Synchronous Equipment Timing Source
SENDDUSFF
Indicates that the facility will send the DUS (Don't use for synchronization) value in 0xff bits pattern as the synchronization status message for that facility. Defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
AISONLPBK
Parameter type is AIS_ON_LPBK—indicates if AIS should be sent on loopback
•
AIS is sent on facility loopback
•
AIS is sent on all loopbacks
•
AIS is not sent on loopback
•
AIS is sent on terminal loopback
FREQ
Parameter type is OPTICAL-WLEN—optical wavelength
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1530
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
FOREIGNFEND
Indicates whether the far-end NE on the DCC is a foreign NE
Parameter type is ON_OFF—disable or enabled an attribute
•
Disable an attribute
•
Enable an attribute
FOREIGNIP
The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. String
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.7 RTRV-10GIGE
Retrieve 10GIGE
Usage Guidelines
This command retrieves the 10 Gbps-specific parameters for a port that has been configured to support the gigabyte Ethernet payload with the ENT-10GIGE command.
Category
Ports
Security
Retrieve
Related Commands
Input Format
RTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-10GIGE:TID:FAC-1-1:100;
Input Parameters
Table 21-13 RTRV-10GIGE Input Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[MACADDR=<MACADDR>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PSTPSTQ>,[<SST>]"
;Output Examples
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:NAME=\"NY PORT\",MACADDR=00-0E-AA-BB-CC-FF,LBCL=10.0,
OPT=10.0,OPR=10.0,FREQ=1550,LOSSB=SX:Unlocked-Disabled,AutomaticInService"
;Output Parameters
Table 21-14 RTRV-10GIGE Output Parameters
AID
Access identifier from the "25.1.11 FACILITY" section on page 25-16
ROLE
The port role in a Y-cable protection scheme. Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
Port status in a Y-cable protection scheme. Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
NAME
Port name. String. Optional
MACADDR
The MAC address for the 10 gigabyte Ethernet payload. String. Optional
LBCL
Displays the current value of the laser current. Float. Optional
OPT
Displays the current value of the transmitted optical power. Float. Optional
OPR
Displays the current value of the received optical power. Float. Optional
FREQ
Parameter type is OPTICAL-WLEN—optical wavelength
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1530
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.8 RTRV-ALM-<MOD2ALM>
Retrieve Alarm (1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS3I, E1, E100, E1000, E3, E4, FSTE, G1000, GFPOS, GIGE, STM4, STM64, STM1, STM16, OCH, OMS, OTS, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, STS36C, VC4, VC416C, VC42C, VC43C, UDCDCC, UDCF, VCG, VC11, VC12, WLEN)
Usage Guidelines
This command retrieves and sends the current status of alarm conditions. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.
See Table 27-1 on page 27-1 for supported modifiers by platform.
Note
Note
Category
Fault
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];Input Example
RTRV-ALM-STM4:ELDRIDGE:FAC-5-1:225::MN,SD,SA;
Input Parameters
Table 21-15 RTRV-ALM-<MOD2ALM> Input Parameters
AID
Access identifier from the "25.1.1 AidUnionId" section on page 25-6. Must not be null
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See the Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],,:[<DESC>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1,STM4:MJ,SD,SA,09-05,12-30-20,,:\"BER AT SIGNAL DEGRADE LEVEL\","
;Output Parameters
Table 21-16 RTRV-ALM-<MOD2ALM> Output Parameters
AID
Access identifier from the "25.1 ALL" section on page 25-1
AIDTYPE
Type of access identifier. Optional
Parameter type is MOD2ALM—alarm type
•
1 Gigabit Fibre Channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
Client facility for MXP/TXP cards
•
DS3I alarm
•
E1alarm
•
E100 alarm
•
E1000 alarm
•
E3alarm
•
E4 frame. Only applicable to STM1E port 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode
•
Fast Ethernet Port alarm
•
G1000 alarm
•
Generic framing protocol over packet over SDH virtual port alarm
•
GIG Ethernet port alarm
•
STM1 alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC38C alarm
•
VC44C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
•
UDCDCC alarm
•
UCDF alarm
•
Virtual Concatenation Group alarm
•
Wavelength Path Provisioning
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether the problem is reported (that is, whether it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See the Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date when the specific event or violation occurred. Optional
OCRTM
Time when the specific event or violation occurred. Optional
DESC
The condition description
21.9 RTRV-ALM-ALL
Retrieve Alarm All
Usage Guidelines
This command retrieves and sends the current status of all active alarm conditions. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.
To retrieve all the NE alarms, issue all of the following commands:
RTRV-ALM-ALL
RTRV-ALM-BITS
RTRV-ALM-ENV
RTRV-ALM-SYNCNCategory
Fault
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-ALL:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDITION>],[<SRVEFF>][,,,];Input Example
RTRV-ALM-ALL:COTATI:ALL:229::MN,PWRRESTART,NSA;
Input Parameters
Table 21-17 RTRV-ALM-ALL Input Parameters
AID
Access identifier from the "25.1 ALL" section on page 25-1. A null value is equivalent to ALL. String
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDITION
The type of alarm condition. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,<OCRDAT>,
<OCRTM>,,:[<DESC>],[<AIDDET>]";
Output Examples
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2,EQPT:MN,PWRRESTART,NSA,08-01,14-25-59,,:\"POWER FAIL RESTART\",E1-N-14"
;Output Parameters
Table 21-18 RTRV-ALM-ALL Output Parameters
AID
Access identifier from the "25.1 ALL" section on page 25-1. Optional
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit Fibre Channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3I alarm
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
STM1 alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STM1E alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
•
SYNCN alarm
•
TCC alarm
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date
OCRTM
Time
DESC
A condition description. String. Optional
AIDDET
AIDDET uses the same addressing rules as the AID, but specifies AID type and additional details about the entity being managed. The supplementary equipment identification. Optional
21.10 RTRV-ALM-BITS
Retrieve Alarm Building Integrated Timing Supply
Usage Guidelines
This command retrieves and sends the current status of alarm conditions associated with the BITS facility. The alarm condition or severity retrieved is specified using the input parameters as a filter.
Category
Synchronization
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-BITS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input Example
RTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;
Input Parameters
Table 21-19 RTRV-ALM-BITS Input Parameters
AID
Access identifier from the "25.1.4 BITS" section on page 25-8. Must not be null
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
The condition type for an alarm or reported event. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,:[<DESC>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,08-01,14-25-59,,:\"LOSS OF SIGNAL\","
;Output Parameters
Table 21-20 RTRV-ALM-BITS Output Parameters
AID
Access identifier from the "25.1.4 BITS" section on page 25-8. Optional
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit Fibre Channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3I alarm
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
STM1 alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STM1E alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
•
SYNCN alarm
•
TCC alarm
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date. Optional
OCRTM
Time. Optional
DESC
A condition description. String. Optional
21.11 RTRV-ALM-ENV
Retrieve Alarm Environment
Usage Guidelines
This command retrieves the environmental alarms.
Category
Environment
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input Example
RTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
Table 21-21 RTRV-ALM-ENV Input Parameters
AID
Access identifier from the "25.1.9 ENV" section on page 25-14. Must not be null
Note
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
ALMTYPE
The alarm type for the environmental alarm. A null value is equivalent to ALL
Parameter type is ENV_ALM—environmental alarm types
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High air flow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnected bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48V power supply failure
•
-139V power converter
•
-190V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],[<DESC>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,08-01,14-25-59,\"OPEN DOOR\""
;Output Parameters
Table 21-22 RTRV-ALM-ENV Output Parameters
AID
Access identifier from the "25.1.9 ENV" section on page 25-14
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 on page 26-1 for a list of conditions
ALMTYPE
The alarm type for the environmental alarm. A null value is equivalent to ALL
Parameter type is ENV_ALM—environmental alarm types
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High air flow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48V power supply failure
•
-139V power converter
•
-190V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
OCRDAT
Date. Optional
OCRTM
Time. Optional
DESC
A condition description. String. Optional
21.12 RTRV-ALM-EQPT
Retrieve Alarm Equipment
Usage Guidelines
This command retrieves and sends the current status of alarm conditions associated with the equipment units. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.
Category
Equipment
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-EQPT:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input Example
RTRV-ALM-EQPT:TWOROCK:SLOT-7:227::MJ,HITEMP,NSA;
Input Parameters
Table 21-23 RTRV-ALM-EQPT Input Parameters
AID
Access identifier from the "25.1.10 EQPT" section on page 25-15. Must not be null
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
The condition type for an alarm or a reported event. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,,:[<DESC>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-7,EQPT:MJ,HITEMP,NSA,08-01,14-25-59,,:\"HI TEMPERATURE\","
;Output Parameters
Table 21-24 RTRV-ALM-EQPT Output Parameters
AID
Access identifier from the "25.1.10 EQPT" section on page 25-15. Optional
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit Fibre Channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3I alarm
•
E1 alarmed
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
STM1 alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STM1E alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
•
SYNCN alarm
•
TCC alarm
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date. Optional
OCRTM
Time. Optional
DESC
A condition description. String. Optional
21.13 RTRV-ALM-SYNCN
Retrieve Alarm Synchronization
Usage Guidelines
This command retrieves and sends the current status of 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.
Category
Synchronization
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-SYNCN:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];Input Example
RTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;
Input Parameters
Table 21-25 RTRV-ALM-SYNCN Input Parameters
AID
Access identifier from the "25.1.22 SYNC_REF" section on page 25-20. Must not be null
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
The condition type for an alarm or a reported event. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 on page 26-1 for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,:[<DESC>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:CR,FAILTOSW,SA,
08-01,14-25-59,,:\"FAILURE TO SWITCH TO PROTECTION\","
;Output Parameters
Table 21-26 RTRV-ALM-SYNCN Output Parameters
AID
Access identifier from the "25.1.20 SYN" section on page 25-20
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit Fibre Channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
