cisco.dnac.network_device_images_validation_results_info module – Information module for Network Device Images Validation Results

Note

This module is part of the cisco.dnac collection (version 6.39.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.network_device_images_validation_results_info.

New in cisco.dnac 6.18.0

Synopsis

  • Get all Network Device Images Validation Results. - > This API provides a comprehensive overview of the outcomes from various tests and assessments defined by system and custom validations related to network device images. These results are essential for identifying potential issues, verifying configurations, and ensuring that the network meets the requirement for image update.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.10.1

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

headers

dictionary

Additional headers.

id

string

Id query parameter. Unique identifier of network device validation task.

limit

float

Limit query parameter. The number of records to show for this page. The minimum and maximum values are 1 and 500, respectively.

networkDeviceId

string

NetworkDeviceId query parameter. Network device identifier.

offset

float

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

operationType

string

OperationType query parameter. The operation type, as part of which this validation will get triggered. Available values DISTRIBUTION, ACTIVATION, READINESS_CHECK.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response. Available values asc, desc.

sortBy

string

SortBy query parameter. A property within the response to sort by.

status

string

Status query parameter. Status of the validation result. SUCCESS, FAILED, IN_PROGRESS, WARNING.

type

string

Type query parameter. Type of the validation. Available values PRE_VALIDATION, POST_VALIDATION.

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 software_image_management_swim.SoftwareImageManagementSwim.network_device_image_update_validation_results,

  • Paths used are get /dna/intent/api/v1/networkDeviceImages/validationResults,

  • 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 Software Image Management (SWIM) NetworkDeviceImageUpdateValidationResults

Complete reference of the NetworkDeviceImageUpdateValidationResults API.

Examples

---
- name: Get all Network Device Images Validation Results
  cisco.dnac.network_device_images_validation_results_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}}"
    networkDeviceId: string
    id: string
    operationType: string
    status: string
    type: string
    sortBy: string
    order: string
    limit: 0
    offset: 0
  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": [{"endTime": 0, "id": "string", "name": "string", "networkDeviceId": "string", "operationType": "string", "parentId": "string", "resultDetails": {"key": "string", "value": "string"}, "startTime": 0, "status": "string", "type": "string"}], "version": "string"}

Authors

  • Rafael Campos (@racampos)