eos_facts - Сбор фактов с удалённых устройств, работающих на Arista EOS
Новая версия с 2.2.
Описание
- Сбор базового набора фактов устройства с удалённого устройства, работающего на eos. Этот модуль добавляет к ключам всех базовых сетевых фактов префикс
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass | Устаревший Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации, см. руководство EOS Platform Options. Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот параметр игнорируется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize bool |
| Устаревший Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации, см. руководство EOS Platform Options. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| gather_subset | По умолчанию: "!config" | При указании этого параметра, сбор фактов будет ограничен определённым подмножеством. Возможные значения для этого параметра: все, оборудование, конфигурация и интерфейсы. Можно указать список значений, чтобы включить более широкое подмножество. Значения также можно использовать с начальным !, чтобы указать, что определённое подмножество не должно собираться. | |
| provider | Устаревший Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации, см. руководство EOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать стандартный порт)" | Указывает порт, используемый при построении соединения с удалённым устройством. Это значение относится к cli или eapi. Значение порта будет по умолчанию соответствовать общепринятому порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации соединения с удалённым устройством. Это общий параметр, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации соединения с удалённым устройством. Этот параметр используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот параметр игнорируется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| transport обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| use_ssl bool |
| Настраивает транспорт transport на использование SSL, если значение равно true только в случае transport=eapi. Если значение параметра transport не равно eapi, это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самоподписанных сертификатов. Если значение параметра transport не равно eapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Сведения о работе с CLI, eAPI и привилегированным режимом см. в руководстве EOS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible Network Guide
- Дополнительную информацию об использовании 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 строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
Состояние
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимый.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его поддерживает Команда по поддержке сетевых решений Ansible. Более подробная информация в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживает Команда по поддержке сетевых решений Ansible, см. в здесь.
Поддержка
Дополнительную информацию о поддержке данного модуля Red Hat см. в этой статье базы знаний
Автор
- Peter Sprygada (@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.6/modules/eos_facts_module.html
