Rsync PullInstall

Summary

Pull files or directories from a remote host to a local path using rsync over SSH.

Inputs

• Remote Path (required) — Remote source path on the SSH server to pull files from. Adding a trailing slash copies directory contents.
• Local Path (required) — Local destination path accessible to the n8n container where files will be saved.
• Strict Host Key Checking — SSH StrictHostKeyChecking option to control host key verification (Accept New, Yes, No).
• Additional SSH Options — Extra SSH options specified as -o KEY=VALUE, one per line.
• Archive Mode — Boolean to enable rsync's archive mode (-a), default true.
• Compress — Boolean to enable compression during transfer (-z), default true.
• Delete Extra Files — Boolean to delete files in local destination that do not exist on remote source, default false.
• Dry Run — Boolean to perform a dry run without actual file transfers, default false.
• Exclude Patterns — Optional rsync exclude patterns, one per line, to exclude matching files from being transferred.
• Rsync Binary — Name or absolute path of the rsync binary to use, default "rsync".
• Command Timeout — Maximum time in seconds to allow the rsync command to run, default 3600.
• Additional Arguments — Extra arguments passed verbatim to the rsync command.

Output shape

a list of items with JSON containing detailed rsync pull operation results including command, stderr/stdout logs, and status for each input item

Each output item corresponds to an input item. On failure, errors are reported inside output JSON if Continue On Fail is enabled; otherwise, node execution fails. The result includes fields like operation type, command used, source and destination paths, command output, and error details if any.

Links

• n8n community nodes installation guide