cisco.dnac.swim_import_via_url module – Resource module for Swim Import Via Url

Note

This module is part of the cisco.dnac collection (version 6.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Manage operation create of the resource Swim Import Via Url.

  • 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 >= 2.5.0

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: “admin”

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • no

  • yes ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: “2.3.3.0”

payload

list / elements=dictionary

Swim Import Via Url’s payload.

applicationType

string

Swim Import Via Url’s applicationType.

imageFamily

string

Swim Import Via Url’s imageFamily.

sourceURL

string

Swim Import Via Url’s sourceURL.

thirdParty

boolean

ThirdParty flag.

Choices:

  • no

  • yes

vendor

string

Swim Import Via Url’s vendor.

scheduleAt

string

ScheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional).

scheduleDesc

string

ScheduleDesc query parameter. Custom Description (Optional).

scheduleOrigin

string

ScheduleOrigin query parameter. Originator of this call (Optional).

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • SDK Method used are software_image_management_swim.SoftwareImageManagementSwim.import_software_image_via_url,

  • Paths used are post /dna/intent/api/v1/image/importation/source/url,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples

- name: Create
  cisco.dnac.swim_import_via_url:
    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}}"
    payload:
    - applicationType: string
      imageFamily: string
      sourceURL: string
      thirdParty: true
      vendor: string
    scheduleAt: string
    scheduleDesc: string
    scheduleOrigin: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: “{\n \”response\”: {\n \”taskId\”: \”string\”,\n \”url\”: \”string\”\n },\n \”version\”: \”string\”\n}\n”

Authors

  • Rafael Campos (@racampos)