New-ScheduledTaskSettingsSet

New-ScheduledTaskSettingsSet

Creates a new scheduled task settings object.

Sintaxis

Parameter Set: NewSettings1
New-ScheduledTaskSettingsSet [-AllowStartIfOnBatteries] [-AsJob] [-CimSession <CimSession[]> ] [-Compatibility <CompatibilityEnum> ] [-DeleteExpiredTaskAfter <TimeSpan> ] [-Disable] [-DisallowDemandStart] [-DisallowHardTerminate] [-DisallowStartOnRemoteAppSession] [-DontStopIfGoingOnBatteries] [-DontStopOnIdleEnd] [-ExecutionTimeLimit <TimeSpan> ] [-Hidden] [-IdleDuration <TimeSpan> ] [-IdleWaitTimeout <TimeSpan> ] [-MaintenanceDeadline <TimeSpan> ] [-MaintenanceExclusive] [-MaintenancePeriod <TimeSpan> ] [-MultipleInstances <MultipleInstancesEnum> ] [-NetworkId <String> ] [-NetworkName <String> ] [-Priority <Int32> ] [-RestartCount <Int32> ] [-RestartInterval <TimeSpan> ] [-RestartOnIdle] [-RunOnlyIfIdle] [-RunOnlyIfNetworkAvailable] [-StartWhenAvailable] [-ThrottleLimit <Int32> ] [-WakeToRun] [ <CommonParameters>]

Descripción detallada

The New-ScheduledTaskSettingsSet cmdlet creates an object that contains scheduled task settings. Each scheduled task has one set of task settings. Use this cmdlet to configure options to manage the behavior of the task upon completion, to manage the behavior of the task if a problem occurs, or to manage the behavior of the task if an instance of the task is already running.

You can use the scheduled task settings to register a new scheduled task or update an existing task registration.

Parámetros

-AllowStartIfOnBatteries

Indicates that Task Scheduler starts if the computer is running on battery power.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-AsJob

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-CimSession<CimSession[]>

Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.

Alias	Session
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-Compatibility<CompatibilityEnum>

Indicates which version of Task Scheduler with which a task is compatible. Los valores aceptables para este parámetro son los siguientes:
-- V1
-- Vista
-- Win7
-- Win8

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-DeleteExpiredTaskAfter<TimeSpan>

Specifies the amount of time that Task Scheduler waits before deleting the task after it expires.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-Disable

Indicates that the task is disabled.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-DisallowDemandStart

Indicates that the task cannot be started by using either the Run command or the Context menu.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-DisallowHardTerminate

Indicates that the task cannot be terminated by using TerminateProcess.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-DisallowStartOnRemoteAppSession

Indicates that the task does not start if the task is triggered to run in a Remote Applications Integrated Locally (RAIL) session.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-DontStopIfGoingOnBatteries

Indicates that the task does not stop if the computer switches to battery power.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-DontStopOnIdleEnd

Indicates that Task Scheduler does not terminate the task if the idle condition ends before the task is completed.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-ExecutionTimeLimit<TimeSpan>

Specifies the amount of time that Task Scheduler is allowed to complete the task.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-Hidden

Indicates that the task is hidden in the Task Scheduler UI.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-IdleDuration<TimeSpan>

Specifies the amount of time that the computer must be in an idle state before Task Scheduler runs the task.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-IdleWaitTimeout<TimeSpan>

Specifies the amount of time that Task Scheduler waits for an idle condition to occur.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-MaintenanceDeadline<TimeSpan>

Specifies the amount of time after which Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task failed to complete during regular Automatic maintenance.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-MaintenanceExclusive

Indicates that the task needs to run alone when it is started in maintenance mode.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-MaintenancePeriod<TimeSpan>

Specifies the amount of time that the task needs to run once during regular Automatic maintenance.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-MultipleInstances<MultipleInstancesEnum>

Specifies the policy that defines how Task Scheduler handles multiple instances of the task.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-NetworkId<String>

Specifies the ID of a network profile that Task Scheduler uses to determine if the task can run. You must specify the ID of a network if you specify the RunOnlyIfNetworkAvailable paramater.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-NetworkName<String>

Specifies the name of a network profile that Task Scheduler uses to determine if the task can run. The Task Scheduler UI uses this setting for display purposes. Specify a network name if you specify the RunOnlyIfNetworkAvailable paramater.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-Priority<Int32>

Specifies the priority level of the task. Priority must be an integer from 1 (lowest priority) to 10 (highest priority). The default value is 7.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-RestartCount<Int32>

Specifies the number of times that Task Scheduler attempts to restart the task.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-RestartInterval<TimeSpan>

Specifies the amount of time that Task Scheduler attempts to restart the task.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-RestartOnIdle

Indicates that Task Scheduler restarts the task when the computer cycles into an idle condition more than once.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-RunOnlyIfIdle

Indicates that Task Scheduler runs the task only when the computer is idle.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-RunOnlyIfNetworkAvailable

Indicates that Task Scheduler runs the task only when a network is available. Task Scheduler uses the NetworkID paramater and NetworkName parameter that you specify in this cmdlet to determine if the network is available.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-StartWhenAvailable

Indicates that Task Scheduler can start the task at any time after its scheduled time has passed.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-ThrottleLimit<Int32>

Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-WakeToRun

Indicates that Task Scheduler wakes the computer before it runs the task.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

• Microsoft.Management.Infrastructure.CimInstance#MSFT_TaskSettings

Ejemplos

Example 1: Register a scheduled task that uses default task settings

This example registers a scheduled task that uses default task settings.

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.

PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

The second command creates scheduled task settings that use the default settings and assigns the ScheduledTaskSettings object to the Stset variable.

PS C:\> $STSet = New-ScheduledTaskSettingsSet

The third command registers the scheduled task Task01 to run the task action named Cmd and to use the default task settings.

PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $STSet

Example 2: Set the priority of a scheduled task

This example sets the priority of a scheduled task.

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.

PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

The second command creates scheduled task settings that sets a higher priority for the scheduled task, and assigns the ScheduledTaskSettings object to the Stset variable.

PS C:\> $STSet = New-ScheduledTaskSettingsSet -Priority 5

The third command registers the scheduled task Task01 to run the task action named Cmd and to use the task settings that have a priority setting of 9.

PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stset

Example 3: Set restart settings for a scheduled task

This example sets restart settings for a scheduled task.

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.

PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

The second command creates scheduled task settings that specify that Task Scheduler attempts three restarts of the task at sixty minute intervals. This command assigns the ScheduledTaskSettings object to the Stset variable.

PS C:\> $Stset = New-ScheduledTaskSettingsSet -RestartCount 3 -RestartInterval 60

The third command registers the scheduled task Task01 to run the task action named Cmd and to use the task settings that the ScheduledTaskSettings object defines.

PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stset

Example 4: Set idle settings for a scheduled task

This example sets idle settings for a scheduled task.

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.

PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

The second command creates scheduled task settings that specify that Task Scheduler runs the task only when the computer is idle for 2 minutes and waits for 2 hours and 30 minutes for an idle condition. This command assigns the ScheduledTaskSettings object to the Stset variable.

PS C:\> $Stset = New-ScheduledTaskSettingsSet -RunOnlyIfIdle -IdleDuration 00:02:00 -IdleWaitTimeout 02:30:00

The third command registers the scheduled task Task01 to run the task action named Cmd and to use the task settings that the ScheduledTaskSettings object defines.

PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stset

Example 5: Register a scheduled task that runs only when a network is available

This example registers a scheduled task that runs only when a network is available.

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.

PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

The second command creates scheduled task settings that specify that Task Scheduler runs the task only when a network is available. This command assigns the ScheduledTaskSettings object to the Stset variable.

PS C:\> $Stset = New-ScheduledTaskSettingsSet -RunOnlyIfNetworkAvailable

The third command registers the scheduled task Task01 to run the task action named Cmd only when a network is available.

PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stset

Temas relacionados

Register-ScheduledTask

New-ScheduledTask

Get-ScheduledTask

Get-ScheduledTaskInfo

Unregister-ScheduledTask

Enable-ScheduledTask

Start-ScheduledTask