Professional Documents
Culture Documents
About BITS Cmdlets
About BITS Cmdlets
about_BITS_Cmdlets
SHORT DESCRIPTION
Provides background information about the Background Intelligent Transfer
Service (BITS).
LONG DESCRIPTION
This topic provides information about BITS, BITS transfer types, BITS
transfer persistence, BITS transfer priority, the Windows PowerShell and
BITS cmdlets, and BITS server configuration. This topic also provides
links to more information about BITS.
About BITS
BITS is a file transfer service that provides a scriptable interface
through Windows PowerShell. BITS transfers files asynchronously in the
foreground or in the background. And, it automatically resumes file
transfers after network disconnections and after a computer is restarted.
Background transfers use only idle network bandwidth in an effort to
preserve the user s interactive experience with other network
applications such as Internet Explorer. BITS does this by examining the
network traffic and then using only the idle portion of the network
bandwidth. BITS continuously throttles its use of the bandwidth as the
user increases or decreases their use of the bandwidth. BITS performs
the transfers asynchronously, which means that your program or script
does not have to be running for BITS to perform the transfer. Both
uploads and downloads are supported. BITS is particularly suitable for
copying files from an HTTP location in an Internet Information Services
virtual directory to the logical drive of a client. Standard server
message block (SMB) copy operations are also supported. In addition to
the scripting interface provided by Windows PowerShell, BITS provides a
set of COM APIs to allow programming access.
Cmdlet Descriptions
--------- --------------------------------
Add-BitsFile Adds one or more files to a BITS transfer.
Complete-BitsTransfer Completes a BITS transfer.
Get-BitsTransfer Gets a single or multiple BITS transfer.
Remove-BitsTransfer Deletes a BITS transfer.
Resume-BitsTransfer Resumes a suspended BITS transfer.
Set-BitsTransfer Configures BITS transfer jobs.
Start-BitsTransfer Creates and starts a BITS transfer job.
Suspend-BitsTransfer Suspends a BITS transfer job.
To copy a file using BITS:
1. Create a BITS transfer job by using the Start-BitsTranfer cmdlet,
optionally with the Suspend parameter.
2. Add files to the BITS transfer job by using the Add-BitsFile
cmdlet.
3. Start the BITS transfer by using the Resume-BitsTransfer cmdlet.
4. Check the status of the BITS transfer job by using the
Get-BitsTransfer cmdlet.
Sample Commands
A simple Windows PowerShell BITS file transfer command might resemble
the following command:
C:\PS> Start-BitsTransfer http://server01/servertestdir/testfile1.txt c:
\clienttestdir\testfile1.txt
A slightly more complex Windows PowerShell BITS file transfer set of
commands might resemble the following command:
C:\PS> Import-CSV filelist.txt | Start-BitsTransfer -TransferType Upload
SEE ALSO
Online version: http://go.microsoft.com/fwlink/?LinkId=142218
Add-BitsFile
Complete-BitsTransfer
Get-BitsTransfer
Remove-BitsTransfer
Resume-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer
Suspend-BitsTransfer