Skip to main content
Skip table of contents

FTP/SFTP/SCP Connector

Those connectors, known by the type names FTP, SFTP, and SCP, expose stored procedures to leverage file resources stored servers that are accessible using these protocols.

Connector-specific Connection Properties Shared by FTP, SFTP, SCP

Property name
DescriptionDefault value
host
Hostlocalhost
portPort

ftp, ftpes: 21
ftps: 990
sftp, scp: 22

userUser-
passwordPassword-
remoteDirectoryDefault remote directory-

Connector-specific Connection Properties - FTP Only

Property name
DescriptionDefault value
secure

Specifies if the remote server shall be accessed using TLS:

  • FTPES (explicit TLS) if secure and explicit property are set to TRUE.
  • FTPS (implicit TLS) if the secure property is set to true and explicit is set to FALSE.
FALSE
explicit

Enables FTPES (explicit TLS). This parameter works only with secure set to TRUE

FALSE
passiveSpecifies if the remote server shall be accessed using passive modeFALSE
proxy

Possible values: NONE, HTTP, SOCKS4, SOCKS5, FTP.

Value FTP is only valid for FTP connector and thus should be set only as connection property, not a system property

-
proxyHostHost address of the proxy server-
proxyPortPort used by the proxy server-
proxyUserUser at proxy server server-
proxyPasswordPassword for the proxy server-
serverTimeoutServer read timeout60

Connector-Specific Connection Properties - SFTP Only 

Property name
DescriptionDefault value

privatekey

Specifies the s path to a keyfile. This parameter may be set instead of the password parameter-
proxyPossible values: NONE, HTTP, SOCKS4, SOCKS5-

proxyHost

Host adress of the proxy server-

proxyPort

Port used by the proxy server-

proxyUser

User at the proxy server-

proxyPassword

Password for the proxy server-
configUsed for SSH configurationStrictHostKeyChecking=no

config connection property available since v4.0.8

Usage and Examples

FTP

Usage

SQL
CALL SYSADMIN.createConnection(name => <ftp_alias>, jbossCLITemplateName => 'ftp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>,secure=<true/false>,passive=<true/false>') ;;
CALL SYSADMIN.createDataSource(name => <sftp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

Example

SQL
CALL SYSADMIN.createConnection(name => 'ftp', jbossCLITemplateName => 'ftp', connectionOrResourceAdapterProperties => 'host=myserver,poer=21,user=JohnDoe,password=mySecretPassword,secure=false,passive=true') ;;
CALL SYSADMIN.createDataSource(name => 'ftp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

SFTP

Usage

SQL
CALL SYSADMIN.createConnection(name => <sftp_alias>, jbossCLITemplateName => 'sftp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>') ;;
CALL SYSADMIN.createDataSource(name => <sftp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

Example

SQL
CALL SYSADMIN.createConnection(name => 'sftp', jbossCLITemplateName => 'sftp', connectionOrResourceAdapterProperties => 'host=myserver,port=22, user=JohnDoe,password=JohnsSecretPassword') ;;
CALL SYSADMIN.createDataSource(name => 'sftp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

SCP

Usage

SQL
CALL SYSADMIN.createConnection(name => <scp_alias>, jbossCLITemplateName => 'scp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>') ;;
CALL SYSADMIN.createDataSource(name => <scp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

Example

SQL
CALL SYSADMIN.createConnection(name => 'scp', jbossCLITemplateName => 'scp', cconnectionOrResourceAdapterProperties => 'host=myserver,port=22, user=JohnDoe,password=JohnsSecretPassword') ;;
CALL SYSADMIN.createDataSource(name => 'scp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.