Get-XenPoolUpdateProperty

Last published : Nov 12, 2026
Gets a property of a PoolUpdate object.

Syntax

Get-XenPoolUpdateProperty [-PoolUpdate] <Pool_update>
    -XenProperty {Uuid | NameLabel | NameDescription | Version | InstallationSize | Key | AfterApplyGuidance | Vdi | Hosts | OtherConfig | EnforceHomogeneity}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenPoolUpdateProperty [-Ref] <XenRef[Pool_update]>
    -XenProperty {Uuid | NameLabel | NameDescription | Version | InstallationSize | Key | AfterApplyGuidance | Vdi | Hosts | OtherConfig | EnforceHomogeneity}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a PoolUpdate object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given pool\_update.
NameLabel: Get the name/label field of the given pool\_update.
NameDescription: Get the name/description field of the given pool\_update.
Version: Get the version field of the given pool\_update.
InstallationSize: Get the installation\_size field of the given pool\_update.
Key: Get the key field of the given pool\_update.
AfterApplyGuidance: Get the after\_apply\_guidance field of the given pool\_update.
Vdi: Get the vdi field of the given pool\_update.
Hosts: Get the hosts field of the given pool\_update.
OtherConfig: Get the other\_config field of the given pool\_update.
EnforceHomogeneity: Get the enforce\_homogeneity field of the given pool\_update.

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

-PoolUpdate

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

-Ref

The PoolUpdate object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Pool_update]
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 XenPoolUpdateProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, Version, InstallationSize, Key, AfterApplyGuidance, Vdi, Hosts, OtherConfig, EnforceHomogeneity

Inputs

  • Pool_update
  • XenRef[Pool_update]

Outputs

  • System.Object

Examples

Example 1: Get the Version property

PS> Get-XenPoolUpdate -Name "Demo PoolUpdate" | Get-XenPoolUpdateProperty -XenProperty Version
Gets the Version property of a PoolUpdate.

Example 2: Get the InstallationSize property

PS> Get-XenPoolUpdate -Name "Demo PoolUpdate" | Get-XenPoolUpdateProperty -XenProperty InstallationSize
Gets the InstallationSize property of a PoolUpdate.

Example 3: Get the Key property

PS> Get-XenPoolUpdate -Name "Demo PoolUpdate" | Get-XenPoolUpdateProperty -XenProperty Key
Gets the Key property of a PoolUpdate.