Edit

Suspend-BitsTransfer

  • Reference
Module:
BitsTransfer

Suspends a BITS transfer job.

Syntax

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.

Type:BitsJob[]
Aliases:b
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required: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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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.