functions/Copy-DbaServerAuditSpecification.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
function Copy-DbaServerAuditSpecification {
    <#
  .SYNOPSIS
   Copy-DbaServerAuditSpecification migrates server audit specifications from one SQL Server to another.
 
  .DESCRIPTION
   By default, all audits are copied. The -AuditSpecification parameter is auto-populated for command-line completion and can be used to copy only specific audits.
 
   If the audit specification 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 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 Destination
   Destination Sql Server. You must have sysadmin access and server version must be SQL Server version 2000 or greater.
 
  .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 AuditSpecification
   The Server Audit Specification(s) to process - this list is auto-populated from the server. If unspecified, all Server Audit Specifications will be processed.
 
  .PARAMETER ExcludeAuditSpecification
   The Server Audit Specification(s) to exclude - this list is auto-populated from the server
 
  .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 Audit Specification if it exists
 
  .PARAMETER Silent
   Use this switch to disable any kind of verbose messages
 
  .NOTES
   Tags: Migration,ServerAudit,AuditSpecification
   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-DbaServerAuditSpecification
 
  .EXAMPLE
   Copy-DbaServerAuditSpecification -Source sqlserver2014a -Destination sqlcluster
 
   Copies all server audits from sqlserver2014a to sqlcluster, using Windows credentials. If audits with the same name exist on sqlcluster, they will be skipped.
 
  .EXAMPLE
   Copy-DbaServerAuditSpecification -Source sqlserver2014a -Destination sqlcluster -ServerAuditSpecification tg_noDbDrop -SourceSqlCredential $cred -Force
 
   Copies a single audit, the tg_noDbDrop audit from sqlserver2014a to sqlcluster, using SQL credentials for sqlserver2014a and Windows credentials for sqlcluster. If an audit with the same name exists on sqlcluster, it will be dropped and recreated because -Force was used.
 
  .EXAMPLE
   Copy-DbaServerAuditSpecification -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,
        [object[]]$AuditSpecification,
        [object[]]$ExcludeAuditSpecification,
        [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 (!(Test-SqlSa -SqlInstance $sourceServer -SqlCredential $SourceSqlCredential)) {
            Stop-Function -Message "Not a sysadmin on $source. Quitting."
            return
        }

        if (!(Test-SqlSa -SqlInstance $destServer -SqlCredential $DestinationSqlCredential)) {
            Stop-Function -Message "Not a sysadmin on $destination. Quitting."
            return
        }

        if ($sourceServer.VersionMajor -lt 10 -or $destServer.VersionMajor -lt 10) {
            Stop-Function -Message "Server Audit Specifications are only supported in SQL Server 2008 and above. Quitting."
            return
        }

        if ($destServer.VersionMajor -lt $sourceServer.VersionMajor) {
            Stop-Function -Message "Migration from version $($destServer.VersionMajor) to version $($sourceServer.VersionMajor) is not supported."
            return
        }

        $AuditSpecifications = $sourceServer.ServerAuditSpecifications
        $destAudits = $destServer.ServerAuditSpecifications
    }
    process {
        if (Test-FunctionInterrupt) { return }

        foreach ($auditSpec in $AuditSpecifications) {
            $auditSpecName = $auditSpec.Name

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

            if ($AuditSpecification -and $auditSpecName -notin $AuditSpecification -or $auditSpecName -in $ExcludeAuditSpecification) {
                continue
            }

            $destServer.Audits.Refresh()

            if ($destServer.Audits.Name -notcontains $auditSpec.AuditName) {
                Write-Message -Level Warning -Message "Audit $($auditSpec.AuditName) does not exist on $Destination. Skipping $auditSpecName."
                continue
            }

            if ($destAudits.name -contains $auditSpecName) {
                if ($force -eq $false) {
                    Write-Message -Level Warning -Message "Server audit $auditSpecName exists at destination. Use -Force to drop and migrate."

                    $copyAuditSpecStatus.Status = "Skipped"
                    $copyAuditSpecStatus
                    continue
                }
                else {
                    if ($Pscmdlet.ShouldProcess($destination, "Dropping server audit $auditSpecName and recreating")) {
                        try {
                            Write-Message -Level Verbose -Message "Dropping server audit $auditSpecName"
                            $destServer.ServerAuditSpecifications[$auditSpecName].Drop()
                        }
                        catch {
                            $copyAuditSpecStatus.Status = "Failed"
                            $copyAuditSpecStatus.Notes = $_.Exception
                            $copyAuditSpecStatus

                            Stop-Function -Message "Issue dropping audit spec" -Target $auditSpecName -ErrorRecord $_ -Continue
                        }
                    }
                }
            }
            if ($Pscmdlet.ShouldProcess($destination, "Creating server audit $auditSpecName")) {
                try {
                    Write-Message -Level Verbose -Message "Copying server audit $auditSpecName"
                    $sql = $auditSpec.Script() | Out-String
                    Write-Message -Level Debug -Message $sql
                    $destServer.Query($sql)

                    $copyAuditSpecStatus.Status = "Successful"
                    $copyAuditSpecStatus
                }
                catch {
                    $copyAuditSpecStatus.Status = "Failed"
                    $copyAuditSpecStatus.Notes = $_.Exception
                    $copyAuditSpecStatus

                    Stop-Function -Message "Issue creating audit spec on destination" -Target $auditSpecName -ErrorRecord $_
                }
            }
        }
    }
    end {
        Test-DbaDeprecation -DeprecatedOn "1.0.0" -Silent:$false -Alias Copy-SqlAuditSpecification
    }
}