cisco.catalystcenter.download_software_release_create module -- Resource module for Download Software Release Create

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.download_software_release_create.

New in cisco.catalystcenter 6.46.0

Synopsis

  • Manage operation create of the resource Download Software Release Create.

  • This api is used to trigger download workflow of a specific release.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

Default: :ansible-option-default:`"3.1.6.0"`

optionalPackages

list / elements=string

Provide the list of optional package's id to be downloaded.Obtain the `id` from the `packagesn.id` attribute where `packagesn.optional` is true from the `/dna/system/api/v1/releases/releaseSummary` API where the `releaseName` and `releaseVersion` is the requested download version.

releaseName

string

The `releaseName` of the release to be downloaded.Obtain the releaseName from the `name` attribute in the response of the `/dna/system/api/v1/releases` API.

releaseVersion

string

The `releaseVersion` of the release to be downloaded.Obtain the releaseVersion from the `version` attribute in the response of the `/dna/system/api/v1/releases` API.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are system_software_upgrade.SystemSoftwareUpgrade.download_release,

  • Paths used are post /dna/system/api/v1/downloadSoftwareRelease,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for System Software Upgrade DownloadRelease

Complete reference of the DownloadRelease API.

Examples

---
- name: Create
  cisco.catalystcenter.download_software_release_create:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    optionalPackages:
      - string
    releaseName: string
    releaseVersion: 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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)