ironware_facts – Сбор фактов с устройств, на которых работает Extreme Ironware
Новая версия 2.5.
Обзор
- Сбор базового набора фактов устройства с удаленного устройства, на котором работает Ironware. Этот модуль добавляет ко всем ключевым фактам сетевой базы данных префикс
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authorize boolean |
| Устаревший Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство по параметрам платформы IronWare по ссылке IronWare Platform Options guide. Инструктирует модуль перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| gather_subset - | Значение по умолчанию: ["!config", "!mpls"] | Если задано, этот аргумент ограничивает собираемые факты определенным подмножеством. Возможные значения для этого аргумента включают все, hardware, config, mpls и interfaces. Можно указать список значений, чтобы включить более широкое подмножество. Значения также могут использоваться с начальным !, чтобы указать, что определенное подмножество не должно собираться. | |
| provider dictionary | Устаревший Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство по параметрам платформы IronWare по ссылке IronWare Platform Options guide. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass string | Указывает пароль для использования, если требуется переход в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Инструктирует модуль перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host string | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port integer | Значение по умолчанию: 22 | Указывает порт для подключения к удаленному устройству. | |
| ssh_keyfile path | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Значение по умолчанию: 10 | Устанавливает время ожидания простоя подключения в секундах. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | |
| username string | Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
Примечания
Примечание
- Тестировалось на Ironware 5.8e
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
Примеры
# 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 list | при настройке интерфейсов | Все настроенные IPv4-адреса на устройстве |
| ansible_net_all_ipv6_addresses list | при настройке интерфейсов | Все настроенные IPv6-адреса на устройстве |
| ansible_net_config string | при настройке конфигурации | Текущая активная конфигурация с устройства |
| ansible_net_filesystems list | при настройке hardware | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_subset list | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_interfaces dictionary | при настройке интерфейсов | Хэш всех интерфейсов, работающих в системе |
| ansible_net_memfree_mb integer | при настройке hardware | Доступная свободная память на удаленном устройстве в Мб |
| ansible_net_memtotal_mb integer | при настройке hardware | Общий объем памяти на удаленном устройстве в Мб |
| ansible_net_model string | всегда | Имя модели, возвращенное устройством |
| ansible_net_mpls_lsps dictionary | При настройке LSP | Все настроенные LSP MPLS на устройстве |
| ansible_net_mpls_vll dictionary | При настройке MPLS VLL | Все настроенные экземпляры VLL на устройстве |
| ansible_net_mpls_vll_local dictionary | При настройке MPLS VLL-LOCAL | Все настроенные экземпляры VLL-LOCAL на устройстве |
| ansible_net_mpls_vpls dictionary | При настройке MPLS VPLS | Все настроенные экземпляры VPLS на устройстве |
| ansible_net_neighbors dictionary | при настройке интерфейсов | Список соседей LLDP с удаленного устройства |
| ansible_net_serialnum string | всегда | Серийный номер удаленного устройства |
| ansible_net_version string | всегда | Версия операционной системы, работающая на удаленном устройстве |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Пол Бейкер (@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.9/modules/ironware_facts_module.html
