Chapter 16, OPR Commands

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

This chapter provides operate (OPR) commands for the Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, and ONS 15600.

16.1 OPR-ACO-ALL

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Operate Alarm Cutoff All (OPR-ACO-ALL) command cuts off the office audible alarm indication without changing the local alarm indications.

Usage Guidelines

This command does not have any effect on future alarms at the network element (NE); it directs the NE to provide conditioning only on those alarms that are currently active.

The ACO retires the Central Office (CO) alarm audible indicators without clearing the indicators that show that the trouble still exists. There is no need for a RLS-ACO command.

16.2 OPR-ALS

(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA) The Operate Automatic Laser Shutoff (OPR-ALS) command is used to restart the laser of an OC-N facility and in general for all of the facilities that support the ALS feature.

Usage Guidelines

16.3 OPR-APC

(Cisco ONS 15454) The Operate Amplification Power Control (OPR-APC) command permits the APC application inside the NE to force regulation of the optical power to the entire dense wavelength division multiplexing (DWDM) ring.

Usage Guidelines

16.4 OPR-EXT-CONT

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Operate External Control (OPR-EXT-CONT) command operates an external control and closes the external control contact. The control can be operated momentarily or continuously.

Usage Guidelines

<AID>	The node or shelf access identifier from the "SHELF" section. If omitted it addresses the node or first shelf of the node.

<AID>	Access identifier from the "AidUnionId" section.

•

In an automatic state, the contact could be opened or closed depending on the provisioned trigger.

•

RLS-EXT-CONT changes the state to automatic. Therefore, issuing an OPR-EXT-CONT command when the control is manually open and then issuing a RLS-EXT-CONT will not revert the state back to Manual Open.

•

RLS-EXT-CONT is not allowed during the MNTRY duration. It is allowed for the CONTS duration. The length of the MNTRY duration is 2 seconds on the Cisco ONS 15454.

•

RLS-EXT-CONT cannot change the state to automatic if the existing state is Manual Open.


<AID>	Access identifier from the "ENV" section. Must not be null.
<CONTTYPE>	Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE (the environmental control types).
•AIRCOND	Air conditioning
•AUDIBLE	Audible (ONS 15310-MA only)
•ENGINE	Engine
•FAN	Fan
•GEN	Generator
•HEAT	Heat
•LIGHT	Light
•MISC	Miscellaneous
•SPKLR	Sprinkler
<DURATION>	Duration. A null value is equivalent to ALL. The parameter type is Duration.
•CONTS	Continuous duration

16.5 OPR-LASER-OTS

(Cisco ONS 15454) The Operate Laser Optical Transport Section (OPR-LASER-OTS) command instructs a laser to switch on.

Usage Guidelines

16.6 OPR-LNK

(Cisco ONS 15454) The Operate Link (OPR-LNK) command operates the optical link (OLNK) application inside the NE to calculate all the automatic optical links between endpoints that can be univocally identified by the NE.

Usage Guidelines

16.7 OPR-LPBK-<MOD2>

<AID>	Access identifier of an optical facility supporting laser from the "LINE" section

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Operate Loopback for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, or VT2 (OPR-LPBK-MMOD2>) command operates a signal loopback on a traffic or a cross-connect card.

Usage Guidelines

The optional LPBKTYPE parameter defaults to FACILITY in this command if it is given to a port entity. It defaults to CRS if given to a synchronous transport signal (STS) entity.

Note

•

The value CRS for the LPBKTYPE parameter is applicable only for the STS modifier. The FACILITY and TERMINAL values are applicable to the ports.

•

The TERMINAL loopback type is not supported for the DS1 line of a DS3XM card.

•

Loopbacks are only allowed to be set up if the port/interface/STS_PATH is in the OOS-MT or OOS-AINS state.

•

Cross-connect loopbacks cannot be applied to the destination end of any 1WAY cross-connect.

•

A cross-connect loopback can be applied only on one STS path of a cross-connect.

•

FEAC loopbacks can be applied by using the LINE value for the LPBKTYPE parameter and specifying the LOCN as FEND. The FEAC loopbacks are supported only on the DS3(T3) and DS1 interfaces on the DS3XM-12 and DS3XM-6 card.

•

FEAC loopbacks can be applied only if the DS3 is in C-bit framing format. FEAC loopbacks will override existing loopbacks at the near end on the entity and vice versa. This means that if a facility loopback has been applied on a port and if the FEAC loopback is applied, then the facility loopback is first released and the far-end loopback is applied.

•

The LINE value is supported only with the FEND value of the LOCN parameter. FACILITY, TERMINAL, and CRS values are not compatible with the FEND value for the LOCN parameter.

•

A lockout of the protection command is required before putting the span of either a two-fiber or four-fiber bidirectional line switched ring (BLSR) line in loopback.

–

A span lockout of one side (for example, the east side) of the two-fiber BLSR is required before operating a facility (or terminal) line loopback on the same side (that is, the east side) of the ring.

–

A span lockout of one protection side (for example, the East Protection side) of the four-fiber BLSR is required before operating a facility (or terminal) line loopback on the same side working line (that is, the East Working side) of the ring.

•

FEAC loopbacks on the DS1 interface of a DS3XM card can be applied only if a Virtual Tributary (VT) connection has been created on it. An attempt to operate or release FEAC loopbacks in the absence of a VT connection will lead to an error message response.

•

The FEAC line is supported only with the FEND value of the LOCN parameter on DS1, T3 of the DS3XM-12 card.

•

Only the following MOD2 fields are supported in this release: DS1 EC1, G1000, FSTE, OC12, OC192, OC3, OC48, OCH, T1, T3, STS1, STS12C, STS192C, STS24C, STS3C, STS36C, STS48C, STS6C, STS9C, E1, 1GFC, 2GFC, 4GFC, 10GFC, 1GFICON, 2GFICON, 4GFICON, GIGE, 10GIGE, ESCON, STS18C, DV6000, ETRCLO, ISCCOMPAT, ISC3PEER1G, ISC3PEER2R, PASSTHRU, ISC3PEER2G.


<AID>	Access identifier from the "ALL" section. The valid values for AID are FACILITY, DS1, and STS.
<LOCATION>	The location where the operation is to be carried out. LOCATION defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.
•FEND	Action occurs on the far end of the facility.
•NEND	Action occurs on the near end of the facility.
<LPBKTYPE>	Type of loopback signal. The parameter type is LPBK_TYPE, which indicates the type of loopback that is to be operated or released.
•CRS	Path level loopback that is established at the cross-connect matrix level (the XCVT/XC10G card). An STS-level cross-connect loopback causes a path alarm indication signal (AIS-P) to be sent on the outgoing direction of transmission.
•FACILITY	Type of loopback that connects the incoming received signal immediately following the optical-to-electrical conversion (after descrambling) to the associated transmitter in the return direction.
•LINE	Line level loopback for a far-end DS1 path loop back of the DS3XM. The DS3XM cards only support the DS1 path far end FEAC loopback in this release.
•TERMINAL	A loopback that connects the signal that is about to be transmitted (after scrambling but before the electrical-to-optical conversion) and is connected to the associated, incoming receiver.

16.8 OPR-PROTNSW-<MOD2DWDMPAYLOAD>

(Cisco ONS 15454) The Operate Protection Switch for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, or PASSTHRU (OPR-PROTNSW-<MOD2DWDMPAYLOAD>) command initiates a Y-cable protection switch request. User switch requests initiated with this command remain active until they are released through the RLS-PROTNSW-<MOD2DWDMPAYLOAD> command or are overridden by a higher priority protection switch request.

Usage Guidelines

The switch commands; MAN (Manual Switch), FRCD (Forced Switch), and LOCKOUT (Lockout) are supported by the ONS 15454, however, you must have Provisioning or higher privilege to execute FRCD and LOCKOUT operations.

•

Manual Switch of Protection Line (to Working Line). If the AID identifies the protection line, then (only in the 1+1 architecture) service will be transferred from the protection line to the working line, unless a request of equal or higher priority is in effect.

•

Manual Switch of Working Line (to Protection Line). If the AID identifies a working line, service will be switched from the working line to the protection line unless a request of equal or higher priority is in effect.

•

Force Switch of Protection Line (to Working Line). If the AID identifies the protection line, service will be transferred from the protection line to the working line unless a request of equal or higher priority is in effect.

•

Force Switch of Working Line (to Protection Line). If the AID identifies a working line, service will be transferred from the working line to the protection line unless a request of equal or higher priority is in effect. A lockout of protection and a signal fail of protection line have higher priority than this switch command.

•

Lockout of Protection Line. If the AID identifies the protection line, this switch command will prevent the working line from switching to protection line. If the working line is already in protection, then the working line will be switched back to its original working line.

•

Lockout of Working Line. If the AID identifies the working line, this switch command will prevent the working line from switching to protection line. If the working line is already in protection, then the working line will be switched back from protection line to its original working line.

If the command is used against preprovisioned cards, the SROF (Protection Switching Failed) error is returned.


<SRC>	Access identifier from the "FACILITY" section.
<SC>	Switch command that is to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•APS-CLEAR	APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•CLEAR	CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•EXERCISE	EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
•LOCKOUT	Locks the facility out of switching. The system cannot switch to this facility to carry service.
•MAN	Requests a manual switch of the facility.

16.9 OPR-PROTNSW-<OCN_TYPE>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Operate Protection Switch for OC3, OC12, OC48, or OC192 (OPR-PROTNSW-<OCN_TYPE>) command initiates a SONET line protection switch request. User switch requests initiated with this command remain active until they are released via the RLS-PROTNSW-OCN command or are overridden by a higher priority protection switch request.

Usage Guidelines

The switch commands; MAN (Manual Switch), FRCD (Forced Switch), and LOCKOUT (Lockout) are supported by the ONS 15454.

•

Manual Switch of Working Line (to Protection Line). If the AID identifies a working line, then service will be switched from the working line to the protection line unless a request of equal or higher priority is in effect.

•

Force Switch of Protection Line (to Working Line). If the AID identifies the protection line, then (only in the 1+1 architecture) service will be transferred from the protection line to the working line unless a request of equal or higher priority is in effect.

•

Force Switch of Working Line (to Protection Line). If the AID identifies a working line, then service will be transferred from the working line to the protection line unless a request of equal or higher priority is in effect. A lockout of protection and a signal fail of protection line have higher priority than this switch command.

•

This command is not used for the common control (TCC2/TCC2P or XCVT/XC10G) cards. A query on a common control card will generate an IIAC (Input, Invalid Access Identifier) error message. For common control card switching, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

•

Sending this command to electrical cards will return an IIAC (Input, Invalid Access Identifier) error message. For electrical card switching, use the ALW-SWTOPROTN/SWTOWKG-EQPT and INH-SWTOPROTN/SWTOWKG-EQPT commands.

•

Sending this command to query on a card that is not in a protection group will return the SNVS (Status, Not in Valid State) error message.

•

Sending this command to a working card that is failed or missing will return the SROF (Protection Switching Failed) error message.

•

Sending this command to a protect card that is failed or missing will return the SROF (Protection Switching Failed) error message.

•

Sending this command to a card that is already in protection with a higher priority will return the SSRD (Status, Switch Request Denied) error message.

•

Sending this command to an OCN line with a switching mode that is already in mode will return a SAMS (Already in the Maintenance State) error message.

•

Sending this command with EXERCISE or APS_CLEAR switch operation will return an error SROF (Invalid Protection Switch Operation) because these operations are not valid according to Telcordia GR-833-CORE. The EX-SW-<OCN_BLSR> is the correct command to perform the EXERCISE switch over the BLSR line.

•

Protection switch will be denied if signal degrade/signal fail (SD/SF) is already present on the switching path. If SD/SF is generated on the switching path after the switch is performed, the switch will be overwritten by the APS_CLEAR state. This does not apply for lockout of protection and forced switches that have higher priority than SD/SF.

Note

•

To get the protection switching state (manual, lockout, forced), use the RTRV-COND-ALL or RTRV-ALM-ALL commands.

•

If the far end of the same span has a higher protection switching state (for example, the near end is under Manual protection switching state and the far end is in the forced protection switching state) the near-end protection switching state will be preemptive and shown as APS_CLEAR switching state over the Cisco Transport Controller (CTC) or TL1 interface. The RTRV-PROTNSW-OCN command is used to retrieve the current switching state of a SONET line.

•

Sending the following manual ring switching requests on both east and west sides/spans of a two-fiber or four-fiber ring in less than 30 to 45 seconds will cause the system to execute only one (WEST) side BLSR query and preempt the other (EAST) side query. There will be no event messages coming out for the preempted side whose switching state will be in APS-CLEAR state:

–

A single TL1 command with both side/span AIDs (in the list AID format) of the same two-fiber or four-fiber ring.

–

The separated (via TL1, or CTC, or TL1 and CTC user interfaces) queries on the both sides/spans of the same two-fiber or four-fiber ring.

•

DIRN is an optional parameter. A NULL value defaults to BTH for a BLSR protection, BTH for a 1+1 bidirectional protection group, and RCV for a 1+1 unidirectional protection group.

DIRN follows these rules: TRMT will always fail for any kind of protection groups. For two-fiber and four-fiber BLSR protection groups, both the RCV and TRMT directions will fail.

•

DIRN is applicable for both 1+1 and BLSR protection groups. For example, OPR-PROTNSW can be performed on a BLSR span/ring as follows:

•

A lockout of the protection command is required before putting the span of either a two-fiber or four-fiber BLSR line in loopback.

–

A span lockout of one side (for example, the east side) of the two-fiber BLSR is required before operating a facility (or terminal) line loopback on the same side (for example, the east side) of the ring.

–

A span lockout of one protection side (for example, the East Protection side) of the four-fiber BLSR is required before operating a facility (or terminal) line loopback on the same side Working line (for example, the East Working side) of the ring.

•

A span lockout on the working unit is not supported in ONS 15454, ONS 15327, and ONS 15600.


<AID>	Access identifier from the "FACILITY" section. Identifies the facility in the NE to which the switch request is directed.
<SC>	Switch command that is to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•APS-CLEAR	APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands
•CLEAR	CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•EXERCISE	EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
•LOCKOUT	Locks the facility out of switching. The system cannot switch to this facility to carry service.
•MAN	Requests a manual switch of the facility.
<SWITCHTYPE>	BLSR switch type. The parameter type is SWITCH_TYPE (switch type).
•RING	BLSR ring switch type
•SPAN	BLSR span switch type
<DIRN>	The direction relative to the entity defined in the AID field. The direction of the switching. DIRN defaults to RCV. The parameter type is DIRECTION (transmit and receive directions).
•BTH	Both transmit and receive directions
•RCV	Receive direction only
•TRMT	Transmit direction only

16.10 OPR-PROTNSW-<PATH>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Operate Protection Switch for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, or VT2 (OPR-PROTNSW-<PATH>) command initiates a SONET path protection switch request. User switch requests initiated with this command (forced switch, lockout, and manual switch) remain active until they are released through the RLS-PROTNSW-<PATH> command or overridden by a higher priority protection switch request.

Usage Guidelines

•

If you send this command on the drop AID, a DENY (Invalid AID, should use working/protect AID) message will be returned.

•

To get the protection switching state (manual, lockout, forced), use the RTRV-COND-ALL or RTRV-ALM-ALL commands.

•

Telcordia GR-1400 does not allow the LOCKOUT_OF_WORKING on the path protection WORKING path/AID. When sending this command on the path protection WORKING path, a SROF (Invalid Protection Switch Operation) is returned.

•

If sending this command with EXERCISE or APS_CLEAR switch operation, an SROF (Invalid Protection Switch Operation) error will be returned because these operations are not valid according to Telcordia GR-833-CORE.

•

A protection switch will be denied if SD/SF is already present on the switching path. If SD/SF is generated on the switching path after the switch is performed, the switch will be overwritten by the APS_CLEAR state. This does not apply for lockout of protection and forced switch which have higher priority than SD/SF. This rule does not apply for Lockout of Protection and Forced Switch, which have a higher priority than SD/SF.


<SRC>	Source access identifier from the "CrossConnectId" section.
<SC>	The switch command that is to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•APS-CLEAR	APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•CLEAR	CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•EXERCISE	EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
•LOCKOUT	Locks the facility out of switching. The system cannot switch to this facility to carry service.
•MAN	Requests a manual switch of the facility.

16.11 OPR-PROTNSW-OCH

(Cisco ONS 15454) The Operate Protection Switch Optical Channel (OPR-PROTNSW-OCH) command performs a protection switch on the trunk port of a TXPP_MR_2.5G card.

Usage Guidelines


<AID>	Access identifier from the "CHANNEL" section. Indicates the trunk port.
<SW>	Switch operation. The parameter type is SW, which is the type of switch to be initiated.
•APS-CLEAR	APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•CLEAR	CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•EXERCISE	EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
•LOCKOUT	Locks the facility out of switching. The system cannot switch to this facility to carry service.
•MAN	Requests a manual switch of the facility.

16.12 OPR-SLV-WDMANS

(Cisco ONS 15454) The Operate Span Loss Verification Wavelength Division Multiplexing Automatic Node Set-Up (OPR-SLV-WDMANS) command performs the calculation of the expected span loss verification.

Usage Guidelines

16.13 OPR-SYNCNSW

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Operate Synchronization Switch (OPR-SYNCNSW) command initiates a switch to the reference specified by the synchronization reference number if the reference supplied is valid and of the same quality.

Usage Guidelines

For manual types of switches, the reference to which you want to switch should be of the same quality as the active reference source, otherwise the command will fail.

If you want to switch to a reference of lower quality, use the forced switch option.

The Operate Synchronization Switches are released by the RLS-SYNCNSW command or are overridden by a synchronization reference failure.

After the switch is effective, the MANSWTOPRI (Manual Switch to Primary or Secondary Reference...) minor alarm will be raised.

<AID>	Access identifier from the "WDMANS" section


<AID>	Access identifier from the "SYNC_REF" section Defaults to SYNC-NE.
<SWITCHTO>	Access identifier from the "SYNCSW" section. Identifies the new synchronization reference that will be used.
<SC>	Switch command to be initiated on the paths. Only MAN and FRCD switches are allowed for this command. The parameter type is SW, which is the type of switch to be initiated.
•FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
•MAN	Requests a manual switch of the facility.

16.14 OPR-WDMANS

(Cisco ONS 15454) The Operate Wavelength Division Multiplexing Automatic Node Set-Up (OPR-WDMANS) command initiates the Automatic Optical Node Set Up (AONS) application inside the NE to force a recompute of the value to be assigned to all variable optical attenuators (VOAs) representing the optical path inside the node.

Table Of Contents

OPR Commands

16.1 OPR-ACO-ALL

Usage Guidelines

16.2 OPR-ALS

Usage Guidelines

16.3 OPR-APC

Usage Guidelines

16.4 OPR-EXT-CONT

Usage Guidelines

16.5 OPR-LASER-OTS

Usage Guidelines

16.6 OPR-LNK

Usage Guidelines

16.7 OPR-LPBK-<MOD2>

Usage Guidelines

16.8 OPR-PROTNSW-<MOD2DWDMPAYLOAD>

Usage Guidelines

16.9 OPR-PROTNSW-<OCN_TYPE>

Usage Guidelines

16.10 OPR-PROTNSW-<PATH>

Usage Guidelines

16.11 OPR-PROTNSW-OCH

Usage Guidelines

16.12 OPR-SLV-WDMANS

Usage Guidelines

16.13 OPR-SYNCNSW

Usage Guidelines

16.14 OPR-WDMANS

Usage Guidelines