SFTP

Perform file operations on a remote SFTP server.

Revision History

0.0.0.1 - Initial release.
0.0.0.3 - Project restructure.
0.0.0.5 - SupportedCluster update.
0.0.0.10 - Node name correction.

Connection

Parameter	Type	Description
Host	String	The host name or IP address of the remote server.
Port	Integer	The port to connect to. Defaulted to 22.
Timeout (seconds)	Integer	The amount of time to wait for the server before timing out.
Username	String	The username used to authenticate with the server.
Password	Masked	The password used to authenticate with the server.

Methods

Read

Parameter	Type	Notes
Connection	Connection	The SFTP connection profile.
Path	String	The path of the file to read.

Parameter	Type	Notes
Content	Stream	Stream content of file to read.

Write

Parameter	Type	Notes
Connection	Connection	The SFTP connection profile.
Path	String	The path of the file to write.
Content	Stream	Stream content of file to write.
OverwriteExisting	Boolean	When enabled, existing files will be replaced during upload. Defaults to true.

Copy

Parameter	Type	Notes
Connection	Connection	The SFTP connection profile.
Path	String	TThe path of the file to copy.
Destination	String	The destination folder to copy the file into.
OverwriteExisting	Boolean	When enabled, an existing file at the destination will be replaced. Defaults to true.

Move

Parameter	Type	Notes
Connection	Connection	The SFTP connection profile.
Path	String	TThe path of the file to move.
Destination	String	The destination folder to move the file into.
OverwriteExisting	Boolean	When enabled, an existing file at the destination will be replaced. Defaults to true.

Delete

Parameter	Type	Notes
Connection	Connection	The SFTP connection profile.
Path	String	The path of the file to read.

Info

Parameter	Type	Notes
Connection	Connection	The SFTP connection profile.
Path	String	The path of the file to read.

Parameter	Type	Notes
Metadata	Object	The metadata for the specified file/folder.