cisco.dnac.template_deploy – Manage TemplateDeploy objects of ConfigurationTemplates

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Deploys a template.

  • Returns the status of a deployed 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
deployment_id
string
DeploymentId path parameter.
Required for state query.
forcePushTemplate
boolean
    Choices:
  • no
  • yes
TemplateDeploymentInfo's forcePushTemplate.
isComposite
boolean
    Choices:
  • no
  • yes
TemplateDeploymentInfo's isComposite.
mainTemplateId
string
TemplateDeploymentInfo's mainTemplateId.
memberTemplateDeploymentInfo
list / elements=string
TemplateDeploymentInfo's memberTemplateDeploymentInfo (list of any objects).
targetInfo
list / elements=dictionary
TemplateDeploymentInfo's targetInfo (list of objects).
hostName
string
It is the template deploy's hostName.
id
string
It is the template deploy's id.
params
dictionary
It is the template deploy's params.
type
string
It is the template deploy's type.
templateId
string
TemplateDeploymentInfo's templateId.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.template_deploy

The official documentation on the cisco.dnac.plugins.module_utils.definitions.template_deploy module.

TemplateDeploy reference

Complete reference of the TemplateDeploy object model.

TemplateDeploy reference

SDK reference.

Examples

- name: deploy_template
  cisco.dnac.template_deploy:
    state: create  # required
    forcePushTemplate: True  # boolean
    isComposite: True  # boolean
    mainTemplateId: SomeValue  # string
    memberTemplateDeploymentInfo: None
    targetInfo:
    - hostName: SomeValue  # string
      id: SomeValue  # string
      params:
      type: SomeValue  # string
    templateId: SomeValue  # string

- name: get_template_deployment_status
  cisco.dnac.template_deploy:
    state: query  # required
    deployment_id: SomeValue  # string, required
  register: nm_get_template_deployment_status

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 with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
configuration_templates.deploy_template


Authors

  • Rafael Campos (@racampos)