cisco.dnac.configuration_template module – Resource module for Configuration Template
Note
This module is part of the cisco.dnac collection (version 6.20.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.configuration_template
.
New in cisco.dnac 3.1.0
Synopsis
Manage operations update and delete of the resource Configuration Template.
Deletes the template by its id.
API to update a template.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Author of template. |
|
Is it composite template. Choices:
|
|
Configuration Template’s containingTemplates. |
|
Is it composite template. Choices:
|
|
Description of template. |
|
Configuration Template’s deviceTypes. |
|
Device family. |
|
Device series. |
|
Device type. |
|
UUID of template. |
|
Template language (JINJA or VELOCITY). |
|
Name of template. |
|
Project name. |
|
Configuration Template’s rollbackTemplateParams. |
|
Bind to source. |
|
CustomOrder of template param. |
|
Datatype of template param. |
|
Default value of template param. |
|
Description of template param. |
|
Display name of param. |
|
Group. |
|
UUID of template param. |
|
Instruction text for param. |
|
Key. |
|
Is it not a variable. Choices:
|
|
Order of template param. |
|
Is it an array. Choices:
|
|
Name of template param. |
|
Provider. |
|
Configuration Template’s range. |
|
UUID of range. |
|
Max value of range. |
|
Min value of range. |
|
Is param required. Choices:
|
|
Configuration Template’s selection. |
|
Default selection values. |
|
UUID of selection. |
|
Type of selection(SINGLE_SELECT or MULTI_SELECT). |
|
Selection values. |
|
Configuration Template’s tags. |
|
UUID of tag. |
|
Name of tag. |
|
Template content. |
|
Configuration Template’s templateParams. |
|
Bind to source. |
|
CustomOrder of template param. |
|
Datatype of template param. |
|
Default value of template param. |
|
Description of template param. |
|
Display name of param. |
|
Group. |
|
UUID of template param. |
|
Instruction text for param. |
|
Key. |
|
Is it not a variable. Choices:
|
|
Order of template param. |
|
Is it an array. Choices:
|
|
Name of template param. |
|
Provider. |
|
Configuration Template’s range. |
|
UUID of range. |
|
Max value of range. |
|
Min value of range. |
|
Is param required. Choices:
|
|
Configuration Template’s selection. |
|
Default selection values. |
|
UUID of selection. |
|
Type of selection(SINGLE_SELECT or MULTI_SELECT). |
|
Selection values. |
|
Current version of template. |
|
Create time of template. |
|
Custom Params Order. Choices:
|
|
Description of template. |
|
Configuration Template’s deviceTypes. |
|
Device family. |
|
Device series. |
|
Device type. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Define failure policy if template provisioning fails. |
|
UUID of template. |
|
Template language (JINJA or VELOCITY). |
|
Update time of template. |
|
Latest versioned template time. |
|
Name of template. |
|
Parent templateID. |
|
Project UUID. |
|
Project name. |
|
Rollback template content. |
|
Configuration Template’s rollbackTemplateParams. |
|
Bind to source. |
|
CustomOrder of template param. |
|
Datatype of template param. |
|
Default value of template param. |
|
Description of template param. |
|
Display name of param. |
|
Group. |
|
UUID of template param. |
|
Instruction text for param. |
|
Key. |
|
Is it not a variable. Choices:
|
|
Order of template param. |
|
Is it an array. Choices:
|
|
Name of template param. |
|
Provider. |
|
Configuration Template’s range. |
|
UUID of range. |
|
Max value of range. |
|
Min value of range. |
|
Is param required. Choices:
|
|
Configuration Template’s selection. |
|
Default selection values. |
|
UUID of selection. |
|
Type of selection(SINGLE_SELECT or MULTI_SELECT). |
|
Selection values. |
|
Applicable device software type. |
|
Applicable device software variant. |
|
Applicable device software version. |
|
Configuration Template’s tags. |
|
UUID of tag. |
|
Name of tag. |
|
Template content. |
|
TemplateId path parameter. TemplateId(UUID) of template to be deleted. |
|
Configuration Template’s templateParams. |
|
Bind to source. |
|
CustomOrder of template param. |
|
Datatype of template param. |
|
Default value of template param. |
|
Description of template param. |
|
Display name of param. |
|
Group. |
|
UUID of template param. |
|
Instruction text for param. |
|
Key. |
|
Is it not a variable. Choices:
|
|
Order of template param. |
|
Is it an array. Choices:
|
|
Name of template param. |
|
Provider. |
|
Configuration Template’s range. |
|
UUID of range. |
|
Max value of range. |
|
Min value of range. |
|
Is param required. Choices:
|
|
Configuration Template’s selection. |
|
Default selection values. |
|
UUID of selection. |
|
Type of selection(SINGLE_SELECT or MULTI_SELECT). |
|
Selection values. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Configuration Template’s validationErrors. |
|
Validation or design conflicts errors of rollback template. |
|
Validation or design conflicts errors. |
|
UUID of template. |
|
Current version of template. |
|
Current version of template. |
Notes
Note
SDK Method used are configuration_templates.ConfigurationTemplates.deletes_the_template, configuration_templates.ConfigurationTemplates.update_template,
Paths used are delete /dna/intent/api/v1/template-programmer/template/{templateId}, put /dna/intent/api/v1/template-programmer/template,
Does not support
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 DeletesTheTemplate
Complete reference of the DeletesTheTemplate API.
- Cisco DNA Center documentation for Configuration Templates UpdateTemplate
Complete reference of the UpdateTemplate API.
Examples
- name: Update all
cisco.dnac.configuration_template:
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}}"
state: present
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
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
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
- name: Delete by id
cisco.dnac.configuration_template:
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}}"
state: absent
templateId: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |