Udostępnij za pośrednictwem

Get-ScheduledJobOption

  • Odwołanie
Moduł:
PSScheduledJob

Pobiera opcje zadań zaplanowanych.

Składnia

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

Opis

Polecenie cmdlet Get-ScheduledJobOption pobiera opcje zadań zaplanowanych zadań. To polecenie służy do sprawdzania opcji zadania lub potoku opcji zadania do innych poleceń cmdlet.

Opcje zadania nie są zapisywane na dysku niezależnie; są częścią zaplanowanego zadania. Aby uzyskać opcje zadania zaplanowanego zadania, określ zaplanowane zadanie.

Użyj parametrów polecenia cmdlet Get-ScheduledJobOption, aby zidentyfikować zaplanowane zadanie. Zaplanowane zadania można zidentyfikować według ich nazw lub numerów identyfikacyjnych albo wprowadzając lub potokując obiekty ScheduledJob, takie jak obiekty zwracane przez polecenie cmdlet Get-ScheduledJob, aby Get-ScheduledJobOption.

Get-ScheduledJobOption jest jedną z kolekcji poleceń cmdlet planowania zadań w module PSScheduledJob, który jest zawarty w programie Windows PowerShell.

Aby uzyskać więcej informacji na temat zaplanowanych zadań, zobacz temat Informacje w module PSScheduledJob. Zaimportuj moduł PSScheduledJob, a następnie wpisz: Get-Help about_Scheduled* lub zobacz about_Scheduled_Jobs.

To polecenie cmdlet zostało wprowadzone w programie Windows PowerShell 3.0.

Przykłady

Przykład 1. Pobieranie opcji zadania

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

To polecenie pobiera opcje zadań zaplanowanych zadań, które mają kopię zapasową w nazwach. Wyniki pokazują obiekt opcji zadania, który zwrócony Get-ScheduledJobOption.

Przykład 2. Pobieranie wszystkich opcji zadań

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

To polecenie pobiera opcje zadania wszystkich zaplanowanych zadań na komputerze lokalnym.

Używa on polecenia cmdlet Get-ScheduledJob w celu pobrania zaplanowanych zadań na komputerze lokalnym. Operator potoku (|) wysyła zaplanowane zadania do polecenia cmdlet Get-ScheduledJobOptions, które pobiera opcje zadania dla każdego zaplanowanego zadania.

Przykład 3. Pobieranie wybranych opcji zadania

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

W tym przykładzie pokazano, jak znaleźć obiekt opcji zadań z określonymi wartościami.

Pierwsze polecenie pobiera opcje zadań, w których właściwość RunElevated ma wartość $True, a właściwość RunWithoutNetwork ma wartość $False. Dane wyjściowe przedstawiają JobOptions wybrany obiekt.

Przykład 4. Tworzenie nowego zadania przy użyciu opcji zadania

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

W tym przykładzie pokazano, jak używać opcji zadań, które Get-ScheduledJobOptions są w nowym zaplanowanym zadaniu.

Pierwsze polecenie używa Get-ScheduledJobOptions, aby uzyskać opcje zadań zaplanowanego zadania BackupTestLogs. Polecenie zapisuje opcje w zmiennej $Opts.

Drugie polecenie używa polecenia cmdlet Register-ScheduledJob do utworzenia nowego zaplanowanego zadania. Wartość parametru ScheduledJobOption to obiekt options w zmiennej $Opts.

Przykład 5. Pobieranie opcji zadania z komputera zdalnego

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

To polecenie używa polecenia cmdlet Invoke-Command, aby uzyskać opcje zaplanowanego zadania DataDemon na komputerze Srv01. Polecenie zapisuje opcje w zmiennej $O.

Parametry

-Id

Określa numer identyfikacyjny zaplanowanego zadania. Get-ScheduledJobOption pobiera opcje zadania określonego zaplanowanego zadania.

Aby uzyskać numery identyfikacyjne zaplanowanych zadań na komputerze lokalnym lub komputerze zdalnym, użyj polecenia cmdlet Get-ScheduledJob.

Typ:Int32
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-InputObject

Określa zaplanowane zadanie. Wprowadź zmienną zawierającą obiekt ScheduledJob lub wpisz polecenie lub wyrażenie, które pobiera obiekt ScheduledJob, na przykład polecenie Get-ScheduledJob. Możesz również przekazać obiekt ScheduledJob do Get-ScheduledJobOption.

Typ:ScheduledJobDefinition
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Name

Określa nazwy zaplanowanych zadań. Get-ScheduledJobOption pobiera opcje zadania określonego zaplanowanego zadania. Obsługiwane są symbole wieloznaczne.

Aby uzyskać nazwy zaplanowanych zadań na komputerze lokalnym lub komputerze zdalnym, użyj polecenia cmdlet Get-ScheduledJob.

Typ:String
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

ScheduledJobDefinition

Zaplanowane zadanie można potokować z Get-ScheduledJob do Get-ScheduledJobOption.

Dane wyjściowe

ScheduledJobOptions