vyos_facts - Сбор фактов о удалённых устройствах, работающих на VyOS
Новое в версии 2.2.
Описание
- Сбор базового набора фактов устройства с удалённого устройства, работающего под управлением VyOS. Этот модуль добавляет ко всем ключам фактов сети префикс ansible_net_<факт>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_subset | Значение по умолчанию: !config |
При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают all, default, config и neighbors. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным ! для указания того, что определённое подмножество не должно собираться. |
|
| provider | Значение по умолчанию: None |
Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации, см. Руководство по сети. Объект словаря, содержащий данные подключения. |
|
| username | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. |
||
| host обязательно |
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. |
||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение - путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. |
||
| timeout | Значение по умолчанию: 10 |
Устанавливает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль вернёт ошибку. |
|
| password | Значение по умолчанию: None |
Устанавливает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. |
|
| port | Значение по умолчанию: 22 |
Указывает порт для подключения к удалённому устройству. |
|
Примечания
Примечание
- Проверено на VYOS 1.1.7
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
Примеры
- name: collect all facts from the device
vyos_facts:
gather_subset: all
- name: collect only the config and default facts
vyos_facts:
gather_subset: config
- name: collect everything exception the config
vyos_facts:
gather_subset: "!config"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_commits список |
при наличии | Набор доступных ревизий конфигурации |
| ansible_net_config строка |
при конфигурировании config | Текущая конфигурация устройства |
| ansible_net_gather_subset список |
всегда | Список подмножеств, собранных модулем |
| ansible_net_hostname строка |
всегда | Настроенное имя системы |
| ansible_net_model строка |
всегда | Строка модели устройства |
| ansible_net_neighbors список |
при конфигурировании интерфейса | Набор соседей LLDP |
| ansible_net_serialnum строка |
всегда | Серийный номер устройства |
| ansible_net_version строка |
всегда | Версия работающего ПО |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимым.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний
Автор
- Nathaniel Case (@qalthos)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ для его улучшения.
© 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/vyos_facts_module.html
