Read-SCVirtualMachine

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

Description

The Read-SCVirtualMachine cmdlet refreshes the properties of a virtual machine so that the System Center 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.

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

Parameters

VM

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0 
Specifies a virtual machine object.

Force

Required? false
Accept Pipeline Input? false
Position? named 
Forces the operation to complete. 

For example:
- Remove-SCSCVMHost -Force
  Forces the removal of a host object from the VMM database.

- Stop-SCVirtualMachine -Force
  Stops a virtual machine.

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.

RunAsynchronously

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

Requires a virtual machine object, which can be retrieved by using the Get-SCVirtualMachine cmdlet.

Examples

1: Refresh information about a specific virtual machine. 
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> Read-SCVirtualMachine -VM $VM

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

The second command refreshes the properties of the virtual machine stored in $VM (in this case, VM01). After this command completes successfully, current information about this virtual machine will appear in the VMM console.
2: Refresh all virtual machines on hosts whose name matches the specified string. 
PS C:\> $VMs = Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" | where { $_.VMHost.Name -match "VMM" }
PS C:\> $VMs | Read-SCVirtualMachine

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.

See Also