Cmdlet

Update-ConsolePhase

Module ConsoleMonster

Inputs

None

Updates a phase of a running dashboard's phase strip.

Syntax

Update-ConsolePhase [-Detail <String>] [-Key] <String> [-Name <String>] [-Session <LiveSession>] [-Status <StatusKind>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Updates a phase of a running dashboard's phase strip.

Set -Status Running when a phase starts; its duration is measured until it gets a final status (Pass, Fail, Warn, Skip). -Detail replaces the shown detail (for example a percentage).

Examples

Authored help example

EXAMPLE 1

Update-ConsolePhase -Key 'Value'

Parameters

-Detail String optional: A detail such as a percentage or duration.
-Key String requiredposition: 0: The phase key.
-Name String optional: The phases widget name (default phases).
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Status StatusKind optional: The new status.; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info

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.