Get-MonitoringGroup

In this article

    Gets existing monitoring groups for the Virtualization Extensions Service.

    Applies to versions: 8.0, 9.0

    Syntax

    Get-MonitoringGroup [[-Include] <String>[]] [-VESServer <Object>] [<CommonParameters>]

    Detailed Description

    This cmdlet retrieves existing monitoring groups from the Virtualization Extensions Service configuration. The cmdlet returns a collection of objects that represent monitoring groups.

    Parameters

    -Include <String[]>

    Specifies name(s) of monitoring group(s) that should be retrieved. If the parameter is not specified, the cmdlet will return all monitoring groups.

    Note

    This parameter supports wildcards. Search is not case sensitive.

     

    Description

    Aliases

     

    Required?

    False

    Position?

    1

    Default Value

     

    Accept Pipeline Input?

    False

    Accept Wildcard Characters?

    True

    -VESServer

    Specifies the Virtualization Extensions server. You can pass the following types of values:

    • Name of a machine (remote or local) where the Virtualization Extensions Service runs.

    Acceptable formats for the input value are: server name (such as "localhost" or "."), IP address (such as "172.15.19.6") and FQDN (such as "localhost.veeam.local").

    For more information, type “get-help about_VESServerParameter”.

    Description

    Aliases

     

    Required?

    False

    Position?

    Named

    Default Value

     

    Accept Pipeline Input?

    False

    Accept Wildcard Characters?

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters.  For more information about common parameters, see Microsoft Docs.

    Notes

    If the -VESServer parameter is not specified, the cmdlet will connect to the Virtualization Extensions Service on the local machine.

    Output

    The cmdlet returns a collection of Veeam.Psves.MonitoringGroup objects that represent monitoring groups.

    Example 1

    This command returns the list of all existing monitoring groups.

    Get-MonitoringGroup

    Example 2

    This command returns the “Seattle" monitoring group.

    Get-MonitoringGroup –Include Seattle

    -OR-

    Get-MonitoringGroup Seattle

    References

    To learn more about supporting wildcard characters in cmdlet parameters, see Microsoft Docs.