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 | Description | Default value |
---|---|---|
host | Host |
|
| Port | ftp, ftpes: |
| User | - |
| Password | - |
| Default remote directory | - |
Connector-specific Connection Properties - FTP Only
Property name | Description | Default value |
---|---|---|
| Specifies if the remote server shall be accessed using TLS:
| FALSE |
| Enables FTPES (explicit TLS). This parameter works only with | FALSE |
| Specifies if the remote server shall be accessed using passive mode | FALSE |
| Possible values: Value | - |
| Host address of the proxy server | - |
| Port used by the proxy server | - |
| User at proxy server server | - |
| Password for the proxy server | - |
| Server read timeout |
|
Connector-Specific Connection Properties - SFTP Only
Property name | Description | Default value |
---|---|---|
privatekey | Specifies the s path to a keyfile. This parameter may be set instead of the password parameter | - |
| Possible values: | - |
| Host adress of the proxy server | - |
| Port used by the proxy server | - |
| User at the proxy server | - |
| Password for the proxy server | - |
| Used for SSH configuration |
|
config
connection property available since v4.0.8
Usage and Examples
FTP
Usage
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
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
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
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
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
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 =>
''
) ;;