Deprecated

Removed in None

i

Reason:Updated modules released with more functionality | Alternative:nxos_snmp_server

cisco.nxos.nxos_snmp_host (7.0.0) — module

(deprecated, removed after 2024-01-01) Manages SNMP host configuration.

| "added in version" 1.0.0 of cisco.nxos"

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

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0


Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

Manages SNMP host configuration parameters.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# ensure snmp host is configured
- cisco.nxos.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.
    type: str

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

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

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.
    type: str

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

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

community:
    description:
    - Community string or v3 username.
    type: str

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

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

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

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