Package 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.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
void	addToOtherConfig(Connection c, String key, String value)	Add the given key-value pair to the other_config field of the given VLAN.
static VLAN	create(Connection c, PIF taggedPIF, Long tag, Network network)	Create a VLAN mux/demuxer Minimum allowed role: pool-operator First published in XenServer 4.1.
static Task	createAsync(Connection c, PIF taggedPIF, Long tag, Network network)	Create a VLAN mux/demuxer Minimum allowed role: pool-operator First published in XenServer 4.1.
void	destroy(Connection c)	Destroy a VLAN mux/demuxer Minimum allowed role: pool-operator First published in XenServer 4.1.
Task	destroyAsync(Connection c)	Destroy a VLAN mux/demuxer Minimum allowed role: pool-operator First published in XenServer 4.1.
boolean	equals(Object obj)	If obj is a VLAN, compares XenAPI references for equality.
static Set<VLAN>	getAll(Connection c)	Return a list of all the VLANs known to the system.
static 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, String uuid)	Get a reference to the VLAN instance with the specified UUID.
Map<String,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.
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.
String	getUuid(Connection c)	Get the uuid field of the given VLAN.
int	hashCode()
void	removeFromOtherConfig(Connection c, String key)	Remove the given key and its corresponding value from the other_config field of the given VLAN.
void	setOtherConfig(Connection c, Map<String,String> otherConfig)	Set the other_config field of the given VLAN.
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 Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

If obj is a VLAN, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public VLAN.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a record containing the current state of the given VLAN. 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 - 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 VLAN getByUuid(Connection c,
 String uuid)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the VLAN instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

uuid - 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 VLAN. 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 - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getTaggedPIF

public PIF getTaggedPIF(Connection c)
                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the tagged_PIF field of the given VLAN. 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 - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUntaggedPIF

public PIF getUntaggedPIF(Connection c)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the untagged_PIF field of the given VLAN. 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 - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getTag

public Long getTag(Connection c)
            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the tag field of the given VLAN. 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 - 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 VLAN. 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 - 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,
IOException

Set the other_config field of the given VLAN. Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

otherConfig - 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 VLAN. Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

key - Key to add

value - 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 VLAN. 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 on

key - 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.

create

public static VLAN create(Connection c,
 PIF taggedPIF,
 Long tag,
 Network network)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a VLAN mux/demuxer Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

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 - 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.

createAsync

public static Task createAsync(Connection c,
 PIF taggedPIF,
 Long tag,
 Network network)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a VLAN mux/demuxer Minimum allowed role: pool-operator First published in XenServer 4.1.

Parameters:

c - The connection the call is made on

taggedPIF - PIF which receives the tagged traffic

tag - VLAN tag to use

network - Network to receive the untagged traffic

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.

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy a VLAN mux/demuxer 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 - 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 VLAN mux/demuxer 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 - 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<VLAN> getAll(Connection c)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

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

Return a map of VLAN references to VLAN records for all VLANs 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 - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.