powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Suspend-BitsTransfer



NAME
Suspend-BitsTransfer

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

SYNTAX
Suspend-BitsTransfer [-BitsJob] [-Confirm] [-WhatIf] []


DESCRIPTION
The Suspend-BitsTransfer cmdlet suspends (pauses) one or more BITS transfer jobs. If the transfer is already suspen
ded, the cmdlet does nothing. You can restart the BITS transfer job by using the Resume-BitsTransfer cmdlet.


PARAMETERS
-BitsJob
Specifies the BITS transfer jobs to suspend. You can pipe a value to this parameter from other cmdlets that ret
urn BitsJob objects, such as Get-BitsTransfer.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help 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.


NOTES





-------------------------- 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.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkId=141436
Add-BitsFile
Complete-BitsTransfer
Get-BitsTransfer
Remove-BitsTransfer
Resume-BitsTransfer
Set-BitsTransfer
Start-BitsTransfer