cisco.dnac.trigger_image_distribution – Manage TriggerImageDistribution 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.trigger_image_distribution.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

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.
deviceUuid
string
It is the trigger image distribution's deviceUuid.
imageUuid
string
It is the trigger image distribution's imageUuid.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.trigger_image_distribution

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

TriggerImageDistribution reference

Complete reference of the TriggerImageDistribution object model.

TriggerImageDistribution reference

SDK reference.

Examples

- name: trigger_software_image_distribution
  cisco.dnac.trigger_image_distribution:
    state: create  # required
    payload:  # required
    - deviceUuid: SomeValue  # string
      imageUuid: 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.trigger_software_image_distribution


Authors

  • Rafael Campos (@racampos)