
Worked on Greg's comments. Patch 1: Worked on Greg's comments. Patch 2: Worked on Greg's comment. Patch 3: Worked on Mary's comments. Patch 4: Corrected typos (Mary's comments) https://review.opendev.org/c/starlingx/docs/+/792590 Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com> Change-Id: Ief8a1687243d38e4ec01d6dd809c83ad752edf96
126 lines
2.2 KiB
ReStructuredText
126 lines
2.2 KiB
ReStructuredText
.. Fault Management file, created by
|
|
sphinx-quickstart on Thu Sep 3 15:14:59 2020.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
========
|
|
Contents
|
|
========
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
fault-management-overview
|
|
|
|
*****************
|
|
The global banner
|
|
*****************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
the-global-alarm-banner
|
|
|
|
*********************
|
|
Viewing active alarms
|
|
*********************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
viewing-active-alarms-using-horizon
|
|
viewing-active-alarms-using-the-cli
|
|
viewing-alarm-details-using-the-cli
|
|
|
|
*********************
|
|
Viewing the event log
|
|
*********************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
viewing-the-event-log-using-horizon
|
|
viewing-the-event-log-using-the-cli
|
|
|
|
*****************
|
|
Deleting an alarm
|
|
*****************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
deleting-an-alarm-using-the-cli
|
|
|
|
*****************
|
|
Event suppression
|
|
*****************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
events-suppression-overview
|
|
suppressing-and-unsuppressing-events
|
|
viewing-suppressed-alarms-using-the-cli
|
|
suppressing-an-alarm-using-the-cli
|
|
unsuppressing-an-alarm-using-the-cli
|
|
|
|
*****************************
|
|
CLI commands and paged output
|
|
*****************************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
cli-commands-and-paged-output
|
|
|
|
****
|
|
SNMP
|
|
****
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
snmp-overview
|
|
enabling-snmp-support
|
|
traps
|
|
snmp-active-alarm-table
|
|
snmp-event-table
|
|
setting-snmp-identifying-information
|
|
uninstalling-snmp
|
|
|
|
******************************
|
|
Troubleshooting log collection
|
|
******************************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
troubleshooting-log-collection
|
|
|
|
**************
|
|
Alarm messages
|
|
**************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
100-series-alarm-messages
|
|
200-series-alarm-messages
|
|
300-series-alarm-messages
|
|
400-series-alarm-messages
|
|
500-series-alarm-messages
|
|
750-series-alarm-messages
|
|
800-series-alarm-messages
|
|
900-series-alarm-messages
|
|
|
|
************
|
|
Log messages
|
|
************
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
200-series-maintenance-customer-log-messages
|
|
400-series-customer-log-messages
|
|
900-series-orchestration-customer-log-messages
|