Get-BitsTransfer

Retrieve the associated BitsJob object for an existing Background Intelligent Transfer Service (BITS) transfer job.

Syntax
      Get-BitsTransfer [[-Name] string[]] [-AllUsers] [CommonParameters]

      Get-BitsTransfer [-JobId] Guid[] [CommonParameters]

Key
   -AllUsers
       Return 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[]
       Filter 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[]
       Filter the returned BITS jobs based on job name.
       Only BITS jobs with job names that match a name in this array are returned.
       Accepts standard wildcard characters asterisk (*) and question mark (?).
       Or use a range operator such as "[a-r]".

   CommonParameters:
       -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
       -OutBuffer -OutVariable.

Get-BitsTransfer retrieves a set of BITS transfer jobs. By default, the cmdlet returns only the jobs that are owned by the current user. The returned jobs can be filtered by name or ID. The jobs are represented by BitsJob objects.

Examples

Complete all the BITS transfer jobs that are owned by the current user:

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

Complete all the BITS transfer jobs on the computer:

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

Complete the BITS transfer job called 'SS64':

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

“No law can give power to private persons; every law transfers power from private persons to government” ~ Isabel Paterson

Related:

Set-BitsTransfer - Configure BITS transfer jobs
BITS PowerShell cmdlets


© Copyright SS64.com 1999-2014
Some rights reserved