FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
vxlan.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 option version = "2.0.0";
17 
18 import "vnet/interface_types.api";
19 import "vnet/ip/ip_types.api";
20 
21 /** \brief Create or delete a VXLAN tunnel
22  @param client_index - opaque cookie to identify the sender
23  @param context - sender context, to match reply w/ request
24  @param is_add - Use 1 to create the tunnel, 0 to remove it
25  @param instance - optional unique custom device instance, else ~0.
26  @param src_address - Source IP address
27  @param dst_address - Destination IP address, can be multicast
28  @param mcast_sw_if_index - Interface for multicast destination
29  @param encap_vrf_id - Encap route table FIB index
30  @param decap_next_index - index of decap next graph node
31  @param vni - The VXLAN Network Identifier, uint24
32 */
33 define vxlan_add_del_tunnel
34 {
37  bool is_add [default=true];
38  u32 instance; /* If non-~0, specifies a custom dev instance */
39  vl_api_address_t src_address;
40  vl_api_address_t dst_address;
41  vl_api_interface_index_t mcast_sw_if_index;
45 };
46 
47 define vxlan_add_del_tunnel_reply
48 {
51  vl_api_interface_index_t sw_if_index;
52 };
53 
54 define vxlan_tunnel_dump
55 {
58  vl_api_interface_index_t sw_if_index;
59 };
60 
61 define vxlan_tunnel_details
62 {
64  vl_api_interface_index_t sw_if_index;
66  vl_api_address_t src_address;
67  vl_api_address_t dst_address;
68  vl_api_interface_index_t mcast_sw_if_index;
72 };
73 
74 /** \brief Interface set vxlan-bypass request
75  @param client_index - opaque cookie to identify the sender
76  @param context - sender context, to match reply w/ request
77  @param sw_if_index - interface used to reach neighbor
78  @param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
79  @param enable - if non-zero enable, else disable
80 */
81 autoreply define sw_interface_set_vxlan_bypass
82 {
85  vl_api_interface_index_t sw_if_index;
86  bool is_ipv6;
87  bool enable [default=true];
88 };
89 
90 /** \brief Offload vxlan rx request
91  @param client_index - opaque cookie to identify the sender
92  @param context - sender context, to match reply w/ request
93  @param hw_if_index - rx hw interface
94  @param sw_if_index - vxlan interface to offload
95  @param enable - if non-zero enable, else disable
96 */
97 autoreply define vxlan_offload_rx
98 {
101  vl_api_interface_index_t hw_if_index;
102  vl_api_interface_index_t sw_if_index;
103  bool enable [default=true];
104 };
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:58
vl_api_address_t src_address
Definition: vxlan.api:39
unsigned int u32
Definition: types.h:88
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:68
vl_api_address_t src_address
Definition: vxlan.api:66
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:51
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:102
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:85
option version
Definition: vxlan.api:16
vl_api_address_t dst_address
Definition: vxlan.api:67
signed int i32
Definition: types.h:77
vl_api_interface_index_t hw_if_index
Definition: vxlan.api:101
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:64
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:41
vl_api_address_t dst_address
Definition: vxlan.api:40