/ home / cisco / cisco.dnac / 6.13.3 / module / swim_image_details_info

cisco.dnac.swim_image_details_info (6.13.3) — module

Information module for Swim Image Details

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Swim Image Details.

Returns software image list based on a filter criteria. For example "filterbyName = cat3k%".

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
name:
    description:
    - Name query parameter.
    type: str

limit:
    description:
    - Limit query parameter.
    type: int

family:
    description:
    - Family query parameter.
    type: str

offset:
    description:
    - Offset query parameter.
    type: int

sortBy:
    description:
    - SortBy query parameter. Sort results by this field.
    type: str

headers:
    description: Additional headers.
    type: dict

version:
    description:
    - Version query parameter. Software Image Version.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

imageName:
    description:
    - ImageName query parameter. Image Name.
    type: str

imageUuid:
    description:
    - ImageUuid query parameter.
    type: str

sortOrder:
    description:
    - SortOrder query parameter. Sort order - 'asc' or 'des'. Default is asc.
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

createdTime:
    description:
    - CreatedTime query parameter. Time in milliseconds (epoch format).
    type: int

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

imageSeries:
    description:
    - ImageSeries query parameter. Image Series.
    type: str

isCCOLatest:
    description:
    - IsCCOLatest query parameter. Is latest from cisco.com.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

isTaggedGolden:
    description:
    - IsTaggedGolden query parameter. Is Tagged Golden.
    type: bool

applicationType:
    description:
    - ApplicationType query parameter.
    type: str

isCCORecommended:
    description:
    - IsCCORecommended query parameter. Is recommended from cisco.com.
    type: bool

imageSizeLesserThan:
    description:
    - ImageSizeLesserThan query parameter. Size in bytes.
    type: int

imageIntegrityStatus:
    description:
    - ImageIntegrityStatus query parameter. ImageIntegrityStatus - FAILURE, UNKNOWN, VERIFIED.
    type: str

imageSizeGreaterThan:
    description:
    - ImageSizeGreaterThan query parameter. Size in bytes.
    type: int

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: 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"
  type: dict