Remove-Job

El cmdlet Remove-Job elimina los trabajos en segundo plano de PowerShell iniciados por el cmdlet Start-Job o por cmdlets como Invoke-Command que admiten el parámetro AsJob.

Puede usar Remove-Job para eliminar todos los trabajos o eliminar trabajos seleccionados. Los trabajos se identifican mediante su Name, Id., InstanceId, Commando state State. O bien, se puede enviar un objeto de trabajo por la canalización a Remove-Job. Sin parámetros ni valores de parámetros, Remove-Job no tiene ningún efecto.

Desde PowerShell 3.0, Remove-Job puede eliminar tipos de trabajo personalizados, como trabajos programados y trabajos de flujo de trabajo. Por ejemplo, Remove-Job elimina el trabajo programado, todas las instancias del trabajo programado en el disco y los resultados de todas las instancias de trabajo desencadenadas.

Si intenta eliminar un trabajo en ejecución, Remove-Job produce un error. Use el cmdlet Stop-Job para detener un trabajo en ejecución. O bien, use Remove-Job con el parámetro Force para eliminar un trabajo en ejecución.

Los trabajos permanecen en la caché global de trabajos hasta que elimine el trabajo en segundo plano o cierre la sesión de PowerShell.

En este ejemplo se utiliza una variable y la canalización para eliminar una tarea por su nombre.

$batch = Get-Job -Name BatchJob
$batch | Remove-Job

Get-Job usa el parámetro Name para especificar el trabajo, BatchJob. El objeto de trabajo se almacena en la variable $batch. El objeto de $batch se envía por la canalización a Remove-Job.

Una alternativa consiste en usar el parámetro Job, como Remove-Job -Job $batch.

En este ejemplo, se eliminan todos los trabajos de la sesión actual de PowerShell.

Get-Job | Remove-Job

Get-Job obtiene todos los trabajos en la sesión actual de PowerShell. Los objetos de trabajo se envían por la canalización a Remove-Job.

En este ejemplo se eliminan todos los trabajos de la sesión actual de PowerShell que no se han iniciado.

Remove-Job -State NotStarted

Remove-Job usa el parámetro state para especificar el estado del trabajo.

En este ejemplo se eliminan todos los trabajos de la sesión actual con nombres amigables que terminan con lote, incluidos los trabajos que se están ejecutando.

Remove-Job -Name *batch -Force

Remove-Job usa el parámetro Name para especificar un patrón de nombre de trabajo. El patrón incluye el carácter comodín de asterisco (*) para buscar todos los nombres de trabajo que terminan con batch. El parámetro Force elimina los trabajos que están ejecutándose.

En este ejemplo se quita un trabajo que se inició en un equipo remoto mediante Invoke-Command con el parámetro AsJob.

Dado que en el ejemplo se usa el parámetro AsJob, el objeto de trabajo se crea en el equipo local. Pero el trabajo se ejecuta en un equipo remoto. Como resultado, se usan comandos locales para administrar el trabajo.

$job = Invoke-Command -ComputerName Server01 -ScriptBlock {Get-Process} -AsJob
$job | Remove-Job

Invoke-Command ejecuta un trabajo en el equipo Server01. El parámetro AsJob ejecuta el ScriptBlock como un trabajo en segundo plano. El objeto de trabajo se almacena en la variable $job. El objeto de variable $job se envía por la canalización a Remove-Job.

En este ejemplo se muestra cómo eliminar una tarea en un equipo remoto que fue iniciada usando Invoke-Command para ejecutar Start-Job. El objeto de trabajo se crea en el equipo remoto y los comandos remotos se usan para administrar el trabajo. Se requiere una conexión persistente al ejecutar un comando de Start-Job remoto.

$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S -ScriptBlock {Start-Job -ScriptBlock {Get-Process} -Name MyJob}
Invoke-Command -Session $S -ScriptBlock {Remove-Job -Name MyJob}

New-PSSession crea una PSSession, una conexión persistente, al equipo Server01. La conexión se guarda en la variable $S.

Invoke-Command se conecta a la sesión guardada en $S. El ScriptBlock usa Start-Job para iniciar un trabajo remoto. El trabajo ejecuta un comando Get-Process y usa el parámetro Name para especificar un nombre descriptivo para el trabajo, MyJob.

Invoke-Command usa la sesión de $S y ejecuta Remove-Job. El parámetro Name especifica que se elimina el trabajo denominado MyJob.

En este ejemplo se quita un trabajo basado en su InstanceId.

$job = Start-Job -ScriptBlock {Get-Process powershell}
$job | Format-List -Property *
Remove-Job -InstanceId ad02b942-8007-4407-87f3-d23e71955872

State         : Completed
HasMoreData   : True
StatusMessage :
Location      : localhost
Command       : Get-Process powershell
JobStateInfo  : Completed
Finished      : System.Threading.ManualResetEvent
InstanceId    : ad02b942-8007-4407-87f3-d23e71955872
Id            : 3
Name          : Job3
ChildJobs     : {Job4}
PSBeginTime   : 7/26/2019 11:36:56
PSEndTime     : 7/26/2019 11:36:57
PSJobTypeName : BackgroundJob
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
Information   : {}

Start-Job inicia un trabajo en segundo plano y el objeto de trabajo se guarda en la variable $job.

El objeto de $job se envía por la canalización a Format-List. El parámetro Property usa un asterisco (*) para especificar que todas las propiedades del objeto se muestran en una lista.

Remove-Job usa el parámetro InstanceId para especificar el trabajo que se va a eliminar.

Job

Puede canalizar un objeto Job a este cmdlet.

None

Este cmdlet no devuelve ninguna salida.

PowerShell incluye los siguientes alias para Remove-Job:

• Todas las plataformas:
  • rjb

Un trabajo de PowerShell crea un nuevo proceso. Cuando se completa el trabajo, se cierra el proceso. Cuando se ejecuta Remove-Job, el estado del trabajo se elimina.

Si un trabajo se detiene antes de la finalización y su proceso no se ha cerrado, el proceso se termina forzosamente.