Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Resume-BitsTransfer

Resume-BitsTransfer

microsoft.backgroundintelligenttransfer.management.dll

Synopsis

Resumes a Background Intelligent Transfer Service (BITS) transfer job.

Syntax

Resume-BitsTransfer [-BitsJob] [-Asynchronous] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

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.

Parameters

-Asynchronous <SwitchParameter>

Allows the BITS transfer job to be processed in the background. The command prompt reappears immediately after the BITS transfer job is resumed. The returned BitsJob object can be used to monitor status and progress.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-BitsJob <BitsJob[]>

Specifies the BITS transfer jobs to resume. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

Return Type

Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

Notes

You can cancel a transfer job that is running in synchronous mode (foreground priority) by pressing CTRL+C.

Examples

-------------------------- EXAMPLE 1 --------------------------

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.

C:\PS>Get-BitsTransfer | Resume-BitsTransfer

-------------------------- EXAMPLE 2 --------------------------

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.

C:\PS>$b = Start-BitsTransfer -DisplayName "MyJob" -Suspended

-------------------------- EXAMPLE 3 --------------------------

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.

C:\PS>Get-BitsTransfer -Name testjob1 | Resume-BitsTransfer

Online Version
Add-BitsFile
Complete-BitsTransfer
Get-BitsTransfer
Remove-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer
Suspend-BitsTransfer