NAME
Remove-WslImage
SYNOPSIS
Remove a WSL root filesystem from the local disk.
SYNTAX
Remove-WslImage [-Name] <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-WslImage [-Image] <WslImage[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
If the WSL root filesystem is synced, it will remove the tar file and its meta
data from the disk. Builtin root filesystems will still appear as output of
`Get-WslImage`, but their state will be `NotDownloaded`.
PARAMETERS
-Name <String[]>
The identifier of the image. It can be an already known name:
- Arch
- Alpine
- Ubuntu
- Debian
It also can be the URL (https://...) of an existing filesystem or a
image name saved through Export-WslInstance.
It can also be a name in the form:
incus://<os>#<release> (ex: incus://rockylinux#9)
In this case, it will refer to the specified image from
https://images.linuxcontainers.org/images.
Supports wildcards.
-Image <WslImage[]>
The WslImage object representing the WSL root filesystem to delete.
-Force [<SwitchParameter>]
Force removal of the image even if it is the source file. By default, images that serve as source files cannot be removed without this flag.
-WhatIf [<SwitchParameter>]
-Confirm [<SwitchParameter>]
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
-------------------------- EXAMPLE 1 --------------------------
PS > Remove-WslImage -Name "alpine"
Removes the alpine root filesystem.
-------------------------- EXAMPLE 2 --------------------------
PS > New-WslImage -Name "incus://alpine#3.19" | Remove-WslImage
Removes the Incus alpine 3.19 root filesystem.
-------------------------- EXAMPLE 3 --------------------------
PS > Get-WslImage -Type Incus | Remove-WslImage
Removes all the Incus root filesystems present locally.
-------------------------- EXAMPLE 4 --------------------------
PS > Remove-WslImage -Name "*alpine*"
Removes all root filesystems with 'alpine' in their name.
REMARKS
To see the examples, type: "Get-Help Remove-WslImage -Examples"
For more information, type: "Get-Help Remove-WslImage -Detailed"
For technical information, type: "Get-Help Remove-WslImage -Full"
For online help, type: "Get-Help Remove-WslImage -Online"