Get-PrintJob
Retrieves a list of print jobs in the specified printer.
Syntax
Get-PrintJob
[-ComputerName <String>]
[-ID <UInt32>]
[-PrinterName] <String>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
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. Use 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 privileges to use 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
This set of commands retrieves a printer object into a variable ($Printer) using Get-Printer, and then retrieves the list of print jobs on the printer specified by the printer object in the variable by using Get-PrintJob.
Parameters
-AsJob
ps_cimcommon_asjob
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 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 from which to retrieve the print job information.
Type: | String |
Aliases: | CN, computer |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ID
Specifies the ID of the print job to retrieve. You cannot use wildcard characters.
Type: | UInt32 |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Aliases: | PN |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PrinterObject
Specifies the printer object from which to retrieve the print job information.
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 |
Inputs
This cmdlet accepts one printer object.
Outputs
This cmdlet returns one or more print job objects.