Resource Type: dsc_sptimerjobstate

Defined in:
lib/puppet/type/dsc_sptimerjobstate.rb
Providers:
powershell

Overview

The DSC SPTimerJobState resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPTimerJobState/MSFT_SPTimerJobState.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

  • ensure

    The basic property that the resource should be in.

    Supported values:
    • exists?
    • present

Parameters

  • dsc_enabled

    Enabled - Should the timer job be enabled or not

    Supported values:
    • true
    • false
  • dsc_installaccount

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

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_schedule

    Schedule - The schedule for the timer job to execute on

  • dsc_typename

    TypeName - The type name of the timer job (not the display name)

  • dsc_webappurl

    WebAppUrl - The URL of the web application that the timer job belongs to. Use the value ‘N/A’ if no web application is applicable

  • name (namevar)
  • provider

    The specific backend to use for this ‘dsc_sptimerjobstate` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.