Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
duality-group / ansible python
Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: configuration_template_project
short_description: Resource module for Configuration Template Project
description:
- Manage operations create, update and delete of the resource Configuration Template Project.
- This API is used to create a new project.
- Deletes the project by its id.
- This API is used to update an existing project.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
createTime:
description: Create time of project.
type: int
description:
description: Description of project.
type: str
id:
description: UUID of project.
type: str
lastUpdateTime:
description: Update time of project.
type: int
name:
description: Name of project.
type: str
projectId:
description: ProjectId path parameter. ProjectId(UUID) of project to be deleted.
type: str
tags:
description: Configuration Template Project's tags.
elements: dict
suboptions:
id:
description: UUID of tag.
type: str
name:
description: Name of tag.
type: str
type: list
templates:
description: List of templates within the project.
elements: dict
suboptions:
author:
description: Author of template.
type: str
composite:
description: Is it composite template.
type: bool
containingTemplates:
description: Configuration Template Project's containingTemplates.
elements: dict
suboptions:
composite:
description: Is it composite template.
type: bool
description:
description: Description of template.
type: str
deviceTypes:
description: Configuration Template Project's deviceTypes.
elements: dict
suboptions:
productFamily:
description: Device family.
type: str
productSeries:
description: Device series.
type: str
productType:
description: Device type.
type: str
type: list
id:
description: UUID of template.
type: str
language:
description: Template language (JINJA or VELOCITY).
type: str
name:
description: Name of template.
type: str
projectName:
description: Project name.
type: str
rollbackTemplateParams:
description: Configuration Template Project's rollbackTemplateParams.
elements: dict
suboptions:
binding:
description: Bind to source.
type: str
customOrder:
description: CustomOrder of template param.
type: int
dataType:
description: Datatype of template param.
type: str
defaultValue:
description: Default value of template param.
type: str
description:
description: Description of template param.
type: str
displayName:
description: Display name of param.
type: str
group:
description: Group.
type: str
id:
description: UUID of template param.
type: str
instructionText:
description: Instruction text for param.
type: str
key:
description: Key.
type: str
notParam:
description: Is it not a variable.
type: bool
order:
description: Order of template param.
type: int
paramArray:
description: Is it an array.
type: bool
parameterName:
description: Name of template param.
type: str
provider:
description: Provider.
type: str
range:
description: Configuration Template Project's range.
elements: dict
suboptions:
id:
description: UUID of range.
type: str
maxValue:
description: Max value of range.
type: int
minValue:
description: Min value of range.
type: int
type: list
required:
description: Is param required.
type: bool
selection:
description: Configuration Template Project's selection.
suboptions:
defaultSelectedValues:
description: Default selection values.
elements: str
type: list
id:
description: UUID of selection.
type: str
selectionType:
description: Type of selection(SINGLE_SELECT or MULTI_SELECT).
type: str
selectionValues:
description: Selection values.
type: dict
type: dict
type: list
tags:
description: Configuration Template Project's tags.
elements: dict
suboptions:
id:
description: UUID of tag.
type: str
name:
description: Name of tag.
type: str
type: list
templateContent:
description: Template content.
type: str
templateParams:
description: Configuration Template Project's templateParams.
elements: dict
suboptions:
binding:
description: Bind to source.
type: str
customOrder:
description: CustomOrder of template param.
type: int
dataType:
description: Datatype of template param.
type: str
defaultValue:
description: Default value of template param.
type: str
description:
description: Description of template param.
type: str
displayName:
description: Display name of param.
type: str
group:
description: Group.
type: str
id:
description: UUID of template param.
type: str
instructionText:
description: Instruction text for param.
type: str
key:
description: Key.
type: str
notParam:
description: Is it not a variable.
type: bool
order:
description: Order of template param.
type: int
paramArray:
description: Is it an array.
type: bool
parameterName:
description: Name of template param.
type: str
provider:
description: Provider.
type: str
range:
description: Configuration Template Project's range.
elements: dict
suboptions:
id:
description: UUID of range.
type: str
maxValue:
description: Max value of range.
type: int
minValue:
description: Min value of range.
type: int
type: list
required:
description: Is param required.
type: bool
selection:
description: Configuration Template Project's selection.
suboptions:
defaultSelectedValues:
description: Default selection values.
elements: str
type: list
id:
description: UUID of selection.
type: str
selectionType:
description: Type of selection(SINGLE_SELECT or MULTI_SELECT).
type: str
selectionValues:
description: Selection values.
type: dict
type: dict
type: list
version:
description: Current version of template.
type: str
type: list
createTime:
description: Create time of template.
type: int
customParamsOrder:
description: Custom Params Order.
type: bool
description:
description: Description of template.
type: str
deviceTypes:
description: Configuration Template Project's deviceTypes.
elements: dict
suboptions:
productFamily:
description: Device family.
type: str
productSeries:
description: Device series.
type: str
productType:
description: Device type.
type: str
type: list
documentDatabase:
description: Document Database.
type: bool
failurePolicy:
description: Define failure policy if template provisioning fails.
type: str
id:
description: UUID of template.
type: str
language:
description: Template language (JINJA or VELOCITY).
type: str
lastUpdateTime:
description: Update time of template.
type: int
latestVersionTime:
description: Latest versioned template time.
type: int
name:
description: Name of template.
type: str
parentTemplateId:
description: Parent templateID.
type: str
projectAssociated:
description: Project Associated.
type: bool
projectId:
description: Project UUID.
type: str
projectName:
description: Project name.
type: str
rollbackTemplateContent:
description: Rollback template content.
type: str
rollbackTemplateParams:
description: Configuration Template Project's rollbackTemplateParams.
elements: dict
suboptions:
binding:
description: Bind to source.
type: str
customOrder:
description: CustomOrder of template param.
type: int
dataType:
description: Datatype of template param.
type: str
defaultValue:
description: Default value of template param.
type: str
description:
description: Description of template param.
type: str
displayName:
description: Display name of param.
type: str
group:
description: Group.
type: str
id:
description: UUID of template param.
type: str
instructionText:
description: Instruction text for param.
type: str
key:
description: Key.
type: str
notParam:
description: Is it not a variable.
type: bool
order:
description: Order of template param.
type: int
paramArray:
description: Is it an array.
type: bool
parameterName:
description: Name of template param.
type: str
provider:
description: Provider.
type: str
range:
description: Configuration Template Project's range.
elements: dict
suboptions:
id:
description: UUID of range.
type: str
maxValue:
description: Max value of range.
type: int
minValue:
description: Min value of range.
type: int
type: list
required:
description: Is param required.
type: bool
selection:
description: Configuration Template Project's selection.
suboptions:
defaultSelectedValues:
description: Default selection values.
elements: str
type: list
id:
description: UUID of selection.
type: str
selectionType:
description: Type of selection(SINGLE_SELECT or MULTI_SELECT).
type: str
selectionValues:
description: Selection values.
type: dict
type: dict
type: list
softwareType:
description: Applicable device software type.
type: str
softwareVariant:
description: Applicable device software variant.
type: str
softwareVersion:
description: Applicable device software version.
type: str
tags:
description: Configuration Template Project's tags.
elements: dict
suboptions:
id:
description: UUID of tag.
type: str
name:
description: Name of tag.
type: str
type: list
templateContent:
description: Template content.
type: str
templateParams:
description: Configuration Template Project's templateParams.
elements: dict
suboptions:
binding:
description: Bind to source.
type: str
customOrder:
description: CustomOrder of template param.
type: int
dataType:
description: Datatype of template param.
type: str
defaultValue:
description: Default value of template param.
type: str
description:
description: Description of template param.
type: str
displayName:
description: Display name of param.
type: str
group:
description: Group.
type: str
id:
description: UUID of template param.
type: str
instructionText:
description: Instruction text for param.
type: str
key:
description: Key.
type: str
notParam:
description: Is it not a variable.
type: bool
order:
description: Order of template param.
type: int
paramArray:
description: Is it an array.
type: bool
parameterName:
description: Name of template param.
type: str
provider:
description: Provider.
type: str
range:
description: Configuration Template Project's range.
elements: dict
suboptions:
id:
description: UUID of range.
type: str
maxValue:
description: Max value of range.
type: int
minValue:
description: Min value of range.
type: int
type: list
required:
description: Is param required.
type: bool
selection:
description: Configuration Template Project's selection.
suboptions:
defaultSelectedValues:
description: Default selection values.
elements: str
type: list
id:
description: UUID of selection.
type: str
selectionType:
description: Type of selection(SINGLE_SELECT or MULTI_SELECT).
type: str
selectionValues:
description: Selection values.
type: dict
type: dict
type: list
validationErrors:
description: Configuration Template Project's validationErrors.
suboptions:
rollbackTemplateErrors:
description: Validation or design conflicts errors of rollback template.
elements: dict
type: list
templateErrors:
description: Validation or design conflicts errors.
elements: dict
type: list
templateId:
description: UUID of template.
type: str
templateVersion:
description: Current version of template.
type: str
type: dict
version:
description: Current version of template.
type: str
type: list
requirements:
- dnacentersdk >= 2.4.9
- python >= 3.5
notes:
- SDK Method used are
configuration_templates.ConfigurationTemplates.create_project,
configuration_templates.ConfigurationTemplates.deletes_the_project,
configuration_templates.ConfigurationTemplates.update_project,
- Paths used are
post /dna/intent/api/v1/template-programmer/project,
delete /dna/intent/api/v1/template-programmer/project/{projectId},
put /dna/intent/api/v1/template-programmer/project,
"""
EXAMPLES = r"""
- name: Create
cisco.dnac.configuration_template_project:
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
createTime: 0
description: string
id: string
lastUpdateTime: 0
name: string
tags:
- id: string
name: string
templates:
- 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
- name: Update all
cisco.dnac.configuration_template_project:
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
createTime: 0
description: string
id: string
lastUpdateTime: 0
name: string
tags:
- id: string
name: string
templates:
- 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
- name: Delete by id
cisco.dnac.configuration_template_project:
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
projectId: string
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"response": {
"taskId": "string",
"url": "string"
},
"version": "string"
}
"""