cisco.catalystcenter.diagnostic_validation_workflows module -- Resource module for Diagnostic Validation Workflows

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

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

To use it in a playbook, specify: cisco.catalystcenter.diagnostic_validation_workflows.

New in cisco.catalystcenter 6.15.0

Synopsis

  • This module represents an alias of the module diagnostic_validation_workflows_v1

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

Default: :ansible-option-default:`443`

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

Default: :ansible-option-default:`"admin"`

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

description

string

Description of the workflow to run.

id

string

Id path parameter. Workflow id.

name

string

Name of the workflow to run. It must be unique.

validate_response_schema

boolean

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

Choices:

validationSetIds

list / elements=string

List of validation set ids.

Notes

Note

  • SDK Method used are health_and_performance.HealthAndPerformance.deletes_a_validation_workflow_v1, health_and_performance.HealthAndPerformance.submits_the_workflow_for_executing_validations_v1,

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

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

  • Does not support 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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Health and Performance SubmitsTheWorkflowForExecutingValidationsV1

Complete reference of the SubmitsTheWorkflowForExecutingValidationsV1 API.

Cisco DNA Center documentation for Health and Performance DeletesAValidationWorkflowV1

Complete reference of the DeletesAValidationWorkflowV1 API.

Examples

- name: Create
  cisco.catalystcenter.diagnostic_validation_workflows:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    description: string
    name: string
    validationSetIds:
      - string
- name: Delete by id
  cisco.catalystcenter.diagnostic_validation_workflows:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    id: string

Return Values

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

Key

Description

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"id": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)