src/vnet/vxlan-gbp/vxlan_gbp.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2018 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 = "1.1.0";
  18 import "vnet/ip/ip_types.api";
  19
  20 /** \brief Definition of a VXLAN GBP tunnel
  21     @param instance - optional unique custom device instance, else ~0.
  22     @param src - Source IP address
  23     @param dst - Destination IP address, can be multicast
  24     @param mcast_sw_if_index - Interface for multicast destination
  25     @param encap_table_id - Encap route table
  26     @param vni - The VXLAN Network Identifier, uint24
  27     @param sw_ifindex - Ignored in add message, set in details
  28 */
  29 typedef vxlan_gbp_tunnel
  30 {
  31   u32 instance;
  32   vl_api_address_t src;
  33   vl_api_address_t dst;
  34   u32 mcast_sw_if_index;
  35   u32 encap_table_id;
  36   u32 vni;
  37   u32 sw_if_index;
  38 };
  39
  40 /** \brief Create or delete a VXLAN-GBP tunnel
  41     @param client_index - opaque cookie to identify the sender
  42     @param context - sender context, to match reply w/ request
  43     @param is_add - Use 1 to create the tunnel, 0 to remove it
  44 */
  45 define vxlan_gbp_tunnel_add_del
  46 {
  47   u32 client_index;
  48   u32 context;
  49   u8 is_add;
  50   vl_api_vxlan_gbp_tunnel_t tunnel;
  51 };
  52
  53 define vxlan_gbp_tunnel_add_del_reply
  54 {
  55   u32 context;
  56   i32 retval;
  57   u32 sw_if_index;
  58 };
  59
  60 define vxlan_gbp_tunnel_dump
  61 {
  62   u32 client_index;
  63   u32 context;
  64   u32 sw_if_index;
  65 };
  66
  67 define vxlan_gbp_tunnel_details
  68 {
  69   u32 context;
  70   vl_api_vxlan_gbp_tunnel_t tunnel;
  71 };
  72
  73 /** \brief Interface set vxlan-bypass request
  74     @param client_index - opaque cookie to identify the sender
  75     @param context - sender context, to match reply w/ request
  76     @param sw_if_index - interface used to reach neighbor
  77     @param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
  78     @param enable - if non-zero enable, else disable
  79 */
  80 autoreply define sw_interface_set_vxlan_gbp_bypass
  81 {
  82   u32 client_index;
  83   u32 context;
  84   u32 sw_if_index;
  85   u8 is_ipv6;
  86   u8 enable;
  87 };
  88