com.hp.sdn.dvc.facet

Interface VxlanHandler

All Superinterfaces:

Facet, HandlerFacet

public interface VxlanHandler
extends HandlerFacet

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

• create, destroy & query tunnels
• manage VLAN & VNI bindings
• manage tunnel and VNI bindings
• enable/disable MAC learning
• enable/disable flood behaviour
• manage static MAC learning for a tunnel/VNI

Method Summary

Methods

Modifier and Type	Method and Description
void	addMacAddresses(TunnelIndex tunnelIndex, Vni vni, Set<MacAddress> macAddresses) Adds the given set of remote MAC addresses to the specified tunnel/VNI; facilitates static learning.
void	bindTunnelsToVNI(Vni vni, Set<TunnelIndex> tunnelIndexes) Binds the given set of tunnels to the specified VNI.
void	bindVlansToVNI(Vni vni, Set<VlanPortPair> vlanPorts) Binds the given set of VLAN/port pairs to the specified VNI.
void	clearMacAddresses(TunnelIndex tunnelIndex, Vni vni) Clears all remote MAC addresses from the specified tunnel/VNI; facilitates static learning.
TunnelIndex	createTunnel(TunnelIndex tunnelIndex, IpAddress srcIp, IpAddress dstIp) Creates a new VxLan tunnel and returns the resulting interface.
void	destroyTunnel(TunnelIndex tunnelIndex) Destroys the tunnel identified by the specified tunnel interface index.
Set<MacAddress>	getMacAddresses(TunnelIndex tunnelIndex, Vni vni) Gets the set of remote MAC addresses configured on the specified tunnel/VNI; facilitates static learning.
Vxlan	getTunnel(TunnelIndex tunnelIndex) Retrieves the VXLAN tunnel descriptor for the tunnel with the specified interface index.
Set<TunnelIndex>	getTunnelBindings(Vni vni) Retrieves the set of tunnel indexes bound to the specified VNI.
Set<TunnelIndex>	getTunnels(StatusFilter statusFilter) Get a set of tunnel interface indexes that represent tunnels created on the device.
Set<VlanPortPair>	getVlanBindings(Vni vni) Retrieves the set of VLAN/port pairs bound to the specified VNI.
void	removeMacAddresses(TunnelIndex tunnelIndex, Vni vni, Set<MacAddress> macAddresses) Removes the given set of remote MAC addresses from the specified tunnel/VNI; facilitates static learning.
void	setFlooding(Vni vni, boolean on) Enables or disables flooding of packets with unknown destination MAC addresses on a given VNI.
void	setMacLearning(boolean on) Enables or disables learning of remote MAC addresses on the VXLAN tunnels.
void	unbindTunnelsFromVNI(Vni vni, Set<TunnelIndex> tunnelIndexes) Unbinds the given set of tunnels from the specified VNI.
void	unbindVlansFromVNI(Vni vni, Set<VlanPortPair> vlanPorts) Unbinds the given set of VLAN/port pairs from the specified VNI.

Methods inherited from interface com.hp.device.HandlerFacet

apply, fetch, getIpAddress, setIpAddress

Methods inherited from interface com.hp.device.Facet

getContext, getTypeName

Method Detail

createTunnel

TunnelIndex createTunnel(TunnelIndex tunnelIndex,
                       IpAddress srcIp,
                       IpAddress dstIp)

Creates a new VxLan tunnel and returns the resulting interface.

Parameters:

tunnelIndex - specifies the suggested tunnel interface index (as a positive integer) to be used for the tunnel; device may disregard the suggestion and issue one itself; interface index should not be already in use by other tunnels

srcIp - IPv4 address of the local VTEP

dstIp - IPv4 address of the remote VTEP

Returns:

the tunnel interface index of the interface that represents the newly created tunnel

Throws:

IllegalArgumentException - if tunnel interface index is already in use

destroyTunnel

void destroyTunnel(TunnelIndex tunnelIndex)

Destroys the tunnel identified by the specified tunnel interface index.

Parameters:

tunnelIndex - tunnel interface index

Throws:

IllegalArgumentException - if tunnel interface index not correspond to a tunnel

OperationFailureException - if the operation failed for some reason

getTunnels

Set<TunnelIndex> getTunnels(StatusFilter statusFilter)

Get a set of tunnel interface indexes that represent tunnels created on the device.

Parameters:

statusFilter - status filter (ANY, UP, DOWN)

Returns:

set of tunnel interface indexes

getTunnel

Vxlan getTunnel(TunnelIndex tunnelIndex)

Retrieves the VXLAN tunnel descriptor for the tunnel with the specified interface index.

Parameters:

tunnelIndex - interface index of the tunnel

Returns:

tunnel descriptor

bindVlansToVNI

void bindVlansToVNI(Vni vni,
                  Set<VlanPortPair> vlanPorts)

Binds the given set of VLAN/port pairs to the specified VNI. The operation may fail-fast, meaning that no attempt will be made to bind all VLAN port pairs.

Parameters:

vni - VNI to bind to

vlanPorts - set of VLAN ports

Throws:

OperationFailureException - if the operation failed for some reason // TODO: consider specialized exception to allow retrieval of the fail-point

unbindVlansFromVNI

void unbindVlansFromVNI(Vni vni,
                      Set<VlanPortPair> vlanPorts)

Unbinds the given set of VLAN/port pairs from the specified VNI. The operation may fail-fast, meaning that no attempt will be made to unbind all VLAN port pairs.

Parameters:

vni - VNI to unbind from

vlanPorts - set of VLAN ports

Throws:

OperationFailureException - if the operation failed for some reason // TODO: consider specialized exception to allow retrieval of the fail-point

getVlanBindings

Set<VlanPortPair> getVlanBindings(Vni vni)

Retrieves the set of VLAN/port pairs bound to the specified VNI.

Parameters:

vni - VNI a tunnel is bound to

Returns:

set of VLAN/port pairs

bindTunnelsToVNI

void bindTunnelsToVNI(Vni vni,
                    Set<TunnelIndex> tunnelIndexes)

Binds the given set of tunnels to the specified VNI. The operation may fail-fast, meaning that no attempt will be made to bind all tunnels.

Parameters:

vni - VNI to bind to

tunnelIndexes - set of tunnel indexes

Throws:

OperationFailureException - if the operation failed for some reason // TODO: consider specialized exception to allow retrieval of the fail-point

unbindTunnelsFromVNI

void unbindTunnelsFromVNI(Vni vni,
                        Set<TunnelIndex> tunnelIndexes)

Unbinds the given set of tunnels from the specified VNI. The operation may fail-fast, meaning that no attempt will be made to unbind all tunnels.

Parameters:

vni - VNI to unbind from

tunnelIndexes - set of tunnel indexes

Throws:

OperationFailureException - if the operation failed for some reason // TODO: consider specialized exception to allow retrieval of the fail-point

getTunnelBindings

Set<TunnelIndex> getTunnelBindings(Vni vni)

Retrieves the set of tunnel indexes bound to the specified VNI.

Parameters:

vni - VNI a tunnel is bound to

Returns:

set of tunnel indexes

setMacLearning

void setMacLearning(boolean on)

Enables or disables learning of remote MAC addresses on the VXLAN tunnels.

Parameters:

on - true to enable; false to disable

setFlooding

void setFlooding(Vni vni,
               boolean on)

Enables or disables flooding of packets with unknown destination MAC addresses on a given VNI.

Parameters:

vni - virtual network instance

on - true to enable; false to disable // TODO: Is this strictly required? Or should it go into a different facet?

addMacAddresses

void addMacAddresses(TunnelIndex tunnelIndex,
                   Vni vni,
                   Set<MacAddress> macAddresses)

Adds the given set of remote MAC addresses to the specified tunnel/VNI; facilitates static learning.

Parameters:

tunnelIndex - tunnel index

vni - VNI

macAddresses - set of MAC addresses to be added

removeMacAddresses

void removeMacAddresses(TunnelIndex tunnelIndex,
                      Vni vni,
                      Set<MacAddress> macAddresses)

Removes the given set of remote MAC addresses from the specified tunnel/VNI; facilitates static learning.

Parameters:

tunnelIndex - tunnel index

vni - VNI

macAddresses - set of MAC addresses to be removed

clearMacAddresses

void clearMacAddresses(TunnelIndex tunnelIndex,
                     Vni vni)

Clears all remote MAC addresses from the specified tunnel/VNI; facilitates static learning.

Parameters:

tunnelIndex - tunnel index

vni - VNI

getMacAddresses

Set<MacAddress> getMacAddresses(TunnelIndex tunnelIndex,
                              Vni vni)

Gets the set of remote MAC addresses configured on the specified tunnel/VNI; facilitates static learning.

Parameters:

tunnelIndex - tunnel index

vni - VNI

Returns:

set of MAC addresses