Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Macros | Enumerations | Functions
openapi_dot1s.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Data Structures

struct  OPEN_DOT1S_BRIDGEID_t
 DOT1S general bridge identifier formed by combining the bridge priority, instance identifier, and MAC address into an 8-octet hex value. More...
 

Macros

#define OPEN_DOT1S_MAC_ID_LEN   OPEN_MAC_ADDR_LEN
 
#define OPEN_DOT1S_VID_MAC_ADDR_LEN   (OPEN_DOT1S_VLAN_ID_LEN + OPEN_DOT1S_MAC_ID_LEN)
 
#define OPEN_DOT1S_VLAN_ID_LEN   2
 
#define OPENAPI_DOT1S_CST_ID   0
 
#define OPENAPI_DOT1S_MSTID_MAX   4094
 

Enumerations

enum  OPEN_DOT1S_FORCE_VERSION_t {
  OPEN_DOT1S_FORCE_VERSION_DOT1D = 0, OPEN_DOT1S_FORCE_VERSION_UNUSED = 1, OPEN_DOT1S_FORCE_VERSION_DOT1W = 2, OPEN_DOT1S_FORCE_VERSION_DOT1S = 3,
  OPEN_DOT1S_FORCE_VERSION_LAST
}
 
enum  OPEN_DOT1S_MGMT_STR_t { OPEN_DOT1S_MGMT_STR_CONFIG_NAME = 0 }
 
enum  OPEN_DOT1S_PORT_FWD_STATE_t {
  OPEN_DOT1S_PORT_DISCARDING = 1, OPEN_DOT1S_PORT_LEARNING = 2, OPEN_DOT1S_PORT_FORWARDING = 3, OPEN_DOT1S_PORT_DISABLED = 4,
  OPEN_DOT1S_PORT_MANUAL_FWD = 5, OPEN_DOT1S_PORT_NOT_PARTICIPATE = 6
}
 
enum  OPEN_DOT1S_PORT_GUARD_t { OPEN_DOT1S_PORT_GUARD_LOOP = 0, OPEN_DOT1S_PORT_GUARD_ROOT = 1, OPEN_DOT1S_PORT_GUARD_NONE = 2 }
 
enum  OPEN_DOT1S_PORT_ROLE_t {
  OPEN_DOT1S_ROLE_DISABLED = 0, OPEN_DOT1S_ROLE_ROOT = 1, OPEN_DOT1S_ROLE_DESIGNATED = 2, OPEN_DOT1S_ROLE_ALTERNATE = 3,
  OPEN_DOT1S_ROLE_BACKUP = 4, OPEN_DOT1S_ROLE_MASTER = 5
}
 

Functions

open_error_t openapiDot1SBPDUFilterModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sBPDUFilter)
 Gets the Spanning Tree BPDU Filter Mode. More...
 
open_error_t openapiDot1SBPDUFilterModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUFilter)
 Configures Spanning Tree BPDU Filter Mode. More...
 
open_error_t openapiDot1SBPDUGuardModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sBPDUGuard)
 Gets the Spanning Tree BPDU Guard Mode. More...
 
open_error_t openapiDot1SBPDUGuardModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sBPDUGuard)
 Configures Spanning Tree BPDU Guard Mode. More...
 
open_error_t openapiDot1sBridgeMaxHopGet (openapiClientHandle_t *client_handle, uint32_t *count)
 Get the Max Hop count for the device. More...
 
open_error_t openapiDot1sBridgeTxHoldCountGet (openapiClientHandle_t *client_handle, uint32_t *count)
 Get the Tx Hold count for the device. More...
 
open_error_t openapiDot1sCISTBridgeHoldTimeGet (openapiClientHandle_t *client_handle, uint32_t *holdTime)
 Get the CIST Bridge Hold Time. More...
 
open_error_t openapiDot1SCistExtPortPathCostGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *portCost)
 Gets the CIST External Port Path Cost on an interface. More...
 
open_error_t openapiDot1SCistExtPortPathCostModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *costMode)
 Gets the CIST External Port Path Cost Mode on an interface. More...
 
open_error_t openapiDot1SCistExtPortPathCostSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t portCost)
 Sets the CIST External Port Path Cost on an interface. More...
 
open_error_t openapiDot1sCISTHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *helloTime)
 Get the CIST Hello Time of a specific port. More...
 
open_error_t openapiDot1SCistHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t *helloTime)
 Gets the MSTP Root Port HelloTime paramter for the CIST. More...
 
open_error_t openapiDot1sCISTMaxAgeGet (openapiClientHandle_t *client_handle, uint32_t *age)
 Get the max age for the CIST. More...
 
open_error_t openapiDot1SCistPortOperEdgeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
 Gets the CIST Operational Edge Port parameter of a specific port. More...
 
open_error_t openapiDot1SCistPortOperPointToPointGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
 Gets the CIST Operational Point to Point Mac parameter of a specific port. More...
 
open_error_t openapiDot1SCistPortPathCostGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *portCost)
 Gets the CIST port path cost. More...
 
open_error_t openapiDot1SCistPortRegionalRootIDGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *bridgeID)
 Gets the CIST Regional Root Bridge Identifier for a particular interface. More...
 
open_error_t openapiDot1SCistPortTopologyChangeAckGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *val)
 Gets the CIST Topology Change Acknowledge parameter for a specific port in the CIST. More...
 
open_error_t openapiDot1sCISTRegionalRootIDGet (openapiClientHandle_t *client_handle, OPEN_DOT1S_BRIDGEID_t *rootId)
 Get the CIST Regional Root Identifier. More...
 
open_error_t openapiDot1sCISTRegionalRootPathCostGet (openapiClientHandle_t *client_handle, uint32_t *cost)
 Get the CIST Regional Root Path Cost. More...
 
open_error_t openapiDot1sCISTRootFwdDelayGet (openapiClientHandle_t *client_handle, uint32_t *delay)
 Get the CIST Bridge Forward Delay. More...
 
open_error_t openapiDot1SConfigNameGet (openapiClientHandle_t *client_handle, open_buffdesc *dot1sConfigName)
 Gets the Spanning Tree Configuration Name. More...
 
open_error_t openapiDot1SConfigNameSet (openapiClientHandle_t *client_handle, open_buffdesc *dot1sConfigName)
 Configures Spanning Tree Configuration Name. More...
 
open_error_t openapiDot1SConfigRevisionGet (openapiClientHandle_t *client_handle, uint32_t *dot1sConfigRev)
 Gets the Spanning Tree Configuration Revision. More...
 
open_error_t openapiDot1SConfigRevisionSet (openapiClientHandle_t *client_handle, uint32_t dot1sConfigRev)
 Configures Spanning Tree Configuration Revision. More...
 
open_error_t openapiDot1SForceVersionGet (openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t *dot1sForceVersion)
 Gets the Spanning Tree Force Revision. More...
 
open_error_t openapiDot1SForceVersionSet (openapiClientHandle_t *client_handle, OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion)
 Configures Spanning Tree Force Revision. More...
 
open_error_t openapiDot1SIntfBPDUFilterModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sBPDUFilterMode)
 Gets Spanning Tree BPDU Filter mode for an interface. More...
 
open_error_t openapiDot1SIntfBPDUFilterModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFilterMode)
 Configures Spanning Tree BPDU Filter mode for an interface. More...
 
open_error_t openapiDot1SIntfBPDUFloodModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sBPDUFloodMode)
 Gets Spanning Tree BPDU Flood mode for an interface. More...
 
open_error_t openapiDot1SIntfBPDUFloodModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sBPDUFloodMode)
 Configures Spanning Tree BPDU Flood mode for an interface. More...
 
open_error_t openapiDot1SIntfBPDUGuardEffectGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
 Gets the MSTP BPDU guard effect of an interface for the CIST. More...
 
open_error_t openapiDot1SIntfEdgePortModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *dot1sEdgePortMode)
 Gets the Spanning Tree MST Port Administrative Edge Port mode of an interface for the CIST. More...
 
open_error_t openapiDot1SIntfEdgePortModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sEdgePortMode)
 
open_error_t openapiDot1SIntfGuardModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1S_PORT_GUARD_t *dot1sGuardMode)
 Gets Spanning Tree Guard mode. More...
 
open_error_t openapiDot1SIntfGuardModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode)
 Configures Spanning Tree Guard mode. More...
 
open_error_t openapiDot1SIntfHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *helloTime)
 Gets the MSTP Hello time of an interface for the CIST. More...
 
open_error_t openapiDot1SIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *dot1sMode)
 Gets Spanning Tree Admin Mode on an interface. More...
 
open_error_t openapiDot1SIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t dot1sMode)
 Enables/Disables Spanning Tree Admin Mode on an interface. More...
 
open_error_t openapiDot1SIntfPortFwdStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t dot1sInstance, OPEN_DOT1S_PORT_FWD_STATE_t *dot1sPortFwdState)
 Gets Spanning Tree Port Forwarding State. More...
 
open_error_t openapiDot1SIntfPortLoopInconsistentStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t dot1sInstance, OPEN_BOOL_t *loopInconsistentState)
 Configures the Spanning Tree MST Port Administrative Edge Port mode of an interface for the CIST. More...
 
open_error_t openapiDot1SIntfPortRoleGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t dot1sInstance, OPEN_DOT1S_PORT_ROLE_t *dot1sPortRole)
 Gets Spanning Tree Port Role. More...
 
open_error_t openapiDot1sMgmtStrLenGet (openapiClientHandle_t *client_handle, OPEN_DOT1S_MGMT_STR_t strType, uint32_t *strLen)
 Gets the Spanning Tree Management string length. More...
 
open_error_t openapiDot1SModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dot1sMode)
 Gets Spanning Tree Operational Mode. More...
 
open_error_t openapiDot1SModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dot1sMode)
 Enables/Disables Spanning Tree Operational Mode. More...
 
open_error_t openapiDot1SMstiDesignatedBridgeIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, open_buffdesc *bridgeID)
 Get the MSTP Designated Bridge Identifier in a specific instance for a particular interface. More...
 
open_error_t openapiDot1SMstiDesignatedCostGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *dCost)
 Get the MSTP Designated Bridge cost in a specific instance for a particular interface. More...
 
open_error_t openapiDot1SMstiDesignatedPortIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, open_buffdesc *portID)
 Gets the MSTP Designated Port Identifier in a specific instance for a particular interface. More...
 
open_error_t openapiDot1sMSTInstanceBridgeIdentifierGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, OPEN_DOT1S_BRIDGEID_t *id)
 Get the Spanning Tree MST Bridge Identifier for a specific instance. More...
 
open_error_t openapiDot1sMSTInstanceDesignatedRootIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, OPEN_DOT1S_BRIDGEID_t *rootId)
 Get the Spanning Tree MST Designated Root Identifier in a specific instance. More...
 
open_error_t openapiDot1SMSTInstanceFirstFIdGet (openapiClientHandle_t *client_handle, uint32_t dot1sInstance, uint32_t *FId)
 Gets First Forwarding Database Id for the Spanning Tree MST Instance. More...
 
open_error_t openapiDot1SMSTInstanceFirstGet (openapiClientHandle_t *client_handle, uint32_t *instanceId)
 Gets First Spanning Tree MST Instance. More...
 
open_error_t openapiDot1SMSTInstanceFirstVLANGet (openapiClientHandle_t *client_handle, uint32_t dot1sInstance, uint32_t *VLANId)
 Gets First VLAN Id for the Spanning Tree MST Instance. More...
 
open_error_t openapiDot1SMSTInstanceNextFIdGet (openapiClientHandle_t *client_handle, uint32_t dot1sInstance, uint32_t currFId, uint32_t *nextFId)
 Gets Next Forwarding Database Id for the Spanning Tree MST Instance. More...
 
open_error_t openapiDot1SMSTInstanceNextGet (openapiClientHandle_t *client_handle, uint32_t currInstance, uint32_t *nextInstance)
 Gets Next Spanning Tree MST Instance. More...
 
open_error_t openapiDot1SMSTInstanceNextVLANGet (openapiClientHandle_t *client_handle, uint32_t dot1sInstance, uint32_t currVLANId, uint32_t *nextVLANId)
 Gets Next VLAN Id for the Spanning Tree MST Instance. More...
 
open_error_t openapiDot1SMSTInstancePriorityGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint16_t *priority)
 Gets Spanning Tree MST Instance priority. More...
 
open_error_t openapiDot1SMSTInstancePrioritySet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t priority)
 Configures Spanning Tree MST Instance priority. More...
 
open_error_t openapiDot1sMSTInstanceRootPathCostGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t *cost)
 Get the Spanning Tree MST Designated Root Path Cost for a specific instance. More...
 
open_error_t openapiDot1sMSTInstanceRootPortIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t *port)
 Get the Spanning Tree MST Root Port ID in a specific instance. More...
 
open_error_t openapiDot1SMSTInstanceSet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstanceId, OPEN_ACTION_t action)
 Creates/Deletes Spanning Tree MST Instance. More...
 
open_error_t openapiDot1sMSTInstanceTimeSinceTopologyChangeGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t *timeVal)
 Get the Spanning Tree MST Time since the last Topology Change for a specific instance. More...
 
open_error_t openapiDot1sMSTInstanceTopologyChangeCountGet (openapiClientHandle_t *client_handle, uint32_t mstId, uint32_t *count)
 Get the Spanning Tree MST count of Topology Changes in a specific instance. More...
 
open_error_t openapiDot1sMSTInstanceTopologyChangeStateGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, OPEN_BOOL_t *change)
 Get if a toplogy change is in progress for any port assigned to the MST instance. More...
 
open_error_t openapiDot1SMSTInstanceVLANSet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t vlan, OPEN_ACTION_t action)
 Adds/Deletes Spanning Tree MST Instance-VLAN association. More...
 
open_error_t openapiDot1SMSTIntfPortIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, open_buffdesc *portID)
 Get the MSTP Port Identifier of a specific port in a specific instance. More...
 
open_error_t openapiDot1SMstiOperPortPathCostGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *portCost)
 Gets the MSTP operational Port Path Cost in a specific instance. More...
 
open_error_t openapiDot1SMstiPortDesignatedRootIDGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, open_buffdesc *rootID)
 Get the Spanning Tree MST Instance Designated Root Bridge Identifier on a interface. More...
 
open_error_t openapiDot1SMstiPortLoopInconsistentStateGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, OPEN_BOOL_t *status)
 Gets the MSTP Instance Loop Inconsistent State on an interface. More...
 
open_error_t openapiDot1SMstiPortPathCostModeGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, OPEN_CONTROL_t *costMode)
 Get the MSTP Port Path Cost Mode in a specific instance. More...
 
open_error_t openapiDot1SMstiPortPathCostSet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t pCost)
 Set the MSTP Port Path Cost Mode in a specific instance. More...
 
open_error_t openapiDot1SMstiPortPriorityGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *priority)
 Get the MSTP Port Priority in a specific instance. More...
 
open_error_t openapiDot1SMstiPortPrioritySet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t priority)
 Set the MSTP Port Priority in a specific instance. More...
 
open_error_t openapiDot1SPortAutoEdgeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mode)
 Gets the MSTP Administrative Auto Edge Port parameter of a specific port. More...
 
open_error_t openapiDot1SPortAutoEdgeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mode)
 Set the MSTP Administrative Auto Edge Port parameter of a specific port. More...
 
open_error_t openapiDot1SPortRestrictedTcnGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mode)
 Gets the MSTP Administrative Restricted Tcn parameter of a specific port. More...
 
open_error_t openapiDot1SPortRestrictedTcnSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t val)
 Set the MSTP Administrative Restricted Tcn parameter of a specific port. More...
 
open_error_t openapiDot1SPortStatsClear (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Clears the port stats. More...
 
open_error_t openapiDot1SPortStatsMSTPBPDUsReceivedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for MSTP BPDUs Received on a specific port. More...
 
open_error_t openapiDot1SPortStatsMSTPBPDUsSentGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for MSTP BPDUs Sent on a specific port. More...
 
open_error_t openapiDot1SPortStatsRSTPBPDUsReceivedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for RSTP BPDUs Received on a specific port. More...
 
open_error_t openapiDot1SPortStatsRSTPBPDUsSentGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for RSTP BPDUs Sent on a specific port. More...
 
open_error_t openapiDot1SPortStatsSTPBPDUsReceivedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for STP BPDUs Received on a specific port. More...
 
open_error_t openapiDot1SPortStatsSTPBPDUsSentGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
 Gets the MSTP Statistics for STP BPDUs Sent on a specific port. More...
 
open_error_t openapiDot1SPortStatsTransitionsIntoLoopInconsistentStateGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *loopCount)
 Gets the MSTP Statistics for the number of times this interface has transitioned into loop inconsistent state. More...
 
open_error_t openapiDot1SPortStatsTransitionsOutOfLoopInconsistentStateGet (openapiClientHandle_t *client_handle, uint32_t dot1sMSTInstance, uint32_t ifNum, uint32_t *loopCount)
 Gets the MSTP Statistics for the number of times this interface has transitioned out of loop inconsistent state. More...
 
open_error_t openapiDot1SPortUpTimeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *upTime)
 Gets the MSTP Up Time of the port. More...
 
open_error_t openapiDot1VlanMaxGet (openapiClientHandle_t *client_handle, uint32_t *vlanMax)
 Get the maximum number of Spanning Tree VLANs. More...