SFTP Read

Reads the contents of a file from an SFTP server in binary (byte array) or text (string) form.

This Node is only available in the 2023 Refresh.

Revision History

2.0.0.0 - Initial Release
2.0.0.1 - Fixed exception: Poll interval too long
2.0.0.2 - Updated SSH.NET Nuget Package to version 2024.0.0 (fixes HMAC server errors)

Properties

Connection

Type: Connection Input
Provides a Connection and optionally a DropPoint to service the request.

Host
Type: String
Identifies the network location or address where the server is located.

Port
Type: Int32
Defines the specific communication channel through which data is transmitted.
Typically set to port 22 for standard SFTP connections.

Username
Type: String
The username used to authenticate access to the SFTP server.

Password
Type: String
The password used to authenticate access to SFTP server.

ClientPrivateKeyFileContents
Type: Multiline Text Data
The SSH Certificate contents used to authenticate to the SFTP server.

Path

Type: String Input
The path to the file on the SFTP server.

Type

Type: List Input
Indicates whether the file should be read or written as text or binary. In Text mode, the file is read or written as a string. In Binary mode, the file is read or written as a byte array.

Text
Binary

Content

Type: Multiline Text InputOutput
Provides access to the file stream. This property will be set to the file content during invoke. Content may be of type string or byte array - refer to the Type property for more information.

Remarks

If you are reading or writing sizeable files over SFTP, installing a DropPoint in the same network as the SFTP server will significantly improve performance as the data will be compressed in transit to and from the DropPoint.