Get-CxWslDistribution

Namespace ComputerX.PowerShell

Inputs

System.String

Outputs

ComputerX.Wsl.WslDistributionInventoryInfo

Gets WSL distribution inventory with native registration metadata, optional native API configuration, and optional live CLI state.

Examples

Authored help example

Example 1: Lists WSL distributions registered for the current user using native metadata.

PS>


Get-CxWslDistribution

Example 2: Adds native WSL API configuration fields without invoking the WSL CLI.

PS>


Get-CxWslDistribution -IncludeConfiguration

Example 3: Adds live state and live version by invoking the WSL CLI explicitly.

PS>


Get-CxWslDistribution -IncludeLiveStatus

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-CxWslDistribution [-Name <string>] [-IncludeConfiguration] [-IncludeLiveStatus] [-TimeoutSeconds <int>] [<CommonParameters>]

Parameters

Name string optionalposition: 0pipeline: true (ByValue, ByPropertyName): Optional distribution name filter.
IncludeConfiguration SwitchParameter optionalposition: namedpipeline: false: Adds native WSL API configuration fields by invoking wslapi.dll.
IncludeLiveStatus SwitchParameter optionalposition: namedpipeline: false: Adds live state and live WSL version fields by invoking wsl.exe --list --verbose.
TimeoutSeconds int optionalposition: namedpipeline: false: Optional timeout in seconds for live-state CLI collection.

Outputs

ComputerX.Wsl.WslDistributionInventoryInfo