community.general.snmp_facts – Получение фактов устройства с помощью SNMP

Примечание

Этот плагин входит в состав коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.snmp_facts.

Описание
Требования
Параметры
Примеры
Возвращаемые значения

Описание

Получение фактов устройства с помощью SNMP, факты будут добавлены в ключ ansible_facts.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

pysnmp

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
authkey строка		Ключ аутентификации. Требуемая версия — `v3`.
community строка		Строка сообщества SNMP, необходима, если версия равна `v2` или `v2c`.
host строка / обязательно		Устанавливает целевой сервер SNMP (обычно `{{ inventory_hostname }}`).
integrity строка	Варианты: md5 sha	Алгоритм хеширования. Требуется, если версия равна `v3`.
level строка	Варианты: authNoPriv authPriv	Уровень аутентификации. Требуется, если версия равна `v3`.
privacy строка	Варианты: aes des	Алгоритм шифрования. Требуется, если уровень равен `authPriv`.
privkey строка		Ключ шифрования. Требуется, если уровень равен `authPriv`.
username строка		Имя пользователя для SNMPv3. Требуется, если версия равна `v3`.
version строка / обязательно	Варианты: v2 v2c v3	Используемая версия SNMP, `v2`, `v2c` или `v3`.

Примеры

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

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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
ansible_all_ipv4_addresses список / элементы=строка	успех	Список всех адресов IPv4. Пример: ['127.0.0.1', '172.17.0.1']
ansible_interfaces словарь	успех	Словарь каждого сетевого интерфейса и его метаданных. Пример: {'1': {'adminstatus': 'up', 'description': '', 'ifindex': '1', 'ipv4': [{'address': '127.0.0.1', 'netmask': '255.0.0.0'}], 'mac': '', 'mtu': '65536', 'name': 'lo', 'operstatus': 'up', 'speed': '65536'}, '2': {'adminstatus': 'up', 'description': '', 'ifindex': '2', 'ipv4': [{'address': '192.168.213.128', 'netmask': '255.255.255.0'}], 'mac': '000a305a52a1', 'mtu': '1500', 'name': 'Intel Corporation 82545EM Gigabit Ethernet Controller (Copper)', 'operstatus': 'up', 'speed': '1500'}}
ansible_syscontact строка	успех	Текстовая идентификация контактного лица для этого управляемого узла вместе с информацией о том, как с ним связаться. Пример: Me <me@example.org>
ansible_sysdescr строка	успех	Текстовое описание сущности. Пример: Linux ubuntu-user 4.4.0-93-generic
ansible_syslocation строка	успех	Физическое расположение этого узла (например, «телефонный шкаф, 3-й этаж»). Пример: Sitting on the Dock of the Bay
ansible_sysname строка	успех	Административно назначенное имя этого управляемого узла. Пример: ubuntu-user
ansible_sysobjectid строка	успех	Авторитетная идентификация поставщиком подсистемы управления сетью, содержащейся в сущности. Пример: 1.3.6.1.4.1.8072.3.2.10
ansible_sysuptime целое число	успех	Время (в сотых долях секунды) с момента последней перезагрузки сетевого управления системой. Пример: 42388

Авторы

Patrick Ogenstad (@ogenstad)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/snmp_facts_module.html