blob: d6c5f6bcd021259dc37986a13b4206f68f5853eb [file] [log] [blame]
Dave Barachb5e8a772016-12-06 12:04:42 -05001/*
2 * Copyright (c) 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/** \file
17
18 This file defines vpp IP control-plane API messages which are generally
19 called through a shared memory interface.
20*/
21
Juraj Sloboda4b9669d2018-01-15 10:39:21 +010022option version = "1.2.0";
Neale Ranns31ed7442018-02-23 05:29:09 -080023import "vnet/fib/fib_types.api";
Dave Barach0d056e52017-09-28 15:11:16 -040024
Neale Ranns28ab9cc2017-08-14 07:18:42 -070025/** \brief Add / del table request
26 A table can be added multiple times, but need be deleted only once.
27 @param client_index - opaque cookie to identify the sender
28 @param context - sender context, to match reply w/ request
29 @param is_ipv6 - V4 or V6 table
30 @param table_id - table ID associated with the route
31 This table ID will apply to both the unicats
32 and mlticast FIBs
Neale Ranns2297af02017-09-12 09:45:04 -070033 @param name - A client provided name/tag for the table. If this is
34 not set by the client, then VPP will generate something
35 meaningfull.
Neale Ranns28ab9cc2017-08-14 07:18:42 -070036*/
37autoreply define ip_table_add_del
38{
39 u32 client_index;
40 u32 context;
41 u32 table_id;
42 u8 is_ipv6;
43 u8 is_add;
Neale Ranns2297af02017-09-12 09:45:04 -070044 u8 name[64];
Neale Ranns28ab9cc2017-08-14 07:18:42 -070045};
46
Dave Barachb5e8a772016-12-06 12:04:42 -050047/** \brief Dump IP fib table
48 @param client_index - opaque cookie to identify the sender
49*/
50define ip_fib_dump
51{
52 u32 client_index;
53 u32 context;
54};
55
Dave Barachb5e8a772016-12-06 12:04:42 -050056/** \brief IP FIB table response
57 @param table_id - IP fib table id
58 @address_length - mask length
59 @address - ip4 prefix
60 @param count - the number of fib_path in path
61 @param path - array of of fib_path structures
62*/
63manual_endian manual_print define ip_fib_details
64{
65 u32 context;
66 u32 table_id;
Neale Ranns2297af02017-09-12 09:45:04 -070067 u8 table_name[64];
Dave Barachb5e8a772016-12-06 12:04:42 -050068 u8 address_length;
69 u8 address[4];
70 u32 count;
71 vl_api_fib_path_t path[count];
72};
73
74/** \brief Dump IP6 fib table
75 @param client_index - opaque cookie to identify the sender
76*/
77define ip6_fib_dump
78{
79 u32 client_index;
80 u32 context;
81};
82
Neale Ranns2297af02017-09-12 09:45:04 -070083/** \brief IP6 FIB table entry response
Dave Barachb5e8a772016-12-06 12:04:42 -050084 @param table_id - IP6 fib table id
Neale Ranns2297af02017-09-12 09:45:04 -070085 @param address_length - mask length
86 @param address - ip6 prefix
Dave Barachb5e8a772016-12-06 12:04:42 -050087 @param count - the number of fib_path in path
88 @param path - array of of fib_path structures
89*/
90manual_endian manual_print define ip6_fib_details
91{
92 u32 context;
93 u32 table_id;
Neale Ranns2297af02017-09-12 09:45:04 -070094 u8 table_name[64];
Dave Barachb5e8a772016-12-06 12:04:42 -050095 u8 address_length;
96 u8 address[16];
97 u32 count;
98 vl_api_fib_path_t path[count];
99};
100
101/** \brief Dump IP neighboors
102 @param client_index - opaque cookie to identify the sender
103 @param context - sender context, to match reply w/ request
Jon Loeligeraf8dfbf2017-11-08 13:07:39 -0600104 @param sw_if_index - the interface to dump neighboors, ~0 == all
Dave Barachb5e8a772016-12-06 12:04:42 -0500105 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
106*/
107define ip_neighbor_dump
108{
109 u32 client_index;
110 u32 context;
111 u32 sw_if_index;
112 u8 is_ipv6;
113};
114
115/** \brief IP neighboors dump response
116 @param context - sender context which was passed in the request
Jon Loeligeraf8dfbf2017-11-08 13:07:39 -0600117 @param sw_if_index - The interface used to reach the neighbor
Dave Barachb5e8a772016-12-06 12:04:42 -0500118 @param is_static - [1|0] to indicate if neighbor is statically configured
119 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
120*/
121define ip_neighbor_details {
122 u32 context;
Jon Loeligeraf8dfbf2017-11-08 13:07:39 -0600123 u32 sw_if_index;
Pavel Kotucek8cb07c92017-01-11 10:13:54 +0100124 u8 is_static;
Dave Barachb5e8a772016-12-06 12:04:42 -0500125 u8 is_ipv6;
126 u8 mac_address[6];
127 u8 ip_address[16];
128};
129
130/** \brief IP neighbor add / del request
131 @param client_index - opaque cookie to identify the sender
132 @param context - sender context, to match reply w/ request
Dave Barachb5e8a772016-12-06 12:04:42 -0500133 @param sw_if_index - interface used to reach neighbor
134 @param is_add - 1 to add neighbor, 0 to delete
135 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
Neale Ranns239d3fe2017-03-08 08:56:58 -0800136 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
137 @param is_static - A static neighbor Entry - there are not flushed
138 If the interface goes down.
139 @param is_no_adj_fib - Do not create a corresponding entry in the FIB
140 table for the neighbor.
Dave Barachb5e8a772016-12-06 12:04:42 -0500141 @param mac_address - l2 address of the neighbor
142 @param dst_address - ip4 or ip6 address of the neighbor
143*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400144autoreply define ip_neighbor_add_del
Dave Barachb5e8a772016-12-06 12:04:42 -0500145{
146 u32 client_index;
147 u32 context;
Dave Barachb5e8a772016-12-06 12:04:42 -0500148 u32 sw_if_index;
149 /* 1 = add, 0 = delete */
150 u8 is_add;
151 u8 is_ipv6;
152 u8 is_static;
Neale Ranns239d3fe2017-03-08 08:56:58 -0800153 u8 is_no_adj_fib;
Dave Barachb5e8a772016-12-06 12:04:42 -0500154 u8 mac_address[6];
155 u8 dst_address[16];
156};
157
Dave Barachb5e8a772016-12-06 12:04:42 -0500158/** \brief Set the ip flow hash config for a fib request
159 @param client_index - opaque cookie to identify the sender
160 @param context - sender context, to match reply w/ request
161 @param vrf_id - vrf/fib id
162 @param is_ipv6 - if non-zero the fib is ip6, else ip4
163 @param src - if non-zero include src in flow hash
164 @param dst - if non-zero include dst in flow hash
165 @param sport - if non-zero include sport in flow hash
166 @param dport - if non-zero include dport in flow hash
167 @param proto -if non-zero include proto in flow hash
168 @param reverse - if non-zero include reverse in flow hash
169*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400170autoreply define set_ip_flow_hash
Dave Barachb5e8a772016-12-06 12:04:42 -0500171{
172 u32 client_index;
173 u32 context;
174 u32 vrf_id;
175 u8 is_ipv6;
176 u8 src;
177 u8 dst;
178 u8 sport;
179 u8 dport;
180 u8 proto;
181 u8 reverse;
182};
183
Dave Barachb5e8a772016-12-06 12:04:42 -0500184/** \brief IPv6 router advertisement config request
185 @param client_index - opaque cookie to identify the sender
186 @param context - sender context, to match reply w/ request
187 @param suppress -
188 @param managed -
189 @param other -
190 @param ll_option -
191 @param send_unicast -
192 @param cease -
193 @param is_no -
194 @param default_router -
195 @param max_interval -
196 @param min_interval -
197 @param lifetime -
198 @param initial_count -
199 @param initial_interval -
200*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400201autoreply define sw_interface_ip6nd_ra_config
Dave Barachb5e8a772016-12-06 12:04:42 -0500202{
203 u32 client_index;
204 u32 context;
205 u32 sw_if_index;
206 u8 suppress;
207 u8 managed;
208 u8 other;
209 u8 ll_option;
210 u8 send_unicast;
211 u8 cease;
212 u8 is_no;
213 u8 default_router;
214 u32 max_interval;
215 u32 min_interval;
216 u32 lifetime;
217 u32 initial_count;
218 u32 initial_interval;
219};
220
Dave Barachb5e8a772016-12-06 12:04:42 -0500221/** \brief IPv6 router advertisement prefix config request
222 @param client_index - opaque cookie to identify the sender
223 @param context - sender context, to match reply w/ request
Neale Ranns87df12d2017-02-18 08:16:41 -0800224 @param sw_if_index - The interface the RA prefix information is for
225 @param address[] - The prefix to advertise
226 @param address_length - the prefix length
227 @param use_default - Revert to default settings
228 @param no_advertise - Do not advertise this prefix
229 @param off_link - The prefix is off link (it is not configured on the interface)
230 Configures the L-flag, When set, indicates that this
231 prefix can be used for on-link determination.
232 @param no_autoconfig - Setting for the A-flag. When
233 set indicates that this prefix can be used for
234 stateless address configuration.
235 @param no_onlink - The prefix is not on link. Make sure this is consistent
236 with the off_link parameter else YMMV
237 @param is_no - add/delete
238 @param val_lifetime - The length of time in
239 seconds (relative to the time the packet is sent)
240 that the prefix is valid for the purpose of on-link
241 determination. A value of all one bits
242 (0xffffffff) represents infinity
243 @param pref_lifetime - The length of time in
244 seconds (relative to the time the packet is sent)
245 that addresses generated from the prefix via
246 stateless address autoconfiguration remain
247 preferred [ADDRCONF]. A value of all one bits
248 (0xffffffff) represents infinity.
Dave Barachb5e8a772016-12-06 12:04:42 -0500249*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400250autoreply define sw_interface_ip6nd_ra_prefix
Dave Barachb5e8a772016-12-06 12:04:42 -0500251{
252 u32 client_index;
253 u32 context;
254 u32 sw_if_index;
255 u8 address[16];
256 u8 address_length;
257 u8 use_default;
258 u8 no_advertise;
259 u8 off_link;
260 u8 no_autoconfig;
261 u8 no_onlink;
262 u8 is_no;
263 u32 val_lifetime;
264 u32 pref_lifetime;
265};
266
Neale Ranns3f844d02017-02-18 00:03:54 -0800267/** \brief IPv6 ND proxy config
268 @param client_index - opaque cookie to identify the sender
269 @param context - sender context, to match reply w/ request
270 @param sw_if_index - The interface the host is on
271 @param address - The address of the host for which to proxy for
272 @param is_add - Adding or deleting
273*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400274autoreply define ip6nd_proxy_add_del
Neale Ranns3f844d02017-02-18 00:03:54 -0800275{
276 u32 client_index;
277 u32 context;
278 u32 sw_if_index;
279 u8 is_del;
280 u8 address[16];
281};
282
Neale Ranns3f844d02017-02-18 00:03:54 -0800283/** \brief IPv6 ND proxy details returned after request
284 @param context - sender context, to match reply w/ request
285 @param retval - return code for the request
286*/
287define ip6nd_proxy_details
288{
289 u32 client_index;
290 u32 context;
291 u32 sw_if_index;
292 u8 address[16];
293};
294
295/** \brief IPv6 ND proxy dump request
296 @param context - sender context, to match reply w/ request
297 @param retval - return code for the request
298 @param sw_if_index - The interface the host is on
299 @param address - The address of the host for which to proxy for
300*/
301define ip6nd_proxy_dump
302{
303 u32 client_index;
304 u32 context;
305};
306
Juraj Sloboda4b9669d2018-01-15 10:39:21 +0100307/** \brief Start / stop sending router solicitation
308 @param client_index - opaque cookie to identify the sender
309 @param context - sender context, to match reply w/ request
310 @param irt - initial retransmission time
311 @param mrt - maximum retransmission time
312 @param mrc - maximum retransmission count
313 @param mrd - maximum retransmission duration
314 @param sw_if_index - software interface index of interface
315 for sending router solicitation
316 @param stop - if non-zero then stop sending router solicitation,
317 otherwise start sending router solicitation
318*/
319autoreply define ip6nd_send_router_solicitation
320{
321 u32 client_index;
322 u32 context;
323 u32 irt;
324 u32 mrt;
325 u32 mrc;
326 u32 mrd;
327 u32 sw_if_index;
328 u8 stop;
329};
330
Dave Barachb5e8a772016-12-06 12:04:42 -0500331/** \brief IPv6 interface enable / disable request
332 @param client_index - opaque cookie to identify the sender
333 @param context - sender context, to match reply w/ request
334 @param sw_if_index - interface used to reach neighbor
335 @param enable - if non-zero enable ip6 on interface, else disable
336*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400337autoreply define sw_interface_ip6_enable_disable
Dave Barachb5e8a772016-12-06 12:04:42 -0500338{
339 u32 client_index;
340 u32 context;
341 u32 sw_if_index;
342 u8 enable; /* set to true if enable */
343};
344
Dave Barachb5e8a772016-12-06 12:04:42 -0500345/** \brief IPv6 set link local address on interface request
346 @param client_index - opaque cookie to identify the sender
347 @param context - sender context, to match reply w/ request
348 @param sw_if_index - interface to set link local on
349 @param address[] - the new link local address
Dave Barachb5e8a772016-12-06 12:04:42 -0500350*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400351autoreply define sw_interface_ip6_set_link_local_address
Dave Barachb5e8a772016-12-06 12:04:42 -0500352{
353 u32 client_index;
354 u32 context;
355 u32 sw_if_index;
356 u8 address[16];
Dave Barachb5e8a772016-12-06 12:04:42 -0500357};
358
Dave Barachb5e8a772016-12-06 12:04:42 -0500359/** \brief Add / del route request
360 @param client_index - opaque cookie to identify the sender
361 @param context - sender context, to match reply w/ request
362 @param sw_if_index - software index of the new vlan's parent interface
363 @param vrf_id - fib table /vrf associated with the route
364 @param lookup_in_vrf -
365 @param classify_table_index -
Dave Barachb5e8a772016-12-06 12:04:42 -0500366 @param is_add - 1 if adding the route, 0 if deleting
367 @param is_drop - Drop the packet
368 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
369 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
370 @param is_ipv6 - 0 if an ip4 route, else ip6
Neale Ranns810086d2017-11-05 16:26:46 -0800371 @param is_local - The route will result in packets sent to VPP IP stack
372 @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
Dave Barachb5e8a772016-12-06 12:04:42 -0500373 @param is_classify -
374 @param is_multipath - Set to 1 if this is a multipath route, else 0
Neale Rannsf068c3e2018-01-03 04:18:48 -0800375 @param is_dvr - Does the route resolve via a DVR interface.
Neale Ranns054c03a2017-10-13 05:15:07 -0700376 @param is_source_lookup - The the path is a deaggregate path (i.e. a lookup
377 in another table) is the lookup on the packet's
378 source address or destination.
Neale Ranns810086d2017-11-05 16:26:46 -0800379 @param next_hop_weight - Weight for Unequal cost multi-path
380 @param next_hop_preference - Path that are up that have the best preference are
381 are used for forwarding. lower value is better.
382 @param next_hop_id - Used when the path resolves via an object that has a unique
383 identifier.
Dave Barachb5e8a772016-12-06 12:04:42 -0500384 @param dst_address_length -
385 @param dst_address[16] -
386 @param next_hop_address[16] -
387 @param next_hop_n_out_labels - the number of labels in the label stack
388 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
389 @param next_hop_via_label - The next-hop is a resolved via a local label
390*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400391autoreply define ip_add_del_route
Dave Barachb5e8a772016-12-06 12:04:42 -0500392{
393 u32 client_index;
394 u32 context;
395 u32 next_hop_sw_if_index;
396 u32 table_id;
397 u32 classify_table_index;
398 u32 next_hop_table_id;
Neale Ranns810086d2017-11-05 16:26:46 -0800399 u32 next_hop_id;
Dave Barachb5e8a772016-12-06 12:04:42 -0500400 u8 is_add;
401 u8 is_drop;
402 u8 is_unreach;
403 u8 is_prohibit;
404 u8 is_ipv6;
405 u8 is_local;
406 u8 is_classify;
407 u8 is_multipath;
408 u8 is_resolve_host;
409 u8 is_resolve_attached;
Neale Rannsf068c3e2018-01-03 04:18:48 -0800410 u8 is_dvr;
Neale Ranns054c03a2017-10-13 05:15:07 -0700411 u8 is_source_lookup;
Neale Ranns810086d2017-11-05 16:26:46 -0800412 u8 is_udp_encap;
Dave Barachb5e8a772016-12-06 12:04:42 -0500413 u8 next_hop_weight;
Neale Ranns57b58602017-07-15 07:37:25 -0700414 u8 next_hop_preference;
Neale Ranns810086d2017-11-05 16:26:46 -0800415 u8 next_hop_proto;
Dave Barachb5e8a772016-12-06 12:04:42 -0500416 u8 dst_address_length;
417 u8 dst_address[16];
418 u8 next_hop_address[16];
419 u8 next_hop_n_out_labels;
420 u32 next_hop_via_label;
Neale Ranns31ed7442018-02-23 05:29:09 -0800421 vl_api_fib_mpls_label_t next_hop_out_label_stack[next_hop_n_out_labels];
Dave Barachb5e8a772016-12-06 12:04:42 -0500422};
423
Neale Ranns32e1c012016-11-22 17:07:28 +0000424/** \brief Add / del route request
425 @param client_index - opaque cookie to identify the sender
426 @param context - sender context, to match reply w/ request
427 @param sw_if_index - software index of the new vlan's parent interface
428 @param vrf_id - fib table /vrf associated with the route
Neale Rannsd792d9c2017-10-21 10:53:20 -0700429 @param next_hop_afi - Use dpo_proto_t
Neale Ranns32e1c012016-11-22 17:07:28 +0000430 FIXME
431*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400432autoreply define ip_mroute_add_del
Neale Ranns32e1c012016-11-22 17:07:28 +0000433{
434 u32 client_index;
435 u32 context;
436 u32 next_hop_sw_if_index;
437 u32 table_id;
438 u32 entry_flags;
439 u32 itf_flags;
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800440 u32 rpf_id;
Neale Rannsd792d9c2017-10-21 10:53:20 -0700441 u32 bier_imp;
Neale Ranns32e1c012016-11-22 17:07:28 +0000442 u16 grp_address_length;
Neale Rannsd792d9c2017-10-21 10:53:20 -0700443 u8 next_hop_afi;
Neale Ranns32e1c012016-11-22 17:07:28 +0000444 u8 is_add;
445 u8 is_ipv6;
446 u8 is_local;
447 u8 grp_address[16];
448 u8 src_address[16];
449};
450
Neale Ranns5a8123b2017-01-26 01:18:23 -0800451/** \brief Dump IP multicast fib table
452 @param client_index - opaque cookie to identify the sender
453*/
454define ip_mfib_dump
455{
456 u32 client_index;
457 u32 context;
458};
459
460/** \brief IP Multicast FIB table response
461 @param table_id - IP fib table id
462 @address_length - mask length
463 @grp_address - Group address/prefix
464 @src_address - Source address
465 @param count - the number of fib_path in path
466 @param path - array of of fib_path structures
467*/
468manual_endian manual_print define ip_mfib_details
469{
470 u32 context;
471 u32 table_id;
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800472 u32 entry_flags;
473 u32 rpf_id;
Neale Ranns5a8123b2017-01-26 01:18:23 -0800474 u8 address_length;
475 u8 grp_address[4];
476 u8 src_address[4];
477 u32 count;
478 vl_api_fib_path_t path[count];
479};
480
481/** \brief Dump IP6 multicast fib table
482 @param client_index - opaque cookie to identify the sender
483*/
484define ip6_mfib_dump
485{
486 u32 client_index;
487 u32 context;
488};
489
490/** \brief IP6 Multicast FIB table response
491 @param table_id - IP fib table id
492 @address_length - mask length
493 @grp_address - Group address/prefix
494 @src_address - Source address
495 @param count - the number of fib_path in path
496 @param path - array of of fib_path structures
497*/
498manual_endian manual_print define ip6_mfib_details
499{
500 u32 context;
501 u32 table_id;
502 u8 address_length;
503 u8 grp_address[16];
504 u8 src_address[16];
505 u32 count;
506 vl_api_fib_path_t path[count];
507};
508
Dave Barachb5e8a772016-12-06 12:04:42 -0500509define ip_address_details
510{
511 u32 client_index;
512 u32 context;
513 u8 ip[16];
514 u8 prefix_length;
Jon Loeliger466f0d42017-02-09 12:17:50 -0600515 u32 sw_if_index;
516 u8 is_ipv6;
Dave Barachb5e8a772016-12-06 12:04:42 -0500517};
518
519define ip_address_dump
520{
521 u32 client_index;
522 u32 context;
523 u32 sw_if_index;
524 u8 is_ipv6;
525};
526
527define ip_details
528{
529 u32 sw_if_index;
530 u32 context;
Jon Loeliger466f0d42017-02-09 12:17:50 -0600531 u8 is_ipv6;
Dave Barachb5e8a772016-12-06 12:04:42 -0500532};
533
534define ip_dump
535{
536 u32 client_index;
537 u32 context;
538 u8 is_ipv6;
539};
540
Neale Ranns32e1c012016-11-22 17:07:28 +0000541define mfib_signal_dump
542{
543 u32 client_index;
544 u32 context;
545};
546
547define mfib_signal_details
548{
549 u32 client_index;
550 u32 context;
551 u32 sw_if_index;
552 u32 table_id;
553 u16 grp_address_len;
554 u8 grp_address[16];
555 u8 src_address[16];
556 u16 ip_packet_len;
557 u8 ip_packet_data[256];
558};
Dave Barachb5e8a772016-12-06 12:04:42 -0500559
Neale Rannsd91c1db2017-07-31 02:30:50 -0700560/** \brief IP punt policer
561 @param client_index - opaque cookie to identify the sender
562 @param context - sender context, to match reply w/ request
563 @param is_add - 1 to add neighbor, 0 to delete
564 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
565 @param policer_index - Index of policer to use
566*/
567autoreply define ip_punt_police
568{
569 u32 client_index;
570 u32 context;
571 u32 policer_index;
572 u8 is_add;
573 u8 is_ip6;
574};
575
576/** \brief IP punt redirect
577 @param client_index - opaque cookie to identify the sender
578 @param context - sender context, to match reply w/ request
579 @param is_add - 1 to add neighbor, 0 to delete
580 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
581 @param tx_sw_if_index - the TX interface to which traffic shoulde be
582 redirected.
583 @param nh - The next-hop to redirect the traffic to.
584*/
585autoreply define ip_punt_redirect
586{
587 u32 client_index;
588 u32 context;
589 u32 rx_sw_if_index;
590 u32 tx_sw_if_index;
591 u8 is_add;
592 u8 is_ip6;
593 u8 nh[16];
594};
595
Florin Coras595992c2017-11-06 17:17:08 -0800596autoreply define ip_container_proxy_add_del
597{
598 u32 client_index;
599 u32 context;
600 u8 ip[16];
601 u8 is_ip4;
602 u8 plen;
603 u32 sw_if_index;
604 u8 is_add;
605};
606
Neale Rannsb8d44812017-11-10 06:53:54 -0800607/** \brief Configure IP source and L4 port-range check
608 @param client_index - opaque cookie to identify the sender
609 @param context - sender context, to match reply w/ request
610 @param is_ip6 - 1 if source address type is IPv6
611 @param is_add - 1 if add, 0 if delete
612 @param mask_length - mask length for address entry
613 @param address - array of address bytes
614 @param number_of_ranges - length of low_port and high_port arrays (must match)
615 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
616 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
617 @param vrf_id - fib table/vrf id to associate the source and port-range check with
618 @note To specify a single port set low_port and high_port entry the same
619*/
620autoreply define ip_source_and_port_range_check_add_del
621{
622 u32 client_index;
623 u32 context;
624 u8 is_ipv6;
625 u8 is_add;
626 u8 mask_length;
627 u8 address[16];
628 u8 number_of_ranges;
629 u16 low_ports[32];
630 u16 high_ports[32];
631 u32 vrf_id;
632};
633
634/** \brief Set interface source and L4 port-range request
635 @param client_index - opaque cookie to identify the sender
636 @param context - sender context, to match reply w/ request
637 @param interface_id - interface index
638 @param tcp_vrf_id - VRF associated with source and TCP port-range check
639 @param udp_vrf_id - VRF associated with source and TCP port-range check
640*/
641autoreply define ip_source_and_port_range_check_interface_add_del
642{
643 u32 client_index;
644 u32 context;
645 u8 is_add;
646 u32 sw_if_index;
647 u32 tcp_in_vrf_id;
648 u32 tcp_out_vrf_id;
649 u32 udp_in_vrf_id;
650 u32 udp_out_vrf_id;
651};
652
653/** \brief Register for ip4 arp resolution events
654 @param client_index - opaque cookie to identify the sender
655 @param context - sender context, to match reply w/ request
656 @param enable_disable - 1 => register for events, 0 => cancel registration
657 @param pid - sender's pid
658 @param address - the exact ip4 address of interest
659*/
660autoreply define want_ip4_arp_events
661{
662 u32 client_index;
663 u32 context;
664 u8 enable_disable;
665 u32 pid;
666 u32 address;
667};
668
669/** \brief Tell client about an ip4 arp resolution event
670 @param client_index - opaque cookie to identify the sender
671 @param address - the exact ip4 address of interest
672 @param pid - client pid registered to receive notification
673 @param sw_if_index - interface which received ARP packet
674 @param new_mac - the new mac address
675 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
676*/
677define ip4_arp_event
678{
679 u32 client_index;
680 u32 address;
681 u32 pid;
682 u32 sw_if_index;
683 u8 new_mac[6];
684 u8 mac_ip;
685};
686
Marek Gradzki51e59682018-03-06 10:05:44 +0100687service {
688 rpc want_ip4_arp_events returns want_ip4_arp_events_reply
689 events ip4_arp_event;
690};
691
Neale Rannsb8d44812017-11-10 06:53:54 -0800692/** \brief Register for ip6 nd resolution events
693 @param client_index - opaque cookie to identify the sender
694 @param context - sender context, to match reply w/ request
695 @param enable_disable - 1 => register for events, 0 => cancel registration
696 @param pid - sender's pid
697 @param address - the exact ip6 address of interest
698*/
699autoreply define want_ip6_nd_events
700{
701 u32 client_index;
702 u32 context;
703 u8 enable_disable;
704 u32 pid;
705 u8 address[16];
706};
707
708/** \brief Tell client about an ip6 nd resolution or mac/ip event
709 @param client_index - opaque cookie to identify the sender
710 @param pid - client pid registered to receive notification
711 @param sw_if_index - interface which received ARP packet
712 @param address - the exact ip6 address of interest
713 @param new_mac - the new mac address
714 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
715*/
716define ip6_nd_event
717{
718 u32 client_index;
719 u32 pid;
720 u32 sw_if_index;
721 u8 address[16];
722 u8 new_mac[6];
723 u8 mac_ip;
724};
725
Marek Gradzki51e59682018-03-06 10:05:44 +0100726service {
Juraj Sloboda4b9669d2018-01-15 10:39:21 +0100727 rpc want_ip6_ra_events returns want_ip6_ra_events_reply
728 events ip6_ra_event;
729};
730
731/** \brief Register for ip6 router advertisement events
732 @param client_index - opaque cookie to identify the sender
733 @param context - sender context, to match reply w/ request
734 @param enable_disable - 1 => register for events, 0 => cancel registration
735 @param pid - sender's pid
736*/
737autoreply define want_ip6_ra_events
738{
739 u32 client_index;
740 u32 context;
741 u8 enable_disable;
742 u32 pid;
743};
744
745/** \brief Struct representing RA prefix info
746 @param dst_address - RA prefix info destination address
747 @param dst_address_length - RA prefix info destination address length
748 @param flags - RA prefix info flags
749 @param valid_time - RA prefix info valid time
750 @param preferred_time - RA prefix info preferred time
751*/
752typeonly define ip6_ra_prefix_info
753{
754 u8 dst_address[16];
755 u8 dst_address_length;
756 u8 flags;
757 u32 valid_time;
758 u32 preferred_time;
759};
760
761/** \brief Tell client about a router advertisement event
762 @param client_index - opaque cookie to identify the sender
763 @param pid - client pid registered to receive notification
764 @param current_hop_limit - RA current hop limit
765 @param flags - RA flags
766 @param router_lifetime_in_sec - RA lifetime in seconds
767 @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
768 @param time_in_msec_between_retransmitted_neighbor_solicitations -
769 time in msec between retransmitted neighbor solicitations
770 @param n_prefixes -
771 @param prefixes -
772*/
773define ip6_ra_event
774{
775 u32 client_index;
776 u32 pid;
777 u32 sw_if_index;
778 u8 router_address[16];
779 u8 current_hop_limit;
780 u8 flags;
781 u16 router_lifetime_in_sec;
782 u32 neighbor_reachable_time_in_msec;
783 u32 time_in_msec_between_retransmitted_neighbor_solicitations;
784 u32 n_prefixes;
785 vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
786};
787
788service {
Marek Gradzki51e59682018-03-06 10:05:44 +0100789 rpc want_ip6_nd_events returns want_ip6_nd_events_reply
790 events ip6_nd_event;
791};
792
Neale Rannsb8d44812017-11-10 06:53:54 -0800793/** \brief Proxy ARP add / del request
794 @param client_index - opaque cookie to identify the sender
795 @param context - sender context, to match reply w/ request
796 @param vrf_id - VRF / Fib table ID
797 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
798 @param low_address[4] - Low address of the Proxy ARP range
799 @param hi_address[4] - High address of the Proxy ARP range
800*/
801autoreply define proxy_arp_add_del
802{
803 u32 client_index;
804 u32 context;
805 u32 vrf_id;
806 u8 is_add;
807 u8 low_address[4];
808 u8 hi_address[4];
809};
810
811/** \brief Proxy ARP add / del request
812 @param client_index - opaque cookie to identify the sender
813 @param context - sender context, to match reply w/ request
814 @param sw_if_index - Which interface to enable / disable Proxy Arp on
815 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
816*/
817autoreply define proxy_arp_intfc_enable_disable
818{
819 u32 client_index;
820 u32 context;
821 u32 sw_if_index;
822 /* 1 = on, 0 = off */
823 u8 enable_disable;
824};
825
826/** \brief Reset fib table request
827 @param client_index - opaque cookie to identify the sender
828 @param context - sender context, to match reply w/ request
829 @param vrf_id - vrf/table id of the fib table to reset
830 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
831*/
832autoreply define reset_fib
833{
834 u32 client_index;
835 u32 context;
836 u32 vrf_id;
837 u8 is_ipv6;
838};
839
840/** \brief Set max allowed ARP or ip6 neighbor entries request
841 @param client_index - opaque cookie to identify the sender
842 @param context - sender context, to match reply w/ request
843 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
844 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
845*/
846autoreply define set_arp_neighbor_limit
847{
848 u32 client_index;
849 u32 context;
850 u8 is_ipv6;
851 u32 arp_neighbor_limit;
852};
853
854/** \brief IOAM enable : Enable in-band OAM
855 @param id - profile id
856 @param seqno - To enable Seqno Processing
857 @param analyse - Enabling analysis of iOAM at decap node
858 @param pow_enable - Proof of Work enabled or not flag
859 @param trace_enable - iOAM Trace enabled or not flag
860*/
861autoreply define ioam_enable
862{
863 u32 client_index;
864 u32 context;
865 u16 id;
866 u8 seqno;
867 u8 analyse;
868 u8 pot_enable;
869 u8 trace_enable;
870 u32 node_id;
871};
872
873/** \brief iOAM disable
874 @param client_index - opaque cookie to identify the sender
875 @param context - sender context, to match reply w/ request
876 @param index - MAP Domain index
877*/
878autoreply define ioam_disable
879{
880 u32 client_index;
881 u32 context;
882 u16 id;
883};
884
Klement Sekera75e7d132017-09-20 08:26:30 +0200885autoreply define ip_reassembly_set
886{
887 u32 client_index;
888 u32 context;
889 u32 timeout_ms;
890 u32 max_reassemblies;
891 u32 expire_walk_interval_ms;
892 u8 is_ip6;
893};
894
895define ip_reassembly_get
896{
897 u32 client_index;
898 u32 context;
899 u8 is_ip6;
900};
901
902define ip_reassembly_get_reply
903{
904 u32 client_index;
905 u32 context;
906 i32 retval;
907 u32 timeout_ms;
908 u32 max_reassemblies;
909 u32 expire_walk_interval_ms;
910 u8 is_ip6;
911};
912
Dave Barachb5e8a772016-12-06 12:04:42 -0500913/*
914 * Local Variables:
915 * eval: (c-set-style "gnu")
916 * End:
917 */