Vsan File Service System Vsan Perform File Service Enable Preflight Check

Perform a preflight check on a cluster for enabling vSAN file service and/or for the new file service domain configuration.

The preflight check items includes:

Basic check
- Network partition check
- vSAN datastore presence to each host
- The versions of the ESXi hosts match in this cluster
- NTP configuration check in ESXi hosts if vSAN file service version is 8.0 or newer
- Domain configuration format check
- Running OVF information check
- If a DVS portgroup is passed as network, it checks if DVS version is older than 6.6
Advanced check
- Checks covered in 'basic' scope
- File server domain configuration validation in live environment when vSAN file service has been enabled

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanPerformFileServiceEnablePreflightCheck

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 VsanFileServiceSystem/{moId}.

string

release

Required

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

Request Body

VsanPerformFileServiceEnablePreflightCheckRequestType of type(s) application/json

Required

"VsanPerformFileServiceEnablePreflightCheckRequestType Object"

cluster

Required

The target cluster to perform preflight check.

Required privileges: System.Read

domainConfig

Optional

The domain configuration to be validated. If not specified, the validation for the domain will be skipped.

network

Optional

The network which will be used for fs containers

string

scope

Optional

The scope that preflight check will cover. Valid inputs are listed in the VsanFileServicePreflightCheckScopeEnum field. Defaults to "basic".

string

domainUuid

Optional

The file service domain UUID. It is required when the advanced preflight check is performed on an existing domain. If a new file service domain is to be created, leave it empty.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Preflight check result.

Returns VsanFileServicePreflightCheckResult of type(s) application/json

"VsanFileServicePreflightCheckResult Object"

string

ovfInstalled

Optional

This field indicates whether the file service OVF for running vSAN file services has been installed on the vCenter or not.

This field will show the highest OVF version present on this vCenter that is compatible to the cluster. This field will not be set if no compatible OVF version could be found on this vCenter.

string

fsvmVersion

Optional

This field indicates current running file service OVF version used by vSAN file service.

It will only be present if there are file service VMs running in this cluster without mixed version.

string As date-time As date-time

lastUpgradeDate

Optional

This field indicates date file service VMs last upgraded.

string

ovfMixedModeIssue

Optional

Field to indicate whether there are multiple file service VM ovf versions running.

This field will be left empty if there is no issue regarding the mixed OVF version file service VMs.

string

hostVersion

Optional

Field to indicate the lowest host version in this cluster.

This filed will be left empty if there are no hosts in the cluster.

string

mixedModeIssue

Optional

vSAN file service cannot be enabled when there is any host whose version is lower than minimum required host version in this cluster.

Minimum required host version is 7.0.0 in vSAN OSA cluster, or 8.0.2 in vSAN ESA cluster. This issue will be reported if any host whose version is lower than minimum required host version is detected. If this field is empty, it means that all the hosts in the cluster meet the version requirement.

string

networkPartitionIssue

Optional

Issues regarding whether there are network partitions in the cluster.

This field will be left empty if there are no network partitions in this cluster.

string

vsanDatastoreIssue

Optional

Checks whether the vSAN datastore is present to all the hosts to the cluster.

If hosts without vSAN datastore will be reported in this field. This field will be left empty if all the host in this cluster are with vSAN datastore.

string

domainConfigIssue

Optional

Checks whether the domain configuration is valid.

Currently the check includes the existence of the file server IP addresses, the correctness of file server AD domain username and password, the network connectivity of file server domain configuration. This field will only be present when the domain configuration issue is detected.

string

fileServiceVersion

Optional

This field indicates the highest file service version that the cluster can support.

The field will be left empty if the cluster doesn't meet the requirement to enalbe file service.

string

dvsConfigIssue

Optional

Checks whether the dvs configuration is valid.

This check validates if the supplied network for file service is dvsPortGroup, the DSwitch which is hosting the port group has version equal to or older then 6.6.0. This field will only be present when DVS configuration issue is detected.

string

domainConfigWarning

Optional

This field indicates the network connectivity between file server and gateway.

Currently, it will only be present when file server could not connect to gateway. As it is a warning, it won't block user to proceed.

string

ntpConfigWarning

Optional

Checks whether the NTP is configured in ESXi hosts.

This field will only be present when the NTP is not configured in ESXi hosts. Without NTP configured, it won't block user to proceed while user might encounter failure later when joining Active Directory domain if time is out of sync.

string

svsConfigIssue

Optional

Checks whether the standard switch configuration is valid.

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

V San Service Api Operations

POST

Vsan File Service System Vsan Cluster Create Fs Domain

POST