nxos_snmp_host - Manages SNMP host configuration.

New in version 2.2.

Synopsis

  • Manages SNMP host configuration parameters.

Parameters

Parameter Choices/Defaults Comments
community
Community string or v3 username.
provider
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
host
required
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.
port Default:
"0 (use common port)"
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).
username
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.
password
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.
authorize
bool

(added in 2.5.3)
    Choices:
  • no
  • yes
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.
auth_pass
(added in 2.5.3)
Default:
"none"
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.
timeout
(added in 2.3)
Default:
10
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).
ssh_keyfile
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.
transport
required
Default:
"cli"
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.
use_ssl
bool
    Choices:
  • no
  • yes
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
validate_certs
bool
    Choices:
  • no
  • yes
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.
use_proxy
bool

(added in 2.5)
    Choices:
  • no
  • yes
If no, the environment variables http_proxy and https_proxy will be ignored.
snmp_host
required
IP address of hostname of target host.
snmp_type
    Choices:
  • trap
  • inform
type of message to send to host. If this is not specified, trap type is used.
src_intf
Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.
state
    Choices:
  • present
  • absent
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.
udp Default:
162
UDP port number (0-65535).
v3
    Choices:
  • noauth
  • auth
  • priv
Use this when verion is v3. SNMPv3 Security level.
version
    Choices:
  • v1
  • v2c
  • v3
SNMP version. If this is not specified, v1 is used.
vrf
VRF to use to source traffic to source. If state = absent, the vrf is removed.
vrf_filter
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
  • 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
- nxos_snmp_host:
    snmp_host: 3.3.3.3
    community: TESTING
    state: present

Return Values

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

Key Returned Description
commands
list
always
commands sent to the device

Sample:
['snmp-server host 3.3.3.3 filter-vrf another_test_vrf']


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as network which means that it is maintained by the Ansible Network Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Network Team, see here.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/nxos_snmp_host_module.html