/ home / cisco / cisco.dnac / 6.13.3 / module / configuration_template_deploy

cisco.dnac.configuration_template_deploy (6.13.3) — module

Resource module for Configuration Template Deploy

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Manage operation create of the resource Configuration Template Deploy.

API to deploy a template.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Create
  cisco.dnac.configuration_template_deploy:
    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

Inputs

    
dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

targetInfo:
    description: Configuration Template Deploy's targetInfo.
    elements: dict
    suboptions:
      hostName:
        description: Hostname of device is required if targetType is MANAGED_DEVICE_HOSTNAME.
        type: str
      id:
        description: UUID of target is required if targetType is MANAGED_DEVICE_UUID.
        type: str
      params:
        description: Template params/values to be provisioned.
        type: dict
      resourceParams:
        description: Resource params to be provisioned.
        type: dict
      type:
        description: Target type of device.
        type: str
      versionedTemplateId:
        description: Versioned templateUUID to be provisioned.
        type: str
    type: list

templateId:
    description: UUID of template to be provisioned.
    type: str

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

isComposite:
    description: Composite template flag.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

mainTemplateId:
    description: Main template UUID of versioned template.
    type: str

forcePushTemplate:
    description: ForcePushTemplate flag.
    type: bool

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

memberTemplateDeploymentInfo:
    description: MemberTemplateDeploymentInfo.
    type: str

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"deploymentId\": \"string\",\n  \"deploymentName\": \"string\",\n\
    \  \"devices\": [\n    {\n      \"detailedStatusMessage\": \"string\",\n     \
    \ \"deviceId\": \"string\",\n      \"duration\": \"string\",\n      \"endTime\"\
    : \"string\",\n      \"identifier\": \"string\",\n      \"ipAddress\": \"string\"\
    ,\n      \"name\": \"string\",\n      \"startTime\": \"string\",\n      \"status\"\
    : \"string\",\n      \"targetType\": \"string\"\n    }\n  ],\n  \"duration\":\
    \ \"string\",\n  \"endTime\": \"string\",\n  \"projectName\": \"string\",\n  \"\
    startTime\": \"string\",\n  \"status\": \"string\",\n  \"statusMessage\": \"string\"\
    ,\n  \"templateName\": \"string\",\n  \"templateVersion\": \"string\"\n}\n"
  type: dict