powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Complete-BitsTransfer



NAME
Complete-BitsTransfer

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

SYNTAX
Complete-BitsTransfer [-BitsJob] [-Confirm] [-WhatIf] []


DESCRIPTION
The Complete-BitsTransfer cmdlet ends one or more BITS transfer jobs and then saves the files on the client compute
r. 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 re
turn 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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

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





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

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


Description
-----------
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 --------------------------

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


Description
-----------
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.





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

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


Description
-----------
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 cm
dlet.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkId=141427
Add-BitsFile
Get-BitsTransfer
Remove-BitsTransfer
Resume-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer
Suspend-BitsTransfer