Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
openapi_lldp.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_lldp.h
28 *
29 * @purpose LLDP Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 10/10/2012
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_LLDP_H_INCLUDED
39 #define OPENAPI_LLDP_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_LLDP_MED_CAP_CAPABILITIES_BITMASK 0x01
44 #define OPEN_LLDP_MED_CAP_NETWORKPOLICY_BITMASK 0x02
45 #define OPEN_LLDP_MED_CAP_LOCATION_BITMASK 0x04
46 #define OPEN_LLDP_MED_CAP_EXT_PSE_BITMASK 0x08
47 #define OPEN_LLDP_MED_CAP_EXT_PD_BITMASK 0x10
48 #define OPEN_LLDP_MED_CAP_INVENTORY_BITMASK 0x20
49 
50 typedef struct
51 {
52  unsigned char bitmap[2];
53 } OPEN_LLDP_MED_CAPABILITIES_t;
54 
55 typedef enum
56 {
57  OPEN_LLDP_CHASSIS_ID_SUBTYPE_CHASSIS_COMP = 1,
58  OPEN_LLDP_CHASSIS_ID_SUBTYPE_INTF_ALIAS = 2,
59  OPEN_LLDP_CHASSIS_ID_SUBTYPE_PORT_COMP = 3,
60  OPEN_LLDP_CHASSIS_ID_SUBTYPE_MAC_ADDR = 4,
61  OPEN_LLDP_CHASSIS_ID_SUBTYPE_NET_ADDR = 5,
62  OPEN_LLDP_CHASSIS_ID_SUBTYPE_INTF_NAME = 6,
63  OPEN_LLDP_CHASSIS_ID_SUBTYPE_LOCAL = 7
64 } OPEN_LLDP_CHASSIS_ID_SUBTYPE_t;
65 
66 typedef enum {
67  OPEN_LLDP_PORT_ID_SUBTYPE_INTF_ALIAS = 1,
68  OPEN_LLDP_PORT_ID_SUBTYPE_PORT_COMP = 2,
69  OPEN_LLDP_PORT_ID_SUBTYPE_MAC_ADDR = 3,
70  OPEN_LLDP_PORT_ID_SUBTYPE_NET_ADDR = 4,
71  OPEN_LLDP_PORT_ID_SUBTYPE_INTF_NAME = 5,
72  OPEN_LLDP_PORT_ID_SUBTYPE_AGENT_ID = 6,
73  OPEN_LLDP_PORT_ID_SUBTYPE_LOCAL = 7
74 } OPEN_LLDP_PORT_ID_SUBTYPE_t;
75 
76 typedef enum {
77  OPEN_LLDP_SYS_DESC_TLV = 0,
78  OPEN_LLDP_SYS_NAME_TLV = 1,
79  OPEN_LLDP_SYS_CAPABILITIES_TLV = 2,
80  OPEN_LLDP_PORT_DESC_TLV = 3,
81  OPEN_LLDP_MGMT_ADDRESS_TLV = 4,
82  OPEN_LLDP_LAST_TLV = 5
83 } OPEN_LLDP_TLV_TYPE_t;
84 
85 typedef enum {
86  OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_RESERVED = 0,
87  OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV4 = 1,
88  OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV6 = 2,
89  OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_802 = 6
90 } OPEN_LLDP_IANA_ADDR_FAMILY_t;
91 
92 typedef enum
93 {
94  OPEN_UNKNOWN_POLICY_APPTYPE = 0,
95  OPEN_VOICE_POLICY_APPTYPE,
96  OPEN_VOICE_SIGNALING_POLICY_APPTYPE,
97  OPEN_GUEST_VOICE_POLICY_APPTYPE,
98  OPEN_GUEST_VOICE_SIGNALING_POLICY_APPTYPE,
99  OPEN_SOFTPHONE_VOICE_POLICY_APPTYPE,
100  OPEN_VIDEO_CONFERENCING_POLICY_APPTYPE,
101  OPEN_STREAMING_VIDEO_POLICY_APPTYPE,
102  OPEN_VIDEO_SIGNALING_POLICY_APPTYPE
103 }OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t;
104 
105 typedef enum
106 {
107  OPEN_UNKNOWN_LOCATION_SUBTYPE = 0,
108  OPEN_COORDINATE_BASED_LOCATION_SUBTYPE,
109  OPEN_CIVIC_ADDRESS_LOCATION_SUBTYPE,
110  OPEN_ELIN_LOCATION_SUBTYPE
111 }OPEN_LLDPXMED_LOCATION_SUBTYPE_t;
112 
113 typedef enum {
114  OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_UNKNOWN = 1,
115  OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_IF_INDEX = 2,
116  OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_PORT_NUMBER = 3
117 } OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_t;
118 
119 #define OPEN_LLDP_TX_INTERVAL_MIN 5
120 #define OPEN_LLDP_TX_INTERVAL_MAX 32768
121 #define OPEN_LLDP_TX_HOLD_MULTIPLIER_MIN 2
122 #define OPEN_LLDP_TX_HOLD_MULTIPLIER_MAX 10
123 #define OPEN_LLDP_REINIT_DELAY_MIN 1
124 #define OPEN_LLDP_REINIT_DELAY_MAX 10
125 #define OPEN_LLDP_NOTIFY_INTERVAL_MIN 5
126 #define OPEN_LLDP_NOTIFY_INTERVAL_MAX 3600
127 #define OPEN_LLDP_MED_FASTSTART_REPEAT_COUNT_MIN 1
128 #define OPEN_LLDP_MED_FASTSTART_REPEAT_COUNT_MAX 10
129 
130 #define OPEN_LLDP_AUTO_NEG_ADVERTIZED_CAPABILITY_SIZE 3
131 #define OPEN_LLDP_STRING_SIZE 32
132 #define OPEN_LLDP_LOCATION_INFO_STRING_SIZE 256
133 #define OPEN_LLDP_UNKNOWN_TLV_INFO_SIZE_MAX 511
134 #define OPEN_LLDP_CHASSIS_ID_SUBTYPE_STRING_SIZE 64
135 /*****************************************************************/
150 open_error_t openapiLldpMgmtStrLenGet(openapiClientHandle_t *client_handle,
151  uint32_t *strLen);
152 
153 /*****************************************************************/
172 open_error_t openapiLldpIntfTransmitModeSet(openapiClientHandle_t *client_handle,
173  uint32_t ifNum,
174  OPEN_CONTROL_t lldpTxMode);
175 
176 /*****************************************************************/
193 open_error_t openapiLldpIntfTransmitModeGet(openapiClientHandle_t *client_handle,
194  uint32_t ifNum,
195  OPEN_CONTROL_t *lldpTxMode);
196 
197 /*****************************************************************/
215 open_error_t openapiLldpIntfReceiveModeSet(openapiClientHandle_t *client_handle,
216  uint32_t ifNum,
217  OPEN_CONTROL_t lldpRxMode);
218 
219 /*****************************************************************/
235 open_error_t openapiLldpIntfReceiveModeGet(openapiClientHandle_t *client_handle,
236  uint32_t ifNum,
237  OPEN_CONTROL_t *lldpRxMode);
238 
239 /*****************************************************************/
257 open_error_t openapiLldpIntfTLVTransmitModeSet(openapiClientHandle_t *client_handle,
258  uint32_t ifNum,
259  OPEN_LLDP_TLV_TYPE_t tlvType,
260  OPEN_CONTROL_t tlvTransmitMode);
261 
262 /*****************************************************************/
278 open_error_t openapiLldpIntfTLVTransmitModeGet(openapiClientHandle_t *client_handle,
279  uint32_t ifNum,
280  OPEN_LLDP_TLV_TYPE_t tlvType,
281  OPEN_CONTROL_t *tlvTransmitMode);
282 
283 /*****************************************************************/
301 open_error_t openapiLldpIntfNotificationModeSet(openapiClientHandle_t *client_handle,
302  uint32_t ifNum,
303  OPEN_CONTROL_t lldpNotMode);
304 
305 /*****************************************************************/
320 open_error_t openapiLldpIntfNotificationModeGet(openapiClientHandle_t *client_handle,
321  uint32_t ifNum,
322  OPEN_CONTROL_t *lldpNotMode);
323 
324 /*****************************************************************/
337 open_error_t openapiLldpIntfNextGet(openapiClientHandle_t *client_handle,
338  uint32_t ifNum,
339  uint32_t *nextIfNum);
340 
341 /*****************************************************************/
357 open_error_t openapiLldpIntfRemoteDeviceNextGet(openapiClientHandle_t *client_handle,
358  uint32_t ifNum,
359  uint32_t *remIndex,
360  uint32_t *timeStamp);
361 
362 /*****************************************************************/
386 open_error_t openapiLldpIntfRemoteDeviceChassisIdGet(openapiClientHandle_t *client_handle,
387  uint32_t ifNum,
388  uint32_t remIndex,
389  uint32_t timeStamp,
390  OPEN_LLDP_CHASSIS_ID_SUBTYPE_t *chassisIdSubtype,
391  open_buffdesc *chassisId);
392 
393 /*****************************************************************/
417 open_error_t openapiLldpIntfRemoteDevicePortIdGet(openapiClientHandle_t *client_handle,
418  uint32_t ifNum,
419  uint32_t remIndex,
420  uint32_t timeStamp,
421  OPEN_LLDP_PORT_ID_SUBTYPE_t *portIdSubtype,
422  open_buffdesc *portId);
423 
424 /*****************************************************************/
447 open_error_t openapiLldpIntfRemoteDeviceSystemNameGet(openapiClientHandle_t *client_handle,
448  uint32_t ifNum,
449  uint32_t remIndex,
450  uint32_t timeStamp,
451  open_buffdesc *systemName);
452 
453 /*****************************************************************/
476 open_error_t openapiLldpIntfRemoteDeviceSystemDescGet(openapiClientHandle_t *client_handle,
477  uint32_t ifNum,
478  uint32_t remIndex,
479  uint32_t timeStamp,
480  open_buffdesc *systemDesc);
481 
482 /*****************************************************************/
505 open_error_t openapiLldpIntfRemoteDevicePortDescGet(openapiClientHandle_t *client_handle,
506  uint32_t ifNum,
507  uint32_t remIndex,
508  uint32_t timeStamp,
509  open_buffdesc *portDesc);
510 
511 /*****************************************************************/
534 open_error_t openapiLldpIntfRemoteDeviceSysCapSuppGet(openapiClientHandle_t *client_handle,
535  uint32_t ifNum,
536  uint32_t remIndex,
537  uint32_t timeStamp,
538  open_buffdesc *sysCapSupp);
539 
540 /*****************************************************************/
563 open_error_t openapiLldpIntfRemoteDeviceSysCapEnabledGet(openapiClientHandle_t *client_handle,
564  uint32_t ifNum,
565  uint32_t remIndex,
566  uint32_t timeStamp,
567  open_buffdesc *sysCapEnabled);
568 
569 /*****************************************************************/
597 open_error_t openapiLldpIntfRemoteDeviceMgmtAddressNextGet(openapiClientHandle_t *client_handle,
598  uint32_t ifNum,
599  uint32_t remIndex,
600  uint32_t timeStamp,
601  OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily,
602  open_buffdesc *address,
603  uint8_t *addrLen);
604 
605 /*****************************************************************/
625 open_error_t openapiLldpIntfRemoteDeviceTTLGet(openapiClientHandle_t *client_handle,
626  uint32_t ifNum,
627  uint32_t remIndex,
628  uint32_t timeStamp,
629  uint32_t *ttl);
630 
631 /*****************************************************************/
653 open_error_t openapiLldpIntfLocalDeviceChassisIdGet(openapiClientHandle_t *client_handle,
654  uint32_t ifNum,
655  OPEN_LLDP_CHASSIS_ID_SUBTYPE_t *chassisIdSubtype,
656  open_buffdesc *chassisId);
657 
658 /*****************************************************************/
680 open_error_t openapiLldpIntfLocalDevicePortIdGet(openapiClientHandle_t *client_handle,
681  uint32_t ifNum,
682  OPEN_LLDP_PORT_ID_SUBTYPE_t *portIdSubtype,
683  open_buffdesc *portId);
684 
685 /*****************************************************************/
706 open_error_t openapiLldpIntfLocalDeviceSystemNameGet(openapiClientHandle_t *client_handle,
707  uint32_t ifNum,
708  open_buffdesc *systemName);
709 
710 /*****************************************************************/
731 open_error_t openapiLldpIntfLocalDeviceSystemDescGet(openapiClientHandle_t *client_handle,
732  uint32_t ifNum,
733  open_buffdesc *systemDesc);
734 
735 /*****************************************************************/
756 open_error_t openapiLldpIntfLocalDevicePortDescGet(openapiClientHandle_t *client_handle,
757  uint32_t ifNum,
758  open_buffdesc *portDesc);
759 
760 /*****************************************************************/
781 open_error_t openapiLldpIntfLocalDeviceSysCapSuppGet(openapiClientHandle_t *client_handle,
782  uint32_t ifNum,
783  open_buffdesc *sysCapSupp);
784 
785 /*****************************************************************/
806 open_error_t openapiLldpIntfLocalDeviceSysCapEnabledGet(openapiClientHandle_t *client_handle,
807  uint32_t ifNum,
808  open_buffdesc *sysCapEnabled);
809 
810 /*****************************************************************/
832 open_error_t openapiLldpIntfLocalDeviceMgmtAddressGet(openapiClientHandle_t *client_handle,
833  uint32_t ifNum,
834  OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily,
835  open_buffdesc *address);
836 
837 /*****************************************************************/
853 open_error_t openapiLldpMedIntfModeGet(openapiClientHandle_t *client_handle,
854  uint32_t intf,
855  OPEN_CONTROL_t *mode);
856 
857 /*****************************************************************/
877 open_error_t openapiLldpMedIntfModeSet(openapiClientHandle_t *client_handle,
878  uint32_t intf,
879  OPEN_CONTROL_t mode);
880 
881 /*****************************************************************/
897 open_error_t openapiLldpMedIntfConfigNotificationModeGet(openapiClientHandle_t *client_handle,
898  uint32_t intf,
899  OPEN_BOOL_t *mode);
900 
901 /*****************************************************************/
921 open_error_t openapiLldpMedIntfConfigNotificationModeSet(openapiClientHandle_t *client_handle,
922  uint32_t intf,
923  OPEN_BOOL_t mode);
924 
925 /*****************************************************************/
947 open_error_t openapiLldpMedIntfTransmitTlvGet(openapiClientHandle_t *client_handle,
948  uint32_t intf,
949  OPEN_LLDP_MED_CAPABILITIES_t *cap);
950 
951 /*****************************************************************/
977 open_error_t openapiLldpMedIntfTransmitTlvSet(openapiClientHandle_t *client_handle,
978  uint32_t intf,
979  OPEN_LLDP_MED_CAPABILITIES_t *cap);
980 
981 /*****************************************************************/
1008 open_error_t openapiLldpMedRemoteCapabilitiesGet(openapiClientHandle_t *client_handle,
1009  uint32_t intf, uint32_t remIndex, uint32_t timeStamp,
1010  OPEN_LLDP_MED_CAPABILITIES_t *supportedCapabilities,
1011  OPEN_LLDP_MED_CAPABILITIES_t *enabledCapabilities);
1012 
1013 /*****************************************************************/
1031 open_error_t openapiLldpMedRemoteDeviceClassGet(openapiClientHandle_t *client_handle,
1032  uint32_t intf, uint32_t remIndex, uint32_t timeStamp,
1033  uint32_t *deviceClass);
1034 
1035 /*****************************************************************/
1048 open_error_t openapiLldpMedRemoteModelNameSizeGet(openapiClientHandle_t *client_handle,
1049  uint32_t *size);
1050 
1051 /*****************************************************************/
1072 open_error_t openapiLldpMedRemoteModelNameGet(openapiClientHandle_t *client_handle,
1073  uint32_t intf, uint32_t remIndex, uint32_t timeStamp,
1074  open_buffdesc *modelName);
1075 
1076 /*************************************************************************/
1090 open_error_t openapiLldpTxIntervalGet(openapiClientHandle_t *client_handle, uint32_t *interval);
1091 
1092 /*************************************************************************/
1107 open_error_t openapiLldpTxIntervalSet(openapiClientHandle_t *client_handle, uint32_t interval);
1108 
1109 /*************************************************************************/
1123 open_error_t openapiLldpTxHoldGet(openapiClientHandle_t *client_handle, uint32_t *holdCount);
1124 
1125 /*************************************************************************/
1140 open_error_t openapiLldpTxHoldSet(openapiClientHandle_t *client_handle, uint32_t holdCount);
1141 
1142 /*************************************************************************/
1156 open_error_t openapiLldpTxReinitDelayGet(openapiClientHandle_t *client_handle, uint32_t *delay);
1157 
1158 /*************************************************************************/
1173 open_error_t openapiLldpTxReinitDelaySet(openapiClientHandle_t *client_handle, uint32_t delay);
1174 
1175 /*************************************************************************/
1189 open_error_t openapiLldpNotificationIntervalGet(openapiClientHandle_t *client_handle,
1190  uint32_t *interval);
1191 
1192 /*************************************************************************/
1207 open_error_t openapiLldpNotificationIntervalSet(openapiClientHandle_t *client_handle,
1208  uint32_t interval);
1209 
1210 /*************************************************************************/
1224 open_error_t openapiLldpXMedFastStartRepeatCountGet(openapiClientHandle_t *client_handle,
1225  uint32_t *count);
1226 
1227 /*************************************************************************/
1242 open_error_t openapiLldpXMedFastStartRepeatCountSet(openapiClientHandle_t *client_handle,
1243  uint32_t count);
1244 
1245 /*************************************************************************/
1260 open_error_t openapiLldpIntfTxMgmtAddrModeGet(openapiClientHandle_t *client_handle,
1261  uint32_t ifNum, OPEN_BOOL_t *mode);
1262 
1263 /*************************************************************************/
1279 open_error_t openapiLldpIntfTxMgmtAddrModeSet(openapiClientHandle_t *client_handle,
1280  uint32_t ifNum, OPEN_BOOL_t mode);
1281 
1282 /*************************************************************************/
1298 open_error_t openapiLldpXMedLocMediaPolicyVlanIDGet(openapiClientHandle_t *client_handle,
1299  uint32_t ifNum,
1300  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1301  uint32_t *vlanId);
1302 
1303 /*************************************************************************/
1319 open_error_t openapiLldpXMedLocMediaPolicyTaggedGet(openapiClientHandle_t *client_handle,
1320  uint32_t ifNum,
1321  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1322  OPEN_BOOL_t *taggedStatus);
1323 
1324 /*************************************************************************/
1340 open_error_t openapiLldpXMedLocMediaPolicyPriorityGet(openapiClientHandle_t *client_handle,
1341  uint32_t ifNum,
1342  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1343  uint32_t *priority);
1344 
1345 /*************************************************************************/
1361 open_error_t openapiLldpXMedLocMediaPolicyDscpGet(openapiClientHandle_t *client_handle,
1362  uint32_t ifNum,
1363  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1364  uint32_t *dscp);
1365 
1366 /*************************************************************************/
1380 open_error_t openapiLldpRemoteIntfFirstGet (openapiClientHandle_t *client_handle,
1381  uint32_t *ifNum);
1382 
1383 /*************************************************************************/
1398 open_error_t openapiLldpRemoteIntfNextGet (openapiClientHandle_t *client_handle,
1399  uint32_t ifNum, uint32_t *nextIfNum);
1400 
1401 /*************************************************************************/
1420 open_error_t openapiLldpdot3RemPortAutoNegSupportedGet(openapiClientHandle_t *client_handle,
1421  uint32_t ifNum,
1422  uint32_t remIndex,
1423  uint32_t timestamp,
1424  OPEN_BOOL_t *isCapable);
1425 
1426 /*************************************************************************/
1445 open_error_t openapiLldpdot3RemPortAutoNegEnabledGet(openapiClientHandle_t *client_handle,
1446  uint32_t ifNum,
1447  uint32_t remIndex,
1448  uint32_t timestamp,
1449  OPEN_BOOL_t *isEnabled);
1450 
1451 /*************************************************************************/
1470 open_error_t openapiLldpdot3RemPortAutoNegAdvertizedCapGet(openapiClientHandle_t *client_handle,
1471  uint32_t ifNum,
1472  uint32_t remIndex,
1473  uint32_t timestamp,
1474  open_buffdesc *advrtCap);
1475 
1476 /*************************************************************************/
1494 open_error_t openapiLldpdot3RemPortAutoNegOperMauTypeGet(openapiClientHandle_t *client_handle,
1495  uint32_t ifNum,
1496  uint32_t remIndex,
1497  uint32_t timestamp,
1498  uint32_t *type);
1499 
1500 /*************************************************************************/
1515 open_error_t openapiLldpdot3RemPortAutoNegOperMauStringGet(openapiClientHandle_t *client_handle,
1516  uint32_t mauType,
1517  open_buffdesc *mauString);
1518 
1519 /*************************************************************************/
1537 open_error_t openapiLldpMedRemHardwareRevGet(openapiClientHandle_t *client_handle,
1538  uint32_t ifNum, uint32_t remIndex,
1539  uint32_t timestamp,
1540  open_buffdesc *hardwareRev);
1541 
1542 /*************************************************************************/
1560 open_error_t openapiLldpMedRemFirmwareRevGet(openapiClientHandle_t *client_handle,
1561  uint32_t ifNum, uint32_t remIndex,
1562  uint32_t timestamp,
1563  open_buffdesc *firmwareRev);
1564 
1565 /*************************************************************************/
1583 open_error_t openapiLldpMedRemSoftwareRevGet(openapiClientHandle_t *client_handle,
1584  uint32_t ifNum, uint32_t remIndex,
1585  uint32_t timestamp,
1586  open_buffdesc *softwareRev);
1587 
1588 /*************************************************************************/
1606 open_error_t openapiLldpMedRemSerialNumGet(openapiClientHandle_t *client_handle,
1607  uint32_t ifNum, uint32_t remIndex,
1608  uint32_t timestamp,
1609  open_buffdesc *serialNum);
1610 
1611 /*************************************************************************/
1629 open_error_t openapiLldpMedRemAssetIdGet(openapiClientHandle_t *client_handle,
1630  uint32_t ifNum, uint32_t remIndex,
1631  uint32_t timestamp,
1632  open_buffdesc *assetId);
1633 
1634 /*************************************************************************/
1652 open_error_t openapiLldpMedRemPoeDeviceTypeGet(openapiClientHandle_t *client_handle,
1653  uint32_t ifNum, uint32_t remIndex,
1654  uint32_t timestamp,
1655  uint32_t *deviceType);
1656 
1657 /*************************************************************************/
1675 open_error_t openapiLldpMedRemPoePSEPowerAvGet(openapiClientHandle_t *client_handle,
1676  uint32_t ifNum, uint32_t remIndex,
1677  uint32_t timestamp,
1678  uint32_t *powerAv);
1679 
1680 /*************************************************************************/
1698 open_error_t openapiLldpMedRemPoePSEPowerSrcGet(openapiClientHandle_t *client_handle,
1699  uint32_t ifNum, uint32_t remIndex,
1700  uint32_t timestamp,
1701  uint32_t *powerSrcType);
1702 
1703 /*************************************************************************/
1721 open_error_t openapiLldpMedRemPoePSEPowerPriGet(openapiClientHandle_t *client_handle,
1722  uint32_t ifNum, uint32_t remIndex,
1723  uint32_t timestamp,
1724  uint32_t *powerPri);
1725 
1726 /*************************************************************************/
1746 open_error_t openapiLldpMedRemLocationInfoGet(openapiClientHandle_t *client_handle,
1747  uint32_t ifNum, uint32_t remIndex,
1748  uint32_t timestamp,
1749  OPEN_LLDPXMED_LOCATION_SUBTYPE_t subType,
1750  open_buffdesc *locInfo);
1751 
1752 /*************************************************************************/
1771 open_error_t openapiLldpMedRemMediaPolicyVlanIdGet(openapiClientHandle_t *client_handle,
1772  uint32_t ifNum,
1773  uint32_t remIndex,
1774  uint32_t timestamp,
1775  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1776  uint32_t *vlanId);
1777 
1778 /*************************************************************************/
1797 open_error_t openapiLldpMedRemMediaPolicyPriorityGet(openapiClientHandle_t *client_handle,
1798  uint32_t ifNum,
1799  uint32_t remIndex,
1800  uint32_t timestamp,
1801  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1802  uint32_t *priority);
1803 
1804 /*************************************************************************/
1823 open_error_t openapiLldpMedRemMediaPolicyDscpGet(openapiClientHandle_t *client_handle,
1824  uint32_t ifNum, uint32_t remIndex,
1825  uint32_t timestamp,
1826  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1827  uint32_t *dscp);
1828 
1829 /*************************************************************************/
1848 open_error_t openapiLldpMedRemMediaPolicyUnknownGet(openapiClientHandle_t *client_handle,
1849  uint32_t ifNum,
1850  uint32_t remIndex,
1851  uint32_t timestamp,
1852  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1853  OPEN_BOOL_t *unknown);
1854 
1855 /*************************************************************************/
1874 open_error_t openapiLldpMedRemMediaPolicyTaggedGet(openapiClientHandle_t *client_handle,
1875  uint32_t ifNum,
1876  uint32_t remIndex,
1877  uint32_t timestamp,
1878  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1879  OPEN_BOOL_t *tagged);
1880 
1881 /*************************************************************************/
1901 open_error_t openapiLldpRemUnknownTLVEntryNextGet(openapiClientHandle_t *client_handle,
1902  uint32_t ifNum, uint32_t remIndex,
1903  uint32_t timestamp,
1904  uint32_t tlvType,
1905  uint32_t *nextTlvType);
1906 
1907 /*************************************************************************/
1926 open_error_t openapiLldpRemUnknownTLVEntryIsExists(openapiClientHandle_t *client_handle,
1927  uint32_t ifNum,
1928  uint32_t remIndex,
1929  uint32_t timestamp,
1930  uint32_t tlvType,
1931  OPEN_BOOL_t *isExists);
1932 
1933 /*************************************************************************/
1952 open_error_t openapiLldpRemUnknownTLVInfoGet(openapiClientHandle_t *client_handle,
1953  uint32_t ifNum,
1954  uint32_t remIndex,
1955  uint32_t timestamp,
1956  uint32_t tlvType,
1957  open_buffdesc *info);
1958 
1959 /*************************************************************************/
1977 open_error_t openapiLldpMedRemMfgNameGet(openapiClientHandle_t *client_handle,
1978  uint32_t ifNum, uint32_t remIndex,
1979  uint32_t timestamp,
1980  open_buffdesc *mfgName);
1981 
1982 /*************************************************************************/
2000 open_error_t openapiLldpMedRemModelNameGet(openapiClientHandle_t *client_handle,
2001  uint32_t ifNum, uint32_t remIndex,
2002  uint32_t timestamp,
2003  open_buffdesc *modelName);
2004 
2005 /*************************************************************************/
2023 open_error_t openapiLldpMedRemPoePDPowerReqGet(openapiClientHandle_t *client_handle,
2024  uint32_t ifNum, uint32_t remIndex,
2025  uint32_t timestamp,
2026  uint32_t *powerReq);
2027 
2028 /*************************************************************************/
2046 open_error_t openapiLldpMedRemPoePDPowerSrcGet(openapiClientHandle_t *client_handle,
2047  uint32_t ifNum, uint32_t remIndex,
2048  uint32_t timestamp,
2049  uint32_t *powerSrc);
2050 
2051 /*************************************************************************/
2069 open_error_t openapiLldpMedRemPoePDPowerPriGet(openapiClientHandle_t *client_handle,
2070  uint32_t ifNum, uint32_t remIndex,
2071  uint32_t timestamp,
2072  uint32_t *powerPri);
2073 
2074 /*************************************************************************/
2094 open_error_t openapiLldpRemOrgDefOUIGet(openapiClientHandle_t *client_handle,
2095  uint32_t ifNum, uint32_t remIndex,
2096  uint32_t timestamp, uint32_t infoIndex,
2097  open_buffdesc *oui);
2098 
2099 /*************************************************************************/
2118 open_error_t openapiLldpRemOrgDefSubtypeGet(openapiClientHandle_t *client_handle,
2119  uint32_t ifNum, uint32_t remIndex,
2120  uint32_t timestamp, uint32_t infoIndex,
2121  uint32_t *subtype);
2122 
2123 /*************************************************************************/
2138 open_error_t openapiLldpChassisIdSubtypeStringGet(openapiClientHandle_t *client_handle,
2139  OPEN_LLDP_CHASSIS_ID_SUBTYPE_t subtype,
2140  open_buffdesc *subtypeStr);
2141 
2142 /*************************************************************************/
2157 open_error_t openapiLldpPortIdSubtypeStringGet(openapiClientHandle_t *client_handle,
2158  uint32_t subtype,
2159  open_buffdesc *subtypeStr);
2160 
2161 /*****************************************************************/
2194 open_error_t openapiLldpIntfRemoteDeviceEntryNextGet(openapiClientHandle_t *client_handle,
2195  uint32_t ifNum,
2196  uint32_t remIndex,
2197  uint32_t timeStamp,
2198  OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily,
2199  open_buffdesc *address,
2200  uint8_t *addrLen,
2201  OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_t *subType,
2202  uint32_t *intfId);
2203 
2204 /*************************************************************************/
2220 open_error_t openapiLldpdot3LocPortAutoNegSupportedGet(openapiClientHandle_t *client_handle,
2221  uint32_t ifNum,
2222  OPEN_BOOL_t *isCapable);
2223 
2224 /*************************************************************************/
2239 open_error_t openapiLldpdot3LocPortAutoNegEnabledGet(openapiClientHandle_t *client_handle,
2240  uint32_t ifNum,
2241  OPEN_BOOL_t *isEnabled);
2242 
2243 /*************************************************************************/
2259 open_error_t openapiLldpdot3LocPortAutoNegAdvertizedCapGet(openapiClientHandle_t *client_handle,
2260  uint32_t ifNum,
2261  open_buffdesc *advrtCap);
2262 
2263 /*************************************************************************/
2278 open_error_t openapiLldpdot3LocPortAutoNegOperMauTypeGet(openapiClientHandle_t *client_handle,
2279  uint32_t ifNum,
2280  uint32_t *type);
2281 
2282 /*************************************************************************/
2296 open_error_t openapiLldpMedLocDeviceClassGet(openapiClientHandle_t *client_handle,
2297  uint32_t *deviceClass);
2298 
2299 #endif /* OPENAPI_LLDP_H_INCLUDED */
2300 
openapiLldpdot3LocPortAutoNegSupportedGet
open_error_t openapiLldpdot3LocPortAutoNegSupportedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isCapable)
Get the port's auto negotiation capability.
openapiLldpTxIntervalGet
open_error_t openapiLldpTxIntervalGet(openapiClientHandle_t *client_handle, uint32_t *interval)
Gets the 802.1AB global transmit interval.
openapiLldpIntfLocalDeviceChassisIdGet
open_error_t openapiLldpIntfLocalDeviceChassisIdGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_CHASSIS_ID_SUBTYPE_t *chassisIdSubtype, open_buffdesc *chassisId)
Gets the LLDP Local Device Chassis Id and Chassis Id Subtype for the specified interface.
openapiLldpMedRemoteModelNameGet
open_error_t openapiLldpMedRemoteModelNameGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *modelName)
Get the LLDP-MED model name of the remote device.
OPEN_LLDP_IANA_ADDR_FAMILY_t
OPEN_LLDP_IANA_ADDR_FAMILY_t
Definition: openapi_lldp.h:85
OPEN_LLDP_SYS_CAPABILITIES_TLV
System Capabilities TLV.
Definition: openapi_lldp.h:79
openapiLldpIntfLocalDeviceSystemNameGet
open_error_t openapiLldpIntfLocalDeviceSystemNameGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *systemName)
Gets the LLDP Local Device System Name for the specified interface.
openapiLldpTxHoldGet
open_error_t openapiLldpTxHoldGet(openapiClientHandle_t *client_handle, uint32_t *holdCount)
Gets the 802.1AB global transmit hold muliplier.
OPEN_LLDP_PORT_ID_SUBTYPE_t
OPEN_LLDP_PORT_ID_SUBTYPE_t
Definition: openapi_lldp.h:66
OPEN_LLDP_CHASSIS_ID_SUBTYPE_t
OPEN_LLDP_CHASSIS_ID_SUBTYPE_t
Definition: openapi_lldp.h:55
openapiLldpdot3RemPortAutoNegAdvertizedCapGet
open_error_t openapiLldpdot3RemPortAutoNegAdvertizedCapGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, open_buffdesc *advrtCap)
Get remote port's auto negotiation advertized capability as a string.
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV6
IPv6.
Definition: openapi_lldp.h:88
OPEN_LLDP_CHASSIS_ID_SUBTYPE_INTF_NAME
Interface Name.
Definition: openapi_lldp.h:62
openapiLldpdot3RemPortAutoNegOperMauStringGet
open_error_t openapiLldpdot3RemPortAutoNegOperMauStringGet(openapiClientHandle_t *client_handle, uint32_t mauType, open_buffdesc *mauString)
Get remote port's auto negotiation operational MAU in string format.
OPEN_VIDEO_SIGNALING_POLICY_APPTYPE
Video signaling policy.
Definition: openapi_lldp.h:102
openapiLldpRemUnknownTLVInfoGet
open_error_t openapiLldpRemUnknownTLVInfoGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t tlvType, open_buffdesc *info)
Get the TLV info for the specified remote entry.
openapiLldpMedIntfModeSet
open_error_t openapiLldpMedIntfModeSet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t mode)
Set LLDP-MED administrative mode on valid LLDP interfaces.
openapiLldpXMedLocMediaPolicyTaggedGet
open_error_t openapiLldpXMedLocMediaPolicyTaggedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, OPEN_BOOL_t *taggedStatus)
Gets the tagged bit associated with a particular policy type.
openapiLldpMedIntfModeGet
open_error_t openapiLldpMedIntfModeGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t *mode)
Get the interface LLDP-MED administrative mode.
OPEN_STREAMING_VIDEO_POLICY_APPTYPE
Streaming video policy.
Definition: openapi_lldp.h:101
openapiLldpMedRemSerialNumGet
open_error_t openapiLldpMedRemSerialNumGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, open_buffdesc *serialNum)
Get remote device's serial number.
openapiLldpIntfRemoteDeviceSysCapSuppGet
open_error_t openapiLldpIntfRemoteDeviceSysCapSuppGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *sysCapSupp)
Gets the LLDP Remote Device System Capabilities Supported for the specified interface.
OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_UNKNOWN
Unknwon subtype.
Definition: openapi_lldp.h:114
openapiLldpIntfTxMgmtAddrModeGet
open_error_t openapiLldpIntfTxMgmtAddrModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mode)
Gets the 802.1AB mgmt addr transmit mode for the specified interface.
OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_t
OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_t
Definition: openapi_lldp.h:113
openapiLldpMedRemMediaPolicyTaggedGet
open_error_t openapiLldpMedRemMediaPolicyTaggedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, OPEN_BOOL_t *tagged)
Get the tagged bit associated with a particular policy type.
openapiLldpMedRemMediaPolicyUnknownGet
open_error_t openapiLldpMedRemMediaPolicyUnknownGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, OPEN_BOOL_t *unknown)
Get the unknown bit associated with a particular policy type.
OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_IF_INDEX
Interface index subtype.
Definition: openapi_lldp.h:115
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
OPEN_LLDP_CHASSIS_ID_SUBTYPE_PORT_COMP
Port Component.
Definition: openapi_lldp.h:59
openapiLldpIntfLocalDevicePortIdGet
open_error_t openapiLldpIntfLocalDevicePortIdGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_PORT_ID_SUBTYPE_t *portIdSubtype, open_buffdesc *portId)
Gets the LLDP Local Device Port Id and Port Id Subtype for the specified interface.
openapiLldpIntfLocalDeviceSysCapSuppGet
open_error_t openapiLldpIntfLocalDeviceSysCapSuppGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *sysCapSupp)
Gets the LLDP Local Device System Capabilities Supported for the specified interface.
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV4
IPv4.
Definition: openapi_lldp.h:87
OPEN_LLDP_PORT_ID_SUBTYPE_MAC_ADDR
MAC Address.
Definition: openapi_lldp.h:69
openapiLldpIntfRemoteDeviceMgmtAddressNextGet
open_error_t openapiLldpIntfRemoteDeviceMgmtAddressNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily, open_buffdesc *address, uint8_t *addrLen)
Gets the LLDP Remote Device next Management Address for the specified interface.
openapiLldpMedRemoteDeviceClassGet
open_error_t openapiLldpMedRemoteDeviceClassGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t remIndex, uint32_t timeStamp, uint32_t *deviceClass)
Get the LLDP-MED device class of the remote device.
openapiLldpIntfNextGet
open_error_t openapiLldpIntfNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
Gets the next valid LLDP interface.
openapiLldpIntfLocalDevicePortDescGet
open_error_t openapiLldpIntfLocalDevicePortDescGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *portDesc)
Gets the LLDP Local Device Port Description for the specified interface.
openapiLldpMedRemHardwareRevGet
open_error_t openapiLldpMedRemHardwareRevGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, open_buffdesc *hardwareRev)
Get remote device's hardware revision.
openapiLldpRemOrgDefSubtypeGet
open_error_t openapiLldpRemOrgDefSubtypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t infoIndex, uint32_t *subtype)
Get the organizationally defined subtype for specified entry.
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_802
802
Definition: openapi_lldp.h:89
openapiLldpMedRemSoftwareRevGet
open_error_t openapiLldpMedRemSoftwareRevGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, open_buffdesc *softwareRev)
Get remote device's software revision.
openapiLldpdot3RemPortAutoNegEnabledGet
open_error_t openapiLldpdot3RemPortAutoNegEnabledGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, OPEN_BOOL_t *isEnabled)
Get remote port's auto negotiation enabled status.
OPEN_LLDP_CHASSIS_ID_SUBTYPE_CHASSIS_COMP
Chassis Component.
Definition: openapi_lldp.h:57
openapiLldpRemUnknownTLVEntryNextGet
open_error_t openapiLldpRemUnknownTLVEntryNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t tlvType, uint32_t *nextTlvType)
Get the next unknown TLV entry for the indicated remote data entry.
open_buffdesc
Definition: openapi_common.h:138
OPEN_LLDP_PORT_ID_SUBTYPE_AGENT_ID
Agent Circuit Id.
Definition: openapi_lldp.h:72
openapiLldpMedRemPoePSEPowerSrcGet
open_error_t openapiLldpMedRemPoePSEPowerSrcGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t *powerSrcType)
Get remote ports PSE power source.
openapiClientHandle_s
Definition: openapi_common.h:131
OPEN_SOFTPHONE_VOICE_POLICY_APPTYPE
Softphone voice policy.
Definition: openapi_lldp.h:99
openapiLldpMedRemPoePSEPowerAvGet
open_error_t openapiLldpMedRemPoePSEPowerAvGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t *powerAv)
Get remote ports PSE power value in tenths of watts.
OPEN_LLDP_SYS_NAME_TLV
System Name TLV.
Definition: openapi_lldp.h:78
openapiLldpTxReinitDelayGet
open_error_t openapiLldpTxReinitDelayGet(openapiClientHandle_t *client_handle, uint32_t *delay)
Gets the 802.1AB global transmit reinit delay.
openapiLldpMedRemMediaPolicyVlanIdGet
open_error_t openapiLldpMedRemMediaPolicyVlanIdGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, uint32_t *vlanId)
Get the vlan id associated with a particular policy type.
openapiLldpdot3LocPortAutoNegOperMauTypeGet
open_error_t openapiLldpdot3LocPortAutoNegOperMauTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *type)
Get port's auto negotiation operational MAU Type.
openapiLldpdot3LocPortAutoNegAdvertizedCapGet
open_error_t openapiLldpdot3LocPortAutoNegAdvertizedCapGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *advrtCap)
Get port's auto negotiation advertized capability as a string.
openapiLldpPortIdSubtypeStringGet
open_error_t openapiLldpPortIdSubtypeStringGet(openapiClientHandle_t *client_handle, uint32_t subtype, open_buffdesc *subtypeStr)
Get a string representation for port ID Subtype.
openapiLldpRemoteIntfFirstGet
open_error_t openapiLldpRemoteIntfFirstGet(openapiClientHandle_t *client_handle, uint32_t *ifNum)
Get the first interface enable for LLDP receives.
openapiLldpIntfRemoteDeviceTTLGet
open_error_t openapiLldpIntfRemoteDeviceTTLGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, uint32_t *ttl)
Gets the LLDP Remote Device TTL for the specified interface.
openapiLldpIntfRemoteDeviceSystemNameGet
open_error_t openapiLldpIntfRemoteDeviceSystemNameGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *systemName)
Gets the LLDP Remote Device System Name for the specified interface.
OPEN_ELIN_LOCATION_SUBTYPE
Elin location.
Definition: openapi_lldp.h:110
openapiLldpIntfLocalDeviceMgmtAddressGet
open_error_t openapiLldpIntfLocalDeviceMgmtAddressGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily, open_buffdesc *address)
Gets the LLDP Local Device Management Address for the specified interface.
OPEN_LLDP_PORT_ID_SUBTYPE_NET_ADDR
Network Address.
Definition: openapi_lldp.h:70
openapiLldpIntfRemoteDeviceSystemDescGet
open_error_t openapiLldpIntfRemoteDeviceSystemDescGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *systemDesc)
Gets the LLDP Remote Device System Description for the specified interface.
openapiLldpRemoteIntfNextGet
open_error_t openapiLldpRemoteIntfNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
Get the next valid interface enabled for LLDP receives.
OPEN_LLDP_LAST_TLV
Unused.
Definition: openapi_lldp.h:82
openapiLldpMedRemLocationInfoGet
open_error_t openapiLldpMedRemLocationInfoGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, OPEN_LLDPXMED_LOCATION_SUBTYPE_t subType, open_buffdesc *locInfo)
Get the location info received on this port for the given location subtype.
OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t
OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t
Definition: openapi_lldp.h:92
openapiLldpIntfLocalDeviceSystemDescGet
open_error_t openapiLldpIntfLocalDeviceSystemDescGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *systemDesc)
Gets the LLDP Local Device System Description for the specified interface.
openapiLldpRemOrgDefOUIGet
open_error_t openapiLldpRemOrgDefOUIGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t infoIndex, open_buffdesc *oui)
Get the organizationally defined OUI for specified entry.
OPEN_LLDP_CHASSIS_ID_SUBTYPE_INTF_ALIAS
Interface Alias.
Definition: openapi_lldp.h:58
openapiLldpIntfRemoteDeviceEntryNextGet
open_error_t openapiLldpIntfRemoteDeviceEntryNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily, open_buffdesc *address, uint8_t *addrLen, OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_t *subType, uint32_t *intfId)
Gets the LLDP Remote Device management address entry details for the specified interface.
openapiLldpMedRemFirmwareRevGet
open_error_t openapiLldpMedRemFirmwareRevGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, open_buffdesc *firmwareRev)
Get remote device's firmware revision.
openapiLldpMgmtStrLenGet
open_error_t openapiLldpMgmtStrLenGet(openapiClientHandle_t *client_handle, uint32_t *strLen)
Gets the LLDP Management string length.
openapiLldpXMedFastStartRepeatCountGet
open_error_t openapiLldpXMedFastStartRepeatCountGet(openapiClientHandle_t *client_handle, uint32_t *count)
Gets the fast start repeat count.
OPEN_LLDP_CHASSIS_ID_SUBTYPE_MAC_ADDR
MAC Address.
Definition: openapi_lldp.h:60
openapiLldpIntfNotificationModeSet
open_error_t openapiLldpIntfNotificationModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpNotMode)
Sets the LLDP Notification mode for the specified interface.
openapiLldpXMedLocMediaPolicyVlanIDGet
open_error_t openapiLldpXMedLocMediaPolicyVlanIDGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, uint32_t *vlanId)
Gets the vlan id associated with a particular policy type.
openapiLldpRemUnknownTLVEntryIsExists
open_error_t openapiLldpRemUnknownTLVEntryIsExists(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t tlvType, OPEN_BOOL_t *isExists)
Determine if unknown TLV entry exists.
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_VOICE_POLICY_APPTYPE
Voice policy.
Definition: openapi_lldp.h:95
OPEN_LLDP_PORT_ID_SUBTYPE_PORT_COMP
Port Component.
Definition: openapi_lldp.h:68
openapiLldpIntfRemoteDeviceNextGet
open_error_t openapiLldpIntfRemoteDeviceNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *remIndex, uint32_t *timeStamp)
Gets the next LLDP Remote Device entry for the specified interface.
openapiLldpIntfRemoteDeviceSysCapEnabledGet
open_error_t openapiLldpIntfRemoteDeviceSysCapEnabledGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *sysCapEnabled)
Gets the LLDP Remote Device System Capabilities Enabled for the specified interface.
openapiLldpMedLocDeviceClassGet
open_error_t openapiLldpMedLocDeviceClassGet(openapiClientHandle_t *client_handle, uint32_t *deviceClass)
Get local device's MED Classification.
OPEN_LLDP_MED_CAPABILITIES_t
Definition: openapi_lldp.h:50
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_LLDP_PORT_ID_SUBTYPE_INTF_ALIAS
Interface Alias.
Definition: openapi_lldp.h:67
OPEN_LLDP_CHASSIS_ID_SUBTYPE_LOCAL
Local.
Definition: openapi_lldp.h:63
openapiLldpXMedLocMediaPolicyDscpGet
open_error_t openapiLldpXMedLocMediaPolicyDscpGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, uint32_t *dscp)
Gets the DSCP associated with a particular policy type.
openapiLldpMedRemModelNameGet
open_error_t openapiLldpMedRemModelNameGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, open_buffdesc *modelName)
Get the remote device's model name.
openapiLldpMedIntfTransmitTlvSet
open_error_t openapiLldpMedIntfTransmitTlvSet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_LLDP_MED_CAPABILITIES_t *cap)
Set LLDP-MED TLVs for transmision on valid LLDP interfaces.
openapiLldpMedRemoteModelNameSizeGet
open_error_t openapiLldpMedRemoteModelNameSizeGet(openapiClientHandle_t *client_handle, uint32_t *size)
Get the size in bytes for the open_buffdesc used to call openapiLldpMedRemoteModelNameGet().
openapiLldpChassisIdSubtypeStringGet
open_error_t openapiLldpChassisIdSubtypeStringGet(openapiClientHandle_t *client_handle, OPEN_LLDP_CHASSIS_ID_SUBTYPE_t subtype, open_buffdesc *subtypeStr)
Get a string representation for Chassis ID Subtype.
openapiLldpIntfTransmitModeSet
open_error_t openapiLldpIntfTransmitModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpTxMode)
Sets LLDP PDU transmit mode on the specified interface.
openapiLldpIntfNotificationModeGet
open_error_t openapiLldpIntfNotificationModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lldpNotMode)
Gets the LLDP Notification mode for the specified interface.
openapiLldpIntfTLVTransmitModeGet
open_error_t openapiLldpIntfTLVTransmitModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_TLV_TYPE_t tlvType, OPEN_CONTROL_t *tlvTransmitMode)
Gets the LLDP optional TLVs transmit mode for the specified interface.
OPEN_LLDPXMED_LOCATION_SUBTYPE_t
OPEN_LLDPXMED_LOCATION_SUBTYPE_t
Definition: openapi_lldp.h:105
openapiLldpMedIntfConfigNotificationModeGet
open_error_t openapiLldpMedIntfConfigNotificationModeGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_BOOL_t *mode)
Get the interface LLDP-MED configuration notification mode.
openapiLldpMedRemMediaPolicyDscpGet
open_error_t openapiLldpMedRemMediaPolicyDscpGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, uint32_t *dscp)
Get the DSCP associated with a particular policy type.
OPEN_LLDP_PORT_ID_SUBTYPE_LOCAL
Local.
Definition: openapi_lldp.h:73
openapiLldpNotificationIntervalGet
open_error_t openapiLldpNotificationIntervalGet(openapiClientHandle_t *client_handle, uint32_t *interval)
Gets the 802.1AB global notification interval limit.
openapiLldpIntfRemoteDevicePortDescGet
open_error_t openapiLldpIntfRemoteDevicePortDescGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *portDesc)
Gets the LLDP Remote Device Port Description for the specified interface.
openapiLldpIntfRemoteDeviceChassisIdGet
open_error_t openapiLldpIntfRemoteDeviceChassisIdGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_CHASSIS_ID_SUBTYPE_t *chassisIdSubtype, open_buffdesc *chassisId)
Gets the LLDP Remote Device Chassis Id and Chassis Id Subtype for the specified interface.
OPEN_VIDEO_CONFERENCING_POLICY_APPTYPE
Video conferencing policy.
Definition: openapi_lldp.h:100
OPEN_LLDP_PORT_ID_SUBTYPE_INTF_NAME
Interface Name.
Definition: openapi_lldp.h:71
openapiLldpIntfReceiveModeSet
open_error_t openapiLldpIntfReceiveModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpRxMode)
Sets LLDP PDU reception mode on the specified interface.
OPEN_LLDP_CHASSIS_ID_SUBTYPE_NET_ADDR
Network Address.
Definition: openapi_lldp.h:61
openapiLldpMedRemMfgNameGet
open_error_t openapiLldpMedRemMfgNameGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, open_buffdesc *mfgName)
Get the remote device's manufacturer's name.
openapiLldpTxReinitDelaySet
open_error_t openapiLldpTxReinitDelaySet(openapiClientHandle_t *client_handle, uint32_t delay)
Sets the 802.1AB global transmit reinit delay.
openapiLldpMedRemPoePDPowerPriGet
open_error_t openapiLldpMedRemPoePDPowerPriGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t *powerPri)
Get the remote port's PD power priority.
openapiLldpIntfTransmitModeGet
open_error_t openapiLldpIntfTransmitModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lldpTxMode)
Gets the LLDP PDU transmit mode for the specified interface.
openapiLldpTxIntervalSet
open_error_t openapiLldpTxIntervalSet(openapiClientHandle_t *client_handle, uint32_t interval)
Sets the 802.1AB global transmit interval.
openapiLldpdot3RemPortAutoNegOperMauTypeGet
open_error_t openapiLldpdot3RemPortAutoNegOperMauTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t *type)
Get remote port's auto negotiation operational MAU Type.
openapiLldpNotificationIntervalSet
open_error_t openapiLldpNotificationIntervalSet(openapiClientHandle_t *client_handle, uint32_t interval)
Sets the 802.1AB global notification interval limit.
openapiLldpIntfTLVTransmitModeSet
open_error_t openapiLldpIntfTLVTransmitModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_TLV_TYPE_t tlvType, OPEN_CONTROL_t tlvTransmitMode)
Sets the LLDP optional TLVs transmit mode for the specified interface.
OPEN_LLDP_SYS_DESC_TLV
System Description TLV.
Definition: openapi_lldp.h:77
openapiLldpIntfReceiveModeGet
open_error_t openapiLldpIntfReceiveModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lldpRxMode)
Gets the LLDP PDU reception mode for the specified interface.
openapiLldpMedIntfTransmitTlvGet
open_error_t openapiLldpMedIntfTransmitTlvGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_LLDP_MED_CAPABILITIES_t *cap)
Get the interface LLDP-MED TLVs enabled for transmision.
openapiLldpMedIntfConfigNotificationModeSet
open_error_t openapiLldpMedIntfConfigNotificationModeSet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_BOOL_t mode)
Set LLDP-MED configuration notification mode on valid LLDP interfaces.
OPEN_GUEST_VOICE_SIGNALING_POLICY_APPTYPE
Guest voice signaling policy.
Definition: openapi_lldp.h:98
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_RESERVED
Reserved.
Definition: openapi_lldp.h:86
OPEN_CIVIC_ADDRESS_LOCATION_SUBTYPE
Civic address location.
Definition: openapi_lldp.h:109
openapi_common.h
openapiLldpXMedLocMediaPolicyPriorityGet
open_error_t openapiLldpXMedLocMediaPolicyPriorityGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, uint32_t *priority)
Gets the priority associated with a particular policy type.
openapiLldpdot3LocPortAutoNegEnabledGet
open_error_t openapiLldpdot3LocPortAutoNegEnabledGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isEnabled)
Get port's auto negotiation enabled status.
openapiLldpMedRemMediaPolicyPriorityGet
open_error_t openapiLldpMedRemMediaPolicyPriorityGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType, uint32_t *priority)
Get the priority associated with a particular policy type.
openapiLldpTxHoldSet
open_error_t openapiLldpTxHoldSet(openapiClientHandle_t *client_handle, uint32_t holdCount)
Sets the 802.1AB global transmit hold muliplier.
OPEN_LLDP_PORT_DESC_TLV
Port Description TLV.
Definition: openapi_lldp.h:80
openapiLldpMedRemoteCapabilitiesGet
open_error_t openapiLldpMedRemoteCapabilitiesGet(openapiClientHandle_t *client_handle, uint32_t intf, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_MED_CAPABILITIES_t *supportedCapabilities, OPEN_LLDP_MED_CAPABILITIES_t *enabledCapabilities)
Get the LLDP-MED capabilities received from the remote device.
openapiLldpIntfTxMgmtAddrModeSet
open_error_t openapiLldpIntfTxMgmtAddrModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mode)
Sets the 802.1AB mgmt addr transmit mode for the specified interface.
openapiLldpXMedFastStartRepeatCountSet
open_error_t openapiLldpXMedFastStartRepeatCountSet(openapiClientHandle_t *client_handle, uint32_t count)
Sets the fast start repeat count.
OPEN_GUEST_VOICE_POLICY_APPTYPE
Guest voice policy.
Definition: openapi_lldp.h:97
OPEN_VOICE_SIGNALING_POLICY_APPTYPE
Voice signaling polcy.
Definition: openapi_lldp.h:96
OPEN_COORDINATE_BASED_LOCATION_SUBTYPE
Co ordinate based location.
Definition: openapi_lldp.h:108
openapiLldpMedRemAssetIdGet
open_error_t openapiLldpMedRemAssetIdGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, open_buffdesc *assetId)
Get remote device's asset ID.
OPEN_LLDP_TLV_TYPE_t
OPEN_LLDP_TLV_TYPE_t
Definition: openapi_lldp.h:76
OPEN_LLDP_MGMT_ADDRESS_TLV
Management Address TLV.
Definition: openapi_lldp.h:81
OPEN_UNKNOWN_LOCATION_SUBTYPE
Unknown location.
Definition: openapi_lldp.h:107
openapiLldpMedRemPoePDPowerSrcGet
open_error_t openapiLldpMedRemPoePDPowerSrcGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t *powerSrc)
Get the remote port's PD power source.
OPEN_UNKNOWN_POLICY_APPTYPE
Unknwon policy.
Definition: openapi_lldp.h:94
openapiLldpMedRemPoePSEPowerPriGet
open_error_t openapiLldpMedRemPoePSEPowerPriGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t *powerPri)
Get remote ports PSE power priority.
openapiLldpMedRemPoeDeviceTypeGet
open_error_t openapiLldpMedRemPoeDeviceTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t *deviceType)
Get remote device's PoE device type connected to this port.
openapiLldpMedRemPoePDPowerReqGet
open_error_t openapiLldpMedRemPoePDPowerReqGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, uint32_t *powerReq)
Get the remote port's PD power requirement.
openapiLldpIntfLocalDeviceSysCapEnabledGet
open_error_t openapiLldpIntfLocalDeviceSysCapEnabledGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *sysCapEnabled)
Gets the LLDP Local Device System Capabilities Enabled for the specified interface.
openapiLldpdot3RemPortAutoNegSupportedGet
open_error_t openapiLldpdot3RemPortAutoNegSupportedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timestamp, OPEN_BOOL_t *isCapable)
Get remote port's auto negotiation capability.
OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_PORT_NUMBER
Port number subtype.
Definition: openapi_lldp.h:116
openapiLldpIntfRemoteDevicePortIdGet
open_error_t openapiLldpIntfRemoteDevicePortIdGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_PORT_ID_SUBTYPE_t *portIdSubtype, open_buffdesc *portId)
Gets the LLDP Remote Device Port Id and Port Id Subtype for the specified interface.