alarm command

Use the alarm CLI command to display a list of active alarms for a components and to set alarm properties.

Alarm commands

Commands for setting the date and time

Command	Description
alarm	Displays the current raised or cleared alarms
alarm -h	Displays help for the command
alarm -m [<group>[.<sub-group>[.<name>]]]	Masks a single alarm or a group of alarms that share a group or subgroup name (such as system.capture) A masked alarm will not be evaluated by the alarm framework.
alarm -e [<group>[.<sub-group>[.<name>]]]	Exposes masked alarms This command uses the same syntax as the alarm -m command.
alarm -l	Displays the list of possible alarms on the system and their mask status
alarm -s <property=value> <alarm>	Sets the value of an alarm property Alarm properties allow you to configure the thresholds at which the alarms will raise. This feature is not available for all alarms. For the platform alarms with an associated property, see the Long description in the Platform-alarm-reference. Use the alarm -p command to see the property names.
alarm -p	Displays the list of currently supported alarm properties For the platform alarms with an associated property, see the Long description in the Platform-alarm-reference.

The following table describes the characteristics of platform alarms. (The underlined characteristics are displayed when you run the alarm command.)

Platform alarm characteristics

Characteristic	Description
Name	Alarm name
Description	Short description of the alarm
Severity	Impact of the alarm Info - This informational alarm can be ignored if there are no follow up alarms with a higher severity. Attention - Notification of an important system event, such as the system restarting. No action is required. Error - The system encountered a broken function that does not impair the main functionality of the product. Critical - The system is in a condition where a main function is compromised. Take immediate action, possibly with assistance from Customer Support.
Mask	Alarm name, alarm group, or alarm subgroup used to temporarily disable evaluation of the listed alarms when the alarm is raised Masking can prevent the system from raising multiple alarms for the same problem.
Property	Criteria that specify the threshold for raising an alarm (Use alarm -p to show alarm properties.) For the platform alarms with an associated property, see the Long description in the Platform-alarm-reference.
Automatic corrective action	Associations to corrective actions that are triggered when specific conditions are reached

All unmasked alarms are evaluated based on the embedded conditions and system health status.