Compare-VM

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.

-CompatibilityReport<VMCompatibilityReport>

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

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

-DestinationHost<String>

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

-DestinationStoragePath<String>

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

-GenerateNewId

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

-IncludeStorage

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

-Name<String>

Specifies the name of the virtual machine to be compared.

-Path<String>

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

-VM<VirtualMachine>

Specifies the virtual machine object to be compared.

-ResourcePoolName<String>

Friendly name of the resource pool

-RetainVhdCopiesOnSource

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

-SmartPagingFilePath<String>

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

-SnapshotFilePath<String>

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

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

-VirtualMachinePath<String>

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

-Copy

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

-Register

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

-VhdDestinationPath<String>

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

-VhdSourcePath<String>

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

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

• Microsoft.Virtualization.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'

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

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

Imports the virtual machine.

PS C:\> import-vm -CompatibilityReport $report