PowerCLI Reference

Test-VsanNetworkPerformance

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

Syntax

Test-VsanNetworkPerformance [-Cluster] <Cluster[]> [-DurationInSecond <Int32>] [-Server <VIServer[]>] [-UseCache] [<CommonParameters>]

Related Commands

Detailed Description

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

Parameters

Name	Type	Description	Required?	Pipeline Input
Cluster	Cluster[]	Specifies the clusters on which you want to run a vSAN network performance test.	true	True (ByValue)
DurationInSecond	Int32	The duration of network performance test in seconds.	false	False
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.	false	False
UseCache	SwitchParameter	Indicates 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.	false	False

Return Type

VsanClusterNetworkPerformanceTestResult objects representing the result of the test run

Notes

Examples

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

Test-VsanNetworkPerformance -Cluster $cluster

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

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

Test-VsanNetworkPerformance -Cluster $cluster -UseCache

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

-------------------------- Example 3 --------------------------

Test-VsanNetworkPerformance -Cluster $cluster -DurationInSecond 10

Runs the network performance test on the $cluster vSAN cluster for 10 seconds and returns the result of the test.