< Back

Set-PrinterProperty

Wed Jan 30, 2019 5:58 pm

NAME Set-PrinterProperty



SYNOPSIS

Modifies the printer properties for the specified printer.





SYNTAX

Set-PrinterProperty [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-PrinterProperty [-PrinterName] <String> [-PropertyName] <String> [-Value] <String> [-CimSession <CimSession[]>] [-ComputerName <String>]

[-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-PrinterProperty [-PrinterObject] <CimInstance> [-PropertyName] <String> [-Value] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]

[-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-PrinterProperty cmdlet modifies the printer properties for the specified printer.



You cannot use wildcard characters with Set-PrinterProperty. You can use Set-PrinterProperty in a Windows PowerShell remoting session.



You need administrator credentials to run Set-PrinterProperty.





PARAMETERS

-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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ComputerName [<String>]

Specifies the computer name for which to modify the printer properties.



Required? false

Position? named

Default value none

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-PrinterName <String>

Specifies the name of the printer for which to modify the properties.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PrinterObject <CimInstance>

Specifies the printer object for which to update the printer properties.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-PropertyName <String>

Specifies the property name to update.



Required? true

Position? 2

Default value none

Accept pipeline input? True (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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Value <String>

Specifies the new value of the printer property.



Required? true

Position? 3

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

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



This cmdlet accepts one printer object.





OUTPUTS





This cmdlet produces no output.





Example 1: Set a printer property



PS C:\\>Set-PrinterProperty -PrinterName "Printer02" -PropertyName "Config:PropertyName" -Value True



This command sets the Config:PropertyName property of the printer named Printer02 to True.







RELATED LINKS

Get-PrinterProperty