Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | OPEN_LLDP_MED_CAPABILITIES_t |
Functions | |
open_error_t | openapiLldpIntfLocalDeviceChassisIdGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_CHASSIS_ID_SUBTYPE_t *chassisIdSubtype, open_buffdesc *chassisId) |
Gets the LLDP Local Device Chassis Id and Chassis Id Subtype for the specified interface. More... | |
open_error_t | openapiLldpIntfLocalDeviceMgmtAddressGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily, open_buffdesc *address) |
Gets the LLDP Local Device Management Address for the specified interface. More... | |
open_error_t | openapiLldpIntfLocalDevicePortDescGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *portDesc) |
Gets the LLDP Local Device Port Description for the specified interface. More... | |
open_error_t | openapiLldpIntfLocalDevicePortIdGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_PORT_ID_SUBTYPE_t *portIdSubtype, open_buffdesc *portId) |
Gets the LLDP Local Device Port Id and Port Id Subtype for the specified interface. More... | |
open_error_t | openapiLldpIntfLocalDeviceSysCapEnabledGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *sysCapEnabled) |
Gets the LLDP Local Device System Capabilities Enabled for the specified interface. More... | |
open_error_t | openapiLldpIntfLocalDeviceSysCapSuppGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *sysCapSupp) |
Gets the LLDP Local Device System Capabilities Supported for the specified interface. More... | |
open_error_t | openapiLldpIntfLocalDeviceSystemDescGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *systemDesc) |
Gets the LLDP Local Device System Description for the specified interface. More... | |
open_error_t | openapiLldpIntfLocalDeviceSystemNameGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *systemName) |
Gets the LLDP Local Device System Name for the specified interface. More... | |
open_error_t | openapiLldpIntfNextGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum) |
Gets the next valid LLDP interface. More... | |
open_error_t | openapiLldpIntfNotificationModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lldpNotMode) |
Gets the LLDP Notification mode for the specified interface. More... | |
open_error_t | openapiLldpIntfNotificationModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpNotMode) |
Sets the LLDP Notification mode for the specified interface. More... | |
open_error_t | openapiLldpIntfReceiveModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lldpRxMode) |
Gets the LLDP PDU reception mode for the specified interface. More... | |
open_error_t | openapiLldpIntfReceiveModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpRxMode) |
Sets LLDP PDU reception mode on the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDeviceChassisIdGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_CHASSIS_ID_SUBTYPE_t *chassisIdSubtype, open_buffdesc *chassisId) |
Gets the LLDP Remote Device Chassis Id and Chassis Id Subtype for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDeviceMgmtAddressNextGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_IANA_ADDR_FAMILY_t *addressFamily, open_buffdesc *address, uint8_t *addrLen) |
Gets the LLDP Remote Device next Management Address for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDeviceNextGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *remIndex, uint32_t *timeStamp) |
Gets the next LLDP Remote Device entry for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDevicePortDescGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *portDesc) |
Gets the LLDP Remote Device Port Description for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDevicePortIdGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_PORT_ID_SUBTYPE_t *portIdSubtype, open_buffdesc *portId) |
Gets the LLDP Remote Device Port Id and Port Id Subtype for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDeviceSysCapEnabledGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *sysCapEnabled) |
Gets the LLDP Remote Device System Capabilities Enabled for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDeviceSysCapSuppGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *sysCapSupp) |
Gets the LLDP Remote Device System Capabilities Supported for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDeviceSystemDescGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *systemDesc) |
Gets the LLDP Remote Device System Description for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDeviceSystemNameGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *systemName) |
Gets the LLDP Remote Device System Name for the specified interface. More... | |
open_error_t | openapiLldpIntfRemoteDeviceTTLGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t remIndex, uint32_t timeStamp, uint32_t *ttl) |
Gets the LLDP Remote Device TTL for the specified interface. More... | |
open_error_t | openapiLldpIntfTLVTransmitModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_TLV_TYPE_t tlvType, OPEN_CONTROL_t *tlvTransmitMode) |
Gets the LLDP optional TLVs transmit mode for the specified interface. More... | |
open_error_t | openapiLldpIntfTLVTransmitModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LLDP_TLV_TYPE_t tlvType, OPEN_CONTROL_t tlvTransmitMode) |
Sets the LLDP optional TLVs transmit mode for the specified interface. More... | |
open_error_t | openapiLldpIntfTransmitModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *lldpTxMode) |
Gets the LLDP PDU transmit mode for the specified interface. More... | |
open_error_t | openapiLldpIntfTransmitModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t lldpTxMode) |
Sets LLDP PDU transmit mode on the specified interface. More... | |
open_error_t | openapiLldpMedIntfConfigNotificationModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_BOOL_t *mode) |
Get the interface LLDP-MED configuration notification mode. More... | |
open_error_t | openapiLldpMedIntfConfigNotificationModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_BOOL_t mode) |
Set LLDP-MED configuration notification mode on valid LLDP interfaces. More... | |
open_error_t | openapiLldpMedIntfModeGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t *mode) |
Get the interface LLDP-MED administrative mode. More... | |
open_error_t | openapiLldpMedIntfModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t mode) |
Set LLDP-MED administrative mode on valid LLDP interfaces. More... | |
open_error_t | openapiLldpMedIntfTransmitTlvGet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_LLDP_MED_CAPABILITIES_t *cap) |
Get the interface LLDP-MED TLVs enabled for transmision. More... | |
open_error_t | openapiLldpMedIntfTransmitTlvSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_LLDP_MED_CAPABILITIES_t *cap) |
Set LLDP-MED TLVs for transmision on valid LLDP interfaces. More... | |
open_error_t | openapiLldpMedRemoteCapabilitiesGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t remIndex, uint32_t timeStamp, OPEN_LLDP_MED_CAPABILITIES_t *supportedCapabilities, OPEN_LLDP_MED_CAPABILITIES_t *enabledCapabilities) |
Get the LLDP-MED capabilities received from the remote device. More... | |
open_error_t | openapiLldpMedRemoteDeviceClassGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t remIndex, uint32_t timeStamp, uint32_t *deviceClass) |
Get the LLDP-MED device class of the remote device. More... | |
open_error_t | openapiLldpMedRemoteModelNameGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t remIndex, uint32_t timeStamp, open_buffdesc *modelName) |
Get the LLDP-MED model name of the remote device. More... | |
open_error_t | openapiLldpMedRemoteModelNameSizeGet (openapiClientHandle_t *client_handle, uint32_t *size) |
Get the size in bytes for the open_buffdesc used to call openapiLldpMedRemoteModelNameGet(). More... | |
open_error_t | openapiLldpMgmtStrLenGet (openapiClientHandle_t *client_handle, uint32_t *strLen) |
Gets the LLDP Management string length. More... | |
Definition at line 55 of file openapi_lldp.h.
Enumerator | |
---|---|
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_RESERVED |
Reserved. |
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV4 |
IPv4. |
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_IPV6 |
IPv6. |
OPEN_LLDP_IANA_ADDR_FAMILY_NUMBER_802 |
802 |
Definition at line 85 of file openapi_lldp.h.
Definition at line 66 of file openapi_lldp.h.
enum OPEN_LLDP_TLV_TYPE_t |
Definition at line 76 of file openapi_lldp.h.
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.
[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 |
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. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in,out] | addressFamily | Address Family |
[in,out] | address | Address |
OPEN_E_NONE | Management Address get successful. |
OPEN_E_FAIL | Management Address get failed. |
OPEN_E_UNAVAIL | LLDP not supported on this interface. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | portDesc | Local Device Port Description |
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
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.
[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 |
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
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | sysCapEnabled | Local Device System Capabilities Enabled |
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
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | sysCapSupp | Local Device System Capabilities Supported |
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
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | systemDesc | Local Device System Description |
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
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | systemName | Remote Device System Name |
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
open_error_t openapiLldpIntfNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | nextIfNum | ||
) |
Gets the next valid LLDP interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | nextIfNum | ID of the next interface |
OPEN_E_NONE | Next valid LLDP interface get successful. |
OPEN_E_UNAVAIL | No next valid LLDP interface found. |
OpEN API Version: 1.1
open_error_t openapiLldpIntfNotificationModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t * | lldpNotMode | ||
) |
Gets the LLDP Notification mode for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | lldpNotMode | LLDP Notification mode |
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
open_error_t openapiLldpIntfNotificationModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | lldpNotMode | ||
) |
Sets the LLDP Notification mode for the specified interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | lldpNotMode | LLDP Notification mode |
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. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | lldpRxMode | LLDP receive mode |
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
open_error_t openapiLldpIntfReceiveModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | lldpRxMode | ||
) |
Sets LLDP PDU reception mode on the specified interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | lldpRxMode | LLDP receive mode |
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. |
OpEN API Version: 1.1
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.
[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. |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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
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.
[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 |
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. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | lldpTxMode | LLDP transmit mode |
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
open_error_t openapiLldpIntfTransmitModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | lldpTxMode | ||
) |
Sets LLDP PDU transmit mode on the specified interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | lldpTxMode | LLDP transmit mode |
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. |
OpEN API Version: 1.1
open_error_t openapiLldpMedIntfConfigNotificationModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_BOOL_t * | mode | ||
) |
Get the interface LLDP-MED configuration notification mode.
[in] | client_handle | client handle from registration API |
[in] | intf | ID of the interface |
[out] | mode | notification mode Possible values OPEN_BOOL_t |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
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.
[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 |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
open_error_t openapiLldpMedIntfModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_CONTROL_t * | mode | ||
) |
Get the interface LLDP-MED administrative mode.
[in] | client_handle | client handle from registration API |
[in] | intf | ID of the interface |
[out] | mode | lldp mode Possible values OPEN_CONTROL_t |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
open_error_t openapiLldpMedIntfModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
OPEN_CONTROL_t | mode | ||
) |
Set LLDP-MED administrative mode on valid LLDP interfaces.
[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 |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
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.
[in] | client_handle | client handle from registration API |
[in] | intf | ID of the interface |
[out] | cap | bitmask of TLVs enabled |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
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.
[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 |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
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.
[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 |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
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.
[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 |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
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.
[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 |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
open_error_t openapiLldpMedRemoteModelNameSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | size | ||
) |
Get the size in bytes for the open_buffdesc used to call openapiLldpMedRemoteModelNameGet().
[in] | client_handle | client handle from registration API |
[out] | size | number of bytes to allocate in buffer |
OPEN_E_NONE | Get successful. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.14
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.
[in] | client_handle | client handle from registration API |
[out] | strLen | string length |
OPEN_E_NONE | String length get successful. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1