FD.io VPP  v21.10.1-2-g0a485f517
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.1.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 /** \brief Create or delete a VXLAN tunnel
48  @param client_index - opaque cookie to identify the sender
49  @param context - sender context, to match reply w/ request
50  @param is_add - Use 1 to create the tunnel, 0 to remove it
51  @param instance - optional unique custom device instance, else ~0.
52  @param src_address - Source IP address
53  @param dst_address - Destination IP address, can be multicast
54  @param src_port - Source UDP port. It is not included in sent packets. Used only for port registration
55  @param dst_port - Destination UDP port
56  @param mcast_sw_if_index - Interface for multicast destination
57  @param encap_vrf_id - Encap route table FIB index
58  @param decap_next_index - index of decap next graph node
59  @param vni - The VXLAN Network Identifier, uint24
60 */
61 define vxlan_add_del_tunnel_v2
62 {
65  bool is_add [default=true];
66  u32 instance [default=0xffffffff]; /* If non-~0, specifies a custom dev instance */
67  vl_api_address_t src_address;
68  vl_api_address_t dst_address;
71  vl_api_interface_index_t mcast_sw_if_index;
75 };
76 
77 /** \brief Create or delete a VXLAN tunnel
78  @param client_index - opaque cookie to identify the sender
79  @param context - sender context, to match reply w/ request
80  @param is_add - Use 1 to create the tunnel, 0 to remove it
81  @param instance - optional unique custom device instance, else ~0.
82  @param src_address - Source IP address
83  @param dst_address - Destination IP address, can be multicast
84  @param src_port - Source UDP port. It is not included in sent packets. Used only for port registration
85  @param dst_port - Destination UDP port
86  @param mcast_sw_if_index - Interface for multicast destination
87  @param encap_vrf_id - Encap route table FIB index
88  @param decap_next_index - index of decap next graph node
89  @param vni - The VXLAN Network Identifier, uint24
90  @param is_l3 - if true, create the interface in L3 mode, w/o MAC
91 */
92 define vxlan_add_del_tunnel_v3
93 {
96  bool is_add [default=true];
97  u32 instance [default=0xffffffff]; /* If non-~0, specifies a custom dev instance */
98  vl_api_address_t src_address;
99  vl_api_address_t dst_address;
102  vl_api_interface_index_t mcast_sw_if_index;
106  bool is_l3 [default=false];
107 };
108 
109 define vxlan_add_del_tunnel_reply
110 {
113  vl_api_interface_index_t sw_if_index;
114 };
115 define vxlan_add_del_tunnel_v2_reply
116 {
119  vl_api_interface_index_t sw_if_index;
120 };
121 define vxlan_add_del_tunnel_v3_reply
122 {
125  vl_api_interface_index_t sw_if_index;
126 };
127 
128 define vxlan_tunnel_dump
129 {
132  vl_api_interface_index_t sw_if_index;
133 };
134 define vxlan_tunnel_v2_dump
135 {
138  vl_api_interface_index_t sw_if_index;
139 };
140 
141 define vxlan_tunnel_details
142 {
144  vl_api_interface_index_t sw_if_index;
146  vl_api_address_t src_address;
147  vl_api_address_t dst_address;
148  vl_api_interface_index_t mcast_sw_if_index;
152 };
153 define vxlan_tunnel_v2_details
154 {
156  vl_api_interface_index_t sw_if_index;
158  vl_api_address_t src_address;
159  vl_api_address_t dst_address;
162  vl_api_interface_index_t mcast_sw_if_index;
166 };
167 
168 /** \brief Interface set vxlan-bypass request
169  @param client_index - opaque cookie to identify the sender
170  @param context - sender context, to match reply w/ request
171  @param sw_if_index - interface used to reach neighbor
172  @param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
173  @param enable - if non-zero enable, else disable
174 */
175 autoreply define sw_interface_set_vxlan_bypass
176 {
179  vl_api_interface_index_t sw_if_index;
180  bool is_ipv6;
181  bool enable [default=true];
182 };
183 
184 /** \brief Offload vxlan rx request
185  @param client_index - opaque cookie to identify the sender
186  @param context - sender context, to match reply w/ request
187  @param hw_if_index - rx hw interface
188  @param sw_if_index - vxlan interface to offload
189  @param enable - if non-zero enable, else disable
190 */
191 autoreply define vxlan_offload_rx
192 {
195  vl_api_interface_index_t hw_if_index;
196  vl_api_interface_index_t sw_if_index;
197  bool enable [default=true];
198 };
vl_api_vxlan_add_del_tunnel_v3_reply_t::context
u32 context
Definition: vxlan.api:123
vl_api_vxlan_add_del_tunnel_t::vni
u32 vni
Definition: vxlan.api:44
vl_api_sw_interface_set_vxlan_bypass_t
Interface set vxlan-bypass request.
Definition: vxlan.api:175
vl_api_vxlan_add_del_tunnel_reply_t::retval
i32 retval
Definition: vxlan.api:112
vl_api_vxlan_tunnel_v2_details_t::decap_next_index
u32 decap_next_index
Definition: vxlan.api:164
vl_api_vxlan_add_del_tunnel_v3_t::is_add
bool is_add[default=true]
Definition: vxlan.api:96
vl_api_vxlan_tunnel_details_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:144
vl_api_vxlan_add_del_tunnel_v3_t::dst_port
u16 dst_port
Definition: vxlan.api:101
vl_api_vxlan_tunnel_v2_details_t::dst_port
u16 dst_port
Definition: vxlan.api:161
vl_api_vxlan_add_del_tunnel_v3_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:125
vl_api_vxlan_add_del_tunnel_t::src_address
vl_api_address_t src_address
Definition: vxlan.api:39
vl_api_vxlan_add_del_tunnel_reply_t
Definition: vxlan.api:109
vl_api_vxlan_add_del_tunnel_v3_t::dst_address
vl_api_address_t dst_address
Definition: vxlan.api:99
vl_api_sw_interface_set_vxlan_bypass_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:179
vl_api_vxlan_tunnel_details_t::context
u32 context
Definition: vxlan.api:143
vl_api_vxlan_tunnel_v2_dump_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:138
vl_api_vxlan_tunnel_v2_details_t::context
u32 context
Definition: vxlan.api:155
vl_api_vxlan_add_del_tunnel_v2_t::encap_vrf_id
u32 encap_vrf_id
Definition: vxlan.api:72
vl_api_vxlan_tunnel_v2_dump_t
Definition: vxlan.api:134
vl_api_vxlan_add_del_tunnel_t::mcast_sw_if_index
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:41
vl_api_vxlan_add_del_tunnel_v3_t::encap_vrf_id
u32 encap_vrf_id
Definition: vxlan.api:103
vl_api_vxlan_add_del_tunnel_v2_t::dst_port
u16 dst_port
Definition: vxlan.api:70
u16
unsigned short u16
Definition: types.h:57
vl_api_vxlan_add_del_tunnel_v3_t::src_address
vl_api_address_t src_address
Definition: vxlan.api:98
vl_api_vxlan_add_del_tunnel_v2_reply_t::retval
i32 retval
Definition: vxlan.api:118
vl_api_vxlan_tunnel_v2_details_t::mcast_sw_if_index
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:162
vl_api_vxlan_tunnel_details_t::mcast_sw_if_index
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:148
vl_api_vxlan_add_del_tunnel_v2_t::client_index
u32 client_index
Definition: vxlan.api:63
i32
signed int i32
Definition: types.h:77
vl_api_vxlan_tunnel_v2_details_t::dst_address
vl_api_address_t dst_address
Definition: vxlan.api:159
vl_api_vxlan_add_del_tunnel_v3_t::src_port
u16 src_port
Definition: vxlan.api:100
vl_api_sw_interface_set_vxlan_bypass_t::context
u32 context
Definition: vxlan.api:178
vl_api_vxlan_add_del_tunnel_v3_t::instance
u32 instance[default=0xffffffff]
Definition: vxlan.api:97
vl_api_vxlan_add_del_tunnel_v3_t::vni
u32 vni
Definition: vxlan.api:105
vl_api_vxlan_add_del_tunnel_v3_t::mcast_sw_if_index
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:102
vl_api_vxlan_add_del_tunnel_v2_t::is_add
bool is_add[default=true]
Definition: vxlan.api:65
vl_api_vxlan_add_del_tunnel_v3_t::is_l3
bool is_l3[default=false]
Definition: vxlan.api:106
vl_api_vxlan_offload_rx_t
Offload vxlan rx request.
Definition: vxlan.api:191
vl_api_vxlan_tunnel_v2_details_t::instance
u32 instance
Definition: vxlan.api:157
vl_api_vxlan_tunnel_details_t::src_address
vl_api_address_t src_address
Definition: vxlan.api:146
vl_api_vxlan_add_del_tunnel_t::context
u32 context
Definition: vxlan.api:36
vl_api_vxlan_tunnel_v2_dump_t::client_index
u32 client_index
Definition: vxlan.api:136
vl_api_vxlan_tunnel_details_t::encap_vrf_id
u32 encap_vrf_id
Definition: vxlan.api:149
vl_api_vxlan_offload_rx_t::client_index
u32 client_index
Definition: vxlan.api:193
vl_api_vxlan_add_del_tunnel_v2_reply_t
Definition: vxlan.api:115
vl_api_vxlan_tunnel_v2_details_t::encap_vrf_id
u32 encap_vrf_id
Definition: vxlan.api:163
vl_api_vxlan_tunnel_dump_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:132
vl_api_vxlan_tunnel_v2_dump_t::context
u32 context
Definition: vxlan.api:137
vl_api_vxlan_tunnel_details_t::dst_address
vl_api_address_t dst_address
Definition: vxlan.api:147
vl_api_vxlan_offload_rx_t::hw_if_index
vl_api_interface_index_t hw_if_index
Definition: vxlan.api:195
vl_api_vxlan_add_del_tunnel_v2_t::context
u32 context
Definition: vxlan.api:64
vl_api_vxlan_tunnel_details_t::vni
u32 vni
Definition: vxlan.api:151
version
option version
Definition: vxlan.api:16
vl_api_vxlan_add_del_tunnel_v2_t::mcast_sw_if_index
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:71
vl_api_vxlan_tunnel_details_t::decap_next_index
u32 decap_next_index
Definition: vxlan.api:150
vl_api_vxlan_offload_rx_t::enable
bool enable[default=true]
Definition: vxlan.api:197
vl_api_vxlan_add_del_tunnel_t
Create or delete a VXLAN tunnel.
Definition: vxlan.api:33
vl_api_vxlan_tunnel_dump_t::context
u32 context
Definition: vxlan.api:131
vl_api_vxlan_tunnel_dump_t::client_index
u32 client_index
Definition: vxlan.api:130
vl_api_vxlan_tunnel_v2_details_t
Definition: vxlan.api:153
vl_api_vxlan_add_del_tunnel_v2_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:119
vl_api_vxlan_add_del_tunnel_v2_t::decap_next_index
u32 decap_next_index
Definition: vxlan.api:73
vl_api_vxlan_add_del_tunnel_v3_t::decap_next_index
u32 decap_next_index
Definition: vxlan.api:104
vl_api_vxlan_add_del_tunnel_v3_reply_t::retval
i32 retval
Definition: vxlan.api:124
u32
unsigned int u32
Definition: types.h:88
vl_api_vxlan_tunnel_v2_details_t::src_port
u16 src_port
Definition: vxlan.api:160
vl_api_vxlan_add_del_tunnel_t::dst_address
vl_api_address_t dst_address
Definition: vxlan.api:40
vl_api_sw_interface_set_vxlan_bypass_t::is_ipv6
bool is_ipv6
Definition: vxlan.api:180
vl_api_vxlan_add_del_tunnel_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:113
vl_api_sw_interface_set_vxlan_bypass_t::enable
bool enable[default=true]
Definition: vxlan.api:181
vl_api_vxlan_tunnel_v2_details_t::src_address
vl_api_address_t src_address
Definition: vxlan.api:158
vl_api_vxlan_add_del_tunnel_t::instance
u32 instance
Definition: vxlan.api:38
instance
u32 instance
Definition: gre.api:51
vl_api_vxlan_add_del_tunnel_v2_t::instance
u32 instance[default=0xffffffff]
Definition: vxlan.api:66
vl_api_vxlan_add_del_tunnel_t::client_index
u32 client_index
Definition: vxlan.api:35
vl_api_vxlan_add_del_tunnel_v3_t::context
u32 context
Definition: vxlan.api:95
vl_api_vxlan_add_del_tunnel_v2_t::src_port
u16 src_port
Definition: vxlan.api:69
vl_api_vxlan_add_del_tunnel_v2_t::vni
u32 vni
Definition: vxlan.api:74
vl_api_vxlan_add_del_tunnel_v2_reply_t::context
u32 context
Definition: vxlan.api:117
vl_api_vxlan_add_del_tunnel_v2_t::src_address
vl_api_address_t src_address
Definition: vxlan.api:67
vl_api_vxlan_offload_rx_t::context
u32 context
Definition: vxlan.api:194
vl_api_vxlan_offload_rx_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:196
vl_api_vxlan_add_del_tunnel_v2_t
Create or delete a VXLAN tunnel.
Definition: vxlan.api:61
vl_api_vxlan_add_del_tunnel_t::encap_vrf_id
u32 encap_vrf_id
Definition: vxlan.api:42
vl_api_vxlan_add_del_tunnel_t::decap_next_index
u32 decap_next_index
Definition: vxlan.api:43
vl_api_vxlan_add_del_tunnel_t::is_add
bool is_add[default=true]
Definition: vxlan.api:37
vl_api_vxlan_tunnel_details_t
Definition: vxlan.api:141
vl_api_vxlan_tunnel_dump_t
Definition: vxlan.api:128
vl_api_vxlan_add_del_tunnel_v3_t
Create or delete a VXLAN tunnel.
Definition: vxlan.api:92
vl_api_vxlan_add_del_tunnel_reply_t::context
u32 context
Definition: vxlan.api:111
vl_api_vxlan_add_del_tunnel_v3_t::client_index
u32 client_index
Definition: vxlan.api:94
vl_api_vxlan_tunnel_v2_details_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:156
vl_api_vxlan_add_del_tunnel_v2_t::dst_address
vl_api_address_t dst_address
Definition: vxlan.api:68
vl_api_vxlan_add_del_tunnel_v3_reply_t
Definition: vxlan.api:121
vl_api_vxlan_tunnel_v2_details_t::vni
u32 vni
Definition: vxlan.api:165
vl_api_sw_interface_set_vxlan_bypass_t::client_index
u32 client_index
Definition: vxlan.api:177
vl_api_vxlan_tunnel_details_t::instance
u32 instance
Definition: vxlan.api:145