Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Suspend-PrintJob

Suspend-PrintJob

msft_printjob_v1.0.cdxml

Synopsis

Suspends a print job on the specified printer.

Syntax

Suspend-PrintJob [-PrinterObject] [-ID] [-AsJob] [-CimSession] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Suspend-PrintJob [-PrinterName] [-ID] [-AsJob] [-CimSession] [-ComputerName] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Suspend-PrintJob [-InputObject] [-AsJob] [-CimSession] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

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

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ComputerName <String>

Specifies the name of the computer on which to suspend a print job.

Aliases

CN,computer

Required?

false

Position

named

Default value

local machine name

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ID <UInt32>

Specifies the ID of the print job to suspend on the specified printer. You can use wildcard characters.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance>

Specifies the object which contains the print job to suspend on the specified printer.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-PrinterName <String>

Specifies a printer name on which to suspend the print job.

Aliases

PN

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByValue, ByPropertyName)

Accept wildcard characters?

false

-PrinterObject <CimInstance>

Specifies the object which contains the printer on which to suspend the print job.

Aliases

Printer

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByValue, ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_PrintJob

Return Type


Notes

None

Examples

Example 1: Suspend a specific print job

This command suspends the print job with an ID of 1 on the printer named PrinterName.

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

Example 2: Suspend a print job using a printer object and print job ID

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.

PS C:\>$printer = Get-Printer -Name "PrinterName:"


PS C:\>Suspend-PrintJob -PrinterObject $printer -ID 1

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

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.

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


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

Online Version
Get-PrintJob
Remove-PrintJob
Restart-PrintJob
Resume-PrintJob