Try SpotterManage Template objects of ConfigurationTemplates
| "added in version" 1.0.0 of cisco.dnac"
Authors: Rafael Campos (@racampos)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.dnac:==2.0.7
collections:
- name: cisco.dnac
version: 2.0.7Creates a new Template.
List the Templates available.
Updates an existing Template.
Returns details of the specified Template.
Deletes an existing Template.
- name: create_template
cisco.dnac.template:
state: create # required
project_id: SomeValue # string, required
author: SomeValue # string
composite: True # boolean
containingTemplates:
- composite: True # boolean
id: SomeValue # string
name: SomeValue # string
version: SomeValue # string
createTime: 1 # integer
description: SomeValue # string
deviceTypes:
- productFamily: SomeValue # string
productSeries: SomeValue # string
productType: SomeValue # string
failurePolicy: # valid values are 'ABORT_ON_ERROR',
# 'CONTINUE_ON_ERROR',
# 'ROLLBACK_ON_ERROR',
# 'ROLLBACK_TARGET_ON_ERROR',
# 'ABORT_TARGET_ON_ERROR'.
SomeValue # string
id: SomeValue # string
lastUpdateTime: 1 # integer
name: SomeValue # string
parentTemplateId: SomeValue # string
projectId: SomeValue # string
projectName: SomeValue # string
rollbackTemplateContent: SomeValue # string
rollbackTemplateParams:
- binding: SomeValue # string
dataType: SomeValue # string
defaultValue: SomeValue # string
description: SomeValue # string
displayName: SomeValue # string
group: SomeValue # string
id: SomeValue # string
instructionText: SomeValue # string
key: SomeValue # string
notParam: True # boolean
order: 1 # integer
paramArray: True # boolean
parameterName: SomeValue # string
provider: SomeValue # string
range:
- id: SomeValue # string
maxValue: 1 # integer
minValue: 1 # integer
required: True # boolean
selection:
id: SomeValue # string
selectionType: SomeValue # string
selectionValues:
softwareType: SomeValue # string
softwareVariant: SomeValue # string
softwareVersion: SomeValue # string
tags:
- SomeValue # string
templateContent: SomeValue # string
templateParams:
- binding: SomeValue # string
dataType: SomeValue # string
defaultValue: SomeValue # string
description: SomeValue # string
displayName: SomeValue # string
group: SomeValue # string
id: SomeValue # string
instructionText: SomeValue # string
key: SomeValue # string
notParam: True # boolean
order: 1 # integer
paramArray: True # boolean
parameterName: SomeValue # string
provider: SomeValue # string
range:
- id: SomeValue # string
maxValue: 1 # integer
minValue: 1 # integer
required: True # boolean
selection:
id: SomeValue # string
selectionType: SomeValue # string
selectionValues:
version: SomeValue # string
- name: gets_the_templates_available
cisco.dnac.template:
state: query # required
filter_conflicting_templates: True # boolean
product_family: SomeValue # string
product_series: SomeValue # string
product_type: SomeValue # string
project_id: SomeValue # string
software_type: SomeValue # string
software_version: SomeValue # string
register: nm_gets_the_templates_available
- name: update_template
cisco.dnac.template:
state: update # required
author: SomeValue # string
composite: True # boolean
containingTemplates:
- composite: True # boolean
id: SomeValue # string
name: SomeValue # string
version: SomeValue # string
createTime: 1 # integer
description: SomeValue # string
deviceTypes:
- productFamily: SomeValue # string
productSeries: SomeValue # string
productType: SomeValue # string
failurePolicy: # valid values are 'ABORT_ON_ERROR',
# 'CONTINUE_ON_ERROR',
# 'ROLLBACK_ON_ERROR',
# 'ROLLBACK_TARGET_ON_ERROR',
# 'ABORT_TARGET_ON_ERROR'.
SomeValue # string
id: SomeValue # string
lastUpdateTime: 1 # integer
name: SomeValue # string
parentTemplateId: SomeValue # string
projectId: SomeValue # string
projectName: SomeValue # string
rollbackTemplateContent: SomeValue # string
rollbackTemplateParams:
- binding: SomeValue # string
dataType: SomeValue # string
defaultValue: SomeValue # string
description: SomeValue # string
displayName: SomeValue # string
group: SomeValue # string
id: SomeValue # string
instructionText: SomeValue # string
key: SomeValue # string
notParam: True # boolean
order: 1 # integer
paramArray: True # boolean
parameterName: SomeValue # string
provider: SomeValue # string
range:
- id: SomeValue # string
maxValue: 1 # integer
minValue: 1 # integer
required: True # boolean
selection:
id: SomeValue # string
selectionType: SomeValue # string
selectionValues:
softwareType: SomeValue # string
softwareVariant: SomeValue # string
softwareVersion: SomeValue # string
tags:
- SomeValue # string
templateContent: SomeValue # string
templateParams:
- binding: SomeValue # string
dataType: SomeValue # string
defaultValue: SomeValue # string
description: SomeValue # string
displayName: SomeValue # string
group: SomeValue # string
id: SomeValue # string
instructionText: SomeValue # string
key: SomeValue # string
notParam: True # boolean
order: 1 # integer
paramArray: True # boolean
parameterName: SomeValue # string
provider: SomeValue # string
range:
- id: SomeValue # string
maxValue: 1 # integer
minValue: 1 # integer
required: True # boolean
selection:
id: SomeValue # string
selectionType: SomeValue # string
selectionValues:
version: SomeValue # string
- name: get_template_details
cisco.dnac.template:
state: query # required
template_id: SomeValue # string, required
latest_version: True # boolean
register: nm_get_template_details
- name: delete_template
cisco.dnac.template:
state: delete # required
template_id: SomeValue # string, required
id:
description:
- TemplateDTO's id.
type: str
name:
description:
- TemplateDTO's name.
type: str
tags:
description:
- TemplateDTO's tags (list of strings).
type: list
author:
description:
- TemplateDTO's author.
type: str
version:
description:
- TemplateDTO's version.
type: str
composite:
description:
- TemplateDTO's composite.
type: bool
projectId:
description:
- TemplateDTO's projectId.
type: str
createTime:
description:
- TemplateDTO's createTime.
type: int
project_id:
description:
- ProjectId path parameter.
- ProjectId query parameter.
- Required for state create.
required: true
type: str
description:
description:
- TemplateDTO's description.
type: str
deviceTypes:
description:
- TemplateDTO's deviceTypes (list of objects).
elements: dict
suboptions:
productFamily:
description:
- It is the Template's productFamily.
type: str
productSeries:
description:
- It is the Template's productSeries.
type: str
productType:
description:
- It is the Template's productType.
type: str
type: list
projectName:
description:
- TemplateDTO's projectName.
type: str
template_id:
description:
- TemplateId path parameter.
required: true
type: str
product_type:
description:
- ProductType query parameter.
type: str
softwareType:
description:
- TemplateDTO's softwareType.
type: str
failurePolicy:
description:
- TemplateDTO's failurePolicy.
type: str
software_type:
description:
- SoftwareType query parameter.
type: str
lastUpdateTime:
description:
- TemplateDTO's lastUpdateTime.
type: int
latest_version:
description:
- LatestVersion query parameter.
type: bool
product_family:
description:
- ProductFamily query parameter.
type: str
product_series:
description:
- ProductSeries query parameter.
type: str
templateParams:
description:
- TemplateDTO's TemplateParams (list of objects).
elements: dict
suboptions:
binding:
description:
- It is the Template's binding.
type: str
dataType:
description:
- It is the Template's dataType.
type: str
defaultValue:
description:
- It is the Template's defaultValue.
type: str
description:
description:
- It is the Template's description.
type: str
displayName:
description:
- It is the Template's displayName.
type: str
group:
description:
- It is the Template's group.
type: str
id:
description:
- It is the Template's id.
type: str
instructionText:
description:
- It is the Template's instructionText.
type: str
key:
description:
- It is the Template's key.
type: str
notParam:
description:
- It is the Template's notParam.
type: bool
order:
description:
- It is the Template's order.
type: int
paramArray:
description:
- It is the Template's paramArray.
type: bool
parameterName:
description:
- It is the Template's parameterName.
type: str
provider:
description:
- It is the Template's provider.
type: str
range:
description:
- It is the Template's range.
elements: dict
suboptions:
id:
description:
- It is the Template's id.
type: str
maxValue:
description:
- It is the Template's maxValue.
type: int
minValue:
description:
- It is the Template's minValue.
type: int
type: list
required:
description:
- It is the Template's required.
type: bool
selection:
description:
- It is the Template's selection.
suboptions:
id:
description:
- It is the Template's id.
type: str
selectionType:
description:
- It is the Template's selectionType.
type: str
selectionValues:
description:
- It is the Template's selectionValues.
type: dict
type: dict
type: list
softwareVariant:
description:
- TemplateDTO's softwareVariant.
type: str
softwareVersion:
description:
- TemplateDTO's softwareVersion.
type: str
templateContent:
description:
- TemplateDTO's TemplateContent.
type: str
parentTemplateId:
description:
- TemplateDTO's parentTemplateId.
type: str
software_version:
description:
- SoftwareVersion query parameter.
type: str
containingTemplates:
description:
- TemplateDTO's containingTemplates (list of objects).
elements: dict
suboptions:
composite:
description:
- It is the Template's composite.
type: bool
id:
description:
- It is the Template's id.
type: str
name:
description:
- It is the Template's name.
type: str
version:
description:
- It is the Template's version.
type: str
type: list
rollbackTemplateParams:
description:
- TemplateDTO's rollbackTemplateParams (list of objects).
elements: dict
suboptions:
binding:
description:
- It is the Template's binding.
type: str
dataType:
description:
- It is the Template's dataType.
type: str
defaultValue:
description:
- It is the Template's defaultValue.
type: str
description:
description:
- It is the Template's description.
type: str
displayName:
description:
- It is the Template's displayName.
type: str
group:
description:
- It is the Template's group.
type: str
id:
description:
- It is the Template's id.
type: str
instructionText:
description:
- It is the Template's instructionText.
type: str
key:
description:
- It is the Template's key.
type: str
notParam:
description:
- It is the Template's notParam.
type: bool
order:
description:
- It is the Template's order.
type: int
paramArray:
description:
- It is the Template's paramArray.
type: bool
parameterName:
description:
- It is the Template's parameterName.
type: str
provider:
description:
- It is the Template's provider.
type: str
range:
description:
- It is the Template's range.
elements: dict
suboptions:
id:
description:
- It is the Template's id.
type: str
maxValue:
description:
- It is the Template's maxValue.
type: int
minValue:
description:
- It is the Template's minValue.
type: int
type: list
required:
description:
- It is the Template's required.
type: bool
selection:
description:
- It is the Template's selection.
suboptions:
id:
description:
- It is the Template's id.
type: str
selectionType:
description:
- It is the Template's selectionType.
type: str
selectionValues:
description:
- It is the Template's selectionValues.
type: dict
type: dict
type: list
rollbackTemplateContent:
description:
- TemplateDTO's rollbackTemplateContent.
type: str
filter_conflicting_templates:
description:
- FilterConflictingTemplates query parameter.
type: bool
dnac_response:
description: A dictionary with the response returned by the DNA Center Python SDK
returned: always
sample:
response: 29
version: '1.0'
type: dict
missing_params:
description: Provided arguments do not comply with the schema of the DNA Center
Python SDK function
returned: when the function request schema is not satisfied
sample: null
type: list
sdk_function:
description: The DNA Center SDK function used to execute the task
returned: always
sample: configuration_templates.create_template
type: str