Set-ClusteredScheduledTask

Set-ClusteredScheduledTask

Changes settings for a clustered scheduled task.

Sintaxis

Parameter Set: Object
Set-ClusteredScheduledTask [-TaskName] <String> [-InputObject] <CimInstance> [[-Cluster] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: Params
Set-ClusteredScheduledTask [-TaskName] <String> [[-Action] <CimInstance[]> ] [[-Trigger] <CimInstance[]> ] [[-Settings] <CimInstance> ] [[-Description] <String> ] [[-Cluster] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: Xml
Set-ClusteredScheduledTask [-TaskName] <String> [-Xml] <String> [[-Cluster] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Descripción detallada

The Set-ClusteredScheduledTask cmdlet changes settings for a clustered scheduled task. For instance, you can change the actions or triggers associated with a task.

You can make changes to a task even if an instance of the task is currently running. Any changes do not affect any actions already initiated.

For more information about the Task Scheduler, see the Task Scheduler Overview topic in the TechNet Library at https://technet.microsoft.com/en-us/library/cc721871.aspx.

Parámetros

-Action<CimInstance[]>

Specifies an array of action objects to use in the task. To obtain a task action object, use the New-ScheduledTaskAction cmdlet.

A task can have a single action or up to 32 actions. If you specify more than one action, the cluster runs them in sequence.

Alias

ninguno

¿Requerido?

false

¿Posición?

2

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

-Cluster<String>

Specifies the name of a failover cluster. If you do not specify a cluster, the cmdlet uses the current node cluster name.

Alias

ninguno

¿Requerido?

false

¿Posición?

6

Valor predeterminado

"."

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-Description<String>

Specifies a description of a task.

Alias

ninguno

¿Requerido?

false

¿Posición?

5

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-InputObject<CimInstance>

Especifica la entrada para este cmdlet. Puede usar este parámetro o puede canalizar la entrada a este cmdlet. This is a clustered scheduled task object. To obtain a clustered scheduled task object, use the Get-ClusteredScheduledTask cmdlet.

Alias

ninguno

¿Requerido?

true

¿Posición?

2

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByValue)

¿Aceptar caracteres comodín?

false

-Settings<CimInstance>

Specifies a CimInstance object that contains properties that Windows Task Scheduler uses to configure running of a task. To obtain a settings object, use the New-ScheduledTaskSettingSet cmdlet.

Alias

ninguno

¿Requerido?

false

¿Posición?

4

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-TaskName<String>

Specifies a name of a scheduled task.

Alias

ninguno

¿Requerido?

true

¿Posición?

1

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

-Trigger<CimInstance[]>

Specifies an array of trigger objects to use in the task. To obtain a task trigger object, use the New-ScheduledTaskTrigger cmdlet.

A trigger is a set of criteria that starts the running of a task. You can use both time-based and event-based triggers. One or more triggers can start a task. You can specify up to 48 triggers.

Alias

ninguno

¿Requerido?

false

¿Posición?

3

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-Xml<String>

Specifies an XML-formatted string that contains a task definition. You can export a task definition from Task Scheduler.

The string represents the triggers, actions, and other settings for a task. The string uses the Task Scheduler Schema.

Alias

ninguno

¿Requerido?

true

¿Posición?

2

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByValue)

¿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_ClusteredScheduledTask

Ejemplos

Example 1: Change actions for a task

This example changes the task actions for a scheduled task.

The first command uses the New-ScheduledTaskAction cmdlet to create a task action and stores that action in the $Action01 variable.

The second command uses the New-ScheduledTaskAction cmdlet to create a task action and stores that action in the $Action02 variable.

The final command changes the action assigned to the task named Task03 to the the two actions stored in $Action01 and $Action02. The cluster runs more than one action in sequence.

PS C:\> $Action01 = New-ScheduledTaskAction -Execute Notepad
PS C:\> $Action02 = New-ScheduledTaskAction -Execute Calc
PS C:\> Set-ClusteredScheduledTask -TaskName "Task03" -Action $Action01,$Action02

Temas relacionados

New-ScheduledTaskAction

New-ScheduledTaskTrigger

New-ScheduledTaskSettingsSet

Get-ClusteredScheduledTask

Register-ClusteredScheduledTask

Unregister-ClusteredScheduledTask