Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
openapi_dot1s.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2023 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 {
45  OPEN_DOT1S_FORCE_VERSION_DOT1D = 0,
46  OPEN_DOT1S_FORCE_VERSION_UNUSED = 1,
47  OPEN_DOT1S_FORCE_VERSION_DOT1W = 2,
48  OPEN_DOT1S_FORCE_VERSION_DOT1S = 3,
49  OPEN_DOT1S_FORCE_VERSION_LAST
50 }OPEN_DOT1S_FORCE_VERSION_t;
51 
52 typedef enum
53 {
54  OPEN_DOT1S_PORT_GUARD_LOOP = 0,
55  OPEN_DOT1S_PORT_GUARD_ROOT = 1,
56  OPEN_DOT1S_PORT_GUARD_NONE = 2
57 }OPEN_DOT1S_PORT_GUARD_t;
58 
59 typedef enum
60 {
61  OPEN_DOT1S_MGMT_STR_CONFIG_NAME = 0
62 }OPEN_DOT1S_MGMT_STR_t;
63 
64 typedef enum
65 {
66  OPEN_DOT1S_PORT_DISCARDING = 1,
67  OPEN_DOT1S_PORT_LEARNING = 2,
68  OPEN_DOT1S_PORT_FORWARDING = 3,
69  OPEN_DOT1S_PORT_DISABLED = 4,
70  OPEN_DOT1S_PORT_MANUAL_FWD = 5,
71  OPEN_DOT1S_PORT_NOT_PARTICIPATE = 6
72 }OPEN_DOT1S_PORT_FWD_STATE_t;
73 
74 typedef enum
75 {
76  OPEN_DOT1S_ROLE_DISABLED = 0,
77  OPEN_DOT1S_ROLE_ROOT = 1,
78  OPEN_DOT1S_ROLE_DESIGNATED = 2,
79  OPEN_DOT1S_ROLE_ALTERNATE = 3,
80  OPEN_DOT1S_ROLE_BACKUP = 4,
81  OPEN_DOT1S_ROLE_MASTER = 5
83 }OPEN_DOT1S_PORT_ROLE_t;
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 
92 #define OPEN_DOT1S_BRIDGE_MAXAGE_MIN 6
93 #define OPEN_DOT1S_BRIDGE_MAXAGE_MAX 40
94 #define OPEN_DOT1S_BRIDGE_FORWARDDELAY_MIN 4
95 #define OPEN_DOT1S_BRIDGE_FORWARDDELAY_MAX 30
96 #define OPEN_DOT1S_BRIDGE_MAXHOP_MIN 6
97 #define OPEN_DOT1S_BRIDGE_MAXHOP_MAX 40
98 #define OPEN_DOT1S_BRIDGE_HOLDCOUNT_MIN 1
99 #define OPEN_DOT1S_BRIDGE_HOLDCOUNT_MAX 10
100 
101 #define OPEN_DOT1S_CONFIG_DIGEST_SIZE 16
102 
107 typedef struct
108 {
109  uint8_t octets[OPEN_DOT1S_VID_MAC_ADDR_LEN];
110 } OPEN_DOT1S_BRIDGEID_t;
111 
112 
113 /*****************************************************************/
129 open_error_t openapiDot1sMgmtStrLenGet(openapiClientHandle_t *client_handle,
130  OPEN_DOT1S_MGMT_STR_t strType,
131  uint32_t *strLen);
132 
133 /*****************************************************************/
146 open_error_t openapiDot1VlanMaxGet(openapiClientHandle_t *client_handle,
147  uint32_t *vlanMax);
148 
149 /*****************************************************************/
165 open_error_t openapiDot1SModeSet(openapiClientHandle_t *client_handle,
166  OPEN_CONTROL_t dot1sMode);
167 
168 /*****************************************************************/
183 open_error_t openapiDot1SModeGet(openapiClientHandle_t *client_handle,
184  OPEN_CONTROL_t *dot1sMode);
185 
186 /*****************************************************************/
203 open_error_t openapiDot1SIntfBPDUFilterModeSet(openapiClientHandle_t *client_handle,
204  uint32_t ifNum,
205  OPEN_CONTROL_t dot1sBPDUFilterMode);
206 
207 /*****************************************************************/
223 open_error_t openapiDot1SIntfBPDUFilterModeGet(openapiClientHandle_t *client_handle,
224  uint32_t ifNum,
225  OPEN_CONTROL_t *dot1sBPDUFilterMode);
226 
227 /*****************************************************************/
244 open_error_t openapiDot1SIntfBPDUFloodModeSet(openapiClientHandle_t *client_handle,
245  uint32_t ifNum,
246  OPEN_CONTROL_t dot1sBPDUFloodMode);
247 
248 /*****************************************************************/
264 open_error_t openapiDot1SIntfBPDUFloodModeGet(openapiClientHandle_t *client_handle,
265  uint32_t ifNum,
266  OPEN_CONTROL_t *dot1sBPDUFloodMode);
267 
268 /*****************************************************************/
283 open_error_t openapiDot1SBPDUGuardModeSet(openapiClientHandle_t *client_handle,
284  OPEN_CONTROL_t dot1sBPDUGuard);
285 
286 /*****************************************************************/
300 open_error_t openapiDot1SBPDUGuardModeGet(openapiClientHandle_t *client_handle,
301  OPEN_CONTROL_t *dot1sBPDUGuard);
302 
303 /*****************************************************************/
318 open_error_t openapiDot1SBPDUFilterModeSet(openapiClientHandle_t *client_handle,
319  OPEN_CONTROL_t dot1sBPDUFilter);
320 
321 /*****************************************************************/
335 open_error_t openapiDot1SBPDUFilterModeGet(openapiClientHandle_t *client_handle,
336  OPEN_CONTROL_t *dot1sBPDUFilter);
337 
338 /*****************************************************************/
356 open_error_t openapiDot1SConfigNameSet(openapiClientHandle_t *client_handle,
357  open_buffdesc *dot1sConfigName);
358 
359 /*****************************************************************/
375 open_error_t openapiDot1SConfigNameGet(openapiClientHandle_t *client_handle,
376  open_buffdesc *dot1sConfigName);
377 
378 /*****************************************************************/
395 open_error_t openapiDot1SConfigRevisionSet(openapiClientHandle_t *client_handle,
396  uint32_t dot1sConfigRev);
397 
398 /*****************************************************************/
412 open_error_t openapiDot1SConfigRevisionGet(openapiClientHandle_t *client_handle,
413  uint32_t *dot1sConfigRev);
414 
415 /*****************************************************************/
430 open_error_t openapiDot1SForceVersionSet(openapiClientHandle_t *client_handle,
431  OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion);
432 
433 /*****************************************************************/
447 open_error_t openapiDot1SForceVersionGet(openapiClientHandle_t *client_handle,
448  OPEN_DOT1S_FORCE_VERSION_t *dot1sForceVersion);
449 
450 /*****************************************************************/
466 open_error_t openapiDot1SIntfGuardModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum,
467  OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode);
468 
469 /*****************************************************************/
485 open_error_t openapiDot1SIntfGuardModeGet(openapiClientHandle_t *client_handle,
486  uint32_t ifNum,
487  OPEN_DOT1S_PORT_GUARD_t *dot1sGuardMode);
488 
489 /*****************************************************************/
507 open_error_t openapiDot1SMSTInstanceSet(openapiClientHandle_t *client_handle,
508  uint32_t dot1sMSTInstanceId,
509  OPEN_ACTION_t action);
510 
511 /*****************************************************************/
525 open_error_t openapiDot1SMSTInstanceFirstGet(openapiClientHandle_t *client_handle,
526  uint32_t *instanceId);
527 
528 /*****************************************************************/
543 open_error_t openapiDot1SMSTInstanceNextGet(openapiClientHandle_t *client_handle,
544  uint32_t currInstance,
545  uint32_t *nextInstance);
546 
547 /*****************************************************************/
567 open_error_t openapiDot1SMSTInstancePrioritySet(openapiClientHandle_t *client_handle,
568  uint32_t dot1sMSTInstance,
569  uint32_t priority);
570 
571 /*****************************************************************/
586 open_error_t openapiDot1SMSTInstancePriorityGet(openapiClientHandle_t *client_handle,
587  uint32_t dot1sMSTInstance,
588  uint16_t *priority);
589 
590 /*****************************************************************/
611 open_error_t openapiDot1SMSTInstanceVLANSet(openapiClientHandle_t *client_handle,
612  uint32_t dot1sMSTInstance,
613  uint32_t vlan,
614  OPEN_ACTION_t action);
615 /*****************************************************************/
630 open_error_t openapiDot1SMSTInstanceFirstVLANGet(openapiClientHandle_t *client_handle,
631  uint32_t dot1sInstance,
632  uint32_t *VLANId);
633 
634 /*****************************************************************/
650 open_error_t openapiDot1SMSTInstanceNextVLANGet(openapiClientHandle_t *client_handle,
651  uint32_t dot1sInstance,
652  uint32_t currVLANId, uint32_t *nextVLANId);
653 
654 /*****************************************************************/
669 open_error_t openapiDot1SMSTInstanceFirstFIdGet(openapiClientHandle_t *client_handle,
670  uint32_t dot1sInstance,
671  uint32_t *FId);
672 
673 /*****************************************************************/
689 open_error_t openapiDot1SMSTInstanceNextFIdGet(openapiClientHandle_t *client_handle,
690  uint32_t dot1sInstance,
691  uint32_t currFId, uint32_t *nextFId);
692 
693 /*************************************************************************/
712 open_error_t openapiDot1sMSTInstanceBridgeIdentifierGet(openapiClientHandle_t *client_handle,
713  uint32_t dot1sMSTInstance,
714  OPEN_DOT1S_BRIDGEID_t *id);
715 
716 /*************************************************************************/
735 open_error_t openapiDot1sMSTInstanceTimeSinceTopologyChangeGet(openapiClientHandle_t *client_handle,
736  uint32_t dot1sMSTInstance,
737  uint32_t *timeVal);
738 
739 /*************************************************************************/
758 open_error_t openapiDot1sMSTInstanceTopologyChangeCountGet(openapiClientHandle_t *client_handle,
759  uint32_t dot1sMSTInstance,
760  uint32_t *count);
761 
762 /*************************************************************************/
782 open_error_t openapiDot1sMSTInstanceTopologyChangeStateGet(openapiClientHandle_t *client_handle,
783  uint32_t dot1sMSTInstance,
784  OPEN_BOOL_t *change);
785 
786 /*************************************************************************/
805 open_error_t openapiDot1sMSTInstanceDesignatedRootIDGet(openapiClientHandle_t *client_handle,
806  uint32_t dot1sMSTInstance,
807  OPEN_DOT1S_BRIDGEID_t *rootId);
808 
809 /*************************************************************************/
828 open_error_t openapiDot1sMSTInstanceRootPathCostGet(openapiClientHandle_t *client_handle,
829  uint32_t dot1sMSTInstance,
830  uint32_t *cost);
831 
832 /*************************************************************************/
851 open_error_t openapiDot1sMSTInstanceRootPortIDGet(openapiClientHandle_t *client_handle,
852  uint32_t dot1sMSTInstance,
853  uint32_t *port);
854 
855 /*************************************************************************/
869 open_error_t openapiDot1sCISTMaxAgeGet(openapiClientHandle_t *client_handle,
870  uint32_t *age);
871 
872 /*************************************************************************/
886 open_error_t openapiDot1sBridgeMaxHopGet(openapiClientHandle_t *client_handle,
887  uint32_t *count);
888 
889 /*************************************************************************/
903 open_error_t openapiDot1sBridgeTxHoldCountGet(openapiClientHandle_t *client_handle,
904  uint32_t *count);
905 
906 /*************************************************************************/
920 open_error_t openapiDot1sCISTRootFwdDelayGet(openapiClientHandle_t *client_handle,
921  uint32_t *delay);
922 
923 /*************************************************************************/
938 open_error_t openapiDot1sCISTHelloTimeGet(openapiClientHandle_t *client_handle,
939  uint32_t ifNum,
940  uint32_t *helloTime);
941 
942 /*************************************************************************/
956 open_error_t openapiDot1sCISTBridgeHoldTimeGet(openapiClientHandle_t *client_handle,
957  uint32_t *holdTime);
958 
959 /*************************************************************************/
973 open_error_t openapiDot1sCISTRegionalRootIDGet(openapiClientHandle_t *client_handle,
974  OPEN_DOT1S_BRIDGEID_t *rootId);
975 
976 /*************************************************************************/
990 open_error_t openapiDot1sCISTRegionalRootPathCostGet(openapiClientHandle_t *client_handle,
991  uint32_t *cost);
992 
993 /*****************************************************************/
1009 open_error_t openapiDot1SIntfModeSet(openapiClientHandle_t *client_handle,
1010  uint32_t ifNum,
1011  OPEN_CONTROL_t dot1sMode);
1012 
1013 /*****************************************************************/
1029 open_error_t openapiDot1SIntfModeGet(openapiClientHandle_t *client_handle,
1030  uint32_t ifNum,
1031  OPEN_CONTROL_t *dot1sMode);
1032 
1033 /*****************************************************************/
1049 open_error_t openapiDot1SIntfPortFwdStateGet(openapiClientHandle_t *client_handle,
1050  uint32_t ifNum,
1051  uint32_t dot1sInstance,
1052  OPEN_DOT1S_PORT_FWD_STATE_t *dot1sPortFwdState);
1053 
1054 /*****************************************************************/
1070 open_error_t openapiDot1SIntfPortRoleGet(openapiClientHandle_t *client_handle,
1071  uint32_t ifNum,
1072  uint32_t dot1sInstance,
1073  OPEN_DOT1S_PORT_ROLE_t *dot1sPortRole);
1074 
1075 /*****************************************************************/
1092 open_error_t openapiDot1SIntfPortLoopInconsistentStateGet(openapiClientHandle_t *client_handle,
1093  uint32_t ifNum,
1094  uint32_t dot1sInstance,
1095  OPEN_BOOL_t *loopInconsistentState);
1096 
1097 /*****************************************************************/
1113 open_error_t openapiDot1SIntfEdgePortModeSet(openapiClientHandle_t *client_handle,
1114  uint32_t ifNum,
1115  OPEN_CONTROL_t dot1sEdgePortMode);
1116 
1117 /*****************************************************************/
1134 open_error_t openapiDot1SIntfEdgePortModeGet(openapiClientHandle_t *client_handle,
1135  uint32_t ifNum,
1136  uint32_t *dot1sEdgePortMode);
1137 
1138 /*****************************************************************/
1154 open_error_t openapiDot1SIntfHelloTimeGet(openapiClientHandle_t *client_handle,
1155  uint32_t ifNum,
1156  uint32_t *helloTime);
1157 
1158 /*****************************************************************/
1174 open_error_t openapiDot1SIntfBPDUGuardEffectGet(openapiClientHandle_t *client_handle,
1175  uint32_t ifNum,
1176  OPEN_CONTROL_t *mode);
1177 
1178 /*****************************************************************/
1197 open_error_t openapiDot1SMSTIntfPortIDGet(openapiClientHandle_t *client_handle,
1198  uint32_t dot1sMSTInstance,
1199  uint32_t ifNum,
1200  open_buffdesc *portID);
1201 
1202 /*****************************************************************/
1220 open_error_t openapiDot1SMstiPortPrioritySet(openapiClientHandle_t *client_handle,
1221  uint32_t dot1sMSTInstance,
1222  uint32_t ifNum,
1223  uint32_t priority);
1224 
1225 /*****************************************************************/
1243 open_error_t openapiDot1SMstiPortPriorityGet(openapiClientHandle_t *client_handle,
1244  uint32_t dot1sMSTInstance,
1245  uint32_t ifNum,
1246  uint32_t *priority);
1247 
1248 /*****************************************************************/
1266 open_error_t openapiDot1SMstiPortPathCostModeGet(openapiClientHandle_t *client_handle,
1267  uint32_t dot1sMSTInstance,
1268  uint32_t ifNum,
1269  OPEN_CONTROL_t *costMode);
1270 
1271 /*****************************************************************/
1289 open_error_t openapiDot1SMstiPortPathCostSet(openapiClientHandle_t *client_handle,
1290  uint32_t dot1sMSTInstance,
1291  uint32_t ifNum,
1292  uint32_t pCost);
1293 
1294 /*****************************************************************/
1312 open_error_t openapiDot1SMstiOperPortPathCostGet(openapiClientHandle_t *client_handle,
1313  uint32_t dot1sMSTInstance,
1314  uint32_t ifNum,
1315  uint32_t *portCost);
1316 
1317 /*****************************************************************/
1332 open_error_t openapiDot1SCistExtPortPathCostModeGet(openapiClientHandle_t *client_handle,
1333  uint32_t ifNum,
1334  OPEN_CONTROL_t *costMode);
1335 
1336 /*****************************************************************/
1351 open_error_t openapiDot1SCistExtPortPathCostGet(openapiClientHandle_t *client_handle,
1352  uint32_t ifNum,
1353  uint32_t *portCost);
1354 
1355 /*****************************************************************/
1370 open_error_t openapiDot1SCistExtPortPathCostSet(openapiClientHandle_t *client_handle,
1371  uint32_t ifNum,
1372  uint32_t portCost);
1373 
1374 /*****************************************************************/
1391 open_error_t openapiDot1SMstiPortDesignatedRootIDGet(openapiClientHandle_t *client_handle,
1392  uint32_t dot1sMSTInstance,
1393  uint32_t ifNum,
1394  open_buffdesc *rootID);
1395 
1396 /*****************************************************************/
1413 open_error_t openapiDot1SMstiDesignatedCostGet(openapiClientHandle_t *client_handle,
1414  uint32_t dot1sMSTInstance,
1415  uint32_t ifNum,
1416  uint32_t *dCost);
1417 
1418 /*****************************************************************/
1435 open_error_t openapiDot1SMstiDesignatedBridgeIDGet(openapiClientHandle_t *client_handle,
1436  uint32_t dot1sMSTInstance,
1437  uint32_t ifNum,
1438  open_buffdesc *bridgeID);
1439 
1440 /*****************************************************************/
1457 open_error_t openapiDot1SMstiDesignatedPortIDGet(openapiClientHandle_t *client_handle,
1458  uint32_t dot1sMSTInstance,
1459  uint32_t ifNum,
1460  open_buffdesc *portID);
1461 
1462 /*****************************************************************/
1478 open_error_t openapiDot1SCistPortTopologyChangeAckGet(openapiClientHandle_t *client_handle,
1479  uint32_t ifNum,
1480  OPEN_BOOL_t *val);
1481 
1482 /*****************************************************************/
1496 open_error_t openapiDot1SCistHelloTimeGet(openapiClientHandle_t *client_handle,
1497  uint32_t *helloTime);
1498 
1499 /*****************************************************************/
1515 open_error_t openapiDot1SCistPortOperEdgeGet(openapiClientHandle_t *client_handle,
1516  uint32_t ifNum,
1517  OPEN_BOOL_t *status);
1518 
1519 /*****************************************************************/
1536 open_error_t openapiDot1SCistPortOperPointToPointGet(openapiClientHandle_t *client_handle,
1537  uint32_t ifNum,
1538  OPEN_BOOL_t *status);
1539 
1540 /*****************************************************************/
1555 open_error_t openapiDot1SCistPortRegionalRootIDGet(openapiClientHandle_t *client_handle,
1556  uint32_t ifNum,
1557  open_buffdesc *bridgeID);
1558 
1559 /*****************************************************************/
1574 open_error_t openapiDot1SCistPortPathCostGet(openapiClientHandle_t *client_handle,
1575  uint32_t ifNum,
1576  uint32_t *portCost);
1577 
1578 /*****************************************************************/
1594 open_error_t openapiDot1SMstiPortLoopInconsistentStateGet(openapiClientHandle_t *client_handle,
1595  uint32_t dot1sMSTInstance,
1596  uint32_t ifNum,
1597  OPEN_BOOL_t *status);
1598 
1599 /*****************************************************************/
1616 open_error_t
1617 openapiDot1SPortStatsTransitionsIntoLoopInconsistentStateGet(
1618  openapiClientHandle_t *client_handle,
1619  uint32_t dot1sMSTInstance,
1620  uint32_t ifNum,
1621  uint32_t *loopCount);
1622 
1623 /*****************************************************************/
1640 open_error_t
1641 openapiDot1SPortStatsTransitionsOutOfLoopInconsistentStateGet(
1642  openapiClientHandle_t *client_handle,
1643  uint32_t dot1sMSTInstance,
1644  uint32_t ifNum,
1645  uint32_t *loopCount);
1646 
1647 /*****************************************************************/
1661 open_error_t openapiDot1SPortStatsClear(openapiClientHandle_t *client_handle,
1662  uint32_t ifNum);
1663 
1664 /*****************************************************************/
1680 open_error_t openapiDot1SPortRestrictedTcnGet(openapiClientHandle_t *client_handle,
1681  uint32_t ifNum,
1682  OPEN_BOOL_t *mode);
1683 
1684 /*****************************************************************/
1700 open_error_t openapiDot1SPortRestrictedTcnSet(openapiClientHandle_t *client_handle,
1701  uint32_t ifNum,
1702  OPEN_BOOL_t val);
1703 
1704 /*****************************************************************/
1720 open_error_t openapiDot1SPortAutoEdgeGet(openapiClientHandle_t *client_handle,
1721  uint32_t ifNum,
1722  OPEN_BOOL_t *mode);
1723 
1724 /*****************************************************************/
1740 open_error_t openapiDot1SPortAutoEdgeSet(openapiClientHandle_t *client_handle,
1741  uint32_t ifNum,
1742  OPEN_BOOL_t mode);
1743 
1744 /*****************************************************************/
1759 open_error_t openapiDot1SPortUpTimeGet(openapiClientHandle_t *client_handle,
1760  uint32_t ifNum,
1761  open_buffdesc *upTime);
1762 
1763 /*****************************************************************/
1778 open_error_t openapiDot1SPortStatsSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1779  uint32_t ifNum,
1780  uint32_t *val);
1781 
1782 /*****************************************************************/
1797 open_error_t openapiDot1SPortStatsSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1798  uint32_t ifNum,
1799  uint32_t *val);
1800 
1801 /*****************************************************************/
1816 open_error_t openapiDot1SPortStatsRSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1817  uint32_t ifNum,
1818  uint32_t *val);
1819 
1820 /*****************************************************************/
1835 open_error_t openapiDot1SPortStatsRSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1836  uint32_t ifNum,
1837  uint32_t *val);
1838 
1839 /*****************************************************************/
1854 open_error_t openapiDot1SPortStatsMSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1855  uint32_t ifNum,
1856  uint32_t *val);
1857 
1858 /*****************************************************************/
1873 open_error_t openapiDot1SPortStatsMSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1874  uint32_t ifNum,
1875  uint32_t *val);
1876 
1877 /*************************************************************************/
1891 open_error_t openapiDot1sCistBridgeMaxAgeGet(openapiClientHandle_t *client_handle,
1892  uint32_t *maxAge);
1893 
1894 /*************************************************************************/
1909 open_error_t openapiDot1sCistBridgeMaxAgeSet(openapiClientHandle_t *client_handle,
1910  uint32_t maxAge);
1911 
1912 /*************************************************************************/
1926 open_error_t openapiDot1sCistBridgeHelloTimeGet(openapiClientHandle_t *client_handle,
1927  uint32_t *helloTime);
1928 
1929 /*************************************************************************/
1943 open_error_t openapiDot1sCistBridgFwdDelayGet(openapiClientHandle_t *client_handle,
1944  uint32_t *fwdDelay);
1945 
1946 /*************************************************************************/
1961 open_error_t openapiDot1sCistBridgeFwdDelaySet(openapiClientHandle_t *client_handle,
1962  uint32_t fwdDelay);
1963 
1964 /*************************************************************************/
1979 open_error_t openapiDot1sBridgeMaxHopSet(openapiClientHandle_t *client_handle,
1980  uint32_t maxHopCount);
1981 
1982 /*************************************************************************/
1998 open_error_t openapiDot1sBridgeTxHoldCountSet(openapiClientHandle_t *client_handle,
1999  uint32_t txHoldCount);
2000 
2001 /*************************************************************************/
2015 open_error_t openapiDot1sCistRootFwdDelayGet(openapiClientHandle_t *client_handle,
2016  uint32_t *fwdDelay);
2017 
2018 /*************************************************************************/
2033 open_error_t openapiDot1sTopologyChangePortIDGet(openapiClientHandle_t *client_handle,
2034  uint32_t *portId);
2035 
2036 /*************************************************************************/
2052 open_error_t openapiDot1sMstiPortPathCostGet(openapiClientHandle_t *client_handle,
2053  uint32_t mstId, uint32_t ifNum,
2054  uint32_t *portPathCost);
2055 
2056 /*************************************************************************/
2070 open_error_t openapiDot1sConfigDigestKeyGet(openapiClientHandle_t *client_handle,
2071  open_buffdesc *digestKeyBuf);
2072 
2073 /*************************************************************************/
2091 open_error_t
2092 openapiDot1sMstiTimeSinceTopologyChangeGet(openapiClientHandle_t *client_handle,
2093  uint32_t mstID, uint32_t *days,
2094  uint32_t *hours, uint32_t *minutes,
2095  uint32_t *seconds);
2096 
2097 /*************************************************************************/
2116 open_error_t openapiDot1sPortNextGet(openapiClientHandle_t *client_handle,
2117  uint32_t mstID, uint32_t prevIntIfNum,
2118  uint32_t *intIfNum);
2119 
2120 #endif /* OPENAPI_DOT1S_H_INCLUDED */
2121 
OPEN_DOT1S_ROLE_MASTER
MasterPort.
Definition: openapi_dot1s.h:81
openapiDot1SCistPortTopologyChangeAckGet
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.
openapiDot1SBPDUFilterModeGet
open_error_t openapiDot1SBPDUFilterModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sBPDUFilter)
Gets the Spanning Tree BPDU Filter Mode.
openapiDot1sBridgeTxHoldCountSet
open_error_t openapiDot1sBridgeTxHoldCountSet(openapiClientHandle_t *client_handle, uint32_t txHoldCount)
Set the MSTP transmit hold count parameter for the device.
openapiDot1SModeGet
open_error_t openapiDot1SModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sMode)
Gets Spanning Tree Operational Mode.
OPEN_DOT1S_FORCE_VERSION_DOT1S
IEEE 802.1s Multiple Spanning Tree.
Definition: openapi_dot1s.h:48
openapiDot1SIntfEdgePortModeGet
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...
openapiDot1SMSTInstancePrioritySet
open_error_t openapiDot1SMSTInstancePrioritySet(openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t priority)
Configures Spanning Tree MST Instance priority.
openapiDot1SCistPortOperPointToPointGet
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.
openapiDot1SIntfPortRoleGet
open_error_t openapiDot1SIntfPortRoleGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t dot1sInstance, OPEN_DOT1S_PORT_ROLE_t *dot1sPortRole)
Gets Spanning Tree Port Role.
OPEN_DOT1S_MGMT_STR_CONFIG_NAME
String type Configuration name.
Definition: openapi_dot1s.h:61
openapiDot1SMstiPortPathCostSet
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.
openapiDot1SIntfEdgePortModeSet
open_error_t openapiDot1SIntfEdgePortModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sEdgePortMode)
OPEN_DOT1S_PORT_ROLE_t
OPEN_DOT1S_PORT_ROLE_t
Definition: openapi_dot1s.h:74
openapiDot1SMSTInstancePriorityGet
open_error_t openapiDot1SMSTInstancePriorityGet(openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint16_t *priority)
Gets Spanning Tree MST Instance priority.
openapiDot1SConfigRevisionGet
open_error_t openapiDot1SConfigRevisionGet(openapiClientHandle_t *client_handle, uint32_t *dot1sConfigRev)
Gets the Spanning Tree Configuration Revision.
OPEN_DOT1S_PORT_GUARD_LOOP
Port Guard Loop.
Definition: openapi_dot1s.h:54
openapiDot1sCistBridgFwdDelayGet
open_error_t openapiDot1sCistBridgFwdDelayGet(openapiClientHandle_t *client_handle, uint32_t *fwdDelay)
Get the MSTP Bridge forward delay for the CIST.
OPEN_DOT1S_PORT_LEARNING
Port state Learning.
Definition: openapi_dot1s.h:67
openapiDot1SIntfBPDUFilterModeSet
open_error_t openapiDot1SIntfBPDUFilterModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFilterMode)
Configures Spanning Tree BPDU Filter mode for an interface.
openapiDot1SMSTInstanceNextFIdGet
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.
openapiDot1SPortRestrictedTcnSet
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_DOT1S_FORCE_VERSION_t
Definition: openapi_dot1s.h:43
OPEN_DOT1S_PORT_GUARD_ROOT
Port Guard Root.
Definition: openapi_dot1s.h:55
openapiDot1sCISTRegionalRootIDGet
open_error_t openapiDot1sCISTRegionalRootIDGet(openapiClientHandle_t *client_handle, OPEN_DOT1S_BRIDGEID_t *rootId)
Get the CIST Regional Root Identifier.
openapiDot1sCISTRegionalRootPathCostGet
open_error_t openapiDot1sCISTRegionalRootPathCostGet(openapiClientHandle_t *client_handle, uint32_t *cost)
Get the CIST Regional Root Path Cost.
OPEN_DOT1S_PORT_MANUAL_FWD
Port state Manual Forward.
Definition: openapi_dot1s.h:70
openapiDot1SIntfBPDUFilterModeGet
open_error_t openapiDot1SIntfBPDUFilterModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sBPDUFilterMode)
Gets Spanning Tree BPDU Filter mode for an interface.
openapiDot1SPortAutoEdgeGet
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_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiDot1SModeSet
open_error_t openapiDot1SModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sMode)
Enables/Disables Spanning Tree Operational Mode.
openapiDot1SCistExtPortPathCostSet
open_error_t openapiDot1SCistExtPortPathCostSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t portCost)
Sets the CIST External Port Path Cost on an interface.
openapiDot1SCistPortOperEdgeGet
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.
openapiDot1sMSTInstanceTopologyChangeCountGet
open_error_t openapiDot1sMSTInstanceTopologyChangeCountGet(openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t *count)
Get the Spanning Tree MST count of Topology Changes in a specific instance.
openapiDot1sCistRootFwdDelayGet
open_error_t openapiDot1sCistRootFwdDelayGet(openapiClientHandle_t *client_handle, uint32_t *fwdDelay)
Get the MSTP root port forward delay for the CIST.
openapiDot1SIntfModeGet
open_error_t openapiDot1SIntfModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sMode)
Gets Spanning Tree Admin Mode on an interface.
openapiDot1SCistExtPortPathCostGet
open_error_t openapiDot1SCistExtPortPathCostGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *portCost)
Gets the CIST External Port Path Cost on an interface.
openapiDot1SMstiPortLoopInconsistentStateGet
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.
openapiDot1SMSTInstanceNextGet
open_error_t openapiDot1SMSTInstanceNextGet(openapiClientHandle_t *client_handle, uint32_t currInstance, uint32_t *nextInstance)
Gets Next Spanning Tree MST Instance.
openapiDot1sCISTRootFwdDelayGet
open_error_t openapiDot1sCISTRootFwdDelayGet(openapiClientHandle_t *client_handle, uint32_t *delay)
Get the CIST Bridge Forward Delay.
openapiDot1SMstiOperPortPathCostGet
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.
openapiDot1SIntfHelloTimeGet
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.
OPEN_DOT1S_FORCE_VERSION_DOT1D
IEEE 802.1d Spanning Tree.
Definition: openapi_dot1s.h:45
openapiDot1SMSTInstanceNextVLANGet
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_buffdesc
Definition: openapi_common.h:138
openapiDot1SPortStatsClear
open_error_t openapiDot1SPortStatsClear(openapiClientHandle_t *client_handle, uint32_t ifNum)
Clears the port stats.
openapiDot1SMstiDesignatedCostGet
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_DOT1S_FORCE_VERSION_UNUSED
unused
Definition: openapi_dot1s.h:46
openapiClientHandle_s
Definition: openapi_common.h:131
openapiDot1SIntfModeSet
open_error_t openapiDot1SIntfModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sMode)
Enables/Disables Spanning Tree Admin Mode on an interface.
openapiDot1SIntfGuardModeGet
open_error_t openapiDot1SIntfGuardModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1S_PORT_GUARD_t *dot1sGuardMode)
Gets Spanning Tree Guard mode.
openapiDot1sCISTBridgeHoldTimeGet
open_error_t openapiDot1sCISTBridgeHoldTimeGet(openapiClientHandle_t *client_handle, uint32_t *holdTime)
Get the CIST Bridge Hold Time.
openapiDot1sMSTInstanceRootPathCostGet
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.
openapiDot1SPortStatsMSTPBPDUsReceivedGet
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.
openapiDot1SMstiPortPathCostModeGet
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.
openapiDot1SIntfGuardModeSet
open_error_t openapiDot1SIntfGuardModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode)
Configures Spanning Tree Guard mode.
OPEN_DOT1S_ROLE_BACKUP
BackupPort.
Definition: openapi_dot1s.h:80
openapiDot1sBridgeMaxHopSet
open_error_t openapiDot1sBridgeMaxHopSet(openapiClientHandle_t *client_handle, uint32_t maxHopCount)
Set the MSTP max hop count parameter for the device.
openapiDot1SMstiPortDesignatedRootIDGet
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.
openapiDot1SPortAutoEdgeSet
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.
openapiDot1SMSTInstanceVLANSet
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.
openapiDot1SConfigNameGet
open_error_t openapiDot1SConfigNameGet(openapiClientHandle_t *client_handle, open_buffdesc *dot1sConfigName)
Gets the Spanning Tree Configuration Name.
openapiDot1SBPDUGuardModeSet
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_DOT1S_PORT_FWD_STATE_t
Definition: openapi_dot1s.h:64
openapiDot1SCistExtPortPathCostModeGet
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_DOT1S_PORT_GUARD_NONE
Port Guard None.
Definition: openapi_dot1s.h:56
openapiDot1sMSTInstanceTimeSinceTopologyChangeGet
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_DOT1S_ROLE_ROOT
RootPort.
Definition: openapi_dot1s.h:77
OPEN_DOT1S_ROLE_DISABLED
DisabledPort.
Definition: openapi_dot1s.h:76
OPEN_ACTION_t
OPEN_ACTION_t
OPEN uses these enumerators to indicate the interface types.
Definition: openapi_common.h:194
openapiDot1SPortStatsSTPBPDUsSentGet
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.
openapiDot1sPortNextGet
open_error_t openapiDot1sPortNextGet(openapiClientHandle_t *client_handle, uint32_t mstID, uint32_t prevIntIfNum, uint32_t *intIfNum)
Get the next port participating in MSTP associated with the specified MSTP instance ID...
OPEN_DOT1S_FORCE_VERSION_DOT1W
IEEE 802.1w Rapid Spanning Tree.
Definition: openapi_dot1s.h:47
openapiDot1SBPDUFilterModeSet
open_error_t openapiDot1SBPDUFilterModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUFilter)
Configures Spanning Tree BPDU Filter Mode.
openapiDot1SPortRestrictedTcnGet
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.
openapiDot1SPortStatsTransitionsIntoLoopInconsistentStateGet
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...
openapiDot1SConfigNameSet
open_error_t openapiDot1SConfigNameSet(openapiClientHandle_t *client_handle, open_buffdesc *dot1sConfigName)
Configures Spanning Tree Configuration Name.
OPEN_CONTROL_t
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
Definition: openapi_common.h:163
openapiDot1SMstiDesignatedBridgeIDGet
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...
openapiDot1sMstiPortPathCostGet
open_error_t openapiDot1sMstiPortPathCostGet(openapiClientHandle_t *client_handle, uint32_t mstId, uint32_t ifNum, uint32_t *portPathCost)
Get the MSTP port path cost in a specific instance.
openapiDot1sCISTMaxAgeGet
open_error_t openapiDot1sCISTMaxAgeGet(openapiClientHandle_t *client_handle, uint32_t *age)
Get the max age for the CIST.
openapiDot1SMSTInstanceFirstFIdGet
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.
openapiDot1VlanMaxGet
open_error_t openapiDot1VlanMaxGet(openapiClientHandle_t *client_handle, uint32_t *vlanMax)
Get the maximum number of Spanning Tree VLANs.
openapiDot1SMstiDesignatedPortIDGet
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.
openapiDot1SIntfBPDUFloodModeSet
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_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:179
OPEN_DOT1S_BRIDGEID_t
DOT1S general bridge identifier formed by combining the bridge priority, instance identifier...
Definition: openapi_dot1s.h:107
openapiDot1SPortStatsRSTPBPDUsSentGet
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.
openapiDot1SMSTIntfPortIDGet
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.
openapiDot1SForceVersionSet
open_error_t openapiDot1SForceVersionSet(openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion)
Configures Spanning Tree Force Revision.
openapiDot1SCistPortRegionalRootIDGet
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.
openapiDot1SPortUpTimeGet
open_error_t openapiDot1SPortUpTimeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *upTime)
Gets the MSTP Up Time of the port.
OPEN_DOT1S_ROLE_ALTERNATE
AlternatePort.
Definition: openapi_dot1s.h:79
openapiDot1SPortStatsMSTPBPDUsSentGet
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.
openapiDot1sMSTInstanceTopologyChangeStateGet
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. ...
openapiDot1sCistBridgeMaxAgeSet
open_error_t openapiDot1sCistBridgeMaxAgeSet(openapiClientHandle_t *client_handle, uint32_t maxAge)
Set the MSTP Bridge Max Age parameter for the CIST.
openapiDot1sBridgeMaxHopGet
open_error_t openapiDot1sBridgeMaxHopGet(openapiClientHandle_t *client_handle, uint32_t *count)
Get the Max Hop count for the device.
openapiDot1SIntfPortFwdStateGet
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.
openapiDot1sMstiTimeSinceTopologyChangeGet
open_error_t openapiDot1sMstiTimeSinceTopologyChangeGet(openapiClientHandle_t *client_handle, uint32_t mstID, uint32_t *days, uint32_t *hours, uint32_t *minutes, uint32_t *seconds)
Get the MSTP Time since the last Topology Change in an instance.
openapiDot1SMSTInstanceSet
open_error_t openapiDot1SMSTInstanceSet(openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstanceId, OPEN_ACTION_t action)
Creates/Deletes Spanning Tree MST Instance.
openapiDot1SIntfPortLoopInconsistentStateGet
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...
openapiDot1SForceVersionGet
open_error_t openapiDot1SForceVersionGet(openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t *dot1sForceVersion)
Gets the Spanning Tree Force Revision.
openapiDot1sMgmtStrLenGet
open_error_t openapiDot1sMgmtStrLenGet(openapiClientHandle_t *client_handle, OPEN_DOT1S_MGMT_STR_t strType, uint32_t *strLen)
Gets the Spanning Tree Management string length.
openapiDot1SIntfBPDUFloodModeGet
open_error_t openapiDot1SIntfBPDUFloodModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sBPDUFloodMode)
Gets Spanning Tree BPDU Flood mode for an interface.
openapiDot1SPortStatsRSTPBPDUsReceivedGet
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.
openapiDot1sTopologyChangePortIDGet
open_error_t openapiDot1sTopologyChangePortIDGet(openapiClientHandle_t *client_handle, uint32_t *portId)
Get the port ID that triggered topology change.
openapiDot1SMSTInstanceFirstVLANGet
open_error_t openapiDot1SMSTInstanceFirstVLANGet(openapiClientHandle_t *client_handle, uint32_t dot1sInstance, uint32_t *VLANId)
Gets First VLAN Id for the Spanning Tree MST Instance.
openapiDot1SPortStatsTransitionsOutOfLoopInconsistentStateGet
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...
openapiDot1SBPDUGuardModeGet
open_error_t openapiDot1SBPDUGuardModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sBPDUGuard)
Gets the Spanning Tree BPDU Guard Mode.
OPEN_DOT1S_PORT_FORWARDING
Port state Forwarding.
Definition: openapi_dot1s.h:68
openapiDot1sMSTInstanceBridgeIdentifierGet
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.
openapiDot1SCistPortPathCostGet
open_error_t openapiDot1SCistPortPathCostGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *portCost)
Gets the CIST port path cost.
openapiDot1SMstiPortPrioritySet
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.
openapi_common.h
openapiDot1SCistHelloTimeGet
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
OPEN_DOT1S_PORT_GUARD_t
Definition: openapi_dot1s.h:52
OPEN_DOT1S_MGMT_STR_t
OPEN_DOT1S_MGMT_STR_t
Definition: openapi_dot1s.h:59
openapiDot1SConfigRevisionSet
open_error_t openapiDot1SConfigRevisionSet(openapiClientHandle_t *client_handle, uint32_t dot1sConfigRev)
Configures Spanning Tree Configuration Revision.
openapiDot1sMSTInstanceRootPortIDGet
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.
openapiDot1SPortStatsSTPBPDUsReceivedGet
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.
openapiDot1sCistBridgeMaxAgeGet
open_error_t openapiDot1sCistBridgeMaxAgeGet(openapiClientHandle_t *client_handle, uint32_t *maxAge)
Get the MSTP Bridge Max Age parameter for the CIST.
OPEN_DOT1S_FORCE_VERSION_LAST
must be last
Definition: openapi_dot1s.h:49
openapiDot1sCISTHelloTimeGet
open_error_t openapiDot1sCISTHelloTimeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *helloTime)
Get the CIST Hello Time of a specific port.
OPEN_DOT1S_ROLE_DESIGNATED
DesignatedPort.
Definition: openapi_dot1s.h:78
openapiDot1sCistBridgeFwdDelaySet
open_error_t openapiDot1sCistBridgeFwdDelaySet(openapiClientHandle_t *client_handle, uint32_t fwdDelay)
Set the MSTP Bridge forward delay for the CIST.
openapiDot1sMSTInstanceDesignatedRootIDGet
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.
openapiDot1SMSTInstanceFirstGet
open_error_t openapiDot1SMSTInstanceFirstGet(openapiClientHandle_t *client_handle, uint32_t *instanceId)
Gets First Spanning Tree MST Instance.
OPEN_DOT1S_PORT_DISABLED
Port state Disabled.
Definition: openapi_dot1s.h:69
openapiDot1SMstiPortPriorityGet
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.
openapiDot1sConfigDigestKeyGet
open_error_t openapiDot1sConfigDigestKeyGet(openapiClientHandle_t *client_handle, open_buffdesc *digestKeyBuf)
Get the MSTP Configuration Digest Key.
OPEN_DOT1S_PORT_DISCARDING
Port state Discarding.
Definition: openapi_dot1s.h:66
OPEN_DOT1S_PORT_NOT_PARTICIPATE
Port state Not Participating.
Definition: openapi_dot1s.h:71
openapiDot1sBridgeTxHoldCountGet
open_error_t openapiDot1sBridgeTxHoldCountGet(openapiClientHandle_t *client_handle, uint32_t *count)
Get the Tx Hold count for the device.
openapiDot1sCistBridgeHelloTimeGet
open_error_t openapiDot1sCistBridgeHelloTimeGet(openapiClientHandle_t *client_handle, uint32_t *helloTime)
Get the MSTP Bridge hello time parameter for the CIST.
openapiDot1SIntfBPDUGuardEffectGet
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.