vSphere PowerCLI Cmdlets Reference

Get-Stat

Synopsis

Retrieves the statistical information available on a vSphere server.

Syntax

Get-Stat [-Entity] <VIObject[]> [-Common] [-Memory] [-Cpu] [-Disk] [-Network] [-Stat <String[]>] [-Start <DateTime>] [-Finish <DateTime>] [-MaxSamples <Int32>] [-IntervalMins <Int32>] [-IntervalSecs <Int32>] [-Instance <String[]>] [-Realtime] [<CommonParameters>]

Related Commands

Online version
Get-StatType
Get-StatsInterval
New-StatsInterval
Remove-StatsInterval
Set-StatsInterval

Detailed Description

Retrieves the statistical information available on a vSphere server for each provided entity. For example, if the CPU parameter is set to $true, collects the average CPU usage and the average CPU usagemhz counters as appropriate for each entity. If the Stats parameter is set to $true, collects all provided named stats counters. Counters are provided using a dotted notation of the form "counter group"."counter name"."rollup type". For example: "cpu.usage.min". The cmdlet uses the Start time, if provided, and the Finish time, if provided, along with the MaxSamples, if provided, to bound the data collection. If intervalSecs is provided, the closest matching available interval is used. For each statistics sample on the server, the cmdlet returns a Sample object. The Instance property of the Sample object shows the serial number of the device for which a statistics value is taken. If the Instance property is empty ("), this indicates that the statistics sample contains an average statistic value for all specified devices. If you are connected to a vCenter Server and Get-Stat is run for a host entity, the cmdlet returns only the statistics available on the vCenter Server.

Parameters

NameDescriptionRequired?Pipeline InputDefault Value
EntitySpecify the objects (such as virtual machine, virtual machine host, resource pool, and so on) whose statistics you want to retrieve.truetrue (ByValue)
CommonIndicate whether the command collects common CPU, disk, memory and network statistics.falsefalse
MemoryIndicate whether the command collects common memory statistics, such as the mem usage, mem vmmemctl, mem active and mem granted counters as appropriate for each entity.falsefalse
CpuIndicate whether the command collects common CPU statistics, such as the average CPU usage and average CPU usagemhz counters as appropriate for each entity.falsefalse
DiskIndicate whether the command collects common disk statistics, such as the average disk usage, average disk read and average disk write counters as appropriate for each entity.falsefalse
NetworkIndicate whether the command collects common network statistics, such as the average network usage, average network transmitted and average network received counters as appropriate for each entity.falsefalse
StatSpecify the identifiers of the statistics you want to retrieve. Counters are provided using a dotted notation of the form "counter group"."counter name"."rollup type". For example, "cpu.usage.min".falsefalse
StartSpecify the beginning of the time range for which you want to collect statistics. The valid format is dd/mm/yyyy.falsefalse
FinishSpecify the end of the time range for which you want to collect statistics. The valid format is dd/mm/yyyy.falsefalse
MaxSamplesSpecify the maximum number of samples for each statistic.falsefalse
IntervalMinsSpecify the interval in minutes of the statistics samples you want to retrieve. The closest available statistics interval is taken.
If the IntervalMins parameter is not specified, the samples with the best sample rate are retrieved. A best sample rate is the highest sample rate, whose relevant period contains the relevant periods for all other sample rates. A relevant period is the period that starts no earlier than the oldest sample still retained, and is a subset of a query period specified by the user.

Note that this parameter is deprecated and will be removed in a future release.
falsefalse
IntervalSecsSpecify the interval in seconds of the statistics samples you want to retrieve. The closest available statistics interval is taken.falsefalse
InstanceSpecify the Instance property of the statistics you want to retrieve.falsefalse
RealtimeIndicate whether the command collects real time statistics.falsefalse

Return Type

Sample

Notes

Samples are not generated for a virtual machine while it is powered off.

Examples

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

Get-Stat -Entity VM -Start 5/5/2008 -Finish 7/10/2008 -Disk -IntervalSecs 300

Prints the disk statistics for the specified time interval for the first virtual machine, retrieved by the Get-VM cmdlet.

-------------- Example 2 --------------

Get-Stat ?Entity Host ?Cpu ?Instance 0, "

Retrieves the cumulative statistics for a multiprocessor host and the CPU statistics for the first processor.


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