Package com.xensource.xenapi
Class Tunnel
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.Tunnel
A tunnel for network traffic
First published in XenServer 5.6 FP1.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a Tunnel -
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 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 Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.static Tunnel
create
(Connection c, PIF transportPIF, Network network, Types.TunnelProtocol protocol) Create a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.static Task
createAsync
(Connection c, PIF transportPIF, Network network) Create a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.static Task
createAsync
(Connection c, PIF transportPIF, Network network, Types.TunnelProtocol protocol) Create a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.void
Destroy a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.Destroy a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.boolean
If obj is a Tunnel, compares XenAPI references for equality.Get the access_PIF field of the given tunnel.getAll
(Connection c) Return a list of all the tunnels known to the system.static Map<Tunnel,
Tunnel.Record> 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.Get the other_config field of the given tunnel.Get the protocol field of the given tunnel.Get a record containing the current state of the given tunnel.Get the status field of the given tunnel.Get the transport_PIF field of the given tunnel.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
setProtocol
(Connection c, Types.TunnelProtocol protocol) Set the protocol field of the given tunnel.void
setStatus
(Connection c, Map<String, String> status) Set the status field of the given tunnel.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 Tunnel, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public Tunnel.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given tunnel. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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 Tunnel getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the tunnel instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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
- 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 tunnel. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getAccessPIF
public PIF getAccessPIF(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the access_PIF field of the given tunnel. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getTransportPIF
public PIF getTransportPIF(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the transport_PIF field of the given tunnel. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getStatus
public Map<String,String> getStatus(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the status field of the given tunnel. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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 tunnel. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getProtocol
public Types.TunnelProtocol getProtocol(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the protocol field of the given tunnel. Minimum allowed role: read-only First published in 1.250.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.
-
setStatus
public void setStatus(Connection c, Map<String, String> status) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the status field of the given tunnel. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onstatus
- 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.
-
addToStatus
public void addToStatus(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the status field of the given tunnel. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromStatus
public void removeFromStatus(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the status field of the given tunnel. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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
- 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, IOExceptionSet the other_config field of the given tunnel. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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
- 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 tunnel. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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
- 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 tunnel. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setProtocol
public void setProtocol(Connection c, Types.TunnelProtocol protocol) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the protocol field of the given tunnel. Minimum allowed role: pool-operator First published in 1.250.0.- Parameters:
c
- The connection the call is made onprotocol
- 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.
-
create
public static Tunnel create(Connection c, PIF transportPIF, Network network) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.OpenvswitchNotActive, Types.TransportPifNotConfigured, Types.IsTunnelAccessPif Create a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made ontransportPIF
- PIF which receives the tagged traffic First published in XenServer 7.0.network
- Network to receive the tunnelled traffic First published in XenServer 7.0.- Returns:
- The reference of the created tunnel 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.Types.OpenvswitchNotActive
- This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.Types.TransportPifNotConfigured
- The tunnel transport PIF has no IP configuration set.Types.IsTunnelAccessPif
- Cannot create a VLAN or tunnel on top of a tunnel access PIF - use the underlying transport PIF instead.
-
create
public static Tunnel create(Connection c, PIF transportPIF, Network network, Types.TunnelProtocol protocol) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.OpenvswitchNotActive, Types.TransportPifNotConfigured, Types.IsTunnelAccessPif Create a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made ontransportPIF
- PIF which receives the tagged traffic First published in XenServer 7.0.network
- Network to receive the tunnelled traffic First published in XenServer 7.0.protocol
- Protocol used for the tunnel (GRE or VxLAN) First published in 1.250.0.- Returns:
- The reference of the created tunnel 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.Types.OpenvswitchNotActive
- This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.Types.TransportPifNotConfigured
- The tunnel transport PIF has no IP configuration set.Types.IsTunnelAccessPif
- Cannot create a VLAN or tunnel on top of a tunnel access PIF - use the underlying transport PIF instead.
-
createAsync
public static Task createAsync(Connection c, PIF transportPIF, Network network) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.OpenvswitchNotActive, Types.TransportPifNotConfigured, Types.IsTunnelAccessPif Create a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made ontransportPIF
- PIF which receives the tagged traffic First published in XenServer 7.0.network
- Network to receive the tunnelled traffic First published in XenServer 7.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.Types.OpenvswitchNotActive
- This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.Types.TransportPifNotConfigured
- The tunnel transport PIF has no IP configuration set.Types.IsTunnelAccessPif
- Cannot create a VLAN or tunnel on top of a tunnel access PIF - use the underlying transport PIF instead.
-
createAsync
public static Task createAsync(Connection c, PIF transportPIF, Network network, Types.TunnelProtocol protocol) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.OpenvswitchNotActive, Types.TransportPifNotConfigured, Types.IsTunnelAccessPif Create a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made ontransportPIF
- PIF which receives the tagged traffic First published in XenServer 7.0.network
- Network to receive the tunnelled traffic First published in XenServer 7.0.protocol
- Protocol used for the tunnel (GRE or VxLAN) First published in 1.250.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.Types.OpenvswitchNotActive
- This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.Types.TransportPifNotConfigured
- The tunnel transport PIF has no IP configuration set.Types.IsTunnelAccessPif
- Cannot create a VLAN or tunnel on top of a tunnel access PIF - use the underlying transport PIF instead.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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 a tunnel Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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.
-
getAll
public static Set<Tunnel> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the tunnels known to the system. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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<Tunnel,Tunnel.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of tunnel references to tunnel records for all tunnels known to the system. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-