functions/Copy-SqlSsisCatalog.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
Function Copy-SqlSsisCatalog
{
<#
.SYNOPSIS
Copy-SqlSsisCatalog migrates Folders, SSIS projects, and environments from one SQL Server to another.
 
.DESCRIPTION
By default, all folders, projects, and environments are copied.
The -Project parameter can be specified to copy only one project, if desired.
The parameters get more granular from the Folder level. i.e. specifying folder will only deploy projects/environments from within that folder.
 
.PARAMETER Source
Source SQL Server.You must have sysadmin access and server version must be SQL Server version 2012 or greater.
 
.PARAMETER Destination
Destination Sql Server. You must have sysadmin access and server version must be SQL Server version 2012 or greater.
 
.PARAMETER Force
Drops and recreates the SSIS Catalog if it exists
 
.PARAMETER Project
Specify a source Project name.
 
.PARAMETER Folder
Specify a source folder name.
 
.PARAMETER Environment
Specify an environment to copy over.
 
.PARAMETER EnableSqlClr
If the destination does not have SQL CLR configuration option enabled (which is required for SSISDB), providing this parameter will skip user prompts for enabling CLR on the destination.
 
.PARAMETER CreateCatalogPassword
If a destination SSISDB catalog needs to be created, specify this secure string parameter to skip password prompts.
 
.PARAMETER WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
 
.PARAMETER Confirm
Prompts you for confirmation before executing any changing operations within the command.
 
.PARAMETER SourceSqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$scred = Get-Credential, this pass $scred object to the param.
 
Windows Authentication will be used if DestinationSqlCredential is not specified. To connect as a different Windows user, run PowerShell as that user.
 
.PARAMETER DestinationSqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$dcred = Get-Credential, this pass this $dcred to the param.
 
Windows Authentication will be used if DestinationSqlCredential is not specified. To connect as a different Windows user, run PowerShell as that user.
 
.NOTES
Original Author: Phil Schwartz (philschwartz.me, @pschwartzzz)
  
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
 
.LINK
https://dbatools.io/Copy-SqlSsisCatalog
  
.EXAMPLE
Copy-SqlSsisCatalog -Source sqlserver2014a -Destination sqlcluster
 
Copies all folders, environments and all ssis Projects from sqlserver2014a to sqlcluster, using Windows credentials. If folders with the same name exist on the destination they will be skipped, but projects will be redeployed.
 
.EXAMPLE
Copy-SqlSsisCatalog -Source sqlserver2014a -Destination sqlcluster -Project Archive_Tables -SourceSqlCredential $cred -Force
 
Copies a single Project, the Archive_Tables Project from sqlserver2014a to sqlcluster, using SQL credentials for sqlserver2014a
and Windows credentials for sqlcluster. If a Project with the same name exists on sqlcluster, it will be deleted and recreated because -Force was used.
 
.EXAMPLE
Copy-SqlSsisCatalog -Source sqlserver2014a -Destination sqlcluster -WhatIf -Force
 
Shows what would happen if the command were executed using force.
 
.EXAMPLE
$SecurePW = Read-Host "Enter password" -AsSecureString
Copy-SqlSsisCatalog -Source sqlserver2014a -Destination sqlcluster -CreateCatalogPassword $SecurePW
 
Deploy entire SSIS catalog to an instance without a destination catalog. Passing -CreateCatalogPassword will bypass any user prompts for creating the destination catalog.
 
#>

[CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $true)]
param (
[parameter(Mandatory = $true)]
[Object]$Source,
[parameter(Mandatory = $true)]
[Object]$Destination,
[System.Management.Automation.PSCredential]$SourceSqlCredential,
[System.Management.Automation.PSCredential]$DestinationSqlCredential,
[String]$Project,
[String]$Folder,
[String]$Environment,
[System.Security.SecureString]$CreateCatalogPassword,
[Switch]$EnableSqlClr,
[Switch]$Force
)

BEGIN
{
Function Get-RemoteIntegrationService
{
param (
[Object]$Computer
)
$result = Get-Service -ComputerName $Computer -Name msdts*
if ($result.Count -gt 0)
{
$running = $false
foreach ($service in $result)
{
if (!$service.Status -eq "Running")
{
Write-Warning "Service $($service.DisplayName) was found on the destination, but is currently not running."
}
else
{
Write-Verbose "Service $($service.DisplayName) was found running on the destination."
$running = $true
}
}
if (!$running)
{
throw "No Integration Services' service was found running on the destination."
}
}
else
{
throw "No Integration Services' service was found on the destination, please ensure the feature is installed and running."
}
}

Function Invoke-ProjectDeployment
{
param (
[String]$Project,
[String]$Folder
)
$sqlConn = New-Object System.Data.SqlClient.SqlConnection
$sqlConn.ConnectionString = $sourceConnection.ConnectionContext.ConnectionString
if ($sqlConn.State -eq "Closed")
{
$sqlConn.Open()
}
try
{
Write-Output "Deploying project $Project from folder $Folder."
$cmd = New-Object System.Data.SqlClient.SqlCommand
$cmd.CommandType = "StoredProcedure"
$cmd.connection = $sqlConn
$cmd.CommandText = "SSISDB.Catalog.get_project"
$cmd.Parameters.Add("@folder_name", $Folder) | out-null;
$cmd.Parameters.Add("@project_name", $Project) | out-null;
[byte[]]$results = $cmd.ExecuteScalar();
if ($results -ne $null)
{
$destFolder = $destinationFolders | Where-Object { $_.Name -eq $Folder }
$deployedProject = $destFolder.DeployProject($Project, $results)
if ($deployedProject.Status -ne "Success")
{
Write-Error "An error occured deploying project $Project."
}
}
else
{
Write-Error "Failed deploying $Project from folder $Folder."
continue
}
}
catch
{
Write-Exception $_
}
finally
{
if ($sqlConn.State -eq "Open")
{
$sqlConn.Close()
}
}
}

Function New-CatalogFolder
{
param (
[String]$Folder,
[String]$Description,
[Switch]$Force
)
if ($Force)
{
$remove = $destinationFolders | Where-Object { $_.Name -eq $Folder }
$envs = $remove.Environments.Name
foreach ($e in $envs)
{
$remove.Environments[$e].Drop()
}
$projs = $remove.Projects.Name
foreach ($p in $projs)
{
$remove.Projects[$p].Drop()
}
$remove.Drop()
$destinationCatalog.Alter()
$destinationCatalog.Refresh()
}
Write-Output "Creating folder $Folder."
$destFolder = New-Object "$ISNamespace.CatalogFolder" ($destinationCatalog, $Folder, $Description)
$destFolder.Create()
$destFolder.Alter()
$destFolder.Refresh()
}

Function New-FolderEnvironment
{
param (
[String]$Folder,
[String]$Environment,
[Switch]$Force
)
$envDestFolder = $destinationFolders | Where-Object { $_.Name -eq $Folder }
if ($force)
{
$envDestFolder.Environments[$Environment].Drop()
$envDestFolder.Alter()
$envDestFolder.Refresh()
}
$srcEnv = ($sourceFolders | Where-Object { $_.Name -eq $Folder }).Environments[$Environment]
$targetEnv = New-Object "$ISNamespace.EnvironmentInfo" ($envDestFolder, $srcEnv.Name, $srcEnv.Description)
foreach ($var in $srcEnv.Variables)
{
if ($var.Value.ToString() -eq "")
{
$finalValue = ""
}
else
{
$finalValue = $var.Value
}
$targetEnv.Variables.Add($var.Name, $var.Type, $finalValue, $var.Sensitive, $var.Description)
}
Write-Output "Creating environment $Environment."
$targetEnv.Create()
$targetEnv.Alter()
$targetEnv.Refresh()
}

Function New-SSISDBCatalog
{
param (
[System.Security.SecureString]$Password
)

if (!$Password)
{
Write-Output "SSISDB Catalog requires a password."
$pass1 = Read-Host "Enter a password" -AsSecureString
$plainTextPass1 = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($pass1))
$pass2 = Read-Host "Re-enter password" -AsSecureString
$plainTextPass2 = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($pass2))
if ($plainTextPass1 -ne $plainTextPass2)
{
throw "Validation error, passwords entered do not match."
}
$plainTextPass = $plainTextPass1
}
else
{
$plainTextPass = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($Password))
}

$catalog = New-Object "$ISNamespace.Catalog" ($destinationSSIS, "SSISDB", $plainTextPass)
$catalog.Create()
$catalog.Refresh()
}

$folder = $psboundparameters.Folder
$project = $psboundparameters.Project
$environment = $psboundparameters.Environment

$ISNamespace = "Microsoft.SqlServer.Management.IntegrationServices"

$sourceConnection = Connect-SqlServer -SqlServer $Source -SqlCredential $SourceSqlCredential
$destinationConnection = Connect-SqlServer -SqlServer $Destination -SqlCredential $DestinationSqlCredential

if ($sourceConnection.versionMajor -lt 11 -or $destinationConnection.versionMajor -lt 11)
{
throw "SSISDB catalog is only available on Sql Server 2012 and above, exiting..."
}

try
{
Get-RemoteIntegrationService -Computer $Destination
}
catch
{
Write-Exception $_
throw "An error occured when checking the destination for Integration Services. Is Integration Services installed?"
}

try
{
Write-Verbose "Connecting to $Source integration services."
$sourceSSIS = New-Object "$ISNamespace.IntegrationServices" $sourceConnection
}
catch
{
Write-Exception $_
throw "There was an error connecting to the source integration services."
}
try
{
Write-Verbose "Connecting to $Destination integration services."
$destinationSSIS = New-Object "$ISNamespace.IntegrationServices" $destinationConnection
}
catch
{
Write-Exception $_
throw "There was an error connecting to the destination integration services."
}

$sourceCatalog = $sourceSSIS.Catalogs | Where-Object { $_.Name -eq "SSISDB" }
$destinationCatalog = $destinationSSIS.Catalogs | Where-Object { $_.Name -eq "SSISDB" }

$sourceFolders = $sourceCatalog.Folders
$destinationFolders = $destinationCatalog.Folders
}
PROCESS
{
if (!$sourceCatalog)
{
throw "The source SSISDB catalog does not exist."
}
if (!$destinationCatalog)
{
if (!$destinationConnection.Configuration.IsSqlClrEnabled.ConfigValue)
{
if ($Pscmdlet.ShouldProcess($Destination, "Enabling SQL CLR configuration option."))
{
If (!$EnableSqlClr)
{
$message = "The destination does not have SQL CLR configuration option enabled (required by SSISDB), would you like to enable it?"
$yes = New-Object System.Management.Automation.Host.ChoiceDescription "&Yes", "Enable SQL CLR on $Destination."
$no = New-Object System.Management.Automation.Host.ChoiceDescription "&No", "Exit."
$options = [System.Management.Automation.Host.ChoiceDescription[]]($yes, $no)
$result = $host.ui.PromptForChoice($null, $message, $options, 0)
switch ($result)
{
0 { continue }
1 { return }
}
}
Write-Verbose "Enabling SQL CLR configuration option at the destination."
if ($destinationConnection.Configuration.ShowAdvancedOptions.ConfigValue -eq $false)
{
$destinationConnection.Configuration.ShowAdvancedOptions.ConfigValue = $true
$changeback = $true
}

$destinationConnection.Configuration.IsSqlClrEnabled.ConfigValue = $true

if ($changeback -eq $true)
{
$destinationConnection.Configuration.ShowAdvancedOptions.ConfigValue = $false
}
$destinationConnection.Configuration.Alter()
}
}
else
{
Write-Verbose "SQL CLR configuration option is already enabled at the destination."
}
if ($Pscmdlet.ShouldProcess($Destination, "Create destination SSISDB Catalog"))
{
if (!$CreateCatalogPassword)
{
$message = "The destination SSISDB catalog does not exist, would you like to create one?"
$yes = New-Object System.Management.Automation.Host.ChoiceDescription "&Yes", "Create an SSISDB catalog on $Destination."
$no = New-Object System.Management.Automation.Host.ChoiceDescription "&No", "Exit."
$options = [System.Management.Automation.Host.ChoiceDescription[]]($yes, $no)
$result = $host.ui.PromptForChoice($null, $message, $options, 0)
switch ($result)
{
0 { New-SSISDBCatalog }
1 { return }
}
}
else
{
New-SSISDBCatalog -Password $CreateCatalogPassword
}

$destinationSSIS.Refresh()
$destinationCatalog = $destinationSSIS.Catalogs | Where-Object { $_.Name -eq "SSISDB" }
$destinationFolders = $destinationCatalog.Folders
}
else
{
throw "The destination SSISDB catalog does not exist."
}
}
if ($folder)
{
if ($sourceFolders.Name -contains $folder)
{
$srcFolder = $sourceFolders | Where-Object { $_.Name -eq $folder }
if ($destinationFolders.Name -contains $folder)
{
if (!$force)
{
Write-Warning "Integration services catalog folder $folder exists at destination. Use -Force to drop and recreate."
}
else
{
if ($Pscmdlet.ShouldProcess($Destination, "Dropping folder $folder and recreating"))
{
try
{
New-CatalogFolder -Folder $srcFolder.Name -Description $srcFolder.Description -Force
}
catch
{
Write-Exception $_
}

}
}
}
else
{
if ($Pscmdlet.ShouldProcess($Destination, "Creating folder $folder"))
{
try
{
New-CatalogFolder -Folder $srcFolder.Name -Description $srcFolder.Description
}
catch
{
Write-Exception $_
}
}
}
}
else
{
throw "The source folder provided does not exist in the source Integration Services catalog."
}
}
else
{
foreach ($srcFolder in $sourceFolders)
{
if ($destinationFolders.Name -notcontains $srcFolder.Name)
{
if ($Pscmdlet.ShouldProcess($Destination, "Creating folder $($srcFolder.Name)"))
{
try
{
New-CatalogFolder -Folder $srcFolder.Name -Description $srcFolder.Description
}
catch
{
Write-Exception $_
}
}
}
else
{
if (!$force)
{
Write-Warning "Integration services catalog folder $($srcFolder.Name) exists at destination. Use -Force to drop and recreate."
continue
}
else
{
if ($Pscmdlet.ShouldProcess($Destination, "Dropping folder $($srcFolder.Name) and recreating"))
{
try
{
New-CatalogFolder -Folder $srcFolder.Name -Description $srcFolder.Description -Force
}
catch
{
Write-Exception $_
}
}
}
}
}
}

# Refresh folders for project and environment deployment
if ($Pscmdlet.ShouldProcess($Destination, "Refresh folders for project deployment"))
{
try { $destinationFolders.Alter() }
catch { } # Sometimes it says Alter() doesn't exist ¯\_(ツ)_/¯
$destinationFolders.Refresh()
}

if ($folder)
{
$sourceFolders = $sourceFolders | Where-Object { $_.Name -eq $folder }
if (!$sourceFolders)
{
throw "The source folder $folder does not exist in the source Integration Services catalog."
}
}
if ($project)
{
$folderDeploy = $sourceFolders | Where-Object { $_.Projects.Name -eq $project }
if (!$folderDeploy)
{
throw "The project $project cannot be found in the source Integration Services catalog."
}
else
{
foreach ($f in $folderDeploy)
{
if ($Pscmdlet.ShouldProcess($Destination, "Deploying project $project from folder $($f.Name)"))
{
try
{
Invoke-ProjectDeployment -Folder $f.Name -Project $project
}
catch
{
Write-Exception $_
}
}
}
}
}
else
{
foreach ($curFolder in $sourceFolders)
{
foreach ($proj in $curFolder.Projects)
{
if ($Pscmdlet.ShouldProcess($Destination, "Deploying project $($proj.Name) from folder $($curFolder.Name)"))
{
try
{
Invoke-ProjectDeployment -Project $proj.Name -Folder $curFolder.Name
}
catch
{
Write-Exception $_
}
}
}
}
}

if ($environment)
{
$folderDeploy = $sourceFolders | Where-Object { $_.Environments.Name -eq $environment }
if (!$folderDeploy)
{
throw "The environment $environment cannot be found in the source Integration Services catalog."
}
else
{
foreach ($f in $folderDeploy)
{
if ($destinationFolders[$f.Name].Environments.Name -notcontains $environment)
{
if ($Pscmdlet.ShouldProcess($Destination, "Deploying environment $environment from folder $($f.Name)"))
{
try
{
New-FolderEnvironment -Folder $f.Name -Environment $environment
}
catch
{
Write-Exception $_
}
}
}
else
{
if (!$force)
{
Write-Warning "Integration services catalog environment $environment exists in folder $($f.Name) at destination. Use -Force to drop and recreate."
}
else
{
If ($Pscmdlet.ShouldProcess($Destination, "Dropping existing environment $environment and deploying environment $environment from folder $($f.Name)"))
{
try
{
New-FolderEnvironment -Folder $f.Name -Environment $environment -Force
}
catch
{
Write-Exception $_
}
}
}
}
}
}
}
else
{
foreach ($curFolder in $sourceFolders)
{
foreach ($env in $curFolder.Environments)
{
if ($destinationFolders[$curFolder.Name].Environments.Name -notcontains $env.Name)
{
if ($Pscmdlet.ShouldProcess($Destination, "Deploying environment $($env.Name) from folder $($curFolder.Name)"))
{
try
{
New-FolderEnvironment -Environment $env.Name -Folder $curFolder.Name
}
catch
{
Write-Exception $_
}
}
}
else
{
if (!$force)
{
Write-Warning "Integration services catalog environment $($env.Name) exists in folder $($curFolder.Name) at destination. Use -Force to drop and recreate."
continue
}
else
{
if ($Pscmdlet.ShouldProcess($Destination, "Deploying environment $($env.Name) from folder $($curFolder.Name)"))
{
try
{
New-FolderEnvironment -Environment $env.Name -Folder $curFolder.Name -Force
}
catch
{
Write-Exception $_
}
}
}
}
}
}
}
}

END
{
$sourceConnection.ConnectionContext.Disconnect()
$destinationConnection.ConnectionContext.Disconnect()
if ($Pscmdlet.ShouldProcess("console", "Showing finished message"))
{
Write-Output "Integration services migration finished."
}
}
}