UpgradeSpec

UpgradeSpec
UpgradeSpec

Upgrade Specification

JSON Example
{
    "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": [
        {
            "resourceId": "string",
            "upgradeMechanism": "One among: ReducedDowntimeMigration, InPlace",
            "startSwitchoverTimestamp": "string",
            "temporaryNetwork": {
                "networkMode": "One among: STATIC, AUTOMATIC",
                "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

Parameter To