DSCResources/MSFT_SPTimerJobState/MSFT_SPTimerJobState.psm1

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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [parameter(Mandatory = $false)]
        [System.String]
        $WebApplication,

        [parameter(Mandatory = $false)]
        [System.Boolean]
        $Enabled,

        [parameter(Mandatory = $false)]
        [System.String]
        $Schedule,

        [parameter(Mandatory = $false)]
        [System.Management.Automation.PSCredential]
        $InstallAccount
    )

    Write-Verbose -Message "Getting timer job settings for job '$Name'"

    $result = Invoke-SPDSCCommand -Credential $InstallAccount `
                                  -Arguments $PSBoundParameters `
                                  -ScriptBlock {
        $params = $args[0]
        
        try 
        {
            $spFarm = Get-SPFarm
        } 
        catch 
        {
            Write-Verbose -Message ("No local SharePoint farm was detected. Timer job " + `
                                    "settings will not be applied")
            return $null
        }

        # Get a reference to the timer job
        if ($params.ContainsKey("WebApplication")) 
        {
            $timerjob = Get-SPTimerJob -Identity $params.Name `
                                       -WebApplication $params.WebApplication
        } 
        else 
        {
            $timerjob = Get-SPTimerJob $params.Name
        }

        # Check if timer job if found
        if ($null -eq $timerjob) 
        { 
            return $null 
        }
        
        $schedule = $null
        if ($null -ne $timerjob.Schedule) 
        {
            $schedule = $timerjob.Schedule.ToString()
        }
        
        if ($null -eq $timerjob.WebApplication) 
        {
            # Timer job is not associated to web application
            return @{
                Name = $params.Name
                Enabled = -not $timerjob.IsDisabled
                Schedule = $schedule
                InstallAccount = $params.InstallAccount
            }
        } 
        else 
        {
            # Timer job is associated to web application
            return @{
                Name = $params.Name
                WebApplication = $timerjob.WebApplication.Url
                Enabled = -not $timerjob.IsDisabled
                Schedule = $schedule
                InstallAccount = $params.InstallAccount
            }
        }
    }
    return $result
}

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [parameter(Mandatory = $false)]
        [System.String]
        $WebApplication,

        [parameter(Mandatory = $false)]
        [System.Boolean]
        $Enabled,

        [parameter(Mandatory = $false)]
        [System.String]
        $Schedule,

        [parameter(Mandatory = $false)]
        [System.Management.Automation.PSCredential]
        $InstallAccount
    )

    Write-Verbose -Message "Setting timer job settings for job '$Name'"

    Invoke-SPDSCCommand -Credential $InstallAccount `
                        -Arguments $PSBoundParameters `
                        -ScriptBlock {

        $params = $args[0]

        try 
        {
            $spFarm = Get-SPFarm
        } 
        catch 
        {
            throw "No local SharePoint farm was detected. Timer job settings will not be applied"
            return
        }
        
        Write-Verbose -Message "Start update"

        #find Timer Job
        if ($params.ContainsKey("WebApplication") -eq $true) 
        {
            $job = Get-SPTimerJob $params.Name -WebApplication $params.WebApplication
        } 
        else 
        {
            $job = Get-SPTimerJob $params.Name
        }

        if ($job.GetType().IsArray -eq $false) 
        {
            # Set the timer job settings
            if ($params.ContainsKey("Enabled") -eq $true) 
            { 
                # Enable/Disable timer job
                if ($params.Enabled) 
                {
                    Write-Verbose -Message "Enable timer job $($params.Name)"
                    try 
                    {
                        Enable-SPTimerJob $job
                    }
                    catch 
                    {
                        throw ("Error occurred while enabling job. Timer job settings will " + `
                               "not be applied. Error details: $($_.Exception.Message)")
                        return
                    }
                } 
                else 
                {
                    Write-Verbose -Message "Disable timer job $($params.Name)"
                    try 
                    {
                        Disable-SPTimerJob $job
                    } 
                    catch 
                    {
                        throw ("Error occurred while disabling job. Timer job settings will " + `
                               "not be applied. Error details: $($_.Exception.Message)")
                        return
                    }
                }
            }

            if ($params.ContainsKey("Schedule") -eq $true) 
            {
                # Set timer job schedule
                Write-Verbose -Message "Set timer job $($params.Name) schedule"
                try 
                {
                    Set-SPTimerJob $job -Schedule $params.Schedule -ErrorAction Stop
                } 
                catch 
                {
                    if ($_.Exception.Message -like "*The time given was not given in the proper format*") 
                    {
                        throw "Incorrect schedule format used. New schedule will not be applied."
                        return
                    } 
                    else 
                    {
                        throw ("Error occurred. Timer job settings will not be applied. Error " + `
                               "details: $($_.Exception.Message)")
                        return
                    }
                }
            }
        } 
        else 
        {
            throw "Could not find specified job. Total jobs found: $($job.Count)"
            return
        }
    }
}

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [parameter(Mandatory = $false)]
        [System.String]
        $WebApplication,

        [parameter(Mandatory = $false)]
        [System.Boolean]
        $Enabled,

        [parameter(Mandatory = $false)]
        [System.String]
        $Schedule,

        [parameter(Mandatory = $false)]
        [System.Management.Automation.PSCredential]
        $InstallAccount
    )

    Write-Verbose -Message "Testing timer job settings for job '$Name'"

    $CurrentValues = Get-TargetResource @PSBoundParameters

    if ($null -eq $CurrentValues) 
    { 
        return $false 
    }

    return Test-SPDscParameterState -CurrentValues $CurrentValues `
                                    -DesiredValues $PSBoundParameters
}

Export-ModuleMember -Function *-TargetResource