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" | При указании этого аргумента сбор фактов ограничивается заданным подмножеством. Возможные значения для этого аргумента включают все, аппаратные, конфигурация и интерфейсы. Можно указать список значений для включения более крупного подмножества. Значения также могут использоваться с начальным ! для указания того, что определённое подмножество не должно собираться. | |
| provider - | Объект типа dict, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль для использования, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port - | По умолчанию: 22 | Указывает порт для подключения к удалённому устройству. | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение - путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | По умолчанию: 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 словарь | при настройке интерфейсов | Хэш всех интерфейсов, работающих на системе. Это даёт информацию о описании, MAC-адресе, MTU, скорости, дуплексе и состоянии работы |
| ansible_net_memfree_mb целое число | при настройке аппаратного обеспечения | Доступная свободная память на удалённом устройстве в МБ |
| ansible_net_model строка | всегда | Название модели, возвращённое устройством Lenovo ENOS |
| ansible_net_neighbors словарь | при настройке интерфейсов | Список соседей 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.7/modules/enos_facts_module.html
