vSphere PowerCLI Cmdlets Reference

Get-StatType

Synopsis

Retrieves the available statistics types for a inventory object.

Syntax

Get-StatType [[-Name] <String[]>] [-Entity] <InventoryItem[]> [-Start <DateTime>] [-Finish <DateTime>] [-Interval <StatInterval[]>] [-Realtime] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version
Get-Stat
Get-StatInterval
New-StatInterval
Remove-StatInterval
Set-StatInterval

Detailed Description

Retrieves the available statistics types for a virtual machine, virtual machine host, cluster, or resource pool. Performance statistics types can be filtered by their names, start and finish times, and collection intervals. If the Realtime parameter is set, the Start and Finish parameters are ignored.

Parameters

NameDescriptionRequired?Pipeline InputDefault Value
NameSpecify the names of the statistics types you want to retrieve.falsefalse
EntitySpecify clusters, virtual machine hosts, resource pools, or virtual machines, for which you want to retrieve the available statistics types.truetrue (ByValue)
StartSpecify the beginning of the time range for which the statistics types you want to retrieve are collected. The valid format is dd/mm/yyyy. This value corresponds to the server time. When the start time is omitted, the returned statistics types start from the first available statistics type in the system.falsefalse
FinishSpecify the end of the time range for which the statistics types you want to retrieve are collected. The valid format is dd/mm/yyyy. This value corresponds to the server time. When the finish time is omitted, the returned result includes up to the most recent statistics type.falsefalse
IntervalSpecify the interval, at which the statistics types you want to retrieve are gathered. The interval can be specified by its name or by its sampling period in seconds.falsefalse
RealtimeIndicate that you want to retrieve realtime statistics type as well. If this parameter is set, the Start and Finish parameters are ignored.falsefalse
ServerSpecify the vSphere servers 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

Return Type

System.String

Notes

Zero or more strings representing statistics types.

Examples

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

Get-StatType -Entity VM

Retrieves the statistics types collected for the VM virtual machine.


Copyright © 1998 - 2010 VMware, Inc. All rights reserved.