SetConnect

SFTPdownload

SecureFTP::SFTPdownload
Description

Download one or all files from the specified hostname using SSH. Optionally you can automatically remove the remote-file(s) after it is downloaded. Use regular-expression filters to select which files you wish to download.

The following private key formats are supported:

RSA in OpenSSL PEM and ssh.com format
DSA in OpenSSL PEM and ssh.com format
ECDSA 256/384/521 in OpenSSL PEM format
ED25519 in OpenSSH key format

Private keys can be encrypted using one of the following cipher methods:

DES-EDE3-CBC
DES-EDE3-CFB
DES-CBC
AES-128-CBC
AES-192-CBC
AES-256-CBC

If you get "Invalid private key file" you can try converting the private key file to "ssh.com" format:

  • download and install PuTTY Key Generator from https://www.chiark.greenend.org.uk/~sgtatham/putty/
  • start "PuTTYgen"
  • now "Load" your private key into PuTTYgen
  • click "Conversions\Export ssh.com key" to save to a new private key file
  • use this file in Omniphlex

 

SFTPdownload - FTP Server
Options
Hostname
The hostname or ip-address of the computer to connect to.
Port
The SFTP port (default=22).
Username
FTP username .
Password
FTP password .
SFTPdownload - Source
Options
Root path
Directory on the FTP server.
Include Subdirectories
When checked, files in subdirectories will be included.
Search Pattern
Filenames matching this regular-expression will be downloaded.
Process All Files
When checked, all matching files will be downloaded. When unchecked only the first file found will be downloaded.
SFTPdownload - Destination
Options
Destination Folder
Directory to which the files will be downloaded.
If Local File Exists
How to proceed if the downloaded file already exists.
SFTPdownload - Options

Options
Retries
Number of times the plugin will try to download a file when an error occurs.
Timeout
The timeout in seconds for the session.
Verbose Logging
Show trace logging.
Check Stabletime
If enabled, the file will only be downloaded once it is considered to be "stable": the file hasn't changed for the specified number of seconds.
AutoDelete Files
When checked, the file on the FTP server will be automatically deleted after is has been downloaded.
Remove Empty Directories
When checked, empty directories will be removed.
Keep Directory Structure
When checked, the directory structure on the FTP server will be replicated in the destination folder.
Encoding
The encoding to use for the transfer.
SFTPdownload - Security

Options
Authentication Type
PASSWORD
Use standard password authentication only.
PUBLICKEY
Public/Private key with optional passphrase is used for authentication.
Privatekey File
Full path/name to the private keyfile.
Passphrase
Optional passprase which belongs to the private keyfile..
PASSWORD & PUBLICKEY
Password and Public/Private key with optional passphrase is used for authentication.
Privatekey File
Full path/name to the private keyfile.
Passphrase
Optional passprase which belongs to the private keyfile..

Documentation

Release notes