SAI Metadata
Loading...
Searching...
No Matches
sairouterinterface.h File Reference

This module defines SAI Router interface. More...

#include <saitypes.h>

Go to the source code of this file.

Classes

struct  _sai_router_interface_api_t
 Routing interface methods table retrieved with sai_api_query() More...
 

Typedefs

typedef enum _sai_router_interface_type_t sai_router_interface_type_t
 Attribute data for SAI_ROUTER_INTERFACE_ATTR_TYPE.
 
typedef enum _sai_router_interface_attr_t sai_router_interface_attr_t
 Routing interface attribute IDs.
 
typedef enum _sai_router_interface_stat_t sai_router_interface_stat_t
 Router interface counter IDs in sai_get_router_interface_stats() call.
 
typedef sai_status_t(* sai_create_router_interface_fn) (_Out_ sai_object_id_t *router_interface_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
 Create router interface.
 
typedef sai_status_t(* sai_remove_router_interface_fn) (_In_ sai_object_id_t router_interface_id)
 Remove router interface.
 
typedef sai_status_t(* sai_set_router_interface_attribute_fn) (_In_ sai_object_id_t router_interface_id, _In_ const sai_attribute_t *attr)
 Set router interface attribute.
 
typedef sai_status_t(* sai_get_router_interface_attribute_fn) (_In_ sai_object_id_t router_interface_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
 Get router interface attribute.
 
typedef sai_status_t(* sai_get_router_interface_stats_fn) (_In_ sai_object_id_t router_interface_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _Out_ uint64_t *counters)
 Get router interface statistics counters. Deprecated for backward compatibility.
 
typedef sai_status_t(* sai_get_router_interface_stats_ext_fn) (_In_ sai_object_id_t router_interface_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _In_ sai_stats_mode_t mode, _Out_ uint64_t *counters)
 Get router interface statistics counters extended.
 
typedef sai_status_t(* sai_clear_router_interface_stats_fn) (_In_ sai_object_id_t router_interface_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids)
 Clear router interface statistics counters.
 
typedef struct _sai_router_interface_api_t sai_router_interface_api_t
 Routing interface methods table retrieved with sai_api_query()
 

Enumerations

enum  _sai_router_interface_type_t {
  SAI_ROUTER_INTERFACE_TYPE_PORT , SAI_ROUTER_INTERFACE_TYPE_VLAN , SAI_ROUTER_INTERFACE_TYPE_LOOPBACK , SAI_ROUTER_INTERFACE_TYPE_MPLS_ROUTER ,
  SAI_ROUTER_INTERFACE_TYPE_SUB_PORT , SAI_ROUTER_INTERFACE_TYPE_BRIDGE , SAI_ROUTER_INTERFACE_TYPE_QINQ_PORT
}
 Attribute data for SAI_ROUTER_INTERFACE_ATTR_TYPE. More...
 
enum  _sai_router_interface_attr_t {
  SAI_ROUTER_INTERFACE_ATTR_START , SAI_ROUTER_INTERFACE_ATTR_VIRTUAL_ROUTER_ID = SAI_ROUTER_INTERFACE_ATTR_START , SAI_ROUTER_INTERFACE_ATTR_TYPE , SAI_ROUTER_INTERFACE_ATTR_PORT_ID ,
  SAI_ROUTER_INTERFACE_ATTR_VLAN_ID , SAI_ROUTER_INTERFACE_ATTR_OUTER_VLAN_ID , SAI_ROUTER_INTERFACE_ATTR_INNER_VLAN_ID , SAI_ROUTER_INTERFACE_ATTR_BRIDGE_ID ,
  SAI_ROUTER_INTERFACE_ATTR_SRC_MAC_ADDRESS , SAI_ROUTER_INTERFACE_ATTR_ADMIN_V4_STATE , SAI_ROUTER_INTERFACE_ATTR_ADMIN_V6_STATE , SAI_ROUTER_INTERFACE_ATTR_MTU ,
  SAI_ROUTER_INTERFACE_ATTR_INGRESS_ACL , SAI_ROUTER_INTERFACE_ATTR_EGRESS_ACL , SAI_ROUTER_INTERFACE_ATTR_NEIGHBOR_MISS_PACKET_ACTION , SAI_ROUTER_INTERFACE_ATTR_V4_MCAST_ENABLE ,
  SAI_ROUTER_INTERFACE_ATTR_V6_MCAST_ENABLE , SAI_ROUTER_INTERFACE_ATTR_LOOPBACK_PACKET_ACTION , SAI_ROUTER_INTERFACE_ATTR_IS_VIRTUAL , SAI_ROUTER_INTERFACE_ATTR_NAT_ZONE_ID ,
  SAI_ROUTER_INTERFACE_ATTR_DISABLE_DECREMENT_TTL , SAI_ROUTER_INTERFACE_ATTR_ADMIN_MPLS_STATE , SAI_ROUTER_INTERFACE_ATTR_END , SAI_ROUTER_INTERFACE_ATTR_CUSTOM_RANGE_START = 0x10000000 ,
  SAI_ROUTER_INTERFACE_ATTR_CUSTOM_RANGE_END
}
 Routing interface attribute IDs. More...
 
enum  _sai_router_interface_stat_t {
  SAI_ROUTER_INTERFACE_STAT_IN_OCTETS , SAI_ROUTER_INTERFACE_STAT_IN_PACKETS , SAI_ROUTER_INTERFACE_STAT_OUT_OCTETS , SAI_ROUTER_INTERFACE_STAT_OUT_PACKETS ,
  SAI_ROUTER_INTERFACE_STAT_IN_ERROR_OCTETS , SAI_ROUTER_INTERFACE_STAT_IN_ERROR_PACKETS , SAI_ROUTER_INTERFACE_STAT_OUT_ERROR_OCTETS , SAI_ROUTER_INTERFACE_STAT_OUT_ERROR_PACKETS
}
 Router interface counter IDs in sai_get_router_interface_stats() call. More...
 

Detailed Description

This module defines SAI Router interface.

Copyright (c) 2014 Microsoft Open Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

THIS CODE IS PROVIDED ON AN AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.

See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.

Microsoft would like to thank the following companies for their review and assistance with these files: Intel Corporation, Mellanox Technologies Ltd, Dell Products, L.P., Facebook, Inc., Marvell International Ltd.

Definition in file sairouterinterface.h.