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 define vxlan_add_del_tunnel_reply
81 vl_api_interface_index_t sw_if_index;
83 define vxlan_add_del_tunnel_v2_reply
87 vl_api_interface_index_t sw_if_index;
90 define vxlan_tunnel_dump
94 vl_api_interface_index_t sw_if_index;
96 define vxlan_tunnel_v2_dump
100 vl_api_interface_index_t sw_if_index;
103 define vxlan_tunnel_details
106 vl_api_interface_index_t sw_if_index;
108 vl_api_address_t src_address;
109 vl_api_address_t dst_address;
110 vl_api_interface_index_t mcast_sw_if_index;
112 u32 decap_next_index;
115 define vxlan_tunnel_v2_details
118 vl_api_interface_index_t sw_if_index;
120 vl_api_address_t src_address;
121 vl_api_address_t dst_address;
124 vl_api_interface_index_t mcast_sw_if_index;
126 u32 decap_next_index;
130 /** \brief Interface set vxlan-bypass request
131 @param client_index - opaque cookie to identify the sender
132 @param context - sender context, to match reply w/ request
133 @param sw_if_index - interface used to reach neighbor
134 @param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
135 @param enable - if non-zero enable, else disable
137 autoreply define sw_interface_set_vxlan_bypass
141 vl_api_interface_index_t sw_if_index;
143 bool enable [default=true];
146 /** \brief Offload vxlan rx request
147 @param client_index - opaque cookie to identify the sender
148 @param context - sender context, to match reply w/ request
149 @param hw_if_index - rx hw interface
150 @param sw_if_index - vxlan interface to offload
151 @param enable - if non-zero enable, else disable
153 autoreply define vxlan_offload_rx
157 vl_api_interface_index_t hw_if_index;
158 vl_api_interface_index_t sw_if_index;
159 bool enable [default=true];