Partager via

Set-ScheduledJobOption

  • Référence
Module:
PSScheduledJob

Modifie les options d'une tâche planifiée.

Syntaxe

Set-ScheduledJobOption
   [-InputObject] <ScheduledJobOptions>
   [-PassThru]
   [-RunElevated]
   [-HideInTaskScheduler]
   [-RestartOnIdleResume]
   [-MultipleInstancePolicy <TaskMultipleInstancePolicy>]
   [-DoNotAllowDemandStart]
   [-RequireNetwork]
   [-StopIfGoingOffIdle]
   [-WakeToRun]
   [-ContinueIfGoingOnBattery]
   [-StartIfOnBattery]
   [-IdleTimeout <TimeSpan>]
   [-IdleDuration <TimeSpan>]
   [-StartIfIdle]
   [<CommonParameters>]

Description

L’applet Set-ScheduledJobOptions de commande modifie les options de travail des travaux planifiés.

Pour modifier les options d’un travail planifié, commencez par utiliser l’applet Get-ScheduledJobOption de commande pour obtenir les options de travail d’un travail planifié. Ensuite, dirigez les options vers Set-ScheduledJobOption ou enregistrez les options dans une variable et utilisez le paramètre InputObject de l’applet de Set-ScheduledJobOption commande pour identifier les options. Utilisez les paramètres restants pour modifier les options de Set-ScheduledJobOption travail.

Pour activer une option de tâche, utilisez le paramètre qui définit cette option. Pour désactiver une option, tapez le nom du paramètre, un signe deux-points (:) et $false. Par exemple, pour désactiver l’option RunElevated , tapez -RunElevated:$false.

Chaque objet options de travail inclut une propriété JobDefinition qui contient le travail planifié, de sorte que l’association avec le travail planifié est conservée lorsque les options de travail sont modifiées.

Les options de tâche planifiée déterminent le mode d'exécution de la tâche quand elle est démarrée par le Planificateur de tâches. Ces options ne s’appliquent pas lorsque vous utilisez l’applet Start-Job de commande pour démarrer un travail planifié.

Set-ScheduledJobOption est l’une des collections d’applets de commande de planification de travaux dans le module PSScheduledJob inclus dans Windows PowerShell.

Pour plus d'informations sur les tâches planifiées, consultez les rubriques À propos dans le module PSScheduledJob. Importez le module PSScheduledJob, puis tapez : Get-Help about_Scheduled* ou consultez about_Scheduled_Jobs.

Cette applet de commande a été introduite dans Windows PowerShell 3.0.

Exemples

Exemple 1 : Modifier les options de travail

Get-ScheduledJobOption -Name "DeployPackage"

StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : False
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : False
DoNotAllowDemandStart  : False
MultipleInstancePolicy : IgnoreNew
JobDefinition          :

Get-ScheduledJobOption -Name "DeployPackage" |
    Set-ScheduledJobOption -WakeToRun -RequireNetwork:$false -PassThru

StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : True
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : True
DoNotAllowDemandStart  : False
MultipleInstancePolicy : IgnoreNewJobDefinition          :

Cet exemple montre comment modifier les options d'une tâche planifiée sur l'ordinateur local.

La première commande utilise l’applet Get-ScheduledJobOption de commande pour obtenir les options de travail du travail planifié DeployPackage. La sortie indique que les propriétés WakeToRun et RunElevated sont définies $falsesur .

La deuxième commande utilise l’applet Set-ScheduledJobOpton de commande pour modifier les options de travail afin que les valeurs des propriétés WakeToRun et RunWithoutNetwork soient $True. La commande utilise le paramètre PassThru pour retourner le déclencheur après la modification.

Cette commande n'est pas obligatoire ; elle est incluse uniquement pour montrer l'effet de la modification de l'option.

Exemple 2 : Modifier une option sur tous les travaux planifiés à distance

Invoke-Command -Computer "Server01" -ScriptBlock {
    Get-ScheduledJob |
        Get-ScheduledJobOption |
        Set-ScheduledJobOption -IdleTimeout 2:00:00
}

Cette commande modifie la valeur de IdleTimeout d’une heure (valeur par défaut) à deux heures sur tous les travaux planifiés sur l’ordinateur Server01.

La commande utilise l’applet Invoke-Command de commande pour exécuter une commande sur l’ordinateur Server01.

La commande distante commence par une Get-ScheduledJob commande qui obtient tous les travaux planifiés sur l’ordinateur. Les travaux planifiés sont redirigés vers l’applet Get-ScheduledJobOption de commande, ce qui obtient les options de travail des travaux planifiés. Chaque objet d’options de travail contient une propriété JobDefinition qui contient le travail planifié, de sorte que l’objet options reste associé au travail planifié même lorsqu’il est modifié.

Les déclencheurs de travail sont dirigés vers l’applet Set-ScheduledJobOption de commande, ce qui modifie la valeur de l’option IdleTimeout sur deux heures (2:00:00).

Paramètres

-ContinueIfGoingOnBattery

Ne pas arrêter la tâche planifiée si l'ordinateur passe en mode d'alimentation par batterie (se déconnecte de l'alimentation secteur) pendant l'exécution de la tâche. Par défaut, les tâches planifiées s'arrêtent quand l'ordinateur se déconnecte de l'alimentation secteur.

Le paramètre ContinueIfGoingOnBattery définit la valeur de la propriété StopIfGoingOnBatteries des travaux $trueplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DoNotAllowDemandStart

Démarrer la tâche uniquement au moment où elle est déclenchée. Les utilisateurs ne peuvent pas démarrer la tâche manuellement, notamment à l'aide de la fonctionnalité Exécuter du Planificateur de tâches.

Ce paramètre affecte uniquement le Planificateur de tâches. Il n’empêche pas les utilisateurs d’utiliser l’applet Start-Job de commande pour démarrer le travail.

Le paramètre DoNotAllowDemandStart définit la valeur de la propriété DoNotAllowDemandStart des travaux $trueplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-HideInTaskScheduler

Ne pas afficher la tâche dans le Planificateur de tâches. Cette valeur affecte uniquement l'ordinateur sur lequel s'exécute la tâche. Par défaut, les tâches planifiées apparaissent dans le Planificateur de tâches.

Même si une tâche est masquée, les utilisateurs peuvent afficher la tâche en sélectionnant l’option Afficher l’affichage des tâches masquées dans le Planificateur de tâches .

Le paramètre HideInTaskScheduler définit la valeur de la propriété ShowInTaskScheduler des travaux $falseplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IdleDuration

Spécifie la durée pendant laquelle l'ordinateur doit être inactif avant que la tâche commence. La valeur par défaut est de 10 minutes. Si l’ordinateur n’est pas inactif pendant la durée spécifiée avant l’expiration de la valeur de IdleTimeout , le travail planifié ne s’exécute pas tant que l’heure planifiée suivante n’est pas exécutée, le cas échéant.

Entrez un objet timespan, tel qu’un généré par l’applet New-TimeSpan de commande, ou entrez une valeur au format qui est automatiquement convertie en <hours>:<minutes>:<seconds> objet TimeSpan .

Pour activer cette valeur, utilisez le paramètre StartIfIdle . Par défaut, la propriété StartIfNotIdle des travaux planifiés est définie $true sur et Windows PowerShell ignore les valeurs IdleDuration et IdleTimeout .

Type:TimeSpan
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IdleTimeout

Spécifie la durée pendant laquelle l'ordinateur doit être inactif avant que la tâche commence. La valeur par défaut est de 10 minutes. Si l’ordinateur n’est pas inactif pendant la durée spécifiée avant l’expiration de la valeur de IdleTimeout , le travail planifié ne s’exécute pas tant que l’heure planifiée suivante n’est pas exécutée, le cas échéant.

Entrez un objet timespan, tel qu’un généré par l’applet New-TimeSpan de commande, ou entrez une valeur au format qui est automatiquement convertie en <hours>:<minutes>:<seconds> objet TimeSpan .

Pour activer cette valeur, utilisez le paramètre StartIfIdle . Par défaut, la propriété StartIfNotIdle des travaux planifiés est définie sur $True et Windows PowerShell ignore les valeurs IdleDuration et IdleTimeout .

Type:TimeSpan
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InputObject

Spécifie les options de tâche. Entrez une variable qui contient des objets ScheduledJobOptions ou tapez une commande ou une expression qui obtient des objets ScheduledJobOptions , tels qu’une Get-ScheduledJobOption commande. Vous pouvez également diriger un objet ScheduledJobOptions vers Set-ScheduledJobOption.

Type:ScheduledJobOptions
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-MultipleInstancePolicy

Détermine comment le système répond à une demande de démarrage d'une instance d'une tâche planifiée alors qu'une autre instance de la tâche est en cours d'exécution. Les valeurs valides pour ce paramètre sont :

  • IgnoreNew - La nouvelle instance de travail est ignorée. Il s’agit de la valeur par défaut.
  • Parallel - La nouvelle instance de travail démarre immédiatement.
  • Queue - La nouvelle instance de travail démarre dès que l’instance actuelle se termine.
  • StopExisting - L’instance actuelle du travail s’arrête et la nouvelle instance démarre.

Pour exécuter la tâche, toutes les conditions de la planification des tâches doivent être remplies. Par exemple, si les conditions définies par les paramètres RequireNetwork, IdleDuration et IdleTimeout ne sont pas satisfaites, l’instance de travail n’est pas démarrée, quelle que soit la valeur de ce paramètre.

Type:TaskMultipleInstancePolicy
Valeurs acceptées:None, IgnoreNew, Parallel, Queue, StopExisting
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PassThru

Retourne un objet représentant l’élément que vous utilisez. Par défaut, cette applet de commande ne génère aucun résultat.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RequireNetwork

Exécute la tâche planifiée uniquement quand des connexions réseau sont disponibles.

Si vous spécifiez ce paramètre et que le réseau n'est pas disponible à l'heure de début planifiée, la tâche ne s'exécute pas avant la prochaine heure de début planifiée, le cas échéant.

Le paramètre RequireNetwork définit la valeur de la propriété RunWithoutNetwork des travaux $falseplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RestartOnIdleResume

Redémarre une tâche planifiée quand l'ordinateur devient inactif. Ce paramètre fonctionne avec le paramètre StopIfGoingOffIdle , qui suspend une tâche planifiée en cours d’exécution si l’ordinateur devient actif (laisse l’état inactif).

Le paramètre RestartOnIdleResume définit la valeur de la propriété RestartOnIdleResume des travaux $trueplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RunElevated

Exécute la tâche planifiée avec les autorisations d'un membre du groupe Administrateurs sur l'ordinateur sur lequel s'exécute la tâche.

Pour permettre à un travail planifié de s’exécuter avec des autorisations d’administrateur, utilisez le paramètre Credential pour Register-ScheduledJob fournir des informations d’identification explicites pour le travail.

Le paramètre RunElevated définit la valeur de la propriété RunElevated des travaux $trueplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-StartIfIdle

Démarre le travail planifié si l’ordinateur a été inactif pendant l’heure spécifiée par le paramètre IdleDuration avant l’expiration de l’heure spécifiée par le paramètre IdleTimeout .

Par défaut, les paramètres IdleDuration et IdleTimeout sont ignorés et le travail démarre à l’heure de début planifiée, même si l’ordinateur est occupé.

Si vous spécifiez ce paramètre et que l'ordinateur est occupé (non inactif) à l'heure de début planifiée, la tâche ne s'exécute pas avant la prochaine heure de début planifiée, le cas échéant.

Le paramètre StartIfIdle définit la valeur de la propriété StartIfNotIdle des travaux $falseplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-StartIfOnBattery

Démarre la tâche planifiée, même si l'ordinateur fonctionne sur batterie à l'heure de début planifiée. La valeur par défaut est $false.

Le paramètre StartIfOnBattery définit la valeur de la propriété StartIfOnBatteries des travaux $trueplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-StopIfGoingOffIdle

Interrompt une tâche planifiée en cours d'exécution si l'ordinateur devient actif (non inactif) alors que la tâche est en cours d'exécution.

Par défaut, une tâche planifiée qui est suspendue quand l'ordinateur devient actif reprend quand il redevient inactif. Pour modifier ce comportement par défaut, utilisez le paramètre RestartOnIdleResume .

Le paramètre StopIfGoingOffIdle définit la valeur de la propriété StopIfGoingOffIdle des travaux $trueplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WakeToRun

Sort l'ordinateur de son état de veille prolongée ou de veille à l'heure de début planifiée afin qu'il puisse exécuter la tâche. Par défaut, si l'ordinateur est dans un état de veille prolongée ou de veille à l'heure de début planifiée, la tâche ne s'exécute pas.

Le paramètre WakeToRun définit la valeur de la propriété WakeToRun des travaux $trueplanifiés sur .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

ScheduledJobOptions

Vous pouvez diriger un objet d’options de travail planifiée vers cette applet de commande.

Sorties

None

Par défaut, cette applet de commande ne retourne aucune sortie.

ScheduledJobOptions

Lorsque vous utilisez le paramètre PassThru , cette applet de commande retourne les options de travail qui ont été modifiées.