Cmdlet

Update-ConsoleCell

Module ConsoleMonster

Inputs

None

Sets the state of cells of a cell map (New-ConsoleCellMap) in the running dashboard.

Syntax

Update-ConsoleCell [-Index] <Int32[]> [-Name <String>] [-Session <LiveSession>] [-Status] <StatusKind> [<CommonParameters>]

Parameter set: Set

Update-ConsoleCell -Add [-Name <String>] [-Session <LiveSession>] [[-Status] <StatusKind>] [-Times <Int32>] [<CommonParameters>]

Parameter set: Add

Update-ConsoleCell -Count <Int32> [-Name <String>] [-Session <LiveSession>] [<CommonParameters>]

Parameter set: Count

Description

Sets the state of cells of a cell map (New-ConsoleCellMap) in the running dashboard.

-Index names the cells by position, from 0 (in a grid with -Columns, row * columns + column); -Status is their new state: Pass, Fail, Warn, Skip, Info, Running or Pending (PowerShell's words such as Success and Error work too). An index past the end grows the map. -Add appends cells in the -Status state instead, and -Count sets the number of cells (new ones are pending). Safe to call from any runspace or thread.

Examples

Authored help example

EXAMPLE 1

Update-ConsoleCell -Name checks -Index 7 -Status Running
Update-ConsoleCell -Name checks -Index 7 -Status Pass

A check starts and passes on the second server of a grid with five checks per row

EXAMPLE 2

Update-ConsoleCell -Name files -Count 40
Update-ConsoleCell -Name files -Index 0, 1, 2 -Status Pass

Grow a map as items are found, then mark them

Parameters

-Index Int32[] requiredposition: 0sets: Set: The cells to set, by position from 0.
-Name String optional: The cell map name (default cells).
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Status StatusKind required in Setposition: 1sets: Set, Add: The new state (for -Add, the state of the new cells; default Pending).; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-Add SwitchParameter requiredsets: Add: Appends cells in the -Status state.
-Times Int32 optionalsets: Add: How many cells -Add appends (default 1).
-Count Int32 requiredsets: Count: Sets the number of cells: new ones are pending, extra ones are removed (at least 1).

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.