Xapi Project Docs

Class: Bond

A Network bond that combines physical network interfaces, also known as link aggregation

Published in:

XenServer 4.1 (miami)

A Network bond that combines physical network interfaces, also known as link aggregation

Enums

bond_mode

Values:	balance-slb	Source-level balancing
	active-backup	Active/passive bonding: only one NIC is carrying traffic
	lacp	Link aggregation control protocol

Fields

bool auto_update_mac [RO/runtime]

true if the MAC was taken from the primary slave when the bond was created, and false if the client specified the MAC

Default value:	true
Published in:	Citrix Hypervisor 8.1 (quebec)

int links_up [RO/runtime]

Number of links up in this bond

Default value:	0
Published in:	XenServer 6.1 (tampa)	Number of links up in this bond

PIF ref master [RO/constructor]

The bonded interface

Default value:	Null
Published in:	XenServer 4.1 (miami)	The bonded interface

enum bond_mode mode [RO/runtime]

The algorithm used to distribute traffic among the bonded NICs

Default value:	balance-slb
Published in:	XenServer 6.0 (boston)

(string → string) map other_config [RW]

additional configuration

Default value:	{}
Published in:	XenServer 4.1 (miami)	additional configuration

PIF ref primary_slave [RO/runtime]

The PIF of which the IP configuration and MAC were copied to the bond, and which will receive all configuration/VLANs/VIFs on the bond if the bond is destroyed

Default value:	OpaqueRef:NULL
Published in:	XenServer 6.0 (boston)

(string → string) map properties [RO/runtime]

Additional configuration properties specific to the bond mode.

Default value:	{}
Published in:	XenServer 6.1 (tampa)	Additional configuration properties specific to the bond mode.

PIF ref set slaves [RO/runtime]

The interfaces which are part of this bond

Published in:

XenServer 4.1 (miami)

The interfaces which are part of this bond

string uuid [RO/runtime]

Unique identifier/object reference

Published in:

XenServer 4.0 (rio)

Unique identifier/object reference

Messages

void add_to_other_config (session ref, Bond ref, string, string)

Add the given key-value pair to the other_config field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
	string key	Key to add
	string value	Value to add
Minimum role:	pool-operator
Published in:	XenServer 4.1 (miami)	additional configuration

Bond ref create (session ref, network ref, PIF ref set, string, enum bond_mode, (string → string) map)

Create an interface bond

Parameters:	session ref session_id	Reference to a valid session
	network ref network	Network to add the bonded PIF to
	PIF ref set members	PIFs to add to this bond
	string MAC	The MAC address to use on the bond itself. If this parameter is the empty string then the bond will inherit its MAC address from the primary slave.
	enum bond_mode mode	Bonding mode to use for the new bond
	(string → string) map properties	Additional configuration parameters specific to the bond mode
Minimum role:	pool-operator
Result:	The reference of the created Bond object
Published in:	XenServer 4.1 (miami)	Create an interface bond

void destroy (session ref, Bond ref)

Destroy an interface bond

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	Bond to destroy
Minimum role:	pool-operator
Published in:	XenServer 4.1 (miami)	Destroy an interface bond

Bond ref set get_all (session ref)

Return a list of all the Bonds known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	references to all objects
Published in:	XenServer 4.1 (miami)	A Network bond that combines physical network interfaces, also known as link aggregation

(Bond ref → Bond record) map get_all_records (session ref)

Return a map of Bond references to Bond records for all Bonds known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	records of all objects
Published in:	XenServer 4.1 (miami)	A Network bond that combines physical network interfaces, also known as link aggregation

bool get_auto_update_mac (session ref, Bond ref)

Get the auto_update_mac field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	Citrix Hypervisor 8.1 (quebec)

Bond ref get_by_uuid (session ref, string)

Get a reference to the Bond instance with the specified UUID.

Parameters:	session ref session_id	Reference to a valid session
	string uuid	UUID of object to return
Minimum role:	read-only
Result:	reference to the object
Published in:	XenServer 4.1 (miami)	A Network bond that combines physical network interfaces, also known as link aggregation

int get_links_up (session ref, Bond ref)

Get the links_up field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 6.1 (tampa)	Number of links up in this bond

PIF ref get_master (session ref, Bond ref)

Get the master field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.1 (miami)	The bonded interface

enum bond_mode get_mode (session ref, Bond ref)

Get the mode field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 6.0 (boston)

(string → string) map get_other_config (session ref, Bond ref)

Get the other_config field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.1 (miami)	additional configuration

PIF ref get_primary_slave (session ref, Bond ref)

Get the primary_slave field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 6.0 (boston)

(string → string) map get_properties (session ref, Bond ref)

Get the properties field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 6.1 (tampa)	Additional configuration properties specific to the bond mode.

Bond record get_record (session ref, Bond ref)

Get a record containing the current state of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	all fields from the object
Published in:	XenServer 4.1 (miami)	A Network bond that combines physical network interfaces, also known as link aggregation

PIF ref set get_slaves (session ref, Bond ref)

Get the slaves field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.1 (miami)	The interfaces which are part of this bond

string get_uuid (session ref, Bond ref)

Get the uuid field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	Unique identifier/object reference

void remove_from_other_config (session ref, Bond ref, string)

Remove the given key and its corresponding value from the other_config field of the given Bond. If the key is not in that Map, then do nothing.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
	string key	Key to remove
Minimum role:	pool-operator
Published in:	XenServer 4.1 (miami)	additional configuration

void set_mode (session ref, Bond ref, enum bond_mode)

Change the bond mode

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	The bond
	enum bond_mode value	The new bond mode
Minimum role:	pool-operator
Published in:	XenServer 6.0 (boston)

void set_other_config (session ref, Bond ref, (string → string) map)

Set the other_config field of the given Bond.

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	reference to the object
	(string → string) map value	New value to set
Minimum role:	pool-operator
Published in:	XenServer 4.1 (miami)	additional configuration

void set_property (session ref, Bond ref, string, string)

Set the value of a property of the bond

Parameters:	session ref session_id	Reference to a valid session
	Bond ref self	The bond
	string name	The property name
	string value	The property value
Minimum role:	pool-operator
Published in:	XenServer 6.1 (tampa)	Set the value of a property of the bond

Class: Bond

Enums

Fields

Messages Hide implicit

Classes

Messages