Get-BitsTransfer

Get-BitsTransfer

Gets the associated BitsJob object for an existing BITS transfer job.

Syntax

Parameter Set: ListJobsByName
Get-BitsTransfer [[-Name] <String[]> ] [[-AllUsers]] [ <CommonParameters>]

Parameter Set: ListJobsById
Get-BitsTransfer [-JobId] <Guid[]> [ <CommonParameters>]




Detailed Description

The Get-BitsTransfer cmdlet retrieves a set of Background Intelligent Transfer Service (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

Indicates that this cmdlet gets 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.


Aliases

all

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobId<Guid[]>

Specifies an array of 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.


Aliases

id

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of 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 Transfer"

Get-BitsTransfer -Name "BITS Transfe[a-r]"

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


Aliases

n

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

    This cmdlet accepts one or more BitsJob objects as input that populates the parameter (based on the property name).


Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

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


Examples

Example 1: Get all BitsJob objects owned by the current user

This command gets all the BitsJob objects that are owned by the current user.


PS C:\>Get-BitsTransfer

Example 2: Get the BitsJob object identified by job ID

This command gets the BitsJob object that is identified by the specified job ID.


PS C:\>Get-BitsTransfer -JobId C0DD3D8C-C3A2-4562-80B19224879C

Example 3: Get all BitsJob objects with a specific display name

This command gets all the BitsJob objects, owned by all users, where the DisplayName property of the BitsJob object contains either Microsoft or Windows. If the user does not have administrative credentials, this command returns an error because it uses the AllUsers parameter.


PS C:\>Get-BitsTransfer -AllUsers -Name "*Microsoft*", "*Windows*"

Example 4: Get a BitsJob object identified by a specific display name

This command gets the BitsJob object that is identified by the specified display name.


C:\PS>Get-BitsTransfer -Name "TestJob1"

Related topics

Community Additions

ADD
Show: