Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
openapi_lldp.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2024 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 #include "openapi_vlan.h"
43 
44 #define OPEN_LLDP_MED_CAP_CAPABILITIES_BITMASK 0x01
45 #define OPEN_LLDP_MED_CAP_NETWORKPOLICY_BITMASK 0x02
46 #define OPEN_LLDP_MED_CAP_LOCATION_BITMASK 0x04
47 #define OPEN_LLDP_MED_CAP_EXT_PSE_BITMASK 0x08
48 #define OPEN_LLDP_MED_CAP_EXT_PD_BITMASK 0x10
49 #define OPEN_LLDP_MED_CAP_INVENTORY_BITMASK 0x20
50 
51 typedef struct
52 {
53  unsigned char bitmap[2];
55 
56 typedef enum
57 {
66 
67 typedef enum {
76 
77 typedef enum {
89 
90 typedef enum {
96 
97 typedef enum
98 {
109 
110 typedef enum
111 {
117 
118 typedef enum {
123 
124 #define OPEN_LLDP_TX_INTERVAL_MIN 5
125 #define OPEN_LLDP_TX_INTERVAL_MAX 32768
126 #define OPEN_LLDP_TX_HOLD_MULTIPLIER_MIN 2
127 #define OPEN_LLDP_TX_HOLD_MULTIPLIER_MAX 10
128 #define OPEN_LLDP_REINIT_DELAY_MIN 1
129 #define OPEN_LLDP_REINIT_DELAY_MAX 10
130 #define OPEN_LLDP_NOTIFY_INTERVAL_MIN 5
131 #define OPEN_LLDP_NOTIFY_INTERVAL_MAX 3600
132 #define OPEN_LLDP_MED_FASTSTART_REPEAT_COUNT_MIN 1
133 #define OPEN_LLDP_MED_FASTSTART_REPEAT_COUNT_MAX 10
134 
135 #define OPEN_LLDP_AUTO_NEG_ADVERTIZED_CAPABILITY_SIZE 3
136 #define OPEN_LLDP_STRING_SIZE 32
137 #define OPEN_LLDP_LOCATION_INFO_STRING_SIZE 256
138 #define OPEN_LLDP_UNKNOWN_TLV_INFO_SIZE_MAX 511
139 #define OPEN_LLDP_CHASSIS_ID_SUBTYPE_STRING_SIZE 64
140 /*****************************************************************/
156  uint32_t *strLen);
157 
158 /*****************************************************************/
178  uint32_t ifNum,
179  OPEN_CONTROL_t lldpTxMode);
180 
181 /*****************************************************************/
199  uint32_t ifNum,
200  OPEN_CONTROL_t *lldpTxMode);
201 
202 /*****************************************************************/
221  uint32_t ifNum,
222  OPEN_CONTROL_t lldpRxMode);
223 
224 /*****************************************************************/
241  uint32_t ifNum,
242  OPEN_CONTROL_t *lldpRxMode);
243 
244 /*****************************************************************/
263  uint32_t ifNum,
264  OPEN_LLDP_TLV_TYPE_t tlvType,
265  OPEN_CONTROL_t tlvTransmitMode);
266 
267 /*****************************************************************/
284  uint32_t ifNum,
285  OPEN_LLDP_TLV_TYPE_t tlvType,
286  OPEN_CONTROL_t *tlvTransmitMode);
287 
288 /*****************************************************************/
307  uint32_t ifNum,
308  OPEN_CONTROL_t lldpNotMode);
309 
310 /*****************************************************************/
326  uint32_t ifNum,
327  OPEN_CONTROL_t *lldpNotMode);
328 
329 /*****************************************************************/
343  uint32_t ifNum,
344  uint32_t *nextIfNum);
345 
346 /*****************************************************************/
363  uint32_t ifNum,
364  uint32_t *remIndex,
365  uint32_t *timeStamp);
366 
367 /*****************************************************************/
392  uint32_t ifNum,
393  uint32_t remIndex,
394  uint32_t timeStamp,
395  OPEN_LLDP_CHASSIS_ID_SUBTYPE_t *chassisIdSubtype,
396  open_buffdesc *chassisId);
397 
398 /*****************************************************************/
423  uint32_t ifNum,
424  uint32_t remIndex,
425  uint32_t timeStamp,
426  OPEN_LLDP_PORT_ID_SUBTYPE_t *portIdSubtype,
427  open_buffdesc *portId);
428 
429 /*****************************************************************/
453  uint32_t ifNum,
454  uint32_t remIndex,
455  uint32_t timeStamp,
456  open_buffdesc *systemName);
457 
458 /*****************************************************************/
482  uint32_t ifNum,
483  uint32_t remIndex,
484  uint32_t timeStamp,
485  open_buffdesc *systemDesc);
486 
487 /*****************************************************************/
511  uint32_t ifNum,
512  uint32_t remIndex,
513  uint32_t timeStamp,
514  open_buffdesc *portDesc);
515 
516 /*****************************************************************/
540  uint32_t ifNum,
541  uint32_t remIndex,
542  uint32_t timeStamp,
543  open_buffdesc *sysCapSupp);
544 
545 /*****************************************************************/
569  uint32_t ifNum,
570  uint32_t remIndex,
571  uint32_t timeStamp,
572  open_buffdesc *sysCapEnabled);
573 
574 /*****************************************************************/
603  uint32_t ifNum,
604  uint32_t remIndex,
605  uint32_t timeStamp,
606  OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily,
607  open_buffdesc *address,
608  uint8_t *addrLen);
609 
610 /*****************************************************************/
631  uint32_t ifNum,
632  uint32_t remIndex,
633  uint32_t timeStamp,
634  uint32_t *ttl);
635 
636 /*****************************************************************/
659  uint32_t ifNum,
660  OPEN_LLDP_CHASSIS_ID_SUBTYPE_t *chassisIdSubtype,
661  open_buffdesc *chassisId);
662 
663 /*****************************************************************/
686  uint32_t ifNum,
687  OPEN_LLDP_PORT_ID_SUBTYPE_t *portIdSubtype,
688  open_buffdesc *portId);
689 
690 /*****************************************************************/
712  uint32_t ifNum,
713  open_buffdesc *systemName);
714 
715 /*****************************************************************/
737  uint32_t ifNum,
738  open_buffdesc *systemDesc);
739 
740 /*****************************************************************/
762  uint32_t ifNum,
763  open_buffdesc *portDesc);
764 
765 /*****************************************************************/
787  uint32_t ifNum,
788  open_buffdesc *sysCapSupp);
789 
790 /*****************************************************************/
812  uint32_t ifNum,
813  open_buffdesc *sysCapEnabled);
814 
815 /*****************************************************************/
838  uint32_t ifNum,
839  OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily,
840  open_buffdesc *address);
841 
842 /*****************************************************************/
859  uint32_t intf,
860  OPEN_CONTROL_t *mode);
861 
862 /*****************************************************************/
883  uint32_t intf,
884  OPEN_CONTROL_t mode);
885 
886 /*****************************************************************/
903  uint32_t intf,
904  OPEN_BOOL_t *mode);
905 
906 /*****************************************************************/
927  uint32_t intf,
928  OPEN_BOOL_t mode);
929 
930 /*****************************************************************/
953  uint32_t intf,
955 
956 /*****************************************************************/
983  uint32_t intf,
985 
986 /*****************************************************************/
1014  uint32_t intf, uint32_t remIndex, uint32_t timeStamp,
1015  OPEN_LLDP_MED_CAPABILITIES_t *supportedCapabilities,
1016  OPEN_LLDP_MED_CAPABILITIES_t *enabledCapabilities);
1017 
1018 /*****************************************************************/
1037  uint32_t intf, uint32_t remIndex, uint32_t timeStamp,
1038  uint32_t *deviceClass);
1039 
1040 /*****************************************************************/
1054  uint32_t *size);
1055 
1056 /*****************************************************************/
1078  uint32_t intf, uint32_t remIndex, uint32_t timeStamp,
1079  open_buffdesc *modelName);
1080 
1081 /*************************************************************************/
1095 open_error_t openapiLldpTxIntervalGet(openapiClientHandle_t *client_handle, uint32_t *interval);
1096 
1097 /*************************************************************************/
1112 open_error_t openapiLldpTxIntervalSet(openapiClientHandle_t *client_handle, uint32_t interval);
1113 
1114 /*************************************************************************/
1128 open_error_t openapiLldpTxHoldGet(openapiClientHandle_t *client_handle, uint32_t *holdCount);
1129 
1130 /*************************************************************************/
1145 open_error_t openapiLldpTxHoldSet(openapiClientHandle_t *client_handle, uint32_t holdCount);
1146 
1147 /*************************************************************************/
1161 open_error_t openapiLldpTxReinitDelayGet(openapiClientHandle_t *client_handle, uint32_t *delay);
1162 
1163 /*************************************************************************/
1178 open_error_t openapiLldpTxReinitDelaySet(openapiClientHandle_t *client_handle, uint32_t delay);
1179 
1180 /*************************************************************************/
1195  uint32_t *interval);
1196 
1197 /*************************************************************************/
1213  uint32_t interval);
1214 
1215 /*************************************************************************/
1230  uint32_t *count);
1231 
1232 /*************************************************************************/
1248  uint32_t count);
1249 
1250 /*************************************************************************/
1266  uint32_t ifNum, OPEN_BOOL_t *mode);
1267 
1268 /*************************************************************************/
1285  uint32_t ifNum, OPEN_BOOL_t mode);
1286 
1287 /*************************************************************************/
1304  uint32_t ifNum,
1305  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1306  uint32_t *vlanId);
1307 
1308 /*************************************************************************/
1325  uint32_t ifNum,
1326  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1327  OPEN_BOOL_t *taggedStatus);
1328 
1329 /*************************************************************************/
1346  uint32_t ifNum,
1347  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1348  uint32_t *priority);
1349 
1350 /*************************************************************************/
1367  uint32_t ifNum,
1368  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1369  uint32_t *dscp);
1370 
1371 /*************************************************************************/
1386  uint32_t *ifNum);
1387 
1388 /*************************************************************************/
1404  uint32_t ifNum, uint32_t *nextIfNum);
1405 
1406 /*************************************************************************/
1426  uint32_t ifNum,
1427  uint32_t remIndex,
1428  uint32_t timestamp,
1429  OPEN_BOOL_t *isCapable);
1430 
1431 /*************************************************************************/
1451  uint32_t ifNum,
1452  uint32_t remIndex,
1453  uint32_t timestamp,
1454  OPEN_BOOL_t *isEnabled);
1455 
1456 /*************************************************************************/
1476  uint32_t ifNum,
1477  uint32_t remIndex,
1478  uint32_t timestamp,
1479  open_buffdesc *advrtCap);
1480 
1481 /*************************************************************************/
1500  uint32_t ifNum,
1501  uint32_t remIndex,
1502  uint32_t timestamp,
1503  uint32_t *type);
1504 
1505 /*************************************************************************/
1521  uint32_t mauType,
1522  open_buffdesc *mauString);
1523 
1524 /*************************************************************************/
1543  uint32_t ifNum, uint32_t remIndex,
1544  uint32_t timestamp,
1545  open_buffdesc *hardwareRev);
1546 
1547 /*************************************************************************/
1566  uint32_t ifNum, uint32_t remIndex,
1567  uint32_t timestamp,
1568  open_buffdesc *firmwareRev);
1569 
1570 /*************************************************************************/
1589  uint32_t ifNum, uint32_t remIndex,
1590  uint32_t timestamp,
1591  open_buffdesc *softwareRev);
1592 
1593 /*************************************************************************/
1612  uint32_t ifNum, uint32_t remIndex,
1613  uint32_t timestamp,
1614  open_buffdesc *serialNum);
1615 
1616 /*************************************************************************/
1635  uint32_t ifNum, uint32_t remIndex,
1636  uint32_t timestamp,
1637  open_buffdesc *assetId);
1638 
1639 /*************************************************************************/
1658  uint32_t ifNum, uint32_t remIndex,
1659  uint32_t timestamp,
1660  uint32_t *deviceType);
1661 
1662 /*************************************************************************/
1681  uint32_t ifNum, uint32_t remIndex,
1682  uint32_t timestamp,
1683  uint32_t *powerAv);
1684 
1685 /*************************************************************************/
1704  uint32_t ifNum, uint32_t remIndex,
1705  uint32_t timestamp,
1706  uint32_t *powerSrcType);
1707 
1708 /*************************************************************************/
1727  uint32_t ifNum, uint32_t remIndex,
1728  uint32_t timestamp,
1729  uint32_t *powerPri);
1730 
1731 /*************************************************************************/
1752  uint32_t ifNum, uint32_t remIndex,
1753  uint32_t timestamp,
1755  open_buffdesc *locInfo);
1756 
1757 /*************************************************************************/
1777  uint32_t ifNum,
1778  uint32_t remIndex,
1779  uint32_t timestamp,
1780  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1781  uint32_t *vlanId);
1782 
1783 /*************************************************************************/
1803  uint32_t ifNum,
1804  uint32_t remIndex,
1805  uint32_t timestamp,
1806  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1807  uint32_t *priority);
1808 
1809 /*************************************************************************/
1829  uint32_t ifNum, uint32_t remIndex,
1830  uint32_t timestamp,
1831  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1832  uint32_t *dscp);
1833 
1834 /*************************************************************************/
1854  uint32_t ifNum,
1855  uint32_t remIndex,
1856  uint32_t timestamp,
1857  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1858  OPEN_BOOL_t *unknown);
1859 
1860 /*************************************************************************/
1880  uint32_t ifNum,
1881  uint32_t remIndex,
1882  uint32_t timestamp,
1883  OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t policyAppType,
1884  OPEN_BOOL_t *tagged);
1885 
1886 /*************************************************************************/
1907  uint32_t ifNum, uint32_t remIndex,
1908  uint32_t timestamp,
1909  uint32_t tlvType,
1910  uint32_t *nextTlvType);
1911 
1912 /*************************************************************************/
1932  uint32_t ifNum,
1933  uint32_t remIndex,
1934  uint32_t timestamp,
1935  uint32_t tlvType,
1936  OPEN_BOOL_t *isExists);
1937 
1938 /*************************************************************************/
1958  uint32_t ifNum,
1959  uint32_t remIndex,
1960  uint32_t timestamp,
1961  uint32_t tlvType,
1962  open_buffdesc *info);
1963 
1964 /*************************************************************************/
1983  uint32_t ifNum, uint32_t remIndex,
1984  uint32_t timestamp,
1985  open_buffdesc *mfgName);
1986 
1987 /*************************************************************************/
2006  uint32_t ifNum, uint32_t remIndex,
2007  uint32_t timestamp,
2008  open_buffdesc *modelName);
2009 
2010 /*************************************************************************/
2029  uint32_t ifNum, uint32_t remIndex,
2030  uint32_t timestamp,
2031  uint32_t *powerReq);
2032 
2033 /*************************************************************************/
2052  uint32_t ifNum, uint32_t remIndex,
2053  uint32_t timestamp,
2054  uint32_t *powerSrc);
2055 
2056 /*************************************************************************/
2075  uint32_t ifNum, uint32_t remIndex,
2076  uint32_t timestamp,
2077  uint32_t *powerPri);
2078 
2079 /*************************************************************************/
2100  uint32_t ifNum, uint32_t remIndex,
2101  uint32_t timestamp, uint32_t infoIndex,
2102  open_buffdesc *oui);
2103 
2104 /*************************************************************************/
2124  uint32_t ifNum, uint32_t remIndex,
2125  uint32_t timestamp, uint32_t infoIndex,
2126  uint32_t *subtype);
2127 
2128 /*************************************************************************/
2145  open_buffdesc *subtypeStr);
2146 
2147 /*************************************************************************/
2163  uint32_t subtype,
2164  open_buffdesc *subtypeStr);
2165 
2166 /*****************************************************************/
2200  uint32_t ifNum,
2201  uint32_t remIndex,
2202  uint32_t timeStamp,
2203  OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily,
2204  open_buffdesc *address,
2205  uint8_t *addrLen,
2207  uint32_t *intfId);
2208 
2209 /*************************************************************************/
2226  uint32_t ifNum,
2227  OPEN_BOOL_t *isCapable);
2228 
2229 /*************************************************************************/
2245  uint32_t ifNum,
2246  OPEN_BOOL_t *isEnabled);
2247 
2248 /*************************************************************************/
2265  uint32_t ifNum,
2266  open_buffdesc *advrtCap);
2267 
2268 /*************************************************************************/
2284  uint32_t ifNum,
2285  uint32_t *type);
2286 
2287 /*************************************************************************/
2302  uint32_t *deviceClass);
2303 
2304 /*************************************************************************/
2324  uint32_t ifNum,
2325  uint16_t *portVlan);
2326 
2327 /*************************************************************************/
2350  uint32_t ifNum,
2351  uint32_t remIndex,
2352  uint32_t timeStamp,
2353  uint16_t *portVlan);
2354 
2355 /*************************************************************************/
2372  uint32_t ifNum,
2373  OPEN_VLAN_LIST_t *vlanList);
2374 
2375 /*************************************************************************/
2393  uint32_t ifNum,
2394  uint32_t vlanId,
2395  open_buffdesc *vlanName);
2396 
2397 /*************************************************************************/
2423  uint32_t ifNum,
2424  uint32_t remIndex,
2425  uint32_t timeStamp,
2426  uint32_t infoIndex,
2427  uint32_t *nextInfoIndex);
2428 
2429 /*************************************************************************/
2455  uint32_t ifNum,
2456  uint32_t remIndex,
2457  uint32_t timeStamp,
2458  uint32_t infoIndex,
2459  uint16_t *vlan,
2460  open_buffdesc *vlanName);
2461 
2462 /*************************************************************************/
2480  uint32_t ifNum,
2481  uint16_t *maxFrameSize);
2482 
2483 /*************************************************************************/
2507  uint32_t ifNum,
2508  uint32_t remIndex,
2509  uint32_t timeStamp,
2510  uint16_t *maxFrameSize);
2511 
2512 /*************************************************************************/
2536  uint32_t ifNum,
2537  OPEN_BOOL_t *aggregationCapable,
2538  OPEN_BOOL_t *aggregationMember,
2539  uint32_t *aggregationId);
2540 
2541 /*************************************************************************/
2570  uint32_t ifNum,
2571  uint32_t remIndex,
2572  uint32_t timeStamp,
2573  OPEN_BOOL_t *aggregationCapable,
2574  OPEN_BOOL_t *aggregationMember,
2575  uint32_t *aggregationId);
2576 #endif /* OPENAPI_LLDP_H_INCLUDED */
2577 
open_error_t openapiLldpdot3LocPortAutoNegSupportedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isCapable)
Get the port's auto negotiation capability.
open_error_t openapiLldpIntfRemotePortLinkAggregationInfoGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, OPEN_BOOL_t *aggregationCapable, OPEN_BOOL_t *aggregationMember, uint32_t *aggregationId)
Gets the 802.1AB remote port link aggregation for the specified interface.
open_error_t openapiLldpTxIntervalGet(openapiClientHandle_t *client_handle, uint32_t *interval)
Gets the 802.1AB global transmit interval.
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.
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
Definition: openapi_lldp.h:90
System Capabilities TLV.
Definition: openapi_lldp.h:80
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.
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
Definition: openapi_lldp.h:67
OPEN_LLDP_CHASSIS_ID_SUBTYPE_t
Definition: openapi_lldp.h:56
Link Aggregation TLV.
Definition: openapi_lldp.h:86
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_error_t openapiLldpdot3RemPortAutoNegOperMauStringGet(openapiClientHandle_t *client_handle, uint32_t mauType, open_buffdesc *mauString)
Get remote port's auto negotiation operational MAU in string format.
Video signaling policy.
Definition: openapi_lldp.h:107
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.
open_error_t openapiLldpMedIntfModeSet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t mode)
Set LLDP-MED administrative mode on valid LLDP interfaces.
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.
open_error_t openapiLldpIntfRemoteDeviceMaxFrameSizeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, uint16_t *maxFrameSize)
Gets the 802.1AB remote port Maximum Frame Size for the specified interface.
open_error_t openapiLldpMedIntfModeGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t *mode)
Get the interface LLDP-MED administrative mode.
Streaming video policy.
Definition: openapi_lldp.h:106
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.
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_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
Definition: openapi_lldp.h:118
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.
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_error_t
OPEN uses these enumerators to indicate the error codes.
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.
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_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.
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.
open_error_t openapiLldpIntfNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
Gets the next valid LLDP interface.
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.
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.
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_error_t openapiLldpIntfLocalPortLinkAggregationInfoGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *aggregationCapable, OPEN_BOOL_t *aggregationMember, uint32_t *aggregationId)
Gets the 802.1AB local port link aggregation for the specified interface.
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.
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_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_error_t openapiLldpIntfLocalDeviceMaxFrameSizeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint16_t *maxFrameSize)
Gets the 802.1AB local Maximum Frame Size for the specified interface.
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.
open_error_t openapiLldpRemoteDeviceVlanInfoIndexGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, uint32_t infoIndex, uint32_t *nextInfoIndex)
Gets the 802.1AB next information index for the matching VLAN entries for the specified interface...
open_error_t openapiLldpIntfLocalDeviceVlanGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_VLAN_LIST_t *vlanList)
Gets the 802.1AB local VLANs for the specified interface.
Softphone voice policy.
Definition: openapi_lldp.h:104
Port VLAN ID TLV.
Definition: openapi_lldp.h:83
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.
System Name TLV.
Definition: openapi_lldp.h:79
open_error_t openapiLldpTxReinitDelayGet(openapiClientHandle_t *client_handle, uint32_t *delay)
Gets the 802.1AB global transmit reinit delay.
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.
open_error_t openapiLldpdot3LocPortAutoNegOperMauTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *type)
Get port's auto negotiation operational MAU Type.
open_error_t openapiLldpdot3LocPortAutoNegAdvertizedCapGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *advrtCap)
Get port's auto negotiation advertized capability as a string.
open_error_t openapiLldpPortIdSubtypeStringGet(openapiClientHandle_t *client_handle, uint32_t subtype, open_buffdesc *subtypeStr)
Get a string representation for port ID Subtype.
open_error_t openapiLldpRemoteIntfFirstGet(openapiClientHandle_t *client_handle, uint32_t *ifNum)
Get the first interface enable for LLDP receives.
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.
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_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_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.
open_error_t openapiLldpIntfLocalDevicePortVlanGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint16_t *portVlan)
Gets the 802.1AB local port VLAN for the specified interface.
open_error_t openapiLldpRemoteIntfNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
Get the next valid interface enabled for LLDP receives.
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
Definition: openapi_lldp.h:97
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.
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_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.
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.
open_error_t openapiLldpMgmtStrLenGet(openapiClientHandle_t *client_handle, uint32_t *strLen)
Gets the LLDP Management string length.
open_error_t openapiLldpXMedFastStartRepeatCountGet(openapiClientHandle_t *client_handle, uint32_t *count)
Gets the fast start repeat count.
open_error_t openapiLldpIntfNotificationModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpNotMode)
Sets the LLDP Notification mode for the specified interface.
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.
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 uses these enumerators to indicate enable or disable for a given config or status parameter...
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.
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.
open_error_t openapiLldpMedLocDeviceClassGet(openapiClientHandle_t *client_handle, uint32_t *deviceClass)
Get local device's MED Classification.
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
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.
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.
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.
open_error_t openapiLldpMedRemoteModelNameSizeGet(openapiClientHandle_t *client_handle, uint32_t *size)
Get the size in bytes for the open_buffdesc used to call openapiLldpMedRemoteModelNameGet().
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.
open_error_t openapiLldpIntfTransmitModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpTxMode)
Sets LLDP PDU transmit mode on the specified interface.
open_error_t openapiLldpIntfNotificationModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lldpNotMode)
Gets the LLDP Notification mode for the specified interface.
open_error_t openapiLldpIntfRemoteDeviceVlanIdAndNameGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, uint32_t infoIndex, uint16_t *vlan, open_buffdesc *vlanName)
Gets the 802.1AB local VLAN name for the specified VLAN.
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
Definition: openapi_lldp.h:110
open_error_t openapiLldpMedIntfConfigNotificationModeGet(openapiClientHandle_t *client_handle, uint32_t intf, OPEN_BOOL_t *mode)
Get the interface LLDP-MED configuration notification mode.
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_error_t openapiLldpNotificationIntervalGet(openapiClientHandle_t *client_handle, uint32_t *interval)
Gets the 802.1AB global notification interval limit.
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.
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.
Maximum Frame Size TLV.
Definition: openapi_lldp.h:85
Video conferencing policy.
Definition: openapi_lldp.h:105
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_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.
open_error_t openapiLldpTxReinitDelaySet(openapiClientHandle_t *client_handle, uint32_t delay)
Sets the 802.1AB global transmit reinit delay.
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.
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.
open_error_t openapiLldpTxIntervalSet(openapiClientHandle_t *client_handle, uint32_t interval)
Sets the 802.1AB global transmit interval.
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.
open_error_t openapiLldpNotificationIntervalSet(openapiClientHandle_t *client_handle, uint32_t interval)
Sets the 802.1AB global notification interval limit.
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.
System Description TLV.
Definition: openapi_lldp.h:78
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.
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.
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.
Guest voice signaling policy.
Definition: openapi_lldp.h:103
Civic address location.
Definition: openapi_lldp.h:114
open_error_t openapiLldpIntfRemoteDevicePortVlanGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, uint16_t *portVlan)
Gets the 802.1AB remote port VLAN for the specified interface.
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.
open_error_t openapiLldpdot3LocPortAutoNegEnabledGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isEnabled)
Get port's auto negotiation enabled status.
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.
open_error_t openapiLldpTxHoldSet(openapiClientHandle_t *client_handle, uint32_t holdCount)
Sets the 802.1AB global transmit hold muliplier.
Port Description TLV.
Definition: openapi_lldp.h:81
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.
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.
open_error_t openapiLldpXMedFastStartRepeatCountSet(openapiClientHandle_t *client_handle, uint32_t count)
Sets the fast start repeat count.
Co ordinate based location.
Definition: openapi_lldp.h:113
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
Definition: openapi_lldp.h:77
VLAN Name TLV.
Definition: openapi_lldp.h:84
Management Address TLV.
Definition: openapi_lldp.h:82
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_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.
open_error_t openapiLldpIntfLocalDeviceVlanNameGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId, open_buffdesc *vlanName)
Gets the 802.1AB local VLAN name for the specified VLAN.
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.
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.
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.
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_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.