cisco.dnac.images_info module – Information module for Images Info
Note
This module is part of the cisco.dnac collection (version 6.27.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.images_info.
New in cisco.dnac 6.15.0
Synopsis
This module represents an alias of the module images_v1_info
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
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: |
|
Golden query parameter. When set to `true`, it will retrieve the images marked as tagged golden. When set to `false`, it will retrieve the images marked as not tagged golden. Choices:
|
|
HasAddonImages query parameter. When set to `true`, it will retrieve the images which have add-on images. When set to `false`, it will retrieve the images which do not have add-on images. Choices:
|
|
Additional headers. |
|
Imported query parameter. When the value is set to `true`, it will include physically imported images. Conversely, when the value is set to `false`, it will include image records from the cloud. The identifier for cloud images can be utilized to download images from Cisco.com to the disk. Choices:
|
|
Integrity query parameter. Filter with verified images using Integrity Verification Available values UNKNOWN, VERIFIED. |
|
IsAddonImages query parameter. When set to `true`, it will retrieve the images that an add-on image. When set to `false`, it will retrieve the images that are not add-on images. Choices:
|
|
Limit query parameter. The number of records to show for this page. The minimum and maximum values are 1 and 500, respectively. |
|
Name query parameter. Filter with software image or add-on name. Supports partial case-insensitive search. A minimum of 3 characters is required for the search. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. The minimum value is 1. |
|
ProductNameOrdinal query parameter. The product name ordinal is a unique value for each network device product. The productNameOrdinal can be obtained from the response of API `/dna/intent/api/v1/siteWiseProductNames`. |
|
SiteId query parameter. Site identifier to get the list of all available products under the site. The default value is the global site. See https //developer.cisco.com/docs/dna-center/get-site for `siteId`. |
|
SupervisorProductNameOrdinal query parameter. The supervisor engine module ordinal is a unique value for each supervisor module. The `supervisorProductNameOrdinal` can be obtained from the response of API `/dna/intent/api/v1/siteWiseProductNames`. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Version query parameter. Filter with image version. Supports partial case-insensitive search. A minimum of 3 characters is required for the search. |
Notes
Note
SDK Method used are software_image_management_swim.SoftwareImageManagementSwim.returns_list_of_software_images_v1,
Paths used are get /dna/intent/api/v1/images,
It should be noted that this module is an alias of images_v1_info
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) ReturnsListOfSoftwareImagesV1
Complete reference of the ReturnsListOfSoftwareImagesV1 API.
Examples
- name: Get all Images Info
cisco.dnac.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}}"
siteId: string
productNameOrdinal: 0
supervisorProductNameOrdinal: 0
imported: True
name: string
version: string
golden: True
integrity: string
hasAddonImages: True
isAddonImages: True
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: |