You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

snmp_facts - Retrieve facts for a device using SNMP.¶

New in version 1.9.

Synopsis
Requirements (on host that executes module)
Options
Examples
- Status

Synopsis ¶

Retrieve facts for a device using SNMP, the facts will be inserted to the ansible_facts key.

Requirements (on host that executes module)¶

pysnmp

Options ¶

parameter	required	default	choices	comments
authkey	no			Authentication key, required if version is v3
community	no			The SNMP community string, required if version is v2/v2c
host	yes			Set to target snmp server (normally {{inventory_hostname}})
integrity	no		md5 sha	Hashing algorithm, required if version is v3
level	no		authPriv authNoPriv	Authentication level, required if version is v3
privacy	no		des aes	Encryption algorithm, required if level is authPriv
privkey	no			Encryption key, required if version is authPriv
username	no			Username for SNMPv3, required if version is v3
version	yes		v2 v2c v3	SNMP Version to use, v2/v2c or v3

Examples ¶

# Gather facts with SNMP version 2
- snmp_facts:
    host: '{{ inventory_hostname }}'
    version: v2c
    community: public
  delegate_to: local

# Gather facts using SNMP version 3
- snmp_facts:
    host: '{{ inventory_hostname }}'
    version: v3
    level: authPriv
    integrity: sha
    privacy: aes
    username: snmp-user
    authkey: abc12345
    privkey: def6789
  delegate_to: localhost

Status ¶

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.