Invoke-XenPoolPatch

Last published : Nov 12, 2026
\[Deprecated\] Invokes an operation on a PoolPatch object.
Related information
PoolPatch cmdlets

Syntax

Invoke-XenPoolPatch [-PoolPatch] <Pool_patch>
    -XenAction {Apply | PoolApply | Precheck | Clean | PoolClean | CleanOnHost}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPoolPatch [-Ref] <XenRef[Pool_patch]>
    -XenAction {Apply | PoolApply | Precheck | Clean | PoolClean | CleanOnHost}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPoolPatch [-Uuid] <guid>
    -XenAction {Apply | PoolApply | Precheck | Clean | PoolClean | CleanOnHost}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPoolPatch [-Name] <string>
    -XenAction {Apply | PoolApply | Precheck | Clean | PoolClean | CleanOnHost}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]

Description

DEPRECATED. This class has been deprecated.
Invokes an operation on a PoolPatch object. Use the -XenAction parameter to select which operation to perform.
Apply: Apply the selected patch to a host and return its output. (Deprecated.)
PoolApply: Apply the selected patch to all hosts in the pool and return a map of host\_ref -> patch output. (Deprecated.)
Precheck: Execute the precheck stage of the selected patch on a host and return its output. (Deprecated.)
Clean: Removes the patch's files from the server. (Deprecated.)
PoolClean: Removes the patch's files from all hosts in the pool, but does not remove the database entries. (Deprecated.)
CleanOnHost: Removes the patch's files from the specified host. (Deprecated.)

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
Attribute Value
Type SwitchParameter
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

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-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

-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

-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

-Uuid

The UUID of the PoolPatch 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

-XenAction

Selects which action to use.
Attribute Value
Type XenPoolPatchAction
Required True
Position Named
Accepts pipeline input False
Accepted values Apply, PoolApply, Precheck, Clean, PoolClean, CleanOnHost

-XenHost

The host to apply the patch too. Accepted when -XenAction is Apply, Precheck, CleanOnHost.
Attribute Value
Type XenRef[Host]
Required False
Position Named
Accepts pipeline input False

Inputs

  • Pool_patch
  • XenRef[Pool_patch]
  • guid
  • string

Outputs

  • System.Object

Examples

Example 1: Run the Apply operation

PS> Get-XenPoolPatch -Name "Demo PoolPatch" | Invoke-XenPoolPatch -XenAction Apply -PassThru
Invokes the Apply operation on a PoolPatch. -PassThru writes the result to the pipeline.

Example 2: Run the Apply operation by name

PS> Invoke-XenPoolPatch -XenAction Apply -Name "Demo PoolPatch" -PassThru
Invokes the Apply operation on a PoolPatch. -Name matches on name\_label, which is not unique, so every match is operated on. -PassThru writes the result to the pipeline.

Example 3: Run Apply asynchronously

PS> Invoke-XenPoolPatch -Name "Demo PoolPatch" -XenAction Apply -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.