arista.eos.eos_facts – Сбор фактов с удалённых устройств, работающих под управлением Arista EOS
Примечание
Этот плагин является частью коллекции arista.eos (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Чтобы использовать его в книге задач, укажите: arista.eos.eos_facts.
Новое в версии 1.0.0: плагина arista.eos
Краткое описание
- Сбор фактов с устройств Arista, работающих под управлением операционной системы EOS. Этот модуль размещает собранные факты в дереве фактов, индексируемом именем соответствующего ресурса. Модуль фактов всегда собирает базовый набор фактов с устройства и может включить или отключить сбор дополнительных фактов.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_network_resources список / элементы=строка | При указании этого аргумента факты будут ограничены определённым подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, VLAN и т.д. Можно указать список значений, чтобы включить большее подмножество. Значения также могут использоваться с начальным ! для указания, что определённое подмножество не должно собираться. Значения также могут использоваться с начальным ! для указания, что определённое подмножество не должно собираться. Допустимые подмножества: «all», «interfaces», «l2_interfaces», «l3_interfaces», «lacp», «lacp_interfaces», «lag_interfaces», «lldp_global», «lldp_interfaces», «vlans», «acls». | ||
| gather_subset список / элементы=строка | По умолчанию: «!config» | При указании этого аргумента факты будут ограничены определённым подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию и интерфейсы. Можно указать список значений, чтобы включить большее подмножество. Значения также могут использоваться с начальным ! для указания, что определённое подмножество не должно собираться. | |
| 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 Network Guide
- Дополнительная информация по использованию Ansible для управления устройствами Arista EOS доступна на странице интеграции Arista.
Примеры
- 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 список / элементы=строка | при конфигурации интерфейсов | Все 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 строка | всегда | Версия операционной системы, работающая на удалённом устройстве |
Авторы
- Пётр Спрыгада (@privateip)
- Натаниэль Кейс (@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.10/collections/arista/eos/eos_facts_module.html
