Deploy your Amazon DataSync agent

To deploy an agent on VMware

1. Open the Amazon DataSync console at https://console.amazonaws.cn/datasync/.

2. In the left navigation pane, choose Agents, and then choose Create agent.

3. For Hypervisor, choose VMWare ESXi, and then choose Download the image.

   The agent downloads in a .zip file that contains an .ova image file.

4. To minimize network latency, deploy the agent as close as possible to the storage system that DataSync needs to access (the same local network if possible). For more information, see Amazon DataSync network requirements.

   If needed, see your hypervisor's documentation on how to deploy an .ova file in a VMware host.

5. Power on your hypervisor, log in to the agent VM, and get the agent's IP address. You need this IP address to activate the agent.

   The agent VM's default credentials are login admin and password password. If needed, change the password through the VM's local console.

To deploy an agent on KVM

1. Open the Amazon DataSync console at https://console.amazonaws.cn/datasync/.

2. In the left navigation pane, choose Agents, and then choose Create agent.

3. For Hypervisor, choose Kernel-based Virtual Machine (KVM), and then choose Download the image.

   The agent downloads in a .zip file that contains a .qcow2 image file.

4. To minimize network latency, deploy the agent as close as possible to the storage system that DataSync needs to access (the same local network if possible). For more information, see Amazon DataSync network requirements.

5. Run the following command to install your .qcow2 image.

   virt-install \
       --name "datasync" \
       --description "DataSync agent" \
       --os-type=generic \
       --ram=32768 \
       --vcpus=4 \
       --disk path=datasync-yyyymmdd-x86_64.qcow2,bus=virtio,size=80 \
       --network default,model=virtio \
       --graphics none \
       --import

   For information about how to manage this VM and your KVM host, see your hypervisor's documentation.

6. Power on your hypervisor, log in to your VM, and get the IP address of the agent. You need this IP address to activate the agent.

   The agent VM's default credentials are login admin and password password. If needed, change the password through the VM's local console.

To deploy an agent on Hyper-V

1. Open the Amazon DataSync console at https://console.amazonaws.cn/datasync/.

2. In the left navigation pane, choose Agents, and then choose Create agent.

3. For Hypervisor, choose Microsoft Hyper-V, and then choose Download the image.

   The agent downloads in a .zip file that contains a .vhdx image file.

4. To minimize network latency, deploy the agent as close as possible to the storage system that DataSync needs to access (the same local network if possible). For more information, see Amazon DataSync network requirements.

   If needed, see your hypervisor's documentation on how to deploy a .vhdx file in a Hyper-V host.

   Warning

   You may notice poor network performance if you enable virtual machine queue (VMQ) on a Hyper-V host that's using a Broadcom network adapter. For information about a workaround, see the Microsoft documentation.

5. Power on your hypervisor, log in to your VM, and get the IP address of the agent. You need this IP address to activate the agent.

   The agent VM's default credentials are login admin and password password. If needed, change the password through the VM's local console.

To choose the agent AMI for your Amazon Web Services Region

• Use the following Amazon CLI command to get the latest DataSync Amazon Machine Image (AMI) ID for your Amazon Web Services Region.

  aws ssm get-parameter --name /aws/service/datasync/ami --region region

  Example command and output

  aws ssm get-parameter --name /aws/service/datasync/ami --region us-east-1                              
  
  {
      "Parameter": {
          "Name": "/aws/service/datasync/ami",
          "Type": "String",
          "Value": "ami-id",
          "Version": 6,
          "LastModifiedDate": 1569946277.996,
          "ARN": "arn:aws-cn:ssm:us-east-1::parameter/aws/service/datasync/ami"
      }
  }

To deploy your DataSync agent as an Amazon EC2 instance

1. From the Amazon Web Services account where the source file system resides, launch the agent by using your AMI from the Amazon EC2 launch wizard. Use the following URL to launch the AMI.

   https://console.amazonaws.cn/ec2/v2/home?region=source-file-system-region#LaunchInstanceWizard:ami=ami-id

   In the URL, replace the source-file-system-region and ami-id with your own source Amazon Web Services Region and AMI ID.

2. For Instance type, choose one of the recommended Amazon EC2 instances for DataSync.

3. For Network settings, choose Edit and then do the following:

   1. For VPC, choose the virtual private cloud (VPC) where the storage system you're transferring data to or from is located.

   2. For Auto-assign public IP, choose whether you want your agent to be accessible from the public internet.

      You use the instance's public or private IP address later to activate your agent.

   3. For Firewall (security groups), create or a select a security group that does the following:

      • Allows inbound traffic from your web browser to the instance on port 80 (HTTP).

      • Allows inbound and outbound traffic between the instance and your storage system. For more information, see Network requirements for self-managed and other cloud storage.

      Note

      You will need to configure additional ports depending on the type service endpoint that you use to connect the agent with Amazon.

4. (Recommended) To increase performance when transferring from a cloud-based file system, expand Advanced details choose a Placement group value where your storage resides.

5. Choose Launch to launch your instance.

6. Once your instance status is Running, choose the instance.

7. If you configured your instance to be accessible from the public internet, make note of the instance's public IP address. If you didn't, make note of the private IP address.

   You need this IP address when activating your agent.