Spec-Zone.ru › Ansible 2.4

iosxr_facts - Сбор фактов с удалённых устройств, работающих под IOS XR

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

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

Описание

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

Параметры

параметр обязательно по умолчанию варианты комментарии
gather_subset
нет !config
При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают all, hardware, config и interfaces. Можно указать список значений для включения более широкого подмножества. Значения также могут быть использованы с начальным !, чтобы указать, что определённое подмножество не должно собираться.
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
Указывает порт для подключения к удалённому устройству.

Примеры

# Collect all facts from the device
- iosxr_facts:
    gather_subset: all

# Collect only the config and default facts
- iosxr_facts:
    gather_subset:
      - config

# Do not collect hardware facts
- iosxr_facts:
    gather_subset:
      - "!hardware"

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

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

имя описание возвращается тип пример
ansible_net_all_ipv4_addresses
Все IPv4-адреса, настроенные на устройстве
при настройке interfaces список
ansible_net_all_ipv6_addresses
Все IPv6-адреса, настроенные на устройстве
при настройке interfaces список
ansible_net_config
Текущая активная конфигурация с устройства
при настройке config строка
ansible_net_filesystems
Все имена файловых систем, доступные на устройстве
при настройке hardware список
ansible_net_gather_subset
Список собранных подмножеств фактов с устройства
всегда список
ansible_net_hostname
Настроенное имя хоста устройства
всегда строка
ansible_net_image
Файл образа, используемый устройством
всегда строка
ansible_net_interfaces
Хэш всех интерфейсов, работающих на системе
при настройке interfaces словарь
ansible_net_memfree_mb
Доступная свободная память на удалённом устройстве в Мб
при настройке hardware целое число
ansible_net_memtotal_mb
Общий объём памяти на удалённом устройстве в Мб
при настройке hardware целое число
ansible_net_neighbors
Список соседей LLDP с удалённого устройства
при настройке interfaces словарь
ansible_net_version
Версия операционной системы, работающей на удалённом устройстве
всегда строка

Статус

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

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

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

Spec-Zone.ru

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