Vsan Upgrade System Perform Vsan Upgrade Preflight Check

Vsan Upgrade System Perform Vsan Upgrade Preflight Check

Perform an upgrade pre-flight check on a cluster.

Required privileges: System.Read

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/VsanUpgradeSystem/{moId}/PerformVsanUpgradePreflightCheck
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 VsanUpgradeSystem/{moId}.

string
release
Required

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

Request Body
PerformVsanUpgradePreflightCheckRequestType of type(s) application/json
Required

Show optional properties

{
    "cluster": {}
}
{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "downgradeFormat": false
}
MoRefClusterComputeResource
cluster
Required

Reference to an instance of the ClusterComputeResource managed object.

boolean
downgradeFormat
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
200

Pre-flight check result.

Returns VsanUpgradeSystemPreflightCheckResult of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "issues": [
        {
            "_typeName": "string",
            "msg": "string"
        }
    ],
    "diskMappingToRestore": {
        "_typeName": "string",
        "ssd": {
            "_typeName": "string",
            "deviceName": "string",
            "deviceType": "string",
            "key": "string",
            "uuid": "string",
            "descriptor": [
                {
                    "_typeName": "string",
                    "quality": "string",
                    "id": "string"
                }
            ],
            "canonicalName": "string",
            "displayName": "string",
            "lunType": "string",
            "vendor": "string",
            "model": "string",
            "revision": "string",
            "scsiLevel": 0,
            "serialNumber": "string",
            "durableName": {
                "_typeName": "string",
                "namespace": "string",
                "namespaceId": 0,
                "data": [
                    0
                ]
            },
            "alternateName": [
                {
                    "_typeName": "string",
                    "namespace": "string",
                    "namespaceId": 0,
                    "data": [
                        0
                    ]
                }
            ],
            "standardInquiry": [
                0
            ],
            "queueDepth": 0,
            "operationalState": [
                "string"
            ],
            "capabilities": {
                "_typeName": "string",
                "updateDisplayNameSupported": false
            },
            "vStorageSupport": "string",
            "protocolEndpoint": false,
            "perenniallyReserved": false,
            "clusteredVmdkSupported": false,
            "applicationProtocol": "string",
            "dispersedNs": false,
            "deviceReservation": "string",
            "capacity": {
                "_typeName": "string",
                "blockSize": 0,
                "block": 0
            },
            "devicePath": "string",
            "ssd": false,
            "localDisk": false,
            "physicalLocation": [
                "string"
            ],
            "emulatedDIXDIFEnabled": false,
            "vsanDiskInfo": {
                "_typeName": "string",
                "vsanUuid": "string",
                "formatVersion": 0
            },
            "scsiDiskType": "string",
            "usedByMemoryTiering": false
        },
        "nonSsd": [
            {
                "_typeName": "string",
                "deviceName": "string",
                "deviceType": "string",
                "key": "string",
                "uuid": "string",
                "descriptor": [
                    {
                        "_typeName": "string",
                        "quality": "string",
                        "id": "string"
                    }
                ],
                "canonicalName": "string",
                "displayName": "string",
                "lunType": "string",
                "vendor": "string",
                "model": "string",
                "revision": "string",
                "scsiLevel": 0,
                "serialNumber": "string",
                "durableName": {
                    "_typeName": "string",
                    "namespace": "string",
                    "namespaceId": 0,
                    "data": [
                        0
                    ]
                },
                "alternateName": [
                    {
                        "_typeName": "string",
                        "namespace": "string",
                        "namespaceId": 0,
                        "data": [
                            0
                        ]
                    }
                ],
                "standardInquiry": [
                    0
                ],
                "queueDepth": 0,
                "operationalState": [
                    "string"
                ],
                "capabilities": {
                    "_typeName": "string",
                    "updateDisplayNameSupported": false
                },
                "vStorageSupport": "string",
                "protocolEndpoint": false,
                "perenniallyReserved": false,
                "clusteredVmdkSupported": false,
                "applicationProtocol": "string",
                "dispersedNs": false,
                "deviceReservation": "string",
                "capacity": {
                    "_typeName": "string",
                    "blockSize": 0,
                    "block": 0
                },
                "devicePath": "string",
                "ssd": false,
                "localDisk": false,
                "physicalLocation": [
                    "string"
                ],
                "emulatedDIXDIFEnabled": false,
                "vsanDiskInfo": {
                    "_typeName": "string",
                    "vsanUuid": "string",
                    "formatVersion": 0
                },
                "scsiDiskType": "string",
                "usedByMemoryTiering": false
            }
        ]
    }
}
array of VsanUpgradeSystemPreflightCheckIssue
issues
Optional

Detected issues.

In some cases, not all possible issues are captured, i.e. only the first (few) issues may be captured, and only once those are resolved would additional issues be reported. Absence of issues means the pre-flight check passed.

VsanHostDiskMapping
diskMappingToRestore
Optional

A VsanHostDiskMapping is a set of one SSD HostScsiDisk backed by a set of one or more non-SSD HostScsiDisk.

The maximum allowed VsanHostDiskMapping for a host is 5. A maximum set of 7 non-SSDs HostScsiDisk can be added to the one SSD HostScsiDisk.

See also VsanHostConfigInfoStorageInfo, InitializeDisks_Task.


500

Failure

Returns VsanFault of type(s) application/json
This response body class contains all of the following: VimFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Virtual Infrastructure Operations
POST
Vsan Upgrade System Perform Vsan Upgrade Task
POST
Vsan Upgrade System Perform Vsan Upgrade Preflight Check
POST
Vsan Upgrade System Query Vsan Upgrade Status