cisco.catalystcenter.templates_details_info module -- Information module for Templates Details
Note
This module is part of the cisco.catalystcenter collection (version 2.2.2).
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.templates_details_info.
New in cisco.catalystcenter 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.
catalystcentersdk >= 3.1.3.0.0
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
AllTemplateAttributes query parameter. Return all template attributes. Choices: |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
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 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:`"2.3.7.6"` |
|
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. The number of records to show for this page;The minimum is 1, and the maximum is 500. |
|
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 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_templates_details_v2,
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 uses the embedded connection manager from Cisco CATALYST SDK
See Also
See also
- Cisco DNA Center documentation for Configuration Templates GetTemplatesDetailsV2
Complete reference of the GetTemplatesDetailsV2 API.
Examples
---
- name: Get all Templates Details
cisco.catalystcenter.templates_details_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_api_port: "{{catalystcenter_api_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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 |
|---|---|