Wait-Job

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

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

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

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

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

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

Wait-Job コマンドレットは、ジョブが終了状態になるまで待機してから実行を続行します。 終了状態は次のとおりです。

• 完了済み
• 失敗しました
• 停止しました
• 一時停止されています
• 切断された

指定されたジョブ、またはすべてのジョブが終了状態になるまで待機できます。 Timeout パラメーターを使用してジョブの最大待機時間を設定したり、Force パラメーターを使用して Suspended または Disconnected 状態のジョブを待機したりすることもできます。

ジョブ内のコマンドが完了すると、Wait-Job はジョブ オブジェクトを返し、実行を続行します。

Wait-Job コマンドレットを使用して、Start-Job コマンドレットまたは コマンドレットの Invoke-Command パラメーターを使用してジョブが開始されるのを待機できます。 ジョブの詳細については、about_Jobsを参照してください。

Windows PowerShell 3.0 以降、Wait-Job コマンドレットは、ワークフロー ジョブやスケジュールされたジョブのインスタンスなどのカスタム ジョブの種類を待機します。 Wait-Job が特定の種類のジョブを待機できるようにするには、セッションにカスタム ジョブの種類をサポートするモジュールをインポートしてから、Get-Job コマンドレットを実行します。この際、Import-Module コマンドレットを使用するか、モジュール内のコマンドレットを使用または取得します。 特定のカスタム ジョブの種類については、カスタム ジョブの種類機能のドキュメントを参照してください。

Get-Job | Wait-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

この例では、リモートコンピューターで開始されたジョブに対してWait-Job コマンドレットを使用し、Start-Job コマンドレットを利用する方法を示します。 Start-Job コマンドと Wait-Job コマンドの両方が、Invoke-Command コマンドレットを使用してリモート コンピューターに送信されます。

この例では、Wait-Job を使用して、3 つの異なるコンピューターでジョブとして実行されている Get-Date コマンドが完了したかどうかを確認します。

最初のコマンドは、3 台のリモート コンピューターそれぞれに Windows PowerShell セッション (PSSession) を作成し、$s 変数に格納します。

2 番目のコマンドでは、Invoke-Command を使用して、Start-Jobの 3 つの各セッションで $s を実行します。 すべてのジョブの名前は Date1 です。

3 番目のコマンドでは、Invoke-Command を使用して Wait-Jobを実行します。 このコマンドは、各コンピューターの Date1 ジョブが完了するまで待機します。 結果として得られた job オブジェクトのコレクション (array) は $done 変数に格納されます。

4 番目のコマンドでは、 変数内のジョブ オブジェクトの配列の $done プロパティを使用して、完了したジョブの数を決定します。

$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}

この例では、 の Wait-Job パラメーターを使用して、現在のセッションで実行されている多数のジョブの最初のジョブが終了状態になっているかどうかを判断します。 また、Wait-Job コマンドレットを使用してリモート ジョブが完了するまで待機する方法についても説明します。

最初のコマンドは、Machines.txt ファイルにリストされている各コンピューターに PSSession を作成し、PSSession オブジェクトを $s 変数に格納します。 このコマンドでは、Get-Content コマンドレットを使用してファイルの内容を取得します。 Get-Content コマンドは、New-PSSession コマンドの前に実行されるようにかっこで囲まれています。

2 番目のコマンドは、Get-EventLog コマンド文字列を引用符で囲んで $c 変数に格納します。

3 番目のコマンドでは、Invoke-Command コマンドレットを使用して、Start-Jobの各セッションで $s を実行します。 Start-Job コマンドは、Get-EventLog 変数で $c コマンドを実行するジョブを開始します。

このコマンドは、Using: スコープ修飾子を使用して、$c 変数がローカル コンピューターで定義されたことを示します。 Using: スコープ修飾子は、Windows PowerShell 3.0 で導入されています。 Using: スコープ修飾子の詳細については、「about_Remote_Variables」を参照してください。

4 番目のコマンドでは、Invoke-Command を使用してセッションで Wait-Job コマンドを実行します。 Any パラメーターを使用して、リモート コンピューターの最初のジョブが終了状態になるまで待機します。

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>

この例では、 の Wait-Job パラメーターを使用して、リモート コンピューターで実行されているジョブの最大待機時間を設定する方法を示します。

最初のコマンドは、3 つのリモート コンピューター (Server01、Server02、Server03) のそれぞれに PSSession を作成し、PSSession オブジェクトを $s 変数に格納します。

2 番目のコマンドでは、Invoke-Command を使用して、Start-Jobの各 PSSession オブジェクトで $s を実行します。 結果のジョブ オブジェクトが $jobs 変数に格納されます。

3 番目のコマンドでは、Invoke-Command を使用して、Wait-Jobの各セッションで $s を実行します。 Wait-Job コマンドは、すべてのコマンドが 30 秒以内に完了したかどうかを判断します。 値が 30 の Timeout パラメーターを使用して最大待機時間を設定し、コマンドの結果を $done 変数に格納します。

この場合、30 秒後に、Server02 コンピューター上のコマンドのみが完了します。 Wait-Job が待機を終了し、完了したジョブを表すオブジェクトを返して、コマンドプロンプトを表示します。

$done 変数には、Server02 で実行されたジョブを表すジョブ オブジェクトが含まれています。

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

このコマンドは、ID によって 3 つのジョブを識別し、いずれかのジョブが終了状態になるまで待機します。 最初のジョブが完了すると、実行が続行されます。

Wait-Job -Name "DailyLog" -Timeout 120

このコマンドは、DailyLog ジョブが完了するまで 120 秒 (2 分) 待機します。 ジョブが次の 2 分間に完了しない場合、実行は続行され、ジョブはバックグラウンドで実行され続けます。

Wait-Job -Name "Job3"

このコマンドは、ジョブ名を使用して、待機するジョブを識別します。

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

この例では、Wait-Jobを使用してローカル コンピューターで開始されたジョブで Start-Job コマンドレットを使用する方法を示します。

これらのコマンドは、先週追加または更新された Windows PowerShell スクリプト ファイルを取得するジョブを開始します。

最初のコマンドでは、Start-Job を使用してローカル コンピューターでジョブを開始します。 ジョブは、Get-ChildItem コマンドを実行して、前の週に追加または更新された .ps1 ファイル名拡張子を持つすべてのファイルを取得します。

3 番目のコマンドでは、Wait-Job を使用して、ジョブが終了状態になるまで待機します。 ジョブが完了すると、ジョブに関する情報を含むジョブ オブジェクトが表示されます。

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

この例では、Wait-Jobの AsJob パラメーターを使用して、リモート コンピューターで開始されたジョブで Invoke-Command を使用する方法を示します。 AsJobを使用する場合、ジョブはローカル コンピューターで作成され、リモート コンピューターでジョブが実行されている場合でも、結果はローカル コンピューターに自動的に返されます。

この例では、Wait-Job を使用して、3 台のリモート コンピューター上のセッションで実行されている Get-Process コマンドが終了状態であるかどうかを判断します。

最初のコマンドは、3 台のコンピューター PSSession オブジェクトを作成し、$s 変数に格納します。

2 番目のコマンドでは、Invoke-Command を使用して、Get-Processの 3 つの各セッションで $s を実行します。 コマンドは、AsJob パラメーターを使用して、ジョブとしてコマンドを非同期的に実行します。 このコマンドは、Start-Jobを使用して開始されたジョブと同様にジョブ オブジェクトを返し、ジョブ オブジェクトは $j 変数に格納されます。

3 番目のコマンドでは、パイプライン演算子 (|) を使用して、$j のジョブ オブジェクトを Wait-Job コマンドレットに送信します。 この場合、ジョブはローカル コンピューター上に存在するため、Invoke-Command コマンドは必要ありません。

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

このコマンドは、ID 値が 1 であるジョブを待機します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

ジョブ オブジェクトをこのコマンドレットにパイプできます。

このコマンドレットは、終了状態のジョブを表すジョブ オブジェクトを返します。 Timeout パラメーターの値を超えたために待機が終了した場合、Wait-Job はオブジェクトを返しません。

PowerShell には、Wait-Jobの次のエイリアスが含まれています。

• すべてのプラットフォーム:
  • wjb

既定では、ジョブが次のいずれかの状態にある場合、Wait-Job は戻るか待機を終了します。

• 完了済み
• 失敗しました
• 停止しました
• 一時停止されています
• 切断された

中断されたジョブと切断されたジョブを待機し続けるように Wait-Job に指示するには、Force パラメーターを使用します。