Rename-ItemProperty

Renames a property of an item.
Rename-ItemProperty [-Path*] <String> [-Name*] <String> [-NewName*] <String> [-Credential [<PSCredential>]] [-Exclude[<String[]>]] [-Filter [<String>]] [-Force] [-Include [<String[]>]] [-PassThru] [-Confirm] [-WhatIf][-UseTransaction [<SwitchParameter>]] [<CommonParameters>]
Rename-ItemProperty [-Name*] <String> [-NewName*] <String> [-Credential [<PSCredential>]] [-Exclude [<String[]>]][-Filter [<String>]] [-Force] [-Include [<String[]>]] [-PassThru] -LiteralPath* <String> [-Confirm] [-WhatIf][-UseTransaction [<SwitchParameter>]] [<CommonParameters>]

The Rename-ItemProperty cmdlet changes the name of a specified item property. The value of the property is not changed. For example, you can use Rename-ItemProperty to change the name of a registry entry.

Parameters
-Credential [<PSCredential>]

Specifies a user account that has permission to perform this action. The default is the current user.

Type a user name, such as User01 or Domain01User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, this cmdlet prompts you for a password.

This parameter is not supported by any providers installed with Windows PowerShell.

-Exclude [<String[]>]

Specifies items that this cmdlet omits. Wildcard characters are permitted.

-Filter [<String>]

Specifies a filter in the format or language of the provider. The value of this parameter qualifies the Path parameter. The syntax of the filter, including the use of wildcard characters, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when it retrieves the objects instead of having Windows PowerShell filter the objects after they are retrieved.

-Force [<SwitchParameter>]

Forces the cmdlet to rename a property of an object that cannot otherwise be accessed by the user. Implementation varies from provider to provider.

-Include [<String[]>]

Specifies only those items upon which the cmdlet acts, excluding all others.

-LiteralPath <String>

Specifies a path of the item property. This cmdlet uses the value of the LiteralPath cmdlet exactly as it is typed. No characters are interpreted as wildcard characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.

-Name <String>

Specifies the current name of the property to rename.

-NewName <String>

Specifies the new name for the property.

-PassThru [<SwitchParameter>]

Returns an object that represents the item property. By default, this cmdlet does not generate any output.

-Path <String>

  • This value is required
  • Accepts pipeline input ByValue

Specifies the path of the item to rename.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

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.

-UseTransaction [<SwitchParameter>]

  • Default value is false

Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

System.String

You can pipe a string that contains a path, but not a literal path, to this cmdlet.

Outputs

None, System.Management.Automation.PSCustomObject

This cmdlet generates a PSCustomObject that represents the renamed item property, if you specify the PassThru parameter. Otherwise, this cmdlet does not generate any output.

Examples
  1. Rename a registry entry:
    PS C:> Rename-ItemProperty -Path HKLM:SoftwareSmpApplication -Name config -NewName oldconfig
    

    This command renames the config registry entry that is contained in the HKEY_LOCAL_MACHINESoftwareSmpApplication key to oldconfig.

Additional Notes
 Remove-ItemProperty is designed to work with the data exposed by any provider. To list the providers available 
 in your session, type Get-PSProvider. For more information, see about_Providers.
Related Links

Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-Item
Set-ItemProperty