Update Upgrade Schedule
Commit/Reschedule an existing upgrade. It moves the upgrade from DRAFT state to SCHEDULED state and/or changes the upgrade scheduled date/time.
upgradeId
{
"scheduledTimestamp": "string",
"upgradeNow": false,
"markForCancellation": false
}
Upgrade Scheduled Time
Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored
Flag for marking an upgrade for cancellation. If set to true, other fields in the request will be ignored
Ok
{
"id": "string",
"bundleId": "string",
"resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
"parallelUpgrade": 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"
}
}
],
"status": "string",
"taskId": "string",
"nsxtUpgradeUserInputSpec": {
"nsxtHostClusterUpgradeSpecs": [
{
"hostClusterId": "string",
"hostParallelUpgrade": false,
"liveUpgrade": false
}
],
"nsxtEdgeClusterUpgradeSpecs": [
{
"edgeClusterId": "string",
"edgeParallelUpgrade": false
}
],
"nsxtUpgradeOptions": {
"isEdgeOnlyUpgrade": false,
"isHostClustersUpgradeParallel": false,
"isEdgeClustersUpgradeParallel": false
},
"nsxtId": "string"
},
"bundle": {
"id": "string",
"type": "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
"description": "string",
"version": "string",
"severity": "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
"vendor": "string",
"releasedDate": "string",
"isCumulative": false,
"isCompliant": false,
"sizeMB": "number",
"downloadStatus": "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED, RECALLED",
"components": [
{
"description": "string",
"vendor": "string",
"releasedDate": "string",
"toVersion": "string",
"fromVersion": "string",
"imageType": "One among: PATCH, INSTALL",
"id": "string",
"type": "string"
}
],
"applicabilityStatus": "One among: SUCCESS, IN_PROGRESS, FAILED, AVAILABLE, PENDING",
"applicabilityOrder": 1,
"isPartiallyUpgraded": true
},
"endTime": 0
}
ID for Upgrade
Bundle ID for Upgrade
Resource Type for Upgrade
Boolean to represent components will be upgraded in parallel on not
Overall upgrade status
Task ID associated with upgrade
Bundle contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.
End time of the upgrade
Upgrade Not Found
{
"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.