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 decap_next_index - Name of decap next graph node
  27     @param vni - The VXLAN Network Identifier, uint24
  28     @param sw_ifindex - Ignored in add message, set in details
  29 */
  30 typedef vxlan_gbp_tunnel
  31 {
  32   u32 instance;
  33   vl_api_address_t src;
  34   vl_api_address_t dst;
  35   u32 mcast_sw_if_index;
  36   u32 encap_table_id;
  37   u32 decap_next_index;
  38   u32 vni;
  39   u32 sw_if_index;
  40 };
  41
  42 /** \brief Create or delete a VXLAN-GBP tunnel
  43     @param client_index - opaque cookie to identify the sender
  44     @param context - sender context, to match reply w/ request
  45     @param is_add - Use 1 to create the tunnel, 0 to remove it
  46 */
  47 define vxlan_gbp_tunnel_add_del
  48 {
  49   u32 client_index;
  50   u32 context;
  51   u8 is_add;
  52   vl_api_vxlan_gbp_tunnel_t tunnel;
  53 };
  54
  55 define vxlan_gbp_tunnel_add_del_reply
  56 {
  57   u32 context;
  58   i32 retval;
  59   u32 sw_if_index;
  60 };
  61
  62 define vxlan_gbp_tunnel_dump
  63 {
  64   u32 client_index;
  65   u32 context;
  66   u32 sw_if_index;
  67 };
  68
  69 define vxlan_gbp_tunnel_details
  70 {
  71   u32 context;
  72   vl_api_vxlan_gbp_tunnel_t tunnel;
  73 };
  74
  75 /** \brief Interface set vxlan-bypass request
  76     @param client_index - opaque cookie to identify the sender
  77     @param context - sender context, to match reply w/ request
  78     @param sw_if_index - interface used to reach neighbor
  79     @param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
  80     @param enable - if non-zero enable, else disable
  81 */
  82 autoreply define sw_interface_set_vxlan_gbp_bypass
  83 {
  84   u32 client_index;
  85   u32 context;
  86   u32 sw_if_index;
  87   u8 is_ipv6;
  88   u8 enable;
  89 };
  90