Set-XenBond

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

Syntax

Set-XenBond [-Bond] <Bond> [-PassThru] [-OtherConfig <hashtable>]
    [-Mode {balance_slb | active_backup | lacp | unknown}] [-Property <string[]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenBond [-Ref] <XenRef[Bond]> [-PassThru] [-OtherConfig <hashtable>]
    [-Mode {balance_slb | active_backup | lacp | unknown}] [-Property <string[]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenBond [-Uuid] <guid> [-PassThru] [-OtherConfig <hashtable>]
    [-Mode {balance_slb | active_backup | lacp | unknown}] [-Property <string[]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Changes writable fields of a Bond. 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

-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

-Bond

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

-Confirm

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

-Mode

Change the bond mode
Attribute Value
Type bond_mode
Required False
Position Named
Accepts pipeline input False
Accepted values balance_slb, active_backup, lacp, unknown

-OtherConfig

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

-Property

Set the value of a property of the bond
Attribute Value
Type string[]
Required False
Position Named
Accepts pipeline input False

-Ref

The Bond object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Bond]
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 Bond 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

  • Bond
  • XenRef[Bond]
  • guid

Outputs

  • Bond
  • Task
  • void

Examples

Example 1: Set the OtherConfig field

PS> Get-XenBond -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenBond -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a Bond.

Example 2: Set a mode

PS> Get-XenBond -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenBond -Mode balance_slb
Change the bond mode

Example 3: Set a property

PS> Get-XenBond -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenBond -Property "tag1"
Set the value of a property of the bond
  • Bond cmdlets
  • Class: Bond
  • Using the XenServer PowerShell module