-
Notifications
You must be signed in to change notification settings - Fork 30
Move WinSCPItem
Moves an item from one location to another from an active WinSCP Session.
Move-WinSCPItem [-WinSCPSession] <Session> [-Path] <String[]> [[-Destination] <String>] [-Force] [-PassThru] [<CommonParameters>]
Once connected to an active WinSCP Session, one or many files can be moved to another location within the same WinSCP Session.
A valid open WinSCP.Session, returned from New-WinSCPSession.
| Required? | true |
| Position? | 0 |
| Default value | |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | false |
Full path to remote item to be moved.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Full path to new location to move the item to.
| Required? | false |
| Position? | 2 |
| Default value | / |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Creates the destination directory if it does not exist.
| Required? | false |
| Position? | named |
| Default value | false |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Returns a WinSCP.RemoteFileInfo of the moved object.
| Required? | false |
| Position? | named |
| Default value | false |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
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).
It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.
Represents text as a series of Unicode characters.
Specifies a return value type for a method that does not return a value.
If the WinSCPSession is piped into this command, the connection will be closed and the object will be disposed upon completion of the command.
PS C:\> New-WinSCPSession -Credential (New-Object -TypeName System.Managemnet.Automation.PSCredential -ArgumentList $env:USERNAME, (New-Object -TypeName System.Security.SecureString)) -HostName $env:COMPUTERNAME -Protocol Ftp | Move-WinSCPItem -Path '/rDir/rFile.txt' -Destination '/rDir/rSubDir/'
PS C:\> $credential = Get-Credential PS C:\> $session = New-WinSCPSession -Credential $credential -Hostname 'myftphost.org' -SshHostKeyFingerprint 'ssh-rsa 1024 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx' PS C:\> Move-WinSCPItem -WinSCPSession $session -Path '/rDir/rFile.txt' -Destination '/rDir/rSubDir/' -PassThruDirectory: /rdir/rSubdir
FileType LastWriteTime Length Name
D 1/1/2015 12:00:00 AM 0 rFile.txt