FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
lisp_gpe.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 = "1.0.0";
17 
18 /** \brief GPE locator structure
19  @param is_ip4 - whether addr is IPv4 or v6
20  @param weight - locator weight
21  @param addr - IPv4/6 address
22 */
23 typedef gpe_locator
24 {
25  u8 is_ip4;
27  u8 addr[16];
28 };
29 
30 /** \brief add or delete GPE tunnel
31  @param client_index - opaque cookie to identify the sender
32  @param context - sender context, to match reply w/ request
33  @param is_add - add address if non-zero, else delete
34  @param eid_type -
35  0 : ipv4
36  1 : ipv6
37  2 : mac
38  @param rmt_eid - remote eid
39  @param lcl_eid - local eid
40  @param rmt_len - remote prefix len
41  @param lcl_len - local prefix len
42  @param vni - virtual network identifier
43  @param dp_table - vrf/bridge domain id
44  @param action - negative action when 0 locators configured
45  @param loc_num - number of locators
46  @param locs - array of remote locators
47 */
48 manual_print manual_endian define gpe_add_del_fwd_entry
49 {
54  u8 rmt_eid[16];
55  u8 lcl_eid[16];
62  vl_api_gpe_locator_t locs[loc_num];
63 };
64 
65 define gpe_add_del_fwd_entry_reply
66 {
70 };
71 
72 /** \brief enable or disable gpe protocol
73  @param client_index - opaque cookie to identify the sender
74  @param context - sender context, to match reply w/ request
75  @param is_en - enable protocol if non-zero, else disable
76 */
77 autoreply define gpe_enable_disable
78 {
82 };
83 
84 /** \brief add or delete gpe_iface
85  @param client_index - opaque cookie to identify the sender
86  @param context - sender context, to match reply w/ request
87  @param is_add - add address if non-zero, else delete
88 */
89 autoreply define gpe_add_del_iface
90 {
97 };
98 
99 define gpe_fwd_entry_vnis_get
100 {
103 };
104 
105 manual_print manual_endian define gpe_fwd_entry_vnis_get_reply
106 {
110  u32 vnis[count];
111 };
112 
113 define gpe_fwd_entries_get
114 {
118 };
119 
120 typedef gpe_fwd_entry
121 {
122  u32 fwd_entry_index;
127  u8 leid[16];
128  u8 reid[16];
131 };
132 
133 manual_print manual_endian define gpe_fwd_entries_get_reply
134 {
138  vl_api_gpe_fwd_entry_t entries[count];
139 };
140 
141 define gpe_fwd_entry_path_dump
142 {
146 };
147 
148 manual_endian manual_print define gpe_fwd_entry_path_details
149 {
151  vl_api_gpe_locator_t lcl_loc;
152  vl_api_gpe_locator_t rmt_loc;
153 };
154 
155 /** \brief Set GPE encapsulation mode
156  @param client_index - opaque cookie to identify the sender
157  @param context - sender context, to match reply w/ request
158  @param mode - LISP (value 0) or VXLAN (value 1)
159 */
160 autoreply define gpe_set_encap_mode
161 {
165 };
166 
167 /** \brief get GPE encapsulation mode
168  @param client_index - opaque cookie to identify the sender
169  @param context - sender context, to match reply w/ request
170  @param mode - LISP (value 0) or VXLAN (value 1)
171 */
172 define gpe_get_encap_mode
173 {
176 };
177 
178 /** \brief Reply for set_encap_mode
179  @param context - returned sender context, to match reply w/ request
180  @param retval - return code
181  @param encap_mode - GPE encapsulation mode
182 */
183 define gpe_get_encap_mode_reply
184 {
188 };
189 
190 /** \brief Add native fwd rpath
191  @param context - returned sender context, to match reply w/ request
192  @param retval - return code
193  @param is_add - flag to indicate add or del
194  @param table_id - table id for route path
195  @param nh_sw_if_index - next-hop sw_if_index (~0 if not set)
196  @param is_ip4 - flag to indicate if nh is ip4
197  @param nh_addr - next hop ip address
198 */
199 autoreply define gpe_add_del_native_fwd_rpath
200 {
207  u8 nh_addr[16];
208 };
209 
210 /** \brief get GPE native fwd rpath
211  @param client_index - opaque cookie to identify the sender
212  @param context - sender context, to match reply w/ request
213 */
214 define gpe_native_fwd_rpaths_get
215 {
219 };
220 
221 /** \brief Reply for get native fwd rpath
222  @param context - returned sender context, to match reply w/ request
223  @param retval - return code
224  @param table_id - table id for route path
225  @param nh_sw_if_index - next-hop sw_if_index (~0 if not set)
226  @param nh_addr - next hop address
227 */
228 typedef gpe_native_fwd_rpath
229 {
230  u32 fib_index;
233  u8 nh_addr[16];
234 };
235 
236 manual_print manual_endian define gpe_native_fwd_rpaths_get_reply
237 {
241  vl_api_gpe_native_fwd_rpath_t entries[count];
242 };
243 
244 /*
245  * Local Variables:
246  * eval: (c-set-style "gnu")
247  * End:
248  */
249 
vl_api_gpe_locator_t lcl_loc
Definition: lisp_gpe.api:151
u8 count
Definition: dhcp.api:208
u8 eid_type
Definition: lisp_gpe.api:53
u32 client_index
Definition: lisp_gpe.api:101
typedef gpe_native_fwd_rpath
Reply for get native fwd rpath.
Definition: lisp_gpe.api:229
u32 dp_table
Definition: lisp_gpe.api:59
u8 is_add
Definition: lisp_gpe.api:52
u32 fwd_entry_index
Definition: lisp_gpe.api:69
unsigned char u8
Definition: types.h:56
u32 nh_sw_if_index
Definition: lisp_gpe.api:231
unsigned int u32
Definition: types.h:88
u8 eid_type
Definition: lisp_gpe.api:124
u32 count
Definition: lisp_gpe.api:109
u32 dp_table
Definition: lisp_gpe.api:123
u8 action
Definition: lisp_gpe.api:60
u32 context
Definition: lisp_gpe.api:150
u32 context
Definition: lisp_gpe.api:144
u32 vni
Definition: lisp_gpe.api:129
u32 loc_num
Definition: lisp_gpe.api:61
u8 addr[16]
Definition: lisp_gpe.api:27
u8 reid[16]
Definition: lisp_gpe.api:128
u32 context
Definition: lisp_gpe.api:107
u32 vni
Definition: lisp_gpe.api:58
u32 context
Definition: lisp_gpe.api:102
vl_api_gpe_locator_t rmt_loc
Definition: lisp_gpe.api:152
u8 reid_prefix_len
Definition: lisp_gpe.api:126
typedef gpe_locator
GPE locator structure.
Definition: lisp_gpe.api:24
u8 is_ip4
Definition: lisp_gpe.api:232
u8 action
Definition: lisp_gpe.api:130
option version
Definition: lisp_gpe.api:16
u8 leid_prefix_len
Definition: lisp_gpe.api:125
signed int i32
Definition: types.h:77
u32 client_index
Definition: lisp_gpe.api:143
u8 rmt_len
Definition: lisp_gpe.api:56
u8 nh_addr[16]
Definition: lisp_gpe.api:233
u32 context
Definition: lisp_gpe.api:67
u8 weight
Definition: lisp_gpe.api:26
u32 entries
u32 client_index
Definition: lisp_gpe.api:50
i32 retval
Definition: lisp_gpe.api:68
i32 retval
Definition: lisp_gpe.api:108
u8 leid[16]
Definition: lisp_gpe.api:127
u8 lcl_len
Definition: lisp_gpe.api:57
u32 fwd_entry_index
Definition: lisp_gpe.api:145
u32 context
Definition: lisp_gpe.api:51
typedef gpe_fwd_entry
Definition: lisp_gpe.api:121