Cmdlet

Update-ConsoleSpinner

Module ConsoleMonster

Inputs

None

Updates a spinner in a running dashboard.

Syntax

Update-ConsoleSpinner [-Detail <Object>] [-Label <Object>] [[-Name] <String>] [-Restart] [-Session <LiveSession>] [-Status <StatusKind>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Updates a spinner in a running dashboard.

-Label renames it, -Detail changes the muted detail, -Restart restarts its clock and returns it to running, and -Status sets a final state that replaces the animation with the status marker.

Examples

Authored help example

EXAMPLE 1

Update-ConsoleSpinner -Name 'Name'

Parameters

-Detail Object optional: A new detail.
-Label Object optional: A new label.
-Name String optionalposition: 0: The spinner name (default spinner).
-Restart SwitchParameter optional: Restart the clock and return to running.
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Status StatusKind optional: A final status (Pass, Fail, Warn, Skip).; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info

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.