.. Document meta
:orphan:
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
.. role:: ansible-attribute-support-label
.. role:: ansible-attribute-support-property
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. Anchors
.. _ansible_collections.cisco.dnac.configuration_template_deploy_v2_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.configuration_template_deploy_v2 -- Resource module for Configuration Template Deploy V2
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 3.2.0).
To install it use: :code:`ansible-galaxy collection install cisco.dnac`.
To use it in a playbook, specify: :code:`cisco.dnac.configuration_template_deploy_v2`.
.. version_added
.. versionadded:: 3.1.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Manage operation create of the resource Configuration Template Deploy V2.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk >= 2.3.1
- python >= 3.5
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="2">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div>
<b>dnac_debug</b>
<a class="ansibleOptionLink" href="#parameter-dnac_debug" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b> ←</div></li>
<li>yes</li>
</ul>
</td>
<td>
<div>Flag for Cisco DNA Center SDK to enable debugging.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-dnac_host"></div>
<b>dnac_host</b>
<a class="ansibleOptionLink" href="#parameter-dnac_host" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
/ <span style="color: red">required</span> </div>
</td>
<td>
</td>
<td>
<div>The Cisco DNA Center hostname.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-dnac_password"></div>
<b>dnac_password</b>
<a class="ansibleOptionLink" href="#parameter-dnac_password" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>The Cisco DNA Center password to authenticate.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-dnac_port"></div>
<b>dnac_port</b>
<a class="ansibleOptionLink" href="#parameter-dnac_port" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">443</div>
</td>
<td>
<div>The Cisco DNA Center port.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-dnac_username"></div>
<b>dnac_username</b>
<a class="ansibleOptionLink" href="#parameter-dnac_username" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"admin"</div>
</td>
<td>
<div>The Cisco DNA Center username to authenticate.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: user</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div>
<b>dnac_verify</b>
<a class="ansibleOptionLink" href="#parameter-dnac_verify" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li><div style="color: blue"><b>yes</b> ←</div></li>
</ul>
</td>
<td>
<div>Flag to enable or disable SSL certificate verification.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-dnac_version"></div>
<b>dnac_version</b>
<a class="ansibleOptionLink" href="#parameter-dnac_version" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"2.2.2.3"</div>
</td>
<td>
<div>Informs the SDK which version of Cisco DNA Center to use.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-forcePushTemplate"></div>
<b>forcePushTemplate</b>
<a class="ansibleOptionLink" href="#parameter-forcePushTemplate" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>ForcePushTemplate flag.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-isComposite"></div>
<b>isComposite</b>
<a class="ansibleOptionLink" href="#parameter-isComposite" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Composite template flag.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-mainTemplateId"></div>
<b>mainTemplateId</b>
<a class="ansibleOptionLink" href="#parameter-mainTemplateId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Main template UUID of versioned template.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-memberTemplateDeploymentInfo"></div>
<b>memberTemplateDeploymentInfo</b>
<a class="ansibleOptionLink" href="#parameter-memberTemplateDeploymentInfo" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>MemberTemplateDeploymentInfo.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-targetInfo"></div>
<b>targetInfo</b>
<a class="ansibleOptionLink" href="#parameter-targetInfo" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Configuration Template Deploy V2's targetInfo.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-targetInfo/hostName"></div>
<b>hostName</b>
<a class="ansibleOptionLink" href="#parameter-targetInfo/hostName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Hostname of device is required if targetType is MANAGED_DEVICE_HOSTNAME.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-targetInfo/id"></div>
<b>id</b>
<a class="ansibleOptionLink" href="#parameter-targetInfo/id" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>UUID of target is required if targetType is MANAGED_DEVICE_UUID.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-targetInfo/params"></div>
<b>params</b>
<a class="ansibleOptionLink" href="#parameter-targetInfo/params" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Template params/values to be provisioned.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-targetInfo/resourceParams"></div>
<b>resourceParams</b>
<a class="ansibleOptionLink" href="#parameter-targetInfo/resourceParams" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Resource params to be provisioned.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-targetInfo/type"></div>
<b>type</b>
<a class="ansibleOptionLink" href="#parameter-targetInfo/type" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Target type of device.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-targetInfo/versionedTemplateId"></div>
<b>versionedTemplateId</b>
<a class="ansibleOptionLink" href="#parameter-targetInfo/versionedTemplateId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Versioned templateUUID to be provisioned.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-templateId"></div>
<b>templateId</b>
<a class="ansibleOptionLink" href="#parameter-templateId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>UUID of template to be provisioned.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div>
<b>validate_response_schema</b>
<a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li><div style="color: blue"><b>yes</b> ←</div></li>
</ul>
</td>
<td>
<div>Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.</div>
</td>
</tr>
</table>
<br/>
.. Attributes
.. Notes
Notes
-----
.. note::
- Does not support ``check_mode``
.. Seealso
See Also
--------
.. seealso::
`Configuration Template Deploy V2 reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the Configuration Template Deploy V2 object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- 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: []
targetInfo:
- hostName: string
id: string
params: {}
resourceParams: {}
type: string
versionedTemplateId: string
templateId: string
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{
"response": {
"taskId": "string",
"url": "string"
},
"version": "string"
}</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors