Get-BitsTransfer
Get-BitsTransfer is accessible with the help of BitsTransfer module. To configure BitsTransfer, go through this link.
Synopsis
Gets the associated BitsJob object for an existing BITS transfer job.
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.
| Type: | SwitchParameter |
| Aliases: | all |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobId
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.
| Type: | Guid[] |
| Aliases: | id |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Name
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.
| Type: | String[] |
| Aliases: | n |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Syntax
Get-BitsTransfer [[-Name] <String[]>] [-AllUsers] [<CommonParameters>]
Get-BitsTransfer [-JobId] <Guid[]> [<CommonParameters>]
——————-Example 1——————-
Get all BitsJob objects owned by the current user
PS C:>Get-BitsTransfer
This command gets all the BitsJob objects that are owned by the current user.
——————-Example 2——————-
Get the BitsJob object identified by job ID
PS C:>Get-BitsTransfer -JobId <JobID>
This command gets the BitsJob object that is identified by the specified job ID.
——————-Example 3——————-
Get all BitsJob objects with a specific display name
PS C:>Get-BitsTransfer -AllUsers -Name “Microsoft“, “Windows“
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.
——————-Example 3——————-
Get a BitsJob object identified by a specific display name
C:\PS>Get-BitsTransfer -Name “transferJob1”
This command gets the BitsJob object that is identified by the specified display name.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Get-BitsTransfer
You can also read about
- Add-BitsFile
- Complete-BitsTransfer
- Remove-BitsTransfer
- Resume-BitsTransfer
- Set-BitsTransfer
- Start-BitsTransfer
- Suspend-BitsTransfer
