{"id":3690,"date":"2021-01-04T08:00:59","date_gmt":"2021-01-04T14:00:59","guid":{"rendered":"https:\/\/practicalpowershell.com\/?p=3690"},"modified":"2020-12-27T09:24:07","modified_gmt":"2020-12-27T15:24:07","slug":"using-start-bitstransfer","status":"publish","type":"post","link":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/","title":{"rendered":"Using Start-BitsTransfer"},"content":{"rendered":"


New Year, New Posts. So first, Happy New Year! and Second, welcome to my 4th year of producing PowerShell Tips.
<\/p>\n

START-BITSTRANSFER<\/h3>\n

For this tip we will explore the Start-BitsTransfer cmdlet to see how useful it is. First, what is Bits? Well, technically, its BITS and it stands for Background Intelligent Transfer Service, which is a Microsoft technology. You can read about it more here:

\nBackground Intelligent Transfer Service<\/a>

\nWhat it allows us to do is to transfer files from locations that we have access to and ‘download’ those files to a location of our choice, that we also need access to. If we review the Get-Help for the Start-BitsTransfer cmdlet we see there are no examples and the Get-Help -Online for the cmdlet also fails to pull up the proper Online Help page for Start-BitsTransfer cmdlet. However, we can find the help using our favorite Search engine which brings up this page:

\nhttps:\/\/docs.microsoft.com\/en-us\/powershell\/module\/bitstransfer\/start-bitstransfer?view=win10-ps<\/a>

\nWe have a proper example on the page that looks like this:
\n[sourcecode language=”powershell”]
\nStart-BitsTransfer -Source "http:\/\/server01\/servertestdir\/testfile1.txt" -Destination "c:\\clienttestdir\\testfile1.txt"
\n[\/sourcecode]
\nWe can see a list of parameters available to the cmdlet as well:
\n\"\"<\/a>
\nUse Case Scenarios for Start-BitsTransfer:
<\/p>\n

EXAMPLES<\/h3>\n

Example #1<\/strong>
\nIn most cases, the easiest way to use the cmdlet is to use the Source and Destination parameters for the cmdlet. Examples:
\n[sourcecode language=”powershell”]
\nStart-BitsTransfer -Source "<SourceFile>" -Destination "<DownloadFile>"
\n[\/sourcecode]
\nNow, let’s say our source was a Microsoft update and our destination was a local server share, then we would construct the one-liner like this:
\n.NET download location – https:\/\/download.visualstudio.microsoft.com\/download\/pr\/7afca223-55d2-470a-8edc-6a1739ae3252\/abd170b4b0ec15ad0222a809b761a036\/ndp48-x86-x64-allos-enu.exe”
\n[sourcecode language=”powershell”]
\n$SourceFile = "https:\/\/download.visualstudio.microsoft.com\/download\/pr\/7afca223-55d2-470a-8edc-6a1739ae3252\/abd170b4b0ec15ad0222a809b761a036\/ndp48-x86-x64-allos-enu.exe"
\n$DownloadPath = "\\\\fs01\\Downloads\\Updates"
\nStart-BitsTransfer -Source "$SourceFile" -Destination "$DownloadPath"
\n[\/sourcecode]
\nStart-BitsTransfer does not provide much feedback, unless we add that code to a script.
\nExample #2<\/strong>
\nFor this example, we will download a file from GitHub, only to find that is fails. With a straight download, we see something like this:

\n\"\"<\/a>
\nNow, the solution is to use a switch called ‘Dynamic’ which was discovered in this thread here:

\nhttps:\/\/powershell.org\/forums\/topic\/bits-transfer-with-github\/<\/a><\/strong>

\nBy using that switch, no more errors occur. Below is a real code section that was created for downloaded an Exchange Health Check script:
\n[sourcecode language=”powershell”]
\n# HealthChecker Script – Latest Version
\n$Repo = "dpaulson45\/HealthChecker"
\n$File = "HealthChecker.ps1"
\n$CurrentPath = (Get-Item -Path ".\\" -Verbose).FullName
\n$Releases = "https:\/\/api.github.com\/repos\/$repo\/releases"
\n$tag = (Invoke-WebRequest $releases | ConvertFrom-Json)[0].tag_name
\n$download = "https:\/\/github.com\/$repo\/releases\/download\/$tag\/$file"
\nTry {
\n Start-BitsTransfer -Source "$Download" -Destination "$CurrentPath" -dynamic -ErrorAction STOP
\n} Catch {
\n Write-Host " * Download of $Tag of HealthChecker failed" -ForegroundColor Red
\n Write-Host " – Using previous version of HealthChecker script." -ForegroundColor Yellow
\n}
\n[\/sourcecode]
\nNow we have a script to download the file to a local path.<\/p>\n

NEXT STEPS<\/h3>\n

Look out for the next post where we can dive into other BitsTransfer cmdlets. There are quite a few cmdlets that involve the BITS technology. See you next time!<\/p>\n

FURTHER READING<\/h3>\n

I cover this and many more topics in this book:<\/p>\n\n\n
\nNotes from the Field: A PowerShell Primer<\/a><\/strong>
\n\"\"<\/a>\n<\/td>\n<\/tr>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

New Year, New Posts. So first, Happy New Year! and Second, welcome to my 4th year of producing PowerShell Tips. START-BITSTRANSFER For this tip we will explore the Start-BitsTransfer cmdlet to see how useful it is. First, what is Bits? Well, technically, its BITS and it stands for Background Intelligent Transfer Service, which is a […]<\/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":[22],"tags":[],"class_list":["post-3690","post","type-post","status-publish","format-standard","hentry","category-powershell"],"yoast_head":"\nUsing Start-BitsTransfer - 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\/using-start-bitstransfer\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Using Start-BitsTransfer - Practical PowerShell\" \/>\n<meta property=\"og:description\" content=\"New Year, New Posts. So first, Happy New Year! and Second, welcome to my 4th year of producing PowerShell Tips. START-BITSTRANSFER For this tip we will explore the Start-BitsTransfer cmdlet to see how useful it is. First, what is Bits? Well, technically, its BITS and it stands for Background Intelligent Transfer Service, which is a […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/\" \/>\n<meta property=\"og:site_name\" content=\"Practical PowerShell\" \/>\n<meta property=\"article:published_time\" content=\"2021-01-04T14:00:59+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/practicalpowershell.com\/wp-content\/uploads\/2020\/12\/Start-BitsTransfer-001.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\\\/using-start-bitstransfer\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/\"},\"author\":{\"name\":\"damian\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#\\\/schema\\\/person\\\/4d0733c81966e744aabbb49f56d64deb\"},\"headline\":\"Using Start-BitsTransfer\",\"datePublished\":\"2021-01-04T14:00:59+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/\"},\"wordCount\":598,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#\\\/schema\\\/person\\\/4d0733c81966e744aabbb49f56d64deb\"},\"image\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/practicalpowershell.com\\\/wp-content\\\/uploads\\\/2020\\\/12\\\/Start-BitsTransfer-001.jpg\",\"articleSection\":[\"PowerShell\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/\",\"url\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/\",\"name\":\"Using Start-BitsTransfer - Practical PowerShell\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/practicalpowershell.com\\\/wp-content\\\/uploads\\\/2020\\\/12\\\/Start-BitsTransfer-001.jpg\",\"datePublished\":\"2021-01-04T14:00:59+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/#primaryimage\",\"url\":\"https:\\\/\\\/i0.wp.com\\\/practicalpowershell.com\\\/wp-content\\\/uploads\\\/2020\\\/12\\\/Start-BitsTransfer-001.jpg?fit=823%2C158&ssl=1\",\"contentUrl\":\"https:\\\/\\\/i0.wp.com\\\/practicalpowershell.com\\\/wp-content\\\/uploads\\\/2020\\\/12\\\/Start-BitsTransfer-001.jpg?fit=823%2C158&ssl=1\",\"width\":823,\"height\":158},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/practicalpowershell.com\\\/using-start-bitstransfer\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/practicalpowershell.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Using Start-BitsTransfer\"}]},{\"@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":"Using Start-BitsTransfer - 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\/using-start-bitstransfer\/","og_locale":"en_US","og_type":"article","og_title":"Using Start-BitsTransfer - Practical PowerShell","og_description":"New Year, New Posts. So first, Happy New Year! and Second, welcome to my 4th year of producing PowerShell Tips. START-BITSTRANSFER For this tip we will explore the Start-BitsTransfer cmdlet to see how useful it is. First, what is Bits? Well, technically, its BITS and it stands for Background Intelligent Transfer Service, which is a […]","og_url":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/","og_site_name":"Practical PowerShell","article_published_time":"2021-01-04T14:00:59+00:00","og_image":[{"url":"https:\/\/practicalpowershell.com\/wp-content\/uploads\/2020\/12\/Start-BitsTransfer-001.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\/using-start-bitstransfer\/#article","isPartOf":{"@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/"},"author":{"name":"damian","@id":"https:\/\/practicalpowershell.com\/#\/schema\/person\/4d0733c81966e744aabbb49f56d64deb"},"headline":"Using Start-BitsTransfer","datePublished":"2021-01-04T14:00:59+00:00","mainEntityOfPage":{"@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/"},"wordCount":598,"commentCount":0,"publisher":{"@id":"https:\/\/practicalpowershell.com\/#\/schema\/person\/4d0733c81966e744aabbb49f56d64deb"},"image":{"@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/#primaryimage"},"thumbnailUrl":"https:\/\/practicalpowershell.com\/wp-content\/uploads\/2020\/12\/Start-BitsTransfer-001.jpg","articleSection":["PowerShell"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/practicalpowershell.com\/using-start-bitstransfer\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/","url":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/","name":"Using Start-BitsTransfer - Practical PowerShell","isPartOf":{"@id":"https:\/\/practicalpowershell.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/#primaryimage"},"image":{"@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/#primaryimage"},"thumbnailUrl":"https:\/\/practicalpowershell.com\/wp-content\/uploads\/2020\/12\/Start-BitsTransfer-001.jpg","datePublished":"2021-01-04T14:00:59+00:00","breadcrumb":{"@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/practicalpowershell.com\/using-start-bitstransfer\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/#primaryimage","url":"https:\/\/i0.wp.com\/practicalpowershell.com\/wp-content\/uploads\/2020\/12\/Start-BitsTransfer-001.jpg?fit=823%2C158&ssl=1","contentUrl":"https:\/\/i0.wp.com\/practicalpowershell.com\/wp-content\/uploads\/2020\/12\/Start-BitsTransfer-001.jpg?fit=823%2C158&ssl=1","width":823,"height":158},{"@type":"BreadcrumbList","@id":"https:\/\/practicalpowershell.com\/using-start-bitstransfer\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/practicalpowershell.com\/"},{"@type":"ListItem","position":2,"name":"Using Start-BitsTransfer"}]},{"@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\/3690","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=3690"}],"version-history":[{"count":5,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/posts\/3690\/revisions"}],"predecessor-version":[{"id":3716,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/posts\/3690\/revisions\/3716"}],"wp:attachment":[{"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/media?parent=3690"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/categories?post=3690"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/practicalpowershell.com\/wp-json\/wp\/v2\/tags?post=3690"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}