community.network.ironware_facts – Сбор фактов с устройств, работающих на Extreme Ironware
Примечание
Этот плагин является частью коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в playbook, укажите: community.network.ironware_facts.
Обзор
- Сбор базового набора фактов устройства с удалённого устройства, работающего на Ironware. Этот модуль добавляет к ключам всех баз фактов сети префикс
ansible_net_<fact>. Модуль facts всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authorize boolean |
| Устаревший Начиная с Ansible 2.7 рекомендуется использовать connection: network_cli и become: yes.Для получения дополнительной информации, пожалуйста, обратитесь к руководству IronWare Platform Options. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| gather_subset string | Значение по умолчанию: ["!config", "!mpls"] | При указании этот аргумент ограничит собранные факты заданным подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию, mpls и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным ! для указания, что определённое подмножество не должно собираться. | |
| provider dictionary | Устаревший Начиная с Ansible 2.7 рекомендуется использовать connection: network_cli и become: yes.Для получения дополнительной информации, пожалуйста, обратитесь к руководству IronWare Platform Options. Объект dict, содержащий данные подключения. | ||
| auth_pass string | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной среды 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 Network
Примеры
- name: Collect all facts from the device
community.network.ironware_facts:
gather_subset: all
- name: Collect only the config and default facts
community.network.ironware_facts:
gather_subset:
- config
- name: Do not collect hardware facts
community.network.ironware_facts:
gather_subset:
- "!hardware"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses list / elements=string | при конфигурации интерфейсов | Все IP-адреса IPv4, настроенные на устройстве |
| ansible_net_all_ipv6_addresses list / elements=string | при конфигурации интерфейсов | Все IP-адреса IPv6, настроенные на устройстве |
| ansible_net_config string | при конфигурации config | Текущая активная конфигурация с устройства |
| ansible_net_filesystems list / elements=string | при конфигурации оборудования | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_subset list / elements=string | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_interfaces dictionary | при конфигурации интерфейсов | Хэш всех интерфейсов, работающих на системе |
| ansible_net_memfree_mb integer | при конфигурации оборудования | Доступная свободная память на удалённом устройстве в Мб |
| ansible_net_memtotal_mb integer | при конфигурации оборудования | Общий объём памяти на удалённом устройстве в Мб |
| ansible_net_model string | всегда | Название модели, возвращённое с устройства |
| ansible_net_mpls_lsps dictionary | При конфигурации LSP | Все MPLS LSP, настроенные на устройстве |
| 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 | всегда | Версия операционной системы, работающая на удалённом устройстве |
Авторы
- 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.10/collections/community/network/ironware_facts_module.html
