Модуль cisco.dnac.configuration_template_info – Модуль информации о шаблоне конфигурации
Примечание
Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в книге задач укажите: cisco.dnac.configuration_template_info.
Добавлена в cisco.dnac 3.1.0
Описание
- Получение всех шаблонов конфигурации.
- Получение шаблона конфигурации по id.
- Детали шаблона по его id.
- Список доступных шаблонов.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- dnacentersdk >= 2.7.2
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
dnac_debug boolean | Флаг для Cisco DNA Center SDK для включения отладки. Варианты:
|
dnac_host string / required | Имя хоста Cisco DNA Center. |
dnac_password string | Пароль Cisco DNA Center для аутентификации. |
dnac_port integer | Порт Cisco DNA Center. По умолчанию: |
dnac_username aliases: user string | Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: |
dnac_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
dnac_version string | Информирует SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: |
filterConflictingTemplates boolean | Параметр запроса FilterConflictingTemplates. Фильтрует шаблон(ы) на основе конфликтующих шаблонов. Варианты:
|
headers dictionary | Дополнительные заголовки. |
latestVersion boolean | Параметр запроса LatestVersion. Флаг LatestVersion для получения шаблона последней версии. Варианты:
|
productFamily string | Параметр запроса ProductFamily. Фильтрует шаблон(ы) на основе семейства устройств. |
productSeries string | Параметр запроса ProductSeries. Фильтрует шаблон(ы) на основе серии устройств. |
productType string | Параметр запроса ProductType. Фильтрует шаблон(ы) на основе типа устройства. |
projectId string | Параметр запроса ProjectId. Фильтрует шаблон(ы) на основе UUID проекта. |
projectNames list / elements=string | Параметр запроса ProjectNames. Фильтрует шаблон(ы) на основе имен проектов. |
softwareType string | Параметр запроса SoftwareType. Фильтрует шаблон(ы) на основе типа программного обеспечения. |
softwareVersion string | Параметр запроса SoftwareVersion. Фильтрует шаблон(ы) на основе версии программного обеспечения. |
sortOrder string | Параметр запроса SortOrder. Порядок сортировки по возрастанию (asc) или убыванию (des). |
tags list / elements=string | Параметр запроса Tags. Фильтрует шаблон(ы) на основе тегов. |
templateId string | Параметр пути TemplateId. TemplateId (UUID) для получения подробной информации о шаблоне. |
unCommitted boolean | Параметр запроса UnCommitted. Фильтрует шаблон(ы) на основе подтвержденного или нет шаблона. Варианты:
|
validate_response_schema boolean | Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты:
|
Примечания
Примечание
- Используемые методы SDK: configuration_templates.ConfigurationTemplates.get_template_details, configuration_templates.ConfigurationTemplates.gets_the_templates_available,
- Используемые пути: get /dna/intent/api/v1/template-programmer/template, get /dna/intent/api/v1/template-programmer/template/{templateId},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco DNA Center по шаблонам конфигурации GetsDetailsOfAGivenTemplate
-
Полное описание API GetsDetailsOfAGivenTemplate.
- Документация Cisco DNA Center по шаблонам конфигурации GetsTheTemplatesAvailable
-
Полное описание API GetsTheTemplatesAvailable.
Примеры
- name: Get all Configuration Template
cisco.dnac.configuration_template_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers: "{{my_headers | from_json}}"
projectId: string
softwareType: string
softwareVersion: string
productFamily: string
productSeries: string
productType: string
filterConflictingTemplates: True
tags: []
projectNames: []
unCommitted: True
sortOrder: string
register: result
- name: Get Configuration Template by id
cisco.dnac.configuration_template_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers: "{{my_headers | from_json}}"
latestVersion: True
templateId: string
register: result
Значения возврата
Общие значения возврата описаны в здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
dnac_response словарь | Словарь или список со значением, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/configuration_template_info_module.html
