Complete-BitsTransfer is accessible with the help of BitsTransfer module. To configure BitsTransfer, go through this link.
Synopsis
Completes a BITS transfer job.
Description
The Complete-BitsTransfer cmdlet ends one or more Background Intelligent Transfer Service (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
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.
| Type: | BitsJob[] |
| Aliases: | b |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| 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.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Syntax
Complete-BitsTransfer [-BitsJob] <BitsJob[]> [-WhatIf] [-Confirm] [<CommonParameters>]
——————-Example 1——————-
Complete all BITS transfer jobs owned by the current user
C:\PS>Get-BitsTransfer | Complete-BitsTransfer
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.
——————-Example 2——————-
Complete all BITS transfer jobs on the computer
PS C:>$Bits = Get-BitsTransfer -AllUsers
PS C:> Complete-BitsTransfer -BitsJob $Bits
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 $Bits variable.
The second command uses the BitsJob parameter to pass the BitsJob objects that are stored in the $Bits variable to the Complete-BitsTransfer cmdlet.
——————-Example 2——————-
Complete a BITS transfer job by display name
PS C:>Get-BitsTransfer -Name transferjob1 | Complete-BitsTransfer
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.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Complete-BitsTransfer
You can also read about
- Add-BitsFile
- Get-BitsTransfer
- Remove-BitsTransfer
- Resume-BitsTransfer
- Set-BitsTransfer
- Start-BitsTransfer
- Suspend-BitsTransfer