9e969de7bc56f4263cee21de3d404feb4317df05
[vpp.git] / src / vnet / vxlan / vxlan.api
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 = "1.1.0";
17
18 /** \brief Create or delete a VXLAN tunnel
19     @param client_index - opaque cookie to identify the sender
20     @param context - sender context, to match reply w/ request
21     @param is_add - Use 1 to create the tunnel, 0 to remove it
22     @param is_ipv6 - Use 0 for IPv4, 1 for IPv6
23     @param instance - optional unique custom device instance, else ~0.
24     @param src_address - Source IP address
25     @param dst_address - Destination IP address, can be multicast
26     @param mcast_sw_if_index - Interface for multicast destination
27     @param encap_vrf_id - Encap route table FIB index
28     @param decap_next_index - Name of decap next graph node
29     @param vni - The VXLAN Network Identifier, uint24
30 */
31 define vxlan_add_del_tunnel
32 {
33   u32 client_index;
34   u32 context;
35   u8 is_add;
36   u8 is_ipv6;
37   u32 instance;         /* If non-~0, specifies a custom dev instance */
38   u8 src_address[16];
39   u8 dst_address[16];
40   u32 mcast_sw_if_index;
41   u32 encap_vrf_id;
42   u32 decap_next_index;
43   u32 vni;
44 };
45
46 define vxlan_add_del_tunnel_reply
47 {
48   u32 context;
49   i32 retval;
50   u32 sw_if_index;
51 };
52
53 define vxlan_tunnel_dump
54 {
55   u32 client_index;
56   u32 context;
57   u32 sw_if_index;
58 };
59
60 define vxlan_tunnel_details
61 {
62   u32 context;
63   u32 sw_if_index;
64   u32 instance;
65   u8 src_address[16];
66   u8 dst_address[16];
67   u32 mcast_sw_if_index;
68   u32 encap_vrf_id;
69   u32 decap_next_index;
70   u32 vni;
71   u8 is_ipv6;
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 {
83   u32 client_index;
84   u32 context;
85   u32 sw_if_index;
86   u8 is_ipv6;
87   u8 enable;
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 {
99   u32 client_index;
100   u32 context;
101   u32 hw_if_index;
102   u32 sw_if_index;
103   u8 enable;
104 };