1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2018 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 This file defines vpp IP control-plane API messages which are generally
20 called through a shared memory interface.
23 option version = "3.0.1";
25 import "vnet/interface_types.api";
26 import "vnet/fib/fib_types.api";
27 import "vnet/ethernet/ethernet_types.api";
28 import "vnet/mfib/mfib_types.api";
29 import "vnet/interface_types.api";
31 /** \brief An IP table
32 @param is_ipv6 - V4 or V6 table
33 @param table_id - table ID associated with the route
34 This table ID will apply to both the unicast
36 @param name - A client provided name/tag for the table. If this is
37 not set by the client, then VPP will generate something
47 /** \brief Add / del table request
48 A table can be added multiple times, but need be deleted only once.
49 @param client_index - opaque cookie to identify the sender
50 @param context - sender context, to match reply w/ request
52 autoreply define ip_table_add_del
56 bool is_add [default=true];
57 vl_api_ip_table_t table;
60 /** \brief Dump IP all fib tables
61 @param client_index - opaque cookie to identify the sender
62 @param context - sender context, to match reply w/ request
70 /** \brief IP table replace being
72 The use-case is that, for some unspecified reason, the control plane
73 has a very different set of entries it wants in the table than VPP
74 currently has. The CP would thus like to 'replace' VPP's current table
75 only by specifying what the new set of entries shall be, i.e. it is not
76 going to delete anything that already exists.
77 the CP declares the start of this procedure with this begin_replace
78 API Call, and when it has populated all the entries it wants, it calls
79 the below end_replace API. From this point on it is of course free
80 to add and delete entries as usual.
81 The underlying mechanism by which VPP implements this replace is
82 purposefully left unspecified.
84 @param client_index - opaque cookie to identify the sender
85 @param context - sender context, to match reply w/ request
86 @param table - The table to resync
88 autoreply define ip_table_replace_begin
92 vl_api_ip_table_t table;
95 /** \brief IP table replace end
99 @param client_index - opaque cookie to identify the sender
100 @param context - sender context, to match reply w/ request
101 @param table - The table that has converged
103 autoreply define ip_table_replace_end
107 vl_api_ip_table_t table;
110 /** \brief IP table flush
111 Flush a table of all routes
112 @param client_index - opaque cookie to identify the sender
113 @param context - sender context, to match reply w/ request
114 @param table - The table to flush
116 autoreply define ip_table_flush
120 vl_api_ip_table_t table;
123 /** \brief IP FIB table response
124 @param context - sender context
125 @param table - description of the table
127 manual_endian manual_print define ip_table_details
130 vl_api_ip_table_t table;
133 /** \brief An IP route
134 @param table_id The IP table the route is in
135 @param stats_index The index of the route in the stats segment
136 @param prefix the prefix for the route
137 @param n_paths The number of paths the route has
138 @param paths The paths of the route
144 vl_api_prefix_t prefix;
146 vl_api_fib_path_t paths[n_paths];
149 /** \brief Add / del route request
150 @param client_index - opaque cookie to identify the sender
151 @param context - sender context, to match reply w/ request
152 @param is_multipath - Set to 1 if these paths will be added/removed
153 to/from the existing set, or 0 to replace
155 is_add=0 & is_multipath=0 implies delete all paths
156 @param is_add - Are the paths being added or removed
158 define ip_route_add_del
162 bool is_add [default=true];
164 vl_api_ip_route_t route;
166 define ip_route_add_del_reply
173 /** \brief Dump IP routes from a table
174 @param client_index - opaque cookie to identify the sender
175 @param table - The table from which to dump routes (ony ID an AF are needed)
181 vl_api_ip_table_t table;
184 /** \brief IP FIB table entry response
185 @param route The route entry in the table
187 manual_endian manual_print define ip_route_details
190 vl_api_ip_route_t route;
193 /** \brief Lookup IP route from a table
194 @param client_index - opaque cookie to identify the sender
195 @param table_id - The IP table to look the route up in
196 @param exact - 0 for normal route lookup, 1 for exact match only
197 @param prefix - The prefix (or host) for route lookup.
199 define ip_route_lookup
205 vl_api_prefix_t prefix;
208 /** \brief IP FIB table lookup response
209 @param retval - return code of the lookup
210 @param route - The route entry in the table if found
212 define ip_route_lookup_reply
216 vl_api_ip_route_t route;
219 /** \brief Set the ip flow hash config for a fib request
220 @param client_index - opaque cookie to identify the sender
221 @param context - sender context, to match reply w/ request
222 @param vrf_id - vrf/fib id
223 @param is_ipv6 - if non-zero the fib is ip6, else ip4
224 @param src - if non-zero include src in flow hash
225 @param dst - if non-zero include dst in flow hash
226 @param sport - if non-zero include sport in flow hash
227 @param dport - if non-zero include dport in flow hash
228 @param proto -if non-zero include proto in flow hash
229 @param reverse - if non-zero include reverse in flow hash
230 @param symmetric - if non-zero include symmetry in flow hash
232 autoreply define set_ip_flow_hash
247 /** \brief IPv6 interface enable / disable request
248 @param client_index - opaque cookie to identify the sender
249 @param context - sender context, to match reply w/ request
250 @param sw_if_index - interface used to reach neighbor
251 @param enable - if non-zero enable ip6 on interface, else disable
253 autoreply define sw_interface_ip6_enable_disable
257 vl_api_interface_index_t sw_if_index;
258 bool enable; /* set to true if enable */
261 /** \brief Dump IP multicast fib table
262 @param client_index - opaque cookie to identify the sender
264 define ip_mtable_dump
269 define ip_mtable_details
273 vl_api_ip_table_t table;
276 /** \brief Add / del route request
278 Adds a route, consisting both of the MFIB entry to match packets
279 (which may already exist) and a path to send those packets down.
280 Routes can be entered repeatedly to add multiple paths. Deletions are
283 @param client_index - opaque cookie to identify the sender
284 @param context - sender context, to match reply w/ request
285 @param table_id - fib table /vrf associated with the route
286 @param is_add - true if adding a route; false if deleting one
287 @param is_ipv6 - true iff all the addresses are v6
288 @param entry_flags - see fib_entry_flag_t
289 @param itf_flags - see mfib_entry_flags_t
290 @param next_hop_afi - see dpo_proto_t; the type of destination description
291 @param src_address - the source of the packet
292 @param grp_address - the group the packet is destined to
293 @param nh_address - the nexthop to forward the packet to
294 @param next_hop_sw_if_index - interface to emit packet on
296 BIER AFIs use the BIER imposition ID. v4 and v6 AFIs use either the
297 interface or the nexthop address.
299 Note that if the route is source-specific (S is supplied, not all 0s),
300 the prefix match is treated as exact (prefixlen /32 or /128).
302 FIXME not complete yet
307 vl_api_mfib_entry_flags_t entry_flags;
309 vl_api_mprefix_t prefix;
311 vl_api_mfib_path_t paths[n_paths];
314 define ip_mroute_add_del
318 bool is_add [default=true];
320 vl_api_ip_mroute_t route;
322 define ip_mroute_add_del_reply
329 /** \brief Dump IP multicast fib table
330 @param table - The table from which to dump routes (ony ID an AF are needed)
332 define ip_mroute_dump
336 vl_api_ip_table_t table;
339 /** \brief IP Multicast Route Details
340 @param route - Details of the route
342 manual_endian manual_print define ip_mroute_details
345 vl_api_ip_mroute_t route;
348 define ip_address_details
351 vl_api_interface_index_t sw_if_index;
352 vl_api_address_with_prefix_t prefix;
355 define ip_address_dump
359 vl_api_interface_index_t sw_if_index;
363 /** \brief IP unnumbered configurations
364 @param sw_if_index The interface that has unnumbered configuration
365 @param ip_sw_if_index The IP interface that it is unnumbered to
367 define ip_unnumbered_details
370 vl_api_interface_index_t sw_if_index;
371 vl_api_interface_index_t ip_sw_if_index;
374 /** \brief Dump IP unnumbered configurations
375 @param sw_if_index ~0 for all interfaces, else the interface desired
377 define ip_unnumbered_dump
381 vl_api_interface_index_t sw_if_index [default=0xffffffff];
387 vl_api_interface_index_t sw_if_index;
398 define mfib_signal_dump
404 define mfib_signal_details
407 vl_api_interface_index_t sw_if_index;
409 vl_api_mprefix_t prefix;
411 u8 ip_packet_data[256];
414 /** \brief IP punt policer
415 @param client_index - opaque cookie to identify the sender
416 @param context - sender context, to match reply w/ request
417 @param is_add - 1 to add neighbor, 0 to delete
418 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
419 @param policer_index - Index of policer to use
421 autoreply define ip_punt_police
426 bool is_add [default=true];
430 /** \brief Punt redirect type
431 @param rx_sw_if_index - specify the original RX interface of traffic
432 that should be redirected. ~0 means any interface.
433 @param tx_sw_if_index - the TX interface to which traffic should be
435 @param nh - the next-hop to redirect the traffic to.
436 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
438 typedef punt_redirect
440 vl_api_interface_index_t rx_sw_if_index;
441 vl_api_interface_index_t tx_sw_if_index;
445 /** \brief IP punt redirect
446 @param client_index - opaque cookie to identify the sender
447 @param context - sender context, to match reply w/ request
448 @param punt - punt definition
449 @param is_add - 1 to add neighbor, 0 to delete
451 autoreply define ip_punt_redirect
455 vl_api_punt_redirect_t punt;
456 bool is_add [default=true];
459 define ip_punt_redirect_dump
463 vl_api_interface_index_t sw_if_index;
467 define ip_punt_redirect_details
470 vl_api_punt_redirect_t punt;
473 autoreply define ip_container_proxy_add_del
478 vl_api_interface_index_t sw_if_index;
479 bool is_add [default=true];
482 define ip_container_proxy_dump
488 define ip_container_proxy_details
491 vl_api_interface_index_t sw_if_index;
492 vl_api_prefix_t prefix;
495 /** \brief Configure IP source and L4 port-range check
496 @param client_index - opaque cookie to identify the sender
497 @param context - sender context, to match reply w/ request
498 @param is_ip6 - 1 if source address type is IPv6
499 @param is_add - 1 if add, 0 if delete
500 @param ip - prefix to match
501 @param number_of_ranges - length of low_port and high_port arrays (must match)
502 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
503 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
504 @param vrf_id - fib table/vrf id to associate the source and port-range check with
505 @note To specify a single port set low_port and high_port entry the same
507 autoreply define ip_source_and_port_range_check_add_del
511 bool is_add [default=true];
512 vl_api_prefix_t prefix;
519 /** \brief Set interface source and L4 port-range request
520 @param client_index - opaque cookie to identify the sender
521 @param context - sender context, to match reply w/ request
522 @param interface_id - interface index
523 @param tcp_vrf_id - VRF associated with source and TCP port-range check
524 @param udp_vrf_id - VRF associated with source and TCP port-range check
526 autoreply define ip_source_and_port_range_check_interface_add_del
530 bool is_add [default=true];
531 vl_api_interface_index_t sw_if_index;
538 /** \brief IPv6 set link local address on interface request
539 @param client_index - opaque cookie to identify the sender
540 @param context - sender context, to match reply w/ request
541 @param sw_if_index - interface to set link local on
542 @param ip - the new link local address
544 autoreply define sw_interface_ip6_set_link_local_address
548 vl_api_interface_index_t sw_if_index;
549 vl_api_ip6_address_t ip;
552 /** \brief IOAM enable : Enable in-band OAM
553 @param id - profile id
554 @param seqno - To enable Seqno Processing
555 @param analyse - Enabling analysis of iOAM at decap node
556 @param pow_enable - Proof of Work enabled or not flag
557 @param trace_enable - iOAM Trace enabled or not flag
559 autoreply define ioam_enable
571 /** \brief iOAM disable
572 @param client_index - opaque cookie to identify the sender
573 @param context - sender context, to match reply w/ request
574 @param index - MAP Domain index
576 autoreply define ioam_disable
585 IP_REASS_TYPE_FULL = 0,
586 IP_REASS_TYPE_SHALLOW_VIRTUAL = 0x1,
589 autoreply define ip_reassembly_set
594 u32 max_reassemblies;
595 u32 max_reassembly_length;
596 u32 expire_walk_interval_ms;
598 vl_api_ip_reass_type_t type;
601 define ip_reassembly_get
606 vl_api_ip_reass_type_t type;
609 define ip_reassembly_get_reply
614 u32 max_reassemblies;
615 u32 max_reassembly_length;
616 u32 expire_walk_interval_ms;
620 /** \brief Enable/disable reassembly feature
621 @param client_index - opaque cookie to identify the sender
622 @param context - sender context, to match reply w/ request
623 @param sw_if_index - interface to enable/disable feature on
624 @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
625 @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
627 autoreply define ip_reassembly_enable_disable
631 vl_api_interface_index_t sw_if_index;
634 vl_api_ip_reass_type_t type;
639 * eval: (c-set-style "gnu")