Configure data transfer agents

Configure the agent in Azure Portal

Add an agent

To add an agent with the Azure Portal, follow these steps:

1. Select Data Transfer Agents from the LiveData Migrator list on the side menu.
2. Select + Create from the command bar, or select Create data transfer agent from the main panel.
3. Enter a name for the agent in the Data Transfer Agent Name field.
4. Paste the authentication token from the output in your terminal into the Authentication Token field.
   Data Migrator gets the hostname and the port number from this token and populates the corresponding Hostname or IP address field in the portal automatically.
5. Select Save.

Check the status of an agent in Azure Portal

To check if the status of the connection to an agent is healthy:

1. Select Data Transfer Agents from the LiveData Migrator list on the side menu.
2. From the Data Transfer Agents panel, select Refresh.
   The Data Transfer Agents page lists all agents and whether they are healthy or unhealthy under the Status column.

Configure the agent with the Azure CLI

All data transfer agent commands use the following format:

az livedata migrator data-transfer-agent <command list>

For more information about the listed parameters, see LiveData extension commands.

Add an agent with the Azure CLI

Add an agent with connection token string.

 az livedata migrator data-transfer-agent create -g <ExampleResourceGroup> \
--migrator-name <ExampleMigrator> --data-transfer-agent-name <ExampleDataTransferAgent> \
--host-name <example_host_name> \
--port 1443 \
--token 123456789123456789

Add an agent with a token file.

 az livedata migrator data-transfer-agent create -g <ExampleResourceGroup> \
--migrator-name <ExampleMigrator> --data-transfer-agent-name <ExampleDataTransferAgent> \
--host-name <example_host_name> \
--port 1443 \
--token @./mytoken.txt

List Data Transfer Agents with the Azure CLI

To list all installed data transfer agents, run the following Azure CLI command:

az livedata migrator data-transfer-agent list -g <ExampleResourceGroup> \
--migrator-name <ExampleMigrator>  -o table

Show Data Transfer Agent with the Azure CLI

To check the status of data transferring with an agent, use the following command:

az livedata migrator data-transfer-agent show -g <ExampleResourceGroup> --migrator-name <ExampleMigrator> --data-transfer-agent-name <ExampleDataTransferAgent>  

{
  "lastWeekTotalBytes": 20971520,
  "lastDayTotalBytes": 20971520,
  "agentName": "<example_agent_name>"
}

Metrics appear only after the agent begins to transfer data.

If an agent hasn't been used yet to transfer data, you see the following output:

  "error" : 15004,
  "status" : 404,
  "title" : "Data Agent not found",
  "message" : "Data agent with given name not found"

Set Bandwidth Policy with the Azure CLI

az livedata migrator data-transfer-agent set-bandwidth-policy -g <ExampleResourceGroup> \
--migrator-name <ExampleMigrator> --data-transfer-agent-name <ExampleDataTransferAgent> \
--limit 2GB

Reset Bandwidth Policy with the Azure CLI

az livedata migrator data-transfer-agent reset-bandwidth-policy -g <ExampleResourceGroup> \
 --migrator-name <ExampleMigrator> --data-transfer-agent-name <ExampleDataTransferAgent>

Learn more

Configure data transfer agent properties
Troubleshooting