cisco.dnac.configuration_template_info – Information module for Configuration Template

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 ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.configuration_template_info.

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Configuration Template.

  • Get Configuration Template by id.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.4.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
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.
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.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

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

See Also

See also

Configuration Template reference

Complete reference of the Configuration Template object model.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

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" } ], "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", "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" }


Authors

  • Rafael Campos (@racampos)