cisco.dnac.templates_details_info module – Information module for Templates Details
Note
This module is part of the cisco.dnac collection (version 6.13.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.templates_details_info.
New in cisco.dnac 4.0.0
Synopsis
Get all Templates Details.
Get templates details.
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 |
|---|---|
AllTemplateAttributes query parameter. Return all template attributes. Choices:
|
|
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. |
|
Id query parameter. Id of template to be searched. |
|
IncludeVersionDetails query parameter. Include template version details. Choices:
|
|
Limit query parameter. Limits number of results. |
|
Name query parameter. Name of template to be searched. |
|
Offset query parameter. Index of first result. |
|
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 id. |
|
ProjectName query parameter. Filter template(s) based on project name. |
|
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 (dsc). |
|
Tags query parameter. Filter template(s) based on tags. |
|
UnCommitted query parameter. Return uncommitted template. 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_templates_details,
Paths used are get /dna/intent/api/v2/template-programmer/template,
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 GetTemplatesDetails
Complete reference of the GetTemplatesDetails API.
Examples
- name: Get all Templates Details
cisco.dnac.templates_details_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}}"
id: string
name: string
projectId: string
projectName: string
softwareType: string
softwareVersion: string
productFamily: string
productSeries: string
productType: string
filterConflictingTemplates: True
tags: []
unCommitted: True
sortOrder: string
allTemplateAttributes: True
includeVersionDetails: True
offset: 0
limit: 0
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: |