PowerShell Logo Small

Remove-BitsTransfer



This is the built-in help made by Microsoft for the command 'Remove-BitsTransfer', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 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.

SYNOPSIS

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

SYNTAX


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



Search powershellhelp.space

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.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/p/?linkid=287260
Add-BitsFile
Complete-BitsTransfer
Get-BitsTransfer
Resume-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer
Suspend-BitsTransfer

REMARKS

<

Examples


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

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



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 -AllUsersPS C:\>Remove-BitsTransfer -BitsJob $b



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.