Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
openapi_vlan.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_vlan.h
28 *
29 * @purpose VLAN Configuration and Status
30 *
31 * @component OPEN
32 *
33 * @create 08/29/2012
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_VLAN_H_INCLUDED
39 #define OPENAPI_VLAN_H_INCLUDED
40 
41 #include <stdio.h>
42 #include <stddef.h>
43 #include <sys/un.h>
44 
45 #include "openapi_common.h"
46 
48 typedef enum
49 {
50  OPEN_DOT1Q_SWPORT_MODE_NONE = 0,
51  OPEN_DOT1Q_SWPORT_MODE_GENERAL = 1,
52  OPEN_DOT1Q_SWPORT_MODE_ACCESS = 2,
53  OPEN_DOT1Q_SWPORT_MODE_TRUNK = 3,
54  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_HOST = 4,
55  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC = 5,
56  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC_TRUNK = 6,
57  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_ISOLATED_TRUNK = 7,
58  OPEN_DOT1Q_SWPORT_MODE_AUTO_TRUNK = 8,
59 } OPEN_DOT1Q_SWPORT_MODE_t;
60 
62 #define OPEN_VLAN_LIST_MAX_ENTRIES 4096
63 
64 typedef struct
65 {
66  uint32_t numEntries;
67  uint16_t ids[OPEN_VLAN_LIST_MAX_ENTRIES];
68 } OPEN_VLAN_LIST_t;
69 
71 typedef enum
72 {
73  OPEN_PRIVATE_VLAN_UNCONFIGURED = 0,
74  OPEN_PRIVATE_VLAN_PRIMARY,
75  OPEN_PRIVATE_VLAN_SECONDARY_ISOLATED,
76  OPEN_PRIVATE_VLAN_SECONDARY_COMMUNITY,
77 } OPEN_DOT1Q_PVLAN_TYPE_t;
78 
79 
81 typedef enum
82 {
83  OPEN_PRIVATE_VLAN_UNCONFIGURED_PORT,
84  OPEN_PRIVATE_VLAN_HOST_PORT,
85  OPEN_PRIVATE_VLAN_COMMUNITY_PORT,
86  OPEN_PRIVATE_VLAN_PROMISCOUS_PORT
87 } OPEN_DOT1Q_PVLAN_PORT_TYPE_t;
88 
90 typedef enum
91 {
92  OPEN_DOT1Q_VLAN_TYPE_NOT_PARTICIPATING,
93  OPEN_DOT1Q_VLAN_TYPE_DEFAULT,
94  OPEN_DOT1Q_VLAN_TYPE_ADMIN,
95  OPEN_DOT1Q_VLAN_TYPE_GVRP_REGISTERED,
96  OPEN_DOT1Q_VLAN_TYPE_WS_L2_TNNL_REGISTERED,
97  OPEN_DOT1Q_VLAN_TYPE_IP_INTERNAL_VLAN,
98  OPEN_DOT1Q_VLAN_TYPE_AUTHMGR_REGISTERED,
99  OPEN_DOT1Q_VLAN_TYPE_MVRP_REGISTERED,
100  OPEN_DOT1Q_VLAN_TYPE_OPENFLOW_REGISTERED,
101  OPEN_DOT1Q_VLAN_TYPE_AUTO_VIDEO_REGISTERED,
102  OPEN_DOT1Q_VLAN_TYPE_EVC_REGISTERED,
103  OPEN_DOT1Q_VLAN_TYPE_PBB_REGISTERED
104 } OPEN_DOT1Q_VLAN_TYPE_t;
105 
106 #define OPEN_DOT1Q_UNTAGGED 0
107 #define OPEN_DOT1Q_TAGGED 1
108 
109 /*****************************************************************/
127 open_error_t openapiVlanNextGet(openapiClientHandle_t *client_handle,
128  uint32_t vlanNum,
129  uint32_t *nextVlanNum);
130 
131 /*****************************************************************/
144 open_error_t openapiVlanCreatedCheck(openapiClientHandle_t *client_handle,
145  uint32_t vlanNum);
146 
147 /*****************************************************************/
159 int openapiVlanIsStatic(openapiClientHandle_t *client_handle,
160  uint32_t vlanNum);
161 
162 /*****************************************************************/
178 open_error_t openapiVlanCreate(openapiClientHandle_t *client_handle,
179  uint32_t vlanNum);
180 
181 /*****************************************************************/
199 open_error_t openapiVlanDelete(openapiClientHandle_t *client_handle,
200  uint32_t vlanNum);
201 
202 /*****************************************************************/
218 open_error_t openapiVlanIfAcceptFrameTypeGet(openapiClientHandle_t *client_handle,
219  uint32_t ifNum,
220  OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t *type);
221 
222 /*****************************************************************/
238 open_error_t openapiVlanIfAcceptFrameTypeSet(openapiClientHandle_t *client_handle,
239  uint32_t ifNum,
240  OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t type);
241 
242 /*****************************************************************/
258 open_error_t openapiVlanIfPvidGet(openapiClientHandle_t *client_handle,
259  uint32_t ifNum,
260  uint32_t *vlanNum);
261 
262 /*****************************************************************/
280 open_error_t openapiVlanIfTaggingGet(openapiClientHandle_t *client_handle,
281  uint32_t ifNum,
282  uint32_t vlanNum,
283  OPEN_CONTROL_t *tagging);
284 
285 /*****************************************************************/
303 open_error_t openapiVlanIfParticipationStatusGet(openapiClientHandle_t *client_handle,
304  uint32_t vlanNum,
305  uint32_t ifNum,
306  uint32_t *participating);
307 
308 /*****************************************************************/
325 open_error_t openapiVlanNextChangedGet(openapiClientHandle_t *client_handle,
326  uint32_t vlanNum,
327  uint32_t *nextVlanNum,
328  uint32_t *delete_pending);
329 
330 /*****************************************************************/
353 open_error_t openapiVlanIfParticipationSet(openapiClientHandle_t *client_handle,
354  uint32_t vlanNum,
355  uint32_t ifNum,
356  OPEN_VLAN_PARTICIPATION_MODE_t participationMode);
357 
358 /*****************************************************************/
379 open_error_t openapiVlanIfParticipationGet(openapiClientHandle_t *client_handle,
380  uint32_t vlanNum,
381  uint32_t ifNum,
382  OPEN_VLAN_PARTICIPATION_MODE_t *participationMode);
383 
384 /*****************************************************************/
404 open_error_t openapiVlanIfPvidSet(openapiClientHandle_t *client_handle,
405  uint32_t ifNum,
406  uint32_t vlanNum);
407 
408 /*****************************************************************/
429 open_error_t openapiVlanIfTaggingSet(openapiClientHandle_t *client_handle,
430  uint32_t ifNum,
431  uint32_t vlanNum,
432  OPEN_CONTROL_t tagging);
433 
434 /*****************************************************************/
448 open_error_t openapiVlanIfNumTrafficClassesGet(openapiClientHandle_t *client_handle,
449  uint32_t ifNum,
450  uint32_t *numTrafficClasses);
451 
452 /*****************************************************************/
471 open_error_t openapiVlanIfDefaultUserPrioritySet(openapiClientHandle_t *client_handle,
472  uint32_t ifNum,
473  uint32_t priority);
474 
475 /*****************************************************************/
490 open_error_t openapiVlanIfDefaultUserPriorityGet(openapiClientHandle_t *client_handle,
491  uint32_t ifNum,
492  uint32_t *priority);
493 
494 /*****************************************************************/
508 open_error_t openapiVlanNameLenGet(openapiClientHandle_t *client_handle,
509  uint32_t *strLen);
510 
511 /*****************************************************************/
532 open_error_t openapiVlanNameSet(openapiClientHandle_t *client_handle,
533  uint32_t vlanNum,
534  open_buffdesc *vlanName);
535 
536 /*****************************************************************/
553 open_error_t openapiVlanNameGet(openapiClientHandle_t *client_handle,
554  uint32_t vlanNum,
555  open_buffdesc *vlanName);
556 
557 /*****************************************************************/
574 open_error_t openapiDot1qSwPortModeSet(openapiClientHandle_t *client_handle,
575  uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t mode);
576 
577 /*****************************************************************/
594 open_error_t openapiDot1qSwPortModeGet(openapiClientHandle_t *client_handle,
595  uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t *mode);
596 
597 /*****************************************************************/
614 open_error_t openapiDot1qSwPortAccessVlanSet(openapiClientHandle_t *client_handle,
615  uint32_t intf, uint32_t vlanId);
616 
617 /*****************************************************************/
634 open_error_t openapiDot1qSwPortAccessVlanGet(openapiClientHandle_t *client_handle,
635  uint32_t intf, uint32_t *vlanId);
636 
637 /*****************************************************************/
655 open_error_t openapiDot1qSwPortTrunkNativeVlanSet(openapiClientHandle_t *client_handle,
656  uint32_t intf, uint32_t vlanId);
657 
658 /*****************************************************************/
675 open_error_t openapiDot1qSwPortTrunkNativeVlanGet(openapiClientHandle_t *client_handle,
676  uint32_t intf, uint32_t *vlanId);
677 
678 /*****************************************************************/
694 open_error_t openapiDot1qSwPortTrunkAllowedVlanListSet(openapiClientHandle_t *client_handle,
695  uint32_t intf,
696  OPEN_VLAN_LIST_t *vidList);
697 
698 /*****************************************************************/
713 open_error_t openapiDot1qSwPortTrunkAllowedVlanListGet(openapiClientHandle_t *client_handle,
714  uint32_t intf,
715  OPEN_VLAN_LIST_t *vidList);
716 
717 /*****************************************************************/
732 open_error_t openapiDot1qSwPortForbiddenVlanListGet(openapiClientHandle_t *client_handle,
733  uint32_t intf,
734  OPEN_VLAN_LIST_t *vidList);
735 
736 /*****************************************************************/
751 open_error_t openapiDot1qSwPortUntaggedVlanListGet(openapiClientHandle_t *client_handle,
752  uint32_t intf,
753  OPEN_VLAN_LIST_t *vidList);
754 
755 /*****************************************************************/
770 open_error_t openapiDot1qSwPortTaggedVlanListGet(openapiClientHandle_t *client_handle,
771  uint32_t intf,
772  OPEN_VLAN_LIST_t *vidList);
773 
774 /*****************************************************************/
789 open_error_t openapiDot1qSwPortDynamicallyAddedVlanListGet(openapiClientHandle_t *client_handle,
790  uint32_t intf,
791  OPEN_VLAN_LIST_t *vidList);
792 
793 /*****************************************************************/
814 open_error_t openapiPvlanIntfModeGet(openapiClientHandle_t *client_handle,
815  uint32_t intf,
816  OPEN_DOT1Q_SWPORT_MODE_t *mode);
817 
818 /*****************************************************************/
838 open_error_t openapiPvlanIntfHostAssocGet(openapiClientHandle_t *client_handle,
839  uint32_t intf,
840  uint32_t *primaryVid,
841  uint32_t *secondaryVid);
842 
843 /*****************************************************************/
863 open_error_t openapiPvlanIntfPromiscAssocGet(openapiClientHandle_t *client_handle,
864  uint32_t intf,
865  uint32_t *primaryVid,
866  OPEN_VLAN_LIST_t *secondaryVidList);
867 
868 /*****************************************************************/
885 open_error_t openapiPvlanIntfOperAssocGet(openapiClientHandle_t *client_handle,
886  uint32_t intf,
887  OPEN_VLAN_LIST_t *operationalVidList);
888 
889 /*****************************************************************/
912 open_error_t openapiPvlanIntfPromiscTrunkAssocNextGet(openapiClientHandle_t *client_handle,
913  uint32_t intf,
914  uint32_t primaryVid,
915  uint32_t *nextPrimaryVid,
916  OPEN_VLAN_LIST_t *secondaryVidList);
917 
918 /*****************************************************************/
941 open_error_t openapiPvlanIntfIsolatedTrunkAssocNextGet(openapiClientHandle_t *client_handle,
942  uint32_t intf,
943  uint32_t primaryVid,
944  uint32_t *nextPrimaryVid,
945  uint32_t *secondaryVid);
946 
947 /*****************************************************************/
969 open_error_t openapiPvlanIntfTrunkNativeVlanGet(openapiClientHandle_t *client_handle,
970  uint32_t intf,
971  uint32_t *nativeVid);
972 
973 /*****************************************************************/
991 open_error_t openapiPvlanIntfTrunkAllowedVlanListGet(openapiClientHandle_t *client_handle,
992  uint32_t intf,
993  OPEN_VLAN_LIST_t *normalVidList);
994 
995 /*****************************************************************/
1011 open_error_t openapiDot1qPrivateVlanEnable(openapiClientHandle_t *client_handle,
1012  uint32_t vlanId,
1013  OPEN_DOT1Q_PVLAN_TYPE_t pvlanType);
1014 
1015 /*****************************************************************/
1031 open_error_t openapiDot1qPrivateVlanGet(openapiClientHandle_t *client_handle,
1032  uint32_t vlanId,
1033  OPEN_DOT1Q_PVLAN_TYPE_t *pvlanType);
1034 
1035 /*****************************************************************/
1051 open_error_t openapiDot1qApiPrivateVlanAssocAdd(openapiClientHandle_t *client_handle,
1052  uint32_t vlanId,
1053  OPEN_VLAN_LIST_t vidList);
1054 
1055 /*****************************************************************/
1071 open_error_t openapiDot1qApiPrivateVlanAssocRemove(openapiClientHandle_t *client_handle,
1072  uint32_t vlanId,
1073  OPEN_VLAN_LIST_t vidList);
1074 
1075 /*****************************************************************/
1091 open_error_t openapiDot1qPrivateVlanAssociationGet(openapiClientHandle_t *client_handle,
1092  uint32_t vlanId,
1093  OPEN_VLAN_LIST_t *vidList);
1094 
1095 /*****************************************************************/
1112 open_error_t openapiDot1qIntfPVlanHostAssocSet(openapiClientHandle_t *client_handle,
1113  uint32_t ifNum,
1114  uint32_t primary_vlan,
1115  uint32_t sec_vlan);
1116 
1117 /*****************************************************************/
1132 open_error_t openapiDot1qPVlanIntfHostAssocRemove(openapiClientHandle_t *client_handle,
1133  uint32_t ifNum);
1134 
1135 /*****************************************************************/
1152 open_error_t openapiDot1qIntfPVlanPromiscAssocSet(openapiClientHandle_t *client_handle,
1153  uint32_t ifNum,
1154  uint32_t primary_vlan,
1155  OPEN_VLAN_LIST_t vidList);
1156 
1157 /*****************************************************************/
1172 open_error_t openapiDot1qPVlanIntfPromiscAssocRemove(openapiClientHandle_t *client_handle,
1173  uint32_t ifNum);
1174 
1175  /*****************************************************************/
1195 open_error_t openapiVlanMacAdd(openapiClientHandle_t *client_handle,
1196  open_buffdesc *mac, uint32_t vlanId);
1197 
1198 /*****************************************************************/
1218 open_error_t openapiVlanMacDelete(openapiClientHandle_t *client_handle,
1219  open_buffdesc *mac, uint32_t vlanId);
1220 
1221 /*****************************************************************/
1240 open_error_t openapiVlanMacGet(openapiClientHandle_t *client_handle,
1241  open_buffdesc *mac, uint32_t *vlanId);
1242 
1243 /*****************************************************************/
1263 open_error_t openapiVlanMacGetNext(openapiClientHandle_t *client_handle,
1264  open_buffdesc *mac, open_buffdesc *nextmac,
1265  uint32_t *nextvlanId);
1266 
1267 /*****************************************************************/
1283 open_error_t openapiVlanGlobalAutoTrunkGet(openapiClientHandle_t *client_handle,
1284  OPEN_CONTROL_t *adminMode);
1285 
1286 /*****************************************************************/
1302 open_error_t openapiVlanGlobalAutoTrunkSet(openapiClientHandle_t *client_handle,
1303  OPEN_CONTROL_t adminMode);
1304 
1305 /*****************************************************************/
1322 open_error_t openapiDot1qOperAutoTrunkModeGet(openapiClientHandle_t *client_handle,
1323  uint32_t intIfNum,
1324  OPEN_BOOL_t *autoTrunkOperMode);
1325 
1326 /*************************************************************************/
1340 open_error_t openapiDot1qMaxSupportedVlansGet(openapiClientHandle_t *client_handle,
1341  uint32_t *val);
1342 
1343 /*************************************************************************/
1357 open_error_t openapiMostVlanEntriesGet(openapiClientHandle_t *client_handle,
1358  uint32_t *val);
1359 
1360 /*************************************************************************/
1374 open_error_t openapiStaticVlanEntriesGet(openapiClientHandle_t *client_handle,
1375  uint32_t *val);
1376 
1377 /*************************************************************************/
1391 open_error_t openapiDynamicVlanEntriesGet(openapiClientHandle_t *client_handle,
1392  uint32_t *val);
1393 
1394 /*************************************************************************/
1409 open_error_t openapiDot1qVlanNumDeletesGet(openapiClientHandle_t *client_handle,
1410  uint32_t *val);
1411 
1412 /*************************************************************************/
1430 open_error_t openapiVlanTaggedSetGet(openapiClientHandle_t *client_handle,
1431  uint32_t vlanId, uint32_t ifNum,
1432  uint32_t *val);
1433 
1434 /*************************************************************************/
1449 open_error_t openapiNextVlanGet(openapiClientHandle_t *client_handle,
1450  uint32_t vid, uint32_t *nextVid);
1451 
1452 /*************************************************************************/
1468 open_error_t openapiQportsEnableIngressFilteringGet(openapiClientHandle_t *client_handle,
1469  uint32_t ifNum,
1470  uint32_t *val);
1471 
1472 /*************************************************************************/
1488 open_error_t openapiQportsEnableIngressFilteringSet(openapiClientHandle_t *client_handle,
1489  uint32_t ifNum,
1490  uint32_t mode);
1491 
1492 /*************************************************************************/
1508 open_error_t openapiDot1qPortIngressFiltering(openapiClientHandle_t *client_handle,
1509  uint32_t ifNum, uint32_t *val);
1510 
1511 /*************************************************************************/
1528 open_error_t openapiQportsCurrentIngressFilteringGet(openapiClientHandle_t *client_handle,
1529  uint32_t ifNum,
1530  uint32_t *val);
1531 
1532 /*************************************************************************/
1549 open_error_t openapiVlanVIDListGet(openapiClientHandle_t *client_handle,
1550  uint32_t intfNum, OPEN_VLAN_LIST_t *data,
1551  uint32_t *numOfElements);
1552 
1553 /*************************************************************************/
1572 open_error_t openapiDot1qRxPacketsNotForwardedCountGet(openapiClientHandle_t *client_handle,
1573  uint32_t ifNum,
1574  uint64_t *totalRxPktsNotForwarded);
1575 
1576 /*****************************************************************/
1593 open_error_t openapiVlanTypeGet(openapiClientHandle_t *client_handle,
1594  uint32_t vlanNum,
1595  OPEN_DOT1Q_VLAN_TYPE_t *vlanType);
1596 #endif /* OPENAPI_VLAN_H_INCLUDED */
1597 
openapiVlanNameLenGet
open_error_t openapiVlanNameLenGet(openapiClientHandle_t *client_handle, uint32_t *strLen)
Gets the VLAN Name string length.
OPEN_PRIVATE_VLAN_PROMISCOUS_PORT
Promiscous port.
Definition: openapi_vlan.h:86
openapiPvlanIntfPromiscTrunkAssocNextGet
open_error_t openapiPvlanIntfPromiscTrunkAssocNextGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t primaryVid, uint32_t *nextPrimaryVid, OPEN_VLAN_LIST_t *secondaryVidList)
Get the next primary VLAN and any associated secondary VLAN(s) for a promiscuous trunk interface in a...
OPEN_DOT1Q_SWPORT_MODE_t
OPEN_DOT1Q_SWPORT_MODE_t
&lt; Dot1q port modes.
Definition: openapi_vlan.h:48
openapiVlanGlobalAutoTrunkGet
open_error_t openapiVlanGlobalAutoTrunkGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
Get the Auto-Trunk administrative mode.
openapiDot1qRxPacketsNotForwardedCountGet
open_error_t openapiDot1qRxPacketsNotForwardedCountGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint64_t *totalRxPktsNotForwarded)
Get the total number of received packets that are not forwarded of the interafce. ...
openapiVlanDelete
open_error_t openapiVlanDelete(openapiClientHandle_t *client_handle, uint32_t vlanNum)
Deletes the VLAN with the ID specified on the switch.
OPEN_VLAN_LIST_t::numEntries
uint32_t numEntries
number of valid list entries
Definition: openapi_vlan.h:66
openapiVlanGlobalAutoTrunkSet
open_error_t openapiVlanGlobalAutoTrunkSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
Set the Auto-Trunk administrative mode.
openapiVlanMacDelete
open_error_t openapiVlanMacDelete(openapiClientHandle_t *client_handle, open_buffdesc *mac, uint32_t vlanId)
To delete a mac from a VLAN.
openapiDot1qSwPortForbiddenVlanListGet
open_error_t openapiDot1qSwPortForbiddenVlanListGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
Get the forbidden VLAN list for the interface when the interface is in general mode.
openapiPvlanIntfOperAssocGet
open_error_t openapiPvlanIntfOperAssocGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *operationalVidList)
Get the list of operational VLAN(s) for a private VLAN interface.
OPEN_DOT1Q_SWPORT_MODE_ACCESS
Switchport access mode.
Definition: openapi_vlan.h:52
OPEN_DOT1Q_VLAN_TYPE_PBB_REGISTERED
PBB VLAN.
Definition: openapi_vlan.h:103
openapiPvlanIntfTrunkAllowedVlanListGet
open_error_t openapiPvlanIntfTrunkAllowedVlanListGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *normalVidList)
Get the list of normal VLAN(s) carried by a promiscuous or isolated trunk interface in a private VLAN...
OPEN_PRIVATE_VLAN_HOST_PORT
Host port.
Definition: openapi_vlan.h:84
openapiVlanIsStatic
int openapiVlanIsStatic(openapiClientHandle_t *client_handle, uint32_t vlanNum)
Returns whether the VLAN is static.
openapiDot1qSwPortTrunkNativeVlanGet
open_error_t openapiDot1qSwPortTrunkNativeVlanGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *vlanId)
Get the Native VLAN ID for a port when in trunking mode.
openapiVlanIfNumTrafficClassesGet
open_error_t openapiVlanIfNumTrafficClassesGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *numTrafficClasses)
Gets an interface&#39;s number of traffic classes supported.
OPEN_DOT1Q_SWPORT_MODE_TRUNK
Switchport trunk mode.
Definition: openapi_vlan.h:53
openapiDot1qPVlanIntfPromiscAssocRemove
open_error_t openapiDot1qPVlanIntfPromiscAssocRemove(openapiClientHandle_t *client_handle, uint32_t ifNum)
Clear VLAN bindings for private VLAN interface.
openapiVlanCreatedCheck
open_error_t openapiVlanCreatedCheck(openapiClientHandle_t *client_handle, uint32_t vlanNum)
Test if the given VLAN has been configured on the switch.
OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC
Switchport private promisc mode.
Definition: openapi_vlan.h:55
openapiDot1qOperAutoTrunkModeGet
open_error_t openapiDot1qOperAutoTrunkModeGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *autoTrunkOperMode)
Get the operational auto-trunk mode of the interface.
OPEN_DOT1Q_VLAN_TYPE_t
OPEN_DOT1Q_VLAN_TYPE_t
Definition: openapi_vlan.h:90
OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t
OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t
OPEN uses these enumerators to indicate the types of frames that may be received on this port...
Definition: openapi_common.h:225
openapiDot1qVlanNumDeletesGet
open_error_t openapiDot1qVlanNumDeletesGet(openapiClientHandle_t *client_handle, uint32_t *val)
Get the number of times a VLAN entry has been deleted from DOT1Q table.
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiVlanNextGet
open_error_t openapiVlanNextGet(openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t *nextVlanNum)
Gets the next VLAN number that has been configured on the switch.
openapiDot1qApiPrivateVlanAssocRemove
open_error_t openapiDot1qApiPrivateVlanAssocRemove(openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t vidList)
Remove VLAN bindings for private VLAN domain.
OPEN_DOT1Q_SWPORT_MODE_NONE
This is used by applications like gvrp who do not care about the mode.
Definition: openapi_vlan.h:50
openapiPvlanIntfHostAssocGet
open_error_t openapiPvlanIntfHostAssocGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *primaryVid, uint32_t *secondaryVid)
Get the private VLAN association for a host mode interface.
OPEN_DOT1Q_VLAN_TYPE_AUTHMGR_REGISTERED
Dynamically configured Auth manager/DOT1X VLAN.
Definition: openapi_vlan.h:98
openapiVlanMacGetNext
open_error_t openapiVlanMacGetNext(openapiClientHandle_t *client_handle, open_buffdesc *mac, open_buffdesc *nextmac, uint32_t *nextvlanId)
Gets the next MAC vlan entry details of a given MAC.
OPEN_VLAN_LIST_t
Definition: openapi_vlan.h:64
OPEN_DOT1Q_SWPORT_MODE_PRIVATE_HOST
Switchport private host mode.
Definition: openapi_vlan.h:54
openapiDot1qSwPortAccessVlanGet
open_error_t openapiDot1qSwPortAccessVlanGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *vlanId)
Get the Access VLAN ID for a port.
openapiDot1qSwPortModeSet
open_error_t openapiDot1qSwPortModeSet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t mode)
Set the Switchport Configuration Mode for a port.
OPEN_DOT1Q_VLAN_TYPE_WS_L2_TNNL_REGISTERED
Dynamically configured L2 Tunnel VLAN.
Definition: openapi_vlan.h:96
openapiDot1qPrivateVlanAssociationGet
open_error_t openapiDot1qPrivateVlanAssociationGet(openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t *vidList)
Get VLAN bindings for private VLAN domain.
OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC_TRUNK
Switchport private promisc trunk mode.
Definition: openapi_vlan.h:56
OPEN_PRIVATE_VLAN_SECONDARY_COMMUNITY
Secondary community.
Definition: openapi_vlan.h:76
open_buffdesc
Definition: openapi_common.h:138
openapiClientHandle_s
Definition: openapi_common.h:131
OPEN_PRIVATE_VLAN_PRIMARY
Primary.
Definition: openapi_vlan.h:74
openapiVlanNameSet
open_error_t openapiVlanNameSet(openapiClientHandle_t *client_handle, uint32_t vlanNum, open_buffdesc *vlanName)
Configures a VLAN Name.
openapiVlanIfParticipationGet
open_error_t openapiVlanIfParticipationGet(openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, OPEN_VLAN_PARTICIPATION_MODE_t *participationMode)
Gets an interface&#39;s configured participation mode for the specified VLAN.
openapiVlanCreate
open_error_t openapiVlanCreate(openapiClientHandle_t *client_handle, uint32_t vlanNum)
Creates the VLAN with the ID specified on the switch.
openapiDot1qSwPortAccessVlanSet
open_error_t openapiDot1qSwPortAccessVlanSet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t vlanId)
Set the Access VLAN ID for a port.
OPEN_DOT1Q_VLAN_TYPE_DEFAULT
Default VLAN, always valued at 1.
Definition: openapi_vlan.h:93
openapiQportsCurrentIngressFilteringGet
open_error_t openapiQportsCurrentIngressFilteringGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get the Current Ingress Filtering configuration for a port.
OPEN_DOT1Q_VLAN_TYPE_NOT_PARTICIPATING
Not Participating.
Definition: openapi_vlan.h:92
openapiVlanIfTaggingGet
open_error_t openapiVlanIfTaggingGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum, OPEN_CONTROL_t *tagging)
Gets an interface&#39;s tagging setting for the specified VLAN.
openapiVlanIfParticipationStatusGet
open_error_t openapiVlanIfParticipationStatusGet(openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, uint32_t *participating)
Gets an interface&#39;s participation status for the specified VLAN.
OPEN_PRIVATE_VLAN_UNCONFIGURED
Unconfigured.
Definition: openapi_vlan.h:73
openapiVlanMacGet
open_error_t openapiVlanMacGet(openapiClientHandle_t *client_handle, open_buffdesc *mac, uint32_t *vlanId)
To get the details of the mac vlan entry.
OPEN_DOT1Q_SWPORT_MODE_AUTO_TRUNK
Switchport auto trunk mode.
Definition: openapi_vlan.h:58
openapiVlanIfTaggingSet
open_error_t openapiVlanIfTaggingSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum, OPEN_CONTROL_t tagging)
Sets an interface&#39;s tagging mode for the given VLAN.
openapiDot1qSwPortUntaggedVlanListGet
open_error_t openapiDot1qSwPortUntaggedVlanListGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
Get the untagged VLAN list for the interface when the interface is in general mode.
openapiDot1qSwPortTrunkNativeVlanSet
open_error_t openapiDot1qSwPortTrunkNativeVlanSet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t vlanId)
Set the native VLAN ID for a port when in trunking mode.
openapiDot1qSwPortDynamicallyAddedVlanListGet
open_error_t openapiDot1qSwPortDynamicallyAddedVlanListGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
Get the dynamically added VLAN list for the interface when the interface is in general mode...
openapiDot1qSwPortModeGet
open_error_t openapiDot1qSwPortModeGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t *mode)
Get the Switchport Configuration Mode for a port.
openapiVlanIfPvidGet
open_error_t openapiVlanIfPvidGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanNum)
Gets an interface&#39;s PVID.
openapiVlanTypeGet
open_error_t openapiVlanTypeGet(openapiClientHandle_t *client_handle, uint32_t vlanNum, OPEN_DOT1Q_VLAN_TYPE_t *vlanType)
Gets the VLAN type for the specified VLAN.
openapiDot1qIntfPVlanHostAssocSet
open_error_t openapiDot1qIntfPVlanHostAssocSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t primary_vlan, uint32_t sec_vlan)
Set VLAN bindings for private VLAN interface.
OPEN_DOT1Q_VLAN_TYPE_MVRP_REGISTERED
Dynamically configured MVRP VLAN.
Definition: openapi_vlan.h:99
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
OPEN_PRIVATE_VLAN_UNCONFIGURED_PORT
Unconfigured port.
Definition: openapi_vlan.h:83
openapiVlanIfAcceptFrameTypeSet
open_error_t openapiVlanIfAcceptFrameTypeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t type)
Set the Acceptable Frame Type configuration for a port.
OPEN_DOT1Q_SWPORT_MODE_PRIVATE_ISOLATED_TRUNK
Switchport private isolated trunk mode.
Definition: openapi_vlan.h:57
openapiMostVlanEntriesGet
open_error_t openapiMostVlanEntriesGet(openapiClientHandle_t *client_handle, uint32_t *val)
Get the max VLAN entries allowed.
openapiPvlanIntfTrunkNativeVlanGet
open_error_t openapiPvlanIntfTrunkNativeVlanGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *nativeVid)
Get the native VLAN for a promiscuous or isolated trunk interface in a private VLAN.
openapiDot1qSwPortTrunkAllowedVlanListSet
open_error_t openapiDot1qSwPortTrunkAllowedVlanListSet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
Set the list of VLANs allowed on an interface when the interface is in trunking mode.
openapiPvlanIntfPromiscAssocGet
open_error_t openapiPvlanIntfPromiscAssocGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *primaryVid, OPEN_VLAN_LIST_t *secondaryVidList)
Get the private VLAN association for a promiscuous mode interface.
OPEN_VLAN_PARTICIPATION_MODE_t
OPEN_VLAN_PARTICIPATION_MODE_t
OPEN uses these enumerators to indicate the VLAN participation of a given interface.
Definition: openapi_common.h:216
openapiDot1qPrivateVlanGet
open_error_t openapiDot1qPrivateVlanGet(openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_DOT1Q_PVLAN_TYPE_t *pvlanType)
Get the configured private VLAN type.
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_DOT1Q_VLAN_TYPE_GVRP_REGISTERED
Dynamically configured GVRP VLAN.
Definition: openapi_vlan.h:95
OPEN_DOT1Q_PVLAN_PORT_TYPE_t
OPEN_DOT1Q_PVLAN_PORT_TYPE_t
Definition: openapi_vlan.h:81
openapiVlanNameGet
open_error_t openapiVlanNameGet(openapiClientHandle_t *client_handle, uint32_t vlanNum, open_buffdesc *vlanName)
Gets the VLAN Name.
openapiNextVlanGet
open_error_t openapiNextVlanGet(openapiClientHandle_t *client_handle, uint32_t vid, uint32_t *nextVid)
Gets the next VLAN ID.
openapiVlanIfPvidSet
open_error_t openapiVlanIfPvidSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanNum)
Sets an interface&#39;s VLAN ID (PVID).
openapiDot1qMaxSupportedVlansGet
open_error_t openapiDot1qMaxSupportedVlansGet(openapiClientHandle_t *client_handle, uint32_t *val)
Get dot1q Max Supported VLANs.
OPEN_DOT1Q_VLAN_TYPE_ADMIN
Administratively configured, static VLAN.
Definition: openapi_vlan.h:94
openapiDot1qPrivateVlanEnable
open_error_t openapiDot1qPrivateVlanEnable(openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_DOT1Q_PVLAN_TYPE_t pvlanType)
Setup a VLAN as private VLAN.
OPEN_PRIVATE_VLAN_COMMUNITY_PORT
Community port.
Definition: openapi_vlan.h:85
openapiDot1qPVlanIntfHostAssocRemove
open_error_t openapiDot1qPVlanIntfHostAssocRemove(openapiClientHandle_t *client_handle, uint32_t ifNum)
Clear VLAN bindings for private VLAN interface.
openapiPvlanIntfModeGet
open_error_t openapiPvlanIntfModeGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t *mode)
Get the private VLAN mode for an interface.
openapiVlanIfDefaultUserPrioritySet
open_error_t openapiVlanIfDefaultUserPrioritySet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority)
Sets an interface&#39;s default user priority.
openapiDot1qPortIngressFiltering
open_error_t openapiDot1qPortIngressFiltering(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get VLAN ingress filtering status per port.
OPEN_DOT1Q_VLAN_TYPE_AUTO_VIDEO_REGISTERED
Auto-Video VLAN.
Definition: openapi_vlan.h:101
openapiQportsEnableIngressFilteringSet
open_error_t openapiQportsEnableIngressFilteringSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t mode)
Set the Ingress Filtering configuration for a port.
OPEN_PRIVATE_VLAN_SECONDARY_ISOLATED
Secondary isolated.
Definition: openapi_vlan.h:75
openapiVlanIfAcceptFrameTypeGet
open_error_t openapiVlanIfAcceptFrameTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t *type)
Get the Acceptable Frame Type configuration for a port.
openapiStaticVlanEntriesGet
open_error_t openapiStaticVlanEntriesGet(openapiClientHandle_t *client_handle, uint32_t *val)
Get the number of static VLANs.
openapiVlanVIDListGet
open_error_t openapiVlanVIDListGet(openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_VLAN_LIST_t *data, uint32_t *numOfElements)
Get a list of VLANs an interface is a member of.
openapiDynamicVlanEntriesGet
open_error_t openapiDynamicVlanEntriesGet(openapiClientHandle_t *client_handle, uint32_t *val)
Get the number of dynamic VLANs.
openapi_common.h
openapiDot1qSwPortTrunkAllowedVlanListGet
open_error_t openapiDot1qSwPortTrunkAllowedVlanListGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
Get the list of VLANs allowed on an interface when the interface is in trunking mode.
OPEN_DOT1Q_VLAN_TYPE_EVC_REGISTERED
EVC VLAN.
Definition: openapi_vlan.h:102
openapiVlanIfDefaultUserPriorityGet
open_error_t openapiVlanIfDefaultUserPriorityGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *priority)
Gets an interface&#39;s default user priority.
openapiDot1qIntfPVlanPromiscAssocSet
open_error_t openapiDot1qIntfPVlanPromiscAssocSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t primary_vlan, OPEN_VLAN_LIST_t vidList)
Set VLAN bindings for private VLAN interface.
openapiDot1qSwPortTaggedVlanListGet
open_error_t openapiDot1qSwPortTaggedVlanListGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_VLAN_LIST_t *vidList)
Get the tagged VLAN list for the interface when the interface is in general mode. ...
OPEN_VLAN_LIST_MAX_ENTRIES
#define OPEN_VLAN_LIST_MAX_ENTRIES
VLAN list.
Definition: openapi_vlan.h:62
openapiVlanIfParticipationSet
open_error_t openapiVlanIfParticipationSet(openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t ifNum, OPEN_VLAN_PARTICIPATION_MODE_t participationMode)
Sets an interface&#39;s participation mode configuration for the specified VLAN.
openapiPvlanIntfIsolatedTrunkAssocNextGet
open_error_t openapiPvlanIntfIsolatedTrunkAssocNextGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t primaryVid, uint32_t *nextPrimaryVid, uint32_t *secondaryVid)
Get the next primary VLAN and any associated secondary VLAN for an isolated trunk interface in a priv...
OPEN_DOT1Q_SWPORT_MODE_GENERAL
Switchport general mode.
Definition: openapi_vlan.h:51
openapiVlanTaggedSetGet
open_error_t openapiVlanTaggedSetGet(openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t ifNum, uint32_t *val)
Get the tagging configuration of a port.
OPEN_DOT1Q_VLAN_TYPE_OPENFLOW_REGISTERED
Dynamically configured OPENFLOW VLAN.
Definition: openapi_vlan.h:100
OPEN_DOT1Q_VLAN_TYPE_IP_INTERNAL_VLAN
Dynamically configured IP internal VLAN.
Definition: openapi_vlan.h:97
OPEN_DOT1Q_PVLAN_TYPE_t
OPEN_DOT1Q_PVLAN_TYPE_t
Definition: openapi_vlan.h:71
openapiVlanMacAdd
open_error_t openapiVlanMacAdd(openapiClientHandle_t *client_handle, open_buffdesc *mac, uint32_t vlanId)
To add a mac to a VLAN.
openapiQportsEnableIngressFilteringGet
open_error_t openapiQportsEnableIngressFilteringGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
Get the Ingress Filtering configuration for a port.
openapiVlanNextChangedGet
open_error_t openapiVlanNextChangedGet(openapiClientHandle_t *client_handle, uint32_t vlanNum, uint32_t *nextVlanNum, uint32_t *delete_pending)
Gets the next VLAN which has a pending change or a pending deletion.
openapiDot1qApiPrivateVlanAssocAdd
open_error_t openapiDot1qApiPrivateVlanAssocAdd(openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_VLAN_LIST_t vidList)
Setup a VLAN bindings for private VLAN domain.