## PowerCLI Reference

# Get-VsanStat

## Synopsis

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

Syntax

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.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
Name | String[] | 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 | false | false
EndTime | DateTime | Specifies 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. | false | false
Entity | VIObject[] | Specifies the entity for which you want to retrieve vSAN performance metrics. OBN is supported for the Cluster, VMHost, VirtualMachine, and VsanIscsiTarget entity types. | false | true (ByValue)
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
StartTime | DateTime | Specifies the client local time from which you want to retrieve statistics. The returned samples do not include the sample at StartTime. | false | false

Return Type

Zero or more VsanStatSample objects

Notes

Examples

-------------- 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.