junos_facts – Сбор фактов с удалённых устройств, работающих под управлением Juniper Junos
Описание
- Собирает информацию о фактах с удалённого устройства, работающего под управлением операционной системы Junos. По умолчанию модуль собирает основные данные о фактах устройства, которые будут включены в hostvars. Дополнительную информацию о фактах можно собрать на основе настроенного набора аргументов.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ncclient (>=v0.5.2)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| config_format - |
| Аргумент config_format указывает формат конфигурации при сериализации вывода с устройства. Этот аргумент применим только когда значение config присутствует в gather_subset. config_format должен поддерживаться версией Junos, работающей на устройстве. Это значение не применимо при получении фактов старого стиля, когда значение ofacts присутствует в значении gather_subset. Этот параметр валиден только для gather_subset значений. | |
| gather_network_resources - добавлен в 2.9 | При указании данного аргумента, собираемые факты будут ограничены заданным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, VLAN и т.д. Можно указать список значений для включения более крупного подмножества. Значения также могут быть использованы с начальным ! для указания, что конкретное подмножество не должно быть собрано. Допустимые подмножества — 'all', 'interfaces', 'lacp', 'lacp_interfaces', 'lag_interfaces', 'l2_interfaces', 'l3_interfaces', 'lldp_global', 'lldp_interfaces', 'vlans'. | ||
| gather_subset - | Значение по умолчанию: ["!config"] | При указании данного аргумента, собираемые факты будут ограничены заданным подмножеством. Возможные значения для этого аргумента включают все, аппаратное обеспечение, конфигурацию и интерфейсы. Можно указать список значений для включения более крупного подмножества. Значения также могут быть использованы с начальным ! для указания, что конкретное подмножество не должно быть собрано. Для обеспечения обратной совместимости старые типы фактов могут быть получены, явно добавив ofacts в значение; это требует установки junos-eznc в качестве предварительного требования. Допустимые значения gather_subset — default, hardware, config, interfaces, ofacts. Если ofacts присутствует в списке, это извлекает факты старого стиля (ключи фактов без префикса «ansible_»), и это требует установки библиотеки junos-eznc на контрольном узле, а учётные данные входа в устройство должны быть указаны в опции provider. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli или connection: netconf.Для получения дополнительной информации, пожалуйста, обратитесь к руководству Junos OS Platform Options. Объект словаря, содержащий сведения о соединении. | ||
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: 22 | Указывает порт для подключения к удалённому устройству. Значение порта по умолчанию — хорошо известный порт SSH 22 (для transport=cli) или порт 830 (для transport=netconf) устройства. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку. | |
| username строка | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
Примечания
Примечание
- Убедитесь, что config_format, используемый для извлечения конфигурации с устройства, поддерживается версией Junos, работающей на устройстве.
- При config_format = json конфигурация в результатах будет словарем (а не строкой JSON).
- Этот модуль требует, чтобы служба системы netconf была включена на управляемом удалённом устройстве.
- Протестировано на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.
- Рекомендуемое подключение —
netconf. Смотрите руководство по вариантам платформы Junos OS. - Этот модуль также работает с подключениями
localдля устаревших playbook. - Для получения старых стилей фактов требуется библиотека junos-eznc, установленная на контрольном узле, и учётные данные входа в устройство должны быть указаны в опции provider.
- Для получения информации об использовании CLI и netconf см. руководство по вариантам платформы Junos OS
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство по Ansible для сетей
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами Juniper см. https://www.ansible.com/ansible-juniper.
Примеры
- name: collect default set of facts
junos_facts:
- name: collect default set of facts and configuration
junos_facts:
gather_subset: config
- name: Gather legacy and resource facts
junos_facts:
gather_subset: all
gather_network_resources: all
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible по работе с сетями. [сеть]
Поддержка Red Hat
Дополнительная информация о поддержке Red Hat этого модуля доступна в этой статье из базы знаний Red Hat: статья из базы знаний 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.9/modules/junos_facts_module.html