Suspend-BitsTransfer

Suspends a Background Intelligent Transfer Service (BITS) transfer job.
Suspend-BitsTransfer [-BitsJob*] <BitsJob[]> [-Confirm] [-WhatIf] [<CommonParameters>]

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[]>

  • This value is required
  • Accepts pipeline input ByValue

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.

-Confirm [<SwitchParameter>]

Prompts you for confirmation before executing the command.

-WhatIf [<SwitchParameter>]

Describes what would happen if you executed the command without actually executing the command.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

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.

Examples
  1. This command suspends all the BITS transfer jobs that are owned by the current user:
    C:PS> Get-BitsTransfer | Suspend-BitsTransfer
    

    The output of Get-BitsTransfer is a set of BitsJob objects. This output is piped to the Suspend-BitsTransfer cmdlet.

  2. This command suspends all the BITS transfer jobs on the computer:
    C:PS> $b = Get-BitsTransfer -AllUsers
    Suspend-BitsTransfer -BitsJob $b
    

    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.

Additional Notes
 
Related Links

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