Register-ScheduledTask

Registers a scheduled task definition on a local computer.

Syntax

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>]
Register-ScheduledTask
        [-TaskName] <String>
        [[-TaskPath] <String>]
        [-Action] <CimInstance[]>
        [[-Trigger] <CimInstance[]>]
        [[-Settings] <CimInstance>]
        [[-Principal] <CimInstance>]
        [[-Description] <String>]
        [-AsJob]
        [-CimSession <CimSession[]>]
        [-Force]
        [-ThrottleLimit <Int32>]
Register-ScheduledTask
        [[-TaskName] <String>]
        [[-TaskPath] <String>]
        [-InputObject] <CimInstance>
        [[-User] <String>]
        [[-Password] <String>]
        [-AsJob]
        [-CimSession <CimSession[]>]
        [-Force]
        [-ThrottleLimit <Int32>]
Register-ScheduledTask
        [-TaskName] <String>
        [[-TaskPath] <String>]
        [-Xml] <String>
        [[-User] <String>]
        [[-Password] <String>]
        [-AsJob]
        [-CimSession <CimSession[]>]
        [-Force]
        [-ThrottleLimit <Int32>]

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.

Examples

Example 1: Register a scheduled task

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

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.

Required Parameters

-Action

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.

Type:CimInstance[]
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

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

Type:CimInstance
Position:3
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-TaskName

Specifies the name of a scheduled task.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Xml

Specifies the XML string that contains a task definition.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Briefly describes the task.

Type:String
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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Password

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.

Type:String
Position:7
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Principal

Specifies the security context in which a task is run.

Type:CimInstance
Position:6
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RunLevel

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

Type:RunLevelEnum
Position:8
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Settings

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

Type:CimInstance
Position:5
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TaskPath

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.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Trigger

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

Type:CimInstance[]
Position:4
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-User

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

Type:String
Position:6
Default value:Current user
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_ScheduledTask