starlingx/docs
Code Issues Proposed changes
47040fa69b
docs/doc/source/fault-mgmt/kubernetes/suppressing-an-alarm-using-the-cli.rst
Dinesh Neelapu f600bcb1da Fix the alarm option for fm event-suppress command. 
As per the Greg suggestion, the id is added to the --alarm option with underscore.

For more information see, https://review.opendev.org/c/starlingx/docs/+/886760

Change-Id: Ia9dcc41c7986f2755be2fa22a3fcf8213ca02898
Signed-off-by: Dinesh Neelapu <dinesh.neelapu@windriver.com>
2023-06-27 18:31:05 +00:00

1.2 KiB
Raw Blame History

Suppress an Alarm Using the CLI

You can use the CLI to prevent a monitored system parameter from generating unnecessary alarms.

  1. Use the fm event-suppress to suppress a single alarm or multiple alarms by ID.

    ~(keystone_admin)$ fm event-suppress [--nowrap] --alarm_id <alarm_ id>[,<alarm-id>] \
[--nopaging] [--uuid]

    where

    <alarm-id>

    is a comma separated list of alarm UUIDs.

    --nowrap

    disables output wrapping

    --nopaging

    disables paged output

    --uuid

    includes the alarm type UUIDs in the output

    An error message is generated in the case of an invalid <alarm-id>: Alarm ID not found: <alarm-id>.

    If the specified number of Alarm IDs is greater than 1, and at least 1 is wrong, then the suppress command is not applied (none of the specified Alarm IDs are suppressed).

    Note

    Suppressing an Alarm will result in the system NOT notifying the operator of this particular fault.