/ home / cisco / cisco.dnac / 6.13.3 / module / task_operation_info

cisco.dnac.task_operation_info (6.13.3) — module

Information module for Task Operation

| "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

Get Task Operation by id.

Returns root tasks associated with an Operationid.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get Task Operation by id
  cisco.dnac.task_operation_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    operationId: string
    offset: 0
    limit: 0
  register: result

Inputs

    
limit:
    description:
    - 'Limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing
      for {limit}, minimum value is 1.

      '
    type: int

offset:
    description:
    - Offset path parameter. Index, minimum value is 0.
    type: int

headers:
    description: Additional headers.
    type: dict

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

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

operationId:
    description:
    - OperationId path parameter.
    type: str

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

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

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": [\n    {\n      \"additionalStatusURL\": \"string\"\
    ,\n      \"data\": \"string\",\n      \"endTime\": \"string\",\n      \"errorCode\"\
    : \"string\",\n      \"errorKey\": \"string\",\n      \"failureReason\": \"string\"\
    ,\n      \"id\": \"string\",\n      \"instanceTenantId\": \"string\",\n      \"\
    isError\": true,\n      \"lastUpdate\": \"string\",\n      \"operationIdList\"\
    : {},\n      \"parentId\": \"string\",\n      \"progress\": \"string\",\n    \
    \  \"rootId\": \"string\",\n      \"serviceType\": \"string\",\n      \"startTime\"\
    : \"string\",\n      \"username\": \"string\",\n      \"version\": 0\n    }\n\
    \  ],\n  \"version\": \"string\"\n}\n"
  type: dict