Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
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 
105 typedef struct
106 {
107  uint8_t octets[OPEN_DOT1S_VID_MAC_ADDR_LEN];
108 } OPEN_DOT1S_BRIDGEID_t;
109 
110 
111 /*****************************************************************/
127 open_error_t openapiDot1sMgmtStrLenGet(openapiClientHandle_t *client_handle,
128  OPEN_DOT1S_MGMT_STR_t strType,
129  uint32_t *strLen);
130 
131 /*****************************************************************/
144 open_error_t openapiDot1VlanMaxGet(openapiClientHandle_t *client_handle,
145  uint32_t *vlanMax);
146 
147 /*****************************************************************/
163 open_error_t openapiDot1SModeSet(openapiClientHandle_t *client_handle,
164  OPEN_CONTROL_t dot1sMode);
165 
166 /*****************************************************************/
181 open_error_t openapiDot1SModeGet(openapiClientHandle_t *client_handle,
182  OPEN_CONTROL_t *dot1sMode);
183 
184 /*****************************************************************/
201 open_error_t openapiDot1SIntfBPDUFilterModeSet(openapiClientHandle_t *client_handle,
202  uint32_t ifNum,
203  OPEN_CONTROL_t dot1sBPDUFilterMode);
204 
205 /*****************************************************************/
221 open_error_t openapiDot1SIntfBPDUFilterModeGet(openapiClientHandle_t *client_handle,
222  uint32_t ifNum,
223  OPEN_CONTROL_t *dot1sBPDUFilterMode);
224 
225 /*****************************************************************/
242 open_error_t openapiDot1SIntfBPDUFloodModeSet(openapiClientHandle_t *client_handle,
243  uint32_t ifNum,
244  OPEN_CONTROL_t dot1sBPDUFloodMode);
245 
246 /*****************************************************************/
262 open_error_t openapiDot1SIntfBPDUFloodModeGet(openapiClientHandle_t *client_handle,
263  uint32_t ifNum,
264  OPEN_CONTROL_t *dot1sBPDUFloodMode);
265 
266 /*****************************************************************/
281 open_error_t openapiDot1SBPDUGuardModeSet(openapiClientHandle_t *client_handle,
282  OPEN_CONTROL_t dot1sBPDUGuard);
283 
284 /*****************************************************************/
298 open_error_t openapiDot1SBPDUGuardModeGet(openapiClientHandle_t *client_handle,
299  OPEN_CONTROL_t *dot1sBPDUGuard);
300 
301 /*****************************************************************/
316 open_error_t openapiDot1SBPDUFilterModeSet(openapiClientHandle_t *client_handle,
317  OPEN_CONTROL_t dot1sBPDUFilter);
318 
319 /*****************************************************************/
333 open_error_t openapiDot1SBPDUFilterModeGet(openapiClientHandle_t *client_handle,
334  OPEN_CONTROL_t *dot1sBPDUFilter);
335 
336 /*****************************************************************/
354 open_error_t openapiDot1SConfigNameSet(openapiClientHandle_t *client_handle,
355  open_buffdesc *dot1sConfigName);
356 
357 /*****************************************************************/
373 open_error_t openapiDot1SConfigNameGet(openapiClientHandle_t *client_handle,
374  open_buffdesc *dot1sConfigName);
375 
376 /*****************************************************************/
393 open_error_t openapiDot1SConfigRevisionSet(openapiClientHandle_t *client_handle,
394  uint32_t dot1sConfigRev);
395 
396 /*****************************************************************/
410 open_error_t openapiDot1SConfigRevisionGet(openapiClientHandle_t *client_handle,
411  uint32_t *dot1sConfigRev);
412 
413 /*****************************************************************/
428 open_error_t openapiDot1SForceVersionSet(openapiClientHandle_t *client_handle,
429  OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion);
430 
431 /*****************************************************************/
445 open_error_t openapiDot1SForceVersionGet(openapiClientHandle_t *client_handle,
446  OPEN_DOT1S_FORCE_VERSION_t *dot1sForceVersion);
447 
448 /*****************************************************************/
464 open_error_t openapiDot1SIntfGuardModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum,
465  OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode);
466 
467 /*****************************************************************/
483 open_error_t openapiDot1SIntfGuardModeGet(openapiClientHandle_t *client_handle,
484  uint32_t ifNum,
485  OPEN_DOT1S_PORT_GUARD_t *dot1sGuardMode);
486 
487 /*****************************************************************/
505 open_error_t openapiDot1SMSTInstanceSet(openapiClientHandle_t *client_handle,
506  uint32_t dot1sMSTInstanceId,
507  OPEN_ACTION_t action);
508 
509 /*****************************************************************/
523 open_error_t openapiDot1SMSTInstanceFirstGet(openapiClientHandle_t *client_handle,
524  uint32_t *instanceId);
525 
526 /*****************************************************************/
541 open_error_t openapiDot1SMSTInstanceNextGet(openapiClientHandle_t *client_handle,
542  uint32_t currInstance,
543  uint32_t *nextInstance);
544 
545 /*****************************************************************/
565 open_error_t openapiDot1SMSTInstancePrioritySet(openapiClientHandle_t *client_handle,
566  uint32_t dot1sMSTInstance,
567  uint32_t priority);
568 
569 /*****************************************************************/
584 open_error_t openapiDot1SMSTInstancePriorityGet(openapiClientHandle_t *client_handle,
585  uint32_t dot1sMSTInstance,
586  uint16_t *priority);
587 
588 /*****************************************************************/
609 open_error_t openapiDot1SMSTInstanceVLANSet(openapiClientHandle_t *client_handle,
610  uint32_t dot1sMSTInstance,
611  uint32_t vlan,
612  OPEN_ACTION_t action);
613 /*****************************************************************/
628 open_error_t openapiDot1SMSTInstanceFirstVLANGet(openapiClientHandle_t *client_handle,
629  uint32_t dot1sInstance,
630  uint32_t *VLANId);
631 
632 /*****************************************************************/
648 open_error_t openapiDot1SMSTInstanceNextVLANGet(openapiClientHandle_t *client_handle,
649  uint32_t dot1sInstance,
650  uint32_t currVLANId, uint32_t *nextVLANId);
651 
652 /*****************************************************************/
667 open_error_t openapiDot1SMSTInstanceFirstFIdGet(openapiClientHandle_t *client_handle,
668  uint32_t dot1sInstance,
669  uint32_t *FId);
670 
671 /*****************************************************************/
687 open_error_t openapiDot1SMSTInstanceNextFIdGet(openapiClientHandle_t *client_handle,
688  uint32_t dot1sInstance,
689  uint32_t currFId, uint32_t *nextFId);
690 
691 /*************************************************************************/
710 open_error_t openapiDot1sMSTInstanceBridgeIdentifierGet(openapiClientHandle_t *client_handle,
711  uint32_t dot1sMSTInstance,
712  OPEN_DOT1S_BRIDGEID_t *id);
713 
714 /*************************************************************************/
733 open_error_t openapiDot1sMSTInstanceTimeSinceTopologyChangeGet(openapiClientHandle_t *client_handle,
734  uint32_t dot1sMSTInstance,
735  uint32_t *timeVal);
736 
737 /*************************************************************************/
756 open_error_t openapiDot1sMSTInstanceTopologyChangeCountGet(openapiClientHandle_t *client_handle,
757  uint32_t dot1sMSTInstance,
758  uint32_t *count);
759 
760 /*************************************************************************/
780 open_error_t openapiDot1sMSTInstanceTopologyChangeStateGet(openapiClientHandle_t *client_handle,
781  uint32_t dot1sMSTInstance,
782  OPEN_BOOL_t *change);
783 
784 /*************************************************************************/
803 open_error_t openapiDot1sMSTInstanceDesignatedRootIDGet(openapiClientHandle_t *client_handle,
804  uint32_t dot1sMSTInstance,
805  OPEN_DOT1S_BRIDGEID_t *rootId);
806 
807 /*************************************************************************/
826 open_error_t openapiDot1sMSTInstanceRootPathCostGet(openapiClientHandle_t *client_handle,
827  uint32_t dot1sMSTInstance,
828  uint32_t *cost);
829 
830 /*************************************************************************/
849 open_error_t openapiDot1sMSTInstanceRootPortIDGet(openapiClientHandle_t *client_handle,
850  uint32_t dot1sMSTInstance,
851  uint32_t *port);
852 
853 /*************************************************************************/
867 open_error_t openapiDot1sCISTMaxAgeGet(openapiClientHandle_t *client_handle,
868  uint32_t *age);
869 
870 /*************************************************************************/
884 open_error_t openapiDot1sBridgeMaxHopGet(openapiClientHandle_t *client_handle,
885  uint32_t *count);
886 
887 /*************************************************************************/
901 open_error_t openapiDot1sBridgeTxHoldCountGet(openapiClientHandle_t *client_handle,
902  uint32_t *count);
903 
904 /*************************************************************************/
918 open_error_t openapiDot1sCISTRootFwdDelayGet(openapiClientHandle_t *client_handle,
919  uint32_t *delay);
920 
921 /*************************************************************************/
936 open_error_t openapiDot1sCISTHelloTimeGet(openapiClientHandle_t *client_handle,
937  uint32_t ifNum,
938  uint32_t *helloTime);
939 
940 /*************************************************************************/
954 open_error_t openapiDot1sCISTBridgeHoldTimeGet(openapiClientHandle_t *client_handle,
955  uint32_t *holdTime);
956 
957 /*************************************************************************/
971 open_error_t openapiDot1sCISTRegionalRootIDGet(openapiClientHandle_t *client_handle,
972  OPEN_DOT1S_BRIDGEID_t *rootId);
973 
974 /*************************************************************************/
988 open_error_t openapiDot1sCISTRegionalRootPathCostGet(openapiClientHandle_t *client_handle,
989  uint32_t *cost);
990 
991 /*****************************************************************/
1007 open_error_t openapiDot1SIntfModeSet(openapiClientHandle_t *client_handle,
1008  uint32_t ifNum,
1009  OPEN_CONTROL_t dot1sMode);
1010 
1011 /*****************************************************************/
1027 open_error_t openapiDot1SIntfModeGet(openapiClientHandle_t *client_handle,
1028  uint32_t ifNum,
1029  OPEN_CONTROL_t *dot1sMode);
1030 
1031 /*****************************************************************/
1047 open_error_t openapiDot1SIntfPortFwdStateGet(openapiClientHandle_t *client_handle,
1048  uint32_t ifNum,
1049  uint32_t dot1sInstance,
1050  OPEN_DOT1S_PORT_FWD_STATE_t *dot1sPortFwdState);
1051 
1052 /*****************************************************************/
1068 open_error_t openapiDot1SIntfPortRoleGet(openapiClientHandle_t *client_handle,
1069  uint32_t ifNum,
1070  uint32_t dot1sInstance,
1071  OPEN_DOT1S_PORT_ROLE_t *dot1sPortRole);
1072 
1073 /*****************************************************************/
1090 open_error_t openapiDot1SIntfPortLoopInconsistentStateGet(openapiClientHandle_t *client_handle,
1091  uint32_t ifNum,
1092  uint32_t dot1sInstance,
1093  OPEN_BOOL_t *loopInconsistentState);
1094 
1095 /*****************************************************************/
1111 open_error_t openapiDot1SIntfEdgePortModeSet(openapiClientHandle_t *client_handle,
1112  uint32_t ifNum,
1113  OPEN_CONTROL_t dot1sEdgePortMode);
1114 
1115 /*****************************************************************/
1132 open_error_t openapiDot1SIntfEdgePortModeGet(openapiClientHandle_t *client_handle,
1133  uint32_t ifNum,
1134  uint32_t *dot1sEdgePortMode);
1135 
1136 /*****************************************************************/
1152 open_error_t openapiDot1SIntfHelloTimeGet(openapiClientHandle_t *client_handle,
1153  uint32_t ifNum,
1154  uint32_t *helloTime);
1155 
1156 /*****************************************************************/
1172 open_error_t openapiDot1SIntfBPDUGuardEffectGet(openapiClientHandle_t *client_handle,
1173  uint32_t ifNum,
1174  OPEN_CONTROL_t *mode);
1175 
1176 /*****************************************************************/
1195 open_error_t openapiDot1SMSTIntfPortIDGet(openapiClientHandle_t *client_handle,
1196  uint32_t dot1sMSTInstance,
1197  uint32_t ifNum,
1198  open_buffdesc *portID);
1199 
1200 /*****************************************************************/
1218 open_error_t openapiDot1SMstiPortPrioritySet(openapiClientHandle_t *client_handle,
1219  uint32_t dot1sMSTInstance,
1220  uint32_t ifNum,
1221  uint32_t priority);
1222 
1223 /*****************************************************************/
1241 open_error_t openapiDot1SMstiPortPriorityGet(openapiClientHandle_t *client_handle,
1242  uint32_t dot1sMSTInstance,
1243  uint32_t ifNum,
1244  uint32_t *priority);
1245 
1246 /*****************************************************************/
1264 open_error_t openapiDot1SMstiPortPathCostModeGet(openapiClientHandle_t *client_handle,
1265  uint32_t dot1sMSTInstance,
1266  uint32_t ifNum,
1267  OPEN_CONTROL_t *costMode);
1268 
1269 /*****************************************************************/
1287 open_error_t openapiDot1SMstiPortPathCostSet(openapiClientHandle_t *client_handle,
1288  uint32_t dot1sMSTInstance,
1289  uint32_t ifNum,
1290  uint32_t pCost);
1291 
1292 /*****************************************************************/
1310 open_error_t openapiDot1SMstiOperPortPathCostGet(openapiClientHandle_t *client_handle,
1311  uint32_t dot1sMSTInstance,
1312  uint32_t ifNum,
1313  uint32_t *portCost);
1314 
1315 /*****************************************************************/
1330 open_error_t openapiDot1SCistExtPortPathCostModeGet(openapiClientHandle_t *client_handle,
1331  uint32_t ifNum,
1332  OPEN_CONTROL_t *costMode);
1333 
1334 /*****************************************************************/
1349 open_error_t openapiDot1SCistExtPortPathCostGet(openapiClientHandle_t *client_handle,
1350  uint32_t ifNum,
1351  uint32_t *portCost);
1352 
1353 /*****************************************************************/
1368 open_error_t openapiDot1SCistExtPortPathCostSet(openapiClientHandle_t *client_handle,
1369  uint32_t ifNum,
1370  uint32_t portCost);
1371 
1372 /*****************************************************************/
1389 open_error_t openapiDot1SMstiPortDesignatedRootIDGet(openapiClientHandle_t *client_handle,
1390  uint32_t dot1sMSTInstance,
1391  uint32_t ifNum,
1392  open_buffdesc *rootID);
1393 
1394 /*****************************************************************/
1411 open_error_t openapiDot1SMstiDesignatedCostGet(openapiClientHandle_t *client_handle,
1412  uint32_t dot1sMSTInstance,
1413  uint32_t ifNum,
1414  uint32_t *dCost);
1415 
1416 /*****************************************************************/
1433 open_error_t openapiDot1SMstiDesignatedBridgeIDGet(openapiClientHandle_t *client_handle,
1434  uint32_t dot1sMSTInstance,
1435  uint32_t ifNum,
1436  open_buffdesc *bridgeID);
1437 
1438 /*****************************************************************/
1455 open_error_t openapiDot1SMstiDesignatedPortIDGet(openapiClientHandle_t *client_handle,
1456  uint32_t dot1sMSTInstance,
1457  uint32_t ifNum,
1458  open_buffdesc *portID);
1459 
1460 /*****************************************************************/
1476 open_error_t openapiDot1SCistPortTopologyChangeAckGet(openapiClientHandle_t *client_handle,
1477  uint32_t ifNum,
1478  OPEN_BOOL_t *val);
1479 
1480 /*****************************************************************/
1494 open_error_t openapiDot1SCistHelloTimeGet(openapiClientHandle_t *client_handle,
1495  uint32_t *helloTime);
1496 
1497 /*****************************************************************/
1513 open_error_t openapiDot1SCistPortOperEdgeGet(openapiClientHandle_t *client_handle,
1514  uint32_t ifNum,
1515  OPEN_BOOL_t *status);
1516 
1517 /*****************************************************************/
1534 open_error_t openapiDot1SCistPortOperPointToPointGet(openapiClientHandle_t *client_handle,
1535  uint32_t ifNum,
1536  OPEN_BOOL_t *status);
1537 
1538 /*****************************************************************/
1553 open_error_t openapiDot1SCistPortRegionalRootIDGet(openapiClientHandle_t *client_handle,
1554  uint32_t ifNum,
1555  open_buffdesc *bridgeID);
1556 
1557 /*****************************************************************/
1572 open_error_t openapiDot1SCistPortPathCostGet(openapiClientHandle_t *client_handle,
1573  uint32_t ifNum,
1574  uint32_t *portCost);
1575 
1576 /*****************************************************************/
1592 open_error_t openapiDot1SMstiPortLoopInconsistentStateGet(openapiClientHandle_t *client_handle,
1593  uint32_t dot1sMSTInstance,
1594  uint32_t ifNum,
1595  OPEN_BOOL_t *status);
1596 
1597 /*****************************************************************/
1614 open_error_t
1615 openapiDot1SPortStatsTransitionsIntoLoopInconsistentStateGet(
1616  openapiClientHandle_t *client_handle,
1617  uint32_t dot1sMSTInstance,
1618  uint32_t ifNum,
1619  uint32_t *loopCount);
1620 
1621 /*****************************************************************/
1638 open_error_t
1639 openapiDot1SPortStatsTransitionsOutOfLoopInconsistentStateGet(
1640  openapiClientHandle_t *client_handle,
1641  uint32_t dot1sMSTInstance,
1642  uint32_t ifNum,
1643  uint32_t *loopCount);
1644 
1645 /*****************************************************************/
1659 open_error_t openapiDot1SPortStatsClear(openapiClientHandle_t *client_handle,
1660  uint32_t ifNum);
1661 
1662 /*****************************************************************/
1678 open_error_t openapiDot1SPortRestrictedTcnGet(openapiClientHandle_t *client_handle,
1679  uint32_t ifNum,
1680  OPEN_BOOL_t *mode);
1681 
1682 /*****************************************************************/
1698 open_error_t openapiDot1SPortRestrictedTcnSet(openapiClientHandle_t *client_handle,
1699  uint32_t ifNum,
1700  OPEN_BOOL_t val);
1701 
1702 /*****************************************************************/
1718 open_error_t openapiDot1SPortAutoEdgeGet(openapiClientHandle_t *client_handle,
1719  uint32_t ifNum,
1720  OPEN_BOOL_t *mode);
1721 
1722 /*****************************************************************/
1738 open_error_t openapiDot1SPortAutoEdgeSet(openapiClientHandle_t *client_handle,
1739  uint32_t ifNum,
1740  OPEN_BOOL_t mode);
1741 
1742 /*****************************************************************/
1757 open_error_t openapiDot1SPortUpTimeGet(openapiClientHandle_t *client_handle,
1758  uint32_t ifNum,
1759  open_buffdesc *upTime);
1760 
1761 /*****************************************************************/
1776 open_error_t openapiDot1SPortStatsSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1777  uint32_t ifNum,
1778  uint32_t *val);
1779 
1780 /*****************************************************************/
1795 open_error_t openapiDot1SPortStatsSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1796  uint32_t ifNum,
1797  uint32_t *val);
1798 
1799 /*****************************************************************/
1814 open_error_t openapiDot1SPortStatsRSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1815  uint32_t ifNum,
1816  uint32_t *val);
1817 
1818 /*****************************************************************/
1833 open_error_t openapiDot1SPortStatsRSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1834  uint32_t ifNum,
1835  uint32_t *val);
1836 
1837 /*****************************************************************/
1852 open_error_t openapiDot1SPortStatsMSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1853  uint32_t ifNum,
1854  uint32_t *val);
1855 
1856 /*****************************************************************/
1871 open_error_t openapiDot1SPortStatsMSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1872  uint32_t ifNum,
1873  uint32_t *val);
1874 
1875 /*************************************************************************/
1889 open_error_t openapiDot1sCistBridgeMaxAgeGet(openapiClientHandle_t *client_handle,
1890  uint32_t *maxAge);
1891 
1892 /*************************************************************************/
1907 open_error_t openapiDot1sCistBridgeMaxAgeSet(openapiClientHandle_t *client_handle,
1908  uint32_t maxAge);
1909 
1910 /*************************************************************************/
1924 open_error_t openapiDot1sCistBridgeHelloTimeGet(openapiClientHandle_t *client_handle,
1925  uint32_t *helloTime);
1926 
1927 /*************************************************************************/
1941 open_error_t openapiDot1sCistBridgFwdDelayGet(openapiClientHandle_t *client_handle,
1942  uint32_t *fwdDelay);
1943 
1944 /*************************************************************************/
1959 open_error_t openapiDot1sCistBridgeFwdDelaySet(openapiClientHandle_t *client_handle,
1960  uint32_t fwdDelay);
1961 
1962 /*************************************************************************/
1977 open_error_t openapiDot1sBridgeMaxHopSet(openapiClientHandle_t *client_handle,
1978  uint32_t maxHopCount);
1979 
1980 /*************************************************************************/
1996 open_error_t openapiDot1sBridgeTxHoldCountSet(openapiClientHandle_t *client_handle,
1997  uint32_t txHoldCount);
1998 
1999 /*************************************************************************/
2013 open_error_t openapiDot1sCistRootFwdDelayGet(openapiClientHandle_t *client_handle,
2014  uint32_t *fwdDelay);
2015 
2016 /*************************************************************************/
2031 open_error_t openapiDot1sTopologyChangePortIDGet(openapiClientHandle_t *client_handle,
2032  uint32_t *portId);
2033 
2034 /*************************************************************************/
2050 open_error_t openapiDot1sMstiPortPathCostGet(openapiClientHandle_t *client_handle,
2051  uint32_t mstId, uint32_t ifNum,
2052  uint32_t *portPathCost);
2053 
2054 
2055 #endif /* OPENAPI_DOT1S_H_INCLUDED */
2056 
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:137
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:130
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:193
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.
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:162
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:178
OPEN_DOT1S_BRIDGEID_t
DOT1S general bridge identifier formed by combining the bridge priority, instance identifier...
Definition: openapi_dot1s.h:105
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.
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.
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.