Docs Menu
API Developer Guide / middleware / pub / client / sftp / commands / open

Service: open

This service is used to open a remote connection for a Unix/Linux machine.

Input Parameters:

Name Type Description
host: String Name of the host
username: String Name of the User
password: String password
pemfileLocation: String Encoded file includes Base64 data.
port: Integer Port Number

Output Parameter:

Name Type Description
sshObjects: Document
sftpClient: Object SFTP Client
sshClient: Object SSB Client
session: Object Provides information about single-user
status: String Status of the operation
error: String Error Message
pemfilePath: String Encoded file includes Base64 data.