ansible.snmp.v3_usm (2.0.0) — connection

Install collection

Install with ansible-galaxy collection install ansible.snmp:==2.0.0

Add to requirements.yml

  collections:
    - name: ansible.snmp
      version: 2.0.0

Description

Make SNMP v3 user-based security model (USM) connections to a device.

Requirements

• python bindings for netsnmp

Inputs

    
host:
    default: inventory_hostname
    description:
    - Specifies the remote device FQDN or IP address for the SNMP connection to.
    type: str
    vars:
    - name: ansible_host

port:
    default: 161
    description:
    - Specifies the port on the remote device that listens for SNMP connections.
    env:
    - name: ANSIBLE_REMOTE_PORT
    ini:
    - key: remote_port
      section: defaults
    type: int
    vars:
    - name: ansible_port

context:
    default: ''
    description:
    - Specify the SNMP v3 context name.
    env:
    - name: ANSIBLE_SNMP_CONTEXT
    ini:
    - key: context
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_context

retries:
    default: 3
    description:
    - Specify the number retries before failure
    env:
    - name: ANSIBLE_SNMP_RETRIES
    ini:
    - key: retries
      section: ansible.snmp
    type: int
    vars:
    - name: ansible_snmp_RETRIES

timeout:
    default: 500000
    description:
    - Specify the number of micro-seconds before a retry
    env:
    - name: ANSIBLE_SNMP_TIMEOUT
    ini:
    - key: timeout
      section: ansible.snmp
    type: int
    vars:
    - name: ansible_snmp_timeout

version:
    choices:
    - 3
    default: 3
    description:
    - Specify the SNMP version
    type: int

sec_name:
    default: initial
    description:
    - Specify the SNMP v3 security name.
    env:
    - name: ANSIBLE_SNMP_SEC_NAME
    ini:
    - key: sec_name
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_sec_name

auth_pass:
    description:
    - Specify the SNMP v3 authentication passphrase.
    env:
    - name: ANSIBLE_SNMP_AUTH_PASS
    ini:
    - key: context
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_auth_pass

priv_pass:
    description:
    - Specify the SNMP v3 privacy passphrase.
    env:
    - name: ANSIBLE_SNMP_PRIV_PASS
    ini:
    - key: priv_proto
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_priv_pass

sec_level:
    choices:
    - noAuthNoPriv
    - authNoPriv
    - authPriv
    default: noAuthNoPriv
    description:
    - Specify the SNMP v3 secutiry level.
    env:
    - name: ANSIBLE_SNMP_SEC_LEVEL
    ini:
    - key: sec_level
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_sec_level

auth_proto:
    choices:
    - MD5
    - SHA1
    - SHA-192
    - SHA-256
    - SHA-284
    - SHA-512
    default: MD5
    description:
    - Specify the SNMP v3 authentication protocol.
    env:
    - name: ANSIBLE_SNMP_AUTH_PROTO
    ini:
    - key: context
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_auth_proto

priv_proto:
    choices:
    - DES
    - AES128
    - AES256
    default: DES
    description:
    - Specify the SNMP v3 privacy protocol.
    env:
    - name: ANSIBLE_SNMP_PRIV_PROTO
    ini:
    - key: priv_proto
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_priv_proto

sec_engine_id:
    description:
    - Specify the SNMP v3 security engine ID.
    - Will be probed if not supplied.
    env:
    - name: ANSIBLE_SNMP_SEC_ENGINE_ID
    ini:
    - key: sec_name
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_sec_engine_id

context_engine_id:
    description:
    - Specify the SNMP v3 context engine ID.
    - Will be probed if not supplied.
    env:
    - name: ANSIBLE_SNMP_CONTEXT_ENGINE_ID
    ini:
    - key: sec_level
      section: ansible.snmp
    type: str
    vars:
    - name: ansible_snmp_context_engine_id