cisco.dnac.network_device_images_validations_id module – Resource module for Network Device Images Validations Id

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

New in cisco.dnac 6.18.0

Synopsis

  • Manage operations update and delete of the resource Network Device Images Validations Id.

  • Delete the custom network device validation.

  • Update the custom network device validation details.

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

cli

string

Edit the Command line interface (CLI). Validate the CLI - Cisco DevNet https //developer.cisco.com/docs/dna-center/2-3-7/run-read-only-commands-on-devices-to-get-their-real-time-co…

description

string

Details of the network device validation.

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"

id

string

Id path parameter. Unique identifier of network device validation.

productSeriesOrdinals

list / elements=float

The custom check will be mapped to the product series and devices that belong to this series. These devices will consume this check when triggered.

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

  • Paths used are delete /dna/intent/api/v1/networkDeviceImages/validations/{id}, put /dna/intent/api/v1/networkDeviceImages/validations/{id},

  • 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 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) DeleteCustomNetworkDeviceValidation

Complete reference of the DeleteCustomNetworkDeviceValidation API.

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

Complete reference of the UpdateCustomNetworkDeviceValidation API.

Examples

---
- name: Update by id
  cisco.dnac.network_device_images_validations_id:
    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}}"
    state: present
    cli: string
    description: string
    id: string
    productSeriesOrdinals:
      - 0
- name: Delete by id
  cisco.dnac.network_device_images_validations_id:
    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}}"
    state: absent
    id: string

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": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)