Export-VMSnapshot

Module:: Hyper-V

Exports a virtual machine checkpoint to disk.

Syntax

Export-VMSnapshot
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential[]>]
      [-Name] <String[]>
      [-Path] <String>
      -VMName <String[]>
      [-AsJob]
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Export-VMSnapshot
      [-VM] <VirtualMachine[]>
      [-Name] <String[]>
      [-Path] <String>
      [-AsJob]
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Export-VMSnapshot
      [-VMSnapshot] <VMSnapshot[]>
      [-Path] <String>
      [-AsJob]
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Export-VMSnapshot cmdlet exports a virtual machine checkpoint to disk.

Note: In Windows Server 2012 R2, virtual machine snapshots were renamed to virtual machine checkpoints. For clarity, this document will refer to virtual machine snapshots as checkpoints.

Examples

Example 1

PS C:\> Export-VMSnapshot -Name 'Base Image' -VMName TestVM -Path D:\

Exports checkpoint Base Image of virtual machine TestVM to D:.

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

-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 checkpoint 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 checkpoint to be exported.

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

-Passthru

Specifies that a VMSnapshot object is to be passed through to the pipeline representing the checkpoint 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 checkpoint 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 of which the checkpoint is to be exported.

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

-VMName

Specifies the name of the virtual machine of which the checkpoint is to be exported.

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

-VMSnapshot

Specifies the checkpoint to be exported.

Type:	VMSnapshot[]
Aliases:	VMCheckpoint
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.Snapshot

If -PassThru is specified.

Share via