com.hp.sdn.dvc.facet

Interface VlanHandler

All Superinterfaces:

Facet, HandlerFacet

public interface VlanHandler
extends HandlerFacet

Abstraction for provisioning and managing VLANs on switches. It provides ability to do the following:

• create vlan-port pairs
• create and delete vlans
• add and remove port pairs to/from a vlan
• get a set of all vlans
• get a vlan for a given port
• get a set of VID for a given port
• get a set of vlans for a given port

Method Summary

Methods

Modifier and Type	Method and Description
void	addIpAddress(VlanId vid, IpAddress ip, SubnetMask mask) Add an IP address to the vlan.
void	addPort(VlanPortPair port) Add a port to a vlan.
void	createVlan(VlanId vid, String name, String description) Creates a vlan
void	deleteVlan(VlanId vid) Delete the vlan identified by the vlan identifier (VID).
Set<VlanId>	getVIdsContainingPort(InterfaceId port, VlanTagType tag) Get the set of vlan identifiers (VID) that the specified port is a member of.
VlanInfo	getVlan(VlanId vid) Get the Vlan object for the specified VID.
Set<VlanInfo>	getVlans() Get a set of all Vlans that have been created.
Set<VlanInfo>	getVlansContainingPort(InterfaceId port, VlanTagType tag) Get the set of Vlans that the specified port is a member of.
void	removeIpAddress(VlanId vid, IpAddress ip, SubnetMask mask) Remove an IP address from the vlan.
void	removePort(VlanPortPair port) Remove a port from a vlan.
void	setDescription(VlanId vid) Set or change the vlan description.
void	setName(VlanId vid) Set or change the vlan name.

Methods inherited from interface com.hp.device.HandlerFacet

apply, fetch, getIpAddress, setIpAddress

Methods inherited from interface com.hp.device.Facet

getContext, getTypeName

Method Detail

createVlan

void createVlan(VlanId vid,
              String name,
              String description)

Creates a vlan

Parameters:

vid - the vlan identifier (VID) to be assigned to the vlan

name - the vlan name

description - description of the vlan

deleteVlan

void deleteVlan(VlanId vid)

Delete the vlan identified by the vlan identifier (VID).

Parameters:

vid - the vlan identifier (VID) assigned to the vlan to be deleted

addPort

void addPort(VlanPortPair port)

Add a port to a vlan. The VID is specified in the VlanPortPair object.

Parameters:

port - the port to be added

removePort

void removePort(VlanPortPair port)

Remove a port from a vlan. The VID is specified in the VlanPortPair object.

Parameters:

port - the port to be removed

addIpAddress

void addIpAddress(VlanId vid,
                IpAddress ip,
                SubnetMask mask)

Add an IP address to the vlan.

Parameters:

vid - vlan identifier to add IP address

ip - IP address to be added to the vlan

mask - subnet mask for the IP address

removeIpAddress

void removeIpAddress(VlanId vid,
                   IpAddress ip,
                   SubnetMask mask)

Remove an IP address from the vlan.

Parameters:

vid - vlan identifier to remove the IP address from

ip - IP address to be removed from the vlan

mask - subnet mask for the IP address

setName

void setName(VlanId vid)

Set or change the vlan name.

Parameters:

vid - vlan identifier for the vlan whose name is to be set.

setDescription

void setDescription(VlanId vid)

Set or change the vlan description.

Parameters:

vid - vlan identifier for the vlan whose description is to be set.

getVlans

Set<VlanInfo> getVlans()

Get a set of all Vlans that have been created.

Returns:

a set of Vlan objects

getVlan

VlanInfo getVlan(VlanId vid)

Get the Vlan object for the specified VID. The Vlan object will contain the set of VlanPortPorts assigned to the vlan.

Parameters:

vid - the vlan identifier (VID) assigned to the vlan

Returns:

Vlan object

getVIdsContainingPort

Set<VlanId> getVIdsContainingPort(InterfaceId port,
                                VlanTagType tag)

Get the set of vlan identifiers (VID) that the specified port is a member of.

Parameters:

port - the port to return VIDs for

tag - the tag type of the port

Returns:

VlanIds containing the specified port

getVlansContainingPort

Set<VlanInfo> getVlansContainingPort(InterfaceId port,
                                   VlanTagType tag)

Get the set of Vlans that the specified port is a member of.

Parameters:

port - the port to return Vlans for

tag - the tag type of the port

Returns:

Vlans containing the specified port