Export (0) Print
Expand All

Resume-BitsTransfer

Updated: August 15, 2012

Applies To: Windows Server 2012

Resume-BitsTransfer

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

Syntax

Parameter Set: Default
Resume-BitsTransfer [-BitsJob] <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

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

none

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

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

    This cmdlet accepts one or more BitsJob objects as input that populates the BitsJob parameter.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

    When called with the Asynchronous parameter, this cmdlet sends the BitsJob object that is associated with the resumed BITS transfer job as output. Otherwise, no output is generated.


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
PS C:\> Add-BitsTransfer -BitsJob $b -ClientFileName C:\myFile -ServerFileName http://www.mysite.com/file1
PS C:\> Resume-BitsTransfer -BitsJob $b -Asynchronous

-------------------------- 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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft