Chapter 18, RLS Commands

Table Of Contents

RLS Commands

18.1  RLS-EXT-CONT

18.2  RLS-LASER-OTS

18.3  RLS-LPBK-<MOD2>

18.4  RLS-PROTNSW-<MOD2DWDMPAYLOAD>

18.5  RLS-PROTNSW-<OCN_TYPE>

18.6  RLS-PROTNSW-<PATH>

18.7  RLS-PROTNSW-OCH

18.8  RLS-SYNCNSW

RLS 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 release (RLS) commands for the Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, and ONS 15600.

18.1  RLS-EXT-CONT

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Release External Control (RLS-EXT-CONT) command releases a forced contact state and returns the control of the contact to an AUTOMATIC control state. In AUTOMATIC control state, the contact can be opened or closed depending on triggers that might be provisioned in the network element (NE). Therefore, issuing a RLS might not produce any contact state change.

Usage Guidelines

The NE defaults to having no triggers provisioned for external controls, which consequently produces default open contacts. An NE with this default provisioning will always produce an open contact with a RLS-EXT-CONT command.

Note•The duration is not supported; it defaults to CONTS.

•In an automatic state, the contact could be opened or closed depending on the provisioned trigger. Therefore, issuing an OPR-EXT-CONT command followed by an RLS-EXT-CONT command might not produce any contact state change.

•The RLS-EXT-CONT is not allowed during the MNTRY duration. The command is allowed for the CONTS duration. The length of MNTRY duration is set to be 2 seconds.

•RLS-EXT-CONT cannot change the contact state to Automatic if the existing state is Manual Open.

Category

Environment

Security

Maintenance

Input Format

RLS-EXT-CONT:[<TID>]:<AID>:<CTAG>[::,];

Input Example

RLS-EXT-CONT:CISCO:ENV-OUT-2:123;

Input Parameters

<AID>

Access identifier from the "ENV" section. Identifies the external control being released.

18.2  RLS-LASER-OTS

(Cisco ONS 15454) The Release Laser Optical Transport Section (RLS-LASER-OTS) command instructs a laser to be switched off.

Usage Guidelines

None

Category

DWDM

Security

Maintenance

Input Format

RLS-LASER-OTS:[<TID>]:<AID>:<CTAG>;

Input Example

RLS-LASER-OTS::LINE-5-2-TX:3;

Input Parameters

<AID>

Access identifier from the "LINE" section. Identifies the external control being released.

18.3  RLS-LPBK-<MOD2>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Release 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, and VT2 (RLS-LPBK-<MOD2>) command releases a signal loopback on a multiservice or a cross-connect card.

Usage Guidelines

See Table 27-1 for supported modifiers by platform.

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

•The optional LPBKTYPE field defaults to the current existing loopback type.

•The TERMINAL loopback type is supported on the DS1 path of DS3XM cards.

•FEAC loopbacks can be released by specifying LINE as the loopback type and FEND as the location.

•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 result in an error message.

•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.

Category

Troubleshooting and Test Access

Security

Maintenance

Input Format

RLS-LPBK-<MOD2>:[<TID>]:<SRC>:<CTAG>::[<LOCATION>],,,[<LPBKTYPE>];

Input Example

RLS-LPBK-DS1:PTREYES:DS1-4-1-2-13:203::NEND,,,FACILITY;

Input Parameters

<SRC>

Source 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 which is established at the cross-connect matrix level (the XCVT/XC10G card). A synchronous transport signal (STS)-level cross-connect loopback causes a path alarm indication signal (AIS-P) to be sent in 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.

18.4  RLS-PROTNSW-<MOD2DWDMPAYLOAD>

(Cisco ONS 15454) The Release Protection Switch for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, or PASSTHRU (RLS-PROTNSW-<MOD2DWDMPAYLOAD>) command releases a Y-cable protection switch on client facilities.

Usage Guidelines

None

Category

DWDM

Security

Maintenance

Input Format

RLS-PROTNSW-<MOD2DWDMPAYLOAD>:[<TID>]:<SRC>:<CTAG>[::];

Input Example

RLS-PROTNSW-HDTV:CISCO:FAC-1-1-1:100;

Input Parameters

<SRC>

Source access identifier from the "FACILITY" section.

18.5  RLS-PROTNSW-<OCN_TYPE>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Release Protection Switch for OC3, OC12, OC48, or OC192 (RLS-PROTNSW-<OCN_TYPE>) command releases a SONET line protection switch request.

Usage Guidelines

See Table 27-1 for supported modifiers by platform.

The release of a protection switch request is applicable only to the OPR-PROTNSW protection switch commands, which are the user-initiated switch protection commands.

The following actions will return error messages:

•This command is not used for the common control (TCC2/TCC2P or XCVT/XC10G) cards. Sending a command on a common control card will return an IIAC (Input, Invalid Access Identifier) error message. To query the common control card switching commands, 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 SWFA (Status, Working unit Failed) error message.

•Sending this command to a protect card that is failed or missing will return the SPFA (Status, Protection unit Failed) error message.

•Sending this command to a card that is not in protection will return the SNPR (Status, Not in Protection State) error message.

•Sending this command to an OC-N line that is already in clear mode will return a SAMS (Already in Clear Maintenance State) error message.

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

•DIRN is an optional parameter. A NULL value defaults to BTH for a bidirectional line switched ring (BLSR), BTH for a 1+1 bidirectional protection group, and RCV for 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. OPR-PROTNSW applies to a BLSR span/ring as shown by the following command, which instructs the NE to release a line protection switch request between a working line and a protection line:

RLS-PROTNSW-OC48::FAC-5-1:A::BTH;

Category

Protection

Security

Maintenance

Input Format

RLS-PROTNSW-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::<DIRECTION>];

Input Example

RLS-PROTNSW-OC48:PETALUMA:FAC-6-1:209::BTH;

Input Parameters

<AID>

Access identifier from the "FACILITY" section. Identifies the facility in the NE to which the switch request is directed.

<DIRECTION>

Direction. Defaults to RCV. The parameter type is DIRECTION (transmit and receive direction)

•BTH

Both transmit and receive directions

•RCV

Receive direction only

•TRMT

Transmit direction only

18.6  RLS-PROTNSW-<PATH>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Release Protection Switch for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, or VT2 (RLS-PROTNSW-<PATH>) command releases a SONET path protection switch request that was established with the OPR-PROTNSW-<PATH> command. This command assumes that only one user-initiated switch is active per AID.

Usage Guidelines

See Table 27-1 for supported modifiers by platform.

Note•This command applies to path protection configuration only.

•The VTAID should be the working or protect AID only.

•If sending 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 command.

Category

Protection

Security

Maintenance

Input Format

RLS-PROTNSW-<PATH>:[<TID>]:<SRC>:<CTAG>[::];

Input Example

RLS-PROTNSW-STS1:CISCO:STS-2-1-1:123;

Input Parameters

MSRC>

Source access identifier from the "CrossConnectId" section.

18.7  RLS-PROTNSW-OCH

(Cisco ONS 15454) The Release Protection Switch Optical Channel (RLS-PROTNSW-OCH) command releases the protection switch on a TXPP_MR_2.5G card.

Usage Guidelines

None

Category

DWDM

Security

Maintenance

Input Format

RLS-PROTNSW-OCH:[<TID>]:<AID>:<CTAG>;

Input Example

RLS-PROTNSW-OCH:VA454-22:CHAN-2-2:1;

Input Parameters

<AID>

Access identifier from the "CHANNEL" section.

18.8  RLS-SYNCNSW

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Release Synchronization Switch (RLS-SYNCNSW) command releases the previous synchronization reference provided by the OPR-SYNCNSW command.

Usage Guidelines

In a nonrevertive system, the use of the RLS-SYNCNSW command might not be appropriate. All the switching between synchronization references should be initiated with the OPR-SYNCNSW command.

When a switch is released, the MANSWTOPRI (Manual Switch to Primary Reference or Secondary...) or FRDCSWTOPRI (Forced Switch to Primary Reference or Secondary...) minor alarm will be cleared.

Category

Synchronization

Security

Maintenance

Input Format

RLS-SYNCNSW:[<TID>]:[<AID>]:<CTAG>;

Input Example

RLS-SYNCNSW:CISCO:SYNC-NE:3;

Input Parameters

<AID>

Access identifier from the "SYNC_REF" section Defaults to SYNC-NE.

<SRC>	Source 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 which is established at the cross-connect matrix level (the XCVT/XC10G card). A synchronous transport signal (STS)-level cross-connect loopback causes a path alarm indication signal (AIS-P) to be sent in 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.

<AID>	Access identifier from the "FACILITY" section. Identifies the facility in the NE to which the switch request is directed.
<DIRECTION>	Direction. Defaults to RCV. The parameter type is DIRECTION (transmit and receive direction)
•BTH	Both transmit and receive directions
•RCV	Receive direction only
•TRMT	Transmit direction only