cisco.catalystcenter.network_device_images_validation_results_info module -- Information module for Network Device Images Validation Results

Note

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

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.network_device_images_validation_results_info.

New in cisco.catalystcenter 2.2.0

Synopsis

  • Get all Network Device Images Validation Results.

  • This API provides a comprehensive overview of the outcomes from various tests.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

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

headers

dictionary

Additional headers.

id

string

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

limit

integer

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

integer

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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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 uses the embedded connection manager from Cisco CATALYST SDK

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Software Image Management (SWIM) NetworkDeviceImageUpdateValidationResults

Complete reference of the NetworkDeviceImageUpdateValidationResults API.

Examples

---
- name: Get all Network Device Images Validation Results
  cisco.catalystcenter.network_device_images_validation_results_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    networkDeviceId: string
    id: string
    operationType: string
    status: string
    type: string
    sortBy: string
    order: asc
    limit: 500
    offset: 1
  register: result

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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"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

  • Bryan Vargas (@bvargasre)