eos_facts – Сбор фактов с удаленных устройств, работающих под управлением Arista EOS
Обзор
- Сбор фактов с устройств Arista, работающих под управлением операционной системы EOS. Этот модуль помещает собранные факты в дерево фактов, ключом которого является соответствующее имя ресурса. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass строка | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Дополнительную информацию см. в руководстве EOS Platform Options. Указывает пароль, используемый при необходимости для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не выполняет никаких действий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Дополнительную информацию см. в руководстве EOS Platform Options. Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| gather_network_resources список добавлено в 2.9 | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, VLAN и т.д. Можно указать список значений для включения более крупного подмножества. Значения также могут использоваться с начальным !, чтобы указать, что определенное подмножество не должно собираться. Значения также могут использоваться с начальным !, чтобы указать, что определенное подмножество не должно собираться. Допустимые подмножества — 'all', 'interfaces', 'l2_interfaces', 'l3_interfaces', 'lacp', 'lacp_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces', 'vlans'. | ||
| gather_subset список | Значение по умолчанию: "!config" | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают all, hardware, config и interfaces. Можно указать список значений для включения более крупного подмножества. Значения также могут использоваться с начальным ! для указания, что определенное подмножество не должно собираться. | |
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Дополнительную информацию см. в руководстве EOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass строка | Указывает пароль, используемый при необходимости для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не выполняет никаких действий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: 0 | Указывает порт, используемый при построении соединения с удаленным устройством. Это значение относится к транспорту cli или eapi. Значение порта по умолчанию соответствует обычному порту транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернет ошибку. | ||
| transport строка / обязательно |
| Настраивает транспортное соединение, используемое при подключении к удаленному устройству. | |
| use_proxy логическое добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое |
| Настраивает transport на использование SSL, если установлено значение yes только при transport=eapi. Если аргумент transport не равен eapi, это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, управляемых лично, использующих самозаверенные сертификаты. Если аргумент transport не равен eapi, это значение игнорируется. | |
Примечания
Примечание
- Сведения об использовании CLI, eAPI и привилегированного режима см. в руководстве EOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista.
Примеры
- name: Gather all legacy facts
- eos_facts:
gather_subset: all
- name: Gather only the config and default facts
eos_facts:
gather_subset:
- config
- name: Do not gather hardware facts
eos_facts:
gather_subset:
- "!hardware"
- name: Gather legacy and resource facts
eos_facts:
gather_subset: all
gather_network_resources: all
- name: Gather only the interfaces resource facts and no legacy facts
- eos_facts:
gather_subset:
- '!all'
- '!min'
gather_network_resources:
- interfaces
- name: Gather all resource facts and minimal legacy facts
eos_facts:
gather_subset: min
gather_network_resources: all
Значения возврата
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список | при конфигурировании интерфейсов | Все IPv4-адреса, настроенные на устройстве |
| ansible_net_all_ipv6_addresses список | при конфигурировании интерфейсов | Все IPv6-адреса, настроенные на устройстве |
| ansible_net_api строка | всегда | Имя протокола передачи данных |
| ansible_net_config строка | при конфигурировании конфигурации | Текущая активная конфигурация устройства |
| ansible_net_filesystems список | при конфигурировании оборудования | Все имена файловых систем, доступные на устройстве |
| ansible_net_fqdn строка | всегда | Полное доменное имя устройства |
| ansible_net_gather_network_resources список | при конфигурировании ресурса | Список фактов для подмножеств сетевых ресурсов, собранных с устройства |
| 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_python_version строка | всегда | Версия Python, используемая контроллером Ansible |
| ansible_net_serialnum строка | всегда | Серийный номер удаленного устройства |
| ansible_net_version строка | всегда | Версия операционной системы, работающая на удаленном устройстве |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается командой Ansible по работе с сетями. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Peter Sprygada (@privateip)
- Nathaniel Case (@Qalthos)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 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/eos_facts_module.html
