powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Move-Item



NAME
Move-Item

SYNOPSIS
Moves an item from one location to another.

SYNTAX
Move-Item [-LiteralPath] [[-Destination] ] [-Credential ] [-Exclude ] [-
Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [ rs>]

Move-Item [-Path] [[-Destination] ] [-Credential ] [-Exclude ] [-Filter
] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] []


DESCRIPTION
The Move-Item cmdlet moves an item, including its properties, contents, and child items, from one location to anoth
er location. The locations must be supported by the same provider. For example, it can move a file or subdirectory
from one directory to another or move a registry subkey from one key to another. When you move an item, it is added
to the new location and deleted from its original location.


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

-Destination
Specifies the path to the location where the items are being moved. The default is the current directory. Wildc
ards are permitted, but the result must specify a single location.

To rename the item being moved, specify a new name in the value of the Destination parameter.

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

-Exclude
Omits the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pa
ttern, such as "*.txt". 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 Win
dows 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 move an item that writes over an existing read-only item. Implementation varies from provi
der to provider. For more information, see about_Providers. Even using the Force parameter, the cmdlet cannot o
verride security restrictions.

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

-Include
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? false

-LiteralPath
Specifies the path to the current location of the items. 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 es
cape sequences.

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

-PassThru []
Passes an object representing the item to the pipeline. 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 current location of the items. The default is the current directory. Wildcards are pe
rmitted.

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 to Move-Item.


OUTPUTS
None or an object representing the moved item.
When you use the Passthru parameter, Move-Item generates an object representing the moved item. Otherwise, this
cmdlet does not generate any output.


NOTES


Move-Item will move files between drives that are supported by the same provider, but it will move directories
only within the same drive.

Because a Move-Item command moves the properties, contents, and child items of an item, all moves are recursive
by default.

You can also refer to Move-Item by its built-in aliases, "move", "mv", and "mi". For more information, see abou
t_Aliases.

The Move-Item 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>move-item -path C:\test.txt -destination E:\Temp\tst.txt


Description
-----------
This command moves the Test.txt file from the C: drive to the E:\Temp directory and renames it from "test.txt" to "
tst.txt".





-------------------------- EXAMPLE 2 --------------------------

C:\PS>move-item -path C:\Temp -destination C:\Logs


Description
-----------
This command moves the C:\Temp directory and its contents to the C:\Logs directory. The Temp directory, and all of
its subdirectories and files, then appear in the Logs directory.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>move-item -path .\*.txt -destination C:\Logs


Description
-----------
This command moves all of the text files (*.txt) in the current directory (represented by a dot (.)) to the C:\Logs
directory.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>get-childitem -path . -recurse -include *.txt | move-item -destination C:\TextFiles


Description
-----------
This command moves all of the text files from the current directory and all subdirectories, recursively, to the C:\
TextFiles directory.

The command uses the Get-ChildItem cmdlet to get all of the child items in the current directory (represented by th
e dot [.]) and its subdirectories that have a *.txt file name extension. It uses the Recurse parameter to make the
retrieval recursive and the Include parameter to limit the retrieval to *.txt files.

The pipeline operator (|) sends the results of this command to Move-Item, which moves the text files to the TextFil
es directory.

If files being moved to C:\Textfiles have the same name, Move-Item displays an error and continues, but it moves on
ly one file with each name to C:\Textfiles. The other files remain in their original directories.

If the Textfiles directory (or any other element of the destination path) does not exist, the command fails. The mi
ssing directory is not created for you, even if you use the Force parameter. Move-Item moves the first item to a fi
le called "Textfiles" and then displays an error explaining that the file already exists.

Also, by default, Get-ChildItem does not move hidden files. To move hidden files, use the Force parameter with Get-
ChildItem.





-------------------------- EXAMPLE 5 --------------------------

C:\PS>move-item hklm:\software\mycompany\* hklm:\software\mynewcompany


Description
-----------
This command moves the registry keys and values within the MyCompany registry key in HKLM\Software to the MyNewComp
any key. The wildcard character (*) indicates that the contents of the MyCompany key should be moved, not the key i
tself. In this command, the optional Path and Destination parameter names are omitted.





-------------------------- EXAMPLE 6 --------------------------

C:\PS>move-item -literalpath 'Logs[Sept`06]' -destination 'Logs[2006]'


Description
-----------
This command moves the Logs[Sept`06] directory (and its contents) into the Logs[2006] directory.

The LiteralPath parameter is used instead of Path, because the original directory name includes left bracket and ri
ght bracket characters ("[" and "]"). The path is also enclosed in single quotation marks (' '), so that the backti
ck symbol (`) is not misinterpreted.

The Destination parameter does not require a literal path, because the Destination variable also must be enclosed i
n single quotation marks, because it includes brackets that can be misinterpreted.






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