Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.9.0.2
Welcome
ADK Documentation
API Reference
Files
Data Structures
Data Fields
Data Structures
Here are the data structures with brief descriptions:
[detail level
1
2
]
_open_bst_error_data_
Structure to hold error info during multi threshold set
_open_ft_5_tuple_key_
5-tuple parameters
_open_ft_capabilities_t_
Structure to hold capbilities
_open_ft_cl_config
Flow tracker collector config
_open_ft_cl_info_
Flow tracker collector configuration
_open_ft_clear_flw_grp_stats_
_open_ft_config_feat_param_
_open_ft_configure_feature_
Flow Tracker feature configuration
_open_ft_flw_grp_config_
Flow group configuration
_open_ft_flw_grp_mon_params_
Union of flow group monitoring params
_open_ft_flw_grp_stats_t_
Structure to hold Group stats
_open_ft_flw_rec_template_
_open_ft_flw_rec_template_info_
_open_ft_ipfix_config_
IPFIX configuration of flow and flow group record exporting processes
_open_ft_template_xmit_config_s
_open_ifa_5_tuple_key_
_open_ifa_capabilities_
_open_ifa_cl_config_
_open_ifa_cl_key_
_open_ifa_feature_
_open_ifa_flow_
_open_ifa_flow_key_
_open_ifa_flow_params_
_open_ifa_session_
_open_ifa_session_key_
_open_ifa_session_stats_
_open_ip_fix_fld_spec_with_en_
_open_port_mask_
_open_pt_config_pkt_drop_ctrs_s
_open_pt_drop_ctrs_req_info_s
_open_pt_drop_reason_data_s
_open_pt_drop_reason_info_s
_OPEN_pt_hashing_info_
Packet hashing resolution information
_open_pt_pkt_drop_ctrs_s
_OPEN_pt_trace_profile_
Trace Profile
OPEN_ACL_ASSIGNED_INTF_LIST_t
ACL interface list
OPEN_ACL_ASSIGNED_VLAN_LIST_t
ACL VLAN list
OPEN_ACL_INTF_DIR_LIST_t
Interface ACL list
OPEN_ACL_INTF_LIST_INFO_t
Interface ACL entry information
OPEN_ACL_VLAN_DIR_LIST_t
VLAN ACL list
OPEN_ACL_VLAN_LIST_INFO_t
VLAN ACL entry information
OPEN_ARP_ENTRY_t
OPEN_ASIC_CAPABILITIES_ALL_t
OPEN_ASIC_CAPABILITIES_t
OPEN_ASIC_PORT_MAP_t
open_bgpDecProcHist_s
Structure used to report BGP decision process history
open_bgpPeerRxAttrErrors_s
Counters for BGP path attribute errors for received paths
open_bgpPeerStatus_s
Structure used to report BGP peer status
OPEN_BHD_PKT_SAMPLING_CONFIG_t
OPEN_BHD_PKT_SAMPLING_PARAMS_t
open_agent_sampling_params
open_sflow_sampling_params
OPEN_BHD_PORT_SFLOW_SAMPLING_STATUS_t
OPEN_BLACK_HOLE_CONFIG_t
open_bootp_dhcp_t
OPEN_BST_ASIC_SNAPSHOT_DATA_COMPRESSED_t
A Complete Data set for a 'snapshot'
OPEN_BST_ASIC_SNAPSHOT_DATA_t
A Complete Data set for a 'snapshot'
OPEN_BST_CONFIG_t
Feature Configuration
OPEN_BST_DEVICE_DATA_t
Buffer Count for the device
OPEN_BST_DEVICE_THRESHOLD_t
Profile configuration for the device level buffers
OPEN_BST_EGRESS_CPU_QUEUE_DATA_t
Buffer Count for CPU Queues
_open_cpuq_data_
OPEN_BST_EGRESS_CPU_QUEUE_THRESHOLD_t
Profile configuration for CPU Queues
OPEN_BST_EGRESS_MC_QUEUE_DATA_t
Buffer Count for Egress Multicast Queues
_open_emcq_data_
OPEN_BST_EGRESS_MC_QUEUE_THRESHOLD_t
Profile configuration for Egress Multicast Queues
OPEN_BST_EGRESS_PORT_SP_DATA_t
Buffer Count for Egress Port + Service Pools
_open_epsp_data_
OPEN_BST_EGRESS_PORT_SP_THRESHOLD_t
Profile configuration for Egress Port + Service Pools
OPEN_BST_EGRESS_RQE_QUEUE_DATA_t
Buffer Count for RQE Queues
_open_rqeq_data_
OPEN_BST_EGRESS_RQE_QUEUE_THRESHOLD_t
Profile configuration for RQE Queues
OPEN_BST_EGRESS_SP_DATA_t
Buffer Count for Egress Service Pools
_open_esp_data_
OPEN_BST_EGRESS_SP_THRESHOLD_t
Profile configuration for Egress Service Pools
OPEN_BST_EGRESS_UC_QUEUE_DATA_t
Buffer Count for Egress Unicast Queues
_open_eucq_data_
OPEN_BST_EGRESS_UC_QUEUE_THRESHOLD_t
Profile configuration for Egress Unicast Queues
OPEN_BST_EGRESS_UC_QUEUEGROUPS_DATA_t
Buffer Count for Egress Unicast Queue Groups
_open_eucqg_data_
OPEN_BST_EGRESS_UC_QUEUEGROUPS_THRESHOLD_t
Profile configuration for Egress Unicast Queue Groups
OPEN_BST_INGRESS_PORT_PG_DATA_t
Buffer Count for Ingress Port + Priority Groups
_open_ippg_data_
OPEN_BST_INGRESS_PORT_PG_THRESHOLD_t
Profile configuration for Ingress Port + Priority Groups
OPEN_BST_INGRESS_PORT_SP_DATA_t
Buffer Count for Ingress Port + Service Pools
_open_ipsp_data_
OPEN_BST_INGRESS_PORT_SP_THRESHOLD_t
Profile configuration for Ingress Port + Service Pools
OPEN_BST_INGRESS_SP_DATA_t
Buffer Count for Ingress Service Pools
_open_isp_data_
OPEN_BST_INGRESS_SP_THRESHOLD_t
Profile configuration for Ingress Service Pools
OPEN_BST_TRIGGER_INFO_t
open_buffdesc
OPEN_COUNTER_STATS_t
OPEN_CPU_PERIOD_UTIL_INFO_t
open_dhcp_option125_t
OPEN_DHCP_SERVER_CLIENT_ID_t
DHCP client ID
OPEN_DHCP_SERVER_POOL_NAME_t
DHCP Pool name
OPEN_DHCP_SERVER_POOL_VRF_NAME_t
DHCP Pool's VRF-name
open_dhcp_vendor_specific_option_t
open_dhcp_vendor_sub_opt_t
OPEN_DOT1AS_CLOCK_IDENTITY_t
OPEN_DOT1CB_GLOBAL_STATS_t
OPEN_DOT1CB_INTF_STATS_t
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
OPEN_FT_PORT_MASK_t
open_hash_egress_obj_s
open_hashPktInfo_s
open_in6_addr_s
Hash Mode names
open_inet_addr_s
open_inet_pfx_s
OPEN_IPV4DT_CLEAR_REQUEST_s
OPEN_IPV4DT_ENTRIES_COUNT_s
OPEN_IPV4DT_ENTRY_s
OPEN_IPV4DT_SHOW_REQUEST_s
open_l2ol3AccessPortInfo_t
Access Port Entry Information
open_l2ol3ErrorStats_t
Overlay Failure Statistics Information
open_l2ol3L2FwdEntry_t
Tenant Forwarding Entry Information
open_l2ol3ResourceLimits_t
Overlay Global Resource Limits
open_l2ol3ResourceStats_t
Overlay Global Statistics Information
open_l2ol3TenantConfig_t
Tenant Configuration Information
open_l2ol3TunnelInfo_t
Tunnel Port Entry Information
open_l2ol3TunnelStats_t
Tunnel Counters Information
open_l2ol3TunnelStatus_t
Tunnel Status Information
OPEN_LLDP_MED_CAPABILITIES_t
OPEN_METER_ENTRY_t
OPEN_METER_STATS_t
OPEN_MPLS_LABELS_t
OPEN_MPLS_TUNNEL_INITIATOR_t
MPLS tunnel initiator informaton
OPEN_MSRP_RESERVATION_INFO_t
OPEN_MSRP_STEAM_INFO_t
open_pt_5_tuple_params_s_
OPEN_PT_DROP_REASON_MASK_t
OPEN_PT_LOOKUP_RESULT_MASK_t
Lookup result set bit map
OPEN_PT_PACKET_t
Packet Including Checksum
open_revision_data_t
OPEN_SNMP_COMMUNITY_s
OPEN_SNMP_TRAP_CONFIG_s
open_sysExtAgentPktRxDesc_t
OPEN_SYSTEM_COSQ_HWQ_MAP_t
Structure of cosq H/W queue map
OPEN_SYSTEM_COSQ_HWQ_MAP_V2_t
Structure of cosq H/W queue map version 2
OPEN_SYSTEM_PORT_COSQ_HWQ_MAP_t
Structure of port-cosq-hwqueue map
OPEN_SYSTEM_PORT_COSQ_HWQ_MAP_V2_t
Structure of port-cosq-hwqueue map version 2
OPEN_TCAM_ACTION_t
Structure to define the action that should be taken
open_tcam_version_t
Version information for the TCAM API
open_tcamHardwareGroupUsage_s
Hardware TCAM group usage information
open_tcamHardwarePolicyUsage_s
Hardware TCAM Policy Usage Information
OPEN_TIMERANGE_DATE_AND_TIME_s
OPEN_TIMERANGE_PERIODIC_ENTRY_s
open_tlv_option_t
open_USP_t
OPEN_VLAN_LIST_t
openapiClientHandle_s
openapiEventList_t
openapiTrapLogEntry_t
openBfdEndpoint_s
openBfdSessionInfo_s
The BFD Session data
openBfdSessionKey_s
The key into the BFD database
openBfdSessionStats_s
openEcmpRouteProtocolCount_s
openNextHop_s
openrBestRouteChangeMsg_s
Message structure for forwarding table change notifications
openRmMatchParams_s
openRmSetParams_s
openRoute_s
openRouteChange_s
openRouteChangeList_s
openRouteStats_s
openrPolicyChangeMsg_s
openrRouterEventMsg_s
syncdbClientHandle_t
Syncdb Client Handle
syncdbClientStatus_t
Client Table Status
syncdbDataTableStatus_t
Data Table Status
syncdbJsonNode_s
The JSON node definition
tcam_api_policyHeader_s
Header that goes on the front of each policy
© 2022 by Broadcom. All rights reserved.