Remove-Job

Syntax

Remove-Job
      [-Force]
      [-Id] <Int32[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-Job
      [-Job] <Job[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-Job
      [-Force]
      [-InstanceId] <Guid[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-Job
      [-Force]
      [-Name] <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-Job
      [-Force]
      [-Filter] <Hashtable>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-Job
      [-State] <JobState>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-Job
      [-Command <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-Job cmdlet deletes Windows PowerShell background jobs. You can start jobs by using the Start-Job or the AsJob parameter of any cmdlet.

You can use this cmdlet to delete all jobs or delete jobs based on their name, ID, instance ID, command, or state, or by passing a job object to Remove-Job . Without parameters or parameter values, Remove-Job has no effect.

Starting in Windows PowerShell 3.0, you can use the Remove-Job cmdlet to delete custom job types, such as scheduled jobs and workflow jobs. If you use Remove-Job to delete a scheduled job, it deletes the scheduled job and deletes all instances of the scheduled job on disk. This includes the results of all triggered job instances.

Before deleting a running job, use the Stop-Job cmdlet to stop the job. If you try to delete a running job, the command fails. You can use the Force parameter of Remove-Job to delete a running job.

If you do not delete a background job, the job remains in the global job cache until you close the session in which the job was created.

Examples

Example 1: Delete a job by using its name

PS C:\> $batch = Get-Job -Name "BatchJob"

PS C:\> $batch | Remove-Job

This example deletes a background job named BatchJob from the current session. The first command uses the Get-Job cmdlet to get an object that represents the job, and then it saves the job in the $batch variable.

The second command uses a pipeline operator (|) to send the job to the Remove-Job cmdlet.

This command is equivalent to using the Job parameter of Remove-Job , for example, Remove-Job -Job $batch .

Example 2: Delete all jobs in a session

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

This command deletes all of the jobs in the current session.

Example 3: Delete NotStarted jobs

PS C:\> Remove-Job -State NotStarted

This command deletes all jobs from the current session that have not yet been started.

Example 4: Delete jobs by using a friendly name

PS C:\> Remove-Job -Name *batch -Force

This command deletes all jobs that have friendly names that end with batch from the current session. These include jobs that are running.

The command uses the Name parameter of Remove-Job to specify a job name pattern, and it uses the Force parameter to make sure that all jobs are removed, even those that might be in progress.

Example 5: Delete a job that was created by Invoke-Command

PS C:\> $j = Invoke-Command -ComputerName Server01 -ScriptBlock {Get-Process} -AsJob

PS C:\> $j | Remove-Job

This example shows how to use the Remove-Job cmdlet to remove a job that was started on a remote computer by using the AsJob parameter of the Invoke-Command cmdlet.

The first command uses the Invoke-Command cmdlet to run a job on the Server01 computer. It uses the AsJob parameter to run the command as a background job, and it saves the resulting job object in the $j variable.

Because the command used the AsJob parameter, the job object is created on the local computer, even though the job runs on a remote computer. As a result, you use local commands to manage the job.

The second command uses the Remove-Job cmdlet to remove the job. It uses a pipeline operator (|) to send the job in $j to Remove-Job . This is a local command. A remote command is not required to remove a job that was started by using the AsJob parameter.

Example 6: Delete a job that was created by Invoke-Command and Start-Job

The first command uses the New-PSSession cmdlet to create a **PSSession**, which is a persistent connection, to the Server01 computer. A persistent connection is required when you run **Start-Job** remotely. The command stores the **PSSession** in the $s variable.

PS C:\> $s = New-PSSession -ComputerName Server01



The second command uses the **Invoke-Command** cmdlet to run a **Start-Job** command in the **PSSession** in $s. The job runs a **Get-Process** command. It uses the *Name* parameter of **Start-Job** to specify a friendly name for the job.

PS C:\> Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {Get-Process} -Name MyJob}



The third command uses the **Invoke-Command** cmdlet to run a **Remove-Job** command in the **PSSession** in $s. The command uses the *Name* parameter to identify the job to delete.

PS C:\> Invoke-Command -Session $s -ScriptBlock {Remove-Job -Name MyJob}

This example shows how to remove a job that was started by using Invoke-Command to run a Start-Job command. In this case, the job object is created on the remote computer and you use remote commands to manage the job.

Example 7: Delete a job by using its instance ID

The first command uses **Start-Job** to start a background job. The command saves the resulting job object in the $j variable.

PS C:\> $j = Start-Job -ScriptBlock {Get-Process Powershell}



The second command uses a pipeline operator (|) to send the job object in $j to the Format-List cmdlet. The **Format-List** command uses the *Property* parameter with a value of * (all) to display all of the properties of the job object in a list.The job object display shows the values of the **ID** and **InstanceID** properties, together with the other properties of the object.

PS C:\> $j | Format-List -Property *



HasMoreData   : False

StatusMessage :

Location      : localhost

Command       : get-process powershell

JobStateInfo  : Failed

Finished      : System.Threading.ManualResetEvent

InstanceId    : dce2ee73-f8c9-483e-bdd7-a549d8687eed

Id            : 1

Name          : Job1

ChildJobs     : {Job2}

Output        : {}

Error         : {}

Progress      : {}

Verbose       : {}

Debug         : {}

Warning       : {}

StateChanged  :



The third command uses a **Remove-Job** command to remove the job from the current session. To generate the command, you can copy and paste the *InstanceID* value from the object display.To copy a value in the Windows PowerShell console, use the mouse to select the value, and then press Enter to copy it. To paste a value, right-click.

PS C:\> Remove-Job -InstanceID dce2ee73-f8c9-483e-bdd7-a549d8687eed

This example shows how to remove a job based on its instance ID.

Required Parameters

Optional Parameters

Inputs

System.Management.Automation.Job

You can pipe a job object to this cmdlet.

Outputs

None

This cmdlet does not generate any output.

Related Links

• Get-Job
• Invoke-Command
• Receive-Job
• Resume-Job
• Start-Job
• Stop-Job
• Suspend-Job
• Wait-Job