cisco.dnac.diagnostic_validation_workflows_info module – Information module for Diagnostic Validation Workflows Info

Note

This module is part of the cisco.dnac collection (version 6.25.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.15.0

Synopsis

  • This module represents an alias of the module diagnostic_validation_workflows_v1_info

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

endTime

float

EndTime query parameter. Workflows started before the given time (as milliseconds since UNIX epoch).

headers

dictionary

Additional headers.

id

string

Id path parameter. Workflow id.

limit

float

Limit query parameter. The number of records to show for this page.

offset

float

Offset query parameter. The first record to show for this page; the first record is numbered 1.

runStatus

string

RunStatus query parameter. Execution status of the workflow. If the workflow is successfully submitted, runStatus is `PENDING`. If the workflow execution has started, runStatus is `IN_PROGRESS`. If the workflow executed is completed with all validations executed, runStatus is `COMPLETED`. If the workflow execution fails while running validations, runStatus is `FAILED`.

startTime

float

StartTime query parameter. Workflows started after the given time (as milliseconds since UNIX epoch).

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are health_and_performance.HealthAndPerformance.retrieves_the_list_of_validation_workflows_v1, health_and_performance.HealthAndPerformance.retrieves_validation_workflow_details_v1,

  • Paths used are get /dna/intent/api/v1/diagnosticValidationWorkflows, get /dna/intent/api/v1/diagnosticValidationWorkflows/{id},

  • It should be noted that this module is an alias of diagnostic_validation_workflows_v1_info

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Health and Performance RetrievesTheListOfValidationWorkflowsV1

Complete reference of the RetrievesTheListOfValidationWorkflowsV1 API.

Cisco DNA Center documentation for Health and Performance RetrievesValidationWorkflowDetailsV1

Complete reference of the RetrievesValidationWorkflowDetailsV1 API.

Examples

- name: Get all Diagnostic Validation Workflows Info
  cisco.dnac.diagnostic_validation_workflows_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}}"
    startTime: 0
    endTime: 0
    runStatus: string
    offset: 0
    limit: 0
  register: result

- name: Get Diagnostic Validation Workflows Info by id
  cisco.dnac.diagnostic_validation_workflows_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}}"
    id: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": {"description": "string", "id": "string", "name": "string", "releaseVersion": "string", "runStatus": "string", "submitTime": 0, "validationSetIds": ["string"], "validationSetsRunDetails": [{"endTime": 0, "startTime": 0, "validationRunDetails": [{"validationId": "string", "validationMessage": "string", "validationName": "string", "validationStatus": "string"}], "validationSetId": "string", "validationStatus": "string", "version": "string"}], "validationStatus": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)