cisco.dnac.templates_template_id_versions_v1_info module – Information module for Templates Template Id Versions V1
Note
This module is part of the cisco.dnac collection (version 6.27.0).
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_template_id_versions_v1_info.
New in cisco.dnac 6.17.0
Synopsis
Get all Templates Template Id Versions V1.
Get a template’s version information.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
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: |
|
Additional headers. |
|
LatestVersion query parameter. Filter response to only include the latest version of a template. Choices:
|
|
Limit query parameter. The number of records to show for this page;The minimum is 1, and the maximum is 500. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response. |
|
TemplateId path parameter. The id of the template to get versions of, retrieveable from `GET /dna/intent/api/v1/templates`. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
VersionNumber query parameter. Filter response to only get the template version that matches this version number. |
Notes
Note
SDK Method used are configuration_templates.ConfigurationTemplates.get_template_versions_v1,
Paths used are get /dna/intent/api/v1/templates/{templateId}/versions,
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 GetTemplateVersionsV1
Complete reference of the GetTemplateVersionsV1 API.
Examples
- name: Get all Templates Template Id Versions V1
cisco.dnac.templates_template_id_versions_v1_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}}"
versionNumber: 0
latestVersion: True
order: string
limit: 0
offset: 0
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: |