Get-XenPoolPatchProperty

Last published : Nov 12, 2026
\[Deprecated\] Gets a property of a PoolPatch object.
Related information
PoolPatch cmdlets

Syntax

Get-XenPoolPatchProperty [-PoolPatch] <Pool_patch>
    -XenProperty {Uuid | NameLabel | NameDescription | Version | Size | PoolApplied | HostPatches | AfterApplyGuidance | PoolUpdate | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenPoolPatchProperty [-Ref] <XenRef[Pool_patch]>
    -XenProperty {Uuid | NameLabel | NameDescription | Version | Size | PoolApplied | HostPatches | AfterApplyGuidance | PoolUpdate | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

DEPRECATED. This class has been deprecated.
Gets a specified property of a PoolPatch object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given pool\_patch.
NameLabel: Get the name/label field of the given pool\_patch.
NameDescription: Get the name/description field of the given pool\_patch.
Version: Get the version field of the given pool\_patch.
Size: Get the size field of the given pool\_patch.
PoolApplied: Get the pool\_applied field of the given pool\_patch.
HostPatches: Get the host\_patches field of the given pool\_patch.
AfterApplyGuidance: Get the after\_apply\_guidance field of the given pool\_patch.
PoolUpdate: Get the pool\_update field of the given pool\_patch.
OtherConfig: Get the other\_config field of the given pool\_patch.

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

-PoolPatch

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

-Ref

The PoolPatch object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Pool_patch]
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 XenPoolPatchProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, Version, Size, PoolApplied, HostPatches, AfterApplyGuidance, PoolUpdate, OtherConfig

Inputs

  • Pool_patch
  • XenRef[Pool_patch]

Outputs

  • System.Object

Examples

Example 1: Get the Version property

PS> Get-XenPoolPatch -Name "Demo PoolPatch" | Get-XenPoolPatchProperty -XenProperty Version
Gets the Version property of a PoolPatch.

Example 2: Get the Size property

PS> Get-XenPoolPatch -Name "Demo PoolPatch" | Get-XenPoolPatchProperty -XenProperty Size
Gets the Size property of a PoolPatch.

Example 3: Get the PoolApplied property

PS> Get-XenPoolPatch -Name "Demo PoolPatch" | Get-XenPoolPatchProperty -XenProperty PoolApplied
Gets the PoolApplied property of a PoolPatch.