Skip to content
ConsoleMonster
Cmdlet

New-ConsoleLane

Module ConsoleMonster
Inputs
None
Outputs
ConsoleMonster.Widgets.Lane

Creates one lane (a worker, server or item of a parallel workload) for New-ConsoleLanes.

Syntax

New-ConsoleLane [-Detail <Object>] [-Done <Double>] [-Failed <Int32>] [-Key] <String> [-Label <Object>] [-Passed <Int32>] [-Skipped <Int32>] [-Status <StatusKind>] [-Total <Double>] [-Warned <Int32>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Description

Creates one lane (a worker, server or item of a parallel workload) for New-ConsoleLanes.

Use it inside the script block of New-ConsoleLanes when lanes differ: each has its own total, progress, status, result counts and detail. -Key names the lane for Update-ConsoleLane; the label defaults to the key and accepts rich text from New-ConsoleText. To add lanes to a widget made earlier, pipe it to Add-ConsoleItem.

Examples

Authored help example

EXAMPLE 1

New-ConsoleLanes {
    New-ConsoleLane 'DC01' -Total 40 -Done 40 -Status Pass -Passed 40
    New-ConsoleLane 'DC02' -Total 40 -Done 22 -Status Running -Passed 21 -Warned 1 -Detail 'replication'
    New-ConsoleLane 'DC03' -Total 40
} | Write-ConsoleWidget

Three servers at different points

Parameters

-Detail Object optional
What the lane is doing now (shown literally; rich text keeps its colours).
-Done Double optional
Steps done.
-Failed Int32 optional
Results that failed.
-Key String requiredposition: 0
The lane key, used by Update-ConsoleLane -Key.
-Label Object optional
The label (defaults to the key; rich text from New-ConsoleText keeps its colours).
-Passed Int32 optional
Results that passed.
-Skipped Int32 optional
Results skipped.
-Status StatusKind optional
The status (default Pending): Pass, Fail, Warn, Skip, Running or Pending, or PowerShell's words.
Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-Total Double optional
Planned steps.
-Warned Int32 optional
Results with warnings.

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.