cisco.catalystcenter.configuration_template_info module -- Information module for Configuration Template
Note
This module is part of the cisco.catalystcenter collection (version 2.3.1).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.configuration_template_info.
New in cisco.catalystcenter 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.
catalystcentersdk >= 3.1.6.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
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 Catalyst 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 uses the embedded connection manager from Cisco CATALYST SDK
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.catalystcenter.configuration_template_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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.catalystcenter.configuration_template_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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 |
|---|---|