Read-SCVMHostCluster

Applies To: System Center 2012 - Virtual Machine Manager

Read-SCVMHostCluster

Refreshes host cluster properties in the VMM console.

Syntax

Parameter Set: Default
Read-SCVMHostCluster [-VMHostCluster] <HostCluster> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]

Detailed Description

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

For more information about Read-SCVMHostCluster, type: "Get-Help Read-SCVMHostCluster -online".

Parameters

-JobVariable<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMHostCluster<HostCluster>

Specifies a VMM host cluster object.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • VMHostCluster

Examples

1: Refresh information about a specific host cluster.

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.

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

Add-SCVMHostCluster

Find-SCCluster

Get-SCVMHostCluster

Install-SCVMHostCluster

Move-SCVMHostCluster

Remove-SCVMHostCluster

Set-SCVMHostCluster

Test-SCVMHostCluster

Uninstall-SCVMHostCluster