powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-StatType



NAME
Get-StatType

SYNOPSIS
Retrieves the available statistics types for a inventory object.

SYNTAX
Get-StatType [[-Name] ] [-Entity] [-Start ] [-Finish ] [-Interval <
StatInterval[]>] [-Realtime] [-Server ] []


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


PARAMETERS
-Name
Specify the names of the statistics types you want to retrieve.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Entity
Specify clusters, virtual machine hosts, resource pools, or virtual machines, for which you want to retrieve th
e available statistics types.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Start
Specify 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 retu
rned statistics types start from the first available statistics type in the system.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

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

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Interval
Specify the interval, at which the statistics types you want to retrieve are gathered. The interval can be spec
ified by its name or by its sampling period in seconds.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Realtime
Indicate that you want to retrieve realtime statistics type as well. If this parameter is set, the Start and Fi
nish parameters are ignored.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
System.String


NOTES


Zero or more strings representing statistics types.

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

C:\PS>Get-StatType -Entity VM


Retrieves the statistics types collected for the VM virtual machine.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Get-StatType.html
Get-Stat
Get-StatInterval
New-StatInterval
Remove-StatInterval
Set-StatInterval