ansible.builtin.nxos_snmp_host (v2.3.3.0-1) — module

Manages SNMP host configuration.

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

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

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

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: 3.3.3.3
    community: TESTING
    state: present
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

Inputs

    
udp:
    default: null
    description:
    - UDP port number (0-65535).
    required: false

vrf:
    default: null
    description:
    - VRF to use to source traffic to source.
    required: false

type:
    choices:
    - trap
    - inform
    default: traps
    description:
    - type of message to send to host.
    required: false

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Manage the state of the resource.
    required: true

version:
    choices:
    - v2c
    - v3
    default: v2c
    description:
    - SNMP version.
    required: false

src_intf:
    default: null
    description:
    - Source interface.
    required: false

community:
    default: null
    description:
    - Community string or v3 username.
    required: false

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

vrf_filter:
    default: null
    description:
    - Name of VRF to filter.
    required: false

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
end_state:
  description: k/v pairs of switchport after module execution
  returned: always
  sample:
    community: TESTING
    snmp_type: trap
    udp: '162'
    v3: noauth
    version: v2c
    vrf: test_vrf
    vrf_filter:
    - test_vrf
    - another_test_vrf
    - one_more_vrf
  type: dict
existing:
  description: k/v pairs of existing snmp host
  returned: always
  sample:
    community: TESTING
    snmp_type: trap
    udp: '162'
    v3: noauth
    version: v2c
    vrf: test_vrf
    vrf_filter:
    - test_vrf
    - another_test_vrf
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    community: TESTING
    snmp_host: 3.3.3.3
    snmp_type: trap
    version: v2c
    vrf_filter: one_more_vrf
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - snmp-server host 3.3.3.3 filter-vrf another_test_vrf
  type: list