Export-VMSnapshot

Exports a virtual machine snapshot to disk.

Syntax

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

Description

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

Examples

Example 1

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

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

Required Parameters

-Name

Specifies the name of the snapshot to be exported.

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Path

Specifies the path to the folder into which the snapshot is to be exported.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VM

Specifies the virtual machine of which the snapshot is to be exported.

Type:VirtualMachine[]
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMName

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

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

Specifies the snapshot to be exported.

Type:VMSnapshot[]
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

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

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

Specifies one or more Hyper-V hosts on which the virtual machine snapshot 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:.
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Passthru

Specifies that a VMSnapshot object is to be passed through to the pipeline representing the snapshot to be exported.

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

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

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

Outputs

None by default; Microsoft.Virtualization.Powershell.Snapshot if -PassThru is specified.