Wait-Job

Referenz

Modul:: Microsoft.PowerShell.Core

Wartet, bis ein oder alle powerShell-Aufträge, die in der Sitzung ausgeführt werden, in einem Beendigungszustand liegen.

Syntax

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-Id] <Int32[]>
    [<CommonParameters>]

Wait-Job
    [-Job] <Job[]>
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [<CommonParameters>]

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-Name] <String[]>
    [<CommonParameters>]

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-InstanceId] <Guid[]>
    [<CommonParameters>]

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-State] <JobState>
    [<CommonParameters>]

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-Filter] <Hashtable>
    [<CommonParameters>]

Beschreibung

Das Cmdlet Wait-Job wartet auf einen Auftrag, bevor die Ausführung fortgesetzt wird. Die Beendigungszustände sind:

Abgeschlossen
Misslungen
Angehalten
Ausgesetzt
Entfernt

Sie können warten, bis ein angegebener Auftrag oder alle Aufträge in einem Beendigungszustand liegen. Sie können auch eine maximale Wartezeit für den Auftrag mithilfe des Timeout--Parameters festlegen oder den Parameter Force verwenden, um auf einen Auftrag im Suspended- oder Disconnected-Status zu warten.

Wenn die Befehle im Auftrag abgeschlossen sind, gibt Wait-Job ein Auftragsobjekt zurück und setzt die Ausführung fort.

Sie können das Cmdlet Wait-Job verwenden, um mit dem Cmdlet Start-Job oder dem parameter AsJob des Cmdlets Invoke-Command begonnene Aufträge zu warten. Weitere Informationen zu Aufträgen finden Sie unter about_Jobs.

Ab Windows PowerShell 3.0 wartet das cmdlet Wait-Job auch auf benutzerdefinierte Auftragstypen, z. B. Workflowaufträge und Instanzen geplanter Aufträge. Damit Wait-Job auf Aufträge eines bestimmten Typs warten können, importieren Sie das Modul, das den benutzerdefinierten Auftragstyp unterstützt, in die Sitzung, bevor Sie das cmdlet Get-Job ausführen, entweder mithilfe des Cmdlets Import-Module oder mithilfe oder Abrufen eines Cmdlets im Modul. Informationen zu einem bestimmten benutzerdefinierten Auftragstyp finden Sie in der Dokumentation des Features für den benutzerdefinierten Auftragstyp.

Beispiele

Beispiel 1: Auf alle Aufträge warten

Get-Job | Wait-Job

Dieser Befehl wartet auf den Abschluss aller aufträge, die in der Sitzung ausgeführt werden.

Beispiel 2: Warten auf Aufträge, die auf Remotecomputern gestartet wurden, mithilfe von Start-Job

$s = New-PSSession Server01, Server02, Server03
Invoke-Command -Session $s -ScriptBlock {Start-Job -Name Date1 -ScriptBlock {Get-Date}}
$done = Invoke-Command -Session $s -Command {Wait-Job -Name Date1}
$done.Count

3

In diesem Beispiel wird gezeigt, wie Sie das cmdlet Wait-Job mit Aufträgen verwenden, die auf Remotecomputern mithilfe des Cmdlets Start-Job gestartet wurden. Befehle Start-Job und Wait-Job werden mithilfe des cmdlets Invoke-Command an den Remotecomputer übermittelt.

In diesem Beispiel wird Wait-Job verwendet, um zu bestimmen, ob ein Get-Date Befehl, der als Auftrag auf drei verschiedenen Computern ausgeführt wird, abgeschlossen ist.

Der erste Befehl erstellt eine Windows PowerShell-Sitzung (PSSession) auf jedem der drei Remotecomputer und speichert sie in der $s Variablen.

Der zweite Befehl verwendet Invoke-Command, um Start-Job in jeder der drei Sitzungen in $sauszuführen. Alle Aufträge heißen "Date1".

Der dritte Befehl verwendet Invoke-Command, um Wait-Jobauszuführen. Dieser Befehl wartet auf den Abschluss der Date1 Aufträge auf jedem Computer. Sie speichert die resultierende Auflistung (Array-) von Auftrag Objekten in der $done Variablen.

Der vierte Befehl verwendet die eigenschaft Count des Arrays von Auftragsobjekten in der variablen $done, um zu bestimmen, wie viele der Aufträge abgeschlossen sind.

Beispiel 3: Ermitteln, wann der erste Auftrag abgeschlossen ist

$s = New-PSSession -ComputerName (Get-Content -Path .\Machines.txt)
$c = 'Get-EventLog -LogName System | Where-Object {$PSItem.EntryType -eq "error" --and $PSItem.Source -eq "LSASRV"} | Out-File -FilePath Errors.txt'
Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {$Using:c}
Invoke-Command -Session $s -ScriptBlock {Wait-Job -Any}

In diesem Beispiel wird der Any-Parameter von Wait-Job verwendet, um zu bestimmen, wann sich die erste der in der aktuellen Sitzung ausgeführten Aufträge in einem Beendigungszustand befindet. Außerdem wird gezeigt, wie Sie mit dem Cmdlet Wait-Job warten, bis Remoteaufträge abgeschlossen sind.

Der erste Befehl erstellt eine PSSession- auf jedem der in der Machines.txt Datei aufgeführten Computer und speichert die PSSession- Objekte in der variablen $s. Der Befehl verwendet das Cmdlet Get-Content, um den Inhalt der Datei abzurufen. Der Befehl Get-Content wird in Klammern eingeschlossen, um sicherzustellen, dass er vor dem Befehl New-PSSession ausgeführt wird.

Der zweite Befehl speichert eine Get-EventLog Befehlszeichenfolge in Anführungszeichen in der variablen $c.

Der dritte Befehl verwendet Invoke-Command Cmdlet, um Start-Job in den einzelnen Sitzungen in $sauszuführen. Der Befehl Start-Job startet einen Auftrag, der den Befehl Get-EventLog in der variablen $c ausführt.

Der Befehl verwendet den Using: Bereichsmodifizierer, um anzugeben, dass die $c Variable auf dem lokalen Computer definiert wurde. Der Using: Bereichsmodifizierer wird in Windows PowerShell 3.0 eingeführt. Weitere Informationen zum Using: Bereichsmodifizierer finden Sie unter about_Remote_Variables.

Der vierte Befehl verwendet Invoke-Command, um einen Wait-Job Befehl in den Sitzungen auszuführen. Er verwendet die Any Parameter, um zu warten, bis der erste Auftrag auf den Remotecomputern den Zustand beendet.

Beispiel 4: Festlegen einer Wartezeit für Aufträge auf Remotecomputern

PS> $s = New-PSSession -ComputerName Server01, Server02, Server03
PS> $jobs = Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {Get-Date}}
PS> $done = Invoke-Command -Session $s -ScriptBlock {Wait-Job -Timeout 30}
PS>

In diesem Beispiel wird gezeigt, wie Sie den Timeout Parameter von Wait-Job verwenden, um eine maximale Wartezeit für die Aufträge festzulegen, die auf Remotecomputern ausgeführt werden.

Der erste Befehl erstellt eine PSSession- auf jedem der drei Remotecomputer (Server01, Server02 und Server03) und speichert dann die PSSession- Objekte in der $s Variablen.

Der zweite Befehl verwendet Invoke-Command, um Start-Job in jedem der PSSession- Objekte in $sauszuführen. Es speichert die resultierenden Auftragsobjekte in der $jobs Variablen.

Der dritte Befehl verwendet Invoke-Command, um Wait-Job in jeder sitzung in $sauszuführen. Der Befehl Wait-Job bestimmt, ob alle Befehle innerhalb von 30 Sekunden abgeschlossen wurden. Er verwendet den Timeout--Parameter mit dem Wert 30, um die maximale Wartezeit festzulegen, und speichert dann die Ergebnisse des Befehls in der $done Variablen.

In diesem Fall ist nach 30 Sekunden nur der Befehl auf dem Server02-Computer abgeschlossen. Wait-Job die Wartezeit endet, gibt das Objekt zurück, das den abgeschlossenen Auftrag darstellt, und zeigt die Eingabeaufforderung an.

Die variable $done enthält ein Auftragsobjekt, das den Auftrag darstellt, der auf Server02 ausgeführt wurde.

Beispiel 5: Warten, bis einer von mehreren Aufträgen abgeschlossen ist

Wait-Job -Id 1,2,5 -Any

Mit diesem Befehl werden drei Aufträge anhand ihrer IDs identifiziert und gewartet, bis sich eins dieser Aufträge in einem Beendigungszustand befindet. Die Ausführung wird fortgesetzt, wenn der erste Auftrag abgeschlossen ist.

Beispiel 6: Warten Sie auf einen Zeitraum, und lassen Sie dann zu, dass der Auftrag im Hintergrund fortgesetzt wird.

Wait-Job -Name "DailyLog" -Timeout 120

Dieser Befehl wartet 120 Sekunden (zwei Minuten), bis der DailyLog-Auftrag abgeschlossen ist. Wenn der Auftrag in den nächsten zwei Minuten nicht abgeschlossen wird, wird die Ausführung fortgesetzt, und der Auftrag wird weiterhin im Hintergrund ausgeführt.

Beispiel 7: Warten auf einen Auftrag anhand des Namens

Wait-Job -Name "Job3"

Dieser Befehl verwendet den Auftragsnamen, um den Auftrag zu identifizieren, für den gewartet werden soll.

Beispiel 8: Warten auf Aufträge auf dem lokalen Computer, die mit Start-Job gestartet wurden

$j = Start-Job -ScriptBlock {Get-ChildItem -Filter *.ps1| Where-Object {$PSItem.LastWriteTime -gt ((Get-Date) - (New-TimeSpan -Days 7))}}
$j | Wait-Job

In diesem Beispiel wird gezeigt, wie Sie das Cmdlet Wait-Job mit Aufträgen verwenden, die mit Start-Jobauf dem lokalen Computer gestartet wurden.

Diese Befehle starten einen Auftrag, der die Windows PowerShell-Skriptdateien abruft, die in der letzten Woche hinzugefügt oder aktualisiert wurden.

Der erste Befehl verwendet Start-Job, um einen Auftrag auf dem lokalen Computer zu starten. Der Auftrag führt einen Get-ChildItem Befehl aus, der alle Dateien mit einer .ps1 Dateinamenerweiterung abruft, die in der letzten Woche hinzugefügt oder aktualisiert wurden.

Der dritte Befehl verwendet Wait-Job, um zu warten, bis sich der Auftrag in einem Beendigungszustand befindet. Nach Abschluss des Auftrags zeigt der Befehl das Auftragsobjekt an, das Informationen zum Auftrag enthält.

Beispiel 9: Warten auf Aufträge, die auf Remotecomputern gestartet wurden, mithilfe von Invoke-Command

$s = New-PSSession -ComputerName Server01, Server02, Server03
$j = Invoke-Command -Session $s -ScriptBlock {Get-Process} -AsJob
$j | Wait-Job

In diesem Beispiel wird gezeigt, wie Sie Wait-Job mit Aufträgen verwenden, die auf Remotecomputern gestartet wurden, indem Sie den Parameter AsJob von Invoke-Commandverwenden. Wenn Sie AsJobverwenden, wird der Auftrag auf dem lokalen Computer erstellt, und die Ergebnisse werden automatisch an den lokalen Computer zurückgegeben, obwohl der Auftrag auf den Remotecomputern ausgeführt wird.

In diesem Beispiel wird Wait-Job verwendet, um zu bestimmen, ob ein Get-Process Befehl, der in den Sitzungen auf drei Remotecomputern ausgeführt wird, in einem Beendigungszustand liegt.

Der erste Befehl erstellt PSSession- Objekte auf drei Computern und speichert sie in der $s Variablen.

Der zweite Befehl verwendet Invoke-Command, um Get-Process in jeder der drei Sitzungen in $sauszuführen. Der Befehl verwendet den AsJob Parameter, um den Befehl asynchron als Auftrag auszuführen. Der Befehl gibt ein Auftragsobjekt zurück, genau wie die Aufträge, die mit Start-Jobgestartet wurden, und das Auftragsobjekt wird in der variablen $j gespeichert.

Der dritte Befehl verwendet einen Pipelineoperator (|), um das Auftragsobjekt in $j an das Cmdlet Wait-Job zu senden. In diesem Fall ist kein Invoke-Command Befehl erforderlich, da sich der Auftrag auf dem lokalen Computer befindet.

Beispiel 10: Warten auf einen Auftrag mit einer ID

Get-Job

Id   Name     State      HasMoreData     Location             Command
--   ----     -----      -----------     --------             -------
1    Job1     Completed  True            localhost,Server01.. Get-Service
4    Job4     Completed  True            localhost            dir | where

Wait-Job -Id 1

Dieser Befehl wartet auf den Auftrag mit dem ID-Wert 1.

Parameter

-Any

Gibt an, dass dieses Cmdlet das Auftragsobjekt zurückgibt und die Ausführung fortsetzt, wenn ein Auftrag abgeschlossen ist. Standardmäßig wartet Wait-Job, bis alle angegebenen Aufträge abgeschlossen sind, bevor die Eingabeaufforderung angezeigt wird.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Filter

Gibt eine Hashtabelle mit Bedingungen an. Dieses Cmdlet wartet auf Aufträge, die alle Bedingungen in der Hashtabelle erfüllen. Geben Sie eine Hashtabelle ein, in der die Schlüssel Auftragseigenschaften und die Werte Auftragseigenschaftswerte sind.

Dieser Parameter funktioniert nur für benutzerdefinierte Auftragstypen, z. B. Workflowaufträge und geplante Aufträge. Es funktioniert nicht bei Standardaufträgen, z. B. bei denen, die mit dem Cmdlet Start-Job erstellt wurden. Informationen zur Unterstützung für diesen Parameter finden Sie im Hilfethema für den Auftragstyp.

Dieser Parameter wurde in Windows PowerShell 3.0 eingeführt.

Typ:	Hashtable
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Force

Gibt an, dass dieses Cmdlet weiterhin auf Aufträge im Zustand "Angehalten" oder "Getrennt" wartet. Standardmäßig gibt Wait-Job die Wartezeit zurück oder endet, wenn Aufträge in einem der folgenden Zustände enthalten sind:

Abgeschlossen
Misslungen
Angehalten
Ausgesetzt
Entfernt

Dieser Parameter wurde in Windows PowerShell 3.0 eingeführt.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Id

Gibt ein Array von IDs von Aufträgen an, für die dieses Cmdlet wartet.

Die ID ist eine ganze Zahl, die den Auftrag in der aktuellen Sitzung eindeutig identifiziert. Es ist einfacher zu merken und einzugeben als die Instanz-ID, aber sie ist nur in der aktuellen Sitzung eindeutig. Sie können eine oder mehrere IDs eingeben, getrennt durch Kommas. Geben Sie Get-Jobein, um die ID eines Auftrags zu finden.

Typ:	Int32[]
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-InstanceId

Gibt ein Array von Instanz-IDs von Aufträgen an, für die dieses Cmdlet wartet. Der Standardwert ist alle Aufträge.

Eine Instanz-ID ist eine GUID, die den Auftrag auf dem Computer eindeutig identifiziert. Um die Instanz-ID eines Auftrags zu finden, verwenden Sie Get-Job.

Typ:	Guid[]
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Job

Gibt die Aufträge an, für die dieses Cmdlet wartet. Geben Sie eine Variable ein, die die Auftragsobjekte oder einen Befehl enthält, der die Auftragsobjekte abruft. Sie können auch einen Pipelineoperator verwenden, um Auftragsobjekte an das Cmdlet Wait-Job zu senden. Standardmäßig wartet Wait-Job auf alle Aufträge, die in der aktuellen Sitzung erstellt wurden.

Typ:	Job[]
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Name

Gibt Anzeigenamen von Aufträgen an, für die dieses Cmdlet wartet.

Typ:	String[]
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-State

Gibt einen Auftragsstatus an. Dieses Cmdlet wartet nur auf Aufträge im angegebenen Zustand. Die zulässigen Werte für diesen Parameter sind:

NotStarted
Ausgeführte
Abgeschlossen
Misslungen
Angehalten
Gesperrt
Ausgesetzt
Entfernt
Aufschiebend
Anhaltend

Weitere Informationen zu Auftragszuständen finden Sie unter JobState Enumeration.

Typ:	JobState
Zulässige Werte:	NotStarted, Running, Completed, Failed, Stopped, Blocked, Suspended, Disconnected, Suspending, Stopping, AtBreakpoint
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Timeout

Gibt die maximale Wartezeit für jeden Auftrag in Sekunden an. Der Standardwert -1 gibt an, dass das Cmdlet wartet, bis der Auftrag abgeschlossen ist. Die Anzeigedauer beginnt, wenn Sie den Befehl Wait-Job übermitteln, nicht den Befehl Start-Job.

Wenn diese Zeit überschritten wird, wird die Wartezeit beendet und die Ausführung fortgesetzt, auch wenn der Auftrag noch ausgeführt wird. Der Befehl zeigt keine Fehlermeldung an.

Typ:	Int32
Aliase:	TimeoutSec
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

Eingaben

System.Management.Automation.RemotingJob

Sie können ein Auftragsobjekt an dieses Cmdlet weiterleiten.

Ausgaben

System.Management.Automation.PSRemotingJob

Dieses Cmdlet gibt Auftragsobjekte zurück, die die Aufträge in einem Beendigungszustand darstellen. Wenn die Wartezeit endet, weil der Wert des Timeout Parameter überschritten wird, gibt Wait-Job keine Objekte zurück.

Hinweise

PowerShell enthält die folgenden Aliase für Wait-Job:

Alle Plattformen:
- wjb

Standardmäßig gibt Wait-Job die Wartezeit zurück oder endet, wenn Aufträge in einem der folgenden Zustände enthalten sind:

Abgeschlossen
Misslungen
Angehalten
Ausgesetzt
Entfernt

Um Wait-Job weiter auf Angehaltene und getrennte Aufträge zu warten, verwenden Sie den Parameter Force.