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

Restart-PrintJob

Last Updated: 2/14/2017

SYNOPSIS

Restarts a print job on the specified printer.

SYNTAX

jobObject

Restart-PrintJob [-InputObject] <CimInstance> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
 [-WhatIf] [-Confirm] [<CommonParameters>]

printerName

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

printObject

Restart-PrintJob [-ID] <UInt32> [-PrinterObject] <CimInstance> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

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 credentials to use Restart-PrintJob.

EXAMPLES

Example 1: Restart a selected print job

PS C:\> Restart-PrintJob -PrinterName "PrinterName" -ID 1

This command restarts the print job that has an ID of 1 on the printer named PrinterName.

Example 2: Restart a print job by using printer object and the print job ID

PS C:\>$Printer = Get-Printer -PrinterName "PrinterName"
PS C:\> Restart-PrintJob -PrinterObject $Printer -ID 1

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 restarts the print job that has the ID 1 on the printer in $Printer.

Example 3: Restart print job using job object

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

The first command gets a printer job that has the ID on a printer named PrinterName by using the Get-PrintJob cmdlet. The command stores the result in the $PrintJob variable.

The second command restarts the print job in $PrintJob.

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 on which to restart the print job.

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

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-ID

Specifies the ID of the print job to restart on the specified printer. You can use wildcard characters.

Type: UInt32
Parameter Sets: printerName, printObject
Aliases: 

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

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance
Parameter Sets: jobObject
Aliases: 

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

-PrinterName

Specifies the printer name on which to restart the print job.

Type: String
Parameter Sets: printerName
Aliases: PN

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

-PrinterObject

Specifies the printer object which contains the printer on which to restart the print job.

Type: CimInstance
Parameter Sets: printObject
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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.

INPUTS

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

This cmdlet accepts one print job object.

OUTPUTS

This cmdlet produces no output.

NOTES

Get-PrintJob

Remove-PrintJob

Suspend-PrintJob

Resume-PrintJob

© 2017 Microsoft