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.5.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.

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.

  • 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.5.0

  • python >= 3.5

Parameters

Parameter

Comments

applicationType

string

ApplicationType query parameter.

createdTime

integer

CreatedTime query parameter. Time in milliseconds (epoch format).

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: “admin”

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • no

  • yes ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: “2.3.3.0”

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

IsCCOLatest query parameter. Is latest from cisco.com.

Choices:

  • no

  • yes

isCCORecommended

boolean

IsCCORecommended query parameter. Is recommended from cisco.com.

Choices:

  • no

  • yes

isTaggedGolden

boolean

IsTaggedGolden query parameter. Is Tagged Golden.

Choices:

  • no

  • yes

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

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • no

  • yes ← (default)

version

string

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_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

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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

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

Authors

  • Rafael Campos (@racampos)