Suspend-PrintJob

Suspend-PrintJob

Suspends a print job on the specified printer.

Syntax

Parameter Set: jobObject
Suspend-PrintJob [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: printerName
Suspend-PrintJob [-PrinterName] <String> [-ID] <UInt32> [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: printerObject
Suspend-PrintJob [-PrinterObject] <CimInstance> [-ID] <UInt32> [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]




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

none

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

-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

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.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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

    This cmdlet accepts one print job object.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • This cmdlet produces no output.


Examples

Example 1: Suspend a specific print job

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

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.


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

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.


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

Related topics

Community Additions

ADD
Show: