Get-StatType

NAME Get-StatType



SYNOPSIS

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





SYNTAX

Get-StatType [[-Name] <String[]>] [-Entity] <VIObject[]> [-Finish <DateTime>] [-Interval <StatInterval[]>]

[-Realtime] [-Server <VIServer[]>] [-Start <DateTime>] [<CommonParameters>]





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

-Entity <VIObject[]>

Specifies clusters, virtual machine hosts, resource pools, or virtual machines, for which you want to retrieve

the available statistics types.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the statistics types you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? true



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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more System.String objects







NOTES





Zero or more strings representing statistics types.



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



Get-StatType -Entity VM



Retrieves the statistics types collected for the VM virtual machine.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... tType.html

Get-Stat

Get-StatInterval

New-StatInterval

Remove-StatInterval

Set-StatInterval