com.xensource.xenapi
Class Bond

java.lang.Object
  extended by com.xensource.xenapi.XenAPIObject
      extended by com.xensource.xenapi.Bond

public class Bond
extends XenAPIObject

First published in XenServer 4.1.


Nested Class Summary
static class Bond.Record
          Represents all the fields in a Bond
 
Field Summary
protected  java.lang.String ref
          The XenAPI reference (OpaqueRef) to this object.
 
Method Summary
 void addToOtherConfig(Connection c, java.lang.String key, java.lang.String value)
          Add the given key-value pair to the other_config field of the given Bond.
static Bond create(Connection c, Network network, java.util.Set<PIF> members, java.lang.String MAC)
          Create an interface bond First published in XenServer 4.1.
static Bond create(Connection c, Network network, java.util.Set<PIF> members, java.lang.String MAC, Types.BondMode mode)
          Create an interface bond First published in XenServer 4.1.
static Bond create(Connection c, Network network, java.util.Set<PIF> members, java.lang.String MAC, Types.BondMode mode, java.util.Map<java.lang.String,java.lang.String> properties)
          Create an interface bond First published in XenServer 4.1.
static Task createAsync(Connection c, Network network, java.util.Set<PIF> members, java.lang.String MAC)
          Create an interface bond First published in XenServer 4.1.
static Task createAsync(Connection c, Network network, java.util.Set<PIF> members, java.lang.String MAC, Types.BondMode mode)
          Create an interface bond First published in XenServer 4.1.
static Task createAsync(Connection c, Network network, java.util.Set<PIF> members, java.lang.String MAC, Types.BondMode mode, java.util.Map<java.lang.String,java.lang.String> properties)
          Create an interface bond First published in XenServer 4.1.
 void destroy(Connection c)
          Destroy an interface bond First published in XenServer 4.1.
 Task destroyAsync(Connection c)
          Destroy an interface bond First published in XenServer 4.1.
 boolean equals(java.lang.Object obj)
          If obj is a Bond, compares XenAPI references for equality.
static java.util.Set<Bond> getAll(Connection c)
          Return a list of all the Bonds known to the system.
static java.util.Map<Bond,Bond.Record> getAllRecords(Connection c)
          Return a map of Bond references to Bond records for all Bonds known to the system.
static Bond getByUuid(Connection c, java.lang.String uuid)
          Get a reference to the Bond instance with the specified UUID.
 java.lang.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.
 java.util.Map<java.lang.String,java.lang.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.
 java.util.Map<java.lang.String,java.lang.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.
 java.util.Set<PIF> getSlaves(Connection c)
          Get the slaves field of the given Bond.
 java.lang.String getUuid(Connection c)
          Get the uuid field of the given Bond.
 int hashCode()
           
 void removeFromOtherConfig(Connection c, java.lang.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 First published in XenServer 6.0.
 Task setModeAsync(Connection c, Types.BondMode value)
          Change the bond mode First published in XenServer 6.0.
 void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig)
          Set the other_config field of the given Bond.
 void setProperty(Connection c, java.lang.String name, java.lang.String value)
          Set the value of a property of the bond First published in XenServer 6.1.
 Task setPropertyAsync(Connection c, java.lang.String name, java.lang.String value)
          Set the value of a property of the bond First published in XenServer 6.1.
 java.lang.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 Detail

ref

protected final java.lang.String ref
The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()
Specified by:
toWireString in class XenAPIObject
Returns:
The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)
If obj is a Bond, compares XenAPI references for equality.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getRecord

public Bond.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Get a record containing the current state of the given Bond. First published in XenServer 4.1.

Returns:
all fields from the object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getByUuid

public static Bond getByUuid(Connection c,
                             java.lang.String uuid)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Get a reference to the Bond instance with the specified UUID. First published in XenServer 4.1.

Parameters:
uuid - UUID of object to return
Returns:
reference to the object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException
Get the uuid field of the given Bond. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getMaster

public PIF getMaster(Connection c)
              throws Types.BadServerResponse,
                     Types.XenAPIException,
                     org.apache.xmlrpc.XmlRpcException
Get the master field of the given Bond. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getSlaves

public java.util.Set<PIF> getSlaves(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException
Get the slaves field of the given Bond. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getOtherConfig

public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
                                                                throws Types.BadServerResponse,
                                                                       Types.XenAPIException,
                                                                       org.apache.xmlrpc.XmlRpcException
Get the other_config field of the given Bond. First published in XenServer 4.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getPrimarySlave

public PIF getPrimarySlave(Connection c)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException
Get the primary_slave field of the given Bond. First published in XenServer 6.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getMode

public Types.BondMode getMode(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Get the mode field of the given Bond. First published in XenServer 6.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties(Connection c)
                                                               throws Types.BadServerResponse,
                                                                      Types.XenAPIException,
                                                                      org.apache.xmlrpc.XmlRpcException
Get the properties field of the given Bond. First published in XenServer 6.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getLinksUp

public java.lang.Long getLinksUp(Connection c)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Get the links_up field of the given Bond. First published in XenServer 6.1.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                           java.util.Map<java.lang.String,java.lang.String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException
Set the other_config field of the given Bond. First published in XenServer 4.1.

Parameters:
otherConfig - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                             java.lang.String key,
                             java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Add the given key-value pair to the other_config field of the given Bond. First published in XenServer 4.1.

Parameters:
key - Key to add
value - Value to add
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
                                  java.lang.String key)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
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. First published in XenServer 4.1.

Parameters:
key - Key to remove
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
                               Network network,
                               java.util.Set<PIF> members,
                               java.lang.String MAC)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Create an interface bond First published in XenServer 4.1.

Parameters:
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
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

create

public static Bond create(Connection c,
                          Network network,
                          java.util.Set<PIF> members,
                          java.lang.String MAC)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException
Create an interface bond First published in XenServer 4.1.

Parameters:
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
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
                               Network network,
                               java.util.Set<PIF> members,
                               java.lang.String MAC,
                               Types.BondMode mode)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Create an interface bond First published in XenServer 4.1.

Parameters:
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
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

create

public static Bond create(Connection c,
                          Network network,
                          java.util.Set<PIF> members,
                          java.lang.String MAC,
                          Types.BondMode mode)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException
Create an interface bond First published in XenServer 4.1.

Parameters:
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
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
                               Network network,
                               java.util.Set<PIF> members,
                               java.lang.String MAC,
                               Types.BondMode mode,
                               java.util.Map<java.lang.String,java.lang.String> properties)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Create an interface bond First published in XenServer 4.1.

Parameters:
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
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

create

public static Bond create(Connection c,
                          Network network,
                          java.util.Set<PIF> members,
                          java.lang.String MAC,
                          Types.BondMode mode,
                          java.util.Map<java.lang.String,java.lang.String> properties)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException
Create an interface bond First published in XenServer 4.1.

Parameters:
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
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Destroy an interface bond First published in XenServer 4.1.

Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException
Destroy an interface bond First published in XenServer 4.1.

Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setModeAsync

public Task setModeAsync(Connection c,
                         Types.BondMode value)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Change the bond mode First published in XenServer 6.0.

Parameters:
value - The new bond mode
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setMode

public void setMode(Connection c,
                    Types.BondMode value)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException
Change the bond mode First published in XenServer 6.0.

Parameters:
value - The new bond mode
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setPropertyAsync

public Task setPropertyAsync(Connection c,
                             java.lang.String name,
                             java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Set the value of a property of the bond First published in XenServer 6.1.

Parameters:
name - The property name
value - The property value
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setProperty

public void setProperty(Connection c,
                        java.lang.String name,
                        java.lang.String value)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException
Set the value of a property of the bond First published in XenServer 6.1.

Parameters:
name - The property name
value - The property value
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<Bond> getAll(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException
Return a list of all the Bonds known to the system. First published in XenServer 4.1.

Returns:
references to all objects
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<Bond,Bond.Record> getAllRecords(Connection c)
                                                     throws Types.BadServerResponse,
                                                            Types.XenAPIException,
                                                            org.apache.xmlrpc.XmlRpcException
Return a map of Bond references to Bond records for all Bonds known to the system. First published in XenServer 4.1.

Returns:
records of all objects
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException