PowerCLI Reference



This cmdlet retrieves vSAN performance statistics for the specified server entity.


Get-VsanStat [[-Name] <String[]>] [-Entity <VIObject[]>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version

Detailed Description

This cmdlet retrieves vSAN performance statistics for the specified server entity.


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the performance metrics you want to retrieve. If not specified, all the metrics are returned. The value is in the format 'ViewName.MetricName'.

ViewName is applicable to different entity types:
Cluster: Backend, VMConsumption
VMHost: Backend, VMConsumption, HostNetwork, HostIscsi
VirtualMachine: Performance
HardDisk: VirtualDisk, Vscsi
VsanDisk: Performance
VsanDiskGroup: Performance
VsanIscsiTarget: Performance
VsanIscsiLun: Performance
EndTimeDateTimeSpecifies the client local time up to which you want to retrieve statistics. If the specified value is later than current server time, the value is replaced by the current server time. The returned samples include the sample at EndTime.falsefalse
EntityVIObject[]Specifies the entity for which you want to retrieve vSAN performance metrics. OBN is supported for the Cluster, VMHost, VirtualMachine, and VsanIscsiTarget entity types.falsetrue (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
StartTimeDateTimeSpecifies the client local time from which you want to retrieve statistics. The returned samples do not include the sample at StartTime.falsefalse

Return Type

Zero or more VsanStatSample objects



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

$diskGroups = Get-VsanDiskGroup -Cluster "vsan-cluster"
Get-VsanStat -Entity $diskGroups

Retrieves all vSAN performance samples for vSAN disk groups of the "vsan-cluster" cluster.

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

Get-VsanStat -Entity "vsan-cluster" -Name "Backend.ReadThroughput"

Retrieves vSAN performance samples for backend read throughput of the "vsan-cluster" cluster.

Copyright © VMware, Inc. All rights reserved.