This is the built-in help made by Microsoft for the command 'Set-BitsTransfer', in PowerShell version 3 - as retrieved from
Windows version 'Microsoft Windows Server 2012 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.
Modifies the properties of an existing Background Intelligent Transfer Service (BITS) transfer job.
Set-BitsTransfer [-BitsJob] <BitsJob[]> [-Authentication <string>] [-Credential <PSCredential>] [-Description <string>] [-DisplayName
<string>] [-Priority <string>] [-ProxyAuthentication <string>] [-ProxyBypass <string[]>] [-ProxyCredential <PSCredential>] [-ProxyList
<Uri[]>] [-ProxyUsage <string>] [-RetryInterval <int>] [-RetryTimeout <int>] [-SetOwnerToCurrentUser] [-Confirm] [-WhatIf] [<CommonParameters>]
The Set-BitsTransfer cmdlet modifies the properties of an existing BITS transfer job. You can specify the job that you want to modify in the
BitsJob parameter. Or, you can specify the job by passing it through the pipeline.
<
Online version: http://go.microsoft.com/fwlink/?LinkId=141433
Add-BitsFile
Complete-BitsTransfer
Get-BitsTransfer
Remove-BitsTransfer
Resume-BitsTransfer
Start-BitsTransfer
Suspend-BitsTransfer
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>$b = Get-BitsTransfer -JobId 10778CFA-C1D7-4A82-8A9D-80B19224879C
Set-BitsTransfer -BitsJob $b -Priority High
Description
-----------
This command modifies the priority of an existing BITS transfer job.
The first command retrieves the BITS transfer job specified by the JobId parameter and then stores it in the $b variable.
The second command uses the BitsJob parameter to pass the BitsJob object stored in the $b variable to the Set-BitsTransfer parameter. The
Priority parameter is used to set the priority of the BITS transfer job to High.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>Get-BitsTransfer -AllUsers -Name *Microsoft* | Set-BitsTransfer -SetOwnerToCurrentUser
Description
-----------
This command makes the current user the owner of a set of existing BITS transfer jobs.
The output of the Get-BitsTransfer cmdlet is a set of BitsJob objects whose display name contains "Microsoft". This output is passed to the
Set-BitsTransfer cmdlet through the pipeline. The SetOwnerToCurrentUser parameter specifies that the owner of each BITS transfer job is the
current user.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>$b = Get-BitsTransfer -JobId 10778CFA-C1D7-4A82-8A9D-80B19224879C
$c = Get-Credential
Set-BitsTransfer -BitsJob $b -ProxyUsage AutoDetect -ProxyAuthentication $c
Description
-----------
This command changes the proxy settings of an existing BITS transfer job.
The first command retrieves the BITS transfer job identified by the JobId parameter and then stores it in the $b variable.
The second command retrieves credentials from the user and then stores them in the $c variable.
The third command uses the BitsJob parameter to pass the BitsJob object stored in the $b variable to the Set-BitsTransfer cmdlet. It uses the
ProxyAuthentication parameter to pass the PSCredential object stored in the $c parameter. The ProxyUsage parameter allows the BITS transfer
job to automatically discover the Web proxy server by using the Web Proxy Autodiscovery Protocol (WPAD) protocol. The supplied set of
credentials is used to authenticate the user at the proxy server.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>Get-BitsTransfer | Set-BitsTransfer -ProxyUsage Override -ProxyList http://proxy1,http://proxy2:81 -ProxyBypass http://directconnect
Description
-----------
This command changes the proxy settings of an existing BITS transfer job.
The output of the Get-BitsTransfer cmdlet is the set of BitsJob objects that are owned by the current user. This output is piped to the
Set-BitsTransfer cmdlet. The Override value that is specified in the ProxyUsage parameter indicates that an explicit list of proxy server and
bypassed host names will be provided.
The ProxyList parameter specifies two proxy servers. The first server in the list (http://proxy1) is used. If that connection fails, the
command tries the connection by using the second server in the list (http://proxy2:81). If both connections fail, the job fails.
When a list of host names is specified in the ProxyBypass parameter, the connection that is made is a direct connection that does not use a
proxy server. In this example, no proxy server is used to add a file to the BITS transfer queue on the "directconnect" server.