< Back
New-ScheduledTaskAction
Post
NAME New-ScheduledTaskAction
SYNOPSIS
Creates a scheduled task action.
SYNTAX
New-ScheduledTaskAction [-Execute] <String> [[-Argument] <String>] [[-WorkingDirectory] <String>] [-CimSession <CimSession[]>] [-Id <String>]
[-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The New-ScheduledTaskAction cmdlet creates an object that contains the definition of a scheduled task action. A scheduled task action represents a
command that a task executes when Task Scheduler runs the task. You can use a task action definition to register a new scheduled task or update an
existing task registration.
A task can have a single action or a maximum of 32 actions. When you specify multiple actions, Task Scheduler executes the actions sequentially. The
Task Scheduler service controls tasks activation, and it hosts the tasks that it starts.
PARAMETERS
-Argument [<String>]
Specifies arguments for the command-line operation.
Required? false
Position? 2
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
-Execute <String>
Specifies the path to an executable file.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Id [<String>]
Specifies an identifier of an action. Task Scheduler uses this identifier for logging.
Required? false
Position? named
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
-WorkingDirectory [<String>]
Specifies a directory where Task Scheduler will run the task. If you do not specify a working directory, Task Scheduler runs the task in the
%windir%\\system32 directory.
Required? false
Position? 3
Default value none
Accept pipeline input? false
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_TaskAction
Example 1: Create a scheduled task action
PS C:\\> New-ScheduledTaskAction -Execute "PowerShell.exe"
This command creates a new scheduled task action that runs PowerShell.exe.
RELATED LINKS
Online Version:
Enable-ScheduledTask
Get-ScheduledTaskInfo
New-ScheduledTask
New-ScheduledTaskPrincipal
Register-ScheduledTask
Start-ScheduledTask
SYNOPSIS
Creates a scheduled task action.
SYNTAX
New-ScheduledTaskAction [-Execute] <String> [[-Argument] <String>] [[-WorkingDirectory] <String>] [-CimSession <CimSession[]>] [-Id <String>]
[-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The New-ScheduledTaskAction cmdlet creates an object that contains the definition of a scheduled task action. A scheduled task action represents a
command that a task executes when Task Scheduler runs the task. You can use a task action definition to register a new scheduled task or update an
existing task registration.
A task can have a single action or a maximum of 32 actions. When you specify multiple actions, Task Scheduler executes the actions sequentially. The
Task Scheduler service controls tasks activation, and it hosts the tasks that it starts.
PARAMETERS
-Argument [<String>]
Specifies arguments for the command-line operation.
Required? false
Position? 2
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
-Execute <String>
Specifies the path to an executable file.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Id [<String>]
Specifies an identifier of an action. Task Scheduler uses this identifier for logging.
Required? false
Position? named
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
-WorkingDirectory [<String>]
Specifies a directory where Task Scheduler will run the task. If you do not specify a working directory, Task Scheduler runs the task in the
%windir%\\system32 directory.
Required? false
Position? 3
Default value none
Accept pipeline input? false
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_TaskAction
Example 1: Create a scheduled task action
PS C:\\> New-ScheduledTaskAction -Execute "PowerShell.exe"
This command creates a new scheduled task action that runs PowerShell.exe.
RELATED LINKS
Online Version:
Enable-ScheduledTask
Get-ScheduledTaskInfo
New-ScheduledTask
New-ScheduledTaskPrincipal
Register-ScheduledTask
Start-ScheduledTask