com.xensource.xenapi

Class VLAN

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VLAN

public class VLAN
extends XenAPIObject

A VLAN mux/demux First published in XenServer 4.1.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VLAN.Record Represents all the fields in a VLAN

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

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 VLAN.
static VLAN	create(Connection c, PIF taggedPIF, java.lang.Long tag, Network network) Create a VLAN mux/demuxer First published in XenServer 4.1.
static Task	createAsync(Connection c, PIF taggedPIF, java.lang.Long tag, Network network) Create a VLAN mux/demuxer First published in XenServer 4.1.
void	destroy(Connection c) Destroy a VLAN mux/demuxer First published in XenServer 4.1.
Task	destroyAsync(Connection c) Destroy a VLAN mux/demuxer First published in XenServer 4.1.
boolean	equals(java.lang.Object obj) If obj is a VLAN, compares XenAPI references for equality.
static java.util.Set<VLAN>	getAll(Connection c) Return a list of all the VLANs known to the system.
static java.util.Map<VLAN,VLAN.Record>	getAllRecords(Connection c) Return a map of VLAN references to VLAN records for all VLANs known to the system.
static VLAN	getByUuid(Connection c, java.lang.String uuid) Get a reference to the VLAN instance with the specified UUID.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given VLAN.
VLAN.Record	getRecord(Connection c) Get a record containing the current state of the given VLAN.
java.lang.Long	getTag(Connection c) Get the tag field of the given VLAN.
PIF	getTaggedPIF(Connection c) Get the tagged_PIF field of the given VLAN.
PIF	getUntaggedPIF(Connection c) Get the untagged_PIF field of the given VLAN.
java.lang.String	getUuid(Connection c) Get the uuid field of the given VLAN.
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 VLAN.
void	setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) Set the other_config field of the given VLAN.
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 VLAN, 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 VLAN.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given VLAN. First published in XenServer 4.1.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static VLAN getByUuid(Connection c,
             java.lang.String uuid)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a reference to the VLAN 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 VLAN. First published in XenServer 4.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getTaggedPIF

public PIF getTaggedPIF(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Get the tagged_PIF field of the given VLAN. First published in XenServer 4.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUntaggedPIF

public PIF getUntaggedPIF(Connection c)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Get the untagged_PIF field of the given VLAN. First published in XenServer 4.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getTag

public java.lang.Long getTag(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get the tag field of the given VLAN. 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 VLAN. First published in XenServer 4.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 VLAN. 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 VLAN. 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 VLAN. 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,
               PIF taggedPIF,
               java.lang.Long tag,
               Network network)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a VLAN mux/demuxer First published in XenServer 4.1.

Parameters:

taggedPIF - PIF which receives the tagged traffic

tag - VLAN tag to use

network - Network to receive the untagged traffic

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static VLAN create(Connection c,
          PIF taggedPIF,
          java.lang.Long tag,
          Network network)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Create a VLAN mux/demuxer First published in XenServer 4.1.

Parameters:

taggedPIF - PIF which receives the tagged traffic

tag - VLAN tag to use

network - Network to receive the untagged traffic

Returns:

The reference of the created VLAN 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 a VLAN mux/demuxer 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 a VLAN mux/demuxer First published in XenServer 4.1.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<VLAN> getAll(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Return a list of all the VLANs 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<VLAN,VLAN.Record> getAllRecords(Connection c)
                                                     throws Types.BadServerResponse,
                                                            Types.XenAPIException,
                                                            org.apache.xmlrpc.XmlRpcException

Return a map of VLAN references to VLAN records for all VLANs known to the system. First published in XenServer 4.1.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException