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:
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.
18 This file defines vpp IP control-plane API messages which are generally
19 called through a shared memory interface.
22 option version = "1.1.0";
23 import "vnet/fib/fib_types.api";
25 /** \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
33 @param name - A client provided name/tag for the table. If this is
34 not set by the client, then VPP will generate something
37 autoreply define ip_table_add_del
47 /** \brief Dump IP fib table
48 @param client_index - opaque cookie to identify the sender
56 /** \brief IP FIB table response
57 @param table_id - IP fib table id
58 @address_length - mask length
60 @param count - the number of fib_path in path
61 @param path - array of of fib_path structures
63 manual_endian manual_print define ip_fib_details
71 vl_api_fib_path_t path[count];
74 /** \brief Dump IP6 fib table
75 @param client_index - opaque cookie to identify the sender
83 /** \brief IP6 FIB table entry response
84 @param table_id - IP6 fib table id
85 @param address_length - mask length
86 @param address - ip6 prefix
87 @param count - the number of fib_path in path
88 @param path - array of of fib_path structures
90 manual_endian manual_print define ip6_fib_details
98 vl_api_fib_path_t path[count];
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
104 @param sw_if_index - the interface to dump neighboors, ~0 == all
105 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
107 define ip_neighbor_dump
115 /** \brief IP neighboors dump response
116 @param context - sender context which was passed in the request
117 @param sw_if_index - The interface used to reach the neighbor
118 @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]
121 define ip_neighbor_details {
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
133 @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
136 @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.
141 @param mac_address - l2 address of the neighbor
142 @param dst_address - ip4 or ip6 address of the neighbor
144 autoreply define ip_neighbor_add_del
149 /* 1 = add, 0 = delete */
158 /** \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
170 autoreply define set_ip_flow_hash
184 /** \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
191 @param send_unicast -
194 @param default_router -
195 @param max_interval -
196 @param min_interval -
198 @param initial_count -
199 @param initial_interval -
201 autoreply define sw_interface_ip6nd_ra_config
218 u32 initial_interval;
221 /** \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
224 @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.
250 autoreply define sw_interface_ip6nd_ra_prefix
267 /** \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
274 autoreply define ip6nd_proxy_add_del
283 /** \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
287 define ip6nd_proxy_details
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
301 define ip6nd_proxy_dump
307 /** \brief IPv6 interface enable / disable request
308 @param client_index - opaque cookie to identify the sender
309 @param context - sender context, to match reply w/ request
310 @param sw_if_index - interface used to reach neighbor
311 @param enable - if non-zero enable ip6 on interface, else disable
313 autoreply define sw_interface_ip6_enable_disable
318 u8 enable; /* set to true if enable */
321 /** \brief IPv6 set link local address on interface request
322 @param client_index - opaque cookie to identify the sender
323 @param context - sender context, to match reply w/ request
324 @param sw_if_index - interface to set link local on
325 @param address[] - the new link local address
327 autoreply define sw_interface_ip6_set_link_local_address
335 /** \brief Add / del route request
336 @param client_index - opaque cookie to identify the sender
337 @param context - sender context, to match reply w/ request
338 @param sw_if_index - software index of the new vlan's parent interface
339 @param vrf_id - fib table /vrf associated with the route
340 @param lookup_in_vrf -
341 @param classify_table_index -
342 @param is_add - 1 if adding the route, 0 if deleting
343 @param is_drop - Drop the packet
344 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
345 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
346 @param is_ipv6 - 0 if an ip4 route, else ip6
347 @param is_local - The route will result in packets sent to VPP IP stack
348 @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
350 @param is_multipath - Set to 1 if this is a multipath route, else 0
351 @param is_dvr - Does the route resolve via a DVR interface.
352 @param is_source_lookup - The the path is a deaggregate path (i.e. a lookup
353 in another table) is the lookup on the packet's
354 source address or destination.
355 @param next_hop_weight - Weight for Unequal cost multi-path
356 @param next_hop_preference - Path that are up that have the best preference are
357 are used for forwarding. lower value is better.
358 @param next_hop_id - Used when the path resolves via an object that has a unique
360 @param dst_address_length -
361 @param dst_address[16] -
362 @param next_hop_address[16] -
363 @param next_hop_n_out_labels - the number of labels in the label stack
364 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
365 @param next_hop_via_label - The next-hop is a resolved via a local label
367 autoreply define ip_add_del_route
371 u32 next_hop_sw_if_index;
373 u32 classify_table_index;
374 u32 next_hop_table_id;
385 u8 is_resolve_attached;
390 u8 next_hop_preference;
392 u8 dst_address_length;
394 u8 next_hop_address[16];
395 u8 next_hop_n_out_labels;
396 u32 next_hop_via_label;
397 vl_api_fib_mpls_label_t next_hop_out_label_stack[next_hop_n_out_labels];
400 /** \brief Add / del route request
401 @param client_index - opaque cookie to identify the sender
402 @param context - sender context, to match reply w/ request
403 @param sw_if_index - software index of the new vlan's parent interface
404 @param vrf_id - fib table /vrf associated with the route
405 @param next_hop_afi - Use dpo_proto_t
408 autoreply define ip_mroute_add_del
412 u32 next_hop_sw_if_index;
418 u16 grp_address_length;
427 /** \brief Dump IP multicast fib table
428 @param client_index - opaque cookie to identify the sender
436 /** \brief IP Multicast FIB table response
437 @param table_id - IP fib table id
438 @address_length - mask length
439 @grp_address - Group address/prefix
440 @src_address - Source address
441 @param count - the number of fib_path in path
442 @param path - array of of fib_path structures
444 manual_endian manual_print define ip_mfib_details
454 vl_api_fib_path_t path[count];
457 /** \brief Dump IP6 multicast fib table
458 @param client_index - opaque cookie to identify the sender
466 /** \brief IP6 Multicast FIB table response
467 @param table_id - IP fib table id
468 @address_length - mask length
469 @grp_address - Group address/prefix
470 @src_address - Source address
471 @param count - the number of fib_path in path
472 @param path - array of of fib_path structures
474 manual_endian manual_print define ip6_mfib_details
482 vl_api_fib_path_t path[count];
485 define ip_address_details
495 define ip_address_dump
517 define mfib_signal_dump
523 define mfib_signal_details
533 u8 ip_packet_data[256];
536 /** \brief IP punt policer
537 @param client_index - opaque cookie to identify the sender
538 @param context - sender context, to match reply w/ request
539 @param is_add - 1 to add neighbor, 0 to delete
540 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
541 @param policer_index - Index of policer to use
543 autoreply define ip_punt_police
552 /** \brief IP punt redirect
553 @param client_index - opaque cookie to identify the sender
554 @param context - sender context, to match reply w/ request
555 @param is_add - 1 to add neighbor, 0 to delete
556 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
557 @param tx_sw_if_index - the TX interface to which traffic shoulde be
559 @param nh - The next-hop to redirect the traffic to.
561 autoreply define ip_punt_redirect
572 autoreply define ip_container_proxy_add_del
583 /** \brief Configure IP source and L4 port-range check
584 @param client_index - opaque cookie to identify the sender
585 @param context - sender context, to match reply w/ request
586 @param is_ip6 - 1 if source address type is IPv6
587 @param is_add - 1 if add, 0 if delete
588 @param mask_length - mask length for address entry
589 @param address - array of address bytes
590 @param number_of_ranges - length of low_port and high_port arrays (must match)
591 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
592 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
593 @param vrf_id - fib table/vrf id to associate the source and port-range check with
594 @note To specify a single port set low_port and high_port entry the same
596 autoreply define ip_source_and_port_range_check_add_del
610 /** \brief Set interface source and L4 port-range request
611 @param client_index - opaque cookie to identify the sender
612 @param context - sender context, to match reply w/ request
613 @param interface_id - interface index
614 @param tcp_vrf_id - VRF associated with source and TCP port-range check
615 @param udp_vrf_id - VRF associated with source and TCP port-range check
617 autoreply define ip_source_and_port_range_check_interface_add_del
629 /** \brief Register for ip4 arp resolution events
630 @param client_index - opaque cookie to identify the sender
631 @param context - sender context, to match reply w/ request
632 @param enable_disable - 1 => register for events, 0 => cancel registration
633 @param pid - sender's pid
634 @param address - the exact ip4 address of interest
636 autoreply define want_ip4_arp_events
645 /** \brief Tell client about an ip4 arp resolution event
646 @param client_index - opaque cookie to identify the sender
647 @param address - the exact ip4 address of interest
648 @param pid - client pid registered to receive notification
649 @param sw_if_index - interface which received ARP packet
650 @param new_mac - the new mac address
651 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
664 rpc want_ip4_arp_events returns want_ip4_arp_events_reply
665 events ip4_arp_event;
668 /** \brief Register for ip6 nd resolution events
669 @param client_index - opaque cookie to identify the sender
670 @param context - sender context, to match reply w/ request
671 @param enable_disable - 1 => register for events, 0 => cancel registration
672 @param pid - sender's pid
673 @param address - the exact ip6 address of interest
675 autoreply define want_ip6_nd_events
684 /** \brief Tell client about an ip6 nd resolution or mac/ip event
685 @param client_index - opaque cookie to identify the sender
686 @param pid - client pid registered to receive notification
687 @param sw_if_index - interface which received ARP packet
688 @param address - the exact ip6 address of interest
689 @param new_mac - the new mac address
690 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
703 rpc want_ip6_nd_events returns want_ip6_nd_events_reply
707 /** \brief Proxy ARP add / del request
708 @param client_index - opaque cookie to identify the sender
709 @param context - sender context, to match reply w/ request
710 @param vrf_id - VRF / Fib table ID
711 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
712 @param low_address[4] - Low address of the Proxy ARP range
713 @param hi_address[4] - High address of the Proxy ARP range
715 autoreply define proxy_arp_add_del
725 /** \brief Proxy ARP add / del request
726 @param client_index - opaque cookie to identify the sender
727 @param context - sender context, to match reply w/ request
728 @param sw_if_index - Which interface to enable / disable Proxy Arp on
729 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
731 autoreply define proxy_arp_intfc_enable_disable
736 /* 1 = on, 0 = off */
740 /** \brief Reset fib table request
741 @param client_index - opaque cookie to identify the sender
742 @param context - sender context, to match reply w/ request
743 @param vrf_id - vrf/table id of the fib table to reset
744 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
746 autoreply define reset_fib
754 /** \brief Set max allowed ARP or ip6 neighbor entries request
755 @param client_index - opaque cookie to identify the sender
756 @param context - sender context, to match reply w/ request
757 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
758 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
760 autoreply define set_arp_neighbor_limit
765 u32 arp_neighbor_limit;
768 /** \brief IOAM enable : Enable in-band OAM
769 @param id - profile id
770 @param seqno - To enable Seqno Processing
771 @param analyse - Enabling analysis of iOAM at decap node
772 @param pow_enable - Proof of Work enabled or not flag
773 @param trace_enable - iOAM Trace enabled or not flag
775 autoreply define ioam_enable
787 /** \brief iOAM disable
788 @param client_index - opaque cookie to identify the sender
789 @param context - sender context, to match reply w/ request
790 @param index - MAP Domain index
792 autoreply define ioam_disable
799 autoreply define ip_reassembly_set
804 u32 max_reassemblies;
805 u32 expire_walk_interval_ms;
809 define ip_reassembly_get
816 define ip_reassembly_get_reply
822 u32 max_reassemblies;
823 u32 expire_walk_interval_ms;
829 * eval: (c-set-style "gnu")