vyos_facts - Сбор фактов с удалённых устройств, работающих под управлением VyOS
Новое в версии 2.2.
Обзор
- Сбор базового набора фактов устройства с удалённого устройства, работающего под управлением VyOS. Данный модуль добавляет к ключам всех базовых сетевых фактов префикс ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_subset | Значение по умолчанию: "!config" | При указании данного аргумента набор собираемых фактов ограничится заданным подмножеством. Возможные значения для этого аргумента включают all, default, config и neighbors. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным префиксом ! для указания того, что определённое подмножество не должно собираться. | |
| provider | Устаревшее Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Для получения дополнительной информации обратитесь к Руководству по сетям. Объект типа 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. | ||
Примечания
Примечание
- Тестировано с 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 строка | при наличии конфигурации | Конфигурация running-config устройства |
| ansible_net_gather_subset список | всегда | Список подмножеств, собранных модулем |
| ansible_net_hostname строка | всегда | Настроенное имя хоста системы |
| ansible_net_model строка | всегда | Строка модели устройства |
| ansible_net_neighbors список | при наличии интерфейса | Набор соседей LLDP |
| ansible_net_serialnum строка | всегда | Серийный номер устройства |
| ansible_net_version строка | всегда | Версия работающего ПО |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его поддерживает команда Ansible по сетевым решениям. См. Поддержка и техническое обслуживание модулей для получения дополнительной информации.
Список других модулей, поддерживаемых командой Ansible по сетевым решениям, см. здесь.
Поддержка
Дополнительную информацию о поддержке данного модуля компанией 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.6/modules/vyos_facts_module.html
