PowerCLI Reference



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


Test-VsanStoragePerformance [-Cluster] <Cluster[]> [-RunAsync] [-Server <VIServer[]>] [-StoragePolicy <SpbmStoragePolicy>] [-TestDurationSeconds <Int32>] [-UseCache] [-Workload <VsanStorageWorkloadType>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

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

This cmdlet is obsolete and will be removed in a future release.


NameTypeDescriptionRequired?Pipeline InputDefault Value
ClusterCluster[]Specifies the clusters on which you want to run a vSAN storage performance test.trueTrue (ByValue)
RunAsyncSwitchParameterIndicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.falseFalse
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
StoragePolicySpbmStoragePolicySpecifies the storage policy you want to use.falseFalse
TestDurationSecondsInt32Specifies the duration of the storage performance test in seconds. When the UseCache parameter is not specified, TestDurationSeconds must be specified.falseFalse
UseCacheSwitchParameterIndicates whether to get a cached result from the server. If specified, a test is not run on the server and the last result cached on the server side is returned. If not specified, a test is run on the server side and the result is returned.falseFalse
WorkloadVsanStorageWorkloadTypeSpecifies the type of workload which should be run to test the storage performance.falseFalse

Return Type

VsanClusterStoragePerformanceTestResult objects representing the result of the test run



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

Test-VsanStoragePerformance -Cluster $cluster -TestDurationsSeconds 120 -StoragePolicy $policy -WorkLoad BasicSanityTest

Runs the storage performance test of basic sanity workload type with test duration of 120 seconds, using the $policy storage policy on the $cluster vSAN cluster, and returns the result of the test.

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

Test-VsanStoragePerformance -Cluster $cluster -UseCache

Gets the result of the last storage performance test run on the $cluster vSAN cluster.

Copyright © VMware, Inc. All rights reserved.