Read-SCVMHost
Read-SCVMHost
Refreshes virtual machine host properties in the VMM console.
Syntax
Parameter Set: DefaultRefresh
Read-SCVMHost [-VMHost] <Host> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]
Parameter Set: OutOfBandRefresh
Read-SCVMHost [-VMHost] <Host> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RefreshOutOfBandProperties] [-RunAsynchronously] [ <CommonParameters>]
Detailed 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
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 Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
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 |
-VMHost<Host>
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.
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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.
- Host
Examples
Example 1: Refresh information about a specific host
The first command gets the host object named VMHost01, and then stores the object in the $VMHost variable.
The second command refreshes the properties for VMHost01 so that current information about this host appears in the VMM console.
PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01"
PS C:\> Read-SCVMHost -VMHost $VMHost
Example 2: Refresh information about all hosts
This command refreshes information about all hosts managed by VMMServer01 so that current information about each host appears in the VMM Console.
PS C:\> Get-SCVMHost -VMMServer "VMMServer01.Contoso.com" | Read-SCVMHost
Example 3: Refresh information about a given host through its OOB channel
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.
PS C:\> Get-SCVMHost -ComputerName "VMHost02" | Read-SCVMHost -RefreshOutOfBandProperties