This is the built-in help made by Microsoft for the command 'Get-BitsTransfer', in PowerShell version 4 - as retrieved from
Windows version 'Microsoft Windows 8.1 Enterprise' 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.
Retrieves the associated BitsJob object for an existing Background Intelligent Transfer Service (BITS) transfer job.
Get-BitsTransfer [[-Name] <String[]>] [[-AllUsers]] [<CommonParameters>]
Get-BitsTransfer [-JobId] <Guid[]> [<CommonParameters>]
The Get-BitsTransfer cmdlet retrieves a set of BITS transfer jobs. By default, the cmdlet returns the jobs that are owned by the current user. However, if you have a
dministrative credentials, you can specify the AllUsers parameter so that the command returns jobs that are owned by all users. The returned jobs can be filtered by n
ame or ID. The jobs are represented by BitsJob objects.
<
Online Version: http://go.microsoft.com/fwlink/p/?linkid=287259
Add-BitsFile
Complete-BitsTransfer
Remove-BitsTransfer
Resume-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer
Suspend-BitsTransfer
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Get-BitsTransfer
JobId DisplayName TransferType JobState OwnerAccount
----- ----------- ------------ -------- ------------
07acbe90-7d25-4d05-a... TestJob2 Download Suspended DOMAIN01\user01
c0dd3d8c-c3a2-4562-8... TestJob1 Download Transferred DOMAIN01\user01
1ef8c549-7a92-4173-b... BitsJobTransfer Download Transferred DOMAIN01\user01
2c8302d5-3f44-4981-8... BitsJobTransfer Download Transferred DOMAIN01\user01
This command returns all the BitsJob objects that are owned by the current user.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>Get-BitsTransfer -JobId C0DD3D8C-C3A2-4562-80B19224879C
JobId DisplayName TransferType JobState OwnerAccount
----- ----------- ------------ -------- ------------
c0dd3d8c-c3a2-4562-8... TestJob1 Download Transferred DOMAIN01\user01
This command returns the BitsJob object that is identified by the specified job ID.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>Get-BitsTransfer -AllUsers -Name *Microsoft*, *Windows*
JobId DisplayName TransferType JobState OwnerAccount
----- ----------- ------------ -------- ------------
07acbe90-7d25-4d05-a... MicrosoftTest Download Suspended DOMAIN01\user01
c0dd3d8c-c3a2-4562-8... WindowsTest Download Transferred DOMAIN01\user02
This command returns all the BitsJob objects, owned by all users, where the DisplayName property of the BitsJob object contains either "Microsoft" or "Windows". If th
e user does not have administrative credentials, this command returns an error because it uses the AllUsers parameter.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>Get-BitsTransfer -Name testjob1
JobId DisplayName TransferType JobState OwnerAccount
----- ----------- ------------ -------- ------------
c0dd3d8c-c3a2-4562-8... TestJob1 Download Transferred DOMAIN01\user01
This command returns the BitsJob object that is identified by the specified display name.