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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.snmp_facts.

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

Краткое описание

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

Требования

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

pysnmp (либо pysnmp < 6.2.4, либо pysnmp >= 7.1)

Параметры

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

Атрибуты

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

Примечания

Примечание

Рекомендуется обновить pysnmp до версии 7.1 или новее. Поддержка pysnmp 6.2 будет прекращена.

Примеры

- 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

Возвращаемые факты

Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляют их. На них можно ссылаться по имени, как и на любые другие факты узла. Для их использования не требуется регистрировать их.

Ключ	Описание
ansible_all_ipv4_addresses list / элементы=string	Список всех адресов IPv4. Возвращается: success Пример: `["127.0.0.1", "172.17.0.1"]`
ansible_interfaces dictionary	Словарь сетевых интерфейсов с метаданными для каждого из них. Возвращается: success Пример: `{"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 string	Текстовое описание контактного лица для этого управляемого узла и сведения о том, как с ним связаться. Возвращается: success Пример: `"Me <me@example.org>"`
ansible_sysdescr string	Текстовое описание сущности. Возвращается: success Пример: `"Linux ubuntu-user 4.4.0-93-generic #116-Ubuntu SMP Fri Aug 11 21:17:51 UTC 2017 x86_64"`
ansible_syslocation string	Физическое местоположение этого узла (например, `telephone closet, 3rd floor`). Возвращается: success Пример: `"Sitting on the Dock of the Bay"`
ansible_sysname string	Имя этого управляемого узла, назначенное администратором. Возвращается: success Пример: `"ubuntu-user"`
ansible_sysobjectid string	Идентификатор подсистемы управления сетью, содержащейся в сущности, определённый производителем. Возвращается: success Пример: `"1.3.6.1.4.1.8072.3.2.10"`
ansible_sysuptime integer	Время (в сотых долях секунды) с момента последней повторной инициализации подсистемы управления сетью. Возвращается: success Пример: `42388`

Авторы

Patrick Ogenstad (@ogenstad)
Laurenz Altenmueller (@lalten)

Ссылки на коллекцию

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