cisco.catalystcenter.network_device_images_validations_info module -- Information module for Network Device Images Validations

Note

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

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

New in cisco.catalystcenter 6.18.0

Synopsis

  • Get all Network Device Images Validations. - > Fetches custom network device validations that run on the network device as part of the update workflow. This process verifies and assesses the configuration of the network devices.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

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

headers

dictionary

Additional headers.

limit

float

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

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.

order

string

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

productSeriesOrdinal

float

ProductSeriesOrdinal query parameter. Unique identifier of product series.

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.get_the_list_of_custom_network_device_validations,

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

  • 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

See Also

See also

Cisco DNA Center documentation for Software Image Management (SWIM) GetTheListOfCustomNetworkDeviceValidations

Complete reference of the GetTheListOfCustomNetworkDeviceValidations API.

Examples

---
- name: Get all Network Device Images Validations
  cisco.catalystcenter.network_device_images_validations_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    productSeriesOrdinal: 0
    operationType: string
    type: string
    order: string
    offset: 0
    limit: 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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"category": "string", "cli": "string", "description": "string", "id": "string", "name": "string", "operationType": "string", "productSeriesOrdinals": [0], "type": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)