PowerCLI Reference



This cmdlet runs a health test on the specified vSAN clusters and returns the test results.


Test-VsanClusterHealth [-Cluster] <Cluster[]> [-Server <VIServer[]>] [-TestResultFilter <VsanClusterHealthResultFilter[]>] [-UseCache] [-VMCreateTimeoutSeconds <Int32>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet runs a health test on the specified vSAN clusters and returns the test results.


NameTypeDescriptionRequired?Pipeline InputDefault Value
ClusterCluster[]Specifies the clusters on which you want to run a vSAN health test.trueTrue (ByValue)
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falseFalse
TestResultFilterVsanClusterHealthResultFilter[]Specifies a subset of health test results. Only the specified test result fields are returned.falseFalse
UseCacheSwitchParameterIndicates to return the result directly from cache instead of running the full health check. The cache is updated periodically and keeps the latest vSAN health summary check result, either triggered from a user on-demand request or the periodical vSAN health check for triggering a health event or alarm.falseFalse
VMCreateTimeoutSecondsInt32Specifies the timeout to run virtual machine creation tests in seconds. The default value is 120.falseFalse

Return Type

VsanClusterHealthTestResult objects representing the result of the test run



-------------------------- Example 1 --------------------------

Test-VsanClusterHealth -Cluster $cluster

Runs the vSAN cluster health test on $cluster vSAN cluster and returns the result of the test.

-------------------------- Example 2 --------------------------

Test-VsanVMCreation -Cluster $cluster -UseCache -TestResultFilter NetworkHealth, DiskBalance

Gets the result of the last health test run on $cluster vSAN cluster. Returns test result fields for network health and disk balance.

Copyright © VMware, Inc. All rights reserved.