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.3.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 is_static - [1|0] to indicate if neighbor is statically configured
124 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
126 define ip_neighbor_details {
135 /** \brief IP neighbor add / del request
136 @param client_index - opaque cookie to identify the sender
137 @param context - sender context, to match reply w/ request
138 @param sw_if_index - interface used to reach neighbor
139 @param is_add - 1 to add neighbor, 0 to delete
140 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
141 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
142 @param is_static - A static neighbor Entry - there are not flushed
143 If the interface goes down.
144 @param is_no_adj_fib - Do not create a corresponding entry in the FIB
145 table for the neighbor.
146 @param mac_address - l2 address of the neighbor
147 @param dst_address - ip4 or ip6 address of the neighbor
149 autoreply define ip_neighbor_add_del
154 /* 1 = add, 0 = delete */
163 /** \brief Set the ip flow hash config for a fib request
164 @param client_index - opaque cookie to identify the sender
165 @param context - sender context, to match reply w/ request
166 @param vrf_id - vrf/fib id
167 @param is_ipv6 - if non-zero the fib is ip6, else ip4
168 @param src - if non-zero include src in flow hash
169 @param dst - if non-zero include dst in flow hash
170 @param sport - if non-zero include sport in flow hash
171 @param dport - if non-zero include dport in flow hash
172 @param proto -if non-zero include proto in flow hash
173 @param reverse - if non-zero include reverse in flow hash
175 autoreply define set_ip_flow_hash
189 /** \brief IPv6 router advertisement config request
190 @param client_index - opaque cookie to identify the sender
191 @param context - sender context, to match reply w/ request
196 @param send_unicast -
199 @param default_router -
200 @param max_interval -
201 @param min_interval -
203 @param initial_count -
204 @param initial_interval -
206 autoreply define sw_interface_ip6nd_ra_config
223 u32 initial_interval;
226 /** \brief IPv6 router advertisement prefix config request
227 @param client_index - opaque cookie to identify the sender
228 @param context - sender context, to match reply w/ request
229 @param sw_if_index - The interface the RA prefix information is for
230 @param address[] - The prefix to advertise
231 @param address_length - the prefix length
232 @param use_default - Revert to default settings
233 @param no_advertise - Do not advertise this prefix
234 @param off_link - The prefix is off link (it is not configured on the interface)
235 Configures the L-flag, When set, indicates that this
236 prefix can be used for on-link determination.
237 @param no_autoconfig - Setting for the A-flag. When
238 set indicates that this prefix can be used for
239 stateless address configuration.
240 @param no_onlink - The prefix is not on link. Make sure this is consistent
241 with the off_link parameter else YMMV
242 @param is_no - add/delete
243 @param val_lifetime - The length of time in
244 seconds (relative to the time the packet is sent)
245 that the prefix is valid for the purpose of on-link
246 determination. A value of all one bits
247 (0xffffffff) represents infinity
248 @param pref_lifetime - The length of time in
249 seconds (relative to the time the packet is sent)
250 that addresses generated from the prefix via
251 stateless address autoconfiguration remain
252 preferred [ADDRCONF]. A value of all one bits
253 (0xffffffff) represents infinity.
255 autoreply define sw_interface_ip6nd_ra_prefix
272 /** \brief IPv6 ND proxy config
273 @param client_index - opaque cookie to identify the sender
274 @param context - sender context, to match reply w/ request
275 @param sw_if_index - The interface the host is on
276 @param address - The address of the host for which to proxy for
277 @param is_add - Adding or deleting
279 autoreply define ip6nd_proxy_add_del
288 /** \brief IPv6 ND proxy details returned after request
289 @param context - sender context, to match reply w/ request
290 @param retval - return code for the request
292 define ip6nd_proxy_details
299 /** \brief IPv6 ND proxy dump request
300 @param context - sender context, to match reply w/ request
301 @param retval - return code for the request
302 @param sw_if_index - The interface the host is on
303 @param address - The address of the host for which to proxy for
305 define ip6nd_proxy_dump
311 /** \brief Start / stop sending router solicitation
312 @param client_index - opaque cookie to identify the sender
313 @param context - sender context, to match reply w/ request
314 @param irt - initial retransmission time
315 @param mrt - maximum retransmission time
316 @param mrc - maximum retransmission count
317 @param mrd - maximum retransmission duration
318 @param sw_if_index - software interface index of interface
319 for sending router solicitation
320 @param stop - if non-zero then stop sending router solicitation,
321 otherwise start sending router solicitation
323 autoreply define ip6nd_send_router_solicitation
335 /** \brief IPv6 interface enable / disable 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 - interface used to reach neighbor
339 @param enable - if non-zero enable ip6 on interface, else disable
341 autoreply define sw_interface_ip6_enable_disable
346 u8 enable; /* set to true if enable */
349 /** \brief IPv6 set link local address on interface request
350 @param client_index - opaque cookie to identify the sender
351 @param context - sender context, to match reply w/ request
352 @param sw_if_index - interface to set link local on
353 @param address[] - the new link local address
355 autoreply define sw_interface_ip6_set_link_local_address
363 /** \brief Add / del route request
364 @param client_index - opaque cookie to identify the sender
365 @param context - sender context, to match reply w/ request
366 @param sw_if_index - software index of the new vlan's parent interface
367 @param vrf_id - fib table /vrf associated with the route
368 @param lookup_in_vrf -
369 @param classify_table_index -
370 @param is_add - 1 if adding the route, 0 if deleting
371 @param is_drop - Drop the packet
372 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
373 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
374 @param is_ipv6 - 0 if an ip4 route, else ip6
375 @param is_local - The route will result in packets sent to VPP IP stack
376 @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
378 @param is_multipath - Set to 1 if this is a multipath route, else 0
379 @param is_dvr - Does the route resolve via a DVR interface.
380 @param is_source_lookup - The the path is a deaggregate path (i.e. a lookup
381 in another table) is the lookup on the packet's
382 source address or destination.
383 @param next_hop_weight - Weight for Unequal cost multi-path
384 @param next_hop_preference - Path that are up that have the best preference are
385 are used for forwarding. lower value is better.
386 @param next_hop_id - Used when the path resolves via an object that has a unique
388 @param dst_address_length -
389 @param dst_address[16] -
390 @param next_hop_address[16] -
391 @param next_hop_n_out_labels - the number of labels in the label stack
392 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
393 @param next_hop_via_label - The next-hop is a resolved via a local label
395 define ip_add_del_route
399 u32 next_hop_sw_if_index;
401 u32 classify_table_index;
402 u32 next_hop_table_id;
413 u8 is_resolve_attached;
418 u8 next_hop_preference;
420 u8 dst_address_length;
422 u8 next_hop_address[16];
423 u8 next_hop_n_out_labels;
424 u32 next_hop_via_label;
425 vl_api_fib_mpls_label_t next_hop_out_label_stack[next_hop_n_out_labels];
428 define ip_add_del_route_reply
435 /** \brief Add / del route request
436 @param client_index - opaque cookie to identify the sender
437 @param context - sender context, to match reply w/ request
438 @param sw_if_index - software index of the new vlan's parent interface
439 @param vrf_id - fib table /vrf associated with the route
440 @param next_hop_afi - Use dpo_proto_t
443 define ip_mroute_add_del
447 u32 next_hop_sw_if_index;
453 u16 grp_address_length;
463 define ip_mroute_add_del_reply
470 /** \brief Dump IP multicast fib table
471 @param client_index - opaque cookie to identify the sender
479 /** \brief IP Multicast FIB table response
480 @param table_id - IP fib table id
481 @address_length - mask length
482 @grp_address - Group address/prefix
483 @src_address - Source address
484 @param count - the number of fib_path in path
485 @param path - array of of fib_path structures
487 manual_endian manual_print define ip_mfib_details
498 vl_api_fib_path_t path[count];
501 /** \brief Dump IP6 multicast fib table
502 @param client_index - opaque cookie to identify the sender
510 /** \brief IP6 Multicast FIB table response
511 @param table_id - IP fib table id
512 @address_length - mask length
513 @grp_address - Group address/prefix
514 @src_address - Source address
515 @param count - the number of fib_path in path
516 @param path - array of of fib_path structures
518 manual_endian manual_print define ip6_mfib_details
526 vl_api_fib_path_t path[count];
529 define ip_address_details
538 define ip_address_dump
546 /** \brief IP unnumbered configurations
547 @param sw_if_index The interface that has unnumbered configuration
548 @param ip_sw_if_index The IP interface that it is unnnumbered to
550 define ip_unnumbered_details
557 /** \brief Dump IP unnumbered configurations
558 @param sw_if_index ~0 for all interfaces, else the interface desired
560 define ip_unnumbered_dump
581 define mfib_signal_dump
587 define mfib_signal_details
596 u8 ip_packet_data[256];
599 /** \brief IP punt policer
600 @param client_index - opaque cookie to identify the sender
601 @param context - sender context, to match reply w/ request
602 @param is_add - 1 to add neighbor, 0 to delete
603 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
604 @param policer_index - Index of policer to use
606 autoreply define ip_punt_police
615 /** \brief IP punt redirect
616 @param client_index - opaque cookie to identify the sender
617 @param context - sender context, to match reply w/ request
618 @param is_add - 1 to add neighbor, 0 to delete
619 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
620 @param tx_sw_if_index - the TX interface to which traffic shoulde be
622 @param nh - The next-hop to redirect the traffic to.
624 autoreply define ip_punt_redirect
635 autoreply define ip_container_proxy_add_del
646 /** \brief Configure IP source and L4 port-range check
647 @param client_index - opaque cookie to identify the sender
648 @param context - sender context, to match reply w/ request
649 @param is_ip6 - 1 if source address type is IPv6
650 @param is_add - 1 if add, 0 if delete
651 @param mask_length - mask length for address entry
652 @param address - array of address bytes
653 @param number_of_ranges - length of low_port and high_port arrays (must match)
654 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
655 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
656 @param vrf_id - fib table/vrf id to associate the source and port-range check with
657 @note To specify a single port set low_port and high_port entry the same
659 autoreply define ip_source_and_port_range_check_add_del
673 /** \brief Set interface source and L4 port-range request
674 @param client_index - opaque cookie to identify the sender
675 @param context - sender context, to match reply w/ request
676 @param interface_id - interface index
677 @param tcp_vrf_id - VRF associated with source and TCP port-range check
678 @param udp_vrf_id - VRF associated with source and TCP port-range check
680 autoreply define ip_source_and_port_range_check_interface_add_del
692 /** \brief Enable/disable periodic IP neighbor scan
693 @param client_index - opaque cookie to identify the sender
694 @param context - sender context, to match reply w/ request
695 @param mode - 0: disable, 1: IPv4, 2: IPv6, 3: both IPv4/v6
696 @param scan_interval - neighbor scan interval in minutes, 0: default to 1
697 @param max_proc_time - max processing time per run in usec, 0: default to 20
698 @param max_update - max neighbor probe/delete per run, 0: default to 10
699 @param scan_int_delay - delay in msec to resume scan if exceed max proc
700 time or update, 0: default to 1
701 @param stale_threshold - threshold in minutes for neighbor deletion,
702 0: default to 4*scan_interval
704 autoreply define ip_scan_neighbor_enable_disable
716 /** \brief IP probe neighbor address on an interface by sending an
717 ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
718 @param client_index - opaque cookie to identify the sender
719 @param context - sender context, to match reply w/ request
720 @param sw_if_index - interface index
721 @param dst_address - target IP address to send IP addr resolution request
722 @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
724 autoreply define ip_probe_neighbor
733 /** \brief Register for IP4 ARP resolution event on receing ARP reply or
734 MAC/IP info from ARP requests in L2 BDs
735 @param client_index - opaque cookie to identify the sender
736 @param context - sender context, to match reply w/ request
737 @param enable_disable - 1 => register for events, 0 => cancel registration
738 @param pid - sender's pid
739 @param address - exact IP4 address of interested arp resolution event, or
740 0 to get MAC/IP info from ARP requests in BDs
742 autoreply define want_ip4_arp_events
751 /** \brief Tell client about an IP4 ARP resolution event or
752 MAC/IP info from ARP requests in L2 BDs
753 @param client_index - opaque cookie to identify the sender
754 @param address - the exact ip4 address of interest
755 @param pid - client pid registered to receive notification
756 @param sw_if_index - interface which received ARP packet
757 @param new_mac - the new mac address
758 @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
771 rpc want_ip4_arp_events returns want_ip4_arp_events_reply
772 events ip4_arp_event;
775 /** \brief Register for IP6 ND resolution event on recieving NA reply
776 MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
777 @param client_index - opaque cookie to identify the sender
778 @param context - sender context, to match reply w/ request
779 @param enable_disable - 1 => register for events, 0 => cancel registration
780 @param pid - sender's pid
781 @param address - the exact IP6 address of interested ND resolution event, or
782 0 to get MAC/IP info from ICMP6 NS in L2 BDs.
784 autoreply define want_ip6_nd_events
793 /** \brief Tell client about an IP6 ND resolution or
794 MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
795 @param client_index - opaque cookie to identify the sender
796 @param pid - client pid registered to receive notification
797 @param sw_if_index - interface which received ARP packet
798 @param address - the exact ip6 address of interest
799 @param new_mac - the new mac address
800 @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
813 rpc want_ip6_ra_events returns want_ip6_ra_events_reply
817 /** \brief Register for ip6 router advertisement events
818 @param client_index - opaque cookie to identify the sender
819 @param context - sender context, to match reply w/ request
820 @param enable_disable - 1 => register for events, 0 => cancel registration
821 @param pid - sender's pid
823 autoreply define want_ip6_ra_events
831 /** \brief Struct representing RA prefix info
832 @param dst_address - RA prefix info destination address
833 @param dst_address_length - RA prefix info destination address length
834 @param flags - RA prefix info flags
835 @param valid_time - RA prefix info valid time
836 @param preferred_time - RA prefix info preferred time
838 typeonly define ip6_ra_prefix_info
841 u8 dst_address_length;
847 /** \brief Tell client about a router advertisement event
848 @param client_index - opaque cookie to identify the sender
849 @param pid - client pid registered to receive notification
850 @param current_hop_limit - RA current hop limit
851 @param flags - RA flags
852 @param router_lifetime_in_sec - RA lifetime in seconds
853 @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
854 @param time_in_msec_between_retransmitted_neighbor_solicitations -
855 time in msec between retransmitted neighbor solicitations
864 u8 router_address[16];
865 u8 current_hop_limit;
867 u16 router_lifetime_in_sec;
868 u32 neighbor_reachable_time_in_msec;
869 u32 time_in_msec_between_retransmitted_neighbor_solicitations;
871 vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
875 rpc want_ip6_nd_events returns want_ip6_nd_events_reply
879 /** \brief Proxy ARP configuration type
880 @param vrf_id - VRF / Fib table ID
881 @param low_address[4] - Low address of the Proxy ARP range
882 @param hi_address[4] - High address of the Proxy ARP range
884 typeonly define proxy_arp
891 /** \brief Proxy ARP add / del request
892 @param client_index - opaque cookie to identify the sender
893 @param context - sender context, to match reply w/ request
894 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
895 @param proxy - Proxy configuration
897 autoreply define proxy_arp_add_del
902 vl_api_proxy_arp_t proxy;
905 /** \brief Proxy ARP dump request
907 define proxy_arp_dump
913 /** \brief Proxy ARP dump details reply
914 * @param proxy - Same data as used to configure
916 define proxy_arp_details
919 vl_api_proxy_arp_t proxy;
922 /** \brief Proxy ARP add / del interface request
923 @param client_index - opaque cookie to identify the sender
924 @param context - sender context, to match reply w/ request
925 @param sw_if_index - Which interface to enable / disable Proxy Arp on
926 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
928 autoreply define proxy_arp_intfc_enable_disable
933 /* 1 = on, 0 = off */
937 /** \brief Proxy ARP interface dump request
939 define proxy_arp_intfc_dump
945 /** \brief Proxy ARP interface dump details reply
946 * @param sw_if_index The interface on which ARP proxy is enabled.
948 define proxy_arp_intfc_details
954 /** \brief Reset fib table request
955 @param client_index - opaque cookie to identify the sender
956 @param context - sender context, to match reply w/ request
957 @param vrf_id - vrf/table id of the fib table to reset
958 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
960 autoreply define reset_fib
968 /** \brief Set max allowed ARP or ip6 neighbor entries request
969 @param client_index - opaque cookie to identify the sender
970 @param context - sender context, to match reply w/ request
971 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
972 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
974 autoreply define set_arp_neighbor_limit
979 u32 arp_neighbor_limit;
982 /** \brief IOAM enable : Enable in-band OAM
983 @param id - profile id
984 @param seqno - To enable Seqno Processing
985 @param analyse - Enabling analysis of iOAM at decap node
986 @param pow_enable - Proof of Work enabled or not flag
987 @param trace_enable - iOAM Trace enabled or not flag
989 autoreply define ioam_enable
1001 /** \brief iOAM disable
1002 @param client_index - opaque cookie to identify the sender
1003 @param context - sender context, to match reply w/ request
1004 @param index - MAP Domain index
1006 autoreply define ioam_disable
1013 autoreply define ip_reassembly_set
1018 u32 max_reassemblies;
1019 u32 expire_walk_interval_ms;
1023 define ip_reassembly_get
1030 define ip_reassembly_get_reply
1035 u32 max_reassemblies;
1036 u32 expire_walk_interval_ms;
1040 /** \brief Enable/disable reassembly feature
1041 @param client_index - opaque cookie to identify the sender
1042 @param context - sender context, to match reply w/ request
1043 @param sw_if_index - interface to enable/disable feature on
1044 @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
1045 @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
1047 autoreply define ip_reassembly_enable_disable
1058 * eval: (c-set-style "gnu")