cisco.dnac.reports_executions_info (6.13.3) — module

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 all Reports Executions.

Get Reports Executions by id.

Get details of all executions for a given report.

Returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response header.

Requirements

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

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

- name: Get all Reports Executions
  cisco.dnac.reports_executions_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}}"
    reportId: string
  register: result

Scanned by Steampunk Spotter

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

- name: Get Reports Executions by id
  cisco.dnac.reports_executions_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}}"
    reportId: string
    executionId: string
  register: result

Inputs

    
dirPath:
    description:
    - Directory absolute path. Defaults to the current working directory.
    type: str

headers:
    description: Additional headers.
    type: dict

filename:
    description:
    - The filename used to save the download file.
    type: str

reportId:
    description:
    - ReportId path parameter. ReportId of report.
    type: str

saveFile:
    description:
    - Enable or disable automatic file creation of raw response.
    type: bool

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

executionId:
    description:
    - ExecutionId path parameter. ExecutionId of report execution.
    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  \"data\": \"filecontent\",\n  \"filename\": \"filename\",\n  \"dirpath\"\
    : \"download/directory\",\n  \"path\": \"download/directory/filename\"\n}\n"
  type: dict

See also

• Cisco DNA Center documentation for Reports DownloadReportContent: Complete reference of the DownloadReportContent API. link
• Cisco DNA Center documentation for Reports GetAllExecutionDetailsForAGivenReport: Complete reference of the GetAllExecutionDetailsForAGivenReport API. link