< Back
Test-VsanClusterHealth
Post
NAME Test-VsanClusterHealth
SYNOPSIS
This cmdlet runs a health test on the specified vSAN clusters and returns the test results.
SYNTAX
Test-VsanClusterHealth [-Cluster] <Cluster[]> [-Server <VIServer[]>] [-TestResultFilter
<VsanClusterHealthResultFilter[]>] [-UseCache] [-VMCreateTimeoutSeconds <Int32>] [<CommonParameters>]
DESCRIPTION
This cmdlet runs a health test on the specified vSAN clusters and returns the test results.
PARAMETERS
-Cluster <Cluster[]>
Specifies the clusters on which you want to run a vSAN health test.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Server <VIServer[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-TestResultFilter <VsanClusterHealthResultFilter[]>
Specifies a subset of health test results. Only the specified test result fields are returned.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseCache [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-VMCreateTimeoutSeconds <Int32>
Specifies the timeout to run virtual machine creation tests in seconds. The default value is 120.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
VsanClusterHealthTestResult objects representing the result of the test run
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ealth.html
SYNOPSIS
This cmdlet runs a health test on the specified vSAN clusters and returns the test results.
SYNTAX
Test-VsanClusterHealth [-Cluster] <Cluster[]> [-Server <VIServer[]>] [-TestResultFilter
<VsanClusterHealthResultFilter[]>] [-UseCache] [-VMCreateTimeoutSeconds <Int32>] [<CommonParameters>]
DESCRIPTION
This cmdlet runs a health test on the specified vSAN clusters and returns the test results.
PARAMETERS
-Cluster <Cluster[]>
Specifies the clusters on which you want to run a vSAN health test.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Server <VIServer[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-TestResultFilter <VsanClusterHealthResultFilter[]>
Specifies a subset of health test results. Only the specified test result fields are returned.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseCache [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-VMCreateTimeoutSeconds <Int32>
Specifies the timeout to run virtual machine creation tests in seconds. The default value is 120.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
VsanClusterHealthTestResult objects representing the result of the test run
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ealth.html