cisco.dnac.trigger_image_activation – Manage TriggerImageActivation 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_activation.

New in version 1.0.0: of cisco.dnac

Synopsis

• Activates a software image on a given device. Software image must be present in the device flash.

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.
	activateLowerImageVersion boolean	Choices: no yes	It is the trigger image activation's activateLowerImageVersion.
	deviceUpgradeMode string		It is the trigger image activation's deviceUpgradeMode.
	deviceUuid string		It is the trigger image activation's deviceUuid.
	distributeIfNeeded boolean	Choices: no yes	It is the trigger image activation's distributeIfNeeded.
	imageUuidList list / elements=string		It is the trigger image activation's imageUuidList.
	smuImageUuidList list / elements=string		It is the trigger image activation's smuImageUuidList.
schedule_validate boolean		Choices: no yes	ScheduleValidate, validates data before schedule (Optional).

See Also

See also

cisco.dnac.plugins.module_utils.definitions.trigger_image_activation

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

TriggerImageActivation reference

Complete reference of the TriggerImageActivation object model.

TriggerImageActivation reference

SDK reference.

Examples

- name: trigger_software_image_activation
  cisco.dnac.trigger_image_activation:
    state: create  # required
    payload:  # required
    - activateLowerImageVersion: True  # boolean
      deviceUpgradeMode: SomeValue  # string
      deviceUuid: SomeValue  # string
      distributeIfNeeded: True  # boolean
      imageUuidList:
      - SomeValue  # string
      smuImageUuidList:
      - SomeValue  # string
    schedule_validate: True  # boolean

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_activation

Authors

• Rafael Campos (@racampos)