Set-Printer
Updates the configuration of an existing printer.
Syntax
Set-Printer
[-Name] <String[]>
[-ComputerName <String>]
[-Comment <String>]
[-Datatype <String>]
[-DriverName <String>]
[-UntilTime <UInt32>]
[-KeepPrintedJobs <Boolean>]
[-Location <String>]
[-PermissionSDDL <String>]
[-PortName <String>]
[-PrintProcessor <String>]
[-Priority <UInt32>]
[-Published <Boolean>]
[-RenderingMode <RenderingModeEnum>]
[-SeparatorPageFile <String>]
[-Shared <Boolean>]
[-ShareName <String>]
[-StartTime <UInt32>]
[-DisableBranchOfficeLogging <Boolean>]
[-BranchOfficeOfflineLogSizeMB <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Set-Printer
-InputObject <CimInstance[]>
[-Comment <String>]
[-Datatype <String>]
[-DriverName <String>]
[-UntilTime <UInt32>]
[-KeepPrintedJobs <Boolean>]
[-Location <String>]
[-PermissionSDDL <String>]
[-PortName <String>]
[-PrintProcessor <String>]
[-Priority <UInt32>]
[-Published <Boolean>]
[-RenderingMode <RenderingModeEnum>]
[-SeparatorPageFile <String>]
[-Shared <Boolean>]
[-ShareName <String>]
[-StartTime <UInt32>]
[-DisableBranchOfficeLogging <Boolean>]
[-BranchOfficeOfflineLogSizeMB <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
The Set-Printer cmdlet updates the configuration of the specified printer.
Use the KeepPrintedJobs parameter to make a printer keep printed jobs.
You can specify the printer to update by using either a printer object retrieved by Get-Printer, or by specifying a printer name.
You can use wildcard characters with Set-Printer. You can use Set-Printer in a Windows PowerShell remoting session.
You need administrator privileges to use Set-Printer.
Examples
Example 1: Set printer to keep printed jobs
PS C:\> Set-Printer -Name "Microsoft XPS Document Writer" -KeepPrintedJobs $trueThis command configures the "Microsoft XPS Document Writer" printer to keep printed jobs.
Example 2: Set printer to keep printed jobs by using a printer object
PS C:\>$printer = Get-Printer -Name "Microsoft XPS Document Writer"
PS C:\>$printer.KeepPrintedJobs = $true
PS C:\>Set-Printer -InputObject $printerThis set of commands retrieves a printer object in to a variable ($printer) using Get-Printer, and passes the contents of the variable to Set-Printer.
Parameters
-AsJob
ps_cimcommon_asjob
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BranchOfficeOfflineLogSizeMB
Specifies the maximum size, in megabytes, of the branch office remote offline log file for this printer. You cannot specify this parameter for unshared queues or queues that do not have branch office enabled.
| Type: | UInt32 |
| 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 |
-Comment
Specifies the text to add to the Comment field for the specified printer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
Specifies the name of the computer on which the printer is installed.
| Type: | String |
| Aliases: | CN |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Datatype
Specifies the data type the printer uses to record print jobs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableBranchOfficeLogging
Indicates whether branch office remote logging is disabled. You cannot specify this parameter for unshared queues.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DriverName
Specifies the name of the printer driver for the printer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the object which contains the printer information to update.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-KeepPrintedJobs
Specifies whether the printer jobs in the queue are kept.
| Type: | Boolean |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
Specifies the location of the printer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the printer to modify.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PermissionSDDL
Specifies the permissions for the printer as an SDDL string.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PortName
Specifies the name of the port used or created for the printer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrintProcessor
Specifies the name of the print processor used by the printer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Priority
Specifies the relative queue priority.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Published
Specifies whether or not the printer is published in the network directory service.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RenderingMode
Specifies the rendering mode for the printer. You can specify one of the following three rendering modes: SSR, CSR, or BOPD
| Type: | RenderingModeEnum |
| Accepted values: | SSR, CSR, BranchOffice |
| Position: | Named |
| Default value: | CSR |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SeparatorPageFile
Specifies the path to and name of the separator page to be used by the printer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Shared
Changes the share state of the printer.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ShareName
Specifies the name by which to share the printer on the network. To change the share state of a printer, specify the Shared parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartTime
Specifies the starting time of printer availability.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-UntilTime
Specifies the ending time of printer availability.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
This cmdlet accepts one printer object.
Outputs
This cmdlet returns a printer object.
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for