cisco.dnac.network_device_images_info module – Information module for Network Device Images
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_info.
New in cisco.dnac 6.18.0
Synopsis
Get all Network Device Images. - > This API retrieves information about running images and golden image bundle, if they are available for network devices. It also provides network device update status and image update status related to the golden image bundle and the compatible features supported by the network devices.
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 |
|---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Limit query parameter. The number of records to show for this page. The minimum and maximum values are 1 and 500, respectively. |
|
ManagementAddress query parameter. IP address or DNS name used to access and manage network devices. |
|
NetworkDeviceImageStatus query parameter. Network device image status with respect to golden images. Available values OUTDATED, UP_TO_DATE, UNKNOWN, CONFLICTED, UNSUPPORTED. |
|
NetworkDeviceUpdateStatus query parameter. Network device current update status with respect to golden images. Available values DISTRIBUTION_PENDING, DISTRIBUTION_IN_PROGRESS, DISTRIBUTION_FAILED, ACTIVATION_PENDING, ACTIVATION_IN_PROGRESS, ACTIVATION_FAILED, DEVICE_UP_TO_DATE,UNKNOWN. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. The minimum value is 1. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response. Available values asc, desc. |
|
SortBy query parameter. Sort the response by a specified attribute. Available attributes for sorting are `id`,`networkDeviceUpdateStatus`,`networkDeviceImageStatus`, `goldenImages.name`, `goldenImages.version`, `installedImages.name`, `installedImages.version`. |
|
Flag for Cisco DNA 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_network_devices_with_image_details,
Paths used are get /dna/intent/api/v1/networkDeviceImages,
Supports
check_modeThe 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) GetTheListOfNetworkDevicesWithImageDetails
Complete reference of the GetTheListOfNetworkDevicesWithImageDetails API.
Examples
---
- name: Get all Network Device Images
cisco.dnac.network_device_images_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}}"
managementAddress: string
networkDeviceImageStatus: string
networkDeviceUpdateStatus: string
sortBy: 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 |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |