junipernetworks.junos.junos_facts – Сбор фактов с удалённых устройств, работающих под управлением Juniper Junos
Примечание
Этот плагин входит в состав коллекции junipernetworks.junos (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install junipernetworks.junos.
Для использования в книге задач укажите: junipernetworks.junos.junos_facts.
Новое в версии 1.0.0: из junipernetworks.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 список / элементы=строка | При указании этот аргумент ограничит собираемые факты определённым подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, 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 целое число | Указывает порт для создания соединения с удалённым устройством. Значение порта по умолчанию равно общеизвестному порту SSH 22 (для transport=cli) или 830 (для transport=netconf) устройства. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| 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 Platform Options. - Этот модуль также работает с
localсоединениями для устаревших книг задач. - Для получения фактов старого стиля требуется установка библиотеки junos-eznc на контрольном узле и предоставление данных для входа в систему устройства в параметре provider.
- Для получения информации об использовании CLI и netconf см. руководство Junos OS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible по сетям
- Для получения дополнительной информации об использовании Ansible для управления устройствами Juniper см. https://www.ansible.com/ansible-juniper.
Примеры
- name: collect default set of facts
junipernetworks.junos.junos_facts:
- name: collect default set of facts and configuration
junipernetworks.junos.junos_facts:
gather_subset: config
- name: Gather legacy and resource facts
junipernetworks.junos.junos_facts:
gather_subset: all
gather_network_resources: all
Авторы
- Nathaniel Case (@Qalthos)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/junipernetworks/junos/junos_facts_module.html