src/vnet/gre/gre.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2015-2020 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.1.0";
  18
  19 import "vnet/interface_types.api";
  20 import "vnet/tunnel/tunnel_types.api";
  21 import "vnet/ip/ip_types.api";
  22
  23 /** \brief A GRE tunnel type
  24 */
  25 enum gre_tunnel_type : u8
  26 {
  27   GRE_API_TUNNEL_TYPE_L3 = 0,
  28   /* L2 Transparent Ethernet Bridge */
  29   GRE_API_TUNNEL_TYPE_TEB,
  30   /* Encapsulated Remote Switched Port ANalyzer */
  31   GRE_API_TUNNEL_TYPE_ERSPAN,
  32 };
  33
  34 /** \brief A composite type uniquely defining a GRE tunnel.
  35     @param type - tunnel type (see enum definition), 0: L3, 1: TEB, 2: ERSPAN
  36     @param mode - P2P or P2MP
  37     @param flags - to control encap/decap behaviour
  38     @param session_id - session for ERSPAN tunnel, range 0-1023
  39     @param instance - optional unique custom device instance, else ~0.
  40     @param outer_table_id - Encap FIB table ID
  41     @param sw_if_index - ignored on create/delete, present in details.
  42     @param src - Source IP address
  43     @param dst - Destination IP address, can be multicast
  44 */
  45 typedef gre_tunnel
  46 {
  47   vl_api_gre_tunnel_type_t type;
  48   vl_api_tunnel_mode_t mode;
  49   vl_api_tunnel_encap_decap_flags_t flags;
  50   u16 session_id;
  51   u32 instance;
  52   u32 outer_table_id;
  53   vl_api_interface_index_t sw_if_index;
  54   vl_api_address_t src;
  55   vl_api_address_t dst;
  56 };
  57
  58 /** \brief Add or delete a single GRE tunnel.
  59     @param client_index - opaque cookie to identify the sender.
  60     @param context - sender context, to match reply w/ request.
  61     @param is_add - add if true, delete if false.
  62     @param tunnel - tunnel definition to add or delete.
  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 /** \brief Add or delete a single GRE tunnel.
  73     @param context - sender context, to match reply w/ request.
  74     @param retval - return code for the request.
  75     @param sw_if_index - the interface corresponding to the affected tunnel.
  76 */
  77 define gre_tunnel_add_del_reply
  78 {
  79   u32 context;
  80   i32 retval;
  81   vl_api_interface_index_t sw_if_index;
  82 };
  83
  84 /** \brief Dump details of all or just a single GRE tunnel.
  85     @param client_index - opaque cookie to identify the sender.
  86     @param context - sender context, to match reply w/ request.
  87     @param sw_if_index - filter for tunnel of this interface index, ~0 for all.
  88 */
  89 define gre_tunnel_dump
  90 {
  91   u32 client_index;
  92   u32 context;
  93   vl_api_interface_index_t sw_if_index;
  94 };
  95
  96 /** \brief Details response for one of the requested GRE tunnels.
  97     @param context - sender context, to match reply w/ request.
  98     @param tunnel - definition of the dumped tunnel.
  99 */
 100 define gre_tunnel_details
 101 {
 102   u32 context;
 103   vl_api_gre_tunnel_t tunnel;
 104 };
 105
 106 /*
 107  * Local Variables:
 108  * eval: (c-set-style "gnu")
 109  * End:
 110  */