ironware_facts - Сбор фактов с устройств, на которых запущена Extreme Ironware
Новая версия с 2.5.
Обзор
- Сбор базового набора фактов устройства с удалённого устройства, на котором запущена Ironware. Этот модуль добавляет все базовые ключи фактов сети с префиксом
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включить или выключить сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authorize bool |
| Указывает модулю на вход в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| gather_subset | Значение по умолчанию: ["!config", "!mpls"] | При указании данного аргумента сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию, mpls и интерфейсы. Можно указать список значений для включения более широкого подмножества. Значения также могут быть использованы с начальным ! для указания, что определённое подмножество не должно собираться. | |
| provider | Объект словаря, содержащий данные подключения. | ||
| host | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: 22 | Указывает порт для использования при построении подключения к удалённому устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Указывает модулю на вход в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| timeout | Значение по умолчанию: 10 | Указывает время ожидания бездействия подключения в секундах. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | |
Примечания
Примечание
- Проверено на Ironware 5.8e
Примеры
# Collect all facts from the device
- ironware_facts:
gather_subset: all
# Collect only the config and default facts
- ironware_facts:
gather_subset:
- config
# Do not collect hardware facts
- ironware_facts:
gather_subset:
- "!hardware"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список | при конфигурации интерфейсов | Все настроенные IPv4-адреса устройства |
| ansible_net_all_ipv6_addresses список | при конфигурации интерфейсов | Все настроенные IPv6-адреса устройства |
| ansible_net_config строка | при конфигурации config | Текущая активная конфигурация устройства |
| ansible_net_filesystems список | при конфигурации оборудования | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_subset список | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_interfaces словарь | при конфигурации интерфейсов | Хэш всех интерфейсов, работающих в системе |
| ansible_net_memfree_mb целое число | при конфигурации оборудования | Доступная свободная память на удалённом устройстве в Мб |
| ansible_net_memtotal_mb целое число | при конфигурации оборудования | Общий объём памяти на удалённом устройстве в Мб |
| ansible_net_model строка | всегда | Имя модели, возвращённое устройством |
| ansible_net_mpls_lsps словарь | При конфигурации LSP | Все настроенные LSP MPLS на устройстве |
| ansible_net_mpls_vll словарь | При конфигурации MPLS VLL | Все настроенные экземпляры VLL на устройстве |
| ansible_net_mpls_vll_local словарь | При конфигурации MPLS VLL-LOCAL | Все настроенные экземпляры VLL-LOCAL на устройстве |
| ansible_net_mpls_vpls словарь | При конфигурации MPLS VPLS | Все настроенные экземпляры VPLS на устройстве |
| ansible_net_neighbors словарь | при конфигурации интерфейсов | Список соседей LLDP с удалённого устройства |
| ansible_net_serialnum строка | всегда | Серийный номер удалённого устройства |
| ansible_net_version строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Поддержка и обслуживание модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Paul Baker (@paulquack)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/ironware_facts_module.html
