cisco.dnac.configuration_template_project – Resource module for Configuration Template Project

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create, update and delete of the resource Configuration Template Project.

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
createTime integer						Create time of project.
description string						Description of project.
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.
id string						UUID of project.
lastUpdateTime integer						Update time of project.
name string						Name of project.
projectId string						ProjectId path parameter. ProjectId(UUID) of project to be deleted.
tags list / elements=string						Configuration Template Project's tags.
	id string					UUID of tag.
	name string					Name of tag.
templates list / elements=string						List of templates within the project.
	author string					Author of template.
	composite boolean				Choices: no yes	Is it composite template.
	containingTemplates list / elements=string					Configuration Template Project's containingTemplates.
		composite boolean			Choices: no yes	Is it composite template.
		description string				Description of template.
		deviceTypes list / elements=string				Configuration Template Project's deviceTypes.
			productFamily string			Device family.
			productSeries string			Device series.
			productType string			Device type.
		id string				UUID of template.
		language string				Template language (JINJA or VELOCITY).
		name string				Name of template.
		projectName string				Project name.
		rollbackTemplateParams list / elements=string				Configuration Template Project's rollbackTemplateParams.
			binding string			Bind to source.
			customOrder integer			CustomOrder of template param.
			dataType string			Datatype of template param.
			defaultValue string			Default value of template param.
			description string			Description of template param.
			displayName string			Display name of param.
			group string			Group.
			id string			UUID of template param.
			instructionText string			Instruction text for param.
			key string			Key.
			notParam boolean		Choices: no yes	Is it not a variable.
			order integer			Order of template param.
			paramArray boolean		Choices: no yes	Is it an array.
			parameterName string			Name of template param.
			provider string			Provider.
			range list / elements=string			Configuration Template Project's range.
				id string		UUID of range.
				maxValue integer		Max value of range.
				minValue integer		Min value of range.
			required boolean		Choices: no yes	Is param required.
			selection dictionary			Configuration Template Project's selection.
				defaultSelectedValues list / elements=string		Default selection values.
				id string		UUID of selection.
				selectionType string		Type of selection(SINGLE_SELECT or MULTI_SELECT).
				selectionValues dictionary		Selection values.
		tags list / elements=string				Configuration Template Project's tags.
			id string			UUID of tag.
			name string			Name of tag.
		templateContent string				Template content.
		templateParams list / elements=string				Configuration Template Project's templateParams.
			binding string			Bind to source.
			customOrder integer			CustomOrder of template param.
			dataType string			Datatype of template param.
			defaultValue string			Default value of template param.
			description string			Description of template param.
			displayName string			Display name of param.
			group string			Group.
			id string			UUID of template param.
			instructionText string			Instruction text for param.
			key string			Key.
			notParam boolean		Choices: no yes	Is it not a variable.
			order integer			Order of template param.
			paramArray boolean		Choices: no yes	Is it an array.
			parameterName string			Name of template param.
			provider string			Provider.
			range list / elements=string			Configuration Template Project's range.
				id string		UUID of range.
				maxValue integer		Max value of range.
				minValue integer		Min value of range.
			required boolean		Choices: no yes	Is param required.
			selection dictionary			Configuration Template Project's selection.
				defaultSelectedValues list / elements=string		Default selection values.
				id string		UUID of selection.
				selectionType string		Type of selection(SINGLE_SELECT or MULTI_SELECT).
				selectionValues dictionary		Selection values.
		version string				Current version of template.
	createTime integer					Create time of template.
	customParamsOrder boolean				Choices: no yes	Custom Params Order.
	description string					Description of template.
	deviceTypes list / elements=string					Configuration Template Project's deviceTypes.
		productFamily string				Device family.
		productSeries string				Device series.
		productType string				Device type.
	documentDatabase boolean				Choices: no yes	Document Database.
	failurePolicy string					Define failure policy if template provisioning fails.
	id string					UUID of template.
	language string					Template language (JINJA or VELOCITY).
	lastUpdateTime integer					Update time of template.
	latestVersionTime integer					Latest versioned template time.
	name string					Name of template.
	parentTemplateId string					Parent templateID.
	projectAssociated boolean				Choices: no yes	Project Associated.
	projectId string					Project UUID.
	projectName string					Project name.
	rollbackTemplateContent string					Rollback template content.
	rollbackTemplateParams list / elements=string					Configuration Template Project's rollbackTemplateParams.
		binding string				Bind to source.
		customOrder integer				CustomOrder of template param.
		dataType string				Datatype of template param.
		defaultValue string				Default value of template param.
		description string				Description of template param.
		displayName string				Display name of param.
		group string				Group.
		id string				UUID of template param.
		instructionText string				Instruction text for param.
		key string				Key.
		notParam boolean			Choices: no yes	Is it not a variable.
		order integer				Order of template param.
		paramArray boolean			Choices: no yes	Is it an array.
		parameterName string				Name of template param.
		provider string				Provider.
		range list / elements=string				Configuration Template Project's range.
			id string			UUID of range.
			maxValue integer			Max value of range.
			minValue integer			Min value of range.
		required boolean			Choices: no yes	Is param required.
		selection dictionary				Configuration Template Project's selection.
			defaultSelectedValues list / elements=string			Default selection values.
			id string			UUID of selection.
			selectionType string			Type of selection(SINGLE_SELECT or MULTI_SELECT).
			selectionValues dictionary			Selection values.
	softwareType string					Applicable device software type.
	softwareVariant string					Applicable device software variant.
	softwareVersion string					Applicable device software version.
	tags list / elements=string					Configuration Template Project's tags.
		id string				UUID of tag.
		name string				Name of tag.
	templateContent string					Template content.
	templateParams list / elements=string					Configuration Template Project's templateParams.
		binding string				Bind to source.
		customOrder integer				CustomOrder of template param.
		dataType string				Datatype of template param.
		defaultValue string				Default value of template param.
		description string				Description of template param.
		displayName string				Display name of param.
		group string				Group.
		id string				UUID of template param.
		instructionText string				Instruction text for param.
		key string				Key.
		notParam boolean			Choices: no yes	Is it not a variable.
		order integer				Order of template param.
		paramArray boolean			Choices: no yes	Is it an array.
		parameterName string				Name of template param.
		provider string				Provider.
		range list / elements=string				Configuration Template Project's range.
			id string			UUID of range.
			maxValue integer			Max value of range.
			minValue integer			Min value of range.
		required boolean			Choices: no yes	Is param required.
		selection dictionary				Configuration Template Project's selection.
			defaultSelectedValues list / elements=string			Default selection values.
			id string			UUID of selection.
			selectionType string			Type of selection(SINGLE_SELECT or MULTI_SELECT).
			selectionValues dictionary			Selection values.
	validationErrors dictionary					Configuration Template Project's validationErrors.
		rollbackTemplateErrors list / elements=dictionary				Validation or design conflicts errors of rollback template.
		templateErrors list / elements=dictionary				Validation or design conflicts errors.
		templateId string				UUID of template.
		templateVersion string				Current version of template.
	version string					Current version of template.
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

• 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

Configuration Template Project reference

Complete reference of the Configuration Template Project object model.

Examples

- 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 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: { "response": { "taskId": "string", "url": "string" }, "version": "string" }

Authors

• Rafael Campos (@racampos)