Get-XenBondProperty

Last published : Nov 12, 2026
Gets a property of a Bond object.
Related information
Bond cmdlets

Syntax

Get-XenBondProperty [-Bond] <Bond>
    -XenProperty {Uuid | Master | Slaves | OtherConfig | PrimarySlave | Mode | Properties | LinksUp | AutoUpdateMac}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenBondProperty [-Ref] <XenRef[Bond]>
    -XenProperty {Uuid | Master | Slaves | OtherConfig | PrimarySlave | Mode | Properties | LinksUp | AutoUpdateMac}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a Bond object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given Bond.
Master: Get the master field of the given Bond.
Slaves: Get the slaves field of the given Bond.
OtherConfig: Get the other\_config field of the given Bond.
PrimarySlave: Get the primary\_slave field of the given Bond.
Mode: Get the mode field of the given Bond.
Properties: Get the properties field of the given Bond.
LinksUp: Get the links\_up field of the given Bond.
AutoUpdateMac: Get the auto\_update\_mac field of the given Bond.

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

-Bond

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

-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

-XenProperty

Selects which property to use.
Attribute Value
Type XenBondProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, Master, Slaves, OtherConfig, PrimarySlave, Mode, Properties, LinksUp, AutoUpdateMac

Inputs

  • Bond
  • XenRef[Bond]

Outputs

  • System.Object

Examples

Example 1: Get the Master property

PS> Get-XenBond -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenBondProperty -XenProperty Master
Gets the Master property of a Bond.

Example 2: Get the Slaves property

PS> Get-XenBond -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenBondProperty -XenProperty Slaves
Gets the Slaves property of a Bond.

Example 3: Get the OtherConfig property

PS> Get-XenBond -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenBondProperty -XenProperty OtherConfig
Gets the OtherConfig property of a Bond.
  • Bond cmdlets
  • Class: Bond
  • Using the XenServer PowerShell module