Cmdlet

Update-ConsoleLiveTable

Module: ConsoleMonster
Inputs: None

Adds, updates, removes or clears rows of a live table (New-ConsoleLiveTable) in the running dashboard.

Syntax

Update-ConsoleLiveTable
[-Key] <String>
[-Session <LiveSession>]
[[-Value] <Object[]>]
[[-WidgetId] <String>]
[<CommonParameters>]

Parameter set: Row

Update-ConsoleLiveTable
[-Key] <String>
-Remove
[-Session <LiveSession>]
[[-WidgetId] <String>]
[<CommonParameters>]

Parameter set: Remove

Update-ConsoleLiveTable
-Clear
[-Session <LiveSession>]
[[-WidgetId] <String>]
[<CommonParameters>]

Parameter set: Clear

Description

-Key identifies the row: a new key adds a row, an existing key replaces its values. -Remove deletes the row and -Clear deletes them all; the column widths stay.

Examples

Example 1

Update-ConsoleLiveTable -WidgetId jobs -Key $job.Id -Value $job.Name, 'Running', $elapsed

Track a job from start to finish

Parameters

-Key String requiredposition: 1sets: Row, Remove: The stable row key.
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Value Object[] optionalposition: 2sets: Row: The values, one per column (numbers, dates, durations and statuses go through the column presenters).
-WidgetId String optionalposition: 0: The live table name (default table).
-Remove SwitchParameter requiredsets: Remove: Removes the row with that key.
-Clear SwitchParameter requiredsets: Clear: Removes every row.

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.