racampos.dnac.template_deploy (0.0.1) — module

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1

Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

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: query_result

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

deploy_template:
  contains: null
  deploymentId:
    description: TemplateDeploymentInfo's deploymentId.
    returned: success
    sample: <deploymentid>
    type: str
  deploymentName:
    description: TemplateDeploymentInfo's deploymentName.
    returned: success
    sample: <deploymentname>
    type: str
  description: Deploys a template.
  devices:
    contains:
      deviceId:
        description: It is the template deploy's deviceId.
        returned: success
        sample: <deviceid>
        type: str
      duration:
        description: It is the template deploy's duration.
        returned: success
        sample: <duration>
        type: str
      endTime:
        description: It is the template deploy's endTime.
        returned: success
        sample: <endtime>
        type: str
      ipAddress:
        description: It is the template deploy's ipAddress.
        returned: success
        sample: <ipaddress>
        type: str
      name:
        description: It is the template deploy's name.
        returned: success
        sample: <name>
        type: str
      startTime:
        description: It is the template deploy's startTime.
        returned: success
        sample: <starttime>
        type: str
      status:
        description: It is the template deploy's status.
        returned: success
        sample: <status>
        type: str
    description: TemplateDeploymentInfo's devices (list of objects).
    returned: success
    type: list
  duration:
    description: TemplateDeploymentInfo's duration.
    returned: success
    sample: <duration>
    type: str
  endTime:
    description: TemplateDeploymentInfo's endTime.
    returned: success
    sample: <endtime>
    type: str
  projectName:
    description: TemplateDeploymentInfo's projectName.
    returned: success
    sample: <projectname>
    type: str
  returned: success
  startTime:
    description: TemplateDeploymentInfo's startTime.
    returned: success
    sample: <starttime>
    type: str
  status:
    description: TemplateDeploymentInfo's status.
    returned: success
    sample: <status>
    type: str
  templateName:
    description: TemplateDeploymentInfo's templateName.
    returned: success
    sample: <templatename>
    type: str
  templateVersion:
    description: TemplateDeploymentInfo's templateVersion.
    returned: success
    sample: <templateversion>
    type: str
  type: dict
get_template_deployment_status:
  contains: null
  deploymentId:
    description: DeploymentId, property of the response body.
    returned: always
    sample: <deploymentid>
    type: str
  deploymentName:
    description: DeploymentName, property of the response body.
    returned: always
    sample: <deploymentname>
    type: str
  description: Returns the status of a deployed template.
  devices:
    contains:
      deviceId:
        description: It is the template deploy's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      duration:
        description: It is the template deploy's duration.
        returned: always
        sample: <duration>
        type: str
      endTime:
        description: It is the template deploy's endTime.
        returned: always
        sample: <endtime>
        type: str
      ipAddress:
        description: It is the template deploy's ipAddress.
        returned: always
        sample: <ipaddress>
        type: str
      name:
        description: It is the template deploy's name.
        returned: always
        sample: <name>
        type: str
      startTime:
        description: It is the template deploy's startTime.
        returned: always
        sample: <starttime>
        type: str
      status:
        description: It is the template deploy's status.
        returned: always
        sample: <status>
        type: str
    description: Devices, property of the response body (list of objects).
    returned: always
    type: list
  duration:
    description: Duration, property of the response body.
    returned: always
    sample: <duration>
    type: str
  endTime:
    description: EndTime, property of the response body.
    returned: always
    sample: <endtime>
    type: str
  projectName:
    description: ProjectName, property of the response body.
    returned: always
    sample: <projectname>
    type: str
  returned: always
  startTime:
    description: StartTime, property of the response body.
    returned: always
    sample: <starttime>
    type: str
  status:
    description: Status, property of the response body.
    returned: always
    sample: <status>
    type: str
  templateName:
    description: TemplateName, property of the response body.
    returned: always
    sample: <templatename>
    type: str
  templateVersion:
    description: TemplateVersion, property of the response body.
    returned: always
    sample: <templateversion>
    type: str
  type: dict

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