Full path: /system/sftp/connect
Connects to the SSH server with SFTP support and returns an SFTP connection object that you can use for other SFTP functions in subsequent steps. Some parameters can be set to <Expression> (e.g., Login credentials). To find out more about expressions, see FlowForce Expressions.
The /system/sftp/connect function might return an unconnected SFTP connection if the Abort on error parameter is set to false. The SFTP connection might also be lost during the execution of a job. In both cases, all subsequent steps with this connection will not succeed.
Parameters
Name |
Type |
Description |
|---|---|---|
Host |
string |
Mandatory parameter. Address of the remote SFTP server, as a URL or IP address. |
Port |
number |
The port number used to connect to the SFTP server. The default value is 22. |
Login credential |
credential |
Use the username and password of the SFTP account or select a FlowForce credential record with the username and password or with the username and SSH key. For more information, see Credentials.
Skip this parameter if the SFTP server does not require credentials. |
Abort on error |
boolean |
Optional parameter. If job execution fails and the Abort on error parameter is set to true, the job execution will be aborted. The default value is true. |
Logging |
string |
This parameter is optional. It allows diagnosing SSH issues. You can set the log level to default (general information), verbose, or debug. You can leave the parameter empty, in which case no logging will happen. For more information, see the subsection below. |
SFTP logging
The Logging parameter helps diagnose SSH issues. The log levels can be default (general information), verbose, and debug. The parameter syntax is as follows:
( settings “;” )? filename
The file must be creatable for writing by the job user account. The file will be overwritten if it exists. You can use, for example, {instance-id()} inside the filename to make it unique. If the file cannot be created, the connection step will fail.
Log level configuration
The logging options are listed below:
•No logging: If the Logging parameter is set to an empty string (empty text field), no logging happens.
•Default-level log: If the parameter is a file name, the default-level log will be written to that file. The file name must be an absolute path (e.g., C:\temp\logfile.txt).
•Verbose- or debug-level log: Only if special (more verbose) settings are desired is the extended syntax with a semicolon needed. For example, to get a debug-level log, write the following parameter value in the Logging text field:
debug;c:\temp\mylogfile.txt
Global and individual configuration
Log levels can be configured globally for both SFTP and SSH or individually for each. To configure SSH and SFTP separately, the log level must be prefixed with ssh= or sftp= depending on your needs. Multiple settings are separated by commas. The sample parameter value below shows how to set a debug-level log for SSH and a default-level log for SFTP:
ssh=debug,sftp=default;c:\temp\mylogfile.txt
Default-level log
The default-level log of a connection attempt may look as follows:
[SSH:info ] SSH Line 2.0 OpenSSH_7.9p1 Debian-10+deb10u2
[SFTP:info ] Connection established
[SFTP:info ] Closing SFTP connection
[SFTP:info ] SFTP read operation failed, status=broken pipe detail=0
Verbose-level log
To set the parameter to a verbose-level log, write the relevant parameter value in the Logging text field. An example of a verbose-level log is shown below:
[SSH:verbose] sending data
[SSH:verbose] Data received 112
[SSH:verbose] Received request result for channel 0
[SFTP:verbose] SFTP connection established
[SSH:verbose] sending data
[SSH:verbose] Data received 208
[SFTP:verbose] Received SFTP version 3 response
[SFTP:info ] Connection established
[SSH:verbose] sending data
[SFTP:info ] Closing SFTP connection
[SFTP:verbose] Closing SFTP channel
[SSH:verbose] sending data
[SSH:verbose] sending data
[SFTP:info ] SFTP read operation failed, status=broken pipe detail=0
[SSH:verbose] Connected closed
[SSH:verbose] Data received 0
The debug-level log will show more detailed information about all operations.
