Edit

Managed Reference for BITS PowerShell Commands

  • Article

Background Intelligent Transfer Service (BITS) 4.0 can use Windows PowerShell cmdlets to create and manage file download and upload transfer jobs.

Import-Module BitsTransfer
mkdir -force c:\temp\BITSFILES
Start-BitsTransfer -Source https://aka.ms/WinServ16/StndPDF -Destination c:\temp\BITSFILES\WindowsServer2016.pdf

Windows PowerShell cmdlets for BITS provide much of the same functionality as the bitsadmin command-line utility. However, Windows PowerShell also does the following:

  • Automates BITS tasks in an extensible and management-oriented scripting language.
  • Provides a single tool for all job-related tasks.

Note

To use these commands, you must first import the BITS PowerShell module, using the Import-Module BitsTransfer command. For more information, see the following TechNet article.

For more information on using Windows Powershell, see Windows PowerShell.

BITS PowerShell Classes

Namespace: Microsoft.BackgroundIntelligentTransfer.Management

Assembly: System.Management.Automation

These BITS command classes are implemented by Windows PowerShell. These classes are included in this software development kit (SDK) for completeness only. The members of these classes cannot be used directly, nor should they be used to derive other classes.

Class Description
AddBitsFileCommand Adds one or more files to an existing BITS transfer job.
See the Add-BitsFile cmdlet for detailed information about the parameters and for examples.
ClearBitsTransferCommand Cancels a BITS transfer job.
See the Clear-BitsTransfer cmdlet for detailed information about the parameters and for examples.
CompleteBitsTransferCommand Completes a BITS transfer job.
See the Complete-BitsTransfer cmdlet for detailed information about the parameters and for examples.
GetBitsTransferCommand Retrieves the associated BitsJob object for an existing BITS transfer job.
See the Get-BitsTransfer cmdlet for detailed information about the parameters and for examples.
NewBitsTransferCommand Creates a new BITS transfer job.
See the New-BitsTransfer cmdlet for detailed information about the parameters and for examples.
ResumeBitsTransferCommand Resumes a BITS transfer job.
See the Resume-BitsTransfer cmdlet for detailed information about the parameters and for examples.
SetBitsTransferCommand Modifies the properties of an existing BITS transfer job.
See the Set-BitsTransfer cmdlet for detailed information about the parameters and for examples.
SuspendBitsTransferCommand Suspends a BITS transfer job.
See the Suspend-BitsTransfer cmdlet for detailed information about the parameters and for examples.