sx_api_topo.h File Reference

Go to the source code of this file.

Functions
sx_status_t	sx_api_topo_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_topo_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_topo_device_set (IN sx_api_handle_t handle, IN sx_access_cmd_t cmd, IN sx_topolib_dev_info_t *dev_info)
sx_status_t	sx_api_topo_device_dump (sx_api_handle_t handle, sx_access_cmd_t cmd, sx_topo_lib_dump_db_info_t *dump_info)
sx_status_t	sx_api_topo_tree_dump (sx_api_handle_t handle, sx_access_cmd_t cmd, sx_topo_lib_dump_db_info_t *dump_info)
sx_status_t	sx_api_topo_tree_set (IN sx_api_handle_t handle, IN sx_access_cmd_t cmd, INOUT sx_topo_lib_tree_t *tree)
sx_status_t	sx_api_topo_unicast_reload_balance (IN sx_api_handle_t handle, IN sx_tree_hndl_t tree, IN sx_port_log_id_t log_port)
sx_status_t	sx_api_topo_mc_tree_group_set (IN sx_api_handle_t handle, IN sx_access_cmd_t cmd, INOUT sx_mc_tree_group_id_t *mc_tree_group_id)
sx_status_t	sx_api_topo_mc_tree_group_dev_set (IN sx_api_handle_t handle, IN sx_access_cmd_t cmd, IN sx_mc_tree_group_hndl_t old_tree_group, IN sx_mc_tree_group_hndl_t new_tree_group, IN sx_dev_id_t dev_id)
sx_status_t	sx_api_topo_mc_tree_group_tree_set (IN sx_api_handle_t handle, IN sx_access_cmd_t cmd, IN sx_mc_tree_group_hndl_t tree_group, IN sx_tree_hndl_t tree)
sx_status_t	sx_api_topo_mc_reload_balance (IN sx_api_handle_t handle, IN sx_mc_tree_group_hndl_t mc_tree_group_id)

Function Documentation

sx_api_topo_log_verbosity_level_set()

sx_status_t sx_api_topo_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
	)

This function sets the log verbosity level of TOPOLOGY 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	- TOPOLOGY module verbosity level
[in]	api_verbosity_level	- TOPOLOGY API verbosity level

Returns

SX_STATUS_SUCCESS if operation completes successfully SX_STATUS_PARAM_ERROR if any input parameters is invalid SX_STATUS_ERROR general error

sx_api_topo_log_verbosity_level_get()

sx_status_t sx_api_topo_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
	)

This function gets the log verbosity level of TOPOLOGY 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	- TOPOLOGY module verbosity level
[out]	api_verbosity_level_p	- TOPOLOGY API verbosity level

Returns

SX_STATUS_SUCCESS if operation completes successfully SX_STATUS_PARAM_ERROR if any input parameters is invalid SX_STATUS_ERROR general error

sx_api_topo_device_set()

sx_status_t sx_api_topo_device_set	(	IN sx_api_handle_t	handle,
		IN sx_access_cmd_t	cmd,
		IN sx_topolib_dev_info_t *	dev_info
	)

This function sets the device s. Each device that is introduced to the system must be configured to the topology library. This API maintains a database that is used by other libraries to receive a device irrelevant for configuration

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- ADD a new device to topo lib the DELETE delete device from topo lib note that the device should be removed from all forwarding tree prior to that operation change unicast/multicast/flood_tree_hndl_arr; READY device is ready we can route traffic from/to /via this device please note that trees(unicast/multicast/flood_ must be configured with the new device
[in]	dev_info	- pointer to device info to set

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error

SX_STATUS_PARAM_NULL if null pointer is given

sx_api_topo_device_dump()

sx_status_t sx_api_topo_device_dump	(	sx_api_handle_t	handle,
		sx_access_cmd_t	cmd,
		sx_topo_lib_dump_db_info_t *	dump_info
	)

This function prints device topology information into the debug output Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- GET_ALL - dump the topo tree
[in]	dump_info	- pointer to dump info

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error

SX_STATUS_PARAM_NULL if null parameter is given

sx_api_topo_tree_dump()

sx_status_t sx_api_topo_tree_dump	(	sx_api_handle_t	handle,
		sx_access_cmd_t	cmd,
		sx_topo_lib_dump_db_info_t *	dump_info
	)

This function prints topology tree to the debug output Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- GET_ALL - dump the topo tree
[in]	dump_info	- pointer to dump info

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error

SX_STATUS_PARAM_NULL if null pointer is given

sx_api_topo_tree_set()

sx_status_t sx_api_topo_tree_set	(	IN sx_api_handle_t	handle,
		IN sx_access_cmd_t	cmd,
		INOUT sx_topo_lib_tree_t *	tree
	)

This function sets forwarding tree . Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- ADD add new tree DIT -add leaf to existing tree DELETE-remove tree
[in]	sx_topo_lib_tree_t	-
[in,out]	len_p	- In: Pointer to the input array's length Out: Pointer to the # of updated entries

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error

SX_STATUS_CMD_UNSUPPORTED if invalid access command used

SX_STATUS_MEMORY_ERROR if there's not enough memory

sx_api_topo_unicast_reload_balance()

sx_status_t sx_api_topo_unicast_reload_balance	(	IN sx_api_handle_t	handle,
		IN sx_tree_hndl_t	tree,
		IN sx_port_log_id_t	log_port
	)

This function reload balance unicast traffic Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle [in] tree- all ports that forward traffic via "tree" should replace (chose another tree) possible value specific tree handle/ALL_TREE [in] log_port- rebalance this port possible value port/ALL_PORT
[in,out]	mc_id_p	- Pointer to a Multicast ID

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error

sx_api_topo_mc_tree_group_set()

sx_status_t sx_api_topo_mc_tree_group_set	(	IN sx_api_handle_t	handle,
		IN sx_access_cmd_t	cmd,
		INOUT sx_mc_tree_group_id_t *	mc_tree_group_id
	)

This function sets multicast tree group tree group is a group of devices that tag ingress packet with the same MID (multicast ID) Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- CREATE-create a new multicast tree group DELETE-delete multicast tree group please note that the should be empty GET-get multicast tree group parameters
[in]	sx_topo_lib_tree_t	-
[in,out]	len_p	- In: Pointer to the input array's length Out: Pointer to the # of updated entries

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error

sx_api_topo_mc_tree_group_dev_set()

sx_status_t sx_api_topo_mc_tree_group_dev_set	(	IN sx_api_handle_t	handle,
		IN sx_access_cmd_t	cmd,
		IN sx_mc_tree_group_hndl_t	old_tree_group,
		IN sx_mc_tree_group_hndl_t	new_tree_group,
		IN sx_dev_id_t	dev_id
	)

This function add/remove devices form tree group tree group is a group of devices that tag ingress packet with the same MID (multicast ID) Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- ADD/REMOVE MOVE-migrate device form one multicast tree group to another
[in]	old_tree_group	-valid only for cmd MOVE the tree group to migrate from
[in]	new_tree_group	-
[in]	dev_id

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error

sx_api_topo_mc_tree_group_tree_set()

sx_status_t sx_api_topo_mc_tree_group_tree_set	(	IN sx_api_handle_t	handle,
		IN sx_access_cmd_t	cmd,
		IN sx_mc_tree_group_hndl_t	tree_group,
		IN sx_tree_hndl_t	tree
	)

This function add/remove forwarding tree form mc tree group Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	-ADD/REMOVE
[in]	tree_group	- multicast tree group
[in]	tree	forwarding tree

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error

sx_api_topo_mc_reload_balance()

sx_status_t sx_api_topo_mc_reload_balance	(	IN sx_api_handle_t	handle,
		IN sx_mc_tree_group_hndl_t	mc_tree_group_id
	)

This function reload balance multicast traffic Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]

handle

- SX-API handle [in] tree- reload balance all multicast that forward traffic via mc_tree_group_id value "specific tree group handle"/ALL_TREE_GROUP

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameters is invalid

SX_STATUS_ERROR general error