Set-XenObserver

Last published : Nov 12, 2026
Sets fields of an Observer object.
Related information
Observer cmdlets

Syntax

Set-XenObserver [-Observer] <Observer> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-Hosts <List[XenRef[Host]]>] [-Enabled <bool>]
    [-Attributes <hashtable>] [-Endpoints <string[]>] [-Components <string[]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenObserver [-Ref] <XenRef[Observer]> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-Hosts <List[XenRef[Host]]>] [-Enabled <bool>]
    [-Attributes <hashtable>] [-Endpoints <string[]>] [-Components <string[]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenObserver [-Uuid] <guid> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-Hosts <List[XenRef[Host]]>] [-Enabled <bool>]
    [-Attributes <hashtable>] [-Endpoints <string[]>] [-Components <string[]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenObserver [-Name] <string> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-Hosts <List[XenRef[Host]]>] [-Enabled <bool>]
    [-Attributes <hashtable>] [-Endpoints <string[]>] [-Components <string[]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Changes writable fields of an Observer. Each optional parameter listed below corresponds to a field that can be set.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress. Available only for those fields whose underlying operation supports asynchronous invocation.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Attributes

Set the attributes of an observer. These are used to emit metadata by the observer
Attribute Value
Type hashtable
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

-Components

Set the components on which the observer will broadcast to. i.e. xapi, xenopsd, networkd, etc.
Attribute Value
Type string[]
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

-Enabled

Enable / disable this observer which will stop the observer from producing observability information
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-Endpoints

Set the file/HTTP endpoints the observer sends data to
Attribute Value
Type string[]
Required False
Position Named
Accepts pipeline input False

-Hosts

Sets the hosts that the observer is to be registered on
Attribute Value
Type List[XenRef[Host]]
Required False
Position Named
Accepts pipeline input False

-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

-NameDescription

Set the name/description field of the given Observer.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

Set the name/label field of the given Observer.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-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

  • Observer
  • Task
  • void

Examples

Example 1: Set the NameLabel field

PS> Get-XenObserver -Name "Demo Observer" | Set-XenObserver -NameLabel "new value"
Sets the NameLabel field of an Observer.

Example 2: Set the NameDescription field

PS> Get-XenObserver -Name "Demo Observer" | Set-XenObserver -NameDescription "new value"
Sets the NameDescription field of an Observer.

Example 3: Set a hosts

PS> Get-XenObserver -Name "Demo Observer" | Set-XenObserver -Hosts $value
Sets the hosts that the observer is to be registered on