cnos_facts – Сбор фактов с удалённых устройств, работающих на Lenovo CNOS
Новая версия с 2.3.
Описание
- Сбор базового набора фактов устройства с удалённого устройства Lenovo, работающего на CNOS. Этот модуль добавляет все базовые ключи фактов сети с префиксом
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включить или отключить сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass
-
добавлен в 2.6
|
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize имеет значение false, то этот аргумент не действует. Если значение не указано в задаче, используется значение переменной окружения
ANSIBLE_NET_AUTH_PASS. |
||
| authorize
boolean
добавлен в 2.6
|
|
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения
ANSIBLE_NET_AUTHORIZE. |
|
| gather_subset
-
добавлен в 2.6
|
Значение по умолчанию: "!config" |
Если указан, этот аргумент ограничит собираемые факты заданным подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным
!, чтобы указать, что определённое подмножество не должно собираться. |
|
| provider
-
добавлен в 2.6
|
Объект словаря, содержащий данные подключения. |
||
| 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. |
||
Примечания
Примечание
- Тестировалось с CNOS 10.8.1
Примеры
Tasks: The following are examples of using the module cnos_facts.
---
- name: Test cnos Facts
cnos_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
- cnos_facts:
gather_subset: all
provider: "{{ cli }}"
# Collect only the config and default facts
- cnos_facts:
gather_subset:
- config
provider: "{{ cli }}"
# Do not collect hardware facts
- cnos_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 CNOS |
| ansible_net_neighbors
словарь
|
при конфигурировании интерфейсов |
Список соседей LLDP с удалённого устройства |
| ansible_net_serialnum
строка
|
всегда |
Серийный номер устройства Lenovo CNOS |
| ansible_net_version
строка
|
всегда |
Версия операционной системы CNOS, работающей на удалённом устройстве |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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/cnos_facts_module.html