Cmdlet

Update-ConsoleLane

Module ConsoleMonster

Inputs

None

Updates a lane of a running dashboard: progress, step results, status and detail.

Syntax

Update-ConsoleLane [-Complete] [-Detail <Object>] [-Key] <String> [-Label <Object>] [-Name <String>] [-Result <StatusKind>] [-Session <LiveSession>] [-Status <StatusKind>] [-Steps <Double>] [-Total <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Updates a lane of a running dashboard: progress, step results, status and detail.

With -Result, counts one completed step (or -Steps steps) as passed, failed, warning or skipped and advances the bar. With -Status, sets the lane state (Running, Pass, Fail, Warn, Skip). -Complete finishes the lane (Fail if any step failed, Warn if any warned, otherwise Pass). Safe to call from any runspace or thread.

Examples

Authored help example

EXAMPLE 1

Update-ConsoleLane -Key 'Value'

Parameters

-Complete SwitchParameter optional: Finish the lane.
-Detail Object optional: What the lane is doing now.
-Key String requiredposition: 0: The lane key (created on first use).
-Label Object optional: The lane label (when adding or renaming).
-Name String optional: The lanes widget name (default lanes).
-Result StatusKind optional: Result of completed steps.; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Status StatusKind optional: Set the lane status.; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-Steps Double optional: Steps completed with this result (default 1).
-Total Double optional: Planned steps for the lane.

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.