sx_api_mc_container.h File Reference

Go to the source code of this file.

Functions
sx_status_t	sx_api_mc_container_log_verbosity_level_set (const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, const sx_verbosity_level_t module_verbosity_level, const sx_verbosity_level_t api_verbosity_level)
sx_status_t	sx_api_mc_container_log_verbosity_level_get (const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, sx_verbosity_level_t *module_verbosity_level_p, sx_verbosity_level_t *api_verbosity_level_p)
sx_status_t	sx_api_mc_container_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, sx_mc_container_id_t *container_id_p, const sx_mc_next_hop_t *next_hop_list_p, const uint32_t next_hop_cnt, const sx_mc_container_attributes_t *container_attr_p)
sx_status_t	sx_api_mc_container_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, sx_mc_container_id_t container_id, sx_mc_next_hop_t *next_hop_list_p, uint32_t *next_hop_cnt_p, sx_mc_container_attributes_t *container_attr_p)
sx_status_t	sx_api_mc_container_iter_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_mc_container_id_t container_id_key, sx_mc_container_id_filter_t *container_id_filter_p, sx_mc_container_id_t *container_id_list_p, uint32_t *container_id_cnt_p)

Function Documentation

sx_api_mc_container_log_verbosity_level_set()

sx_status_t sx_api_mc_container_log_verbosity_level_set	(	const sx_api_handle_t	handle,
		const sx_log_verbosity_target_t	verbosity_target,
		const sx_verbosity_level_t	module_verbosity_level,
		const sx_verbosity_level_t	api_verbosity_level
	)

Sets the log verbosity level of MC_CONTAINER MODULE. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- set verbosity of : API / MODULE / BOTH
[in]	module_verbosity_level	- MC_CONTAINER module verbosity level
[in]	api_verbosity_level	- MC_CONTAINER API verbosity level

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_ERROR for a general error

sx_api_mc_container_log_verbosity_level_get()

sx_status_t sx_api_mc_container_log_verbosity_level_get	(	const sx_api_handle_t	handle,
		const sx_log_verbosity_target_t	verbosity_target,
		sx_verbosity_level_t *	module_verbosity_level_p,
		sx_verbosity_level_t *	api_verbosity_level_p
	)

Gets the log verbosity level of MC_CONTAINER MODULE. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- get verbosity of : API / MODULE / BOTH
[out]	module_verbosity_level_p	- MC_CONTAINER module verbosity level
[out]	api_verbosity_level_p	- MC_CONTAINER API verbosity level

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_ERROR for a general error

sx_api_mc_container_set()

sx_status_t sx_api_mc_container_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		sx_mc_container_id_t *	container_id_p,
		const sx_mc_next_hop_t *	next_hop_list_p,
		const uint32_t	next_hop_cnt,
		const sx_mc_container_attributes_t *	container_attr_p
	)

Manipulate a multicast container Command CREATE creates a new container with the specified list of next_hops_cnt next hops in next_hop_list_p, and returns its new container ID in container_id_p. Commands ADD and DELETE add or delete the next hops specified by next_hop_list_p and next_hop_cnt to/from an existing container specified by container_id_p. Command SET replaces the contents of an existing container specified by container_id_p, with the specified list of next hops in next_hop_list_p. Command DESTROY deletes an existing container specified by container_id_p. Command DELETE_ALL deletes all existing containers. Notes: A container in use (e.g. by a multicast route or ACL) cannot be destroyed A container may contain at most RM_API_ROUTER_RIFS_MAX next hops

Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	- CREATE/ADD/DELETE/SET/DESTROY/DELETE_ALL.
[in,out]	container_id_p	- Specifies or returns the container ID
[in]	next_hop_list_p	- Specifies the list of next hops for the container
[in]	next_hop_cnt	- Specifies the amount of next hops in next_hop_list_p
[in]	container_attr_p	- Specifies the container attributes

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if any input parameter is invalid.

SX_STATUS_ENTRY_NOT_FOUND if specified container ID does not exist.

SX_STATUS_NO_RESOURCES if there are no resources for the operation.

SX_STATUS_RESOURCE_IN_USE if group is in use and cannot be destroyed.

sx_api_mc_container_get()

sx_status_t sx_api_mc_container_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		sx_mc_container_id_t	container_id,
		sx_mc_next_hop_t *	next_hop_list_p,
		uint32_t *	next_hop_cnt_p,
		sx_mc_container_attributes_t *	container_attr_p
	)

Retrieve information about a multicast container Command GET retrieves information about the container specified by container_id_p. Command GETFIRST retrieves the first container, its ID, next hops and attributes. Command GETNEXT retrieves the next container after container_id_p, its ID, next hops and attributes. Command COUNT returns the number of existing containers, in *next_hop_cnt Notes: *next_hop_cnt should contain the maximum amount of next hops to retrieve. If next_hop_list_p is NULL, then next hops are not retrieved at all. If *next_hop_cnt is 0, or if next_hop_list_p is NULL, then the amount of next hops is returned in *next_hop_cnt If container_attr is NULL, then attributes are not retrieved.

Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	- GET
[in]	container_id	- Specifies a container ID whose attributes to retrieve
[out]	next_hop_list_p	- Returns the list of next hops in the container
[in,out]	next_hop_cnt_p	- Specifies the maximum amount of next hops to retrieve, and returns the amount of next hops retrieved
[out]	container_attr_p	- Returns the container attributes

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_CMD_UNSUPPORTED if access command isn't supported.

SX_STATUS_PARAM_ERROR if any input parameter is invalid.

SX_STATUS_ENTRY_NOT_FOUND if specified container does not exist, or no more containers.

sx_api_mc_container_iter_get()

sx_status_t sx_api_mc_container_iter_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_mc_container_id_t	container_id_key,
		sx_mc_container_id_filter_t *	container_id_filter_p,
		sx_mc_container_id_t *	container_id_list_p,
		uint32_t *	container_id_cnt_p
	)

This function retrieves a list of MC Containers. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	GET/GET_NEXT/GET_FIRST.
[in]	container_id_key	- Container ID to use as key.
[in]	container_filter_p	- Filter to use (not supported yet).
[out]	container_id_list_p	- pointer to the list of Container IDs returned.
[in,out]	container_id_cnt_p	[in] number of entries to retrieve; [out] retrieved number of entries.

The following use case scenarios apply with different input parameters X = don't-care

• 1) cmd = SX_ACCESS_CMD_GET, key = X, Filter = X, list = X, Count = 0: In this case the API will return the total number of containers in the Internal DB
• 2) cmd = SX_ACCESS_CMD_GET, key = valid/invalid, Filter = X, list = Valid, Count = 1: In this case the API will check if the specified key exists. if it does the key will be returned in the list along with a count of 1. If the key does not exist an empty list will be returned with count = 0
• 3) cmd = SX_ACCESS_CMD_GET, key = valid, Filter = X, list is Valid, Count > 1: A count >1 will be treated as a count of 1 and the behaviour will be same as earlier GET use cases.
• 5) cmd = SX_ACCESS_CMD_GET_FIRST/SX_ACCESS_CMD_GETNEXT, key = X, Filter = X, list = Null, Count = 0: For either SX_ACCESS_CMD_GET_FIRST/SX_ACCESS_CMD_GETNEXT a zero count will return an empty list.
• 6) cmd = SX_ACCESS_CMD_GET_FIRST, key = X, Filter = X, list = Valid, Count > 0: In this case the API will return the first Container IDs starting from the head of the database. The total elements fetched will be returned as the return count. Note: return count may be less than or equal to the requested count. The key is dont-care but a non-Null return list pointer must be provided
• 7) cmd = SX_ACCESS_CMD_GETNEXT, key = valid/invalid, Filter = X, list = Valid, Count > 0: In this case the API will return the next set of IDs starting from the next valid container after the specified key. The total elements fetched will be returned as the return count. Note: return count may be less than or equal to the requested count. If no valid next counter exists in the DB (key = end of list, or invalid key specified, or key too large), an empty list will be returned.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if parameter is invalid.

SX_STATUS_CMD_UNSUPPORTED if command is not supported.

SX_STATUS_INVALID_HANDLE if handle is invalid.

SX_STATUS_ERROR general error.