Rename a property of an item, the value of the property is not changed.
Syntax
Rename-ItemProperty { [-path] string[] | [-literalPath] string[] }
[[-name] string[]] [-newName] string
[-passThru] [-force] [-filter string]
[-include string[]] [-exclude string[]]
[-credential PSCredential] [-whatIf]
[-confirm] [-UseTransaction] [CommonParameters]
Key
-Path string
The path(s) to the item to be renamed. Wildcards are permitted.
-LiteralPath string
Like Path above, only the value is used exactly as typed.
No characters are interpreted as wildcards. If the path includes any
escape characters then enclose the path in single quotation marks.
-Name string
The name(s) of the property to rename.
-NewName string
The new name for the property.
-PassThru
Pass the object created by Rename-ItemProperty along the pipeline.
-Force
Override restrictions that prevent the command from succeeding, apart
from security settings.
-Filter string
A filter in the provider's format or language.
The exact syntax of the filter (wildcard support etc) depends on the provider.
Filters are more efficient than -include/-exclude, because the provider
applies the filter when retrieving the objects, rather than having
PowerShell filter the objects after they are retrieved.
-Exclude string
Omit the specified items from the Path e.g. "*SS64*"
this only works when the path includes a wildcard character.
-include string
Include only the specified items from the Path. e.g. "May*"
this only works when the path includes a wildcard character.
-Credential PSCredential
Use a credential to validate access to the file. Credential represents
a user-name, such as "User64" or "Domain64\User64", or a PSCredential
object, such as the one retrieved by using the Get-Credential cmdlet.
If you type a user name, you will be prompted for a password.
-Confirm
Prompt for confirmation before executing the command.
-WhatIf
Describe what would happen if you executed the command without actually executing it.
-UseTransaction
Include the command in the active transaction.
CommonParameters:
-Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer -OutVariable.
Standard Aliases for Rename-ItemProperty: rnp
Examples
Rename the config registry entry contained in the HKLM\Software\SS64 key to oldconfig:
PS C:\> rename-itemproperty -path HKLM:\Software\SS64 `
-name config -newname oldconfig
"It is the final proof of God's omnipotence that he need not exist in order to save us" ~ Peter De Vries
Related PowerShell Cmdlets:
Clear-ItemProperty - Delete the value of a property.
Copy-ItemProperty - Copy a property along with its value.
Get-ItemProperty - Retrieve the properties of an object.
Move-ItemProperty - Move a property from one location to another.
New-ItemProperty - Set a new property of an item at a location.
Remove-ItemProperty - Delete the property and its value from an item.
Rename-Item - Change the name of an existing item.
Set-ItemProperty - Set the value of a property.