starlingx/docs
Code Issues Proposed changes

Configure Custom SNMP Engine ID

Browse Source 
Updated exactEngineID 0x[STRING] to exactEngineID 0X[STRING]
Added "exactEngineID" as an additional option
Closes-Bug: 1996925

Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com>
Change-Id: Ide2e8043e402876d13b96b2377570ae12834f634
This commit is contained in:
Juanita-Balaraj 2022-11-17 11:25:48 -05:00
parent 2192558b91
commit 005bb56d38
2 changed files with 49 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
doc/source/fault-mgmt/kubernetes/enabling-snmp-support.rst
View File

@ -29,7 +29,7 @@ In order to enable and configure |SNMP|, complete the following steps.
#. Use the following command to list the system applications and check whether #. Use the following command to list the system applications and check whether
|SNMP| is uploaded or applied. If |SNMP| is already "uploaded", go to Step |SNMP| is uploaded or applied. If |SNMP| is already "uploaded", go to Step
5 to configure and enable |SNMP|. If |SNMP| is already "applied", |SNMP| is 5 to configure and enable |SNMP|. If |SNMP| is already "applied", |SNMP| is
already configured and enabled, see, :ref:`Change Configuration of the SNMP already configured and enabled, see :ref:`Change Configuration of the SNMP
application <change-configuration-of-SNMP>` to make configuration changes. application <change-configuration-of-SNMP>` to make configuration changes.
.. code-block:: none .. code-block:: none
@ -47,8 +47,8 @@ In order to enable and configure |SNMP|, complete the following steps.
#. In order to load the |SNMP| application definitions (FluxCD manifest and #. In order to load the |SNMP| application definitions (FluxCD manifest and
Helm charts), where **[snmp-<Major>.<Minor>-<Build>.tgz]**, for example, Helm charts), where **[snmp-<Major>.<Minor>-<Build>.tgz]**, for example,
**snmp-1.0-2.tgz** is the app filename, with version **1.0-2**, available **snmp-1.0-2.tgz** is the app filename with version **1.0-2** available
at the following path "/usr/local/share/applications/helm", use the at the following path ``/usr/local/share/applications/helm`` use the
following command. following command.
.. code-block:: none .. code-block:: none
@ -92,7 +92,7 @@ In order to enable and configure |SNMP|, complete the following steps.
variable in the |SNMP| Helm chart is a multi-line variable that follows the variable in the |SNMP| Helm chart is a multi-line variable that follows the
syntax of Net-SNMP's ``snmpd.conf`` file for configuring the |SNMP| agent, syntax of Net-SNMP's ``snmpd.conf`` file for configuring the |SNMP| agent,
see `http://www.net-snmp.org/docs/man/snmpd.conf.html see `http://www.net-snmp.org/docs/man/snmpd.conf.html
<http://www.net-snmp.org/docs/man/snmpd.conf.html>`__, for a detailed <http://www.net-snmp.org/docs/man/snmpd.conf.html>`__, for detailed
description of the commands. description of the commands.
.. warning:: .. warning::
@ -127,10 +127,10 @@ In order to enable and configure |SNMP|, complete the following steps.
trapsess -v 3 -u testuser -a MD5 -A testpassword -l authPriv -x DES -X testpassword udp:10.10.10.1:162 trapsess -v 3 -u testuser -a MD5 -A testpassword -l authPriv -x DES -X testpassword udp:10.10.10.1:162
EOF EOF
**\(Optional\)** You can add your own EngineID value, instead of having it **(Optional)** You can add your own EngineID value, instead of having it
auto-created. This keeps the EngineID value the same, even when the |SNMP| auto-created. This keeps the EngineID value the same, even when the |SNMP|
application restarts. The EngineID is required if you are using an |SNMP| application restarts. The EngineID is required if you are using an |SNMP|
trap viewer or |SNMP| monitoring tool. Add the 'engineID [STRING]' value in trap viewer or |SNMP| monitoring tool. Add the `engineID [STRING]` value in
the ``configmap:user_conf`` variable, as shown below. the ``configmap:user_conf`` variable, as shown below.
.. code-block:: none .. code-block:: none
@ -143,6 +143,24 @@ In order to enable and configure |SNMP|, complete the following steps.
... ...
EOF EOF
.. note::
The EngineID value consists of a string of 10-64 characters in
hexadecimal numbers. In case you need to specify the
whole string (i.e., Net-SNMP will not add characters), you can use the
``exactEngineID`` value instead. Add the `exactEngineID 0X[STRING]`
value in the ``configmap:user_conf`` variable, as shown below.
.. code-block:: none
cat <<EOF > user_conf.yaml
configmap:
user_conf: |-
...
exactEngineID 0X[STRING]
...
EOF
#. Update the values of the ``configmap:user_conf`` attribute on the Helm #. Update the values of the ``configmap:user_conf`` attribute on the Helm
chart using the following command. chart using the following command.
@ -309,9 +327,9 @@ update its configuration.
.. rubric:: |proc| .. rubric:: |proc|
#. Create a Helm chart values file (for example, user_conf.yaml) with the #. Create a Helm chart values file (for example, user_conf.yaml) with the
definition of the **configmap:user_conf** attribute defining your SNMP definition of the ``configmap:user_conf`` attribute defining your SNMP
configuration of V2 communities, V2 trap sinks, V3 users and/or V3 trap configuration of V2 communities, V2 trap sinks, V3 users and/or V3 trap
sessions, as shown in the example below. The **configmap:user_conf** sessions, as shown in the example below. The ``configmap:user_conf``
variable in the SNMP Helm chart is a multi-line variable that follows the variable in the SNMP Helm chart is a multi-line variable that follows the
syntax of Net-SNMP's snmpd.conf file for configuring the SNMP agent, see syntax of Net-SNMP's snmpd.conf file for configuring the SNMP agent, see
`http://www.net-snmp.org/docs/man/snmpd.conf.html <http://www.net-snmp.org/docs/man/snmpd.conf.html>`__, `http://www.net-snmp.org/docs/man/snmpd.conf.html <http://www.net-snmp.org/docs/man/snmpd.conf.html>`__,
@ -349,11 +367,11 @@ update its configuration.
trapsess -v 3 -u testuser -a MD5 -A testpassword -l authPriv -x DES -X testpassword udp:10.10.10.1:162 trapsess -v 3 -u testuser -a MD5 -A testpassword -l authPriv -x DES -X testpassword udp:10.10.10.1:162
EOF EOF
**\(Optional\)** You can add your own EngineID value, instead of having it **(Optional)** You can add your own EngineID value, instead of having it
auto-created. This keeps the EngineID value the same, even when the |SNMP| auto-created. This keeps the EngineID value the same, even when the |SNMP|
application restarts. The EngineID is required if you are using an |SNMP| application restarts. The EngineID is required if you are using an |SNMP|
trap viewer or |SNMP| monitoring tool. Add the 'engineID [STRING]' value in trap viewer or |SNMP| monitoring tool. Add the `engineID [STRING]` value in
the`` configmap:user_conf`` variable, as shown below. the ``configmap:user_conf`` variable, as shown below.
.. code-block:: none .. code-block:: none
@ -365,6 +383,24 @@ update its configuration.
... ...
EOF EOF
.. note::
The EngineID value consists of a string of 10-64 characters in
hexadecimal numbers. In this case you need to specify the
whole string (i.e., Net-SNMP will not add characters), you can use the
``exactEngineID`` value instead. Add the `exactEngineID 0X[STRING]`
value in the ``configmap:user_conf`` variable, as shown below.
.. code-block:: none
cat <<EOF > user_conf.yaml
configmap:
user_conf: |-
...
exactEngineID 0X[STRING]
...
EOF
#. Update the values of the ``configmap:user_conf`` attribute on the Helm #. Update the values of the ``configmap:user_conf`` attribute on the Helm
chart using the following command. chart using the following command.

3
doc/source/spelling_wordlist.txt
View File

@ -269,6 +269,7 @@ Emulex
enablement enablement
Enablement Enablement
engineID engineID
exactEngineID
enp enp
EntityInstanceID EntityInstanceID
env env
@ -847,7 +848,7 @@ runtimes
rvmc rvmc
rw rw
rx rx
ｵs <EFBFBD>s
Salesforce Salesforce
sampleimage sampleimage
sbin sbin