Rename-Printer
Rename-Printer
Renames the specified printer.
Syntax
Parameter Set: name
Rename-Printer [-Name] <String> [-NewName] <String> [-AsJob] [-CimSession <CimSession> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: object
Rename-Printer [-InputObject] <CimInstance> [-NewName] <String> [-AsJob] [-CimSession <CimSession> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
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 |
-InputObject<CimInstance>
Specifies the object which contains the printer to rename.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the printer to rename.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies the new name of the printer.
Aliases |
none |
Required? |
true |
Position? |
2 |
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_Printer
This cmdlet accepts one printer object.
Outputs
The output type is the type of the objects that the cmdlet emits.
- This cmdlet produces no output.
Examples
-------------------------- ExampleXAMPLE 1: Rename a printer -------------------------- xample: Rename a printer
This command renames the "Microsoft XPS Document Writer" printer name as "MXDW".
PS C:\> Rename-Printer –Name "Microsoft XPS Document Writer" –NewName "MXDW"
Example 2: Rename a printer by using a printer object
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.
PS C:\> $Printer = Get-Printer –Name “Microsoft XPS Document Writer"
PS C:\> Rename-Printer -InputObject $Printer –NewName "MXDW"