src/vnet/gre/gre.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2015-2019 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 option version = "2.0.1";
  18
  19 import "vnet/interface_types.api";
  20 import "vnet/ip/ip_types.api";
  21
  22 /** \brief A GRE tunnel type
  23 */
  24 enum gre_tunnel_type : u8
  25 {
  26   GRE_API_TUNNEL_TYPE_L3 = 0,
  27   GRE_API_TUNNEL_TYPE_TEB,
  28   GRE_API_TUNNEL_TYPE_ERSPAN,
  29 };
  30
  31 /** \brief A GRE tunnel mode
  32 */
  33 enum gre_tunnel_mode : u8
  34 {
  35   /* point-to-point */
  36   GRE_API_TUNNEL_MODE_P2P,
  37   /* multi-point */
  38   GRE_API_TUNNEL_MODE_MP,
  39 };
  40
  41 /** \brief A GRE tunnel
  42     @param client_index - opaque cookie to identify the sender
  43     @param context - sender context, to match reply w/ request
  44     @param tunnel_type - 0: L3, 1: TEB, 2: ERSPAN
  45     @param instance - optional unique custom device instance, else ~0.
  46     @param src - Source IP address
  47     @param dst - Destination IP address, can be multicast
  48     @param outer_table_id - Encap FIB table ID
  49     @param session_id - session for ERSPAN tunnel, range 0-1023
  50     @param sw_if_index - ignored on create/delete, present in details.
  51 */
  52 typedef gre_tunnel
  53 {
  54   vl_api_gre_tunnel_type_t type;
  55   vl_api_gre_tunnel_mode_t mode;
  56   u16 session_id;
  57   u32 instance;
  58   u32 outer_table_id;
  59   vl_api_interface_index_t sw_if_index;
  60   vl_api_address_t src;
  61   vl_api_address_t dst;
  62 };
  63
  64 define gre_tunnel_add_del
  65 {
  66   u32 client_index;
  67   u32 context;
  68   bool is_add;
  69   vl_api_gre_tunnel_t tunnel;
  70 };
  71
  72 define gre_tunnel_add_del_reply
  73 {
  74   u32 context;
  75   i32 retval;
  76   vl_api_interface_index_t sw_if_index;
  77 };
  78
  79 define gre_tunnel_dump
  80 {
  81   u32 client_index;
  82   u32 context;
  83   vl_api_interface_index_t sw_if_index;
  84 };
  85
  86 define gre_tunnel_details
  87 {
  88   u32 context;
  89   vl_api_gre_tunnel_t tunnel;
  90 };
  91
  92 /*
  93  * Local Variables:
  94  * eval: (c-set-style "gnu")
  95  * End:
  96  */