Resource Type: dsc_scheduledtask

Defined in:

lib/puppet/type/dsc_scheduledtask.rb

Overview

The DSC ScheduledTask resource type. Automatically generated from version 9.1.0

Properties

• dsc_actionarguments

  The arguments to pass the executable.

• dsc_actionexecutable

  The path to the .exe for this task.

• dsc_actionworkingpath

  The working path to specify for the executable.

• dsc_allowstartifonbatteries

  Indicates whether the task should start if the machine is on batteries or not. Defaults to $false.

• dsc_builtinaccount

  Run the task as one of the built in service accounts. When set ExecuteAsCredential will be ignored and LogonType will be set to ‘ServiceAccount’.

• dsc_compatibility

  The task compatibility level. Defaults to Vista.

• dsc_daysinterval

  Specifies the interval between the days in the schedule. An interval of 1 produces a daily schedule. An interval of 2 produces an every-other day schedule.

• dsc_daysofweek

  Specifies an array of the days of the week on which Task Scheduler runs the task.

• dsc_delay

  Specifies a delay to the start of the trigger. The delay is a static delay before the task is executed. Can only be used in combination with ScheduleType OnEvent.

• dsc_description

  The task description.

• dsc_disallowdemandstart

  Indicates whether the task is prohibited to run on demand or not. Defaults to $false.

• dsc_disallowhardterminate

  Indicates whether the task is prohibited to be terminated or not. Defaults to $false.

• dsc_disallowstartonremoteappsession

  Indicates that the task does not start if the task is triggered to run in a Remote Applications Integrated Locally (RAIL) session.

• dsc_dontstopifgoingonbatteries

  Indicates that the task does not stop if the computer switches to battery power.

• dsc_dontstoponidleend

  Indicates that Task Scheduler does not terminate the task if the idle condition ends before the task is completed.

• dsc_enable

  True if the task should be enabled, false if it should be disabled.

• dsc_ensure

  Present if the task should exist, Absent if it should be removed.

• dsc_eventsubscription

  Specifies the EventSubscription in XML. This can be easily generated using the Windows Eventlog Viewer. For the query schema please check: docs.microsoft.com/en-us/windows/desktop/WES/queryschema-schema. Can only be used in combination with ScheduleType OnEvent.

• dsc_executeasgmsa

  The gMSA (Group Managed Service Account) this task should execute as. Cannot be used in combination with ExecuteAsCredential or BuiltInAccount.

• dsc_executiontimelimit

  Specifies the amount of time that Task Scheduler is allowed to complete the task.

• dsc_hidden

  Indicates that the task is hidden in the Task Scheduler UI.

• dsc_idleduration

  Specifies the amount of time that the computer must be in an idle state before Task Scheduler runs the task.

• dsc_idlewaittimeout

  Specifies the amount of time that Task Scheduler waits for an idle condition to occur.

• dsc_logontype

  Specifies the security logon method that Task Scheduler uses to run the tasks that are associated with the principal.

• dsc_multipleinstances

  Specifies the policy that defines how Task Scheduler handles multiple instances of the task.

• dsc_networkname

  Specifies the name of a network profile that Task Scheduler uses to determine if the task can run. The Task Scheduler UI uses this setting for display purposes. Specify a network name if you specify the RunOnlyIfNetworkAvailable parameter.

• dsc_priority

  Specifies the priority level of the task. Priority must be an integer from 0 (highest priority) to 10 (lowest priority). The default value is 7. Priority levels 7 and 8 are used for background tasks. Priority levels 4, 5, and 6 are used for interactive tasks.

• dsc_randomdelay

  Specifies a random amount of time to delay the start time of the trigger. The delay time is a random time between the time the task triggers and the time that you specify in this setting.

• dsc_repeatinterval

  How many units (minutes, hours, days) between each run of this task?

• dsc_repetitionduration

  Specifies how long the repetition pattern repeats after the task starts. May be set to ‘Indefinitely` to specify an indefinite duration.

• dsc_restartcount

  Specifies the number of times that Task Scheduler attempts to restart the task.

• dsc_restartinterval

  Specifies the amount of time that Task Scheduler attempts to restart the task.

• dsc_restartonidle

  Indicates that Task Scheduler restarts the task when the computer cycles into an idle condition more than once.

• dsc_runlevel

  Specifies the level of user rights that Task Scheduler uses to run the tasks that are associated with the principal. Defaults to ‘Limited’.

• dsc_runonlyifidle

  Indicates that Task Scheduler runs the task only when the computer is idle.

• dsc_runonlyifnetworkavailable

  Indicates that Task Scheduler runs the task only when a network is available. Task Scheduler uses the NetworkID parameter and NetworkName parameter that you specify in this cmdlet to determine if the network is available.

• dsc_scheduletype

  When should the task be executed.

• dsc_starttime

  The time of day this task should start at - defaults to 12:00 AM. Not valid for AtLogon and AtStartup tasks.

• dsc_startwhenavailable

  Indicates that Task Scheduler can start the task at any time after its scheduled time has passed.

• dsc_synchronizeacrosstimezone

  Enable the scheduled task option to synchronize across time zones. This is enabled by including the timezone offset in the scheduled task trigger. Defaults to false which does not include the timezone offset.

• dsc_taskpath

  The path to the task - defaults to the root directory.

• dsc_user

  Specifies the identifier of the user for a trigger that starts a task when a user logs on.

• dsc_waketorun

  Indicates that Task Scheduler wakes the computer before it runs the task.

• dsc_weeksinterval

  Specifies the interval between the weeks in the schedule. An interval of 1 produces a weekly schedule. An interval of 2 produces an every-other week schedule.

Parameters

• dsc_executeascredential

  The credential this task should execute as. If not specified defaults to running as the local system account.

• dsc_psdscrunascredential
• dsc_taskname (namevar)

  The name of the task.

• dsc_timeout

  The maximum time in seconds to wait for the DSC resource to complete.

• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

  Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).