As an administrator, you can run a Google Workspace Migration for Microsoft Outlook (GWMMO) migration using the command line. If you want, your users can import their own data using the command line and certain arguments.
Use the command line to run a migration
- Open a command prompt.
- On a single line, enter:
- ClientMigration.exe
- --profile_name "profile name" (if you're migrating from an Outlook profile) or
--pst_file_names "pst file path" (if you're migrating from PST files).Put the profile name or PST path in double quotation marks and separate multiple PST paths with the pipe character ( | ).
- Any additional arguments and parameters (details below on this page).
Precede each argument by a double dash (--) and enclose all parameters in double quotation marks.
Admin & user arguments
| Argument & description | Parameter (if required) |
|---|---|
--crash_reporting
Submits automatic crash reports to Google. For details, go to Send crash reports for GWMMO. If you don't want to send automatic crash reports, use |
|
--email_migration_end_date
Excludes all messages after a certain date from the migration. |
Date in YYYY-MM-DD format |
--email_migration_start_date
Excludes all messages before a certain date from the migration. |
Date in YYYY-MM-DD format |
--exclude_top_level_folders
Specifies top-level folders to exclude from migration. |
Comma-separated list of top-level folders to exclude |
--force_restart
Remigrates all items, instead of just the items not successfully migrated. |
|
--google_email
Migrates data to a specified Google Workspace user. |
Google Workspace email address |
--help
Displays a list of arguments. |
|
--migrate_deleted
Migrates messages in the Deleted items folder. |
|
--migrate_junk
Migrates messages in the Junk email folder. |
|
--noenable_calendar_migration
Runs the migration without including calendar data. |
|
--noenable_contact_migration
Runs the migration without including contact data. |
|
--noenable_email_migration
Runs the migration without including email data. |
|
--noenable_label_prefix
Use when migrating mail from PST files or Outlook profiles with multiple accounts.
|
|
--nouse_gui
Runs GWMMO without a GUI. |
|
--nowait
Closes GWMMO without waiting for the Enter key. |
|
--profile_name
Specifies that you're migrating from an Outlook profile. Required unless you use the |
Outlook profile you're migrating from |
--pst_file_names
Specifies that you're migrating from a PST file. Required unless you use the |
List of fully qualified PST file paths you're migrating from. Separate filenames with the pipe character |
Examples
The following example migrates all calendars and contacts but only email messages created on or after February 15, 2022. It specifies migrating data from the outlook-profile-name Outlook profile to the [email protected] Google Workspace user account without using the GUI.
ClientMigration.exe --profile_name="outlook-profile-name" --google_email="[email protected]" --nouse_gui --email_migration_start_date="2022-02-15"
The following example migrates only email messages and contacts (not calendars) from the c:\pst\archive1.pst and c:\pst\archive2.pst PST files to the [email protected] Google Workspace user account without using the GUI. When complete, GWMMO closes without waiting for the Enter key.
ClientMigration.exe --pst_file_names="c:\pst\archive1.pst|c:\pst\archive2.pst" --google_email="[email protected]" --noenable_calendar_migration --nouse_gui --nowait
Admin-only argument
| Argument & description | Parameter |
|---|---|
--service_account_json_path
For repeated, unattended migrations Uses a service account to authorize GWMMO |
The path to the service account JSON file To get the path, go to Create a service account. |
Example
The following example migrates all calendars and contacts but only email messages created on or after February 15, 2022. It specifies migrating data from the outlook-profile-name Outlook profile to the [email protected] Google Workspace user account. Instead of prompting the user for access, the migration uses the service account credentials stored in C:\Users\admin\service_account.json.
ClientMigration.exe --profile_name="outlook-profile-name" --google_email="[email protected]" --nouse_gui --email_migration_start_date="2022-02-15" --service_account_json_path="C:\Users\admin\service_account.json"
Related topic
Google Workspace migration product matrix
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.
