Table Of Contents

RLS Commands

20.1  RLS-CPS

20.2  RLS-EXT-CONT

20.3  RLS-LPBK-<MOD2NCSPAYLOAD>

20.4  RLS-LPBK-EFM

20.5  RLS-PROTNSW-<MOD2NCSPAYLOAD>

20.6  RLS-PROTNSW-<PATH>

20.7  RLS-PROTNSW-<STM_TYPE>

20.8  RLS-PROTNSW-<OCN_TYPE>

20.9  RLS-PROTNSW-OCH

20.10  RLS-PROTNSW-OTS

20.11  RLS-SYNCNSW

RLS Commands

---

This chapter provides release (RLS) commands for the Cisco NCS 2002 and Cisco NCS 2006.

20.1  RLS-CPS

The Release Control Plane Service (RLS-CPS) command is used to deactivate a Control Plane Service parameter.

Usage Guidelines

•Specify only the source port to identify the CPS

•Specify both the source AIDs, if the CPS is of type ADD 2WAY

•If the AID is invalid, an IIAC (invalid AID) error message is returned

•The ALL AID is invalid for this command

•CLIENT cps type support FAC and VFAC AID type.

•TRUNK cps type support CHAN AID type.

•ADD cps type support CHAN, PCHAN, and LINEWL AID type.

Category

NCS

Security

Provisioning

Input Format

RLS-CPS:[<TID>]:<SRC>:<CTAG>::[:CKTID=<CKTID>][:];

Input Example

RLS-CPS::PCHAN-8-8-RX&PCHAN-8-8-TX:8::;

Input Parameters

<SRC>	Source AID from the "CrossConnectId1" section.
<CKTID>	Circuit identification parameter can be used to filter this command

20.2  RLS-EXT-CONT

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.

Usage Guidelines

•In AUTOMATIC control state, the contact can be opened or closed depending on triggers that might or might not be provisioned in the NE. Therefore, issuing a RLS might not produce any contact state change.

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

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

20.3  RLS-LPBK-<MOD2NCSPAYLOAD>

The Release Loopback for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 4GFC, 2GFICON, 5GIB, 8GFC, CLNT, D1VIDEO, DS3I, DV6000, E1, E3, E4, ESCON, ETRCLO, ETH, EQPT, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, STM4, STM64, STM1, STM16, OCH, OMS, OTS, OTU3, POS, STM1E, 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, OTU2, OTU4, ISC3STP1G, or ISC3STP2G (RLS-LPBK-<MOD2>) command releases a signal loopback on an I/O card or a cross-connect. See Table 29-1 for supported modifiers by platform.

Usage Guidelines

The command supports the modifier 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, ISC3STP1G, and ISC3STP2G.

•The value CRS for the LPBKTYPE parameter is applicable only for the VC 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.

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

•RLS-LPBK-EQPT uses the backplane loopback type to unprovision the loopback provisioned.

•You can run the command even if the loopback type is not specified in the command.

•When the backplane loopback provisioned on the equipment is released, it unprovisions all the ports present on the equipment loopback.

Category

Troubleshooting and Test Access

Security

Maintenance

Input Format

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

Input Example

RLS-LPBK-3GVIDEO:PTREYES:VFAC-1-2-5-1:203::NEND,,,FACILITY;

RLS-LPBK-EQPT::SLOT-2:1::NEND,,,BACKPLANE-TERMINAL;

Table 20-1 Parameter Support

Parameter	Description
<SRC>	Source access identifier from the "ALL" section. The valid values for AID are FACILITY, DS1, and STS. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
<LOCATION>	(Optional) 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>	(Optional) Type of loopback signal. The parameter type is LPBK_TYPE, which indicates the type of loopback that is to be operated or released.
•BACKPLANE-FACILITY	Puts the 100G-LC-C, 10x10G-LC, and CFP-LC cards in facility loopback.
•BACKPLANE-TERMINAL	Puts the 100G-LC-C, 10x10G-LC, and CFP-LC cards in Terminal loopback.
•CRS	Path-level loopback that is established at the cross-connect matrix level. A VC level cross-connect loopback causes an 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.
•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.

20.4  RLS-LPBK-EFM

The Release Loopback Ethernet in the First Mile (RLS-LPBK-EFM) command releases the loopback that is provisioned on the Ethernet in the First Mile (EFM) enabled port.

Usage Guidelines

•This command is applicable only to GE_XP and 10GE_XP cards.

•The card should be in Layer2 over DMDM mode.

Category

Ports

Security

Provisioning

Input Format

RLS-LPBK-EFM:[<TID>]:<AID>:<CTAG>;

Input Example

RLS-LPBK-EFM::ETH-12-1-1:1;

Table 20-2 REP-LPBK-EFM Command - Parameter Support

Input Parameters	Description
<AID>	Access identifier from the "ETH" section.

20.5  RLS-PROTNSW-<MOD2NCSPAYLOAD>

The Release Protection Switch for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 8GFC, D1VIDEO, DV6000, DVBASI, ETRCLO, FSTE, GIGE, HDTV, ISC1, ISC3, OTU3, OTU4, PASSTHRU, 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, ISC3STP1G, or ISC3STP2G (RLS-PROTNSW-<MOD2NCSPAYLOAD>) command releases a SONET line protection switch request.

Usage Guidelines

The command supports the modifier 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, ISC3STP1G, and ISC3STP2G.

Category

NCS

Security

Maintenance

Input Format

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

Input Example

RLS-PROTNSW-3GVIDEO:CISCO:VFAC-1-1-1:100;

Input Parameters

<SRC>

Source access identifier from the "FACILITY" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.

20.6  RLS-PROTNSW-<PATH>

The Release Protection Switch for VC3, VC44C, VC464C, VC48C, VC4, VC412C, VC46C, VC416C, VC42C, VC43C, or VC11 (RLS-PROTNSW-<PATH>) command releases an NCS 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. See Table 29-1 for supported modifiers by platform.

Usage Guidelines

•This command applies to subnetwork connection protection (SNCP) configurations only.

•The VTAID should be working or protect AID only.

•Sending this command on the Drop AID will return a DENY (Invalid AID, should use working/protect AID) message.

•Use the RTRV-COND-ALL or RTRV-ALM-ALL command to retrieve the protection switching state (manual, lockout, forced).

Category

Protection

Security

Maintenance

Input Format

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

Input Example

RLS-PROTNSW-VC3:CISCO:VC3-2-1-1:123;

Input Parameters

<SRC>

Source access identifier from the "CrossConnectId" section.

20.7  RLS-PROTNSW-<STM_TYPE>

The Release Protection Switch (STM1, STM4, STM16, STM64) command releases a protection switch request. See Table 29-1 for supported modifiers by platform.

Usage Guidelines

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

•Use the RTRV-COND-ALL or RTRV-ALM-ALL command to retrieve the protection switching state (manual, lockout, forced).

•DIRN is an optional parameter. A NULL value defaults to BTH for a MS-SPRing protection, BTH for 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 MS-SPRing protection groups, both the RCV and TRMT directions will fail.

•DIRN is applicable for both 1+1 and MS-SPRing protection groups. OPR-PROTNSW applies to a MS-SPRing span/ring as shown by the following command:

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

This command instructs the NE to release a line protection switch request between a working line and a protection line.

The following actions will return error messages:

•This command is not used for the common control (TCC2, TCC2P, TCC3, XC-VXL-10G, XC-VXL-2.5G, or XC-VXC-10G) cards. Sending a command on a common control card will return an Input, Invalid Access Identifier (IIAC) error message. To switch common control cards, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.

•Sending this command to non-NCS (STM) cards will return an Input, Invalid Access Identifier (IIAC) error message. To switch a non-NCS card, use the ALW-SWTOPROTN-EQPT, ALS-SWTOWKG-EQPT, INH-SWTOPROTN-EQPT, and INH-SWTOWKG-EQPT commands.

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

•Sending this command to a working card that is failed or missing will return the Status, Working Unit Failed (SWFA) error message.

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

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

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

Category

Protection

Security

Maintenance

Input Format

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

Input Example

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

Table 20-3 Parameter Support

Parameter	Description
<AID>	Access identifier from the "FACILITY" section. Identifies the facility in the NE to which the switch request is directed.
<DIRECTION>	(Optional) 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

20.8  RLS-PROTNSW-<OCN_TYPE>

The Release Protection Switch for OC3, OC12, OC48, OC192, or OC768 (RLS-PROTNSW-<OCN_TYPE>) command releases a SONET line protection switch request.

Usage Guidelines

See Table 29-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/TCC3 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:

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

This command instructs the NE to release a line protection switch request between a working line and a protection line

---

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

20.9  RLS-PROTNSW-OCH

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

NCS

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.

20.10  RLS-PROTNSW-OTS

The Release Protection Switch OTS (RLS-PROTNSW-OTS) command releases the protection switch on a TXPP_MR_2.5G card or a protection switch unit or a OTU2-XP card.

When Y-cable protection is provisioned on the OTU2-XP, this command releases a Y-cable protection switch.

Usage Guidelines

None

Category

NCS

Security

Maintenance

Input Format

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

Input Example

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

Input Parameters

<AID>

Access identifier from the "CHANNEL" section.

20.11  RLS-SYNCNSW

The Release Synchronization Switch (RLS-SYNCHSW) 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.

After a switch is released, a minor alarm, Manual Switch to Primary Reference or Secondary (MANSWTOPRI) or Forced Switch to Primary Reference or Secondary (FRDCSWTOPRI), 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>

(Optional) Access identifier from the "SYNC_REF" sectionDefaults to SYNC-NE.