Package com.xensource.xenapi

Class Bond

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Bond

public class Bond
extends XenAPIObject

A Network bond that combines physical network interfaces, also known as link aggregation First published in XenServer 4.1.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Bond.Record	Represents all the fields in a Bond

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	ref	The XenAPI reference (OpaqueRef) to this object.

Constructor Summary

Constructors

Constructor	Description
Bond(String ref)	Creates an object from a given XenAPI reference (OpaqueRef)

Method Summary

Modifier and Type	Method	Description
void	addToOtherConfig(Connection c, String key, String value)	Add the given key-value pair to the other_config field of the given Bond.
static Bond	create(Connection c, Network network, Set<PIF> members, String MAC)	Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.
static Bond	create(Connection c, Network network, Set<PIF> members, String MAC, Types.BondMode mode)	Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.
static Bond	create(Connection c, Network network, Set<PIF> members, String MAC, Types.BondMode mode, Map<String,String> properties)	Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.
static Task	createAsync(Connection c, Network network, Set<PIF> members, String MAC)	Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.
static Task	createAsync(Connection c, Network network, Set<PIF> members, String MAC, Types.BondMode mode)	Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.
static Task	createAsync(Connection c, Network network, Set<PIF> members, String MAC, Types.BondMode mode, Map<String,String> properties)	Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.
void	destroy(Connection c)	Destroy an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.
Task	destroyAsync(Connection c)	Destroy an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.
boolean	equals(Object obj)	If obj is a Bond, compares XenAPI references for equality.
static Set<Bond>	getAll(Connection c)	Return a list of all the Bonds known to the system.
static Map<Bond,Bond.Record>	getAllRecords(Connection c)	Return a map of Bond references to Bond records for all Bonds known to the system.
Boolean	getAutoUpdateMac(Connection c)	Get the auto_update_mac field of the given Bond.
static Bond	getByUuid(Connection c, String uuid)	Get a reference to the Bond instance with the specified UUID.
Long	getLinksUp(Connection c)	Get the links_up field of the given Bond.
PIF	getMaster(Connection c)	Get the master field of the given Bond.
Types.BondMode	getMode(Connection c)	Get the mode field of the given Bond.
Map<String,String>	getOtherConfig(Connection c)	Get the other_config field of the given Bond.
PIF	getPrimarySlave(Connection c)	Get the primary_slave field of the given Bond.
Map<String,String>	getProperties(Connection c)	Get the properties field of the given Bond.
Bond.Record	getRecord(Connection c)	Get a record containing the current state of the given Bond.
Set<PIF>	getSlaves(Connection c)	Get the slaves field of the given Bond.
String	getUuid(Connection c)	Get the uuid field of the given Bond.
int	hashCode()
void	removeFromOtherConfig(Connection c, String key)	Remove the given key and its corresponding value from the other_config field of the given Bond.
void	setMode(Connection c, Types.BondMode value)	Change the bond mode Minimum allowed role: pool-operator First published in XenServer 6.0.
Task	setModeAsync(Connection c, Types.BondMode value)	Change the bond mode Minimum allowed role: pool-operator First published in XenServer 6.0.
void	setOtherConfig(Connection c, Map<String,String> otherConfig)	Set the other_config field of the given Bond.
void	setProperty(Connection c, String name, String value)	Set the value of a property of the bond Minimum allowed role: pool-operator First published in XenServer 6.1.
Task	setPropertyAsync(Connection c, String name, String value)	Set the value of a property of the bond Minimum allowed role: pool-operator First published in XenServer 6.1.
String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Constructor Details

Bond

public Bond(String ref)

Creates an object from a given XenAPI reference (OpaqueRef)

Parameters:

ref - The OpaqueRef from which to create the object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

If obj is a Bond, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public Bond.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a record containing the current state of the given Bond. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Returns:

all fields from the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByUuid

public static Bond getByUuid(Connection c,
 String uuid)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the Bond instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUuid

public String getUuid(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the uuid field of the given Bond. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getMaster

public PIF getMaster(Connection c)
              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the master field of the given Bond. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getSlaves

public Set<PIF> getSlaves(Connection c)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the slaves field of the given Bond. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getOtherConfig

public Map<String,String> getOtherConfig(Connection c)
                                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the other_config field of the given Bond. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getPrimarySlave

public PIF getPrimarySlave(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the primary_slave field of the given Bond. Minimum allowed role: read-only First published in XenServer 6.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getMode

public Types.BondMode getMode(Connection c)
                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the mode field of the given Bond. Minimum allowed role: read-only First published in XenServer 6.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getProperties

public Map<String,String> getProperties(Connection c)
                                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the properties field of the given Bond. Minimum allowed role: read-only First published in XenServer 6.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getLinksUp

public Long getLinksUp(Connection c)
                throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the links_up field of the given Bond. Minimum allowed role: read-only First published in XenServer 6.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAutoUpdateMac

public Boolean getAutoUpdateMac(Connection c)
                         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the auto_update_mac field of the given Bond. Minimum allowed role: read-only First published in Citrix Hypervisor 8.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setOtherConfig

public void setOtherConfig(Connection c,
 Map<String,String> otherConfig)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the other_config field of the given Bond. Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

otherConfig - New value to set

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

addToOtherConfig

public void addToOtherConfig(Connection c,
 String key,
 String value)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the given key-value pair to the other_config field of the given Bond. Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
 String key)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

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. Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

key - Key to remove

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

create

public static Bond create(Connection c,
 Network network,
 Set<PIF> members,
 String MAC)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

network - Network to add the bonded PIF to

members - PIFs to add to this bond

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.

Returns:

The reference of the created Bond object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

create

public static Bond create(Connection c,
 Network network,
 Set<PIF> members,
 String MAC,
 Types.BondMode mode)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

network - Network to add the bonded PIF to

members - PIFs to add to this bond

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.

mode - Bonding mode to use for the new bond First published in XenServer 6.0.

Returns:

The reference of the created Bond object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

create

public static Bond create(Connection c,
 Network network,
 Set<PIF> members,
 String MAC,
 Types.BondMode mode,
 Map<String,String> properties)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

network - Network to add the bonded PIF to

members - PIFs to add to this bond

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.

mode - Bonding mode to use for the new bond First published in XenServer 6.0.

properties - Additional configuration parameters specific to the bond mode First published in XenServer 6.1.

Returns:

The reference of the created Bond object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

createAsync

public static Task createAsync(Connection c,
 Network network,
 Set<PIF> members,
 String MAC)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

network - Network to add the bonded PIF to

members - PIFs to add to this bond

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.

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

createAsync

public static Task createAsync(Connection c,
 Network network,
 Set<PIF> members,
 String MAC,
 Types.BondMode mode)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

network - Network to add the bonded PIF to

members - PIFs to add to this bond

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.

mode - Bonding mode to use for the new bond First published in XenServer 6.0.

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

createAsync

public static Task createAsync(Connection c,
 Network network,
 Set<PIF> members,
 String MAC,
 Types.BondMode mode,
 Map<String,String> properties)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

network - Network to add the bonded PIF to

members - PIFs to add to this bond

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.

mode - Bonding mode to use for the new bond First published in XenServer 6.0.

properties - Additional configuration parameters specific to the bond mode First published in XenServer 6.1.

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setMode

public void setMode(Connection c,
 Types.BondMode value)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Change the bond mode Minimum allowed role: pool-operator First published in XenServer 6.0.

Parameters:

c - The connection the call is made on

value - The new bond mode

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setModeAsync

public Task setModeAsync(Connection c,
 Types.BondMode value)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Change the bond mode Minimum allowed role: pool-operator First published in XenServer 6.0.

Parameters:

c - The connection the call is made on

value - The new bond mode

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setProperty

public void setProperty(Connection c,
 String name,
 String value)
                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the value of a property of the bond Minimum allowed role: pool-operator First published in XenServer 6.1.

Parameters:

c - The connection the call is made on

name - The property name

value - The property value

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setPropertyAsync

public Task setPropertyAsync(Connection c,
 String name,
 String value)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the value of a property of the bond Minimum allowed role: pool-operator First published in XenServer 6.1.

Parameters:

c - The connection the call is made on

name - The property name

value - The property value

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAll

public static Set<Bond> getAll(Connection c)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a list of all the Bonds known to the system. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Returns:

references to all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecords

public static Map<Bond,Bond.Record> getAllRecords(Connection c)
                                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of Bond references to Bond records for all Bonds known to the system. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

Returns:

records of all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.