cisco.dnac.import_image_url – Manage ImportImageUrl 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_url.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported 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
payload
list / elements=dictionary / required
An object to send in the Request body.
applicationType
string
It is the import image url's applicationType.
imageFamily
string
It is the import image url's imageFamily.
sourceURL
string
It is the import image url's sourceURL.
thirdParty
boolean
    Choices:
  • no
  • yes
It is the import image url's thirdParty.
vendor
string
It is the import image url's vendor.
schedule_at
string
Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .
schedule_desc
string
Custom Description (Optional).
schedule_origin
string
Originator of this call (Optional).

See Also

See also

cisco.dnac.plugins.module_utils.definitions.import_image_url

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

ImportImageUrl reference

Complete reference of the ImportImageUrl object model.

ImportImageUrl reference

SDK reference.

Examples

- name: import_software_image_via_url
  cisco.dnac.import_image_url:
    state: create  # required
    payload:  # required
    - applicationType: SomeValue  # string
      imageFamily: SomeValue  # string
      sourceURL: SomeValue  # string
      thirdParty: True  # boolean
      vendor: SomeValue  # string
    schedule_at: SomeValue  # string
    schedule_desc: SomeValue  # string
    schedule_origin: 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_software_image_via_url


Authors

  • Rafael Campos (@racampos)