Export (0) Print
Expand All

New-ScheduledTaskTrigger

Windows Server 2012 R2 and Windows 8.1

Updated: May 8, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

New-ScheduledTaskTrigger

Creates a scheduled task trigger object.

Syntax

Parameter Set: Once
New-ScheduledTaskTrigger [-Once] -At <DateTime> [-RandomDelay <TimeSpan> ] [-RepetitionDuration <TimeSpan> ] [-RepetitionInterval <TimeSpan> ] [ <CommonParameters>]

Parameter Set: AtLogon
New-ScheduledTaskTrigger [-AtLogOn] [-RandomDelay <TimeSpan> ] [-User <String> ] [ <CommonParameters>]

Parameter Set: AtStartup
New-ScheduledTaskTrigger [-AtStartup] [-RandomDelay <TimeSpan> ] [ <CommonParameters>]

Parameter Set: Daily
New-ScheduledTaskTrigger [-Daily] -At <DateTime> [-DaysInterval <Int32> ] [-RandomDelay <TimeSpan> ] [ <CommonParameters>]

Parameter Set: Weekly
New-ScheduledTaskTrigger [-Weekly] -At <DateTime> -DaysOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}[] [-RandomDelay <TimeSpan> ] [-WeeksInterval <Int32> ] [ <CommonParameters>]




Detailed 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).


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AtLogOn

Indicates that a trigger starts a task when a user logs on.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AtStartup

Indicates that a trigger starts a task when the system is started.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Daily

Indicates that a trigger starts a task on a recurring daily schedule.


Aliases

none

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.


Aliases

none

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.


Aliases

none

Required?

true

Position?

named

Default Value

{ DayOfWeek.Monday, DayOfWeek.Tuesday, DayOfWeek.Wednesday, DayOfWeek.Thursday, DayOfWeek.Friday, DayOfWeek.Saturday, DayOfWeek.Sunday }

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Once

Indicates that a trigger starts a task once at a time specified in the At parameter.


Aliases

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

0

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RepetitionDuration<TimeSpan>

Specifies how long the repetition pattern repeats after the task starts.


Aliases

none

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.


Aliases

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Weekly

Indicates that the trigger starts a task on a recurring weekly schedule.


Aliases

none

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.


Aliases

none

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_TaskTrigger

Examples

Example 1: Register a scheduled task that starts a task once

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.


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

Example 2: Register a scheduled task that starts every day

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.


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

Example 3: Register a scheduled task that starts every 3 days

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.


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

Example 4: Register a scheduled task that starts every-other week

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.


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

Example 5: Register a scheduled task that starts when a user logs on

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.


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft