< Back
Rename-Printer
Post
NAME Rename-Printer
SYNOPSIS
Renames the specified printer.
SYNTAX
Rename-Printer [-Name] <String> [-NewName] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-Printer [-NewName] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
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 the Get-Printer cmdlet, 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 credentials to run Rename-Printer.
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
-Name <String>
Specifies the name of the printer to rename.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
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: 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"
The first command gets a printer named Microsoft XPS Document Writer by using Get-Printer. The command stores the result in the $Printer variable.
The second command renames the printer in $Printer as MXDW.
RELATED LINKS
Add-Printer
Remove-Printer
Get-Printer
Set-Printer
SYNOPSIS
Renames the specified printer.
SYNTAX
Rename-Printer [-Name] <String> [-NewName] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
Rename-Printer [-NewName] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]
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 the Get-Printer cmdlet, 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 credentials to run Rename-Printer.
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
-Name <String>
Specifies the name of the printer to rename.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
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: 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"
The first command gets a printer named Microsoft XPS Document Writer by using Get-Printer. The command stores the result in the $Printer variable.
The second command renames the printer in $Printer as MXDW.
RELATED LINKS
Add-Printer
Remove-Printer
Get-Printer
Set-Printer