File system Move

File system Move

Certified

Move or rename an FTP file

Moves/renames a remote file; destination directories are created when missing. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home.

yaml
type: io.kestra.plugin.fs.ftp.Move
yaml
id: fs_ftp_move
namespace: company.team

tasks:
  - id: move
    type: io.kestra.plugin.fs.ftp.Move
    host: localhost
    port: 21
    username: foo
    password: "{{ secret('FTP_PASSWORD') }}"
    from: "/upload/dir1/file.txt"
    to: "/upload/dir2/file.txt"
Properties

Source file or directory URI

Remote host

Destination URI

Full target path. If it ends with /, the source name is kept. Existing targets are replaced when overwrite is true.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaultfalse

Enable the RSA/SHA1 algorithm (disabled by default)

Default{ "connectionTimeout": "PT30S", "dataTimeout": "PT30S", "socketTimeout": "PT30S", "controlKeepAliveTimeout": "PT30S", "controlKeepAliveReplyTimeout": "PT30S" }

FTP client options

Definitions
connectionTimeoutstring
DefaultPT30S

Control connection timeout

Maximum time to open the control channel. Default 30s.

controlKeepAliveReplyTimeoutstring
DefaultPT30S

Keep-alive reply timeout

How long to wait for keep-alive responses before failing. Default 30s.

controlKeepAliveTimeoutstring
DefaultPT30S

Control keep-alive interval

Sends keep-alive commands during long transfers. Default 30s.

dataTimeoutstring
DefaultPT30S

Data channel timeout

Maximum time to open the data socket. Default 30s.

socketTimeoutstring
DefaultPT30S

Socket read timeout

Timeout for socket reads and writes once connected. Default 30s.

Defaultfalse

Overwrite existing files

If false (default), fails when the destination already exists.

Defaulttrue

Use passive data connections

Passive mode avoids most firewall and NAT issues and is enabled by default (true). Set to false to force active mode.

Password

Default21

Remote port

FTP proxy hostname

FTP proxy port

Possible Values
DIRECTHTTPSOCKS

FTP proxy type

Defaulttrue

Verify data channel IP

Ensures the responding server IP matches the control connection to prevent spoofed data channels.

Defaulttrue

Treat path as user home root

If true (default), remote paths are resolved relative to the authenticated user's home directory.

Username

Formaturi

The from uri

Formaturi

The destination uri