vyos_facts – Получение фактов о устройствах vyos
Обзор
- Сбор фактов с сетевых устройств, работающих под управлением операционной системы vyos. Этот модуль помещает собранные факты в дерево фактов, ключом которого является соответствующее имя ресурса. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_network_resources - добавлен в 2.9 | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным ! для указания того, что конкретное подмножество не должно собираться. Допустимые подмножества: 'all', 'interfaces', 'l3_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces'. | ||
| gather_subset - | Значение по умолчанию: "!config" | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все, стандартное, конфигурацию и соседей. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным ! для указания того, что конкретное подмножество не должно собираться. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации, пожалуйста, обратитесь к Руководству по сети. Объект словаря, содержащий данные соединения. | ||
| 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. | ||
Примечания
Примечание
- Тестировалось на VyOS 1.1.8 (helium).
- Этот модуль работает с подключением
network_cli. См. параметры платформы VyOS OS. - Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible
Примеры
# Gather all facts
- vyos_facts:
gather_subset: all
gather_network_resources: all
# collect only the config and default facts
- vyos_facts:
gather_subset: config
# collect everything exception the config
- vyos_facts:
gather_subset: "!config"
# Collect only the interfaces facts
- vyos_facts:
gather_subset:
- '!all'
- '!min'
gather_network_resources:
- interfaces
# Do not collect interfaces facts
- vyos_facts:
gather_network_resources:
- "!interfaces"
# Collect interfaces and minimal default facts
- vyos_facts:
gather_subset: min
gather_network_resources: interfaces
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| ansible_net_api строка | всегда | Имя протокола передачи |
| ansible_net_commits список | при наличии | Набор доступных версий конфигурации |
| ansible_net_config строка | при наличии конфигурации | Текущая конфигурация устройства |
| ansible_net_gather_network_resources список | всегда | Список собранных с устройства подмножеств сетевых ресурсов |
| ansible_net_gather_subset список | всегда | Список подмножеств, собранных модулем |
| ansible_net_hostname строка | всегда | Настроенное имя хоста системы |
| ansible_net_model строка | всегда | Строка модели устройства |
| ansible_net_neighbors список | при наличии интерфейса | Набор соседей LLDP |
| ansible_net_python_version строка | всегда | Версия Python, используемая контроллером Ansible |
| ansible_net_serialnum строка | всегда | Серийный номер устройства |
| ansible_net_version строка | всегда | Версия работающего ПО |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Network. [сетевой]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Nathaniel Case (@qalthos)
- Nilashish Chakraborty (@Nilashishc)
- Rohit Thakur (@rohitthakur2590)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vyos_facts_module.html
