Install the node servers

Nodes are servers that perform the scanning or migrating actions of the partitions. Adding nodes helps balance the migration work across available servers. 

If a node becomes inoperable and its partition is incomplete, the partition rejoins the queue. Another node picks up the partition and completes the task. If this occurs, you'll see it noted in the execution log.

Before you begin

First, consider how many node servers you require (see below). Also:

  • Ensure the Microsoft Windows server you plan to install the Google Workspace Migrate node has sufficient space. For details, see System requirements
  • Copy GoogleWorkspaceMigrate_Node_Installer that you downloaded in the previous step, to the Windows servers where you plan to install each node. 
  • Disable Windows automatic updates on the server.

Finally, we recommend that you follow Microsoft's guidance for noncritical service recovery settings.

How many node servers do I need?

The number of node servers you should deploy depends on the number of users in your organization and the amount of data you want to migrate. In general, deploying more node servers results in faster migrations. Use the following table for guidance.

Note: Once you start the migration, you should not decommission any node servers, even when it looks like the nodes are not currently involved in migration tasks. 

Number of users Amount of data Recommended number
of node servers
Less than 1,000   10
1,000–4,999 Fewer than 1 million files 20
5,000–10,000 1–5 million files 40
More than 10,000 More than 5 million files 40*

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

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: Record the access key and keep it in a secure place. You'll need it later when you associate the node with the platform.

  9. Review the installation and click Install.
  10. Click Next, then Install.
  11. After installation, click Finish.
  12. Repeat these steps for each node server you want to install. See below 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 interface

To install the node: 

  1. On the Windows server for the node, run PowerShell as administrator. 
  2. Run the node installer using the parameters from the tables below.

    Note: The installer automatically chooses the preselected setup options (below).

  3. After installation, enter the Start-Service -Name AppBridge.Local.ServiceHost command to start the Google Workspace Migrate node service.
  4. Open the Google Workspace Migrate management app from the Start menu. Alternatively, let the app reopen automatically when you restart Windows.

Preselected setup options

When running on 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

Command-line parameters

Parameter Description
/Port (Optional) Port number for the Google Workspace Migrate  service (the default is 5131).

(Optional) 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.


To use the installer noninteractively, use the following command-line parameters:

Parameter Description
/SP- Turns off prompts at the beginning of a setup.

Turns off the setup wizard and windows during the installation process.

/SUPPRESSMSGBOXES Suppresses all message boxes.
/NORESTART Prevents a system restart during installation.

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


Install or upgrade the node:

GoogleWorkspaceMigrate_Node_Installer_version-number.exe /SP- /SILENT /SUPPRESSMSGBOXES /NORESTART

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.