cisco.nxos.nxos_snmp_host module – (deprecated, removed after 2024-01-01) Manages SNMP host configuration.

Note

This module is part of the cisco.nxos collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_snmp_host.

New in cisco.nxos 1.0.0

DEPRECATED

Removed in:

major release after 2024-01-01

Why:

Updated modules released with more functionality

Alternative:

nxos_snmp_server

Synopsis

  • Manages SNMP host configuration parameters.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

community

string

Community string or v3 username.

snmp_host

string / required

IP address of hostname of target host.

snmp_type

string

type of message to send to host. If this is not specified, trap type is used.

Choices:

  • "trap"

  • "inform"

src_intf

string

Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.

state

string

Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.

Choices:

  • "present" ← (default)

  • "absent"

udp

string

UDP port number (0-65535).

Default: "162"

v3

string

Use this when verion is v3. SNMPv3 Security level.

Choices:

  • "noauth"

  • "auth"

  • "priv"

version

string

SNMP version. If this is not specified, v1 is used.

Choices:

  • "v1"

  • "v2c"

  • "v3"

vrf

string

VRF to use to source traffic to source. If state = absent, the vrf is removed.

vrf_filter

string

Name of VRF to filter. If state = absent, the vrf is removed from the filter.

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL

  • Limited Support for Cisco MDS

  • state=absent removes the host configuration if it is configured.

  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

# ensure snmp host is configured
- cisco.nxos.nxos_snmp_host:
    snmp_host: 192.0.2.3
    community: TESTING
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

commands

list / elements=string

commands sent to the device

Returned: always

Sample: ["snmp-server host 192.0.2.3 filter-vrf another_test_vrf"]

Status

  • This module will be removed in a major release after 2024-01-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Jason Edelman (@jedelman8)

  • Gabriele Gerbino (@GGabriele)