| Author | Chrissy LeMaire (@cl), netnerds.net |
| Availability | Windows, Linux, macOS |
Aliases : Start-SqlMigration
Want to see the source code for this command? Check out Start-DbaMigration on GitHub.
Want to see the Bill Of Health for this command? Check out Start-DbaMigration.
Migrates SQL Server ALL databases, logins, database mail profiles/accounts, credentials, SQL Agent objects, linked servers, Central Management Server objects, server configuration settings (sp_configure), user objects in systems databases, system triggers and backup devices from one SQL Server to another.
For more granular control, please use Exclude or use the other functions available within the dbatools module.
Start-DbaMigration consolidates most of the migration tools in dbatools into one command. This is useful when you're looking to migrate entire instances. It less flexible than using the underlying functions. Think of it as an easy button. It migrates:
All user databases to exclude support databases such as ReportServerTempDB (Use -IncludeSupportDbs for this). Use -Exclude Databases to skip.
All logins. Use -Exclude Logins to skip.
All database mail objects. Use -Exclude DatabaseMail
All credentials. Use -Exclude Credentials to skip.
All objects within the Job Server (SQL Agent). Use -Exclude AgentServer to skip.
All linked servers. Use -Exclude LinkedServers to skip.
All groups and servers within Central Management Server. Use -Exclude CentralManagementServer to skip.
All SQL Server configuration objects (everything in sp_configure). Use -Exclude SpConfigure to skip.
All user objects in system databases. Use -Exclude SysDbUserObjects to skip.
All system triggers. Use -Exclude SystemTriggers to skip.
All system backup devices. Use -Exclude BackupDevices to skip.
All Audits. Use -Exclude Audits to skip.
All Endpoints. Use -Exclude Endpoints to skip.
All Extended Events. Use -Exclude ExtendedEvents to skip.
All Policy Management objects. Use -Exclude PolicyManagement to skip.
All Resource Governor objects. Use -Exclude ResourceGovernor to skip.
All Server Audit Specifications. Use -Exclude ServerAuditSpecifications to skip.
All Custom Errors (User Defined Messages). Use -Exclude CustomErrors to skip.
All Data Collector collection sets. Does not configure the server. Use -Exclude DataCollector to skip.
All startup procedures. Use -Exclude StartupProcedures to skip.
This script provides the ability to migrate databases using detach/copy/attach or backup/restore. SQL Server logins, including passwords, SID and database/server roles can also be migrated. In addition, job server objects can be migrated and server configuration settings can be exported or migrated. This script works with named instances, clusters and SQL Express.
By default, databases will be migrated to the destination SQL Server's default data and log directories. You can override this by specifying -ReuseSourceFolderStructure. Filestreams and filegroups are also migrated. Safety is emphasized.
Start-DbaMigration
[[-Source] <DbaInstanceParameter>]
[[-Destination] <DbaInstanceParameter[]>]
[-DetachAttach]
[-Reattach]
[-BackupRestore]
[[-SharedPath] <String>]
[-WithReplace]
[-NoRecovery]
[-SetSourceReadOnly]
[-ReuseSourceFolderStructure]
[-IncludeSupportDbs]
[[-SourceSqlCredential] <PSCredential>]
[[-DestinationSqlCredential] <PSCredential>]
[[-Exclude] <String[]>]
[-DisableJobsOnDestination]
[-DisableJobsOnSource]
[-ExcludeSaRename]
[-UseLastBackup]
[-KeepCDC]
[-KeepReplication]
[-Continue]
[-Force]
[[-AzureCredential] <String>]
[[-MasterKeyPassword] <SecureString>]
[-EnableException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PS C:\> Start-DbaMigration -Source sqlserver\instance -Destination sqlcluster -DetachAttach
All databases, logins, job objects and sp_configure options will be migrated from sqlserver\instance to sqlcluster. Databases will be migrated using the detach/copy files/attach method. Dbowner will
be updated. User passwords, SIDs, database roles and server roles will be migrated along with the login.
PS C:\> $params = @{
>> Source = "sqlcluster"
>> Destination = "sql2016"
>> SourceSqlCredential = $scred
>> DestinationSqlCredential = $cred
>> SharedPath = "\\fileserver\share\sqlbackups\Migration"
>> BackupRestore = $true
>> ReuseSourceFolderStructure = $true
>> Force = $true
>> }
>>
PS C:\> Start-DbaMigration @params -Verbose
Utilizes splatting technique to set all the needed parameters. This will migrate databases using the backup/restore method. It will also include migration of the logins, database mail configuration,
credentials, SQL Agent, Central Management Server, and SQL Server global configuration.
PS C:\> Start-DbaMigration -Verbose -Source sqlcluster -Destination sql2016 -DetachAttach -Reattach -SetSourceReadonly
Migrates databases using detach/copy/attach. Reattach at source and set source databases read-only. Also migrates everything else.
PS C:\> $PSDefaultParameters = @{
>> "dbatools:Source" = "sqlcluster"
>> "dbatools:Destination" = "sql2016"
>> }
>>
PS C:\> Start-DbaMigration -Verbose -Exclude Databases, Logins
Utilizes the PSDefaultParameterValues system variable, and sets the Source and Destination parameters for any function in the module that has those parameter names. This prevents the need from
passing them in constantly.
The execution of the function will migrate everything but logins and databases.
Source SQL Server.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Destination SQL Server. You may specify multiple servers.
Note that when using -BackupRestore with multiple servers, the backup will only be performed once and backups will be deleted at the end.
When using -DetachAttach with multiple servers, -Reattach must be specified.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
If this switch is enabled, the the detach/copy/attach method is used to perform database migrations. No files are deleted on Source. If the destination attachment fails, the source database will be
reattached. File copies are performed over administrative shares (\server\x$\mssql) using BITS. If a database is being mirrored, the mirror will be broken prior to migration.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, all databases are reattached to Source after a DetachAttach migration is complete.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, the Copy-Only backup and restore method is used to perform database migrations. You must specify -SharedPath with a valid UNC format as well (\server\share).
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Specifies the network location for the backup files. The SQL Server service accounts on both Source and Destination must have read/write permission to access this location.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
If this switch is enabled, databases are restored from backup using WITH REPLACE. This is useful if you want to stage some complex file paths.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, databases will be left in the No Recovery state to enable further backups to be added.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, all migrated databases will be set to ReadOnly on the source instance prior to detach/attach & backup/restore. If -Reattach is specified, the database is set to read-only
after reattaching.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, the data and log directory structures on Source will be kept on Destination. Otherwise, databases will be migrated to Destination's default data and log directories.
Consider this if you're migrating between different versions and use part of Microsoft's default SQL structure (MSSQL12.INSTANCE, etc.).
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, the ReportServer, ReportServerTempDb, SSIDb, and distribution databases will be migrated if they exist. A logfile named $SOURCE-$DESTINATION-$date-Sqls.csv will be written
to the current directory. Requires -BackupRestore or -DetachAttach.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Exclude one or more objects to migrate
Databases
Logins
AgentServer
Credentials
LinkedServers
SpConfigure
CentralManagementServer
DatabaseMail
SysDbUserObjects
SystemTriggers
BackupDevices
Audits
Endpoints
ExtendedEvents
PolicyManagement
ResourceGovernor
ServerAuditSpecifications
CustomErrors
DataCollector
StartupProcedures
AgentServerProperties
MasterCertificates
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | |
| Accepted Values | Databases,Logins,AgentServer,Credentials,LinkedServers,SpConfigure,CentralManagementServer,DatabaseMail,SysDbUserObjects,SystemTriggers,BackupDevices,Audits,Endpoints,ExtendedEvents,PolicyManagement,ResourceGovernor,ServerAuditSpecifications,CustomErrors,DataCollector,StartupProcedures,AgentServerProperties,MasterCertificates |
If this switch is enabled, migrated SQL Agent jobs will be disabled on the destination instance.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, SQL Agent jobs will be disabled on the source instance.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, the sa account will not be renamed on the destination instance to match the source.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Use the last full, diff and logs instead of performing backups. Note that the backups must exist in a location accessible by all destination servers, such a network share.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Indicates whether CDC information should be copied as part of the database
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Indicates whether replication configuration should be copied as part of the database copy operation
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If specified, will to attempt to restore transaction log backups on top of existing database(s) in Recovering or Standby states. Only usable with -UseLastBackup
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If migrating users, forces drop and recreate of SQL and Windows logins.
If migrating databases, deletes existing databases with matching names.
If using -DetachAttach, -Force will break mirrors and drop dbs from Availability Groups.
For other migration objects, it will just drop existing items and readd, if -force is supported within the underlying function.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Name of the AzureCredential if SharedPath is Azure page blob
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
The password to encrypt a master key if one is required. This must be a SecureString.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
| Alias | wi |
| Required | False |
| Pipeline | false |
| Default Value |
If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
| Alias | cf |
| Required | False |
| Pipeline | false |
| Default Value |