Wait-Job

Referencia

Módulo:: Microsoft.PowerShell.Core

Suprime el símbolo del sistema hasta que se completen uno o todos los trabajos en segundo plano de Windows PowerShell que se ejecutan en la sesión.

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>]

Description

El cmdlet Wait-Job espera a que finalicen los trabajos en segundo plano Windows PowerShell antes de que muestre el símbolo del sistema. Puede esperar hasta que haya finalizado algún trabajo en segundo plano, o hasta que todos los trabajos en segundo plano hayan finalizado; además, puede establecer un tiempo máximo de espera para el trabajo.

Cuando se completen los comandos en el trabajo, Wait-Job muestra el símbolo del sistema y devuelve un objeto de trabajo para que pueda canalizarlo a otro comando.

Puede usar el cmdlet Wait-Job para esperar trabajos en segundo plano, como los que se iniciaron mediante el cmdlet Start-Job o el parámetro AsJob del cmdlet Invoke-Command. Para más información sobre los trabajos en segundo plano de Windows PowerShell, vea la página about_Jobs.

A partir de Windows PowerShell 3.0, el cmdlet Wait-Job también espera tipos de trabajo personalizados, como trabajos de flujo de trabajo e instancias de trabajos programados. Para permitir que Wait-Job espere trabajos de un tipo determinado, importe el módulo que admite el tipo de trabajo personalizado en la sesión antes de ejecutar el cmdlet Get-Job, ya sea mediante el cmdlet Import-Module o mediante o obtener un cmdlet en el módulo. Para información sobre un tipo determinado de trabajo personalizado, vea la documentación de la característica del tipo de trabajo personalizado.

Ejemplos

Ejemplo 1: Esperar todos los trabajos

PS C:\> Get-Job | Wait-Job

Este comando espera a que finalicen todos los trabajos en segundo plano que se ejecutan en la sesión.

Ejemplo 2: Esperar a que se inicien trabajos en equipos remotos mediante Start-Job

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

En este ejemplo se muestra cómo usar el cmdlet Wait-Job con trabajos iniciados en equipos remotos mediante el cmdlet Start-Job . Los comandos Start-Job y Wait-Job se envían al equipo remoto mediante el cmdlet Invoke-Command .

En este ejemplo se usa Wait-Job para determinar si ha finalizado un comando de Get-Date que se ejecuta como un trabajo en segundo plano en tres equipos diferentes.

El primer comando crea una sesión de Windows PowerShell (PSSession) en cada uno de los tres equipos remotos y las almacena en la variable $s.

El segundo comando usa Invoke-Command para ejecutar Start-Job en cada una de las tres sesiones de $s. Todos los trabajos se denominan Date1.

El tercer comando usa Invoke-Command para ejecutar Wait-Job. Este comando espera a que finalicen los trabajos date1 de cada equipo. Almacena la colección (matriz) resultante de objetos de trabajo en la variable $done.

El cuarto comando usa la propiedad Count de la matriz de objetos de trabajo en la variable $done para determinar cuántos de los trabajos han finalizado.

Ejemplo 3: Determinar cuándo finaliza el primer trabajo en segundo plano

PS C:\> $s = New-PSSession (Get-Content Machines.txt)
PS C:\> $c = 'Get-EventLog -LogName System | where {$_.EntryType -eq "error" --and $_.Source -eq "LSASRV"} | Out-File Errors.txt'
PS C:\> Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {$Using:c}
PS C:\> Invoke-Command -Session $s -ScriptBlock {Wait-Job -Any}

En este ejemplo se usa el parámetro Any de Wait-Job para determinar cuándo se completan los primeros de muchos trabajos en segundo plano que se ejecutan en la sesión actual. También muestra cómo usar el cmdlet Wait-Job para esperar a que finalicen los trabajos remotos.

El primer comando crea una PSSession en cada uno de los equipos enumerados en el archivo Machines.txt y almacena los objetos PSSession en la variable $s. El comando usa el cmdlet Get-Content para obtener el contenido del archivo. El comando Get-Content se incluye entre paréntesis para asegurarse de que se ejecuta antes del comando New-PSSession.

El segundo comando almacena una cadena de comandos Get-EventLog , entre comillas, en la variable $c.

El tercer comando usa Invoke-Command cmdlet para ejecutar Start-Job en cada una de las sesiones de $s. El comando Start-Job inicia un trabajo en segundo plano que ejecuta el comando Get-EventLog en la variable $c.

El comando usa el modificador de ámbito Using para indicar que se definió la variable $c en el equipo local. El modificador de ámbito Using se introdujo en Windows PowerShell 3.0. Para obtener más información sobre el modificador Using scope ( Usar modificador de ámbito), vea about_Remote_Variables (https://go.microsoft.com/fwlink/?LinkID=252653).

El cuarto comando usa Invoke-Command para ejecutar un comando Wait-Job en las sesiones. Usa el parámetro Any para esperar hasta que se complete el primer trabajo en los equipos remotos.

Ejemplo 4: Establecer un tiempo de espera para trabajos en equipos remotos

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

En este ejemplo se muestra cómo usar el parámetro Timeout de Wait-Job para establecer un tiempo de espera máximo para los trabajos que se ejecutan en equipos remotos.

El primer comando crea una PSSession en cada uno de los tres equipos remotos (Server01, Server02 y Server03) y, a continuación, almacena los objetos PSSession en la variable $s.

El segundo comando usa Invoke-Command para ejecutar Start-Job en cada uno de los objetos PSSession de $s. Almacena los objetos de trabajo resultantes en la variable $jobs.

El tercer comando usa Invoke-Command para ejecutar Wait-Job en cada una de las sesiones de $s. El comando Wait-Job determina si todos los comandos se han completado en un plazo de 30 segundos. Usa el parámetro Timeout con un valor de 30 para establecer el tiempo de espera máximo y, a continuación, almacena los resultados del comando en la variable $done.

En este caso, después de 30 segundos, solo se ha completo el comando del equipo Server02. Wait-Job finaliza la espera, muestra el símbolo del sistema y devuelve el objeto que representa el trabajo completado.

La variable $done contiene un objeto de trabajo que representa el trabajo que se ejecutó en Server02.

Ejemplo 5: Esperar hasta que finalice uno de varios trabajos

PS C:\> Wait-Job -id 1,2,5 -Any

Este comando identifica tres trabajos por sus identificadores y espera hasta que se complete cualquiera de ellos. El símbolo del sistema devuelve cuando finaliza el primer trabajo.

Ejemplo 6: Esperar un período y permitir que el trabajo continúe en segundo plano

PS C:\> Wait-Job -Name "DailyLog" -Timeout 120

Este comando espera 120 segundos (dos minutos) para que finalice el trabajo DailyLog. Si el trabajo no finaliza en los dos minutos siguientes, el símbolo del sistema devuelve de todos modos y el trabajo continúa ejecutándose en segundo plano.

Ejemplo 7: Esperar un trabajo por nombre

PS C:\> Wait-Job -Name "Job3"

Este comando usa el nombre del trabajo para identificar el trabajo para el que se va a esperar.

Ejemplo 8: Esperar trabajos en el equipo local iniciado con Start-Job

PS C:\> $j = Start-Job -ScriptBlock {Get-ChildItem *.ps1| where {$_lastwritetime -gt ((Get-Date) - (New-TimeSpan -Days 7))}}
PS C:\> $j | Wait-Job

En este ejemplo se muestra cómo usar el cmdlet Wait-Job con trabajos iniciados en el equipo local mediante Start-Job.

Estos comandos inician un trabajo que obtiene los archivos de script de Windows PowerShell que se agregaron o actualizaron en la última semana.

El primer comando usa Start-Job para iniciar un trabajo en segundo plano en el equipo local. El trabajo ejecuta un comando Get-ChildItem que obtiene todos los archivos que tienen una extensión de nombre de archivo .ps1 que se agregaron o actualizaron en la semana pasada.

El tercer comando usa Wait-Job para esperar hasta que se complete el trabajo. Cuando finalice el trabajo, el comando muestra el objeto de trabajo, que contiene información sobre el trabajo.

Ejemplo 9: Esperar a que se inicien trabajos en equipos remotos mediante Invoke-Command

PS C:\> $s = New-PSSession Server01, Server02, Server03
PS C:\> $j = Invoke-Command -Session $s -ScriptBlock {Get-Process} -AsJob
PS C:\> $j | Wait-Job

En este ejemplo se muestra cómo usar Wait-Job con trabajos iniciados en equipos remotos mediante el parámetro AsJob de Invoke-Command. Al usar AsJob, el trabajo se crea en el equipo local y los resultados se devuelven automáticamente al equipo local, aunque el trabajo se ejecute en los equipos remotos.

En este ejemplo se usa Wait-Job para determinar si se ha completado un comando Get-Process que se ejecuta en las sesiones de tres equipos remotos.

El primer comando crea objetos PSSession en tres equipos y los almacena en la variable $s.

El segundo comando usa Invoke-Command para ejecutar Get-Process en cada una de las tres sesiones de $s. El comando usa el parámetro AsJob para ejecutar el comando de forma asincrónica como un trabajo en segundo plano. El comando devuelve un objeto de trabajo, al igual que los trabajos iniciados mediante Start-Job y el objeto job se almacena en la variable $j.

El tercer comando usa un operador de canalización (|) para enviar el objeto de trabajo en $j al cmdlet Wait-Job . No se requiere un comando Invoke-Command en este caso, porque el trabajo reside en el equipo local.

Ejemplo 10: Esperar un trabajo que tenga un identificador

PS C:\> Get-Job

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

PS C:\> Wait-Job -Id 1

Este comando espera al trabajo con un valor de identificador 1.

Parámetros

-Any

Indica que este cmdlet muestra el símbolo del sistema y devuelve el objeto de trabajo cuando finaliza cualquier trabajo. De forma predeterminada, Wait-Job espera hasta que se completen todos los trabajos especificados antes de que muestre el símbolo del sistema.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

Especifica una tabla hash de condiciones. Este cmdlet espera a que los trabajos cumplan todas las condiciones de la tabla hash. Especifique una tabla hash donde las claves sean propiedades de una tarea y los valores sean valores de propiedad de la tarea.

Este parámetro solo funciona en tipos de trabajo personalizados, como trabajos de flujo de trabajo y trabajos programados. No funciona en trabajos en segundo plano estándar, como los creados mediante el cmdlet Start-Job . Para información sobre la compatibilidad para este parámetro, vea el tema de ayuda para el tipo de trabajo.

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:	Hashtable
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Force

Indica que este cmdlet sigue esperando trabajos en estado Suspendido o Desconectado. De forma predeterminada, Wait-Job devuelve o finaliza la espera, cuando los trabajos se encuentran en uno de los estados siguientes:

Completed
Con error
Detenido
Suspended
Escenario desconectado

Este parámetro se incorporó en Windows PowerShell 3.0.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Especifica una matriz de identificadores de trabajos para los que este cmdlet espera.

El identificador es un entero que identifica de forma única el trabajo en la sesión actual. Es más fácil recordar y escribir que el identificador de instancia, pero solo es único en la sesión actual. Puede escribir uno o varios identificadores, separados por comas. Para buscar el identificador de un trabajo, escriba Get-Job.

Type:	Int32[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InstanceId

Especifica una matriz de identificadores de instancia de trabajos para los que este cmdlet espera. El valor predeterminado es todas las tareas.

Un identificador de instancia es un GUID que identifica de forma única la tarea en el equipo. Para buscar el identificador de instancia de un trabajo, use Get-Job.

Type:	Guid[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Job

Especifica los trabajos para los que espera este cmdlet. Escriba una variable que contenga los objetos de trabajo o un comando que obtenga los objetos de trabajo. También puede usar un operador de canalización para enviar objetos de trabajo al cmdlet Wait-Job . De forma predeterminada, Wait-Job espera todos los trabajos creados en la sesión actual.

Type:	Job[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Especifica los nombres descriptivos de los trabajos para los que espera este cmdlet.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-State

Especifica un estado de trabajo. Este cmdlet espera solo los trabajos en el estado especificado. Los valores permitidos para este parámetro son los siguientes:

NotStarted
En ejecución
Completed
Con error
Detenido
Bloqueado
Suspended
Escenario desconectado
Suspendiendo
Deteniéndose

Para obtener más información sobre los estados de trabajo, vea JobState (enumeración) en MSDN Library.

Type:	JobState
Accepted values:	NotStarted, Running, Completed, Failed, Stopped, Blocked, Suspended, Disconnected, Suspending, Stopping, AtBreakpoint
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Timeout

Especifica el tiempo de espera máximo para cada trabajo en segundo plano, en segundos. El valor predeterminado, -1, indica que el cmdlet espera hasta que finalice el trabajo. El tiempo se inicia al enviar el comando Wait-Job , no el comando Start-Job .

Si se supera este tiempo, la espera finaliza y se devuelve el símbolo del sistema, aunque todavía se esté ejecutando el trabajo. El comando no muestra ningún mensaje de error.

Type:	Int32
Aliases:	TimeoutSec
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

System.Management.Automation.RemotingJob

Puede canalizar un objeto de trabajo a este cmdlet.

Salidas

System.Management.Automation.PSRemotingJob

Este cmdlet devuelve objetos de trabajo que representan los trabajos completados. Si finaliza la espera porque se supera el valor del parámetro Timeout , Wait-Job no devuelve ningún objeto.

Notas

De forma predeterminada, Wait-Job devuelve o finaliza la espera, cuando los trabajos se encuentran en uno de los estados siguientes:

Completed
Con error
Detenido
Suspended
Desconectado Para dirigir Wait-Job para continuar esperando trabajos suspendidos y desconectados, use el parámetro Force .