Remove SNMPv2c CLIs from user docs

Fault Management guide is updated, this review can be merged.

Patchset changes:
Updated text explaining how to configure SNMP.
Corrected Task ID.
Removed "Depends-On".
This review on hold until Fault Management Guide is updated.

Deleted SNMPv2c commands in system RST file.
Replaced “StarlingX” with |prod| substitution.

Story: 2008132
Task: 41397

Change-Id: I7197604b71e588a2e22bf2da4a4265b2404d26ad
Signed-off-by: MCamp859 <maryx.camp@intel.com>
This commit is contained in:
MCamp859
2021-01-22 12:22:37 -05:00
parent 4e6c19dc27
commit b2aae4c63a

View File

@@ -5,7 +5,7 @@ system
:command:`system` is the command-line interface for System Inventory and :command:`system` is the command-line interface for System Inventory and
Maintenance. Maintenance.
This page documents the :command:`system` command in StarlingX R3.0. This page documents the :command:`system` command in |prod|.
.. contents:: .. contents::
:local: :local:
@@ -56,12 +56,12 @@ Certificate management
********************** **********************
Certificate management commands allow you to install custom certificates Certificate management commands allow you to install custom certificates
for a variety of StarlingX use cases. For example: for a variety of |prod| use cases. For example:
* StarlingX REST APIs and StarlingX Horizon web server. * |prod| REST APIs and |prod| Horizon web server.
* StarlingX local Docker registry. * |prod| local Docker registry.
* OpenStack REST APIs and OpenStack Horizon web server. * OpenStack REST APIs and OpenStack Horizon web server.
* StarlingX trusted certificate authority(s). * |prod| trusted certificate authority(s).
``certificate-install`` ``certificate-install``
Install certificate. Install certificate.
@@ -163,7 +163,7 @@ The following set of commands enable configuration of:
* Basic system attributes * Basic system attributes
* OAM IP address(es), subnet, and gateway * OAM IP address(es), subnet, and gateway
* Remote DNS servers for StarlingX hosts * Remote DNS servers for |prod| hosts
* Time synchronization protocols, for example: NPT and/or PTP * Time synchronization protocols, for example: NPT and/or PTP
``modify`` ``modify``
@@ -201,12 +201,12 @@ System configuration service-parameter
************************************** **************************************
Service parameters provide a generic mechanism to configure a variety of Service parameters provide a generic mechanism to configure a variety of
configurable parameters in StarlingX, including: configurable parameters in |prod|, including:
* HTTP and HTTPS ports * HTTP and HTTPS ports
* StarlingX Horizon authentication lockout parameters * |prod| Horizon authentication lockout parameters
* StarlingX Keystone token expiration * |prod| Keystone token expiration
* StarlingX host management parameters such as heartbeat intervals and host boot * |prod| host management parameters such as heartbeat intervals and host boot
timeouts timeouts
``service-parameter-add`` ``service-parameter-add``
@@ -265,11 +265,11 @@ The :command:`host-sensor*` commands provide the ability to:
Application management Application management
********************** **********************
StarlingX provides an application package management that combines Airship |prod| provides an application package management that combines Airship
Armada and Kubernetes Helm. The StarlingX application management provides: Armada and Kubernetes Helm. The |prod| application management provides:
* System Helm overrides to automatically apply StarlingX applications according * System Helm overrides to automatically apply |prod| applications according
to the particular StarlingX configuration currently running. to the particular |prod| configuration currently running.
* Management for user specified Helm overrides. * Management for user specified Helm overrides.
``helm-chart-attribute-modify`` ``helm-chart-attribute-modify``
@@ -315,40 +315,15 @@ Armada and Kubernetes Helm. The StarlingX application management provides:
SNMP configuration SNMP configuration
****************** ******************
StarlingX supports a simple SNMPv2c agent. All fault management alarms and events |prod| supports SNMPv2c and SNMPv3, but it is now configured using Helm charts.
are sent out as SNMP traps. SNMP GET requests are supported in an active alarm
table and a historical events table.
``snmp-comm-add``
Add a new SNMP community.
``snmp-comm-delete``
Delete an SNMP community.
``snmp-comm-list``
List community strings.
``snmp-comm-show``
Show SNMP community attributes.
``snmp-trapdest-add``
Create a new SNMP trap destination.
``snmp-trapdest-delete``
Delete an SNMP trap destination.
``snmp-trapdest-list``
List SNMP trap destinations.
``snmp-trapdest-show``
Show a SNMP trap destination.
For more information, see |fault-doc|: :ref:`SNMP overview <snmp-overview>`.
****************** ******************
Host configuration Host configuration
****************** ******************
Host commands manage the general configuration of a StarlingX host. This Host commands manage the general configuration of a |prod| host. This
includes assignment of CPU cores to platform or hosted applications, the includes assignment of CPU cores to platform or hosted applications, the
configuration of amount and size for memory huge pages, and the configuration of configuration of amount and size for memory huge pages, and the configuration of
Kubernetes node labels. Kubernetes node labels.
@@ -744,7 +719,7 @@ Link Layer Discovery Protocol (LLDP), which runs on all host interfaces.
Controller services management Controller services management
****************************** ******************************
The following set of commands enables display of services running on the StarlingX The following set of commands enables display of services running on the |prod|
controllers/masters. Optional services can be enabled or disabled using these controllers/masters. Optional services can be enabled or disabled using these
commands. commands.