Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Suspend-BitsTransfer

Suspend-BitsTransfer

microsoft.backgroundintelligenttransfer.management.dll

Synopsis

Suspends a Background Intelligent Transfer Service (BITS) transfer job.

Syntax

Suspend-BitsTransfer [-BitsJob] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Suspend-BitsTransfer cmdlet suspends (pauses) one or more 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 <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.

Aliases

None

Required?

true

Position

1

Default value

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

Return Type

Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

Notes

None

Examples

-------------------------- EXAMPLE 1 --------------------------

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.

C:\PS>Get-BitsTransfer | Suspend-BitsTransfer

-------------------------- EXAMPLE 2 --------------------------

This command suspends all the BITS transfer jobs on the computer.

The first command retrieves all the BitsJob objects on the computer and then stores them in the $b variable.

The second command uses the BitsJob parameter to pass the BitsJob objects that are stored in the $b variable to the Suspend-BitsTransfer cmdlet.

C:\PS>$b = Get-BitsTransfer -AllUsers

Online Version
Add-BitsFile
Complete-BitsTransfer
Get-BitsTransfer
Remove-BitsTransfer
Resume-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer