How to Configure an SFTP Send Port


This section provides information on how to configure an SFTP send port using the BizTalk Server Administration Console.

To configure an SFTP send port

  1. In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options and specify SFTP for the Type option in the Transport section of the General tab.

  2. On the General tab, in the Transport section, click the Configure button.

  3. In the SFTP Transport Properties dialog box, on the General tab, specify the following:

    Use this

    To do this


    Specify the maximum number of concurrent connections that can be opened to the server.

    Temporary Folder (applicable to BizTalk Server 2013 R2 only)

    A temporary folder on the SFTP server to upload large files to, before they can be atomically moved to the required location on the same server.

    Proxy (applicable to BizTalk Server 2013 R2 only)


    Specifies either the DNS name or the IP address of the proxy server.


    Specifies the password for the proxy server.


    Specifies the port for the proxy server.


    Specifies the protocol used by the proxy server.


    Specifies the username for the proxy server.



    If set to True, the send port accepts any SSH public host key from the server. If set to False, the port matches the host key with the key specified in the SSHServerHostKey property.

    Default value: False


    Specifies the authentication method that the send port uses for authenticating the client to the SSH Server. If set to Password, you must specify the value in the Password property. If set to PublicKeyAuthentication, you must specify the private key of the user in the PrivateKey property. If set to MultiFactorAuthentication you must provide Username with its Password and PrivateKey. Additionally, if the private key is protected by a password, specify the password as well for the PrivateKeyPassword property.

    Default value: Password

    Encryption Cypher (applicable to BizTalk Server 2013 R2 only)

    Specify the kind of encryption cipher.


    Specify the SFTP user password if you set the ClientAuthenticationMode to Password.


    Specify the private key for the SFTP user if you set the ClientAuthenticationMode to PublicKeyAuthentication.


    Specify a private key password, if required for the key specified in the PrivateKey property.


    Specifies the fingerprint of the server used by the adapter to authenticate the server if the AccessAnySSHServerHostKey property is set to False. If the fingerprints do not match, the connection fails.


    Specifies a username for the secure FTP server.

    SSH Server


    If the file being transferred to the secure FTP server already exists at the destination, this property specifies whether the data from the file being transferred should be appended to the existing file. If set to True, the data is appended. If set to False, the file at the destination server is overwritten.

    Default value: False


    Specifies the folder path on the secure FTP server where the file is copied.


    Specifies the port address for the secure FTP server on which the file transfer takes place.


    Specifies the server name or IP address of the secure FTP server.


    Specifies the name with which the file is transferred to the secure FTP server. You can also use macros for the target file name.

  4. Click OK and OK again to save settings.

Community Additions