webMethods Integration Cloud and Cloud Deployment Documentation 6.0.0 | webMethods Integration Cloud | Applications | Predefined Applications | Secure File Transfer Protocol (SFTP)
 
Secure File Transfer Protocol (SFTP)
 
SFTP Predefined Operations
The SSH File Transfer Protocol (SFTP) is a network protocol that is based on the Secure Shell protocol (SSH). SFTP facilitates secure file access, file transfer, and file management over any reliable data stream. The Secure File Transfer Protocol (SFTP) Application downloads files from or uploads files to an SFTP-enabled server using the secure file transport channel.
Integration Cloud connects to an SFTP server using the SSH File Transfer Protocol (SFTP) and provides operations to retrieve, transfer, rename, and delete files or directories in the SFTP server. You can also change the permission or ownership of files in the SFTP server.
You can configure Integration Cloud to connect to an SFTP server to perform the following tasks using the SFTP protocol:
*Transfer files between Integration Cloud and the SFTP server. You can get a file from the SFTP server or upload a file to the SFTP server.
*Access files in the SFTP server. You can view the directories and files in the SFTP server and also view their permissions and ownership information.
*Manage directories or files in the SFTP server. You can create, rename, or delete files or directories in the SFTP server. You can also change the permissions or ownership of files in the SFTP server.
For this parameter...
Specify...
Host Name or IP Address
The host name or IP address of the SFTP server.
Port Number
The port number of the SFTP server. The port number must be within the range of 1 and 65535 (inclusive).
Host Public Key
The public key of the SFTP server. Select Auto Retrieve if you want Integration Cloud to automatically retrieve the public key of the SFTP server. Select Upload if you have the public key of the SFTP server. Integration Cloud will use the uploaded public key.
Finger Print
The host public key fingerprint of the SFTP server.
Note: This field is visible only after you have established a connection to an SFTP server.
Before establishing a connection, the SFTP server sends an encrypted fingerprint of its host public keys to ensure that the SFTP connection will be exchanging data with the correct server. Save the fingerprint information locally. This enables you to check the fingerprint information against the data you have saved every time you establish a new connection.
User Name
The user name for the SFTP user account.
Authentication Type
The type of authentication Integration Cloud uses to authenticate itself to the SFTP server. Client authentication can be either by password or by public and private keys. Select Password if you want to use password authentication. If you are using password authentication, enter the password for the specified user to connect to the SFTP server. Select Public Key if you want to authenticate Integration Cloud by using public and private keys. To use this authentication type, the SFTP server and Integration Cloud must each have access to their own private key and each other's public key.
Private Key
If you selected Public Key as the authentication type, select the private key file of the specified SFTP user.
PassPhrase
If you selected Public Key as the authentication type and if the private key you specified requires a passphrase, enter the passphrase for the private key file of the specified user.
Advanced Options
Maximum Retries
The number of times Integration Cloud attempts to connect to the SFTP server. The maximum allowed value is 6. The minimum allowed value is 1.
Response Timeout
The amount of time (measured in seconds) Integration Cloud waits for a response from the SFTP server before timing out and terminating the request. A value of 0 indicates that the session will never time out. In case the network is slow or the back end processing takes longer than usual, increase the Response Timeout value.
Session Timeout
The number of minutes you want Integration Cloud to wait before terminating an idle session. The session timeout value must be within the range of 10 and 60 minutes.
Preferred Key Exchange Algorithms
The algorithms that Integration Cloud presents to the SFTP server for key exchange. You can specify the order in which Integration Cloud presents the algorithms to the SFTP server by moving the available algorithms up or down by clicking Move Up or Move Down. The SFTP server has its own set of preferred algorithms configured. At the time of key exchange, one of the algorithms supported by both Integration Cloud and the SFTP server will be chosen.
Compression
Whether or not to compress the data to reduce the amount of data that is transmitted. Integration Cloud supports compression using the compression algorithm zlib. You can use compression only if the SFTP server that you are connecting to supports compression. Select None if you do not want to compress the data. Select zlib if you want to compress the data that is transmitted between the SFTP server and Integration Cloud.
Compression Level
The compression level to use if you selected the compression algorithm zlib in the Compression field. The minimum allowed value is 1 (fast, less compression) and the maximum allowed value is 9 (slow, most compression).
Copyright © 2014- 2019 | 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.