external help file | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|
Microsoft.HyperV.PowerShell.dll-Help.xml |
Hyper-V |
10/30/2017 |
2.0.0 |
Export-VM |
Exports a virtual machine to disk.
Export-VM [-ComputerName <String[]>] [-Name] <String[]> [-Path] <String> [-AsJob] [-Passthru] [-WhatIf]
[-Confirm] [<CommonParameters>]
Export-VM [-Path] <String> [-AsJob] [-Passthru] [-VM] <VirtualMachine[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
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.
PS C:\>Export-VM -Name Test -Path D:\
Exports virtual machine Test to the root of the D drive.
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.
Specifies that the cmdlet is to be run as a background job.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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[]
Parameter Sets: Name
Aliases:
Required: False
Position: Named
Default value: .
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the name of the virtual machine to be exported.
Type: String[]
Parameter Sets: Name
Aliases: VMName
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the path to the folder into which the virtual machine is to be exported.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the virtual machine to be exported.
Type: VirtualMachine[]
Parameter Sets: VMObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
None by default; Microsoft.HyperV.PowerShell.VirtualMachine if -PassThru is specified.