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.12.0).

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 2.2.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.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

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

compatibleFeatures

list / elements=dictionary

The list of functionalities or capabilities that are supported or compatible with a particular device. For example, it determines whether ISSU, Rommon update, etc. Can be enabled on the device.

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

Initiate both the distribution and activation of the images. At the end of this process, only the images that are fetched from the GET API `/dna/intent/api/v1/images?imported=true` and are part of the `installedImages` will be running on the network device. If there are no image ids available, they will be retrieved from the golden bundle as part of the workflow.

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:

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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst 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_port: "{{catalystcenter_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

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)