Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Functions | |
open_error_t | openapiDbDot1dTpAgingTimeGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get timeout period for aging out dynamically learned forwarding information. More... | |
open_error_t | openapiDbDot1dTpAgingTimeSet (openapiClientHandle_t *client_handle, uint32_t value) |
Set timeout period for aging out dynamically learned forwarding information. More... | |
open_error_t | openapiDot1dBaseBridgeAddressGet (openapiClientHandle_t *client_handle, open_buffdesc *bridgeAddress) |
Get the unique MAC address used to refer to the bridge. More... | |
open_error_t | openapiDot1dBaseNumPortsGet (openapiClientHandle_t *client_handle, uint32_t *numPorts) |
Get number of ports controlled by the bridging entity. More... | |
open_error_t | openapiDot1dBasePortCircuitGet (openapiClientHandle_t *client_handle, uint32_t port, open_buffdesc *buffer) |
Get name of an object instance unique to this port. More... | |
open_error_t | openapiDot1dBasePortDelayExceededDiscardsGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *delayExceededDiscardsValue) |
Get number of frames discarded by this port due to delay through the bridge. More... | |
open_error_t | openapiDot1dBasePortEntryGet (openapiClientHandle_t *client_handle, uint32_t port) |
Get admin state of the port. More... | |
open_error_t | openapiDot1dBasePortEntryNextGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIntIfNum) |
Get Internal Interface Number of next valid port. More... | |
open_error_t | openapiDot1dBasePortIfIndexGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *ifIndex) |
Get ifIndex associated with the internal interface number. More... | |
open_error_t | openapiDot1dBasePortMtuExceededDiscardsGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *mtuExceededDiscardsValue) |
Get number of frames discarded by this port due to delay through the bridge. More... | |
open_error_t | openapiDot1dBaseTypeGet (openapiClientHandle_t *client_handle, uint32_t *type) |
Get dot1d Base type of bridging. More... | |
open_error_t | openapiDot1dInstanceMemberGetNext (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIntIfNum) |
Get next interface for current instance. More... | |
open_error_t | openapiDot1dIsInterfaceInCurrentInstance (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *isInInstance) |
Determine if the interface is the currently configured STP instance. More... | |
open_error_t | openapiDot1dIsValidIntf (openapiClientHandle_t *client_handle, uint32_t intIfNum) |
Check if an interface is valid for DOT1D. More... | |
open_error_t | openapiDot1dStpBridgeForwardDelayGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get Spanning Tree Bridge Forward Delay. More... | |
open_error_t | openapiDot1dStpBridgeHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get Spanning Tree Bridge Hello Time. More... | |
open_error_t | openapiDot1dStpBridgeMaxAgeGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get Spanning Tree bridge max age. More... | |
open_error_t | openapiDot1dStpDesignatedRootGet (openapiClientHandle_t *client_handle, open_buffdesc *buffer) |
Get Spanning Tree Designated root for the switch. More... | |
open_error_t | openapiDot1dStpForwardDelayGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get Spanning Tree forward delay. More... | |
open_error_t | openapiDot1dStpHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get Spanning Tree hello time. More... | |
open_error_t | openapiDot1dStpHoldTimeGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get Spanning Tree hold time. More... | |
open_error_t | openapiDot1dStpMaxAgeGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get Spanning Tree max age. More... | |
open_error_t | openapiDot1dStpPortDesignatedBridgeGet (openapiClientHandle_t *client_handle, uint32_t port, open_buffdesc *buffer) |
Get Spanning Tree Designated Bridge for this port. More... | |
open_error_t | openapiDot1dStpPortDesignatedCostGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get Spanning Tree Designated Cost for this port. More... | |
open_error_t | openapiDot1dStpPortDesignatedPortGet (openapiClientHandle_t *client_handle, uint32_t port, uint16_t *value) |
Get Spanning Tree Designated port ID. More... | |
open_error_t | openapiDot1dStpPortDesignatedRootGet (openapiClientHandle_t *client_handle, uint32_t port, open_buffdesc *buffer) |
Get Spanning Tree Designated Root for the switch. More... | |
open_error_t | openapiDot1dStpPortForwardTransitionsGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get number of times this port has transitioned from Learning state to Forwarding state. More... | |
open_error_t | openapiDot1dStpPortPathCostGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get Spanning Tree Path Cost for this port. More... | |
open_error_t | openapiDot1dStpPortPriorityGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get Spanning Tree Port Priority. More... | |
open_error_t | openapiDot1dStpPortStateGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get Spanning Tree Port State. More... | |
open_error_t | openapiDot1dStpPriorityGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the Spanning Tree Bridge priority. More... | |
open_error_t | openapiDot1dStpProtocolSpecificationGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get indication of what version of the Spanning Tree Protocol is being run. More... | |
open_error_t | openapiDot1dStpRootCostGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the cost of the path to the root as seen from this bridge. More... | |
open_error_t | openapiDot1dStpRootPortGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get port number with lowest cost path from bridge to the root bridge. More... | |
open_error_t | openapiDot1dStpTimeSinceTopologyChangeGet (openapiClientHandle_t *client_handle, uint64_t *value) |
Get the time since last topology change was detected by the bridge. More... | |
open_error_t | openapiDot1dStpTopChangesGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get the STP change count. More... | |
open_error_t | openapiDot1dTpFdbEntryGet (openapiClientHandle_t *client_handle, open_buffdesc *address) |
Get info about a specific unicast MAC address which the bridge has forwarding and/or filtering information. More... | |
open_error_t | openapiDot1dTpFdbEntryNextGet (openapiClientHandle_t *client_handle, open_buffdesc *address) |
Get info about a specific unicast MAC address which the bridge has forwarding and/or filtering information. More... | |
open_error_t | openapiDot1dTpFdbPortGet (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t *value) |
Returns the port number. More... | |
open_error_t | openapiDot1dTpFdbStatusGet (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t *value) |
Get the status of the dot1dTpFdbEntry. More... | |
open_error_t | openapiDot1dTpLearnedEntryDiscardsGet (openapiClientHandle_t *client_handle, uint32_t *value) |
Get number of Forwarding Database entries that have been discarded due to a lack of space to store them. More... | |
open_error_t | openapiDot1dTpPortInDiscardsGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get count of valid frames received which were discarded by the Forwarding Process. More... | |
open_error_t | openapiDot1dTpPortInFramesGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get number of frames received by this port from its segment. More... | |
open_error_t | openapiDot1dTpPortMaxInfoGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get maximum size of the INFO field this port will receive or transmit. More... | |
open_error_t | openapiDot1dTpPortOutFramesGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value) |
Get number of frames transmitted by this port to its segment. More... | |
open_error_t openapiDbDot1dTpAgingTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get timeout period for aging out dynamically learned forwarding information.
[in] | client_handle | client handle from registration API. |
[out] | value | timeout period. |
OPEN_E_NONE | If the timeout period was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDbDot1dTpAgingTimeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | value | ||
) |
Set timeout period for aging out dynamically learned forwarding information.
[in] | client_handle | client handle from registration API. |
[in] | value | timeout period. |
OPEN_E_NONE | If the timeout period was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dBaseBridgeAddressGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | bridgeAddress | ||
) |
Get the unique MAC address used to refer to the bridge.
[in] | client_handle | client handle from registration API. |
[out] | bridgeAddress | the pointer to the MAC address. |
OPEN_E_NONE | If the unique MAC address was successfully found. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dBaseNumPortsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | numPorts | ||
) |
Get number of ports controlled by the bridging entity.
[in] | client_handle | client handle from registration API. |
[out] | numPorts | number of ports. |
OPEN_E_NONE | If the counter was successfully found and stored in the space provided. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | If the counter requested does not exist. |
OpEN API Version: 1.7
open_error_t openapiDot1dBasePortCircuitGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
open_buffdesc * | buffer | ||
) |
Get name of an object instance unique to this port.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number. |
[out] | buffer | data buffer. |
OPEN_E_NONE | If the name of an object instance was successfully found. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dBasePortDelayExceededDiscardsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | delayExceededDiscardsValue | ||
) |
Get number of frames discarded by this port due to delay through the bridge.
[in] | client_handle | client handle from registration API. |
[in] | port | port internal interface number. |
[out] | delayExceededDiscardsValue | delay exceeded value. |
OPEN_E_NONE | If the number of frames was successfully found. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dBasePortEntryGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port | ||
) |
Get admin state of the port.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number. |
OPEN_E_NONE | If the port of bridge was successfully found and stored in the space provided. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | If the counter requested does not exisit. |
OpEN API Version: 1.7
open_error_t openapiDot1dBasePortEntryNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t * | nextIntIfNum | ||
) |
Get Internal Interface Number of next valid port.
[in] | client_handle | client handle from registration API. |
[in] | intIfNum | starting interface. |
[out] | nextIntIfNum | next interface. |
OPEN_E_NONE | If the next interface was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dBasePortIfIndexGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | ifIndex | ||
) |
Get ifIndex associated with the internal interface number.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number. |
[out] | ifIndex | pointer to ifIndex. |
OPEN_E_NONE | If the counter was successfully found and stored in the space provided. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | If the counter requested does not exisit. |
OpEN API Version: 1.7
open_error_t openapiDot1dBasePortMtuExceededDiscardsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | mtuExceededDiscardsValue | ||
) |
Get number of frames discarded by this port due to delay through the bridge.
[in] | client_handle | client handle from registration API. |
[in] | port | port internal interface number. |
[out] | mtuExceededDiscardsValue | mtu exceededDiscards value. |
OPEN_E_NONE | If the number of frames was successfully found. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dBaseTypeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | type | ||
) |
Get dot1d Base type of bridging.
[in] | client_handle | client handle from registration API. |
[out] | type | type of bridging. |
OPEN_E_NONE | If the counter was successfully found and stored in the space provided. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_ERROR | If the counter requested does not exisit. |
OpEN API Version: 1.7
open_error_t openapiDot1dInstanceMemberGetNext | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t * | nextIntIfNum | ||
) |
Get next interface for current instance.
[in] | client_handle | client handle from registration API. |
[in] | intIfNum | starting interface. |
[out] | nextIntIfNum | next interface. |
OPEN_E_NONE | If the next interface was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dIsInterfaceInCurrentInstance | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t * | isInInstance | ||
) |
Determine if the interface is the currently configured STP instance.
[in] | client_handle | client handle from registration API. |
[in] | intIfNum | interface to remove. |
[out] | isInInstance | port priority. |
OPEN_E_NONE | If the port priority was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dIsValidIntf | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum | ||
) |
Check if an interface is valid for DOT1D.
[in] | client_handle | client handle from registration API. |
[in] | intIfNum | internal interface number. |
OPEN_E_NONE | If the interface is valid. |
OPEN_E_FAIL | Returned values are invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpBridgeForwardDelayGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get Spanning Tree Bridge Forward Delay.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree bridge forward delay. |
OPEN_E_NONE | If the bridge forward delay was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpBridgeHelloTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get Spanning Tree Bridge Hello Time.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree bridge hello time. |
OPEN_E_NONE | If the bridge hello time was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpBridgeMaxAgeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get Spanning Tree bridge max age.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree bridge max age. |
OPEN_E_NONE | If the bridge max age was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpDesignatedRootGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | buffer | ||
) |
Get Spanning Tree Designated root for the switch.
[in] | client_handle | client handle from registration API. |
[out] | buffer | STP designated root for the switch. |
OPEN_E_NONE | If the STP designated root was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpForwardDelayGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get Spanning Tree forward delay.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree forward delay. |
OPEN_E_NONE | If the forward delay was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpHelloTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get Spanning Tree hello time.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree hello time. |
OPEN_E_NONE | If the hello time was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpHoldTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get Spanning Tree hold time.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree hold time. |
OPEN_E_NONE | If the hold time was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpMaxAgeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get Spanning Tree max age.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree max age. |
OPEN_E_NONE | If the max age was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPortDesignatedBridgeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
open_buffdesc * | buffer | ||
) |
Get Spanning Tree Designated Bridge for this port.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | buffer | spanning tree designated bridge for this port. |
OPEN_E_NONE | If the designated bridge was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPortDesignatedCostGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get Spanning Tree Designated Cost for this port.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | value | spanning tree designated cost for this port. |
OPEN_E_NONE | If the designated cost was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPortDesignatedPortGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint16_t * | value | ||
) |
Get Spanning Tree Designated port ID.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | value | spanning tree port id for this port. |
OPEN_E_NONE | If the port id was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPortDesignatedRootGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
open_buffdesc * | buffer | ||
) |
Get Spanning Tree Designated Root for the switch.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | buffer | spanning tree designated root for the switch. |
OPEN_E_NONE | If the designated root was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPortForwardTransitionsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get number of times this port has transitioned from Learning state to Forwarding state.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | value | number of times port has transitioned from Learning to Forwarding. |
OPEN_E_NONE | If the number of times port was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPortPathCostGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get Spanning Tree Path Cost for this port.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | value | spanning tree port path cost. |
OPEN_E_NONE | If the port path cost was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPortPriorityGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get Spanning Tree Port Priority.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | value | port priority. |
OPEN_E_NONE | If the port priority was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPortStateGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get Spanning Tree Port State.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | value | spanning tree port state. |
OPEN_E_NONE | If the port state was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpPriorityGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the Spanning Tree Bridge priority.
[in] | client_handle | client handle from registration API. |
[out] | value | bridge priority. |
OPEN_E_NONE | If the STP bridge priority was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpProtocolSpecificationGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get indication of what version of the Spanning Tree Protocol is being run.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree protocol version. |
OPEN_E_NONE | If the indication version of STP was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpRootCostGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the cost of the path to the root as seen from this bridge.
[in] | client_handle | client handle from registration API. |
[out] | value | root cost for switch. |
OPEN_E_NONE | If the root cost for switch was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpRootPortGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get port number with lowest cost path from bridge to the root bridge.
[in] | client_handle | client handle from registration API. |
[out] | value | root port for the switch. |
OPEN_E_NONE | If the port number with lowest cost was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpTimeSinceTopologyChangeGet | ( | openapiClientHandle_t * | client_handle, |
uint64_t * | value | ||
) |
Get the time since last topology change was detected by the bridge.
[in] | client_handle | client handle from registration API. |
[out] | value | time since last spanning tree topology change. |
OPEN_E_NONE | If the time was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dStpTopChangesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get the STP change count.
[in] | client_handle | client handle from registration API. |
[out] | value | spanning tree topology change count. |
OPEN_E_NONE | If the STP change count was successfully found. |
OPEN_E_UNAVAIL | Feature is not supported. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dTpFdbEntryGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address | ||
) |
Get info about a specific unicast MAC address which the bridge has forwarding and/or filtering information.
[in] | client_handle | client handle from registration API. |
[in] | address | MAC address. |
OPEN_E_NONE | If the info about MAC was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dTpFdbEntryNextGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address | ||
) |
Get info about a specific unicast MAC address which the bridge has forwarding and/or filtering information.
[in] | client_handle | client handle from registration API. |
[in] | address | MAC address. |
OPEN_E_NONE | If the info about MAC was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dTpFdbPortGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t * | value | ||
) |
Returns the port number.
[in] | client_handle | client handle from registration API. |
[out] | address | MAC address. |
[out] | value | port number. |
OPEN_E_NONE | If the port number was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dTpFdbStatusGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t * | value | ||
) |
Get the status of the dot1dTpFdbEntry.
[in] | client_handle | client handle from registration API. |
[out] | address | MAC address. |
[out] | value | port status. |
OPEN_E_NONE | If the status was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
" The status of this entry. The meaning of the values are:
other(1): none of the following. This would include the case where some other MIB object (not corresponding instance of dot1dTpFdbPort, nor an entry in the dot1dStaticTable) is being used to determine if and how frames addressed to the value of the corresponding instance of dot1dTpFdbAddress are being forwarded.
invalid(2): this entry is no longer valid (e.g. it was learned but has since aged-out), but has not yet been flushed from the table.
learned(3): the value of the corresponding instance of dot1dTpFdbPort was learned and is being used.
self(4): the value of the corresponding instance of dot1dTpFdbAddress represents one of the bridge's addresses. The corresponding instance of dot1dTpFdbPort indicates which of the bridge's ports has this address.
mgmt(5): the value of this corresponding instance of dot1dTpFdbAddress is also the value of an existing instance of dot1dStaticAddress."
open_error_t openapiDot1dTpLearnedEntryDiscardsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | value | ||
) |
Get number of Forwarding Database entries that have been discarded due to a lack of space to store them.
[in] | client_handle | client handle from registration API. |
[out] | value | number of discarded entries. |
OPEN_E_NONE | If the number of discarded entries was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dTpPortInDiscardsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get count of valid frames received which were discarded by the Forwarding Process.
[in] | client_handle | client handle from registration API. |
[in] | port | interface number. |
[out] | value | number of valid frames received. |
OPEN_E_NONE | If the number of valid frames was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dTpPortInFramesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get number of frames received by this port from its segment.
[in] | client_handle | client handle from registration API. |
[in] | port | interface number. |
[out] | value | number of frames received. |
OPEN_E_NONE | If the number of times port was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dTpPortMaxInfoGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get maximum size of the INFO field this port will receive or transmit.
[in] | client_handle | client handle from registration API. |
[in] | port | internal interface number, physical or logical. |
[out] | value | maximum size. |
OPEN_E_NONE | If the number of times port was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1dTpPortOutFramesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | port, | ||
uint32_t * | value | ||
) |
Get number of frames transmitted by this port to its segment.
[in] | client_handle | client handle from registration API. |
[in] | port | interface number. |
[out] | value | number of frames received. |
OPEN_E_NONE | If the number of times port was successfully found. |
OPEN_E_FAIL | Returned values are not invalid. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7