Spec-Zone.ru › Ansible 2.9

enos_facts – Сбор фактов о удалённых устройствах, работающих под Lenovo ENOS

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

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

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

Параметры

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

Примечания

Примечание

  • Проверено на ENOS 8.4.1

Примеры

Tasks: The following are examples of using the module enos_facts.
---
- name: Test Enos Facts
  enos_facts:
    provider={{ cli }}

  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: 22
      username: admin
      password: admin
      transport: cli
      timeout: 30
      authorize: True
      auth_pass:

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

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

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

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

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

Ключ Возвращаемое значение Описание
ansible_net_all_ipv4_addresses
список
при настройке интерфейсов
Все настроенные IPv4-адреса устройства

ansible_net_all_ipv6_addresses
список
при настройке интерфейсов
Все настроенные IPv6-адреса устройства

ansible_net_config
строка
при настройке конфигурации
Текущая активная конфигурация устройства

ansible_net_gather_subset
список
всегда
Список подмножеств фактов, собранных с устройства

ansible_net_hostname
строка
всегда
Настроенное имя хоста устройства

ansible_net_image
строка
всегда
Указывает активную версию образа устройства

ansible_net_interfaces
dictionary
при настройке интерфейсов
Хэш всех интерфейсов, работающих на системе. Это предоставляет информацию о описании, MAC-адресе, MTU, скорости, дуплексе и состоянии работы

ansible_net_memfree_mb
целое число
при настройке аппаратных средств
Доступная свободная память на удалённом устройстве в МБ

ansible_net_model
строка
всегда
Имя модели, возвращённое устройством Lenovo ENOS

ansible_net_neighbors
dictionary
при настройке интерфейсов
Список соседей LLDP с удалённого устройства

ansible_net_serialnum
строка
всегда
Серийный номер устройства Lenovo ENOS

ansible_net_version
строка
всегда
Версия операционной системы ENOS, работающей на удалённом устройстве



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Anil Kumar Muraleedharan (@amuraleedhar)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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

Spec-Zone.ru

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