Skip to main content

Download File

Downloads a file from a remote SSH server to the local system.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Client Id - The unique identifier of the SSH connection, obtained from the Connect node.
  • Remote Path - The file path on the remote server to download.
  • Local Path - The destination file path on the local system.

How It Works​

The Download File node transfers a file from a remote SSH server to the local system:

  1. Validates the provided client ID, remote path, and local path
  2. Retrieves the SSH client associated with the client ID
  3. Initiates a secure file transfer from the remote path to the local path
  4. Completes the transfer and returns success or error

Requirements​

  • A valid client ID from a previously established SSH connection using the Connect node
  • Valid remote file path that exists on the SSH server
  • Valid local file path where the user has write permissions
  • Sufficient disk space on the local system for the file

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid client ID
  • No active connection found for the provided client ID
  • Empty or invalid remote path
  • Empty or invalid local path
  • File not found at the remote path
  • Insufficient permissions to read the remote file
  • Insufficient disk space on the local system
  • Network connectivity issues during transfer

Usage Notes​

  • The remote path must be accessible to the SSH user account
  • The local path directory must exist and be writable
  • Large file transfers may take significant time depending on network conditions
  • The node will overwrite existing files at the local path without warning