Full path: /system/ftp/list
Lists the contents of a directory on an FTP server. In case of successful execution, this function returns a sequence of string. Otherwise, the outcome depends on the Abort execution on error parameter, as further described below.
If you intend to use the triggerfile parameter in any FTP function, remember that its path is absolute. For an example, see the FTP store function. |
Parameters
Name |
Type |
Description |
||
|---|---|---|---|---|
FTP Server |
string |
Address of the remote FTP server, either as a URL or IP address.
Mandatory parameter. |
||
Port |
number |
The port number used to connect to the FTP server. The default value is 21. |
||
Directory on host |
string |
The name of the directory, on the host, whose contents you want to list.
Optional parameter. The default value is the current directory, "/". |
||
Login credentials |
credential |
The username and password of the FTP account, as a FlowForce credential record, see Credentials.
Skip this parameter if the FTP server does not require credentials. |
||
Use passive mode |
boolean |
Use passive mode if connection problems occur (for example, if routers or firewalls are set up to prevent active connections).
Optional parameter. The default value is true. |
||
Use SSL/TLS encryption |
string |
(Optional parameter, the default value is No.) To transfer information, FTP uses a command channel and a data channel. If you would like to transfer FTP data without encryption, set this value to No. Otherwise, set this value to one of the following:
•Explicit with encrypted command channel •Explicit with encrypted command and data channel
If you set any of the two options above, the server certificate will be validated according to the Verify server certificate parameter described below.
|
||
Verify server certificate |
string |
(Optional parameter.) Specifies how FlowForce should verify the FTP server's certificate. Valid values:
•No verification - Accept any certificate. •Verify against system certificate store (default value) - On Windows, use the certificate store of the user account running the job and the system store to verify the certificate signature. On Linux, use the system certificate store, usually located in /usr/lib/ssl/cert.pem and /usr/lib/ssl/certs, or the path where the SSL_CERT_FILE and SSL_CERT_DIR environment variables point to. •Verify against selected server certificate - FlowForce will compare the FTP server's certificate with the one specified in the Server Certificate parameter.
Using this parameter requires the presence of a server certificate and a secure connection. If a secure connection cannot be established, the FTP function will fail. |
||
Server certificate |
certificate |
(Optional parameter.) Specifies the path to a certificate object in FlowForce. The specified FlowForce certificate will be verified against the FTP server certificate if you also set the previous parameter to Verify against selected server certificate. Otherwise, this parameter value will be ignored. |
||
Wildcard |
string |
The wildcard string to use, for example, *.js if you need to retrieve all .js files from the directory specified by the Directory on host parameter.
Optional parameter. The default value is an empty string, which means no wildcard filtering takes place. |
||
Abort on error |
boolean |
This parameter controls what happens when execution has failed. If execution has failed and Abort on error is true, the job execution is aborted, and you can handle errors by means of protected blocks. If execution has failed and Abort on error is false, then the function returns an empty sequence.
Optional parameter. The default value is true. |
||
Account |
string |
The FTP account name of the user allowed access to the files on the remote server.
Optional parameter. |
