Cmdlet

Update-ConsoleStatusItem

Module: ConsoleMonster
Inputs: None

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

Syntax

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

Parameter set: All Parameter Sets

Description

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

Examples

Example 1

Update-ConsoleStatusItem -Key restore -Status Pass -Detail '1.6s'

Mark a step as passed with its duration

Parameters

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

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.