public class Tunnel extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
Tunnel.Record
Represents all the fields in a Tunnel
|
Modifier and Type | Field and Description |
---|---|
protected String |
ref
The XenAPI reference to this object.
|
Modifier and Type | Method and Description |
---|---|
void |
addToOtherConfig(Connection c,
String key,
String value)
Add the given key-value pair to the other_config field of the given tunnel.
|
void |
addToStatus(Connection c,
String key,
String value)
Add the given key-value pair to the status field of the given tunnel.
|
static Tunnel |
create(Connection c,
PIF transportPIF,
Network network)
Create a tunnel
|
static Task |
createAsync(Connection c,
PIF transportPIF,
Network network)
Create a tunnel
|
void |
destroy(Connection c)
Destroy a tunnel
|
Task |
destroyAsync(Connection c)
Destroy a tunnel
|
boolean |
equals(Object obj)
If obj is a Tunnel, compares XenAPI references for equality.
|
PIF |
getAccessPIF(Connection c)
Get the access_PIF field of the given tunnel.
|
static Set<Tunnel> |
getAll(Connection c)
Return a list of all the tunnels known to the system.
|
static Map<Tunnel,Tunnel.Record> |
getAllRecords(Connection c)
Return a map of tunnel references to tunnel records for all tunnels known to the system.
|
static Tunnel |
getByUuid(Connection c,
String uuid)
Get a reference to the tunnel instance with the specified UUID.
|
Map<String,String> |
getOtherConfig(Connection c)
Get the other_config field of the given tunnel.
|
Tunnel.Record |
getRecord(Connection c)
Get a record containing the current state of the given tunnel.
|
Map<String,String> |
getStatus(Connection c)
Get the status field of the given tunnel.
|
PIF |
getTransportPIF(Connection c)
Get the transport_PIF field of the given tunnel.
|
String |
getUuid(Connection c)
Get the uuid field of the given tunnel.
|
int |
hashCode() |
void |
removeFromOtherConfig(Connection c,
String key)
Remove the given key and its corresponding value from the other_config field of the given tunnel.
|
void |
removeFromStatus(Connection c,
String key)
Remove the given key and its corresponding value from the status field of the given tunnel.
|
void |
setOtherConfig(Connection c,
Map<String,String> otherConfig)
Set the other_config field of the given tunnel.
|
void |
setStatus(Connection c,
Map<String,String> status)
Set the status field of the given tunnel.
|
String |
toWireString() |
protected final String ref
public String toWireString()
toWireString
in class XenAPIObject
public boolean equals(Object obj)
public Tunnel.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Tunnel getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public PIF getAccessPIF(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public PIF getTransportPIF(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getStatus(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setStatus(Connection c, Map<String,String> status) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
status
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToStatus(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromStatus(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setOtherConfig(Connection c, Map<String,String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
otherConfig
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task createAsync(Connection c, PIF transportPIF, Network network) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OpenvswitchNotActive, Types.TransportPifNotConfigured, Types.IsTunnelAccessPif
transportPIF
- PIF which receives the tagged trafficnetwork
- Network to receive the tunnelled trafficTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OpenvswitchNotActive
Types.TransportPifNotConfigured
Types.IsTunnelAccessPif
public static Tunnel create(Connection c, PIF transportPIF, Network network) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OpenvswitchNotActive, Types.TransportPifNotConfigured, Types.IsTunnelAccessPif
transportPIF
- PIF which receives the tagged trafficnetwork
- Network to receive the tunnelled trafficTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OpenvswitchNotActive
Types.TransportPifNotConfigured
Types.IsTunnelAccessPif
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Set<Tunnel> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Map<Tunnel,Tunnel.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException