Move-ItemProperty

 

SYNOPSIS

Moves a property from one location to another.

 

SYNTAX

Move-ItemProperty [-path] <string[]> [-destination] <string> [-name] <string[]> [-include <string[]>] [-force] [-passThru] [-exclude <string[]>] [-credential <PSCredential>] [-filter <string>] [-whatIf] [-confirm] [<CommonParamete

rs>]

 

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

 

DETAILED DESCRIPTION

The Move-ItemProperty cmdlet moves a property of an item from one item to another item. For example, it can move a registry entry from one registry key to another.  When you move an item property, it is added to the new location and deleted from its original location.

 

PARAMETERS

 

-path <string[]>

Specifies the path to the current location of the property. Wildcards are permitted.

 

Required?

true

Position?

1

Default value

N/A - The path must be specified

Accept pipeline input?  

true (ByValue, ByPropertyName)

Accept wildcard characters? 

true

 

-destination <string>

Specifies the path to the destination location.

 

Required?                                           

true

Position?

2

Default value

 

Accept pipeline input?  

true (ByPropertyName)

Accept wildcard characters? 

true

 

-name <string[]>

Specifies the name of the property to be moved.

 

Required?

true

Position?

3

Default value

 

Accept pipeline input?  

true (ByPropertyName)

Accept wildcard characters? 

false

 

-include <string[]>

Moves only the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as "*.txt". Wildcards are permitted.

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

false

Accept wildcard characters? 

true

 

-force <SwitchParameter>

Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. For example, Force will override the read-only attribute or create directories to complete a file path, but it will not attempt to change file permissions.

 

Required?

false

Position?

named

Default value

False

Accept pipeline input?  

false

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

 

Accept pipeline input?  

false

Accept wildcard characters? 

false

 

-exclude <string[]>

Omits the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as "*.txt". Wildcards are permitted.

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

false

Accept wildcard characters? 

true

 

-credential <PSCredential>

Uses a credential to validate access to the file. <Credential> represents a user-name, such as "User01" or "Domain01\User01", 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. This parameter appears, but it is not supported in any Windows PowerShell core cmdlets or providers.

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

true (ByPropertyName)

Accept wildcard characters? 

false

 

-filter <string>

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

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

false

Accept wildcard characters? 

true

 

-literalPath <string[]>

Specifies the path to the current location of the property. Unlike Path, 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".

 

NOTES

 

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

 

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

 

The names of the Path, Destination, and Name parameters are optional. If you omit the parameter names, the unnamed parameter values must appear in this order: Path, Destination, Name. If you include the parameter names, the parameters can appear in any order.

 

You can also refer to Move-ItemProperty by its built-in alias, "mp". For more information, see About_Alias.

 

EXAMPLE 1

 

move-itemproperty HKLM:\Software\MyCompany\MyApp -Name `

Version -Destination HKLM:\Software\MyCompany\NewApp

 

This command moves the "Version" registry value, and its data, from the MyApp subkey to the NewApp subkey of the HKLM\Software\MyCompany registry key.

 

 

RELATED LINKS

Clear-ItemProperty

New-ItemProperty

Copy-ItemProperty

Rename-ItemProperty

Get-ItemProperty

Set-ItemProperty

Remove-ItemProperty

about_namespace