SharePointDSC

1.2.0.0

DSCResources/MSFT_SPTimerJobState/MSFT_SPTimerJobState.schema.mof

/*
**Description**
 
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 internal timer job name, not the display name!
Use "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" to find the internal name for each Timer Job.
 
**Example**
 
    SPTimerJobState DisableTimerJob_DeadSiteDelete
    {
        Name = "job-dead-site-delete"
        WebApplication = "http://sites.sharepoint.contoso.com"
        Enabled = $true
        Schedule ="weekly at sat 5:00"
        PsDscRunAsCredential = $InstallAccount
    }
*/
 
[ClassVersion("1.0.0.0"), FriendlyName("SPTimerJobState")]
class MSFT_SPTimerJobState : OMI_BaseResource
{
    [Key, Description("The internal name of the timer job (not the display name)")] String Name;
    [Write, Description("The name of the web application that the timer job belongs to")] String WebApplication;
    [Write, Description("Should the timer job be enabled or not")] Boolean Enabled;
    [Write, Description("The schedule for the timer job to execute on")] String Schedule;
    [Write, Description("POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5"), EmbeddedInstance("MSFT_Credential")] String InstallAccount;
};