Hybrid Integration 10.1 | Integrating On-Premises Applications | Integration Server Built-In Services | Client Folder | pub.client.sftp:login
 
pub.client.sftp:login
WmPublic. Connects to a remote SFTP server and logs in with the specified SFTP user alias.
Important: You must use this service to initiate an SFTP session before using most other pub.client.sftp services.
Input Parameters
userAlias
String Alias containing the SFTP client configuration for an SFTP user account. Integration Server creates a new session each time it logs on to the SFTP server and returns the session key to the user.
reuseSession
String Flag indicating whether or not Integration Server reuses a session that is already open for the specified user alias. Set to:
*true to reuse the session that is already open for the specified user alias. If no session is open for this user alias, the pub.client.sftp:login service will create a new session and return the key for this new session.
*false to create a new session for the specified user alias. This is the default.
Output Parameters
sessionKey
String Unique key for the current SFTP session. Most other pub.client.sftp services require this session key to execute.
returnCode
String Standard SFTP protocol return code.
returnMsg
String Text message describing the return code.
Usage Notes
You cannot execute SFTP commands in parallel using the same session key.
Copyright © 2015- 2017 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.