| external help file | Module Name | online version | schema |
|---|---|---|---|
Wsl-help.xml |
Wsl |
2.0.0 |
Imports a WSL distribution from a gzipped tarball or VHD file.
Import-WslDistribution [-InPlace] -LiteralPath <String[]> [[-Name] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Import-WslDistribution [-InPlace] [-Path] <String[]> [[-Name] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Import-WslDistribution [-Path] <String[]> [-Destination] <String> [[-Name] <String>] [[-Version] <Int32>]
[-RawDestination] [-Format <WslExportFormat>] [-WhatIf] [-Confirm] [<CommonParameters>]
Import-WslDistribution -LiteralPath <String[]> [-Destination] <String> [[-Name] <String>] [[-Version] <Int32>]
[-RawDestination] [-Format <WslExportFormat>] [-WhatIf] [-Confirm] [<CommonParameters>]
The Import-WslDistribution cmdlet imports a WSL distribution that was previously exported to a
gzipped tarball or VHD file, for example using the Export-WslDistribution cmdlet.
If you do not specify a distribution name, the name is derived from the input file name. For example, a file named "Ubuntu.tar.gz" would be imported to a distribution named "Ubuntu".
A directory with the name of the distribution is created as a child of the path specified using the Destination parameter, unless the RawDestination parameter is used. This allows multiple distributions to be imported using a single command.
This cmdlet can be used to import distributions to a new location, or with VHD files it can also register them using the VHD file in the supplied location using the InPlace parameter.
This cmdlet wraps the functionality of wsl.exe --import.
Import-WslDistribution D:\backup.tar.gz D:\wsl "Ubuntu"Name State Version Default
---- ----- ------- -------
Ubuntu Stopped 2 False
This example imports the file named D:\backup.tar.gz as a distribution named "Ubuntu", whose
filesystem will be stored in the directory D:\wsl\Ubuntu.
Import-WslDistribution D:\backup.tar.gz D:\wsl\mydistro "Ubuntu" -RawDestinationName State Version Default
---- ----- ------- -------
Ubuntu Stopped 2 False
This example imports the file named D:\backup.tar.gz as a distribution named "Ubuntu", whose file
system will be stored in the directory D:\wsl\mydistro. The name of the distribution is not appended
to this path because the RawDestination parameter was used.
Import-WslDistribution D:\backup\*.tar.gz D:\wslName State Version Default
---- ----- ------- -------
Alpine Stopped 2 False
Debian Stopped 2 False
Ubuntu Stopped 2 False
This example imports all .tar.gz files from D:\backup, using the base name of each file as the name
of the distribution. Each distribution will be stored in a separate subdirectory of D:\wsl.
Import-WslDistribution D:\backup\*.vhdx D:\wslName State Version Default
---- ----- ------- -------
Alpine Stopped 2 False
Debian Stopped 2 False
Ubuntu Stopped 2 False
This example imports all .vhdx files from D:\backup, using the base name of each file as the name
of the distribution. Each VHD file will be copied to a separate subdirectory of D:\wsl.
Import-WslDistribution -InPlace D:\wsl\Ubuntu.vhdx | Set-WslDistribution -DefaultThis example imports the file named D:\wsl\Ubuntu.vhdx as a distribution named "Ubuntu", using the
file at its present location. It then makes the new distribution the default distribution.
Get-Item D:\backup\*.tar.gz -Exclude "Ubuntu*" | Import-WslDistribution -Destination D:\wsl -Version 1Name State Version Default
---- ----- ------- -------
Alpine Stopped 1 False
Debian Stopped 1 False
This example imports all .tar.gz files, except those whose names start with Ubuntu, as WSL1
distributions stored in subdirectories of D:\wsl.
Specifies the destination directory where the file system for the imported distribution will be stored.
Unless the RawDestination parameter is used, the name of the distribution will be appended to this path as a subdirectory.
Type: String
Parameter Sets: Path, LiteralPath
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the format of the file to import, which can be either a gzipped tarball or a VHD. Auto
determines the format based on the file extension; Tar indicates the file is a gzipped tarball;
and Vhd indicates the file is a Virtual Hard Disk.
When using Auto, all files are assumed to be gzipped tarballs, unless their name ends in .vhdx.
Importing VHDs requires at least WSL version 0.58.
Type: WslExportFormat
Parameter Sets: Path, LiteralPath
Aliases: fmt
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies that the new distribution should use the input file in its current location, without
copying it. The input must be a .vhdx file when importing in place.
This parameter requires at least WSL version 0.58.
Type: SwitchParameter
Parameter Sets: LiteralPathInPlace, PathInPlace
Aliases: ip
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the path to a .tar.gz or .vhdx file to import. The value of LiteralPath is used
exactly as it is typed. No characters are interpreted as wildcards.
Type: String[]
Parameter Sets: LiteralPathInPlace, LiteralPath
Aliases: PSPath, LP
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the name of the imported WSL distribution.
If you specify an explicit distribution name, you cannot import multiple distributions with a single command.
Type: String
Parameter Sets: (All)
Aliases: DistributionName
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the path to a .tar.gz or .vhdx file to import. Wildcard characters are permitted.
Type: String[]
Parameter Sets: PathInPlace, Path
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: TrueSpecifies that the Destination path should be used as is, without appending the distribution name to it.
If RawDestination is specified, you cannot import multiple distributions with one command.
Type: SwitchParameter
Parameter Sets: Path, LiteralPath
Aliases: rd
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the distribution version to use for the imported distribution, either 1 or 2.
If omitted, the currently configured default distribution version is used.
Type: Int32
Parameter Sets: Path, LiteralPath
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalsePrompts 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: FalseShows 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: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe a string that contains a path to this cmdlet.
An object representing the imported distribution. See Get-WslDistribution for more information.