Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Macros | Enumerations | Functions
LLDP Configuration And Status [OPENAPI_LLDP]

Data Structures

struct  OPEN_LLDP_MED_CAPABILITIES_t
 

Macros

#define OPEN_LLDP_MED_CAP_CAPABILITIES_BITMASK   0x01
 
#define OPEN_LLDP_MED_CAP_EXT_PD_BITMASK   0x10
 
#define OPEN_LLDP_MED_CAP_EXT_PSE_BITMASK   0x08
 
#define OPEN_LLDP_MED_CAP_INVENTORY_BITMASK   0x20
 
#define OPEN_LLDP_MED_CAP_LOCATION_BITMASK   0x04
 
#define OPEN_LLDP_MED_CAP_NETWORKPOLICY_BITMASK   0x02
 

Enumerations

enum  OPEN_LLDP_CHASSIS_ID_SUBTYPE_t {
  OPEN_LLDP_CHASSIS_ID_SUBTYPE_CHASSIS_COMP = 1, OPEN_LLDP_CHASSIS_ID_SUBTYPE_INTF_ALIAS = 2, OPEN_LLDP_CHASSIS_ID_SUBTYPE_PORT_COMP = 3, OPEN_LLDP_CHASSIS_ID_SUBTYPE_MAC_ADDR = 4,
  OPEN_LLDP_CHASSIS_ID_SUBTYPE_NET_ADDR = 5, OPEN_LLDP_CHASSIS_ID_SUBTYPE_INTF_NAME = 6, OPEN_LLDP_CHASSIS_ID_SUBTYPE_LOCAL = 7
}
 
enum  OPEN_LLDP_IANA_ADDR_FAMILY_t { OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_RESERVED = 0, OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV4 = 1, OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV6 = 2, OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_802 = 6 }
 
enum  OPEN_LLDP_PORT_ID_SUBTYPE_t {
  OPEN_LLDP_PORT_ID_SUBTYPE_INTF_ALIAS = 1, OPEN_LLDP_PORT_ID_SUBTYPE_PORT_COMP = 2, OPEN_LLDP_PORT_ID_SUBTYPE_MAC_ADDR = 3, OPEN_LLDP_PORT_ID_SUBTYPE_NET_ADDR = 4,
  OPEN_LLDP_PORT_ID_SUBTYPE_INTF_NAME = 5, OPEN_LLDP_PORT_ID_SUBTYPE_AGENT_ID = 6, OPEN_LLDP_PORT_ID_SUBTYPE_LOCAL = 7
}
 
enum  OPEN_LLDP_TLV_TYPE_t {
  OPEN_LLDP_SYS_DESC_TLV = 0, OPEN_LLDP_SYS_NAME_TLV = 1, OPEN_LLDP_SYS_CAPABILITIES_TLV = 2, OPEN_LLDP_PORT_DESC_TLV = 3,
  OPEN_LLDP_MGMT_ADDRESS_TLV = 4, OPEN_LLDP_LAST_TLV = 5
}
 

Functions

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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiLldpIntfNextGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
 Gets the next valid LLDP interface. More...
 
open_error_t openapiLldpIntfNotificationModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lldpNotMode)
 Gets the LLDP Notification mode for the specified interface. More...
 
open_error_t openapiLldpIntfNotificationModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpNotMode)
 Sets the LLDP Notification mode for the specified interface. More...
 
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. More...
 
open_error_t openapiLldpIntfReceiveModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpRxMode)
 Sets LLDP PDU reception mode on the specified interface. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiLldpIntfTransmitModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpTxMode)
 Sets LLDP PDU transmit mode on the specified interface. More...
 
open_error_t openapiLldpMedIntfConfigNotificationModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_BOOL_t *mode)
 Get the interface LLDP-MED configuration notification mode. More...
 
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. More...
 
open_error_t openapiLldpMedIntfModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t *mode)
 Get the interface LLDP-MED administrative mode. More...
 
open_error_t openapiLldpMedIntfModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t mode)
 Set LLDP-MED administrative mode on valid LLDP interfaces. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiLldpMedRemoteModelNameSizeGet (openapiClientHandle_t *client_handle, uint32_t *size)
 Get the size in bytes for the open_buffdesc used to call openapiLldpMedRemoteModelNameGet(). More...
 
open_error_t openapiLldpMgmtStrLenGet (openapiClientHandle_t *client_handle, uint32_t *strLen)
 Gets the LLDP Management string length. More...
 

Detailed Description

Enumeration Type Documentation

Enumerator
OPEN_LLDP_CHASSIS_ID_SUBTYPE_CHASSIS_COMP 

Chassis Component.

OPEN_LLDP_CHASSIS_ID_SUBTYPE_INTF_ALIAS 

Interface Alias.

OPEN_LLDP_CHASSIS_ID_SUBTYPE_PORT_COMP 

Port Component.

OPEN_LLDP_CHASSIS_ID_SUBTYPE_MAC_ADDR 

MAC Address.

OPEN_LLDP_CHASSIS_ID_SUBTYPE_NET_ADDR 

Network Address.

OPEN_LLDP_CHASSIS_ID_SUBTYPE_INTF_NAME 

Interface Name.

OPEN_LLDP_CHASSIS_ID_SUBTYPE_LOCAL 

Local.

Definition at line 55 of file openapi_lldp.h.

Enumerator
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_RESERVED 

Reserved.

OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV4 

IPv4.

OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV6 

IPv6.

OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_802 

802

Definition at line 85 of file openapi_lldp.h.

Enumerator
OPEN_LLDP_PORT_ID_SUBTYPE_INTF_ALIAS 

Interface Alias.

OPEN_LLDP_PORT_ID_SUBTYPE_PORT_COMP 

Port Component.

OPEN_LLDP_PORT_ID_SUBTYPE_MAC_ADDR 

MAC Address.

OPEN_LLDP_PORT_ID_SUBTYPE_NET_ADDR 

Network Address.

OPEN_LLDP_PORT_ID_SUBTYPE_INTF_NAME 

Interface Name.

OPEN_LLDP_PORT_ID_SUBTYPE_AGENT_ID 

Agent Circuit Id.

OPEN_LLDP_PORT_ID_SUBTYPE_LOCAL 

Local.

Definition at line 66 of file openapi_lldp.h.

Enumerator
OPEN_LLDP_SYS_DESC_TLV 

System Description TLV.

OPEN_LLDP_SYS_NAME_TLV 

System Name TLV.

OPEN_LLDP_SYS_CAPABILITIES_TLV 

System Capabilities TLV.

OPEN_LLDP_PORT_DESC_TLV 

Port Description TLV.

OPEN_LLDP_MGMT_ADDRESS_TLV 

Management Address TLV.

OPEN_LLDP_LAST_TLV 

Unused.

Definition at line 76 of file openapi_lldp.h.

Function Documentation

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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]chassisIdSubtypeChassis Id Subtype of type OPEN_LLDP_CHASSIS_ID_SUBTYPE_t
[out]chassisIdChassis Id
Note
Maximum size for chassisId is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEChassis Id and Subtype get successful.
OPEN_E_FAILChassis Id and Subtype get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in,out]addressFamilyAddress Family
[in,out]addressAddress
Note
Maximum size for address is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEManagement Address get successful.
OPEN_E_FAILManagement Address get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]portDescLocal Device Port Description
Note
Maximum size for portDesc is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEPort Description get successful.
OPEN_E_FAILPort Description get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]portIdSubtypePort Id Subtype of type OPEN_LLDP_PORT_ID_SUBTYPE_t
[out]portIdPort Id
Note
Maximum size for portId is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEPort Id and Subtype get successful.
OPEN_E_FAILPort Id and Subtype get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]sysCapEnabledLocal Device System Capabilities Enabled
Note
Maximum size for sysCapEnabled is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEEnabled Capabilities get successful.
OPEN_E_FAILSupported Capabilities get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]sysCapSuppLocal Device System Capabilities Supported
Note
Maximum size for sysCapSupp is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONESupported Capabilities get successful.
OPEN_E_FAILSupported Capabilities get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]systemDescLocal Device System Description
Note
Maximum size for systemDesc is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONESystem Description get successful.
OPEN_E_FAILSystem Description get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]systemNameRemote Device System Name
Note
Maximum size for systemName is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONESystem Name get successful.
OPEN_E_FAILSystem Name get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
open_error_t openapiLldpIntfNextGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  nextIfNum 
)

Gets the next valid LLDP interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]nextIfNumID of the next interface
Return values
OPEN_E_NONENext valid LLDP interface get successful.
OPEN_E_UNAVAILNo next valid LLDP interface found.

OpEN API Version: 1.1

Examples:
lldp_example.c.
open_error_t openapiLldpIntfNotificationModeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t lldpNotMode 
)

Gets the LLDP Notification mode for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]lldpNotModeLLDP Notification mode
Return values
OPEN_E_NONENotification mode get successful.
OPEN_E_FAILNotification mode get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
open_error_t openapiLldpIntfNotificationModeSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t  lldpNotMode 
)

Sets the LLDP Notification mode for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]lldpNotModeLLDP Notification mode
Return values
OPEN_E_NONENotification mode set successful.
OPEN_E_FAILNotification mode set failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed. Invalid lldpNotMode can cause this return code.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]lldpRxModeLLDP receive mode
Return values
OPEN_E_NONEReceive mode get successful .
OPEN_E_FAILReceive mode get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed. NULL lldpRxMode can cause this return code.

OpEN API Version: 1.1

Examples:
lldp_example.c.
open_error_t openapiLldpIntfReceiveModeSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t  lldpRxMode 
)

Sets LLDP PDU reception mode on the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]lldpRxModeLLDP receive mode
Return values
OPEN_E_NONEReceive mode set successful.
OPEN_E_FAILReceive mode set failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed. Invalid lldpRxMode can cause this return code.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]chassisIdSubtypeChassis Id Subtype of type OPEN_LLDP_CHASSIS_ID_SUBTYPE_t
[out]chassisIdChassis Id.
Note
Maximum size for chassisId is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEChassis Id and Subtype get successful.
OPEN_E_FAILChassis Id and Subtype get failed.
OPEN_E_PARAMError in parameter passed.
OPEN_E_INTERNALOther internal error.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in,out]addressFamilyAddress Family. Pass 0 for the first time.
[in,out]addressAddress Initialize portDesc:pstart and size with a char buffer of length returned by openapiLldpMgmtStrLenGet()
[in,out]addrLenAddress Length. Passing 0 will return the first address
Note
Maximum size for address is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEManagement Address get successful.
OPEN_E_FAILManagement Address get failed.
OPEN_E_UNAVAILNext Management Address not available.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Passing 0 for the remIndex and timeStamp returns the first Neighbor entry.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in,out]remIndexRemote Device Index
[in,out]timeStampTimestamp when the entry was added
Return values
OPEN_E_NONENeighbor entry get successful.
OPEN_E_FAILNext Neighbor entry is not present.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]portDescRemote Device Port Description
Note
Maximum size for portDesc is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEPort Description get successful.
OPEN_E_FAILPort Description get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]portIdSubtypePort Id Subtype of type OPEN_LLDP_PORT_ID_SUBTYPE_t
[out]portIdPort Id
Note
Maximum size for portId is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEPort Id and Subtype get successful.
OPEN_E_FAILPort Id and Subtype get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]sysCapEnabledRemote Device System Capabilities Enabled
Note
Maximum size for sysCapEnabled is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONEEnabled Capabilities get successful.
OPEN_E_FAILSupported Capabilities get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]sysCapSuppRemote Device System Capabilities Supported
Note
Maximum size for sysCapSupp is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONESupported Capabilities get successful.
OPEN_E_FAILSupported Capabilities get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]systemDescRemote Device System Description
Note
Maximum size for systemDesc is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONESystem Description get successful.
OPEN_E_FAILSystem Description get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]systemNameRemote Device System Name
Note
Maximum size for systemName is determined by calling openapiLldpMgmtStrLenGet().
Return values
OPEN_E_NONESystem Name get successful.
OPEN_E_FAILSystem Name get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]remIndexRemote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]ttlRemote Device TTL
Return values
OPEN_E_NONETTL get successful.
OPEN_E_FAILTTL get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]tlvTypeLLDP TLV of type OPEN_LLDP_TLV_TYPE_t
[out]tlvTransmitModeTLV transmit mode
Return values
OPEN_E_NONETLVs transmit mode get successful.
OPEN_E_FAILTLVs transmit mode get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]tlvTypeLLDP TLV of type OPEN_LLDP_TLV_TYPE_t
[in]tlvTransmitModeTLV transmit mode
Return values
OPEN_E_NONETLVs transmit mode set successful.
OPEN_E_FAILTLVs transmit mode set failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[out]lldpTxModeLLDP transmit mode
Return values
OPEN_E_NONETransmit mode get successful .
OPEN_E_FAILTransmit mode get failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed. NULL lldpTxMode can cause this return code.
OPEN_E_INTERNALOther Internal Failure.

OpEN API Version: 1.1

Examples:
lldp_example.c.
open_error_t openapiLldpIntfTransmitModeSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t  lldpTxMode 
)

Sets LLDP PDU transmit mode on the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumID of the interface
[in]lldpTxModeLLDP transmit mode
Return values
OPEN_E_NONETransmit mode set successful.
OPEN_E_FAILTransmit mode set failed.
OPEN_E_UNAVAILLLDP not supported on this interface.
OPEN_E_PARAMError in parameter passed. Invalid lldpTxMode can cause this return code.
OPEN_E_INTERNALOther Internal Failure.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:
lldp_example.c.
open_error_t openapiLldpMedIntfConfigNotificationModeGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
OPEN_BOOL_t mode 
)

Get the interface LLDP-MED configuration notification mode.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface
[out]modenotification mode Possible values OPEN_BOOL_t
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.14

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface or OPEN_ALL_INTERFACES for all interfaces
[in]modenotification mode Possible values OPEN_BOOL_t
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.
Configuration notification mode is set on all valid LLDP interfaces, if OPEN_ALL_INTERFACES is passed in for the 'intf' parameter.

OpEN API Version: 1.14

Examples:
lldp_example.c.
open_error_t openapiLldpMedIntfModeGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
OPEN_CONTROL_t mode 
)

Get the interface LLDP-MED administrative mode.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface
[out]modelldp mode Possible values OPEN_CONTROL_t
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.14

Examples:
lldp_example.c.
open_error_t openapiLldpMedIntfModeSet ( openapiClientHandle_t client_handle,
uint32_t  intf,
OPEN_CONTROL_t  mode 
)

Set LLDP-MED administrative mode on valid LLDP interfaces.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface or OPEN_ALL_INTERFACES for all interfaces
[in]modelldp mode Possible values OPEN_CONTROL_t
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.
Administrative mode is set on all valid LLDP interfaces, if OPEN_ALL_INTERFACES is passed in for the 'intf' parameter.

OpEN API Version: 1.14

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface
[out]capbitmask of TLVs enabled
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
The following bitmask values are provided for convenience.
  • Bitmask value OPEN_LLDP_MED_CAP_CAPABILITIES_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_NETWORKPOLICY_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_LOCATION_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_EXT_PSE_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_EXT_PD_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_INVENTORY_BITMASK

OpEN API Version: 1.14

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface or OPEN_ALL_INTERFACES for all interfaces
[in]capbitmask of TLVs to be enabled
Return values
OPEN_E_NONESet successful.
OPEN_E_FAILSet failed.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch.
TLV bitmask for transmission is set on all valid LLDP interfaces, if OPEN_ALL_INTERFACES is passed in for the 'intf' parameter.
The following bitmask values are provided for convenience.
  • Bitmask value OPEN_LLDP_MED_CAP_CAPABILITIES_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_NETWORKPOLICY_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_LOCATION_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_EXT_PSE_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_EXT_PD_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_INVENTORY_BITMASK

OpEN API Version: 1.14

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface
[in]remIndexRemote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]supportedCapabilitiesbitmask of TLVs supported
[out]enabledCapabilitiesbitmask of TLVs enabled
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
The following bitmask values are provided for convenience.
  • Bitmask value OPEN_LLDP_MED_CAP_CAPABILITIES_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_NETWORKPOLICY_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_LOCATION_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_EXT_PSE_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_EXT_PD_BITMASK
  • Bitmask value OPEN_LLDP_MED_CAP_INVENTORY_BITMASK

OpEN API Version: 1.14

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface
[in]remIndexRemote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]deviceClassclass of the remote device
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.14

Examples:
lldp_example.c.
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.

Parameters
[in]client_handleclient handle from registration API
[in]intfID of the interface
[in]remIndexRemote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]timeStampRemote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]modelNamemodel name of the remote device
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
Size of buffer is returned by openapiLldpMedRemoteModelNameSizeGet(). Using a smaller buffer may result in truncated data being returned.

OpEN API Version: 1.14

Examples:
lldp_example.c.
open_error_t openapiLldpMedRemoteModelNameSizeGet ( openapiClientHandle_t client_handle,
uint32_t *  size 
)

Get the size in bytes for the open_buffdesc used to call openapiLldpMedRemoteModelNameGet().

Parameters
[in]client_handleclient handle from registration API
[out]sizenumber of bytes to allocate in buffer
Return values
OPEN_E_NONEGet successful.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.14

Examples:
lldp_example.c.
open_error_t openapiLldpMgmtStrLenGet ( openapiClientHandle_t client_handle,
uint32_t *  strLen 
)

Gets the LLDP Management string length.

This length is used to allocate and initialize the open_buffdesc type argument buffers used by various LLDP OpEN APIs.

Parameters
[in]client_handleclient handle from registration API
[out]strLenstring length
Return values
OPEN_E_NONEString length get successful.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.1

Examples:
lldp_example.c.