cisco.dnac.configuration_template_deploy_v2 module – Resource module for Configuration Template Deploy V2

Note

This module is part of the cisco.dnac collection (version 6.7.2).

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

New in cisco.dnac 3.1.0

Synopsis

  • Manage operation create of the resource Configuration Template Deploy V2.

  • V2 API to deploy 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.5.5

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.5.3"

forcePushTemplate

boolean

ForcePushTemplate flag.

Choices:

  • false

  • true

isComposite

boolean

Composite template flag.

Choices:

  • false

  • true

mainTemplateId

string

Main template UUID of versioned template.

memberTemplateDeploymentInfo

string

MemberTemplateDeploymentInfo.

targetInfo

list / elements=dictionary

Configuration Template Deploy V2’s targetInfo.

hostName

string

Hostname of device is required if targetType is MANAGED_DEVICE_HOSTNAME.

id

string

UUID of target is required if targetType is MANAGED_DEVICE_UUID.

params

dictionary

Template params/values to be provisioned.

resourceParams

dictionary

Resource params to be provisioned.

type

string

Target type of device.

versionedTemplateId

string

Versioned templateUUID to be provisioned.

templateId

string

UUID of template to be provisioned.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are configuration_templates.ConfigurationTemplates.deploy_template_v2,

  • Paths used are post /dna/intent/api/v2/template-programmer/template/deploy,

  • 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 DeployTemplateV2

Complete reference of the DeployTemplateV2 API.

Examples

- name: Create
  cisco.dnac.configuration_template_deploy_v2:
    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}}"
    forcePushTemplate: true
    isComposite: true
    mainTemplateId: string
    memberTemplateDeploymentInfo: string
    targetInfo:
    - hostName: string
      id: string
      params: {}
      resourceParams: {}
      type: string
      versionedTemplateId: string
    templateId: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)