Perform Upgrade

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.

Request
URI
POST
https://{api_host}/v1/upgrades
COPY
Request Body
UpgradeSpec of type(s) application/json
Required

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"
            }
        }
    ]
}
string
bundleId
Required

Bundle ID for Upgrade

string
resourceType
Required

Resource Type for Upgrade

boolean
parallelUpgrade
Optional

Boolean to represent components will be upgraded in parallel on not

boolean
draftMode
Optional

Boolean to represent upgrade will be created in DRAFT mode. This allows to run prechecks before user confirm/commit the upgrade.

resourceUpgradeSpecs
Required

Resource Upgrade Specifications

nsxtUpgradeUserInputSpecs
Optional

Resource Upgrade Specifications for NSX upgrade

vcenterUpgradeUserInputSpecs
Optional

User Input for vCenter upgrade

Responses
202

Accepted

Returns Task of type(s) application/json
{
    "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
}
string
id
Required

Task ID

string
name
Required

Task name

localizableDescriptionPack
Optional

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.

string
type
Optional

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 _

string
status
Required

Task status

string
creationTimestamp
Required

Task creation timestamp

string
completionTimestamp
Required

Task completion timestamp

array of SubTask
subTasks
Optional

List of sub-tasks of the task

array of Error
errors
Optional

List of errors in case of a failure

array of Resource
resources
Optional

List of resources associated with task

string
resolutionStatus
Optional

Resolution state

boolean
isCancellable
Optional

Represents task can be cancellable or not.

boolean
isRetryable
Optional

Indicates whether a task is eligible for retry or not.


400

Bad Request

Returns Error of type(s) application/json
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


403

Operation not allowed

Returns Error of type(s) application/json
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


424

Failed Dependency

Returns Error of type(s) application/json
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.