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.
Upgrade Specification
Show optional properties
{
"bundleId": "string",
"resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"resourceUpgradeSpecs": [
{
"resourceId": "string"
}
]
}{
"bundleId": "string",
"draftMode": false,
"nsxtUpgradeUserInputSpecs": [
{
"nsxtEdgeClusterUpgradeSpecs": [
{
"edgeClusterId": "string",
"edgeParallelUpgrade": false
}
],
"nsxtHostClusterUpgradeSpecs": [
{
"hostClusterId": "string",
"hostParallelUpgrade": false,
"liveUpgrade": false
}
],
"nsxtId": "string",
"nsxtUpgradeOptions": {
"isEdgeClustersUpgradeParallel": false,
"isEdgeOnlyUpgrade": false,
"isHostClustersUpgradeParallel": false
}
}
],
"parallelUpgrade": false,
"resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"resourceUpgradeSpecs": [
{
"customISOSpec": {
"hostIds": [
"string"
],
"id": "string"
},
"enableQuickboot": false,
"evacuateOfflineVms": false,
"personalitySpec": {
"hardwareSupportSpecs": [
{
"name": "string",
"packageSpec": {
"name": "string",
"version": "string"
}
}
],
"personalityId": "string"
},
"resourceId": "string",
"scheduledTimestamp": "string",
"shutdownVms": false,
"toVersion": "string",
"upgradeNow": false
}
],
"vcenterUpgradeUserInputSpecs": [
{
"temporaryNetwork": {
"gateway": "string",
"ipAddress": "string",
"subnetMask": "string"
}
}
]
}Bundle ID for Upgrade
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
Boolean to represent components will be upgraded in parallel on not
Resource Type for Upgrade
User Input for vCenter upgrade
OK
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"id": "string",
"isCancellable": false,
"localizableDescriptionPack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"name": "string",
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"subTasks": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"stages": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type": "string"
}
],
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
"subTasks": [
"SubTask Object"
],
"type": "string"
}
],
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"isRetryable": false
}Task completion timestamp
Task creation timestamp
Task ID
Represents task can be cancellable or not.
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.
Task name
Resolution state
Task status
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
Indicates whether a task is eligible for retry or not.
Accepted
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"id": "string",
"isCancellable": false,
"localizableDescriptionPack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"name": "string",
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"subTasks": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"resources": [
{
"fqdn": "sfo-vc01.rainpole.io",
"name": "string",
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"sans": [
"string"
],
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
}
],
"stages": [
{
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
],
"name": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"type": "string"
}
],
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
"subTasks": [
"SubTask Object"
],
"type": "string"
}
],
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"isRetryable": false
}Task completion timestamp
Task creation timestamp
Task ID
Represents task can be cancellable or not.
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.
Task name
Resolution state
Task status
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
Indicates whether a task is eligible for retry or not.
Bad Request
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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 minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
Operation not allowed
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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 minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
Failed Dependency
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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 minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
Internal Server Error
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}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 minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message