docs/doc/source/fault-mgmt/kubernetes/suppressing-an-alarm-using-the-cli.rst
Dinesh Neelapu ba2857ff69 Fix the alarm option for fm event-suppress command. (r8, ds8)
Removed the id from --alarm option.

Change-Id: I1a5694d2e87aa00d5f43fe0967c90beb33ddc533
Signed-off-by: Dinesh Neelapu <dinesh.neelapu@windriver.com>
2023-06-26 14:20:22 +00:00

48 lines
1.2 KiB
ReStructuredText

.. ani1552680633324
.. _suppressing-an-alarm-using-the-cli:
===============================
Suppress an Alarm Using the CLI
===============================
You can use the CLI to prevent a monitored system parameter from generating
unnecessary alarms.
.. rubric:: |proc|
#. Use the :command:`fm event-suppress` to suppress a single alarm or
multiple alarms by ID.
.. code-block:: none
~(keystone_admin)$ fm event-suppress [--nowrap] --alarm <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.