Package com.xensource.xenapi
Class Bond
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.Bond
First published in XenServer 4.1.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
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 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 an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.Destroy an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.boolean
If obj is a Bond, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the Bonds known to the system.static Map<Bond,
Bond.Record> Return a map of Bond references to Bond records for all Bonds known to the system.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.Get the links_up field of the given Bond.Get the master field of the given Bond.Get the mode field of the given Bond.Get the other_config field of the given Bond.Get the primary_slave field of the given Bond.Get the properties field of the given Bond.Get a record containing the current state of the given Bond.Get the slaves field of the given Bond.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.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.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.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a Bond, compares XenAPI references for equality. -
hashCode
public int hashCode() -
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. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByUuid
public static Bond getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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 onuuid
- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getMaster
public PIF getMaster(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getSlaves
public Set<PIF> getSlaves(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getPrimarySlave
public PIF getPrimarySlave(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getMode
public Types.BondMode getMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getProperties
public Map<String,String> getProperties(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getLinksUp
public Long getLinksUp(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAutoUpdateMac
public Boolean getAutoUpdateMac(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionSet 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 onotherConfig
- New value to set- Throws:
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.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, 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. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
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.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, 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. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
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.
-
createAsync
public static Task createAsync(Connection c, Network network, Set<PIF> members, String MAC) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
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.- Returns:
- Task
- Throws:
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.
-
create
public static Bond create(Connection c, Network network, Set<PIF> members, String MAC) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
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.- Returns:
- The reference of the created Bond object
- Throws:
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.
-
createAsync
public static Task createAsync(Connection c, Network network, Set<PIF> members, String MAC, Types.BondMode mode) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
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.- Returns:
- Task
- Throws:
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.
-
create
public static Bond create(Connection c, Network network, Set<PIF> members, String MAC, Types.BondMode mode) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Create an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
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.- Returns:
- The reference of the created Bond object
- Throws:
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.
-
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, org.apache.xmlrpc.XmlRpcExceptionCreate an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
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.- Returns:
- Task
- Throws:
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.
-
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, org.apache.xmlrpc.XmlRpcExceptionCreate an interface bond Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
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.- Returns:
- The reference of the created Bond object
- Throws:
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.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setModeAsync
public Task setModeAsync(Connection c, Types.BondMode value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Change the bond mode Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- The new bond mode- Returns:
- Task
- Throws:
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.
-
setMode
public void setMode(Connection c, Types.BondMode value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Change the bond mode Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- The new bond mode- Throws:
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.
-
setPropertyAsync
public Task setPropertyAsync(Connection c, String name, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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 onname
- The property namevalue
- The property value- Returns:
- Task
- Throws:
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.
-
setProperty
public void setProperty(Connection c, String name, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException 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 onname
- The property namevalue
- The property value- Throws:
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.
-
getAll
public static 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. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAllRecords
public static 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. 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-