Remove-XenPoolProperty

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

Syntax

Remove-XenPoolProperty [-Pool] <Pool> [-PassThru] [-OtherConfig <string>] [-Tags <string>]
    [-GuiConfig <string>] [-HealthCheckConfig <string>] [-LicenseServer <string>]
    [-GuestAgentConfig <string>] [-Repository <XenRef[Repository]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenPoolProperty [-Ref] <XenRef[Pool]> [-PassThru] [-OtherConfig <string>]
    [-Tags <string>] [-GuiConfig <string>] [-HealthCheckConfig <string>]
    [-LicenseServer <string>] [-GuestAgentConfig <string>]
    [-Repository <XenRef[Repository]>] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenPoolProperty [-Uuid] <guid> [-PassThru] [-OtherConfig <string>] [-Tags <string>]
    [-GuiConfig <string>] [-HealthCheckConfig <string>] [-LicenseServer <string>]
    [-GuestAgentConfig <string>] [-Repository <XenRef[Repository]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Removes values from the collection-valued fields of a Pool. Each optional parameter listed below corresponds to a field that can be removed from.

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

-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

-GuestAgentConfig

Remove a key-value pair from the pool-wide guest agent configuration
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-GuiConfig

Remove the given key and its corresponding value from the gui\_config field of the given pool. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-HealthCheckConfig

Remove the given key and its corresponding value from the health\_check\_config field of the given pool. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-LicenseServer

Remove the given key and its corresponding value from the license\_server field of the given pool. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-OtherConfig

Remove the given key and its corresponding value from the other\_config field of the given pool. If the key is not in that Map, then do nothing.
Attribute Value
Type string
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

-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

-Repository

Remove a repository from the enabled set
Attribute Value
Type 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

-Tags

Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing.
Attribute Value
Type string
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)

-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
  • XenRef[Pool]
  • guid

Outputs

  • Pool
  • Task

Examples

Example 1: Remove from the OtherConfig field

PS> Remove-XenPoolProperty -OtherConfig "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the OtherConfig field of a Pool.

Example 2: Remove from the Tags field

PS> Remove-XenPoolProperty -Tags "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the Tags field of a Pool.

Example 3: Remove from the GuiConfig field

PS> Remove-XenPoolProperty -GuiConfig "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Removes a value from the GuiConfig field of a Pool.
  • Pool cmdlets
  • Class: Pool
  • Using the XenServer PowerShell module