Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Macros | Enumerations | Functions
Spanning Tree Configuration And Status [OPENAPI_DOT1S]

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. More...
 
open_error_t openapiDot1SBPDUFilterModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUFilter)
 Configures Spanning Tree BPDU Filter Mode. More...
 
open_error_t openapiDot1SBPDUGuardModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sBPDUGuard)
 Gets the Spanning Tree BPDU Guard Mode. More...
 
open_error_t openapiDot1SBPDUGuardModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUGuard)
 Configures Spanning Tree BPDU Guard Mode. More...
 
open_error_t openapiDot1sBridgeMaxHopGet (openapiClientHandle_t *client_handle, uint32_t *count)
 Get the Max Hop count for the device. More...
 
open_error_t openapiDot1sBridgeTxHoldCountGet (openapiClientHandle_t *client_handle, uint32_t *count)
 Get the Tx Hold count for the device. More...
 
open_error_t openapiDot1sCISTBridgeHoldTimeGet (openapiClientHandle_t *client_handle, uint32_t *holdTime)
 Get the CIST Bridge Hold Time. More...
 
open_error_t openapiDot1SCistExtPortPathCostGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *portCost)
 Gets the CIST External Port Path Cost on an interface. More...
 
open_error_t openapiDot1SCistExtPortPathCostModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *costMode)
 Gets the CIST External Port Path Cost Mode on an interface. More...
 
open_error_t openapiDot1SCistExtPortPathCostSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t portCost)
 Sets the CIST External Port Path Cost on an interface. More...
 
open_error_t openapiDot1sCISTHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *helloTime)
 Get the CIST Hello Time of a specific port. More...
 
open_error_t openapiDot1SCistHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t *helloTime)
 Gets the MSTP Root Port HelloTime paramter for the CIST. More...
 
open_error_t openapiDot1sCISTMaxAgeGet (openapiClientHandle_t *client_handle, uint32_t *age)
 Get the max age for the CIST. More...
 
open_error_t openapiDot1SCistPortOperEdgeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
 Gets the CIST Operational Edge Port parameter of a specific port. More...
 
open_error_t openapiDot1SCistPortOperPointToPointGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
 Gets the CIST Operational Point to Point Mac parameter of a specific port. More...
 
open_error_t openapiDot1SCistPortPathCostGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *portCost)
 Gets the CIST port path cost. More...
 
open_error_t openapiDot1SCistPortRegionalRootIDGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *bridgeID)
 Gets the CIST Regional Root Bridge Identifier for a particular interface. More...
 
open_error_t openapiDot1SCistPortTopologyChangeAckGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *val)
 Gets the CIST Topology Change Acknowledge parameter for a specific port in the CIST. More...
 
open_error_t openapiDot1sCISTRegionalRootIDGet (openapiClientHandle_t *client_handle, OPEN_DOT1S_BRIDGEID_t *rootId)
 Get the CIST Regional Root Identifier. More...
 
open_error_t openapiDot1sCISTRegionalRootPathCostGet (openapiClientHandle_t *client_handle, uint32_t *cost)
 Get the CIST Regional Root Path Cost. More...
 
open_error_t openapiDot1sCISTRootFwdDelayGet (openapiClientHandle_t *client_handle, uint32_t *delay)
 Get the CIST Bridge Forward Delay. More...
 
open_error_t openapiDot1SConfigNameGet (openapiClientHandle_t *client_handle, open_buffdesc *dot1sConfigName)
 Gets the Spanning Tree Configuration Name. More...
 
open_error_t openapiDot1SConfigNameSet (openapiClientHandle_t *client_handle, open_buffdesc *dot1sConfigName)
 Configures Spanning Tree Configuration Name. More...
 
open_error_t openapiDot1SConfigRevisionGet (openapiClientHandle_t *client_handle, uint32_t *dot1sConfigRev)
 Gets the Spanning Tree Configuration Revision. More...
 
open_error_t openapiDot1SConfigRevisionSet (openapiClientHandle_t *client_handle, uint32_t dot1sConfigRev)
 Configures Spanning Tree Configuration Revision. More...
 
open_error_t openapiDot1SForceVersionGet (openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t *dot1sForceVersion)
 Gets the Spanning Tree Force Revision. More...
 
open_error_t openapiDot1SForceVersionSet (openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion)
 Configures Spanning Tree Force Revision. More...
 
open_error_t openapiDot1SIntfBPDUFilterModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sBPDUFilterMode)
 Gets Spanning Tree BPDU Filter mode for an interface. More...
 
open_error_t openapiDot1SIntfBPDUFilterModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFilterMode)
 Configures Spanning Tree BPDU Filter mode for an interface. More...
 
open_error_t openapiDot1SIntfBPDUFloodModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sBPDUFloodMode)
 Gets Spanning Tree BPDU Flood mode for an interface. More...
 
open_error_t openapiDot1SIntfBPDUFloodModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFloodMode)
 Configures Spanning Tree BPDU Flood mode for an interface. More...
 
open_error_t openapiDot1SIntfBPDUGuardEffectGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
 Gets the MSTP BPDU guard effect of an interface for the CIST. More...
 
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. More...
 
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. More...
 
open_error_t openapiDot1SIntfGuardModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode)
 Configures Spanning Tree Guard mode. More...
 
open_error_t openapiDot1SIntfHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *helloTime)
 Gets the MSTP Hello time of an interface for the CIST. More...
 
open_error_t openapiDot1SIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sMode)
 Gets Spanning Tree Admin Mode on an interface. More...
 
open_error_t openapiDot1SIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sMode)
 Enables/Disables Spanning Tree Admin Mode on an interface. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiDot1sMgmtStrLenGet (openapiClientHandle_t *client_handle, OPEN_DOT1S_MGMT_STR_t strType, uint32_t *strLen)
 Gets the Spanning Tree Management string length. More...
 
open_error_t openapiDot1SModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sMode)
 Gets Spanning Tree Operational Mode. More...
 
open_error_t openapiDot1SModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sMode)
 Enables/Disables Spanning Tree Operational Mode. More...
 
open_error_t openapiDot1SMstiDesignatedBridgeIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, open_buffdesc *bridgeID)
 Get the MSTP Designated Bridge Identifier in a specific instance for a particular interface. More...
 
open_error_t openapiDot1SMstiDesignatedCostGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *dCost)
 Get the MSTP Designated Bridge cost in a specific instance for a particular interface. More...
 
open_error_t openapiDot1SMstiDesignatedPortIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, open_buffdesc *portID)
 Gets the MSTP Designated Port Identifier in a specific instance for a particular interface. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiDot1SMSTInstanceFirstGet (openapiClientHandle_t *client_handle, uint32_t *instanceId)
 Gets First Spanning Tree MST Instance. More...
 
open_error_t openapiDot1SMSTInstanceFirstVLANGet (openapiClientHandle_t *client_handle, uint32_t dot1sInstance, uint32_t *VLANId)
 Gets First VLAN Id for the Spanning Tree MST Instance. More...
 
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. More...
 
open_error_t openapiDot1SMSTInstanceNextGet (openapiClientHandle_t *client_handle, uint32_t currInstance, uint32_t *nextInstance)
 Gets Next Spanning Tree MST Instance. More...
 
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. More...
 
open_error_t openapiDot1SMSTInstancePriorityGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint16_t *priority)
 Gets Spanning Tree MST Instance priority. More...
 
open_error_t openapiDot1SMSTInstancePrioritySet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t priority)
 Configures Spanning Tree MST Instance priority. More...
 
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. More...
 
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. More...
 
open_error_t openapiDot1SMSTInstanceSet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstanceId, OPEN_ACTION_t action)
 Creates/Deletes Spanning Tree MST Instance. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiDot1SMSTIntfPortIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, open_buffdesc *portID)
 Get the MSTP Port Identifier of a specific port in a specific instance. More...
 
open_error_t openapiDot1SMstiOperPortPathCostGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *portCost)
 Gets the MSTP operational Port Path Cost in a specific instance. More...
 
open_error_t openapiDot1SMstiPortDesignatedRootIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, open_buffdesc *rootID)
 Get the Spanning Tree MST Instance Designated Root Bridge Identifier on a interface. More...
 
open_error_t openapiDot1SMstiPortLoopInconsistentStateGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, OPEN_BOOL_t *status)
 Gets the MSTP Instance Loop Inconsistent State on an interface. More...
 
open_error_t openapiDot1SMstiPortPathCostModeGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, OPEN_CONTROL_t *costMode)
 Get the MSTP Port Path Cost Mode in a specific instance. More...
 
open_error_t openapiDot1SMstiPortPathCostSet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t pCost)
 Set the MSTP Port Path Cost Mode in a specific instance. More...
 
open_error_t openapiDot1SMstiPortPriorityGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *priority)
 Get the MSTP Port Priority in a specific instance. More...
 
open_error_t openapiDot1SMstiPortPrioritySet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t priority)
 Set the MSTP Port Priority in a specific instance. More...
 
open_error_t openapiDot1SPortAutoEdgeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mode)
 Gets the MSTP Administrative Auto Edge Port parameter of a specific port. More...
 
open_error_t openapiDot1SPortAutoEdgeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mode)
 Set the MSTP Administrative Auto Edge Port parameter of a specific port. More...
 
open_error_t openapiDot1SPortRestrictedTcnGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mode)
 Gets the MSTP Administrative Restricted Tcn parameter of a specific port. More...
 
open_error_t openapiDot1SPortRestrictedTcnSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t val)
 Set the MSTP Administrative Restricted Tcn parameter of a specific port. More...
 
open_error_t openapiDot1SPortStatsClear (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Clears the port stats. More...
 
open_error_t openapiDot1SPortStatsMSTPBPDUsReceivedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for MSTP BPDUs Received on a specific port. More...
 
open_error_t openapiDot1SPortStatsMSTPBPDUsSentGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for MSTP BPDUs Sent on a specific port. More...
 
open_error_t openapiDot1SPortStatsRSTPBPDUsReceivedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for RSTP BPDUs Received on a specific port. More...
 
open_error_t openapiDot1SPortStatsRSTPBPDUsSentGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for RSTP BPDUs Sent on a specific port. More...
 
open_error_t openapiDot1SPortStatsSTPBPDUsReceivedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for STP BPDUs Received on a specific port. More...
 
open_error_t openapiDot1SPortStatsSTPBPDUsSentGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for STP BPDUs Sent on a specific port. More...
 
open_error_t openapiDot1SPortStatsTransitionsIntoLoopInconsistentStateGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *loopCount)
 Gets the MSTP Statistics for the number of times this interface has transitioned into loop inconsistent state. More...
 
open_error_t openapiDot1SPortStatsTransitionsOutOfLoopInconsistentStateGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *loopCount)
 Gets the MSTP Statistics for the number of times this interface has transitioned out of loop inconsistent state. More...
 
open_error_t openapiDot1SPortUpTimeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *upTime)
 Gets the MSTP Up Time of the port. More...
 
open_error_t openapiDot1VlanMaxGet (openapiClientHandle_t *client_handle, uint32_t *vlanMax)
 Get the maximum number of Spanning Tree VLANs. More...
 

Detailed Description

Enumeration Type Documentation

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.

Enumerator
OPEN_DOT1S_MGMT_STR_CONFIG_NAME 

String type Configuration name.

Definition at line 59 of file openapi_dot1s.h.

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.

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.

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_handleclient handle from registration API
[out]dot1sBPDUFilterspanning tree BPDU filter
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sBPDUFilterspanning tree BPDU filter
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[out]dot1sBPDUGuardspanning tree BPDU guard
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sBPDUGuardspanning tree BPDU guard
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[out]countmax hop count
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[out]countTx hold count
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[out]holdTimehold time
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.

OpEN API Version: 1.18

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistExtPortPathCostGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  portCost 
)

Gets the CIST External Port Path Cost on an interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]portCostCIST path cost of the interface
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistExtPortPathCostModeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t costMode 
)

Gets the CIST External Port Path Cost Mode on an interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]costModeCIST path cost of the interface
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistExtPortPathCostSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  portCost 
)

Sets the CIST External Port Path Cost on an interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]portCostCIST path cost of the interface
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleclient handle from registration API
[in]ifNuminterface number
[out]helloTimehello time
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.

OpEN API Version: 1.18

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistHelloTimeGet ( openapiClientHandle_t client_handle,
uint32_t *  helloTime 
)

Gets the MSTP Root Port HelloTime paramter for the CIST.

Parameters
[in]client_handleclient handle from registration API
[out]helloTimeRoot port Hello time
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleclient handle from registration API
[out]agethe current CIST max age
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.

OpEN API Version: 1.18

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistPortOperEdgeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t status 
)

Gets the CIST Operational Edge Port parameter of a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]statusOperational Edge Port status
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistPortOperPointToPointGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t status 
)

Gets the CIST Operational Point to Point Mac parameter of a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]statusOperational Point to Point Mac parameter
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistPortPathCostGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  portCost 
)

Gets the CIST port path cost.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]portCostCIST port path cost
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistPortRegionalRootIDGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
open_buffdesc bridgeID 
)

Gets the CIST Regional Root Bridge Identifier for a particular interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]bridgeIDMSTP Designated Bridge Identifier
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SCistPortTopologyChangeAckGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t val 
)

Gets the CIST Topology Change Acknowledge parameter for a specific port in the CIST.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]valTopology Change Acknowledge
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleclient handle from registration API
[out]rootIdregional root identifier
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[out]costregional root path cost
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[out]delayforward delay for the CIST
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[out]dot1sConfigNamespanning tree configuration name
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sConfigNamespanning tree configuration name
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[out]dot1sConfigRevspanning tree configuration revision
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sConfigRevspanning tree configuration revision
-Minimum value OPENAPI_DOT1S_MIN_REVISION_VALUE
-Maximum value OPENAPI_DOT1S_MAX_REVISION_VALUE
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[out]dot1sForceVersionspanning tree force version
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sForceVersionspanning tree force version
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]ifNumID of the interface
[out]dot1sBPDUFilterModespanning tree BPDU filter mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumID of the interface
[in]dot1sBPDUFilterModespanning tree BPDU filter mode
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumID of the interface
[out]dot1sBPDUFloodModespanning tree BPDU Flood mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumID of the interface
[in]dot1sBPDUFloodModespanning tree BPDU Flood mode
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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 openapiDot1SIntfBPDUGuardEffectGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t mode 
)

Gets the MSTP BPDU guard effect of an interface for the CIST.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]modespanning tree BPDU guard effect mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleclient handle from registration API
[in]ifNumID of the interface
[out]dot1sEdgePortModespanning tree edge port mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumID of the interface
[in]dot1sEdgePortModespanning tree edge port mode
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumID of the interface
[out]dot1sGuardModespanning tree Guard mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumID of the interface
[in]dot1sGuardModespanning tree Guard mode
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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 openapiDot1SIntfHelloTimeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  helloTime 
)

Gets the MSTP Hello time of an interface for the CIST.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]helloTimespanning tree port hello time
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleclient handle from registration API
[in]ifNumID of the interface
[out]dot1sModespanning tree admin mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

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_handleclient handle from registration API
[in]ifNumID of the interface
[in]dot1sModespanning tree mode
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]ifNumID of the interface
[in]dot1sInstancespanning tree MST instance
[out]dot1sPortFwdStatespanning tree port forwarding state
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]ifNumID of the interface
[in]dot1sInstancespanning tree MST instance
[out]loopInconsistentStateloop inconsistent state (a boolean value)
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]ifNumID of the interface
[in]dot1sInstancespanning tree MST instance
[out]dot1sPortRolespanning tree port role
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]strTypestring type
[out]strLenstring length
Return values
OPEN_E_NONEString length Get successful.
OPEN_E_PARAMError 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_handleclient handle from registration API
[out]dot1sModespanning tree operational mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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_handleclient handle from registration API
[in]dot1sModespanning tree operational mode
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther 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 openapiDot1SMstiDesignatedBridgeIDGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
open_buffdesc bridgeID 
)

Get the MSTP Designated Bridge Identifier in a specific instance for a particular interface.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]bridgeIDMSTP Designated Bridge Identifier
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiDesignatedCostGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
uint32_t *  dCost 
)

Get the MSTP Designated Bridge cost in a specific instance for a particular interface.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]dCostMSTP Designated Bridge cost
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiDesignatedPortIDGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
open_buffdesc portID 
)

Gets the MSTP Designated Port Identifier in a specific instance for a particular interface.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]portIDMSTP Designated Bridge Identifier
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_CST_ID
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]idbridge identifier
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_CST_ID
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]rootIddesignated root identifier
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[in]dot1sInstancespanning tree MST instance
[out]FIdForwarding Database Id
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILno next VLAN found
OPEN_E_PARAMError 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_handleclient handle from registration API
[out]instanceIdfirst spanning tree MST instance Id
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILNo next instance found.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sInstancespanning tree MST instance
[out]VLANIdVLAN Id
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILno next VLAN found
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sInstancespanning tree MST instance
[in]currFIdcurrent Forwarding Database Id
[out]nextFIdnext Forwarding Database Id
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILno next VLAN found
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]currInstancecurrent spanning tree MST instance Id
[out]nextInstancenext spanning tree MST instance Id
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILNo next instance found.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sInstancespanning tree MST instance
[in]currVLANIdcurrent VLAN Id
[out]nextVLANIdnext VLAN Id
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILno next VLAN found
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[out]priorityinstance priority
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_MSTID_MIN
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[in]priorityinstance priority
-Minimum value OPENAPI_DOT1S_PRIORITY_MIN
-Maximum value OPENAPI_DOT1S_PRIORITY_MAX
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_CST_ID
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]costdesignated root path cost
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_CST_ID
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]portport ID of the root port
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[in]dot1sMSTInstanceIdspanning tree MST instance Id
-Minimum value OPENAPI_DOT1S_MSTID_MIN
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[in]actioncreate/delete instance
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_CST_ID
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]timeValtime value, in seconds
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_CST_ID
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]countnumber of TCNs received
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_CST_ID
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[out]changeOPEN_TRUE, a change in progress OPEN_FALSE, no change in progress.
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid 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_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
-Minimum value OPENAPI_DOT1S_MSTID_MIN
-Maximum value OPENAPI_DOT1S_MSTID_MAX
[in]vlanVLAN
-Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID
-Maximum value openapiDot1VlanMaxGet()
[in]actioncreate/delete association
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError 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 openapiDot1SMSTIntfPortIDGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
open_buffdesc portID 
)

Get the MSTP Port Identifier of a specific port in a specific instance.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]portIDport ID of the interface
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.
Note
an MSTID of zero will represent the CIST

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiOperPortPathCostGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
uint32_t *  portCost 
)

Gets the MSTP operational Port Path Cost in a specific instance.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]portCostport path cost of the MSTP parameter
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.
Note
an MSTID of zero will represent the CIST

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiPortDesignatedRootIDGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
open_buffdesc rootID 
)

Get the Spanning Tree MST Instance Designated Root Bridge Identifier on a interface.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]rootIDMSTP Designated Root Bridge Identifier
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiPortLoopInconsistentStateGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
OPEN_BOOL_t status 
)

Gets the MSTP Instance Loop Inconsistent State on an interface.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]statusMSTP Loop Inconsistent State
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiPortPathCostModeGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
OPEN_CONTROL_t costMode 
)

Get the MSTP Port Path Cost Mode in a specific instance.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]costModecurrent mode of the MSTP parameter
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.
Note
an MSTID of zero will represent the CIST

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiPortPathCostSet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
uint32_t  pCost 
)

Set the MSTP Port Path Cost Mode in a specific instance.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[in]pCostpath cost of the MSTP parameter
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.
Note
an MSTID of zero will represent the CIST

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiPortPriorityGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
uint32_t *  priority 
)

Get the MSTP Port Priority in a specific instance.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]prioritypriority of the interface MSTP
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.
Note
an MSTID of zero will represent the CIST

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SMstiPortPrioritySet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
uint32_t  priority 
)

Set the MSTP Port Priority in a specific instance.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[in]prioritypriority of the interface MSTP
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.
Note
an MSTID of zero will represent the CIST

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortAutoEdgeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t mode 
)

Gets the MSTP Administrative Auto Edge Port parameter of a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]modeAuto Edge Port mode
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortAutoEdgeSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t  mode 
)

Set the MSTP Administrative Auto Edge Port parameter of a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]modeAuto Edge Port mode
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortRestrictedTcnGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t mode 
)

Gets the MSTP Administrative Restricted Tcn parameter of a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]modeTCN guard status
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortRestrictedTcnSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t  val 
)

Set the MSTP Administrative Restricted Tcn parameter of a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]valTCN guard status
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsClear ( openapiClientHandle_t client_handle,
uint32_t  ifNum 
)

Clears the port stats.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsMSTPBPDUsReceivedGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  val 
)

Gets the MSTP Statistics for MSTP BPDUs Received on a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]valMSTP BPDUs received
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsMSTPBPDUsSentGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  val 
)

Gets the MSTP Statistics for MSTP BPDUs Sent on a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]valMSTP BPDUs sent
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsRSTPBPDUsReceivedGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  val 
)

Gets the MSTP Statistics for RSTP BPDUs Received on a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]valRSTP BPDUs received
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsRSTPBPDUsSentGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  val 
)

Gets the MSTP Statistics for RSTP BPDUs Sent on a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]valRSTP BPDUs sent
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsSTPBPDUsReceivedGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  val 
)

Gets the MSTP Statistics for STP BPDUs Received on a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]valSTP BPDUs received
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsSTPBPDUsSentGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  val 
)

Gets the MSTP Statistics for STP BPDUs Sent on a specific port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]valSTP BPDUs sent
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsTransitionsIntoLoopInconsistentStateGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
uint32_t *  loopCount 
)

Gets the MSTP Statistics for the number of times this interface has transitioned into loop inconsistent state.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]loopCountLoop Inconsistent State Start stat
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortStatsTransitionsOutOfLoopInconsistentStateGet ( openapiClientHandle_t client_handle,
uint32_t  dot1sMSTInstance,
uint32_t  ifNum,
uint32_t *  loopCount 
)

Gets the MSTP Statistics for the number of times this interface has transitioned out of loop inconsistent state.

Parameters
[in]client_handleclient handle from registration API
[in]dot1sMSTInstancespanning tree MST instance
[in]ifNumID of the interface
[out]loopCountLoop Inconsistent State End stat
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

Examples:
dot1s_example.c.
open_error_t openapiDot1SPortUpTimeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
open_buffdesc upTime 
)

Gets the MSTP Up Time of the port.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]upTimeport up time
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.19

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_handleClient handle from registration API
[out]vlanMaxMaximum VLAN
Return values
OPEN_E_NONEif SNTP priority is returned successfully.
OPEN_E_PARAMif invalid parameter is passed.

OpEN API Version: 1.1

Examples:
dot1s_example.c.