Skip to content

Copy-DbaAgentJob - Add -NewName parameter to allow copying jobs to sa… #10371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
frodr1k wants to merge 1 commit into
base: development
Choose a base branch
from
+102 −21
Open

Copy-DbaAgentJob - Add -NewName parameter to allow copying jobs to sa… #10371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 45 additions & 21 deletions public/Copy-DbaAgentJob.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ function Copy-DbaAgentJob {
Overwrites existing jobs on the destination server and automatically sets missing job owners to the 'sa' login.
Use this when you need to replace existing jobs or when source job owners don't exist on the destination server during migrations.

.PARAMETER NewName
The new name for the job on the destination server.
Required when source and destination are the same server instance. Use this to create a copy of a job under a different name on the same or a different server.
Cannot be used when copying multiple jobs simultaneously.

.PARAMETER UseLastModified
When enabled, compares the last modification date (date_modified) from msdb.dbo.sysjobs between source and destination instances.
Jobs are only copied or updated if the source job is newer than the destination job. This provides intelligent synchronization:
Expand Down Expand Up @@ -120,6 +125,11 @@ function Copy-DbaAgentJob {
PS C:\> Copy-DbaAgentJob -Source sqlserver2014a -Destination sqlserver2014b -UseLastModified

Copies jobs from sqlserver2014a to sqlserver2014b, but only creates new jobs or updates existing jobs where the source job has a newer date_modified timestamp. Jobs with matching timestamps are skipped.

.EXAMPLE
PS C:\> Copy-DbaAgentJob -Source sqlserver2014a -Destination sqlserver2014a -Job "OriginalJob" -NewName "JobCopy"

Copies the job "OriginalJob" on sqlserver2014a to the same server as "JobCopy". When source and destination are the same instance, -NewName is required.
#>
[cmdletbinding(DefaultParameterSetName = "Default", SupportsShouldProcess, ConfirmImpact = "Medium")]
param (
Expand All @@ -133,6 +143,7 @@ function Copy-DbaAgentJob {
[switch]$DisableOnSource,
[switch]$DisableOnDestination,
[switch]$Force,
[string]$NewName,
[switch]$UseLastModified,
[parameter(ValueFromPipeline)]
[Microsoft.SqlServer.Management.Smo.Agent.Job[]]$InputObject,
Expand All @@ -157,6 +168,10 @@ function Copy-DbaAgentJob {
return
}
}
if ((Test-Bound "NewName") -and $InputObject.Count -gt 1) {
Stop-Function -Message "Cannot use -NewName when copying multiple jobs"
return
}
if ($Force) { $ConfirmPreference = 'none' }
}
process {
Expand All @@ -174,11 +189,16 @@ function Copy-DbaAgentJob {
$jobId = $serverJob.JobId
$sourceserver = $serverJob.Parent.Parent
$alertsReferencingJob = @()
$destJobName = if (Test-Bound "NewName") { $NewName } else { $jobName }

if ($sourceserver.Name -eq $destServer.Name -and -not (Test-Bound "NewName")) {
Stop-Function -Message "Source and destination are the same server ($($destServer.Name)). Use -NewName to copy job [$jobName] with a different name on the same server." -Continue
}

$copyJobStatus = [PSCustomObject]@{
SourceServer = $sourceserver.Name
DestinationServer = $destServer.Name
Name = $jobName
Name = $destJobName
Type = "Agent Job"
Status = $null
Notes = $null
Expand Down Expand Up @@ -290,7 +310,7 @@ function Copy-DbaAgentJob {
continue
}

if ($destJobs.name -contains $serverJob.name) {
if ($destJobs.name -contains $destJobName) {
if ($UseLastModified) {
# Query date_modified from both source and destination using parameterized queries
try {
Expand All @@ -306,7 +326,7 @@ function Copy-DbaAgentJob {
SqlInstance = $destServer
Database = "msdb"
Query = "SELECT date_modified FROM dbo.sysjobs WHERE name = @jobName"
SqlParameter = @{ jobName = $jobName }
SqlParameter = @{ jobName = $destJobName }
}
$destDate = (Invoke-DbaQuery @splatDestDate).date_modified

Expand All @@ -323,19 +343,19 @@ function Copy-DbaAgentJob {
}
} elseif ($sourceDate -gt $destDate) {
# Source is newer, proceed with drop and recreate
if ($Pscmdlet.ShouldProcess($destinstance, "Source job is newer (modified $sourceDate). Dropping and recreating job $jobName")) {
if ($Pscmdlet.ShouldProcess($destinstance, "Source job is newer (modified $sourceDate). Dropping and recreating job $destJobName")) {
try {
Write-Message -Message "Source job $jobName is newer. Dropping and recreating." -Level Verbose
Write-Message -Message "Source job $jobName is newer. Dropping and recreating $destJobName." -Level Verbose
# Before dropping, save which alerts reference this job
$splatAlertsForJob = @{
SqlInstance = $destServer
Database = "msdb"
Query = "SELECT name FROM dbo.sysalerts WHERE job_id = (SELECT job_id FROM dbo.sysjobs WHERE name = @jobName)"
SqlParameter = @{ jobName = $jobName }
SqlParameter = @{ jobName = $destJobName }
}
$alertsReferencingJob = (Invoke-DbaQuery @splatAlertsForJob).name
Write-Message -Message "Found $($alertsReferencingJob.Count) alert(s) referencing job $jobName" -Level Verbose
$destServer.JobServer.Jobs[$jobName].Drop()
Write-Message -Message "Found $($alertsReferencingJob.Count) alert(s) referencing job $destJobName" -Level Verbose
$destServer.JobServer.Jobs[$destJobName].Drop()
} catch {
$copyJobStatus.Status = "Failed"
$copyJobStatus.Notes = (Get-ErrorMessage -Record $_).Message
Expand Down Expand Up @@ -384,19 +404,19 @@ function Copy-DbaAgentJob {
}
continue
} else {
if ($Pscmdlet.ShouldProcess($destinstance, "Dropping job $jobName and recreating")) {
if ($Pscmdlet.ShouldProcess($destinstance, "Dropping job $destJobName and recreating")) {
try {
Write-Message -Message "Dropping Job $jobName" -Level Verbose
Write-Message -Message "Dropping Job $destJobName" -Level Verbose
# Before dropping, save which alerts reference this job
$splatAlertsForJob = @{
SqlInstance = $destServer
Database = "msdb"
Query = "SELECT name FROM dbo.sysalerts WHERE job_id = (SELECT job_id FROM dbo.sysjobs WHERE name = @jobName)"
SqlParameter = @{ jobName = $jobName }
SqlParameter = @{ jobName = $destJobName }
}
$alertsReferencingJob = (Invoke-DbaQuery @splatAlertsForJob).name
Write-Message -Message "Found $($alertsReferencingJob.Count) alert(s) referencing job $jobName" -Level Verbose
$destServer.JobServer.Jobs[$jobName].Drop()
Write-Message -Message "Found $($alertsReferencingJob.Count) alert(s) referencing job $destJobName" -Level Verbose
$destServer.JobServer.Jobs[$destJobName].Drop()
} catch {
$copyJobStatus.Status = "Failed"
$copyJobStatus.Notes = (Get-ErrorMessage -Record $_).Message
Expand All @@ -408,9 +428,9 @@ function Copy-DbaAgentJob {
}
}

if ($Pscmdlet.ShouldProcess($destinstance, "Creating Job $jobName")) {
if ($Pscmdlet.ShouldProcess($destinstance, "Creating Job $destJobName")) {
try {
Write-Message -Message "Copying Job $jobName" -Level Verbose
Write-Message -Message "Copying Job $jobName as $destJobName" -Level Verbose
$sql = $serverJob.Script() | Out-String

if ($missingLogin.Count -gt 0 -and $force) {
Expand All @@ -420,12 +440,16 @@ function Copy-DbaAgentJob {

$sql = $sql -replace [Regex]::Escape("@server=N'$($sourceserver.DomainInstanceName)'"), "@server=N'$($destServer.DomainInstanceName)'"

if (Test-Bound "NewName") {
$sql = $sql -replace [Regex]::Escape("@job_name=N'$jobName'"), "@job_name=N'$NewName'"
}

Write-Message -Message $sql -Level Debug
$destServer.Query($sql)

$destServer.JobServer.Jobs.Refresh()
$destServer.JobServer.Jobs[$serverJob.name].IsEnabled = $sourceServer.JobServer.Jobs[$serverJob.name].IsEnabled
$destServer.JobServer.Jobs[$serverJob.name].Alter()
$destServer.JobServer.Jobs[$destJobName].IsEnabled = $sourceServer.JobServer.Jobs[$serverJob.name].IsEnabled
$destServer.JobServer.Jobs[$destJobName].Alter()

# Restore alert-to-job links if job was dropped and recreated
if ($alertsReferencingJob -and $alertsReferencingJob.Count -gt 0) {
Expand Down Expand Up @@ -461,10 +485,10 @@ function Copy-DbaAgentJob {
}

if ($DisableOnDestination) {
if ($Pscmdlet.ShouldProcess($destinstance, "Disabling $jobName")) {
Write-Message -Message "Disabling $jobName on $destinstance" -Level Verbose
$destServer.JobServer.Jobs[$serverJob.name].IsEnabled = $False
$destServer.JobServer.Jobs[$serverJob.name].Alter()
if ($Pscmdlet.ShouldProcess($destinstance, "Disabling $destJobName")) {
Write-Message -Message "Disabling $destJobName on $destinstance" -Level Verbose
$destServer.JobServer.Jobs[$destJobName].IsEnabled = $False
$destServer.JobServer.Jobs[$destJobName].Alter()
}
}

Expand Down
57 changes: 57 additions & 0 deletions tests/Copy-DbaAgentJob.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Describe $CommandName -Tag UnitTests {
"DisableOnSource",
"DisableOnDestination",
"Force",
"NewName",
"UseLastModified",
"InputObject",
"EnableException"
Expand Down Expand Up @@ -261,4 +262,60 @@ WHERE a.name = '$testAlertName'
$alertCheck.JobName | Should -Be $testJobWithAlert
}
}

Context "-NewName parameter" {
BeforeAll {
$PSDefaultParameterValues["*-Dba*:EnableException"] = $true
$sourceNewNameJob = "dbatoolsci_newname_source"
$null = New-DbaAgentJob -SqlInstance $TestConfig.InstanceCopy1 -Job $sourceNewNameJob
$PSDefaultParameterValues.Remove("*-Dba*:EnableException")
}

AfterAll {
$PSDefaultParameterValues["*-Dba*:EnableException"] = $true
$null = Remove-DbaAgentJob -SqlInstance $TestConfig.InstanceCopy1 -Job "dbatoolsci_newname_source", "dbatoolsci_newname_copy" -ErrorAction SilentlyContinue
$null = Remove-DbaAgentJob -SqlInstance $TestConfig.InstanceCopy2 -Job "dbatoolsci_newname_renamed" -ErrorAction SilentlyContinue
$PSDefaultParameterValues.Remove("*-Dba*:EnableException")
}

It "copies job to same server with new name" {
$splatSameServer = @{
Source = $TestConfig.InstanceCopy1
Destination = $TestConfig.InstanceCopy1
Job = $sourceNewNameJob
NewName = "dbatoolsci_newname_copy"
}
$result = Copy-DbaAgentJob @splatSameServer

$result.Name | Should -Be "dbatoolsci_newname_copy"
$result.Status | Should -Be "Successful"
$copiedJob = Get-DbaAgentJob -SqlInstance $TestConfig.InstanceCopy1 -Job "dbatoolsci_newname_copy"
$copiedJob | Should -Not -BeNullOrEmpty
}

It "fails when copying to same server without -NewName" {
$splatNoNewName = @{
Source = $TestConfig.InstanceCopy1
Destination = $TestConfig.InstanceCopy1
Job = $sourceNewNameJob
EnableException = $true
}
{ Copy-DbaAgentJob @splatNoNewName } | Should -Throw
}

It "copies job to different server with new name" {
$splatDiffServer = @{
Source = $TestConfig.InstanceCopy1
Destination = $TestConfig.InstanceCopy2
Job = $sourceNewNameJob
NewName = "dbatoolsci_newname_renamed"
}
$result = Copy-DbaAgentJob @splatDiffServer

$result.Name | Should -Be "dbatoolsci_newname_renamed"
$result.Status | Should -Be "Successful"
$renamedJob = Get-DbaAgentJob -SqlInstance $TestConfig.InstanceCopy2 -Job "dbatoolsci_newname_renamed"
$renamedJob | Should -Not -BeNullOrEmpty
}
}
}