Syntax
Get-StatType [[-Name] <String[]>] [-Entity] <VIObject[]> [-Finish <DateTime>] [-Interval <StatInterval[]>] [-Realtime] [-Server <VIServer[]>] [-Start <DateTime>] [<CommonParameters>]Related Commands
Online VersionDetailed Description
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.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Specifies the names of the statistics types you want to retrieve. | false | False | |
| Entity | VIObject[] | Specifies clusters, virtual machine hosts, resource pools, or virtual machines, for which you want to retrieve the available statistics types. | true | True (ByValue) | |
| Finish | DateTime | 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. | false | False | |
| Interval | StatInterval[] | 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. | false | False | |
| Realtime | SwitchParameter | Indicates that you want to retrieve realtime statistics type as well. If this parameter is set, the Start and Finish parameters are ignored. | false | False | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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. | false | False | |
| Start | DateTime | 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. | false | False |
Return Type
Zero or more System.String objectsNotes
Zero or more strings representing statistics types.Examples
-------------------------- Example 1 --------------------------
Get-StatType -Entity VM
Retrieves the statistics types collected for the VM virtual machine.