Read-SCVMHostCluster

Refreshes host cluster properties in the VMM console.

Syntax

Read-SCVMHostCluster
    [-VMHostCluster] <HostCluster>
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

The Read-SCVMHostCluster cmdlet refreshes host cluster properties so that the Virtual Machine Manager (VMM) console displays updated information about the host cluster.

Examples

Example 1: Refresh information about a specific host cluster

PS C:\> Get-SCVMHostCluster -Name "VMHostCluster01.Contoso.Com" | Read-SCVMHostCluster

This command gets the host cluster object named VMHostCluster01 and passes the object to the Refresh-SCVMHostCluster cmdlet, which refreshes the properties for the host cluster so that current information about the host cluster appears in the VMM console.

Required Parameters

-VMHostCluster

Specifies a VMM host cluster object.

Type:HostCluster
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

VMHostCluster

This cmdlet returns a VMHostCluster object.