Partager via

Get-ScheduledJobOption

  • Référence
Module:
PSScheduledJob

Obtient les options de travail des travaux planifiés.

Syntaxe

Get-ScheduledJobOption
   [-InputObject] <ScheduledJobDefinition>
   [<CommonParameters>]
Get-ScheduledJobOption
   [-Id] <Int32>
   [<CommonParameters>]
Get-ScheduledJobOption
   [-Name] <String>
   [<CommonParameters>]

Description

L’applet de commande Get-ScheduledJobOption obtient les options de travail des travaux planifiés. Vous pouvez utiliser cette commande pour examiner les options de travail ou diriger les options de travail vers d’autres applets de commande.

Les options de travail ne sont pas enregistrées sur le disque indépendamment ; ils font partie d’un travail planifié. Pour obtenir les options de travail d’un travail planifié, spécifiez la tâche planifiée.

Utilisez les paramètres de l’applet de commande Get-ScheduledJobOption pour identifier le travail planifié. Vous pouvez identifier les travaux planifiés par leurs noms ou numéros d’identification, ou en entrant ou en pipissant objets scheduledJob, tels que ceux retournés par l’applet de commande Get-ScheduledJob, pour Get-ScheduledJobOption.

Get-ScheduledJobOption est une collection d’applets de commande de planification de travaux dans le module 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 : Obtenir les options de travail

PS C:\> Get-ScheduledJobOption -Name "*Backup*"
StartIfOnBatteries     : False

StopIfGoingOnBatteries : True

WakeToRun              : False

StartIfNotIdle         : True

StopIfGoingOffIdle     : False

RestartOnIdleResume    : False

IdleDuration           : 00:10:00

IdleTimeout            : 01:00:00

ShowInTaskScheduler    : True

RunElevated            : True

RunWithoutNetwork      : True

DoNotAllowDemandStart  : False

MultipleInstancePolicy : Ignore

NewJobDefinition       : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

Cette commande obtient les options de travail des travaux planifiés qui ont backup dans leurs noms. Les résultats affichent l’objet options de travail qui Get-ScheduledJobOption retourné.

Exemple 2 : Obtenir toutes les options de travail

PS C:\> Get-ScheduledJob | Get-ScheduledJobOptions

Cette commande obtient les options de travail de tous les travaux planifiés sur l’ordinateur local.

Il utilise l’applet de commande Get-ScheduledJob pour obtenir les travaux planifiés sur l’ordinateur local. Un opérateur de pipeline (|) envoie les travaux planifiés au Get-ScheduledJobOptions cmdlet, qui obtient les options de travail de chaque travail planifié.

Exemple 3 : Obtenir les options de travail sélectionnées

PS C:\> Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun}
StartIfOnBatteries     : False

StopIfGoingOnBatteries : True

WakeToRun              : True

StartIfNotIdle         : True

StopIfGoingOffIdle     : False

RestartOnIdleResume    : False

IdleDuration           : 00:10:00

IdleTimeout            : 01:00:00

ShowInTaskScheduler    : True

RunElevated            : True

RunWithoutNetwork      : True

DoNotAllowDemandStart  : False

MultipleInstancePolicy : Ignore

NewJobDefinition       : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

The second command shows how to find to which scheduled job the job options belong. This command uses a pipeline operator (|) to send the selected job options to the ForEach-Object cmdlet, which gets the JobDefinition property of each options object. The JobDefinition property contains the originating job object. The results show that the selected options came from the DeployPkg scheduled job.
PS C:\> Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun} | ForEach-Object {$_.JobDefinition}
Id         Name            Triggers        Command                                  Enabled

--         ----            --------        -------                                  -------

2          DeployPkg         {1, 2}        DeployPackage.ps1                        True

Cet exemple montre comment rechercher un objet d’options de travail avec des valeurs particulières.

La première commande obtient les options de travail dans lesquelles la propriété RunElevated a la valeur $True et la propriété RunWithoutNetwork a une valeur de $False. La sortie affiche l’objet JobOptions sélectionné.

Exemple 4 : Utiliser les options de travail pour créer un travail

PS C:\> $Opts = Get-ScheduledJobOption -Name "BackupTestLogs"
PS C:\> Register-ScheduledJob -Name "Archive-Scripts" -FilePath "\\Srv01\Scripts\ArchiveScripts.ps1" -ScheduledJobOption $Opts

Cet exemple montre comment utiliser les options de travail qui Get-ScheduledJobOptions obtient dans un nouveau travail planifié.

La première commande utilise Get-ScheduledJobOptions pour obtenir les options de travaux du travail planifié BackupTestLogs. La commande enregistre les options dans la variable $Opts.

La deuxième commande utilise Register-ScheduledJob cmdlet pour créer un travail planifié. La valeur du paramètre ScheduledJobOption est l’objet options de la variable $Opts.

Exemple 5 : Obtenir des options de travail à partir d’un ordinateur distant

PS C:\> $O = Invoke-Command -ComputerName "Srv01" -ScriptBlock {Get-ScheduledJob -Name "DataDemon" }

Cette commande utilise l’applet de commande Invoke-Command pour obtenir les options de travail planifiées du travail DataDemon sur l’ordinateur Srv01. La commande enregistre les options dans la variable $O.

Paramètres

-Id

Spécifie le numéro d’identification d’un travail planifié. Get-ScheduledJobOption obtient les options de travail du travail planifié spécifié.

Pour obtenir les numéros d’identification des travaux planifiés sur l’ordinateur local ou un ordinateur distant, utilisez l’applet de commande Get-ScheduledJob.

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 un travail planifié. Entrez une variable qui contient un objet ScheduledJob ou tapez une commande ou une expression qui obtient un objet ScheduledJob, tel qu’une commande Get-ScheduledJob. Vous pouvez également diriger un objet ScheduledJob vers Get-ScheduledJobOption.

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

Spécifie les noms des travaux planifiés. Get-ScheduledJobOption obtient les options de travail du travail planifié spécifié. Les caractères génériques sont pris en charge.

Pour obtenir les noms des travaux planifiés sur l’ordinateur local ou un ordinateur distant, utilisez l’applet de commande Get-ScheduledJob.

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

Entrées

ScheduledJobDefinition

Vous pouvez diriger un travail planifié de Get-ScheduledJob vers Get-ScheduledJobOption .

Sorties

ScheduledJobOptions