Suspend-BitsTransfer
Suspends a BITS transfer job.
Syntax
Default (Default)
Suspend-BitsTransfer
[-BitsJob] <BitsJob[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Examples
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.
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.
Parameter properties
| Type: | BitsJob[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | b |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.BackgroundIntelligentTransfer.Management.BitsJob
This cmdlet accepts one or more BitsJob objects as input that populates the BitsJob parameter.
Outputs
Microsoft.BackgroundIntelligentTransfer.Management.BitsJob
This cmdlet generates the BitsJob objects that are associated with the BITS transfer jobs that were suspended.