starlingx/docs
Code Issues Proposed changes
docs/doc/source/fault-mgmt/fault-management-overview.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

2.8 KiB
Raw Blame History

Fault Management Overview

An admin user can view fault management alarms and logs in order to monitor and respond to fault conditions.

See Alarm Messages <100-series-alarm-messages> for the list of alarms and Customer Log Messages <200-series-maintenance-customer-log-messages> for the list of customer logs reported by .

You can access active and historical alarms, and customer logs using the CLI, GUI, REST APIs and SNMP (Simple Network Management Protocol).

To use the CLI, see Viewing Active Alarms Using the CLI <viewing-active-alarms-using-the-cli> and Viewing the Event Log Using the CLI <viewing-the-event-log-using-the-cli>.

Using the GUI, you can obtain fault management information in a number of places.

  • The Fault Management pages, available from Admin > Fault Management in the left-hand pane, provide access to the following:

    • The Global Alarm Banner in the page header of all screens provides the active alarm counts for all alarm severities, see The Global Alarm Banner <the-global-alarm-banner>.

    • Admin > Fault Management > Active Alarms—Alarms that are currently set, and require user action to clear them. For more information about active alarms, see Viewing Active Alarms Using the CLI <viewing-active-alarms-using-the-cli> and Deleting an Alarm Using the CLI <deleting-an-alarm-using-the-cli>.

    • Admin > Fault Management > Events—The event log consolidates historical alarms that have occurred in the past, that is, both set and clear events of active alarms, as well as customer logs.

      For more about the event log, which includes historical alarms and customer logs, see Viewing the Event Log Using Horizon <viewing-the-event-log-using-horizon>.

    • Admin > Fault Management > Events Suppression—Individual events can be put into a suppressed state or an unsuppressed state. A suppressed alarm is excluded from the Active Alarm and Events displays. All alarms are unsuppressed by default. An event can be suppressed or unsuppressed using the Horizon Web interface, the CLI, or REST APIs.

  • The Data Network Topology view provides real-time alarm information for data networks and associated worker hosts and data/pci-passthru/pci-sriov interfaces.

To use SNMP, see SNMP Overview <snmp-overview>.