.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.configuration_template_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.configuration_template_info -- Information module for Configuration Template +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.1.3). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.configuration_template_info`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Configuration Template. - Get Configuration Template by id. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
filterConflictingTemplates
boolean
    Choices:
  • no
  • yes
FilterConflictingTemplates query parameter. Filter template(s) based on confliting templates.
headers
dictionary
Additional headers.
latestVersion
boolean
    Choices:
  • no
  • yes
LatestVersion query parameter. LatestVersion flag to get the latest versioned template.
productFamily
string
ProductFamily query parameter. Filter template(s) based on device family.
productSeries
string
ProductSeries query parameter. Filter template(s) based on device series.
productType
string
ProductType query parameter. Filter template(s) based on device type.
projectId
string
ProjectId query parameter. Filter template(s) based on project UUID.
projectNames
list / elements=string
ProjectNames query parameter. Filter template(s) based on project names.
softwareType
string
SoftwareType query parameter. Filter template(s) based software type.
softwareVersion
string
SoftwareVersion query parameter. Filter template(s) based softwareVersion.
sortOrder
string
SortOrder query parameter. Sort Order Ascending (asc) or Descending (des).
tags
list / elements=string
Tags query parameter. Filter template(s) based on tags.
templateId
string
TemplateId path parameter. TemplateId(UUID) to get details of the template.
unCommitted
boolean
    Choices:
  • no
  • yes
UnCommitted query parameter. Filter template(s) based on template commited or not.

.. Notes .. Seealso See Also -------- .. seealso:: `Configuration Template reference `_ Complete reference of the Configuration Template object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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: custom: value 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: custom: value latestVersion: True templateId: string register: result .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "tags": [ { "id": "string", "name": "string" } ], "author": "string", "composite": true, "containingTemplates": [ { "tags": [ { "id": "string", "name": "string" } ], "composite": true, "description": "string", "deviceTypes": [ { "productFamily": "string", "productSeries": "string", "productType": "string" } ], "id": "string", "language": "string", "name": "string", "projectName": "string", "rollbackTemplateParams": [ { "binding": "string", "customOrder": 0, "dataType": "string", "defaultValue": "string", "description": "string", "displayName": "string", "group": "string", "id": "string", "instructionText": "string", "key": "string", "notParam": true, "order": 0, "paramArray": true, "parameterName": "string", "provider": "string", "range": [ { "id": "string", "maxValue": 0, "minValue": 0 } ], "required": true, "selection": { "defaultSelectedValues": [ "string" ], "id": "string", "selectionType": "string", "selectionValues": {} } } ], "templateContent": "string", "templateParams": [ { "binding": "string", "customOrder": 0, "dataType": "string", "defaultValue": "string", "description": "string", "displayName": "string", "group": "string", "id": "string", "instructionText": "string", "key": "string", "notParam": true, "order": 0, "paramArray": true, "parameterName": "string", "provider": "string", "range": [ { "id": "string", "maxValue": 0, "minValue": 0 } ], "required": true, "selection": { "defaultSelectedValues": [ "string" ], "id": "string", "selectionType": "string", "selectionValues": {} } } ], "version": "string" } ], "createTime": 0, "customParamsOrder": true, "description": "string", "deviceTypes": [ { "productFamily": "string", "productSeries": "string", "productType": "string" } ], "failurePolicy": "string", "id": "string", "language": "string", "lastUpdateTime": 0, "latestVersionTime": 0, "name": "string", "parentTemplateId": "string", "projectId": "string", "projectName": "string", "rollbackTemplateContent": "string", "rollbackTemplateParams": [ { "binding": "string", "customOrder": 0, "dataType": "string", "defaultValue": "string", "description": "string", "displayName": "string", "group": "string", "id": "string", "instructionText": "string", "key": "string", "notParam": true, "order": 0, "paramArray": true, "parameterName": "string", "provider": "string", "range": [ { "id": "string", "maxValue": 0, "minValue": 0 } ], "required": true, "selection": { "defaultSelectedValues": [ "string" ], "id": "string", "selectionType": "string", "selectionValues": {} } } ], "softwareType": "string", "softwareVariant": "string", "softwareVersion": "string", "templateContent": "string", "templateParams": [ { "binding": "string", "customOrder": 0, "dataType": "string", "defaultValue": "string", "description": "string", "displayName": "string", "group": "string", "id": "string", "instructionText": "string", "key": "string", "notParam": true, "order": 0, "paramArray": true, "parameterName": "string", "provider": "string", "range": [ { "id": "string", "maxValue": 0, "minValue": 0 } ], "required": true, "selection": { "defaultSelectedValues": [ "string" ], "id": "string", "selectionType": "string", "selectionValues": {} } } ], "validationErrors": { "rollbackTemplateErrors": {}, "templateErrors": {}, "templateId": "string", "templateVersion": "string" }, "version": "string" }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors