Search
Clear search
Close search
Google apps
Main menu

Google Apps is now G Suite. Same service, new name. More about the name change.

Run a migration from the command line with GSMMO

As an alternative to using the G Suite Migration for Microsoft® Outlook (GSMMO) wizard, you can run a migration using the command line tool. You can import your own data (use the user-only arguments). Or administrators can migrate data on behalf of a user by using the administrator-only arguments.

Run your migration using the arguments and parameters shown below. Precede each argument by a double dash (--), and enclose all parameters in double quotes. Enter the command on a single line.

Here's an example:

ClientMigration.exe --nouse_gui --profile_name="outlook-profile-name"
--google_email="google-user-email"
--service_account_json_path="C:\Users\admin\privatekey.json"
--email_migration_start_date="2010-02-15"
 
For this argument... Supply this parameter Description
--help No parameter required. Displays a list of the arguments for ClientMigration.exe.
--crash_reporting No parameter required. Automatic crash reports will be submitted to Google. See Send crash reports for GSMMO for more info.
--email_migration_start_date Date in YYYY-MM-DD format. All messages before this date are excluded from migration.
--email_migration_end_date Date in YYYY-MM-DD format. All messages after this date are excluded from migration.
--exclude_top_level_folders Comma-separated list of top-level folders to exclude. Specifies top-level folders to exclude from migration.
--force_restart No parameter required. Reruns the migration from the beginning rather than from the last point of failure.
--google_email Email address of G Suite user to whom data is migrated. Required.
--migrate_deleted No parameter required. Migrates messages in the Deleted items folder.
--migrate_junk No parameter required. Migrates messages in the Junk email folder.
--nocrash_reporting No parameter required. Automatic crash reports will not be submitted to Google. See Send crash reports for GSMMO for more info.
--noenable_calendar_migration No parameter required. Runs the migration without including calendar data.
--noenable_contact_migration No parameter required. Runs the migration without including contact data.
--noenable_email_migration No parameter required. Runs the migration without including email data.
--noenable_label_prefix No parameter required. Applies when migrating mail from PST files. Does not include the PST file name as a prefix in Gmail labels created for messages migrated from Outlook folders.
--nouse_gui No parameter required. Runs the utility via the command line. GUI mode is default.
--nowait No parameter required. Closes the tool without waiting for the Enter key when run from the command line.
--profile_name Microsoft Outlook profile from which data is migrated. Required unless you use the pst_file_names argument (see below).
--pst_file_names List of fully qualified PST file names from which data is migrated, separated by "|". Required unless you use the profile_name argument (see above).
--service_account_json_path The path to the Service Account credentials file. For instructions on how to obtain this file, see "Configure G Suite" in the G Suite Migration for Microsoft Exchange Admin Guide.
Was this article helpful?
How can we improve it?
Sign in to your account

Get account-specific help by signing in with your G Suite account email address, or learn how to get started with G Suite.