enos_facts - Сбор фактов с удалённых устройств, работающих под управлением Lenovo ENOS
Новая версия 2.5.
Обзор
- Сбор базового набора фактов устройства с удалённого устройства Lenovo, работающего под управлением ENOS. Этот модуль добавляет к всем базовым ключам фактов сети префикс
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включить или отключить сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass | Значение по умолчанию: нет | Указывает пароль, используемый при необходимости для перехода в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize |
| Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| gather_subset | Значение по умолчанию: !config | Если указан, этот аргумент ограничивает собираемые факты заданным подмножеством. Возможные значения для этого аргумента включают все, hardware, config и interfaces. Можно указать список значений для включения более широкого подмножества. Значения также могут использоваться с начальным ! для указания того, что определённое подмножество не должно собираться. | |
| provider | Значение по умолчанию: Нет | Объект типа dict, содержащий сведения о подключении. | |
| username | Устанавливает имя пользователя для проверки подлинности подключения к удалённому устройству. Это значение используется для проверки подлинности сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| authorize |
| Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для проверки подлинности подключения к удалённому устройству. Это значение — путь к ключу, используемому для проверки подлинности сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| auth_pass | Значение по умолчанию: нет | Указывает пароль, используемый при необходимости для перехода в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному каналу. Значение host используется в качестве целевого адреса для канала. | ||
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. | |
| password | Значение по умолчанию: Нет | Указывает пароль для проверки подлинности подключения к удалённому устройству. Это значение используется для проверки подлинности сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт для построения подключения к удалённому устройству. | |
Примечания
Примечание
- Проверено на ENOS 8.4.1.68
Примеры
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 словарь | при настройке interfaces | Словарь всех интерфейсов, работающих на системе. Предоставляет информацию о описании, MAC-адресе, MTU, скорости, режиме дуплекса и состоянии |
| ansible_net_memfree_mb целое число | при настройке hardware | Доступная свободная память на удалённом устройстве в МБ |
| ansible_net_model строка | всегда | Имя модели, возвращённое устройством Lenovo ENOS |
| ansible_net_neighbors словарь | при настройке interfaces | Список соседей LLDP с удалённого устройства |
| ansible_net_serialnum строка | всегда | Серийный номер устройства Lenovo ENOS |
| ansible_net_version строка | всегда | Версия операционной системы ENOS, работающей на удалённом устройстве |
Статус
Данный модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/enos_facts_module.html