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
296 /** \brief IPv6 ND proxy dump request
297 @param context - sender context, to match reply w/ request
298 @param retval - return code for the request
299 @param sw_if_index - The interface the host is on
300 @param address - The address of the host for which to proxy for
302 define ip6nd_proxy_dump
308 /** \brief Start / stop sending router solicitation
309 @param client_index - opaque cookie to identify the sender
310 @param context - sender context, to match reply w/ request
311 @param irt - initial retransmission time
312 @param mrt - maximum retransmission time
313 @param mrc - maximum retransmission count
314 @param mrd - maximum retransmission duration
315 @param sw_if_index - software interface index of interface
316 for sending router solicitation
317 @param stop - if non-zero then stop sending router solicitation,
318 otherwise start sending router solicitation
320 autoreply define ip6nd_send_router_solicitation
332 /** \brief IPv6 interface enable / disable request
333 @param client_index - opaque cookie to identify the sender
334 @param context - sender context, to match reply w/ request
335 @param sw_if_index - interface used to reach neighbor
336 @param enable - if non-zero enable ip6 on interface, else disable
338 autoreply define sw_interface_ip6_enable_disable
343 u8 enable; /* set to true if enable */
346 /** \brief IPv6 set link local address on interface request
347 @param client_index - opaque cookie to identify the sender
348 @param context - sender context, to match reply w/ request
349 @param sw_if_index - interface to set link local on
350 @param address[] - the new link local address
352 autoreply define sw_interface_ip6_set_link_local_address
360 /** \brief Add / del route request
361 @param client_index - opaque cookie to identify the sender
362 @param context - sender context, to match reply w/ request
363 @param sw_if_index - software index of the new vlan's parent interface
364 @param vrf_id - fib table /vrf associated with the route
365 @param lookup_in_vrf -
366 @param classify_table_index -
367 @param is_add - 1 if adding the route, 0 if deleting
368 @param is_drop - Drop the packet
369 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
370 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
371 @param is_ipv6 - 0 if an ip4 route, else ip6
372 @param is_local - The route will result in packets sent to VPP IP stack
373 @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
375 @param is_multipath - Set to 1 if this is a multipath route, else 0
376 @param is_dvr - Does the route resolve via a DVR interface.
377 @param is_source_lookup - The the path is a deaggregate path (i.e. a lookup
378 in another table) is the lookup on the packet's
379 source address or destination.
380 @param next_hop_weight - Weight for Unequal cost multi-path
381 @param next_hop_preference - Path that are up that have the best preference are
382 are used for forwarding. lower value is better.
383 @param next_hop_id - Used when the path resolves via an object that has a unique
385 @param dst_address_length -
386 @param dst_address[16] -
387 @param next_hop_address[16] -
388 @param next_hop_n_out_labels - the number of labels in the label stack
389 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
390 @param next_hop_via_label - The next-hop is a resolved via a local label
392 autoreply define ip_add_del_route
396 u32 next_hop_sw_if_index;
398 u32 classify_table_index;
399 u32 next_hop_table_id;
410 u8 is_resolve_attached;
415 u8 next_hop_preference;
417 u8 dst_address_length;
419 u8 next_hop_address[16];
420 u8 next_hop_n_out_labels;
421 u32 next_hop_via_label;
422 vl_api_fib_mpls_label_t next_hop_out_label_stack[next_hop_n_out_labels];
425 /** \brief Add / del route request
426 @param client_index - opaque cookie to identify the sender
427 @param context - sender context, to match reply w/ request
428 @param sw_if_index - software index of the new vlan's parent interface
429 @param vrf_id - fib table /vrf associated with the route
430 @param next_hop_afi - Use dpo_proto_t
433 autoreply define ip_mroute_add_del
437 u32 next_hop_sw_if_index;
443 u16 grp_address_length;
453 /** \brief Dump IP multicast fib table
454 @param client_index - opaque cookie to identify the sender
462 /** \brief IP Multicast FIB table response
463 @param table_id - IP fib table id
464 @address_length - mask length
465 @grp_address - Group address/prefix
466 @src_address - Source address
467 @param count - the number of fib_path in path
468 @param path - array of of fib_path structures
470 manual_endian manual_print define ip_mfib_details
480 vl_api_fib_path_t path[count];
483 /** \brief Dump IP6 multicast fib table
484 @param client_index - opaque cookie to identify the sender
492 /** \brief IP6 Multicast FIB table response
493 @param table_id - IP fib table id
494 @address_length - mask length
495 @grp_address - Group address/prefix
496 @src_address - Source address
497 @param count - the number of fib_path in path
498 @param path - array of of fib_path structures
500 manual_endian manual_print define ip6_mfib_details
508 vl_api_fib_path_t path[count];
511 define ip_address_details
521 define ip_address_dump
529 /** \brief IP unnumbered configurations
530 @param sw_if_index The interface that has unnumbered configuration
531 @param ip_sw_if_index The IP interface that it is unnnumbered to
533 define ip_unnumbered_details
541 /** \brief Dump IP unnumbered configurations
542 @param sw_if_index ~0 for all interfaces, else the interface desired
544 define ip_unnumbered_dump
565 define mfib_signal_dump
571 define mfib_signal_details
581 u8 ip_packet_data[256];
584 /** \brief IP punt policer
585 @param client_index - opaque cookie to identify the sender
586 @param context - sender context, to match reply w/ request
587 @param is_add - 1 to add neighbor, 0 to delete
588 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
589 @param policer_index - Index of policer to use
591 autoreply define ip_punt_police
600 /** \brief IP punt redirect
601 @param client_index - opaque cookie to identify the sender
602 @param context - sender context, to match reply w/ request
603 @param is_add - 1 to add neighbor, 0 to delete
604 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
605 @param tx_sw_if_index - the TX interface to which traffic shoulde be
607 @param nh - The next-hop to redirect the traffic to.
609 autoreply define ip_punt_redirect
620 autoreply define ip_container_proxy_add_del
631 /** \brief Configure IP source and L4 port-range check
632 @param client_index - opaque cookie to identify the sender
633 @param context - sender context, to match reply w/ request
634 @param is_ip6 - 1 if source address type is IPv6
635 @param is_add - 1 if add, 0 if delete
636 @param mask_length - mask length for address entry
637 @param address - array of address bytes
638 @param number_of_ranges - length of low_port and high_port arrays (must match)
639 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
640 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
641 @param vrf_id - fib table/vrf id to associate the source and port-range check with
642 @note To specify a single port set low_port and high_port entry the same
644 autoreply define ip_source_and_port_range_check_add_del
658 /** \brief Set interface source and L4 port-range request
659 @param client_index - opaque cookie to identify the sender
660 @param context - sender context, to match reply w/ request
661 @param interface_id - interface index
662 @param tcp_vrf_id - VRF associated with source and TCP port-range check
663 @param udp_vrf_id - VRF associated with source and TCP port-range check
665 autoreply define ip_source_and_port_range_check_interface_add_del
677 /** \brief Enable/disable periodic IP neighbor scan
678 @param client_index - opaque cookie to identify the sender
679 @param context - sender context, to match reply w/ request
680 @param mode - 0: disable, 1: IPv4, 2: IPv6, 3: both IPv4/v6
681 @param scan_interval - neighbor scan interval in minutes, 0: default to 1
682 @param max_proc_time - max processing time per run in usec, 0: default to 20
683 @param max_update - max neighbor probe/delete per run, 0: default to 10
684 @param scan_int_delay - delay in msec to resume scan if exceed max proc
685 time or update, 0: default to 1
686 @param stale_threshold - threshold in minutes for neighbor deletion,
687 0: default to 4*scan_interval
689 autoreply define ip_scan_neighbor_enable_disable
701 /** \brief IP probe neighbor address on an interface by sending an
702 ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
703 @param client_index - opaque cookie to identify the sender
704 @param context - sender context, to match reply w/ request
705 @param sw_if_index - interface index
706 @param dst_address - target IP address to send IP addr resolution request
707 @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
709 autoreply define ip_probe_neighbor
718 /** \brief Register for IP4 ARP resolution event on receing ARP reply or
719 MAC/IP info from ARP requests in L2 BDs
720 @param client_index - opaque cookie to identify the sender
721 @param context - sender context, to match reply w/ request
722 @param enable_disable - 1 => register for events, 0 => cancel registration
723 @param pid - sender's pid
724 @param address - exact IP4 address of interested arp resolution event, or
725 0 to get MAC/IP info from ARP requests in BDs
727 autoreply define want_ip4_arp_events
736 /** \brief Tell client about an IP4 ARP resolution event or
737 MAC/IP info from ARP requests in L2 BDs
738 @param client_index - opaque cookie to identify the sender
739 @param address - the exact ip4 address of interest
740 @param pid - client pid registered to receive notification
741 @param sw_if_index - interface which received ARP packet
742 @param new_mac - the new mac address
743 @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
756 rpc want_ip4_arp_events returns want_ip4_arp_events_reply
757 events ip4_arp_event;
760 /** \brief Register for IP6 ND resolution event on recieving NA reply
761 MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
762 @param client_index - opaque cookie to identify the sender
763 @param context - sender context, to match reply w/ request
764 @param enable_disable - 1 => register for events, 0 => cancel registration
765 @param pid - sender's pid
766 @param address - the exact IP6 address of interested ND resolution event, or
767 0 to get MAC/IP info from ICMP6 NS in L2 BDs.
769 autoreply define want_ip6_nd_events
778 /** \brief Tell client about an IP6 ND resolution or
779 MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
780 @param client_index - opaque cookie to identify the sender
781 @param pid - client pid registered to receive notification
782 @param sw_if_index - interface which received ARP packet
783 @param address - the exact ip6 address of interest
784 @param new_mac - the new mac address
785 @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
798 rpc want_ip6_ra_events returns want_ip6_ra_events_reply
802 /** \brief Register for ip6 router advertisement events
803 @param client_index - opaque cookie to identify the sender
804 @param context - sender context, to match reply w/ request
805 @param enable_disable - 1 => register for events, 0 => cancel registration
806 @param pid - sender's pid
808 autoreply define want_ip6_ra_events
816 /** \brief Struct representing RA prefix info
817 @param dst_address - RA prefix info destination address
818 @param dst_address_length - RA prefix info destination address length
819 @param flags - RA prefix info flags
820 @param valid_time - RA prefix info valid time
821 @param preferred_time - RA prefix info preferred time
823 typeonly define ip6_ra_prefix_info
826 u8 dst_address_length;
832 /** \brief Tell client about a router advertisement event
833 @param client_index - opaque cookie to identify the sender
834 @param pid - client pid registered to receive notification
835 @param current_hop_limit - RA current hop limit
836 @param flags - RA flags
837 @param router_lifetime_in_sec - RA lifetime in seconds
838 @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
839 @param time_in_msec_between_retransmitted_neighbor_solicitations -
840 time in msec between retransmitted neighbor solicitations
849 u8 router_address[16];
850 u8 current_hop_limit;
852 u16 router_lifetime_in_sec;
853 u32 neighbor_reachable_time_in_msec;
854 u32 time_in_msec_between_retransmitted_neighbor_solicitations;
856 vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
860 rpc want_ip6_nd_events returns want_ip6_nd_events_reply
864 /** \brief Proxy ARP configuration type
865 @param vrf_id - VRF / Fib table ID
866 @param low_address[4] - Low address of the Proxy ARP range
867 @param hi_address[4] - High address of the Proxy ARP range
869 typeonly define proxy_arp
876 /** \brief Proxy ARP add / del request
877 @param client_index - opaque cookie to identify the sender
878 @param context - sender context, to match reply w/ request
879 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
880 @param proxy - Proxy configuration
882 autoreply define proxy_arp_add_del
887 vl_api_proxy_arp_t proxy;
890 /** \brief Proxy ARP dump request
892 define proxy_arp_dump
898 /** \brief Proxy ARP dump details reply
899 * @param proxy - Same data as used to configure
901 define proxy_arp_details
904 vl_api_proxy_arp_t proxy;
907 /** \brief Proxy ARP add / del interface request
908 @param client_index - opaque cookie to identify the sender
909 @param context - sender context, to match reply w/ request
910 @param sw_if_index - Which interface to enable / disable Proxy Arp on
911 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
913 autoreply define proxy_arp_intfc_enable_disable
918 /* 1 = on, 0 = off */
922 /** \brief Proxy ARP interface dump request
924 define proxy_arp_intfc_dump
930 /** \brief Proxy ARP interface dump details reply
931 * @param sw_if_index The interface on which ARP proxy is enabled.
933 define proxy_arp_intfc_details
939 /** \brief Reset fib table request
940 @param client_index - opaque cookie to identify the sender
941 @param context - sender context, to match reply w/ request
942 @param vrf_id - vrf/table id of the fib table to reset
943 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
945 autoreply define reset_fib
953 /** \brief Set max allowed ARP or ip6 neighbor entries request
954 @param client_index - opaque cookie to identify the sender
955 @param context - sender context, to match reply w/ request
956 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
957 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
959 autoreply define set_arp_neighbor_limit
964 u32 arp_neighbor_limit;
967 /** \brief IOAM enable : Enable in-band OAM
968 @param id - profile id
969 @param seqno - To enable Seqno Processing
970 @param analyse - Enabling analysis of iOAM at decap node
971 @param pow_enable - Proof of Work enabled or not flag
972 @param trace_enable - iOAM Trace enabled or not flag
974 autoreply define ioam_enable
986 /** \brief iOAM disable
987 @param client_index - opaque cookie to identify the sender
988 @param context - sender context, to match reply w/ request
989 @param index - MAP Domain index
991 autoreply define ioam_disable
998 autoreply define ip_reassembly_set
1003 u32 max_reassemblies;
1004 u32 expire_walk_interval_ms;
1008 define ip_reassembly_get
1015 define ip_reassembly_get_reply
1021 u32 max_reassemblies;
1022 u32 expire_walk_interval_ms;
1026 /** \brief Enable/disable reassembly feature
1027 @param client_index - opaque cookie to identify the sender
1028 @param context - sender context, to match reply w/ request
1029 @param sw_if_index - interface to enable/disable feature on
1030 @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
1031 @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
1033 autoreply define ip_reassembly_enable_disable
1044 * eval: (c-set-style "gnu")