Update Upgrade Schedule

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.

Request
URI
PATCH
https://{api_host}/v1/upgrades/{upgradeId}
COPY
Path Parameters
string
upgradeId
Required

upgradeId

Request Body
UpgradeCommitSpec of type(s) application/json
Required 
{
    "scheduledTimestamp": "string",
    "upgradeNow": false,
    "markForCancellation": false,
    "vcenterUpgradePatchSpecs": [
        {
            "resourceId": "string",
            "startSwitchoverTimestamp": "string"
        }
    ]
}
string
scheduledTimestamp
Optional

Upgrade Scheduled Time

boolean
upgradeNow
Optional

Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored

boolean
markForCancellation
Optional

Flag for marking an upgrade for cancellation. If set to true, other fields in the request will be ignored

array of object
vcenterUpgradePatchSpecs
Optional

User input for vCenter ReducedDowntimeMigration upgrade

Responses
200

Ok

Returns Upgrade of type(s) application/json 
"Upgrade Object"
string
id
Required

ID for Upgrade

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

array of object
resourceUpgradeSpecs
Required

Resource Upgrade Specifications

string
status
Required

Overall upgrade status

string
taskId
Required

Task ID associated with upgrade

object
nsxtUpgradeUserInputSpec
Optional

NSX Upgrade User Input Specification

object
bundle
Optional

Bundle contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

integer As int64 As int64
endTime
Optional

End time of the upgrade

object
vcenterUpgradeUserInputSpec
Optional

vCenter Upgrade User Input Specification


404

Upgrade Not Found

Returns Error of type(s) application/json 
"Error Object"
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 object
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 
"Error Object"
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 object
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.


Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Upgrades Operations
GET
Get Upgrades
POST
Perform Upgrade
POST
Start Upgrade Precheck
GET
Get Upgrade By Id
PATCH
Update Upgrade Schedule
GET
Get Upgrade Precheck By ID