...
| Name | Default | Type/Unit | Comment |
|---|---|---|---|
| sftp.usetmp | "true" | boolean | Force using a temporary name when transmitting a file to the remote SFTP server. Once the transmission has completed successfully, the file is renamed with its final target name. The temporary file name is by default the file name with the ".tmp" suffix concatenated to it, however this behaviour can be customised with the "mksuffix", "prefix" and "suffix" options. |
| sftp.mkdirs | "true" | boolean | Allow creating the directory named by the target pathname, including any necessary but non-existent parent directories. |
| sftp.prefix | - | string | When using the "usetmp" option, this option allow setting the prefix to use for the temporary file name (e.g. "."). |
| sftp.suffix | - | string | When using the "usetmp" option, this option allow setting the suffix to use for the temporary file name (e.g. ".tmp"). |
| sftp.chmod | - | integer | If set, the file mode will be changed according to the value of this option once it has uploaded a file successfully (e.g. "640"). |
| sftp.ignoreCheck | "false" | boolean | If set, the remote size of the file is not checked after an upload has been completed. If not set, the remote size of the uploaded file is checked and compared against the size of the source file. |
| sftp.execCode | "0" | integer | Allow specifying the expected exit code of the command (or list of commands) started with the "execCmd" option. If the exit code is different from the one specified in this parameter then the transmission is tagged as failed. |
| sftp.execCmd | - | string | Allow specifying a command (or list of commands) to execute on the SSH server once a file has been transmitted (multiple commands can be specified using the semi columns separator). The parameter "$filename" can be introduced in the commands and it gives the name of the file transmitted (source or target depending if the transmission was a upload or a download). |
| sftp.kex | - | string | Allow specifying the key exchange algorithms to allow (e.g. "ecdh-sha2-nistp256,ecdh-sha2-nistp384"). The list of valid algorithms can be found at http://www.jcraft.com/jsch/README (multiple algorithms can be specified using the columns separator). By default all supported algorithms are allowed. |
| sftp.serverHostKey | - | string | Allow specifying the host key type to allow (e.g. "ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521"). The list of valid key types can be found at http://www.jcraft.com/jsch/README (multiple algorithms can be specified using the columns separator). By default all supported key types are allowed. |
| sftp.cipher | - | string | Allow specifying the cipher algorithms to allow (e.g. "aes128-cbc,3des-cbc,blowfish-cbc"). The list of valid algorithms can be found at http://www.jcraft.com/jsch/README (multiple algorithms can be specified using the columns separator). By default all supported algorithms are allowed. |
| sftp.mac | - | string | Allow specifying the Message Authentication Code (MAC) algorithms to allow (e.g. "hmac-md5,hmac-md5-96,hmac-sha1,hmac-sha1-96"). The list of valid algorithms can be found at http://www.jcraft.com/jsch/README (multiple algorithms can be specified using the columns separator). By default all supported algorithms are allowed. |
| sftp.compression | - | string | Allow specifying the compression algorithms to allow (e.g. "zlib,none"). The list of valid algorithms can be found at http://www.jcraft.com/jsch/README (multiple algorithms can be specified using the columns separator). By default all supported algorithms are allowed. |
| sftp.fingerPrint | - | string | Allow specifying a key's fingerprint. It is a lower-case hexadecimal representation of the MD5 of a key (e.g. "22:fb:ee:fe:18:cd:aa:9a:9c:78:89:9f:b4:78:75:b4"). If a key's fingerprint is defined then it is compared against the key's fingerprint of the remote SFTP server when connecting. If it does not match then the connection is rejected. |
| sftp.preferredAuthentications | - | string | Allow specifying the list of supported authentication methods (e.g. password,publickey,keyboard-interactive). |
| sftp.passPhrase | - | string | The passphrase necessary to access the private key when the "privateKey" or "privateKeyFile" option is used. This option is only required if the private key is protected. |
| sftp.privateKeyFile | - | string | Adds a private key to be used for public-key authentication. The private key should be in the PEM format in a file accessible from the ECaccess Gateway (the file permissions should be set accordingly). This option contains the name of the file (e.g. "/home/uid/.ssh/mykey.pem"). If both options, "privateKeyFile" and "privateKey" are defined, then the latest will be ignored. |
| sftp.privateKey | - | string | Adds a private key to be used for public-key authentication. The private key should be in the PEM format. e.g. sftp.privateKey=" As shown in the example above, the first line should always be sftp.privateKey=" and the last line should always be " with the content of the private key in between. |
| sftp.listenAddress | - | string | Allow specifying the source address used by the SFTP client when connecting to the remote SFTP server. By default, the system will pick up a valid local address. |
| sftp.sessionTimeOut | "60000" | milliseconds | This value is used as the socket timeout parameter, and also as the default connection timeout. The value must be > 0. A timeout of zero is interpreted as an infinite timeout. |
| sftp.connectTimeOut | - | milliseconds | This value is used as the connection timeout. The value must be > 0. A timeout of zero is interpreted as an infinite timeout. The default value is the same as the "sessionTimeOut" value. |
| sftp.mksuffix | "false" | boolean | If set, the SFTP client will generate a random suffix for the "usetmp" option with 3 characters (e.g. ".3te"). If this option is used then the "prefix" and "suffix" options are ignored. |
| sftp.port | "22" | short | Allow specifying the port number of the remote SFTP server to connect to. |
...
The "reject", "append", "resume" and "overwrite" options are mutually exclusive and determine what to do if there is an existing target file. The "mailto" option specifies an email address to be notified in case of a successful (option "onsuccess") and/or a failed transfer (option "onfailure"). The "check" option prints the status of the specified request on the standard output. The transfer status, which can be checked with the ecaccess-ectrans-list command or the Web interface, can takes values as listed in table 1. Table 1: Transfer status.
| Status | Meaning |
| INIT | Files are being transferred to the spool |
| COPY | Files are being transferred to the remote site |
| WAIT | Files are scheduled and waiting to be started |
| RETR | File transfer will be retried |
| STOP | Files have NOT been successfully transferred (error) |
| DONE | Files have been successfully transferred |
Transfer to a Member State host via gateway
To transfer file "fff" from the current working directory on "ecgate" to the "genericFtp" protocol of the use "myUser" on the ECaccess gateway "ecaccess.meteo.ms":
> ectrans -gateway ecaccess.meteo.ms \ -remote myUser@genericFtp -source fff \ -verbose verbose: gateway=ecaccess.meteo.ms verbose: echost=ecgate.ecmwf.int verbose: ecport=644 verbose: action=spool verbose: ecuser=uid verbose: source=fff verbose: target=fff verbose: keep=false verbose: remove=false verbose: option=reject verbose: lifetime=1w verbose: delay=(none) verbose: at=(now) verbose: format=yyyyMMddHHmmss verbose: retryCnt=144 verbose: retryFrq=10m File to upload (5140480 bytes) 9442903031
...