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.3.0";
23 import "vnet/ip/ip_types.api";
24 import "vnet/fib/fib_types.api";
26 /** \brief Add / del table request
27 A table can be added multiple times, but need be deleted only once.
28 @param client_index - opaque cookie to identify the sender
29 @param context - sender context, to match reply w/ request
30 @param is_ipv6 - V4 or V6 table
31 @param table_id - table ID associated with the route
32 This table ID will apply to both the unicats
34 @param name - A client provided name/tag for the table. If this is
35 not set by the client, then VPP will generate something
38 autoreply define ip_table_add_del
48 /** \brief Dump IP fib table
49 @param client_index - opaque cookie to identify the sender
57 /** \brief IP FIB table response
58 @param table_id - IP fib table id
59 @address_length - mask length
61 @param count - the number of fib_path in path
62 @param path - array of of fib_path structures
64 manual_endian manual_print define ip_fib_details
72 vl_api_fib_path_t path[count];
75 /** \brief Dump IP6 fib table
76 @param client_index - opaque cookie to identify the sender
84 /** \brief IP6 FIB table entry response
85 @param table_id - IP6 fib table id
86 @param address_length - mask length
87 @param address - ip6 prefix
88 @param count - the number of fib_path in path
89 @param path - array of of fib_path structures
91 manual_endian manual_print define ip6_fib_details
99 vl_api_fib_path_t path[count];
102 /** \brief Dump IP neighboors
103 @param client_index - opaque cookie to identify the sender
104 @param context - sender context, to match reply w/ request
105 @param sw_if_index - the interface to dump neighboors, ~0 == all
106 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
108 define ip_neighbor_dump
116 /** \brief IP neighboors dump response
117 @param context - sender context which was passed in the request
118 @param sw_if_index - The interface used to reach the neighbor
119 @param is_static - [1|0] to indicate if neighbor is statically configured
120 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
122 define ip_neighbor_details {
131 /** \brief IP neighbor add / del request
132 @param client_index - opaque cookie to identify the sender
133 @param context - sender context, to match reply w/ request
134 @param sw_if_index - interface used to reach neighbor
135 @param is_add - 1 to add neighbor, 0 to delete
136 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
137 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
138 @param is_static - A static neighbor Entry - there are not flushed
139 If the interface goes down.
140 @param is_no_adj_fib - Do not create a corresponding entry in the FIB
141 table for the neighbor.
142 @param mac_address - l2 address of the neighbor
143 @param dst_address - ip4 or ip6 address of the neighbor
145 autoreply define ip_neighbor_add_del
150 /* 1 = add, 0 = delete */
159 /** \brief Set the ip flow hash config for a fib request
160 @param client_index - opaque cookie to identify the sender
161 @param context - sender context, to match reply w/ request
162 @param vrf_id - vrf/fib id
163 @param is_ipv6 - if non-zero the fib is ip6, else ip4
164 @param src - if non-zero include src in flow hash
165 @param dst - if non-zero include dst in flow hash
166 @param sport - if non-zero include sport in flow hash
167 @param dport - if non-zero include dport in flow hash
168 @param proto -if non-zero include proto in flow hash
169 @param reverse - if non-zero include reverse in flow hash
171 autoreply define set_ip_flow_hash
185 /** \brief IPv6 router advertisement config request
186 @param client_index - opaque cookie to identify the sender
187 @param context - sender context, to match reply w/ request
192 @param send_unicast -
195 @param default_router -
196 @param max_interval -
197 @param min_interval -
199 @param initial_count -
200 @param initial_interval -
202 autoreply define sw_interface_ip6nd_ra_config
219 u32 initial_interval;
222 /** \brief IPv6 router advertisement prefix config request
223 @param client_index - opaque cookie to identify the sender
224 @param context - sender context, to match reply w/ request
225 @param sw_if_index - The interface the RA prefix information is for
226 @param address[] - The prefix to advertise
227 @param address_length - the prefix length
228 @param use_default - Revert to default settings
229 @param no_advertise - Do not advertise this prefix
230 @param off_link - The prefix is off link (it is not configured on the interface)
231 Configures the L-flag, When set, indicates that this
232 prefix can be used for on-link determination.
233 @param no_autoconfig - Setting for the A-flag. When
234 set indicates that this prefix can be used for
235 stateless address configuration.
236 @param no_onlink - The prefix is not on link. Make sure this is consistent
237 with the off_link parameter else YMMV
238 @param is_no - add/delete
239 @param val_lifetime - The length of time in
240 seconds (relative to the time the packet is sent)
241 that the prefix is valid for the purpose of on-link
242 determination. A value of all one bits
243 (0xffffffff) represents infinity
244 @param pref_lifetime - The length of time in
245 seconds (relative to the time the packet is sent)
246 that addresses generated from the prefix via
247 stateless address autoconfiguration remain
248 preferred [ADDRCONF]. A value of all one bits
249 (0xffffffff) represents infinity.
251 autoreply define sw_interface_ip6nd_ra_prefix
268 /** \brief IPv6 ND proxy config
269 @param client_index - opaque cookie to identify the sender
270 @param context - sender context, to match reply w/ request
271 @param sw_if_index - The interface the host is on
272 @param address - The address of the host for which to proxy for
273 @param is_add - Adding or deleting
275 autoreply define ip6nd_proxy_add_del
284 /** \brief IPv6 ND proxy details returned after request
285 @param context - sender context, to match reply w/ request
286 @param retval - return code for the request
288 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 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
319 autoreply define ip6nd_send_router_solicitation
331 /** \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
337 autoreply define sw_interface_ip6_enable_disable
342 u8 enable; /* set to true if enable */
345 /** \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
351 autoreply define sw_interface_ip6_set_link_local_address
359 /** \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 -
366 @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
371 @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.
374 @param is_multipath - Set to 1 if this is a multipath route, else 0
375 @param is_dvr - Does the route resolve via a DVR interface.
376 @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.
379 @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
384 @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
391 autoreply define ip_add_del_route
395 u32 next_hop_sw_if_index;
397 u32 classify_table_index;
398 u32 next_hop_table_id;
409 u8 is_resolve_attached;
414 u8 next_hop_preference;
416 u8 dst_address_length;
418 u8 next_hop_address[16];
419 u8 next_hop_n_out_labels;
420 u32 next_hop_via_label;
421 vl_api_fib_mpls_label_t next_hop_out_label_stack[next_hop_n_out_labels];
424 /** \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
429 @param next_hop_afi - Use dpo_proto_t
432 autoreply define ip_mroute_add_del
436 u32 next_hop_sw_if_index;
442 u16 grp_address_length;
452 /** \brief Dump IP multicast fib table
453 @param client_index - opaque cookie to identify the sender
461 /** \brief IP Multicast FIB table response
462 @param table_id - IP fib table id
463 @address_length - mask length
464 @grp_address - Group address/prefix
465 @src_address - Source address
466 @param count - the number of fib_path in path
467 @param path - array of of fib_path structures
469 manual_endian manual_print define ip_mfib_details
479 vl_api_fib_path_t path[count];
482 /** \brief Dump IP6 multicast fib table
483 @param client_index - opaque cookie to identify the sender
491 /** \brief IP6 Multicast FIB table response
492 @param table_id - IP fib table id
493 @address_length - mask length
494 @grp_address - Group address/prefix
495 @src_address - Source address
496 @param count - the number of fib_path in path
497 @param path - array of of fib_path structures
499 manual_endian manual_print define ip6_mfib_details
507 vl_api_fib_path_t path[count];
510 define ip_address_details
519 define ip_address_dump
527 /** \brief IP unnumbered configurations
528 @param sw_if_index The interface that has unnumbered configuration
529 @param ip_sw_if_index The IP interface that it is unnnumbered to
531 define ip_unnumbered_details
538 /** \brief Dump IP unnumbered configurations
539 @param sw_if_index ~0 for all interfaces, else the interface desired
541 define ip_unnumbered_dump
562 define mfib_signal_dump
568 define mfib_signal_details
577 u8 ip_packet_data[256];
580 /** \brief IP punt policer
581 @param client_index - opaque cookie to identify the sender
582 @param context - sender context, to match reply w/ request
583 @param is_add - 1 to add neighbor, 0 to delete
584 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
585 @param policer_index - Index of policer to use
587 autoreply define ip_punt_police
596 /** \brief IP punt redirect
597 @param client_index - opaque cookie to identify the sender
598 @param context - sender context, to match reply w/ request
599 @param is_add - 1 to add neighbor, 0 to delete
600 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
601 @param tx_sw_if_index - the TX interface to which traffic shoulde be
603 @param nh - The next-hop to redirect the traffic to.
605 autoreply define ip_punt_redirect
616 autoreply define ip_container_proxy_add_del
627 /** \brief Configure IP source and L4 port-range check
628 @param client_index - opaque cookie to identify the sender
629 @param context - sender context, to match reply w/ request
630 @param is_ip6 - 1 if source address type is IPv6
631 @param is_add - 1 if add, 0 if delete
632 @param mask_length - mask length for address entry
633 @param address - array of address bytes
634 @param number_of_ranges - length of low_port and high_port arrays (must match)
635 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
636 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
637 @param vrf_id - fib table/vrf id to associate the source and port-range check with
638 @note To specify a single port set low_port and high_port entry the same
640 autoreply define ip_source_and_port_range_check_add_del
654 /** \brief Set interface source and L4 port-range request
655 @param client_index - opaque cookie to identify the sender
656 @param context - sender context, to match reply w/ request
657 @param interface_id - interface index
658 @param tcp_vrf_id - VRF associated with source and TCP port-range check
659 @param udp_vrf_id - VRF associated with source and TCP port-range check
661 autoreply define ip_source_and_port_range_check_interface_add_del
673 /** \brief Enable/disable periodic IP neighbor scan
674 @param client_index - opaque cookie to identify the sender
675 @param context - sender context, to match reply w/ request
676 @param mode - 0: disable, 1: IPv4, 2: IPv6, 3: both IPv4/v6
677 @param scan_interval - neighbor scan interval in minutes, 0: default to 1
678 @param max_proc_time - max processing time per run in usec, 0: default to 20
679 @param max_update - max neighbor probe/delete per run, 0: default to 10
680 @param scan_int_delay - delay in msec to resume scan if exceed max proc
681 time or update, 0: default to 1
682 @param stale_threshold - threshold in minutes for neighbor deletion,
683 0: default to 4*scan_interval
685 autoreply define ip_scan_neighbor_enable_disable
697 /** \brief IP probe neighbor address on an interface by sending an
698 ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
699 @param client_index - opaque cookie to identify the sender
700 @param context - sender context, to match reply w/ request
701 @param sw_if_index - interface index
702 @param dst_address - target IP address to send IP addr resolution request
703 @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
705 autoreply define ip_probe_neighbor
714 /** \brief Register for IP4 ARP resolution event on receing ARP reply or
715 MAC/IP info from ARP requests in L2 BDs
716 @param client_index - opaque cookie to identify the sender
717 @param context - sender context, to match reply w/ request
718 @param enable_disable - 1 => register for events, 0 => cancel registration
719 @param pid - sender's pid
720 @param address - exact IP4 address of interested arp resolution event, or
721 0 to get MAC/IP info from ARP requests in BDs
723 autoreply define want_ip4_arp_events
732 /** \brief Tell client about an IP4 ARP resolution event or
733 MAC/IP info from ARP requests in L2 BDs
734 @param client_index - opaque cookie to identify the sender
735 @param address - the exact ip4 address of interest
736 @param pid - client pid registered to receive notification
737 @param sw_if_index - interface which received ARP packet
738 @param new_mac - the new mac address
739 @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
752 rpc want_ip4_arp_events returns want_ip4_arp_events_reply
753 events ip4_arp_event;
756 /** \brief Register for IP6 ND resolution event on recieving NA reply
757 MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
758 @param client_index - opaque cookie to identify the sender
759 @param context - sender context, to match reply w/ request
760 @param enable_disable - 1 => register for events, 0 => cancel registration
761 @param pid - sender's pid
762 @param address - the exact IP6 address of interested ND resolution event, or
763 0 to get MAC/IP info from ICMP6 NS in L2 BDs.
765 autoreply define want_ip6_nd_events
774 /** \brief Tell client about an IP6 ND resolution or
775 MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
776 @param client_index - opaque cookie to identify the sender
777 @param pid - client pid registered to receive notification
778 @param sw_if_index - interface which received ARP packet
779 @param address - the exact ip6 address of interest
780 @param new_mac - the new mac address
781 @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
794 rpc want_ip6_ra_events returns want_ip6_ra_events_reply
798 /** \brief Register for ip6 router advertisement events
799 @param client_index - opaque cookie to identify the sender
800 @param context - sender context, to match reply w/ request
801 @param enable_disable - 1 => register for events, 0 => cancel registration
802 @param pid - sender's pid
804 autoreply define want_ip6_ra_events
812 /** \brief Struct representing RA prefix info
813 @param dst_address - RA prefix info destination address
814 @param dst_address_length - RA prefix info destination address length
815 @param flags - RA prefix info flags
816 @param valid_time - RA prefix info valid time
817 @param preferred_time - RA prefix info preferred time
819 typeonly define ip6_ra_prefix_info
822 u8 dst_address_length;
828 /** \brief Tell client about a router advertisement event
829 @param client_index - opaque cookie to identify the sender
830 @param pid - client pid registered to receive notification
831 @param current_hop_limit - RA current hop limit
832 @param flags - RA flags
833 @param router_lifetime_in_sec - RA lifetime in seconds
834 @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
835 @param time_in_msec_between_retransmitted_neighbor_solicitations -
836 time in msec between retransmitted neighbor solicitations
845 u8 router_address[16];
846 u8 current_hop_limit;
848 u16 router_lifetime_in_sec;
849 u32 neighbor_reachable_time_in_msec;
850 u32 time_in_msec_between_retransmitted_neighbor_solicitations;
852 vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
856 rpc want_ip6_nd_events returns want_ip6_nd_events_reply
860 /** \brief Proxy ARP configuration type
861 @param vrf_id - VRF / Fib table ID
862 @param low_address[4] - Low address of the Proxy ARP range
863 @param hi_address[4] - High address of the Proxy ARP range
865 typeonly define proxy_arp
872 /** \brief Proxy ARP add / del request
873 @param client_index - opaque cookie to identify the sender
874 @param context - sender context, to match reply w/ request
875 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
876 @param proxy - Proxy configuration
878 autoreply define proxy_arp_add_del
883 vl_api_proxy_arp_t proxy;
886 /** \brief Proxy ARP dump request
888 define proxy_arp_dump
894 /** \brief Proxy ARP dump details reply
895 * @param proxy - Same data as used to configure
897 define proxy_arp_details
900 vl_api_proxy_arp_t proxy;
903 /** \brief Proxy ARP add / del interface request
904 @param client_index - opaque cookie to identify the sender
905 @param context - sender context, to match reply w/ request
906 @param sw_if_index - Which interface to enable / disable Proxy Arp on
907 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
909 autoreply define proxy_arp_intfc_enable_disable
914 /* 1 = on, 0 = off */
918 /** \brief Proxy ARP interface dump request
920 define proxy_arp_intfc_dump
926 /** \brief Proxy ARP interface dump details reply
927 * @param sw_if_index The interface on which ARP proxy is enabled.
929 define proxy_arp_intfc_details
935 /** \brief Reset fib table request
936 @param client_index - opaque cookie to identify the sender
937 @param context - sender context, to match reply w/ request
938 @param vrf_id - vrf/table id of the fib table to reset
939 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
941 autoreply define reset_fib
949 /** \brief Set max allowed ARP or ip6 neighbor entries request
950 @param client_index - opaque cookie to identify the sender
951 @param context - sender context, to match reply w/ request
952 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
953 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
955 autoreply define set_arp_neighbor_limit
960 u32 arp_neighbor_limit;
963 /** \brief IOAM enable : Enable in-band OAM
964 @param id - profile id
965 @param seqno - To enable Seqno Processing
966 @param analyse - Enabling analysis of iOAM at decap node
967 @param pow_enable - Proof of Work enabled or not flag
968 @param trace_enable - iOAM Trace enabled or not flag
970 autoreply define ioam_enable
982 /** \brief iOAM disable
983 @param client_index - opaque cookie to identify the sender
984 @param context - sender context, to match reply w/ request
985 @param index - MAP Domain index
987 autoreply define ioam_disable
994 autoreply define ip_reassembly_set
999 u32 max_reassemblies;
1000 u32 expire_walk_interval_ms;
1004 define ip_reassembly_get
1011 define ip_reassembly_get_reply
1016 u32 max_reassemblies;
1017 u32 expire_walk_interval_ms;
1021 /** \brief Enable/disable reassembly feature
1022 @param client_index - opaque cookie to identify the sender
1023 @param context - sender context, to match reply w/ request
1024 @param sw_if_index - interface to enable/disable feature on
1025 @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
1026 @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
1028 autoreply define ip_reassembly_enable_disable
1039 * eval: (c-set-style "gnu")