-
Notifications
You must be signed in to change notification settings - Fork 225
/
SqlServerDscHelper.psm1
1683 lines (1399 loc) · 54 KB
/
SqlServerDscHelper.psm1
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
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Load Localization Data
Import-Module -Name (Join-Path -Path (Join-Path -Path $PSScriptRoot `
-ChildPath 'DscResources') `
-ChildPath 'CommonResourceHelper.psm1')
$script:localizedData = Get-LocalizedData -ResourceName 'SqlServerDscHelper' -ScriptRoot $PSScriptRoot
<#
.SYNOPSIS
Connect to a SQL Server Database Engine and return the server object.
.PARAMETER SQLServer
String containing the host name of the SQL Server to connect to.
.PARAMETER SQLInstanceName
String containing the SQL Server Database Engine instance to connect to.
.PARAMETER SetupCredential
PSCredential object with the credentials to use to impersonate a user when connecting.
If this is not provided then the current user will be used to connect to the SQL Server Database Engine instance.
.PARAMETER LoginType
If the SetupCredential is set, specify with this parameter, which type
of credentials are set: Native SQL login or Windows user Login. Default
value is 'WindowsUser'.
#>
function Connect-SQL
{
[CmdletBinding()]
param
(
[Parameter()]
[ValidateNotNull()]
[System.String]
$ServerName = $env:COMPUTERNAME,
[Parameter()]
[ValidateNotNull()]
[System.String]
$InstanceName = 'MSSQLSERVER',
[Parameter()]
[ValidateNotNull()]
[System.Management.Automation.PSCredential]
$SetupCredential,
[Parameter()]
[ValidateSet('WindowsUser', 'SqlLogin')]
[System.String]
$LoginType = 'WindowsUser'
)
Import-SQLPSModule
if ($InstanceName -eq 'MSSQLSERVER')
{
$databaseEngineInstance = $ServerName
}
else
{
$databaseEngineInstance = "$ServerName\$InstanceName"
}
if ($SetupCredential)
{
$sql = New-Object -TypeName Microsoft.SqlServer.Management.Smo.Server
if ($LoginType -eq 'SqlLogin')
{
$connectUsername = $SetupCredential.Username
$sql.ConnectionContext.LoginSecure = $false
$sql.ConnectionContext.Login = $SetupCredential.Username
$sql.ConnectionContext.SecurePassword = $SetupCredential.Password
}
if ($LoginType -eq 'WindowsUser')
{
$connectUsername = $SetupCredential.GetNetworkCredential().UserName
$sql.ConnectionContext.ConnectAsUser = $true
$sql.ConnectionContext.ConnectAsUserPassword = $SetupCredential.GetNetworkCredential().Password
$sql.ConnectionContext.ConnectAsUserName = $SetupCredential.GetNetworkCredential().UserName
}
Write-Verbose -Message (
'Connecting using the credential ''{0}'' and the login type ''{1}''.' `
-f $connectUsername, $LoginType
) -Verbose
$sql.ConnectionContext.ServerInstance = $databaseEngineInstance
$sql.ConnectionContext.Connect()
}
else
{
$sql = New-Object -TypeName Microsoft.SqlServer.Management.Smo.Server -ArgumentList $databaseEngineInstance
}
if ( $sql.Status -match '^Online$' )
{
Write-Verbose -Message ($script:localizedData.ConnectedToDatabaseEngineInstance -f $databaseEngineInstance) -Verbose
return $sql
}
else
{
$errorMessage = $script:localizedData.FailedToConnectToDatabaseEngineInstance -f $databaseEngineInstance
New-InvalidOperationException -Message $errorMessage
}
}
<#
.SYNOPSIS
Connect to a SQL Server Analysis Service and return the server object.
.PARAMETER SQLServer
String containing the host name of the SQL Server to connect to.
.PARAMETER SQLInstanceName
String containing the SQL Server Analysis Service instance to connect to.
.PARAMETER SetupCredential
PSCredential object with the credentials to use to impersonate a user when connecting.
If this is not provided then the current user will be used to connect to the SQL Server Analysis Service instance.
#>
function Connect-SQLAnalysis
{
[CmdletBinding()]
param
(
[Parameter()]
[ValidateNotNullOrEmpty()]
[System.String]
$SQLServer = $env:COMPUTERNAME,
[Parameter()]
[ValidateNotNullOrEmpty()]
[System.String]
$SQLInstanceName = 'MSSQLSERVER',
[Parameter()]
[ValidateNotNullOrEmpty()]
[System.Management.Automation.PSCredential]
[System.Management.Automation.Credential()]
$SetupCredential
)
$null = [System.Reflection.Assembly]::LoadWithPartialName('Microsoft.AnalysisServices')
if ($SQLInstanceName -eq 'MSSQLSERVER')
{
$analysisServiceInstance = $SQLServer
}
else
{
$analysisServiceInstance = "$SQLServer\$SQLInstanceName"
}
if ($SetupCredential)
{
$userName = $SetupCredential.GetNetworkCredential().UserName
$password = $SetupCredential.GetNetworkCredential().Password
$analysisServicesDataSource = "Data Source=$analysisServiceInstance;User ID=$userName;Password=$password"
}
else
{
$analysisServicesDataSource = "Data Source=$analysisServiceInstance"
}
try
{
$analysisServicesObject = New-Object -TypeName Microsoft.AnalysisServices.Server
if ($analysisServicesObject)
{
$analysisServicesObject.Connect($analysisServicesDataSource)
}
else
{
$errorMessage = $script:localizedData.FailedToConnectToAnalysisServicesInstance -f $analysisServiceInstance
New-InvalidOperationException -Message $errorMessage
}
Write-Verbose -Message ($script:localizedData.ConnectedToAnalysisServicesInstance -f $analysisServiceInstance) -Verbose
}
catch
{
$errorMessage = $script:localizedData.FailedToConnectToAnalysisServicesInstance -f $analysisServiceInstance
New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
}
return $analysisServicesObject
}
<#
.SYNOPSIS
Returns the major SQL version for the specific instance.
.PARAMETER SQLInstanceName
String containing the name of the SQL instance to be configured. Default value is 'MSSQLSERVER'.
.OUTPUTS
System.UInt16. Returns the SQL Server major version number.
#>
function Get-SqlInstanceMajorVersion
{
[CmdletBinding()]
[OutputType([System.UInt16])]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$SQLInstanceName = 'MSSQLSERVER'
)
$sqlInstanceId = (Get-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\Microsoft SQL Server\Instance Names\SQL').$SQLInstanceName
$sqlVersion = (Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Microsoft SQL Server\$sqlInstanceId\Setup").Version
if (-not $sqlVersion)
{
$errorMessage = $script:localizedData.SqlServerVersionIsInvalid -f $SQLInstanceName
New-InvalidResultException -Message $errorMessage
}
[System.UInt16] $sqlMajorVersionNumber = $sqlVersion.Split('.')[0]
return $sqlMajorVersionNumber
}
<#
.SYNOPSIS
Returns a localized error message.
This helper function is obsolete, should use new helper functions.
https://github.com/PowerShell/SqlServerDsc/blob/dev/CONTRIBUTING.md#localization
https://github.com/PowerShell/SqlServerDsc/blob/dev/DSCResources/CommonResourceHelper.psm1
Strings in this function has not been localized since this helper function should be removed
when all resources has moved over to the new localization,
.PARAMETER ErrorType
String containing the key of the localized error message.
.PARAMETER FormatArgs
Collection of strings to replace format objects in the error message.
.PARAMETER ErrorCategory
The category to use for the error message. Default value is 'OperationStopped'.
Valid values are a value from the enumeration System.Management.Automation.ErrorCategory.
.PARAMETER TargetObject
The object that was being operated on when the error occurred.
.PARAMETER InnerException
Exception object that was thrown when the error occurred, which will be added to the final error message.
#>
function New-TerminatingError
{
[CmdletBinding()]
[OutputType([System.Management.Automation.ErrorRecord])]
param
(
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$ErrorType,
[Parameter()]
[System.String[]]
$FormatArgs,
[Parameter()]
[System.Management.Automation.ErrorCategory]
$ErrorCategory = [System.Management.Automation.ErrorCategory]::OperationStopped,
[Parameter()]
[System.Object]
$TargetObject = $null,
[Parameter()]
[System.Exception]
$InnerException = $null
)
$errorMessage = $script:localizedData.$ErrorType
if (!$errorMessage)
{
$errorMessage = ($script:localizedData.NoKeyFound -f $ErrorType)
if (!$errorMessage)
{
$errorMessage = ("No Localization key found for ErrorType: '{0}'." -f $ErrorType)
}
}
$errorMessage = ($errorMessage -f $FormatArgs)
if ( $InnerException )
{
$errorMessage += " InnerException: $($InnerException.Message)"
}
$callStack = Get-PSCallStack
# Get Name of calling script
if ($callStack[1] -and $callStack[1].ScriptName)
{
$scriptPath = $callStack[1].ScriptName
$callingScriptName = $scriptPath.Split('\')[-1].Split('.')[0]
$errorId = "$callingScriptName.$ErrorType"
}
else
{
$errorId = $ErrorType
}
Write-Verbose -Message "$($script:localizedData.$ErrorType -f $FormatArgs) | ErrorType: $errorId"
$exception = New-Object -TypeName System.Exception -ArgumentList $errorMessage, $InnerException
$errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord -ArgumentList $exception, $errorId, $ErrorCategory, $TargetObject
return $errorRecord
}
<#
.SYNOPSIS
Displays a localized warning message.
This helper function is obsolete, should use Write-Warning together with individual resource
localization strings.
https://github.com/PowerShell/SqlServerDsc/blob/dev/CONTRIBUTING.md#localization
Strings in this function has not been localized since this helper function should be removed
when all resources has moved over to the new localization,
.PARAMETER WarningType
String containing the key of the localized warning message.
.PARAMETER FormatArgs
Collection of strings to replace format objects in warning message.
#>
function New-WarningMessage
{
[CmdletBinding()]
param
(
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$WarningType,
[Parameter()]
[System.String[]]
$FormatArgs
)
## Attempt to get the string from the localized data
$warningMessage = $script:localizedData.$WarningType
## Ensure there is a message present in the localization file
if (!$warningMessage)
{
$errorParams = @{
ErrorType = 'NoKeyFound'
FormatArgs = $WarningType
ErrorCategory = 'InvalidArgument'
TargetObject = 'New-WarningMessage'
}
## Raise an error indicating the localization data is not present
throw New-TerminatingError @errorParams
}
## Apply formatting
$warningMessage = $warningMessage -f $FormatArgs
## Write the message as a warning
Write-Warning -Message $warningMessage
}
<#
.SYNOPSIS
Displays a standardized verbose message.
This helper function is obsolete, should use Write-Verbose together with individual resource
localization strings.
https://github.com/PowerShell/SqlServerDsc/blob/dev/CONTRIBUTING.md#localization
Strings in this function has not been localized since this helper function should be removed
when all resources has moved over to the new localization,
.PARAMETER Message
String containing the key of the localized warning message.
#>
function New-VerboseMessage
{
[CmdletBinding()]
[Alias()]
[OutputType([System.String])]
Param
(
[Parameter(Mandatory = $true)]
[System.String]
$Message
)
Write-Verbose -Message ((Get-Date -format yyyy-MM-dd_HH-mm-ss) + ": $Message") -Verbose
}
<#
.SYNOPSIS
This method is used to compare current and desired values for any DSC resource.
.PARAMETER CurrentValues
This is hash table of the current values that are applied to the resource.
.PARAMETER DesiredValues
This is a PSBoundParametersDictionary of the desired values for the resource.
.PARAMETER ValuesToCheck
This is a list of which properties in the desired values list should be checked.
If this is empty then all values in DesiredValues are checked.
#>
function Test-SQLDscParameterState
{
[CmdletBinding()]
param
(
[Parameter(Mandatory = $true)]
[System.Collections.Hashtable]
$CurrentValues,
[Parameter(Mandatory = $true)]
[System.Object]
$DesiredValues,
[Parameter()]
[System.Array]
$ValuesToCheck
)
$returnValue = $true
if (($DesiredValues.GetType().Name -ne 'HashTable') `
-and ($DesiredValues.GetType().Name -ne 'CimInstance') `
-and ($DesiredValues.GetType().Name -ne 'PSBoundParametersDictionary'))
{
$errorMessage = $script:localizedData.PropertyTypeInvalidForDesiredValues -f $($DesiredValues.GetType().Name)
New-InvalidArgumentException -ArgumentName 'DesiredValues' -Message $errorMessage
}
if (($DesiredValues.GetType().Name -eq 'CimInstance') -and ($null -eq $ValuesToCheck))
{
$errorMessage = $script:localizedData.PropertyTypeInvalidForValuesToCheck
New-InvalidArgumentException -ArgumentName 'ValuesToCheck' -Message $errorMessage
}
if (($null -eq $ValuesToCheck) -or ($ValuesToCheck.Count -lt 1))
{
$keyList = $DesiredValues.Keys
}
else
{
$keyList = $ValuesToCheck
}
$keyList | ForEach-Object -Process {
if (($_ -ne 'Verbose'))
{
if (($CurrentValues.ContainsKey($_) -eq $false) `
-or ($CurrentValues.$_ -ne $DesiredValues.$_) `
-or (($DesiredValues.GetType().Name -ne 'CimInstance' -and $DesiredValues.ContainsKey($_) -eq $true) -and ($null -ne $DesiredValues.$_ -and $DesiredValues.$_.GetType().IsArray)))
{
if ($DesiredValues.GetType().Name -eq 'HashTable' -or `
$DesiredValues.GetType().Name -eq 'PSBoundParametersDictionary')
{
$checkDesiredValue = $DesiredValues.ContainsKey($_)
}
else
{
# If DesiredValue is a CimInstance.
$checkDesiredValue = $false
if (([System.Boolean]($DesiredValues.PSObject.Properties.Name -contains $_)) -eq $true)
{
if ($null -ne $DesiredValues.$_)
{
$checkDesiredValue = $true
}
}
}
if ($checkDesiredValue)
{
$desiredType = $DesiredValues.$_.GetType()
$fieldName = $_
if ($desiredType.IsArray -eq $true)
{
if (($CurrentValues.ContainsKey($fieldName) -eq $false) `
-or ($null -eq $CurrentValues.$fieldName))
{
Write-Verbose -Message ($script:localizedData.PropertyValidationError -f $fieldName) -Verbose
$returnValue = $false
}
else
{
$arrayCompare = Compare-Object -ReferenceObject $CurrentValues.$fieldName `
-DifferenceObject $DesiredValues.$fieldName
if ($null -ne $arrayCompare)
{
Write-Verbose -Message ($script:localizedData.PropertiesDoesNotMatch -f $fieldName) -Verbose
$arrayCompare | ForEach-Object -Process {
Write-Verbose -Message ($script:localizedData.PropertyThatDoesNotMatch -f $_.InputObject, $_.SideIndicator) -Verbose
}
$returnValue = $false
}
}
}
else
{
switch ($desiredType.Name)
{
'String'
{
if (-not [System.String]::IsNullOrEmpty($CurrentValues.$fieldName) -or `
-not [System.String]::IsNullOrEmpty($DesiredValues.$fieldName))
{
Write-Verbose -Message ($script:localizedData.ValueOfTypeDoesNotMatch `
-f $desiredType.Name, $fieldName, $($CurrentValues.$fieldName), $($DesiredValues.$fieldName)) -Verbose
$returnValue = $false
}
}
'Int32'
{
if (-not ($DesiredValues.$fieldName -eq 0) -or `
-not ($null -eq $CurrentValues.$fieldName))
{
Write-Verbose -Message ($script:localizedData.ValueOfTypeDoesNotMatch `
-f $desiredType.Name, $fieldName, $($CurrentValues.$fieldName), $($DesiredValues.$fieldName)) -Verbose
$returnValue = $false
}
}
{ $_ -eq 'Int16' -or $_ -eq 'UInt16'}
{
if (-not ($DesiredValues.$fieldName -eq 0) -or `
-not ($null -eq $CurrentValues.$fieldName))
{
Write-Verbose -Message ($script:localizedData.ValueOfTypeDoesNotMatch `
-f $desiredType.Name, $fieldName, $($CurrentValues.$fieldName), $($DesiredValues.$fieldName)) -Verbose
$returnValue = $false
}
}
default
{
Write-Warning -Message ($script:localizedData.UnableToCompareProperty `
-f $fieldName, $desiredType.Name)
$returnValue = $false
}
}
}
}
}
}
}
return $returnValue
}
<#
.SYNOPSIS
Imports the module SQLPS in a standardized way.
.PARAMETER Force
Forces the removal of the previous SQL module, to load the same or newer
version fresh.
This is meant to make sure the newest version is used, with the latest
assemblies.
#>
function Import-SQLPSModule
{
[CmdletBinding()]
param
(
[Parameter()]
[Switch]
$Force
)
if ($Force.IsPresent)
{
Write-Verbose -Message $script:localizedData.ModuleForceRemoval -Verbose
Remove-Module -Name @('SqlServer','SQLPS','SQLASCmdlets') -Force -ErrorAction SilentlyContinue
}
<#
Check if either of the modules are already loaded into the session.
Prefer to use the first one (in order found).
NOTE: There should actually only be either SqlServer or SQLPS loaded,
otherwise there can be problems with wrong assemblies being loaded.
#>
$loadedModuleName = (Get-Module -Name @('SqlServer', 'SQLPS') | Select-Object -First 1).Name
if ($loadedModuleName)
{
Write-Verbose -Message ($script:localizedData.PowerShellModuleAlreadyImported -f $loadedModuleName) -Verbose
return
}
$availableModuleName = $null
# Get the newest SqlServer module if more than one exist
$availableModule = Get-Module -FullyQualifiedName 'SqlServer' -ListAvailable |
Sort-Object -Property 'Version' -Descending |
Select-Object -First 1 -Property Name, Path, Version
if ($availableModule)
{
$availableModuleName = $availableModule.Name
Write-Verbose -Message ($script:localizedData.PreferredModuleFound) -Verbose
}
else
{
Write-Verbose -Message ($script:localizedData.PreferredModuleNotFound) -Verbose
<#
After installing SQL Server the current PowerShell session doesn't know about the new path
that was added for the SQLPS module.
This reloads PowerShell session environment variable PSModulePath to make sure it contains
all paths.
#>
$env:PSModulePath = [System.Environment]::GetEnvironmentVariable('PSModulePath', 'Machine')
<#
Get the newest SQLPS module if more than one exist.
#>
$availableModule = Get-Module -FullyQualifiedName 'SQLPS' -ListAvailable |
Select-Object -Property Name, Path, @{
Name = 'Version'
Expression = {
# Parse the build version number '120', '130' from the Path.
(Select-String -InputObject $_.Path -Pattern '\\([0-9]{3})\\' -List).Matches.Groups[1].Value
}
} |
Sort-Object -Property 'Version' -Descending |
Select-Object -First 1
if ($availableModule)
{
# This sets $availableModuleName to the Path of the module to be loaded.
$availableModuleName = Split-Path -Path $availableModule.Path -Parent
}
}
if ($availableModuleName)
{
try
{
Write-Debug -Message ($script:localizedData.DebugMessagePushingLocation)
Push-Location
<#
SQLPS has unapproved verbs, disable checking to ignore Warnings.
Suppressing verbose so all cmdlet is not listed.
#>
$importedModule = Import-Module -Name $availableModuleName -DisableNameChecking -Verbose:$false -Force:$Force -PassThru -ErrorAction Stop
<#
SQLPS returns two entries, one with module type 'Script' and another with module type 'Manifest'.
Only return the object with module type 'Manifest'.
SqlServer only returns one object (of module type 'Script'), so no need to do anything for SqlServer module.
#>
if ($availableModuleName -ne 'SqlServer')
{
$importedModule = $importedModule | Where-Object -Property 'ModuleType' -EQ -Value 'Manifest'
}
Write-Verbose -Message ($script:localizedData.ImportedPowerShellModule -f $importedModule.Name, $importedModule.Version, $importedModule.Path) -Verbose
}
catch
{
$errorMessage = $script:localizedData.FailedToImportPowerShellSqlModule -f $availableModuleName
New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
}
finally
{
Write-Debug -Message ($script:localizedData.DebugMessagePoppingLocation)
Pop-Location
}
}
else
{
$errorMessage = $script:localizedData.PowerShellSqlModuleNotFound
New-InvalidOperationException -Message $errorMessage
}
}
<#
.SYNOPSIS
Restarts a SQL Server instance and associated services
.PARAMETER SQLServer
Hostname of the SQL Server to be configured
.PARAMETER SQLInstanceName
Name of the SQL instance to be configured. Default is 'MSSQLSERVER'
.PARAMETER Timeout
Timeout value for restarting the SQL services. The default value is 120 seconds.
.PARAMETER SkipClusterCheck
If cluster check should be skipped. If this is present no connection
is made to the instance to check if the instance is on a cluster.
This need to be used for some resource, for example for the SqlServerNetwork
resource when it's used to enable a disable protocol.
.PARAMETER SkipWaitForOnline
If this is present no connection is made to the instance to check if the
instance is online.
This need to be used for some resource, for example for the SqlServerNetwork
resource when it's used to disable protocol.
.EXAMPLE
Restart-SqlService -SQLServer localhost
.EXAMPLE
Restart-SqlService -SQLServer localhost -SQLInstanceName 'NamedInstance'
.EXAMPLE
Restart-SqlService -SQLServer localhost -SQLInstanceName 'NamedInstance' -SkipClusterCheck -SkipWaitForOnline
.EXAMPLE
Restart-SqlService -SQLServer CLU01 -Timeout 300
#>
function Restart-SqlService
{
[CmdletBinding()]
param
(
[Parameter(Mandatory = $true)]
[System.String]
$SQLServer,
[Parameter()]
[System.String]
$SQLInstanceName = 'MSSQLSERVER',
[Parameter()]
[System.UInt32]
$Timeout = 120,
[Parameter()]
[Switch]
$SkipClusterCheck,
[Parameter()]
[Switch]
$SkipWaitForOnline
)
if (-not $SkipClusterCheck.IsPresent)
{
## Connect to the instance
$serverObject = Connect-SQL -ServerName $SQLServer -InstanceName $SQLInstanceName
if ($serverObject.IsClustered)
{
# Get the cluster resources
Write-Verbose -Message ($script:localizedData.GetSqlServerClusterResources) -Verbose
$sqlService = Get-CimInstance -Namespace root/MSCluster -ClassName MSCluster_Resource -Filter "Type = 'SQL Server'" |
Where-Object -FilterScript { $_.PrivateProperties.InstanceName -eq $serverObject.ServiceName }
Write-Verbose -Message ($script:localizedData.GetSqlAgentClusterResource) -Verbose
$agentService = $sqlService | Get-CimAssociatedInstance -ResultClassName MSCluster_Resource |
Where-Object -FilterScript { ($_.Type -eq 'SQL Server Agent') -and ($_.State -eq 2) }
# Build a listing of resources being acted upon
$resourceNames = @($sqlService.Name, ($agentService | Select-Object -ExpandProperty Name)) -join ","
# Stop the SQL Server and dependent resources
Write-Verbose -Message ($script:localizedData.BringClusterResourcesOffline -f $resourceNames) -Verbose
$sqlService | Invoke-CimMethod -MethodName TakeOffline -Arguments @{ Timeout = $Timeout }
# Start the SQL server resource
Write-Verbose -Message ($script:localizedData.BringSqlServerClusterResourcesOnline) -Verbose
$sqlService | Invoke-CimMethod -MethodName BringOnline -Arguments @{ Timeout = $Timeout }
# Start the SQL Agent resource
if ($agentService)
{
Write-Verbose -Message ($script:localizedData.BringSqlServerAgentClusterResourcesOnline) -Verbose
$agentService | Invoke-CimMethod -MethodName BringOnline -Arguments @{ Timeout = $Timeout }
}
}
else
{
# Not a cluster, restart the Windows service.
$restartWindowsService = $true
}
}
else
{
# Should not check if a cluster, assume that a Windows service should be restarted.
$restartWindowsService = $true
}
if ($restartWindowsService)
{
if ($SQLInstanceName -eq 'MSSQLSERVER')
{
$serviceName = 'MSSQLSERVER'
}
else
{
$serviceName = 'MSSQL${0}' -f $SQLInstanceName
}
Write-Verbose -Message ($script:localizedData.GetServiceInformation -f 'SQL Server') -Verbose
$sqlService = Get-Service -Name $serviceName
<#
Get all dependent services that are running.
There are scenarios where an automatic service is stopped and should not be restarted automatically.
#>
$agentService = $sqlService.DependentServices | Where-Object -FilterScript { $_.Status -eq 'Running' }
# Restart the SQL Server service
Write-Verbose -Message ($script:localizedData.RestartService -f 'SQL Server') -Verbose
$sqlService | Restart-Service -Force
# Start dependent services
$agentService | ForEach-Object {
Write-Verbose -Message ($script:localizedData.StartingDependentService -f $_.DisplayName) -Verbose
$_ | Start-Service
}
}
Write-Verbose -Message ($script:localizedData.WaitingInstanceTimeout -f $SQLServer, $SQLInstanceName, $Timeout) -Verbose
if (-not $SkipWaitForOnline.IsPresent)
{
$connectTimer = [System.Diagnostics.StopWatch]::StartNew()
do
{
# This call, if it fails, will take between ~9-10 seconds to return.
$testConnectionServerObject = Connect-SQL -ServerName $SQLServer -InstanceName $SQLInstanceName -ErrorAction SilentlyContinue
if ($testConnectionServerObject -and $testConnectionServerObject.Status -ne 'Online')
{
# Waiting 2 seconds to not hammer the SQL Server instance.
Start-Sleep -Seconds 2
}
else
{
break
}
} until ($connectTimer.Elapsed.Seconds -ge $Timeout)
$connectTimer.Stop()
# Was the timeout period reach before able to connect to the SQL Server instance?
if (-not $testConnectionServerObject -or $testConnectionServerObject.Status -ne 'Online')
{
$errorMessage = $script:localizedData.FailedToConnectToInstanceTimeout -f $SQLServer, $SQLInstanceName, $Timeout
New-InvalidOperationException -Message $errorMessage
}
}
}
<#
.SYNOPSIS
Restarts a Reporting Services instance and associated services
.PARAMETER SQLInstanceName
Name of the instance to be restarted. Default is 'MSSQLSERVER'
(the default instance).
.PARAMETER WaitTime
Number of seconds to wait between service stop and service start.
Defaults to 0 seconds.
#>
function Restart-ReportingServicesService
{
[CmdletBinding()]
param
(
[Parameter()]
[System.String]
$SQLInstanceName = 'MSSQLSERVER',
[Parameter()]
[System.UInt16]
$WaitTime = 0
)
$ServiceName = 'ReportServer'
if (-not ($SQLInstanceName -eq 'MSSQLSERVER'))
{
$ServiceName += '${0}' -f $SQLInstanceName
}
Write-Verbose -Message ($script:localizedData.GetServiceInformation -f 'Reporting Services') -Verbose
$reportingServicesService = Get-Service -Name $ServiceName
<#
Get all dependent services that are running.
There are scenarios where an automatic service is stopped and should
not be restarted automatically.
#>
$dependentService = $reportingServicesService.DependentServices | Where-Object -FilterScript {
$_.Status -eq 'Running'
}
Write-Verbose -Message ($script:localizedData.RestartService -f $reportingServicesService.DisplayName) -Verbose
Write-Verbose -Message ($script:localizedData.StoppingService -f $reportingServicesService.DisplayName) -Verbose
$reportingServicesService | Stop-Service -Force
if ($WaitTime -ne 0)
{
Write-Verbose -Message ($script:localizedData.WaitServiceRestart -f $WaitTime, $reportingServicesService.DisplayName) -Verbose
Start-Sleep -Seconds $WaitTime
}
Write-Verbose -Message ($script:localizedData.StartingService -f $reportingServicesService.DisplayName) -Verbose
$reportingServicesService | Start-Service
# Start dependent services
$dependentService | ForEach-Object {
Write-Verbose -Message ($script:localizedData.StartingDependentService -f $_.DisplayName) -Verbose
$_ | Start-Service
}
}
<#
.SYNOPSIS
Executes a query on the specified database.
.PARAMETER SQLServer
The hostname of the server that hosts the SQL instance.
.PARAMETER SQLInstanceName
The name of the SQL instance that hosts the database.
.PARAMETER Database
Specify the name of the database to execute the query on.
.PARAMETER Query
The query string to execute.
.PARAMETER WithResults
Specifies if the query should return results.
.EXAMPLE
Invoke-Query -SQLServer Server1 -SQLInstanceName MSSQLSERVER -Database master -Query 'SELECT name FROM sys.databases' -WithResults
.EXAMPLE
Invoke-Query -SQLServer Server1 -SQLInstanceName MSSQLSERVER -Database master -Query 'RESTORE DATABASE [NorthWinds] WITH RECOVERY'
#>
function Invoke-Query
{
[CmdletBinding()]
param
(
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[System.String]
$SQLServer,
[Parameter(Mandatory = $true)]
[System.String]
$SQLInstanceName,
[Parameter(Mandatory = $true)]
[System.String]
$Database,
[Parameter(Mandatory = $true)]
[System.String]
$Query,
[Parameter()]
[Switch]
$WithResults
)
$serverObject = Connect-SQL -ServerName $SQLServer -InstanceName $SQLInstanceName