Get-XenPoolPatch

Last published : Nov 12, 2026
\[Deprecated\] Gets the PoolPatch objects in the pool.

Syntax

Get-XenPoolPatch [[-Ref] <XenRef[Pool_patch]>] [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]
Get-XenPoolPatch [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]
Get-XenPoolPatch [-Name] <string> [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]

Description

DEPRECATED. This class has been deprecated.
Retrieves the PoolPatch objects in the pool. With no parameters the cmdlet returns the whole collection; use -Name, -Uuid or -Ref to select one.
PoolPatch: Pool-wide patches.

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

-Name

The name of the PoolPatch to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-Ref

The PoolPatch object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Pool_patch]
Required False
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 PoolPatch to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

Inputs

  • XenRef[Pool_patch]
  • guid
  • string

Outputs

  • Pool_patch[]

Examples

Example 1: List every PoolPatch

PS> Get-XenPoolPatch
Retrieves every PoolPatch object in the pool. With no parameters the cmdlet fetches the whole collection.

Example 2: Retrieve one PoolPatch by name

PS> Get-XenPoolPatch -Name "Demo PoolPatch"
Retrieves a single PoolPatch. -Name matches on name\_label, which is not unique, so every match is operated on.

Example 3: Retrieve one PoolPatch by uuid

PS> Get-XenPoolPatch -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single PoolPatch. -Uuid is the way to be sure of exactly one object.