PowerShell Logo Small

Register-ScheduledTask



This is the built-in help made by Microsoft for the command 'Register-ScheduledTask', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

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



Search powershellhelp.space

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.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/p/?linkid=287557
Get-ScheduledTask
Disable-ScheduledTask
Enable-ScheduledTask
Export-ScheduledTask
New-ScheduledTask
Set-ScheduledTask
Start-ScheduledTask
Stop-ScheduledTask
Unregister-ScheduledTask

REMARKS

<

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.