Suspend-PrintJob
Suspends a print job on the specified printer.
Syntax
Suspend-PrintJob
[-InputObject] <CimInstance>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Suspend-PrintJob
[-ComputerName <String>]
[-ID] <UInt32>
[-PrinterName] <String>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Suspend-PrintJob
[-ID] <UInt32>
[-PrinterObject] <CimInstance>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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.
Examples
Example 1: Suspend a specific print job
Suspend-PrintJob -PrinterName "PrinterName" -ID 1This 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
$Printer = Get-Printer -Name "PrinterName"
Suspend-PrintJob -PrinterObject $Printer -ID 1The 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
$PrintJob = Get-PrintJob -PrinterName "PrinterName" -ID 1
Suspend-PrintJob -InputObject $printJobThe 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.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
Specifies the name of the computer on which to suspend a print job.
| Type: | String |
| Aliases: | CN, computer |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ID
Specifies the ID of the print job to suspend on the specified printer. You cannot use wildcard characters.
| Type: | UInt32 |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
| Type: | CimInstance |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PrinterName
Specifies a printer name on which to suspend the print job.
| Type: | String |
| Aliases: | PN |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PrinterObject
Specifies the object which contains the printer on which to suspend the print job.
| Type: | CimInstance |
| Aliases: | Printer |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 PowerShell® 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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |