Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
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... | |
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... | |
Definition at line 43 of file openapi_dot1s.h.
Enumerator | |
---|---|
OPEN_DOT1S_MGMT_STR_CONFIG_NAME |
String type Configuration name. |
Definition at line 59 of file openapi_dot1s.h.
Definition at line 64 of file openapi_dot1s.h.
Enumerator | |
---|---|
OPEN_DOT1S_PORT_GUARD_LOOP |
Port Guard Loop. |
OPEN_DOT1S_PORT_GUARD_ROOT |
Port Guard Root. |
OPEN_DOT1S_PORT_GUARD_NONE |
Port Guard None. |
Definition at line 52 of file openapi_dot1s.h.
Definition at line 74 of file openapi_dot1s.h.
open_error_t openapiDot1SBPDUFilterModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | dot1sBPDUFilter | ||
) |
Gets the Spanning Tree BPDU Filter Mode.
[in] | client_handle | client handle from registration API |
[out] | dot1sBPDUFilter | spanning tree BPDU filter |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1SBPDUFilterModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | dot1sBPDUFilter | ||
) |
Configures Spanning Tree BPDU Filter Mode.
[in] | client_handle | client handle from registration API |
[in] | dot1sBPDUFilter | spanning tree BPDU filter |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiDot1SBPDUGuardModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | dot1sBPDUGuard | ||
) |
Gets the Spanning Tree BPDU Guard Mode.
[in] | client_handle | client handle from registration API |
[out] | dot1sBPDUGuard | spanning tree BPDU guard |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SBPDUGuardModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | dot1sBPDUGuard | ||
) |
Configures Spanning Tree BPDU Guard Mode.
[in] | client_handle | client handle from registration API |
[in] | dot1sBPDUGuard | spanning tree BPDU guard |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1sBridgeMaxHopGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | count | ||
) |
Get the Max Hop count for the device.
[in] | client_handle | client handle from registration API |
[out] | count | max hop count |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
open_error_t openapiDot1sBridgeTxHoldCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | count | ||
) |
Get the Tx Hold count for the device.
[in] | client_handle | client handle from registration API |
[out] | count | Tx hold count |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
open_error_t openapiDot1sCISTBridgeHoldTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | holdTime | ||
) |
Get the CIST Bridge Hold Time.
[in] | client_handle | client handle from registration API |
[out] | holdTime | hold time |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
open_error_t openapiDot1SCistExtPortPathCostGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | portCost | ||
) |
Gets the CIST External Port Path Cost on an interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | portCost | CIST path cost of the interface |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | costMode | CIST path cost of the interface |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1SCistExtPortPathCostSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | portCost | ||
) |
Sets the CIST External Port Path Cost on an interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | portCost | CIST path cost of the interface |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1sCISTHelloTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | helloTime | ||
) |
Get the CIST Hello Time of a specific port.
[in] | client_handle | client handle from registration API |
[in] | ifNum | interface number |
[out] | helloTime | hello time |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
open_error_t openapiDot1SCistHelloTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | helloTime | ||
) |
Gets the MSTP Root Port HelloTime paramter for the CIST.
[in] | client_handle | client handle from registration API |
[out] | helloTime | Root port Hello time |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1sCISTMaxAgeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | age | ||
) |
Get the max age for the CIST.
[in] | client_handle | client handle from registration API |
[out] | age | the current CIST max age |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | status | Operational Edge Port status |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | status | Operational Point to Point Mac parameter |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1SCistPortPathCostGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | portCost | ||
) |
Gets the CIST port path cost.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | portCost | CIST port path cost |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | bridgeID | MSTP Designated Bridge Identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | val | Topology Change Acknowledge |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1sCISTRegionalRootIDGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_DOT1S_BRIDGEID_t * | rootId | ||
) |
Get the CIST Regional Root Identifier.
[in] | client_handle | client handle from registration API |
[out] | rootId | regional root identifier |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
open_error_t openapiDot1sCISTRegionalRootPathCostGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | cost | ||
) |
Get the CIST Regional Root Path Cost.
[in] | client_handle | client handle from registration API |
[out] | cost | regional root path cost |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
open_error_t openapiDot1sCISTRootFwdDelayGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | delay | ||
) |
Get the CIST Bridge Forward Delay.
[in] | client_handle | client handle from registration API |
[out] | delay | forward delay for the CIST |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
open_error_t openapiDot1SConfigNameGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | dot1sConfigName | ||
) |
Gets the Spanning Tree Configuration Name.
[in] | client_handle | client handle from registration API |
[out] | dot1sConfigName | spanning tree configuration name |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SConfigNameSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | dot1sConfigName | ||
) |
Configures Spanning Tree Configuration Name.
[in] | client_handle | client handle from registration API |
[in] | dot1sConfigName | spanning tree configuration name |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SConfigRevisionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | dot1sConfigRev | ||
) |
Gets the Spanning Tree Configuration Revision.
[in] | client_handle | client handle from registration API |
[out] | dot1sConfigRev | spanning tree configuration revision |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SConfigRevisionSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | dot1sConfigRev | ||
) |
Configures Spanning Tree Configuration Revision.
[in] | client_handle | client handle from registration API |
[in] | dot1sConfigRev | spanning tree configuration revision |
- | Minimum value OPENAPI_DOT1S_MIN_REVISION_VALUE | |
- | Maximum value OPENAPI_DOT1S_MAX_REVISION_VALUE |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SForceVersionGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_DOT1S_FORCE_VERSION_t * | dot1sForceVersion | ||
) |
Gets the Spanning Tree Force Revision.
[in] | client_handle | client handle from registration API |
[out] | dot1sForceVersion | spanning tree force version |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SForceVersionSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_DOT1S_FORCE_VERSION_t | dot1sForceVersion | ||
) |
Configures Spanning Tree Force Revision.
[in] | client_handle | client handle from registration API |
[in] | dot1sForceVersion | spanning tree force version |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SIntfBPDUFilterModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t * | dot1sBPDUFilterMode | ||
) |
Gets Spanning Tree BPDU Filter mode for an interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | dot1sBPDUFilterMode | spanning tree BPDU filter mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SIntfBPDUFilterModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | dot1sBPDUFilterMode | ||
) |
Configures Spanning Tree BPDU Filter mode for an interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | dot1sBPDUFilterMode | spanning tree BPDU filter mode |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SIntfBPDUFloodModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t * | dot1sBPDUFloodMode | ||
) |
Gets Spanning Tree BPDU Flood mode for an interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | dot1sBPDUFloodMode | spanning tree BPDU Flood mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SIntfBPDUFloodModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | dot1sBPDUFloodMode | ||
) |
Configures Spanning Tree BPDU Flood mode for an interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | dot1sBPDUFloodMode | spanning tree BPDU Flood mode |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | mode | spanning tree BPDU guard effect mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | dot1sEdgePortMode | spanning tree edge port mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SIntfEdgePortModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | dot1sEdgePortMode | ||
) |
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | dot1sEdgePortMode | spanning tree edge port mode |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SIntfGuardModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DOT1S_PORT_GUARD_t * | dot1sGuardMode | ||
) |
Gets Spanning Tree Guard mode.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | dot1sGuardMode | spanning tree Guard mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SIntfGuardModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DOT1S_PORT_GUARD_t | dot1sGuardMode | ||
) |
Configures Spanning Tree Guard mode.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | dot1sGuardMode | spanning tree Guard mode |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | helloTime | spanning tree port hello time |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1SIntfModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t * | dot1sMode | ||
) |
Gets Spanning Tree Admin Mode on an interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | dot1sMode | spanning tree admin mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SIntfModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CONTROL_t | dot1sMode | ||
) |
Enables/Disables Spanning Tree Admin Mode on an interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | dot1sMode | spanning tree mode |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | dot1sInstance | spanning tree MST instance |
[out] | dot1sPortFwdState | spanning tree port forwarding state |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | dot1sInstance | spanning tree MST instance |
[out] | loopInconsistentState | loop inconsistent state (a boolean value) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.18
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | dot1sInstance | spanning tree MST instance |
[out] | dot1sPortRole | spanning tree port role |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1sMgmtStrLenGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_DOT1S_MGMT_STR_t | strType, | ||
uint32_t * | strLen | ||
) |
Gets the Spanning Tree Management string length.
This length is used to allocate and initialize the open_buffdesc type argument buffers used by various DOT1S OpEN APIs.
[in] | client_handle | client handle from registration API |
[in] | strType | string type |
[out] | strLen | string length |
OPEN_E_NONE | String length Get successful. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | dot1sMode | ||
) |
Gets Spanning Tree Operational Mode.
[in] | client_handle | client handle from registration API |
[out] | dot1sMode | spanning tree operational mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
open_error_t openapiDot1SModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | dot1sMode | ||
) |
Enables/Disables Spanning Tree Operational Mode.
[in] | client_handle | client handle from registration API |
[in] | dot1sMode | spanning tree operational mode |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | bridgeID | MSTP Designated Bridge Identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | dCost | MSTP Designated Bridge cost |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | portID | MSTP Designated Bridge Identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_CST_ID | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[out] | id | bridge identifier |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_CST_ID | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[out] | rootId | designated root identifier |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sInstance | spanning tree MST instance |
[out] | FId | Forwarding Database Id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | no next VLAN found |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SMSTInstanceFirstGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | instanceId | ||
) |
Gets First Spanning Tree MST Instance.
[in] | client_handle | client handle from registration API |
[out] | instanceId | first spanning tree MST instance Id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | No next instance found. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SMSTInstanceFirstVLANGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | dot1sInstance, | ||
uint32_t * | VLANId | ||
) |
Gets First VLAN Id for the Spanning Tree MST Instance.
[in] | client_handle | client handle from registration API |
[in] | dot1sInstance | spanning tree MST instance |
[out] | VLANId | VLAN Id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | no next VLAN found |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sInstance | spanning tree MST instance |
[in] | currFId | current Forwarding Database Id |
[out] | nextFId | next Forwarding Database Id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | no next VLAN found |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SMSTInstanceNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | currInstance, | ||
uint32_t * | nextInstance | ||
) |
Gets Next Spanning Tree MST Instance.
[in] | client_handle | client handle from registration API |
[in] | currInstance | current spanning tree MST instance Id |
[out] | nextInstance | next spanning tree MST instance Id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | No next instance found. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sInstance | spanning tree MST instance |
[in] | currVLANId | current VLAN Id |
[out] | nextVLANId | next VLAN Id |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | no next VLAN found |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SMSTInstancePriorityGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | dot1sMSTInstance, | ||
uint16_t * | priority | ||
) |
Gets Spanning Tree MST Instance priority.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[out] | priority | instance priority |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
open_error_t openapiDot1SMSTInstancePrioritySet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | dot1sMSTInstance, | ||
uint32_t | priority | ||
) |
Configures Spanning Tree MST Instance priority.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_MSTID_MIN | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[in] | priority | instance priority |
- | Minimum value OPENAPI_DOT1S_PRIORITY_MIN | |
- | Maximum value OPENAPI_DOT1S_PRIORITY_MAX |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_CST_ID | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[out] | cost | designated root path cost |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_CST_ID | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[out] | port | port ID of the root port |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
open_error_t openapiDot1SMSTInstanceSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | dot1sMSTInstanceId, | ||
OPEN_ACTION_t | action | ||
) |
Creates/Deletes Spanning Tree MST Instance.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstanceId | spanning tree MST instance Id |
- | Minimum value OPENAPI_DOT1S_MSTID_MIN | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[in] | action | create/delete instance |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_CST_ID | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[out] | timeVal | time value, in seconds |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_CST_ID | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[out] | count | number of TCNs received |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_CST_ID | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[out] | change | OPEN_TRUE, a change in progress OPEN_FALSE, no change in progress. |
OPEN_E_NONE | On success. |
OPEN_E_FAIL | On failure. |
OPEN_E_PARAM | Invalid argument. |
OpEN API Version: 1.18
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
- | Minimum value OPENAPI_DOT1S_MSTID_MIN | |
- | Maximum value OPENAPI_DOT1S_MSTID_MAX | |
[in] | vlan | VLAN |
- | Minimum value OPENAPI_DOT1Q_MIN_VLAN_ID | |
- | Maximum value openapiDot1VlanMaxGet() | |
[in] | action | create/delete association |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.1
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | portID | port ID of the interface |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | portCost | port path cost of the MSTP parameter |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | rootID | MSTP Designated Root Bridge Identifier |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | status | MSTP Loop Inconsistent State |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | costMode | current mode of the MSTP parameter |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[in] | pCost | path cost of the MSTP parameter |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | priority | priority of the interface MSTP |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[in] | priority | priority of the interface MSTP |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | mode | Auto Edge Port mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | mode | Auto Edge Port mode |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | mode | TCN guard status |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[in] | val | TCN guard status |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1SPortStatsClear | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum | ||
) |
Clears the port stats.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | val | MSTP BPDUs received |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | val | MSTP BPDUs sent |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | val | RSTP BPDUs received |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | val | RSTP BPDUs sent |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | val | STP BPDUs received |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | val | STP BPDUs sent |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | loopCount | Loop Inconsistent State Start stat |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | dot1sMSTInstance | spanning tree MST instance |
[in] | ifNum | ID of the interface |
[out] | loopCount | Loop Inconsistent State End stat |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1SPortUpTimeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | upTime | ||
) |
Gets the MSTP Up Time of the port.
[in] | client_handle | client handle from registration API |
[in] | ifNum | ID of the interface |
[out] | upTime | port up time |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiDot1VlanMaxGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | vlanMax | ||
) |
Get the maximum number of Spanning Tree VLANs.
[in] | client_handle | Client handle from registration API |
[out] | vlanMax | Maximum VLAN |
OPEN_E_NONE | if SNTP priority is returned successfully. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.1