Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

Register-ScheduledTask

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

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

Register-ScheduledTask

Registers a scheduled task definition on a local computer.

Syntax

Parameter Set: User
Register-ScheduledTask [-TaskName] <String> [[-TaskPath] <String> ] [-Action] <CimInstance[]> [[-Trigger] <CimInstance[]> ] [[-Settings] <CimInstance> ] [[-User] <String> ] [[-Password] <String> ] [[-RunLevel] <RunLevelEnum> ] [[-Description] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: Object
Register-ScheduledTask [[-TaskName] <String> ] [[-TaskPath] <String> ] [-InputObject] <CimInstance> [[-User] <String> ] [[-Password] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: Principal
Register-ScheduledTask [-TaskName] <String> [[-TaskPath] <String> ] [-Action] <CimInstance[]> [[-Trigger] <CimInstance[]> ] [[-Settings] <CimInstance> ] [[-Principal] <CimInstance> ] [[-Description] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: Xml
Register-ScheduledTask [-TaskName] <String> [[-TaskPath] <String> ] [-Xml] <String> [[-User] <String> ] [[-Password] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Register-ScheduledTask cmdlet registers a scheduled task definition on a local computer.

You can register a task to run any of the following application or file types: Win32 applications, Win16 applications, OS/2 applications, MS-DOS applications, batch files (*.bat), command files (*.cmd), or any properly registered file type.

Parameters

-Action<CimInstance[]>

Specifies an array of one or more work items for the task to run. If you specify multiple actions, the computer runs them in order. You can specify up to 32 actions.


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

Briefly describes the task.


Aliases

none

Required?

false

Position?

9

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Instructs the cmdlet to perform the operation without prompting for confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<CimInstance>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Password<String>

Specifies a password for the <run as> user. The password is ignored for the well-known system accounts.

Well-known accounts are: NT AUTHORITY\SYSTEM, NT AUTHORITY\LOCALSERVICE, NT AUTHORITY\NETWORKSERVICE, and the well-known security identifiers (SIDs) for all three accounts.


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Principal<CimInstance>

Specifies the security context in which a task is run.


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunLevel<RunLevelEnum>

Specifies the required privilege level to run tasks that are associated with the principal.


Aliases

none

Required?

false

Position?

8

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Settings<CimInstance>

Specifies a configuration that the Task Scheduler service uses to determine how to run a task.


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskName<String>

Specifies the name of a scheduled task.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TaskPath<String>

Specifies the path for a scheduled task in Task Scheduler namespace. You can use \ for the root folder. If you do not specify a path, the cmdlet uses the root folder.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Trigger<CimInstance[]>

Specifies an array of one or more trigger objects that start a scheduled task. A task can have a maximum of 48 triggers.


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-User<String>

Specifies the name of the <run as> user account to use when you run the task.


Aliases

none

Required?

false

Position?

4

Default Value

Current user

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Xml<String>

Specifies the XML string that contains a task definition.


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

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_ScheduledTask

Examples

Example 1: Register a scheduled task

In this example, the set of commands uses cmdlets and variables to define and register a scheduled task.

The first command uses the New-ScheduledTaskTrigger cmdlet to assign a time trigger to the $Time variable.

The second command assigns the $User variable to the <run as> user account name (Contoso\Administrator).

The third command assigns the $PS variable to PowerShell.exe. This variable is used to define a task action.

The fourth command registers a scheduled task that is named SoftwareScan in the root folder. The registered task uses the pre-created action and trigger values that are specified by the $Action and $User variables.


PS C:\> $Time = New-ScheduledTaskTrigger -At 12:00 -Once 
PS C:\> $User = "Contoso\Administrator"
PS C:\> $PS = PowerShell.exe
PS C:\> Register-ScheduledTask -TaskName "SoftwareScan" -Trigger $Time -User $User –Action $PS

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.