Windows PowerShell command on Get-command New-ScheduledTask
MyWebUniversity

Windows PowerShell command on Get-command New-ScheduledTask

NAME

New-ScheduledTask

SYNOPSIS

Creates a scheduled task instance.

SYNTAX

New-ScheduledTask [[-Action] ] [[-Trigger] ] [[-Settings] ]

[[-Principal] ] [[-Description] ] [-CimSession ] [-ThrottleLimit ]

[]

DESCRIPTION

The New-ScheduledTask cmdlet creates an object that contains the definition of a scheduled task. New-ScheduledTask

does not automatically register the object with the Task Scheduler service. 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 work items for a task to run. When you specify multiple actions, they run sequentially. A task can have up to 32 actions. Required? false Position? 1 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? 5 Default value none Accept pipeline input? false Accept wildcard characters? false

-Principal []

Specifies the security context in which a task runs. Required? false Position? 4 Default value none Accept pipeline input? false Accept wildcard characters? false

-Settings []

Specifies a configuration object that the Task Scheduler service uses to determine how to run a task. Required? false Position? 3 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 cause a scheduled task to start. A trigger is a set of criteria that starts a scheduled task when the criteria are met. You can use a

time-based trigger or an event-based trigger to start a task, and one or more triggers can start a task. A

task can have up to 48 triggers. For more information about triggers, see Triggers. Required? false Position? 2 Default value none Accept pipeline input? false 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: Define a scheduled task and register it at a later time

PS C:\> $A = New-ScheduledTaskAction -Execute "Taskmgr.exe"

PS C:\> $T = New-ScheduledTaskTrigger -AtLogon

PS C:\> $P = "Contoso\Administrator"

PS C:\> $S = New-ScheduledTaskSettingsSet

PS C:\> $D = New-ScheduledTask -Action $A -Principal $P -Trigger $T -Settings $S

PS C:\> Register-ScheduledTask T1 -InputObject $D

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

The first command uses the New-ScheduledTaskAction cmdlet to assign the variable $A to the executable file

tskmgr.exe.

The second command uses the New-ScheduledTaskTrigger cmdlet to assign the variable $T to the value AtLogon.

The third command assigns the variable $P to the principal of the scheduled task, Contoso\Administrator.

The fourth command uses the New-ScheduledTaskSettingsSet cmdlet to assign the variable $S to a task settings

object.

The fifth command creates a new task and assigns the variable $D to the task definition.

The sixth command (hypothetically) runs at a later time. It registers the new scheduled task and defines it by

using the $D variable.

RELATED LINKS

Online Version:

Disable-ScheduledTask

Enable-ScheduledTask

Export-ScheduledTask

Get-ScheduledTask

New-ScheduledTaskAction

New-ScheduledTaskSettingsSet

New-ScheduledTaskTrigger

Register-ScheduledTask

Set-ScheduledTask

Start-ScheduledTask

Stop-ScheduledTask

Unregister-ScheduledTask



Contact us      |      About us      |      Term of use      |       Copyright © 2000-2019 OurUNIX.com ™