This cmdlet will create a migration session and initialize it. The initialization will configure
migration settings at session level. If no specific setting parameters are defined, default settings
will be used. After a session is registered, the user can add a migration task to the migration
session and start migration.
By default, this is set to On. If no User mapping file is provided by the user, then Azure Active
Directory is used as the default for user mapping or map by login name on sp2010.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CustomAzureAccessKey
If you use your own Azure storage, you need to set Azure storage account to On, enter your account
and key. You also need to select if you want to enable or disable encryption, and whether temporary
files are deleted when migration is completed.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CustomAzureStorageAccount
The default is Off. If you wish to use your own Azure storage, set this value to On.
If you choose to turn it On, additional fields will appear for you to enter your account and key,
and settings to select if you want to enable or disable encryption. You also need to decide whether
temporary files are deleted when migration is completed.
Note: This feature is supported only for General Purpose storage accounts as General-Purpose
accounts support Azure blobs and queues. This feature is not available for Blob Storage accounts.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DefaultFlowOwnerEmail
The default flow owner name for workflow migration.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DeleteTempFilesWhenMigrationDone
By default, this is set to Off. If you set this value to On, those temporary files in Custom Azure
storage generated during migration will be deleted when the migration is completed. Otherwise, those
temporary files will not be deleted.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DisableNoScriptDuringMigration
By default this is set to On. will allow temporary change customize script status.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DuplicatePageBehavior
Determine the behavior of the page file migration when encountering a page file with the same name
or same id on the target.By default, DuplicatePageBehavior is set to RENAME.
For RENAME, we will keep the conflicted page file on the target and rename the source page file
with a new name.
For OVERWRITE, we will overwrite the conflicted page file on the target using the source page file
For SKIP, we will skip migrating this conflicted page file.
For NO_PAGES_MIGRATION, we will skip all the page files no matter they conflict with the target or
not during the migration.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DuplicatePageBehavior
Determine the behavior of the page file migration when encountering a page file with the same name
or same id on the target.By default, DuplicatePageBehavior is set to RENAME.
For RENAME, we will keep the conflicted page file on the target and rename the source page file
with a new name.
For OVERWRITE, we will overwrite the conflicted page file on the target using the source page file
For SKIP, we will skip migrating this conflicted page file.
For NO_PAGES_MIGRATION, we will skip all the page files no matter they conflict with the target or
not during the migration.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EnableEncryption
The default is set to On. If you use your own Azure storage, you will set and define your account
and key, and decide and configure enable or disable encryption in settings, and whether temporary
files are deleted when migration is completed.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EnableMultiRound
The default setting is Off. This means the migration will only do one check round to make sure no
new changes or additions were made since the previous run. If it is set to On, it will do up to 5
check round to make sure no changes or additions were made.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Force
Forcibly stop and unregister existing migration.
Note: If you have a registered SPMT migration session already, the Force parameter will register a
new session anyway.The Force parameter performs the function of Stop-SMPTMigration and
Unregister-SPMTMigration together. If you have never run "Register-SPMTMigration", with or without
the Force parameter, a new session will be created.
If you have an active migration and didn't use the Force parameter, you need to run
Stop-SPMTMigration, and then run Unregister-SPMTMigration to unregister the exiting migration
session first.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-HandleUnspportedWorkflowActions
The value should be Stop or Continue.
Default value is Stop.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-IgnoreUpdate
The default setting is OFF.
Skip the checking and installation of new updates, even when a new version of PowerShell SPMT is
available.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-IncludeHiddenFiles
If set to true, hidden system files will be migrated. By default, it is set to true.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-KeepAllVersions
The default is set to On. If set to On, all version numbers of the file will be migrated.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-LookupReferencePolicy
The look up reference in list setting. Default is to migrate all referenced lists. Values can be 0,
1, 2, corresponding to FIND_ALL_REFERENCE,SKIP_AND_CONTINUE or DO_NOT_MIGRATE.
The default setting is Off. If set to On, all the site fields and content types will be migrated.
Otherwise, only those fields and content types used by lists to be migrated will be migrated.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MigrateFilesCreatedAfter
If you choose to limit which files are to be migrated based on creation dates, set your values in
this section. This may be to limit the number of files migrated or to adhere to overall company
governance policy regarding to file retention. The default value is null.
Parameter properties
Type:
System.DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MigrateFilesModifiedAfter
If you choose to limit what files are to be migrated based on modified dates, set your values in
this section. This may be to limit the number of files migrated or to adhere to overall company
governance policy regarding to file retention. The default value is null.
Parameter properties
Type:
System.DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MigrateFileVersionHistory
If set to No, only the most recent versions of the file will be migrated. If set to Yes, you can
choose whether to keep all versions, or limit it to a specific number. By default, it is set to On.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MigrateNavigation
By default this is set to On. We will migrate the site and web navigation nodes when doing the
migration.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MigrateSiteSettings
Migrate site setting. Default is to preserver all settings. Values can be PRESERVE_ALL_SETTINGS,
PRESERVE_ALL_BUT_SKIP_TITLE_LOGO, ONLY_TITLE_LOGO, SKIP_ALL_SETTINGS.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MigrateTermGroups
By default this is set to On. We will migrate the term groups when doing the migration.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MigrateWithoutRootFolder
In file share migrations, use this parameter to migrate only the root folder's contents to the
target.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MigrationType
Migration Type. The value can be WORKFLOW or CONTENT. Default value is CONTENT
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-NumberOfVersionToMigrate
You can choose a specific version number for the files to be migrated. By default, the number of
versions kept is 10.
Parameter properties
Type:
System.Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-PreservePermissionInheritance
Keep subsite and list level permission inheritance. By default, it is true.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-PreserveUserPermissionsForFileShare
By default, this is set to Off. If set to On, permissions will be preserved.
Parameter properties
Type:
Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-PreserveUserPermissionsForSharePointSource
By default, this is set to On. If set to Off, no permissions will be preserved.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ReplacementOfInvalidChar
The replacement of invalid characters in filename/path.
There is no default value.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ScanOnly
The default is Off. When ScanOnly is On, only a scan will be performed. If you wish to scan migrated
items as a pre-assessment to migration, turn it On.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SkipContentTypesWithName
To prevent certain content types from migrating, list each content type name, separating it with a
semicolon. The default value is null.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SkipFilesWithExtension
To prevent certain file types from migrating, list each extension, separate them with colons. The
default value is null.
Parameter properties
Type:
System.Collections.Generic.List`1[System.String]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SkipListsWithName
To prevent certain lists from migrating, list each list name, separating it with a semicolon. The
default value is null.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SkipListWithAudienceTargetingEnabled
By default, this is set to On. Lists with an audience field, the migration will fail with warning
"Does not support list with audience settings' unless customer enable the 'Ignore audience' setting.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SkipSitesWithName
To prevent certain sites from migrating, list each site name, separating it with a semicolon. The
default value is null.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SPOCredential
The credentials are used to connect the SharePoint Online tenant. If no credentials are passed in,
use ADAL OAuth2. Important: If you are using multifactor authentication on your tenant, do not use
the -SPOCredential parameter. The ADAL dialog will prompt for authentication and MFA.
Parameter properties
Type:
System.Management.Automation.PSCredential
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-StartMigrationAutomaticallyWhenNoScanIssue
By default, this is set to On. When StartMigrationAutomaticallyWhenNoScanIssue is turned on, it
means to start migration automatically if no scan issue.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-UseCustomAzureStorage
If you use your own Azure storage, you will set your account and key, and select if you want to
enable or disable encryption, and whether temporary files are deleted when migration is completed.
Parameter properties
Type:
System.Boolean
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-UserMappingFile
By default, Microsoft Entra lookup is used to map users when submitting migration jobs. If you
choose to use a custom user mapping file and you want to preserve user permissions, turn off
Microsoft Entra lookup.By doing so, if a user isn't found in the mapping file, the tool won't look
it up in Microsoft Entra ID.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WorkingFolder
By default, a temp folder will be created as working folder. If you wish to specify your own
specific working folder, enter the name here. Note: By default, the working folder is
%appdata%\Microsoft\MigrationToolStorage.Please make sure that your working folder has a minimum of
150 GB of free space.It may need more depending on the size of the data you plan to migrate.
Parameter properties
Type:
System.String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
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.
Feedback
Was this page helpful?
No
Need help with this topic?
Want to try using Ask Learn to clarify or guide you through this topic?