cisco.dnac.import_image_file – Manage ImportImageFile 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_file.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

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
filename
string / required
The filename (with its extension, for example, test.zip).
filepath
string / required
The full path of a file. The file is opened with rb flag.
is_third_party
boolean
    Choices:
  • no
  • yes
Third party Image check.
third_party_application_type
string
Third Party Application Type.
third_party_image_family
string
Third Party image family.
third_party_vendor
string
Third Party Vendor.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.import_image_file

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

ImportImageFile reference

Complete reference of the ImportImageFile object model.

ImportImageFile reference

SDK reference.

Examples

- name: import_local_software_image
  cisco.dnac.import_image_file:
    state: create  # required
    filename: SomeValue  # string, required
    filepath: SomeValue  # string, required
    is_third_party: True  # boolean
    third_party_application_type: SomeValue  # string
    third_party_image_family: SomeValue  # string
    third_party_vendor: SomeValue  # string

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


Authors

  • Rafael Campos (@racampos)