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
|
#!powershell
# -*- coding: utf-8 -*-
# (c) 2022, John McCall (@lowlydba)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#AnsibleRequires -CSharpUtil Ansible.Basic
#AnsibleRequires -PowerShell ansible_collections.lowlydba.sqlserver.plugins.module_utils._SqlServerUtils
#Requires -Modules @{ ModuleName="dbatools"; ModuleVersion="2.0.0" }
$ErrorActionPreference = "Stop"
$spec = @{
supports_check_mode = $true
options = @{
job = @{type = 'str'; required = $true }
description = @{type = 'str'; required = $false; }
category = @{type = 'str'; required = $false; }
enabled = @{type = 'bool'; required = $false; default = $true }
owner_login = @{type = 'str'; required = $false; }
start_step_id = @{type = 'int'; required = $false; }
schedule = @{type = 'str'; required = $false; }
force = @{type = 'bool'; required = $false; default = $false }
state = @{type = 'str'; required = $false; default = 'present'; choices = @('present', 'absent') }
}
}
$module = [Ansible.Basic.AnsibleModule]::Create($args, $spec, @(Get-LowlyDbaSqlServerAuthSpec))
$sqlInstance, $sqlCredential = Get-SqlCredential -Module $module
$job = $module.Params.job
$description = $module.Params.description
$enabled = $module.Params.enabled
$ownerLogin = $module.Params.owner_login
$category = $module.Params.category
$schedule = $module.Params.schedule
[nullable[int]]$startStepId = $module.Params.start_step_id
$force = $module.Params.force
$state = $module.Params.state
$checkMode = $module.CheckMode
$module.Result.changed = $false
# Configure Agent job
try {
$existingJob = Get-DbaAgentJob -SqlInstance $sqlInstance -SqlCredential $sqlCredential -Job $job -EnableException
$output = $existingJob
if ($state -eq "absent") {
if ($null -ne $existingJob) {
$output = $existingJob | Remove-DbaAgentJob -Confirm:$false -WhatIf:$checkMode -EnableException
$module.Result.changed = $true
}
}
elseif ($state -eq "present") {
$jobParams = @{
SqlInstance = $sqlInstance
SqlCredential = $sqlCredential
Job = $job
WhatIf = $checkMode
Force = $force
EnableException = $true
}
if ($enabled -eq $false) {
$jobParams.add("Disabled", $true)
}
if ($null -ne $ownerLogin) {
$jobParams.add("OwnerLogin", $ownerLogin)
}
if ($null -ne $schedule) {
$jobParams.add("Schedule", $schedule)
}
if ($null -ne $category) {
$jobParams.add("Category", $category)
}
if ($null -ne $description) {
$jobParams.add("Description", $description)
}
if ($null -ne $startStepID) {
$jobParams.add("StartStepId", $startStepID)
}
# Create new job
if ($null -eq $existingJob) {
try {
$null = New-DbaAgentJob @jobParams
# Explicitly fetch the new job to make sure results don't suffer from SMO / Agent stale data bugs
$output = Get-DbaAgentJob -SqlInstance $sqlInstance -SqlCredential $sqlCredential -Job $job -EnableException
}
catch {
$module.FailJson("Failed creating new agent job: $($_.Exception.Message)", $_)
}
$module.Result.changed = $true
}
# Job exists
else {
# Need to serialize to prevent SMO auto refreshing
$old = ConvertTo-SerializableObject -InputObject $existingJob -UseDefaultProperty $false
if ($enabled -eq $true) {
$jobParams.Add("Enabled", $true)
}
$output = Set-DbaAgentJob @jobParams
if ($null -ne $output) {
$compareProperty = @(
"Category"
"Enabled"
"Name"
"OwnerLoginName"
"HasSchedule"
"Description"
"StartStepId"
)
$diff = Compare-Object -ReferenceObject $output -DifferenceObject $old -Property $compareProperty
if ($diff -or $checkMode) {
$module.Result.changed = $true
}
}
}
}
if ($output) {
$resultData = ConvertTo-SerializableObject -InputObject $output
$module.Result.data = $resultData
}
$module.ExitJson()
}
catch {
$module.FailJson("Error configuring SQL Agent job: $($_.Exception.Message)", $_)
}
|
