.. Document meta
:orphan:
.. Anchors
.. _ansible_collections.cisco.dnac.swim_image_details_info_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.swim_image_details_info -- Information module for Swim Image Details
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 3.1.1).
To install it use: :code:`ansible-galaxy collection install cisco.dnac`.
To use it in a playbook, specify: :code:`cisco.dnac.swim_image_details_info`.
.. version_added
.. versionadded:: 1.0.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Get all Swim Image Details.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-applicationType"></div>
<b>applicationType</b>
<a class="ansibleOptionLink" href="#parameter-applicationType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>ApplicationType query parameter.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-createdTime"></div>
<b>createdTime</b>
<a class="ansibleOptionLink" href="#parameter-createdTime" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>CreatedTime query parameter. Time in milliseconds (epoch format).</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-family"></div>
<b>family</b>
<a class="ansibleOptionLink" href="#parameter-family" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Family query parameter.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-headers"></div>
<b>headers</b>
<a class="ansibleOptionLink" href="#parameter-headers" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Additional headers.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-imageIntegrityStatus"></div>
<b>imageIntegrityStatus</b>
<a class="ansibleOptionLink" href="#parameter-imageIntegrityStatus" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>ImageIntegrityStatus query parameter. ImageIntegrityStatus - FAILURE, UNKNOWN, VERIFIED.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-imageName"></div>
<b>imageName</b>
<a class="ansibleOptionLink" href="#parameter-imageName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>ImageName query parameter. Image Name.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-imageSeries"></div>
<b>imageSeries</b>
<a class="ansibleOptionLink" href="#parameter-imageSeries" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>ImageSeries query parameter. Image Series.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-imageSizeGreaterThan"></div>
<b>imageSizeGreaterThan</b>
<a class="ansibleOptionLink" href="#parameter-imageSizeGreaterThan" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>ImageSizeGreaterThan query parameter. Size in bytes.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-imageSizeLesserThan"></div>
<b>imageSizeLesserThan</b>
<a class="ansibleOptionLink" href="#parameter-imageSizeLesserThan" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>ImageSizeLesserThan query parameter. Size in bytes.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-imageUuid"></div>
<b>imageUuid</b>
<a class="ansibleOptionLink" href="#parameter-imageUuid" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>ImageUuid query parameter.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-isCCOLatest"></div>
<b>isCCOLatest</b>
<a class="ansibleOptionLink" href="#parameter-isCCOLatest" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>IsCCOLatest query parameter. Is latest from cisco.com.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-isCCORecommended"></div>
<b>isCCORecommended</b>
<a class="ansibleOptionLink" href="#parameter-isCCORecommended" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>IsCCORecommended query parameter. Is recommended from cisco.com.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-isTaggedGolden"></div>
<b>isTaggedGolden</b>
<a class="ansibleOptionLink" href="#parameter-isTaggedGolden" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>IsTaggedGolden query parameter. Is Tagged Golden.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-limit"></div>
<b>limit</b>
<a class="ansibleOptionLink" href="#parameter-limit" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Limit query parameter.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-name"></div>
<b>name</b>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name query parameter.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-offset"></div>
<b>offset</b>
<a class="ansibleOptionLink" href="#parameter-offset" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Offset query parameter.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-sortBy"></div>
<b>sortBy</b>
<a class="ansibleOptionLink" href="#parameter-sortBy" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>SortBy query parameter. Sort results by this field.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-sortOrder"></div>
<b>sortOrder</b>
<a class="ansibleOptionLink" href="#parameter-sortOrder" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>SortOrder query parameter. Sort order - 'asc' or 'des'. Default is asc.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-version"></div>
<b>version</b>
<a class="ansibleOptionLink" href="#parameter-version" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Version query parameter. Software Image Version.</div>
</td>
</tr>
</table>
<br/>
.. Notes
.. Seealso
See Also
--------
.. seealso::
`Swim Image Details reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the Swim Image Details object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- 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
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{
"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"
}</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors