You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-39Lines changed: 39 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,45 +60,45 @@ xScheduledTask resource is used to define basic recurring scheduled tasks on the
60
60
Tasks are created to run indefinitly based on the schedule defined.
61
61
xScheduledTask has the following properties:
62
62
63
-
*TaskName: The name of the task
64
-
*TaskPath: The path to the task - defaults to the root directory
65
-
*Description: The task description
66
-
*ActionExecutable: The path to the .exe for this task
67
-
*ActionArguments: The arguments to pass the executable
68
-
*ActionWorkingPath: The working path to specify for the executable
69
-
*ScheduleType: When should the task be executed ("Once", "Daily", "Weekly", "AtStartup", "AtLogOn")
70
-
*RepeatInterval: How many units (minutes, hours, days) between each run of this task?
71
-
*StartTime: The time of day this task should start at - defaults to 12:00 AM. Not valid for AtLogon and AtStartup tasks
72
-
*Ensure: Present if the task should exist, false if it should be removed
73
-
*Enable: True if the task should be enabled, false if it should be disabled
74
-
*ExecuteAsCredential: The credential this task should execute as. If not specified defaults to running as the local system account
75
-
*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.
76
-
*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.
77
-
*RepetitionDuration: Specifies how long the repetition pattern repeats after the task starts.
78
-
*DaysOfWeek: Specifies an array of the days of the week on which Task Scheduler runs the task.
79
-
*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.
80
-
*User: Specifies the identifier of the user for a trigger that starts a task when a user logs on.
81
-
*DisallowDemandStart: Indicates whether the task is prohibited to run on demand or not. Defaults to $false
82
-
*DisallowHardTerminate: Indicates whether the task is prohibited to be terminated or not. Defaults to $false
83
-
*Compatibility: The task compatibility level. Defaults to Vista. Possible values: "AT","V1","Vista","Win7","Win8"
84
-
*AllowStartIfOnBatteries: Indicates whether the task should start if the machine is on batteries or not. Defaults to $false
85
-
*Hidden: Indicates that the task is hidden in the Task Scheduler UI. Defaults to $false
86
-
*RunOnlyIfIdle: Indicates that Task Scheduler runs the task only when the computer is idle.
87
-
*IdleWaitTimeout: Specifies the amount of time that Task Scheduler waits for an idle condition to occur. DateTime ;
88
-
*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.
89
-
*DisallowStartOnRemoteAppSession: Indicates that the task does not start if the task is triggered to run in a Remote Applications Integrated Locally (RAIL) session.
90
-
*StartWhenAvailable: Indicates that Task Scheduler can start the task at any time after its scheduled time has passed.
91
-
*DontStopIfGoingOnBatteries: Indicates that the task does not stop if the computer switches to battery power.
92
-
*WakeToRun: Indicates that Task Scheduler wakes the computer before it runs the task.
93
-
*IdleDuration: Specifies the amount of time that the computer must be in an idle state before Task Scheduler runs the task.
94
-
*RestartOnIdle: Indicates that Task Scheduler restarts the task when the computer cycles into an idle condition more than once.
95
-
*DontStopOnIdleEnd: Indicates that Task Scheduler does not terminate the task if the idle condition ends before the task is completed.
96
-
*ExecutionTimeLimit: Specifies the amount of time that Task Scheduler is allowed to complete the task.
97
-
*MultipleInstances: Specifies the policy that defines how Task Scheduler handles multiple instances of the task. Possible values: "IgnoreNew","Parallel","Queue"
98
-
*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.
99
-
*RestartCount: Specifies the number of times that Task Scheduler attempts to restart the task.
100
-
*RestartInterval: Specifies the amount of time that Task Scheduler attempts to restart the task.
101
-
*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.
63
+
*TaskName: The name of the task
64
+
*TaskPath: The path to the task - defaults to the root directory
65
+
*Description: The task description
66
+
*ActionExecutable: The path to the .exe for this task
67
+
*ActionArguments: The arguments to pass the executable
68
+
*ActionWorkingPath: The working path to specify for the executable
69
+
*ScheduleType: When should the task be executed ("Once", "Daily", "Weekly", "AtStartup", "AtLogOn")
70
+
*RepeatInterval: How many units (minutes, hours, days) between each run of this task?
71
+
*StartTime: The time of day this task should start at - defaults to 12:00 AM. Not valid for AtLogon and AtStartup tasks
72
+
*Ensure: Present if the task should exist, false if it should be removed
73
+
*Enable: True if the task should be enabled, false if it should be disabled
74
+
*ExecuteAsCredential: The credential this task should execute as. If not specified defaults to running as the local system account
75
+
*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.
76
+
*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.
77
+
*RepetitionDuration: Specifies how long the repetition pattern repeats after the task starts.
78
+
*DaysOfWeek: Specifies an array of the days of the week on which Task Scheduler runs the task.
79
+
*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.
80
+
*User: Specifies the identifier of the user for a trigger that starts a task when a user logs on.
81
+
*DisallowDemandStart: Indicates whether the task is prohibited to run on demand or not. Defaults to $false
82
+
*DisallowHardTerminate: Indicates whether the task is prohibited to be terminated or not. Defaults to $false
83
+
*Compatibility: The task compatibility level. Defaults to Vista. Possible values: "AT","V1","Vista","Win7","Win8"
84
+
*AllowStartIfOnBatteries: Indicates whether the task should start if the machine is on batteries or not. Defaults to $false
85
+
*Hidden: Indicates that the task is hidden in the Task Scheduler UI. Defaults to $false
86
+
*RunOnlyIfIdle: Indicates that Task Scheduler runs the task only when the computer is idle.
87
+
*IdleWaitTimeout: Specifies the amount of time that Task Scheduler waits for an idle condition to occur. DateTime ;
88
+
*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.
89
+
*DisallowStartOnRemoteAppSession: Indicates that the task does not start if the task is triggered to run in a Remote Applications Integrated Locally (RAIL) session.
90
+
*StartWhenAvailable: Indicates that Task Scheduler can start the task at any time after its scheduled time has passed.
91
+
*DontStopIfGoingOnBatteries: Indicates that the task does not stop if the computer switches to battery power.
92
+
*WakeToRun: Indicates that Task Scheduler wakes the computer before it runs the task.
93
+
*IdleDuration: Specifies the amount of time that the computer must be in an idle state before Task Scheduler runs the task.
94
+
*RestartOnIdle: Indicates that Task Scheduler restarts the task when the computer cycles into an idle condition more than once.
95
+
*DontStopOnIdleEnd: Indicates that Task Scheduler does not terminate the task if the idle condition ends before the task is completed.
96
+
*ExecutionTimeLimit: Specifies the amount of time that Task Scheduler is allowed to complete the task.
97
+
*MultipleInstances: Specifies the policy that defines how Task Scheduler handles multiple instances of the task. Possible values: "IgnoreNew","Parallel","Queue"
98
+
*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.
99
+
*RestartCount: Specifies the number of times that Task Scheduler attempts to restart the task.
100
+
*RestartInterval: Specifies the amount of time that Task Scheduler attempts to restart the task.
101
+
*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.
0 commit comments