{"id":480,"date":"2018-12-03T08:00:50","date_gmt":"2018-12-03T14:00:50","guid":{"rendered":"https:\/\/practicalpowershell.com\/?p=480"},"modified":"2020-03-13T22:02:13","modified_gmt":"2020-03-14T04:02:13","slug":"adding-a-progress-bar","status":"publish","type":"post","link":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/","title":{"rendered":"Adding a Progress Bar"},"content":{"rendered":"

\"\"<\/a>When dealing with complex scripts with lots of running parts and that take some time to complete, it is convenient to have some sort of progress indicator to help visually indicate where a script is in a particular stage. In order to be successful we would need a count of how many items are being processed and what number in that list we are at. From there were can perform some simple math and then that can translate into our progress.

\nWhere to get started? First we can see what cmdlets are available for progress in PowerShell:
\n[sourcecode language=”powershell”]
\nGet-Command *progress*
\nWe find that there is only one cmdlet available for progress in PowerShell:<BR>
\n<em>Name
\n—-
\nWrite-Progress<\/em><BR>
\nIn PowerShell progress<BR>
\nPractical Examples of a Progress Bar<BR>
\n<em>Example 1<\/em><BR>
\nIn this example we have a script that is performing a series of tasks. These tasks are responsible for gathering information on an environment. The environment could be anything from Exchange, Active Directory or Office 365. The point would be to concentrate on a series of tasks. Now in this script, we have
\nSample Code (not a complete script):
\n[sourcecode language="powershell"]
\n# Variables
\n$Counter = 0
\n$Tasks = "Task 1","Task 2","Task 3","Task 4","Task 5","Task 6","Task 7","Task 8","Task 9","Task 10","Task 11","Task 12","Task 13","Task 14","Task 15"
\nFunction Task1 {
\n# Gather AD Domain information
\n$ADDomains = (Get-ADForest).Domains | Out-file $Destination -Append
\n}
\nFunction Task2 {
\n# Group Policy Check
\n$ScriptFile = "GPOCheck.ps1"
\n$Fullpath = ".\\"+$ScriptFile
\nInvoke-Expression $FullPath
\n}
\nForeach ($Task in $Tasks) {
\n$Counter ++
\nWrite-Progress -Activity "Performing Tasks" -Status "In progress: $Task of 15"
\n$Task
\n}
\n[\/sourcecode]
\nNote that when a task starts, the counter going up and we know we are on task number ## of 15. Each of these tasks is a separate function, which makes it easier for use to call and monitor the script progress:
\n\"\"<\/a>
\nThis way if you have a long running script or there are tasks that take some time to run, you will at least know how far a script has progressed.

\nExample 2<\/em>
\nFor this example we’ll use the Write-Progress cmdlet to provide a percentage done instead of a overall number like Example 1. We can simply modify the Foreach loop to display a percentage instead of a task number like so:
\n[sourcecode language=”powershell”]
\nForeach ($Task in $Tasks) {
\n$Counter ++
\n$Percent = $Counter\/15
\n$I = [math]::Round($Percent,4)*100
\nWrite-Progress -Activity "Performing Tasks" -Status "Task Progress: $I%" -Percent $I
\n$Task
\n}
\n[\/sourcecode]
\nThis will then provide a progress bar that looks like this instead:
\n\"\"<\/a>
\nInner Loops<\/em>

\nIn addition to the main progress bars, there is also the option to run a progress bad for an inner loop if you use those. So, for example, if a function has some sub tasks that it runs, this progress bar can then relay where it is, while inside of the main running task.

\nSample Code:<\/em>

\n[sourcecode language=”powershell”]
\nFunction Task2 {
\n$SubCounter = 0
\n$Subtasks = "SubTask 1","SubTask 2","SubTask 3","SubTask 4","SubTask 5"
\nForeach ($SubTask in $Subtasks) {
\n$SubCounter ++
\nWrite-Progress -Activity "Performing Tasks" -Status "In progress: $Task of 15"
\nWrite-Progress -Id 1 -Activity "Performing SubTasks" -Status "In Progress: $SubTask of 10" -CurrentOperation InnerLoop
\nStart-Sleep 2
\n}
\n}
\nForeach ($Task in $Tasks) {
\n$Counter ++
\nWrite-Progress -Activity "Performing Tasks" -Status "In progress: $Task of 15"
\nInvoke-Expression $Task
\n}
\n[\/sourcecode]
\n\"\"<\/a>
\nThis would be useful if you have a complex level of tasks and functions. Having a visual clue as to how far the script has progress, even in the smaller tasks of a function, are useful.<\/p>\n","protected":false},"excerpt":{"rendered":"

When dealing with complex scripts with lots of running parts and that take some time to complete, it is convenient to have some sort of progress indicator to help visually indicate where a script is in a particular stage. In order to be successful we would need a count of how many items are being […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"rop_custom_images_group":[],"rop_custom_messages_group":[],"rop_publish_now":"initial","rop_publish_now_accounts":[],"rop_publish_now_history":[],"rop_publish_now_status":"pending","_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-480","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"\nAdding a Progress Bar - Practical PowerShell<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Adding a Progress Bar - Practical PowerShell\" \/>\n<meta property=\"og:description\" content=\"When dealing with complex scripts with lots of running parts and that take some time to complete, it is convenient to have some sort of progress indicator to help visually indicate where a script is in a particular stage. In order to be successful we would need a count of how many items are being […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/\" \/>\n<meta property=\"og:site_name\" content=\"Practical PowerShell\" \/>\n<meta property=\"article:published_time\" content=\"2018-12-03T14:00:50+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-03-14T04:02:13+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/practicalpowershell.com\/wp-content\/uploads\/2020\/03\/Progress05-150x150.jpg\" \/>\n<meta name=\"author\" content=\"damian\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"damian\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/\"},\"author\":{\"name\":\"damian\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#\\\/schema\\\/person\\\/4d0733c81966e744aabbb49f56d64deb\"},\"headline\":\"Adding a Progress Bar\",\"datePublished\":\"2018-12-03T14:00:50+00:00\",\"dateModified\":\"2020-03-14T04:02:13+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/\"},\"wordCount\":642,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#\\\/schema\\\/person\\\/4d0733c81966e744aabbb49f56d64deb\"},\"image\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/practicalpowershell.com\\\/wp-content\\\/uploads\\\/2020\\\/03\\\/Progress05-150x150.jpg\",\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/\",\"url\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/\",\"name\":\"Adding a Progress Bar - Practical PowerShell\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/practicalpowershell.com\\\/wp-content\\\/uploads\\\/2020\\\/03\\\/Progress05-150x150.jpg\",\"datePublished\":\"2018-12-03T14:00:50+00:00\",\"dateModified\":\"2020-03-14T04:02:13+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/#primaryimage\",\"url\":\"https:\\\/\\\/i0.wp.com\\\/practicalpowershell.com\\\/wp-content\\\/uploads\\\/2020\\\/03\\\/Progress05.jpg?fit=583%2C234&ssl=1\",\"contentUrl\":\"https:\\\/\\\/i0.wp.com\\\/practicalpowershell.com\\\/wp-content\\\/uploads\\\/2020\\\/03\\\/Progress05.jpg?fit=583%2C234&ssl=1\",\"width\":583,\"height\":234},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/adding-a-progress-bar\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/practicalpowershell.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Adding a Progress Bar\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#website\",\"url\":\"https:\\\/\\\/practicalpowershell.com\\\/\",\"name\":\"Practical PowerShell\",\"description\":\"PowerShell books written by experts\",\"publisher\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#\\\/schema\\\/person\\\/4d0733c81966e744aabbb49f56d64deb\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/practicalpowershell.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":[\"Person\",\"Organization\"],\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#\\\/schema\\\/person\\\/4d0733c81966e744aabbb49f56d64deb\",\"name\":\"damian\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d5a8cc64a5aa27558a897b108e3be1a89859511a3fd26176dac292f26e7a4ae4?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d5a8cc64a5aa27558a897b108e3be1a89859511a3fd26176dac292f26e7a4ae4?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d5a8cc64a5aa27558a897b108e3be1a89859511a3fd26176dac292f26e7a4ae4?s=96&d=mm&r=g\",\"caption\":\"damian\"},\"logo\":{\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d5a8cc64a5aa27558a897b108e3be1a89859511a3fd26176dac292f26e7a4ae4?s=96&d=mm&r=g\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Adding a Progress Bar - Practical PowerShell","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/","og_locale":"en_US","og_type":"article","og_title":"Adding a Progress Bar - Practical PowerShell","og_description":"When dealing with complex scripts with lots of running parts and that take some time to complete, it is convenient to have some sort of progress indicator to help visually indicate where a script is in a particular stage. In order to be successful we would need a count of how many items are being […]","og_url":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/","og_site_name":"Practical PowerShell","article_published_time":"2018-12-03T14:00:50+00:00","article_modified_time":"2020-03-14T04:02:13+00:00","og_image":[{"url":"https:\/\/practicalpowershell.com\/wp-content\/uploads\/2020\/03\/Progress05-150x150.jpg","type":"","width":"","height":""}],"author":"damian","twitter_card":"summary_large_image","twitter_misc":{"Written by":"damian","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/#article","isPartOf":{"@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/"},"author":{"name":"damian","@id":"https:\/\/practicalpowershell.com\/#\/schema\/person\/4d0733c81966e744aabbb49f56d64deb"},"headline":"Adding a Progress Bar","datePublished":"2018-12-03T14:00:50+00:00","dateModified":"2020-03-14T04:02:13+00:00","mainEntityOfPage":{"@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/"},"wordCount":642,"commentCount":0,"publisher":{"@id":"https:\/\/practicalpowershell.com\/#\/schema\/person\/4d0733c81966e744aabbb49f56d64deb"},"image":{"@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/#primaryimage"},"thumbnailUrl":"https:\/\/practicalpowershell.com\/wp-content\/uploads\/2020\/03\/Progress05-150x150.jpg","inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/practicalpowershell.com\/adding-a-progress-bar\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/","url":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/","name":"Adding a Progress Bar - Practical PowerShell","isPartOf":{"@id":"https:\/\/practicalpowershell.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/#primaryimage"},"image":{"@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/#primaryimage"},"thumbnailUrl":"https:\/\/practicalpowershell.com\/wp-content\/uploads\/2020\/03\/Progress05-150x150.jpg","datePublished":"2018-12-03T14:00:50+00:00","dateModified":"2020-03-14T04:02:13+00:00","breadcrumb":{"@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/practicalpowershell.com\/adding-a-progress-bar\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/#primaryimage","url":"https:\/\/i0.wp.com\/practicalpowershell.com\/wp-content\/uploads\/2020\/03\/Progress05.jpg?fit=583%2C234&ssl=1","contentUrl":"https:\/\/i0.wp.com\/practicalpowershell.com\/wp-content\/uploads\/2020\/03\/Progress05.jpg?fit=583%2C234&ssl=1","width":583,"height":234},{"@type":"BreadcrumbList","@id":"https:\/\/practicalpowershell.com\/adding-a-progress-bar\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/practicalpowershell.com\/"},{"@type":"ListItem","position":2,"name":"Adding a Progress Bar"}]},{"@type":"WebSite","@id":"https:\/\/practicalpowershell.com\/#website","url":"https:\/\/practicalpowershell.com\/","name":"Practical PowerShell","description":"PowerShell books written by experts","publisher":{"@id":"https:\/\/practicalpowershell.com\/#\/schema\/person\/4d0733c81966e744aabbb49f56d64deb"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/practicalpowershell.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":["Person","Organization"],"@id":"https:\/\/practicalpowershell.com\/#\/schema\/person\/4d0733c81966e744aabbb49f56d64deb","name":"damian","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/d5a8cc64a5aa27558a897b108e3be1a89859511a3fd26176dac292f26e7a4ae4?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/d5a8cc64a5aa27558a897b108e3be1a89859511a3fd26176dac292f26e7a4ae4?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d5a8cc64a5aa27558a897b108e3be1a89859511a3fd26176dac292f26e7a4ae4?s=96&d=mm&r=g","caption":"damian"},"logo":{"@id":"https:\/\/secure.gravatar.com\/avatar\/d5a8cc64a5aa27558a897b108e3be1a89859511a3fd26176dac292f26e7a4ae4?s=96&d=mm&r=g"}}]}},"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/posts\/480","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/comments?post=480"}],"version-history":[{"count":2,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/posts\/480\/revisions"}],"predecessor-version":[{"id":488,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/posts\/480\/revisions\/488"}],"wp:attachment":[{"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/media?parent=480"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/categories?post=480"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/tags?post=480"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}