3 Ways to Download a File in PowerShell - bdsthanhhoavn.com

3 Ways to Download a File in PowerShell

If you use PowerShell to manage Windows, sooner or later you will need to download a file. This is especially true for Windows Server, since best practices have long warned against browsing the internet from a web browser installed on a server.

PowerShell is surprisingly flexible when it comes to file downloads. In fact, there are at least three different ways that you can download a file in PowerShell.

  1. Invoke-WebRequest
  2. New-Object
  3. Start-BitsTransfer

Before explaining how, I want to note that each of the three download techniques accepts a common set of parameters. These parameters include A), the URL that points to the file that is being downloaded, and B), a path to where the file will be stored on your local system once it is downloaded.

As a best practice, I recommend storing the path and the URL in variables. For the purposes of this article, I will be using the variables $URL and $Path. Here is an example of how you would declare these variables, although you will want to replace the values with your own.

$URL = “http://192.168.0.1/MyFile.txt”

$Path=”C:\Files\MyFile.txt”

Notice that the path not only contains the file system location but also the filename to use for the file you will download. This filename does not have to match the filename within the URL. In fact, you can use a different filename as a way of renaming a file when you download it.

1. Invoke-WebRequest Cmdlet

The Invoke-WebRequest cmdlet tends to be my go-to cmdlet for downloading files. Any of the three cmdlets that I show you will work, however.

The syntax used by the Invoke-WebRequest cmdlet is simple. Here is what a download command might look like:

Invoke-WebRequest -URI $URL -OutFile $Path

Note that the URL is mapped to a parameter called -URI, not -URL. If you try to name the parameter -URL, you will receive an error message like the one shown in Figure 1.

Brien PoseyPowerShell screenshot shows that the parameter -URL will produce an error message

Figure 1. Be sure to enter -URI as the parameter name, not -URL.

In Figure 2, you can see what the download process looks like, along with the downloaded file.

Brien PoseyScreenshot shows Invoke-WebRequest cmdlet used to download a file

Figure 2. This is how you use the Invoke-WebRequest cmdlet to download a file.

2. New-Object Cmdlet

You can also use the New-Object cmdlet to download a file in PowerShell.

The New-Object cmdlet, as you may already know, can be used to create a .NET framework object or a COM object. If your goal is to download a file, you will need to create a System.Net.WebClient object. When you create this object, you must call the DownloadFile method and provide values for the URL and for the output path.

Here is an example of what this command looks like:

(New-Object System.Net.WebClient).DownloadFile ($URL, $Path)

When using this command, make sure the New-Object cmdlet is in parentheses. Figure 3 shows you the command in action.

Brien PoseyScreenshot shows New-Object cmdlet used to download a file in PowerShell

Figure 3. This is how to use the New-Object cmdlet to download a file.

3. Start-BitsTransfer

The third way that you can download files in PowerShell is to perform a BITS transfer.

BITS refers to the Background Intelligent Transfer Service. This service is a part of the Windows operating system, and you will need to have BITS enabled for this technique to work.

The Start-BitsTransfer command is just as easy to use as the other two commands. The command looks like this:

Start-BitsTransfer -Source $URL -Destination $Path

Figure 4 offers an example of the command. Although the figure does not show it, BITS transfers include an onscreen progress bar that you can use to monitor the download.

Brien PoseyScreenshot shows BITS transfer used to download a file in PowerShell

Figure 4. This is how you perform a BITS transfer using PowerShell.

Leave a Comment