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

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

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

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

Описание

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

Требования

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

pysnmp

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлен в community.general 3.3.0 Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения статуса без изменения целевого объекта.
diff_mode	Поддержка: нет Это действие не изменяет состояние.	Вернёт детали изменений (или, возможно, необходимых изменений в `check_mode`) в режиме сравнения.
facts	Поддержка: полная	Действие возвращает словарь `ansible_facts`, который будет обновлять существующие факты хоста.

Примеры

- 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

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
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 строка	Физическое расположение узла (например, `telephone closet, 3rd floor`). Возвращается: успешно Пример: `"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/snmp_facts_module.html