ansible.builtin.nxos_snmp_host (v2.7.16) — module

Manages SNMP host configuration.

| "added in version" 2.2 of ansible.builtin"

Authors: Jason Edelman (@jedelman8), Gabriele Gerbino (@GGabriele)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.7.16

Description

Manages SNMP host configuration parameters.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# ensure snmp host is configured
- nxos_snmp_host:
    snmp_host: 192.0.2.3
    community: TESTING
    state: present

Inputs

    
v3:
    choices:
    - noauth
    - auth
    - priv
    description:
    - Use this when verion is v3. SNMPv3 Security level.

udp:
    default: 162
    description:
    - UDP port number (0-65535).

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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - 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.

version:
    choices:
    - v1
    - v2c
    - v3
    description:
    - SNMP version. If this is not specified, v1 is used.

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

community:
    description:
    - Community string or v3 username.

snmp_host:
    description:
    - IP address of hostname of target host.
    required: true

snmp_type:
    choices:
    - trap
    - inform
    description:
    - type of message to send to host. If this is not specified, trap type is used.

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

Outputs

commands:
  description: commands sent to the device
  returned: always
  sample:
  - snmp-server host 192.0.2.3 filter-vrf another_test_vrf
  type: list