Upgrade

Upgrade
Upgrade

Upgrade object which contain details regarding the upgrade

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

resourceUpgradeSpecs
Required

Resource Upgrade Specifications

string
status
Required

Overall upgrade status

string
taskId
Required

Task ID associated with upgrade

nsxtUpgradeUserInputSpec
Optional

NSX Upgrade User Input Specification

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

vcenterUpgradeUserInputSpec
Optional

vCenter Upgrade User Input Specification