< Back
Rename-ItemProperty
Post
NAME Rename-ItemProperty
SYNOPSIS
Renames a property of an item.
SYNTAX
Rename-ItemProperty [-Name] <String> [-NewName] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force]
[-Include <String[]>] -LiteralPath <String> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Rename-ItemProperty [-Path] <String> [-Name] <String> [-NewName] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter
<String>] [-Force] [-Include <String[]>] [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
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
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-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 Domain01\\User01, 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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies items that this cmdlet omits. Wildcard characters are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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. For more information, see about_Providers.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies only those items upon which the cmdlet acts, excluding all others.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the current name of the property to rename.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NewName <String>
Specifies the new name for the property.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object that represents the item property. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies the path of the item to rename.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
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.
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
*
Example 1: Rename a registry entry
PS C:\\>Rename-ItemProperty -Path HKLM:\\Software\\SmpApplication -Name config -NewName oldconfig
This command renames the config registry entry that is contained in the HKEY_LOCAL_MACHINE\\Software\\SmpApplication key to oldconfig.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821622
Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-Item
Set-ItemProperty
SYNOPSIS
Renames a property of an item.
SYNTAX
Rename-ItemProperty [-Name] <String> [-NewName] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force]
[-Include <String[]>] -LiteralPath <String> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Rename-ItemProperty [-Path] <String> [-Name] <String> [-NewName] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter
<String>] [-Force] [-Include <String[]>] [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
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
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-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 Domain01\\User01, 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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies items that this cmdlet omits. Wildcard characters are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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. For more information, see about_Providers.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies only those items upon which the cmdlet acts, excluding all others.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the current name of the property to rename.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NewName <String>
Specifies the new name for the property.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object that represents the item property. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies the path of the item to rename.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
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.
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
*
Example 1: Rename a registry entry
PS C:\\>Rename-ItemProperty -Path HKLM:\\Software\\SmpApplication -Name config -NewName oldconfig
This command renames the config registry entry that is contained in the HKEY_LOCAL_MACHINE\\Software\\SmpApplication key to oldconfig.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821622
Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-Item
Set-ItemProperty