Get-StatType Command | Vmware PowerCLI Reference

Get-StatType

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

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
 Entity VIObject[] 1
  • pipeline
  • wildcards
 Specifies clusters, virtual machine hosts, resource pools, or virtual machines, for which you want to retrieve the available statistics types.
optional Finish DateTime named
Specifies 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.
optional Interval StatInterval[] named
  • wildcards
 Specifies 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.
optional Name String[] named
  • wildcards
 Specifies the names of the statistics types you want to retrieve.
optional Realtime SwitchParameter named
Indicates that you want to retrieve realtime statistics type as well. If this parameter is set, the Start and Finish parameters are ignored.
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 Connect-VIServer.
optional Start DateTime named
Specifies 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.

Output

System.String

Examples

Example 1 

Get-StatType -Entity "MyVM"

Retrieves the statistics types collected for the specified virtual machine.

Related Commands

Stat

This cmdlet retrieves the statistical information available on a vCenter Server system.

StatInterval

This cmdlet retrieves the available statistics intervals and filters them using the provided parameters.

This cmdlet creates a statistics interval with the specified parameters.

This cmdlet removes the statistics interval specified by the provided sampling period or name.

This cmdlet changes the statistics interval that is specified by the provided parameters.

StatType

This cmdlet retrieves the available statistics types for a inventory object.