Rename-ItemProperty

 

SYNOPSIS

Renames a property of an item.

 

SYNTAX

Rename-ItemProperty [-path] <string> [-name] <string> [-newName] <string> [-passThru] [-force] [-credential <PSCredential>] [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-whatIf] [-confirm] [<CommonParameters>]

 

Rename-ItemProperty [-literalPath] <string> [-name] <string> [-newName] <string> [-passThru] [-force] [-credential <PSCredential>] [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-whatIf] [-confirm] [<CommonParameters>]

 

DETAILED DESCRIPTION

Renames a property of an item. The value of the property is not changed.

 

PARAMETERS

 

-path <string>

Specifies the path to the item to be renamed.

 

Required?

true

Position?

1

Default value

N/A - The path must be specified

Accept pipeline input?  

true (ByValue, ByPropertyName)

Accept wildcard characters? 

true

 

-name <string>

Specifies the current name of the property to be renamed.

 

Required?

true

Position?

2

Default value

String.empty

Accept pipeline input?  

true (ByPropertyName)

Accept wildcard characters? 

false

 

-newName <string>

Specifies the new name for the property.

 

Required?

true

Position?

3

Default value

 

Accept pipeline input?  

true (ByPropertyName)

Accept wildcard characters? 

false

 

-passThru <SwitchParameter>

Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.

 

Required?

false

Position?

named

Default value

False

Accept pipeline input?  

false

Accept wildcard characters? 

false

 

-force <SwitchParameter>

Allows cmdlet to override restrictions such as renaming existing files as long as security is not compromised.

 

Required?

false

Position?

named

Default value

False

Accept pipeline input?  

false

Accept wildcard characters? 

false

 

-credential <PSCredential>

The credential is used to validate access. If a PSCredential object, obtained earlier using get-credential is supplied, it will be used as is. If a user name is supplied, there will be a prompt for a password.

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

true (ByPropertyName)

Accept wildcard characters? 

false

 

-include <string[]>

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? 

true

 

-exclude <string[]>

Omits the specified items. Wildcards are permitted.

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

false

Accept wildcard characters? 

true

 

-filter <string>

Specifies filter elements as required and supported by providers.

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

false

Accept wildcard characters? 

false

 

-literalPath <string>

Specifies a path to the item property. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. 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?

1

Default value

 

Accept pipeline input?  

true (ByPropertyName)

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

 

-confirm

Prompts you for confirmation before executing the command.

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

false

Accept wildcard characters? 

false

 

<CommonParameters>

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

 

RETURN TYPE

None

 

NOTES

 

For more information, type "Get-Help Rename-ItemProperty  -detailed". For technical information, type "Get-Help Rename-ItemProperty -full".

 

When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".

 

EXAMPLE 1

 

rename-itemproperty -path HKLM:\Software\SmpApplication `

-name config -newname oldconfig

 

This command renames the config registry entry contained in the HKEY_LOCAL_MACHINE\Software\SmpApplication key to oldconfig.

 

RELATED LINKS

Set-ItemProperty

Clear-ItemProperty

Copy-ItemProperty

Move-ItemProperty

New-ItemProperty

Get-ItemProperty

Remove-ItemProperty

about_namespace