Add-SPMTTask

Module:

Microsoft.SharePoint.MigrationTool.PowerShell Module

Add a new migration task to the registered migration session.

Add-SPMTTask
 -FileShareSource <String>
 -TargetSiteUrl <String>
 -TargetList <String>
 [-TargetListRelativePath <String>]
 [-MigrationType <String>]
 [<CommonParameters>]

Add-SPMTTask
 -SharePointSourceSiteUrl <String>
 -SharePointSourceCredential <PSCredential>
 -TargetSiteUrl <String>
 [-MigrateAll]
 [-MigrationType <String>]
 [<CommonParameters>]

Add-SPMTTask
 -SharePointSourceSiteUrl <String>
 -SharePointSourceCredential <PSCredential>
 -SourceList <String>
 -TargetSiteUrl <String>
 -TargetList <String>
 [-SourceListRelativePath <String>]
 [-TargetListRelativePath <String>]
 [-MigrationType <String>]
 [<CommonParameters>]

Add-SPMTTask
 -JsonDefinition <String>
 [-SharePointSourceCredential <PSCredential>]
 [-MigrationType <String>]
 [<CommonParameters>]

Add a new migration task to the registered migration session. Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task.

This example adds one File Share migration task and one SharePoint 2013 migration task to the registered migration session.

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

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

#Define File Share data source#
$FileshareSource = "YourFileShareDataSource"

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

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

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

This example adds a new migration task to the registered migration session. Currently there are three different types of tasks allowed: File Share task, SharePoint task and JSON defined task.

# Code snippets for bulk migration by loading the sample CSV with the name of spmt.csv

$csvItems = import-csv "C:\spmt.csv" -Header c1,c2,c3,c4,c5,c6
ForEach ($item in $csvItems) {
 Write-Host $item.c1
 Add-SPMTTask -FileShareSource $item.c1 -TargetSiteUrl $item.c4 -TargetList $item.c5 -TargetListRelativePath $item.c6
}

# Two migration tasks are defined in the file spmt.csv

D:\MigrationTest\Files\Average_1M\c,,,https://SPOSite.sharepoint.com,Documents,Test
C:\work\Powershell\negative,,,https://SPOSite.sharepoint.com/,Documents,DocLibrary_SubfolderName

# Code snippets for bulk migration by loading one JSON file:

$jsonItems = Get-Content -Raw -Path "C:\spmt.json" | ConvertFrom-Json
ForEach ($taskItem in $jsonItems.Tasks) {
 $jsonString = ConvertTo-Json $taskItem -Depth 100
 Add-SPMTTask -JsonDefinition $jsonString -SharePointSourceCredential $onpremCredential
}

// Three migration tasks are defined in the file spmt.json.
{
 "Tasks":[
 {
 "SourcePath":"https://On-prem/sites/test",
 "TargetPath":"https://YourSPO.sharepoint.com",
 "Items":{
 "Lists":[
 {
 "SourceList":"list-01",
 "TargetList":"list-01"
 }
 ],
 "SubSites":[

 ]
 }
 },
 {
 "SourcePath":"https://On-prem/sites/test",
 "TargetPath":"https://YourSPO.sharepoint.com",
 "Items":{
 "Lists":[
 {
 "SourceList":"list-02",
 "TargetList":"list-02"
 }
 ],
 "SubSites":[

 ]
 }
 },
 {
 "SourcePath":"https://On-prem/sites/test",
 "TargetPath":"https://YourSPO.sharepoint.com",
 "Items":{
 "Lists":[
 {
 "SourceList":"doclib-01",
 "TargetList":"doclib-01"
 }
 ],
 "SubSites":[

 ]
 }
 }
 ]
}

This is a Json sample for File Share migration.

{
 "SourcePath":"\\LocalOrFileShareDataSource",
 "TargetPath":"https://YourTargetSite",
 "TargetList":"Documents",
 "TargetListRelativePath":"subfolder"
}

// Json sample for SharePoint migration(lists only):
{
 "SourcePath":"https://YourOnPremSite",
 "TargetPath":"https://YourTargetSite",
 "Items":{
 "Lists":[
 {
 "SourceList":"sourceListName",
 "TargetList":"targetListName"
 }
 ]
 }
}

// Json sample for SharePoint migration(lists and subsites):
{
 "SourcePath":"https://YourOnPremSite",
 "TargetPath":"https://YourTargetSite",
 "Items":{
 "Lists":[
 {
 "SourceList":"listVersion2",
 "TargetList":"ListVersion2"
 },
 {
 "SourceList":"listVersion3",
 "TargetList":"ListVersion3"
 }
 ],
 "SubSites":[
 {
 "SourceSubSitePath":"subSite",
 "TargetSubSitePath":"targetSubSite",
 "Lists":[
 {
 "SourceList":"testSubListB",
 "TargetList":"targetSubList"
 }
 ]
 }
 ]
 }
}

// Json sample for SharePoint migration(whole site):
{
 "SourcePath":"https://YourOnPremSite/subsite2",
 "TargetPath":"https://YourTargetSite/targetSubSite2"
}

// Json sample with task level setting:
{
 "Tasks": [
 {
 "SourcePath": "https://YourOnPremServerSiteURL",
 "TargetPath": "https://YourTargetSiteURL",
 "Items": {
 "Lists": [
 {
 "SourceList": "SourceListName",
 "TargetList": "TargetListName"
 }
 ],
 "SubSites": []
 },
 "Settings": {
 "MigrateFileVersionHistory": true,
 "KeepFileVersions": 100,
 "MigrateHiddenItems": false,
 "MigrateItemsCreatedAfter": "yyyy-MM-dd",
 "MigrateItemsModifiedAfter": "yyyy-MM-dd",
 "SkipFilesWithExtensions": "txt:mp3:OtherFileExtentionsYouwantSkip",
 "EnableAzureDirectoryLookup": false,
 "PreservePermission": true,
 "UseCustomAzureStorage": false,
 "CustomAzureStorageAccount": null,
 "CustomAzureAccessKey": null,
 "CustomAzureDeletionAfterMig": false,
 "UserMappingCSVFile": null,
 "SkipListWithAudienceEnabled": true,
 "EnableIncremental": false,
 "MigrateOneNoteNotebook": true,
 "MigrateAllWebStructures": false,
 "FilterOutPathSpecialCharacters": false
 }
 }
 ]
}

// Note: Datetime format is "yyyy-MM-dd"

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.