SFTP Enumerate

Enumerates all files matching the specified criteria in the specified location on an SFTP server.

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.

DirectoryPath

Type: String Input
The path to the directory from which files should be listed.

Filter

Type: String Input
The search string to match against the names of files in the path.
Filter can be a combination of literal and wildcard characters, but doesn't support regular expressions.
The following wildcard specifiers are permitted in Filter.
\* (asterisk) Zero or more characters in that position.
? (question mark) Zero or one character in that position.
Characters other than the wildcard are literal characters.
Filter cannot end in two periods .. or contain two periods .. followed by Directory Separator Character, nor can it contain any invalid characters.

FolderDepthLimit

Type: Int32 Input
Specifies to what extent sub-directories should be evaluated. If no input is supplied, defaults to 0, meaning that sub-directory contents is not evaluated. The directory path supplied to the node acts as level 0, and a sub-directory inside the supplied path would be considered level 1.

ReturnFullPath

Type: Boolean Input
When true, the full path to the file will be provided on the FileName output. When false, only the file name will be provided.

FilePath

Type: String Output
Returns the name of each file found in turn.

CurrentRow

Type: Int32 Output
An incrementing counter, returning the index of the current file in the returned list.

TotalRows

Type: Int32 Output
Returns the total number of files which match the supplied criteria.