Edit

Rename-Printer

  • Reference
Module:
PrintManagement

Renames the specified printer.

Syntax

Rename-Printer
      [-Name] <String>
      [-NewName] <String>
      [-AsJob]
      [-CimSession <CimSession>]
      [-ThrottleLimit <Int32>]
      [-Confirm]
      [-WhatIf]
Rename-Printer
      [-InputObject] <CimInstance>
      [-NewName] <String>
      [-AsJob]
      [-CimSession <CimSession>]
      [-ThrottleLimit <Int32>]
      [-Confirm]
      [-WhatIf]

Description

The Rename-Printer cmdlet renames the specified printer on a computer. You can specify the printer to rename by using either a printer object retrieved by Get-Printer, or by specifying a printer name.

You cannot use wildcard characters with Rename-Printer. You can use Rename-Printer in a Windows PowerShell remoting session.

You need administrator privileges to use Rename-Printer.

Examples

-------------------------- Example 1: Rename a printer --------------------------

xample: Rename a printer

PS C:\> Rename-Printer -Name "Microsoft XPS Document Writer" -NewName "MXDW"

This command renames the "Microsoft XPS Document Writer" printer name as "MXDW".

Example 2: Rename a printer by using a printer object

PS C:\>$Printer = Get-Printer -Name "Microsoft XPS Document Writer"



PS C:\>Rename-Printer -InputObject $Printer -NewName "MXDW"

This set of commands retrieves a printer object into a variable ($Printer) using Get-Printer, and then passes the contents of the variable to Rename-Printer.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
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
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
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the object which contains the printer to rename.

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

-Name

Specifies the name of the printer to rename.

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

-NewName

Specifies the new name of the printer.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
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

-WhatIf

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

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

Inputs

CimInstance

This cmdlet accepts one printer object.

Outputs

This cmdlet produces no output.