NAME
Suspend-PrintJob
SYNOPSIS
Suspends a print job on the specified printer.
SYNTAX
Suspend-PrintJob [-PrinterName] [-ID] [-CimSession ] [-ComputerName ]
[-ThrottleLimit ] [-Confirm] [-WhatIf] []
Suspend-PrintJob [-CimSession ] [-ThrottleLimit ] [-Confirm] [-WhatIf] []
Suspend-PrintJob [-PrinterObject] [-ID] [-CimSession ] [-ThrottleLimit
] [-Confirm] [-WhatIf] []
DESCRIPTION
The Suspend-PrintJob cmdlet suspends a print job on the specified printer. Use the Resume-PrintJob cmdlet to
resume the suspended print job.
You can specify the print job to suspend by specifying the PrinterName and job ID parameters, specifying a printer
object and the job ID parameter, or by specifying a print job object as an input.
You cannot use wildcard characters with Suspend-PrintJob. You can use Suspend-PrintJob in a Windows PowerShell
remoting session.
You do not need administrator credentials to run Suspend-PrintJob.
PARAMETERS
-CimSession []
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such
as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local
computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ComputerName []
Specifies the name of the computer on which to suspend a print job.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ID
Specifies the ID of the print job to suspend on the specified printer. You can use wildcard characters.
Required? true
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PrinterName
Specifies a printer name on which to suspend the print job.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue, ByPropertyName)
Accept wildcard characters? false
-PrinterObject
Specifies the object which contains the printer on which to suspend the print job.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue, ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit []
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this
parameter is omitted or a value of 0 is entered, then Windows PowerShellr calculates an optimum throttle limit
for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies
only to the current cmdlet, not to the session or to the computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm []
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf []
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_PrintJob
This cmdlet accepts one print job object.
OUTPUTS
This cmdlet produces no output.
Example 1: Suspend a specific print job
PS C:\> Suspend-PrintJob -PrinterName "PrinterName" -ID 1
This command suspends the print job that has an ID of 1 on the printer named PrinterName.
Example 2: Suspend a print job using a printer object and print job ID
PS C:\>$Printer = Get-Printer -Name "PrinterName"
PS C:\> Suspend-PrintJob -PrinterObject $Printer -ID 1
The first command gets a printer named PrinterName by using the Get-Printer cmdlet. The command stores the result
in the $Printer variable.
The second command suspends the print job that an ID of 1 on the printer stored in $Printer.
Example 3: Suspend a print job using a print job object
PS C:\>$PrintJob = Get-PrintJob -PrinterName "PrinterName" -ID 1
PS C:\> Suspend-PrintJob -InputObject $printJob
The first command gets a print job that has the ID 1 on the printer named PrinterName by using the Get-PrintJob.
The command stores the result in the $PrintJob variable.
The second command suspends the print job in $PrintJob.
RELATED LINKS
Get-PrintJob
Remove-PrintJob
Restart-PrintJob
Resume-PrintJob