Export (0) Print
Expand All

Remove-BitsTransfer

Updated: October 28, 2009

Applies To: Windows PowerShell 2.0

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

Syntax

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

Description

The Remove-BitsTransfer cmdlet cancels a BITS transfer job. It deletes the underlying transfer job, removes any temporary files from the client, and deletes the associated BitsJob object.

When the Remove-BitsTransfer cmdlet cancels a transfer job, it deletes all the transfers. Consider a scenario is which you are transferring three files. One file is completely transferred, one file is pending, and one file is currently being transferred. In this scenario, Remove-BitsTransfer cancels the whole transfer and deletes the underlying files. Any files that were already transferred will not be available after you use the Remove-BitsTransfer cmdlet to cancel the transfer job. Optionally, you can use a Complete-BitsTransfer command to commit any files that are completely downloaded and to cancel the pending and current transfers. The transferred file would not be deleted and would be available.

Parameters

-BitsJob <BitsJob[]>

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

 

Required?

true

Position?

1

Default Value

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before executing the command.

 

Required?

false

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

 

Required?

false

Position?

named

Default Value

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

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

 

Inputs

Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

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

Outputs

None

This cmdlet does not generate any output.

Notes

After a job is removed (canceled) or completed, any job objects that were previously cached in variables or in scripts are no longer valid.

Example 1

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

Description
-----------
This command cancels all the BITS transfer jobs that are owned by the current user. 

The output of the Get-BitsTransfer cmdlet is piped to the Remove-BitsTransfer cmdlet. The output is a set of BitsJob objects.







Example 2

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

Description
-----------
This command cancels 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 Remove-BitsTransfer cmdlet.







See Also



Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft