Read-SCVMHost

  • Reference
Module:
VirtualMachineManager

Refreshes virtual machine host properties in the VMM Console.

Syntax

Read-SCVMHost
    [-VMHost] <Host>
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]
Read-SCVMHost
    [-VMHost] <Host>
    [-RefreshOutOfBandProperties]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

The Read-SCVMHost cmdlet refreshes the properties of a virtual machine host so that the Virtual Machine Manager (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)

Examples

Example 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.

Example 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.

Example 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.

Parameters

-JobVariable

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

Type:String
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RefreshOutOfBandProperties

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:Host
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

Host

This cmdlet returns a Host object.