Get-VsanPerformanceContributor Command | Vmware PowerCLI Reference

Get-VsanPerformanceContributor

This cmdlet retrieves a list of the most impactful vSAN performance contributors, based on the specified entity type. The list includes the contributors that exhibit the highest IOPS, throughput, or latency consumption within the provided start and end times in the specified vSAN cluster.

Syntax

Get-VsanPerformanceContributor
-Cluster < Cluster >
[-EndTime < DateTime > ]
[-EntityCountLimit < Int32 > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-StartTime < DateTime > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Cluster Cluster named
  • pipeline
  • wildcards
Specifies the cluster for which you want to retrieve vSAN performance contributors.
optional EndTime DateTime named
Specifies the client local end time for which you want to retrieve vSAN performance contributors.
optional Entity VsanPerfContributorEntityType named
Specifies the entity for which you want to retrieve vSAN performance contributors. Represents the managed object type of the top entities. The accepted values are VirtualMachine, DiskGroup, HostDomClient, HostDomCompmgr, and VsanEsaDiskLayer.
optional EntityCountLimit Int32 named
Specifies the number of vSAN performance contributors that you want to retrieve. The default value is 10 and the maximum is 64.
optional MetricId VsanPerfContributorMetricIdType named
Specifies the metric for which you want to retrieve vSAN performance contributors. The valid metric types for the "VirtualMachine", "DiskGroup", "HostDomClient", and "HostDomCompmgr" entities are "IopsRead", "IopsWrite", "ThroughputRead", "ThroughputWrite", "LatencyRead", "LatencyWrite". The valid metric types for the "VsanEsaDiskLayer" entity are "IopsReadCapacity", "IopsWriteCapacity", "TputReadCapacity", "TputWriteCapacity", "AvgLatReadCapacity", and "AvgLatWriteCapacity".
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
optional StartTime DateTime named
Specifies the client local start time for which you want to retrieve vSAN performance contributors. Please note that the maximum allowable duration between StartTime and EndTime is 24 hours.

Output

VMware.VimAutomation.Storage.Types.V1.Vsan.Performance.VsanPerformanceContributor

Examples

Example 1

$cluster = get-cluster
Get-VsanPerformanceContributor -StartTime 2023-08-28T05:17:00 -Entity "HostDomClient" -EndTime 2023-08-28T06:17:00 -MetricId "LatencyWrite" -Cluster $cluster

Retrieves the vSAN performance entities given the time constraints, the "HostDomClient" entity type, and the "LatencyWrite" metric.

Example 2

get-vsanperformanceContributor -startTime 2023-08-27T05:17:00 -entity "VirtualMachine" -endtime 2023-08-28T06:17:00 -cluster $cluster -EntityCountLimit 5 -MetricId "IopsWrite"

Retrieves the top five vSAN performance entities given the time constraints, the "VirtualMachine" entity type, and the "IopsWrite" metric.

Related Commands

VsanPerformanceContributor

This cmdlet retrieves a list of the most impactful vSAN performance contributors, based on the specified entity type. The list includes the contributors that exhibit the highest IOPS, throughput, or latency consumption within the provided start and end times in the specified vSAN cluster.