arista.eos.eos_facts – Сбор фактов с удаленных устройств, работающих под управлением Arista EOS
Примечание
Этот плагин входит в состав коллекции arista.eos (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Для использования в плейбуке укажите: arista.eos.eos_facts.
Новое в версии 1.0.0: плагина arista.eos
Описание
- Сбор фактов с устройств Arista, работающих под управлением операционной системы EOS. Данный модуль помещает собранные факты в дерево фактов, используя имя соответствующего ресурса в качестве ключа. Модуль фактов всегда собирает базовый набор фактов с устройства и позволяет включать или отключать сбор дополнительных фактов.
Примечание
Данный модуль имеет соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_network_resources список / элементы=строка | При указании этого аргумента сбор фактов будет ограничен заданным подмножеством. Возможные значения этого аргумента включают all и ресурсы, такие как интерфейсы, VLAN и т.д. Можно указать список значений для включения большего подмножества. Значения также можно использовать с начальным !, чтобы указать, что определённое подмножество не должно собираться. Значения также можно использовать с начальным !, чтобы указать, что определённое подмножество не должно собираться. Допустимые подмножества: 'all', 'interfaces', 'l2_interfaces', 'l3_interfaces', 'lacp', 'lacp_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces', 'vlans', 'acls'. | ||
| gather_subset список / элементы=строка | По умолчанию: "!config" | При указании этого аргумента сбор фактов будет ограничен заданным подмножеством. Возможные значения этого аргумента включают all, hardware, config и interfaces. Можно указать список значений для включения большего подмножества. Значения также можно использовать с начальным ! для исключения определенного подмножества. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6, для eAPI рекомендуется использовать connection: httpapi.Этот параметр будет удален в релизе после 2022-06-01. Дополнительную информацию см. в руководстве 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 булево |
| Если 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
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista Arista integration page.
Примеры
- name: Gather all legacy facts
- arista.eos.eos_facts:
gather_subset: all
- name: Gather only the config and default facts
arista.eos.eos_facts:
gather_subset:
- config
- name: Do not gather hardware facts
arista.eos.eos_facts:
gather_subset:
- '!hardware'
- name: Gather legacy and resource facts
arista.eos.eos_facts:
gather_subset: all
gather_network_resources: all
- name: Gather only the interfaces resource facts and no legacy facts
- arista.eos.eos_facts:
gather_subset:
- '!all'
- '!min'
gather_network_resources:
- interfaces
- name: Gather all resource facts and minimal legacy facts
arista.eos.eos_facts:
gather_subset: min
gather_network_resources: all
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список / элементы=строка | при конфигурировании интерфейсов | Все IP-адреса IPv4, настроенные на устройстве |
| ansible_net_all_ipv6_addresses список / элементы=строка | при конфигурировании интерфейсов | Все IP-адреса 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 строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
Авторы
- Peter Sprygada (@privateip)
- Nathaniel Case (@Qalthos)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/arista/eos/eos_facts_module.html
