New-ScheduledTaskSettingsSet
Builds the settings part of a scheduled task, such as retry and battery behaviour.
Syntax
Short syntax for this command. The parameter table below may list more parameters than this short line shows.
New-ScheduledTaskSettingsSet [-AllowStartIfOnBatteries] [-StartWhenAvailable]Parameters
Note: the short syntax above does not show every parameter in this table. The rows marked No in the last column are still listed here with their descriptions. Check Get-Help for the full syntax before you use one of them.
| Parameter | What it does | In short syntax |
|---|---|---|
-AllowStartIfOnBatteries | allow the task to start on battery power | Yes |
-StartWhenAvailable | start the task as soon as possible if a run was missed | Yes |
-RestartCount | how many times to retry a failed run | No |
Examples
Creates a settings object only, and it does not register a task. Pass it to Register-ScheduledTask with -Settings when you build the task.
$settings = New-ScheduledTaskSettingsSet -AllowStartIfOnBatteries -StartWhenAvailableIllustrative output: see the lesson example for this command.
Common mistakes
General cautions for this command.
- Guessing parameters instead of checking Get-Help for this command.
- Running a changing form of this command before previewing its effect.
Related commands
Commands that share this command's lesson come first, then commands that share its verb. Every link goes to a real command page.