External Alarm Commands

external-alarms

Syntax

external-alarms

Context

config

Description

This command enables access to the context to configure external alarm attributes on 7705 SAR Ethernet ports (supported on all platforms with Ethernet ports), on the Auxiliary Alarm card, and on the four alarm inputs on the fan module (for the 7705 SAR-8 Shelf V2), alarm connector (for the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-Wx, and 7705 SAR-X), and alarm module (for the 7705 SAR-18).

When configuring custom alarms for an Ethernet port, the port must be configured for 100Base-Tx operation with autonegotiation disabled.

alarm

Syntax

[no] alarm alarm-id

Context

config>external-alarms

Description

This command creates or removes alarms.

The no form of this command disables the alarm attributes for the specified alarm. The alarm must be in the shutdown state before the no form of the command can be performed.

Default

n/a

Parameters

alarm-id

specifies the alarm identifier

Values

1 to 2147483647

chassis-alarming

Syntax

[no] chassis-alarming

Context

config>external-alarms>alarm

Description

This command generates output to chassis alarm relays and LEDs for the specified alarm.

The no form of this command disables the generation of output to chassis alarm relays and LEDs.

Default

chassis-alarming

log

Syntax

[no] log

Context

config>external-alarms>alarm

Description

This command generates raise/clear log events for the specified alarm and controls SNMP trap generation for the raise/clear log events.

The no form of this command disables the generation of raise/clear log events.

Default

log

severity

Syntax

severity {critical | major | minor | warning}

Context

config>external-alarms>alarm

Description

This command configures the severity level for the specified alarm.

The alarm must be disabled before the severity level can be modified.

If the alarm generates raise/clear log events and SNMP traps (enabled by the log command), the severity of the raise log events and SNMP traps is controlled by this configuration. The severity level of the clear log events and SNMP traps is warning.

If the alarm generates output to chassis alarm relays and LEDs (enabled by the chassis-alarming command), the severity level of the alarm output is controlled by this configuration. For chassis relay alarms, only the critical, major and minor levels of severity apply. (There are three LEDs that represent each of them.)

Default

major

Parameters

critical

specifies a critical alarm

major

specifies a major alarm

minor

specifies a minor alarm

warning

specifies a warning (not applicable for chassis relay alarms)

thresholds

Syntax

thresholds

Context

config>external-alarms>alarm

Description

This command enables the context to configure the thresholds for the specified alarm.

Default

n/a

analog

Syntax

analog

Context

config>external-alarms>alarm>thresholds

Description

This command enables the context to configure analog trigger thresholds for the specified alarm.

Default

n/a

level

Syntax

[no] level {lt | gt} millivolts

Context

config>external-alarms>alarm>thresholds>analog

Description

This command configures the analog voltage level thresholds for the specified alarm.

The analog input level threshold cannot be changed from no level when there are no analog inputs configured as triggers. When all analog inputs are removed from the trigger list, the level is automatically changed to no level. The analog input level threshold cannot be changed to no level when there is analog input in the trigger list. When the first analog input is added to the alarm trigger, the level is automatically changed to gt 0.

The no form of this command removes the analog voltage level threshold.

Default

no level

Parameters

lt

specifies a less-than value

gt

specifies a greater-than value

millivolts

specifies the voltage level in millivolts

Values

0 to 75000

trigger

Syntax

trigger [any | all] {alarm-input1 | alarm-input2... | alarm-input8}

no trigger

Context

config>external-alarms>alarm

Description

This command configures the inputs that will trigger the alarm. An alarm can be configured to trigger on any configured input or only when all enabled configured inputs are active. Administratively disabled inputs are ignored for alarm triggering.

Digital inputs are considered normally open. This means that a digital input becomes active only if it closes. Analog inputs have a customizable voltage threshold. This threshold can be configured using the thresholds command. Analog inputs become active when this threshold is crossed.

The no form of this command removes the trigger.

Default

no trigger

Parameters

any

specifies that any configured input trigger will raise an alarm

all

specifies that all configured input triggers that are enabled are required to raise an alarm

alarm-input

identifies the input trigger, up to a maximum of eight

for Ethernet ports, the format is:

     port-slot/mda/port [name]

for the Auxiliary Alarm card, the format is:

     alarm-slot/mda.{d | a}-alarm-num [name]

for the four alarm inputs on the fan module (for the 7705 SAR-8 Shelf V2), alarm connector (for the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-Wx, and 7705 SAR-X), and alarm module (for the 7705 SAR-18), the format is:

     alarm.d-alarm-num [name]

where:

     slot = card slot number for IOM (always 1 on the 7705 SAR)

     mda = Ethernet adapter card or Auxiliary Alarm card slot number (for Ethernet modules or ports on platforms with no card slots, the mda slot number is preconfigured)

     port = port number for Ethernet ports

     d = digital input

     a = analog input

     alarm-num = alarm port number (1 to 24 for digital on the Auxiliary Alarm card, 1 to 4 for digital on the four chassis alarm inputs, 1 or 2 for analog)

     name = optional name assigned to the input

for example: alarm-1/3.d-3

windowOpen3

alarm.d-1

The name option lets users assign a more meaningful name (must be unique) to the alarm input; for example, windowOpen3 might be more meaningful to a user than the identifier alarm-1/3.d-3. Once the name has been configured, it can be used interchangeably with the alarm input identifier; for example, windowOpen3 can be used instead of alarm-1/3.d-3 as an alarm input trigger.

input

Syntax

input alarm-input

Context

config>external-alarms

Description

This command enables the context to configure the external alarm inputs on 7705 SAR Ethernet ports, on the Auxiliary Alarm card, and on the four alarm inputs on the fan module (for the 7705 SAR-8 Shelf V2), alarm connector (for the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-Wx, and 7705 SAR-X), and alarm module (for the 7705 SAR-18).

An alarm input must be associated with an alarm in order for the input to be triggered. See the trigger command. An input can be associated with up to four alarms.

Default

n/a

Parameters

alarm-input

identifies the alarm input

for Ethernet ports, the format is:

     port-slot/mda/port [name]

for the Auxiliary Alarm card, the format is:

     alarm-slot/mda.{d | a}-alarm-num [name]

for the four alarm inputs on the fan module (for the 7705 SAR-8 Shelf V2), alarm connector (for the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-Wx, and 7705 SAR-X), and alarm module (for the 7705 SAR-18), the format is:

     alarm.d-alarm-num [name]

where:

     slot = card slot number for IOM (always 1 on the 7705 SAR)

     mda = Ethernet adapter card or Auxiliary Alarm card slot number (for Ethernet modules or ports on platforms with no card slots, the mda slot number is preconfigured)

     port = port number for Ethernet ports

     d = digital input

     a = analog input

     alarm-num = alarm port number (1 to 24 for digital on the Auxiliary Alarm card, 1 to 4 for digital on the four chassis alarm inputs, 1 or 2 for analog)

     name = optional name assigned to the input

for example:

alarm-1/3.d-3

windowOpen3

alarm.d-1

The name option lets users assign a more meaningful name (must be unique) to the alarm input; for example, windowOpen3 might be more meaningful to a user than the identifier alarm-1/3.d-3. Once the name has been configured, it can be used interchangeably with the alarm input identifier; for example, windowOpen3 can be used instead of alarm-1/3.d-3 as an alarm input trigger for the trigger command, or when performing a show>external-alarms>input or show>external-alarms> output command.

debounce

Syntax

debounce seconds

debounce detect detect-seconds clear clear-seconds

no debounce

Context

config>external-alarms>input

Description

This command configures the debounce time associated with detecting and clearing an alarm input. Debounce time is not supported on alarm inputs on Ethernet ports.

The no debounce form of the command sets both the detect time and clear time to 0.

Default

2 (for both detect time and clear time)

Parameters

seconds

specifies the amount of time that the input must be on or off before it is accepted as changed from on to off (or from off to on)

Values

1 to 60

detect-seconds

specifies the amount of time that the input must be on before it is accepted as on by the system

Values

0 to 60

clear-seconds

specifies the amount of time that the input must be off before it is accepted as off by the system

Values

0 to 60

output

Syntax

output alarm-output

Context

config>external-alarms

Description

This command enables the context to configure the external alarm output relays.

Default

n/a

Parameters

alarm-output

identifies the output relay, in the following format:

    relay-slot/mda.d-relay-num [name]

where:

     slot = slot number of the card in the chassis (always 1 on the 7705 SAR)

     mda = Auxiliary Alarm card slot number

     d = digital output

     relay-num = output relay number (1to 8)

     name = name assigned to the output relay

for example:

relay-1/3.d-5

doorHolder5

The name option lets users assign a more meaningful name (must be unique) to the output relay; for example, doorHolder5 might be more meaningful to a user than the output relay identifier relay-1/3.d-5. Once the name has been configured, it can be used interchangeably with the alarm identifier; for example, doorHolder5 can be used instead of relay-1/3.d-5 when performing a show>external-alarms>output command.

name

Syntax

name name-string

no name

Context

config>external-alarms>input

config>external-alarms>output

Description

This command configures a name for the alarm input or output relay. The configured name must be unique within the external alarms context; therefore, it must not be the same as an alarm-input name configured for the trigger or input command, or an alarm-output name configured for the output command. For example, alarm-1/3.d-1 or doorOpen1 cannot be used as a name for any alarm input, and relay-1/3.d-5 or doorHolder5 cannot be used as a name for any output relay.

The no form of this command does not associate a name with the alarm input or output relay.

Default

no name

Parameters

name-string

specifies a unique name for the alarm input or output relay (maximum of 15 characters)

normally

Syntax

normally {open | closed}

Context

config>external-alarms>input

Description

This command configures the normal condition of the digital input – either normally open or normally closed. You cannot configure the normal condition on alarm inputs on Ethernet ports.

Default

normally open