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
 

Complete-BitsTransfer

Complete-BitsTransfer

microsoft.backgroundintelligenttransfer.management.dll

Synopsis

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

Syntax

Complete-BitsTransfer [-BitsJob] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Complete-BitsTransfer cmdlet ends one or more BITS transfer jobs and then saves the files on the client computer. If an error occurs, the associated BitsJob object is written to the error pipeline.

Parameters

-BitsJob <BitsJob[]>

Specifies the BITS transfer jobs to complete. 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

None

Notes

None

Examples

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

This command completes all the BITS transfer jobs that are owned by the current user.

In this command, the output of the Get-BitsTransfer cmdlet is piped to the Complete-BitsTransfer cmdlet. The output is a set of BitsJob objects.

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

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

These commands complete all the BITS transfer jobs on the computer.

The first command retrieves all the BitsJob objects on the computer and then stores them in the $b variable.

The second command uses the BitsJob parameter to pass the BitsJob objects that are stored in the $b variable to the Complete-BitsTransfer cmdlet.

C:\PS>$b = Get-BitsTransfer -AllUsers

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

This command completes the BITS transfer job that is identified by the specified display name.

The output of the Get-BitsTransfer cmdlet is a BitsJob object. This output is piped to the Complete-BitsTransfer cmdlet.

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

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