Cmdlet

Set-ConsoleValue

Module ConsoleMonster

Inputs

None

Sets a value in a running dashboard: a key/value pair, a bar or a stacked-bar segment.

Syntax

Set-ConsoleValue [-Key] <String> [-Name <String>] [-Session <LiveSession>] [-Value] <Object> [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Sets a value in a running dashboard: a key/value pair, a bar or a stacked-bar segment.

Sends a "set" update to the named widget. For a key/value list the value is shown as text; for bar charts and stacked bars it must be numeric.

Examples

Authored help example

EXAMPLE 1

Set-ConsoleValue -Key 'Value' -Value 'Value'

Parameters

-Key String requiredposition: 0: The key, bar label or segment.
-Name String optional: The widget name (default keyvalue).
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Value Object requiredposition: 1: The value.

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.