Set-XenPool

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

Syntax

Set-XenPool [-Pool] <Pool> [-PassThru] [-NameLabel <string>] [-NameDescription <string>]
    [-DefaultSR <XenRef[SR]>] [-SuspendImageSR <XenRef[SR]>] [-CrashDumpSR <XenRef[SR]>]
    [-OtherConfig <hashtable>] [-HaAllowOvercommit <bool>] [-Tags <string[]>]
    [-GuiConfig <hashtable>] [-HealthCheckConfig <hashtable>] [-WlbEnabled <bool>]
    [-WlbVerifyCert <bool>] [-PolicyNoVendorDevice <bool>] [-LivePatchingDisabled <bool>]
    [-IsPsrPending <bool>] [-MigrationCompression <bool>] [-CoordinatorBias <bool>]
    [-LicenseServer <hashtable>] [-HaRebootVmOnInternalShutdown <bool>]
    [-LimitConsoleSessions <bool>] [-VmConsoleIdleTimeout <long>]
    [-AutoUpdateVmSecurebootCertificates <bool>]
    [-LldpMulticastAddress {nearestbridge | nearestnontpmrbridge | nearestcustomerbridge | unknown}]
    [-HaHostFailuresToTolerate <long>] [-VswitchController <string>]
    [-IgmpSnoopingEnabled <bool>] [-LldpEnabled <bool[]>]
    [-Repositories <List[XenRef[Repository]]>] [-UefiCertificates <string>]
    [-CustomUefiCertificates <string>] [-HttpsOnly <bool>]
    [-TelemetryNextCollection <DateTime>] [-UpdateSyncEnabled <bool>]
    [-LocalAuthMaxThreads <long>] [-ExtAuthMaxThreads <long>]
    [-ExtAuthCacheEnabled <bool>] [-ExtAuthCacheSize <long>] [-ExtAuthCacheExpiry <long>]
    [-SshEnabledTimeout <long>] [-ConsoleIdleTimeout <long>] [-SshAutoMode <bool>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenPool [-Ref] <XenRef[Pool]> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-DefaultSR <XenRef[SR]>] [-SuspendImageSR <XenRef[SR]>]
    [-CrashDumpSR <XenRef[SR]>] [-OtherConfig <hashtable>] [-HaAllowOvercommit <bool>]
    [-Tags <string[]>] [-GuiConfig <hashtable>] [-HealthCheckConfig <hashtable>]
    [-WlbEnabled <bool>] [-WlbVerifyCert <bool>] [-PolicyNoVendorDevice <bool>]
    [-LivePatchingDisabled <bool>] [-IsPsrPending <bool>] [-MigrationCompression <bool>]
    [-CoordinatorBias <bool>] [-LicenseServer <hashtable>]
    [-HaRebootVmOnInternalShutdown <bool>] [-LimitConsoleSessions <bool>]
    [-VmConsoleIdleTimeout <long>] [-AutoUpdateVmSecurebootCertificates <bool>]
    [-LldpMulticastAddress {nearestbridge | nearestnontpmrbridge | nearestcustomerbridge | unknown}]
    [-HaHostFailuresToTolerate <long>] [-VswitchController <string>]
    [-IgmpSnoopingEnabled <bool>] [-LldpEnabled <bool[]>]
    [-Repositories <List[XenRef[Repository]]>] [-UefiCertificates <string>]
    [-CustomUefiCertificates <string>] [-HttpsOnly <bool>]
    [-TelemetryNextCollection <DateTime>] [-UpdateSyncEnabled <bool>]
    [-LocalAuthMaxThreads <long>] [-ExtAuthMaxThreads <long>]
    [-ExtAuthCacheEnabled <bool>] [-ExtAuthCacheSize <long>] [-ExtAuthCacheExpiry <long>]
    [-SshEnabledTimeout <long>] [-ConsoleIdleTimeout <long>] [-SshAutoMode <bool>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenPool [-Uuid] <guid> [-PassThru] [-NameLabel <string>] [-NameDescription <string>]
    [-DefaultSR <XenRef[SR]>] [-SuspendImageSR <XenRef[SR]>] [-CrashDumpSR <XenRef[SR]>]
    [-OtherConfig <hashtable>] [-HaAllowOvercommit <bool>] [-Tags <string[]>]
    [-GuiConfig <hashtable>] [-HealthCheckConfig <hashtable>] [-WlbEnabled <bool>]
    [-WlbVerifyCert <bool>] [-PolicyNoVendorDevice <bool>] [-LivePatchingDisabled <bool>]
    [-IsPsrPending <bool>] [-MigrationCompression <bool>] [-CoordinatorBias <bool>]
    [-LicenseServer <hashtable>] [-HaRebootVmOnInternalShutdown <bool>]
    [-LimitConsoleSessions <bool>] [-VmConsoleIdleTimeout <long>]
    [-AutoUpdateVmSecurebootCertificates <bool>]
    [-LldpMulticastAddress {nearestbridge | nearestnontpmrbridge | nearestcustomerbridge | unknown}]
    [-HaHostFailuresToTolerate <long>] [-VswitchController <string>]
    [-IgmpSnoopingEnabled <bool>] [-LldpEnabled <bool[]>]
    [-Repositories <List[XenRef[Repository]]>] [-UefiCertificates <string>]
    [-CustomUefiCertificates <string>] [-HttpsOnly <bool>]
    [-TelemetryNextCollection <DateTime>] [-UpdateSyncEnabled <bool>]
    [-LocalAuthMaxThreads <long>] [-ExtAuthMaxThreads <long>]
    [-ExtAuthCacheEnabled <bool>] [-ExtAuthCacheSize <long>] [-ExtAuthCacheExpiry <long>]
    [-SshEnabledTimeout <long>] [-ConsoleIdleTimeout <long>] [-SshAutoMode <bool>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

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

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress. Available only for those fields whose underlying operation supports asynchronous invocation.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-AutoUpdateVmSecurebootCertificates

Set the auto\_update\_vm\_secureboot\_certificates field of the given pool.
Attribute Value
Type bool
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

-ConsoleIdleTimeout

Set the console idle timeout for all hosts in the pool
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-CoordinatorBias

Set the coordinator\_bias field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-CrashDumpSR

Set the crash\_dump\_SR field of the given pool.
Attribute Value
Type XenRef[SR]
Required False
Position Named
Accepts pipeline input False

-CustomUefiCertificates

Set custom UEFI certificates for a pool and all its hosts. Need \`allow-custom-uefi-certs\` set to true in conf. If empty: default back to Pool.uefi\_certificates
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-DefaultSR

Set the default\_SR field of the given pool.
Attribute Value
Type XenRef[SR]
Required False
Position Named
Accepts pipeline input False

-ExtAuthCacheEnabled

This parameter has no documentation.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-ExtAuthCacheExpiry

This parameter has no documentation.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-ExtAuthCacheSize

This parameter has no documentation.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-ExtAuthMaxThreads

This parameter has no documentation.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-GuiConfig

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

-HaAllowOvercommit

Set the ha\_allow\_overcommit field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-HaHostFailuresToTolerate

Set the maximum number of host failures to consider in the HA VM restart planner
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-HaRebootVmOnInternalShutdown

Set the ha\_reboot\_vm\_on\_internal\_shutdown field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-HealthCheckConfig

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

-HttpsOnly

updates all the host firewalls in the pool to open or close port 80 depending on the value
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-IgmpSnoopingEnabled

Enable or disable IGMP Snooping on the pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-IsPsrPending

Set the is\_psr\_pending field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-LicenseServer

Set the license\_server field of the given pool.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-LimitConsoleSessions

Set the limit\_console\_sessions field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-LivePatchingDisabled

Set the live\_patching\_disabled field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-LldpEnabled

Enable or disable LLDP on the NIC of every managed physical PIF in the pool, then apply the change by re-plugging the affected PIFs.
Attribute Value
Type bool[]
Required False
Position Named
Accepts pipeline input False

-LldpMulticastAddress

Set the lldp\_multicast\_address field of the given pool.
Attribute Value
Type lldp_multicast_address
Required False
Position Named
Accepts pipeline input False
Accepted values nearestbridge, nearestnontpmrbridge, nearestcustomerbridge, unknown

-LocalAuthMaxThreads

This parameter has no documentation.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-MigrationCompression

Set the migration\_compression field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-NameDescription

Set the name\_description field of the given pool.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

Set the name\_label field of the given pool.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-OtherConfig

Set the other\_config field of the given pool.
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

-PolicyNoVendorDevice

Set the policy\_no\_vendor\_device field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-Pool

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

-Ref

The Pool object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Pool]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-Repositories

Set enabled set of repositories
Attribute Value
Type List[XenRef[Repository]]
Required False
Position Named
Accepts pipeline input False

-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

-SshAutoMode

Set the SSH auto mode for all hosts in the pool
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-SshEnabledTimeout

Set the SSH enabled timeout for all hosts in the pool
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-SuspendImageSR

Set the suspend\_image\_SR field of the given pool.
Attribute Value
Type XenRef[SR]
Required False
Position Named
Accepts pipeline input False

-Tags

Set the tags field of the given pool.
Attribute Value
Type string[]
Required False
Position Named
Accepts pipeline input False

-TelemetryNextCollection

Set the timestamp for the next telemetry data collection.
Attribute Value
Type DateTime
Required False
Position Named
Accepts pipeline input False

-UefiCertificates

Set the UEFI certificates for a pool and all its hosts. Deprecated: use set\_custom\_uefi\_certificates instead
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-UpdateSyncEnabled

enable or disable periodic update synchronization depending on the value
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-Uuid

The UUID of the Pool to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-VmConsoleIdleTimeout

Set the vm\_console\_idle\_timeout field of the given pool.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-VswitchController

Set the IP address of the vswitch controller.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-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

-WlbEnabled

Set the wlb\_enabled field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-WlbVerifyCert

Set the wlb\_verify\_cert field of the given pool.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

Inputs

  • Pool
  • XenRef[Pool]
  • guid

Outputs

  • Pool
  • Task
  • void

Examples

Example 1: Set the NameLabel field

PS> Get-XenPool -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenPool -NameLabel "new value"
Sets the NameLabel field of a Pool.

Example 2: Set the NameDescription field

PS> Get-XenPool -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenPool -NameDescription "new value"
Sets the NameDescription field of a Pool.

Example 3: Set the DefaultSR field

PS> $sr = Get-XenSR | Select-Object -First 1
PS> Get-XenPool -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenPool -DefaultSR $sr
Sets the DefaultSR field of a Pool.
  • Pool cmdlets
  • Class: Pool
  • Using the XenServer PowerShell module