PowerCLI Reference

Get-Metric

Synopsis

This cmdlet retrieves the available metrics on a vCenter Server system.

Syntax

Get-Metric [[-Name] <String[]>] [-MetricGroup <String[]>] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Get-AlarmAction
Get-AlarmActionTrigger
Get-AlarmDefinition
Get-AlarmTrigger
New-AlarmAction
New-AlarmActionTrigger
New-AlarmDefinition
New-AlarmTrigger
Remove-AlarmAction
Remove-AlarmActionTrigger
Remove-AlarmDefinition
Set-AlarmDefinition
Get-Metric
Get-EventType

Detailed Description

This cmdlet retrieves the available metrics on a vCenter Server system. The cmdlet returns a set of metrics that correspond to the filter criteria provided by the cmdlet parameters. To specify a server different from the default one, use the Server parameter.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the metrics that you want to retrieve.falseFalse
MetricGroupString[]Specifies the metric groups of the metrics that you want to retrieve.falseFalse
ServerVIServer[]Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.falseFalse

Return Type

VMware.VimAutomation.ViCore.Types.V1.Metric

Notes

Examples

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

Get-Metric

Retrieves all available metrics.

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

Get-Metric -Name "Usage*"

Retrieves metrics with the name Usage.

-------------------------- Example 3 --------------------------

Get-Metric -MetricGroup "CPU" $server

Retrieves all available metrics on the server that match the pattern.

-------------------------- Example 4 --------------------------

Get-Metric -Name "Usage" -MetricGroup "CPU"

Retrieves all metrics with the name Usage from a metric group CPU.


Copyright © VMware, Inc. All rights reserved.