Displaying Progress from PowerShell Jobs
Published on 11 Sep 2015Tags #jobs #PowerShell #Progress
Whenever a PowerShell job attempts to display progress, it is intercepted and stored for progressing by the controlling code outside the job. This allows for displaying progress from PowerShell jobs on the console.
PowerShell provides access to all streams from a jobs: standard output, standard error, information, verbose, warning, debug, error, progress. The progress property of a job give direct access to a collection of progress messages from the code executed in the job. This progress data can be used to display progress bars for several parallel jobs at once to offer a more comfortable overview of the overall progress from PowerShell jobs.
Update: Note that you can also collect and display progress by calling Receive-Job but this will also display data from all other streams.
Consider the following simple example: Installing a Windows feature may take a considerable amount of time. If this needs to be done on a large number of servers, it is helpful to see the progress from PowerShell jobs. The code below uses my cmdlet Show-JobProgress
to collect and display progress information:
$Job = Start-Job -Scriptblock {Add-WindowsFeature -Name 'Telnet-Client'}
while (@('Completed', 'Failed') -notcontains $Job.State) {
$Job | Wait-Job -Timeout 2
$Job | Show-JobProgress
}
Show-JobProgress
can also be used together with Invoke-Queue
which I have published previously.
The following code contains a cmdlet called Show-JobProgress
which accepts an array of PowerShell jobs and collect the last progress message from all child jobs:
In case you have any feedback please use the comments below or create a new revision on GitHub.