Multicast Group Management

Functions
nmf_status_t	nmf_mcgrp_add (nmf_client_t clid, int slot, int *mcgrp_id, char *name)
	Create a Multicast Group.
nmf_status_t	nmf_mcgrp_rem (nmf_client_t clid, int slot, int mcgrp_id)
	Remove a Multicast Group.
nmf_status_t	nmf_mcgrp_list_get (nmf_client_t clid, int slot, nm_bv_t *mcgrp_list)
	Get the MCGRP defined for this switch.
nmf_status_t	nmf_mcgrp_port_add (nmf_client_t clid, int slot, int mcgrp_id, int port_num, short vlan_id)
	Add a port to a MCGRP.
nmf_status_t	nmf_mcgrp_port_rem (nmf_client_t clid, int slot, int mcgrp, int port_num, short vlan_id)
	Remove a port from a MCGRP.
nmf_status_t	nmf_mcgrp_port_list_get (nmf_client_t clid, int slot, int mcgrp_id, nm_bv_t *port_list)
	Get the port membership list for a MCGRP.
nmf_status_t	nmf_mcgrp_port_vlan_list_get (nmf_client_t clid, int slot, int mcgrp_id, int port, nm_bv_t *vlan_list)
	Get the VLAN membership list for a MCGRP port.
nmf_status_t	nmf_mcgrp_attr_set (nmf_client_t clid, int slot, int mcgrp_id, enum nmf_mcgrp_attr_id id, union nmf_mcgrp_attr_value *attr)
	Set the MCGRP attribute.
nmf_status_t	nmf_mcgrp_attr_get (nmf_client_t clid, int slot, int mcgrp_id, enum nmf_mcgrp_attr_id id, union nmf_mcgrp_attr_value *attr)
	Get the MCGRP attribute.

---

Function Documentation

nmf_status_t nmf_mcgrp_add	(	nmf_client_t	clid,
		int	slot,
		int *	mcgrp_id,
		char *	name
	)

Create a Multicast Group.

Create a Multicast port group. A multicast port group acts as a logical destination port for the purpose of packet forwarding. T

An ACL must be enabled in order to be active. A newly created rule as returned by this function is inactive. See the nmf_acl_enable() and nmf_acl_disable() functions.

If the specified ACL name already exists, the function returns -NMF_EINUSE and returns the associated nmf_id_t. This function can therefore be used to lookup an ACL by name.

Parameters:

	clid	The client handle.
	slot	The slot number
	mcgrp_id	Pointer to an nmf_id_t to receive the Mcast Group Id.
	name	A name to associate with the ACL.

Returns:

NMF_OK An ACL with the specified name was created. The ACL has no rules and is inactive.

-NMF_EEXIST An ACL with the specified name already exists. The associated nmf_id_t is returned in the acl_id parameter. Add a Multicast Group

Parameters:

	clid	The client handle.
	slot	The slot number
	*mcgrp_id	Pointer to an integer to receive the Multicast Group number
	name	Pointer to descriptive name for the Multicast Group

Returns:

NMF_OK Success

-NMF_ENOENT Slot not found.

nmf_status_t nmf_mcgrp_attr_get	(	nmf_client_t	clid,
		int	slot,
		int	mcgrp_id,
		enum nmf_mcgrp_attr_id	id,
		union nmf_mcgrp_attr_value *	attr
	)

Get the MCGRP attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	mcgrp_id	The MCGRP identifier.
	id	The attribute identifier
	attr	Pointer to the attribute value

Returns:

NMF_OK Success

-NMF_ENOENT Slot or MCGRP id not found.

nmf_status_t nmf_mcgrp_attr_set	(	nmf_client_t	clid,
		int	slot,
		int	mcgrp_id,
		enum nmf_mcgrp_attr_id	id,
		union nmf_mcgrp_attr_value *	attr
	)

Set the MCGRP attribute.

Parameters:

	clid	The client handle.
	slot	The slot number
	mcgrp_id	The MCGRP id.
	id	The attribute identifier
	attr	Pointer to the attribute value

Returns:

NMF_OK Success

-NMF_ENOENT Slot or MCGRP id not found.

nmf_status_t nmf_mcgrp_list_get	(	nmf_client_t	clid,
		int	slot,
		nm_bv_t *	mcgrp_list
	)

Get the MCGRP defined for this switch.

Parameters:

	clid	The client handle.
	slot	The slot number
	mcgrp_list	A bit vector representing the MCGRP list.

Returns:

NMF_OK Success

-NMF_ENOENT Slot not found.

nmf_status_t nmf_mcgrp_port_add	(	nmf_client_t	clid,
		int	slot,
		int	mcgrp_id,
		int	port_num,
		short	vlan_id
	)

Add a port to a MCGRP.

Parameters:

	clid	The client handle.
	slot	The slot number
	mcgrp_id	The MCGRP identifier.
	port_num	The port number.
	vlan_id	The VLAN Id.

Returns:

NMF_OK Success

-NMF_ENOENT Slot, MCGRP or VLAN not found.

-NMF_EINVAL Invalid port number.

nmf_status_t nmf_mcgrp_port_list_get	(	nmf_client_t	clid,
		int	slot,
		int	mcgrp_id,
		nm_bv_t *	port_list
	)

Get the port membership list for a MCGRP.

Parameters:

	clid	The client handle.
	slot	The slot number
	mcgrp_id	The MCGRP id.
	port_list	The bit vector representing the port membership list.

Returns:

NMF_OK Success

-NMF_ENOENT Slot not found.

nmf_status_t nmf_mcgrp_port_rem	(	nmf_client_t	clid,
		int	slot,
		int	mcgrp,
		int	port_num,
		short	vlan_id
	)

Remove a port from a MCGRP.

Parameters:

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

Returns:

NMF_OK Success

-NMF_ENOENT MCGRP does not exist or Port/VLAN is not present in the MCGRP

nmf_status_t nmf_mcgrp_port_vlan_list_get	(	nmf_client_t	clid,
		int	slot,
		int	mcgrp_id,
		int	port,
		nm_bv_t *	vlan_list
	)

Get the VLAN membership list for a MCGRP port.

Parameters:

	clid	The client handle.
	slot	The slot number
	mcgrp_id	The MCGRP id.
	port	The port number.
	vlan_list	The bit vector representing the VLAN membership list for the port

Returns:

NMF_OK Success

-NMF_ENOENT Slot not found.

nmf_status_t nmf_mcgrp_rem	(	nmf_client_t	clid,
		int	slot,
		int	mcgrp_id
	)

Remove a Multicast Group.

Parameters:

	clid	The client handle.
	slot	The slot number
	mcgrp_id	The MCGRP number to remove.

Returns:

NMF_OK Success

-NMF_ENOENT Slot not found.