AWS DataSync
User Guide

Creating a Location for SMB

When you use this location in a task you will configure it as the source or destination location. DataSync supports the SMB 2 and SMB 3 protocols.

To create an SMB location

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

  2. In the navigation pane, choose Locations. The locations that you previously created appear in the list of locations.

  3. On the Locations page, choose Create location.

  4. For Location type, choose Server Message Block (SMB). You configure this location as a source or destination later.

  5. For Agents, choose the agent that you want to use. The agent connects to your on-premises SMB server and makes it easier to securely transfer data between the on-premises location and AWS.

  6. For SMB Server, provide the DNS name or IP address of the SMB server.

    DataSync automatically chooses the SMB version that it uses to read from an SMB location.

  7. For Share name, enter the name of the share exported by your SMB server. You can include a folder from within this share.

  8. For User, enter the user who can mount the location and has the permissions to access files file share. To transfer data from or into the share you specified, DataSync needs to have permissions to read all the data or write to the share. To ensure this, we recommend that the user you configure is either a local Administrator or a member of the built-in Active Directory group (Backup Operators).

  9. For Password, enter the password of the user who can mount the location and has the permissions to access the SMB file share.

  10. (Optional) Expand the Additional settings section if you want to enter values for these settings:

    • (Optional) For Domain, enter the name of the domain the user is part of.

    • (Optional) For SMB version, choose the SMB version. DataSync uses this version to mount your SMB file share. If you don't choose a version, DataSync automatically selects a version based on negotiation with the SMB server.

  11. (Optional) For Key and Value, enter a key and value to tag your SMB location. A tag is a key-value pair that helps you manage, filter, and search for your locations.

  12. When you are done, choose Create location.

SMB Location Settings

Following, you can find descriptions for the configuration settings for SMB locations in DataSync.

Agent

An agent is a VM that is deployed in your on-premises environment to connect to your on-premises location. An agent makes it easier to securely transfer data between the on-premises location and AWS. You can use an agent for more than one location.

If a task is using multiple agents, all the agents need to have the status Available for the task to run. If you use multiple agents for a source location, the status of all the agents must be Available for the task to run. Agents are automatically updated by AWS on a regular basis, using a mechanism that doesn't interrupt your tasks.

SMB Server

The name of the SMB server, the IP address or DNS name of the SMB server. An agent that is installed on-premises uses this name to mount the SMB server in a network.

Share Name

The name of the share exported by your SMB server. You can include a folder from within this share.

User

The user who can mount the location and has the permissions to access SMB file share.

Password

The password of the user who can mount the location and has the permissions to access files and folders in the SMB file share.

Domain

The the name of the domain the user is part of.

SMB Version

DataSync supports the SMB version 2 and SMB version 3 protocols. DataSync automatically selects a version based on negotiation with the SMB server.

Tag

A tag is a key-value pair that helps you manage, filter, and search for your location. Adding a tag is optional. We recommend using tags for naming your resources.

On this page: