Get-PrintJob
Get-PrintJob
Retrieves a list of print jobs in the specified printer.
Syntax
Parameter Set: name
Get-PrintJob [-PrinterName] <String> [-AsJob] [-CimSession <CimSession> ] [-ComputerName <String> ] [-ID <UInt32> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: object
Get-PrintJob [-PrinterObject] <CimInstance> [-AsJob] [-CimSession <CimSession> ] [-ID <UInt32> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed 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.
Parameters
-AsJob
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the name of the computer from which to retrieve the print job information.
Aliases |
none |
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 retrieve. You can use wildcard characters.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PrinterName<String>
Specifies the name of the printer from which to retrieve the print job information.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-PrinterObject<CimInstance>
Specifies the printer object from which to retrieve the print job information.
Aliases |
none |
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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_Printer
This cmdlet accepts one printer object.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_PrintJob
This cmdlet returns one or more print job objects.
Examples
Example 1: Get a list of print jobs
This command retrieves a list of print jobs on the printer named PrinterName.
PS C:\> Get-PrintJob –PrinterName "PrinterName"
Example 2: Get a list of print jobs using a printer object
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.
PS C:\> $printer = Get-Printer -Name "PrinterName:"
PS C:\> Get-PrintJob –InputObject $printer