Cmdlet

Update-ConsoleProgress

Module ConsoleMonster

Inputs

None

Updates a progress bar in a running dashboard.

Syntax

Update-ConsoleProgress [-Increment <Double>] [-Label <Object>] [[-Name] <String>] [-Session <LiveSession>] [-Status <StatusKind>] [-Total <Double>] [-Value <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Updates a progress bar in a running dashboard.

-Value sets the value, -Increment adds to it, -Label renames the bar and -Status sets a final state that recolours it.

Examples

Authored help example

EXAMPLE 1

Update-ConsoleProgress -Name 'Name'

Parameters

-Increment Double optional: Amount to add to the value.
-Label Object optional: A new label.
-Name String optionalposition: 0: The progress bar name (default progress).
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Status StatusKind optional: A final status (Pass, Fail, Warn).; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-Total Double optional: A new total.
-Value Double optional: The new 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.