.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.dnac.templates_details_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.templates_details_info -- Information module for Templates Details +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 4.0.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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.templates_details_info`. .. version_added .. versionadded:: 4.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Templates Details. .. 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 >= 2.4.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
allTemplateAttributes
boolean
    Choices:
  • no
  • yes
AllTemplateAttributes query parameter. Return all template attributes.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.3.3"
Informs the SDK which version of Cisco DNA Center to use.
filterConflictingTemplates
boolean
    Choices:
  • no
  • yes
FilterConflictingTemplates query parameter. Filter template(s) based on confliting templates.
headers
dictionary
Additional headers.
id
string
Id query parameter. Id of template to be searched.
includeVersionDetails
boolean
    Choices:
  • no
  • yes
IncludeVersionDetails query parameter. Include template version details.
limit
integer
Limit query parameter. Limits number of results.
name
string
Name query parameter. Name of template to be searched.
offset
integer
Offset query parameter. Index of first result.
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 id.
projectName
string
ProjectName query parameter. Filter template(s) based on project name.
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 (dsc).
tags
list / elements=string
Tags query parameter. Filter template(s) based on tags.
unCommitted
boolean
    Choices:
  • no
  • yes
UnCommitted query parameter. Return uncommitted template.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

.. Attributes .. Notes Notes ----- .. note:: - Supports ``check_mode`` - The 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 .. Seealso See Also -------- .. seealso:: `Templates Details reference `_ Complete reference of the Templates Details object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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: custom: value 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 .. 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:
{ "response": [ { "author": "string", "composite": true, "containingTemplates": [ { "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": {} } } ], "tags": [ { "id": "string", "name": "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": {} } } ], "version": "string" } ], "createTime": 0, "customParamsOrder": true, "description": "string", "deviceTypes": [ { "productFamily": "string", "productSeries": "string", "productType": "string" } ], "documentDatabase": true, "failurePolicy": "string", "id": "string", "language": "string", "lastUpdateTime": 0, "latestVersionTime": 0, "name": "string", "parentTemplateId": "string", "projectAssociated": true, "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", "tags": [ { "id": "string", "name": "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", "versionsInfo": [ { "author": "string", "description": "string", "id": "string", "version": "string", "versionComment": "string", "versionTime": 0 } ] } ], "version": "string" }


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