Complete-BitsTransfer

Completes a Background Intelligent Transfer Service (BITS) transfer job.
Complete-BitsTransfer [-BitsJob*] <BitsJob[]> [-Confirm] [-WhatIf] [<CommonParameters>]

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

  • This value is required
  • Accepts pipeline input ByValue

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.

-Confirm [<SwitchParameter>]

Prompts you for confirmation before executing the command.

-WhatIf [<SwitchParameter>]

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

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.

Examples
  1. This command completes all the BITS transfer jobs that are owned by the current user:
    C:PS> Get-BitsTransfer | Complete-BitsTransfer
    

    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.

  2. These commands complete all the BITS transfer jobs on the computer:
    C:PS> $b = Get-BitsTransfer -AllUsers
    Complete-BitsTransfer -BitsJob $b
    

    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.

  3. This command completes the BITS transfer job that is identified by the specified display name:
    C:PS> Get-BitsTransfer -Name testjob1 | Complete-BitsTransfer
    

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

Additional Notes
 
Related Links

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