Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Macros | Enumerations | Functions
openapi_lldp.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

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...