functions/Copy-DbaServerAudit.ps1
|
function Copy-DbaServerAudit { <# .SYNOPSIS Copy-DbaServerAudit migrates server audits from one SQL Server to another. .DESCRIPTION By default, all audits are copied. The -Audit parameter is auto-populated for command-line completion and can be used to copy only specific audits. If the audit 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 Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER Destination Destination SQL Server. You must have sysadmin access and the server must be SQL Server 2000 or higher. .PARAMETER DestinationSqlCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER Audit The audit(s) to process. Options for this list are auto-populated from the server. If unspecified, all audits will be processed. .PARAMETER ExcludeAudit The audit(s) 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 Force If this switch is enabled, the audits will be dropped and recreated on Destination. .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Tags: Migration Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT Requires: sysadmin access on SQL Servers .LINK https://dbatools.io/Copy-DbaServerAudit .EXAMPLE PS C:\> Copy-DbaServerAudit -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 PS C:\> Copy-DbaServerAudit -Source sqlserver2014a -Destination sqlcluster -Audit 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 PS C:\> Copy-DbaServerAudit -Source sqlserver2014a -Destination sqlcluster -WhatIf -Force Shows what would happen if the command were executed using force. #> [CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess)] param ( [parameter(Mandatory)] [DbaInstanceParameter]$Source, [PSCredential] $SourceSqlCredential, [parameter(Mandatory)] [DbaInstanceParameter[]]$Destination, [PSCredential] $DestinationSqlCredential, [object[]]$Audit, [object[]]$ExcludeAudit, [switch]$Force, [Alias('Silent')] [switch]$EnableException ) begin { try { $sourceServer = Connect-SqlInstance -SqlInstance $Source -SqlCredential $SourceSqlCredential -MinimumVersion 10 } catch { Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $Source return } $serverAudits = $sourceServer.Audits } process { if (Test-FunctionInterrupt) { return } foreach ($destinstance in $Destination) { try { $destServer = Connect-SqlInstance -SqlInstance $destinstance -SqlCredential $DestinationSqlCredential -MinimumVersion 10 } catch { Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $destinstance -Continue } $destAudits = $destServer.Audits foreach ($currentAudit in $serverAudits) { $auditName = $currentAudit.Name $copyAuditStatus = [pscustomobject]@{ SourceServer = $sourceServer.Name DestinationServer = $destServer.Name Name = $auditName Type = "Server Audit" Status = $null Notes = $null DateTime = [DbaDateTime](Get-Date) } if ($Audit -and $auditName -notin $Audit -or $auditName -in $ExcludeAudit) { continue } $sql = $currentAudit.Script() | Out-String if ($destAudits.Name -contains $auditName) { if ($force -eq $false) { if ($Pscmdlet.ShouldProcess($destinstance, "Server audit $auditName exists at destination. Use -Force to drop and migrate.")) { $copyAuditStatus.Status = "Skipped" $copyAuditStatus.Notes = "Already exists" Write-Message -Level Verbose -Message "Server audit $auditName exists at destination. Use -Force to drop and migrate." } continue } else { if ($Pscmdlet.ShouldProcess($destinstance, "Dropping server audit $auditName")) { try { Write-Message -Level Verbose -Message "Dropping server audit $auditName." foreach ($spec in $destServer.ServerAuditSpecifications) { if ($auditSpecification.Auditname -eq $auditName) { $auditSpecification.Drop() } } $destServer.audits[$auditName].Disable() $destServer.audits[$auditName].Alter() $destServer.audits[$auditName].Drop() } catch { $copyAuditStatus.Status = "Failed" $copyAuditStatus | Select-DefaultView -Property DateTime, SourceServer, DestinationServer, Name, Type, Status, Notes -TypeName MigrationObject Stop-Function -Message "Issue dropping audit from destination." -Target $auditName -ErrorRecord $_ } } } } if ($null -ne ($currentAudit.Filepath) -and -not (Test-DbaPath -SqlInstance $destServer -Path $currentAudit.Filepath)) { if ($Force -eq $false) { if ($Pscmdlet.ShouldProcess($destinstance, "$($currentAudit.Filepath) does not exist on $destinstance. Skipping $auditName. Specify -Force to create the directory.")) { $copyAuditStatus.Status = "Skipped" $copyAuditStatus.Notes = "$($currentAudit.Filepath) does not exist on $destinstance. Skipping $auditName. Specify -Force to create the directory." $copyAuditStatus | Select-DefaultView -Property DateTime, SourceServer, DestinationServer, Name, Type, Status, Notes -TypeName MigrationObject } continue } else { Write-Message -Level Verbose -Message "Force specified. Creating directory." $destNetBios = Resolve-NetBiosName $destServer #Variable marked as unused by PSScriptAnalyzer #$path = Join-AdminUnc $destNetBios $currentAudit.Filepath $root = $currentAudit.Filepath.Substring(0, 3) $rootUnc = Join-AdminUnc $destNetBios $root if ((Test-Path $rootUnc) -eq $true) { if ($Pscmdlet.ShouldProcess($destinstance, "Creating directory $($currentAudit.Filepath)")) { try { $null = New-DbaDirectory -SqlInstance $destServer -Path $currentAudit.Filepath -EnableException } catch { Write-Message -Level Warning -Message "Couldn't create directory $($currentAudit.Filepath). Using default data directory." $datadir = Get-SqlDefaultPaths $destServer data $sql = $sql.Replace($currentAudit.FilePath, $datadir) } } } else { $datadir = Get-SqlDefaultPaths $destServer data $sql = $sql.Replace($currentAudit.FilePath, $datadir) } } } if ($Pscmdlet.ShouldProcess($destinstance, "Creating server audit $auditName")) { try { Write-Message -Level Verbose -Message "File path $($currentAudit.Filepath) exists on $destinstance." Write-Message -Level Verbose -Message "Copying server audit $auditName." $destServer.Query($sql) $copyAuditStatus.Status = "Successful" $copyAuditStatus | Select-DefaultView -Property DateTime, SourceServer, DestinationServer, Name, Type, Status, Notes -TypeName MigrationObject } catch { $copyAuditStatus.Status = "Failed" $copyAuditStatus.Notes = (Get-ErrorMessage -Record $_) $copyAuditStatus | Select-DefaultView -Property DateTime, SourceServer, DestinationServer, Name, Type, Status, Notes -TypeName MigrationObject Stop-Function -Message "Issue creating audit." -Target $auditName -ErrorRecord $_ } } } } } end { Test-DbaDeprecation -DeprecatedOn "1.0.0" -EnableException:$false -Alias Copy-SqlAudit } } |