-
Notifications
You must be signed in to change notification settings - Fork 107
SPTimerJobState
Brian Farnhill edited this page May 11, 2017
·
19 revisions
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name | Key | String | The internal name of the timer job (not the display name) | |
WebApplication | Write | String | The name of the web application that the timer job belongs to | |
Enabled | Write | Boolean | Should the timer job be enabled or not | |
Schedule | Write | String | The schedule for the timer job to execute on | |
InstallAccount | Write | String | POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 |
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.
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_DeadSiteDelete
{
Name = "job-dead-site-delete"
WebApplication = "http://sites.sharepoint.contoso.com"
Enabled = $false
Schedule ="weekly at sat 5:00"
PsDscRunAsCredential = $SetupAccount
}
}
}
- Home
- Getting Started
- Pre-requisites
- Installing the module
- Exporting SharePoint Configuration
- Creating Configuration Files
- Pre-created Examples
- Creating an Azure development environment
- Understanding Resources & Syntax
- Remote PowerShell Authentication
- Contributing to SharePointDsc
- Other useful modules for SharePoint DSC configurations