Remove-XenTask

Last published : Nov 12, 2026
Deletes a Task object.
Related information
Task cmdlets

Syntax

Remove-XenTask [-Task] <Task> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenTask [-Ref] <XenRef[Task]> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenTask [-Uuid] <guid> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenTask [-Name] <string> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Deletes the specified Task object.
task.destroy: Destroy the task object.
Task: A long-running asynchronous task.

Parameters

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-Name

The name of the Task to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Ref

The Task object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Task]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Task

The Task object to operate on.
Attribute Value
Type Task
Required True
Position 0
Accepts pipeline input True (ByValue)

-Uuid

The UUID of the Task to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

Inputs

  • Task
  • XenRef[Task]
  • guid
  • string

Outputs

  • void

Examples

Example 1: Delete a Task piped from the getter

PS> Get-XenTask -Name "Demo Task" | Remove-XenTask
Deletes a Task. The object is piped in, which is the usual way once you already have it.

Example 2: Delete a Task by name

PS> Remove-XenTask -Name "Demo Task"
Deletes a Task. -Name matches on name\_label, which is not unique, so every match is operated on.

Example 3: See what would be deleted

PS> Get-XenTask -Name "Demo Task" | Remove-XenTask -WhatIf
Reports the Task that would be deleted without deleting anything. Every cmdlet that changes the server takes -WhatIf and -Confirm.
  • Task cmdlets
  • Class: Task
  • Using the XenServer PowerShell module