This document provides a brief description of the Bridge Support OpEN APIs. It provides the following services:
- Get/Set the timeout period for aging out dynamically learned forwarding information.
- Get the unique MAC address used to refer to the bridge.
- Get number of ports controlled by the bridging entity.
- Get name of an object instance unique to this port.
- Get number of frames discarded by this port due to delay through the bridge.
- Get admin state of the port.
- Get Internal Interface Number of next valid port.
- Get ifIndex associated with the internal interface number.
- Get number of frames discarded by this port due to delay through the bridge.
- Get dot1d Base type of bridging.
- Get next interface for current instance.
- Determine if the interface is in the currently configured STP instance.
- Check if an interface is valid for DOT1D.
- Get Spanning Tree Bridge Forward Delay.
- Get Spanning Tree Bridge Hello Time.
- Get Spanning Tree bridge max age.
- Get Spanning Tree Designated root for the switch.
- Get Spanning Tree forward delay.
- Get Spanning Tree hello time.
- Get Spanning Tree hold time.
- Get Spanning Tree max age.
- Get Spanning Tree Designated Bridge for this port.
- Get Spanning Tree Designated Cost for this port.
- Get Spanning Tree Designated port ID.
- Get Spanning Tree Designated Root for the switch.
- Get number of times this port has transitioned from Learning state to Forwarding state.
- Get Spanning Tree Path Cost for the port.
- Get Spanning Tree Port Priority.
- Get Spanning Tree Port State.
- Get the Spanning Tree Bridge priority.
- Get indication of what version of the Spanning Tree Protocol is being run.
- Get the cost of the path to the root as seen from this bridge.
- Get port number with lowest cost path from bridge to the root bridge.
- Get the time since last topology change was detected by the bridge.
- Get the STP change count.
- Get info about a first specific unicast MAC address which the bridge has forwarding and/or filtering information.
- Get info about a next specific unicast MAC address which the bridge has forwarding and/or filtering information.
- Get the FDB port number.
- Get the status of the dot1dTpFdbEntry.
- Get number of Forwarding Database entries that have been discarded due to a lack of space to store them.
- Get count of valid frames received which were discarded by the Forwarding Process.
- Get number of frames received by this port from its segment.
- Get maximum size of the INFO field this port will receive or transmit.
- Get number of frames transmitted by this port to its segment.
All 'Set' operations would affect the Switch behavior and configuration.
Example C Application bridge_example
Initialization
In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.
bridge_example
bridge_example.c is a sample application that demonstrates the use of the Bridge OpEN API. bridge_example is started from the command line and exercises all the Bridge OpEN APIs one by one.
Bridge CLI/API Cross Reference