Cisco ONS SDH TL1 Command Guide, Release 9.6.x
Chapter 14, INH Commands
Downloads: This chapterpdf (PDF - 148.0KB) The complete bookPDF (PDF - 10.67MB) | Feedback

Table of Contents

INH Commands

14.1 INH-CONSOLE-PORT

14.2 INH-MSG-ALL

14.3 INH-MSG-DBCHG

14.4 INH-MSG-SECU

14.5 INH-PMREPT-ALL

14.6 INH-SWDX-EQPT

14.7 INH-SWTOPROTN-EQPT

14.8 INH-SWTOWKG-EQPT

14.9 INH-USER-SECU

INH Commands

This chapter provides inhibit (INH) commands for the Cisco ONS 15454 SDH, Cisco ONS 15454 M2, and Cisco ONS 15454 M6.


Note All commands supported on the Cisco ONS 15454 SDH platform are also supported on Cisco ONS 15454 M2 and Cisco ONS 15454 M6 platforms.


14.1 INH-CONSOLE-PORT

(Cisco ONS 15454 SDH) The Inhibit Console Port (INH-CONSOLE-PORT) command is used to turn off the console port for an ML-Series card.

 
Usage Guidelines

None

Category

Security

Security

Superuser

Input Format

INH-CONSOLE-PORT:[<TID>]:<AID>:<CTAG>;

Input Example

INH-CONSOLE-PORT:CISCONODE:SLOT-2:123;

Input Parameters

<AID>

Access identifier from the “EQPT” section.

14.2 INH-MSG-ALL

(Cisco ONS 15454 SDH) The Inhibit Message All (INH-MSG-ALL) command inhibits all REPT ALM and REPT EVT autonomous messages from being transmitted.

 
Usage Guidelines

  • See the ALW-MSG-ALL command to resume these autonomous messages. When a TL1 session starts, the REPT ALM and REPT EVT messages are allowed by default.
  • If this command is used twice in the same session, the Already Inhibited (SAIN) error message is reported.

Category

System

Security

Retrieve

Input Format

INH-MSG-ALL:[<TID>]:[<AID>]:<CTAG>[::,,];

Input Example

INH-MSG-ALL:PETALUMA:ALL:550;

Input Parameters

<AID>

(Optional) Access identifier from the “ALL” section.

14.3 INH-MSG-DBCHG

(Cisco ONS 15454 SDH) The Inhibit Database Change Message (INH-MSG-DBCHG) command disables the REPT DBCHG message.

 
Usage Guidelines

None

Category

Log

Security

Retrieve

Input Format

INH-MSG-DBCHG:[<TID>]::<CTAG>[::,,];

Input Example

INH-MSG-DBCHG:CISCO::123;

Input Parameters

None

14.4 INH-MSG-SECU

(Cisco ONS 15454 SDH) The Inhibit Message Security (INH-MSG-SECU) command inhibits the REPT EVT SECU and REPT ALM SECU messages.

 
Usage Guidelines

None

Category

Security

Security

Superuser

Input Format

INH-MSG-SECU:[<TID>]::<CTAG>[::,,];

Input Example

INH-MSG-SECU:PETALUMA::123;

Input Parameters

None

14.5 INH-PMREPT-ALL

(Cisco ONS 15454 SDH) The Inhibit Performance Report All (INH-PMREPT-ALL) command inhibits all scheduled performance monitoring (PM) reporting. The inhibition of the PM reporting is session-based, which means the command is only effective to the TL1 session that issues this command. A TL1 session for which PM reports are inhibited will include an INHMSG-PMREPT condition when issuing TL1 command RTRV-COND-ALL.

 
Usage Guidelines

None

Category

Performance

Security

Retrieve

Input Format

INH-PMREPT-ALL:[<TID>]::<CTAG>;

Input Example

INH-PMREPT-ALL:NE-NAME::123;

Input Parameters

None

14.6 INH-SWDX-EQPT

(Cisco ONS 15454 SDH) The Inhibit Switch Duplex Equipment (INH-SWDX-EQPT) command inhibits automatic or manual switching on a system containing duplex equipment.

 
Usage Guidelines

  • Use the ALW-SWDX command to release the inhibit.
  • This command is not used for SDH line protection switching. For SDH line/path protection switching commands, use the OPR-PROTNSW and RLS-PROTNSW commands.
  • This command is not used for 1:1 and 1:N equipment protection switching; use ALW-SWTOPROTN, ALW-SWTOWKG, INH-SWTOPROTN, INH-SWTOWKG commands instead.
  • In this release, this command applies only to the XC-VXC-10G, XC-VXL-10G, and XC-VXL-2.5G cards.
  • If you send this command to a TCC2/TCC2P/TCC3 card, an error message will occur because the network element (NE) treats the TCC2/TCC2P/TCC3 as a nonrevertive protection group without user control.

Category

Equipment

Security

Maintenance

Input Format

INH-SWDX-EQPT:[<TID>]:<AID>:<CTAG>[::];

Input Example

INH-SWDX-EQPT:CISCO:SLOT-1:1234;

Input Parameters

<AID>

Access identifier from the “EQPT” section.

14.7 INH-SWTOPROTN-EQPT

(Cisco ONS 15454 SDH) The Inhibit Switch to Protection Equipment (INH-SWTOPROTN-EQPT) command inhibits automatic or manual switching of an equipment card to protection. Use the ALW-SWTOPROTN-EQPT command to release the inhibit.

 
Usage Guidelines

Use the INH-SWTOPROTN-EQPT command for electrical cards (such as, E1, E3, E4, and DS3i-N-12 cards) that can participate in an electrical protection group.

When performing a lockout with this command, traffic will be switched from the card specified by the AID, unless the working card being protected has failed or is missing. When performing a lock-on with this command and the working card specified in the AID is in standby, sending this command will also initiate a traffic switch. When traffic is locked on the working card or locked out of the protection card with this command, the protection card will not carry traffic, even if the working card is pulled from the system.

Sending this command to a working card in a 1:N protection group does not prevent a protection switch from another working card in the same protection group. All the working cards must be sent this command to prevent a protection switch. If the command is sent only to a subset of the working cards, only those working cards will have traffic locked on.

The inhibit state is persistent over TCC2/TCC2P/TCC3 side switches and removal/reboot of all the cards in the protection group. The inhibit state can be, but does not have to be, persistent over a complete power cycle of the NE.

The card specified by the AID will raise the condition of INHSWPR when this command is sent.

The following actions will return error messages:

  • This command only supports the BTH value of the DIRN parameter. A command with any other value is considered an incorrect use of the command and will return an Input, Data Not Valid (IDNV) error message.
  • This command is not used for the common control (TCC2, TCC2P, TCC3, XC-VXL-10G, XC-VXL-2.5G, or XC-VXC-10G) cards. A command on a common control card will return an Input, Invalid Access Identifier (IIAC) error message. To switch the common control cards, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.
  • This command is not used for optical (STM) cards. A command on an optical card will return an IIAC error message. To switch an optical card, use the OPR-PROTNSW and RLS-PROTNSW commands.
  • If this command is used on a card that is not in a protection group, the Status, Not in Valid State (SNVS) error message is returned.
  • If this command is used on a card that is already in the inhibit state, the SAIN error message is returned.
  • Sending this command to a working card when the protect card in the same protection group has already raised the condition of INHSWWKG will return the Status, Protection Unit Locked (SPLD) error message.
  • Sending this command to the protect card when a working card in the same protection group has already raised the condition of INHSWWKG will return the Status, Working Unit Locked (SWLD) error message.
  • Sending this command to an active protect card when the peer working card is failed or missing will return the Status, Working Unit Failed (SWFA) error message.

As long as none of the previous error conditions apply, sending this command to missing cards will not generate any error response.

Category

Equipment

Security

Maintenance

Input Format

INH-SWTOPROTN-EQPT:[<TID>]:<AID>:<CTAG>[::<DIRN>];

Input Example

INH-SWTOPROTN-EQPT:CISCO:SLOT-2:123::BTH;

Input Parameters

<AID>

Access identifier from the “EQPT” section. This AID can either be the working card for which switching to protection is inhibited (lock-on) or the protection card for which carrying traffic is to be inhibited (lockout).

<DIRN>

(Optional) The direction relative to the entity defined in the AID field. The direction of the switching. This command only supports the BTH value of this parameter. DIRN defaults to BTH. The parameter type is DIRECTION (transmit and receive directions).

  • BTH

Both transmit and receive directions

14.8 INH-SWTOWKG-EQPT

(Cisco ONS 15454 SDH) The Inhibit Switch to Working Equipment (INH-SWTOWKG-EQPT) command inhibits automatic or manual switching of an equipment card back to the working card. Use the ALW-SWTOWKG-EQPT command to release the inhibit.

 
Usage Guidelines

INH-SWTOWKG-EQPT is used for electrical cards (such as, E1, E3, E4, and DS3i-N-12 cards) that can participate in an electrical protection group.

When performing a lockout with this command, the traffic will be switched from the card specified by the AID, unless the protection card has failed or is missing. When performing a lock-on with this command and the protection card specified in the AID is in standby, sending this command will initiate a traffic switch only when there is one working card in the protection group. In the case where there is more than one working card in the protection group, an error will be generated (see the error conditions that follow). When traffic is locked on the protection card or locked out of a working card with this command, the working card will not carry traffic, even if the protection card is pulled from the system.

The inhibit state is persistent over TCC2/TCC2P/TCC3 side switches and removal/reboot of all the cards in the protection group. The inhibit state can but does not have to be persistent over a complete power cycle of the NE.

The card specified by the AID will raise the condition of INHSWWKG when this command is sent.

The following actions will return error messages:

  • The command only supports the BTH value of the DIRN parameter. A command with any other value is considered an incorrect use of the command and will return an IDNV error message.
  • This command is not used for the common control (TCC2, TCC2P, TCC3, XC-VXL-10G, XC-VXL-2.5G, or XC-VXC-10G) cards. A command on a common control card will return an IIAC error message. To switch the common control cards, use the SW-DX-EQPT and ALW-SWDX-EQPT commands.
  • This command is not used for optical (STM) cards. A command on an optical card will return an IIAC error message. To switch an optical card, use the OPR-PROTNSW and RLS-PROTNSW commands.
  • If this command is used on a card that is not in a protection group, the SNVS error message is returned.
  • If this command is used on a card that is already in the inhibit state, the SAIN error message is returned.
  • Sending this command to a working card when the protect card in the same protection group has already raised the condition of INHSWPR will return the SPLD error message.
  • Sending this command to a protect card when a working card in the same protection group has already raised the condition of INHSWPR will return the SWLD error message.
  • Sending this command to an active working card when the protect card has failed or is missing will return the SPFA error message.
  • Sending the INH-SWTOWKG command to an active working card when the protect card is already carrying traffic (this only occurs in a 1:N protection group with N greater than one) will return the Status, Protection Unit Active (SPAC) error message.

As long as none of the previous error conditions apply, sending this command to missing cards is allowed and will not generate any error response.

Category

Equipment

Security

Maintenance

Input Format

INH-SWTOWKG-EQPT:[<TID>]:<AID>:<CTAG>[::<DIRN>];

Input Example

INH-SWTOWKG-EQPT:CISCO:SLOT-2:123::BTH;

Input Parameters

<AID>

Access identifier from the “EQPT” section. This AID can either be the working card for which switching to protection is inhibited (lock-on) or the protection card for which carrying traffic is to be inhibited (lockout).

<DIRN>

(Optional) The direction relative to the entity defined in the AID field. The direction of the switching. This command only supports the BTH value of this parameter. DIRN defaults to BTH. The parameter type is DIRECTION (transmit and receive directions)

  • BTH

Both transmit and receive directions

14.9 INH-USER-SECU

(Cisco ONS 15454 SDH) The Inhibit User Security (INH-USER-SECU) command disables (without deleting) a user account, so the user is denied access to the NE. The user is disabled until reenabled through the ALW-USER-SECU command.

 
Usage Guidelines

  • This command does not forcibly log a user off. If the user is logged in, changes do not apply until after the user has logged off.
  • The user is disabled until enabled through the corresponding ALW command.

Category

Security

Security

Superuser

Input Format

INH-USER-SECU:[<TID>]::<CTAG>::<UID>;

Input Example

INH-USER-SECU:PETALUMA::123::CISCO100;

Input Parameters

<UID>

User identifier. UID is a string.