Get-XenObserverProperty

Last published : Nov 12, 2026
Gets a property of an Observer object.
Related information
Observer cmdlets

Syntax

Get-XenObserverProperty [-Observer] <Observer>
    -XenProperty {Uuid | NameLabel | NameDescription | Hosts | Attributes | Endpoints | Components | Enabled}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenObserverProperty [-Ref] <XenRef[Observer]>
    -XenProperty {Uuid | NameLabel | NameDescription | Hosts | Attributes | Endpoints | Components | Enabled}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of an Observer object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given Observer.
NameLabel: Get the name/label field of the given Observer.
NameDescription: Get the name/description field of the given Observer.
Hosts: Get the hosts field of the given Observer.
Attributes: Get the attributes field of the given Observer.
Endpoints: Get the endpoints field of the given Observer.
Components: Get the components field of the given Observer.
Enabled: Get the enabled field of the given Observer.

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

-Observer

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

-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

-XenProperty

Selects which property to use.
Attribute Value
Type XenObserverProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, Hosts, Attributes, Endpoints, Components, Enabled

Inputs

  • Observer
  • XenRef[Observer]

Outputs

  • System.Object

Examples

Example 1: Get the Hosts property

PS> Get-XenObserver -Name "Demo Observer" | Get-XenObserverProperty -XenProperty Hosts
Gets the Hosts property of an Observer.

Example 2: Get the Attributes property

PS> Get-XenObserver -Name "Demo Observer" | Get-XenObserverProperty -XenProperty Attributes
Gets the Attributes property of an Observer.

Example 3: Get the Endpoints property

PS> Get-XenObserver -Name "Demo Observer" | Get-XenObserverProperty -XenProperty Endpoints
Gets the Endpoints property of an Observer.