Spec-Zone.ru › Ansible 2.4

vyos_facts - Сбор фактов с удалённых устройств, работающих под управлением VyOS

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

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

Описание

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

Параметры

параметр обязательно по умолчанию варианты комментарии
gather_subset
нет !config
Если указан, этот аргумент ограничит собранные факты заданным подмножеством. Возможные значения этого аргумента включают all, default, config и neighbors. Можно указать список значений, чтобы включить большее подмножество. Значения также могут быть использованы с начальным ! для указания того, что конкретное подмножество не должно собираться.
provider
нет
Объект словаря, содержащий сведения о подключении.
Объект словаря provider
параметр обязательно по умолчанию варианты комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME.
host
да
Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение - путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
нет 10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут будет превышен до завершения операции, модуль вернёт ошибку.
password
нет
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для подключения к удалённому устройству.

Примеры

- name: collect all facts from the device
  vyos_facts:
    gather_subset: all

- name: collect only the config and default facts
  vyos_facts:
    gather_subset: config

- name: collect everything exception the config
  vyos_facts:
    gather_subset: "!config"

Возвращаемые значения

Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:

имя описание возвращается тип пример
ansible_net_commits
Набор доступных исправлений конфигурации
при наличии список
ansible_net_config
Конфигурация работающей системы устройства
при настройке config строка
ansible_net_gather_subset
Список подмножеств, собранных модулем
всегда список
ansible_net_hostname
Настроенное имя хоста системы
всегда строка
ansible_net_model
Строка модели устройства
всегда строка
ansible_net_neighbors
Набор соседей LLDP
при настройке интерфейса список
ansible_net_serialnum
Серийный номер устройства
всегда строка
ansible_net_version
Версия работающего программного обеспечения
всегда строка

Примечания

Примечание

  • Проверено на VYOS 1.1.7

Статус

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

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

Дополнительную информацию о поддержке этого модуля компанией 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/vyos_facts_module.html

Spec-Zone.ru

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