Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-PrintJob

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

Retrieves a list of print jobs in the specified printer.

SYNTAX

name

Get-PrintJob [-ComputerName <String>] [-ID <UInt32>] [-PrinterName] <String> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

object

Get-PrintJob [-ID <UInt32>] [-PrinterObject] <CimInstance> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

DESCRIPTION

The Get-PrintJob cmdlet retrieves the current print jobs in the specified printer. Specify the PrinterName parameter to list the print jobs from the specified printer.

You cannot use wildcard characters with Get-PrintJob. You can use Get-PrintJob in a Windows PowerShell remoting session.

You do not need administrator credentials to run Get-PrintJob.

EXAMPLES

Example 1: Get a list of print jobs

PS C:\> Get-PrintJob -PrinterName "PrinterName"

This command retrieves a list of print jobs on the printer named PrinterName.

Example 2: Get a list of print jobs using a printer object

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

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 gets print jobs on the printer in $Printer.

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Specifies the name of the computer from which to retrieve the print job information.

Type: String
Parameter Sets: name
Aliases: CN, computer

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 retrieve. You can use wildcard characters.

Type: UInt32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PrinterName

Specifies the name of the printer from which to retrieve the print job information.

Type: String
Parameter Sets: name
Aliases: PN

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-PrinterObject

Specifies the printer object from which to retrieve the print job information.

Type: CimInstance
Parameter Sets: object
Aliases: Printer

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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.

INPUTS

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

This cmdlet accepts one printer object.

OUTPUTS

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

This cmdlet returns one or more print job objects.

NOTES

Remove-PrintJob

Restart-PrintJob

Suspend-PrintJob

Resume-PrintJob

© 2017 Microsoft