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

Note

This plugin is part of the cisco.nxos collection (version 2.8.2).

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 version 1.0.0: of cisco.nxos

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.

provider

dictionary

Deprecated

Starting with Ansible 2.5 we recommend using connection: network_cli.

Starting with Ansible 2.6 we recommend using connection: httpapi for NX-API.

This option will be removed in a release after 2022-06-01.

For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html.

A dict object containing connection details.

auth_pass

string

Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.

authorize

boolean

Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.

Choices:

  • no ← (default)

  • yes

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

password

string

Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).

ssh_keyfile

string

Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

timeout

integer

Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).

transport

string

Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.

Choices:

  • cli ← (default)

  • nxapi

use_proxy

boolean

If no, the environment variables http_proxy and https_proxy will be ignored.

Choices:

  • no

  • yes ← (default)

use_ssl

boolean

Configures the transport to use SSL if set to yes only when the transport=nxapi, otherwise this value is ignored.

Choices:

  • no ← (default)

  • yes

username

string

Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

validate_certs

boolean

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.

Choices:

  • no ← (default)

  • yes

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 NXOS Platform Options guide

  • For more information on using Ansible to manage network devices see the Ansible Network Guide

  • For more information on using Ansible to manage Cisco devices see the Cisco integration page.

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)