cisco.dnac.configuration_template – Resource module for Configuration Template

Note

This plugin is part of the cisco.dnac collection (version 3.0.0).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.configuration_template.

New in version 1.0.0: of cisco.dnac

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter			Choices/Defaults	Comments
author string				Configuration Template's author.
composite boolean			Choices: no yes	Composite flag.
containingTemplates list / elements=string				Configuration Template's containingTemplates.
	composite boolean		Choices: no yes	Composite flag.
	id string			Configuration Template's id.
	name string			Configuration Template's name.
	version string			Configuration Template's version.
createTime integer				Configuration Template's createTime.
description string				Configuration Template's description.
deviceTypes list / elements=string				Configuration Template's deviceTypes.
	productFamily string			Configuration Template's productFamily.
	productSeries string			Configuration Template's productSeries.
	productType string			Configuration Template's productType.
failurePolicy string				Configuration Template's failurePolicy.
id string				Configuration Template's id.
lastUpdateTime integer				Configuration Template's lastUpdateTime.
name string				Configuration Template's name.
parentTemplateId string				Configuration Template's parentTemplateId.
projectId string				Configuration Template's projectId.
projectName string				Configuration Template's projectName.
rollbackTemplateContent string				Configuration Template's rollbackTemplateContent.
rollbackTemplateParams list / elements=string				Configuration Template's rollbackTemplateParams.
	binding string			Configuration Template's binding.
	dataType string			Configuration Template's dataType.
	defaultValue string			Configuration Template's defaultValue.
	description string			Configuration Template's description.
	displayName string			Configuration Template's displayName.
	group string			Configuration Template's group.
	id string			Configuration Template's id.
	instructionText string			Configuration Template's instructionText.
	key string			Configuration Template's key.
	notParam boolean		Choices: no yes	NotParam flag.
	order integer			Configuration Template's order.
	paramArray boolean		Choices: no yes	ParamArray flag.
	parameterName string			Configuration Template's parameterName.
	provider string			Configuration Template's provider.
	range list / elements=string			Configuration Template's range.
		id string		Configuration Template's id.
		maxValue integer		Configuration Template's maxValue.
		minValue integer		Configuration Template's minValue.
	required boolean		Choices: no yes	Required flag.
	selection dictionary			Configuration Template's selection.
		id string		Configuration Template's id.
		selectionType string		Configuration Template's selectionType.
		selectionValues dictionary		Configuration Template's selectionValues.
softwareType string				Configuration Template's softwareType.
softwareVariant string				Configuration Template's softwareVariant.
softwareVersion string				Configuration Template's softwareVersion.
tags list / elements=string				Configuration Template's tags.
templateContent string				Configuration Template's templateContent.
templateId string				TemplateId path parameter.
templateParams list / elements=string				Configuration Template's templateParams.
	binding string			Configuration Template's binding.
	dataType string			Configuration Template's dataType.
	defaultValue string			Configuration Template's defaultValue.
	description string			Configuration Template's description.
	displayName string			Configuration Template's displayName.
	group string			Configuration Template's group.
	id string			Configuration Template's id.
	instructionText string			Configuration Template's instructionText.
	key string			Configuration Template's key.
	notParam boolean		Choices: no yes	NotParam flag.
	order integer			Configuration Template's order.
	paramArray boolean		Choices: no yes	ParamArray flag.
	parameterName string			Configuration Template's parameterName.
	provider string			Configuration Template's provider.
	range list / elements=string			Configuration Template's range.
		id string		Configuration Template's id.
		maxValue integer		Configuration Template's maxValue.
		minValue integer		Configuration Template's minValue.
	required boolean		Choices: no yes	Required flag.
	selection dictionary			Configuration Template's selection.
		id string		Configuration Template's id.
		selectionType string		Configuration Template's selectionType.
		selectionValues dictionary		Configuration Template's selectionValues.
version string				Configuration Template's version.

See Also

See also

Configuration Template reference

Complete reference of the Configuration Template object model.

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
      id: string
      name: string
      version: string
    createTime: 0
    description: string
    deviceTypes:
    - productFamily: string
      productSeries: string
      productType: string
    failurePolicy: string
    id: string
    lastUpdateTime: 0
    name: string
    parentTemplateId: string
    projectId: string
    projectName: string
    rollbackTemplateContent: string
    rollbackTemplateParams:
    - binding: string
      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:
        id: string
        selectionType: string
        selectionValues: {}
    softwareType: string
    softwareVariant: string
    softwareVersion: string
    tags:
    - string
    templateContent: string
    templateParams:
    - binding: string
      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:
        id: string
        selectionType: string
        selectionValues: {}
    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	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "response": { "taskId": {}, "url": "string" }, "version": "string" }

Authors

• Rafael Campos (@racampos)