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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 option version = "2.1.0";
18 import "vnet/interface_types.api";
19 import "vnet/ip/ip_types.api";
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
33 define vxlan_add_del_tunnel
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;
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
61 define vxlan_add_del_tunnel_v2
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;
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
92 define vxlan_add_del_tunnel_v3
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;
104 u32 decap_next_index;
106 bool is_l3 [default=false];
109 define vxlan_add_del_tunnel_reply
113 vl_api_interface_index_t sw_if_index;
115 define vxlan_add_del_tunnel_v2_reply
119 vl_api_interface_index_t sw_if_index;
121 define vxlan_add_del_tunnel_v3_reply
125 vl_api_interface_index_t sw_if_index;
128 define vxlan_tunnel_dump
132 vl_api_interface_index_t sw_if_index;
134 define vxlan_tunnel_v2_dump
138 vl_api_interface_index_t sw_if_index;
141 define vxlan_tunnel_details
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;
150 u32 decap_next_index;
153 define vxlan_tunnel_v2_details
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;
164 u32 decap_next_index;
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
175 autoreply define sw_interface_set_vxlan_bypass
179 vl_api_interface_index_t sw_if_index;
181 bool enable [default=true];
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
191 autoreply define vxlan_offload_rx
195 vl_api_interface_index_t hw_if_index;
196 vl_api_interface_index_t sw_if_index;
197 bool enable [default=true];