VLAN Management Functions

Data Structures
union	nmf_vlan_attr_value
	VLAN Attribute Values. More...
union	nmf_vlan_port_attr_value
	VLAN Port Attribute Values. More...
Enumerations
enum	nmf_stp_state
	STP State.
enum	nmf_vlan_attr_id
	VLAN Attribute Identifiers.
enum	nmf_vlan_port_attr_id
	VLAN Port Attribute Identifiers.
Functions
nmf_status_t	nmf_vlan_add (nmf_client_t clid, int slot, int vlan_id, char *vlan_name)
	Add a VLAN.
nmf_status_t	nmf_vlan_rem (nmf_client_t clid, int slot, int vlan_id)
	Remove a VLAN.
nmf_status_t	nmf_vlan_list_get (nmf_client_t clid, int slot, nm_bv_t *vlan_list)
	Get the VLAN list for a switch and slot.
nmf_status_t	nmf_vlan_port_add (nmf_client_t clid, int slot, int vlan_id, int port_num, int tagged, enum nmf_stp_state stp_state)
	Add a port to a VLAN.
nmf_status_t	nmf_vlan_port_rem (nmf_client_t clid, int slot, int vlan_id, int port_num)
	Remove a port from a VLAN.
nmf_status_t	nmf_vlan_port_list_set (nmf_client_t clid, int slot, int vlan_id, int tagging, enum nmf_stp_state stp_state, nm_bv_t *port_list)
	Set the port membership list for a VLAN.
nmf_status_t	nmf_vlan_port_list_get (nmf_client_t clid, int slot, int vlan_id, nm_bv_t *port_list)
	Get the port membership list for a VLAN.
nmf_status_t	nmf_vlan_attr_set (nmf_client_t clid, int slot, int vlan_id, enum nmf_vlan_attr_id id, union nmf_vlan_attr_value *attr)
	Set a VLAN attribute.
nmf_status_t	nmf_vlan_attr_get (nmf_client_t clid, int slot, int vlan_id, enum nmf_vlan_attr_id id, union nmf_vlan_attr_value *attr)
	Get a VLAN attribute.
nmf_status_t	nmf_vlan_port_attr_set (nmf_client_t clid, int slot, int vlan_id, int port_no, enum nmf_vlan_port_attr_id id, union nmf_vlan_port_attr_value *attr)
	Set a VLAN port's attribute.
nmf_status_t	nmf_vlan_port_attr_get (nmf_client_t clid, int slot, int vlan_id, int port_no, enum nmf_vlan_port_attr_id id, union nmf_vlan_port_attr_value *attr)
	Get a VLAN port's attribute.

---

Function Documentation

nmf_status_t nmf_vlan_add	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		char *	vlan_name
	)

Add a VLAN.

Parameters:

	clid	The client handle.
	slot	The slot
	vlan_id	The VLAN id (1-4095).
	vlan_name	The descriptive name for the VLAN.

Returns:

NMF_OK Success

-NMF_ENOENT Slot not found.

nmf_status_t nmf_vlan_attr_get	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		enum nmf_vlan_attr_id	id,
		union nmf_vlan_attr_value *	attr
	)

Get a VLAN attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id (1-4095).
	id	The attribute identifier
	attr	Pointer to the attribute

Returns:

NMF_OK Success

-NMF_ENOENT Slot or VLAN id not found.

nmf_status_t nmf_vlan_attr_set	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		enum nmf_vlan_attr_id	id,
		union nmf_vlan_attr_value *	attr
	)

Set a VLAN attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id (1-4095).
	id	The attribute identifier
	attr	Pointer to the attribute

Returns:

NMF_OK Success

-NMF_ENOENT Slot or VLAN id not found.

nmf_status_t nmf_vlan_list_get	(	nmf_client_t	clid,
		int	slot,
		nm_bv_t *	vlan_list
	)

Get the VLAN list for a switch and slot.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_list	The bit vector representing the set of VLAN defined for the specified switch and slot.

nmf_status_t nmf_vlan_port_add	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		int	port_num,
		int	tagged,
		enum nmf_stp_state	stp_state
	)

Add a port to a VLAN.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id (1-4095).
	port_num	The port number.
	tagged	Non-zero if packets are to be tagged on egress.
	stp_state	The spanning-tree protocol state of the port to add.

Returns:

NMF_OK Success

nmf_status_t nmf_vlan_port_attr_get	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		int	port_no,
		enum nmf_vlan_port_attr_id	id,
		union nmf_vlan_port_attr_value *	attr
	)

Get a VLAN port's attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id (1-4095).
	port_no	The port number
	id	The attribute identifier
	attr	Pointer to the attribute

Returns:

NMF_OK Success

-NMF_ENOENT Slot or VLAN id not found.

nmf_status_t nmf_vlan_port_attr_set	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		int	port_no,
		enum nmf_vlan_port_attr_id	id,
		union nmf_vlan_port_attr_value *	attr
	)

Set a VLAN port's attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id (1-4095).
	port_no	The port number.
	id	The attribute identifier
	attr	Pointer to the attribute

Returns:

NMF_OK Success

-NMF_ENOENT Slot or VLAN id not found.

nmf_status_t nmf_vlan_port_list_get	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		nm_bv_t *	port_list
	)

Get the port membership list for a VLAN.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id (1-4095).
	port_list	The bit vector representing the port membership list

Returns:

NMF_OK Success

-NMF_ENOENT Slot or VLAN id not found.

nmf_status_t nmf_vlan_port_list_set	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		int	tagging,
		enum nmf_stp_state	stp_state,
		nm_bv_t *	port_list
	)

Set the port membership list for a VLAN.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id (1-4095).
	tagging	The tagging attribute to be assigned to all ports
	stp_state	The STP state to be assigned to all ports
	port_list	The bit vector representing the port membership list

Returns:

NMF_OK Success

-NMF_ENOENT Slot or VLAN id not found.

nmf_status_t nmf_vlan_port_rem	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id,
		int	port_num
	)

Remove a port from a VLAN.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id.
	port_num	The port number.

Returns:

NMF_OK Success

-NMF_ENOENT Slot or VLAN id not found.

nmf_status_t nmf_vlan_rem	(	nmf_client_t	clid,
		int	slot,
		int	vlan_id
	)

Remove a VLAN.

Parameters:

	clid	The client handle.
	slot	The slot number
	vlan_id	The VLAN id.

Returns:

NMF_OK Success

-NMF_ENOENT Slot not found.