Replicator 7.4 - Configuring SFTP with Metalogix Replicator

Configuring STFP With Metalogix Replicator

September 2023

Configuring STFP With Metalogix Replicator

This guide describes how to enable replication using the SFTP transport protocol.

SFTP transport is one way outbound only communication, as a result acknowledgments and responses are not accepted back from the target. This will result in all outbound packages being set to completed

Preparation

Setup

Preparation

This guide describes how to enable replication using the SFTP transport protocol.

SFTP transport is one way outbound only communication, as a result acknowledgments and responses are not accepted back from the target. This will result in all outbound packages being set to completed

Local SFTP Server Settings:

Local SFTP Account Name: Name of the user with permission to connect to the local SFTP server running in the Replicator service. The default user name is typically "ReplicatorSFTPAccount".

Password for Password Authentication: The password for the user described above when using Password Authentication.

Public Encryption Key for Public Authentication: The public key to be used by the remote connection, and the private key pass phrase if key encryption is being used. Metalogix recommends using SSH-2 RSA keys of 2048-bit length for this.

Import Folder Name: The relative path name where Replicator will look for packages to upload via SFTP from another farm (e.g. /WebApp1SFTPImport).

This path is relative to the Replicator temporary folder, which is set to the following by default (where <Farm Admin> is the SharePoint Farm Administrator user):
C:\users\<Farm Admin>\appdata\Local\Temp\

Specify a folder name unique to this web application if more than one web application on this SharePoint farm is configured for replication using the SFTP transport method.

Target SFTP Server Settings

DNS name: The DNS name for the server hosting the SharePoint farm.

Port: The port number used by the SFTP server. Typically, the default port number is 22. Make sure that the firewall is not blocking this port to ensure that SFTP communication takes place.

User Name: Name of the user with permission to connect to the target SFTP server running in the Replicator service. The default user name is typically ReplicatorSFTPAccount.

Password for Password Authentication: The password for the user described above when using Password Authentication.

Private Encryption Key for Public Key Authentication: The private key to be used by the remote connection, and the private key pass phrase if key encryption is being used. Metalogix recommends using SSH-2 RSA keys of 2048-bit length for this.

Target Import Folder Name: The relative path name where Replicator will listen for packages to upload via SFTP from another farm (e.g. /WebApp1SFTPImport).

This path is relative to the Replicator temporary folder, which is set to the following by default (where <Farm Admin> is the SharePoint Farm Administrator user):
C:\users\<Farm Admin>\appdata\Local\Temp\

If more than one web application on this SharePoint farm is configured for replication using the SFTP transport method, specify the folder name that is unique to this web application.

Update Outbound Package Status from Package Response File: Select this option to enable outbound global package status updates from package response files received from the target server.

The following table can be used to gather the required information.