Read-SCVirtualMachine

[アーティクル]
11/16/2015

Read-SCVirtualMachine

Refreshes the properties of a virtual machine so that the VMM console displays updated information about the virtual machine.

構文

Parameter Set: FullRefreshSingleVm
Read-SCVirtualMachine [-VM] <VM> [-Force] [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]

Parameter Set: LightRefreshVmsOnHost
Read-SCVirtualMachine [-VMHost] <Host> [-JobVariable <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]

詳細説明

The Read-SCVirtualMachine cmdlet refreshes the properties of a virtual machine so that the Virtual Machine Manager (VMM) console displays updated information about the virtual machine. The updated properties include Name, Status, Host, Owner, CPUAverage, Service, OperatingSystem, and other properties.

パラメーター

-Force

Forces the operation to complete.

For example:

- Remove-SCVMHost -Force

Forces the removal of a host object from the VMM database.

- Stop-SCVirtualMachine -Force

Stops a virtual machine.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-JobVariable<String>

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

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-OnBehalfOfUser<System.String>

For example:

- Remove-SCVMHost -Force

Forces the removal of a host object from the VMM database.

- Stop-SCVirtualMachine -Force

Stops a virtual machine.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>

For example:

- Remove-SCVMHost -Force

Forces the removal of a host object from the VMM database.

- Stop-SCVirtualMachine -Force

Stops a virtual machine.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PROTipID<Guid]>

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

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-RunAsynchronously

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

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-VM<VM>

Specifies a virtual machine object.

エイリアス	none
必須?	true
位置は?	1
既定値	none
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	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. See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.

エイリアス	none
必須?	true
位置は?	1
既定値	none
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

VirtualMachine

注

This cmdlet requires a virtual machine object, which you can retrieve with the Get-SCVirtualMachine cmdlet.

例

Example Example 1: Refresh information about a specific virtual machine.

The first command gets the virtual machine object named VM01, and then stores the object in the $VM variable.

The second command refreshes the properties of the virtual machine stored in $VM. After this command completes successfully, current information about this virtual machine appears in the VMM console.

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> Read-SCVirtualMachine -VM $VM

Example Example 2: Refresh all virtual machines on hosts whose name matches the specified string.

The first command gets all virtual machine objects from VMMServer01 deployed on hosts whose name contains the string VMM, and then stores the virtual machine objects in the $VMs variable.

The second command refreshes the properties of each virtual machine object stored in $VMs.

PS C:\> $VMs = Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" | where { $_.VMHost.Name -match "VMM" }
PS C:\> $VMs | Read-SCVirtualMachine

Read-SCVirtualMachine