Edit

Share via

Get-SPMTMigration

  • Reference
Module:
SharePointMigrationTool
Applies to:
SharePoint Migration Tool

Return the object of current session. It includes current tasks status and current session level settings.

The status of current tasks includes:

  1. Count of scanned files
  2. Count of migrated files
  3. Migration error message if there is any.

Syntax

Get-SPMTMigration []

Description

Return object of current session. It includes current tasks status and current session level settings.

Examples

EXAMPLE 1

#Define SharePoint 2013 data source#
$Global:SourceSiteUrl = "https://YourOnPremSite/"
$Global:OnPremUserName = "Yourcomputer\administrator"
$Global:OnPremPassword = ConvertTo-SecureString -String "OnPremPassword" -AsPlainText -Force
$Global:SPCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:OnPremUserName, $Global:OnPremPassword
$Global:SourceListName = "SourceListName"


#Define SPO target#
$Global:SPOUrl = "https://contoso.sharepoint.com"
$Global:UserName = "admin@contoso.onmicrosoft.com"
$Global:PassWord = ConvertTo-SecureString -String "YourSPOPassword" -AsPlainText -Force
$Global:SPOCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $Global:UserName, $Global:PassWord
$Global:TargetListName = "TargetListName"

#Define Fileshare data source#
$Global:FileshareSource = "YourFileShareDataSource"

#Import SPMT Migration Module#
Import-Module Microsoft.SharePoint.MigrationTool.PowerShell

#Register the SPMT session with SPO credentials#
Register-SPMTMigration -SPOCredential $Global:SPOCredential -Force

#Add two tasks into the session. One is SharePoint migration task, and another is File Share migration task.#
Add-SPMTTask -SharePointSourceCredential $Global:SPCredential -SharePointSourceSiteUrl $Global:SourceSiteUrl  -TargetSiteUrl $Global:SPOUrl -MigrateAll
Add-SPMTTask -FileShareSource $Global:FileshareSource -TargetSiteUrl $Global:SPOUrl -TargetList $Global:TargetListName

#Start migration in the background#
Start-SPMTMigration -NoShow

#Get the object of current migration#
$session = Get-SPMTMigration

This example starts a migration first, and then run "Get-SPMTMigration" to get the object of current migration.