cisco.dnac.template_deploy (2.0.7) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Deploys a template.

Returns the status of a deployed template.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
targetInfo:
    description:
    - TemplateDeploymentInfo's targetInfo (list of objects).
    elements: dict
    suboptions:
      hostName:
        description:
        - It is the template deploy's hostName.
        type: str
      id:
        description:
        - It is the template deploy's id.
        type: str
      params:
        description:
        - It is the template deploy's params.
        type: dict
      type:
        description:
        - It is the template deploy's type.
        type: str
    type: list

templateId:
    description:
    - TemplateDeploymentInfo's templateId.
    type: str

isComposite:
    description:
    - TemplateDeploymentInfo's isComposite.
    type: bool

deployment_id:
    description:
    - DeploymentId path parameter.
    - Required for state query.
    type: str

mainTemplateId:
    description:
    - TemplateDeploymentInfo's mainTemplateId.
    type: str

forcePushTemplate:
    description:
    - TemplateDeploymentInfo's forcePushTemplate.
    type: bool

memberTemplateDeploymentInfo:
    description:
    - TemplateDeploymentInfo's memberTemplateDeploymentInfo (list of any objects).
    type: list

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: configuration_templates.deploy_template
  type: str

See also

• cisco.dnac.plugins.module_utils.definitions.template_deploy
• TemplateDeploy reference: Complete reference of the TemplateDeploy object model. link
• TemplateDeploy reference: SDK reference. link