38 #ifndef OPENAPI_DOT1S_H_INCLUDED
39 #define OPENAPI_DOT1S_H_INCLUDED
85 #define OPENAPI_DOT1S_CST_ID 0
86 #define OPENAPI_DOT1S_MSTID_MAX 4094
88 #define OPEN_DOT1S_VLAN_ID_LEN 2
89 #define OPEN_DOT1S_MAC_ID_LEN OPEN_MAC_ADDR_LEN
90 #define OPEN_DOT1S_VID_MAC_ADDR_LEN (OPEN_DOT1S_VLAN_ID_LEN + OPEN_DOT1S_MAC_ID_LEN)
98 uint8_t octets[OPEN_DOT1S_VID_MAC_ADDR_LEN];
385 uint32_t dot1sConfigRev);
402 uint32_t *dot1sConfigRev);
497 uint32_t dot1sMSTInstanceId,
515 uint32_t *instanceId);
533 uint32_t currInstance,
534 uint32_t *nextInstance);
557 uint32_t dot1sMSTInstance,
576 uint32_t dot1sMSTInstance,
601 uint32_t dot1sMSTInstance,
620 uint32_t dot1sInstance,
640 uint32_t dot1sInstance,
641 uint32_t currVLANId, uint32_t *nextVLANId);
659 uint32_t dot1sInstance,
679 uint32_t dot1sInstance,
680 uint32_t currFId, uint32_t *nextFId);
702 uint32_t dot1sMSTInstance,
725 uint32_t dot1sMSTInstance,
772 uint32_t dot1sMSTInstance,
795 uint32_t dot1sMSTInstance,
818 uint32_t dot1sMSTInstance,
841 uint32_t dot1sMSTInstance,
929 uint32_t *helloTime);
1040 uint32_t dot1sInstance,
1061 uint32_t dot1sInstance,
1083 uint32_t dot1sInstance,
1125 uint32_t *dot1sEdgePortMode);
1145 uint32_t *helloTime);
1187 uint32_t dot1sMSTInstance,
1210 uint32_t dot1sMSTInstance,
1233 uint32_t dot1sMSTInstance,
1235 uint32_t *priority);
1256 uint32_t dot1sMSTInstance,
1279 uint32_t dot1sMSTInstance,
1302 uint32_t dot1sMSTInstance,
1304 uint32_t *portCost);
1342 uint32_t *portCost);
1381 uint32_t dot1sMSTInstance,
1403 uint32_t dot1sMSTInstance,
1425 uint32_t dot1sMSTInstance,
1447 uint32_t dot1sMSTInstance,
1486 uint32_t *helloTime);
1565 uint32_t *portCost);
1584 uint32_t dot1sMSTInstance,
1608 uint32_t dot1sMSTInstance,
1610 uint32_t *loopCount);
1632 uint32_t dot1sMSTInstance,
1634 uint32_t *loopCount);
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.
open_error_t openapiDot1SBPDUFilterModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sBPDUFilter)
Gets the Spanning Tree BPDU Filter Mode.
open_error_t openapiDot1SModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sMode)
Gets Spanning Tree Operational Mode.
IEEE 802.1s Multiple Spanning Tree.
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 openapiDot1SMSTInstancePrioritySet(openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t priority)
Configures Spanning Tree MST Instance priority.
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.
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.
String type Configuration name.
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.
open_error_t openapiDot1SIntfEdgePortModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sEdgePortMode)
open_error_t openapiDot1SMSTInstancePriorityGet(openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint16_t *priority)
Gets Spanning Tree MST Instance priority.
open_error_t openapiDot1SConfigRevisionGet(openapiClientHandle_t *client_handle, uint32_t *dot1sConfigRev)
Gets the Spanning Tree Configuration Revision.
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 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 openapiDot1SPortRestrictedTcnSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t val)
Set the MSTP Administrative Restricted Tcn parameter of a specific port.
OPEN_DOT1S_FORCE_VERSION_t
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.
Port state Manual Forward.
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 openapiDot1SPortAutoEdgeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mode)
Gets the MSTP Administrative Auto Edge Port parameter of a specific port.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiDot1SModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sMode)
Enables/Disables Spanning Tree Operational Mode.
open_error_t openapiDot1SCistExtPortPathCostSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t portCost)
Sets the CIST External Port Path Cost on an interface.
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.
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 openapiDot1SCistExtPortPathCostGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *portCost)
Gets the CIST External Port Path Cost on an interface.
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.
open_error_t openapiDot1SMSTInstanceNextGet(openapiClientHandle_t *client_handle, uint32_t currInstance, uint32_t *nextInstance)
Gets Next Spanning Tree MST Instance.
open_error_t openapiDot1sCISTRootFwdDelayGet(openapiClientHandle_t *client_handle, uint32_t *delay)
Get the CIST Bridge Forward Delay.
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.
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.
IEEE 802.1d Spanning Tree.
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 openapiDot1SPortStatsClear(openapiClientHandle_t *client_handle, uint32_t ifNum)
Clears the port stats.
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.
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 openapiDot1SIntfGuardModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1S_PORT_GUARD_t *dot1sGuardMode)
Gets Spanning Tree Guard mode.
open_error_t openapiDot1sCISTBridgeHoldTimeGet(openapiClientHandle_t *client_handle, uint32_t *holdTime)
Get the CIST Bridge Hold Time.
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 openapiDot1SPortStatsMSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Gets the MSTP Statistics for MSTP BPDUs Received on a specific port.
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.
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 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.
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.
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 openapiDot1SConfigNameGet(openapiClientHandle_t *client_handle, open_buffdesc *dot1sConfigName)
Gets the Spanning Tree Configuration Name.
open_error_t openapiDot1SBPDUGuardModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUGuard)
Configures Spanning Tree BPDU Guard Mode.
OPEN_DOT1S_PORT_FWD_STATE_t
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.
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_ACTION_t
OPEN uses these enumerators to indicate the interface types.
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.
IEEE 802.1w Rapid Spanning Tree.
open_error_t openapiDot1SBPDUFilterModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUFilter)
Configures Spanning Tree BPDU Filter Mode.
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 openapiDot1SPortRestrictedTcnGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mode)
Gets the MSTP Administrative Restricted Tcn parameter of a specific port.
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 inconsiste...
open_error_t openapiDot1SConfigNameSet(openapiClientHandle_t *client_handle, open_buffdesc *dot1sConfigName)
Configures Spanning Tree Configuration Name.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
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...
open_error_t openapiDot1sCISTMaxAgeGet(openapiClientHandle_t *client_handle, uint32_t *age)
Get the max age for the CIST.
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 openapiDot1VlanMaxGet(openapiClientHandle_t *client_handle, uint32_t *vlanMax)
Get the maximum number of Spanning Tree VLANs.
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.
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_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
DOT1S general bridge identifier formed by combining the bridge priority, instance identifier...
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.
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.
open_error_t openapiDot1SForceVersionSet(openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion)
Configures Spanning Tree Force Revision.
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.
open_error_t openapiDot1SPortUpTimeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *upTime)
Gets the MSTP Up Time of the port.
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.
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 openapiDot1sBridgeMaxHopGet(openapiClientHandle_t *client_handle, uint32_t *count)
Get the Max Hop count for the device.
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 openapiDot1SMSTInstanceSet(openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstanceId, OPEN_ACTION_t action)
Creates/Deletes Spanning Tree MST Instance.
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 openapiDot1SForceVersionGet(openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t *dot1sForceVersion)
Gets the Spanning Tree Force Revision.
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 openapiDot1SIntfBPDUFloodModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sBPDUFloodMode)
Gets Spanning Tree BPDU Flood mode for an interface.
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.
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 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 inconsis...
open_error_t openapiDot1SBPDUGuardModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sBPDUGuard)
Gets the Spanning Tree BPDU Guard 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 openapiDot1SCistPortPathCostGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *portCost)
Gets the CIST port path cost.
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.
open_error_t openapiDot1SCistHelloTimeGet(openapiClientHandle_t *client_handle, uint32_t *helloTime)
Gets the MSTP Root Port HelloTime paramter for the CIST.
open_error_t openapiDot1SConfigRevisionSet(openapiClientHandle_t *client_handle, uint32_t dot1sConfigRev)
Configures Spanning Tree Configuration Revision.
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 openapiDot1SPortStatsSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Gets the MSTP Statistics for STP BPDUs Received on a specific port.
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 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 openapiDot1SMSTInstanceFirstGet(openapiClientHandle_t *client_handle, uint32_t *instanceId)
Gets First Spanning Tree MST Instance.
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.
Port state Not Participating.
open_error_t openapiDot1sBridgeTxHoldCountGet(openapiClientHandle_t *client_handle, uint32_t *count)
Get the Tx Hold count for the device.
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.