Data Structures
struct	OPEN_DOT1S_BRIDGEID_t
	DOT1S general bridge identifier formed by combining the bridge priority, instance identifier, and MAC address into an 8-octet hex value. More...

Macros
#define	OPEN_DOT1S_MAC_ID_LEN OPEN_MAC_ADDR_LEN

#define	OPEN_DOT1S_VID_MAC_ADDR_LEN (OPEN_DOT1S_VLAN_ID_LEN + OPEN_DOT1S_MAC_ID_LEN)

#define	OPEN_DOT1S_VLAN_ID_LEN 2

#define	OPENAPI_DOT1S_CST_ID 0

#define	OPENAPI_DOT1S_MSTID_MAX 4094

Enumerations
enum	OPEN_DOT1S_FORCE_VERSION_t { OPEN_DOT1S_FORCE_VERSION_DOT1D = 0, OPEN_DOT1S_FORCE_VERSION_UNUSED = 1, OPEN_DOT1S_FORCE_VERSION_DOT1W = 2, OPEN_DOT1S_FORCE_VERSION_DOT1S = 3, OPEN_DOT1S_FORCE_VERSION_LAST }

enum	OPEN_DOT1S_MGMT_STR_t { OPEN_DOT1S_MGMT_STR_CONFIG_NAME = 0 }

enum	OPEN_DOT1S_PORT_FWD_STATE_t { OPEN_DOT1S_PORT_DISCARDING = 1, OPEN_DOT1S_PORT_LEARNING = 2, OPEN_DOT1S_PORT_FORWARDING = 3, OPEN_DOT1S_PORT_DISABLED = 4, OPEN_DOT1S_PORT_MANUAL_FWD = 5, OPEN_DOT1S_PORT_NOT_PARTICIPATE = 6 }

enum	OPEN_DOT1S_PORT_GUARD_t { OPEN_DOT1S_PORT_GUARD_LOOP = 0, OPEN_DOT1S_PORT_GUARD_ROOT = 1, OPEN_DOT1S_PORT_GUARD_NONE = 2 }

enum	OPEN_DOT1S_PORT_ROLE_t { OPEN_DOT1S_ROLE_DISABLED = 0, OPEN_DOT1S_ROLE_ROOT = 1, OPEN_DOT1S_ROLE_DESIGNATED = 2, OPEN_DOT1S_ROLE_ALTERNATE = 3, OPEN_DOT1S_ROLE_BACKUP = 4, OPEN_DOT1S_ROLE_MASTER = 5 }

Functions
open_error_t	openapiDot1SBPDUFilterModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t dot1sBPDUFilter)
	Gets the Spanning Tree BPDU Filter Mode.

open_error_t	openapiDot1SBPDUFilterModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUFilter)
	Configures Spanning Tree BPDU Filter Mode.

open_error_t	openapiDot1SBPDUGuardModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t dot1sBPDUGuard)
	Gets the Spanning Tree BPDU Guard Mode.

open_error_t	openapiDot1SBPDUGuardModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUGuard)
	Configures Spanning Tree BPDU Guard Mode.

open_error_t	openapiDot1sBridgeMaxHopGet (openapiClientHandle_t client_handle, uint32_t count)
	Get the Max Hop count for the device.

open_error_t	openapiDot1sBridgeTxHoldCountGet (openapiClientHandle_t client_handle, uint32_t count)
	Get the Tx Hold count for the device.

open_error_t	openapiDot1sCISTBridgeHoldTimeGet (openapiClientHandle_t client_handle, uint32_t holdTime)
	Get the CIST Bridge Hold Time.

open_error_t	openapiDot1sCISTHelloTimeGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t helloTime)
	Get the CIST Hello Time of a specific port.

open_error_t	openapiDot1sCISTMaxAgeGet (openapiClientHandle_t client_handle, uint32_t age)
	Get the max age for the CIST.

open_error_t	openapiDot1sCISTRegionalRootIDGet (openapiClientHandle_t client_handle, OPEN_DOT1S_BRIDGEID_t rootId)
	Get the CIST Regional Root Identifier.

open_error_t	openapiDot1sCISTRegionalRootPathCostGet (openapiClientHandle_t client_handle, uint32_t cost)
	Get the CIST Regional Root Path Cost.

open_error_t	openapiDot1sCISTRootFwdDelayGet (openapiClientHandle_t client_handle, uint32_t delay)
	Get the CIST Bridge Forward Delay.

open_error_t	openapiDot1SConfigNameGet (openapiClientHandle_t client_handle, open_buffdesc dot1sConfigName)
	Gets the Spanning Tree Configuration Name.

open_error_t	openapiDot1SConfigNameSet (openapiClientHandle_t client_handle, open_buffdesc dot1sConfigName)
	Configures Spanning Tree Configuration Name.

open_error_t	openapiDot1SConfigRevisionGet (openapiClientHandle_t client_handle, uint32_t dot1sConfigRev)
	Gets the Spanning Tree Configuration Revision.

open_error_t	openapiDot1SConfigRevisionSet (openapiClientHandle_t *client_handle, uint32_t dot1sConfigRev)
	Configures Spanning Tree Configuration Revision.

open_error_t	openapiDot1SForceVersionGet (openapiClientHandle_t client_handle, OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion)
	Gets the Spanning Tree Force Revision.

open_error_t	openapiDot1SForceVersionSet (openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion)
	Configures Spanning Tree Force Revision.

open_error_t	openapiDot1SIntfBPDUFilterModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFilterMode)
	Gets Spanning Tree BPDU Filter mode for an interface.

open_error_t	openapiDot1SIntfBPDUFilterModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFilterMode)
	Configures Spanning Tree BPDU Filter mode for an interface.

open_error_t	openapiDot1SIntfBPDUFloodModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFloodMode)
	Gets Spanning Tree BPDU Flood mode for an interface.

open_error_t	openapiDot1SIntfBPDUFloodModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFloodMode)
	Configures Spanning Tree BPDU Flood mode for an interface.

open_error_t	openapiDot1SIntfEdgePortModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t dot1sEdgePortMode)
	Gets the Spanning Tree MST Port Administrative Edge Port mode of an interface for the CIST.

open_error_t	openapiDot1SIntfEdgePortModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sEdgePortMode)

open_error_t	openapiDot1SIntfGuardModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode)
	Gets Spanning Tree Guard mode.

open_error_t	openapiDot1SIntfGuardModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode)
	Configures Spanning Tree Guard mode.

open_error_t	openapiDot1SIntfModeGet (openapiClientHandle_t client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sMode)
	Gets Spanning Tree Admin Mode on an interface.

open_error_t	openapiDot1SIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sMode)
	Enables/Disables Spanning Tree Admin Mode on an interface.

open_error_t	openapiDot1SIntfPortFwdStateGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t dot1sInstance, OPEN_DOT1S_PORT_FWD_STATE_t dot1sPortFwdState)
	Gets Spanning Tree Port Forwarding State.

open_error_t	openapiDot1SIntfPortLoopInconsistentStateGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t dot1sInstance, OPEN_BOOL_t loopInconsistentState)
	Configures the Spanning Tree MST Port Administrative Edge Port mode of an interface for the CIST.

open_error_t	openapiDot1SIntfPortRoleGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t dot1sInstance, OPEN_DOT1S_PORT_ROLE_t dot1sPortRole)
	Gets Spanning Tree Port Role.

open_error_t	openapiDot1sMgmtStrLenGet (openapiClientHandle_t client_handle, OPEN_DOT1S_MGMT_STR_t strType, uint32_t strLen)
	Gets the Spanning Tree Management string length.

open_error_t	openapiDot1SModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t dot1sMode)
	Gets Spanning Tree Operational Mode.

open_error_t	openapiDot1SModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sMode)
	Enables/Disables Spanning Tree Operational Mode.

open_error_t	openapiDot1sMSTInstanceBridgeIdentifierGet (openapiClientHandle_t client_handle, uint32_t dot1sMSTInstance, OPEN_DOT1S_BRIDGEID_t id)
	Get the Spanning Tree MST Bridge Identifier for a specific instance.

open_error_t	openapiDot1sMSTInstanceDesignatedRootIDGet (openapiClientHandle_t client_handle, uint32_t dot1sMSTInstance, OPEN_DOT1S_BRIDGEID_t rootId)
	Get the Spanning Tree MST Designated Root Identifier in a specific instance.

open_error_t	openapiDot1SMSTInstanceFirstFIdGet (openapiClientHandle_t client_handle, uint32_t dot1sInstance, uint32_t FId)
	Gets First Forwarding Database Id for the Spanning Tree MST Instance.

open_error_t	openapiDot1SMSTInstanceFirstGet (openapiClientHandle_t client_handle, uint32_t instanceId)
	Gets First Spanning Tree MST Instance.

open_error_t	openapiDot1SMSTInstanceFirstVLANGet (openapiClientHandle_t client_handle, uint32_t dot1sInstance, uint32_t VLANId)
	Gets First VLAN Id for the Spanning Tree MST Instance.

open_error_t	openapiDot1SMSTInstanceNextFIdGet (openapiClientHandle_t client_handle, uint32_t dot1sInstance, uint32_t currFId, uint32_t nextFId)
	Gets Next Forwarding Database Id for the Spanning Tree MST Instance.

open_error_t	openapiDot1SMSTInstanceNextGet (openapiClientHandle_t client_handle, uint32_t currInstance, uint32_t nextInstance)
	Gets Next Spanning Tree MST Instance.

open_error_t	openapiDot1SMSTInstanceNextVLANGet (openapiClientHandle_t client_handle, uint32_t dot1sInstance, uint32_t currVLANId, uint32_t nextVLANId)
	Gets Next VLAN Id for the Spanning Tree MST Instance.

open_error_t	openapiDot1SMSTInstancePriorityGet (openapiClientHandle_t client_handle, uint32_t dot1sMSTInstance, uint16_t priority)
	Gets Spanning Tree MST Instance priority.

open_error_t	openapiDot1SMSTInstancePrioritySet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t priority)
	Configures Spanning Tree MST Instance priority.

open_error_t	openapiDot1sMSTInstanceRootPathCostGet (openapiClientHandle_t client_handle, uint32_t dot1sMSTInstance, uint32_t cost)
	Get the Spanning Tree MST Designated Root Path Cost for a specific instance.

open_error_t	openapiDot1sMSTInstanceRootPortIDGet (openapiClientHandle_t client_handle, uint32_t dot1sMSTInstance, uint32_t port)
	Get the Spanning Tree MST Root Port ID in a specific instance.

open_error_t	openapiDot1SMSTInstanceSet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstanceId, OPEN_ACTION_t action)
	Creates/Deletes Spanning Tree MST Instance.

open_error_t	openapiDot1sMSTInstanceTimeSinceTopologyChangeGet (openapiClientHandle_t client_handle, uint32_t dot1sMSTInstance, uint32_t timeVal)
	Get the Spanning Tree MST Time since the last Topology Change for a specific instance.

open_error_t	openapiDot1sMSTInstanceTopologyChangeCountGet (openapiClientHandle_t client_handle, uint32_t mstId, uint32_t count)
	Get the Spanning Tree MST count of Topology Changes in a specific instance.

open_error_t	openapiDot1sMSTInstanceTopologyChangeStateGet (openapiClientHandle_t client_handle, uint32_t dot1sMSTInstance, OPEN_BOOL_t change)
	Get if a toplogy change is in progress for any port assigned to the MST instance.

open_error_t	openapiDot1SMSTInstanceVLANSet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t vlan, OPEN_ACTION_t action)
	Adds/Deletes Spanning Tree MST Instance-VLAN association.

open_error_t	openapiDot1VlanMaxGet (openapiClientHandle_t client_handle, uint32_t vlanMax)
	Get the maximum number of Spanning Tree VLANs.

Detailed Description

Enumeration Type Documentation

enum OPEN_DOT1S_FORCE_VERSION_t

Enumerator:

OPEN_DOT1S_FORCE_VERSION_DOT1D	IEEE 802.1d Spanning Tree.
OPEN_DOT1S_FORCE_VERSION_UNUSED	unused
OPEN_DOT1S_FORCE_VERSION_DOT1W	IEEE 802.1w Rapid Spanning Tree.
OPEN_DOT1S_FORCE_VERSION_DOT1S	IEEE 802.1s Multiple Spanning Tree.
OPEN_DOT1S_FORCE_VERSION_LAST	must be last

Definition at line 43 of file openapi_dot1s.h.

enum OPEN_DOT1S_MGMT_STR_t

Enumerator:

OPEN_DOT1S_MGMT_STR_CONFIG_NAME

String type Configuration name.

Definition at line 59 of file openapi_dot1s.h.

enum OPEN_DOT1S_PORT_FWD_STATE_t

Enumerator:

OPEN_DOT1S_PORT_DISCARDING	Port state Discarding.
OPEN_DOT1S_PORT_LEARNING	Port state Learning.
OPEN_DOT1S_PORT_FORWARDING	Port state Forwarding.
OPEN_DOT1S_PORT_DISABLED	Port state Disabled.
OPEN_DOT1S_PORT_MANUAL_FWD	Port state Manual Forward.
OPEN_DOT1S_PORT_NOT_PARTICIPATE	Port state Not Participating.

Definition at line 64 of file openapi_dot1s.h.

enum OPEN_DOT1S_PORT_GUARD_t

Enumerator:

OPEN_DOT1S_PORT_GUARD_LOOP	Port Guard Loop.
OPEN_DOT1S_PORT_GUARD_ROOT	Port Guard Root.
OPEN_DOT1S_PORT_GUARD_NONE	Port Guard None.

Definition at line 52 of file openapi_dot1s.h.

enum OPEN_DOT1S_PORT_ROLE_t

Enumerator:

OPEN_DOT1S_ROLE_DISABLED	DisabledPort.
OPEN_DOT1S_ROLE_ROOT	RootPort.
OPEN_DOT1S_ROLE_DESIGNATED	DesignatedPort.
OPEN_DOT1S_ROLE_ALTERNATE	AlternatePort.
OPEN_DOT1S_ROLE_BACKUP	BackupPort.
OPEN_DOT1S_ROLE_MASTER	MasterPort.

Definition at line 74 of file openapi_dot1s.h.

Function Documentation

open_error_t openapiDot1SBPDUFilterModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	dot1sBPDUFilter
	)

Gets the Spanning Tree BPDU Filter Mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	dot1sBPDUFilter	spanning tree BPDU filter

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.7

open_error_t openapiDot1SBPDUFilterModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	dot1sBPDUFilter
	)

Configures Spanning Tree BPDU Filter Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sBPDUFilter	spanning tree BPDU filter

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiDot1SBPDUGuardModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	dot1sBPDUGuard
	)

Gets the Spanning Tree BPDU Guard Mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	dot1sBPDUGuard	spanning tree BPDU guard

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SBPDUGuardModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	dot1sBPDUGuard
	)

Configures Spanning Tree BPDU Guard Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sBPDUGuard	spanning tree BPDU guard

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1sBridgeMaxHopGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	count
	)

Get the Max Hop count for the device.

Parameters

[in]	client_handle	client handle from registration API
[out]	count	max hop count

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sBridgeTxHoldCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	count
	)

Get the Tx Hold count for the device.

Parameters

[in]	client_handle	client handle from registration API
[out]	count	Tx hold count

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sCISTBridgeHoldTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	holdTime
	)

Get the CIST Bridge Hold Time.

Parameters

[in]	client_handle	client handle from registration API
[out]	holdTime	hold time

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sCISTHelloTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	helloTime
	)

Get the CIST Hello Time of a specific port.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface number
[out]	helloTime	hello time

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sCISTMaxAgeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	age
	)

Get the max age for the CIST.

Parameters

[in]	client_handle	client handle from registration API
[out]	age	the current CIST max age

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sCISTRegionalRootIDGet	(	openapiClientHandle_t *	client_handle,
		OPEN_DOT1S_BRIDGEID_t *	rootId
	)

Get the CIST Regional Root Identifier.

Parameters

[in]	client_handle	client handle from registration API
[out]	rootId	regional root identifier

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sCISTRegionalRootPathCostGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	cost
	)

Get the CIST Regional Root Path Cost.

Parameters

[in]	client_handle	client handle from registration API
[out]	cost	regional root path cost

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sCISTRootFwdDelayGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	delay
	)

Get the CIST Bridge Forward Delay.

Parameters

[in]	client_handle	client handle from registration API
[out]	delay	forward delay for the CIST

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1SConfigNameGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	dot1sConfigName
	)

Gets the Spanning Tree Configuration Name.

Parameters

[in]	client_handle	client handle from registration API
[out]	dot1sConfigName	spanning tree configuration name

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Maximum size for dot1sConfigName is determined by calling openapiDot1sMgmtStrLenGet().

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SConfigNameSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	dot1sConfigName
	)

Configures Spanning Tree Configuration Name.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sConfigName	spanning tree configuration name

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

Note: Calling this API will change the running configuration of the switch; Maximum size for dot1sConfigName is determined by calling openapiDot1sMgmtStrLenGet().

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SConfigRevisionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	dot1sConfigRev
	)

Gets the Spanning Tree Configuration Revision.

Parameters

[in]	client_handle	client handle from registration API
[out]	dot1sConfigRev	spanning tree configuration revision

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SConfigRevisionSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sConfigRev
	)

Configures Spanning Tree Configuration Revision.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sConfigRev	spanning tree configuration revision
	-	Minimum value OPENAPI_DOT1S_MIN_REVISION_VALUE
	-	Maximum value OPENAPI_DOT1S_MAX_REVISION_VALUE

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SForceVersionGet	(	openapiClientHandle_t *	client_handle,
		OPEN_DOT1S_FORCE_VERSION_t *	dot1sForceVersion
	)

Gets the Spanning Tree Force Revision.

Parameters

[in]	client_handle	client handle from registration API
[out]	dot1sForceVersion	spanning tree force version

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SForceVersionSet	(	openapiClientHandle_t *	client_handle,
		OPEN_DOT1S_FORCE_VERSION_t	dot1sForceVersion
	)

Configures Spanning Tree Force Revision.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sForceVersion	spanning tree force version

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfBPDUFilterModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	dot1sBPDUFilterMode
	)

Gets Spanning Tree BPDU Filter mode for an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	dot1sBPDUFilterMode	spanning tree BPDU filter mode

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfBPDUFilterModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	dot1sBPDUFilterMode
	)

Configures Spanning Tree BPDU Filter mode for an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	dot1sBPDUFilterMode	spanning tree BPDU filter mode

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfBPDUFloodModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	dot1sBPDUFloodMode
	)

Gets Spanning Tree BPDU Flood mode for an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	dot1sBPDUFloodMode	spanning tree BPDU Flood mode

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfBPDUFloodModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	dot1sBPDUFloodMode
	)

Configures Spanning Tree BPDU Flood mode for an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	dot1sBPDUFloodMode	spanning tree BPDU Flood mode

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfEdgePortModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	dot1sEdgePortMode
	)

Gets the Spanning Tree MST Port Administrative Edge Port mode of an interface for the CIST.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	dot1sEdgePortMode	spanning tree edge port mode

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfEdgePortModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	dot1sEdgePortMode
	)

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	dot1sEdgePortMode	spanning tree edge port mode

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfGuardModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1S_PORT_GUARD_t *	dot1sGuardMode
	)

Gets Spanning Tree Guard mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	dot1sGuardMode	spanning tree Guard mode

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfGuardModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_DOT1S_PORT_GUARD_t	dot1sGuardMode
	)

Configures Spanning Tree Guard mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	dot1sGuardMode	spanning tree Guard mode

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	dot1sMode
	)

Gets Spanning Tree Admin Mode on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	dot1sMode	spanning tree admin mode

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	dot1sMode
	)

Enables/Disables Spanning Tree Admin Mode on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	dot1sMode	spanning tree mode

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfPortFwdStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	dot1sInstance,
		OPEN_DOT1S_PORT_FWD_STATE_t *	dot1sPortFwdState
	)

Gets Spanning Tree Port Forwarding State.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	dot1sInstance	spanning tree MST instance
[out]	dot1sPortFwdState	spanning tree port forwarding state

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfPortLoopInconsistentStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	dot1sInstance,
		OPEN_BOOL_t *	loopInconsistentState
	)

Configures the Spanning Tree MST Port Administrative Edge Port mode of an interface for the CIST.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	dot1sInstance	spanning tree MST instance
[out]	loopInconsistentState	loop inconsistent state (a boolean value)

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1SIntfPortRoleGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	dot1sInstance,
		OPEN_DOT1S_PORT_ROLE_t *	dot1sPortRole
	)

Gets Spanning Tree Port Role.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	dot1sInstance	spanning tree MST instance
[out]	dot1sPortRole	spanning tree port role

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1sMgmtStrLenGet	(	openapiClientHandle_t *	client_handle,
		OPEN_DOT1S_MGMT_STR_t	strType,
		uint32_t *	strLen
	)

Gets the Spanning Tree Management string length.

This length is used to allocate and initialize the open_buffdesc type argument buffers used by various DOT1S OpEN APIs.

Parameters

[in]	client_handle	client handle from registration API
[in]	strType	string type
[out]	strLen	string length

Return values

OPEN_E_NONE	String length Get successful.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	dot1sMode
	)

Gets Spanning Tree Operational Mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	dot1sMode	spanning tree operational mode

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	dot1sMode
	)

Enables/Disables Spanning Tree Operational Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMode	spanning tree operational mode

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1sMSTInstanceBridgeIdentifierGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		OPEN_DOT1S_BRIDGEID_t *	id
	)

Get the Spanning Tree MST Bridge Identifier for a specific instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_CST_ID
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]	id	bridge identifier

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note: Use a dot1sMSTInstance value of OPENAPI_DOT1S_CST_ID to access the CST instance instead of an MST instance.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sMSTInstanceDesignatedRootIDGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		OPEN_DOT1S_BRIDGEID_t *	rootId
	)

Get the Spanning Tree MST Designated Root Identifier in a specific instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_CST_ID
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]	rootId	designated root identifier

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note: Use a dot1sMSTInstance value of OPENAPI_DOT1S_CST_ID to access the CST instance instead of an MST instance.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstanceFirstFIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sInstance,
		uint32_t *	FId
	)

Gets First Forwarding Database Id for the Spanning Tree MST Instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sInstance	spanning tree MST instance
[out]	FId	Forwarding Database Id

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	no next VLAN found
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstanceFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	instanceId
	)

Gets First Spanning Tree MST Instance.

Parameters

[in]	client_handle	client handle from registration API
[out]	instanceId	first spanning tree MST instance Id

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	No next instance found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstanceFirstVLANGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sInstance,
		uint32_t *	VLANId
	)

Gets First VLAN Id for the Spanning Tree MST Instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sInstance	spanning tree MST instance
[out]	VLANId	VLAN Id

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	no next VLAN found
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstanceNextFIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sInstance,
		uint32_t	currFId,
		uint32_t *	nextFId
	)

Gets Next Forwarding Database Id for the Spanning Tree MST Instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sInstance	spanning tree MST instance
[in]	currFId	current Forwarding Database Id
[out]	nextFId	next Forwarding Database Id

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	no next VLAN found
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstanceNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	currInstance,
		uint32_t *	nextInstance
	)

Gets Next Spanning Tree MST Instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	currInstance	current spanning tree MST instance Id
[out]	nextInstance	next spanning tree MST instance Id

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	No next instance found.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstanceNextVLANGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sInstance,
		uint32_t	currVLANId,
		uint32_t *	nextVLANId
	)

Gets Next VLAN Id for the Spanning Tree MST Instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sInstance	spanning tree MST instance
[in]	currVLANId	current VLAN Id
[out]	nextVLANId	next VLAN Id

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	no next VLAN found
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstancePriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		uint16_t *	priority
	)

Gets Spanning Tree MST Instance priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
[out]	priority	instance priority

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstancePrioritySet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		uint32_t	priority
	)

Configures Spanning Tree MST Instance priority.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_MSTID_MIN
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[in]	priority	instance priority
	-	Minimum value OPENAPI_DOT1S_PRIORITY_MIN
	-	Maximum value OPENAPI_DOT1S_PRIORITY_MAX

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1sMSTInstanceRootPathCostGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		uint32_t *	cost
	)

Get the Spanning Tree MST Designated Root Path Cost for a specific instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_CST_ID
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]	cost	designated root path cost

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note: Use a dot1sMSTInstance value of OPENAPI_DOT1S_CST_ID to access the CST instance instead of an MST instance.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sMSTInstanceRootPortIDGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		uint32_t *	port
	)

Get the Spanning Tree MST Root Port ID in a specific instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_CST_ID
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]	port	port ID of the root port

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note: Use a dot1sMSTInstance value of OPENAPI_DOT1S_CST_ID to access the CST instance instead of an MST instance.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstanceSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstanceId,
		OPEN_ACTION_t	action
	)

Creates/Deletes Spanning Tree MST Instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstanceId	spanning tree MST instance Id
	-	Minimum value OPENAPI_DOT1S_MSTID_MIN
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[in]	action	create/delete instance

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1sMSTInstanceTimeSinceTopologyChangeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		uint32_t *	timeVal
	)

Get the Spanning Tree MST Time since the last Topology Change for a specific instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_CST_ID
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]	timeVal	time value, in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note: Use a dot1sMSTInstance value of OPENAPI_DOT1S_CST_ID to access the CST instance instead of an MST instance.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sMSTInstanceTopologyChangeCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	mstId,
		uint32_t *	count
	)

Get the Spanning Tree MST count of Topology Changes in a specific instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_CST_ID
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]	count	number of TCNs received

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note: Use a dot1sMSTInstance value of OPENAPI_DOT1S_CST_ID to access the CST instance instead of an MST instance.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1sMSTInstanceTopologyChangeStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		OPEN_BOOL_t *	change
	)

Get if a toplogy change is in progress for any port assigned to the MST instance.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_CST_ID
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]	change	OPEN_TRUE, a change in progress OPEN_FALSE, no change in progress.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note: Use a dot1sMSTInstance value of OPENAPI_DOT1S_CST_ID to access the CST instance instead of an MST instance.

OpEN API Version: 1.18

Examples:: dot1s_example.c.

open_error_t openapiDot1SMSTInstanceVLANSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	dot1sMSTInstance,
		uint32_t	vlan,
		OPEN_ACTION_t	action
	)

Adds/Deletes Spanning Tree MST Instance-VLAN association.

Parameters

[in]	client_handle	client handle from registration API
[in]	dot1sMSTInstance	spanning tree MST instance
	-	Minimum value OPENAPI_DOT1S_MSTID_MIN
	-	Maximum value OPENAPI_DOT1S_MSTID_MAX
[in]	vlan	VLAN
	-	Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID
	-	Maximum value openapiDot1VlanMaxGet()
[in]	action	create/delete association

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.

Note: Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:: dot1s_example.c.

open_error_t openapiDot1VlanMaxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	vlanMax
	)

Get the maximum number of Spanning Tree VLANs.

Parameters

[in]	client_handle	Client handle from registration API
[out]	vlanMax	Maximum VLAN

Return values

OPEN_E_NONE	if SNTP priority is returned successfully.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

Examples:: dot1s_example.c.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation