docs/doc/source/fault-mgmt/configuring-snmp-trap-destinations.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

3.3 KiB

Configure SNMP Trap Destinations

SNMP (Simple Network Management Protocol) trap destinations are hosts configured in to receive unsolicited SNMP notifications.

Destination hosts are specified by IP address, or by host name if it can be properly resolved by . Notifications are sent to the hosts using a designated community string so that they can be validated.

  1. Configure IP address 10.10.10.1 to receive SNMP notifications using the community string commstr1.

    ~(keystone_admin)$ system snmp-trapdest-add -c commstr1 --ip_address 10.10.10.1
    +------------+--------------------------------------+
    | Property   | Value                                |
    +------------+--------------------------------------+
    | uuid       | c7b6774e-7f45-40f5-bcca-3668de2a186f |
    | ip_address | 10.10.10.1                           |
    | community  | commstr1                             |
    | type       | snmpv2c_trap                         |
    | port       | 162                                  |
    | transport  | udp                                  |
    +------------+--------------------------------------+

    The following are attributes associated with the new community string:

    uuid

    The UUID associated with the trap destination object.

    ip_address

    The trap destination IP address.

    community

    The community string value to be associated with the notifications.

    type

    snmpv2c_trap, the only supported message type for SNMP traps.

    port

    The destination UDP port that SNMP notifications are sent to.

    transport

    The transport protocol used to send notifications.

  2. List defined trap destinations.

    ~(keystone_admin)$ system snmp-trapdest-list
    +------------+----------------+------+--------------+-----------+
    | IP Address  | SNMP Community | Port | Type         | Transport |
    +-------------+----------------+------+--------------+-----------+
    | 10.10.10.1  | commstr1       | 162  | snmpv2c_trap | udp       |
    +-------------+----------------+------+--------------+-----------+
  3. Query access details of a specific trap destination.

    ~(keystone_admin)$ system snmp-trapdest-show 10.10.10.1
    +------------+--------------------------------------+
    | Property   | Value                                |
    +------------+--------------------------------------+
    | uuid       | c7b6774e-7f45-40f5-bcca-3668de2a186f |
    | ip_address | 10.10.10.1                           |
    | community  | commstr1                             |
    | type       | snmpv2c_trap                         |
    | port       | 162                                  |
    | transport  | udp                                  |
    +------------+--------------------------------------+
  4. Disable the sending of SNMP notifications to a specific IP address.

    ~(keystone_admin)$ system snmp-trapdest-delete 10.10.10.1
    Deleted ip 10.10.10.1