cisco.dnac.swim_image_details_info module – Information module for Swim Image Details
Note
This module is part of the cisco.dnac collection (version 6.13.3).
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.swim_image_details_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Swim Image Details.
Returns software image list based on a filter criteria. For example “filterbyName = cat3k%”.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.6.0
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
ApplicationType query parameter. |
|
CreatedTime query parameter. Time in milliseconds (epoch format). |
|
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: |
|
Family query parameter. |
|
Additional headers. |
|
ImageIntegrityStatus query parameter. ImageIntegrityStatus - FAILURE, UNKNOWN, VERIFIED. |
|
ImageName query parameter. Image Name. |
|
ImageSeries query parameter. Image Series. |
|
ImageSizeGreaterThan query parameter. Size in bytes. |
|
ImageSizeLesserThan query parameter. Size in bytes. |
|
ImageUuid query parameter. |
|
IsCCOLatest query parameter. Is latest from cisco.com. Choices:
|
|
IsCCORecommended query parameter. Is recommended from cisco.com. Choices:
|
|
IsTaggedGolden query parameter. Is Tagged Golden. Choices:
|
|
Limit query parameter. |
|
Name query parameter. |
|
Offset query parameter. |
|
SortBy query parameter. Sort results by this field. |
|
SortOrder query parameter. Sort order - ‘asc’ or ‘des’. Default is asc. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Version query parameter. Software Image Version. |
Notes
Note
SDK Method used are software_image_management_swim.SoftwareImageManagementSwim.get_software_image_details,
Paths used are get /dna/intent/api/v1/image/importation,
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) GetSoftwareImageDetails
Complete reference of the GetSoftwareImageDetails API.
Examples
- name: Get all Swim Image Details
cisco.dnac.swim_image_details_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}}"
imageUuid: string
name: string
family: string
applicationType: string
imageIntegrityStatus: string
version: string
imageSeries: string
imageName: string
isTaggedGolden: True
isCCORecommended: True
isCCOLatest: True
createdTime: 0
imageSizeGreaterThan: 0
imageSizeLesserThan: 0
sortBy: string
sortOrder: string
limit: 0
offset: 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: |