docs/doc/source/fault-mgmt/suppressing-an-alarm-using-the-cli.rst
Stone 037c99f0b7 Fault Management doc
Added Data Networks toctree

Changed case on doc title in top level index - changed doc directory to
fault-mgmt.

Added Distributed Cloud section.

Broke out "OpenStack Fault Management Overview" statement about remote log
collection to conditionally included file.

Incorporated patch 6 review comments. Also implemented rST :abbr:
for first instance of SNMP in each file.

Changed port number and community string in two SNMP walk examples.

Change-Id: I1afd71265e752c4c9a54bf2dc9a173b3e17332a7
Signed-off-by: Stone <ronald.stone@windriver.com>
2020-11-27 14:13:00 -05:00

1.2 KiB

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.