Windows PowerShell command on Get-command Register-ScheduledTask

NAME

Register-ScheduledTask

SYNOPSIS

Registers a scheduled task definition on a local computer.

SYNTAX

Register-ScheduledTask [-TaskName] [[-TaskPath] ] [-Action] [[-Trigger]

] [[-Settings] ] [[-User] ] [[-Password] ] [[-RunLevel] {Limited |

Highest}] [[-Description] ] [-CimSession ] [-Force] [-ThrottleLimit ]

[]

Register-ScheduledTask [-TaskName] [[-TaskPath] ] [-Action] [[-Trigger]

] [[-Settings] ] [[-Principal] ] [[-Description] ] [-CimSession

] [-Force] [-ThrottleLimit ] []

Register-ScheduledTask [[-TaskName] ] [[-TaskPath] ] [[-User] ] [[-Password] ]

[-CimSession ] [-Force] [-ThrottleLimit ] []

Register-ScheduledTask [-TaskName] [[-TaskPath] ] [-Xml] [[-User] ] [[-Password]

] [-CimSession ] [-Force] [-ThrottleLimit ] []

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

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 []

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 []

Briefly describes the task. 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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-Password []

Specifies a password for the 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 []

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 []

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 []

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

Specifies the name of a scheduled task. Required? true Position? 1 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. Required? false 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 PowerShellr 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 []

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 []

Specifies the name of the 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

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