...
The various options available for each protocol are described in the following tables (please note the "genericFile" protocol has no option).
WARNING: please note option names are case-sensitive and unknown option names are ignored by ECtrans.
The genericFtp Options
| Name | Default | Type/Unit | Comment |
|---|---|---|---|
| ftp.passive | "false" | boolean | Allow selecting the Passive or Active FTP mode. In Passive mode, the FTP client initiates both connections to the server, solving the problem of firewalls filtering the incoming data port connection to the client from the server. In Active mode, the FTP client connects from a random unprivileged port (N > 1023) to the FTP server's command PORT, usually port 21. Then, the client starts listening to port N+1 and sends the FTP command |
| ftp.extended | "false" | boolean | Its use is required when connecting to a remote IPv6 server (EPSV/EPRT commands are issued instead of PASV/PORT commands when opening data channels). |
| ftp.lowPort | "false" | boolean | Allow forcing the FTP client to bind a privileged port (500 <= N <= 1023) instead of an unprivileged port (N > 1023) when using the Active FTP mode. |
| ftp.commTimeOut | "60000" | milliseconds | Enable/disable a timeout when opening the control channel. The value must be > 0. A timeout of zero is interpreted as an infinite timeout. |
| ftp.dataTimeOut | "60000" | milliseconds | Enable/disable a timeout when reading from the data channel. The value must be > 0. A timeout of zero is interpreted as an infinite timeout. |
| ftp.portTimeOut | "60000" | milliseconds | Enable/disable a timeout when opening the data channel specified by a PORT command. The value must be > 0. A timeout of zero is interpreted as an infinite timeout. |
| ftp.listenAddress | - | string | Allow specifying the listen address used by the FTP client (e.g. when waiting for an incoming data connection). By default, the system will pick up a valid local address. A value of "0.0.0.0" will cause the binding of all the valid network interfaces. |
| ftp.sendBuffSize | "-1" | integer | Allow specifying a buffer size when sending data on the data channel. |
| ftp.receiveBuffSize | "-1" | integer | Allow specifying a buffer size when receiving data from the data channel. |
| ftp.setNoop | "NOOP" | string | Allow specifying the "No-Operation" command. This command does not affect anything at all. It performs no action other than having the server send an OK reply. This command is used to keep connections with the FTP servers "alive" (connected) while nothing is being done. |
| ftp.port | "21" | short | Allow specifying the port number of the remote FTP server to connect to (used to open the control channel). |
| ftp.usecleanpath | "false" | boolean | When using the "mkdir" command this option allow forcing the FTP client to fix directory pathnames (e.g. remove multiple instances of /). |
| ftp.usenlist | "false" | boolean | Force using the NLIST command on the remote FTP server when doing a directory listing instead of the standard LIST. This options is required for some FTP servers which do not allow (or do not implement) the LIST command. |
| ftp.usetmp | "true" | boolean | Force using a temporary name when transmitting a file to the remote FTP server. Once the transmission has completed successfully, the file is renamed with its final target name. |
| ftp.mkdirs | "true" | boolean | Allow creating the directory named by the target pathname, including any necessary but non-existent parent directories. |
| ftp.prefix | - | string | When using the "usetmp" option, this option allow setting the prefix to use for the temporary file name (e.g. "."). |
| ftp.suffix | - | string | When using the "usetmp" option, this option allow setting the suffix to use for the temporary file name (e.g. ".tmp"). |
| ftp.postConnectCmd | - | string | Allow issuing an FTP command on the remote FTP server right after the control connection is established (multiple commands can be specified using the semi columns separator). |
| ftp.preCloseCmd | - | string | Allow issuing an FTP command on the remote FTP server right before closing the control connection (multiple commands can be specified using the semi columns separator). |
| ftp.preGetCmd | - | string | Allow issuing an FTP command on the remote FTP server right before getting a file (multiple commands can be specified using the semi columns separator). |
| ftp.prePutCmd | - | string | Allow issuing an FTP command on the remote FTP server right before putting a file (multiple commands can be specified using the semi columns separator). |
| ftp.postPutCmd | - | string | Allow issuing an FTP command on the remote FTP server right after putting a file (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 which was just transmitted. If the "usetmp" option is used then it will give the temporary name. |
| ftp.mkdirsCmdIndex | "0" | integer | When using the "mkdirs" option, this index allow specifying the level where to start the directory creation. For example, if the directory is "/home/uid/test/data/out/bin", an index of 3 will make sure the FTP client does not try to create the "/home" and "/home/uid" directories. |
| ftp.preMkdirsCmd | - | string | Allow issuing an FTP command on the remote FTP server right before creating a directory (multiple commands can be specified using the semi columns separator). The parameter "$dirname" can be introduced in the commands and it gives the name of the directory to create. |
| ftp.postMkdirsCmd | - | string | Allow issuing an FTP command on the remote FTP server right after creating a directory (multiple commands can be specified using the semi columns separator). The parameter "$dirname" can be introduced in the commands and it gives the name of the directory just created. |
| ftp.keepAlive | "0" | milliseconds | Allow keeping FTP control connections alive in a pool. If the connection is unused for longer than the duration specified by this option then the connection is closed and removed from the pool. A duration of zero is interpreted as no pooling. |
| ftp.useNoop | "0" | milliseconds | When the "keepAlive" option is configured, then this option allow sending NOOPS commands to the remote server in order to keep the connection alive. The value of this option specify the interval between 2 sending of the NOOPS command. A value of 0 deactivate the sending of the NOOPS command. A custom NOOPS command can be specified with the "setNoop" option. |
| ftp.ignoreCheck | "true" | 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. |
| ftp.ignoreDelete | "true" | boolean | If not set, the FTP client tries to delete the target file before the upload is processed. |
| ftp.deleteOnRename | "true" | boolean | If set, the FTP client tries to delete the target file before doing a rename (e.g. when using temporary file names with the "usetmp" option). |
| ftp.retryAfterTimeoutOnCheck | "false" | boolean | If set, the FTP client will try to reconnect if the control connection has timed-out during the data transmission. |
| ftp.keepControlConnectionAlive | "false" | boolean | If set, the FTP client will keep sending NOOPS commands through the control channel while waiting for a data transmission to complete. |
| ftp.mksuffix | "false" | boolean | If set, the FTP client will generate a random suffix for the "usetmp" option with 3 characters (e.g. ".3te"). |
| ftp.usesuffix | "false" | boolean | If set and the "mksuffix" is set as well then the suffix specified in the "suffix" option will be concatenated to the generated suffix (e.g. ".3te.tmp"). |
| ftp.cwd | - | string | Allow changing directory just after the login (a "cd" command is issued with the specified directory). |
| ftp.nopassword | "false" | boolean | Allow connecting to a remote FTP server with no password required (e.g. with anonymous users). |
...