functions/Copy-DbaAgentOperator.ps1
|
function Copy-DbaAgentOperator { <# .SYNOPSIS Copy-DbaAgentOperator migrates operators from one SQL Server to another. .DESCRIPTION By default, all operators are copied. The -Operators parameter is auto-populated for command-line completion and can be used to copy only specific operators. If the associated credentials for the operator do not exist on the destination, it will be skipped. If the operator 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 Operator The operator(s) to process. This list is auto-populated from the server. If unspecified, all operators will be processed. .PARAMETER ExcludeOperator The operators(s) to exclude. This list is 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 Operator 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, Agent, Operator Author: Chrissy LeMaire (@cl), netnerds.net Requires: sysadmin access on SQL Servers Website: https://dbatools.io Copyright: (C) Chrissy LeMaire, clemaire@gmail.com License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Copy-DbaAgentOperator .EXAMPLE Copy-DbaAgentOperator -Source sqlserver2014a -Destination sqlcluster Copies all operators from sqlserver2014a to sqlcluster using Windows credentials. If operators with the same name exist on sqlcluster, they will be skipped. .EXAMPLE Copy-DbaAgentOperator -Source sqlserver2014a -Destination sqlcluster -Operator PSOperator -SourceSqlCredential $cred -Force Copies only the PSOperator operator from sqlserver2014a to sqlcluster using SQL credentials for sqlserver2014a and Windows credentials for sqlcluster. If an operator with the same name exists on sqlcluster, it will be dropped and recreated because -Force was used. .EXAMPLE Copy-DbaAgentOperator -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[]]$Operator, [object[]]$ExcludeOperator, [switch]$Force, [switch][Alias('Silent')]$EnableException ) begin { $sourceServer = Connect-SqlInstance -SqlInstance $Source -SqlCredential $SourceSqlCredential $destServer = Connect-SqlInstance -SqlInstance $Destination -SqlCredential $DestinationSqlCredential $serverOperator = $sourceServer.JobServer.Operators $destOperator = $destServer.JobServer.Operators $failsafe = $destServer.JobServer.AlertSystem | Select-Object FailSafeOperator } process { foreach ($sOperator in $serverOperator) { $operatorName = $sOperator.Name $copyOperatorStatus = [pscustomobject]@{ SourceServer = $sourceServer.Name DestinationServer = $destServer.Name Name = $operatorName Type = "Agent Operator" Status = $null Notes = $null DateTime = [DbaDateTime](Get-Date) } if ($Operator -and $Operator -notcontains $operatorName -or $ExcludeOperator -in $operatorName) { continue } if ($destOperator.Name -contains $sOperator.Name) { if ($force -eq $false) { $copyOperatorStatus.Status = "Skipped" $copyOperatorStatus.Notes = "Already exists" $copyOperatorStatus | Select-DefaultView -Property DateTime, SourceServer, DestinationServer, Name, Type, Status, Notes -TypeName MigrationObject Write-Message -Level Verbose -Message "Operator $operatorName exists at destination. Use -Force to drop and migrate." continue } else { if ($failsafe.FailSafeOperator -eq $operatorName) { Write-Message -Level Verbose -Message "$operatorName is the failsafe operator. Skipping drop." continue } if ($Pscmdlet.ShouldProcess($destination, "Dropping operator $operatorName and recreating")) { try { Write-Message -Level Verbose -Message "Dropping Operator $operatorName" $destServer.JobServer.Operators[$operatorName].Drop() } catch { $copyOperatorStatus.Status = "Failed" $copyOperatorStatus | Select-DefaultView -Property DateTime, SourceServer, DestinationServer, Name, Type, Status, Notes -TypeName MigrationObject Stop-Function -Message "Issue dropping operator" -Category InvalidOperation -InnerErrorRecord $_ -Target $destServer -Continue } } } } if ($Pscmdlet.ShouldProcess($destination, "Creating Operator $operatorName")) { try { Write-Message -Level Verbose -Message "Copying Operator $operatorName" $sql = $sOperator.Script() | Out-String Write-Message -Level Debug -Message $sql $destServer.Query($sql) $copyOperatorStatus.Status = "Successful" $copyOperatorStatus | Select-DefaultView -Property DateTime, SourceServer, DestinationServer, Name, Type, Status, Notes -TypeName MigrationObject } catch { $copyOperatorStatus.Status = "Failed" $copyOperatorStatus | Select-DefaultView -Property DateTime, SourceServer, DestinationServer, Name, Type, Status, Notes -TypeName MigrationObject Stop-Function -Message "Issue creating operator." -Category InvalidOperation -InnerErrorRecord $_ -Target $destServer } } } } end { Test-DbaDeprecation -DeprecatedOn "1.0.0" -EnableException:$false -Alias Copy-SqlOperator } } |