< Back
New-ScheduledTaskTrigger
Post
NAME New-ScheduledTaskTrigger
SYNOPSIS
Creates a scheduled task trigger object.
SYNTAX
New-ScheduledTaskTrigger [-Once] [-RandomDelay <TimeSpan>] [-RepetitionDuration <TimeSpan>] [-RepetitionInterval <TimeSpan>] -At <DateTime>
[<CommonParameters>]
New-ScheduledTaskTrigger [-Weekly] [-RandomDelay <TimeSpan>] [-WeeksInterval <Int32>] -At <DateTime> -DaysOfWeek <DayOfWeek[]> [<CommonParameters>]
New-ScheduledTaskTrigger [-Daily] [-DaysInterval <Int32>] [-RandomDelay <TimeSpan>] -At <DateTime> [<CommonParameters>]
New-ScheduledTaskTrigger [-AtLogOn] [-RandomDelay <TimeSpan>] [-User <String>] [<CommonParameters>]
New-ScheduledTaskTrigger [-AtStartup] [-RandomDelay <TimeSpan>] [<CommonParameters>]
DESCRIPTION
The New-ScheduledTaskTrigger cmdlet creates and returns a new scheduled task trigger object.
You can use a time-based trigger or an event-based trigger to start a task. Time-based triggers include starting a task at a specific time or starting a
task multiple times on a daily or weekly schedule. Event-based triggers include starting a task when the system starts up or when a user logs on to the
computer. Each task can contain one or more triggers, which means there are many ways that you can start a task. If a task has multiple triggers, Task
Scheduler starts the task when any of the triggers occur.
PARAMETERS
-At <DateTime>
Specifies a date and time to trigger the task. This paramater is valid for calendar-based triggers (Once, Daily, Weekly).
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-AtLogOn <SwitchParameter>
Indicates that a trigger starts a task when a user logs on.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-AtStartup <SwitchParameter>
Indicates that a trigger starts a task when the system is started.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Daily <SwitchParameter>
Indicates that a trigger starts a task on a recurring daily schedule.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-DaysInterval [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-DaysOfWeek <DayOfWeek[]>
Specifies an array of the days of the week on which Task Scheduler runs the task.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Once <SwitchParameter>
Indicates that a trigger starts a task once at a time specified in the At parameter.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RandomDelay [<TimeSpan>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RepetitionDuration [<TimeSpan>]
Specifies how long the repetition pattern repeats after the task starts.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RepetitionInterval [<TimeSpan>]
Specifies an amount of time between each restart of the task. The task will run, wait for the time interval specified, and then run again. This
cycle continues for the time that you specify for the RepetitionDuration parameter.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-User [<String>]
Specifies the identifier of the user for a trigger that starts a task when a user logs on.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Weekly <SwitchParameter>
Indicates that the trigger starts a task on a recurring weekly schedule.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-WeeksInterval [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#MSFT_TaskTrigger
Example 1: Register a scheduled task that starts a task once
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts the task once at 3:00 A.M and assigns the ScheduledTaskTrigger object to the $Stt
variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -Once -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd once at 3:00 A.M.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Trigger $Stt
This example registers a scheduled task that starts once.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
Example 2: Register a scheduled task that starts every day
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every day at 3:00 A.M and assigns the ScheduledTaskTrigger object to the $Stt variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -Daily -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd every day at 3:00 A.M.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
This example registers a scheduled task that starts every day.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
Example 3: Register a scheduled task that starts every 3 days
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every 3 days at 3:00 A.M and assigns the ScheduledTaskTrigger object to the $Stt
variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -Daily -DaysInterval 3 -At 3am
The third command registers the scheduled task Task01 to run the task action named cmd every 3 days at 3:00 A.M.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
This example registers a scheduled task that starts every 3 days.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
Example 4: Register a scheduled task that starts every-other week
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every other Sunday at 3:00 A.M and assigns the ScheduledTaskTrigger object to the $Stt
variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -Weekly -WeeksInterval 2 -DaysOfWeek Sunday -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd every other Sunday at 3:00 A.M.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
This example registers a scheduled task that starts every other week.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
Example 5: Register a scheduled task that starts when a user logs on
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts when a user logs on, and assigns the ScheduledTaskTrigger object to the $Stt variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -AtLogon
The third command registers the scheduled task Task01 to run the task action named Cmd when a user logs on.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
This example registers a scheduled task that starts when a user logs on.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
RELATED LINKS
Online Version:
Enable-ScheduledTask
Get-ScheduledTaskInfo
New-ScheduledTask
New-ScheduledTaskAction
Register-ScheduledTask
Start-ScheduledTask
SYNOPSIS
Creates a scheduled task trigger object.
SYNTAX
New-ScheduledTaskTrigger [-Once] [-RandomDelay <TimeSpan>] [-RepetitionDuration <TimeSpan>] [-RepetitionInterval <TimeSpan>] -At <DateTime>
[<CommonParameters>]
New-ScheduledTaskTrigger [-Weekly] [-RandomDelay <TimeSpan>] [-WeeksInterval <Int32>] -At <DateTime> -DaysOfWeek <DayOfWeek[]> [<CommonParameters>]
New-ScheduledTaskTrigger [-Daily] [-DaysInterval <Int32>] [-RandomDelay <TimeSpan>] -At <DateTime> [<CommonParameters>]
New-ScheduledTaskTrigger [-AtLogOn] [-RandomDelay <TimeSpan>] [-User <String>] [<CommonParameters>]
New-ScheduledTaskTrigger [-AtStartup] [-RandomDelay <TimeSpan>] [<CommonParameters>]
DESCRIPTION
The New-ScheduledTaskTrigger cmdlet creates and returns a new scheduled task trigger object.
You can use a time-based trigger or an event-based trigger to start a task. Time-based triggers include starting a task at a specific time or starting a
task multiple times on a daily or weekly schedule. Event-based triggers include starting a task when the system starts up or when a user logs on to the
computer. Each task can contain one or more triggers, which means there are many ways that you can start a task. If a task has multiple triggers, Task
Scheduler starts the task when any of the triggers occur.
PARAMETERS
-At <DateTime>
Specifies a date and time to trigger the task. This paramater is valid for calendar-based triggers (Once, Daily, Weekly).
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-AtLogOn <SwitchParameter>
Indicates that a trigger starts a task when a user logs on.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-AtStartup <SwitchParameter>
Indicates that a trigger starts a task when the system is started.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Daily <SwitchParameter>
Indicates that a trigger starts a task on a recurring daily schedule.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-DaysInterval [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-DaysOfWeek <DayOfWeek[]>
Specifies an array of the days of the week on which Task Scheduler runs the task.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Once <SwitchParameter>
Indicates that a trigger starts a task once at a time specified in the At parameter.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RandomDelay [<TimeSpan>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RepetitionDuration [<TimeSpan>]
Specifies how long the repetition pattern repeats after the task starts.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-RepetitionInterval [<TimeSpan>]
Specifies an amount of time between each restart of the task. The task will run, wait for the time interval specified, and then run again. This
cycle continues for the time that you specify for the RepetitionDuration parameter.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-User [<String>]
Specifies the identifier of the user for a trigger that starts a task when a user logs on.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Weekly <SwitchParameter>
Indicates that the trigger starts a task on a recurring weekly schedule.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-WeeksInterval [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#MSFT_TaskTrigger
Example 1: Register a scheduled task that starts a task once
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts the task once at 3:00 A.M and assigns the ScheduledTaskTrigger object to the $Stt
variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -Once -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd once at 3:00 A.M.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Trigger $Stt
This example registers a scheduled task that starts once.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
Example 2: Register a scheduled task that starts every day
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every day at 3:00 A.M and assigns the ScheduledTaskTrigger object to the $Stt variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -Daily -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd every day at 3:00 A.M.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
This example registers a scheduled task that starts every day.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
Example 3: Register a scheduled task that starts every 3 days
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every 3 days at 3:00 A.M and assigns the ScheduledTaskTrigger object to the $Stt
variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -Daily -DaysInterval 3 -At 3am
The third command registers the scheduled task Task01 to run the task action named cmd every 3 days at 3:00 A.M.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
This example registers a scheduled task that starts every 3 days.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
Example 4: Register a scheduled task that starts every-other week
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts every other Sunday at 3:00 A.M and assigns the ScheduledTaskTrigger object to the $Stt
variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -Weekly -WeeksInterval 2 -DaysOfWeek Sunday -At 3am
The third command registers the scheduled task Task01 to run the task action named Cmd every other Sunday at 3:00 A.M.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
This example registers a scheduled task that starts every other week.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
Example 5: Register a scheduled task that starts when a user logs on
PS C:\\>$Sta = New-ScheduledTaskAction -Execute "Cmd"
The second command creates a scheduled task trigger that starts when a user logs on, and assigns the ScheduledTaskTrigger object to the $Stt variable.
PS C:\\>$Stt = New-ScheduledTaskTrigger -AtLogon
The third command registers the scheduled task Task01 to run the task action named Cmd when a user logs on.
PS C:\\>Register-ScheduledTask Task01 -Action $Sta -Settings $Stt
This example registers a scheduled task that starts when a user logs on.
The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the $Sta variable.
RELATED LINKS
Online Version:
Enable-ScheduledTask
Get-ScheduledTaskInfo
New-ScheduledTask
New-ScheduledTaskAction
Register-ScheduledTask
Start-ScheduledTask