org.onosproject.net.behaviour

Interface InterfaceConfig

All Superinterfaces:

Behaviour, HandlerBehaviour

public interface InterfaceConfig
extends HandlerBehaviour

Means to configure interfaces on devices.

Method Summary

Modifier and Type	Method and Description
boolean	addAccessMode(String intf, VlanId vlanId) Adds an access interface to a VLAN.
boolean	addPatchMode(String ifaceName, PatchDescription patchInterface) Adds a patch mode to the supplied interface.
boolean	addRateLimit(String intf, short limit) Adds a rate limit on an interface.
boolean	addTrunkMode(String intf, List<VlanId> vlanIds) Adds a trunk interface for VLANs.
boolean	addTunnelMode(String intf, TunnelDescription tunnelDesc) Adds a tunnel mode to supplied interface.
List<DeviceInterfaceDescription>	getInterfaces() Provides the interfaces configured on a device.
boolean	removeAccessMode(String intf) Removes an access interface to a VLAN.
boolean	removePatchMode(String ifaceName) Removes a patch mode from the supplied interface.
boolean	removeRateLimit(String intf) Removes rate limit from an interface.
boolean	removeTrunkMode(String intf) Removes trunk mode configuration from an interface.
boolean	removeTunnelMode(String intf) Removes a tunnel interface.

Methods inherited from interface org.onosproject.net.driver.HandlerBehaviour

handler, setHandler

Methods inherited from interface org.onosproject.net.driver.Behaviour

data, setData

Method Detail

addAccessMode

boolean addAccessMode(String intf,
                      VlanId vlanId)

Adds an access interface to a VLAN.

Parameters:

intf - the name of the interface

vlanId - the VLAN ID

Returns:

the result of operation

removeAccessMode

boolean removeAccessMode(String intf)

Removes an access interface to a VLAN.

Parameters:

intf - the name of the interface

Returns:

the result of operation

addTrunkMode

boolean addTrunkMode(String intf,
                     List<VlanId> vlanIds)

Adds a trunk interface for VLANs.

Parameters:

intf - the name of the interface

vlanIds - the VLAN IDs

Returns:

the result of operation

removeTrunkMode

boolean removeTrunkMode(String intf)

Removes trunk mode configuration from an interface.

Parameters:

intf - the name of the interface

Returns:

the result of operation

addRateLimit

boolean addRateLimit(String intf,
                     short limit)

Adds a rate limit on an interface.

Parameters:

intf - the name of the interface

limit - the limit as a percentage

Returns:

the result of operation

removeRateLimit

boolean removeRateLimit(String intf)

Removes rate limit from an interface.

Parameters:

intf - the name of the interface

Returns:

the result of operation

addTunnelMode

boolean addTunnelMode(String intf,
                      TunnelDescription tunnelDesc)

Adds a tunnel mode to supplied interface.

Parameters:

intf - the name of the interface

tunnelDesc - tunnel interface description

Returns:

true if the operation succeeds

removeTunnelMode

boolean removeTunnelMode(String intf)

Removes a tunnel interface.

Parameters:

intf - tunnel interface name

Returns:

true if the operation succeeds

addPatchMode

boolean addPatchMode(String ifaceName,
                     PatchDescription patchInterface)

Adds a patch mode to the supplied interface.

Parameters:

ifaceName - interface name to set patch mode

patchInterface - interface description

Returns:

true if the operation succeeds

removePatchMode

boolean removePatchMode(String ifaceName)

Removes a patch mode from the supplied interface.

Parameters:

ifaceName - interface name

Returns:

true if the operation succeeds

getInterfaces

List<DeviceInterfaceDescription> getInterfaces()

Provides the interfaces configured on a device.

Returns:

the list of the configured interfaces