LLDP Configuration And Status [OPENAPI_LLDP]

Data Structures
struct	OPEN_LLDP_MED_CAPABILITIES_t

Macros
#define	OPEN_LLDP_AUTO_NEG_ADVERTIZED_CAPABILITY_SIZE   3
#define	OPEN_LLDP_CHASSIS_ID_SUBTYPE_STRING_SIZE   64
#define	OPEN_LLDP_LOCATION_INFO_STRING_SIZE   256
#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
#define	OPEN_LLDP_MED_FASTSTART_REPEAT_COUNT_MAX   10
#define	OPEN_LLDP_MED_FASTSTART_REPEAT_COUNT_MIN   1
#define	OPEN_LLDP_NOTIFY_INTERVAL_MAX   3600
#define	OPEN_LLDP_NOTIFY_INTERVAL_MIN   5
#define	OPEN_LLDP_REINIT_DELAY_MAX   10
#define	OPEN_LLDP_REINIT_DELAY_MIN   1
#define	OPEN_LLDP_STRING_SIZE   32
#define	OPEN_LLDP_TX_HOLD_MULTIPLIER_MAX   10
#define	OPEN_LLDP_TX_HOLD_MULTIPLIER_MIN   2
#define	OPEN_LLDP_TX_INTERVAL_MAX   32768
#define	OPEN_LLDP_TX_INTERVAL_MIN   5
#define	OPEN_LLDP_UNKNOWN_TLV_INFO_SIZE_MAX   511

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_MAN_ADDR_IF_SUBTYPE_t { OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_UNKNOWN = 1, OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_IF_INDEX = 2, OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_PORT_NUMBER = 3 }
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_PORT_VLAN_TLV = 5, OPEN_LLDP_VLAN_NAME_TLV = 6, OPEN_LLDP_MAXIMUM_FRAME_SIZE_TLV = 7,   OPEN_LLDP_LINK_AGGREGATION_TLV = 8, OPEN_LLDP_LAST_TLV = 9 }
enum	OPEN_LLDPXMED_LOCATION_SUBTYPE_t { OPEN_UNKNOWN_LOCATION_SUBTYPE = 0, OPEN_COORDINATE_BASED_LOCATION_SUBTYPE, OPEN_CIVIC_ADDRESS_LOCATION_SUBTYPE, OPEN_ELIN_LOCATION_SUBTYPE }
enum	OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t {   OPEN_UNKNOWN_POLICY_APPTYPE = 0, OPEN_VOICE_POLICY_APPTYPE, OPEN_VOICE_SIGNALING_POLICY_APPTYPE, OPEN_GUEST_VOICE_POLICY_APPTYPE,   OPEN_GUEST_VOICE_SIGNALING_POLICY_APPTYPE, OPEN_SOFTPHONE_VOICE_POLICY_APPTYPE, OPEN_VIDEO_CONFERENCING_POLICY_APPTYPE, OPEN_STREAMING_VIDEO_POLICY_APPTYPE,   OPEN_VIDEO_SIGNALING_POLICY_APPTYPE }

Functions
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. More...
open_error_t	openapiLldpdot3LocPortAutoNegAdvertizedCapGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *advrtCap)
	Get port's auto negotiation advertized capability as a string. More...
open_error_t	openapiLldpdot3LocPortAutoNegEnabledGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isEnabled)
	Get port's auto negotiation enabled status. More...
open_error_t	openapiLldpdot3LocPortAutoNegOperMauTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *type)
	Get port's auto negotiation operational MAU Type. More...
open_error_t	openapiLldpdot3LocPortAutoNegSupportedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isCapable)
	Get the port's auto negotiation capability. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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	openapiLldpIntfLocalDeviceMaxFrameSizeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint16_t *maxFrameSize)
	Gets the 802.1AB local Maximum Frame Size 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	openapiLldpIntfLocalDevicePortVlanGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint16_t *portVlan)
	Gets the 802.1AB local port VLAN 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	openapiLldpIntfLocalDeviceVlanGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_VLAN_LIST_t *vlanList)
	Gets the 802.1AB local VLANs for the specified interface. More...
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. More...
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. 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	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. More...
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. 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	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. 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	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. More...
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. 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	openapiLldpIntfTxMgmtAddrModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mode)
	Gets the 802.1AB mgmt addr transmit mode for the specified interface. More...
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. 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	openapiLldpMedLocDeviceClassGet (openapiClientHandle_t *client_handle, uint32_t *deviceClass)
	Get local device's MED Classification. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. 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	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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
open_error_t	openapiLldpMgmtStrLenGet (openapiClientHandle_t *client_handle, uint32_t *strLen)
	Gets the LLDP Management string length. More...
open_error_t	openapiLldpNotificationIntervalGet (openapiClientHandle_t *client_handle, uint32_t *interval)
	Gets the 802.1AB global notification interval limit. More...
open_error_t	openapiLldpNotificationIntervalSet (openapiClientHandle_t *client_handle, uint32_t interval)
	Sets the 802.1AB global notification interval limit. More...
open_error_t	openapiLldpPortIdSubtypeStringGet (openapiClientHandle_t *client_handle, uint32_t subtype, open_buffdesc *subtypeStr)
	Get a string representation for port ID Subtype. More...
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. More...
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. More...
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. More...
open_error_t	openapiLldpRemoteIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
	Get the first interface enable for LLDP receives. More...
open_error_t	openapiLldpRemoteIntfNextGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
	Get the next valid interface enabled for LLDP receives. More...
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. More...
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. More...
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. More...
open_error_t	openapiLldpTxHoldGet (openapiClientHandle_t *client_handle, uint32_t *holdCount)
	Gets the 802.1AB global transmit hold muliplier. More...
open_error_t	openapiLldpTxHoldSet (openapiClientHandle_t *client_handle, uint32_t holdCount)
	Sets the 802.1AB global transmit hold muliplier. More...
open_error_t	openapiLldpTxIntervalGet (openapiClientHandle_t *client_handle, uint32_t *interval)
	Gets the 802.1AB global transmit interval. More...
open_error_t	openapiLldpTxIntervalSet (openapiClientHandle_t *client_handle, uint32_t interval)
	Sets the 802.1AB global transmit interval. More...
open_error_t	openapiLldpTxReinitDelayGet (openapiClientHandle_t *client_handle, uint32_t *delay)
	Gets the 802.1AB global transmit reinit delay. More...
open_error_t	openapiLldpTxReinitDelaySet (openapiClientHandle_t *client_handle, uint32_t delay)
	Sets the 802.1AB global transmit reinit delay. More...
open_error_t	openapiLldpXMedFastStartRepeatCountGet (openapiClientHandle_t *client_handle, uint32_t *count)
	Gets the fast start repeat count. More...
open_error_t	openapiLldpXMedFastStartRepeatCountSet (openapiClientHandle_t *client_handle, uint32_t count)
	Sets the fast start repeat count. More...
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. More...
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. More...
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. More...
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. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_LLDP_CHASSIS_ID_SUBTYPE_t

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 56 of file openapi_lldp.h.

enum OPEN_LLDP_IANA_ADDR_FAMILY_t

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 90 of file openapi_lldp.h.

enum OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_t

Enumerator
OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_UNKNOWN	Unknwon subtype.
OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_IF_INDEX	Interface index subtype.
OPEN_LLDP_MAN_ADDR_IF_SUBTYPE_PORT_NUMBER	Port number subtype.

Definition at line 118 of file openapi_lldp.h.

enum OPEN_LLDP_PORT_ID_SUBTYPE_t

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 67 of file openapi_lldp.h.

enum OPEN_LLDP_TLV_TYPE_t

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_PORT_VLAN_TLV	Port VLAN ID TLV.
OPEN_LLDP_VLAN_NAME_TLV	VLAN Name TLV.
OPEN_LLDP_MAXIMUM_FRAME_SIZE_TLV	Maximum Frame Size TLV.
OPEN_LLDP_LINK_AGGREGATION_TLV	Link Aggregation TLV.
OPEN_LLDP_LAST_TLV	Unused.

Definition at line 77 of file openapi_lldp.h.

enum OPEN_LLDPXMED_LOCATION_SUBTYPE_t

Enumerator
OPEN_UNKNOWN_LOCATION_SUBTYPE	Unknown location.
OPEN_COORDINATE_BASED_LOCATION_SUBTYPE	Co ordinate based location.
OPEN_CIVIC_ADDRESS_LOCATION_SUBTYPE	Civic address location.
OPEN_ELIN_LOCATION_SUBTYPE	Elin location.

Definition at line 110 of file openapi_lldp.h.

enum OPEN_LLDPXMED_POLICY_APPTYPE_VALUE_t

Enumerator
OPEN_UNKNOWN_POLICY_APPTYPE	Unknwon policy.
OPEN_VOICE_POLICY_APPTYPE	Voice policy.
OPEN_VOICE_SIGNALING_POLICY_APPTYPE	Voice signaling polcy.
OPEN_GUEST_VOICE_POLICY_APPTYPE	Guest voice policy.
OPEN_GUEST_VOICE_SIGNALING_POLICY_APPTYPE	Guest voice signaling policy.
OPEN_SOFTPHONE_VOICE_POLICY_APPTYPE	Softphone voice policy.
OPEN_VIDEO_CONFERENCING_POLICY_APPTYPE	Video conferencing policy.
OPEN_STREAMING_VIDEO_POLICY_APPTYPE	Streaming video policy.
OPEN_VIDEO_SIGNALING_POLICY_APPTYPE	Video signaling policy.

Definition at line 97 of file openapi_lldp.h.

Function Documentation

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	subtype	Chassis ID subtype
[out]	subtypeStr	Subtype string

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpdot3LocPortAutoNegAdvertizedCapGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	advrtCap
	)

Get port's auto negotiation advertized capability as a string.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	advrtCap	Interface auto negotiation advertized capability

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpdot3LocPortAutoNegEnabledGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	isEnabled
	)

Get port's auto negotiation enabled status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	isEnabled	Interface auto negotiation enabled status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpdot3LocPortAutoNegOperMauTypeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	type
	)

Get port's auto negotiation operational MAU Type.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	type	MAU type

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpdot3LocPortAutoNegSupportedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	isCapable
	)

Get the port's auto negotiation capability.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	isCapable	Interface auto negotiation capability status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	advrtCap	Remote port auto negotiation advertized capability

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	isEnabled	Remote port auto negotiation enabled status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	mauType	MAU Type
[out]	mauString	MAU type in string

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	type	MAU type

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	isCapable	Remote port auto negotiation capability status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	chassisIdSubtype	Chassis Id Subtype of type OPEN_LLDP_CHASSIS_ID_SUBTYPE_t
[out]	chassisId	Chassis Id

Note

Maximum size for chassisId is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Chassis Id and Subtype get successful.
OPEN_E_FAIL	Chassis Id and Subtype get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface or system capabilities are not available as transmit mode is disabled.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[out]	maxFrameSize	Maximum Frame Size.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in,out]	addressFamily	Address Family
[in,out]	address	Address

Note

Maximum size for address is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Management Address get successful.
OPEN_E_FAIL	Management Address get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface or system capabilities are not available as transmit mode is disabled.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	portDesc	Local Device Port Description

Note

Maximum size for portDesc is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Port Description get successful.
OPEN_E_FAIL	Port Description get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface or system capabilities are not available as transmit mode is disabled.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	portIdSubtype	Port Id Subtype of type OPEN_LLDP_PORT_ID_SUBTYPE_t
[out]	portId	Port Id

Note

Maximum size for portId is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Port Id and Subtype get successful.
OPEN_E_FAIL	Port Id and Subtype get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface or system capabilities are not available as transmit mode is disabled.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[out]	portVlan	Port VLAN ID.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	LLDP not supported on this interface or LLDP transmit mode is disabled.
OPEN_E_INTERNAL	Other Internal Failure.

OpEN API Version: 1.28

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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	sysCapEnabled	Local Device System Capabilities Enabled

Note

Maximum size for sysCapEnabled is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Enabled Capabilities get successful.
OPEN_E_FAIL	Supported Capabilities get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface or system capabilities are not available as transmit mode is disabled.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	sysCapSupp	Local Device System Capabilities Supported

Note

Maximum size for sysCapSupp is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Supported Capabilities get successful.
OPEN_E_FAIL	Supported Capabilities get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface or system capabilities are not available as transmit mode is disabled.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	systemDesc	Local Device System Description

Note

Maximum size for systemDesc is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	System Description get successful.
OPEN_E_FAIL	System Description get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface or system capabilities are not available as transmit mode is disabled.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	systemName	Remote Device System Name

Note

Maximum size for systemName is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	System Name get successful.
OPEN_E_FAIL	System Name get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface or system capabilities are not available as transmit mode is disabled.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[out]	vlanList	VLAN ID List.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[in]	vlanId	VLAN Id.
[out]	vlanName	VLAN Name.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[out]	aggregationCapable	If the interface is capable for LAG or not.
[out]	aggregationMember	If the interface is added in LAG or not.
[out]	aggregationId	LAG ID if the interface is added in LAG.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	nextIfNum	ID of the next interface

Return values

OPEN_E_NONE	Next valid LLDP interface get successful.
OPEN_E_UNAVAIL	No 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	lldpNotMode	LLDP Notification mode

Return values

OPEN_E_NONE	Notification mode get successful.
OPEN_E_FAIL	Notification mode get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	lldpNotMode	LLDP Notification mode

Return values

OPEN_E_NONE	Notification mode set successful.
OPEN_E_FAIL	Notification mode set failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	lldpRxMode	LLDP receive mode

Return values

OPEN_E_NONE	Receive mode get successful .
OPEN_E_FAIL	Receive mode get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	lldpRxMode	LLDP receive mode

Return values

OPEN_E_NONE	Receive mode set successful.
OPEN_E_FAIL	Receive mode set failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	chassisIdSubtype	Chassis Id Subtype of type OPEN_LLDP_CHASSIS_ID_SUBTYPE_t
[out]	chassisId	Chassis Id.

Note

Maximum size for chassisId is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Chassis Id and Subtype get successful.
OPEN_E_FAIL	Chassis Id and Subtype get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other internal error.

OpEN API Version: 1.1

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in,out]	addressFamily	Address Family. Pass 0 for the first time.
[in,out]	address	Address Initialize portDesc:pstart and size with a char buffer of length returned by openapiLldpMgmtStrLenGet()
[in,out]	addrLen	Address Length. Passing 0 will return the first address
[out]	subType	Interface subtype
[out]	intfId	Interface ID

Note

Maximum size for address is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Management Address get successful.
OPEN_E_FAIL	Management Address get failed.
OPEN_E_UNAVAIL	Next Management Address not available.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[out]	maxFrameSize	Maximum Frame Size.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in,out]	addressFamily	Address Family. Pass 0 for the first time.
[in,out]	address	Address Initialize portDesc:pstart and size with a char buffer of length returned by openapiLldpMgmtStrLenGet()
[in,out]	addrLen	Address Length. Passing 0 will return the first address

Note

Maximum size for address is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Management Address get successful.
OPEN_E_FAIL	Management Address get failed.
OPEN_E_UNAVAIL	Next Management Address not available.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in,out]	remIndex	Remote Device Index
[in,out]	timeStamp	Timestamp when the entry was added

Return values

OPEN_E_NONE	Neighbor entry get successful.
OPEN_E_FAIL	Next Neighbor entry is not present.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	portDesc	Remote Device Port Description

Note

Maximum size for portDesc is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Port Description get successful.
OPEN_E_FAIL	Port Description get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	portIdSubtype	Port Id Subtype of type OPEN_LLDP_PORT_ID_SUBTYPE_t
[out]	portId	Port Id

Note

Maximum size for portId is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Port Id and Subtype get successful.
OPEN_E_FAIL	Port Id and Subtype get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[out]	portVlan	Port VLAN ID.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	sysCapEnabled	Remote Device System Capabilities Enabled

Note

Maximum size for sysCapEnabled is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Enabled Capabilities get successful.
OPEN_E_FAIL	Supported Capabilities get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	sysCapSupp	Remote Device System Capabilities Supported

Note

Maximum size for sysCapSupp is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	Supported Capabilities get successful.
OPEN_E_FAIL	Supported Capabilities get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	systemDesc	Remote Device System Description

Note

Maximum size for systemDesc is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	System Description get successful.
OPEN_E_FAIL	System Description get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	systemName	Remote Device System Name

Note

Maximum size for systemName is determined by calling openapiLldpMgmtStrLenGet().

Return values

OPEN_E_NONE	System Name get successful.
OPEN_E_FAIL	System Name get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	remIndex	Remote Device Index Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	ttl	Remote Device TTL

Return values

OPEN_E_NONE	TTL get successful.
OPEN_E_FAIL	TTL get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[in]	infoIndex	Info index.
[out]	vlan	VLAN Id.
[out]	vlanName	VLAN Name.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[out]	aggregationCapable	If the interface is capable for LAG or not.
[out]	aggregationMember	If the interface is added in LAG or not.
[out]	aggregationId	LAG ID if the interface is added in LAG.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	tlvType	LLDP TLV of type OPEN_LLDP_TLV_TYPE_t
[out]	tlvTransmitMode	TLV transmit mode

Return values

OPEN_E_NONE	TLVs transmit mode get successful.
OPEN_E_FAIL	TLVs transmit mode get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	tlvType	LLDP TLV of type OPEN_LLDP_TLV_TYPE_t
[in]	tlvTransmitMode	TLV transmit mode

Return values

OPEN_E_NONE	TLVs transmit mode set successful.
OPEN_E_FAIL	TLVs transmit mode set failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[out]	lldpTxMode	LLDP transmit mode

Return values

OPEN_E_NONE	Transmit mode get successful .
OPEN_E_FAIL	Transmit mode get failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error in parameter passed. NULL lldpTxMode can cause this return code.
OPEN_E_INTERNAL	Other 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_handle	client handle from registration API
[in]	ifNum	ID of the interface
[in]	lldpTxMode	LLDP transmit mode

Return values

OPEN_E_NONE	Transmit mode set successful.
OPEN_E_FAIL	Transmit mode set failed.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Error in parameter passed. Invalid lldpTxMode can cause this return code.
OPEN_E_INTERNAL	Other 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 openapiLldpIntfTxMgmtAddrModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	mode
	)

Gets the 802.1AB mgmt addr transmit mode for the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	mode	Transmit mgmt addr TLV mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	mode	Transmit mgmt addr TLV mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

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_handle	client handle from registration API
[in]	intf	ID of the interface
[out]	mode	notification mode Possible values OPEN_BOOL_t

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intf	ID of the interface or OPEN_ALL_INTERFACES for all interfaces
[in]	mode	notification mode Possible values OPEN_BOOL_t

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intf	ID of the interface
[out]	mode	lldp mode Possible values OPEN_CONTROL_t

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intf	ID of the interface or OPEN_ALL_INTERFACES for all interfaces
[in]	mode	lldp mode Possible values OPEN_CONTROL_t

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intf	ID of the interface
[out]	cap	bitmask of TLVs enabled

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intf	ID of the interface or OPEN_ALL_INTERFACES for all interfaces
[in]	cap	bitmask of TLVs to be enabled

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error 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 openapiLldpMedLocDeviceClassGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	deviceClass
	)

Get local device's MED Classification.

Parameters

[in]	client_handle	client handle from registration API
[out]	deviceClass	Device class

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	assetId	Remote device asset ID

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	firmwareRev	Remote device firmware revision

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	hardwareRev	Remote device hardware revision

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	subType	Loaction subtype
[out]	locInfo	Location information

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	policyAppType	Type of application policy
[out]	dscp	DSCP value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	policyAppType	Type of application policy
[out]	priority	Priority

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	policyAppType	Type of application policy
[out]	tagged	Tagged bit status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	policyAppType	Type of application policy
[out]	unknown	Unknown bit status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	policyAppType	Type of application policy
[out]	vlanId	Location information

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	mfgName	Manufacturer's name as a string

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	modelName	Model name as a string

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

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_handle	client handle from registration API
[in]	intf	ID of the interface
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	supportedCapabilities	bitmask of TLVs supported
[out]	enabledCapabilities	bitmask of TLVs enabled

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intf	ID of the interface
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	deviceClass	class of the remote device

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intf	ID of the interface
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value
[out]	modelName	model name of the remote device

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	size	number of bytes to allocate in buffer

Return values

OPEN_E_NONE	Get successful.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.14

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	deviceType	Remote device POE device type

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	powerPri	Power priority

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	powerReq	Power requirement

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	powerSrc	Power source

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	powerAv	Available power

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	powerPri	Power priority

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	powerSrcType	Power soruce type

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	serialNum	Remote device serial number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[out]	softwareRev	Remote device software revision

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

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_handle	client handle from registration API
[out]	strLen	string length

Return values

OPEN_E_NONE	String length get successful.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.1

Examples:

lldp_example.c.

open_error_t openapiLldpNotificationIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	interval
	)

Gets the 802.1AB global notification interval limit.

Parameters

[in]	client_handle	client handle from registration API
[out]	interval	Interval in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpNotificationIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	interval
	)

Sets the 802.1AB global notification interval limit.

Parameters

[in]	client_handle	client handle from registration API
[in]	interval	Interval in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpPortIdSubtypeStringGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	subtype,
		open_buffdesc *	subtypeStr
	)

Get a string representation for port ID Subtype.

Parameters

[in]	client_handle	client handle from registration API
[in]	subtype	Port ID subtype
[out]	subtypeStr	Subtype string

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	infoIndex	Info index
[out]	oui	Organization unique identifier in XX:XX:XX format

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	infoIndex	Info index
[out]	subtype	Organization defined subtype

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	ifNum	Interface number.
[in]	remIndex	Remote Device Index. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[in]	timeStamp	Remote Device entry timestamp. Use openapiLldpIntfRemoteDeviceNextGet() to get the value.
[in]	infoIndex	Info index.
[out]	nextInfoIndex	Netx info index.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_UNAVAIL	LLDP not supported on this interface.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.28

Examples:

lldp_example.c.

open_error_t openapiLldpRemoteIntfFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	ifNum
	)

Get the first interface enable for LLDP receives.

Parameters

[in]	client_handle	client handle from registration API
[out]	ifNum	First valid interface

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpRemoteIntfNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	nextIfNum
	)

Get the next valid interface enabled for LLDP receives.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	First valid interface number
[out]	nextIfNum	Next valid interface number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	tlvType	TLV type
[out]	isExists	Entry existtance status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	tlvType	TLV type
[out]	nextTlvType	Next TLV type

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

if tlvType is 0, this API will return first entry.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	remIndex	Index associated with this remote entry
[in]	timestamp	Time Stamp associated with this remote entry
[in]	tlvType	TLV type
[out]	info	Organization defined info

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpTxHoldGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	holdCount
	)

Gets the 802.1AB global transmit hold muliplier.

Parameters

[in]	client_handle	client handle from registration API
[out]	holdCount	Hold multiplier

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpTxHoldSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	holdCount
	)

Sets the 802.1AB global transmit hold muliplier.

Parameters

[in]	client_handle	client handle from registration API
[in]	holdCount	Hold multiplier

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpTxIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	interval
	)

Gets the 802.1AB global transmit interval.

Parameters

[in]	client_handle	client handle from registration API
[out]	interval	Interval in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpTxIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	interval
	)

Sets the 802.1AB global transmit interval.

Parameters

[in]	client_handle	client handle from registration API
[in]	interval	Interval in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpTxReinitDelayGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	delay
	)

Gets the 802.1AB global transmit reinit delay.

Parameters

[in]	client_handle	client handle from registration API
[out]	delay	Delay in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpTxReinitDelaySet	(	openapiClientHandle_t *	client_handle,
		uint32_t	delay
	)

Sets the 802.1AB global transmit reinit delay.

Parameters

[in]	client_handle	client handle from registration API
[in]	delay	Delay in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpXMedFastStartRepeatCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	count
	)

Gets the fast start repeat count.

Parameters

[in]	client_handle	client handle from registration API
[out]	count	Fast start repeat count

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

open_error_t openapiLldpXMedFastStartRepeatCountSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	count
	)

Sets the fast start repeat count.

Parameters

[in]	client_handle	client handle from registration API
[in]	count	Fast start repeat count

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	policyAppType	Policy application type
[out]	dscp	Dscp vlaue

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	policyAppType	Policy application type
[out]	priority	Priority

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	policyAppType	Policy application type
[out]	taggedStatus	Tagged Status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.

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.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	policyAppType	Policy application type
[out]	vlanId	Vlan Id

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

lldp_example.c.