Set-XenPoolUpdate

Last published : Nov 12, 2026
Sets fields of a PoolUpdate object.
Related information
PoolUpdate cmdlets

Syntax

Set-XenPoolUpdate [-PoolUpdate] <Pool_update> [-PassThru] [-OtherConfig <hashtable>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenPoolUpdate [-Ref] <XenRef[Pool_update]> [-PassThru] [-OtherConfig <hashtable>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenPoolUpdate [-Uuid] <guid> [-PassThru] [-OtherConfig <hashtable>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenPoolUpdate [-Name] <string> [-PassThru] [-OtherConfig <hashtable>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Changes writable fields of a PoolUpdate. Each optional parameter listed below corresponds to a field that can be set.

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

-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 PoolUpdate to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-OtherConfig

Set the other\_config field of the given pool\_update.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-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

-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

-Uuid

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

Inputs

  • Pool_update
  • XenRef[Pool_update]
  • guid
  • string

Outputs

  • Pool_update
  • void

Examples

Example 1: Set the OtherConfig field

PS> Get-XenPoolUpdate -Name "Demo PoolUpdate" | Set-XenPoolUpdate -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a PoolUpdate.

Example 2: Set the OtherConfig field by name

PS> Set-XenPoolUpdate -OtherConfig @{ "key" = "value" } -Name "Demo PoolUpdate"
Sets the OtherConfig field of a PoolUpdate. -Name matches on name\_label, which is not unique, so every match is operated on.

Example 3: Set the OtherConfig field by uuid

PS> Set-XenPoolUpdate -OtherConfig @{ "key" = "value" } -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Sets the OtherConfig field of a PoolUpdate. -Uuid is the way to be sure of exactly one object.