Test-VsanClusterHealth

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

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Cluster
Cluster[] named
  • wildcards
  • pipeline
  • Specifies the clusters on which you want to run a vSAN health test.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    TestResultFilter
    VsanClusterHealthResultFilter[] named Specifies a subset of health test results. Only the specified test result fields are returned.
    optional
    UseCache
    SwitchParameter named Indicates 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.
    optional
    VMCreateTimeoutSeconds
    Int32 named Specifies the timeout to run virtual machine creation tests in seconds. The default value is 120.

    Output

    VMware.VimAutomation.Storage.Types.V1.Vsan.Health.VsanClusterHealthTestResult

    Examples


    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.

    Related Commands

    Feedback

    Was this page helpful?