PowerShell Logo Small

Suspend-PrintJob



This is the built-in help made by Microsoft for the command 'Suspend-PrintJob', 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.

SYNOPSIS

Suspends a print job on the specified printer.

SYNTAX


Suspend-PrintJob [-PrinterName] <String> [-ID] <UInt32> [-AsJob [<SwitchParameter>]] [-CimSession <CimSession>] [-ComputerName <String>]
[-ThrottleLimit <Int32>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Suspend-PrintJob [-InputObject] <CimInstance> [-AsJob [<SwitchParameter>]] [-CimSession <CimSession>] [-ThrottleLimit <Int32>] [-Confirm
[<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Suspend-PrintJob [-PrinterObject] <CimInstance> [-ID] <UInt32> [-AsJob [<SwitchParameter>]] [-CimSession <CimSession>] [-ThrottleLimit
<Int32>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Suspend-PrintJob cmdlet suspends a print job on the specified printer. Use Resume-PrintJob 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 privileges to use Suspend-PrintJob.



<

RELATED LINKS

Get-PrintJob
Remove-PrintJob
Restart-PrintJob
Resume-PrintJob

REMARKS

<

Examples


Example 1: Suspend a specific print job

PS C:\> Suspend-PrintJob -PrinterName "PrinterName" -ID 1



This command suspends the print job with 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



This set of commands retrieves a printer object into a variable ($printer) using Get-Printer, and then passes the contents of the variable to
Suspend-PrintJob to suspend the print job with an ID of 1 on the printer contained in the printer object.




Example 3: Suspend a print job using a print job object

PS C:\> $printJob = Get-PrintJob -PrinterName "Printer1" -ID 1



PS C:\> Suspend-PrintJob -InputObject $printJob



This set of commands retrieves a print job object with an ID of 1 into a variable ($printJob) using Get-PrintJob, and then passes the contents
of the variable to Suspend-PrintJob to suspend the print job on the printer contained in the print job object.