Integration Server 10.3 | Integration Server Administrator's Guide | Configuring Integration Server to Connect to an SFTP Server | Creating an SFTP User Alias
 
Creating an SFTP User Alias
 
Editing an SFTP User Alias
Migration Impact on SFTP Configurations
Testing the Connection to the SFTP Server
An SFTP user alias is a named set of parameters that contains SFTP user account details and client configurations that Integration Server uses to function as an SFTP client.
In many organizations, a system administrator provides the SFTP user account information that you require to create an SFTP user alias.
You can have multiple SFTP user aliases for the same SFTP user account. Each SFTP user alias name in an Integration Server must be unique.
Keep the following points in mind when configuring Integration Server to act as an SFTP client:
*Integration Server supports password authentication and public key authentication for authenticating itself as the client to the SFTP server.
*For both password and public key authentication, you must have an account on the SFTP server that is set up for SFTP access.
*For public key authentication, the SFTP server and Integration Server must have access to their own private key and each other's public key.
Important:
You must create at least one SFTP server alias before creating an SFTP user alias.
*To create an SFTP user alias
1. Open Integration Server Administrator.
2. In the Navigation panel, select Settings > SFTP.
3. Click User Alias Settings.
4. Click Create User Alias.
5. Under SFTP User Alias Properties, provide the following information:
Parameter
Specify
Alias
A name for the alias.
An SFTP user alias name:
*Can contain only underscores (_) and periods (.) as the special characters.
*Cannot begin with the string "http://".
*Can be of a maximum length of 255 characters.
User Name
The user name for the SFTP user account.
Authentication Type
The type of authentication that Integration Server uses to authenticate itself to the SFTP server. Client authentication can be either by password or by public and private keys.
Select
To
Password
Use password authentication.
Public Key
Authenticate Integration Server by using public and private keys.
To use this authentication type, the SFTP server and Integration Server must each have access to their own private key and each other's public key. If you select public key authentication, Integration Server saves the private key file in the Integration Server_directory /instances/instance_name/config/sftp/identities folder.
Password
If you are using password authentication, enter the password for the specified user to connect to the SFTP server.
Re-type Password
Re-enter the above password.
Private Key Location
If you selected Public Key as the authentication type, enter the location of the private key 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.
Re-type PassPhrase
Re-enter the above passphrase.
SFTP Server Alias
The alias of the SFTP server to which you want the specified user to connect.
Maximum Retries
The number of times Integration Server attempts to connect to the SFTP server. The maximum allowed value is 6. The minimum allowed value is 1. The default is 6 retries.
Connection Timeout (seconds)
The amount of time (measured in seconds) Integration Server waits for a response from the SFTP server before timing out and terminating the request. The default is 0, which indicates that the session will never time out.
Session Timeout (minutes)
The number of minutes you want Integration Server to wait before terminating an idle session. The default is 10 minutes.
Strict Host Key Checking
Whether Integration Server verifies the host key of the SFTP server before establishing a connection to the SFTP server.
Select
To
Yes
Allow Integration Server to verify the host key of SFTP server against the host key that was imported during the SFTP server alias configuration. If the host key is found to be the same, then Integration Server establishes a connection to SFTP server, else the connection to SFTP server fails.
No
Prevent Integration Server from verifying the host key of SFTP server during connection.
Note:
For added security, Software AG recommends you to choose Yes and enable the host key verification.
Compression
Whether or not to compress the data to reduce the amount of data that is transmitted. Integration Server supports compression using the compression algorithm zlib.
Note:
You can use compression only if the SFTP server that you are connecting to supports compression.
Select
To
zlib
Compress the data that is transmitted between the SFTP server and Integration Server.
None
Not compress the data.
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). The maximum allowed value is 6 (slow, most compression). The default is 6.
6. Click Save Changes.
Integration Server saves the SFTP user alias configuration in the Integration Server_directory /instances/instance_name/config/sftp/sftpUserAliases.cnf file.