starlingx/docs
Code Issues Proposed changes
docs/doc/source/fault-mgmt/cli-commands-for-dc-alarms-management.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

4.1 KiB
Raw Blame History

CLI Commands for Distributed Cloud Alarm Management

You can use the CLI to review alarm summaries for the Distributed Cloud.

  • To show the status of all subclouds, as well as a summary count of alarms and warnings for each one, use the alarm summary command.

    For example:

    ~(keystone_admin)$ dcmanager alarm summary
+------------+-----------------+--------------+--------------+----------+----------+
| NAME       | CRITICAL_ALARMS | MAJOR_ALARMS | MINOR_ALARMS | WARNINGS | STATUS   |
+------------+-----------------+--------------+--------------+----------+----------+
| subcloud-5 |               0 |            2 |            0 |        0 | degraded |
| subcloud-1 |               0 |            0 |            0 |        0 | OK       |
+------------+-----------------+--------------+--------------+----------+----------+

    System Controller alarms and warnings are not included.

    The status is one of the following:

    OK

    There are no alarms or warnings, or only warnings.

    degraded

    There are minor or major alarms.

    critical

    There are critical alarms.

  • To show the count of alarms and warnings for the System Controller, use the fm alarm-summary command.

    For example:

    ~(keystone_admin)$ fm alarm-summary
+-----------------+--------------+--------------+----------+
| Critical Alarms | Major Alarms | Minor Alarms | Warnings |
+-----------------+--------------+--------------+----------+
| 0               | 0            | 0            | 0        |
+-----------------+--------------+--------------+----------+

    The following command is equivalent to the fm alarm-summary, providing a count of alarms and warnings for the System Controller:

    fm --os-region-name RegionOne alarm-summary

  • To show the alarm and warning count for a specific subcloud only, add the --os-region-name parameter and supply the region name:

    For example:

    ~(keystone_admin)$ fm --os-region-name subcloud2 --os-auth-url http://192.168.121.2:5000/v3 alarm-summary
+-----------------+--------------+--------------+----------+
| Critical Alarms | Major Alarms | Minor Alarms | Warnings |
+-----------------+--------------+--------------+----------+
| 0               | 0            | 0            | 0        |
+-----------------+--------------+--------------+----------+

  • To list the alarms for a subcloud:

    ~(keystone_admin)$ fm --os-region-name subcloud2 --os-auth-url http://192.168.121.2:5000/v3 alarm-list
+----------+--------------------------------------------+-------------------+----------+-------------------+
| Alarm ID | Reason Text                                | Entity ID         | Severity | Time Stamp        |
+----------+--------------------------------------------+-------------------+----------+-------------------+
| 250.001  | controller-0 Configuration is out-of-date. | host=controller-0 | major    | 2018-02-06T21:37: |
|          |                                            |                   |          | 32.650217         |
|          |                                            |                   |          |                   |
| 250.001  | controller-1 Configuration is out-of-date. | host=controller-1 | major    | 2018-02-06T21:37: |
|          |                                            |                   |          | 29.121674         |
|          |                                            |                   |          |                   |
+----------+--------------------------------------------+-------------------+----------+-------------------+