cisco.catalystcenter.images_info module -- Information module for Images
Note
This module is part of the cisco.catalystcenter collection (version 2.11.0).
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.images_info.
New in cisco.catalystcenter 1.0.0
Synopsis
Get all Images.
A list of available images for the specified site is provided. The default.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.2.3.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
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 Catalyst 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,
Paths used are get /dna/intent/api/v1/images,
Supports
check_modeThe 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
Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)
See Also
See also
- Cisco Catalyst Center documentation for Software Image Management (SWIM) ReturnsListOfSoftwareImages
Complete reference of the ReturnsListOfSoftwareImages API.
Examples
---
- name: Get all Images
cisco.catalystcenter.images_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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: 1
limit: 500
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 Catalyst Center Python SDK Returned: always |