Get-OMStatKey
This cmdlet retrieves VMware Aria Operations statistic keys for a specified adapter and a specified resource. A statistic key, or a metric key, is an identifier of a VMware Aria Operations metric which can be used to refer to this metric when necessary. For example, you can refer to a metric when retrieving data for it.
Syntax
[-AdapterKind
<String[]>]
[-Name <String[]>]
[-ResourceKind <String[]>]
[-Server <OMServer[]>]
[CommonParameters]
[-Name <String[]>]
[-ResourceKind <String[]>]
[-Server <OMServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
String[] | named |
|
Specifies the vRealize Operations resource kind for which to retrieve the valid statistic counter keys. | optional |
|
String[] | named |
|
Filters the statistic keys by name. | optional |
|
String[] | named |
|
Specifies the adapter kind for which to retrieve the valid statistic counter keys. | optional |
|
OMServer[] | named |
|
Specifies the VMware Aria Operations server from which you want to retrieve alerts. The value can be the connection object returned by the Connect-OMServer cmdlet or the object's name, which can be the IP or DNS address of the server machine. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
OMResource[] | named |
|
Specifies the resource object for which to return the valid instance metric keys. Note: The returned keys that identify metric data for a specific instance object, like a CPU or network adapter, do not contain a description or ExtensionData info. | optional |
|
String[] | named |
|
Filters the statistic keys by name. | optional |
|
OMServer[] | named |
|
Specifies the VMware Aria Operations server from which you want to retrieve alerts. The value can be the connection object returned by the Connect-OMServer cmdlet or the object's name, which can be the IP or DNS address of the server machine. |
Output
VMware.VimAutomation.vROps.Types.V1.OMStatKey
Examples
Example 1
Get-OMStatKey -Name 'diskspace|total|*'
Retrieves statistic keys whose name begins with 'diskspace|total|'.
Example 2
Get-OMStatKey -AdapterKind 'VMware'
Retrieves statistic keys for the 'VMware' adapter kind.
Example 3
Get-OMStatKey -ResourceKind 'Folder'
Retrieves statistic keys for the 'Folder' resource kind.
Example 4
Get-OMResource 'MyDatastore' | Get-OMStatKey
Retrieves statistic keys for the 'MyDatastore' resource.
Related Commands
OMStat
This cmdlet retrieves statistical data from the specified VMware Aria Operations server.
OMStatKey
This cmdlet retrieves VMware Aria Operations statistic keys.
