powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Rename-ItemProperty



NAME
Rename-ItemProperty

SYNOPSIS
Renames a property of an item.

SYNTAX
Rename-ItemProperty [-LiteralPath] [-Name] [-NewName] [-Credential ] [-Exc
lude ] [-Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransactio
n] []

Rename-ItemProperty [-Path] [-Name] [-NewName] [-Credential ] [-Exclude tring[]>] [-Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [ mmonParameters>]


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


PARAMETERS
-Credential
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, you will be prompted for a password.

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

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Exclude
Omits the specified items. Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Filter
Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path paramet
er. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficie
nt than other parameters, because the provider applies them when retrieving the objects rather than having Wind
ows PowerShell filter the objects after they are retrieved.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force []
Allows the cmdlet to rename a property of an object that cannot otherwise be accessed by the user. Implementati
on varies from provider to provider. For more information, see about_Providers.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Include
Specifies only those items upon which the cmdlet will act, excluding all others.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-LiteralPath
Specifies a path to the item property. The value of LiteralPath is used exactly as it is typed. No characters a
re interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Sing
le quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Name
Specifies the current name of the property to be renamed.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-NewName
Specifies the new name for the property.

Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-PassThru []
Returns an object representing the item property. By default, this cmdlet does not generate any output.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Path
Specifies the path to the item to be renamed.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-UseTransaction []
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.
For more information, see about_Transactions.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.String
You can pipe a string that contains a path (but not a literal path) to Rename-ItemProperty.


OUTPUTS
None or System.Management.Automation.PSCustomObject
When you use the PassThru parameter, Rename-ItemProperty generates a PSCustomObject representing the renamed it
em property. Otherwise, this cmdlet does not generate any output.


NOTES


The Remove-ItemProperty cmdlet 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 --------------------------

C:\PS>rename-itemproperty -path HKLM:\Software\SmpApplication -name config -newname oldconfig


Description
-----------
This command renames the config registry entry contained in the HKEY_LOCAL_MACHINE\Software\SmpApplication key to o
ldconfig.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113383
about_Providers
Rename-Item
Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Set-ItemProperty