Edit

Share via

Export-VM

  • Reference
Module:
Hyper-V

Exports a virtual machine to disk.

Syntax

Export-VM
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential[]>]
      [-Name] <String[]>
      [-Path] <String>
      [-AsJob]
      [-Passthru]
      [-CaptureLiveState <CaptureLiveState>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-VM
      [-VM] <VirtualMachine[]>
      [-Path] <String>
      [-AsJob]
      [-Passthru]
      [-CaptureLiveState <CaptureLiveState>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Export-VM cmdlet exports a virtual machine to disk. This cmdlet creates a folder at a specified location having three subfolders: Snapshots, Virtual Hard Disks, and Virtual Machines. Each of these folders contains the associated files. The Snapshots folder contains the associated Snapshots, and the Virtual Hard Disk folder contains the specified virtual machine's virtual disks. The Virtual Machines folder contains the configuration XML of the specified virtual machine.

Examples

Example 1

PS C:\> Export-VM -Name Test -Path D:\

Exports virtual machine Test to the root of the D drive.

Example 2

PS C:\> Get-VM | Export-VM -Path D:\

Exports all virtual machines to the root of the D drive. Each virtual machine will be exported to its own folder.

Parameters

-AsJob

Runs the cmdlet as a background job.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CaptureLiveState

Specifies how Hyper-V captures the running virtual machine memory state. The acceptable values for this parameter are:

  • CaptureSavedState. Include memory state.
  • CaptureDataConsistentState. Use Production Checkpoint technology.
  • CaptureCrashConsistentState. Do nothing to handle virtual machine state.
Type:CaptureLiveState
Accepted values:CaptureCrashConsistentState, CaptureSavedState, CaptureDataConsistentState
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies one or more Hyper-V hosts on which the virtual machine is to be exported. 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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the virtual machine to be exported.

Type:String[]
Aliases:VMName
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Passthru

Specifies that a Microsoft.HyperV.PowerShell.VirtualMachine object is to be passed through to the pipeline representing the virtual machine to be exported.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Specifies the path to the folder into which the virtual machine is to be exported.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VM

Specifies the virtual machine to be exported.

Type:VirtualMachine[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

None

Default

Microsoft.HyperV.PowerShell.VirtualMachine

If -PassThru is specified.