Cmdlet

Update-ConsoleFlow

Module: ConsoleMonster
Inputs: None

Updates a node or edge in a live dashboard's flow strip.

Syntax

Update-ConsoleFlow
-NodeKey <String>
[-Session <LiveSession>]
-Status <StatusKind>
[[-WidgetId] <String>]
[<CommonParameters>]

Parameter set: Node

Update-ConsoleFlow
[-Cut]
-EdgeKey <String>
[-Session <LiveSession>]
-Status <StatusKind>
[[-WidgetId] <String>]
[<CommonParameters>]

Parameter set: Edge

Description

Posts a status change to an existing flow in a running dashboard. WidgetId selects the flow; NodeKey or EdgeKey selects its item. Cut severs an edge, Cut:$false reconnects it, and omitting Cut preserves its connection state.

Examples

Example 1

Update-ConsoleFlow -WidgetId chain -NodeKey issuer -Status Fail
Update-ConsoleFlow -WidgetId chain -EdgeKey signature -Status Fail -Cut

Mark an issuer failure and sever its incoming connection

Parameters

-NodeKey String requiredsets: Node: Node to update.
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Status StatusKind required: New status.; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-WidgetId String optionalposition: 0: Flow widget identifier.
-Cut SwitchParameter optionalsets: Edge: Cuts the edge; -Cut:$false reconnects it. Omitted preserves connectivity.
-EdgeKey String requiredsets: Edge: Edge to update.

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.