cisco.catalystcenter.network_device_images_id_activate module -- Resource module for Network Device Images Id Activate

Note

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

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.network_device_images_id_activate.

New in cisco.catalystcenter 6.18.0

Synopsis

• Manage operation create of the resource Network Device Images Id Activate. - > This API initiates the process of updating the software image on the network device. Providing value for the `installedImages` in request payload will initiate both distribution and activation of the images. At the end of this process, only the images which are part of `installedImages` will be running on the network device. To monitor the progress and completion of the update task, call the GET API `/dna/intent/api/v1/networkDeviceImageUpdates?parentId={taskId}`, where `taskId` is from the response of the current endpoint.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
compatibleFeatures list / elements=dictionary	Network Device Images Id Activate's compatibleFeatures.
key string	Name of the compatible feature.
value string	Feature that can be enabled or disabled.
id string	Id path parameter. Network device identifier.
installedImages list / elements=dictionary	Network Device Images Id Activate's installedImages.
id string	Software image identifier.
networkValidationIds list / elements=string	List of unique identifiers of custom network device validations.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are software_image_management_swim.SoftwareImageManagementSwim.update_images_on_the_network_device,

• Paths used are post /dna/intent/api/v1/networkDeviceImages/{id}/activate,

• 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 Software Image Management (SWIM) UpdateImagesOnTheNetworkDevice

Complete reference of the UpdateImagesOnTheNetworkDevice API.

Examples

---
- name: Create
  cisco.catalystcenter.network_device_images_id_activate:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    compatibleFeatures:
      - key: string
        value: string
    id: string
    installedImages:
      - id: string
    networkValidationIds:
      - 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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)