Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Rename-Printer

Last Updated: 3/31/2017

SYNOPSIS

Renames the specified printer.

SYNTAX

name

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

object

Rename-Printer [-NewName] <String> [-InputObject] <CimInstance> [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<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.

EXAMPLES

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.

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance
Parameter Sets: object
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the printer to rename.

Type: String
Parameter Sets: name
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-NewName

Specifies the new name of the printer.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
Parameter Sets: (All)
Aliases: 

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

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

This cmdlet accepts one printer object.

OUTPUTS

This cmdlet produces no output.

NOTES

Add-Printer

Remove-Printer

Get-Printer

Set-Printer

© 2017 Microsoft