cisco.catalystcenter.software_management_executions_info module -- Information module for Software Management Executions

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

New in cisco.catalystcenter 6.46.0

Synopsis

  • Get Software Management Executions by id.

  • This api is used to get execution status and task details of a specific software management workflows.

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"`

headers

dictionary

Additional headers.

id

string

Id path parameter. The id of the execution detail to be retrieved.

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.get_software_management_execution_details,

  • Paths used are get /dna/system/api/v1/softwareManagementExecutions/{id},

  • Supports 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 GetSoftwareManagementExecutionDetails

Complete reference of the GetSoftwareManagementExecutionDetails API.

Examples

---
- name: Get Software Management Executions by id
  cisco.catalystcenter.software_management_executions_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

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": {"completedPercentage": 0, "createdBy": "string", "duration": 0, "endDate": "string", "errorCode": "string", "errorMessage": "string", "id": "string", "isForceUpdate": true, "jobType": "string", "localReleaseId": "string", "optionalPackages": ["string"], "releaseDisplayName": "string", "releaseDisplayVersion": "string", "releaseName": "string", "releaseVersion": "string", "startDate": "string", "status": "string", "systemErrorMessage": "string", "tasks": [{"endDate": "string", "errorCode": "string", "id": "string", "message": "string", "startDate": "string", "status": "string", "systemErrorMessage": "string", "taskName": "string"}], "updateMessage": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)