Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
#include "openapi_common.h"
Go to the source code of this file.
Macros | |
#define | OPENAPI_INTERFACE_NAME_LENGTH 60 |
Enumerations | |
enum | OPEN_DISABLE_REASON_t { OPEN_DISABLE_REASON_NONE = 1, OPEN_DISABLE_REASON_UDLD = 2, OPEN_DISABLE_REASON_STP = 3, OPEN_DISABLE_REASON_BPDUGUARD = 4, OPEN_DISABLE_REASON_BPDUSTORM = 5, OPEN_DISABLE_REASON_DHCPSNOOPING = 6, OPEN_DISABLE_REASON_ARPINSPECTION = 7, OPEN_DISABLE_REASON_STORMCONTROL_BCAST = 8, OPEN_DISABLE_REASON_STORMCONTROL_MCAST = 9, OPEN_DISABLE_REASON_STORMCONTROL_UCAST = 10, OPEN_DISABLE_REASON_XCEIVER = 11, OPEN_DISABLE_REASON_XCEIVERPLUS = 12, OPEN_DISABLE_REASON_LOOPPROTECT = 13, OPEN_DISABLE_REASON_PML = 14, OPEN_DISABLE_REASON_DOS = 15, OPEN_DISABLE_REASON_LINK_FLAP = 16, OPEN_DISABLE_REASON_AUTHMGR_AUTH_VIOLATION = 17, OPEN_DISABLE_REASON_COA = 18 } |
OPEN uses these enumerators to indicate the reason a port is diagnostically disabled. More... | |
enum | OPEN_INTF_STATUS_t { OPEN_INTF_STATUS_NONE = 0, OPEN_INTF_STATUS_ATTACHED = 1 } |
OPEN uses these enumerators to indicate the interface status. More... | |
enum | OPEN_PHY_CAPABILITIES_t { OPEN_PHY_CAP_PORTSPEED_HALF_10 = 0x000000001, OPEN_PHY_CAP_PORTSPEED_FULL_10 = 0x000000002, OPEN_PHY_CAP_PORTSPEED_HALF_100 = 0x000000004, OPEN_PHY_CAP_PORTSPEED_FULL_100 = 0x000000008, OPEN_PHY_CAP_PORTSPEED_HALF_1000 = 0x000000010, OPEN_PHY_CAP_PORTSPEED_FULL_1000 = 0x000000020, OPEN_PHY_CAP_PORTSPEED_FULL_2P5G = 0x000000040, OPEN_PHY_CAP_PORTSPEED_FULL_5G = 0x000000080, OPEN_PHY_CAP_PORTSPEED_FULL_10G = 0x000000100, OPEN_PHY_CAP_PORTSPEED_AUTO_NEG = 0x000000400, OPEN_PHY_CAP_PORTSPEED_SFP = 0x000000800, OPEN_PHY_CAP_PORTSPEED_SFP_DETECT = 0x000001000, OPEN_PHY_CAP_POE_PSE = 0x000002000, OPEN_PHY_CAP_POE_PD = 0x000004000, OPEN_PHY_CAP_INTERNAL = 0x000008000, OPEN_PHY_CAP_NATIVE_EEE = 0x000010000, OPEN_PHY_CAP_AUTO_EEE = 0x000020000, OPEN_PHY_CAP_DUAL_MODE_SUPPORT = 0x000040000, OPEN_PHY_CAP_POE_PSE_PLUS = 0x000080000, OPEN_PHY_CAP_POE_PD_PLUS = 0x000100000, OPEN_PHY_CAP_ENERGY_DETECT = 0x000200000, OPEN_PHY_CAP_COMBO_PREFERENCE = 0x000400000, OPEN_PHY_CAP_EXPANDABLE_PORT = 0x000800000, OPEN_PHY_CAP_AUTO_CONFIG = 0x001000000, OPEN_PHY_CAP_SHORT_REACH = 0x002000000, OPEN_PHY_CAP_UPOE_PSE = 0x004000000, OPEN_PHY_CAP_UPOE_PD = 0x008000000, OPEN_PHY_CAP_DYNAMIC_PORT = 0x010000000, OPEN_PHY_CAP_FIXED_STACK_PORT = 0x020000000, OPEN_PHY_CAP_FEC_SUPPORT = 0x040000000, OPEN_PHY_CAP_PORTSPEED_FULL_20G = 0x080000000, OPEN_PHY_CAP_PORTSPEED_FULL_25G = 0x081000000, OPEN_PHY_CAP_PORTSPEED_FULL_40G = 0x082000000, OPEN_PHY_CAP_PORTSPEED_FULL_50G = 0x084000000, OPEN_PHY_CAP_PORTSPEED_FULL_100G = 0x088000000 } |
enum | OPEN_PORT_AUTO_NEG_t { OPEN_PORT_AUTO_NEG_ENABLE = 0, OPEN_PORT_AUTO_NEG_DISABLE = 1, OPEN_PORT_AUTO_NEG_UNKNOWN = 0xffff } |
enum | OPEN_PORT_CABLE_MEDIA_TYPE_t { OPEN_PORT_CABLE_MEDIA_TYPE_NONE = 0, OPEN_PORT_CABLE_MEDIA_TYPE_COPPER = 1, OPEN_PORT_CABLE_MEDIA_TYPE_FIBER = 2 } |
OPEN uses these enumerators to indicate the interface active media type. More... | |
enum | OPEN_PORT_DUPLEX_t { OPEN_PORT_DUPLEX_HALF = 0, OPEN_PORT_DUPLEX_FULL = 1, OPEN_PORT_DUPLEX_UNKNOWN = 0xffff } |
enum | OPEN_PORT_SPEEDS_t { OPEN_PORTCTRL_PORTSPEED_AUTO_NEG = 1, OPEN_PORTCTRL_PORTSPEED_HALF_100TX = 2, OPEN_PORTCTRL_PORTSPEED_FULL_100TX = 3, OPEN_PORTCTRL_PORTSPEED_HALF_10T = 4, OPEN_PORTCTRL_PORTSPEED_FULL_10T = 5, OPEN_PORTCTRL_PORTSPEED_FULL_100FX = 6, OPEN_PORTCTRL_PORTSPEED_FULL_1000SX = 7, OPEN_PORTCTRL_PORTSPEED_FULL_10GSX = 8, OPEN_PORTCTRL_PORTSPEED_FULL_20GSX = 9, OPEN_PORTCTRL_PORTSPEED_FULL_40GSX = 10, OPEN_PORTCTRL_PORTSPEED_FULL_25GSX = 11, OPEN_PORTCTRL_PORTSPEED_FULL_50GSX = 12, OPEN_PORTCTRL_PORTSPEED_FULL_100GSX = 13, OPEN_PORTCTRL_PORTSPEED_AAL5_155 = 14, OPEN_PORTCTRL_PORTSPEED_FULL_5FX = 15, OPEN_PORTCTRL_PORTSPEED_FULL_200GSX = 16, OPEN_PORTCTRL_PORTSPEED_FULL_400GSX = 17, OPEN_PORTCTRL_PORTSPEED_FULL_2P5FX = 128, OPEN_PORTCTRL_PORTSPEED_LAG = 129, OPEN_PORTCTRL_PORTSPEED_UNKNOWN = 130 } |
enum | OPEN_SPECIAL_PORT_TYPE_t { OPEN_SPECIAL_PORT_TYPE_NORMAL = 1, OPEN_SPECIAL_PORT_TYPE_TRUNK_MEMBER = 2, OPEN_SPECIAL_PORT_TYPE_MIRRORED_PORT = 3, OPEN_SPECIAL_PORT_TYPE_PROBE_PORT = 4, OPEN_SPECIAL_PORT_TYPE_L2TUNNEL_PORT = 5, OPEN_SPECIAL_PORT_TYPE_SERVICE_PORT = 6 } |
OPEN uses these enumerators to indicate a port that is currently being used for a special purpose, such as as a trunk member, probe port, etc. More... | |
Functions | |
open_error_t | openapiIfActiveMediaTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_CABLE_MEDIA_TYPE_t *mediaType) |
Get the active media type for a given interface. More... | |
open_error_t | openapiIfAdminStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *adminState) |
Gets the administrative state for the specified interface. More... | |
open_error_t | openapiIfAdminStateSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t adminState) |
Sets the administrative state for the specified interface. More... | |
open_error_t | openapiIfAutoNegGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_AUTO_NEG_t *autoneg) |
Gets the auto-negotiation mode of a given interface. More... | |
open_error_t | openapiIfAutoNegSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t autoneg) |
Sets the auto-negotiation mode of a given interface. More... | |
open_error_t | openapiIfCapabilitiesGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint64_t *portCapability) |
Gets the capabilities of a given interface. More... | |
open_error_t | openapiIfDescrGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *descrip) |
Gets the Description of a given interface. More... | |
open_error_t | openapiIfDescrSet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *descrip) |
Sets the Description of a given interface. More... | |
open_error_t | openapiIfDescrSizeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *size) |
Gets the Description size of a given interface. More... | |
open_error_t | openapiIfDisableReasonGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DISABLE_REASON_t *reason) |
Gets the disable reason code for an interface. More... | |
open_error_t | openapiIfDuplexGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_DUPLEX_t *duplex_mode) |
Gets the duplex status of a given interface. More... | |
open_error_t | openapiIfDuplexModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_DUPLEX_t *duplex_mode) |
Gets the duplex mode of a given interface. More... | |
open_error_t | openapiIfEthernetHeaderSizeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *headerSize) |
Gets the ethernet header size of a given interface. More... | |
open_error_t | openapiIfExpPortFirstPeerGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *peerIfNum) |
Get the interface number of the port's first and presumably the smallest peer interface. More... | |
open_error_t | openapiIfExpPortOperModeLaneCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *laneCount) |
Determine the number of lanes running under this port based on the operating mode of this port. More... | |
open_error_t | openapiIfExpPortRootPortGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *rootSlot, uint32_t *rootPort) |
Translate internal interface number into root slot and port. More... | |
open_error_t | openapiIfFirstGet (openapiClientHandle_t *client_handle, OPEN_INTF_TYPE_t ifType, uint32_t *firstIfNum) |
Gets the interface identifier for the first interface of the specified interface type. More... | |
open_error_t | openapiIfInDiscardsGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
The number of inbound packets which were chosen to be discarded. More... | |
open_error_t | openapiIfInErrorsGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
Returns the current value of the errors counter. More... | |
open_error_t | openapiIfInOctetsGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
Gets the total number of octets received on the interface including framing characters. More... | |
open_error_t | openapiIfInUcastPktsGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
The number of packets, delivered by this sub-layer to a higher sub-layer. More... | |
open_error_t | openapiIfInUnknownProtosGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
The number of packets received via the interface which were discarded because of an unknown or unsupported protocol. More... | |
open_error_t | openapiIfLastChangeGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
Gets the time of last link state change in seconds. More... | |
open_error_t | openapiIfLinkStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LINK_STATE_t *linkState) |
Gets the link state for the specified interface. More... | |
open_error_t | openapiIfMacAddrGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *mac_addr) |
Gets the MAC address of a given interface. More... | |
open_error_t | openapiIfMacAddrSizeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *size) |
Gets the MAC address size of a given interface. More... | |
open_error_t | openapiIfMaxFrameSizeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *maxFrameSize) |
Gets the Maximum frame size of a given interface. More... | |
open_error_t | openapiIfMaxFrameSizeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t maxFrameSize) |
Sets the Maximum frame size of a given interface. More... | |
open_error_t | openapiIfMtuSizeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *mtu_size) |
Gets the MTU size of a given interface. More... | |
open_error_t | openapiIfMtuSizeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t mtu_size) |
Sets the MTU size of a given interface. More... | |
open_error_t | openapiIfMtuSizeSetV2 (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t mtu_size) |
Sets the MTU size of a given interface. More... | |
open_error_t | openapiIfNameGet (openapiClientHandle_t *client_handle, uint32_t intf, open_buffdesc *intfName) |
Gets the displayable name for the specified interface. More... | |
open_error_t | openapiIfNextChangedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum, uint32_t *delete_pending) |
Gets the next interface which has a pending change or a pending deletion. More... | |
open_error_t | openapiIfNextGet (openapiClientHandle_t *client_handle, OPEN_INTF_TYPE_t ifType, uint32_t ifNum, uint32_t *nextIfNum) |
Gets the interface identifier for the first interface of the specified interface type that has the next identifier. More... | |
open_error_t | openapiIfNumGet (openapiClientHandle_t *client_handle, open_buffdesc *intfName, uint32_t *ifNum) |
Gets the interface number given the displayable name for the interface. More... | |
open_error_t | openapiIfOprStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_STATE_t *val) |
Gets the operational status of a given interface. More... | |
open_error_t | openapiIfOutDiscardsGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
The number of outbound packets which were chosen to be discarded. More... | |
open_error_t | openapiIfOutErrorsGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. More... | |
open_error_t | openapiIfOutOctetsGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
The total number of octets transmitted out of the interface, including framing characters. More... | |
open_error_t | openapiIfOutUcastPktsGet (openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value) |
The total number of packets that higher-level protocols requested be transmitted. More... | |
open_error_t | openapiIfPauseStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *rxPauseAllowed, OPEN_BOOL_t *txPauseAllowed) |
Get the negotiated Rx and Tx pause status of a given interface. More... | |
open_error_t | openapiIfPortSpeedLaneCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *laneCount) |
Determine the number of lanes running under this port based on the running speed of this port. More... | |
open_error_t | openapiIfSoftShutdownStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *soft_shut) |
Gets the Soft-shutdown status of a given interface. More... | |
open_error_t | openapiIfSoftShutdownStateSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t soft_shut) |
Sets the Soft-shutdown status of a given interface. More... | |
open_error_t | openapiIfSpecialPortTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_SPECIAL_PORT_TYPE_t *specialType) |
Get the special port type designation of a given interface. More... | |
open_error_t | openapiIfSpeedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_SPEEDS_t *speed) |
Gets the speed status of a given interface. More... | |
open_error_t | openapiIfSpeedModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_SPEEDS_t *speed) |
Gets the speed mode of a given interface. More... | |
open_error_t | openapiIfSpeedSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_SPEEDS_t speed) |
Sets the speed of a given interface. More... | |
open_error_t | openapiIfStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_INTF_STATUS_t *ifStatus) |
Gets the status of the specified interface. More... | |
open_error_t | openapiIfTypeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_INTF_TYPE_t *ifType) |
Gets the interface type associated with the internal interface number. More... | |