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.

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/upgrades
COPY
Request Body

Upgrade Specification

UpgradeSpec of type(s) application/json
Required 
{
    "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": [
        {
            "enableQuickboot": false,
            "personalitySpec": {
                "hardwareSupportSpecs": [
                    {
                        "name": "string",
                        "packageSpec": {
                            "name": "string",
                            "version": "string"
                        }
                    }
                ],
                "personalityId": "string"
            },
            "resourceId": "string",
            "scheduledTimestamp": "string",
            "shutdownVms": false,
            "toVersion": "string",
            "upgradeNow": false
        }
    ]
}
string
bundleId
Required

Bundle ID for Upgrade

boolean
draftMode
Optional

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

array of NsxtUpgradeUserInputSpec
nsxtUpgradeUserInputSpecs
Optional

Resource Upgrade Specifications for NSXT upgrade

boolean
parallelUpgrade
Optional

Boolean to represent components will be upgraded in parallel on not

string
resourceType
Required

Resource Type for Upgrade

array of ResourceUpgradeSpec
resourceUpgradeSpecs
Required

Resource Upgrade Specifications

Responses
200

OK

Returns Task of type(s) application/json 
{
    "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": "string",
            "name": "string",
            "resourceId": "string",
            "sans": [
                "string"
            ],
            "type": "string"
        }
    ],
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "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": "string",
                    "name": "string",
                    "resourceId": "string",
                    "sans": [
                        "string"
                    ],
                    "type": "string"
                }
            ],
            "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",
            "subTasks": [
                "SubTask Object"
            ],
            "type": "string"
        }
    ],
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
string
completionTimestamp
Optional

Task completion timestamp

string
creationTimestamp
Optional

Task creation timestamp

array of Error
errors
Optional

List of errors in case of a failure

string
id
Optional

Task ID

boolean
isCancellable
Optional

Represents task can be cancellable or not.

MessagePack
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
name
Optional

Task name

string
resolutionStatus
Optional

Resolution state

array of Resource
resources
Optional

List of resources associated with task

string
status
Optional

Task status

array of SubTask
subTasks
Optional

List of sub-tasks of the task

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 _


202

Accepted

Returns Task of type(s) application/json 
{
    "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": "string",
            "name": "string",
            "resourceId": "string",
            "sans": [
                "string"
            ],
            "type": "string"
        }
    ],
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "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": "string",
                    "name": "string",
                    "resourceId": "string",
                    "sans": [
                        "string"
                    ],
                    "type": "string"
                }
            ],
            "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",
            "subTasks": [
                "SubTask Object"
            ],
            "type": "string"
        }
    ],
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
string
completionTimestamp
Optional

Task completion timestamp

string
creationTimestamp
Optional

Task creation timestamp

array of Error
errors
Optional

List of errors in case of a failure

string
id
Optional

Task ID

boolean
isCancellable
Optional

Represents task can be cancellable or not.

MessagePack
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
name
Optional

Task name

string
resolutionStatus
Optional

Resolution state

array of Resource
resources
Optional

List of resources associated with task

string
status
Optional

Task status

array of SubTask
subTasks
Optional

List of sub-tasks of the task

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 _


400

Bad Request

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

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


403

Operation not allowed

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

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


424

Failed Dependency

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

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


500

Internal Server Error

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

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


On This Page
Upgrades Operations
PATCH
Commit Reschedule Upgrade
GET
Get Precheck Using GET
GET
Get Upgrade By Id
GET
Get Upgrades
POST
Perform Prechecks Using POST
POST
Perform Upgrade