Get-SCPROMonitorConfiguration

Module:

VirtualMachineManager Module

Gets a PRO monitor configuration object for a specified scope.

Syntax

HostGroup (Default)

Get-SCPROMonitorConfiguration
    -VMHostGroup <HostGroup>
    [-VMMServer <ServerConnection>]
    [-PROMonitor <PROMonitor>]
    [<CommonParameters>]

Cloud

Get-SCPROMonitorConfiguration
    -Cloud <Cloud>
    [-VMMServer <ServerConnection>]
    [-PROMonitor <PROMonitor>]
    [<CommonParameters>]

HostCluster

Get-SCPROMonitorConfiguration
    -VMHostCluster <HostCluster>
    [-VMMServer <ServerConnection>]
    [-PROMonitor <PROMonitor>]
    [<CommonParameters>]

Service

Get-SCPROMonitorConfiguration
    -Service <Service>
    [-VMMServer <ServerConnection>]
    [-PROMonitor <PROMonitor>]
    [<CommonParameters>]

VMMServer

Get-SCPROMonitorConfiguration
    [-VMMServer <ServerConnection>]
    [-VMMServerScope]
    [-PROMonitor <PROMonitor>]
    [<CommonParameters>]

VMHost

Get-SCPROMonitorConfiguration
    -VMHost <Host>
    [-VMMServer <ServerConnection>]
    [-PROMonitor <PROMonitor>]
    [<CommonParameters>]

VM

Get-SCPROMonitorConfiguration
    -VM <VM>
    [-VMMServer <ServerConnection>]
    [-PROMonitor <PROMonitor>]
    [<CommonParameters>]

ComputerTier

Get-SCPROMonitorConfiguration
    -ComputerTier <ComputerTier>
    [-VMMServer <ServerConnection>]
    [-PROMonitor <PROMonitor>]
    [<CommonParameters>]

Description

The Get-SCPROMonitorConfiguration cmdlet gets one or more Performance and Resource Optimization (PRO) monitor configuration objects for a specified scope.

Examples

Example 1: Get all PRO monitor configuraiton objects on a specified host group

PS C:\> $HostGroup = Get-SCVMHostGroup -Name "Production"
PS C:\> $PROMonitorConfig = Get-SCPROMonitorConfiguration -VMHostGroup $HostGroup
PS C:\> $PROMonitorConfig

The first command gets the host group object named Production and stores the object in the $HostGroup variable.

The second command gets the PRO monitor configuration objects on the host group stored in $HostGroup (Production) and stores the objects in the $PROMonitorConfig variable.

The last command displays information about the PRO monitor configuration objects stored in $PROMonitorConfig to the user.

Parameters

-Cloud

Specifies a private cloud object.

Parameter properties

Type:	Cloud
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Cloud

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ComputerTier

Specifies a computer tier object.

Parameter properties

Type:	ComputerTier
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ComputerTier

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PROMonitor

Specifies a PRO monitor object.

Parameter properties

Type:	PROMonitor
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Service

Specifies a Virtual Machine Manager (VMM) service object.

Parameter properties

Type:	Service
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Service

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VM

Specifies a virtual machine object.

Parameter properties

Type:	VM
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

VM

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VMHost

Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts.

For more information about each type of host, see the Add-SCVMHost cmdlet.

Parameter properties

Type:	Host
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

VMHost

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VMHostCluster

Specifies a VMM host cluster object.

Parameter properties

Type:	HostCluster
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

HostCluster

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VMHostGroup

Specifies a virtual machine host group object.

Parameter properties

Type:	HostGroup
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

HostGroup

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VMMServer

Specifies a VMM server object.

Parameter properties

Type:	ServerConnection
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VMMServerScope

Indicates that the PRO information returned is scoped to the entire VMM server.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

VMMServer

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

PROMonitorConfiguration

This cmdlet returns a PROMonitorConfiguration object.

Related Links

• Set-SCPROMonitorConfiguration