Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Functions
Bridge Support [OPENAPI_BRIDGE]

Macros

#define OPEN_DOT1D_BLOCKING   1
 
#define OPEN_DOT1D_DISABLED   5
 
#define OPEN_DOT1D_FORWARDING   4
 
#define OPEN_DOT1D_LEARNING   3
 
#define OPEN_DOT1D_LISTENING   2
 
#define OPEN_DOT1D_MANUAL_FWD   6
 
#define OPEN_DOT1D_NOT_PARTICIPATE   7
 
#define OPEN_FDB_ADDR_LEN   8
 
#define OPEN_FDB_ADDR_STR_LEN   ((OPEN_FDB_ADDR_LEN * 2) + (OPEN_FDB_ADDR_LEN - 1))
 
#define OPEN_NULLPTR   ((void *)0)
 
#define OPEN_STP_DOT1D_DESIGNATED_ROOT_LEN   18
 
#define OPEN_STP_PROTOCOL_SPEC_IEEE8021D   3
 
#define OPEN_STP_PROTOCOL_SPEC_UNKNOWN   1
 

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

Detailed Description

Function Documentation

open_error_t openapiDbDot1dTpAgingTimeGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get timeout period for aging out dynamically learned forwarding information.

Parameters
[in]client_handleclient handle from registration API.
[out]valuetimeout period.
Return values
OPEN_E_NONEIf the timeout period was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.
Note
In seconds

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDbDot1dTpAgingTimeSet ( openapiClientHandle_t client_handle,
uint32_t  value 
)

Set timeout period for aging out dynamically learned forwarding information.

Parameters
[in]client_handleclient handle from registration API.
[in]valuetimeout period.
Return values
OPEN_E_NONEIf the timeout period was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.
Note
In seconds

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dBaseBridgeAddressGet ( openapiClientHandle_t client_handle,
open_buffdesc bridgeAddress 
)

Get the unique MAC address used to refer to the bridge.

Parameters
[in]client_handleclient handle from registration API.
[out]bridgeAddressthe pointer to the MAC address.
Return values
OPEN_E_NONEIf the unique MAC address was successfully found.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.
Note
It is recommended that this be the numerically smallest MAC address of all ports that belong to this bridge. However it is only required to be unique.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dBaseNumPortsGet ( openapiClientHandle_t client_handle,
uint32_t *  numPorts 
)

Get number of ports controlled by the bridging entity.

Parameters
[in]client_handleclient handle from registration API.
[out]numPortsnumber of ports.
Return values
OPEN_E_NONEIf the counter was successfully found and stored in the space provided.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.
OPEN_E_ERRORIf the counter requested does not exist.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dBasePortCircuitGet ( openapiClientHandle_t client_handle,
uint32_t  port,
open_buffdesc buffer 
)

Get name of an object instance unique to this port.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number.
[out]bufferdata buffer.
Return values
OPEN_E_NONEIf the name of an object instance was successfully found.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.
Note
This function is used for a port which (potentially) has the same value of dot1dBasePortIfIndex as another port on the same bridge.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]portport internal interface number.
[out]delayExceededDiscardsValuedelay exceeded value.
Return values
OPEN_E_NONEIf the number of frames was successfully found.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.
Note
It is incremented by both transparent and source route bridges.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dBasePortEntryGet ( openapiClientHandle_t client_handle,
uint32_t  port 
)

Get admin state of the port.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number.
Return values
OPEN_E_NONEIf the port of bridge was successfully found and stored in the space provided.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.
OPEN_E_ERRORIf the counter requested does not exisit.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dBasePortEntryNextGet ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  nextIntIfNum 
)

Get Internal Interface Number of next valid port.

Parameters
[in]client_handleclient handle from registration API.
[in]intIfNumstarting interface.
[out]nextIntIfNumnext interface.
Return values
OPEN_E_NONEIf the next interface was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError 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.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number.
[out]ifIndexpointer to ifIndex.
Return values
OPEN_E_NONEIf the counter was successfully found and stored in the space provided.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.
OPEN_E_ERRORIf the counter requested does not exisit.
Note
This function is used for a port which (potentially) has the same value of dot1dBasePortIfIndex as another port on the same bridge.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]portport internal interface number.
[out]mtuExceededDiscardsValuemtu exceededDiscards value.
Return values
OPEN_E_NONEIf the number of frames was successfully found.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.
Note
It is incremented by both transparent and source route bridges.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dBaseTypeGet ( openapiClientHandle_t client_handle,
uint32_t *  type 
)

Get dot1d Base type of bridging.

Parameters
[in]client_handleclient handle from registration API.
[out]typetype of bridging.
Return values
OPEN_E_NONEIf the counter was successfully found and stored in the space provided.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.
OPEN_E_ERRORIf the counter requested does not exisit.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dInstanceMemberGetNext ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  nextIntIfNum 
)

Get next interface for current instance.

Parameters
[in]client_handleclient handle from registration API.
[in]intIfNumstarting interface.
[out]nextIntIfNumnext interface.
Return values
OPEN_E_NONEIf the next interface was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dIsInterfaceInCurrentInstance ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  isInInstance 
)

Determine if the interface is the currently configured STP instance.

Parameters
[in]client_handleclient handle from registration API.
[in]intIfNuminterface to remove.
[out]isInInstanceport priority.
Return values
OPEN_E_NONEIf the port priority was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dIsValidIntf ( openapiClientHandle_t client_handle,
uint32_t  intIfNum 
)

Check if an interface is valid for DOT1D.

Parameters
[in]client_handleclient handle from registration API.
[in]intIfNuminternal interface number.
Return values
OPEN_E_NONEIf the interface is valid.
OPEN_E_FAILReturned values are invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpBridgeForwardDelayGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get Spanning Tree Bridge Forward Delay.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree bridge forward delay.
Return values
OPEN_E_NONEIf the bridge forward delay was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpBridgeHelloTimeGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get Spanning Tree Bridge Hello Time.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree bridge hello time.
Return values
OPEN_E_NONEIf the bridge hello time was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpBridgeMaxAgeGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get Spanning Tree bridge max age.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree bridge max age.
Return values
OPEN_E_NONEIf the bridge max age was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.
Note
The granularity of this timer is specified by 802.1D-1990 to be 1 second.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpDesignatedRootGet ( openapiClientHandle_t client_handle,
open_buffdesc buffer 
)

Get Spanning Tree Designated root for the switch.

Parameters
[in]client_handleclient handle from registration API.
[out]bufferSTP designated root for the switch.
Return values
OPEN_E_NONEIf the STP designated root was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.
Note
This value is used as the Root Identifier parameter in all Configuration Bridge PDUs originated by this node.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpForwardDelayGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get Spanning Tree forward delay.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree forward delay.
Return values
OPEN_E_NONEIf the forward delay was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpHelloTimeGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get Spanning Tree hello time.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree hello time.
Return values
OPEN_E_NONEIf the hello time was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.
Note
Time in hundredths of a second.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpHoldTimeGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get Spanning Tree hold time.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree hold time.
Return values
OPEN_E_NONEIf the hold time was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.
Note
Units of hundredths of a second.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpMaxAgeGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get Spanning Tree max age.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree max age.
Return values
OPEN_E_NONEIf the max age was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.
Note
Time in hundredths of a second.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpPortDesignatedBridgeGet ( openapiClientHandle_t client_handle,
uint32_t  port,
open_buffdesc buffer 
)

Get Spanning Tree Designated Bridge for this port.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]bufferspanning tree designated bridge for this port.
Return values
OPEN_E_NONEIf the designated bridge was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpPortDesignatedCostGet ( openapiClientHandle_t client_handle,
uint32_t  port,
uint32_t *  value 
)

Get Spanning Tree Designated Cost for this port.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]valuespanning tree designated cost for this port.
Return values
OPEN_E_NONEIf the designated cost was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpPortDesignatedPortGet ( openapiClientHandle_t client_handle,
uint32_t  port,
uint16_t *  value 
)

Get Spanning Tree Designated port ID.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]valuespanning tree port id for this port.
Return values
OPEN_E_NONEIf the port id was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpPortDesignatedRootGet ( openapiClientHandle_t client_handle,
uint32_t  port,
open_buffdesc buffer 
)

Get Spanning Tree Designated Root for the switch.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]bufferspanning tree designated root for the switch.
Return values
OPEN_E_NONEIf the designated root was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]valuenumber of times port has transitioned from Learning to Forwarding.
Return values
OPEN_E_NONEIf the number of times port was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpPortPathCostGet ( openapiClientHandle_t client_handle,
uint32_t  port,
uint32_t *  value 
)

Get Spanning Tree Path Cost for this port.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]valuespanning tree port path cost.
Return values
OPEN_E_NONEIf the port path cost was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpPortPriorityGet ( openapiClientHandle_t client_handle,
uint32_t  port,
uint32_t *  value 
)

Get Spanning Tree Port Priority.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]valueport priority.
Return values
OPEN_E_NONEIf the port priority was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpPortStateGet ( openapiClientHandle_t client_handle,
uint32_t  port,
uint32_t *  value 
)

Get Spanning Tree Port State.

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]valuespanning tree port state.
Return values
OPEN_E_NONEIf the port state was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpPriorityGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get the Spanning Tree Bridge priority.

Parameters
[in]client_handleclient handle from registration API.
[out]valuebridge priority.
Return values
OPEN_E_NONEIf the STP bridge priority was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpProtocolSpecificationGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get indication of what version of the Spanning Tree Protocol is being run.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree protocol version.
Return values
OPEN_E_NONEIf the indication version of STP was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[out]valueroot cost for switch.
Return values
OPEN_E_NONEIf the root cost for switch was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpRootPortGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get port number with lowest cost path from bridge to the root bridge.

Parameters
[in]client_handleclient handle from registration API.
[out]valueroot port for the switch.
Return values
OPEN_E_NONEIf the port number with lowest cost was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpTimeSinceTopologyChangeGet ( openapiClientHandle_t client_handle,
uint64_t *  value 
)

Get the time since last topology change was detected by the bridge.

Parameters
[in]client_handleclient handle from registration API.
[out]valuetime since last spanning tree topology change.
Return values
OPEN_E_NONEIf the time was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dStpTopChangesGet ( openapiClientHandle_t client_handle,
uint32_t *  value 
)

Get the STP change count.

Parameters
[in]client_handleclient handle from registration API.
[out]valuespanning tree topology change count.
Return values
OPEN_E_NONEIf the STP change count was successfully found.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]addressMAC address.
Return values
OPEN_E_NONEIf the info about MAC was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]addressMAC address.
Return values
OPEN_E_NONEIf the info about MAC was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.
open_error_t openapiDot1dTpFdbPortGet ( openapiClientHandle_t client_handle,
open_buffdesc address,
uint32_t *  value 
)

Returns the port number.

Parameters
[in]client_handleclient handle from registration API.
[out]addressMAC address.
[out]valueport number.
Return values
OPEN_E_NONEIf the port number was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Note
" Either the value of '0', or the port number of the port on which a frame having a source address equal to the value of the corresponding instance of dot1dTpFdbAddress has been seen. A value of '0' indicates that the port number has not been learned by that the bridge does have some forwarding/filtering information about this address (e.g. in the dot1dStaticTable). Implementers are encouraged to assign the port value to this object whenever it is learned even for addresses for which the corresponding value of dot1dTpFdbStatus is not learned(3)."
Examples:
bridge_example.c.
open_error_t openapiDot1dTpFdbStatusGet ( openapiClientHandle_t client_handle,
open_buffdesc address,
uint32_t *  value 
)

Get the status of the dot1dTpFdbEntry.

Parameters
[in]client_handleclient handle from registration API.
[out]addressMAC address.
[out]valueport status.
Return values
OPEN_E_NONEIf the status was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Note
Status types: other(1) invalid(2) learned(3) self(4) mgmt(5)

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

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

Parameters
[in]client_handleclient handle from registration API.
[out]valuenumber of discarded entries.
Return values
OPEN_E_NONEIf the number of discarded entries was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]portinterface number.
[out]valuenumber of valid frames received.
Return values
OPEN_E_NONEIf the number of valid frames was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]portinterface number.
[out]valuenumber of frames received.
Return values
OPEN_E_NONEIf the number of times port was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]portinternal interface number, physical or logical.
[out]valuemaximum size.
Return values
OPEN_E_NONEIf the number of times port was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

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

Parameters
[in]client_handleclient handle from registration API.
[in]portinterface number.
[out]valuenumber of frames received.
Return values
OPEN_E_NONEIf the number of times port was successfully found.
OPEN_E_FAILReturned values are not invalid.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

Examples:
bridge_example.c.