Get-OMStatKey

This cmdlet retrieves vRealize Operations Manager statistic keys for a specified adapter and a specified resource. A statistic key, or a metric key, is an identifier of a vRealize Operations Manager 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]

Parameters

Required Parameter Name Type Position Features Description
optional
AdapterKind
String[] named
  • wildcards
  • Specifies the vRealize Operations resource kind for which to retrieve the valid statistic counter keys.
    optional
    Name
    String[] named
  • wildcards
  • Filters the statistic keys by name.
    optional
    ResourceKind
    String[] named
  • wildcards
  • Specifies the adapter kind for which to retrieve the valid statistic counter keys.
    optional
    Server
    OMServer[] named Specifies the vRealize Operations Manager 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.

    -Resource  <OMResource[]>
    [-Name  <String[]>]
    [-Server  <OMServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Resource
    OMResource[] named
  • wildcards
  • pipeline
  • Specifies the resource object for which to return the valid instance metric keys.
    optional
    Name
    String[] named
  • wildcards
  • Filters the statistic keys by name.
    optional
    Server
    OMServer[] named Specifies the vRealize Operations Manager 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

    Feedback

    Was this page helpful?