Spec-Zone.ru › Ansible 2.4

eos_facts - Сбор фактов с удаленных устройств, работающих на Arista EOS

Новое в версии 2.2.

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Описание

  • Сбор базового набора фактов устройства с удаленного устройства, работающего под управлением eos. Этот модуль добавляет все базовые ключи фактов сети с ansible_net_<fact>. Модуль facts всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.

Параметры

параметр обязательно значение по умолчанию значения комментарии
auth_pass
нет нет
Указывает пароль для использования в случае необходимости входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не имеет действия. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
gather_subset
нет !config
При указании этот аргумент ограничит собранные факты заданным подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут использоваться со вступительным !, чтобы указать, что определенное подмножество не должно собираться.
provider
нет
Объект dict, содержащий данные подключения.
Объект словаря provider
параметр обязательно значение по умолчанию значения комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
нет
Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
auth_pass
нет нет
Указывает пароль для использования в случае необходимости входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не имеет действия. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
host
да
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
timeout
нет 10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль вернет ошибку.
use_ssl
нет True
  • да
  • нет
Настраивает transport для использования SSL, если установлено значение true только когда transport=eapi. Если аргумент transport не равен eapi, это значение игнорируется.
password
нет
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
validate_certs
нет
  • да
  • нет
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Если аргумент transport не равен eapi, это значение игнорируется.
port
нет 0 (использовать стандартный порт)
Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится к cli или eapi. Значение порта по умолчанию устанавливается на соответствующий общий порт транспорта, если он не указан в задаче (cli=22, http=80, https=443).
transport
да cli
  • eapi
  • cli
Настраивает транспортное соединение для подключения к удаленному устройству.

Примеры

# 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
Версия операционной системы, работающей на удаленном устройстве
всегда строка

Примечания

Примечание

  • Тестируется на EOS 4.15

Статус

Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.

Информация о техническом обслуживании

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этом knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.

Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Информацию о сообществе и внесении вклада, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/eos_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API