Remove-XenObserver

Last published : Nov 12, 2026
Deletes an Observer object.
Related information
Observer cmdlets

Syntax

Remove-XenObserver [-Observer] <Observer> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Remove-XenObserver [-Ref] <XenRef[Observer]> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Remove-XenObserver [-Uuid] <guid> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Remove-XenObserver [-Name] <string> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]

Description

Deletes the specified Observer object.
Observer: Describes an observer which will control observability activity in the Toolstack.

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 Observer to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-Observer

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

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

  • Observer
  • XenRef[Observer]
  • guid
  • string

Outputs

  • Task
  • void

Examples

Example 1: Delete an Observer piped from the getter

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

Example 2: Delete an Observer by name

PS> Remove-XenObserver -Name "Demo Observer"
Deletes an Observer. -Name matches on name\_label, which is not unique, so every match is operated on.

Example 3: See what would be deleted

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