Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Compare-VM

Windows Server 2012 R2 and Windows 8.1

Updated: March 3, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Compare-VM

Compares a virtual machine and a virtual machine host for compatibility, returning a compatibility report.

Syntax

Parameter Set: Name
Compare-VM [-Name] <String> [-DestinationHost] <String> [-AsJob] [-ComputerName <String[]> ] [-DestinationStoragePath <String> ] [-IncludeStorage] [-ResourcePoolName <String> ] [-RetainVhdCopiesOnSource] [-SmartPagingFilePath <String> ] [-SnapshotFilePath <String> ] [-Vhds <Hashtable[]> ] [-VirtualMachinePath <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: CompatibilityReport
Compare-VM [-CompatibilityReport] <VMCompatibilityReport> [-AsJob] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Copy
Compare-VM [-Path] <String> [[-VhdDestinationPath] <String> ] -Copy [-AsJob] [-ComputerName <String[]> ] [-GenerateNewId] [-SmartPagingFilePath <String> ] [-SnapshotFilePath <String> ] [-VhdSourcePath <String> ] [-VirtualMachinePath <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Register
Compare-VM [-Path] <String> [-AsJob] [-ComputerName <String[]> ] [-Register] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VM
Compare-VM [-VM] <VirtualMachine> [-DestinationHost] <String> [-AsJob] [-DestinationStoragePath <String> ] [-IncludeStorage] [-ResourcePoolName <String> ] [-RetainVhdCopiesOnSource] [-SmartPagingFilePath <String> ] [-SnapshotFilePath <String> ] [-Vhds <Hashtable[]> ] [-VirtualMachinePath <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Compare-VM cmdlet compares a virtual machine and a virtual machine host for compatibility, returning a compatibility report. This is useful when trying to import or migrate a virtual machine that is incompatible with the target Hyper-V server.

Parameters

-AsJob

Specifies that the cmdlet is to be run as a background job.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CompatibilityReport<VMCompatibilityReport>

Specifies a compatibility report which resolves any incompatibilities between the virtual machine and the virtual machine host.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the . NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.


Aliases

none

Required?

false

Position?

named

Default Value

.

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DestinationHost<String>

Specifies the Hyper-V host to which the virtual machine is to be compared for compatibility.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DestinationStoragePath<String>

Specifies a destination storage path to which all virtual machine storage is to be moved.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-GenerateNewId

Specifies that the virtual machine should be copied and given a new unique identifier.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IncludeStorage

Specifies that the compatibility comparison should include both the virtual machine and its storage.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the virtual machine to be compared.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Path<String>

Specifies the path to the configuration file of the virtual machine to be compared.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VM<VirtualMachine>

Specifies the virtual machine object to be compared.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ResourcePoolName<String>

Friendly name of the resource pool


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RetainVhdCopiesOnSource

Specify this parameter to retain parent virtual hard disks on the source computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SmartPagingFilePath<String>

Specifies the new path to use for a smart paging file, if one is needed.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SnapshotFilePath<String>

Specifies the path for any snapshot files associated with the virtual machine.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Vhds<Hashtable[]>

An array of hashtables that specifies a location for each individual virtual hard disk that needs to be moved. Each hashtable has two entries. The first entry specifies the current location of the virtual hard disk to move, and has a key of SourceFilePath. The second entry specifies the new location for the virtual hard disk, and has a key of DestinationFilePath. The virtual hard disk names must be identical in both entries.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VirtualMachinePath<String>

Specifies the path where the resulting machine configuration files are to be stored.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Copy

Specifies that the comparison should be made for a copy import operation.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Register

Specifies that the comparison should be made for an in-place import operation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VhdDestinationPath<String>

Specifies the folder to which the virtual machine’s VHD is to be copied.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VhdSourcePath<String>

Specifies the folder from which the virtual machine’s VHD files are to be copied.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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.

  • Microsoft.HyperV.PowerShell.CompatibilityReport

Examples

Example 1

Compares virtual machine TestVM and Hyper-V host TestDestinationHost for compatibility.


PS C:\> Compare-VM –Name TestVM –DestinationHost TestDestinationHost

Example 2

Imports a virtual machine whose configuration is not compatible with the Hyper-V host. Note the use of Compare-VM to troubleshoot the import failure in the first step.


 

Attempts import of a virtual machine; the attempt fails due to incompatibilities with the Hyper-V host.


PS C:\> Import-VM -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML'
Import-VM : Unable to import virtual machine due to configuration errors.  Please use Compare-VM to repair the virtual machine.
At line:1 char:1
+ import-vm -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XM ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Import-VM], VirtualizationOperationFailedException
    + FullyQualifiedErrorId : Microsoft.HyperV.PowerShell.Commands.ImportVMCommand 

 

Gets a compatibility report that describes the attempted import and lists the virtual machine’s incompatibilities with the Hyper-V host.


PS C:\> $report = Compare-VM -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML'

 

Displays the compatibility report, revealing that the virtual network adapter was connected to switch Production. The Hyper-V host has no switch by that name.


PS C:\> $report.Incompatibilities | Format-Table -AutoSize
Message                                      MessageId Source
-------                                      --------- ------
Could not find Ethernet switch 'Production'.     33012 Microsoft.HyperV.PowerShell.VMNetworkAdapter 

 

Disconnects the virtual network adapter.


PS C:\> $report.Incompatibilities[0].Source | Disconnect-VMNetworkAdapter

 

Generates a new compatibility report to determine if the virtual machine is compatible with the Hyper-V host.


PS C:\> Compare-VM –CompatibilityReport $report

 

Displays the compatibility report.


PS C:\> $report
VM                 : Microsoft.HyperV.PowerShell.VirtualMachine
OperationType      : ImportVirtualMachine
Destination        : HYPER-V-1
Path               : D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML
SnapshotPath       : D:\vm1\Snapshots
VhdDestinationPath :
VhdSourcePath      :
Incompatibilities  :

 

Imports the virtual machine.


PS C:\> import-vm -CompatibilityReport $report
Name State CPUUsage(%) MemoryAssigned(M) MemoryDemand(M) MemoryStatus Uptime   Status             ReplicationState
---- ----- ----------- ----------------- --------------- ------------ ------   ------             ----------------
VM1  Off   0           0                 0                            00:00:00 Operating normally Disabled

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.