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 string		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса 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 список	при конфигурации interfaces	Все IPv4-адреса, настроенные на устройстве
ansible_net_all_ipv6_addresses список	при конфигурации interfaces	Все IPv6-адреса, настроенные на устройстве
ansible_net_config строка	при конфигурации config	Текущая активная конфигурация с устройства
ansible_net_gather_subset список	всегда	Список подмножеств фактов, собранных с устройства
ansible_net_hostname строка	всегда	Настроенное имя хоста устройства
ansible_net_image строка	всегда	Указывает активный образ для устройства
ansible_net_interfaces dictionary	при конфигурации interfaces	Хэш всех интерфейсов, работающих на системе. Предоставляет информацию об описании, MAC-адресе, MTU, скорости, дуплексе и статусе работы
ansible_net_memfree_mb целое число	при конфигурации hardware	Доступная свободная память на удалённом устройстве в МБ
ansible_net_model строка	всегда	Наименование модели, возвращённое устройством Lenovo ENOS
ansible_net_neighbors dictionary	при конфигурации interfaces	Список соседей LLDP с удалённого устройства
ansible_net_serialnum строка	всегда	Серийный номер устройства Lenovo ENOS
ansible_net_version строка	всегда	Версия операционной системы ENOS, работающая на удалённом устройстве

Статус

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

Авторы

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.8/modules/enos_facts_module.html