Vsan Upgrade System Ex Perform Vsan Upgrade Preflight Check Ex

Vsan Upgrade System Ex Perform Vsan Upgrade Preflight Check Ex

Perform an upgrade preflight check on a cluster.

It deprecates API vim.VsanUpgradeSystem.PerformVsanUpgradePreflightCheck, and helps to check following issues which would break vSAN upgrade process:

  1. Any vSAN host is disconnected from vCenter server
  2. ESXi host before vSphere 6.0 exists in vSAN cluster, of which on-disk format cannot be upgraded
  3. Any vSAN host enables auto-mode to claim disk
  4. Network issue exists in vSAN cluster, which leads to communication problem among vSAN hosts
  5. Not all vSAN member hosts reside in specified vCenter cluster
  6. Any vSAN host contributes in the other vSAN cluster
  7. There is inaccessible vSAN object in vSAN datastore
  8. Any in-use vSAN disk that are unhealthy, such as physical disk lost
  9. Hybrid disk group exists in vSAN cluster, and requests to enable Deduplication and Compression
  10. To request enable Deduplication and Compression, but there is ESXi host software version is below then ESXi 6.0 Update 2
  11. vSAN downgrade is requested, but vSAN objects have already been upgraded to 2.0 or above
  12. Any vSAN object that would present an upgrade issue

Any issue detected by preflight check, requires manual fix by end user, before trigger vSAN upgrade process through PerformVsanUpgradeEx.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanUpgradeSystemEx/{moId}/PerformVsanUpgradePreflightCheckEx
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanUpgradeSystemEx/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
Required
"PerformVsanUpgradePreflightCheckExRequestType Object"
cluster
Required

The target cluster to be converted.

Required privileges: Host.Config.Storage

boolean
downgradeFormat
Optional

Intend to perform a on-disk format downgrade instead of upgrade. Adds additional checks.

spec
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
200

Preflight check result.

Returns VsanDiskFormatConversionCheckResult of type(s) application/json
This response body class contains all of the following: InlineVsanDiskFormatConversionCheckResult0
"VsanDiskFormatConversionCheckResult Object"
boolean
isSupported
Required

Whether vSAN could process disk format conversion on given cluster with specified conversion options.

If this field is set to false, please check the issues field to get the detailed reason which blocks disk format conversion.

integer As int32 As int32
targetVersion
Optional

Goal format version the given cluster could support.

The goal format version is up to the versions of ESXi hosts under given cluster, please reference to below: ESXi of vSphere6.0U2 and latter, supported version is 3 in upgrade process, and 2 in downgrade process; ESXi of vSphere6.0 series before vSphere6.0U2, supported version is 2 in upgrade process, and 1 in downgrade process; ESXi of lower version, is not supported;

boolean
isDataMovementRequired
Optional

Whether data movement is required if disk format conversion process is triggered.

string
storagePoolDisk
Optional

Cannonical name of the disk removed by previous DFC but not added back.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanUpgradeSystemEx/{moId}/PerformVsanUpgradePreflightCheckEx