cisco.dnac.import_image – Manage ImportImage objects of SoftwareImageManagementSwim

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • 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

Parameters

Parameter Choices/Defaults Comments
application_type
string
ApplicationType query parameter.
created_time
integer
Time in milliseconds (epoch format).
family
string
Family query parameter.
image_integrity_status
string
ImageIntegrityStatus - FAILURE, UNKNOWN, VERIFIED.
image_name
string
Image Name.
image_series
string
Image Series.
image_size_greater_than
integer
Size in bytes.
image_size_lesser_than
integer
Size in bytes.
image_uuid
string
ImageUuid query parameter.
is_cco_latest
boolean
    Choices:
  • no
  • yes
Is latest from cisco.com.
is_cco_recommended
boolean
    Choices:
  • no
  • yes
Is recommended from cisco.com.
is_tagged_golden
boolean
    Choices:
  • no
  • yes
Is Tagged Golden.
limit
integer
Limit query parameter.
name
string
Name query parameter.
offset
integer
Offset query parameter.
sort_by
string
Sort results by this field.
sort_order
string
Sort order - 'asc' or 'des'. Default is asc.
version
string
Software Image Version.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.import_image

The official documentation on the cisco.dnac.plugins.module_utils.definitions.import_image module.

ImportImage reference

Complete reference of the ImportImage object model.

ImportImage reference

SDK reference.

Examples

- name: get_software_image_details
  cisco.dnac.import_image:
    state: query  # required
    application_type: SomeValue  # string
    created_time: 1  #  integer
    family: SomeValue  # string
    image_integrity_status: SomeValue  # string
    image_name: SomeValue  # string
    image_series: SomeValue  # string
    image_size_greater_than: 1  #  integer
    image_size_lesser_than: 1  #  integer
    image_uuid: SomeValue  # string
    is_cco_latest: True  # boolean
    is_cco_recommended: True  # boolean
    is_tagged_golden: True  # boolean
    limit: 1  #  integer
    name: SomeValue  # string
    offset: 1  #  integer
    sort_by: SomeValue  # string
    sort_order: SomeValue  # string
    version: SomeValue  # string
  register: nm_get_software_image_details

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 with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
software_image_management_swim.get_software_image_details


Authors

  • Rafael Campos (@racampos)