community.network.enos_facts – Сбор фактов с удалённых устройств, работающих под Lenovo ENOS
Примечание
Этот плагин является частью коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.enos_facts.
Обзор
- Сбор базового набора фактов устройства с удалённого устройства Lenovo, работающего под ENOS. Этот модуль добавляет все базовые ключи фактов сети с префиксом
ansible_net_<fact>. Модуль facts всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass строка | Указывает пароль, используемый при необходимости для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| gather_subset строка | По умолчанию: "!config" | При указании этот аргумент ограничит собранные факты определённым подмножеством. Возможные значения для этого аргумента включают все, аппаратное обеспечение, конфигурация и интерфейсы. Можно указать список значений, чтобы включить более широкое подмножество. Значения также могут использоваться со вступительным ! для указания того, что определённое подмножество не должно собираться. | |
| provider словарь | Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль, используемый при необходимости для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| 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
community.network.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
- community.network.enos_facts:
gather_subset: all
provider: "{{ cli }}"
# Collect only the config and default facts
- community.network.enos_facts:
gather_subset:
- config
provider: "{{ cli }}"
# Do not collect hardware facts
- community.network.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, работающей на удалённом устройстве |
Авторы
- Anil Kumar Muraleedharan (@amuraleedhar)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/enos_facts_module.html
