ResourceUpgradeSpec

ResourceUpgradeSpec

Resource Upgrade Specification

JSON Example

{
    "resourceId": "string",
    "type": "One among: DOMAIN, CLUSTER, STANDALONE_HOST",
    "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,
        "quickPatchOptions": {
            "quickPatchMode": "AUTO"
        },
        "remediationFailureToleranceSpec": {
            "failedHostsTolerancePercentageEnabled": false,
            "failedHostsTolerancePercentage": 0
        },
        "skipReservedVibsCaching": 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"
    },
    "esxStandaloneHostUpgradeOptionsSpec": {
        "esxUpgradeFailureAction": {
            "retryDelay": 0,
            "retryCount": 0,
            "action": "FAIL, RETRY"
        },
        "enableQuickboot": false,
        "preRemediationPowerAction": "POWER_OFF_VMS, SUSPEND_VMS, DO_NOT_CHANGE_VMS_POWER_STATE, SUSPEND_VMS_TO_MEMORY",
        "skipReservedVibsCaching": false
    },
    "hostsToUpgrade": [
        "string"
    ]
}

string

resourceId

Required

Resource ID for Upgrade

string

type

Optional

Resource type

boolean

shutdownVms

Optional

If Resource Type is UNASSIGNED_HOST, set flag for enabling shutting down VM's before Upgrade

string

toVersion

Optional

If Resource Type is UNASSIGNED_HOST, set the target version for Upgrade

string

scheduledTimestamp

Optional

Upgrade Scheduled Time

boolean

upgradeNow

Optional

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

PersonalitySpec

personalitySpec

Optional

Personality Specification for vLCM based upgrade

CustomISOSpec

customIsoSpec

Optional

Custom ISO Specifications for VUM Clusters Upgrade with Custom ISO

boolean

enableQuickboot

Optional

Flag for requesting Quick Boot for ESXi upgrade

boolean

evacuateOfflineVms

Optional

Flag for requesting Evacuation of Offline VMs for ESXi upgrade

EsxUpgradeOptionsSpec

esxUpgradeOptionsSpec

Optional

Options for ESXi upgrade. These are applicable to vSphere Lifecycle Manager Images based upgrade only.

EsxStandaloneHostUpgradeOptionsSpec

esxStandaloneHostUpgradeOptionsSpec

Optional

Options for ESXi standalone host upgrade.

array of string

hostsToUpgrade

Optional

Set of hosts selected for remediation for ESXi upgrade

Property Of

Upgrade

UpgradeSpec