Remove-XenVMAppliance

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

Syntax

Remove-XenVMAppliance [-VMAppliance] <VM_appliance> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Remove-XenVMAppliance [-Ref] <XenRef[VM_appliance]> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Remove-XenVMAppliance [-Uuid] <guid> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Remove-XenVMAppliance [-Name] <string> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]

Description

Deletes the specified VMAppliance object.
VMAppliance: VM appliance.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-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 VMAppliance 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 VMAppliance object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VM_appliance]
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

-Uuid

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

-VMAppliance

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

-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

  • VM_appliance
  • XenRef[VM_appliance]
  • guid
  • string

Outputs

  • Task
  • void

Examples

Example 1: Delete a VMAppliance piped from the getter

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

Example 2: Delete a VMAppliance by name

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

Example 3: See what would be deleted

PS> Get-XenVMAppliance -Name "Demo VMAppliance" | Remove-XenVMAppliance -WhatIf
Reports the VMAppliance that would be deleted without deleting anything. Every cmdlet that changes the server takes -WhatIf and -Confirm.