ironware_facts – Сбор фактов с устройств, на которых запущена Extreme Ironware
Новое в версии 2.5.
Описание
- Сбор базового набора фактов устройства с удаленного устройства, на котором запущена Ironware. Этот модуль добавляет ко всем базовым ключам фактов сети префикс
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или выключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authorize boolean |
| Устарело Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство IronWare Platform Options. Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| gather_subset - | По умолчанию: ["!config", "!mpls"] | При указании этого аргумента сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают all, hardware, config, mpls и interfaces. Можно указать список значений для включения более широкого подмножества. Значения также могут использоваться с начальным !, чтобы указать, что определенное подмножество не должно собираться. | |
| provider - | Устарело Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes.Для получения дополнительной информации см. руководство IronWare Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass - | Указывает пароль, который необходимо использовать, если требуется войти в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host - | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port - | По умолчанию: 22 | Указывает порт, используемый при построении подключения к удаленному устройству. | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение - путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | По умолчанию: 10 | Указывает тайм-аут бездействия подключения в секундах. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | |
| username - | Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
Примечания
Примечание
- Проверено на Ironware 5.8e
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Примеры
# 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 список | при настройке hardware | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_subset список | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_interfaces словарь | при настройке интерфейсов | Хэш всех интерфейсов, работающих в системе |
| ansible_net_memfree_mb целое число | при настройке hardware | Доступная свободная память на удаленном устройстве в Мб |
| ansible_net_memtotal_mb целое число | при настройке hardware | Общая память на удаленном устройстве в Мб |
| ansible_net_model строка | всегда | Имя модели, возвращенное с устройства |
| ansible_net_mpls_lsps словарь | При настройке LSP | Все настроенные MPLS LSP на устройстве |
| 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. [community]
Авторы
- 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.7/modules/ironware_facts_module.html
