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 {
73 /* index of sup interface (e.g. hw interface).
74 equal to sw_if_index for super hw interface. */
77 /* Layer 2 address, if applicable */
78 u32 l2_address_length;
82 u8 interface_name[64];
84 /* 1 = up, 0 = down */
88 /* 1 = half duplex, 2 = full duplex */
91 /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
97 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface*/
100 /* 0 = dot1q, 1=dot1ad */
103 /* Number of tags 0-2 */
104 u8 sub_number_of_tags;
105 u16 sub_outer_vlan_id;
106 u16 sub_inner_vlan_id;
109 u8 sub_outer_vlan_id_any;
110 u8 sub_inner_vlan_id_any;
112 /* vlan tag rewrite state */
114 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
115 u32 vtr_tag1; // first pushed tag
116 u32 vtr_tag2; // second pushed tag
119 /** \brief Set flags on the interface
120 @param client_index - opaque cookie to identify the sender
121 @param context - sender context, to match reply w/ request
122 @param sw_if_index - index of the interface to set flags on
123 @param admin_up_down - set the admin state, 1 = up, 0 = down
124 @param link_up_down - Oper state sent on change event, not used in config.
125 @param deleted - interface was deleted
127 define sw_interface_set_flags {
131 /* 1 = up, 0 = down */
137 /** \brief Reply to sw_interface_set_flags
138 @param context - sender context which was passed in the request
139 @param retval - return code of the set flags request
141 define sw_interface_set_flags_reply {
147 manual_java define sw_interface_dump {
150 u8 name_filter_valid;
154 /** \brief Set or delete one or all ip addresses on a specified interface
155 @param client_index - opaque cookie to identify the sender
156 @param context - sender context, to match reply w/ request
157 @param sw_if_index - index of the interface to add/del addresses
158 @param is_add - add address if non-zero, else delete
159 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
160 @param del_all - if non-zero delete all addresses on the interface
161 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
162 @param address - array of address bytes
164 define sw_interface_add_del_address {
175 /** \brief Reply for interface events registration
176 @param context - returned sender context, to match reply w/ request
177 @param retval - return code
179 define sw_interface_add_del_address_reply {
184 /** \brief Associate the specified interface with a fib table
185 @param client_index - opaque cookie to identify the sender
186 @param context - sender context, to match reply w/ request
187 @param sw_if_index - index of the interface
188 @param is_ipv6 - if non-zero ipv6, else ipv4
189 @param vrf_id - fib table/vrd id to associate the interface with
191 define sw_interface_set_table {
199 /** \brief Reply for interface events registration
200 @param context - returned sender context, to match reply w/ request
201 @param retval - return code
203 define sw_interface_set_table_reply {
208 /** \brief Initialize a new tap interface with the given paramters
209 @param client_index - opaque cookie to identify the sender
210 @param context - sender context, to match reply w/ request
211 @param use_random_mac - let the system generate a unique mac address
212 @param tap_name - name to associate with the new interface
213 @param mac_address - mac addr to assign to the interface if use_radom not set
222 u32 custom_dev_instance;
225 /** \brief Reply for tap connect request
226 @param context - returned sender context, to match reply w/ request
227 @param retval - return code
228 @param sw_if_index - software index allocated for the new tap interface
230 define tap_connect_reply {
236 /** \brief Modify a tap interface with the given paramters
237 @param client_index - opaque cookie to identify the sender
238 @param context - sender context, to match reply w/ request
239 @param sw_if_index - interface index of existing tap interface
240 @param use_random_mac - let the system generate a unique mac address
241 @param tap_name - name to associate with the new interface
242 @param mac_address - mac addr to assign to the interface if use_radom not set
252 u32 custom_dev_instance;
255 /** \brief Reply for tap modify request
256 @param context - returned sender context, to match reply w/ request
257 @param retval - return code
258 @param sw_if_index - software index if the modified tap interface
260 define tap_modify_reply {
266 /** \brief Delete tap interface
267 @param client_index - opaque cookie to identify the sender
268 @param context - sender context, to match reply w/ request
269 @param sw_if_index - interface index of existing tap interface
277 /** \brief Reply for tap delete request
278 @param context - returned sender context, to match reply w/ request
279 @param retval - return code
281 define tap_delete_reply {
286 /** \brief Dump tap interfaces request */
287 define sw_interface_tap_dump {
292 /** \brief Reply for tap dump request
293 @param sw_if_index - software index of tap interface
294 @param dev_name - Linux tap device name
296 manual_java define sw_interface_tap_details {
302 /** \brief Create a new subinterface with the given vlan id
303 @param client_index - opaque cookie to identify the sender
304 @param context - sender context, to match reply w/ request
305 @param sw_if_index - software index of the new vlan's parent interface
306 @param vlan_id - vlan tag of the new interface
308 define create_vlan_subif {
315 /** \brief Reply for the vlan subinterface create request
316 @param context - returned sender context, to match reply w/ request
317 @param retval - return code
318 @param sw_if_index - software index allocated for the new subinterface
320 define create_vlan_subif_reply {
326 /** \brief Add / del route request
327 @param client_index - opaque cookie to identify the sender
328 @param context - sender context, to match reply w/ request
329 @param sw_if_index - software index of the new vlan's parent interface
330 @param vrf_id - fib table /vrf associated with the route
331 @param lookup_in_vrf -
332 @param resolve_attempts -
333 @param classify_table_index -
334 @param create_vrf_if_needed -
335 @param resolve_if_needed -
336 @param is_add - 1 if adding the route, 0 if deleting
338 @param is_ipv6 - 0 if an ip4 route, else ip6
341 @param is_multipath - Set to 1 if this is a multipath route, else 0
342 @param not_last - Is last or not last msg in group of multiple add/del msgs
343 @param next_hop_weight -
344 @param dst_address_length -
345 @param dst_address[16] -
346 @param next_hop_address[16] -
348 define ip_add_del_route {
351 u32 next_hop_sw_if_index;
354 u32 resolve_attempts;
355 u32 classify_table_index;
356 u8 create_vrf_if_needed;
357 u8 resolve_if_needed;
363 /* Is last/not-last message in group of multiple add/del messages. */
367 u8 dst_address_length;
369 u8 next_hop_address[16];
372 /** \brief Reply for add / del route request
373 @param context - returned sender context, to match reply w/ request
374 @param retval - return code
376 define ip_add_del_route_reply {
382 /** \brief Add / del gre tunnel request
383 @param client_index - opaque cookie to identify the sender
384 @param context - sender context, to match reply w/ request
385 @param sw_if_index - software index of the new vlan's parent interface
386 @param inner_vrf_id -
387 @param outer_vrf_id -
388 @param is_add - 1 if adding the tunnel, 0 if deleting
389 @param src_address[4] - tunnel source address
390 @param dst_address[4] - tunnel destination address
391 @param intf_address -
392 @param intf_address_length -
394 define mpls_gre_add_del_tunnel {
404 u8 intfc_address_length;
407 /** \brief Reply for add / del tunnel request
408 @param context - returned sender context, to match reply w/ request
409 @param retval - return code
411 define mpls_gre_add_del_tunnel_reply {
414 u32 tunnel_sw_if_index;
417 /** \brief Add / del MPLS encapsulation request
418 @param client_index - opaque cookie to identify the sender
419 @param context - sender context, to match reply w/ request
420 @param vrf_id - vrf id
421 @param dst_address[4] -
422 @param is_add - 1 if adding the encap, 0 if deleting
423 @param nlabels - number of labels
424 @param labels - array of labels
426 define mpls_add_del_encap {
431 /* 1 = add, 0 = delete */
437 /** \brief Reply for add / del encapsulation request
438 @param context - returned sender context, to match reply w/ request
439 @param retval - return code
441 define mpls_add_del_encap_reply {
446 /** \brief Add / del MPLS decapsulation request
447 @param client_index - opaque cookie to identify the sender
448 @param context - sender context, to match reply w/ request
449 @param rx_vrf_id - receive vrf
450 @param tx_vrf_id - transmit vrf
454 @param is_add - 1 if adding the encap, 0 if deleting
456 define mpls_add_del_decap {
467 /** \brief Reply for MPLS decap add / del request
468 @param context - returned sender context, to match reply w/ request
469 @param retval - return code
471 define mpls_add_del_decap_reply {
476 /** \brief Proxy ARP add / del request
477 @param client_index - opaque cookie to identify the sender
478 @param context - sender context, to match reply w/ request
479 @param vrf_id - VRF / Fib table ID
480 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
481 @param low_address[4] - Low address of the Proxy ARP range
482 @param hi_address[4] - High address of the Proxy ARP range
484 define proxy_arp_add_del {
493 /** \brief Reply for proxy arp add / del request
494 @param context - returned sender context, to match reply w/ request
495 @param retval - return code
497 define proxy_arp_add_del_reply {
502 /** \brief Proxy ARP add / del request
503 @param client_index - opaque cookie to identify the sender
504 @param context - sender context, to match reply w/ request
505 @param sw_if_index - Which interface to enable / disable Proxy Arp on
506 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
508 define proxy_arp_intfc_enable_disable {
512 /* 1 = on, 0 = off */
516 /** \brief Reply for Proxy ARP interface enable / disable request
517 @param context - returned sender context, to match reply w/ request
518 @param retval - return code
520 define proxy_arp_intfc_enable_disable_reply {
525 /** \brief IP neighbor add / del request
526 @param client_index - opaque cookie to identify the sender
527 @param context - sender context, to match reply w/ request
528 @param vrf_id - vrf_id, only for IP4
529 @param sw_if_index - interface used to reach neighbor
530 @param is_add - 1 to add neighbor, 0 to delete
531 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
533 @param mac_address - l2 address of the neighbor
534 @param dst_address - ip4 or ip6 address of the neighbor
536 define ip_neighbor_add_del {
539 u32 vrf_id; /* only makes sense for ip4 */
541 /* 1 = add, 0 = delete */
549 /** \brief Reply for IP Neighbor add / delete request
550 @param context - returned sender context, to match reply w/ request
551 @param retval - return code
553 define ip_neighbor_add_del_reply {
558 /** \brief Reset VRF (remove all routes etc) request
559 @param client_index - opaque cookie to identify the sender
560 @param context - sender context, to match reply w/ request
561 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
562 @param vrf_id - ID of th FIB table / VRF to reset
571 /** \brief Reply for Reset VRF request
572 @param context - returned sender context, to match reply w/ request
573 @param retval - return code
575 define reset_vrf_reply {
580 /** \brief Is Address Reachable request - DISABLED
581 @param client_index - opaque cookie to identify the sender
582 @param context - sender context, to match reply w/ request
583 @param next_hop_sw_if_index - index of interface used to get to next hop
584 @param is_ipv6 - 1 for IPv6, 0 for IPv4
585 @param is_error - address not found or does not match intf
586 @param address[] - Address in question
588 define is_address_reachable {
589 u32 client_index; /* (api_main_t *) am->my_client_index */
591 u32 next_hop_sw_if_index;
592 u8 is_known; /* on reply, this is the answer */
594 u8 is_error; /* address not found or does not match intf */
598 /** \brief Want Stats, register for stats updates
599 @param client_index - opaque cookie to identify the sender
600 @param context - sender context, to match reply w/ request
601 @param enable_disable - 1 = enable stats, 0 = disable
602 @param pid - pid of process requesting stats updates
611 /** \brief Reply for Want Stats request
612 @param context - returned sender context, to match reply w/ request
613 @param retval - return code
615 manual_java define want_stats_reply {
620 /** \brief Want stats counters structure
621 @param vnet_counter_type- such as ip4, ip6, punts, etc
622 @param is_combined - rx & tx total (all types) counts
623 @param first_sw_if_index - first sw index in block of index, counts
624 @param count - number of interfaces this stats block includes counters for
625 @param data - contiguous block of vlib_counter_t structures
627 manual_java define vnet_interface_counters {
628 /* enums - plural - in vnet/interface.h */
629 u8 vnet_counter_type;
631 u32 first_sw_if_index;
636 typeonly manual_print manual_endian define ip4_fib_counter {
643 manual_java manual_print manual_endian define vnet_ip4_fib_counters {
646 vl_api_ip4_fib_counter_t c[0];
649 typeonly manual_print manual_endian define ip6_fib_counter {
656 manual_java manual_print manual_endian define vnet_ip6_fib_counters {
659 vl_api_ip6_fib_counter_t c[0];
662 /** \brief Request for a single block of summary stats
663 @param client_index - opaque cookie to identify the sender
664 @param context - sender context, to match reply w/ request
666 define vnet_get_summary_stats {
671 /** \brief Reply for vnet_get_summary_stats request
672 @param context - sender context, to match reply w/ request
673 @param retval - return code for request
678 define vnet_summary_stats_reply {
686 /** \brief OAM event structure
687 @param dst_address[] -
690 manual_java define oam_event {
695 /** \brief Want OAM events request
696 @param client_index - opaque cookie to identify the sender
697 @param context - sender context, to match reply w/ request
698 @param enable_disable- enable if non-zero, else disable
699 @param pid - pid of the requesting process
701 define want_oam_events {
708 /** \brief Want OAM events response
709 @param context - sender context, to match reply w/ request
710 @param retval - return code for the want oam stats request
712 define want_oam_events_reply {
717 /** \brief OAM add / del target request
718 @param client_index - opaque cookie to identify the sender
719 @param context - sender context, to match reply w/ request
720 @param vrf_id - vrf_id of the target
721 @param src_address[] - source address to use for the updates
722 @param dst_address[] - destination address of the target
723 @param is_add - add target if non-zero, else delete
734 /** \brief OAM add / del target response
735 @param context - sender context, to match reply w/ request
736 @param retval - return code of the request
738 define oam_add_del_reply {
743 /** \brief Reset fib table request
744 @param client_index - opaque cookie to identify the sender
745 @param context - sender context, to match reply w/ request
746 @param vrf_id - vrf/table id of the fib table to reset
747 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
756 /** \brief Reset fib response
757 @param context - sender context, to match reply w/ request
758 @param retval - return code for the reset bfib request
760 define reset_fib_reply {
765 /** \brief DHCP Proxy config add / del request
766 @param client_index - opaque cookie to identify the sender
767 @param context - sender context, to match reply w/ request
768 @param vrf_id - vrf id
769 @param if_ipv6 - ipv6 if non-zero, else ipv4
770 @param is_add - add the config if non-zero, else delete
771 @param insert_circuit_id - option82 suboption 1 fib number
772 @param dhcp_server[] - server address
773 @param dhcp_src_address[] - <fix this, need details>
775 define dhcp_proxy_config {
781 u8 insert_circuit_id;
783 u8 dhcp_src_address[16];
786 /** \brief DHCP Proxy config response
787 @param context - sender context, to match reply w/ request
788 @param retval - return code for the request
790 define dhcp_proxy_config_reply {
795 /** \brief DHCP Proxy set / unset vss request
796 @param client_index - opaque cookie to identify the sender
797 @param context - sender context, to match reply w/ request
798 @param tbl_id - table id
799 @param oui - first part of vpn id
800 @param fib_id - second part of vpn id
801 @param is_ipv6 - ip6 if non-zero, else ip4
802 @param is_add - set vss if non-zero, else delete
804 define dhcp_proxy_set_vss {
814 /** \brief DHCP proxy set / unset vss response
815 @param context - sender context, to match reply w/ request
816 @param retval - return code for the request
818 define dhcp_proxy_set_vss_reply {
823 /** \brief Set the ip flow hash config for a fib request
824 @param client_index - opaque cookie to identify the sender
825 @param context - sender context, to match reply w/ request
826 @param vrf_id - vrf/fib id
827 @param is_ipv6 - if non-zero the fib is ip6, else ip4
828 @param src - if non-zero include src in flow hash
829 @param dst - if non-zero include dst in flow hash
830 @param sport - if non-zero include sport in flow hash
831 @param dport - if non-zero include dport in flow hash
832 @param proto -if non-zero include proto in flow hash
833 @param reverse - if non-zero include reverse in flow hash
835 define set_ip_flow_hash {
848 /** \brief Set the ip flow hash config for a fib response
849 @param context - sender context, to match reply w/ request
850 @param retval - return code for the request
852 define set_ip_flow_hash_reply {
857 /** \brief IPv6 router advertisement config request
858 @param client_index - opaque cookie to identify the sender
859 @param context - sender context, to match reply w/ request
864 @param send_unicast -
867 @param default_router -
868 @param max_interval -
869 @param min_interval -
871 @param initial_count -
872 @param initial_interval -
874 define sw_interface_ip6nd_ra_config {
890 u32 initial_interval;
893 /** \brief IPv6 router advertisement config response
894 @param context - sender context, to match reply w/ request
895 @param retval - return code for the request
897 define sw_interface_ip6nd_ra_config_reply {
902 /** \brief IPv6 router advertisement prefix config request
903 @param client_index - opaque cookie to identify the sender
904 @param context - sender context, to match reply w/ request
907 @param address_length -
909 @param no_advertise -
911 @param no_autoconfig -
914 @param val_lifetime -
915 @param pref_lifetime -
917 define sw_interface_ip6nd_ra_prefix {
933 /** \brief IPv6 router advertisement prefix config response
934 @param context - sender context, to match reply w/ request
935 @param retval - return code for the request
937 define sw_interface_ip6nd_ra_prefix_reply {
942 /** \brief IPv6 interface enable / disable request
943 @param client_index - opaque cookie to identify the sender
944 @param context - sender context, to match reply w/ request
945 @param sw_if_index - interface used to reach neighbor
946 @param enable - if non-zero enable ip6 on interface, else disable
948 define sw_interface_ip6_enable_disable {
952 u8 enable; /* set to true if enable*/
955 /** \brief IPv6 interface enable / disable response
956 @param context - sender context, to match reply w/ request
957 @param retval - return code for the request
959 define sw_interface_ip6_enable_disable_reply {
964 /** \brief IPv6 set link local address on interface request
965 @param client_index - opaque cookie to identify the sender
966 @param context - sender context, to match reply w/ request
967 @param sw_if_index - interface to set link local on
968 @param address[] - the new link local address
969 @param address_length - link local address length
971 define sw_interface_ip6_set_link_local_address {
979 /** \brief IPv6 set link local address on interface response
980 @param context - sender context, to match reply w/ request
981 @param retval - error code for the request
983 define sw_interface_ip6_set_link_local_address_reply {
988 /** \brief Set unnumbered interface add / del request
989 @param client_index - opaque cookie to identify the sender
990 @param context - sender context, to match reply w/ request
991 @param sw_if_index - interface with an IP address
992 @param unnumbered_sw_if_index - interface which will use the address
993 @param is_add - if non-zero set the association, else unset it
995 define sw_interface_set_unnumbered {
998 u32 sw_if_index; /* use this intfc address */
999 u32 unnumbered_sw_if_index; /* on this interface */
1003 /** \brief Set unnumbered interface add / del response
1004 @param context - sender context, to match reply w/ request
1005 @param retval - return code for the request
1007 define sw_interface_set_unnumbered_reply {
1012 /** \brief Create loopback interface request
1013 @param client_index - opaque cookie to identify the sender
1014 @param context - sender context, to match reply w/ request
1015 @param mac_address - mac addr to assign to the interface if none-zero
1017 define create_loopback {
1023 /** \brief Create loopback interface response
1024 @param context - sender context, to match reply w/ request
1025 @param sw_if_index - sw index of the interface that was created
1026 @param retval - return code for the request
1028 define create_loopback_reply {
1034 /** \brief Delete loopback interface request
1035 @param client_index - opaque cookie to identify the sender
1036 @param context - sender context, to match reply w/ request
1037 @param sw_if_index - sw index of the interface that was created
1039 define delete_loopback {
1045 /** \brief Delete loopback interface response
1046 @param context - sender context, to match reply w/ request
1047 @param retval - return code for the request
1049 define delete_loopback_reply {
1054 /** \brief Control ping from client to api server request
1055 @param client_index - opaque cookie to identify the sender
1056 @param context - sender context, to match reply w/ request
1058 manual_java define control_ping {
1063 /** \brief Control ping from the client to the server response
1064 @param client_index - opaque cookie to identify the sender
1065 @param context - sender context, to match reply w/ request
1066 @param retval - return code for the request
1067 @param vpe_pid - the pid of the vpe, returned by the server
1069 manual_java define control_ping_reply {
1076 /** \brief Process a vpe parser cli string request
1077 @param client_index - opaque cookie to identify the sender
1078 @param context - sender context, to match reply w/ request
1079 @param cmd_in_shmem - pointer to cli command string
1081 define cli_request {
1087 /** \brief vpe parser cli string response
1088 @param context - sender context, to match reply w/ request
1089 @param retval - return code for request
1090 @param reply_in_shmem - Reply string from cli processing if any
1098 /** \brief Set max allowed ARP or ip6 neighbor entries request
1099 @param client_index - opaque cookie to identify the sender
1100 @param context - sender context, to match reply w/ request
1101 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1102 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1104 define set_arp_neighbor_limit {
1108 u32 arp_neighbor_limit;
1111 /** \brief Set max allowed ARP or ip6 neighbor entries response
1112 @param context - sender context, to match reply w/ request
1113 @param retval - return code for request
1115 define set_arp_neighbor_limit_reply {
1120 /** \brief L2 interface patch add / del request
1121 @param client_index - opaque cookie to identify the sender
1122 @param context - sender context, to match reply w/ request
1123 @param rx_sw_if_index - receive side interface
1124 @param tx_sw_if_index - transmit side interface
1125 @param is_add - if non-zero set up the interface patch, else remove it
1127 define l2_patch_add_del {
1135 /** \brief L2 interface patch add / del response
1136 @param context - sender context, to match reply w/ request
1137 @param retval - return code for the request
1139 define l2_patch_add_del_reply {
1144 /** \brief IPv6 segment routing tunnel add / del request
1145 @param client_index - opaque cookie to identify the sender
1146 @param context - sender context, to match reply w/ request
1147 @param is_add - add the tunnel if non-zero, else delete it
1148 @param name[] - tunnel name (len. 64)
1149 @param src_address[] -
1150 @param dst_address[] -
1151 @param dst_mask_width -
1152 @param inner_vrf_id -
1153 @param outer_vrf_id -
1154 @param flags_net_byte_order -
1157 @param segs_and_tags[] -
1158 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1160 define sr_tunnel_add_del {
1170 u16 flags_net_byte_order;
1173 u8 segs_and_tags[0];
1177 /** \brief IPv6 segment routing tunnel add / del response
1178 @param context - sender context, to match reply w/ request
1179 @param retval - return value for request
1181 define sr_tunnel_add_del_reply {
1186 /** \brief IPv6 segment routing policy add / del request
1187 @param client_index - opaque cookie to identify the sender
1188 @param context - sender context, to match reply w/ request
1189 @param is_add - add the tunnel if non-zero, else delete it
1190 @param name[] - policy name (len. 64)
1191 @param tunnel_names[] -
1193 define sr_policy_add_del {
1201 /** \brief IPv6 segment routing policy add / del response
1202 @param context - sender context, to match reply w/ request
1203 @param retval - return value for request
1205 define sr_policy_add_del_reply {
1210 /** \brief IPv6 segment routing multicast map to policy add / del request
1211 @param client_index - opaque cookie to identify the sender
1212 @param context - sender context, to match reply w/ request
1213 @param is_add - add the tunnel if non-zero, else delete it
1214 @param multicast_address[] - IP6 multicast address
1215 @param policy_name[] = policy name (len.64)
1217 define sr_multicast_map_add_del {
1221 u8 multicast_address[16];
1225 /** \brief IPv6 segment routing multicast map to policy add / del response
1226 @param context - sender context, to match reply w/ request
1227 @param retval - return value for request
1229 define sr_multicast_map_add_del_reply {
1234 /** \brief Interface set vpath request
1235 @param client_index - opaque cookie to identify the sender
1236 @param context - sender context, to match reply w/ request
1237 @param sw_if_index - interface used to reach neighbor
1238 @param enable - if non-zero enable, else disable
1240 define sw_interface_set_vpath {
1247 /** \brief Interface set vpath response
1248 @param context - sender context, to match reply w/ request
1249 @param retval - return code for the request
1251 define sw_interface_set_vpath_reply {
1256 /** \brief MPLS Ethernet add / del tunnel request
1257 @param client_index - opaque cookie to identify the sender
1258 @param context - sender context, to match reply w/ request
1259 @param vrf_id - vrf_id, only for IP4
1260 @param sw_if_index - interface used to reach neighbor
1261 @param is_add - add if set, tunnel delete if 0
1262 @param dst_mac_address -
1263 @param adj_address -
1264 @param adj_address_length -
1266 define mpls_ethernet_add_del_tunnel {
1273 u8 dst_mac_address[6];
1275 u8 adj_address_length;
1278 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1279 @param context - sender context, to match reply w/ request
1280 @param retval - return code for the request
1282 define mpls_ethernet_add_del_tunnel_reply {
1285 u32 tunnel_sw_if_index;
1287 /** \brief MPLS Ethernet add/ del tunnel 2
1288 @param client_index - opaque cookie to identify the sender
1289 @param context - sender context, to match reply w/ request
1290 @param inner_vrf_id -
1291 @param outer_vrf_id -
1292 @param resolve_attempts -
1293 @param resolve_opaque -
1294 @param resolve_if_needed -
1296 @param adj_address -
1297 @param adj_address_length -
1298 @param next_hop_ip4_address_in_outer_vrf -
1300 define mpls_ethernet_add_del_tunnel_2 {
1305 u32 resolve_attempts;
1306 u32 resolve_opaque; /* no need to set this */
1307 u8 resolve_if_needed;
1311 u8 adj_address_length;
1312 u8 next_hop_ip4_address_in_outer_vrf [4];
1315 /** \brief MPLS Ethernet add/ del tunnel 2
1316 @param context - sender context, to match reply w/ request
1317 @param retval - return code for add /del request
1319 define mpls_ethernet_add_del_tunnel_2_reply {
1324 /** \brief Set L2 XConnect between two interfaces request
1325 @param client_index - opaque cookie to identify the sender
1326 @param context - sender context, to match reply w/ request
1327 @param rx_sw_if_index - Receive interface index
1328 @param tx_sw_if_index - Transmit interface index
1329 @param enable - enable xconnect if not 0, else set to L3 mode
1331 define sw_interface_set_l2_xconnect {
1339 /** \brief Set L2 XConnect response
1340 @param context - sender context, to match reply w/ request
1341 @param retval - L2 XConnect request return code
1343 define sw_interface_set_l2_xconnect_reply {
1348 /** \brief Interface bridge mode request
1349 @param client_index - opaque cookie to identify the sender
1350 @param context - sender context, to match reply w/ request
1351 @param rx_sw_if_index - the interface
1352 @param bd_id - bridge domain id
1353 @param bvi - Setup interface as a bvi, bridge mode only
1354 @param shg - Shared horizon group, for bridge mode only
1355 @param enable - Enable beige mode if not 0, else set to L3 mode
1357 define sw_interface_set_l2_bridge {
1367 /** \brief Interface bridge mode response
1368 @param context - sender context, to match reply w/ request
1369 @param retval - Bridge mode request return code
1371 define sw_interface_set_l2_bridge_reply {
1376 /** \brief L2 FIB add entry request
1377 @param client_index - opaque cookie to identify the sender
1378 @param context - sender context, to match reply w/ request
1379 @param mac - the entry's mac address
1380 @param bd_id - the entry's bridge domain id
1381 @param sw_if_index - the interface
1382 @param is_add - If non zero add the entry, else delete it
1386 define l2fib_add_del {
1397 /** \brief L2 FIB add entry response
1398 @param context - sender context, to match reply w/ request
1399 @param retval - return code for the add l2fib entry request
1401 define l2fib_add_del_reply {
1406 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1407 @param client_index - opaque cookie to identify the sender
1408 @param context - sender context, to match reply w/ request
1409 @param sw_if_index - interface
1410 @param is_set - if non-zero, set the bits, else clear them
1411 @param feature_bitmap - non-zero bits to set or clear
1421 /** \brief Set L2 bits response
1422 @param context - sender context, to match reply w/ request
1423 @param retval - return code for the set l2 bits request
1425 define l2_flags_reply {
1428 u32 resulting_feature_bitmap;
1431 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1432 L2_UU_FLOOD, or L2_ARP_TERM) request
1433 @param client_index - opaque cookie to identify the sender
1434 @param context - sender context, to match reply w/ request
1435 @param bd_id - the bridge domain to set the flags for
1436 @param is_set - if non-zero, set the flags, else clear them
1437 @param feature_bitmap - bits that are non-zero to set or clear
1439 define bridge_flags {
1447 /** \brief Set bridge flags response
1448 @param context - sender context, to match reply w/ request
1449 @param retval - return code for the set bridge flags request
1450 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1452 define bridge_flags_reply {
1455 u32 resulting_feature_bitmap;
1458 /** \brief Set bridge domain ip to mac entry request
1459 @param client_index - opaque cookie to identify the sender
1460 @param context - sender context, to match reply w/ request
1461 @param bd_id - the bridge domain to set the flags for
1462 @param is_add - if non-zero, add the entry, else clear it
1463 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1464 @param mac_address - MAC address
1467 define bd_ip_mac_add_del {
1477 /** \brief Set bridge domain ip to mac entry response
1478 @param context - sender context, to match reply w/ request
1479 @param retval - return code for the set bridge flags request
1481 define bd_ip_mac_add_del_reply {
1486 /** \brief Add/Delete classification table request
1487 @param client_index - opaque cookie to identify the sender
1488 @param context - sender context, to match reply w/ request
1489 @param is_add- if non-zero add the table, else delete it
1490 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1491 @param nbuckets - number of buckets when adding a table
1492 @param memory_size - memory size when adding a table
1493 @param match_n_vectors - number of match vectors
1494 @param next_table_index - index of next table
1495 @param miss_next_index - index of miss table
1496 @param mask[] - match mask
1498 define classify_add_del_table {
1506 u32 match_n_vectors;
1507 u32 next_table_index;
1508 u32 miss_next_index;
1512 /** \brief Add/Delete classification table response
1513 @param context - sender context, to match reply w/ request
1514 @param retval - return code for the table add/del requst
1515 @param new_table_index - for add, returned index of the new table
1516 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1517 @param match_n_vectors -for add, returned value of match_n_vectors in table
1519 define classify_add_del_table_reply {
1522 u32 new_table_index;
1524 u32 match_n_vectors;
1527 /** \brief Classify add / del session request
1528 @param client_index - opaque cookie to identify the sender
1529 @param context - sender context, to match reply w/ request
1530 @param is_add - add session if non-zero, else delete
1531 @param table_index - index of the table to add/del the session, required
1532 @param hit_next_index - for add, hit_next_index of new session, required
1533 @param opaque_index - for add, opaque_index of new session
1534 @param advance -for add, advance value for session
1535 @param match[] - for add, match value for session, required
1537 define classify_add_del_session {
1548 /** \brief Classify add / del session response
1549 @param context - sender context, to match reply w/ request
1550 @param retval - return code for the add/del session request
1552 define classify_add_del_session_reply {
1557 /** \brief Set/unset the classification table for an interface request
1558 @param client_index - opaque cookie to identify the sender
1559 @param context - sender context, to match reply w/ request
1560 @param is_ipv6 - ipv6 if non-zero, else ipv4
1561 @param sw_if_index - interface to associate with the table
1562 @param table_index - index of the table, if ~0 unset the table
1564 define classify_set_interface_ip_table {
1569 u32 table_index; /* ~0 => off */
1572 /** \brief Set/unset interface classification table response
1573 @param context - sender context, to match reply w/ request
1574 @param retval - return code
1576 define classify_set_interface_ip_table_reply {
1581 /** \brief Set/unset l2 classification tables for an interface request
1582 @param client_index - opaque cookie to identify the sender
1583 @param context - sender context, to match reply w/ request
1584 @param sw_if_index - interface to set/unset tables for
1585 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1586 @param ip6_table_index - ip6 index
1587 @param other_table_index - other index
1589 define classify_set_interface_l2_tables {
1594 u32 ip4_table_index;
1595 u32 ip6_table_index;
1596 u32 other_table_index;
1599 /** \brief Set/unset l2 classification tables for an interface response
1600 @param context - sender context, to match reply w/ request
1601 @param retval - return code for the request
1603 define classify_set_interface_l2_tables_reply {
1608 /** \brief Get node index using name request
1609 @param client_index - opaque cookie to identify the sender
1610 @param context - sender context, to match reply w/ request
1611 @param node_name[] - name of the node
1613 define get_node_index {
1619 /** \brief Get node index using name request
1620 @param context - sender context, to match reply w/ request
1621 @param retval - return code for the request
1622 @param node_index - index of the desired node if found, else ~0
1624 define get_node_index_reply {
1630 /** \brief Set the next node for a given node request
1631 @param client_index - opaque cookie to identify the sender
1632 @param context - sender context, to match reply w/ request
1633 @param node_name[] - node to add the next node to
1634 @param next_name[] - node to add as the next node
1636 define add_node_next {
1643 /** \brief IP Set the next node for a given node response
1644 @param context - sender context, to match reply w/ request
1645 @param retval - return code for the add next node request
1646 @param next_index - the index of the next node if success, else ~0
1648 define add_node_next_reply {
1654 /** \brief DHCP Proxy config 2 add / del request
1655 @param client_index - opaque cookie to identify the sender
1656 @param context - sender context, to match reply w/ request
1657 @param rx_vrf_id - receive vrf id
1658 @param server_vrf_id - server vrf id
1659 @param if_ipv6 - ipv6 if non-zero, else ipv4
1660 @param is_add - add the config if non-zero, else delete
1661 @param insert_circuit_id - option82 suboption 1 fib number
1662 @param dhcp_server[] - server address
1663 @param dhcp_src_address[] - <fix this, need details>
1665 define dhcp_proxy_config_2 {
1672 u8 insert_circuit_id;
1674 u8 dhcp_src_address[16];
1677 /** \brief DHCP Proxy config 2 add / del response
1678 @param context - sender context, to match reply w/ request
1679 @param retval - return code for request
1681 define dhcp_proxy_config_2_reply {
1686 /** \brief l2tpv3 tunnel interface create request
1687 @param client_index - opaque cookie to identify the sender
1688 @param context - sender context, to match reply w/ request
1689 @param client_address - remote client tunnel ip address
1690 @param client_address - local tunnel ip address
1691 @param is_ipv6 - ipv6 if non-zero, else ipv4
1692 @param local_session_id - local tunnel session id
1693 @param remote_session_id - remote tunnel session id
1694 @param local_cookie - local tunnel cookie
1695 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1697 define l2tpv3_create_tunnel {
1700 u8 client_address [16];
1701 u8 our_address [16];
1703 u32 local_session_id;
1704 u32 remote_session_id;
1707 u8 l2_sublayer_present;
1710 /** \brief l2tpv3 tunnel interface create response
1711 @param context - sender context, to match reply w/ request
1712 @param retval - return code for the request
1713 @param sw_if_index - index of the new tunnel interface
1715 define l2tpv3_create_tunnel_reply {
1721 define l2tpv3_set_tunnel_cookies {
1725 u64 new_local_cookie;
1726 u64 new_remote_cookie;
1729 /** \brief L2TP tunnel set cookies response
1730 @param context - sender context, to match reply w/ request
1731 @param retval - return code for the request
1733 define l2tpv3_set_tunnel_cookies_reply {
1738 manual_java define sw_if_l2tpv3_tunnel_details {
1741 u8 interface_name[64];
1742 u8 client_address [16];
1743 u8 our_address [16];
1744 u32 local_session_id;
1745 u32 remote_session_id;
1746 u64 local_cookie[2];
1748 u8 l2_sublayer_present;
1751 define sw_if_l2tpv3_tunnel_dump {
1756 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1757 @param client_index - opaque cookie to identify the sender
1758 @param context - sender context, to match reply w/ request
1760 define l2_fib_clear_table {
1765 /** \brief L2 fib clear table response
1766 @param context - sender context, to match reply w/ request
1767 @param retval - return code for the request
1769 define l2_fib_clear_table_reply {
1774 /** \brief L2 interface ethernet flow point filtering enable/disable request
1775 @param client_index - opaque cookie to identify the sender
1776 @param context - sender context, to match reply w/ request
1777 @param sw_if_index - interface to enable/disable filtering on
1778 @param enable_disable - if non-zero enable filtering, else disable
1780 define l2_interface_efp_filter {
1787 /** \brief L2 interface ethernet flow point filtering response
1788 @param context - sender context, to match reply w/ request
1789 @param retval - return code for the request
1791 define l2_interface_efp_filter_reply {
1796 define l2tpv3_interface_enable_disable {
1803 define l2tpv3_interface_enable_disable_reply {
1808 define l2tpv3_set_lookup_key {
1811 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1815 define l2tpv3_set_lookup_key_reply {
1820 define vxlan_add_del_tunnel {
1828 u32 decap_next_index;
1832 define vxlan_add_del_tunnel_reply {
1838 manual_java define vxlan_tunnel_dump {
1844 manual_java define vxlan_tunnel_details {
1850 u32 decap_next_index;
1855 define gre_add_del_tunnel {
1864 define gre_add_del_tunnel_reply {
1870 manual_java define gre_tunnel_dump {
1876 manual_java define gre_tunnel_details {
1884 /** \brief L2 interface vlan tag rewrite configure request
1885 @param client_index - opaque cookie to identify the sender
1886 @param context - sender context, to match reply w/ request
1887 @param sw_if_index - interface the operation is applied to
1888 @param vtr_op - Choose from l2_vtr_op_t enum values
1889 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1890 @param tag1 - Needed for any push or translate vtr op
1891 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1893 define l2_interface_vlan_tag_rewrite {
1898 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1899 u32 tag1; // first pushed tag
1900 u32 tag2; // second pushed tag
1903 /** \brief L2 interface vlan tag rewrite response
1904 @param context - sender context, to match reply w/ request
1905 @param retval - return code for the request
1907 define l2_interface_vlan_tag_rewrite_reply {
1912 /** \brief vhost-user interface create request
1913 @param client_index - opaque cookie to identify the sender
1914 @param is_server - our side is socket server
1915 @param sock_filename - unix socket filename, used to speak with frontend
1916 @param use_custom_mac - enable or disable the use of the provided hardware address
1917 @param mac_address - hardware address to use if 'use_custom_mac' is set
1919 define create_vhost_user_if {
1923 u8 sock_filename[256];
1925 u32 custom_dev_instance;
1930 /** \brief vhost-user interface create response
1931 @param context - sender context, to match reply w/ request
1932 @param retval - return code for the request
1933 @param sw_if_index - interface the operation is applied to
1935 define create_vhost_user_if_reply {
1941 /** \brief vhost-user interface modify request
1942 @param client_index - opaque cookie to identify the sender
1943 @param is_server - our side is socket server
1944 @param sock_filename - unix socket filename, used to speak with frontend
1946 define modify_vhost_user_if {
1951 u8 sock_filename[256];
1953 u32 custom_dev_instance;
1956 /** \brief vhost-user interface modify response
1957 @param context - sender context, to match reply w/ request
1958 @param retval - return code for the request
1960 define modify_vhost_user_if_reply {
1965 /** \brief vhost-user interface delete request
1966 @param client_index - opaque cookie to identify the sender
1968 define delete_vhost_user_if {
1974 /** \brief vhost-user interface delete response
1975 @param context - sender context, to match reply w/ request
1976 @param retval - return code for the request
1978 define delete_vhost_user_if_reply {
1983 define create_subif {
1989 /* These fields map directly onto the subif template */
1993 u8 dot1ad; // 0 = dot1q, 1=dot1ad
1996 u8 outer_vlan_id_any;
1997 u8 inner_vlan_id_any;
2002 define create_subif_reply {
2008 /** \brief show version
2009 @param client_index - opaque cookie to identify the sender
2010 @param context - sender context, to match reply w/ request
2012 define show_version {
2017 /** \brief show version response
2018 @param context - sender context, to match reply w/ request
2019 @param retval - return code for the request
2020 @param program - name of the program (vpe)
2021 @param version - version of the program
2022 @param build_directory - root of the workspace where the program was built
2024 manual_java define show_version_reply {
2030 u8 build_directory[256];
2033 define nsh_gre_add_del_tunnel {
2040 u32 decap_next_index;
2041 u8 tlv_len_in_words;
2047 /* in network byte order */
2056 define nsh_gre_add_del_tunnel_reply {
2062 /** \brief Vhost-user interface details structure (fix this)
2063 @param sw_if_index - index of the interface
2064 @param interface_name - name of interface
2065 @param virtio_net_hdr_sz - net header size
2066 @param features - interface features
2067 @param is_server - vhost-user server socket
2068 @param sock_filename - socket filename
2069 @param num_regions - number of used memory regions
2071 manual_java define sw_interface_vhost_user_details {
2074 u8 interface_name[64];
2075 u32 virtio_net_hdr_sz;
2078 u8 sock_filename[256];
2084 define sw_interface_vhost_user_dump {
2089 manual_java define ip_address_details {
2096 manual_java define ip_address_dump {
2103 manual_java define ip_details {
2114 /** \brief l2 fib table entry structure
2115 @param bd_id - the l2 fib / bridge domain table id
2116 @param mac - the entry's mac address
2117 @param sw_if_index - index of the interface
2118 @param static_mac - the entry is statically configured.
2119 @param filter_mac - the entry is a mac filter entry.
2120 @param bvi_mac - the mac address is a bridge virtual interface
2122 manual_java define l2_fib_table_entry {
2132 /** \brief Dump l2 fib (aka bridge domain) table
2133 @param client_index - opaque cookie to identify the sender
2134 @param bd_id - the l2 fib / bridge domain table identifier
2136 manual_java define l2_fib_table_dump {
2142 define nsh_vxlan_gpe_add_del_tunnel {
2149 u32 decap_next_index;
2151 u8 tlv_len_in_words;
2157 /* in network byte order */
2166 define nsh_vxlan_gpe_add_del_tunnel_reply {
2172 /** \brief add or delete locator_set
2173 @param client_index - opaque cookie to identify the sender
2174 @param context - sender context, to match reply w/ request
2175 @param is_add - add address if non-zero, else delete
2176 @param locator_set_name - locator name
2178 define lisp_add_del_locator_set {
2182 u8 locator_set_name[64];
2185 /** \brief Reply for locator_set add/del
2186 @param context - returned sender context, to match reply w/ request
2187 @param retval - return code
2189 define lisp_add_del_locator_set_reply {
2194 /** \brief add or delete locator for locator_set
2195 @param client_index - opaque cookie to identify the sender
2196 @param context - sender context, to match reply w/ request
2197 @param is_add - add address if non-zero, else delete
2198 @param locator_set_name - name of locator_set to add/del locator
2199 @param sw_if_index - index of the interface
2200 @param priority - priority of the lisp locator
2201 @param weight - weight of the lisp locator
2203 define lisp_add_del_locator {
2207 u8 locator_set_name[64];
2213 /** \brief Reply for locator add/del
2214 @param context - returned sender context, to match reply w/ request
2215 @param retval - return code
2217 define lisp_add_del_locator_reply {
2222 /** \brief add or delete lisp eid-table
2223 @param client_index - opaque cookie to identify the sender
2224 @param context - sender context, to match reply w/ request
2225 @param is_add - add address if non-zero, else delete
2226 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2227 @param ip_address - array of address bytes
2228 @param prefix_len - prefix len
2229 @param locator_set_name - name of locator_set to add/del eid-table
2231 define lisp_add_del_local_eid {
2238 u8 locator_set_name[64];
2241 /** \brief Reply for local_eid add/del
2242 @param context - returned sender context, to match reply w/ request
2243 @param retval - return code
2245 define lisp_add_del_local_eid_reply {
2250 /** \brief add or delete lisp gpe maptunel
2251 @param client_index - opaque cookie to identify the sender
2252 @param context - sender context, to match reply w/ request
2253 @param is_add - add address if non-zero, else delete
2254 @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2255 @param eid_ip_address - array of address bytes
2256 @param eid_prefix_len - prefix len
2257 @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2258 @param source_ip_address - array of address bytes
2259 @param destination_ip_address - array of address bytes
2261 define lisp_gpe_add_del_fwd_entry {
2266 u8 eid_ip_address[16];
2269 u8 source_ip_address[16];
2270 u8 destination_ip_address[16];
2273 /** \brief Reply for gpe_fwd_entry add/del
2274 @param context - returned sender context, to match reply w/ request
2275 @param retval - return code
2277 define lisp_gpe_add_del_fwd_entry_reply {
2282 /** \brief add or delete map-resolver
2283 @param client_index - opaque cookie to identify the sender
2284 @param context - sender context, to match reply w/ request
2285 @param is_add - add address if non-zero, else delete
2286 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2287 @param ip_address - array of address bytes
2289 define lisp_add_del_map_resolver {
2297 /** \brief Reply for map_resolver add/del
2298 @param context - returned sender context, to match reply w/ request
2299 @param retval - return code
2301 define lisp_add_del_map_resolver_reply {
2306 /** \brief enable or disable lisp-gpe protocol
2307 @param client_index - opaque cookie to identify the sender
2308 @param context - sender context, to match reply w/ request
2309 @param is_en - enable protocol if non-zero, else disable
2311 define lisp_gpe_enable_disable {
2317 /** \brief Reply for gpe enable/disable
2318 @param context - returned sender context, to match reply w/ request
2319 @param retval - return code
2321 define lisp_gpe_enable_disable_reply {
2326 /** \brief add or delete gpe_iface
2327 @param client_index - opaque cookie to identify the sender
2328 @param context - sender context, to match reply w/ request
2329 @param is_add - add address if non-zero, else delete
2331 define lisp_gpe_add_del_iface {
2339 /** \brief Reply for gpe_iface add/del
2340 @param context - returned sender context, to match reply w/ request
2341 @param retval - return code
2343 define lisp_gpe_add_del_iface_reply {
2348 /** \brief LISP locator_set status
2349 @param locator_set_name - name of the locator_set
2350 @param sw_if_index - sw_if_index of the locator
2351 @param priority - locator priority
2352 @param weight - locator weight
2354 manual_java define lisp_locator_set_details {
2356 u8 locator_set_name[64];
2362 /** \brief Request for locator_set summary status
2363 @param client_index - opaque cookie to identify the sender
2364 @param context - sender context, to match reply w/ request
2366 define lisp_locator_set_dump {
2371 /** \brief LISP local eid table status
2372 @param locator_set_name - name of the locator_set
2373 @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2374 @param eid_ip_address - array of address bytes
2375 @param eid_prefix_len - prefix len
2377 manual_java define lisp_local_eid_table_details {
2379 u8 locator_set_name[64];
2381 u8 eid_ip_address[16];
2385 /** \brief Request for local eid table summary status
2386 @param client_index - opaque cookie to identify the sender
2387 @param context - sender context, to match reply w/ request
2389 define lisp_local_eid_table_dump {
2394 manual_java define lisp_gpe_tunnel_details {
2399 u8 destination_ip[16];
2411 /** \brief Request for gpe tunnel summary status
2412 @param client_index - opaque cookie to identify the sender
2413 @param context - sender context, to match reply w/ request
2415 define lisp_gpe_tunnel_dump {
2420 /** \brief LISP map resolver status
2421 @param locator_set_name - name of the locator_set
2422 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2423 @param ip_address - array of address bytes
2425 manual_java define lisp_map_resolver_details {
2431 /** \brief Request for map resolver summary status
2432 @param client_index - opaque cookie to identify the sender
2433 @param context - sender context, to match reply w/ request
2435 define lisp_map_resolver_dump {
2440 /** \brief Status of lisp-gpe protocol, enable or disable
2441 @param context - sender context, to match reply w/ request
2442 @param is_en - enable protocol if non-zero, else disable
2444 manual_java define lisp_gpe_enable_disable_status_details {
2449 /** \brief Request for lisp-gpe protocol status
2450 @param client_index - opaque cookie to identify the sender
2451 @param context - sender context, to match reply w/ request
2453 define lisp_gpe_enable_disable_status_dump {
2458 /* Gross kludge, DGMS */
2459 define interface_name_renumber {
2463 u32 new_show_dev_instance;
2466 define interface_name_renumber_reply {
2471 /** \brief Register for ip4 arp resolution events
2472 @param client_index - opaque cookie to identify the sender
2473 @param context - sender context, to match reply w/ request
2474 @param enable_disable - 1 => register for events, 0 => cancel registration
2475 @param pid - sender's pid
2476 @param address - the exact ip4 address of interest
2478 define want_ip4_arp_events {
2486 /** \brief Reply for interface events registration
2487 @param context - returned sender context, to match reply w/ request
2488 @param retval - return code
2490 define want_ip4_arp_events_reply {
2495 /** \brief Tell client about an ip4 arp resolution event
2496 @param client_index - opaque cookie to identify the sender
2497 @param context - sender context, to match reply w/ request
2498 @param address - the exact ip4 address of interest
2499 @param pid - client pid registered to receive notification
2500 @param sw_if_index - interface which received ARP packet
2501 @param new_mac - the new mac address
2503 define ip4_arp_event {
2512 /** \brief L2 bridge domain add or delete request
2513 @param client_index - opaque cookie to identify the sender
2514 @param context - sender context, to match reply w/ request
2515 @param bd_id - the bridge domain to create
2516 @param flood - enable/disable bcast/mcast flooding in the bd
2517 @param uu_flood - enable/disable uknown unicast flood in the bd
2518 @param forward - enable/disable forwarding on all interfaces in the bd
2519 @param learn - enable/disable learning on all interfaces in the bd
2520 @param arp_term - enable/disable arp termination in the bd
2521 @param is_add - add or delete flag
2523 define bridge_domain_add_del {
2535 /** \brief L2 bridge domain add or delete response
2536 @param context - sender context, to match reply w/ request
2537 @param retval - return code for the set bridge flags request
2539 define bridge_domain_add_del_reply {
2544 /** \brief L2 bridge domain request operational state details
2545 @param client_index - opaque cookie to identify the sender
2546 @param context - sender context, to match reply w/ request
2547 @param bd_id - the bridge domain id desired or ~0 to request all bds
2549 manual_java define bridge_domain_dump {
2555 /** \brief L2 bridge domain operational state response
2556 @param bd_id - the bridge domain id
2557 @param flood - bcast/mcast flooding state on all interfaces in the bd
2558 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2559 @param forward - forwarding state on all interfaces in the bd
2560 @param learn - learning state on all interfaces in the bd
2561 @param arp_term - arp termination state on all interfaces in the bd
2562 @param n_sw_ifs - number of sw_if_index's in the domain
2564 manual_java define bridge_domain_details {
2572 u32 bvi_sw_if_index;
2576 /** \brief L2 bridge domain sw interface operational state response
2577 @param bd_id - the bridge domain id
2578 @param sw_if_index - sw_if_index in the domain
2579 @param shg - split horizon group for the interface
2581 manual_java define bridge_domain_sw_if_details {
2588 /** \brief DHCP Client config add / del request
2589 @param client_index - opaque cookie to identify the sender
2590 @param context - sender context, to match reply w/ request
2591 @param sw_if_index - index of the interface for DHCP client
2592 @param hostname - hostname
2593 @param is_add - add the config if non-zero, else delete
2594 @param want_dhcp_event - DHCP event sent to the sender
2595 via dhcp_compl_event API message if non-zero
2596 @param pid - sender's pid
2598 define dhcp_client_config {
2608 /** \brief DHCP Client config response
2609 @param context - sender context, to match reply w/ request
2610 @param retval - return code for the request
2612 define dhcp_client_config_reply {
2617 /** \brief Set/unset input ACL interface
2618 @param client_index - opaque cookie to identify the sender
2619 @param context - sender context, to match reply w/ request
2620 @param sw_if_index - interface to set/unset input ACL
2621 @param ip4_table_index - ip4 classify table index (~0 for skip)
2622 @param ip6_table_index - ip6 classify table index (~0 for skip)
2623 @param l2_table_index - l2 classify table index (~0 for skip)
2624 @param is_add - Set input ACL if non-zero, else unset
2625 Note: User is recommeneded to use just one valid table_index per call.
2626 (ip4_table_index, ip6_table_index, or l2_table_index)
2628 define input_acl_set_interface {
2632 u32 ip4_table_index;
2633 u32 ip6_table_index;
2638 /** \brief Set/unset input ACL interface response
2639 @param context - sender context, to match reply w/ request
2640 @param retval - return code for the request
2642 define input_acl_set_interface_reply {
2647 /** \brief IPsec: Add/delete Security Policy Database
2648 @param client_index - opaque cookie to identify the sender
2649 @param context - sender context, to match reply w/ request
2650 @param is_add - add SPD if non-zero, else delete
2651 @param spd_id - SPD instance id (control plane allocated)
2654 define ipsec_spd_add_del {
2661 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2662 @param context - returned sender context, to match reply w/ request
2663 @param retval - return code
2666 define ipsec_spd_add_del_reply {
2671 /** \brief IPsec: Add/delete SPD from interface
2673 @param client_index - opaque cookie to identify the sender
2674 @param context - sender context, to match reply w/ request
2675 @param is_add - add security mode if non-zero, else delete
2676 @param sw_if_index - index of the interface
2677 @param spd_id - SPD instance id to use for lookups
2681 define ipsec_interface_add_del_spd {
2690 /** \brief Reply for IPsec: Add/delete SPD from interface
2691 @param context - returned sender context, to match reply w/ request
2692 @param retval - return code
2695 define ipsec_interface_add_del_spd_reply {
2700 /** \brief IPsec: Add/delete Security Policy Database entry
2702 See RFC 4301, 4.4.1.1 on how to match packet to selectors
2704 @param client_index - opaque cookie to identify the sender
2705 @param context - sender context, to match reply w/ request
2706 @param is_add - add SPD if non-zero, else delete
2707 @param spd_id - SPD instance id (control plane allocated)
2708 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
2709 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2710 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2711 @param remote_address_start - start of remote address range to match
2712 @param remote_address_stop - end of remote address range to match
2713 @param local_address_start - start of local address range to match
2714 @param local_address_stop - end of local address range to match
2715 @param protocol - protocol type to match [0 means any]
2716 @param remote_port_start - start of remote port range to match ...
2717 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2718 @param local_port_start - start of local port range to match ...
2719 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2720 @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)
2721 @param sa_id - SAD instance id (control plane allocated)
2725 define ipsec_spd_add_del_entry {
2737 u8 remote_address_start[16];
2738 u8 remote_address_stop[16];
2739 u8 local_address_start[16];
2740 u8 local_address_stop[16];
2744 u16 remote_port_start;
2745 u16 remote_port_stop;
2746 u16 local_port_start;
2747 u16 local_port_stop;
2754 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2755 @param context - returned sender context, to match reply w/ request
2756 @param retval - return code
2759 define ipsec_spd_add_del_entry_reply {
2764 /** \brief IPsec: Add/delete Security Association Database entry
2765 @param client_index - opaque cookie to identify the sender
2766 @param context - sender context, to match reply w/ request
2767 @param is_add - add SAD entry if non-zero, else delete
2769 @param sad_id - sad id
2771 @param spi - security parameter index
2773 @param protocol - 0 = AH, 1 = ESP
2775 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
2776 @param crypto_key_length - length of crypto_key in bytes
2777 @param crypto_key - crypto keying material
2779 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
2780 @param integrity_key_length - length of integrity_key in bytes
2781 @param integrity_key - integrity keying material
2783 @param use_extended_sequence_number - use ESN when non-zero
2785 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
2786 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
2787 @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
2788 @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
2792 IPsec tunnel address copy mode (to support GDOI)
2795 define ipsec_sad_add_del_entry {
2806 u8 crypto_algorithm;
2807 u8 crypto_key_length;
2810 u8 integrity_algorithm;
2811 u8 integrity_key_length;
2812 u8 integrity_key[128];
2814 u8 use_extended_sequence_number;
2818 u8 tunnel_src_address[16];
2819 u8 tunnel_dst_address[16];
2822 /** \brief Reply for IPsec: Add/delete Security Association Database entry
2823 @param context - returned sender context, to match reply w/ request
2824 @param retval - return code
2827 define ipsec_sad_add_del_entry_reply {
2832 /** \brief IPsec: Update Security Association keys
2833 @param client_index - opaque cookie to identify the sender
2834 @param context - sender context, to match reply w/ request
2836 @param sa_id - sa id
2838 @param crypto_key_length - length of crypto_key in bytes
2839 @param crypto_key - crypto keying material
2841 @param integrity_key_length - length of integrity_key in bytes
2842 @param integrity_key - integrity keying material
2845 define ipsec_sa_set_key {
2851 u8 crypto_key_length;
2854 u8 integrity_key_length;
2855 u8 integrity_key[128];
2858 /** \brief Reply for IPsec: Update Security Association keys
2859 @param context - returned sender context, to match reply w/ request
2860 @param retval - return code
2863 define ipsec_sa_set_key_reply {
2868 /** \brief IKEv2: Add/delete profile
2869 @param client_index - opaque cookie to identify the sender
2870 @param context - sender context, to match reply w/ request
2872 @param name - IKEv2 profile name
2873 @param is_add - Add IKEv2 profile if non-zero, else delete
2875 define ikev2_profile_add_del {
2883 /** \brief Reply for IKEv2: Add/delete profile
2884 @param context - returned sender context, to match reply w/ request
2885 @param retval - return code
2887 define ikev2_profile_add_del_reply {
2892 /** \brief IKEv2: Set IKEv2 profile authentication method
2893 @param client_index - opaque cookie to identify the sender
2894 @param context - sender context, to match reply w/ request
2896 @param name - IKEv2 profile name
2897 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
2898 @param is_hex - Authentication data in hex format if non-zero, else string
2899 @param data_len - Authentication data length
2900 @param data - Authentication data (for rsa-sig cert file path)
2902 define ikev2_profile_set_auth {
2913 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
2914 @param context - returned sender context, to match reply w/ request
2915 @param retval - return code
2917 define ikev2_profile_set_auth_reply {
2922 /** \brief IKEv2: Set IKEv2 profile local/remote identification
2923 @param client_index - opaque cookie to identify the sender
2924 @param context - sender context, to match reply w/ request
2926 @param name - IKEv2 profile name
2927 @param is_local - Identification is local if non-zero, else remote
2928 @param id_type - Identification type
2929 @param data_len - Identification data length
2930 @param data - Identification data
2932 define ikev2_profile_set_id {
2943 /** \brief Reply for IKEv2:
2944 @param context - returned sender context, to match reply w/ request
2945 @param retval - return code
2947 define ikev2_profile_set_id_reply {
2952 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
2953 @param client_index - opaque cookie to identify the sender
2954 @param context - sender context, to match reply w/ request
2956 @param name - IKEv2 profile name
2957 @param is_local - Traffic selector is local if non-zero, else remote
2958 @param proto - Traffic selector IP protocol (if zero not relevant)
2959 @param start_port - The smallest port number allowed by traffic selector
2960 @param end_port - The largest port number allowed by traffic selector
2961 @param start_addr - The smallest address included in traffic selector
2962 @param end_addr - The largest address included in traffic selector
2964 define ikev2_profile_set_ts {
2977 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
2978 @param context - returned sender context, to match reply w/ request
2979 @param retval - return code
2981 define ikev2_profile_set_ts_reply {
2986 /** \brief IKEv2: Set IKEv2 local RSA private key
2987 @param client_index - opaque cookie to identify the sender
2988 @param context - sender context, to match reply w/ request
2990 @param key_file - Key file absolute path
2992 define ikev2_set_local_key {
2999 /** \brief Reply for IKEv2: Set IKEv2 local key
3000 @param context - returned sender context, to match reply w/ request
3001 @param retval - return code
3003 define ikev2_set_local_key_reply {
3008 /** \brief Tell client about a DHCP completion event
3009 @param client_index - opaque cookie to identify the sender
3010 @param pid - client pid registered to receive notification
3011 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3012 @param host_address - Host IP address
3013 @param router_address - Router IP address
3014 @param host_mac - Host MAC address
3016 manual_java define dhcp_compl_event {
3021 u8 host_address[16];
3022 u8 router_address[16];
3026 /** \brief Add MAP domains
3027 @param client_index - opaque cookie to identify the sender
3028 @param context - sender context, to match reply w/ request
3029 @param ip6_prefix - Rule IPv6 prefix
3030 @param ip4_prefix - Rule IPv4 prefix
3031 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3032 @param ip6_prefix_len - Rule IPv6 prefix length
3033 @param ip4_prefix_len - Rule IPv4 prefix length
3034 @param ea_bits_len - Embedded Address bits length
3035 @param psid_offset - Port Set Identifider (PSID) offset
3036 @param psid_length - PSID length
3037 @param is_translation - MAP-E / MAP-T
3040 define map_add_domain {
3048 u8 ip6_src_prefix_len;
3056 /** \brief Reply for MAP domain add
3057 @param context - returned sender context, to match reply w/ request
3058 @param index - MAP domain index
3059 @param retval - return code
3061 define map_add_domain_reply {
3067 /** \brief Delete MAP domain
3068 @param client_index - opaque cookie to identify the sender
3069 @param context - sender context, to match reply w/ request
3070 @param index - MAP Domain index
3072 define map_del_domain {
3078 /** \brief Reply for MAP domain del
3079 @param context - returned sender context, to match reply w/ request
3080 @param retval - return code
3082 define map_del_domain_reply {
3087 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3088 @param client_index - opaque cookie to identify the sender
3089 @param context - sender context, to match reply w/ request
3090 @param index - MAP Domain index
3091 @param is_add - If 1 add rule, if 0 delete rule
3092 @param ip6_dst - MAP CE IPv6 address
3093 @param psid - Rule PSID
3095 define map_add_del_rule {
3104 /** \brief Reply for MAP rule add/del
3105 @param context - returned sender context, to match reply w/ request
3106 @param retval - return code
3108 define map_add_del_rule_reply {
3113 /** \brief Get list of map domains
3114 @param client_index - opaque cookie to identify the sender
3116 define map_domain_dump {
3121 manual_java define map_domain_details {
3138 define map_rule_dump {
3144 manual_java define map_rule_details {
3150 /** \brief Request for a single block of summary stats
3151 @param client_index - opaque cookie to identify the sender
3152 @param context - sender context, to match reply w/ request
3154 define map_summary_stats {
3159 /** \brief Reply for map_summary_stats request
3160 @param context - sender context, to match reply w/ request
3161 @param retval - return code for request
3162 @param total_bindings -
3164 @param total_ip4_fragments -
3165 @param total_security_check -
3167 define map_summary_stats_reply {
3173 u64 total_ip4_fragments;
3174 u64 total_security_check[2];
3177 /** \brief cop: enable/disable junk filtration features on an interface
3178 @param client_index - opaque cookie to identify the sender
3179 @param context - sender context, to match reply w/ request
3180 @param sw_if_inded - desired interface
3181 @param enable_disable - 1 => enable, 0 => disable
3184 define cop_interface_enable_disable {
3191 /** \brief cop: interface enable/disable junk filtration reply
3192 @param context - returned sender context, to match reply w/ request
3193 @param retval - return code
3196 define cop_interface_enable_disable_reply {
3201 /** \brief cop: enable/disable whitelist filtration features on an interface
3202 Note: the supplied fib_id must match in order to remove the feature!
3204 @param client_index - opaque cookie to identify the sender
3205 @param context - sender context, to match reply w/ request
3206 @param sw_if_index - interface handle, physical interfaces only
3207 @param fib_id - fib identifier for the whitelist / blacklist fib
3208 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3209 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3210 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3213 define cop_whitelist_enable_disable {
3223 /** \brief cop: interface enable/disable junk filtration reply
3224 @param context - returned sender context, to match reply w/ request
3225 @param retval - return code
3228 define cop_whitelist_enable_disable_reply {
3233 /** \brief get_node_graph - get a copy of the vpp node graph
3234 including the current set of graph arcs.
3236 @param client_index - opaque cookie to identify the sender
3237 @param context - sender context, to match reply w/ request
3240 define get_node_graph {
3245 /** \brief get_node_graph_reply
3246 @param context - returned sender context, to match reply w/ request
3247 @param retval - return code
3248 @param reply_in_shmem - result from vlib_node_serialize, in shared
3249 memory. Process with vlib_node_unserialize, remember to switch
3250 heaps and free the result.
3253 define get_node_graph_reply {
3259 /** \brief Clear interface statistics
3260 @param client_index - opaque cookie to identify the sender
3261 @param context - sender context, to match reply w/ request
3262 @param sw_if_index - index of the interface to clear statistics
3264 define sw_interface_clear_stats {
3270 /** \brief Reply to sw_interface_clear_stats
3271 @param context - sender context which was passed in the request
3272 @param retval - return code of the set flags request
3274 define sw_interface_clear_stats_reply {
3279 /** \brief IOAM Trace : Set TRACE profile
3280 @param id - profile id
3281 @param trace_type - Trace type
3282 @param trace_num_elt - Number of nodes in trace path
3283 @param trace_ppc - Trace PPC (none/encap/decap)
3284 @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3285 @param trace_app_data - Trace application data, can be any 4 bytes
3286 @param pow_enable - Proof of Work enabled or not flag
3287 @param node_id - Id of this node
3289 define trace_profile_add {
3302 /** \brief Trace profile add / del response
3303 @param context - sender context, to match reply w/ request
3304 @param retval - return value for request
3306 define trace_profile_add_reply {
3311 /** \brief IOAM Trace enable trace profile for a flow
3312 @param id - id of the trace profile to be applied
3313 @param dest_ipv6 - Destination IPv6 address
3314 @param prefix_length - prefix mask
3315 @param vrf_id - VRF ID
3316 @param trace_op - Trace operation (add/mod/del)
3317 @param enable - apply/remove the trace profile for the flow
3319 define trace_profile_apply {
3330 /** \brief Trace profile apply response
3331 @param context - sender context, to match reply w/ request
3332 @param retval - return value for request
3334 define trace_profile_apply_reply {
3339 /** \brief Delete Trace Profile
3340 @param client_index - opaque cookie to identify the sender
3341 @param context - sender context, to match reply w/ request
3342 @param index - MAP Domain index
3344 define trace_profile_del {
3350 /** \brief Trace profile add / del response
3351 @param context - sender context, to match reply w/ request
3352 @param retval - return value for request
3354 define trace_profile_del_reply {
3359 /** \brief Create host-interface
3360 @param client_index - opaque cookie to identify the sender
3361 @param context - sender context, to match reply w/ request
3362 @param host_if_name - interface name
3363 @param hw_addr - interface MAC
3364 @param use_random_hw_addr - use random generated MAC
3366 define af_packet_create {
3370 u8 host_if_name[64];
3372 u8 use_random_hw_addr;
3375 /** \brief Create host-interface response
3376 @param context - sender context, to match reply w/ request
3377 @param retval - return value for request
3379 define af_packet_create_reply {
3384 /** \brief Delete host-interface
3385 @param client_index - opaque cookie to identify the sender
3386 @param context - sender context, to match reply w/ request
3387 @param host_if_name - interface name
3389 define af_packet_delete {
3393 u8 host_if_name[64];
3396 /** \brief Delete host-interface response
3397 @param context - sender context, to match reply w/ request
3398 @param retval - return value for request
3400 define af_packet_delete_reply {