This is the built-in help made by Microsoft for the command 'Resume-BitsTransfer', in PowerShell version 3 - as retrieved from
Windows version 'Microsoft Windows Server 2012 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Resumes a Background Intelligent Transfer Service (BITS) transfer job.
Resume-BitsTransfer [-BitsJob] <BitsJob[]> [-Asynchronous] [-Confirm] [-WhatIf] [<CommonParameters>]
The Resume-BitsTransfer cmdlet resumes one or more suspended BITS transfer jobs. If the BITS transfer is already in process, the cmdlet does
nothing. You can view the current state of a transfer job by using the Get-BitsTransfer cmdlet.
Important: By default, the Resume-BitsTransfer cmdlet restarts the transfer job synchronously even if the original job was specified as an
asynchronous transfer job. You could use this behavior to convert an asynchronous transfer job into a synchronous transfer job. You could do
this if either of the following conditions is true:
- The asynchronous transfer job was created outside cmdlets.
- The asynchronous transfer job was created by using the Start-BitsTransfer cmdlet.
If you want to restart the transfer job as an asynchronous transfer, use the Asynchronous parameter.
<
Online version: http://go.microsoft.com/fwlink/?LinkId=141432
Add-BitsFile
Complete-BitsTransfer
Get-BitsTransfer
Remove-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer
Suspend-BitsTransfer
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Get-BitsTransfer | Resume-BitsTransfer
Description
-----------
This command resumes all the BITS transfer jobs that are owned by the current user.
The command prompt returns after the jobs are complete or after the jobs enter an error state. The output of the Get-BitsTransfer cmdlet is a
set of BitsJob objects. This output is piped to the Resume-BitsTransfer cmdlet. If any of the BITS transfer jobs are already active, they will
continue to run.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>$b = Start-BitsTransfer -DisplayName "MyJob" -Suspended
Add-BitsTransfer -BitsJob $b -ClientFileName C:\myFile -ServerFileName http://www.mysite.com/file1
Resume-BitsTransfer -BitsJob $b -Asynchronous
Description
-----------
This command resumes a new BITS transfer job that was initially suspended, and it returns the command prompt immediately.
The first command creates a new BitsJob object in a suspended state and then stores it in the $b variable.
The second command adds a file to the transfer queue of the new BitsJob object that is stored in the $b variable.
The third command uses the BitsJob parameter to pass the BitsJob object that is stored in the $b parameter to the Resume-BitsTransfer cmdlet.
This command starts the BITS transfer job.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>Get-BitsTransfer -Name testjob1 | Resume-BitsTransfer
Description
-----------
This command resumes the BITS transfer that is identified by the specified display name.
The command prompt returns after the job is complete or after the job enters an error state. The output of the Get-BitsTransfer cmdlet is a
BitsJob object. This output is piped to the Resume-BitsTransfer cmdlet. If the BITS transfer job is already active, it will continue to run.