public class Bond extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
Bond.Record
Represents all the fields in a Bond
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference (OpaqueRef) to this object.
|
Modifier and Type | Method and Description |
---|---|
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.
|
java.lang.Boolean |
getAutoUpdateMac(Connection c)
Get the auto_update_mac field of the given Bond.
|
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() |
isNull
protected final java.lang.String ref
public java.lang.String toWireString()
toWireString
in class XenAPIObject
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public Bond.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static Bond getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onuuid
- UUID of object to returnTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public PIF getMaster(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Set<PIF> getSlaves(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public PIF getPrimarySlave(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Types.BondMode getMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.util.Map<java.lang.String,java.lang.String> getProperties(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Long getLinksUp(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public java.lang.Boolean getAutoUpdateMac(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onotherConfig
- New value to setTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onkey
- Key to addvalue
- Value to addTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void removeFromOtherConfig(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onkey
- Key to removeTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onnetwork
- Network to add the bonded PIF tomembers
- PIFs to add to this bondMAC
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onnetwork
- Network to add the bonded PIF tomembers
- PIFs to add to this bondMAC
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onnetwork
- Network to add the bonded PIF tomembers
- PIFs to add to this bondMAC
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onnetwork
- Network to add the bonded PIF tomembers
- PIFs to add to this bondMAC
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onnetwork
- Network to add the bonded PIF tomembers
- PIFs to add to this bondMAC
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.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
c
- The connection the call is made onnetwork
- Network to add the bonded PIF tomembers
- PIFs to add to this bondMAC
- 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.Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task setModeAsync(Connection c, Types.BondMode value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The new bond modeTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setMode(Connection c, Types.BondMode value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- The new bond modeTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public Task setPropertyAsync(Connection c, java.lang.String name, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onname
- The property namevalue
- The property valueTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public void setProperty(Connection c, java.lang.String name, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onname
- The property namevalue
- The property valueTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static java.util.Set<Bond> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.public static java.util.Map<Bond,Bond.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.