FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
vxlan_gbp.api
Go to the documentation of this file.
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.1";
18 import "vnet/ip/ip_types.api";
19 import "vnet/interface_types.api";
20 
22 {
25 };
26 
27 /** \brief Definition of a VXLAN GBP tunnel
28  @param instance - optional unique custom device instance, else ~0.
29  @param src - Source IP address
30  @param dst - Destination IP address, can be multicast
31  @param mcast_sw_if_index - Interface for multicast destination
32  @param encap_table_id - Encap route table
33  @param vni - The VXLAN Network Identifier, uint24
34  @param sw_ifindex - Ignored in add message, set in details
35 */
36 typedef vxlan_gbp_tunnel
37 {
38  u32 instance;
39  vl_api_address_t src;
40  vl_api_address_t dst;
41  vl_api_interface_index_t mcast_sw_if_index;
44  vl_api_interface_index_t sw_if_index;
45  vl_api_vxlan_gbp_api_tunnel_mode_t mode;
46 };
47 
48 /** \brief Create or delete a VXLAN-GBP tunnel
49  @param client_index - opaque cookie to identify the sender
50  @param context - sender context, to match reply w/ request
51  @param is_add - Use 1 to create the tunnel, 0 to remove it
52 */
53 define vxlan_gbp_tunnel_add_del
54 {
57  bool is_add [default=true];
58  vl_api_vxlan_gbp_tunnel_t tunnel;
59 };
60 
61 define vxlan_gbp_tunnel_add_del_reply
62 {
65  vl_api_interface_index_t sw_if_index;
66 };
67 
68 define vxlan_gbp_tunnel_dump
69 {
72  vl_api_interface_index_t sw_if_index;
73 };
74 
75 define vxlan_gbp_tunnel_details
76 {
78  vl_api_vxlan_gbp_tunnel_t tunnel;
79 };
80 
81 /** \brief Interface set vxlan-bypass request
82  @param client_index - opaque cookie to identify the sender
83  @param context - sender context, to match reply w/ request
84  @param sw_if_index - interface used to reach neighbor
85  @param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
86  @param enable - if non-zero enable, else disable
87 */
88 autoreply define sw_interface_set_vxlan_gbp_bypass
89 {
92  vl_api_interface_index_t sw_if_index;
93  bool is_ipv6;
94  bool enable [default=true];
95 };
vl_api_vxlan_gbp_tunnel_t tunnel
Definition: vxlan_gbp.api:58
vl_api_address_t src
Definition: vxlan_gbp.api:39
u32 encap_table_id
Definition: vxlan_gbp.api:42
vl_api_interface_index_t sw_if_index
Definition: vxlan_gbp.api:44
vl_api_vxlan_gbp_tunnel_t tunnel
Definition: vxlan_gbp.api:78
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan_gbp.api:41
unsigned int u32
Definition: types.h:88
vxlan_gbp_api_tunnel_mode
Definition: vxlan_gbp.api:21
option version
Definition: vxlan_gbp.api:17
vl_api_address_t dst
Definition: vxlan_gbp.api:40
vl_api_vxlan_gbp_api_tunnel_mode_t mode
Definition: vxlan_gbp.api:45
vl_api_interface_index_t sw_if_index
Definition: vxlan_gbp.api:72
signed int i32
Definition: types.h:77
vl_api_interface_index_t sw_if_index
Definition: vxlan_gbp.api:65
vl_api_interface_index_t sw_if_index
Definition: vxlan_gbp.api:92
u32 instance
Definition: gre.api:57
u32 vni
Definition: vxlan_gbp.api:43
typedef vxlan_gbp_tunnel
Definition of a VXLAN GBP tunnel.
Definition: vxlan_gbp.api:37