Move
type: "io.kestra.plugin.fs.sftp.Move"
Move a file to a SFTP server.
If the destination directory doesn't exist, it will be created
Examples
id: fs_sftp_move
namespace: company.team
tasks:
- id: move
type: io.kestra.plugin.fs.sftp.Move
host: localhost
port: "22"
username: foo
password: pass
from: "/upload/dir1/file.txt"
to: "/upload/dir2/file.txt"
Properties
from
- Type: string
- Dynamic: ✔️
- Required: ✔️
The file or directory to move from remote server.
host
- Type: string
- Dynamic: ✔️
- Required: ✔️
Hostname of the remote server
to
- Type: string
- Dynamic: ✔️
- Required: ✔️
The path to move the file or directory to on the remote server.
The full destination path (with filename optionally) If end with a
/
, the destination is considered as a directory and filename will be happen If the destFile exists, it is deleted first.
keyExchangeAlgorithm
- Type: string
- Dynamic: ❌
- Required: ❌
Configures Key exchange algorithm explicitly e. g diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1.
keyfile
- Type: string
- Dynamic: ✔️
- Required: ❌
Private keyfile in the PEM file format to connect to a remote server using SSH
To generate a PEM format key from OpenSSH, use the following command:
ssh-keygen -m PEM
passphrase
- Type: string
- Dynamic: ✔️
- Required: ❌
Passphrase of the ssh key
password
- Type: string
- Dynamic: ✔️
- Required: ❌
Password on the remote server
port
- Type: string
- Dynamic: ✔️
- Required: ❌
- Default:
22
Port of the remote server
proxyHost
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy host
proxyPassword
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy password
proxyPort
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy port
proxyType
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy type
proxyUser
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy user
rootDir
- Type: boolean
- Dynamic: ✔️
- Required: ❌
- Default:
true
Is the path relative to the users home directory
username
- Type: string
- Dynamic: ✔️
- Required: ❌
Username on the remote server
Outputs
from
- Type: string
- Required: ❌
- Format:
uri
The from uri
to
- Type: string
- Required: ❌
- Format:
uri
The destination uri
Definitions
Was this page helpful?