Getting StartedAPI ReferenceRecipesGitHub
API Reference

Update cluster software

put
https://cluster.ip.address/v2/clusters/softwares

Privileges: CLUSTER_UPGRADE, CLUSTER_MAINTENANCE

Update the software on the cluster through upgrade and/or patch.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The parameters to update the software on the cluster.

Specifies the parameters to update the software on the cluster.

assessSoftwareUpdateParams
object

Required field for operation type AssessSoftwareUpdate

string
enum

Type of node where upgrade has to be performed using the provided
package.

  • ClusterNode
  • ConnectorNode
    nodeType is only applicable for following operation types.
  • DownloadUpgradePackage
  • DownloadPatchPackage
  • DownloadUpgradeAndPatchPackages
Allowed:
string
enum
required

The operation type.

  • DownloadUpgradePackage - Operation to download upgrade package.
  • DownloadPatchPackage - Operation to download patch package.
  • DownloadUpgradeAndPatchPackages - Operation to download upgrade
    and patch packages.
  • DownloadAndUpgrade - Operation to download package and
    and then upgrade the cluster.
  • DownloadAndApplyPatch - Operation to download package and
    and then apply the patch.
  • DownloadAndUpgradeWithPatch - Operation to download upgrade
    and patch packages, and then, upgrade the cluster and immediately
    patch it
  • Upgrade - Operation to upgrade the software on the cluster.
  • ApplyPatch - Operation to apply the patch.
  • RevertPatch - Operation to revert the patch.
  • UpgradeAndPatch - Operation to upgrade the software on the
    cluster and apply a patch.
  • AssessSoftwareUpdate - Operation to perform checks to assess
    the state of cluster pre/post software update (upgrade/patch).
  • AbortApplyPatch - Operation to abort the patch.
  • AbortUpgrade - Operation to abort the upgrade.
patchParams
object

Specifies parameters for patch related operations. This is required
field for below operation types:

  • DownloadPatchPackage
  • DownloadUpgradeAndPatchPackages
  • DownloadAndApplyPatch
  • DownloadAndUpgradeWithPatch
  • ApplyPatch
  • RevertPatch
  • UpgradeAndPatch
upgradeParams
object

Specifies parameters for upgrade related operations. This is required
field for below operation types:

  • DownloadUpgradePackage
  • DownloadUpgradeAndPatchPackages
  • DownloadAndUpgrade
  • DownloadAndUpgradeWithPatch
  • Upgrade
  • UpgradeAndPatch
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?