Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_dot1s.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_dot1s.h
28 *
29 * @purpose Spanning Tree Configuration and Status
30 *
31 * @component OPEN
32 *
33 * @create 10/25/2012
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_DOT1S_H_INCLUDED
39 #define OPENAPI_DOT1S_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 typedef enum
44 {
51 
52 typedef enum
53 {
58 
59 typedef enum
60 {
63 
64 typedef enum
65 {
73 
74 typedef enum
75 {
84 
85 #define OPENAPI_DOT1S_CST_ID 0
86 #define OPENAPI_DOT1S_MSTID_MAX 4094
87 
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)
91 
96 typedef struct
97 {
98  uint8_t octets[OPEN_DOT1S_VID_MAC_ADDR_LEN];
100 
101 
102 /*****************************************************************/
119  OPEN_DOT1S_MGMT_STR_t strType,
120  uint32_t *strLen);
121 
122 /*****************************************************************/
136  uint32_t *vlanMax);
137 
138 /*****************************************************************/
155  OPEN_CONTROL_t dot1sMode);
156 
157 /*****************************************************************/
173  OPEN_CONTROL_t *dot1sMode);
174 
175 /*****************************************************************/
193  uint32_t ifNum,
194  OPEN_CONTROL_t dot1sBPDUFilterMode);
195 
196 /*****************************************************************/
213  uint32_t ifNum,
214  OPEN_CONTROL_t *dot1sBPDUFilterMode);
215 
216 /*****************************************************************/
234  uint32_t ifNum,
235  OPEN_CONTROL_t dot1sBPDUFloodMode);
236 
237 /*****************************************************************/
254  uint32_t ifNum,
255  OPEN_CONTROL_t *dot1sBPDUFloodMode);
256 
257 /*****************************************************************/
273  OPEN_CONTROL_t dot1sBPDUGuard);
274 
275 /*****************************************************************/
290  OPEN_CONTROL_t *dot1sBPDUGuard);
291 
292 /*****************************************************************/
308  OPEN_CONTROL_t dot1sBPDUFilter);
309 
310 /*****************************************************************/
325  OPEN_CONTROL_t *dot1sBPDUFilter);
326 
327 /*****************************************************************/
346  open_buffdesc *dot1sConfigName);
347 
348 /*****************************************************************/
365  open_buffdesc *dot1sConfigName);
366 
367 /*****************************************************************/
385  uint32_t dot1sConfigRev);
386 
387 /*****************************************************************/
402  uint32_t *dot1sConfigRev);
403 
404 /*****************************************************************/
420  OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion);
421 
422 /*****************************************************************/
437  OPEN_DOT1S_FORCE_VERSION_t *dot1sForceVersion);
438 
439 /*****************************************************************/
455 open_error_t openapiDot1SIntfGuardModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum,
456  OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode);
457 
458 /*****************************************************************/
475  uint32_t ifNum,
476  OPEN_DOT1S_PORT_GUARD_t *dot1sGuardMode);
477 
478 /*****************************************************************/
497  uint32_t dot1sMSTInstanceId,
498  OPEN_ACTION_t action);
499 
500 /*****************************************************************/
515  uint32_t *instanceId);
516 
517 /*****************************************************************/
533  uint32_t currInstance,
534  uint32_t *nextInstance);
535 
536 /*****************************************************************/
557  uint32_t dot1sMSTInstance,
558  uint32_t priority);
559 
560 /*****************************************************************/
576  uint32_t dot1sMSTInstance,
577  uint16_t *priority);
578 
579 /*****************************************************************/
601  uint32_t dot1sMSTInstance,
602  uint32_t vlan,
603  OPEN_ACTION_t action);
604 /*****************************************************************/
620  uint32_t dot1sInstance,
621  uint32_t *VLANId);
622 
623 /*****************************************************************/
640  uint32_t dot1sInstance,
641  uint32_t currVLANId, uint32_t *nextVLANId);
642 
643 /*****************************************************************/
659  uint32_t dot1sInstance,
660  uint32_t *FId);
661 
662 /*****************************************************************/
679  uint32_t dot1sInstance,
680  uint32_t currFId, uint32_t *nextFId);
681 
682 /*************************************************************************/
702  uint32_t dot1sMSTInstance,
704 
705 /*************************************************************************/
725  uint32_t dot1sMSTInstance,
726  uint32_t *timeVal);
727 
728 /*************************************************************************/
748  uint32_t mstId,
749  uint32_t *count);
750 
751 /*************************************************************************/
772  uint32_t dot1sMSTInstance,
773  OPEN_BOOL_t *change);
774 
775 /*************************************************************************/
795  uint32_t dot1sMSTInstance,
796  OPEN_DOT1S_BRIDGEID_t *rootId);
797 
798 /*************************************************************************/
818  uint32_t dot1sMSTInstance,
819  uint32_t *cost);
820 
821 /*************************************************************************/
841  uint32_t dot1sMSTInstance,
842  uint32_t *port);
843 
844 /*************************************************************************/
859  uint32_t *age);
860 
861 /*************************************************************************/
876  uint32_t *count);
877 
878 /*************************************************************************/
893  uint32_t *count);
894 
895 /*************************************************************************/
910  uint32_t *delay);
911 
912 /*************************************************************************/
928  uint32_t ifNum,
929  uint32_t *helloTime);
930 
931 /*************************************************************************/
946  uint32_t *holdTime);
947 
948 /*************************************************************************/
963  OPEN_DOT1S_BRIDGEID_t *rootId);
964 
965 /*************************************************************************/
980  uint32_t *cost);
981 
982 /*****************************************************************/
999  uint32_t ifNum,
1000  OPEN_CONTROL_t dot1sMode);
1001 
1002 /*****************************************************************/
1019  uint32_t ifNum,
1020  OPEN_CONTROL_t *dot1sMode);
1021 
1022 /*****************************************************************/
1039  uint32_t ifNum,
1040  uint32_t dot1sInstance,
1041  OPEN_DOT1S_PORT_FWD_STATE_t *dot1sPortFwdState);
1042 
1043 /*****************************************************************/
1060  uint32_t ifNum,
1061  uint32_t dot1sInstance,
1062  OPEN_DOT1S_PORT_ROLE_t *dot1sPortRole);
1063 
1064 /*****************************************************************/
1082  uint32_t ifNum,
1083  uint32_t dot1sInstance,
1084  OPEN_BOOL_t *loopInconsistentState);
1085 
1086 /*****************************************************************/
1103  uint32_t ifNum,
1104  OPEN_CONTROL_t dot1sEdgePortMode);
1105 
1106 /*****************************************************************/
1124  uint32_t ifNum,
1125  uint32_t *dot1sEdgePortMode);
1126 
1127 /*****************************************************************/
1144  uint32_t ifNum,
1145  uint32_t *helloTime);
1146 
1147 /*****************************************************************/
1164  uint32_t ifNum,
1165  OPEN_CONTROL_t *mode);
1166 
1167 /*****************************************************************/
1187  uint32_t dot1sMSTInstance,
1188  uint32_t ifNum,
1189  open_buffdesc *portID);
1190 
1191 /*****************************************************************/
1210  uint32_t dot1sMSTInstance,
1211  uint32_t ifNum,
1212  uint32_t priority);
1213 
1214 /*****************************************************************/
1233  uint32_t dot1sMSTInstance,
1234  uint32_t ifNum,
1235  uint32_t *priority);
1236 
1237 /*****************************************************************/
1256  uint32_t dot1sMSTInstance,
1257  uint32_t ifNum,
1258  OPEN_CONTROL_t *costMode);
1259 
1260 /*****************************************************************/
1279  uint32_t dot1sMSTInstance,
1280  uint32_t ifNum,
1281  uint32_t pCost);
1282 
1283 /*****************************************************************/
1302  uint32_t dot1sMSTInstance,
1303  uint32_t ifNum,
1304  uint32_t *portCost);
1305 
1306 /*****************************************************************/
1322  uint32_t ifNum,
1323  OPEN_CONTROL_t *costMode);
1324 
1325 /*****************************************************************/
1341  uint32_t ifNum,
1342  uint32_t *portCost);
1343 
1344 /*****************************************************************/
1360  uint32_t ifNum,
1361  uint32_t portCost);
1362 
1363 /*****************************************************************/
1381  uint32_t dot1sMSTInstance,
1382  uint32_t ifNum,
1383  open_buffdesc *rootID);
1384 
1385 /*****************************************************************/
1403  uint32_t dot1sMSTInstance,
1404  uint32_t ifNum,
1405  uint32_t *dCost);
1406 
1407 /*****************************************************************/
1425  uint32_t dot1sMSTInstance,
1426  uint32_t ifNum,
1427  open_buffdesc *bridgeID);
1428 
1429 /*****************************************************************/
1447  uint32_t dot1sMSTInstance,
1448  uint32_t ifNum,
1449  open_buffdesc *portID);
1450 
1451 /*****************************************************************/
1468  uint32_t ifNum,
1469  OPEN_BOOL_t *val);
1470 
1471 /*****************************************************************/
1486  uint32_t *helloTime);
1487 
1488 /*****************************************************************/
1505  uint32_t ifNum,
1506  OPEN_BOOL_t *status);
1507 
1508 /*****************************************************************/
1526  uint32_t ifNum,
1527  OPEN_BOOL_t *status);
1528 
1529 /*****************************************************************/
1545  uint32_t ifNum,
1546  open_buffdesc *bridgeID);
1547 
1548 /*****************************************************************/
1564  uint32_t ifNum,
1565  uint32_t *portCost);
1566 
1567 /*****************************************************************/
1584  uint32_t dot1sMSTInstance,
1585  uint32_t ifNum,
1586  OPEN_BOOL_t *status);
1587 
1588 /*****************************************************************/
1605 open_error_t
1607  openapiClientHandle_t *client_handle,
1608  uint32_t dot1sMSTInstance,
1609  uint32_t ifNum,
1610  uint32_t *loopCount);
1611 
1612 /*****************************************************************/
1629 open_error_t
1631  openapiClientHandle_t *client_handle,
1632  uint32_t dot1sMSTInstance,
1633  uint32_t ifNum,
1634  uint32_t *loopCount);
1635 
1636 /*****************************************************************/
1651  uint32_t ifNum);
1652 
1653 /*****************************************************************/
1670  uint32_t ifNum,
1671  OPEN_BOOL_t *mode);
1672 
1673 /*****************************************************************/
1690  uint32_t ifNum,
1691  OPEN_BOOL_t val);
1692 
1693 /*****************************************************************/
1710  uint32_t ifNum,
1711  OPEN_BOOL_t *mode);
1712 
1713 /*****************************************************************/
1730  uint32_t ifNum,
1731  OPEN_BOOL_t mode);
1732 
1733 /*****************************************************************/
1749  uint32_t ifNum,
1750  open_buffdesc *upTime);
1751 
1752 /*****************************************************************/
1768  uint32_t ifNum,
1769  uint32_t *val);
1770 
1771 /*****************************************************************/
1787  uint32_t ifNum,
1788  uint32_t *val);
1789 
1790 /*****************************************************************/
1806  uint32_t ifNum,
1807  uint32_t *val);
1808 
1809 /*****************************************************************/
1825  uint32_t ifNum,
1826  uint32_t *val);
1827 
1828 /*****************************************************************/
1844  uint32_t ifNum,
1845  uint32_t *val);
1846 
1847 /*****************************************************************/
1863  uint32_t ifNum,
1864  uint32_t *val);
1865 
1866 #endif /* OPENAPI_DOT1S_H_INCLUDED */
1867 
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.
Definition: openapi_dot1s.h:48
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.
Definition: openapi_dot1s.h:61
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_DOT1S_PORT_ROLE_t
Definition: openapi_dot1s.h:74
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.
Port state Learning.
Definition: openapi_dot1s.h:67
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
Definition: openapi_dot1s.h:43
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.
Definition: openapi_dot1s.h:70
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.
Definition: openapi_dot1s.h:45
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
Definition: openapi_dot1s.h:64
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.
Definition: openapi_dot1s.h:47
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...
Definition: openapi_dot1s.h:96
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.
Port state Forwarding.
Definition: openapi_dot1s.h:68
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_DOT1S_PORT_GUARD_t
Definition: openapi_dot1s.h:52
OPEN_DOT1S_MGMT_STR_t
Definition: openapi_dot1s.h:59
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.
Port state Disabled.
Definition: openapi_dot1s.h:69
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 Discarding.
Definition: openapi_dot1s.h:66
Port state Not Participating.
Definition: openapi_dot1s.h:71
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.