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