cisco.dnac.configuration_template_info module – Information module for Configuration Template
Note
This module is part of the cisco.dnac collection (version 6.6.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.configuration_template_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Configuration Template.
Get Configuration Template by id.
Details of the template by its id.
List the templates available.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.5.5
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
FilterConflictingTemplates query parameter. Filter template(s) based on confliting templates. Choices:
|
|
Additional headers. |
|
LatestVersion query parameter. LatestVersion flag to get the latest versioned template. Choices:
|
|
ProductFamily query parameter. Filter template(s) based on device family. |
|
ProductSeries query parameter. Filter template(s) based on device series. |
|
ProductType query parameter. Filter template(s) based on device type. |
|
ProjectId query parameter. Filter template(s) based on project UUID. |
|
ProjectNames query parameter. Filter template(s) based on project names. |
|
SoftwareType query parameter. Filter template(s) based software type. |
|
SoftwareVersion query parameter. Filter template(s) based softwareVersion. |
|
SortOrder query parameter. Sort Order Ascending (asc) or Descending (des). |
|
Tags query parameter. Filter template(s) based on tags. |
|
TemplateId path parameter. TemplateId(UUID) to get details of the template. |
|
UnCommitted query parameter. Filter template(s) based on template commited or not. Choices:
|
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are configuration_templates.ConfigurationTemplates.get_template_details, configuration_templates.ConfigurationTemplates.gets_the_templates_available,
Paths used are get /dna/intent/api/v1/template-programmer/template, get /dna/intent/api/v1/template-programmer/template/{templateId},
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Configuration Templates GetsDetailsOfAGivenTemplate
Complete reference of the GetsDetailsOfAGivenTemplate API.
- Cisco DNA Center documentation for Configuration Templates GetsTheTemplatesAvailable
Complete reference of the GetsTheTemplatesAvailable API.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |