net.floodlightcontroller.loadbalancer

Interface ILoadBalancerService

All Superinterfaces:

IFloodlightService

All Known Implementing Classes:

LoadBalancer

public interface ILoadBalancerService
extends IFloodlightService

Method Summary

Modifier and Type	Method and Description
LBMember	createMember(LBMember member) Create and return a new member.
LBMonitor	createMonitor(LBMonitor monitor) Create and return a new monitor.
LBPool	createPool(LBPool pool) Create and return a new pool.
LBVip	createVip(LBVip vip) Create and return a new Vip.
java.util.Collection<LBMember>	listMember(java.lang.String memberId) List selected member by its ID.
java.util.Collection<LBMember>	listMembers() List all current members.
java.util.Collection<LBMember>	listMembersByPool(java.lang.String poolId) List all members in a specified pool.
java.util.Collection<LBMonitor>	listMonitor(java.lang.String monitorId) List selected monitor by its ID.
java.util.Collection<LBMonitor>	listMonitors() List all current monitors.
java.util.Collection<LBPool>	listPool(java.lang.String poolId) List selected pool by its ID.
java.util.Collection<LBPool>	listPools() List all current pools.
java.util.Collection<LBVip>	listVip(java.lang.String vipId) List selected Vip by its ID.
java.util.Collection<LBVip>	listVips() List all current Vips.
int	removeMember(java.lang.String memberId) Remove an existing member.
int	removeMonitor(java.lang.String monitorId) Remove an existing monitor.
int	removePool(java.lang.String poolId) Remove an existing pool.
int	removeVip(java.lang.String vipId) Remove an existing Vip.
LBMember	updateMember(LBMember member) Update and return an existing member.
LBMonitor	updateMonitor(LBMonitor monitor) Update and return an existing monitor.
LBPool	updatePool(LBPool pool) Update and return an existing pool.
LBVip	updateVip(LBVip vip) Update and return an existing Vip.

Method Detail

listVips

java.util.Collection<LBVip> listVips()

List all current Vips.

listVip

java.util.Collection<LBVip> listVip(java.lang.String vipId)

List selected Vip by its ID.

Parameters:

vipId - Id of requested Vip

createVip

LBVip createVip(LBVip vip)

Create and return a new Vip.

Parameters:

LBVip - vip: data structure with caller provided Vip attributes

Returns:

LBVip: Created Vip

updateVip

LBVip updateVip(LBVip vip)

Update and return an existing Vip.

Parameters:

LBVip - vip: data structure with caller provided Vip attributes

Returns:

LBVip: Updated Vip

removeVip

int removeVip(java.lang.String vipId)

Remove an existing Vip.

Parameters:

String - vipId

Returns:

int: removal status

listPools

java.util.Collection<LBPool> listPools()

List all current pools.

listPool

java.util.Collection<LBPool> listPool(java.lang.String poolId)

List selected pool by its ID.

Parameters:

poolId - Id of requested pool

createPool

LBPool createPool(LBPool pool)

Create and return a new pool.

Parameters:

LBPool - pool: data structure with caller provided pool attributes

Returns:

LBPool: Created pool

updatePool

LBPool updatePool(LBPool pool)

Update and return an existing pool.

Parameters:

LBPool - pool: data structure with caller provided pool attributes

Returns:

LBPool: Updated pool

removePool

int removePool(java.lang.String poolId)

Remove an existing pool.

Parameters:

String - poolId

Returns:

int: removal status

listMembers

java.util.Collection<LBMember> listMembers()

List all current members.

listMember

java.util.Collection<LBMember> listMember(java.lang.String memberId)

List selected member by its ID.

Parameters:

memberId - Id of requested member

listMembersByPool

java.util.Collection<LBMember> listMembersByPool(java.lang.String poolId)

List all members in a specified pool.

createMember

LBMember createMember(LBMember member)

Create and return a new member.

Parameters:

LBMember - member: data structure with caller provided member attributes

Returns:

LBMember: Created member

updateMember

LBMember updateMember(LBMember member)

Update and return an existing member.

Parameters:

LBMember - member: data structure with caller provided member attributes

Returns:

LBMember: Updated member

removeMember

int removeMember(java.lang.String memberId)

Remove an existing member.

Parameters:

String - memberId

Returns:

int: removal status

listMonitors

java.util.Collection<LBMonitor> listMonitors()

List all current monitors.

listMonitor

java.util.Collection<LBMonitor> listMonitor(java.lang.String monitorId)

List selected monitor by its ID.

Parameters:

monitorId - Id of requested monitor

createMonitor

LBMonitor createMonitor(LBMonitor monitor)

Create and return a new monitor.

Parameters:

LBMonitor - monitor: data structure with caller provided monitor attributes

Returns:

LBMonitor: Created monitor

updateMonitor

LBMonitor updateMonitor(LBMonitor monitor)

Update and return an existing monitor.

Parameters:

LBMonitor - monitor: data structure with caller provided pool attributes

Returns:

LBMonitor: Updated monitor

removeMonitor

int removeMonitor(java.lang.String monitorId)

Remove an existing monitor.

Parameters:

String - monitorId

Returns:

int: removal status