Load Balance Group Management Functions


Enumerations
enum	nmf_lbg_failover_mode { NMF_LBG_FO_TO_PORT = 1, NMF_LBG_FO_TO_STANDBY_PORT_OR_ANY, NMF_LBG_FO_HASH_TO_STANDBY, NMF_LBG_FO_HASH_TO_ANY }
Functions
nmf_status_t	nmf_lbg_add (nmf_client_t clid, int slot, int lbg_id, char name)
	Add a Load Balance Group.
nmf_status_t	nmf_lbg_rem (nmf_client_t clid, int slot, int lbg_id)
	Remove a Load Balance Group.
nmf_status_t	nmf_lbg_list_get (nmf_client_t clid, int slot, nm_bv_t *lbg_list)
	Get the LBG defined for this switch.
nmf_status_t	nmf_lbg_port_add (nmf_client_t clid, int slot, int lbg_id, int port_num)
	Add a port to a LBG.
nmf_status_t	nmf_lbg_port_rem (nmf_client_t clid, int slot, int lbg, int port_num)
	Remove a port from a LBG.
nmf_status_t	nmf_lbg_port_list_set (nmf_client_t clid, int slot, int lbg, nm_bv_t *port_list)
	Set the port membership list for a LBG.
nmf_status_t	nmf_lbg_port_list_get (nmf_client_t clid, int slot, int lbg, nm_bv_t *port_list)
	Get the port membership list for a LBG.
nmf_status_t	nmf_lbg_attr_set (nmf_client_t clid, int slot, int lbg, enum nmf_lbg_attr_id id, union nmf_lbg_attr_value *attr)
	Set the LBG attribute.
nmf_status_t	nmf_lbg_attr_get (nmf_client_t clid, int slot, int lbg, enum nmf_lbg_attr_id id, union nmf_lbg_attr_value *attr)
	Get the LBG attribute.
nmf_status_t	nmf_lbg_port_attr_set (nmf_client_t clid, int slot, int lbg, int port, enum nmf_lbg_port_attr_id id, union nmf_lbg_port_attr_value *attr)
	Set the LBG attribute.
nmf_status_t	nmf_lbg_port_attr_get (nmf_client_t clid, int slot, int lbg, int port, enum nmf_lbg_port_attr_id id, union nmf_lbg_port_attr_value *attr)
	Get the LBG Port attribute.

Enumeration Type Documentation

enum nmf_lbg_failover_mode

Enumerator:

NMF_LBG_FO_TO_PORT	Failover traffic to the port specified in the LBG port's NMF_LBG_PORT_FO_PORT attribute.
NMF_LBG_FO_TO_STANDBY_PORT_OR_ANY	Failover traffic to the next available port from the set of all standby ports in the LBG. If all standby ports are in use, hash failover to the set of active ports.
NMF_LBG_FO_HASH_TO_STANDBY	Hash failover traffic to the set of standby ports in the LBG
NMF_LBG_FO_HASH_TO_ANY	Hash failover traffic to all active ports regardless of role.

Definition at line 1789 of file nmf.h.

Function Documentation

nmf_status_t nmf_lbg_add	(	nmf_client_t	clid,
		int	slot,
		int *	lbg_id,
		char *	name
	)

Add a Load Balance Group.

Parameters:

	clid	The client handle.
	slot	The slot number
	*lbg_id	Pointer to an integer to receive the LBG number
	name	Pointer to descriptive name for the LBG

Returns:: NMF_OK Success
-NMF_ENOENT Slot not found.

nmf_status_t nmf_lbg_attr_get	(	nmf_client_t	clid,
		int	slot,
		int	lbg,
		enum nmf_lbg_attr_id	id,
		union nmf_lbg_attr_value *	attr
	)

Get the LBG attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg	The LBG number.
	id	The attribute identifier
	attr	Pointer to the attribute value

Returns:: NMF_OK Success
-NMF_ENOENT Slot or LBG id not found.

nmf_status_t nmf_lbg_attr_set	(	nmf_client_t	clid,
		int	slot,
		int	lbg,
		enum nmf_lbg_attr_id	id,
		union nmf_lbg_attr_value *	attr
	)

Set the LBG attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg	The LBG number.
	id	The attribute identifier
	attr	Pointer to the attribute value

Returns:: NMF_OK Success
-NMF_ENOENT Slot or LBG id not found.

nmf_status_t nmf_lbg_list_get	(	nmf_client_t	clid,
		int	slot,
		nm_bv_t *	lbg_list
	)

Get the LBG defined for this switch.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg_list	A bit vector representing the LBG list.

Returns:: NMF_OK Success
-NMF_ENOENT Slot not found.

nmf_status_t nmf_lbg_port_add	(	nmf_client_t	clid,
		int	slot,
		int	lbg_id,
		int	port_num
	)

Add a port to a LBG.

Parameters:

	clid	The client handle.
	slot	The slot number
	lag_id	The LBG number.
	port_num	The port number.

Returns:: NMF_OK Success
-NMF_ENOENT Slot not found.

nmf_status_t nmf_lbg_port_attr_get	(	nmf_client_t	clid,
		int	slot,
		int	lbg,
		int	port,
		enum nmf_lbg_port_attr_id	id,
		union nmf_lbg_port_attr_value *	attr
	)

Get the LBG Port attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg	The LBG number.
	port	The LBG Port number.
	id	The attribute identifier
	attr	Pointer to the attribute value

Returns:: NMF_OK Success
-NMF_ENOENT Slot or LBG id not found.

nmf_status_t nmf_lbg_port_attr_set	(	nmf_client_t	clid,
		int	slot,
		int	lbg,
		int	port,
		enum nmf_lbg_port_attr_id	id,
		union nmf_lbg_port_attr_value *	attr
	)

Set the LBG attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg	The LBG number.
	id	The attribute identifier
	attr	Pointer to the attribute value

Returns:: NMF_OK Success
-NMF_ENOENT Slot or LBG id not found.

nmf_status_t nmf_lbg_port_list_get	(	nmf_client_t	clid,
		int	slot,
		int	lbg,
		nm_bv_t *	port_list
	)

Get the port membership list for a LBG.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg	The LBG number.
	port_list	The bit vector representing the port membership list.

Returns:: NMF_OK Success
-NMF_ENOENT Slot not found.

nmf_status_t nmf_lbg_port_list_set	(	nmf_client_t	clid,
		int	slot,
		int	lbg,
		nm_bv_t *	port_list
	)

Set the port membership list for a LBG.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg	The LBG number.
	port_list	A bit vector representing the port membership list

Returns:: NMF_OK Success
-NMF_ENOENT Slot not found.

nmf_status_t nmf_lbg_port_rem	(	nmf_client_t	clid,
		int	slot,
		int	lbg,
		int	port_num
	)

Remove a port from a LBG.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg	The LBG id.
	port_num	The port number.

Returns:: NMF_OK Success
-NMF_ENOENT Slot not found.

nmf_status_t nmf_lbg_rem	(	nmf_client_t	clid,
		int	slot,
		int	lbg_id
	)

Remove a Load Balance Group.

Parameters:

	clid	The client handle.
	slot	The slot number
	lbg_id	The LBG number to remove.

Returns:: NMF_OK Success
-NMF_ENOENT Slot not found.

Load Balance Group Management Functions

Enumerations

Functions

Enumeration Type Documentation

Function Documentation