Functions
sx_status_t	sx_api_vlan_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_vlan_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_vlan_ports_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_swid_t swid, const sx_vid_t vid, const sx_vlan_ports_t *vlan_port_list_p, const uint32_t port_cnt)

sx_status_t	sx_api_vlan_ports_get (const sx_api_handle_t handle, const sx_swid_t swid, const sx_vid_t vid, sx_vlan_ports_t vlan_port_list_p, uint32_t port_cnt_p)

sx_status_t	sx_api_vlan_port_multi_vlan_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_port_vlans_t *vlan_list_p, const uint32_t vlan_cnt)

sx_status_t	sx_api_vlan_port_prio_tagged_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_untagged_prio_state_t untagged_prio_state)

sx_status_t	sx_api_vlan_port_prio_tagged_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_untagged_prio_state_t *untagged_prio_state_p)

sx_status_t	sx_api_vlan_port_ingr_filter_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_ingr_filter_mode_t ingress_filter_mode)

sx_status_t	sx_api_vlan_port_ingr_filter_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_ingr_filter_mode_t *ingress_filter_mode_p)

sx_status_t	sx_api_vlan_port_pvid_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_vid_t pvid)

sx_status_t	sx_api_vlan_port_pvid_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_vid_t *pvid_p)

sx_status_t	sx_api_vlan_port_accptd_frm_types_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_vlan_frame_types_t *accptd_frm_types_p)

sx_status_t	sx_api_vlan_port_accptd_frm_types_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_vlan_frame_types_t *accptd_frm_types_p)

sx_status_t	sx_api_vlan_default_vid_set (const sx_api_handle_t handle, const sx_swid_t swid, const sx_vid_t vid)

sx_status_t	sx_api_vlan_default_vid_get (const sx_api_handle_t handle, const sx_swid_t swid, sx_vid_t *vid)

sx_status_t	sx_api_vlan_port_qinq_mode_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_qinq_mode_t qinq_mode)

sx_status_t	sx_api_vlan_port_qinq_mode_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_qinq_mode_t *qinq_mode_p)

sx_status_t	sx_api_vlan_port_qinq_outer_prio_mode_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_qinq_outer_prio_mode_t prio_mode)

sx_status_t	sx_api_vlan_port_qinq_outer_prio_mode_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_qinq_outer_prio_mode_t *prio_mode_p)

sx_status_t	sx_api_vlan_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_swid_t swid, sx_vlan_id_t vlan_list_p, uint32_t vlan_cnt_p)

sx_status_t	sx_api_vlan_get (const sx_api_handle_t handle, const sx_swid_t swid, sx_vlan_id_t vlan_list_p, uint32_t vlan_cnt_p)

sx_status_t	sx_api_vlan_attrib_set (const sx_api_handle_t handle, sx_vlan_id_t vid, const sx_vlan_attrib_t *vlan_attrib_p)

sx_status_t	sx_api_vlan_attrib_get (const sx_api_handle_t handle, sx_vlan_id_t vid, sx_vlan_attrib_t *vlan_attrib_p)

Function Documentation

◆ sx_api_vlan_log_verbosity_level_set()

sx_status_t sx_api_vlan_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 VLAN 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	- VLAN module verbosity level
[in]	api_verbosity_level	- VLAN 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_vlan_log_verbosity_level_get()

sx_status_t sx_api_vlan_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 VLAN 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	- VLAN module verbosity level
[out]	api_verbosity_level_p	- VLAN 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_vlan_ports_set()

sx_status_t sx_api_vlan_ports_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_swid_t	swid,
		const sx_vid_t	vid,
		const sx_vlan_ports_t *	vlan_port_list_p,
		const uint32_t	port_cnt
	)

This API sets the VLAN member ports. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

This function is only valid when in 802.1Q mode.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- ADD/DELETE/DELETE_ALL
[in]	swid	- virtual switch partition ID
[in]	vid	- VLAN ID
[in]	vlan_port_list_p	- a pointer to array of port list structure. Each port in the list has its logical port number and the egress filter mode (tagged/ untagged and priority tagged member). If DELETE_ALL command is used port_cnt = 0, vlan_port_list_p = NULL are applicable
[in]	port_cnt	- number of ports in a port list

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_CMD_UNSUPPORTED if unsupported command is requested; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_NO_MEMORY if problems with memory allocation occur; SX_STATUS_NO_RESOURCES if the pool cannot provide object; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_ports_get()

sx_status_t sx_api_vlan_ports_get	(	const sx_api_handle_t	handle,
		const sx_swid_t	swid,
		const sx_vid_t	vid,
		sx_vlan_ports_t *	vlan_port_list_p,
		uint32_t *	port_cnt_p
	)

This API retrieves the VLAN member ports. NOTE: If port_cnt_p is set as less than actual number of ports, the first port_cnt_p elements in array, and successful result are returned as output.

This function is only valid when in 802.1Q mode. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	swid	- virtual switch partition ID
[in]	vid	- VLAN ID
[in,out]	vlan_port_list_p	- a pointer to array of VLAN port list structure. If it is NULL, the port_cnt_p variable is filled out with numbers of ports that could be retrieved. If the pointer is valid, VLAN ports are placed there and port_cnt_p takes actual number ports in array.
[in,out]	port_cnt_p	- number of ports in a list that you want to retrieve

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_NO_MEMORY if problems with memory allocation occur; SX_STATUS_ERROR for a general error; SX_STATUS_CMD_UNSUPPORTED if 802.1D mode is enabled

◆ sx_api_vlan_port_multi_vlan_set()

sx_status_t sx_api_vlan_port_multi_vlan_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_port_vlans_t *	vlan_list_p,
		const uint32_t	vlan_cnt
	)

This API sets the VLANs list to a port in a single command. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

This function is only valid when in 802.1Q mode.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_ADD - add list of VLANs to port SX_ACCESS_CMD_DELETE - remove a list VLANs from port
[in]	log_port	- logical port
[in]	vlan_list_p	- pointer to a VLANs list
[in]	vlan_cnt	- size of VLANs list

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_CMD_UNSUPPORTED if command is not supported; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_NO_MEMORY if problems with memory allocation occur; SX_STATUS_NO_RESOURCES if the pool cannot provide object; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_port_prio_tagged_set()

sx_status_t sx_api_vlan_port_prio_tagged_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_untagged_prio_state_t	untagged_prio_state
	)

This API sets the priority tagged attribute per port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port
[in]	untagged_prio_state	- untagged packets are sent priority-tagged or not

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_NO_MEMORY if problems with memory allocation occur; SX_STATUS_NO_RESOURCES if the pool cannot provide object; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_port_prio_tagged_get()

sx_status_t sx_api_vlan_port_prio_tagged_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_untagged_prio_state_t *	untagged_prio_state_p
	)

This API retrieves the priority tagged attribute per port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port
[out]	untagged_prio_state_p	- untagged packets are sent priority-tagged or not

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_port_ingr_filter_set()

sx_status_t sx_api_vlan_port_ingr_filter_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_ingr_filter_mode_t	ingress_filter_mode
	)

This API enables/disables ingress VLAN filtering on a port The VLAN membership is defined in sx_vlan_ports_set API. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

This function is only valid when in 802.1Q mode.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port number
[in]	ingress_filter_mode	- port ingress VLAN filter mode (enable/disable)

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_CMD_UNSUPPORTED if unsupported access command is requested; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_NO_MEMORY if problems with memory allocation occur; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_port_ingr_filter_get()

sx_status_t sx_api_vlan_port_ingr_filter_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_ingr_filter_mode_t *	ingress_filter_mode_p
	)

This API retrieves ingress VLAN filtering on a port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

This function is only valid when in 802.1Q mode.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port number
[out]	ingress_filter_state_p	- a pointer to port ingress VLAN filter state (enable/disable)

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_PARAM_NULL if a parameter is NULL; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_ERROR for a general error; SX_STATUS_CMD_UNSUPPORTED if 802.1D mode is enabled

◆ sx_api_vlan_port_pvid_set()

sx_status_t sx_api_vlan_port_pvid_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_vid_t	pvid
	)

This API sets port's default VLAN ID. The PVID is set to untagged packets that ingress on the port. Note: When the PVID is deleted from the port, it is assigned with the default VLAN ID.

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- ADD/DELETE
[in]	log_port	- logical port number
[in]	pvid	- port VLAN ID

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_vlan_port_pvid_get()

sx_status_t sx_api_vlan_port_pvid_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_vid_t *	pvid_p
	)

This API retrieves port's default VLAN ID. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port number
[out]	pvid_p	- Port VLAN ID

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_port_accptd_frm_types_set()

sx_status_t sx_api_vlan_port_accptd_frm_types_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_vlan_frame_types_t *	accptd_frm_types_p
	)

This API sets a port's accepted frame types. Note: By default, all ports are configured to accept all frame types Note: Priority tagged packets are considered as untagged packets

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port number
[in]	accptd_frm_types_p	- struct holding the following values: allow_tagged, allow_untagged, allow_prio_tagged

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_port_accptd_frm_types_get()

sx_status_t sx_api_vlan_port_accptd_frm_types_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_vlan_frame_types_t *	accptd_frm_types_p
	)

This API retrieves a port's accepted frame types. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port number
[out]	accptd_frm_types_p	- a pointer to struct holding the following values: allow_tagged, allow_untagged, allow_prio_tagged

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_PARAM_NULL if a parameter is NULL; SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_default_vid_set()

sx_status_t sx_api_vlan_default_vid_set	(	const sx_api_handle_t	handle,
		const sx_swid_t	swid,
		const sx_vid_t	vid
	)

This API sets the virtual switch's default VLAN ID. This VID is set by default as the PVID of all switch ports. If not called, the default VID for all virtual switches is 1.

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	swid	- virtual switch partition ID
[in]	vid	- switch default VLAN ID

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_ACCESS_CMD_UNSUPPORTED if unsupported access command is requested; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_NO_MEMORY if problems with memory allocation occur; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_default_vid_get()

sx_status_t sx_api_vlan_default_vid_get	(	const sx_api_handle_t	handle,
		const sx_swid_t	swid,
		sx_vid_t *	vid
	)

This API gets the virtual switch's default VLAN ID. This VID is set by default as the PVID of all switch ports. If not called, the default VID for all virtual switches is 1.

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	swid	- virtual switch partition ID
[out]	vid	- switch default VLAN ID

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_PARAM_EXCEEDS_RANGE if parameter exceeds range.; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_NO_MEMORY if problems with memory allocation occur; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_ERROR for a general error; SX_STATUS_PARAM_NULL if parameter is NULL.

◆ sx_api_vlan_port_qinq_mode_set()

sx_status_t sx_api_vlan_port_qinq_mode_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_qinq_mode_t	qinq_mode
	)

This API sets Q-in-Q mode of port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

This function is only valid when in 802.1Q mode.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	qinq_mode	- mode: Q-in-Q enabled/disabled

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_INVALID_HANDLE if a NULL handle is received; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_ERROR for a general error; SX_STATUS_CMD_UNSUPPORTED if 802.1D mode is enabled

◆ sx_api_vlan_port_qinq_mode_get()

sx_status_t sx_api_vlan_port_qinq_mode_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_qinq_mode_t *	qinq_mode_p
	)

This API retrieves Q-in-Q mode of port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

This function is only valid when in 802.1Q mode.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	qinq_mode_p	- the retrieved mode

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_INVALID_HANDLE if a NULL handle is received; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_CMD_UNSUPPORTED if 802.1D mode is enabled; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_port_qinq_outer_prio_mode_set()

sx_status_t sx_api_vlan_port_qinq_outer_prio_mode_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_qinq_outer_prio_mode_t	prio_mode
	)

The API sets which priority should be taken for the outer tag (when Q-in-Q is enabled): The port's default priority, or the inner tag's priority.

This function is only valid when in 802.1Q mode. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	prio_mode	- mode: default/inner priority

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_INVALID_HANDLE if a NULL handle is received; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range; SX_STATUS_ENTRY_NOT_FOUND if a requested element is not found in DB; SX_STATUS_SXD_RETURNED_NON_ZERO if SxD driver function fails; SX_STATUS_CMD_UNSUPPORTED if 802.1D mode is enabled; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_port_qinq_outer_prio_mode_get()

sx_status_t sx_api_vlan_port_qinq_outer_prio_mode_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_qinq_outer_prio_mode_t *	prio_mode_p
	)

This API retrieves port's Q-in-Q outer tag priority mode. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

This function is only valid when in 802.1Q mode.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	prio_mode_p	- the retrieved mode

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_INVALID_HANDLE if handle is invalid; SX_STATUS_PARAM_ERROR if any input parameter is invalid; SX_STATUS_ENTRY_NOT_FOUND if requested element is not found in DB; SX_STATUS_CMD_UNSUPPORTED if 802.1D mode is enabled; SX_STATUS_ERROR for a general error

◆ sx_api_vlan_set()

sx_status_t sx_api_vlan_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_swid_t	swid,
		sx_vlan_id_t *	vlan_list_p,
		uint32_t *	vlan_cnt_p
	)

This API creates .1Q vlans. If NO_RESOURCES status is returned then the vlan_list_p will contain the vlans which were not added (number of which is donated by vlan_cnt_p). Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	- ADD/DELETE.
[in]	swid	- switch partition ID
[in]	vlan_list_p	- A list of .1Q vlans to add.
[in]	vlan_cnt_p	- The size of vlan_list_p array.

Returns: SX_STATUS_SUCCESS if operation completes successfully.; SX_STATUS_CMD_UNSUPPORTED if cmd is unsupported in this API.; SX_STATUS_NO_RESOURCES if all the .1Q vlans have been set.; SX_STATUS_PARAM_ERROR if vlan_list_p is NULL.

◆ sx_api_vlan_get()

sx_status_t sx_api_vlan_get	(	const sx_api_handle_t	handle,
		const sx_swid_t	swid,
		sx_vlan_id_t *	vlan_list_p,
		uint32_t *	vlan_cnt_p
	)

This API returns the list of .1Q vlans added to the swid. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	swid	- switch partition ID
[out]	vlan_list_p	- A list of .1Q vlans to add.
[in,out]	vlan_cnt_p	- The number of vlans to return. If vlan_cnt_p==0, Only the number of vlans will be returned and the list will remain empty.

Returns: SX_STATUS_SUCCESS if operation completes successfully.; SX_STATUS_PARAM_ERROR if vlan_list_p is NULL.

◆ sx_api_vlan_attrib_set()

sx_status_t sx_api_vlan_attrib_set	(	const sx_api_handle_t	handle,
		sx_vlan_id_t	vid,
		const sx_vlan_attrib_t *	vlan_attrib_p
	)

This API sets FID attributes. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	vid	- VLAN/FID to set.
[in]	vlan_attrib_p	- Structure containing the attributes

Returns: SX_STATUS_SUCCESS if operation completes successfully.; SX_STATUS_PARAM_ERROR if vlan_attrib_p is NULL.; SX_STATUS_ENTRY_NOT_FOUND if VLAN does not exist

◆ sx_api_vlan_attrib_get()

sx_status_t sx_api_vlan_attrib_get	(	const sx_api_handle_t	handle,
		sx_vlan_id_t	vid,
		sx_vlan_attrib_t *	vlan_attrib_p
	)

This API returns FID attributes. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	vid	- VLAN/FID to get.
[in]	vlan_attrib_p	- Structure containing the returned attributes

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if vlan_attrib_p is NULL.

SX_STATUS_ENTRY_NOT_FOUND if VLAN does not exist

Functions

Function Documentation

◆ sx_api_vlan_log_verbosity_level_set()

◆ sx_api_vlan_log_verbosity_level_get()

◆ sx_api_vlan_ports_set()

◆ sx_api_vlan_ports_get()

◆ sx_api_vlan_port_multi_vlan_set()

◆ sx_api_vlan_port_prio_tagged_set()

◆ sx_api_vlan_port_prio_tagged_get()

◆ sx_api_vlan_port_ingr_filter_set()

◆ sx_api_vlan_port_ingr_filter_get()

◆ sx_api_vlan_port_pvid_set()

◆ sx_api_vlan_port_pvid_get()

◆ sx_api_vlan_port_accptd_frm_types_set()

◆ sx_api_vlan_port_accptd_frm_types_get()

◆ sx_api_vlan_default_vid_set()

◆ sx_api_vlan_default_vid_get()

◆ sx_api_vlan_port_qinq_mode_set()

◆ sx_api_vlan_port_qinq_mode_get()

◆ sx_api_vlan_port_qinq_outer_prio_mode_set()

◆ sx_api_vlan_port_qinq_outer_prio_mode_get()

◆ sx_api_vlan_set()

◆ sx_api_vlan_get()

◆ sx_api_vlan_attrib_set()

◆ sx_api_vlan_attrib_get()