Read-SCVMHost

Refreshes virtual machine host properties in the VMM Console.

Description

The Read-SCVMHost cmdlet refreshes the properties of a virtual machine host so that the VMM Console displays updated information about the host.

Host properties that this cmdlet updates include:

- Name 
- Operating system
- Status (such as Responding)
- Host volumes (typically, addition or removal of drive letters, 
  mount points, as well as used and available space)
- Network adapters (addition or removal)

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

Parameters

VMHost

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0 
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, type: "Get-Help Add-SCVMHost -detailed". See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RefreshOutOfBandProperties

Required? false
Accept Pipeline Input? false
Position? named 
Refreshes available computer hardware properties through the out-of-band baseboard management controller (BMC). This process is different from the regular host refreshing logic, because the host refresher goes through the VMM agent inside the operating system (in-band). The properties that are refreshed through BMC are different from those in the in-band refresher.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Examples

1: Refresh information about a specific host. 
PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01" 
PS C:\> Read-SCVMHost -VMHost $VMHost

The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.

The second command refreshes the properties for VMHost01 so that current information about this host will appear in the VMM Console.
2: Refresh information about all hosts. 
PS C:\> Get-SCVMHost -VMMServer "VMMServer01.Contoso.com" | Read-SCVMHost 

This command refreshes information about all hosts managed by VMMServer01 so that current information about each host will appear in the VMM Console.
3: Refresh information about a given host through its OOB channel. 
PS C:\> Get-SCVMHost -ComputerName "VMHost02" | Read-SCVMHost -RefreshOutOfBandProperties

This command refreshes information about host VMHost02 using its out-of-band interface so that current information about the host appears in the VMM console.

See Also