functions/Copy-SqlAgentCategory.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
Function Copy-SqlAgentCategory
{
<#
.SYNOPSIS
Copy-SqlAgentCategory migrates SQL Agent categories from one SQL Server to another. This is similar to sp_add_category.
 
https://msdn.microsoft.com/en-us/library/ms181597.aspx
 
.DESCRIPTION
By default, all SQL Agent categories for Jobs, Operators and Alerts are copied.
 
The -OperatorCategories parameter is autopopulated for command-line completion and can be used to copy only specific operator categories.
The -AgentCategories parameter is autopopulated for command-line completion and can be used to copy only specific agent categories.
The -JobCategories parameter is autopopulated for command-line completion and can be used to copy only specific job categories.
 
If the category already exists on the destination, it will be skipped unless -Force is used.
 
.PARAMETER Source
Source SQL Server.You must have sysadmin access and server version must be SQL Server version 2000 or greater.
 
.PARAMETER Destination
Destination Sql Server. You must have sysadmin access and server version must be SQL Server version 2000 or greater.
 
.PARAMETER SourceSqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$scred = Get-Credential, then pass $scred object to the -SourceSqlCredential parameter.
 
Windows Authentication will be used if DestinationSqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
 
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, then pass this $dcred to the -DestinationSqlCredential parameter.
 
Windows Authentication will be used if DestinationSqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
 
To connect as a different Windows user, run PowerShell as that user.
 
.PARAMETER CategoryType
Specifies the Category Type to migrate. Valid options are Job, Alert and Operator. When CategoryType is specified, all categories from the selected type will be migrated. For granular migrations, use the three parameters below.
 
.PARAMETER OperatorCategories
This parameter is autopopulated for command-line completion and can be used to copy only specific operator categories.
 
.PARAMETER AgentCategories
This parameter is autopopulated for command-line completion and can be used to copy only specific agent categories.
 
.PARAMETER JobCategories
This parameter is autopopulated for command-line completion and can be used to copy only specific job categories.
 
.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 Force
Drops and recreates the XXXXX if it exists
 
.NOTES
Author: Chrissy LeMaire (@cl), netnerds.net
Requires: sysadmin access on SQL Servers
 
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-SqlAgentCategory
 
.EXAMPLE
Copy-SqlAgentCategory -Source sqlserver2014a -Destination sqlcluster
 
Copies all operator categories from sqlserver2014a to sqlcluster, using Windows credentials. If operator categories with the same name exist on sqlcluster, they will be skipped.
 
.EXAMPLE
Copy-SqlAgentCategory -Source sqlserver2014a -Destination sqlcluster -OperatorCategory PSOperator -SourceSqlCredential $cred -Force
 
Copies a single operator category, the PSOperator operator category from sqlserver2014a to sqlcluster, using SQL credentials for sqlserver2014a and Windows credentials for sqlcluster. If a operator category with the same name exists on sqlcluster, it will be dropped and recreated because -Force was used.
 
.EXAMPLE
Copy-SqlAgentCategory -Source sqlserver2014a -Destination sqlcluster -WhatIf -Force
 
Shows what would happen if the command were executed using force.
#>

[CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $true)]
param (
[parameter(Mandatory = $true)]
[object]$Source,
[parameter(Mandatory = $true)]
[object]$Destination,
[Parameter(ParameterSetName = 'SpecifcAlerts')]
[ValidateSet('Job', 'Alert', 'Operator')]
[string[]]$CategoryType,
[System.Management.Automation.PSCredential]$SourceSqlCredential,
[System.Management.Automation.PSCredential]$DestinationSqlCredential,
[switch]$Force
)
DynamicParam { if ($source) { return (Get-ParamSqlAgentCategories -SqlServer $Source -SqlCredential $SourceSqlCredential) } }

BEGIN
{

Function Copy-SqlJobCategory
{
<#
   .SYNOPSIS
   Copy-SqlJobCategory migrates job categories from one SQL Server to another.
 
   .DESCRIPTION
   By default, all job categories are copied. The -JobCategories parameter is autopopulated for command-line completion and can be used to copy only specific job categories.
 
   If the associated credential for the category does not exist on the destination, it will be skipped. If the job category already exists on the destination, it will be skipped unless -Force is used.
   #>

param (
[string[]]$JobCategories
)

PROCESS
{

$serverjobcategories = $sourceserver.JobServer.JobCategories | Where-Object { $_.ID -ge 100 }
$destjobcategories = $destserver.JobServer.JobCategories | Where-Object { $_.ID -ge 100 }

foreach ($jobcategory in $serverjobcategories)
{
$categoryname = $jobcategory.name
if ($jobcategories.count -gt 0 -and $jobcategories -notcontains $categoryname) { continue }

if ($destjobcategories.name -contains $jobcategory.name)
{
if ($force -eq $false)
{
Write-Warning "Job category $categoryname exists at destination. Use -Force to drop and migrate."
continue
}
else
{
If ($Pscmdlet.ShouldProcess($destination, "Dropping job category $categoryname and recreating"))
{
try
{
Write-Verbose "Dropping Job category $categoryname"
$destserver.jobserver.jobcategories[$categoryname].Drop()

}
catch { 
Write-Exception $_ 
continue
}
}
}
}

If ($Pscmdlet.ShouldProcess($destination, "Creating Job category $categoryname"))
{
try
{
Write-Output "Copying Job category $categoryname"
$sql = $jobcategory.Script() | Out-String
$sql = $sql -replace [Regex]::Escape("'$source'"), [Regex]::Escape("'$destination'")
Write-Verbose $sql
$destserver.ConnectionContext.ExecuteNonQuery($sql) | Out-Null
}
catch
{
Write-Exception $_
}
}
}
}

END
{
If ($Pscmdlet.ShouldProcess("console", "Showing finished message")) { Write-Output "Job category migration finished" }
}
}

Function Copy-SqlOperatorCategory
{
<#
   .SYNOPSIS
   Copy-SqlOperatorCategory migrates operator categories from one SQL Server to another.
 
   .DESCRIPTION
   By default, all operator categories are copied. The -OperatorCategories parameter is autopopulated for command-line completion and can be used to copy only specific operator categories.
 
   If the associated credential for the category does not exist on the destination, it will be skipped. If the operator category already exists on the destination, it will be skipped unless -Force is used.
   #>

[CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $true)]
param (
[string[]]$OperatorCategories
)

PROCESS
{
$serveroperatorcategories = $sourceserver.JobServer.OperatorCategories | Where-Object { $_.ID -ge 100 }
$destoperatorcategories = $destserver.JobServer.OperatorCategories | Where-Object { $_.ID -ge 100 }

foreach ($operatorcategory in $serveroperatorcategories)
{
$categoryname = $operatorcategory.name

if ($operatorcategories.count -gt 0 -and $operatorcategories -notcontains $categoryname) { continue }

if ($destoperatorcategories.name -contains $operatorcategory.name)
{
if ($force -eq $false)
{
Write-Warning "Operator category $categoryname exists at destination. Use -Force to drop and migrate."
continue
}
else
{
If ($Pscmdlet.ShouldProcess($destination, "Dropping operator category $categoryname and recreating"))
{
try
{
Write-Verbose "Dropping Operator category $categoryname"
$destserver.jobserver.operatorcategories[$categoryname].Drop()
Write-Output "Copying Operator category $categoryname"
$sql = $operatorcategory.Script() | Out-String
$sql = $sql -replace [Regex]::Escape("'$source'"), [Regex]::Escape("'$destination'")
Write-Verbose $sql
$destserver.ConnectionContext.ExecuteNonQuery($sql) | Out-Null
}
catch { Write-Exception $_ }
}
}
}
else
{
If ($Pscmdlet.ShouldProcess($destination, "Creating Operator category $categoryname"))
{
try
{
Write-Output "Copying Operator category $categoryname"
$sql = $operatorcategory.Script() | Out-String
$sql = $sql -replace [Regex]::Escape("'$source'"), [Regex]::Escape("'$destination'")
Write-Verbose $sql
$destserver.ConnectionContext.ExecuteNonQuery($sql) | Out-Null
}
catch
{
Write-Exception $_
}
}
}
}
}

END
{
If ($Pscmdlet.ShouldProcess("console", "Showing finished message")) { Write-Output "Operator category migration finished" }
}
}

Function Copy-SqlAlertCategory
{
<#
   .SYNOPSIS
   Copy-SqlAlertCategory migrates alert categories from one SQL Server to another.
 
   .DESCRIPTION
   By default, all alert categories are copied. The -AlertCategories parameter is autopopulated for command-line completion and can be used to copy only specific alert categories.
 
   If the associated credential for the category does not exist on the destination, it will be skipped. If the alert category already exists on the destination, it will be skipped unless -Force is used.
    
   #>

[CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $true)]
param (
[string[]]$AlertCategories
)

PROCESS
{
if ($sourceserver.versionMajor -lt 9 -or $destserver.versionMajor -lt 9)
{
throw "Server AlertCategories are only supported in SQL Server 2005 and above. Quitting."
}

$serveralertcategories = $sourceserver.JobServer.AlertCategories | Where-Object { $_.ID -ge 100 }
$destalertcategories = $destserver.JobServer.AlertCategories | Where-Object { $_.ID -ge 100 }

foreach ($alertcategory in $serveralertcategories)
{
$categoryname = $alertcategory.name
if ($alertcategories.length -gt 0 -and $alertcategories -notcontains $categoryname) { continue }

if ($destalertcategories.name -contains $alertcategory.name)
{
if ($force -eq $false)
{
Write-Warning "Alert category $categoryname exists at destination. Use -Force to drop and migrate."
continue
}
else
{
If ($Pscmdlet.ShouldProcess($destination, "Dropping alert category $categoryname and recreating"))
{
try
{
Write-Verbose "Dropping Alert category $categoryname"
$destserver.jobserver.alertcategories[$categoryname].Drop()
Write-Output "Copying Alert category $categoryname"
$sql = $alertcategory.Script() | Out-String
$sql = $sql -replace [Regex]::Escape("'$source'"), [Regex]::Escape("'$destination'")
Write-Verbose $sql
$destserver.ConnectionContext.ExecuteNonQuery($sql) | Out-Null
}
catch { Write-Exception $_ }
}
}
}
else
{
If ($Pscmdlet.ShouldProcess($destination, "Creating Alert category $categoryname"))
{
try
{
Write-Output "Copying Alert category $categoryname"
$sql = $alertcategory.Script() | Out-String
$sql = $sql -replace [Regex]::Escape("'$source'"), [Regex]::Escape("'$destination'")
Write-Verbose $sql
$destserver.ConnectionContext.ExecuteNonQuery($sql) | Out-Null
}
catch
{
Write-Exception $_
}
}
}
}
}

END
{
If ($Pscmdlet.ShouldProcess("console", "Showing finished message")) { Write-Output "Alert category migration finished" }
}
}

$operatorcategories = $psboundparameters.OperatorCategories
$alertcategories = $psboundparameters.AlertCategories
$jobcategories = $psboundparameters.JobCategories

$sourceserver = Connect-SqlServer -SqlServer $Source -SqlCredential $SourceSqlCredential
$destserver = Connect-SqlServer -SqlServer $Destination -SqlCredential $DestinationSqlCredential

$source = $sourceserver.DomainInstanceName
$destination = $destserver.DomainInstanceName

}

PROCESS
{
if ($CategoryType.count -gt 0)
{

switch ($CategoryType)
{
"Job" {
Copy-SqlJobCategory
}

"Alert" {
Copy-SqlAlertCategory
}

"Operator" {
Copy-SqlOperatorCategory
}
}

return
}

if (($operatorcategories.count + $alertcategories.count + $jobcategories.count) -gt 0)
{

if ($operatorcategories.count -gt 0)
{
Copy-SqlOperatorCategory -OperatorCategories $operatorcategories 
}

if ($alertcategories.count -gt 0)
{
Copy-SqlAlertCategory -AlertCategories $alertcategories 
}

if ($jobcategories.count -gt 0)
{
Copy-SqlJobCategory -JobCategories $jobcategories 
}

return
}

Copy-SqlOperatorCategory 
Copy-SqlAlertCategory 
Copy-SqlJobCategory 
}

END
{

$sourceserver.ConnectionContext.Disconnect()
$destserver.ConnectionContext.Disconnect()

If ($Pscmdlet.ShouldProcess("console", "Showing finished message")) { Write-Output "Agent category migration finished" }
}
}