Cmdlet

Send-ConsoleEvent

Module ConsoleMonster

Inputs

None

Sends a raw live event to any widget of a running dashboard.

Syntax

Send-ConsoleEvent [-Key <String>] [-Operation] <String> [-Session <LiveSession>] [-State <String>] [-Target] <String> [-Text <String>] [-Total <Double>] [-Value <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Sends a raw live event to any widget of a running dashboard.

The general form behind the Update-* cmdlets, for custom widgets and less common operations (for example the dashboard's title or status). Operations are defined by each widget.

Examples

Authored help example

EXAMPLE 1

Send-ConsoleEvent -Target 'Value' -Operation 'Value'

Parameters

-Key String optional: The item key.
-Operation String requiredposition: 1: The operation (advance, state, set, add, write, title, status...).
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-State String optional: A state word.
-Target String requiredposition: 0: The widget name.
-Text String optional: Text.
-Total Double optional: A second numeric value (total, maximum).
-Value Double optional: A numeric 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.