Cisco ONS 15454 SDH TL1 Command Guide, Release 6.0
Chapter 14, INH Commands
Downloads: This chapterpdf (PDF - 234.0KB) The complete bookPDF (PDF - 9.88MB) | Feedback

INH Commands

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 INH (inhibit) commands for the Cisco ONS 15454 SDH.

14.1  INH-CONSOLE-PORT

Inhibit Console Port

Usage Guidelines

This command is used to turn off the console port for the ML-Series cards.

Category

Security

Security

Superuser

Related Commands

ACT-USER

ALW-CONSOLE-PORT

ALW-MSG-SECU

ALW-USER-SECU

CANC

CANC-USER

CANC-USER-SECU

CLR-COND-SECU

DLT-USER-SECU

ED-CMD-SECU

ED-PID

ED-PROTOCOL

ED-USER-SECU

ENT-USER-SECU

INH-MSG-SECU

INH-USER-SECU

REPT ALM SECU

REPT EVT SECU

REPT EVT SESSION

RTRV-AUDIT-LOG

RTRV-CMD-SECU

RTRV-CONSOLE-PORT

RTRV-DFLT-SECU

RTRV-USER-SECU

SET-ATTR-SECUDFLT


Input Format

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

Input Example

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

Input Parameters

Table 14-1 INH-CONSOLE-PORT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.10  EQPT" section on page 25-15.


14.2  INH-MSG-ALL

Inhibit Message All

Usage Guidelines

This command inhibits all REPT ALM and REPT EVT autonomous messages from being transmitted. See the ALW-MSG-ALL to resume these autonomous messages. When a TL1 session starts, the REPT ALM and REPT EVT messages are allowed by default.


Note If this command is used twice in the same session, the SAIN (Already Inhibited) error message is reported.


Category

System

Security

Retrieve

Related Commands

ACT-USER

ALW-MSG-ALL

ALW-MSG-DBCHG

ALW-MSG-SECU

DLT-TRAPTABLE

ED-DAT

ED-NE-GEN

ED-NE-PATH

ED-NE-SYNCN

ED-TRAPTABLE

ENT-TRAPTABLE

INH-MSG-DBCHG

INH-MSG-SECU

INIT-SYS

RTRV-HDR

RTRV-INV

RTRV-NE-GEN

RTRV-NE-IPMAP

RTRV-NE-PATH

RTRV-NE-SYNCN

RTRV-NE-WDMANS

RTRV-TOD

RTRV-TRAPTABLE

SET-TOD


Input Format

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

Input Example

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

Input Parameters

Table 14-2 INH-MSG-ALL Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1  ALL" section on page 25-1


14.3  INH-MSG-DBCHG

Inhibit Database Change Message

Usage Guidelines

This command disables REPT DBCHG.

Category

Log

Security

Retrieve

Related Commands

ACT-USER

ALW-MSG-ALL

ALW-MSG-DBCHG

ALW-MSG-SECU

DLT-TRAPTABLE

ED-DAT

ED-NE-GEN

ED-NE-PATH

ED-NE-SYNCN

ED-TRAPTABLE

ENT-TRAPTABLE

INH-MSG-ALL

INH-MSG-SECU

INIT-SYS

RTRV-HDR

RTRV-INV

RTRV-NE-GEN

RTRV-NE-IPMAP

RTRV-NE-PATH

RTRV-NE-SYNCN

RTRV-NE-WDMANS

RTRV-TOD

RTRV-TRAPTABLE

SET-TOD


Input Format

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

Input Example

INH-MSG-DBCHG:CISCO::123;

Input Parameters

Table 14-3 INH-MSG-DBCHG Input Parameters 

Parameter and Values
Description

 

14.4  INH-MSG-SECU

Inhibit Message Security

Usage Guidelines

This command inhibits the REPT EVT SECU and REPT ALM SECU autonomous messages.

Category

Security

Security

Superuser

Related Commands

ACT-USER

ALW-MSG-ALL

ALW-MSG-DBCHG

ALW-MSG-SECU

DLT-TRAPTABLE

ED-DAT

ED-NE-GEN

ED-NE-PATH

ED-NE-SYNCN

ED-TRAPTABLE

ENT-TRAPTABLE

INH-MSG-ALL

INH-MSG-DBCHG

INIT-SYS

RTRV-HDR

RTRV-INV

RTRV-NE-GEN

RTRV-NE-IPMAP

RTRV-NE-PATH

RTRV-NE-SYNCN

RTRV-NE-WDMANS

RTRV-TOD

RTRV-TRAPTABLE

SET-TOD


Input Format

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

Input Example

INH-MSG-SECU:PETALUMA::123;

Input Parameters

Table 14-4 INH-MSG-SECU Input Parameters 

Parameter and Values
Description

 

14.5  INH-PMREPT-ALL

Inhibit Performance Report All

Usage Guidelines

This command inhibits all scheduled PM reporting. The inhibitance of the PM reporting is session-based, which means the command is only effective to the TL1 session that issues this command. By default, the scheduled PM reporting is inhibited by a TL1 session.

A TL1 session for which PM reports are inhibited will include an INHMSG-PMREPT condition when issuing TL1 command RTRV-COND-ALL.

Category

Performance

Security

Retrieve

Related Commands

ALW-PMREPT-ALL

DLT-RMONTH-<MOD2_RMON>

ENT-RMONTH-<MOD2_RMON>

INIT-REG-<MOD2>

REPT PM <MOD2>

RTRV-PM-<MOD2>

RTRV-PMMODE-<VC_PATH>

RTRV-PMSCHED-<MOD2>

RTRV-PMSCHED-ALL

RTRV-RMONTH-<MOD2_RMON>

RTRV-TH-<MOD2>

RTRV-TH-ALL

SCHED-PMREPT-<MOD2>

SET-PMMODE-<VC_PATH>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Input Parameters

Table 14-5 INH-PMREPT-ALL Input Parameters 

Parameter and Values
Description

 

14.6  INH-SWDX-EQPT

Inhibit Switch Duplex Equipment

Usage Guidelines

This command inhibits automatic or manual switching on a system containing duplex equipment. 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.


Note This command applies for the XC-VXC-10G, XC-VXL-10G and XC-VXL-2.5G equipment units only in this release.



Note If you send this command to a TCC2/TCC2P card, an error message will occur because the NE treats the TCC2/TCC2P as a non-revertive protection group without user control.


Category

Equipment

Security

Maintenance

Related Commands

ALW-SWDX-EQPT

ALW-SWTOPROTN-EQPT

ALW-SWTOWKG-EQPT

DLT-EQPT

ED-EQPT

ENT-EQPT

EX-SW-<STM_MSSPR>

INH-SWTOPROTN-EQPT

INH-SWTOWKG-EQPT

REPT ALM EQPT

REPT EVT EQPT

REPT SW

RTRV-ALM-EQPT

RTRV-ALMTH-EQPT

RTRV-COND-EQPT

RTRV-EQPT

SET-ALMTH-EQPT

SW-DX-EQPT

SW-TOPROTN-EQPT

SW-TOWKG-EQPT


Input Format

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

Input Example

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

Input Parameters

Table 14-6 INH-SWDX-EQPT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.10  EQPT" section on page 25-15


14.7  INH-SWTOPROTN-EQPT

Inhibit Switch to Protection Equipment

Usage Guidelines

This command inhibits automatic or manual switching of an equipment unit to protection. Use the ALW-SWTOPROTN-EQPT command to release the inhibit.

INH-SWTOPROTN-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 unit specified by the AID, unless the working unit being protected has failed or is missing. When performing a lock on with this command and the working unit specified in the AID is in standby, sending this command will also initiate a traffic switch. When traffic is locked on a working unit or locked out of the protection unit with this command, the protection unit will not carry traffic, even if the working unit is pulled from the system.

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

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

The unit 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 one value of the <DIRN> parameter - BTH. A command with any other value is considered an incorrect use of the command and will return an IDNV (Input, Data Not Valid) error message.

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

This command is not used for SDH (STM) cards. A command on a SDH card will return an IIAC (Input, Invalid Access Identifier) error message. To use a SDH card switching command, 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 (Status, Not in Valid State) error message will be returned.

If this command is used on a card that is already in the inhibit state, the SAIN (Status, Already Inhibited) error message will be returned.

Sending the inhibit switch to protection command to a working card when the protect card in the same protection group has already raised the condition of INHSWWKG will return the SPLD (Status, Protection unit Locked) error message.

Sending the inhibit switch to protection command to the protect card when a working card in the same protection group has already raised the condition of INHSWWKG will return the SWLD (Status, Working unit Locked) error message.

Sending the inhibit switch to protection command to an active protect card when the peer working card is failed or missing will return the SWFA (Status, Working unit Failed) error message.

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

Category

Equipment

Security

Maintenance

Related Commands

ALW-SWDX-EQPT

ALW-SWTOPROTN-EQPT

ALW-SWTOWKG-EQPT

DLT-EQPT

ED-EQPT

ENT-EQPT

EX-SW-<STM_MSSPR>

INH-SWDX-EQPT

INH-SWTOWKG-EQPT

REPT ALM EQPT

REPT EVT EQPT

REPT SW

RTRV-ALM-EQPT

RTRV-ALMTH-EQPT

RTRV-COND-EQPT

RTRV-EQPT

SET-ALMTH-EQPT

SW-DX-EQPT

SW-TOPROTN-EQPT

SW-TOWKG-EQPT


Input Format

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

Input Example

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

Input Parameters

Table 14-7 INH-SWTOPROTN-EQPT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.10  EQPT" section on page 25-15. This AID can either be the working unit for which switching to protection is inhibited (lock on) or the protection unit for which carrying traffic is to be inhibited (lockout)

DIRN

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

Parameter type is DIRECTION—transmit and receive directions

BTH

Both transmit and receive directions


14.8  INH-SWTOWKG-EQPT

Inhibit Switch to Working Equipment

Usage Guidelines

This command inhibits automatic or manual switching of an equipment unit back to the working unit. Use the ALW-SWTOWKG-EQPT command to release the inhibit.

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 lock-out with this command, the traffic will be switched from the unit specified by the AID, unless the protection unit has failed or is missing. When performing a lock-on with this command and the protection unit 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 error conditions below). When traffic is locked on the protection unit or locked out of a working unit with this command, the working unit will not carry traffic, even if the protection unit is pulled from the system.

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

The unit 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 one value of the <DIRN> parameter - BTH. A command with any other value is considered an incorrect use of the command and will return an IDNV (Input, Data Not Valid) error message.

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

This command is not used for SDH (STM) cards. A command on a SDH card will receive an IIAC (Input, Invalid Access Identifier) error message. To use an SDH card switching command, 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 (Status, Not in Valid State) error message will be returned.

If this command is used on a card that is already in the inhibit state, the SAIN (Status, Already Inhibited) error message will be 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 (Status, Protection unit Locked) error message should be received.

Sending the INH-SWTOWKG 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 (Status, Working unit Locked) error message.

Sending the INH-SWTOWKG command to an active working card when the protect card has failed or is missing will return the SPFA (Status, Protection unit Failed) 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 SPAC (Status, Protection unit Active) error message.

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

Category

Equipment

Security

Maintenance

Related Commands

ALW-SWDX-EQPT

ALW-SWTOPROTN-EQPT

ALW-SWTOWKG-EQPT

DLT-EQPT

ED-EQPT

ENT-EQPT

EX-SW-<STM_MSSPR>

INH-SWDX-EQPT

INH-SWTOPROTN-EQPT

REPT ALM EQPT

REPT EVT EQPT

REPT SW

RTRV-ALM-EQPT

RTRV-ALMTH-EQPT

RTRV-COND-EQPT

RTRV-EQPT

SET-ALMTH-EQPT

SW-DX-EQPT

SW-TOPROTN-EQPT

SW-TOWKG-EQPT


Input Format

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

Input Example

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

Input Parameters

Table 14-8 INH-SWTOWKG-EQPT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.10  EQPT" section on page 25-15. This AID can either be the working unit for which switching to protection is inhibited (lock on) or the protection unit for which carrying traffic is to be inhibited (lockout)

DIRN

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

Parameter type is DIRECTION—transmit and receive directions

BTH

Both transmit and receive directions


14.9  INH-USER-SECU

Inhibit User Security

Usage Guidelines

This command disables (without deleting) a user account, so the user is denied access to the NE. The user is disabled until reenabled via the ALW-USER-SECU command.


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



Note The user is disabled until enabled through the corresponding ALW command.


Category

Security

Security

Superuser

Related Commands

ACT-USER

ALW-MSG-SECU

ALW-USER-SECU

CANC

CANC-USER

CANC-USER-SECU

CLR-COND-SECU

DLT-USER-SECU

ED-CMD-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

INH-MSG-SECU

REPT ALM SECU

REPT EVT SECU

REPT EVT SESSION

RTRV-CMD-SECU

RTRV-DFLT-SECU

RTRV-USER-SECU

SET-ATTR-SECUDFLT


Input Format

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

Input Example

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

Input Parameters

Table 14-9 INH-USER-SECU Input Parameters 

Parameter and Values
Description

UID

User identifier. String