Initiate software update on the given System.

post/private-cloud-business/v1beta1/systems/{id}/software-update

Initiate a software update on the specified system and the hypervisor clusters in it using the specified software catalog version. Before invoking this API, ensure that software update prechecks on the same parameters successfully completed and is valid.

Securitybearer
Request
path Parameters
id
required
string <uuid>

Unique Identifier of the System, usually a UUID.

Request Body schema: application/json
required
catalogVersion
required
string

Version of the target software catalog for the software precheck/update request.

hypervisorClusterIds
Array of strings <uuid>

List of Unique Identifiers (usually UUIDs) of Hypervisor Clusters in the system for which software update operation is to be initiated. If omitted, software update operation will be initiated on all Hypervisor Clusters available in the system.

Responses
202

Software update request is accepted.

400

Bad Request

401

The current user is not authorized to perform the requested operation.

403

Requested operation is forbidden in the current state of System.

404

Not Found

409

A software precheck or update operation is already in progress.

500

Internal Server Error

Request samples
application/json
{
  • "catalogVersion": "string",
  • "hypervisorClusterIds": [
    ]
}
Response samples
application/json
{ }