Модуль cisco.dnac.configuration_template_project_info – Информационный модуль для проекта Шаблон конфигурации
Примечание
Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля требуются дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: cisco.dnac.configuration_template_project_info.
Новый в cisco.dnac 3.1.0
Описание
- Получение всех проектов Шаблон конфигурации.
- Получение проекта Шаблон конфигурации по идентификатору.
- Получение подробных данных о заданном проекте по его идентификатору.
- Вывод списка проектов.
Примечание
Данный модуль имеет соответствующий плагин действий.
Требования
Ниже приведены требования, необходимые на узле, который выполняет этот модуль.
- dnacentersdk >= 2.7.2
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
dnac_debug boolean | Флаг для Cisco DNA Center SDK для включения отладки. Варианты:
|
dnac_host string / обязательно | Имя хоста Cisco DNA Center. |
dnac_password string | Пароль Cisco DNA Center для аутентификации. |
dnac_port integer | Порт Cisco DNA Center. По умолчанию: |
dnac_username псевдонимы: user string | Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: |
dnac_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
dnac_version string | Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: |
headers словарь | Дополнительные заголовки. |
name строка | Параметр запроса имени. Имя проекта для поиска. |
projectId строка | Параметр пути projectId. projectId (UUID) проекта для получения подробных данных о проекте. |
sortOrder строка | Параметр запроса sortOrder. Порядок сортировки (восходящий - asc, нисходящий - des). |
validate_response_schema boolean | Флаг для Cisco DNA Center SDK для включения проверки запросов по JSON-схеме. Варианты:
|
Примечания
Примечание
- Используемые методы SDK: configuration_templates.ConfigurationTemplates.get_project_details, configuration_templates.ConfigurationTemplates.get_projects,
- Используемые пути: get /dna/intent/api/v1/template-programmer/project, get /dna/intent/api/v1/template-programmer/project/{projectId},
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует никаких плагинов подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco DNA Center для шаблонов конфигурации GetsAListOfProjects
-
Полное описание API GetsAListOfProjects.
- Документация Cisco DNA Center для шаблонов конфигурации GetsTheDetailsOfAGivenProject
-
Полное описание API GetsTheDetailsOfAGivenProject.
Примеры
- name: Get all Configuration Template Project
cisco.dnac.configuration_template_project_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}}"
name: string
sortOrder: string
register: result
- name: Get Configuration Template Project by id
cisco.dnac.configuration_template_project_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
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_project_info_module.html