This is the built-in help made by Microsoft for the command 'Suspend-BitsTransfer', in PowerShell version 3 - as retrieved from
Windows version 'Microsoft Windows Server 2012 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
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.
<
Online version: http://go.microsoft.com/fwlink/?LinkId=141436
Add-BitsFile
Complete-BitsTransfer
Get-BitsTransfer
Remove-BitsTransfer
Resume-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Get-BitsTransfer | Suspend-BitsTransfer
Description
-----------
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 --------------------------
C:\PS>$b = Get-BitsTransfer -AllUsers
Suspend-BitsTransfer -BitsJob $b
Description
-----------
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.