This article will cover troubleshooting and resolving common errors using an SFTP Connection within Workflows.
In the Workflows Console, when attempting to set up an SFTP Connection in Workflows or use an SFTP card in a flow, an error occurs, and the SFTP card(s) cannot be used as intended.
Below are two examples of errors that can be seen when setting up the SFTP Connection. Further errors and information on getting a more detailed error message can be seen in the Cause/Resolution sections below:
-
SFTP server refused connection
-
cannot POST /app/api/config/{connectionID}/test (500)
- Workflows
- SFTP Connector
- Upload File
- Download File
- Write File
There is an issue setting up or using the SFTP Connection, the cause of which varies depending on the specific error message seen.
If the error is seen when setting up the SFTP Connection, as the SFTP Connection is still created/saved and available to select in a flow, follow the steps below to get a more detailed error code, then look for that error code in the Resolution section below:
- Create a new test flow using an SFTP card (such as Download File).
- Select the SFTP connection that had an error during setup.
- Test the card to see a more detailed error response. Below are common errors identified by the error message and their corresponding causes.
Obtain the more descriptive error as described above, and reference the list below for the related error message from either a connection setup issue, or using a successful SFTP Connection, but getting an error on one of the SFTP cards:
Example for the location of the error messages referenced:
Error: SFTP Error: Authentication failed (username/password)
- Issue: SFTP Server could not validate the username/password entered.
- Recommendation: Verify the username/password used to set up the SFTP Connection, possibly testing the combination in an external SFTP client.
Error: SFTP Error: Username/PublicKey combination invalid
- Issue: SFTP Server could not validate the username/key entered.
- Recommendations:
- Verify the username/key used to set up the SFTP Connection, possibly testing the combination in an external SFTP client.
- Verify that the Public Key was uploaded to the Server and that the username entered has permission to authenticate with the SSH Key.
Error: SFTP Error: keyfile auth failed (seen when creating a connection when using Username/Key)
- Issue: The key used for connection has a passphrase/password used when creating the PEM.
- Recommendation: Create a key without adding a passphrase/password.
Error: SFTP Error: Error parsing PEM: offset out of bounds (seen when creating a connection when using Username/Key)
- Issue: When using the Username/Key combination, the key could not be parsed.
- Recommendation: Ensure the key is entered without extra characters before/after the header/footer and that the header/footer is included.
- Example:
-
-----BEGIN OPENSSH PRIVATE KEY-----
-
{ACTUALKEYHEREINBETWEENTHEHEADERFOOTER}
-
-----END OPENSSH PRIVATE KEY-----
Error: SFTP Error: Failed getting banner
- Possible Causes:
- The hostname entered is not an SFTP Server.
- The port is not open or is not accepting additional SSH connections on the SFTP Server.
- Recommendations:
- Verify the SFTP Server information entered.
- Verify that the SFTP Server is not hitting the connection limit and/or restricting additional SSH connections.
- Check if it is possible to block via the Firewall.
- See this linked KBA for IPs used by Workflows to be added to allows list for Workflows usage, including SFTP Connector.
Error: Network Error: Custom (kind: Uncategorized, error: \failed to lookup address information: Name does not resolve!* )
- Issue: Could not resolve the hostname via DNS.
- Recommendation: Verify the hostname is entered correctly when setting up the SFTP connection and that it can be reached externally outside of Workflows.
Error: Missing Value: Missing password and/or private key
- Issue: When setting up the connection, a username was entered, but a corresponding password or key was not entered.
- Recommendation: Create/Re-Auth the SFTP Connection and ensure that when the username is entered, either a password or key is also entered.
Error: Failed to parse request message
- Issue: This is most commonly seen when an SFTP Connection is set up, but a username is not entered.
- Recommendation: Create/Re-Auth the SFTP Connection and ensure to enter a username and either a password or a key.
Error: SFTP Error: failure (when using a Good connection with Download File or Read File cards)
- Issue: The filename (or path/filename) entered does not exist.
- Recommendation: Verify the spelling of the filename (or path/filename) and ensure that the file exists in that location on the SFTP Server.
Error: SFTP Error: no such file
- Issue: The file path is incorrect.
- Recommendation: Test the path first - starting by only adding a forward slash / by itself. After testing, locate the file on the SFTP server and create a folder for it. Example: /foldername/filename.csv.
Error: SFTP Error: Unable to exchange encryption keys
- Issue: The client and server cannot agree on the encryption methods to use for the session.
- Recommendation: The SFTP server should align with at least 1 of the methods from each of these below:
- SSH Key Exchange Algorithms(KEX): diffie-hellman-group-exchange-sha256, diffie-hellman-group1-sha1, diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha1
- SSH MACs: hmac-sha2-512, hmac-sha2-512-etm@openssh.com, hmac-sha2-256, hmac-sha2-256-etm@openssh.com, hmac-sha1, hmac-sha1-96, hmac-md5, hmac-md5-96, hmac-ripemd160 (hmac-ripemd160@openssh.com)
- SSH Ciphers: aes256-gcm@openssh.com, aes128-gcm@openssh.com, aes256-ctr, aes192-ctr, aes128-ctr, aes256-cbc (rijndael-cbc@lysator.liu.se), aes192-cbc, aes128-cbc, 3des-cbc, blowfish-cbc, cast128-cbc, arcfour, arcfour128
Error: Network Error: Custom { kind: Other, error: \"failure\" }
- Issue: There may be an invalid character in the filename that is being uploaded.
- Recommendation: Remove any characters that may be invalid (for example,
!,@,#,$, :)
