Restart-PrintJob
Restart-PrintJob
Restarts a print job on the specified printer.
Syntax
Parameter Set: jobObject
Restart-PrintJob [-InputObject] <CimInstance> [-AsJob] [-CimSession <CimSession> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: printerName
Restart-PrintJob [-PrinterName] <String> [-ID] <UInt32> [-AsJob] [-CimSession <CimSession> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: printObject
Restart-PrintJob [-PrinterObject] <CimInstance> [-ID] <UInt32> [-AsJob] [-CimSession <CimSession> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Restart-PrintJob cmdlet restarts a print job on the specified printer.
You can specify the print job to restart by specifying the PrinterName and ID parameters, by specifying printer object and job ID parameter, or by specifying the job object as an input.
You cannot use wildcard characters with Restart-PrintJob. You can use Restart-PrintJob in a Windows PowerShell remoting session.
You do not need administrator privileges to use Restart-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 on which to restart the print job.
Aliases |
none |
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 restart 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 restart 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 the printer name on which to restart the print job.
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 which contains the printer on which to restart the print job.
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 |
-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: -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_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
-------------------------- ExampleXAMPLE 1: Restart a selected print job -------------------------- xample: Restart a selected print job
This command restarts the print job with an ID of 1 on the printer named PrinterName.
PS C:\> Restart-PrintJob -PrinterName "PrinterName" -ID 1
Example 2: Restart a print job by using printer object and the print job ID
This set of commands retrieves the printer object in to a variable ($printer) using Get-Printer, and then passes the content of the variable to Restart-PrintJob to restart the print job with the ID of 1 on the printer contained in the printer object.
PS C:\> $printer = Get-Printer -PrinterName "PrinterName"
PS C:\> Restart-PrintJob -PrinterObject $printer -ID 1
Example 3: Restart print job using job object
This set of commands retrieves the print job with an ID of 1 in to a variable ($printJob) using Get-PrintJob, and then passes the contents of the variable to Restart-PrintJob to restart the print job on a printer by using a print job object.
PS C:\> $printJob = Get-PrintJob -PrinterName "PrinterName:" -ID 1
PS C:\> Restart-PrintJob -InputObject $printJob