System alarm commands

alarm

Syntax

alarm rmon-alarm-id variable-oid oid-string interval seconds [sample-type] [startup-alarm alarm-type] [rising-event rmon-event-id rising-threshold threshold] [falling-event rmon-event-id falling threshold threshold] [owner owner-string]

no alarm rmon-alarm-id

Context

config>system>thresholds>rmon

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures an entry in the RMON-MIB alarm Table. The alarm command controls the monitoring and triggering of threshold crossing events. In order for notification or logging of a threshold crossing event to occur there must be at least one associated rmon>event configured.

The agent periodically takes statistical sample values from the MIB variable specified for monitoring and compares them to thresholds that have been configured with the alarm command. This command configures the MIB variable to be monitored, the polling period (interval), sampling type (absolute or delta value), and rising and falling threshold parameters. If a sample has crossed a threshold value, the associated event is generated.

The no form of this command removes an rmon-alarm-id from the configuration.

Parameters

rmon-alarm-id

Specifies the rmon-alarm-id as a numerical identifier for the alarm being configured. The number of alarms that can be created is limited to 1200.

Values

1 to 65535

variable-oid oid-string

Specifies the SNMP object identifier of the particular variable to be sampled. Only SNMP variables that resolve to an ASN.1 primitive type of integer (integer, Integer32, Counter32, Counter64, Gauge, or TimeTicks) may be sampled. The oid-string may be expressed using either the dotted string notation or as object name plus dotted instance identifier. For example, ‟1.3.6.1.2.1.2.2.1.10.184582144” or ‟ifInOctets.184582144”.

The oid-string has a maximum length of 255 characters

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds. In the case of delta type sampling, the interval should be set short enough that the sampled variable is very unlikely to increase or decrease by more than 2147483647 - 1 during a single sampling interval. To avoid creating unnecessary processing overhead, the interval value should not be set too low.

Values

1 to 2147483647

sample-type

Specifies the method of sampling the selected variable and calculating the value to be compared against the thresholds.

Values

absolute — Specifies that the value of the selected variable is compared directly with the thresholds at the end of the sampling interval.

delta — Specifies that the value of the selected variable at the last sample is subtracted from the current value, and the difference compared with the thresholds.

Default

absolute

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created.

If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, a single rising threshold crossing event is generated.

If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

rising-event rmon-event-id

Specifies the action to be taken when a rising threshold crossing event occurs.

If there is no corresponding event configured for the specified rmon-event-id, no association exists and no action is taken.

If the rising-event rmon-event-id has a value of zero (0), no associated event exists.

If a rising event rmon-event is configured, the CLI requires a rising-threshold to also be configured.

Values

0 to 65535

Default

0

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-event rmon-event-id

Specifies the action to be taken when a falling threshold crossing event occurs. If there is no corresponding event configured for the specified rmon-event-id, no association exists and no action is taken. If the falling-event has a value of zero (0), no associated event exists.

If a falling event is configured, the CLI requires a falling-threshold to also be configured.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value rises above this threshold and reaches greater than or equal the rising-threshold threshold value.

Values

-2147483648 to 2147483647

Default

0

owner owner

Specifies the creator of this alarm. It defaults to ‟TiMOS CLI”. This parameter is defined primarily to allow entries that have been created in the RMON-MIB alarmTable by remote SNMP managers to be saved and reloaded in a CLI configuration file. The owner is not typically configured by CLI users and can be a maximum of 80 characters.

Default

TiMOS CLI

kb-memory-use-alarm

Syntax

kb-memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no kb-memory-use-warn

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures memory use, in kilobytes, alarm thresholds.

The no form of this command removes the parameters from the configuration.

Parameters

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value rises above this threshold and reaches greater than or equal the rising-threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value, and the startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

kb-memory-use-warn

Syntax

kb-memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no kb-memory-use-warn

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures memory usage, in kilobytes, for warning thresholds

Parameters

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value rises above this threshold and reaches greater than or equal the rising-threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

cflash-cap-alarm

Syntax

cflash-cap-alarm cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type][startup-alarm alarm-type]

no cflash-cap-alarm cflash-id

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command enables capacity monitoring of the compact flash specified in this command. The severity level is alarm. Both a rising and falling threshold can be specified.

The no form of this command removes the configured compact flash threshold alarm.

Parameters

cflash-id

Specifies the name of the cflash device to be monitored.

Values

cf1:, cf2:, uf1:, cf1-A:

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal to the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value raises above this threshold and reaches greater than or equal the rising-threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period, in seconds, over which the data is sampled and compared with the rising and falling thresholds.

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs.

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds CLI command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both a entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created.

If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated.

If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

cflash-cap-warn

Syntax

cflash-cap-warn cflash-id rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no cflash-cap-warn cflash-id

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command enables capacity monitoring of the compact flash specified in this command. The severity level is warning. Both a rising and falling threshold can be specified. The no form of this command removes the configured compact flash threshold warning.

Parameters

cflash-id

Specifies the name of the cflash device to be monitored.

Values

cf1:, cf2:, uf1:, cf1-A:

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value raises above this threshold and reaches greater than or equal the rising-threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs.

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds CLI command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both an entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

event

Syntax

event rmon-event-id [event-type] [description description-string] [owner owner-string]

no event rmon-event-id

Context

config>system>thresholds>rmon

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures an entry in the RMON-MIB event table. The event command controls the generation and notification of threshold crossing events configured with the alarm command. When a threshold crossing event is triggered, the rmon>event configuration optionally specifies if an entry in the RMON-MIB log table should be created to record the occurrence of the event. It may also specify that an SNMP notification (trap) should be generated for the event. The RMON-MIB defines two notifications for threshold crossing events: Rising Alarm and Falling Alarm.

Creating an event entry in the RMON-MIB log table does not create a corresponding entry in the TiMOS event logs. However, when the event type is set to trap, the generation of a Rising Alarm or Falling Alarm notification creates an entry in the TiMOS event logs and that is distributed to whatever TiMOS log destinations are configured: CONSOLE, session, memory, file, syslog, or SNMP trap destination.

The TiMOS logger message includes a rising or falling threshold crossing event indicator, the sample type (absolute or delta), the sampled value, the threshold value, the RMON-alarm-id, the associated RMON-event-id and the sampled SNMP object identifier.

The no form of this command removes an rmon-event-id from the configuration.

Parameters

rmon-event-type

Specifies the type of notification action to be taken when this event occurs.

Values

log — An entry is made in the RMON-MIB log table for each event occurrence.

This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both a entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

description description-string

Specifies a user configurable string that can be used to identify the purpose of this event. This is an optional parameter and can be up to 80 characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

owner owner

Specifies the creator of this alarm. It defaults to ‟TiMOS CLI”. This parameter is defined primarily to allow entries that have been created in the RMON-MIB alarmTable by remote SNMP managers to be saved and reloaded in a CLI configuration file. The owner is not typically configured by CLI users and can be a maximum of 80 characters.

Default

TiMOS CLI

memory-use-alarm

Syntax

memory-use-alarm rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no memory-use-alarm

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

The memory thresholds are based on monitoring the TIMETRA-SYSTEM-MIB sgiMemoryUsed object. This object contains the amount of memory currently used by the system. The severity level is Alarm.

The no form of this command removes the configured memory threshold warning.

Parameters

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either.

After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value raises above this threshold and reaches greater than or equal the rising-threshold threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create an OS logger entry. The RMON-MIB log table entries can be viewed using the CLI command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both a entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

memory-use-warn

Syntax

memory-use-warn rising-threshold threshold [falling-threshold threshold] interval seconds [rmon-event-type] [startup-alarm alarm-type]

no memory-use-warn

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

The memory thresholds are based on monitoring MemoryUsed object. This object contains the amount of memory currently used by the system. The severity level is Alarm.

The absolute sample type method is used.

The no form of this command removes the configured compact flash threshold warning.

Parameters

rising-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval was less than this threshold. A single threshold crossing event is also generated if the first sample taken is greater than or equal to this threshold and the associated startup-alarm is equal to rising or either. After a rising threshold crossing event is generated, another such event is not generated until the sampled value falls below this threshold and reaches less than or equal the falling-threshold value.

Values

-2147483648 to 2147483647

Default

0

falling-threshold threshold

Specifies a threshold for the sampled statistic. A single threshold crossing event is generated when the current sampled value is less than or equal to this threshold, and the value at the last sampling interval was greater than this threshold. A single threshold crossing event is also generated if the first sample taken is less than or equal to this threshold and the associated startup-alarm is equal to falling or either.

After a falling threshold crossing event is generated, another such event is not generated until the sampled value raises above this threshold and reaches greater than or equal the rising-threshold threshold value.

Values

-2147483648 to 2147483647

Default

0

interval seconds

Specifies the polling period over which the data is sampled and compared with the rising and falling thresholds.

Values

1 to 2147483647

rmon-event-type

Specifies the type of notification action to be taken when this event occurs.

Values

log — An entry is made in the RMON-MIB log table for each event occurrence. This does not create a TiMOS logger entry. The RMON-MIB log table entries can be viewed using the show system thresholds command.

trap — A TiMOS logger event is generated. The TiMOS logger utility then distributes the notification of this event to its configured log destinations which may be CONSOLE, Telnet session, memory log, cflash file, syslog, or SNMP trap destinations logs.

both — Both a entry in the RMON-MIB logTable and a TiMOS logger event are generated.

none — No action is taken.

Default

both

startup-alarm alarm-type

Specifies the alarm that may be sent when this alarm is first created. If the first sample is greater than or equal to the rising threshold value and startup-alarm is equal to rising or either, then a single rising threshold crossing event is generated. If the first sample is less than or equal to the falling threshold value and startup-alarm is equal to falling or either, a single falling threshold crossing event is generated.

Values

rising, falling, either

Default

either

rmon

Syntax

rmon

Context

config>system>thresholds

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure generic RMON alarms and events.

Generic RMON alarms can be created on any SNMP object-ID that is valid for RMON monitoring (for example, an integer-based datatype).

The configuration of an event controls the generation and notification of threshold crossing events configured with the alarm command.

thresholds

Syntax

thresholds

Context

config>system

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure monitoring thresholds.