Docs Menu
- Introduction to Syncloop
- Quick Start Syncloop
-
API Developer Guide
-
middleware
-
pub
- adapter
- authorization
- client
- collection
- date
- docList
- file
- graphQL
- io
- json
- jwt
- math
- platform
- security
- server
- service
- specs
- sql
- string
- bytesToHexString
- bytesToString
- compare
- compareStrings
- concat
- decodeBase64
- decodeHTML
- encodeBase64
- encodeHTML
- equals
- equalsIgnoreCase
- escapeSQL
- fromXML
- htmlDecode
- htmlEncode
- indexOf
- isAlphanumeric
- isBlank
- isDate
- isEmpty
- isNumber
- length
- lookupDict
- maskString
- messageDigest
- messageFormat
- NullOrWhiteSpc
- objectToString
- padLeft
- replace
- rightPad
- stringConcat
- stringIndexOf
- stringToBytes
- subString
- TextArrayToTextString
- TextListCollector
- tokenize
- toLower
- toString
- toUpper
- trim
- urlDecode
- tenant
- util
- xml
-
pub
-
middleware
- User Guide
- FAQs
- Java Docs
- Blogs
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. |