1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2015 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 vpe control-plane API messages which are generally
20 called through a shared memory interface.
24 /** \brief Register for interface events
25 @param client_index - opaque cookie to identify the sender
26 @param context - sender context, to match reply w/ request
27 @param enable_disable - 1 => register for events, 0 => cancel registration
28 @param pid - sender's pid
30 define want_interface_events {
37 /** \brief Reply for interface events registration
38 @param context - returned sender context, to match reply w/ request
39 @param retval - return code
41 define want_interface_events_reply {
46 /** \brief Interface details structure (fix this)
47 @param sw_if_index - index of the interface
48 @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
49 @param l2_address_length - length of the interface's l2 address
50 @param pid - the interface's l2 address
51 @param interface_name - name of the interface
52 @param link_duplex - 1 if half duplex, 2 if full duplex
53 @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
54 @param link_MTU - max. transmittion unit
55 @param sub_if_id - A number 0-N to uniquely identify this subif on super if
56 @param sub_dot1ad - 0 = dot1q, 1=dot1ad
57 @param sub_number_of_tags - Number of tags (0 - 2)
58 @param sub_outer_vlan_id
59 @param sub_inner_vlan_id
60 @param sub_exact_match
62 @param sub_outer_vlan_id_any
63 @param sub_inner_vlan_id_any
64 @param vtr_op - vlan tag rewrite operation
69 manual_java define sw_interface_details {
72 /* index of sup interface (e.g. hw interface).
73 equal to sw_if_index for super hw interface. */
76 /* Layer 2 address, if applicable */
77 u32 l2_address_length;
81 u8 interface_name[64];
83 /* 1 = up, 0 = down */
87 /* 1 = half duplex, 2 = full duplex */
90 /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
96 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface*/
99 /* 0 = dot1q, 1=dot1ad */
102 /* Number of tags 0-2 */
103 u8 sub_number_of_tags;
104 u16 sub_outer_vlan_id;
105 u16 sub_inner_vlan_id;
108 u8 sub_outer_vlan_id_any;
109 u8 sub_inner_vlan_id_any;
111 /* vlan tag rewrite state */
113 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
114 u32 vtr_tag1; // first pushed tag
115 u32 vtr_tag2; // second pushed tag
118 /** \brief Set flags on the interface
119 @param client_index - opaque cookie to identify the sender
120 @param context - sender context, to match reply w/ request
121 @param sw_if_index - index of the interface to set flags on
122 @param admin_up_down - set the admin state, 1 = up, 0 = down
123 @param link_up_down - Oper state sent on change event, not used in config.
124 @param deleted - interface was deleted
126 define sw_interface_set_flags {
130 /* 1 = up, 0 = down */
136 /** \brief Reply to sw_interface_set_flags
137 @param context - sender context which was passed in the request
138 @param retval - return code of the set flags request
140 define sw_interface_set_flags_reply {
146 manual_java define sw_interface_dump {
149 u8 name_filter_valid;
153 /** \brief Set or delete one or all ip addresses on a specified interface
154 @param client_index - opaque cookie to identify the sender
155 @param context - sender context, to match reply w/ request
156 @param sw_if_index - index of the interface to add/del addresses
157 @param is_add - add address if non-zero, else delete
158 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
159 @param del_all - if non-zero delete all addresses on the interface
160 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
161 @param address - array of address bytes
163 define sw_interface_add_del_address {
174 /** \brief Reply for interface events registration
175 @param context - returned sender context, to match reply w/ request
176 @param retval - return code
178 define sw_interface_add_del_address_reply {
183 /** \brief Associate the specified interface with a fib table
184 @param client_index - opaque cookie to identify the sender
185 @param context - sender context, to match reply w/ request
186 @param sw_if_index - index of the interface
187 @param is_ipv6 - if non-zero ipv6, else ipv4
188 @param vrf_id - fib table/vrd id to associate the interface with
190 define sw_interface_set_table {
198 /** \brief Reply for interface events registration
199 @param context - returned sender context, to match reply w/ request
200 @param retval - return code
202 define sw_interface_set_table_reply {
207 /** \brief Initialize a new tap interface with the given paramters
208 @param client_index - opaque cookie to identify the sender
209 @param context - sender context, to match reply w/ request
210 @param use_random_mac - let the system generate a unique mac address
211 @param tap_name - name to associate with the new interface
212 @param mac_address - mac addr to assign to the interface if use_radom not set
221 u32 custom_dev_instance;
224 /** \brief Reply for tap connect request
225 @param context - returned sender context, to match reply w/ request
226 @param retval - return code
227 @param sw_if_index - software index allocated for the new tap interface
229 define tap_connect_reply {
235 /** \brief Modify a tap interface with the given paramters
236 @param client_index - opaque cookie to identify the sender
237 @param context - sender context, to match reply w/ request
238 @param sw_if_index - interface index of existing tap interface
239 @param use_random_mac - let the system generate a unique mac address
240 @param tap_name - name to associate with the new interface
241 @param mac_address - mac addr to assign to the interface if use_radom not set
251 u32 custom_dev_instance;
254 /** \brief Reply for tap modify request
255 @param context - returned sender context, to match reply w/ request
256 @param retval - return code
257 @param sw_if_index - software index if the modified tap interface
259 define tap_modify_reply {
265 /** \brief Delete tap interface
266 @param client_index - opaque cookie to identify the sender
267 @param context - sender context, to match reply w/ request
268 @param sw_if_index - interface index of existing tap interface
276 /** \brief Reply for tap delete request
277 @param context - returned sender context, to match reply w/ request
278 @param retval - return code
280 define tap_delete_reply {
285 /** \brief Dump tap interfaces request */
286 define sw_interface_tap_dump {
291 /** \brief Reply for tap dump request
292 @param sw_if_index - software index of tap interface
293 @param dev_name - Linux tap device name
295 manual_java define sw_interface_tap_details {
301 /** \brief Create a new subinterface with the given vlan id
302 @param client_index - opaque cookie to identify the sender
303 @param context - sender context, to match reply w/ request
304 @param sw_if_index - software index of the new vlan's parent interface
305 @param vlan_id - vlan tag of the new interface
307 define create_vlan_subif {
314 /** \brief Reply for the vlan subinterface create request
315 @param context - returned sender context, to match reply w/ request
316 @param retval - return code
317 @param sw_if_index - software index allocated for the new subinterface
319 define create_vlan_subif_reply {
325 /** \brief Add / del route request
326 @param client_index - opaque cookie to identify the sender
327 @param context - sender context, to match reply w/ request
328 @param sw_if_index - software index of the new vlan's parent interface
329 @param vrf_id - fib table /vrf associated with the route
330 @param lookup_in_vrf -
331 @param resolve_attempts -
332 @param classify_table_index -
333 @param create_vrf_if_needed -
334 @param resolve_if_needed -
335 @param is_add - 1 if adding the route, 0 if deleting
337 @param is_ipv6 - 0 if an ip4 route, else ip6
340 @param is_multipath - Set to 1 if this is a multipath route, else 0
341 @param not_last - Is last or not last msg in group of multiple add/del msgs
342 @param next_hop_weight -
343 @param dst_address_length -
344 @param dst_address[16] -
345 @param next_hop_address[16] -
347 define ip_add_del_route {
350 u32 next_hop_sw_if_index;
353 u32 resolve_attempts;
354 u32 classify_table_index;
355 u8 create_vrf_if_needed;
356 u8 resolve_if_needed;
362 /* Is last/not-last message in group of multiple add/del messages. */
366 u8 dst_address_length;
368 u8 next_hop_address[16];
371 /** \brief Reply for add / del route request
372 @param context - returned sender context, to match reply w/ request
373 @param retval - return code
375 define ip_add_del_route_reply {
381 /** \brief Add / del gre tunnel request
382 @param client_index - opaque cookie to identify the sender
383 @param context - sender context, to match reply w/ request
384 @param sw_if_index - software index of the new vlan's parent interface
385 @param inner_vrf_id -
386 @param outer_vrf_id -
387 @param is_add - 1 if adding the tunnel, 0 if deleting
388 @param src_address[4] - tunnel source address
389 @param dst_address[4] - tunnel destination address
390 @param intf_address -
391 @param intf_address_length -
393 define mpls_gre_add_del_tunnel {
403 u8 intfc_address_length;
406 /** \brief Reply for add / del tunnel request
407 @param context - returned sender context, to match reply w/ request
408 @param retval - return code
410 define mpls_gre_add_del_tunnel_reply {
413 u32 tunnel_sw_if_index;
416 /** \brief Add / del MPLS encapsulation request
417 @param client_index - opaque cookie to identify the sender
418 @param context - sender context, to match reply w/ request
419 @param vrf_id - vrf id
420 @param dst_address[4] -
421 @param is_add - 1 if adding the encap, 0 if deleting
422 @param nlabels - number of labels
423 @param labels - array of labels
425 define mpls_add_del_encap {
430 /* 1 = add, 0 = delete */
436 /** \brief Reply for add / del encapsulation request
437 @param context - returned sender context, to match reply w/ request
438 @param retval - return code
440 define mpls_add_del_encap_reply {
445 /** \brief Add / del MPLS decapsulation request
446 @param client_index - opaque cookie to identify the sender
447 @param context - sender context, to match reply w/ request
448 @param rx_vrf_id - receive vrf
449 @param tx_vrf_id - transmit vrf
453 @param is_add - 1 if adding the encap, 0 if deleting
455 define mpls_add_del_decap {
466 /** \brief Reply for MPLS decap add / del request
467 @param context - returned sender context, to match reply w/ request
468 @param retval - return code
470 define mpls_add_del_decap_reply {
475 /** \brief Proxy ARP add / del request
476 @param client_index - opaque cookie to identify the sender
477 @param context - sender context, to match reply w/ request
478 @param vrf_id - VRF / Fib table ID
479 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
480 @param low_address[4] - Low address of the Proxy ARP range
481 @param hi_address[4] - High address of the Proxy ARP range
483 define proxy_arp_add_del {
492 /** \brief Reply for proxy arp add / del request
493 @param context - returned sender context, to match reply w/ request
494 @param retval - return code
496 define proxy_arp_add_del_reply {
501 /** \brief Proxy ARP add / del request
502 @param client_index - opaque cookie to identify the sender
503 @param context - sender context, to match reply w/ request
504 @param sw_if_index - Which interface to enable / disable Proxy Arp on
505 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
507 define proxy_arp_intfc_enable_disable {
511 /* 1 = on, 0 = off */
515 /** \brief Reply for Proxy ARP interface enable / disable request
516 @param context - returned sender context, to match reply w/ request
517 @param retval - return code
519 define proxy_arp_intfc_enable_disable_reply {
524 /** \brief IP neighbor add / del request
525 @param client_index - opaque cookie to identify the sender
526 @param context - sender context, to match reply w/ request
527 @param vrf_id - vrf_id, only for IP4
528 @param sw_if_index - interface used to reach neighbor
529 @param is_add - 1 to add neighbor, 0 to delete
530 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
532 @param mac_address - l2 address of the neighbor
533 @param dst_address - ip4 or ip6 address of the neighbor
535 define ip_neighbor_add_del {
538 u32 vrf_id; /* only makes sense for ip4 */
540 /* 1 = add, 0 = delete */
548 /** \brief Reply for IP Neighbor add / delete request
549 @param context - returned sender context, to match reply w/ request
550 @param retval - return code
552 define ip_neighbor_add_del_reply {
557 /** \brief Reset VRF (remove all routes etc) request
558 @param client_index - opaque cookie to identify the sender
559 @param context - sender context, to match reply w/ request
560 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
561 @param vrf_id - ID of th FIB table / VRF to reset
570 /** \brief Reply for Reset VRF request
571 @param context - returned sender context, to match reply w/ request
572 @param retval - return code
574 define reset_vrf_reply {
579 /** \brief Is Address Reachable request - DISABLED
580 @param client_index - opaque cookie to identify the sender
581 @param context - sender context, to match reply w/ request
582 @param next_hop_sw_if_index - index of interface used to get to next hop
583 @param is_ipv6 - 1 for IPv6, 0 for IPv4
584 @param is_error - address not found or does not match intf
585 @param address[] - Address in question
587 define is_address_reachable {
588 u32 client_index; /* (api_main_t *) am->my_client_index */
590 u32 next_hop_sw_if_index;
591 u8 is_known; /* on reply, this is the answer */
593 u8 is_error; /* address not found or does not match intf */
597 /** \brief Want Stats, register for stats updates
598 @param client_index - opaque cookie to identify the sender
599 @param context - sender context, to match reply w/ request
600 @param enable_disable - 1 = enable stats, 0 = disable
601 @param pid - pid of process requesting stats updates
610 /** \brief Reply for Want Stats request
611 @param context - returned sender context, to match reply w/ request
612 @param retval - return code
614 manual_java define want_stats_reply {
619 /** \brief Want stats counters structure
620 @param vnet_counter_type- such as ip4, ip6, punts, etc
621 @param is_combined - rx & tx total (all types) counts
622 @param first_sw_if_index - first sw index in block of index, counts
623 @param count - number of interfaces this stats block includes counters for
624 @param data - contiguous block of vlib_counter_t structures
626 manual_java define vnet_interface_counters {
627 /* enums - plural - in vnet/interface.h */
628 u8 vnet_counter_type;
630 u32 first_sw_if_index;
635 typeonly manual_print manual_endian define ip4_fib_counter {
642 manual_java manual_print manual_endian define vnet_ip4_fib_counters {
645 vl_api_ip4_fib_counter_t c[0];
648 typeonly manual_print manual_endian define ip6_fib_counter {
655 manual_java manual_print manual_endian define vnet_ip6_fib_counters {
658 vl_api_ip6_fib_counter_t c[0];
661 /** \brief Request for a single block of summary stats
662 @param client_index - opaque cookie to identify the sender
663 @param context - sender context, to match reply w/ request
665 define vnet_get_summary_stats {
670 /** \brief Reply for vnet_get_summary_stats request
671 @param context - sender context, to match reply w/ request
672 @param retval - return code for request
677 define vnet_summary_stats_reply {
685 /** \brief OAM event structure
686 @param dst_address[] -
689 manual_java define oam_event {
694 /** \brief Want OAM events request
695 @param client_index - opaque cookie to identify the sender
696 @param context - sender context, to match reply w/ request
697 @param enable_disable- enable if non-zero, else disable
698 @param pid - pid of the requesting process
700 define want_oam_events {
707 /** \brief Want OAM events response
708 @param context - sender context, to match reply w/ request
709 @param retval - return code for the want oam stats request
711 define want_oam_events_reply {
716 /** \brief OAM add / del target request
717 @param client_index - opaque cookie to identify the sender
718 @param context - sender context, to match reply w/ request
719 @param vrf_id - vrf_id of the target
720 @param src_address[] - source address to use for the updates
721 @param dst_address[] - destination address of the target
722 @param is_add - add target if non-zero, else delete
733 /** \brief OAM add / del target response
734 @param context - sender context, to match reply w/ request
735 @param retval - return code of the request
737 define oam_add_del_reply {
742 /** \brief Reset fib table request
743 @param client_index - opaque cookie to identify the sender
744 @param context - sender context, to match reply w/ request
745 @param vrf_id - vrf/table id of the fib table to reset
746 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
755 /** \brief Reset fib response
756 @param context - sender context, to match reply w/ request
757 @param retval - return code for the reset bfib request
759 define reset_fib_reply {
764 /** \brief DHCP Proxy config add / del request
765 @param client_index - opaque cookie to identify the sender
766 @param context - sender context, to match reply w/ request
767 @param vrf_id - vrf id
768 @param if_ipv6 - ipv6 if non-zero, else ipv4
769 @param is_add - add the config if non-zero, else delete
770 @param insert_circuit_id - option82 suboption 1 fib number
771 @param dhcp_server[] - server address
772 @param dhcp_src_address[] - <fix this, need details>
774 define dhcp_proxy_config {
780 u8 insert_circuit_id;
782 u8 dhcp_src_address[16];
785 /** \brief DHCP Proxy config response
786 @param context - sender context, to match reply w/ request
787 @param retval - return code for the request
789 define dhcp_proxy_config_reply {
794 /** \brief DHCP Proxy set / unset vss request
795 @param client_index - opaque cookie to identify the sender
796 @param context - sender context, to match reply w/ request
797 @param tbl_id - table id
798 @param oui - first part of vpn id
799 @param fib_id - second part of vpn id
800 @param is_ipv6 - ip6 if non-zero, else ip4
801 @param is_add - set vss if non-zero, else delete
803 define dhcp_proxy_set_vss {
813 /** \brief DHCP proxy set / unset vss response
814 @param context - sender context, to match reply w/ request
815 @param retval - return code for the request
817 define dhcp_proxy_set_vss_reply {
822 /** \brief Set the ip flow hash config for a fib request
823 @param client_index - opaque cookie to identify the sender
824 @param context - sender context, to match reply w/ request
825 @param vrf_id - vrf/fib id
826 @param is_ipv6 - if non-zero the fib is ip6, else ip4
827 @param src - if non-zero include src in flow hash
828 @param dst - if non-zero include dst in flow hash
829 @param sport - if non-zero include sport in flow hash
830 @param dport - if non-zero include dport in flow hash
831 @param proto -if non-zero include proto in flow hash
832 @param reverse - if non-zero include reverse in flow hash
834 define set_ip_flow_hash {
847 /** \brief Set the ip flow hash config for a fib response
848 @param context - sender context, to match reply w/ request
849 @param retval - return code for the request
851 define set_ip_flow_hash_reply {
856 /** \brief IPv6 router advertisement config request
857 @param client_index - opaque cookie to identify the sender
858 @param context - sender context, to match reply w/ request
863 @param send_unicast -
866 @param default_router -
867 @param max_interval -
868 @param min_interval -
870 @param initial_count -
871 @param initial_interval -
873 define sw_interface_ip6nd_ra_config {
889 u32 initial_interval;
892 /** \brief IPv6 router advertisement config response
893 @param context - sender context, to match reply w/ request
894 @param retval - return code for the request
896 define sw_interface_ip6nd_ra_config_reply {
901 /** \brief IPv6 router advertisement prefix config request
902 @param client_index - opaque cookie to identify the sender
903 @param context - sender context, to match reply w/ request
906 @param address_length -
908 @param no_advertise -
910 @param no_autoconfig -
913 @param val_lifetime -
914 @param pref_lifetime -
916 define sw_interface_ip6nd_ra_prefix {
932 /** \brief IPv6 router advertisement prefix config response
933 @param context - sender context, to match reply w/ request
934 @param retval - return code for the request
936 define sw_interface_ip6nd_ra_prefix_reply {
941 /** \brief IPv6 interface enable / disable request
942 @param client_index - opaque cookie to identify the sender
943 @param context - sender context, to match reply w/ request
944 @param sw_if_index - interface used to reach neighbor
945 @param enable - if non-zero enable ip6 on interface, else disable
947 define sw_interface_ip6_enable_disable {
951 u8 enable; /* set to true if enable*/
954 /** \brief IPv6 interface enable / disable response
955 @param context - sender context, to match reply w/ request
956 @param retval - return code for the request
958 define sw_interface_ip6_enable_disable_reply {
963 /** \brief IPv6 set link local address on interface request
964 @param client_index - opaque cookie to identify the sender
965 @param context - sender context, to match reply w/ request
966 @param sw_if_index - interface to set link local on
967 @param address[] - the new link local address
968 @param address_length - link local address length
970 define sw_interface_ip6_set_link_local_address {
978 /** \brief IPv6 set link local address on interface response
979 @param context - sender context, to match reply w/ request
980 @param retval - error code for the request
982 define sw_interface_ip6_set_link_local_address_reply {
987 /** \brief Set unnumbered interface add / del request
988 @param client_index - opaque cookie to identify the sender
989 @param context - sender context, to match reply w/ request
990 @param sw_if_index - interface with an IP address
991 @param unnumbered_sw_if_index - interface which will use the address
992 @param is_add - if non-zero set the association, else unset it
994 define sw_interface_set_unnumbered {
997 u32 sw_if_index; /* use this intfc address */
998 u32 unnumbered_sw_if_index; /* on this interface */
1002 /** \brief Set unnumbered interface add / del response
1003 @param context - sender context, to match reply w/ request
1004 @param retval - return code for the request
1006 define sw_interface_set_unnumbered_reply {
1011 /** \brief Create loopback interface request
1012 @param client_index - opaque cookie to identify the sender
1013 @param context - sender context, to match reply w/ request
1014 @param mac_address - mac addr to assign to the interface if none-zero
1016 define create_loopback {
1022 /** \brief Create loopback interface response
1023 @param context - sender context, to match reply w/ request
1024 @param sw_if_index - sw index of the interface that was created
1025 @param retval - return code for the request
1027 define create_loopback_reply {
1033 /** \brief Delete loopback interface request
1034 @param client_index - opaque cookie to identify the sender
1035 @param context - sender context, to match reply w/ request
1036 @param sw_if_index - sw index of the interface that was created
1038 define delete_loopback {
1044 /** \brief Delete loopback interface response
1045 @param context - sender context, to match reply w/ request
1046 @param retval - return code for the request
1048 define delete_loopback_reply {
1053 /** \brief Control ping from client to api server request
1054 @param client_index - opaque cookie to identify the sender
1055 @param context - sender context, to match reply w/ request
1057 manual_java define control_ping {
1062 /** \brief Control ping from the client to the server response
1063 @param client_index - opaque cookie to identify the sender
1064 @param context - sender context, to match reply w/ request
1065 @param retval - return code for the request
1066 @param vpe_pid - the pid of the vpe, returned by the server
1068 manual_java define control_ping_reply {
1075 /** \brief Process a vpe parser cli string request
1076 @param client_index - opaque cookie to identify the sender
1077 @param context - sender context, to match reply w/ request
1078 @param cmd_in_shmem - pointer to cli command string
1080 define cli_request {
1086 /** \brief vpe parser cli string response
1087 @param context - sender context, to match reply w/ request
1088 @param retval - return code for request
1089 @param reply_in_shmem - Reply string from cli processing if any
1097 /** \brief Set max allowed ARP or ip6 neighbor entries request
1098 @param client_index - opaque cookie to identify the sender
1099 @param context - sender context, to match reply w/ request
1100 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1101 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1103 define set_arp_neighbor_limit {
1107 u32 arp_neighbor_limit;
1110 /** \brief Set max allowed ARP or ip6 neighbor entries response
1111 @param context - sender context, to match reply w/ request
1112 @param retval - return code for request
1114 define set_arp_neighbor_limit_reply {
1119 /** \brief L2 interface patch add / del request
1120 @param client_index - opaque cookie to identify the sender
1121 @param context - sender context, to match reply w/ request
1122 @param rx_sw_if_index - receive side interface
1123 @param tx_sw_if_index - transmit side interface
1124 @param is_add - if non-zero set up the interface patch, else remove it
1126 define l2_patch_add_del {
1134 /** \brief L2 interface patch add / del response
1135 @param context - sender context, to match reply w/ request
1136 @param retval - return code for the request
1138 define l2_patch_add_del_reply {
1143 /** \brief IPv6 segment routing tunnel add / del request
1144 @param client_index - opaque cookie to identify the sender
1145 @param context - sender context, to match reply w/ request
1146 @param is_add - add the tunnel if non-zero, else delete it
1147 @param src_address[] -
1148 @param dst_address[] -
1149 @param dst_mask_width -
1150 @param inner_vrf_id -
1151 @param outer_vrf_id -
1152 @param flags_net_byte_order -
1155 @param segs_and_tags[] -
1157 define sr_tunnel_add_del {
1166 u16 flags_net_byte_order;
1169 u8 segs_and_tags[0];
1172 /** \brief IPv6 segment routing tunnel add / del response
1173 @param context - sender context, to match reply w/ request
1174 @param retval - return value for request
1176 define sr_tunnel_add_del_reply {
1181 /** \brief Interface set vpath request
1182 @param client_index - opaque cookie to identify the sender
1183 @param context - sender context, to match reply w/ request
1184 @param sw_if_index - interface used to reach neighbor
1185 @param enable - if non-zero enable, else disable
1187 define sw_interface_set_vpath {
1194 /** \brief Interface set vpath response
1195 @param context - sender context, to match reply w/ request
1196 @param retval - return code for the request
1198 define sw_interface_set_vpath_reply {
1203 /** \brief MPLS Ethernet add / del tunnel request
1204 @param client_index - opaque cookie to identify the sender
1205 @param context - sender context, to match reply w/ request
1206 @param vrf_id - vrf_id, only for IP4
1207 @param sw_if_index - interface used to reach neighbor
1208 @param is_add - add if set, tunnel delete if 0
1209 @param dst_mac_address -
1210 @param adj_address -
1211 @param adj_address_length -
1213 define mpls_ethernet_add_del_tunnel {
1220 u8 dst_mac_address[6];
1222 u8 adj_address_length;
1225 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1226 @param context - sender context, to match reply w/ request
1227 @param retval - return code for the request
1229 define mpls_ethernet_add_del_tunnel_reply {
1232 u32 tunnel_sw_if_index;
1234 /** \brief MPLS Ethernet add/ del tunnel 2
1235 @param client_index - opaque cookie to identify the sender
1236 @param context - sender context, to match reply w/ request
1237 @param inner_vrf_id -
1238 @param outer_vrf_id -
1239 @param resolve_attempts -
1240 @param resolve_opaque -
1241 @param resolve_if_needed -
1243 @param adj_address -
1244 @param adj_address_length -
1245 @param next_hop_ip4_address_in_outer_vrf -
1247 define mpls_ethernet_add_del_tunnel_2 {
1252 u32 resolve_attempts;
1253 u32 resolve_opaque; /* no need to set this */
1254 u8 resolve_if_needed;
1258 u8 adj_address_length;
1259 u8 next_hop_ip4_address_in_outer_vrf [4];
1262 /** \brief MPLS Ethernet add/ del tunnel 2
1263 @param context - sender context, to match reply w/ request
1264 @param retval - return code for add /del request
1266 define mpls_ethernet_add_del_tunnel_2_reply {
1271 /** \brief Set L2 XConnect between two interfaces request
1272 @param client_index - opaque cookie to identify the sender
1273 @param context - sender context, to match reply w/ request
1274 @param rx_sw_if_index - Receive interface index
1275 @param tx_sw_if_index - Transmit interface index
1276 @param enable - enable xconnect if not 0, else set to L3 mode
1278 define sw_interface_set_l2_xconnect {
1286 /** \brief Set L2 XConnect response
1287 @param context - sender context, to match reply w/ request
1288 @param retval - L2 XConnect request return code
1290 define sw_interface_set_l2_xconnect_reply {
1295 /** \brief Interface bridge mode request
1296 @param client_index - opaque cookie to identify the sender
1297 @param context - sender context, to match reply w/ request
1298 @param rx_sw_if_index - the interface
1299 @param bd_id - bridge domain id
1300 @param bvi - Setup interface as a bvi, bridge mode only
1301 @param shg - Shared horizon group, for bridge mode only
1302 @param enable - Enable beige mode if not 0, else set to L3 mode
1304 define sw_interface_set_l2_bridge {
1314 /** \brief Interface bridge mode response
1315 @param context - sender context, to match reply w/ request
1316 @param retval - Bridge mode request return code
1318 define sw_interface_set_l2_bridge_reply {
1323 /** \brief L2 FIB add entry request
1324 @param client_index - opaque cookie to identify the sender
1325 @param context - sender context, to match reply w/ request
1326 @param mac - the entry's mac address
1327 @param bd_id - the entry's bridge domain id
1328 @param sw_if_index - the interface
1329 @param is_add - If non zero add the entry, else delete it
1333 define l2fib_add_del {
1344 /** \brief L2 FIB add entry response
1345 @param context - sender context, to match reply w/ request
1346 @param retval - return code for the add l2fib entry request
1348 define l2fib_add_del_reply {
1353 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1354 @param client_index - opaque cookie to identify the sender
1355 @param context - sender context, to match reply w/ request
1356 @param sw_if_index - interface
1357 @param is_set - if non-zero, set the bits, else clear them
1358 @param feature_bitmap - non-zero bits to set or clear
1368 /** \brief Set L2 bits response
1369 @param context - sender context, to match reply w/ request
1370 @param retval - return code for the set l2 bits request
1372 define l2_flags_reply {
1375 u32 resulting_feature_bitmap;
1378 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1379 L2_UU_FLOOD, or L2_ARP_TERM) request
1380 @param client_index - opaque cookie to identify the sender
1381 @param context - sender context, to match reply w/ request
1382 @param bd_id - the bridge domain to set the flags for
1383 @param is_set - if non-zero, set the flags, else clear them
1384 @param feature_bitmap - bits that are non-zero to set or clear
1386 define bridge_flags {
1394 /** \brief Set bridge flags response
1395 @param context - sender context, to match reply w/ request
1396 @param retval - return code for the set bridge flags request
1397 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1399 define bridge_flags_reply {
1402 u32 resulting_feature_bitmap;
1405 /** \brief Set bridge domain ip to mac entry request
1406 @param client_index - opaque cookie to identify the sender
1407 @param context - sender context, to match reply w/ request
1408 @param bd_id - the bridge domain to set the flags for
1409 @param is_add - if non-zero, add the entry, else clear it
1410 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1411 @param mac_address - MAC address
1414 define bd_ip_mac_add_del {
1424 /** \brief Set bridge domain ip to mac entry response
1425 @param context - sender context, to match reply w/ request
1426 @param retval - return code for the set bridge flags request
1428 define bd_ip_mac_add_del_reply {
1433 /** \brief Add/Delete classification table request
1434 @param client_index - opaque cookie to identify the sender
1435 @param context - sender context, to match reply w/ request
1436 @param is_add- if non-zero add the table, else delete it
1437 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1438 @param nbuckets - number of buckets when adding a table
1439 @param memory_size - memory size when adding a table
1440 @param match_n_vectors - number of match vectors
1441 @param next_table_index - index of next table
1442 @param miss_next_index - index of miss table
1443 @param mask[] - match mask
1445 define classify_add_del_table {
1453 u32 match_n_vectors;
1454 u32 next_table_index;
1455 u32 miss_next_index;
1459 /** \brief Add/Delete classification table response
1460 @param context - sender context, to match reply w/ request
1461 @param retval - return code for the table add/del requst
1462 @param new_table_index - for add, returned index of the new table
1463 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1464 @param match_n_vectors -for add, returned value of match_n_vectors in table
1466 define classify_add_del_table_reply {
1469 u32 new_table_index;
1471 u32 match_n_vectors;
1474 /** \brief Classify add / del session request
1475 @param client_index - opaque cookie to identify the sender
1476 @param context - sender context, to match reply w/ request
1477 @param is_add - add session if non-zero, else delete
1478 @param table_index - index of the table to add/del the session, required
1479 @param hit_next_index - for add, hit_next_index of new session, required
1480 @param opaque_index - for add, opaque_index of new session
1481 @param advance -for add, advance value for session
1482 @param match[] - for add, match value for session, required
1484 define classify_add_del_session {
1495 /** \brief Classify add / del session response
1496 @param context - sender context, to match reply w/ request
1497 @param retval - return code for the add/del session request
1499 define classify_add_del_session_reply {
1504 /** \brief Set/unset the classification table for an interface request
1505 @param client_index - opaque cookie to identify the sender
1506 @param context - sender context, to match reply w/ request
1507 @param is_ipv6 - ipv6 if non-zero, else ipv4
1508 @param sw_if_index - interface to associate with the table
1509 @param table_index - index of the table, if ~0 unset the table
1511 define classify_set_interface_ip_table {
1516 u32 table_index; /* ~0 => off */
1519 /** \brief Set/unset interface classification table response
1520 @param context - sender context, to match reply w/ request
1521 @param retval - return code
1523 define classify_set_interface_ip_table_reply {
1528 /** \brief Set/unset l2 classification tables for an interface request
1529 @param client_index - opaque cookie to identify the sender
1530 @param context - sender context, to match reply w/ request
1531 @param sw_if_index - interface to set/unset tables for
1532 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1533 @param ip6_table_index - ip6 index
1534 @param other_table_index - other index
1536 define classify_set_interface_l2_tables {
1541 u32 ip4_table_index;
1542 u32 ip6_table_index;
1543 u32 other_table_index;
1546 /** \brief Set/unset l2 classification tables for an interface response
1547 @param context - sender context, to match reply w/ request
1548 @param retval - return code for the request
1550 define classify_set_interface_l2_tables_reply {
1555 /** \brief Get node index using name request
1556 @param client_index - opaque cookie to identify the sender
1557 @param context - sender context, to match reply w/ request
1558 @param node_name[] - name of the node
1560 define get_node_index {
1566 /** \brief Get node index using name request
1567 @param context - sender context, to match reply w/ request
1568 @param retval - return code for the request
1569 @param node_index - index of the desired node if found, else ~0
1571 define get_node_index_reply {
1577 /** \brief Set the next node for a given node request
1578 @param client_index - opaque cookie to identify the sender
1579 @param context - sender context, to match reply w/ request
1580 @param node_name[] - node to add the next node to
1581 @param next_name[] - node to add as the next node
1583 define add_node_next {
1590 /** \brief IP Set the next node for a given node response
1591 @param context - sender context, to match reply w/ request
1592 @param retval - return code for the add next node request
1593 @param next_index - the index of the next node if success, else ~0
1595 define add_node_next_reply {
1601 /** \brief DHCP Proxy config 2 add / del request
1602 @param client_index - opaque cookie to identify the sender
1603 @param context - sender context, to match reply w/ request
1604 @param rx_vrf_id - receive vrf id
1605 @param server_vrf_id - server vrf id
1606 @param if_ipv6 - ipv6 if non-zero, else ipv4
1607 @param is_add - add the config if non-zero, else delete
1608 @param insert_circuit_id - option82 suboption 1 fib number
1609 @param dhcp_server[] - server address
1610 @param dhcp_src_address[] - <fix this, need details>
1612 define dhcp_proxy_config_2 {
1619 u8 insert_circuit_id;
1621 u8 dhcp_src_address[16];
1624 /** \brief DHCP Proxy config 2 add / del response
1625 @param context - sender context, to match reply w/ request
1626 @param retval - return code for request
1628 define dhcp_proxy_config_2_reply {
1633 /** \brief l2tpv3 tunnel interface create request
1634 @param client_index - opaque cookie to identify the sender
1635 @param context - sender context, to match reply w/ request
1636 @param client_address - remote client tunnel ip address
1637 @param client_address - local tunnel ip address
1638 @param is_ipv6 - ipv6 if non-zero, else ipv4
1639 @param local_session_id - local tunnel session id
1640 @param remote_session_id - remote tunnel session id
1641 @param local_cookie - local tunnel cookie
1642 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1644 define l2tpv3_create_tunnel {
1647 u8 client_address [16];
1648 u8 our_address [16];
1650 u32 local_session_id;
1651 u32 remote_session_id;
1654 u8 l2_sublayer_present;
1657 /** \brief l2tpv3 tunnel interface create response
1658 @param context - sender context, to match reply w/ request
1659 @param retval - return code for the request
1660 @param sw_if_index - index of the new tunnel interface
1662 define l2tpv3_create_tunnel_reply {
1668 define l2tpv3_set_tunnel_cookies {
1672 u64 new_local_cookie;
1673 u64 new_remote_cookie;
1676 /** \brief L2TP tunnel set cookies response
1677 @param context - sender context, to match reply w/ request
1678 @param retval - return code for the request
1680 define l2tpv3_set_tunnel_cookies_reply {
1685 manual_java define sw_if_l2tpv3_tunnel_details {
1687 u8 interface_name[64];
1688 u8 client_address [16];
1689 u8 our_address [16];
1690 u32 local_session_id;
1691 u32 remote_session_id;
1692 u64 local_cookie[2];
1694 u8 l2_sublayer_present;
1697 define sw_if_l2tpv3_tunnel_dump {
1702 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1703 @param client_index - opaque cookie to identify the sender
1704 @param context - sender context, to match reply w/ request
1706 define l2_fib_clear_table {
1711 /** \brief L2 fib clear table response
1712 @param context - sender context, to match reply w/ request
1713 @param retval - return code for the request
1715 define l2_fib_clear_table_reply {
1720 /** \brief L2 interface ethernet flow point filtering enable/disable request
1721 @param client_index - opaque cookie to identify the sender
1722 @param context - sender context, to match reply w/ request
1723 @param sw_if_index - interface to enable/disable filtering on
1724 @param enable_disable - if non-zero enable filtering, else disable
1726 define l2_interface_efp_filter {
1733 /** \brief L2 interface ethernet flow point filtering response
1734 @param context - sender context, to match reply w/ request
1735 @param retval - return code for the request
1737 define l2_interface_efp_filter_reply {
1742 define l2tpv3_interface_enable_disable {
1749 define l2tpv3_interface_enable_disable_reply {
1754 define l2tpv3_set_lookup_key {
1757 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1761 define l2tpv3_set_lookup_key_reply {
1766 define vxlan_add_del_tunnel {
1773 u32 decap_next_index;
1777 define vxlan_add_del_tunnel_reply {
1783 manual_java define vxlan_tunnel_dump {
1789 manual_java define vxlan_tunnel_details {
1795 u32 decap_next_index;
1799 /** \brief L2 interface vlan tag rewrite configure request
1800 @param client_index - opaque cookie to identify the sender
1801 @param context - sender context, to match reply w/ request
1802 @param sw_if_index - interface the operation is applied to
1803 @param vtr_op - Choose from l2_vtr_op_t enum values
1804 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1805 @param tag1 - Needed for any push or translate vtr op
1806 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1808 define l2_interface_vlan_tag_rewrite {
1813 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1814 u32 tag1; // first pushed tag
1815 u32 tag2; // second pushed tag
1818 /** \brief L2 interface vlan tag rewrite response
1819 @param context - sender context, to match reply w/ request
1820 @param retval - return code for the request
1822 define l2_interface_vlan_tag_rewrite_reply {
1827 /** \brief vhost-user interface create request
1828 @param client_index - opaque cookie to identify the sender
1829 @param is_server - our side is socket server
1830 @param sock_filename - unix socket filename, used to speak with frontend
1831 @param use_custom_mac - enable or disable the use of the provided hardware address
1832 @param mac_address - hardware address to use if 'use_custom_mac' is set
1834 define create_vhost_user_if {
1838 u8 sock_filename[256];
1840 u32 custom_dev_instance;
1845 /** \brief vhost-user interface create response
1846 @param context - sender context, to match reply w/ request
1847 @param retval - return code for the request
1848 @param sw_if_index - interface the operation is applied to
1850 define create_vhost_user_if_reply {
1856 /** \brief vhost-user interface modify request
1857 @param client_index - opaque cookie to identify the sender
1858 @param is_server - our side is socket server
1859 @param sock_filename - unix socket filename, used to speak with frontend
1861 define modify_vhost_user_if {
1866 u8 sock_filename[256];
1868 u32 custom_dev_instance;
1871 /** \brief vhost-user interface modify response
1872 @param context - sender context, to match reply w/ request
1873 @param retval - return code for the request
1875 define modify_vhost_user_if_reply {
1880 /** \brief vhost-user interface delete request
1881 @param client_index - opaque cookie to identify the sender
1883 define delete_vhost_user_if {
1889 /** \brief vhost-user interface delete response
1890 @param context - sender context, to match reply w/ request
1891 @param retval - return code for the request
1893 define delete_vhost_user_if_reply {
1898 define create_subif {
1904 /* These fields map directly onto the subif template */
1908 u8 dot1ad; // 0 = dot1q, 1=dot1ad
1911 u8 outer_vlan_id_any;
1912 u8 inner_vlan_id_any;
1917 define create_subif_reply {
1923 /** \brief show version
1924 @param client_index - opaque cookie to identify the sender
1925 @param context - sender context, to match reply w/ request
1927 define show_version {
1932 /** \brief show version response
1933 @param context - sender context, to match reply w/ request
1934 @param retval - return code for the request
1935 @param program - name of the program (vpe)
1936 @param version - version of the program
1937 @param build_directory - root of the workspace where the program was built
1939 manual_java define show_version_reply {
1945 u8 build_directory[256];
1948 define nsh_gre_add_del_tunnel {
1955 u32 decap_next_index;
1956 u8 tlv_len_in_words;
1962 /* in network byte order */
1971 define nsh_gre_add_del_tunnel_reply {
1977 /** \brief Vhost-user interface details structure (fix this)
1978 @param sw_if_index - index of the interface
1979 @param interface_name - name of interface
1980 @param virtio_net_hdr_sz - net header size
1981 @param features - interface features
1982 @param is_server - vhost-user server socket
1983 @param sock_filename - socket filename
1984 @param num_regions - number of used memory regions
1986 manual_java define sw_interface_vhost_user_details {
1988 u8 interface_name[64];
1989 u32 virtio_net_hdr_sz;
1992 u8 sock_filename[256];
1998 define sw_interface_vhost_user_dump {
2003 manual_java define ip_address_details {
2010 manual_java define ip_address_dump {
2017 manual_java define ip_details {
2028 /** \brief l2 fib table entry structure
2029 @param bd_id - the l2 fib / bridge domain table id
2030 @param mac - the entry's mac address
2031 @param sw_if_index - index of the interface
2032 @param static_mac - the entry is statically configured.
2033 @param filter_mac - the entry is a mac filter entry.
2034 @param bvi_mac - the mac address is a bridge virtual interface
2036 manual_java define l2_fib_table_entry {
2045 /** \brief Dump l2 fib (aka bridge domain) table
2046 @param client_index - opaque cookie to identify the sender
2047 @param bd_id - the l2 fib / bridge domain table identifier
2049 manual_java define l2_fib_table_dump {
2055 define nsh_vxlan_gpe_add_del_tunnel {
2062 u32 decap_next_index;
2064 u8 tlv_len_in_words;
2070 /* in network byte order */
2079 define nsh_vxlan_gpe_add_del_tunnel_reply {
2085 define lisp_gpe_add_del_tunnel {
2092 u32 decap_next_index;
2098 /* in network byte order */
2102 define lisp_gpe_add_del_tunnel_reply {
2108 /** \brief add or delete locator_set
2109 @param client_index - opaque cookie to identify the sender
2110 @param context - sender context, to match reply w/ request
2111 @param is_add - add address if non-zero, else delete
2112 @param locator_set_name - locator name
2114 define lisp_add_del_locator_set {
2118 u8 locator_set_name[64];
2121 /** \brief Reply for locator_set add/del
2122 @param context - returned sender context, to match reply w/ request
2123 @param retval - return code
2125 define lisp_add_del_locator_set_reply {
2130 /** \brief add or delete locator for locator_set
2131 @param client_index - opaque cookie to identify the sender
2132 @param context - sender context, to match reply w/ request
2133 @param is_add - add address if non-zero, else delete
2134 @param locator_set_name - name of locator_set to add/del locator
2135 @param sw_if_index - index of the interface
2136 @param priority - priority of the lisp locator
2137 @param weight - weight of the lisp locator
2139 define lisp_add_del_locator {
2143 u8 locator_set_name[64];
2149 /** \brief Reply for locator add/del
2150 @param context - returned sender context, to match reply w/ request
2151 @param retval - return code
2153 define lisp_add_del_locator_reply {
2158 /** \brief add or delete lisp eid-table
2159 @param client_index - opaque cookie to identify the sender
2160 @param context - sender context, to match reply w/ request
2161 @param is_add - add address if non-zero, else delete
2162 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2163 @param ip_address - array of address bytes
2164 @param prefix_len - prefix len
2165 @param locator_set_name - name of locator_set to add/del eid-table
2167 define lisp_add_del_local_eid {
2174 u8 locator_set_name[64];
2177 /** \brief Reply for local_eid add/del
2178 @param context - returned sender context, to match reply w/ request
2179 @param retval - return code
2181 define lisp_add_del_local_eid_reply {
2186 /** \brief add or delete lisp gpe maptunel
2187 @param client_index - opaque cookie to identify the sender
2188 @param context - sender context, to match reply w/ request
2189 @param is_add - add address if non-zero, else delete
2190 @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2191 @param eid_ip_address - array of address bytes
2192 @param eid_prefix_len - prefix len
2193 @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2194 @param source_ip_address - array of address bytes
2195 @param destination_ip_address - array of address bytes
2197 define lisp_gpe_add_del_fwd_entry {
2202 u8 eid_ip_address[16];
2205 u8 source_ip_address[16];
2206 u8 destination_ip_address[16];
2209 /** \brief Reply for gpe_fwd_entry add/del
2210 @param context - returned sender context, to match reply w/ request
2211 @param retval - return code
2213 define lisp_gpe_add_del_fwd_entry_reply {
2218 /** \brief add or delete map-resolver
2219 @param client_index - opaque cookie to identify the sender
2220 @param context - sender context, to match reply w/ request
2221 @param is_add - add address if non-zero, else delete
2222 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2223 @param ip_address - array of address bytes
2225 define lisp_add_del_map_resolver {
2233 /** \brief Reply for map_resolver add/del
2234 @param context - returned sender context, to match reply w/ request
2235 @param retval - return code
2237 define lisp_add_del_map_resolver_reply {
2242 /** \brief add or delete gpe_iface
2243 @param client_index - opaque cookie to identify the sender
2244 @param context - sender context, to match reply w/ request
2245 @param is_add - add address if non-zero, else delete
2247 define lisp_gpe_add_del_iface {
2253 /** \brief Reply for gpe_iface add/del
2254 @param context - returned sender context, to match reply w/ request
2255 @param retval - return code
2257 define lisp_gpe_add_del_iface_reply {
2262 /** \brief LISP locator_set status
2263 @param locator_set_name - name of the locator_set
2264 @param sw_if_index - sw_if_index of the locator
2265 @param priority - locator priority
2266 @param weight - locator weight
2268 manual_java define lisp_locator_set_details {
2270 u8 locator_set_name[64];
2276 /** \brief Request for locator_set summary status
2277 @param client_index - opaque cookie to identify the sender
2278 @param context - sender context, to match reply w/ request
2280 define lisp_locator_set_dump {
2285 /** \brief LISP local eid table status
2286 @param locator_set_name - name of the locator_set
2287 @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2288 @param eid_ip_address - array of address bytes
2289 @param eid_prefix_len - prefix len
2291 manual_java define lisp_local_eid_table_details {
2293 u8 locator_set_name[64];
2295 u8 eid_ip_address[16];
2299 /** \brief Request for local eid table summary status
2300 @param client_index - opaque cookie to identify the sender
2301 @param context - sender context, to match reply w/ request
2303 define lisp_local_eid_table_dump {
2308 manual_java define lisp_gpe_tunnel_details {
2313 u8 destination_ip[16];
2325 /** \brief Request for gpe tunnel summary status
2326 @param client_index - opaque cookie to identify the sender
2327 @param context - sender context, to match reply w/ request
2329 define lisp_gpe_tunnel_dump {
2334 /** \brief LISP map resolver status
2335 @param locator_set_name - name of the locator_set
2336 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2337 @param ip_address - array of address bytes
2339 manual_java define lisp_map_resolver_details {
2345 /** \brief Request for map resolver summary status
2346 @param client_index - opaque cookie to identify the sender
2347 @param context - sender context, to match reply w/ request
2349 define lisp_map_resolver_dump {
2354 /* Gross kludge, DGMS */
2355 define interface_name_renumber {
2359 u32 new_show_dev_instance;
2362 define interface_name_renumber_reply {
2367 /** \brief Register for ip4 arp resolution events
2368 @param client_index - opaque cookie to identify the sender
2369 @param context - sender context, to match reply w/ request
2370 @param enable_disable - 1 => register for events, 0 => cancel registration
2371 @param pid - sender's pid
2372 @param address - the exact ip4 address of interest
2374 define want_ip4_arp_events {
2382 /** \brief Reply for interface events registration
2383 @param context - returned sender context, to match reply w/ request
2384 @param retval - return code
2386 define want_ip4_arp_events_reply {
2391 /** \brief Tell client about an ip4 arp resolution event
2392 @param client_index - opaque cookie to identify the sender
2393 @param context - sender context, to match reply w/ request
2394 @param address - the exact ip4 address of interest
2395 @param pid - client pid registered to receive notification
2396 @param sw_if_index - interface which received ARP packet
2397 @param new_mac - the new mac address
2399 define ip4_arp_event {
2408 /** \brief L2 bridge domain add or delete request
2409 @param client_index - opaque cookie to identify the sender
2410 @param context - sender context, to match reply w/ request
2411 @param bd_id - the bridge domain to create
2412 @param flood - enable/disable bcast/mcast flooding in the bd
2413 @param uu_flood - enable/disable uknown unicast flood in the bd
2414 @param forward - enable/disable forwarding on all interfaces in the bd
2415 @param learn - enable/disable learning on all interfaces in the bd
2416 @param arp_term - enable/disable arp termination in the bd
2417 @param is_add - add or delete flag
2419 define bridge_domain_add_del {
2431 /** \brief L2 bridge domain add or delete response
2432 @param context - sender context, to match reply w/ request
2433 @param retval - return code for the set bridge flags request
2435 define bridge_domain_add_del_reply {
2440 /** \brief L2 bridge domain request operational state details
2441 @param client_index - opaque cookie to identify the sender
2442 @param context - sender context, to match reply w/ request
2443 @param bd_id - the bridge domain id desired or ~0 to request all bds
2445 manual_java define bridge_domain_dump {
2451 /** \brief L2 bridge domain operational state response
2452 @param bd_id - the bridge domain id
2453 @param flood - bcast/mcast flooding state on all interfaces in the bd
2454 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2455 @param forward - forwarding state on all interfaces in the bd
2456 @param learn - learning state on all interfaces in the bd
2457 @param arp_term - arp termination state on all interfaces in the bd
2458 @param n_sw_ifs - number of sw_if_index's in the domain
2460 manual_java define bridge_domain_details {
2468 u32 bvi_sw_if_index;
2472 /** \brief L2 bridge domain sw interface operational state response
2473 @param bd_id - the bridge domain id
2474 @param sw_if_index - sw_if_index in the domain
2475 @param shg - split horizon group for the interface
2477 manual_java define bridge_domain_sw_if_details {
2484 /** \brief DHCP Client config add / del request
2485 @param client_index - opaque cookie to identify the sender
2486 @param context - sender context, to match reply w/ request
2487 @param sw_if_index - index of the interface for DHCP client
2488 @param hostname - hostname
2489 @param is_add - add the config if non-zero, else delete
2490 @param want_dhcp_event - DHCP event sent to the sender
2491 via dhcp_compl_event API message if non-zero
2492 @param pid - sender's pid
2494 define dhcp_client_config {
2504 /** \brief DHCP Client config response
2505 @param context - sender context, to match reply w/ request
2506 @param retval - return code for the request
2508 define dhcp_client_config_reply {
2513 /** \brief Set/unset input ACL interface
2514 @param client_index - opaque cookie to identify the sender
2515 @param context - sender context, to match reply w/ request
2516 @param sw_if_index - interface to set/unset input ACL
2517 @param ip4_table_index - ip4 classify table index (~0 for skip)
2518 @param ip6_table_index - ip6 classify table index (~0 for skip)
2519 @param l2_table_index - l2 classify table index (~0 for skip)
2520 @param is_add - Set input ACL if non-zero, else unset
2521 Note: User is recommeneded to use just one valid table_index per call.
2522 (ip4_table_index, ip6_table_index, or l2_table_index)
2524 define input_acl_set_interface {
2528 u32 ip4_table_index;
2529 u32 ip6_table_index;
2534 /** \brief Set/unset input ACL interface response
2535 @param context - sender context, to match reply w/ request
2536 @param retval - return code for the request
2538 define input_acl_set_interface_reply {
2543 /** \brief IPsec: Add/delete Security Policy Database
2544 @param client_index - opaque cookie to identify the sender
2545 @param context - sender context, to match reply w/ request
2546 @param is_add - add SPD if non-zero, else delete
2547 @param spd_id - SPD instance id (control plane allocated)
2550 define ipsec_spd_add_del {
2557 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2558 @param context - returned sender context, to match reply w/ request
2559 @param retval - return code
2562 define ipsec_spd_add_del_reply {
2567 /** \brief IPsec: Add/delete SPD from interface
2569 @param client_index - opaque cookie to identify the sender
2570 @param context - sender context, to match reply w/ request
2571 @param is_add - add security mode if non-zero, else delete
2572 @param sw_if_index - index of the interface
2573 @param spd_id - SPD instance id to use for lookups
2577 define ipsec_interface_add_del_spd {
2586 /** \brief Reply for IPsec: Add/delete SPD from interface
2587 @param context - returned sender context, to match reply w/ request
2588 @param retval - return code
2591 define ipsec_interface_add_del_spd_reply {
2596 /** \brief IPsec: Add/delete Security Policy Database entry
2598 See RFC 4301, 4.4.1.1 on how to match packet to selectors
2600 @param client_index - opaque cookie to identify the sender
2601 @param context - sender context, to match reply w/ request
2602 @param is_add - add SPD if non-zero, else delete
2603 @param spd_id - SPD instance id (control plane allocated)
2604 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
2605 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2606 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2607 @param remote_address_start - start of remote address range to match
2608 @param remote_address_stop - end of remote address range to match
2609 @param local_address_start - start of local address range to match
2610 @param local_address_stop - end of local address range to match
2611 @param protocol - protocol type to match [0 means any]
2612 @param remote_port_start - start of remote port range to match ...
2613 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2614 @param local_port_start - start of local port range to match ...
2615 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2616 @param policy - 0 = bypass (no IPsec processing), 1 = discard (discard packet with ICMP processing), 2 = resolve (send request to control plane for SA resolving, and discard without ICMP processing), 3 = protect (apply IPsec policy using following parameters)
2617 @param sa_id - SAD instance id (control plane allocated)
2621 define ipsec_spd_add_del_entry {
2633 u8 remote_address_start[16];
2634 u8 remote_address_stop[16];
2635 u8 local_address_start[16];
2636 u8 local_address_stop[16];
2640 u16 remote_port_start;
2641 u16 remote_port_stop;
2642 u16 local_port_start;
2643 u16 local_port_stop;
2650 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2651 @param context - returned sender context, to match reply w/ request
2652 @param retval - return code
2655 define ipsec_spd_add_del_entry_reply {
2660 /** \brief IPsec: Add/delete Security Association Database entry
2661 @param client_index - opaque cookie to identify the sender
2662 @param context - sender context, to match reply w/ request
2663 @param is_add - add SAD entry if non-zero, else delete
2665 @param sad_id - sad id
2667 @param spi - security parameter index
2669 @param protocol - 0 = AH, 1 = ESP
2671 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
2672 @param crypto_key_length - length of crypto_key in bytes
2673 @param crypto_key - crypto keying material
2675 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
2676 @param integrity_key_length - length of integrity_key in bytes
2677 @param integrity_key - integrity keying material
2679 @param use_extended_sequence_number - use ESN when non-zero
2681 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
2682 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
2683 @param tunnel_src_address - IPsec tunnel source address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
2684 @param tunnel_dst_address - IPsec tunnel destination address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
2688 IPsec tunnel address copy mode (to support GDOI)
2691 define ipsec_sad_add_del_entry {
2702 u8 crypto_algorithm;
2703 u8 crypto_key_length;
2706 u8 integrity_algorithm;
2707 u8 integrity_key_length;
2708 u8 integrity_key[128];
2710 u8 use_extended_sequence_number;
2714 u8 tunnel_src_address[16];
2715 u8 tunnel_dst_address[16];
2718 /** \brief Reply for IPsec: Add/delete Security Association Database entry
2719 @param context - returned sender context, to match reply w/ request
2720 @param retval - return code
2723 define ipsec_sad_add_del_entry_reply {
2728 /** \brief IPsec: Update Security Association keys
2729 @param client_index - opaque cookie to identify the sender
2730 @param context - sender context, to match reply w/ request
2732 @param sa_id - sa id
2734 @param crypto_key_length - length of crypto_key in bytes
2735 @param crypto_key - crypto keying material
2737 @param integrity_key_length - length of integrity_key in bytes
2738 @param integrity_key - integrity keying material
2741 define ipsec_sa_set_key {
2747 u8 crypto_key_length;
2750 u8 integrity_key_length;
2751 u8 integrity_key[128];
2754 /** \brief Reply for IPsec: Update Security Association keys
2755 @param context - returned sender context, to match reply w/ request
2756 @param retval - return code
2759 define ipsec_sa_set_key_reply {
2764 /** \brief IKEv2: Add/delete profile
2765 @param client_index - opaque cookie to identify the sender
2766 @param context - sender context, to match reply w/ request
2768 @param name - IKEv2 profile name
2769 @param is_add - Add IKEv2 profile if non-zero, else delete
2771 define ikev2_profile_add_del {
2779 /** \brief Reply for IKEv2: Add/delete profile
2780 @param context - returned sender context, to match reply w/ request
2781 @param retval - return code
2783 define ikev2_profile_add_del_reply {
2788 /** \brief IKEv2: Set IKEv2 profile authentication method
2789 @param client_index - opaque cookie to identify the sender
2790 @param context - sender context, to match reply w/ request
2792 @param name - IKEv2 profile name
2793 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
2794 @param is_hex - Authentication data in hex format if non-zero, else string
2795 @param data_len - Authentication data length
2796 @param data - Authentication data (for rsa-sig cert file path)
2798 define ikev2_profile_set_auth {
2809 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
2810 @param context - returned sender context, to match reply w/ request
2811 @param retval - return code
2813 define ikev2_profile_set_auth_reply {
2818 /** \brief IKEv2: Set IKEv2 profile local/remote identification
2819 @param client_index - opaque cookie to identify the sender
2820 @param context - sender context, to match reply w/ request
2822 @param name - IKEv2 profile name
2823 @param is_local - Identification is local if non-zero, else remote
2824 @param id_type - Identification type
2825 @param data_len - Identification data length
2826 @param data - Identification data
2828 define ikev2_profile_set_id {
2839 /** \brief Reply for IKEv2:
2840 @param context - returned sender context, to match reply w/ request
2841 @param retval - return code
2843 define ikev2_profile_set_id_reply {
2848 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
2849 @param client_index - opaque cookie to identify the sender
2850 @param context - sender context, to match reply w/ request
2852 @param name - IKEv2 profile name
2853 @param is_local - Traffic selector is local if non-zero, else remote
2854 @param proto - Traffic selector IP protocol (if zero not relevant)
2855 @param start_port - The smallest port number allowed by traffic selector
2856 @param end_port - The largest port number allowed by traffic selector
2857 @param start_addr - The smallest address included in traffic selector
2858 @param end_addr - The largest address included in traffic selector
2860 define ikev2_profile_set_ts {
2873 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
2874 @param context - returned sender context, to match reply w/ request
2875 @param retval - return code
2877 define ikev2_profile_set_ts_reply {
2882 /** \brief IKEv2: Set IKEv2 local RSA private key
2883 @param client_index - opaque cookie to identify the sender
2884 @param context - sender context, to match reply w/ request
2886 @param key_file - Key file absolute path
2888 define ikev2_set_local_key {
2895 /** \brief Reply for IKEv2: Set IKEv2 local key
2896 @param context - returned sender context, to match reply w/ request
2897 @param retval - return code
2899 define ikev2_set_local_key_reply {
2904 /** \brief Tell client about a DHCP completion event
2905 @param client_index - opaque cookie to identify the sender
2906 @param pid - client pid registered to receive notification
2907 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2908 @param host_address - Host IP address
2909 @param router_address - Router IP address
2910 @param host_mac - Host MAC address
2912 manual_java define dhcp_compl_event {
2917 u8 host_address[16];
2918 u8 router_address[16];
2922 /** \brief Add MAP domains
2923 @param client_index - opaque cookie to identify the sender
2924 @param context - sender context, to match reply w/ request
2925 @param ip6_prefix - Rule IPv6 prefix
2926 @param ip4_prefix - Rule IPv4 prefix
2927 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
2928 @param ip6_prefix_len - Rule IPv6 prefix length
2929 @param ip4_prefix_len - Rule IPv4 prefix length
2930 @param ea_bits_len - Embedded Address bits length
2931 @param psid_offset - Port Set Identifider (PSID) offset
2932 @param psid_length - PSID length
2933 @param is_translation - MAP-E / MAP-T
2936 define map_add_domain {
2944 u8 ip6_src_prefix_len;
2952 /** \brief Reply for MAP domain add
2953 @param context - returned sender context, to match reply w/ request
2954 @param index - MAP domain index
2955 @param retval - return code
2957 define map_add_domain_reply {
2963 /** \brief Delete MAP domain
2964 @param client_index - opaque cookie to identify the sender
2965 @param context - sender context, to match reply w/ request
2966 @param index - MAP Domain index
2968 define map_del_domain {
2974 /** \brief Reply for MAP domain del
2975 @param context - returned sender context, to match reply w/ request
2976 @param retval - return code
2978 define map_del_domain_reply {
2983 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
2984 @param client_index - opaque cookie to identify the sender
2985 @param context - sender context, to match reply w/ request
2986 @param index - MAP Domain index
2987 @param is_add - If 1 add rule, if 0 delete rule
2988 @param ip6_dst - MAP CE IPv6 address
2989 @param psid - Rule PSID
2991 define map_add_del_rule {
3000 /** \brief Reply for MAP rule add/del
3001 @param context - returned sender context, to match reply w/ request
3002 @param retval - return code
3004 define map_add_del_rule_reply {
3009 /** \brief Get list of map domains
3010 @param client_index - opaque cookie to identify the sender
3012 define map_domain_dump {
3017 manual_java define map_domain_details {
3033 define map_rule_dump {
3039 manual_java define map_rule_details {
3044 /** \brief Request for a single block of summary stats
3045 @param client_index - opaque cookie to identify the sender
3046 @param context - sender context, to match reply w/ request
3048 define map_summary_stats {
3053 /** \brief Reply for map_summary_stats request
3054 @param context - sender context, to match reply w/ request
3055 @param retval - return code for request
3056 @param total_bindings -
3058 @param total_ip4_fragments -
3059 @param total_security_check -
3061 define map_summary_stats_reply {
3067 u64 total_ip4_fragments;
3068 u64 total_security_check[2];
3071 /** \brief cop: enable/disable junk filtration features on an interface
3072 @param client_index - opaque cookie to identify the sender
3073 @param context - sender context, to match reply w/ request
3074 @param sw_if_inded - desired interface
3075 @param enable_disable - 1 => enable, 0 => disable
3078 define cop_interface_enable_disable {
3085 /** \brief cop: interface enable/disable junk filtration reply
3086 @param context - returned sender context, to match reply w/ request
3087 @param retval - return code
3090 define cop_interface_enable_disable_reply {
3095 /** \brief cop: enable/disable whitelist filtration features on an interface
3096 Note: the supplied fib_id must match in order to remove the feature!
3098 @param client_index - opaque cookie to identify the sender
3099 @param context - sender context, to match reply w/ request
3100 @param sw_if_index - interface handle, physical interfaces only
3101 @param fib_id - fib identifier for the whitelist / blacklist fib
3102 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3103 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3104 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3107 define cop_whitelist_enable_disable {
3117 /** \brief cop: interface enable/disable junk filtration reply
3118 @param context - returned sender context, to match reply w/ request
3119 @param retval - return code
3122 define cop_whitelist_enable_disable_reply {
3127 /** \brief get_node_graph - get a copy of the vpp node graph
3128 including the current set of graph arcs.
3130 @param client_index - opaque cookie to identify the sender
3131 @param context - sender context, to match reply w/ request
3134 define get_node_graph {
3139 /** \brief get_node_graph_reply
3140 @param context - returned sender context, to match reply w/ request
3141 @param retval - return code
3142 @param reply_in_shmem - result from vlib_node_serialize, in shared
3143 memory. Process with vlib_node_unserialize, remember to switch
3144 heaps and free the result.
3147 define get_node_graph_reply {
3153 /** \brief Clear interface statistics
3154 @param client_index - opaque cookie to identify the sender
3155 @param context - sender context, to match reply w/ request
3156 @param sw_if_index - index of the interface to clear statistics
3158 define sw_interface_clear_stats {
3164 /** \brief Reply to sw_interface_clear_stats
3165 @param context - sender context which was passed in the request
3166 @param retval - return code of the set flags request
3168 define sw_interface_clear_stats_reply {
3173 /** \brief IOAM Trace : Set TRACE profile
3174 @param id - profile id
3175 @param trace_type - Trace type
3176 @param trace_num_elt - Number of nodes in trace path
3177 @param trace_ppc - Trace PPC (none/encap/decap)
3178 @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3179 @param trace_app_data - Trace application data, can be any 4 bytes
3180 @param pow_enable - Proof of Work enabled or not flag
3181 @param node_id - Id of this node
3183 define trace_profile_add {
3196 /** \brief Trace profile add / del response
3197 @param context - sender context, to match reply w/ request
3198 @param retval - return value for request
3200 define trace_profile_add_reply {
3205 /** \brief IOAM Trace enable trace profile for a flow
3206 @param id - id of the trace profile to be applied
3207 @param dest_ipv6 - Destination IPv6 address
3208 @param prefix_length - prefix mask
3209 @param vrf_id - VRF ID
3210 @param trace_op - Trace operation (add/mod/del)
3211 @param enable - apply/remove the trace profile for the flow
3213 define trace_profile_apply {
3224 /** \brief Trace profile apply response
3225 @param context - sender context, to match reply w/ request
3226 @param retval - return value for request
3228 define trace_profile_apply_reply {
3233 /** \brief Delete Trace Profile
3234 @param client_index - opaque cookie to identify the sender
3235 @param context - sender context, to match reply w/ request
3236 @param index - MAP Domain index
3238 define trace_profile_del {
3244 /** \brief Trace profile add / del response
3245 @param context - sender context, to match reply w/ request
3246 @param retval - return value for request
3248 define trace_profile_del_reply {