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 = "1.4.0";
24 import "vnet/ip/ip_types.api";
25 import "vnet/fib/fib_types.api";
26 import "vnet/ethernet/ethernet_types.api";
28 /** \brief Add / del table request
29 A table can be added multiple times, but need be deleted only once.
30 @param client_index - opaque cookie to identify the sender
31 @param context - sender context, to match reply w/ request
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 unicats
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
40 autoreply define ip_table_add_del
50 /** \brief Dump IP fib table
51 @param client_index - opaque cookie to identify the sender
59 /** \brief IP FIB table response
60 @param table_id - IP fib table id
61 @address_length - mask length
63 @param count - the number of fib_path in path
64 @param path - array of of fib_path structures
66 manual_endian manual_print define ip_fib_details
75 vl_api_fib_path_t path[count];
78 /** \brief Dump IP6 fib table
79 @param client_index - opaque cookie to identify the sender
87 /** \brief IP6 FIB table entry response
88 @param table_id - IP6 fib table id
89 @param address_length - mask length
90 @param address - ip6 prefix
91 @param count - the number of fib_path in path
92 @param path - array of of fib_path structures
94 manual_endian manual_print define ip6_fib_details
103 vl_api_fib_path_t path[count];
106 /** \brief Dump IP neighboors
107 @param client_index - opaque cookie to identify the sender
108 @param context - sender context, to match reply w/ request
109 @param sw_if_index - the interface to dump neighboors, ~0 == all
110 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
112 define ip_neighbor_dump
120 /** \brief IP neighboors dump response
121 @param context - sender context which was passed in the request
122 @param sw_if_index - The interface used to reach the neighbor
123 @param stats_index - An index in the stats segment that can be used to read
124 the counters for this neighbour.
125 @param is_static - [1|0] to indicate if neighbor is statically configured
126 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
128 define ip_neighbor_details {
138 /** \brief IP neighbor add / del request
139 @param client_index - opaque cookie to identify the sender
140 @param context - sender context, to match reply w/ request
141 @param sw_if_index - interface used to reach neighbor
142 @param is_add - 1 to add neighbor, 0 to delete
143 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
144 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
145 @param is_static - A static neighbor Entry - there are not flushed
146 If the interface goes down.
147 @param is_no_adj_fib - Do not create a corresponding entry in the FIB
148 table for the neighbor.
149 @param mac_address - l2 address of the neighbor
150 @param dst_address - ip4 or ip6 address of the neighbor
152 define ip_neighbor_add_del
157 /* 1 = add, 0 = delete */
166 define ip_neighbor_add_del_reply
173 /** \brief Set the ip flow hash config for a fib request
174 @param client_index - opaque cookie to identify the sender
175 @param context - sender context, to match reply w/ request
176 @param vrf_id - vrf/fib id
177 @param is_ipv6 - if non-zero the fib is ip6, else ip4
178 @param src - if non-zero include src in flow hash
179 @param dst - if non-zero include dst in flow hash
180 @param sport - if non-zero include sport in flow hash
181 @param dport - if non-zero include dport in flow hash
182 @param proto -if non-zero include proto in flow hash
183 @param reverse - if non-zero include reverse in flow hash
184 @param symmetric - if non-zero include symmetry in flow hash
186 autoreply define set_ip_flow_hash
201 /** \brief IPv6 router advertisement config request
202 @param client_index - opaque cookie to identify the sender
203 @param context - sender context, to match reply w/ request
208 @param send_unicast -
211 @param default_router -
212 @param max_interval -
213 @param min_interval -
215 @param initial_count -
216 @param initial_interval -
218 autoreply define sw_interface_ip6nd_ra_config
235 u32 initial_interval;
238 /** \brief IPv6 router advertisement prefix config request
239 @param client_index - opaque cookie to identify the sender
240 @param context - sender context, to match reply w/ request
241 @param sw_if_index - The interface the RA prefix information is for
242 @param address[] - The prefix to advertise
243 @param address_length - the prefix length
244 @param use_default - Revert to default settings
245 @param no_advertise - Do not advertise this prefix
246 @param off_link - The prefix is off link (it is not configured on the interface)
247 Configures the L-flag, When set, indicates that this
248 prefix can be used for on-link determination.
249 @param no_autoconfig - Setting for the A-flag. When
250 set indicates that this prefix can be used for
251 stateless address configuration.
252 @param no_onlink - The prefix is not on link. Make sure this is consistent
253 with the off_link parameter else YMMV
254 @param is_no - add/delete
255 @param val_lifetime - The length of time in
256 seconds (relative to the time the packet is sent)
257 that the prefix is valid for the purpose of on-link
258 determination. A value of all one bits
259 (0xffffffff) represents infinity
260 @param pref_lifetime - The length of time in
261 seconds (relative to the time the packet is sent)
262 that addresses generated from the prefix via
263 stateless address autoconfiguration remain
264 preferred [ADDRCONF]. A value of all one bits
265 (0xffffffff) represents infinity.
267 autoreply define sw_interface_ip6nd_ra_prefix
284 /** \brief IPv6 ND proxy config
285 @param client_index - opaque cookie to identify the sender
286 @param context - sender context, to match reply w/ request
287 @param sw_if_index - The interface the host is on
288 @param address - The address of the host for which to proxy for
289 @param is_add - Adding or deleting
291 autoreply define ip6nd_proxy_add_del
300 /** \brief IPv6 ND proxy details returned after request
301 @param context - sender context, to match reply w/ request
302 @param retval - return code for the request
304 define ip6nd_proxy_details
311 /** \brief IPv6 ND proxy dump request
312 @param context - sender context, to match reply w/ request
313 @param retval - return code for the request
314 @param sw_if_index - The interface the host is on
315 @param address - The address of the host for which to proxy for
317 define ip6nd_proxy_dump
323 /** \brief Start / stop sending router solicitation
324 @param client_index - opaque cookie to identify the sender
325 @param context - sender context, to match reply w/ request
326 @param irt - initial retransmission time
327 @param mrt - maximum retransmission time
328 @param mrc - maximum retransmission count
329 @param mrd - maximum retransmission duration
330 @param sw_if_index - software interface index of interface
331 for sending router solicitation
332 @param stop - if non-zero then stop sending router solicitation,
333 otherwise start sending router solicitation
335 autoreply define ip6nd_send_router_solicitation
347 /** \brief IPv6 interface enable / disable request
348 @param client_index - opaque cookie to identify the sender
349 @param context - sender context, to match reply w/ request
350 @param sw_if_index - interface used to reach neighbor
351 @param enable - if non-zero enable ip6 on interface, else disable
353 autoreply define sw_interface_ip6_enable_disable
358 u8 enable; /* set to true if enable */
361 /** \brief Add / del route request
362 @param client_index - opaque cookie to identify the sender
363 @param context - sender context, to match reply w/ request
364 @param sw_if_index - software index of the new vlan's parent interface
365 @param vrf_id - fib table /vrf associated with the route
366 @param lookup_in_vrf -
367 @param classify_table_index -
368 @param is_add - 1 if adding the route, 0 if deleting
369 @param is_drop - Drop the packet
370 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
371 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
372 @param is_ipv6 - 0 if an ip4 route, else ip6
373 @param is_local - The route will result in packets sent to VPP IP stack
374 @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
376 @param is_multipath - Set to 1 if this is a multipath route, else 0
377 @param is_dvr - Does the route resolve via a DVR interface.
378 @param is_source_lookup - The the path is a deaggregate path (i.e. a lookup
379 in another table) is the lookup on the packet's
380 source address or destination.
381 @param next_hop_weight - Weight for Unequal cost multi-path
382 @param next_hop_preference - Path that are up that have the best preference are
383 are used for forwarding. lower value is better.
384 @param next_hop_id - Used when the path resolves via an object that has a unique
386 @param dst_address_length -
387 @param dst_address[16] -
388 @param next_hop_address[16] -
389 @param next_hop_n_out_labels - the number of labels in the label stack
390 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
391 @param next_hop_via_label - The next-hop is a resolved via a local label
393 define ip_add_del_route
397 u32 next_hop_sw_if_index;
399 u32 classify_table_index;
400 u32 next_hop_table_id;
411 u8 is_resolve_attached;
416 u8 next_hop_preference;
418 u8 dst_address_length;
420 u8 next_hop_address[16];
421 u8 next_hop_n_out_labels;
422 u32 next_hop_via_label;
423 vl_api_fib_mpls_label_t next_hop_out_label_stack[next_hop_n_out_labels];
426 define ip_add_del_route_reply
433 /** \brief Add / del route request
435 Adds a route, consisting both of the MFIB entry to match packets
436 (which may already exist) and a path to send those packets down.
437 Routes can be entered repeatedly to add multiple paths. Deletions are
440 @param client_index - opaque cookie to identify the sender
441 @param context - sender context, to match reply w/ request
442 @param table_id - fib table /vrf associated with the route
443 @param is_add - true if adding a route; false if deleting one
444 @param is_ipv6 - true iff all the addresses are v6
445 @param entry_flags - see fib_entry_flag_t
446 @param itf_flags - see mfib_entry_flags_t
447 @param next_hop_afi - see dpo_proto_t; the type of destination description
448 @param src_address - the source of the packet
449 @param grp_address - the group the packet is destined to
450 @param nh_address - the nexthop to forward the packet to
451 @param next_hop_sw_if_index - interface to emit packet on
453 BIER AFIs use the BIER imposition ID. v4 and v6 AFIs use either the
454 interface or the nexthop address.
456 Note that if the route is source-specific (S is supplied, not all 0s),
457 the prefix match is treated as exact (prefixlen /32 or /128).
459 FIXME not complete yet
461 define ip_mroute_add_del
465 u32 next_hop_sw_if_index;
471 u16 grp_address_length;
481 define ip_mroute_add_del_reply
488 /** \brief Dump IP multicast fib table
489 @param client_index - opaque cookie to identify the sender
497 /** \brief IP Multicast FIB table response
498 @param table_id - IP fib table id
499 @address_length - mask length
500 @grp_address - Group address/prefix
501 @src_address - Source address
502 @param count - the number of fib_path in path
503 @param path - array of of fib_path structures
505 manual_endian manual_print define ip_mfib_details
516 vl_api_fib_path_t path[count];
519 /** \brief Dump IP6 multicast fib table
520 @param client_index - opaque cookie to identify the sender
528 /** \brief IP6 Multicast FIB table response
529 @param table_id - IP fib table id
530 @address_length - mask length
531 @grp_address - Group address/prefix
532 @src_address - Source address
533 @param count - the number of fib_path in path
534 @param path - array of of fib_path structures
536 manual_endian manual_print define ip6_mfib_details
544 vl_api_fib_path_t path[count];
547 define ip_address_details
556 define ip_address_dump
564 /** \brief IP unnumbered configurations
565 @param sw_if_index The interface that has unnumbered configuration
566 @param ip_sw_if_index The IP interface that it is unnnumbered to
568 define ip_unnumbered_details
575 /** \brief Dump IP unnumbered configurations
576 @param sw_if_index ~0 for all interfaces, else the interface desired
578 define ip_unnumbered_dump
599 define mfib_signal_dump
605 define mfib_signal_details
614 u8 ip_packet_data[256];
617 /** \brief IP punt policer
618 @param client_index - opaque cookie to identify the sender
619 @param context - sender context, to match reply w/ request
620 @param is_add - 1 to add neighbor, 0 to delete
621 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
622 @param policer_index - Index of policer to use
624 autoreply define ip_punt_police
633 /** \brief Punt redirect type
634 @param rx_sw_if_index - specify the original RX interface of traffic
635 that should be redirected. ~0 means any interface.
636 @param tx_sw_if_index - the TX interface to which traffic shoulde be
638 @param nh - the next-hop to redirect the traffic to.
639 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
641 typeonly define punt_redirect
648 /** \brief IP punt redirect
649 @param client_index - opaque cookie to identify the sender
650 @param context - sender context, to match reply w/ request
651 @param punt - punt definition
652 @param is_add - 1 to add neighbor, 0 to delete
654 autoreply define ip_punt_redirect
658 vl_api_punt_redirect_t punt;
662 define ip_punt_redirect_dump
670 define ip_punt_redirect_details
673 vl_api_punt_redirect_t punt;
676 autoreply define ip_container_proxy_add_del
687 define ip_container_proxy_dump
693 define ip_container_proxy_details
697 vl_api_prefix_t prefix;
700 /** \brief Configure IP source and L4 port-range check
701 @param client_index - opaque cookie to identify the sender
702 @param context - sender context, to match reply w/ request
703 @param is_ip6 - 1 if source address type is IPv6
704 @param is_add - 1 if add, 0 if delete
705 @param mask_length - mask length for address entry
706 @param address - array of address bytes
707 @param number_of_ranges - length of low_port and high_port arrays (must match)
708 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
709 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
710 @param vrf_id - fib table/vrf id to associate the source and port-range check with
711 @note To specify a single port set low_port and high_port entry the same
713 autoreply define ip_source_and_port_range_check_add_del
727 /** \brief Set interface source and L4 port-range request
728 @param client_index - opaque cookie to identify the sender
729 @param context - sender context, to match reply w/ request
730 @param interface_id - interface index
731 @param tcp_vrf_id - VRF associated with source and TCP port-range check
732 @param udp_vrf_id - VRF associated with source and TCP port-range check
734 autoreply define ip_source_and_port_range_check_interface_add_del
746 /** \brief Set interface source check request
747 @param client_index - opaque cookie to identify the sender
748 @param context - sender context, to match reply w/ request
749 @param is_add - add or del
750 @param loose - strict or loose
751 @param sw_if_index - interface index
753 autoreply define ip_source_check_interface_add_del
762 /** \brief Enable/disable periodic IP neighbor scan
763 @param client_index - opaque cookie to identify the sender
764 @param context - sender context, to match reply w/ request
765 @param mode - 0: disable, 1: IPv4, 2: IPv6, 3: both IPv4/v6
766 @param scan_interval - neighbor scan interval in minutes, 0: default to 1
767 @param max_proc_time - max processing time per run in usec, 0: default to 20
768 @param max_update - max neighbor probe/delete per run, 0: default to 10
769 @param scan_int_delay - delay in msec to resume scan if exceed max proc
770 time or update, 0: default to 1
771 @param stale_threshold - threshold in minutes for neighbor deletion,
772 0: default to 4*scan_interval
774 autoreply define ip_scan_neighbor_enable_disable
786 /** \brief IP probe neighbor address on an interface by sending an
787 ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
788 @param client_index - opaque cookie to identify the sender
789 @param context - sender context, to match reply w/ request
790 @param sw_if_index - interface index
791 @param dst_address - target IP address to send IP addr resolution request
792 @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
794 autoreply define ip_probe_neighbor
803 /** \brief Register for IP4 ARP resolution event on receing ARP reply or
804 MAC/IP info from ARP requests in L2 BDs
805 @param client_index - opaque cookie to identify the sender
806 @param context - sender context, to match reply w/ request
807 @param enable_disable - 1 => register for events, 0 => cancel registration
808 @param pid - sender's pid
809 @param address - exact IP4 address of interested arp resolution event, or
810 0 to get MAC/IP info from ARP requests in BDs
812 autoreply define want_ip4_arp_events
821 /** \brief Tell client about an IP4 ARP resolution event or
822 MAC/IP info from ARP requests in L2 BDs
823 @param client_index - opaque cookie to identify the sender
824 @param address - the exact ip4 address of interest
825 @param pid - client pid registered to receive notification
826 @param sw_if_index - interface which received ARP packet
827 @param new_mac - the new mac address
828 @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
841 rpc want_ip4_arp_events returns want_ip4_arp_events_reply
842 events ip4_arp_event;
845 /** \brief Register for IP6 ND resolution event on recieving NA reply
846 MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
847 @param client_index - opaque cookie to identify the sender
848 @param context - sender context, to match reply w/ request
849 @param enable_disable - 1 => register for events, 0 => cancel registration
850 @param pid - sender's pid
851 @param address - the exact IP6 address of interested ND resolution event, or
852 0 to get MAC/IP info from ICMP6 NS in L2 BDs.
854 autoreply define want_ip6_nd_events
863 /** \brief Tell client about an IP6 ND resolution or
864 MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
865 @param client_index - opaque cookie to identify the sender
866 @param pid - client pid registered to receive notification
867 @param sw_if_index - interface which received ARP packet
868 @param address - the exact ip6 address of interest
869 @param new_mac - the new mac address
870 @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
883 rpc want_ip6_ra_events returns want_ip6_ra_events_reply
887 /** \brief Register for ip6 router advertisement events
888 @param client_index - opaque cookie to identify the sender
889 @param context - sender context, to match reply w/ request
890 @param enable_disable - 1 => register for events, 0 => cancel registration
891 @param pid - sender's pid
893 autoreply define want_ip6_ra_events
901 /** \brief Struct representing RA prefix info
902 @param dst_address - RA prefix info destination address
903 @param dst_address_length - RA prefix info destination address length
904 @param flags - RA prefix info flags
905 @param valid_time - RA prefix info valid time
906 @param preferred_time - RA prefix info preferred time
908 typeonly define ip6_ra_prefix_info
911 u8 dst_address_length;
917 /** \brief Tell client about a router advertisement event
918 @param client_index - opaque cookie to identify the sender
919 @param pid - client pid registered to receive notification
920 @param current_hop_limit - RA current hop limit
921 @param flags - RA flags
922 @param router_lifetime_in_sec - RA lifetime in seconds
923 @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
924 @param time_in_msec_between_retransmitted_neighbor_solicitations -
925 time in msec between retransmitted neighbor solicitations
934 u8 router_address[16];
935 u8 current_hop_limit;
937 u16 router_lifetime_in_sec;
938 u32 neighbor_reachable_time_in_msec;
939 u32 time_in_msec_between_retransmitted_neighbor_solicitations;
941 vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
945 rpc want_ip6_nd_events returns want_ip6_nd_events_reply
949 /** \brief Proxy ARP configuration type
950 @param vrf_id - VRF / Fib table ID
951 @param low_address[4] - Low address of the Proxy ARP range
952 @param hi_address[4] - High address of the Proxy ARP range
954 typeonly define proxy_arp
961 /** \brief Proxy ARP add / del request
962 @param client_index - opaque cookie to identify the sender
963 @param context - sender context, to match reply w/ request
964 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
965 @param proxy - Proxy configuration
967 autoreply define proxy_arp_add_del
972 vl_api_proxy_arp_t proxy;
975 /** \brief Proxy ARP dump request
977 define proxy_arp_dump
983 /** \brief Proxy ARP dump details reply
984 * @param proxy - Same data as used to configure
986 define proxy_arp_details
989 vl_api_proxy_arp_t proxy;
992 /** \brief Proxy ARP add / del interface request
993 @param client_index - opaque cookie to identify the sender
994 @param context - sender context, to match reply w/ request
995 @param sw_if_index - Which interface to enable / disable Proxy Arp on
996 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
998 autoreply define proxy_arp_intfc_enable_disable
1003 /* 1 = on, 0 = off */
1007 /** \brief Proxy ARP interface dump request
1009 define proxy_arp_intfc_dump
1015 /** \brief Proxy ARP interface dump details reply
1016 * @param sw_if_index The interface on which ARP proxy is enabled.
1018 define proxy_arp_intfc_details
1024 /** \brief Reset fib table request
1025 @param client_index - opaque cookie to identify the sender
1026 @param context - sender context, to match reply w/ request
1027 @param vrf_id - vrf/table id of the fib table to reset
1028 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
1030 autoreply define reset_fib
1038 /** \brief Set max allowed ARP or ip6 neighbor entries request
1039 @param client_index - opaque cookie to identify the sender
1040 @param context - sender context, to match reply w/ request
1041 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1042 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1044 autoreply define set_arp_neighbor_limit
1049 u32 arp_neighbor_limit;
1052 /** \brief IOAM enable : Enable in-band OAM
1053 @param id - profile id
1054 @param seqno - To enable Seqno Processing
1055 @param analyse - Enabling analysis of iOAM at decap node
1056 @param pow_enable - Proof of Work enabled or not flag
1057 @param trace_enable - iOAM Trace enabled or not flag
1059 autoreply define ioam_enable
1071 /** \brief iOAM disable
1072 @param client_index - opaque cookie to identify the sender
1073 @param context - sender context, to match reply w/ request
1074 @param index - MAP Domain index
1076 autoreply define ioam_disable
1083 autoreply define ip_reassembly_set
1088 u32 max_reassemblies;
1089 u32 expire_walk_interval_ms;
1093 define ip_reassembly_get
1100 define ip_reassembly_get_reply
1105 u32 max_reassemblies;
1106 u32 expire_walk_interval_ms;
1110 /** \brief Enable/disable reassembly feature
1111 @param client_index - opaque cookie to identify the sender
1112 @param context - sender context, to match reply w/ request
1113 @param sw_if_index - interface to enable/disable feature on
1114 @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
1115 @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
1117 autoreply define ip_reassembly_enable_disable
1128 * eval: (c-set-style "gnu")