Using the SharePoint Migration Tool

The SharePoint Migration Tool (SPMT) is a tool that migrates your files from SharePoint on-premises document libraries or regular file shares and easily copies them to your SharePoint Online tenant. It is available to all Office 365 users.

Note

To install the current release download here: SharePoint Migration Tool.

Before you begin

Review the system requirements, settings, and permissions behavior before beginning your migration.

Allow or prevent Custom Script (NoScript)

In Office 365 tenants you can control whether users can run custom script on personal sites and self-service created sites.

During migration, some web parts require this setting set to allow. Otherwise, the web part will not be migrated.

At least 24 hours before you start migration, do the following:

  1. From the SharePoint Admin Center, select Settings.
  2. Scroll down to "Custom Script".
  3. Select both of the following:
    Allow users to run custom script on personal sites
    Allow users to run customer script on self-service created sites

Leave these settings in place for the duration of your migration.

Note

Changes to this setting might take up to 24 hours to take effect.

For more information, see: Allow or prevent custom script

Note about logging in

When you first launch the SharePoint Migration Tool (SPMT), you will be prompted for your Office 365 username and password. The Office 365 credentials you provide will be to the migration destination.

Authentication supported

SPMT supports the following authentication methods:

  • NTLM
  • Kerberos
  • Forms
  • ADFS
  • Multi-factor authentication
  • SAML based claims
  • Client certificate authentication

Important

If the on-premesis server is configured to support multiple authentication providers,including Windows authentication, then Windows authentication will not be supported. If this describes your environment, use other authentication methods instead of Windows authentication.

Where is your data currently located?

Before you start using the SharePoint Migration Tool (SPMT), note where your data is located and where you want those files located after migration. You will be prompted for the current location of your data files and the location of the SharePoint Online site collection where you want them copied. The SharePoint Migration Tool lets you select from two sources from which to migrate your data: from an on-premises SharePoint Server 2010 or 2013 site or from a local file share or network path.

  • SharePoint on-premises: If you select the SharePoint on-premises option, you will be asked to enter the name of the SharePoint Server site where your files are located and prompted for your credentials for that site. You will indicate what document library you wish to migrate.

    Note

    The SharePoint Migration Tool supports SharePoint Server 2010* and 2013. **Support for 2010 is currently in Public Preview release.

  • File share: If you select the file share option, you will be asked to enter the location of the file share, the URL of the SharePoint Online site, and the document library where they will be copied. The files are not deleted from the source.

Using the SharePoint Migration tool

To install the current release download here: SharePoint Migration Tool Version 2

Migrating data files from SharePoint Server document libraries

  1. Start the SharePoint Migration Tool, then enter your Office 365 username and password.

  2. Select Start your first migration.

  3. Select SharePoint Server.

  4. Enter the SharePoint Server site URL where your content is located. Click Next.

    Important

    Proxy connections are not supported. Using Proxy connections will yield errors such as "SharePoint login fail" or "cannot load document library".

  5. Enter your username and password to the SharePoint Server site; username must use the format of someone@example.com. Click Sign in.

    Note

    If you have already signed in to that site once while using this tool, you won't be prompted again for the same site.

  6. Choose the document library where your files are located. The drop-down list will contain all your possible choices.

  7. Enter the URL of the SharePoint Online site where you want your files migrated.

  8. Select the document library to where your files will be copied.

  9. Click Add. This task will be added to the list. If you want to select another set of data files to migrate, click Add a source.

Migrating data files from a local file share

  1. Start the SharePoint Migration Tool, then enter your Office 365 username and password.

  2. Select Start your first migration.

  3. Select File Share.

  4. Enter the source path of the file share where your content is located. Click Next.

  5. Enter the URL of the SharePoint Online site where you want your files migrated. Click Next.

    Note

    If you have already signed in to that site once while using this tool, you won't be prompted again for the same site.

  6. Choose the document library to where your files will be copied. Click Next.

  7. This task will be added to the list. If you want to select another set of data files to migrate, click Add another source.

  8. When you have finished selecting your sources, click Next.

  9. Review your settings. Then click Migrate.

To use a JSON or CSV file for bulk migration

If you have many sources to migrate, you can use either a JSON or CSV file to do a bulk migration. To learn more on how to create a JSON or CSV file for data content migration, see How to format your JSON or CSV file for data content migration.

  1. Start the SharePoint Migration Tool, then enter your Office 365 username and password.

  2. Select Start your first migration.

  3. Select JSON or CSV file for bulk migration.

  4. Enter the full path of your .CSV or .JSON filewhere your content is located. Click Add.

  5. Enter the URL of the SharePoint Online site where you want your files migrated. Click Next.

    Note

    If you have already signed in to that site once while using this tool, you won't be prompted again for the same site.

  6. Select JSON or CSV file for bulk migration. Enter the location of your file, or click Choose File to locate it. Click Add.

If you are migrating files from an on-premises SharePoint Server, you will be prompted for your username and password for that site unless you provided those credentials in previous steps.

Any errors in your file it will be detected on a line-by-line basis. The error will indicate which line or lines contains the errors. You will not be able to proceed until you correct the errors in your file.

Important

Proxy connections are not supported. Using Proxy connections will yield errors such as "SharePoint login fail" or "cannot load document library".

  1. If you want to select another set of data files to migrate, click Add a source. Otherwise, click Next.

  2. Review your settings. Then click Migrate.

Monitoring and reporting status of migration jobs

After you click Migrate, the progress of your migration jobs will be displayed. As they complete, you can view either detailed or summary reports of an individual job or a single summary report that includes all migration jobs submitted during this session. To learn more, see: Using the SharePoint Migration Tool Reports.

Resuming migration jobs

If you need to close the migration tool before a submitted job has completed, you can restart the tool from any computer.

Note

To resume a submitted migration job, it has to have been running at least 5 minutes. It will be paused at the point you closed the SharePoint Online Migration Tool. If your submitted job was running less than 5 minutes before the tool closed, you must resubmit the job.
To resume migration jobs

  1. Launch the SharePoint Migration Tool. Click Sign In using the same Office 365 username and password you used when you originally submitted the job.

  2. After you sign in, a screen displays any paused migrations, providing details about what has been completed and what remains.

  3. If you want to add additional migration tasks, click Select new sources and destinations. Otherwise, click Next. Your migration jobs will be resumed. If you are migrating files from an on-premises SharePoint Server, you will be prompted for your username and password for that site.

Incremental migration

After a migration task has completed, it can also be saved to be rerun at a later date, allowing you to copy only those new or updated files in the source location.

Note

If you wish to make changes to this setting, do so before your initial migration job is submitted. This setting is global; it will apply to all subsequent tasks you submit.

When this setting is on, an incremental check of the SharePoint Online target environment will be performed. Files will be evaluated as follows:

Status Result
Modified time of the source file is earlier than the modified time of the target file.
File will not be migrated.
Files or lists exist in the SPO target location.
Migration will skip those existing objects during scan.
Time stamp on files or object in the source location is newer in the source
The newer files will be migrated.
Source is a file share.
Validation for migration will be based on the file/folder path.
Source is an on-premises SharePoint Server/
Validation for migration will be based on list item GUID. Use the folder path as a fallback.

Availability

Note

Currently the SharePoint Migration Tool is not available for users of Office 365 operated by 21Vianet in China.
It is also not available for users of Office 365 with the German cloud with the data trustee, German Telekom. However, it is supported for users in Germany whose data location is not in the German datacenter.

Introducing the SharePoint Migration Tool

How the SharePoint Migration Tool works

How to format your JSON or CSV file for data content migration

Create a user mapping file for data content migration

SharePoint Online and OneDrive Migration Speed

SharePoint Migration Tool Feedback and Support Forum