functions/Copy-DbaSpConfigure.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
function Copy-DbaSpConfigure {
    <#
  .SYNOPSIS
   Copy-DbaSpConfigure migrates configuration values from one SQL Server to another.
 
  .DESCRIPTION
   By default, all configuration values are copied. The -ConfigName parameter is auto-populated for command-line completion and can be used to copy only specific configs.
 
  .PARAMETER Source
   Source SQL Server. You must have sysadmin access and server version must be SQL Server version 2000 or higher.
 
  .PARAMETER SourceSqlCredential
   Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or Trusted). To use:
 
   $scred = Get-Credential, then pass $scred object to the -SourceSqlCredential parameter.
 
   Windows Authentication will be used if SourceSqlCredential 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 Destination
   Destination SQL Server. You must have sysadmin access and the server must be SQL Server 2000 or higher.
 
  .PARAMETER DestinationSqlCredential
   Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or 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 ConfigName
   Specifies the configuration setting to process. Options for this list are auto-populated from the server. If unspecified, all ConfigNames will be processed.
 
  .PARAMETER ExcludeConfigName
   Specifies the configuration settings to exclude. Options for this list are auto-populated from the server.
 
  .PARAMETER WhatIf
   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.
 
  .PARAMETER Confirm
   If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
 
  .PARAMETER Silent
   If this switch is enabled, the internal messaging functions will be silenced.
 
  .NOTES
   Tags: Migration, Configure, SpConfigure
   Author: Chrissy LeMaire (@cl), netnerds.net
   Requires: sysadmin access on SQL Servers
 
   Website: https://dbatools.io
   Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
   License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
  .LINK
   https://dbatools.io/Copy-DbaSpConfigure
 
  .EXAMPLE
   Copy-DbaSpConfigure -Source sqlserver2014a -Destination sqlcluster
 
   Copies all sp_configure settings from sqlserver2014a to sqlcluster
 
  .EXAMPLE
   Copy-DbaSpConfigure -Source sqlserver2014a -Destination sqlcluster -ConfigName DefaultBackupCompression, IsSqlClrEnabled -SourceSqlCredential $cred -Force
 
   Copies the values for IsSqlClrEnabled and DefaultBackupCompression from sqlserver2014a to sqlcluster using SQL credentials to authenticate to sqlserver2014a and Windows credentials to authenticate to sqlcluster.
 
  .EXAMPLE
   Copy-DbaSpConfigure -Source sqlserver2014a -Destination sqlcluster -ExcludeConfigName DefaultBackupCompression, IsSqlClrEnabled
 
   Copies all configs except for IsSqlClrEnabled and DefaultBackupCompression, from sqlserver2014a to sqlcluster.
 
  .EXAMPLE
   Copy-DbaSpConfigure -Source sqlserver2014a -Destination sqlcluster -WhatIf
 
   Shows what would happen if the command were executed.
 #>

    [CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $true)]
    param (
        [parameter(Mandatory = $true)]
        [DbaInstanceParameter]$Source,
        [PSCredential]
        $SourceSqlCredential,
        [parameter(Mandatory = $true)]
        [DbaInstanceParameter]$Destination,
        [PSCredential]
        $DestinationSqlCredential,
        [object[]]$ConfigName,
        [object[]]$ExcludeConfigName,
        [switch]$Silent
    )

    begin {

        $sourceServer = Connect-SqlInstance -SqlInstance $Source -SqlCredential $SourceSqlCredential
        $destServer = Connect-SqlInstance -SqlInstance $Destination -SqlCredential $DestinationSqlCredential

        $source = $sourceServer.DomainInstanceName
        $destination = $destServer.DomainInstanceName
    }
    process {

        $sourceProps = Get-DbaSpConfigure -SqlInstance $sourceServer
        $destProps = Get-DbaSpConfigure -SqlInstance $destServer

        foreach ($sourceProp in $sourceProps) {
            $displayName = $sourceProp.DisplayName
            $sConfigName = $sourceProp.ConfigName
            $sConfiguredValue = $sourceProp.ConfiguredValue
            $requiresRestart = $sourceProp.IsDynamic

            $copySpConfigStatus = [pscustomobject]@{
                SourceServer      = $sourceServer.Name
                DestinationServer = $destServer.Name
                Name              = $sConfigName
                Type              = $null
                Status            = $null
                Notes             = $null
                DateTime          = [DbaDateTime](Get-Date)
            }

            if ($ConfigName -and $sConfigName -notin $ConfigName -or $sConfigName -in $ExcludeConfigName ) {
                continue
            }

            $destProp = $destProps | Where-Object ConfigName -eq $sConfigName
            if (!$destProp) {
                Write-Message -Level Warning -Message "Configuration $sConfigName ('$displayName') does not exist on the destination instance."

                $copySpConfigStatus.Status = "Skipped"
                $copySpConfigStatus.Notes = "Configuration does not exist on destination"
                $copySpConfigStatus
                continue
            }

            if ($Pscmdlet.ShouldProcess($destination, "Updating $sConfigName [$displayName]")) {
                try {
                    $destOldConfigValue = $destProp.ConfiguredValue

                    $result = Set-DbaSpConfigure -SqlInstance $destServer -ConfigName $sConfigName -Value $sConfiguredValue -Silent -Mode 'Lazy'
                    if ($result) {
                        Write-Message -Level Verbose -Message "Updated $($destProp.ConfigName) ($($destProp.DisplayName)) from $destOldConfigValue to $sConfiguredValue."
                    }

                    if ($requiresRestart -eq $false) {
                        Write-Message -Level Warning -Message "Configuration option $sConfigName ($displayName) requires restart."
                        $copySpConfigStatus.Notes = "Requires restart"
                    }
                    $copySpConfigStatus.Status = "Successful"
                    $copySpConfigStatus
                }
                catch {
                    $copySpConfigStatus.Status = "Failed"
                    $copySpConfigStatus.Notes = $_.Exception
                    $copySpConfigStatus

                    Stop-Function -Message "Could not set $($destProp.ConfigName) to $sConfiguredValue." -Target $sConfigName -ErrorRecord $_
                }
            }
        }
    }
    end {
        Test-DbaDeprecation -DeprecatedOn "1.0.0" -Silent:$false -Alias Copy-SqlSpConfigure
    }
}