Perform Upgrade
Schedule/Trigger Upgrade of a Resource. Ex: Resource can be DOMAIN, CLUSTER, UNMANAGED_HOST etc. Performing upgrades are supported on VMware Cloud Foundation 3.5 BOM resources and above. Supports scheduling/triggering of only 'parallel' upgrades and only Resource 'cluster' that are managed using both vSphere Lifecycle Manager Baselines and vSphere Lifecycle Manager Images in the same request.
Show optional properties
{
"bundleId": "string",
"resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"resourceUpgradeSpecs": [
{
"resourceId": "string"
}
]
}{
"bundleId": "string",
"resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"parallelUpgrade": false,
"draftMode": false,
"resourceUpgradeSpecs": [
{
"resourceId": "string",
"shutdownVms": false,
"toVersion": "string",
"scheduledTimestamp": "string",
"upgradeNow": false,
"personalitySpec": {
"personalityId": "string",
"hardwareSupportSpecs": [
{
"name": "string",
"packageSpec": {
"name": "string",
"version": "string"
}
}
]
},
"customIsoSpec": {
"id": "string"
},
"enableQuickboot": false,
"evacuateOfflineVms": false,
"esxUpgradeOptionsSpec": {
"esxUpgradeFailureAction": {
"retryDelay": 0,
"retryCount": 0,
"action": "FAIL, RETRY"
},
"enforceHclValidation": false,
"enableQuickPatch": false,
"enableQuickboot": false,
"evacuateOfflineVms": false,
"disableHac": false,
"disableDpm": false,
"preRemediationPowerAction": "POWER_OFF_VMS, SUSPEND_VMS, DO_NOT_CHANGE_VMS_POWER_STATE, SUSPEND_VMS_TO_MEMORY"
}
}
],
"nsxtUpgradeUserInputSpecs": [
{
"nsxtHostClusterUpgradeSpecs": [
{
"hostClusterId": "string",
"hostParallelUpgrade": false,
"liveUpgrade": false
}
],
"nsxtEdgeClusterUpgradeSpecs": [
{
"edgeClusterId": "string",
"edgeParallelUpgrade": false
}
],
"nsxtUpgradeOptions": {
"isEdgeOnlyUpgrade": false,
"isHostClustersUpgradeParallel": false,
"isEdgeClustersUpgradeParallel": false
},
"nsxtId": "string"
}
],
"vcenterUpgradeUserInputSpecs": [
{
"temporaryNetwork": {
"ipAddress": "string",
"subnetMask": "string",
"gateway": "string"
}
}
]
}Bundle ID for Upgrade
Resource Type for Upgrade
Boolean to represent components will be upgraded in parallel on not
Boolean to represent upgrade will be created in DRAFT mode. This allows to run prechecks before user confirm/commit the upgrade.
Resource Upgrade Specifications for NSX upgrade
User Input for vCenter upgrade
Accepted
{
"id": "string",
"name": "string",
"localizableDescriptionPack": {
"component": "string",
"messageKey": "string",
"arguments": [
"string"
],
"message": "string",
"bundle": "string"
},
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
"SubTask Object"
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"isCancellable": false,
"isRetryable": false
}Task ID
Task name
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
Task status
Task creation timestamp
Task completion timestamp
Resolution state
Represents task can be cancellable or not.
Indicates whether a task is eligible for retry or not.
Bad Request
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Operation not allowed
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Failed Dependency
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
InternalServerError
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.