Cmdlet

Update-ConsoleStatus

Module ConsoleMonster

Inputs

None

Updates an item of a status list in a running dashboard.

Syntax

Update-ConsoleStatus [-Detail <String>] [-Key] <String> [-Label <Object>] [-Name <String>] [-Session <LiveSession>] [-Status <StatusKind>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Updates an item of a status list in a running dashboard.

Adds the item when it does not exist. -Detail shows a right-aligned muted note such as a duration.

Examples

Authored help example

EXAMPLE 1

Update-ConsoleStatus -Key 'Value'

Parameters

-Detail String optional: A right-aligned detail.
-Key String requiredposition: 0: The item key.
-Label Object optional: The item label (markup allowed).
-Name String optional: The status list name (default status).
-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.