PerformVsanUpgradeExRequestType

PerformVsanUpgradeExRequestType
PerformVsanUpgradeExRequestType

The parameters of PerformVsanUpgradeEx.

JSON Example
{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "performObjectUpgrade": false,
    "downgradeFormat": false,
    "allowReducedRedundancy": false,
    "excludeHosts": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "spec": {
        "_typeName": "string",
        "dataEfficiencyConfig": {
            "_typeName": "string",
            "dedupEnabled": false,
            "compressionEnabled": false
        },
        "dataEncryptionConfig": {
            "_typeName": "string",
            "encryptionEnabled": false,
            "kmsProviderId": {
                "_typeName": "string",
                "id": "string"
            },
            "kekId": "string",
            "hostKeyId": "string",
            "dekGenerationId": 0,
            "changing": false,
            "eraseDisksBeforeUse": false,
            "wrappedDek": "string",
            "dekId": "string",
            "oldWrappedDek": "string",
            "oldDekId": "string",
            "kekVerifier": "string",
            "dekVerifier": "string",
            "oldDekVerifier": "string",
            "iv": "string",
            "syncing": false
        },
        "skipHostRemediation": false,
        "allowDataMovement": false
    }
}
cluster
Required

The cluster to be upgraded

Required privileges: Host.Config.Storage

boolean
performObjectUpgrade
Optional

After all disk groups have been updated, also upgrade all objects. Once started, rollback of the on disk format is no longer possible. Object upgrade unlocks new vSAN features. The default behavior is upgrading objects is this parameter is not specified.

boolean
downgradeFormat
Optional

Perform a on-disk format downgrade instead of upgrade. Only possible if no upgraded objects exist.

boolean
allowReducedRedundancy
Optional

Removes the need for one disk group worth of free space, by allowing reduced redundancy during disk upgrade.

excludeHosts
Optional

Internal debug option meant for functional testing of vSAN upgrades. Skips upgrade on certain hosts and implies performObjectUpgrade being false. Should not be used by customers.

spec
Optional

The specification of advanced disk format configuration. The spec cannot be supported in downgrade process, for now we don't have any advanced features supported by lower disk format.