Get-BitsTransfer

Retrieves the associated BitsJob object for an existing Background Intelligent Transfer Service (BITS) transferjob.
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 administrative 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 name or ID. The jobs are represented by BitsJob objects.

Parameters
-AllUsers [<SwitchParameter>]

  • Default value is Current

Returns BITS transfer jobs that are owned by all users. If this parameter is not specified, only jobs that are owned by the current user are returned. This parameter requires administrative credentials.

-JobId <Guid[]>

Filters the returned BITS jobs by job ID. Only the BITS jobs that include a job ID in this array are returned. If BitsJob objects are piped to this cmdlet, their job IDs are used as the values of this parameter.

-Name <string[]>

Filters the returned BITS jobs based on job name. Only BITS jobs with job names that match a name in this array are returned. You can use standard wildcard characters such as the asterisk (*) and the question mark (?). Or, you can use a range operator such as”[a-r]”.

For example, you can use any of the following commands:

Get-BitsTransfer -Name “BITS*” Get-BitsTransfer -Name “BITS Transfe?” Get-BitsTransfer -Name “BITS Transfe[a-r]”

A combination of the wildcard character and range operators is also possible.

<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 JobId parameter (based on the property name).

Outputs

Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

This cmdlet generates the BitsJob objects that are associated with the retrieved BITS transfer jobs.

Examples
  1. This command returns all the BitsJob objects that are owned by the current user:
    C:PS> Get-BitsTransfer
    
       JobId                   DisplayName             TransferType            JobState                OwnerAccount
       -----                   -----------             ------------            --------                ------------
       07acbe90-7d25-4d05-a... TestJob2                Download                Suspended               DOMAIN01user01
       c0dd3d8c-c3a2-4562-8... TestJob1                Download                Transferred             DOMAIN01user01
       1ef8c549-7a92-4173-b... BitsJobTransfer         Download                Transferred             DOMAIN01user01
       2c8302d5-3f44-4981-8... BitsJobTransfer         Download                Transferred             DOMAIN01user01
  2. This command returns the BitsJob object that is identified by the specified job ID:
    C:PS> Get-BitsTransfer -JobId C0DD3D8C-C3A2-4562-80B19224879C
    
       JobId                   DisplayName             TransferType            JobState                OwnerAccount
       -----                   -----------             ------------            --------                ------------
       c0dd3d8c-c3a2-4562-8... TestJob1                Download                Transferred             DOMAIN01user01
  3. This command returns all the BitsJob objects, owned by all users, where the DisplayName property of the BitsJob object contains either “Microsoft” or “Windows”:
    C:PS> Get-BitsTransfer -AllUsers -Name *Microsoft*, *Windows*
    
       JobId                   DisplayName             TransferType            JobState                OwnerAccount
       -----                   -----------             ------------            --------                ------------
       07acbe90-7d25-4d05-a... MicrosoftTest           Download                Suspended               DOMAIN01user01
       c0dd3d8c-c3a2-4562-8... WindowsTest             Download                Transferred             DOMAIN01user02

    If the user does not have administrative credentials, this command returns an error because it uses the AllUsers parameter.

  4. This command returns the BitsJob object that is identified by the specified display name:
    C:PS> Get-BitsTransfer -Name testjob1
    
       JobId                   DisplayName             TransferType            JobState                OwnerAccount
       -----                   -----------             ------------            --------                ------------
       c0dd3d8c-c3a2-4562-8... TestJob1                Download                Transferred             DOMAIN01user01
Additional Notes
 
Related Links

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