cisco.dnac.swim_image_details_info – Information module for Swim Image Details

Note

This plugin is part of the cisco.dnac collection (version 3.2.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.

To use it in a playbook, specify: cisco.dnac.swim_image_details_info.

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Swim Image Details.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.3.3

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
applicationType
string
ApplicationType query parameter.
createdTime
integer
CreatedTime query parameter. Time in milliseconds (epoch format).
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
family
string
Family query parameter.
headers
dictionary
Additional headers.
imageIntegrityStatus
string
ImageIntegrityStatus query parameter. ImageIntegrityStatus - FAILURE, UNKNOWN, VERIFIED.
imageName
string
ImageName query parameter. Image Name.
imageSeries
string
ImageSeries query parameter. Image Series.
imageSizeGreaterThan
integer
ImageSizeGreaterThan query parameter. Size in bytes.
imageSizeLesserThan
integer
ImageSizeLesserThan query parameter. Size in bytes.
imageUuid
string
ImageUuid query parameter.
isCCOLatest
boolean
    Choices:
  • no
  • yes
IsCCOLatest query parameter. Is latest from cisco.com.
isCCORecommended
boolean
    Choices:
  • no
  • yes
IsCCORecommended query parameter. Is recommended from cisco.com.
isTaggedGolden
boolean
    Choices:
  • no
  • yes
IsTaggedGolden query parameter. Is Tagged Golden.
limit
integer
Limit query parameter.
name
string
Name query parameter.
offset
integer
Offset query parameter.
sortBy
string
SortBy query parameter. Sort results by this field.
sortOrder
string
SortOrder query parameter. Sort order - 'asc' or 'des'. Default is asc.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
version
string
Version query parameter. Software Image Version.

Notes

Note

  • Supports 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

Swim Image Details reference

Complete reference of the Swim Image Details object model.

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:
      custom: value
    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 Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "response": [ { "applicableDevicesForImage": [ { "mdfId": "string", "productId": [ "string" ], "productName": "string" } ], "applicationType": "string", "createdTime": "string", "extendedAttributes": {}, "family": "string", "feature": "string", "fileServiceId": "string", "fileSize": "string", "imageIntegrityStatus": "string", "imageName": "string", "imageSeries": [ "string" ], "imageSource": "string", "imageType": "string", "imageUuid": "string", "importSourceType": "string", "isTaggedGolden": true, "md5Checksum": "string", "name": "string", "profileInfo": [ { "description": "string", "extendedAttributes": {}, "memory": 0, "productType": "string", "profileName": "string", "shares": 0, "vCpu": 0 } ], "shaCheckSum": "string", "vendor": "string", "version": "string" } ], "version": "string" }


Authors

  • Rafael Campos (@racampos)