functions/Copy-DbaAgentProxyAccount.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
function Copy-DbaAgentProxyAccount {
    <#
  .SYNOPSIS
   Copy-DbaAgentProxyAccount migrates proxy accounts from one SQL Server to another.
 
  .DESCRIPTION
   By default, all proxy accounts are copied. The -ProxyAccounts parameter is auto-populated for command-line completion and can be used to copy only specific proxy accounts.
 
   If the associated credential for the account does not exist on the destination, it will be skipped. If the proxy account 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 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 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 Force
   If this switch is enabled, the Operator will be dropped and recreated on Destination.
 
  .PARAMETER Silent
   If this switch is enabled, the internal messaging functions will be silenced.
 
  .NOTES
   Tags: Migration, Agent
   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-DbaAgentProxyAccount
 
  .EXAMPLE
   Copy-DbaAgentProxyAccount -Source sqlserver2014a -Destination sqlcluster
 
   Copies all proxy accounts from sqlserver2014a to sqlcluster using Windows credentials. If proxy accounts with the same name exist on sqlcluster, they will be skipped.
 
  .EXAMPLE
   Copy-DbaAgentProxyAccount -Source sqlserver2014a -Destination sqlcluster -ProxyAccount PSProxy -SourceSqlCredential $cred -Force
 
   Copies only the PSProxy proxy account from sqlserver2014a to sqlcluster using SQL credentials for sqlserver2014a and Windows credentials for sqlcluster. If a proxy account with the same name exists on sqlcluster, it will be dropped and recreated because -Force was used.
 
  .EXAMPLE
   Copy-DbaAgentProxyAccount -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)]
        [DbaInstanceParameter]$Source,
        [PSCredential]
        $SourceSqlCredential,
        [parameter(Mandatory = $true)]
        [DbaInstanceParameter]$Destination,
        [PSCredential]
        $DestinationSqlCredential,
        [switch]$Force,
        [switch]$Silent
    )

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

        $source = $sourceServer.DomainInstanceName
        $destination = $destServer.DomainInstanceName

        if ($sourceServer.VersionMajor -lt 9 -or $destServer.VersionMajor -lt 9) {
            throw "Server ProxyAccounts are only supported in SQL Server 2005 and above. Quitting."
        }

        $serverProxyAccounts = $sourceServer.JobServer.ProxyAccounts
        $destProxyAccounts = $destServer.JobServer.ProxyAccounts
    }
    process {
        foreach ($proxyAccount in $serverProxyAccounts) {
            $proxyName = $proxyAccount.Name

            $copyAgentProxyAccountStatus = [pscustomobject]@{
                SourceServer        = $sourceServer.Name
                DestinationServer   = $destServer.Name
                Name                = $null
                Type                = $null
                Status              = $null
                DateTime            = [Sqlcollaborative.Dbatools.Utility.DbaDateTime](Get-Date)
            }

            if ($proxyAccounts.Length -gt 0 -and $proxyAccounts -notcontains $proxyName) {
                continue
            }

            # Proxy accounts rely on Credential accounts
            $credentialName = $proxyAccount.CredentialName
            $copyAgentProxyAccountStatus.Name = $credentialName
            $copyAgentProxyAccountStatus.Type = "Credential"
            
            try {
                $credentialtest = $destServer.Credentials[$CredentialName]
            }
            catch {
                # don't care
            }
            
            if ($null -eq $credentialtest) {
                $copyAgentProxyAccountStatus.Status = "Skipped"
                $copyAgentProxyAccountStatus
                Write-Message -Level Warning -Message "Associated credential account, $CredentialName, does not exist on $destination. Skipping migration of $proxyName."
                continue
            }

            if ($destProxyAccounts.Name -contains $proxyName) {
                $copyAgentProxyAccountStatus.Name = $proxyName
                $copyAgentProxyAccountStatus.Type = "ProxyAccount"

                if ($force -eq $false) {
                    $copyAgentProxyAccountStatus.Status = "Skipped"
                    $copyAgentProxyAccountStatus
                    Write-Message -Level Warning -Message "Server proxy account $proxyName exists at destination. Use -Force to drop and migrate."
                    continue
                }
                else {
                    if ($Pscmdlet.ShouldProcess($destination, "Dropping server proxy account $proxyName and recreating")) {
                        try {
                            Write-Message -Level Verbose -Message "Dropping server proxy account $proxyName"
                            $destServer.JobServer.ProxyAccounts[$proxyName].Drop()
                        }
                        catch {
                            $copyAgentProxyAccountStatus.Status = "Failed"
                            $copyAgentProxyAccountStatus
                            Stop-Function -Message "Issue dropping proxy account" -Target $proxyName -InnerErrorRecord $_ -Continue
                        }
                    }
                }
            }

            if ($Pscmdlet.ShouldProcess($destination, "Creating server proxy account $proxyName")) {
                $copyAgentProxyAccountStatus.Name = $proxyName
                $copyAgentProxyAccountStatus.Type = "ProxyAccount"

                try {
                    Write-Message -Level Verbose -Message "Copying server proxy account $proxyName"
                    $sql = $proxyAccount.Script() | Out-String
                    Write-Message -Level Debug -Message $sql
                    $destServer.Query($sql)

# Will fixing this misspelled status cause problems downstream?
                    $copyAgentProxyAccountStatus.Status = "Successful"
                    $copyAgentProxyAccountStatus
                }
                catch {
                    $exceptionstring = $_.Exception.InnerException.ToString()
                    if ($exceptionstring -match 'subsystem') {
                        $copyAgentProxyAccountStatus.Status = "Skipping"
                        $copyAgentProxyAccountStatus

                        Write-Message -Level Warning -Message "One or more subsystems do not exist on the destination server. Skipping that part."
                    }
                    else {
                        $copyAgentProxyAccountStatus.Status = "Failed"
                        $copyAgentProxyAccountStatus

                        Stop-Function -Message "Issue creating proxy account" -Target $proxyName -InnerErrorRecord $_
                    }
                }
            }
        }
    }
    end {
        Test-DbaDeprecation -DeprecatedOn "1.0.0" -Silent:$false -Alias Copy-SqlProxyAccount
    }
}