en-US/about_SPTimerJobState.help.txt

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
.NAME
    SPTimerJobState

# Description
    
    **Type:** Distributed
    
    This resource is used to configure a timer job and make sure it is in a
    specific state. The resource can be used to enable or disabled the job and
    configure the schedule of the job.
    
    The schedule parameter has to be written in the SPSchedule format
    (https://technet.microsoft.com/en-us/library/ff607916.aspx).
    
    Examples are:
    
    - Every 5 minutes between 0 and 59
    - Hourly between 0 and 59
    - Daily at 15:00:00
    - Weekly between Fri 22:00:00 and Sun 06:00:00
    - Monthly at 15 15:00:00
    - Yearly at Jan 1 15:00:00
    
    NOTE:
    Make sure you use the typename timer job name, not the display name! Use
    "Get-SPTimerJob | Where-Object { $_.Title -eq "\<Display Name\>" } | Select typename"
    to find the typename for each Timer Job.
    
    NOTE2: You cannot use SPTimerJobState to change the Health Analyzer jobs, because
    these are configured to specific times by default.
    
.PARAMETER TypeName
    Key - String
    The type name of the timer job (not the display name)

.PARAMETER WebAppUrl
    Key - String
    The URL of the web application that the timer job belongs to. Use the value 'N/A' if no web application is applicable

.PARAMETER Enabled
    Write - Boolean
    Should the timer job be enabled or not

.PARAMETER Schedule
    Write - String
    The schedule for the timer job to execute on

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    This example show how to disable the dead site delete job in the local farm.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPTimerJobState DisableTimerJob_AppServerJob
            {
                TypeName             = "Microsoft.Office.Server.Administration.ApplicationServerJob"
                WebAppUrl            = "http://sites.sharepoint.contoso.com"
                Enabled              = $false
                Schedule             ="weekly at sat 5:00"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }