Partager via

Disable-ScheduledJob

  • Référence
Module:
PSScheduledJob

Désactive un travail planifié.

Syntaxe

Disable-ScheduledJob
       [-InputObject] <ScheduledJobDefinition>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-ScheduledJob
       [-Id] <Int32>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-ScheduledJob
       [-Name] <String>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

L’applet de commande Disable-ScheduledJob désactive temporairement les travaux planifiés. La désactivation conserve toutes les propriétés du travail et ne désactive pas les déclencheurs de travail, mais empêche les travaux planifiés de démarrer automatiquement lorsqu’ils sont déclenchés. Vous pouvez démarrer un travail planifié désactivé à l’aide de l’applet de commande Start-Job ou utiliser un travail planifié désactivé comme modèle.

Pour désactiver un travail planifié, l’applet de commande Disable-ScheduledJob définit la propriété Enabled du travail planifié sur False ($false). Pour réactiver le travail planifié, utilisez l’applet de commande Enable-ScheduledJob.

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

Pour plus d’informations sur les travaux planifiés, consultez les rubriques À propos du 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 : Désactiver un travail planifié

PS C:\> Disable-ScheduledJob -ID 2 -Passthru
Id         Name            Triggers        Command                                  Enabled
--         ----            --------        -------                                  -------
2          Inventory       {1, 2}          \\Srv01\Scripts\Get-FullInventory.ps1    False

Cette commande désactive le travail planifié avec l’ID 2 sur l’ordinateur local. La sortie affiche l’effet de la commande.

Exemple 2 : Désactiver tous les travaux planifiés

PS C:\> Get-ScheduledJob | Disable-ScheduledJob -Passthru
Id         Name            Triggers        Command                                  Enabled
--         ----            --------        -------                                  -------
1          ArchiveProje... {}              C:\Scripts\Archive-DxProjects.ps1        False
2          Inventory       {1, 2}          \\Srv01\Scripts\Get-FullInventory.ps1    False
4          Test-HelpFiles  {1}             .\Test-HelpFiles.ps1                     False
5          TestJob         {1, 2}          .\Run-AllTests.ps1                       False

Cette commande désactive tous les travaux planifiés sur l’ordinateur local. Il utilise l’applet de commande Get-ScheduledJob pour obtenir tout le travail planifié et l’applet de commande Disable-ScheduledJob pour les désactiver.

Vous pouvez réactiver le travail planifié à l’aide de l’applet de commande Enable-ScheduledJob et exécuter un travail planifié désactivé à l’aide de l’applet de commande Start-Job.

disable-ScheduledJob ne génère pas d’avertissements ou d’erreurs si vous désactivez un travail planifié déjà désactivé, de sorte que vous pouvez désactiver tous les travaux planifiés sans conditions.

Exemple 3 : Désactiver les travaux planifiés sélectionnés

PS C:\> Get-ScheduledJob | Where-Object {!$_.Credential} | Disable-ScheduledJob

Cette commande désactive le travail planifié n’inclut pas d’informations d’identification. Les travaux sans informations d’identification s’exécutent avec l’autorisation de l’utilisateur qui les a créés.

La commande utilise l’applet de commande Get-ScheduledJob pour obtenir tous les travaux planifiés sur l’ordinateur. Un opérateur de pipeline envoie les travaux planifiés à l’applet de commande Where-Object, qui sélectionne les travaux planifiés qui n’ont pas d’informations d’identification. La commande utilise l’opérateur non ( !) et fait référence à la propriété Credential du travail planifié. Un autre opérateur de pipeline envoie les travaux planifiés sélectionnés à l’applet de commande Disable-ScheduledJob , qui les désactive.

Exemple 4 : Désactiver les travaux planifiés sur un ordinateur distant

PS C:\> Invoke-Command -ComputerName Srv01, Srv10 -ScriptBlock {Disable-ScheduledJob -Name TestJob}

Cette commande désactive le travail planifié TestJob sur deux ordinateurs distants, Srv01 et Srv10.

La commande utilise l’applet de commande Invoke-Command pour exécuter une commande Disable-ScheduledJob sur les ordinateurs Srv01 et Srv10. La commande utilise le paramètre Name de Disable-ScheduledJob pour sélectionner le travail planifié TestJob sur chaque ordinateur.

Exemple 5 : Désactiver un travail planifié par son ID global

The first command demonstrates one way of finding the GlobalID of a scheduled job. The command uses the Get-ScheduledJob cmdlet to get the scheduled jobs on the computer. A pipeline operator (|) sends the scheduled jobs to the Format-Table cmdlet, which displays the Name, GlobalID, and Command properties of each job in a table.
PS C:\> Get-ScheduledJob | Format-Table -Property Name, GlobalID, Command -Autosize
Name             GlobalId                             Command
----             --------                             -------
ArchiveProjects1 a26a0b3d-b4e6-44d3-8b95-8706ef621f7c C:\Scripts\Archive-DxProjects.ps1
Inventory        3ac37e5d-84c0-4a8f-9661-7e88ebb8f914 \\Srv01\Scripts\Get-FullInventory.ps1
Backup-Scripts   4d0cc6be-c082-48d1-baec-1bd8278f3c81  Copy-Item C:\CurrentScripts\*.ps1 -Destination C:\BackupScripts
Test-HelpFiles   d77020ca-f20d-42be-86c8-fc64df97db90 .\Test-HelpFiles.ps1
Test-HelpFiles   2f1606d2-c6cf-4bef-8b1c-ae36a9cc9934 .\Test-DomainHelpFiles.ps1

The second command uses the  Get-ScheduledJob cmdlet to get the scheduled jobs on the computer. A pipeline operator (|) sends the scheduled jobs to the Where-Object cmdlet, which selects the scheduled job with the specified global ID. Another pipeline operator sends the job to the **Disable-ScheduledJob** cmdlet, which disables it.
PS C:\> Get-ScheduledJob | Where-Object {$_.GlobalID = d77020ca-f20d-42be-86c8-fc64df97db90} | Disable-ScheduledJob

Cet exemple montre comment désactiver un travail planifié à l’aide de son identificateur global. La valeur de la propriété GlobalID d’un travail planifié est un identificateur unique (GUID). Utilisez la valeur GlobalID lorsque la précision est requise, par exemple lorsque vous désactivez des travaux planifiés sur plusieurs ordinateurs.

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

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

-Id

Désactive le travail planifié avec le numéro d’identification (ID) spécifié. Entrez l’ID d’un travail planifié.

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

-InputObject

Spécifie le travail planifié à désactiver. Entrez une variable qui contient ScheduledJobDefinition objets ou tapez une commande ou une expression qui obtient ScheduledJobDefinition objets, tels qu’une commande Get-ScheduledJob. Vous pouvez également diriger un objet ScheduledJobDefinition vers disable-ScheduledJob.

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

-Name

Désactive les travaux planifiés avec les noms spécifiés. Entrez le nom d’un travail planifié. Les caractères génériques sont pris en charge.

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

-PassThru

Retourne un objet représentant l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucune sortie.

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

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

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

Entrées

ScheduledJobDefinition

Vous pouvez diriger un travail planifié vers disable-scheduledJob.

Sorties

None or Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

Si vous utilisez le paramètre passthru , Disable-ScheduledJob retourne le travail planifié qui a été désactivé. Sinon, cette applet de commande ne génère aucune sortie.

Notes

  • disable-ScheduledJob ne génère pas d’avertissements ou d’erreurs si vous l’utilisez pour désactiver un travail planifié déjà désactivé.