Suspend-BitsTransfer is accessible with the help of BitsTransfer module. To configure BitsTransfer, go through this link.
Synopsis
Suspends a BITS transfer job.
Description
The Suspend-BitsTransfer cmdlet suspends, or pauses, one or more Background Intelligent Transfer Service (BITS) transfer jobs. If the transfer is already suspended, the cmdlet does nothing. You can restart the BITS transfer job by using the Resume-BitsTransfer cmdlet.
Parameters
-BitsJob
Specifies the BITS transfer jobs to suspend. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer.
| Type: | BitsJob[] |
| Aliases: | b |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Syntax
Suspend-BitsTransfer [-BitsJob] <BitsJob[]> [-WhatIf] [-Confirm] [<CommonParameters>]
————————Example 1————————
Suspend all BITS transfer jobs owned by the current user
PS C:>Get-BitsTransfer | Suspend-BitsTransfer
This command suspends all the BITS transfer jobs that are owned by the current user.
The output of Get-BitsTransfer is a set of BitsJob objects. This output is piped to the Suspend-BitsTransfer cmdlet.
————————Example 2————————
Suspend all BITS transfer jobs on the computer
PS C:>$Bits = Get-BitsTransfer -AllUsers
PS C:> Suspend-BitsTransfer -BitsJob $Bits
This command suspends all the BITS transfer jobs on the computer.
The first command gets all the BitsJob objects on the computer and then stores them in the $Bits variable.
The second command uses the BitsJob parameter to pass the BitsJob objects that are stored in the $Bits variable to the Suspend-BitsTransfer cmdlet.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Suspend-BitsTransfer
You can also read about
- Add-BitsFile
- Complete-BitsTransfer
- Get-BitsTransfer
- Remove-BitsTransfer
- Resume-BitsTransfer
- Set-BitsTransfer
- Start-BitsTransfer