eos_facts - Сбор фактов с удалённых устройств под управлением Arista EOS
Новое в версии 2.2.
Описание
- Сбор базового набора фактов устройства с удалённого устройства, работающего под управлением EOS. Этот модуль добавляет к ключам всех основных сетевых фактов префикс
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включить или отключить сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass | Значение по умолчанию: none | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр нужен только если используется eAPI. Для получения дополнительной информации обратитесь к руководству Параметры платформы EOS. Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize |
| Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli и become: yes.Этот параметр нужен только если используется eAPI. Для получения дополнительной информации обратитесь к руководству Параметры платформы EOS. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| gather_subset | Значение по умолчанию: !config | При указании этот аргумент ограничит собранные факты заданным подмножеством. Возможные значения для этого аргумента включают все, аппаратные средства, конфигурацию и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также можно использовать с начальным префиксом ! для указания, что конкретное подмножество не должно быть собрано. | |
| provider | Значение по умолчанию: None | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Этот параметр нужен только если используется eAPI. Для получения дополнительной информации обратитесь к руководству Параметры платформы EOS. Объект словаря, содержащий данные соединения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа по CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлен в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| auth_pass | Значение по умолчанию: none | Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | |
| use_ssl |
| Настраивает транспорт на использование SSL, если установлено значение true, только когда transport=eapi. Если аргумент транспорта не eapi, это значение игнорируется. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверяющие сертификаты. Если аргумент транспорта не eapi, это значение игнорируется. | |
| port | Значение по умолчанию: 0 (используется стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к cli или eapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| transport обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Информация об использовании CLI, eAPI и привилегированного режима находится в руководстве Параметры платформы EOS
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами в руководстве Руководство по сетям Ansible
- Дополнительная информация об использовании Ansible для управления устройствами Arista EOS на странице интеграции Arista Arista integration page.
Примеры
# Collect all facts from the device
- eos_facts:
gather_subset: all
# Collect only the config and default facts
- eos_facts:
gather_subset:
- config
# Do not collect hardware facts
- eos_facts:
gather_subset:
- "!hardware"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список | при конфигурировании интерфейсов | Все IPv4-адреса, настроенные на устройстве |
| ansible_net_all_ipv6_addresses список | при конфигурировании интерфейсов | Все IPv6-адреса, настроенные на устройстве |
| ansible_net_config строка | при конфигурировании конфигурации | Текущая активная конфигурация устройства |
| ansible_net_filesystems список | при конфигурировании оборудования | Все имена файловых систем, доступные на устройстве |
| ansible_net_fqdn строка | всегда | Полное доменное имя устройства |
| ansible_net_gather_subset список | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_hostname строка | всегда | Настроенное имя хоста устройства |
| ansible_net_image строка | всегда | Файл образа, используемый устройством |
| ansible_net_interfaces словарь | при конфигурировании интерфейсов | Хеш всех работающих на системе интерфейсов |
| ansible_net_memfree_mb целое число | при конфигурировании оборудования | Доступная свободная память на удаленном устройстве в Мб |
| ansible_net_memtotal_mb целое число | при конфигурировании оборудования | Общая память на удаленном устройстве в Мб |
| ansible_net_model строка | всегда | Имя модели, возвращённое устройством |
| ansible_net_neighbors словарь | при конфигурировании интерфейсов | Список соседей LLDP с удалённого устройства |
| ansible_net_serialnum строка | всегда | Серийный номер удалённого устройства |
| ansible_net_version строка | всегда | Версия операционной системы, работающая на удалённом устройстве |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Поддержка
Для получения дополнительной информации о поддержке этого модуля Red Hat, пожалуйста, обратитесь к этой статье базы знаний
Автор
- Пётр Спрыгада (@privateip)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/eos_facts_module.html
