Install the node servers

Nodes are servers that perform the scanning or migrating actions of the partitions. They help balance the migration work across available servers. The number of node servers you should deploy depends on the number of users in your organization and the amount of data that you want to migrate.

Expand all  |  Collapse all

Step 1: Consider how many node servers you need

Cloud-based data sources
SharePoint data Amount of data Recommended number of node servers
Files only   20

*Additional nodes are unlikely to improve performance.

Files & file permissions Fewer than 10 million items 20
Files & file permissions More than 10 million items 40

*Don't set up multiple clusters with different SharePoint credentials. Due to API quota limits and capabilities of the MySQL server, it won't enhance performance.

Other data sources (Number of users)    
Less than 100 users Fewer than 1 million items 20
100–5,000 users 1–5 million items 40
More than 5,000 users More than 5 million items 40

*To increase migration speed, create multiple clusters of 40 nodes during the migration phase.

On-premises data sources

We recommend that you start with half of the number of node servers recommended in the table above and monitor the load on your source servers.

Add extra nodes if there are resources available to sustain them. To check the resources, run a test migration and add 5 nodes at each step. Monitor the following critical performance counters to ensure that the servers don’t exceed acceptable thresholds: 

Stop adding nodes if:

  • Performance counters of the majority of on-premises servers are exceeding acceptable thresholds.
  • Bridges aren’t completing at a faster rate than before. 

Step 2: Prepare servers

  • Ensure the Microsoft Windows server that you plan to install the Google Workspace Migrate node has sufficient space. For details, go to System requirements.
  • Keep your Windows server updated, but we recommend turning off automatic updates during a migration so the process isn't interrupted.
  • Copy GoogleWorkspaceMigrate_Node_Installer to the Windows servers where you plan to install each node.
  • We recommend that you follow Microsoft's guidance for noncritical service recovery settings.

Step 3: Install the node servers

Install the nodes manually

On the Windows server for the node:

  1. Run GoogleWorkspaceMigrate_Node_Installer as an administrator.
  2. Select a language for the installer and click OK.
  3. Accept the license agreement and click Next.
  4. Choose where to install the Google Workspace Migrate node and click Next.
  5. Choose a start menu folder and click Next.
  6. Select the additional shortcut options and click Next.
  7. Enter a port number or accept the default port 5131 and click Next.
  8. Enter an access key. The platform uses the access key to connect to the node.

    Important: You need the access key to associate the node with the platform. So record and keep it in a secure place

  9. Review the installation and click Install.
  10. Click Next and then Install.
  11. After installation, click Finish.
  12. Repeat these steps for each node server you want to install. See above for details on how many node servers you need.

Tip: If you use Google Compute Engine, you can easily add additional node servers by cloning the machine. You should clone the machine at this point (when a node has been installed but before the nodes are associated).

Install nodes using the command line

When you install from the command line, the installer automatically chooses these setup options:

  • Google Workspace Migrate install location (C:\Program Files\Google Workspace Migrate).
  • Start menu folder (Google Workspace Migrate).
  • Desktop shortcut created for all users.
  • Google Workspace Migrate management app automatically opens when Windows starts.

On the Windows server for the node:

  1. Run Microsoft PowerShell as an administrator.
  2. Enter GoogleWorkspaceMigrate_Node_Installer_version-number.exe and any optional parameters (details below).


    GoogleWorkspaceMigrate_Node_Installer_version-number.exe /ACCESSKEY=access-key /NORESTART /SP- /SUPPRESSMSGBOXES /VERYSILENT

  3. Enter Start-Service -Name AppBridge.Local.ServiceNode to start the Google Workspace Migrate node service.
  4. From the Start menu, open the Google Workspace Migrate management app. Alternatively, let the app reopen automatically when you restart Windows.

Optional command-line parameters

For more details on the command-line parameters available, consult the documentation for Inno Setup.

Parameter Description

Access key string

Important: You need the access key to associate the node with the platform. So record and keep it in a secure place.


File name of the log file

Creates a log file with output from the installer. If the installer doesn’t work as expected, you can view the log file for information.

/NORESTART Prevents a system restart during installation
/PORT Port number for the Google Workspace Migrate service (the default is 5131)
/SP- Turns off prompts at the beginning of a setup
/SUPPRESSMSGBOXES Suppresses all message boxes

Turns off the setup wizard and windows during the installation process

Next step

Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.

Clear search
Close search
Google apps
Main menu