< Back
Register-ScheduledTask
Post
NAME Register-ScheduledTask
SYNOPSIS
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] {Limited | Highest}] [[-Description] <String>] [-CimSession <CimSession[]>] [-Force]
[-ThrottleLimit <Int32>] [<CommonParameters>]
Register-ScheduledTask [-TaskName] <String> [[-TaskPath] <String>] [-Action] <CimInstance[]> [[-Trigger] <CimInstance[]>] [[-Settings] <CimInstance>]
[[-Principal] <CimInstance>] [[-Description] <String>] [-CimSession <CimSession[]>] [-Force] [-ThrottleLimit <Int32>] [<CommonParameters>]
Register-ScheduledTask [[-TaskName] <String>] [[-TaskPath] <String>] [[-User] <String>] [[-Password] <String>] [-CimSession <CimSession[]>] [-Force]
[-ThrottleLimit <Int32>] [<CommonParameters>]
Register-ScheduledTask [-TaskName] <String> [[-TaskPath] <String>] [-Xml] <String> [[-User] <String>] [[-Password] <String>] [-CimSession
<CimSession[]>] [-Force] [-ThrottleLimit <Int32>] [<CommonParameters>]
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.
Required? true
Position? 3
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Description [<String>]
Briefly describes the task.
Required? false
Position? 9
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Instructs the cmdlet to perform the operation without prompting for confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
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.
Required? false
Position? 7
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Principal [<CimInstance>]
Specifies the security context in which a task is run.
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.
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.
Required? false
Position? 5
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TaskName <String>
Specifies the name of a scheduled task.
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.
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.
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.
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.
Required? false
Position? 6
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Xml <String>
Specifies the XML string that contains a task definition.
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, 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_ScheduledTask
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.
RELATED LINKS
Online Version:
Disable-ScheduledTask
Enable-ScheduledTask
Export-ScheduledTask
Get-ScheduledTaskInfo
New-ScheduledTask
Set-ScheduledTask
Start-ScheduledTask
Stop-ScheduledTask
Unregister-ScheduledTask
SYNOPSIS
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] {Limited | Highest}] [[-Description] <String>] [-CimSession <CimSession[]>] [-Force]
[-ThrottleLimit <Int32>] [<CommonParameters>]
Register-ScheduledTask [-TaskName] <String> [[-TaskPath] <String>] [-Action] <CimInstance[]> [[-Trigger] <CimInstance[]>] [[-Settings] <CimInstance>]
[[-Principal] <CimInstance>] [[-Description] <String>] [-CimSession <CimSession[]>] [-Force] [-ThrottleLimit <Int32>] [<CommonParameters>]
Register-ScheduledTask [[-TaskName] <String>] [[-TaskPath] <String>] [[-User] <String>] [[-Password] <String>] [-CimSession <CimSession[]>] [-Force]
[-ThrottleLimit <Int32>] [<CommonParameters>]
Register-ScheduledTask [-TaskName] <String> [[-TaskPath] <String>] [-Xml] <String> [[-User] <String>] [[-Password] <String>] [-CimSession
<CimSession[]>] [-Force] [-ThrottleLimit <Int32>] [<CommonParameters>]
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.
Required? true
Position? 3
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Description [<String>]
Briefly describes the task.
Required? false
Position? 9
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Instructs the cmdlet to perform the operation without prompting for confirmation.
Required? false
Position? named
Default value none
Accept pipeline input? false
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.
Required? false
Position? 7
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Principal [<CimInstance>]
Specifies the security context in which a task is run.
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.
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.
Required? false
Position? 5
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TaskName <String>
Specifies the name of a scheduled task.
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.
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.
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.
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.
Required? false
Position? 6
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Xml <String>
Specifies the XML string that contains a task definition.
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, 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_ScheduledTask
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.
RELATED LINKS
Online Version:
Disable-ScheduledTask
Enable-ScheduledTask
Export-ScheduledTask
Get-ScheduledTaskInfo
New-ScheduledTask
Set-ScheduledTask
Start-ScheduledTask
Stop-ScheduledTask
Unregister-ScheduledTask