Spec-Zone.ru › Ansible 2.4

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

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

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

Описание

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

Параметры

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

Примеры

# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
---
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: cisco
    password: cisco
    transport: cli

---
# Collect all facts from the device
- ios_facts:
    gather_subset: all
    provider: "{{ cli }}"

# Collect only the config and default facts
- ios_facts:
    gather_subset:
      - config
    provider: "{{ cli }}"

# Do not collect hardware facts
- ios_facts:
    gather_subset:
      - "!hardware"
    provider: "{{ cli }}"

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

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

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

Примечания

Примечание

  • Проверено на IOS 15.6

Статус

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

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

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

Spec-Zone.ru

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