Configuring AWS DataSync transfers with an SMB file server

To transfer data to or from your Server Message Block (SMB) file server, you must create an AWS DataSync transfer location. DataSync can use this location as a source or destination for transferring data.

Accessing SMB file servers

DataSync connects to your file server using the SMB protocol and authenticates with credentials that you provide it.

Supported SMB protocol versions

By default, DataSync automatically chooses a version of the SMB protocol based on negotiation with your SMB file server.

You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically. (DataSync supports SMB versions 1.0 and later.)

See the following table for a list of options in the DataSync console and API:

Console option	API option	Description
Automatic	AUTOMATIC	DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the default and recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.
SMB 3.0.2	SMB3	Restricts the protocol negotiation to only SMB version 3.0.2.
SMB 2.1	SMB2	Restricts the protocol negotiation to only SMB version 2.1.
SMB 2.0	SMB2_0	Restricts the protocol negotiation to only SMB version 2.0.
SMB 1.0	SMB1	Restricts the protocol negotiation to only SMB version 1.0.

Required authentication protocols

Your SMB file server must use NTLM authentication for DataSync to access it. DataSync can't access an SMB file server that uses Kerberos authentication.

Required permissions

DataSync needs a user account with permissions to mount and access your SMB file server's files, folders, and file metadata. This can be a local user on your file server or a domain user that's defined in your Microsoft Active Directory.

Object ownership and NTFS ACL permissions

To set object ownership, DataSync needs a user with the SE_RESTORE_NAME privilege, which is usually granted to members of the built-in Active Directory groups Backup Operators and Domain Admins. Providing DataSync a user with this privilege also helps ensure sufficient permissions to files, folders, and file metadata except for NTFS system access control lists (SACLs).

Additional privileges are required for DataSync to copy SACLs, specifically the Windows SE_SECURITY_NAME privilege that's granted to members of the Domain Admins group. To configure how DataSync copies ACLs, see Managing how AWS DataSync transfers files, objects, and metadata

Creating your SMB transfer location

Before you begin, you need an SMB file server that you want to transfer data from.

To create an SMB location by using the console

1. Open the AWS DataSync console at https://console.aws.amazon.com/datasync/.

2. In the left navigation pane, expand Data transfer, then choose Locations and Create location.

3. For Location type, choose Server Message Block (SMB).

   You configure this location as a source or destination later.

4. For Agents, choose one or more DataSync agents that you want to connect to your SMB file server.

   If you choose more than one agent, make sure you understand using multiple agents for a location.

5. For SMB Server, enter the Domain Name System (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

   Note

   You can't specify an IP version 6 (IPv6) address.

6. For Share name, enter the name of the share exported by your SMB file server where DataSync will read or write data.

   You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

   To copy all the data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Required permissions.

7. (Optional) Expand Additional settings and choose an SMB Version for DataSync to use when accessing your file server.

   By default, DataSync automatically chooses a version based on negotiation with the SMB file server. For information, see Supported SMB protocol versions.

8. For User, enter a user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.

   For more information, see Required permissions.

9. For Password, enter the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

10. (Optional) For Domain, enter the Windows domain name that your SMB file server belongs to.

    If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SMB file server.

11. (Optional) Choose Add tag to tag your SMB location.

    Tags are key-value pairs that help you manage, filter, and search for your locations. We recommend creating at least a name tag for your location.

12. Choose Create location.