cisco.dnac.configuration_template_info module – Information module for Configuration Template

Note

This module is part of the cisco.dnac collection (version 6.5.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.

  • 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.

  • dnacentersdk >= 2.5.0

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: “admin”

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • no

  • yes ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: “2.3.3.0”

filterConflictingTemplates

boolean

FilterConflictingTemplates query parameter. Filter template(s) based on confliting templates.

Choices:

  • no

  • yes

headers

dictionary

Additional headers.

latestVersion

boolean

LatestVersion query parameter. LatestVersion flag to get the latest versioned template.

Choices:

  • no

  • yes

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

UnCommitted query parameter. Filter template(s) based on template commited or not.

Choices:

  • no

  • yes

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • no

  • yes ← (default)

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_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

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.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: "{{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.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: "{{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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

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

Authors

  • Rafael Campos (@racampos)