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 {
823 * These messages bounce off the dataplane and are not otherwise
824 * interpreted; each has its own publish / subscribe API.
825 * If the dataplane receives one of these and doesn't have an
826 * active subscription for it, the message will be silently freed.
829 define from_netconf_server {
835 define want_from_netconf_server {
842 define want_from_netconf_server_reply {
847 define to_netconf_server {
853 define want_to_netconf_server {
860 define want_to_netconf_server_reply {
865 define from_netconf_client {
871 define want_from_netconf_client {
878 define want_from_netconf_client_reply {
883 define to_netconf_client {
889 define want_to_netconf_client {
896 define want_to_netconf_client_reply {
901 /** \brief Set the ip flow hash config for a fib request
902 @param client_index - opaque cookie to identify the sender
903 @param context - sender context, to match reply w/ request
904 @param vrf_id - vrf/fib id
905 @param is_ipv6 - if non-zero the fib is ip6, else ip4
906 @param src - if non-zero include src in flow hash
907 @param dst - if non-zero include dst in flow hash
908 @param sport - if non-zero include sport in flow hash
909 @param dport - if non-zero include dport in flow hash
910 @param proto -if non-zero include proto in flow hash
911 @param reverse - if non-zero include reverse in flow hash
913 define set_ip_flow_hash {
926 /** \brief Set the ip flow hash config for a fib response
927 @param context - sender context, to match reply w/ request
928 @param retval - return code for the request
930 define set_ip_flow_hash_reply {
935 /** \brief IPv6 router advertisement config request
936 @param client_index - opaque cookie to identify the sender
937 @param context - sender context, to match reply w/ request
942 @param send_unicast -
945 @param default_router -
946 @param max_interval -
947 @param min_interval -
949 @param initial_count -
950 @param initial_interval -
952 define sw_interface_ip6nd_ra_config {
968 u32 initial_interval;
971 /** \brief IPv6 router advertisement config response
972 @param context - sender context, to match reply w/ request
973 @param retval - return code for the request
975 define sw_interface_ip6nd_ra_config_reply {
980 /** \brief IPv6 router advertisement prefix config request
981 @param client_index - opaque cookie to identify the sender
982 @param context - sender context, to match reply w/ request
985 @param address_length -
987 @param no_advertise -
989 @param no_autoconfig -
992 @param val_lifetime -
993 @param pref_lifetime -
995 define sw_interface_ip6nd_ra_prefix {
1011 /** \brief IPv6 router advertisement prefix config response
1012 @param context - sender context, to match reply w/ request
1013 @param retval - return code for the request
1015 define sw_interface_ip6nd_ra_prefix_reply {
1020 /** \brief IPv6 interface enable / disable request
1021 @param client_index - opaque cookie to identify the sender
1022 @param context - sender context, to match reply w/ request
1023 @param sw_if_index - interface used to reach neighbor
1024 @param enable - if non-zero enable ip6 on interface, else disable
1026 define sw_interface_ip6_enable_disable {
1030 u8 enable; /* set to true if enable*/
1033 /** \brief IPv6 interface enable / disable response
1034 @param context - sender context, to match reply w/ request
1035 @param retval - return code for the request
1037 define sw_interface_ip6_enable_disable_reply {
1042 /** \brief IPv6 set link local address on interface request
1043 @param client_index - opaque cookie to identify the sender
1044 @param context - sender context, to match reply w/ request
1045 @param sw_if_index - interface to set link local on
1046 @param address[] - the new link local address
1047 @param address_length - link local address length
1049 define sw_interface_ip6_set_link_local_address {
1057 /** \brief IPv6 set link local address on interface response
1058 @param context - sender context, to match reply w/ request
1059 @param retval - error code for the request
1061 define sw_interface_ip6_set_link_local_address_reply {
1066 /** \brief Set unnumbered interface add / del request
1067 @param client_index - opaque cookie to identify the sender
1068 @param context - sender context, to match reply w/ request
1069 @param sw_if_index - interface with an IP address
1070 @param unnumbered_sw_if_index - interface which will use the address
1071 @param is_add - if non-zero set the association, else unset it
1073 define sw_interface_set_unnumbered {
1076 u32 sw_if_index; /* use this intfc address */
1077 u32 unnumbered_sw_if_index; /* on this interface */
1081 /** \brief Set unnumbered interface add / del response
1082 @param context - sender context, to match reply w/ request
1083 @param retval - return code for the request
1085 define sw_interface_set_unnumbered_reply {
1090 /** \brief Create loopback interface request
1091 @param client_index - opaque cookie to identify the sender
1092 @param context - sender context, to match reply w/ request
1093 @param mac_address - mac addr to assign to the interface if none-zero
1095 define create_loopback {
1101 /** \brief Create loopback interface response
1102 @param context - sender context, to match reply w/ request
1103 @param sw_if_index - sw index of the interface that was created
1104 @param retval - return code for the request
1106 define create_loopback_reply {
1112 /** \brief Delete loopback interface request
1113 @param client_index - opaque cookie to identify the sender
1114 @param context - sender context, to match reply w/ request
1115 @param sw_if_index - sw index of the interface that was created
1117 define delete_loopback {
1123 /** \brief Delete loopback interface response
1124 @param context - sender context, to match reply w/ request
1125 @param retval - return code for the request
1127 define delete_loopback_reply {
1132 /** \brief Control ping from client to api server request
1133 @param client_index - opaque cookie to identify the sender
1134 @param context - sender context, to match reply w/ request
1136 manual_java define control_ping {
1141 /** \brief Control ping from the client to the server response
1142 @param client_index - opaque cookie to identify the sender
1143 @param context - sender context, to match reply w/ request
1144 @param retval - return code for the request
1145 @param vpe_pid - the pid of the vpe, returned by the server
1147 manual_java define control_ping_reply {
1154 /** \brief Process a vpe parser cli string request
1155 @param client_index - opaque cookie to identify the sender
1156 @param context - sender context, to match reply w/ request
1157 @param cmd_in_shmem - pointer to cli command string
1159 define cli_request {
1165 /** \brief vpe parser cli string response
1166 @param context - sender context, to match reply w/ request
1167 @param retval - return code for request
1168 @param reply_in_shmem - Reply string from cli processing if any
1176 /** \brief Set max allowed ARP or ip6 neighbor entries request
1177 @param client_index - opaque cookie to identify the sender
1178 @param context - sender context, to match reply w/ request
1179 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1180 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1182 define set_arp_neighbor_limit {
1186 u32 arp_neighbor_limit;
1189 /** \brief Set max allowed ARP or ip6 neighbor entries response
1190 @param context - sender context, to match reply w/ request
1191 @param retval - return code for request
1193 define set_arp_neighbor_limit_reply {
1198 /** \brief L2 interface patch add / del request
1199 @param client_index - opaque cookie to identify the sender
1200 @param context - sender context, to match reply w/ request
1201 @param rx_sw_if_index - receive side interface
1202 @param tx_sw_if_index - transmit side interface
1203 @param is_add - if non-zero set up the interface patch, else remove it
1205 define l2_patch_add_del {
1213 /** \brief L2 interface patch add / del response
1214 @param context - sender context, to match reply w/ request
1215 @param retval - return code for the request
1217 define l2_patch_add_del_reply {
1222 /** \brief IPv6 segment routing tunnel add / del request
1223 @param client_index - opaque cookie to identify the sender
1224 @param context - sender context, to match reply w/ request
1225 @param is_add - add the tunnel if non-zero, else delete it
1226 @param src_address[] -
1227 @param dst_address[] -
1228 @param dst_mask_width -
1229 @param inner_vrf_id -
1230 @param outer_vrf_id -
1231 @param flags_net_byte_order -
1234 @param segs_and_tags[] -
1236 define sr_tunnel_add_del {
1245 u16 flags_net_byte_order;
1248 u8 segs_and_tags[0];
1251 /** \brief IPv6 segment routing tunnel add / del response
1252 @param context - sender context, to match reply w/ request
1253 @param retval - return value for request
1255 define sr_tunnel_add_del_reply {
1260 /** \brief Interface set vpath request
1261 @param client_index - opaque cookie to identify the sender
1262 @param context - sender context, to match reply w/ request
1263 @param sw_if_index - interface used to reach neighbor
1264 @param enable - if non-zero enable, else disable
1266 define sw_interface_set_vpath {
1273 /** \brief Interface set vpath response
1274 @param context - sender context, to match reply w/ request
1275 @param retval - return code for the request
1277 define sw_interface_set_vpath_reply {
1282 /** \brief MPLS Ethernet add / del tunnel request
1283 @param client_index - opaque cookie to identify the sender
1284 @param context - sender context, to match reply w/ request
1285 @param vrf_id - vrf_id, only for IP4
1286 @param sw_if_index - interface used to reach neighbor
1287 @param is_add - add if set, tunnel delete if 0
1288 @param dst_mac_address -
1289 @param adj_address -
1290 @param adj_address_length -
1292 define mpls_ethernet_add_del_tunnel {
1299 u8 dst_mac_address[6];
1301 u8 adj_address_length;
1304 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1305 @param context - sender context, to match reply w/ request
1306 @param retval - return code for the request
1308 define mpls_ethernet_add_del_tunnel_reply {
1311 u32 tunnel_sw_if_index;
1313 /** \brief MPLS Ethernet add/ del tunnel 2
1314 @param client_index - opaque cookie to identify the sender
1315 @param context - sender context, to match reply w/ request
1316 @param inner_vrf_id -
1317 @param outer_vrf_id -
1318 @param resolve_attempts -
1319 @param resolve_opaque -
1320 @param resolve_if_needed -
1322 @param adj_address -
1323 @param adj_address_length -
1324 @param next_hop_ip4_address_in_outer_vrf -
1326 define mpls_ethernet_add_del_tunnel_2 {
1331 u32 resolve_attempts;
1332 u32 resolve_opaque; /* no need to set this */
1333 u8 resolve_if_needed;
1337 u8 adj_address_length;
1338 u8 next_hop_ip4_address_in_outer_vrf [4];
1341 /** \brief MPLS Ethernet add/ del tunnel 2
1342 @param context - sender context, to match reply w/ request
1343 @param retval - return code for add /del request
1345 define mpls_ethernet_add_del_tunnel_2_reply {
1350 /** \brief Set L2 XConnect between two interfaces request
1351 @param client_index - opaque cookie to identify the sender
1352 @param context - sender context, to match reply w/ request
1353 @param rx_sw_if_index - Receive interface index
1354 @param tx_sw_if_index - Transmit interface index
1355 @param enable - enable xconnect if not 0, else set to L3 mode
1357 define sw_interface_set_l2_xconnect {
1365 /** \brief Set L2 XConnect response
1366 @param context - sender context, to match reply w/ request
1367 @param retval - L2 XConnect request return code
1369 define sw_interface_set_l2_xconnect_reply {
1374 /** \brief Interface bridge mode request
1375 @param client_index - opaque cookie to identify the sender
1376 @param context - sender context, to match reply w/ request
1377 @param rx_sw_if_index - the interface
1378 @param bd_id - bridge domain id
1379 @param bvi - Setup interface as a bvi, bridge mode only
1380 @param shg - Shared horizon group, for bridge mode only
1381 @param enable - Enable beige mode if not 0, else set to L3 mode
1383 define sw_interface_set_l2_bridge {
1393 /** \brief Interface bridge mode response
1394 @param context - sender context, to match reply w/ request
1395 @param retval - Bridge mode request return code
1397 define sw_interface_set_l2_bridge_reply {
1402 /** \brief L2 FIB add entry request
1403 @param client_index - opaque cookie to identify the sender
1404 @param context - sender context, to match reply w/ request
1405 @param mac - the entry's mac address
1406 @param bd_id - the entry's bridge domain id
1407 @param sw_if_index - the interface
1408 @param is_add - If non zero add the entry, else delete it
1412 define l2fib_add_del {
1423 /** \brief L2 FIB add entry response
1424 @param context - sender context, to match reply w/ request
1425 @param retval - return code for the add l2fib entry request
1427 define l2fib_add_del_reply {
1432 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1433 @param client_index - opaque cookie to identify the sender
1434 @param context - sender context, to match reply w/ request
1435 @param sw_if_index - interface
1436 @param is_set - if non-zero, set the bits, else clear them
1437 @param feature_bitmap - non-zero bits to set or clear
1447 /** \brief Set L2 bits response
1448 @param context - sender context, to match reply w/ request
1449 @param retval - return code for the set l2 bits request
1451 define l2_flags_reply {
1454 u32 resulting_feature_bitmap;
1457 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1458 L2_UU_FLOOD, or L2_ARP_TERM) 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_set - if non-zero, set the flags, else clear them
1463 @param feature_bitmap - bits that are non-zero to set or clear
1465 define bridge_flags {
1473 /** \brief Set bridge flags response
1474 @param context - sender context, to match reply w/ request
1475 @param retval - return code for the set bridge flags request
1476 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1478 define bridge_flags_reply {
1481 u32 resulting_feature_bitmap;
1484 /** \brief Set bridge domain ip to mac entry request
1485 @param client_index - opaque cookie to identify the sender
1486 @param context - sender context, to match reply w/ request
1487 @param bd_id - the bridge domain to set the flags for
1488 @param is_add - if non-zero, add the entry, else clear it
1489 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1490 @param mac_address - MAC address
1493 define bd_ip_mac_add_del {
1503 /** \brief Set bridge domain ip to mac entry response
1504 @param context - sender context, to match reply w/ request
1505 @param retval - return code for the set bridge flags request
1507 define bd_ip_mac_add_del_reply {
1512 /** \brief Add/Delete classification table request
1513 @param client_index - opaque cookie to identify the sender
1514 @param context - sender context, to match reply w/ request
1515 @param is_add- if non-zero add the table, else delete it
1516 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1517 @param nbuckets - number of buckets when adding a table
1518 @param memory_size - memory size when adding a table
1519 @param match_n_vectors - number of match vectors
1520 @param next_table_index - index of next table
1521 @param miss_next_index - index of miss table
1522 @param mask[] - match mask
1524 define classify_add_del_table {
1532 u32 match_n_vectors;
1533 u32 next_table_index;
1534 u32 miss_next_index;
1538 /** \brief Add/Delete classification table response
1539 @param context - sender context, to match reply w/ request
1540 @param retval - return code for the table add/del requst
1541 @param new_table_index - for add, returned index of the new table
1542 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1543 @param match_n_vectors -for add, returned value of match_n_vectors in table
1545 define classify_add_del_table_reply {
1548 u32 new_table_index;
1550 u32 match_n_vectors;
1553 /** \brief Classify add / del session request
1554 @param client_index - opaque cookie to identify the sender
1555 @param context - sender context, to match reply w/ request
1556 @param is_add - add session if non-zero, else delete
1557 @param table_index - index of the table to add/del the session, required
1558 @param hit_next_index - for add, hit_next_index of new session, required
1559 @param opaque_index - for add, opaque_index of new session
1560 @param advance -for add, advance value for session
1561 @param match[] - for add, match value for session, required
1563 define classify_add_del_session {
1574 /** \brief Classify add / del session response
1575 @param context - sender context, to match reply w/ request
1576 @param retval - return code for the add/del session request
1578 define classify_add_del_session_reply {
1583 /** \brief Set/unset the classification table for an interface request
1584 @param client_index - opaque cookie to identify the sender
1585 @param context - sender context, to match reply w/ request
1586 @param is_ipv6 - ipv6 if non-zero, else ipv4
1587 @param sw_if_index - interface to associate with the table
1588 @param table_index - index of the table, if ~0 unset the table
1590 define classify_set_interface_ip_table {
1595 u32 table_index; /* ~0 => off */
1598 /** \brief Set/unset interface classification table response
1599 @param context - sender context, to match reply w/ request
1600 @param retval - return code
1602 define classify_set_interface_ip_table_reply {
1607 /** \brief Set/unset l2 classification tables for an interface request
1608 @param client_index - opaque cookie to identify the sender
1609 @param context - sender context, to match reply w/ request
1610 @param sw_if_index - interface to set/unset tables for
1611 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1612 @param ip6_table_index - ip6 index
1613 @param other_table_index - other index
1615 define classify_set_interface_l2_tables {
1620 u32 ip4_table_index;
1621 u32 ip6_table_index;
1622 u32 other_table_index;
1625 /** \brief Set/unset l2 classification tables for an interface response
1626 @param context - sender context, to match reply w/ request
1627 @param retval - return code for the request
1629 define classify_set_interface_l2_tables_reply {
1634 /** \brief Get node index using name request
1635 @param client_index - opaque cookie to identify the sender
1636 @param context - sender context, to match reply w/ request
1637 @param node_name[] - name of the node
1639 define get_node_index {
1645 /** \brief Get node index using name request
1646 @param context - sender context, to match reply w/ request
1647 @param retval - return code for the request
1648 @param node_index - index of the desired node if found, else ~0
1650 define get_node_index_reply {
1656 /** \brief Set the next node for a given node request
1657 @param client_index - opaque cookie to identify the sender
1658 @param context - sender context, to match reply w/ request
1659 @param node_name[] - node to add the next node to
1660 @param next_name[] - node to add as the next node
1662 define add_node_next {
1669 /** \brief IP Set the next node for a given node response
1670 @param context - sender context, to match reply w/ request
1671 @param retval - return code for the add next node request
1672 @param next_index - the index of the next node if success, else ~0
1674 define add_node_next_reply {
1680 /** \brief DHCP Proxy config 2 add / del request
1681 @param client_index - opaque cookie to identify the sender
1682 @param context - sender context, to match reply w/ request
1683 @param rx_vrf_id - receive vrf id
1684 @param server_vrf_id - server vrf id
1685 @param if_ipv6 - ipv6 if non-zero, else ipv4
1686 @param is_add - add the config if non-zero, else delete
1687 @param insert_circuit_id - option82 suboption 1 fib number
1688 @param dhcp_server[] - server address
1689 @param dhcp_src_address[] - <fix this, need details>
1691 define dhcp_proxy_config_2 {
1698 u8 insert_circuit_id;
1700 u8 dhcp_src_address[16];
1703 /** \brief DHCP Proxy config 2 add / del response
1704 @param context - sender context, to match reply w/ request
1705 @param retval - return code for request
1707 define dhcp_proxy_config_2_reply {
1712 /** \brief l2tpv3 tunnel interface create request
1713 @param client_index - opaque cookie to identify the sender
1714 @param context - sender context, to match reply w/ request
1715 @param client_address - remote client tunnel ip address
1716 @param client_address - local tunnel ip address
1717 @param is_ipv6 - ipv6 if non-zero, else ipv4
1718 @param local_session_id - local tunnel session id
1719 @param remote_session_id - remote tunnel session id
1720 @param local_cookie - local tunnel cookie
1721 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1723 define l2tpv3_create_tunnel {
1726 u8 client_address [16];
1727 u8 our_address [16];
1729 u32 local_session_id;
1730 u32 remote_session_id;
1733 u8 l2_sublayer_present;
1736 /** \brief l2tpv3 tunnel interface create response
1737 @param context - sender context, to match reply w/ request
1738 @param retval - return code for the request
1739 @param sw_if_index - index of the new tunnel interface
1741 define l2tpv3_create_tunnel_reply {
1747 define l2tpv3_set_tunnel_cookies {
1751 u64 new_local_cookie;
1752 u64 new_remote_cookie;
1755 /** \brief L2TP tunnel set cookies response
1756 @param context - sender context, to match reply w/ request
1757 @param retval - return code for the request
1759 define l2tpv3_set_tunnel_cookies_reply {
1764 manual_java define sw_if_l2tpv3_tunnel_details {
1766 u8 interface_name[64];
1767 u8 client_address [16];
1768 u8 our_address [16];
1769 u32 local_session_id;
1770 u32 remote_session_id;
1771 u64 local_cookie[2];
1773 u8 l2_sublayer_present;
1776 define sw_if_l2tpv3_tunnel_dump {
1781 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1782 @param client_index - opaque cookie to identify the sender
1783 @param context - sender context, to match reply w/ request
1785 define l2_fib_clear_table {
1790 /** \brief L2 fib clear table response
1791 @param context - sender context, to match reply w/ request
1792 @param retval - return code for the request
1794 define l2_fib_clear_table_reply {
1799 /** \brief L2 interface ethernet flow point filtering enable/disable 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 to enable/disable filtering on
1803 @param enable_disable - if non-zero enable filtering, else disable
1805 define l2_interface_efp_filter {
1812 /** \brief L2 interface ethernet flow point filtering response
1813 @param context - sender context, to match reply w/ request
1814 @param retval - return code for the request
1816 define l2_interface_efp_filter_reply {
1821 define l2tpv3_interface_enable_disable {
1828 define l2tpv3_interface_enable_disable_reply {
1833 define l2tpv3_set_lookup_key {
1836 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1840 define l2tpv3_set_lookup_key_reply {
1845 define vxlan_add_del_tunnel {
1852 u32 decap_next_index;
1856 define vxlan_add_del_tunnel_reply {
1862 manual_java define vxlan_tunnel_dump {
1868 manual_java define vxlan_tunnel_details {
1874 u32 decap_next_index;
1878 /** \brief L2 interface vlan tag rewrite configure request
1879 @param client_index - opaque cookie to identify the sender
1880 @param context - sender context, to match reply w/ request
1881 @param sw_if_index - interface the operation is applied to
1882 @param vtr_op - Choose from l2_vtr_op_t enum values
1883 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1884 @param tag1 - Needed for any push or translate vtr op
1885 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1887 define l2_interface_vlan_tag_rewrite {
1892 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1893 u32 tag1; // first pushed tag
1894 u32 tag2; // second pushed tag
1897 /** \brief L2 interface vlan tag rewrite response
1898 @param context - sender context, to match reply w/ request
1899 @param retval - return code for the request
1901 define l2_interface_vlan_tag_rewrite_reply {
1906 /** \brief vhost-user interface create request
1907 @param client_index - opaque cookie to identify the sender
1908 @param is_server - our side is socket server
1909 @param sock_filename - unix socket filename, used to speak with frontend
1910 @param use_custom_mac - enable or disable the use of the provided hardware address
1911 @param mac_address - hardware address to use if 'use_custom_mac' is set
1913 define create_vhost_user_if {
1917 u8 sock_filename[256];
1919 u32 custom_dev_instance;
1924 /** \brief vhost-user interface create response
1925 @param context - sender context, to match reply w/ request
1926 @param retval - return code for the request
1927 @param sw_if_index - interface the operation is applied to
1929 define create_vhost_user_if_reply {
1935 /** \brief vhost-user interface modify request
1936 @param client_index - opaque cookie to identify the sender
1937 @param is_server - our side is socket server
1938 @param sock_filename - unix socket filename, used to speak with frontend
1940 define modify_vhost_user_if {
1945 u8 sock_filename[256];
1947 u32 custom_dev_instance;
1950 /** \brief vhost-user interface modify response
1951 @param context - sender context, to match reply w/ request
1952 @param retval - return code for the request
1954 define modify_vhost_user_if_reply {
1959 /** \brief vhost-user interface delete request
1960 @param client_index - opaque cookie to identify the sender
1962 define delete_vhost_user_if {
1968 /** \brief vhost-user interface delete response
1969 @param context - sender context, to match reply w/ request
1970 @param retval - return code for the request
1972 define delete_vhost_user_if_reply {
1977 define create_subif {
1983 /* These fields map directly onto the subif template */
1987 u8 dot1ad; // 0 = dot1q, 1=dot1ad
1990 u8 outer_vlan_id_any;
1991 u8 inner_vlan_id_any;
1996 define create_subif_reply {
2002 /** \brief show version
2003 @param client_index - opaque cookie to identify the sender
2004 @param context - sender context, to match reply w/ request
2006 define show_version {
2011 /** \brief show version response
2012 @param context - sender context, to match reply w/ request
2013 @param retval - return code for the request
2014 @param program - name of the program (vpe)
2015 @param version - version of the program
2016 @param build_directory - root of the workspace where the program was built
2018 manual_java define show_version_reply {
2024 u8 build_directory[256];
2027 define nsh_gre_add_del_tunnel {
2034 u32 decap_next_index;
2035 u8 tlv_len_in_words;
2041 /* in network byte order */
2050 define nsh_gre_add_del_tunnel_reply {
2056 /** \brief Vhost-user interface details structure (fix this)
2057 @param sw_if_index - index of the interface
2058 @param interface_name - name of interface
2059 @param virtio_net_hdr_sz - net header size
2060 @param features - interface features
2061 @param is_server - vhost-user server socket
2062 @param sock_filename - socket filename
2063 @param num_regions - number of used memory regions
2065 manual_java define sw_interface_vhost_user_details {
2067 u8 interface_name[64];
2068 u32 virtio_net_hdr_sz;
2071 u8 sock_filename[256];
2077 define sw_interface_vhost_user_dump {
2082 manual_java define ip_address_details {
2089 manual_java define ip_address_dump {
2096 manual_java define ip_details {
2107 /** \brief l2 fib table entry structure
2108 @param bd_id - the l2 fib / bridge domain table id
2109 @param mac - the entry's mac address
2110 @param sw_if_index - index of the interface
2111 @param static_mac - the entry is statically configured.
2112 @param filter_mac - the entry is a mac filter entry.
2113 @param bvi_mac - the mac address is a bridge virtual interface
2115 manual_java define l2_fib_table_entry {
2124 /** \brief Dump l2 fib (aka bridge domain) table
2125 @param client_index - opaque cookie to identify the sender
2126 @param bd_id - the l2 fib / bridge domain table identifier
2128 manual_java define l2_fib_table_dump {
2134 define nsh_vxlan_gpe_add_del_tunnel {
2141 u32 decap_next_index;
2143 u8 tlv_len_in_words;
2149 /* in network byte order */
2158 define nsh_vxlan_gpe_add_del_tunnel_reply {
2164 define lisp_gpe_add_del_tunnel {
2171 u32 decap_next_index;
2177 /* in network byte order */
2181 define lisp_gpe_add_del_tunnel_reply {
2187 /** \brief add or delete locator_set
2188 @param client_index - opaque cookie to identify the sender
2189 @param context - sender context, to match reply w/ request
2190 @param is_add - add address if non-zero, else delete
2191 @param locator_set_name - locator name
2193 define lisp_add_del_locator_set {
2197 u8 locator_set_name[64];
2200 /** \brief Reply for locator_set add/del
2201 @param context - returned sender context, to match reply w/ request
2202 @param retval - return code
2204 define lisp_add_del_locator_set_reply {
2209 /** \brief add or delete locator for locator_set
2210 @param client_index - opaque cookie to identify the sender
2211 @param context - sender context, to match reply w/ request
2212 @param is_add - add address if non-zero, else delete
2213 @param locator_set_name - name of locator_set to add/del locator
2214 @param sw_if_index - index of the interface
2215 @param priority - priority of the lisp locator
2216 @param weight - weight of the lisp locator
2218 define lisp_add_del_locator {
2222 u8 locator_set_name[64];
2228 /** \brief Reply for locator add/del
2229 @param context - returned sender context, to match reply w/ request
2230 @param retval - return code
2232 define lisp_add_del_locator_reply {
2237 /** \brief add or delete lisp eid-table
2238 @param client_index - opaque cookie to identify the sender
2239 @param context - sender context, to match reply w/ request
2240 @param is_add - add address if non-zero, else delete
2241 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2242 @param ip_address - array of address bytes
2243 @param prefix_len - prefix len
2244 @param locator_set_name - name of locator_set to add/del eid-table
2246 define lisp_add_del_local_eid {
2253 u8 locator_set_name[64];
2256 /** \brief Reply for local_eid add/del
2257 @param context - returned sender context, to match reply w/ request
2258 @param retval - return code
2260 define lisp_add_del_local_eid_reply {
2265 /** \brief add or delete lisp gpe maptunel
2266 @param client_index - opaque cookie to identify the sender
2267 @param context - sender context, to match reply w/ request
2268 @param is_add - add address if non-zero, else delete
2269 @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2270 @param eid_ip_address - array of address bytes
2271 @param eid_prefix_len - prefix len
2272 @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2273 @param source_ip_address - array of address bytes
2274 @param destination_ip_address - array of address bytes
2276 define lisp_gpe_add_del_fwd_entry {
2281 u8 eid_ip_address[16];
2284 u8 source_ip_address[16];
2285 u8 destination_ip_address[16];
2288 /** \brief Reply for gpe_fwd_entry add/del
2289 @param context - returned sender context, to match reply w/ request
2290 @param retval - return code
2292 define lisp_gpe_add_del_fwd_entry_reply {
2297 /** \brief add or delete map-resolver
2298 @param client_index - opaque cookie to identify the sender
2299 @param context - sender context, to match reply w/ request
2300 @param is_add - add address if non-zero, else delete
2301 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2302 @param ip_address - array of address bytes
2304 define lisp_add_del_map_resolver {
2312 /** \brief Reply for map_resolver add/del
2313 @param context - returned sender context, to match reply w/ request
2314 @param retval - return code
2316 define lisp_add_del_map_resolver_reply {
2321 /** \brief add or delete gpe_iface
2322 @param client_index - opaque cookie to identify the sender
2323 @param context - sender context, to match reply w/ request
2324 @param is_add - add address if non-zero, else delete
2326 define lisp_gpe_add_del_iface {
2332 /** \brief Reply for gpe_iface add/del
2333 @param context - returned sender context, to match reply w/ request
2334 @param retval - return code
2336 define lisp_gpe_add_del_iface_reply {
2341 /** \brief LISP locator_set status
2342 @param locator_set_name - name of the locator_set
2343 @param sw_if_index - sw_if_index of the locator
2344 @param priority - locator priority
2345 @param weight - locator weight
2347 manual_java define lisp_locator_set_details {
2349 u8 locator_set_name[64];
2355 /** \brief Request for locator_set summary status
2356 @param client_index - opaque cookie to identify the sender
2357 @param context - sender context, to match reply w/ request
2359 define lisp_locator_set_dump {
2364 /** \brief LISP local eid table status
2365 @param locator_set_name - name of the locator_set
2366 @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2367 @param eid_ip_address - array of address bytes
2368 @param eid_prefix_len - prefix len
2370 manual_java define lisp_local_eid_table_details {
2372 u8 locator_set_name[64];
2374 u8 eid_ip_address[16];
2378 /** \brief Request for local eid table summary status
2379 @param client_index - opaque cookie to identify the sender
2380 @param context - sender context, to match reply w/ request
2382 define lisp_local_eid_table_dump {
2387 manual_java define lisp_gpe_tunnel_details {
2392 u8 destination_ip[16];
2404 /** \brief Request for gpe tunnel summary status
2405 @param client_index - opaque cookie to identify the sender
2406 @param context - sender context, to match reply w/ request
2408 define lisp_gpe_tunnel_dump {
2413 /** \brief LISP map resolver status
2414 @param locator_set_name - name of the locator_set
2415 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2416 @param ip_address - array of address bytes
2418 manual_java define lisp_map_resolver_details {
2424 /** \brief Request for map resolver summary status
2425 @param client_index - opaque cookie to identify the sender
2426 @param context - sender context, to match reply w/ request
2428 define lisp_map_resolver_dump {
2433 /* Gross kludge, DGMS */
2434 define interface_name_renumber {
2438 u32 new_show_dev_instance;
2441 define interface_name_renumber_reply {
2446 /** \brief Register for ip4 arp resolution events
2447 @param client_index - opaque cookie to identify the sender
2448 @param context - sender context, to match reply w/ request
2449 @param enable_disable - 1 => register for events, 0 => cancel registration
2450 @param pid - sender's pid
2451 @param address - the exact ip4 address of interest
2453 define want_ip4_arp_events {
2461 /** \brief Reply for interface events registration
2462 @param context - returned sender context, to match reply w/ request
2463 @param retval - return code
2465 define want_ip4_arp_events_reply {
2470 /** \brief Tell client about an ip4 arp resolution event
2471 @param client_index - opaque cookie to identify the sender
2472 @param context - sender context, to match reply w/ request
2473 @param address - the exact ip4 address of interest
2474 @param pid - client pid registered to receive notification
2475 @param sw_if_index - interface which received ARP packet
2476 @param new_mac - the new mac address
2478 define ip4_arp_event {
2487 /** \brief L2 bridge domain add or delete request
2488 @param client_index - opaque cookie to identify the sender
2489 @param context - sender context, to match reply w/ request
2490 @param bd_id - the bridge domain to create
2491 @param flood - enable/disable bcast/mcast flooding in the bd
2492 @param uu_flood - enable/disable uknown unicast flood in the bd
2493 @param forward - enable/disable forwarding on all interfaces in the bd
2494 @param learn - enable/disable learning on all interfaces in the bd
2495 @param arp_term - enable/disable arp termination in the bd
2496 @param is_add - add or delete flag
2498 define bridge_domain_add_del {
2510 /** \brief L2 bridge domain add or delete response
2511 @param context - sender context, to match reply w/ request
2512 @param retval - return code for the set bridge flags request
2514 define bridge_domain_add_del_reply {
2519 /** \brief L2 bridge domain request operational state details
2520 @param client_index - opaque cookie to identify the sender
2521 @param context - sender context, to match reply w/ request
2522 @param bd_id - the bridge domain id desired or ~0 to request all bds
2524 manual_java define bridge_domain_dump {
2530 /** \brief L2 bridge domain operational state response
2531 @param bd_id - the bridge domain id
2532 @param flood - bcast/mcast flooding state on all interfaces in the bd
2533 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2534 @param forward - forwarding state on all interfaces in the bd
2535 @param learn - learning state on all interfaces in the bd
2536 @param arp_term - arp termination state on all interfaces in the bd
2537 @param n_sw_ifs - number of sw_if_index's in the domain
2539 manual_java define bridge_domain_details {
2547 u32 bvi_sw_if_index;
2551 /** \brief L2 bridge domain sw interface operational state response
2552 @param bd_id - the bridge domain id
2553 @param sw_if_index - sw_if_index in the domain
2554 @param shg - split horizon group for the interface
2556 manual_java define bridge_domain_sw_if_details {
2563 /** \brief DHCP Client config add / del request
2564 @param client_index - opaque cookie to identify the sender
2565 @param context - sender context, to match reply w/ request
2566 @param sw_if_index - index of the interface for DHCP client
2567 @param hostname - hostname
2568 @param is_add - add the config if non-zero, else delete
2569 @param want_dhcp_event - DHCP event sent to the sender
2570 via dhcp_compl_event API message if non-zero
2571 @param pid - sender's pid
2573 define dhcp_client_config {
2583 /** \brief DHCP Client config response
2584 @param context - sender context, to match reply w/ request
2585 @param retval - return code for the request
2587 define dhcp_client_config_reply {
2592 /** \brief Set/unset input ACL interface
2593 @param client_index - opaque cookie to identify the sender
2594 @param context - sender context, to match reply w/ request
2595 @param sw_if_index - interface to set/unset input ACL
2596 @param ip4_table_index - ip4 classify table index (~0 for skip)
2597 @param ip6_table_index - ip6 classify table index (~0 for skip)
2598 @param l2_table_index - l2 classify table index (~0 for skip)
2599 @param is_add - Set input ACL if non-zero, else unset
2600 Note: User is recommeneded to use just one valid table_index per call.
2601 (ip4_table_index, ip6_table_index, or l2_table_index)
2603 define input_acl_set_interface {
2607 u32 ip4_table_index;
2608 u32 ip6_table_index;
2613 /** \brief Set/unset input ACL interface response
2614 @param context - sender context, to match reply w/ request
2615 @param retval - return code for the request
2617 define input_acl_set_interface_reply {
2622 /** \brief IPsec: Add/delete Security Policy Database
2623 @param client_index - opaque cookie to identify the sender
2624 @param context - sender context, to match reply w/ request
2625 @param is_add - add SPD if non-zero, else delete
2626 @param spd_id - SPD instance id (control plane allocated)
2629 define ipsec_spd_add_del {
2636 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2637 @param context - returned sender context, to match reply w/ request
2638 @param retval - return code
2641 define ipsec_spd_add_del_reply {
2646 /** \brief IPsec: Add/delete SPD from interface
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 security mode if non-zero, else delete
2651 @param sw_if_index - index of the interface
2652 @param spd_id - SPD instance id to use for lookups
2656 define ipsec_interface_add_del_spd {
2665 /** \brief Reply for IPsec: Add/delete SPD from interface
2666 @param context - returned sender context, to match reply w/ request
2667 @param retval - return code
2670 define ipsec_interface_add_del_spd_reply {
2675 /** \brief IPsec: Add/delete Security Policy Database entry
2677 See RFC 4301, 4.4.1.1 on how to match packet to selectors
2679 @param client_index - opaque cookie to identify the sender
2680 @param context - sender context, to match reply w/ request
2681 @param is_add - add SPD if non-zero, else delete
2682 @param spd_id - SPD instance id (control plane allocated)
2683 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
2684 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2685 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2686 @param remote_address_start - start of remote address range to match
2687 @param remote_address_stop - end of remote address range to match
2688 @param local_address_start - start of local address range to match
2689 @param local_address_stop - end of local address range to match
2690 @param protocol - protocol type to match [0 means any]
2691 @param remote_port_start - start of remote port range to match ...
2692 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2693 @param local_port_start - start of local port range to match ...
2694 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2695 @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)
2696 @param sa_id - SAD instance id (control plane allocated)
2700 define ipsec_spd_add_del_entry {
2712 u8 remote_address_start[16];
2713 u8 remote_address_stop[16];
2714 u8 local_address_start[16];
2715 u8 local_address_stop[16];
2719 u16 remote_port_start;
2720 u16 remote_port_stop;
2721 u16 local_port_start;
2722 u16 local_port_stop;
2729 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2730 @param context - returned sender context, to match reply w/ request
2731 @param retval - return code
2734 define ipsec_spd_add_del_entry_reply {
2739 /** \brief IPsec: Add/delete Security Association Database entry
2740 @param client_index - opaque cookie to identify the sender
2741 @param context - sender context, to match reply w/ request
2742 @param is_add - add SAD entry if non-zero, else delete
2744 @param sad_id - sad id
2746 @param spi - security parameter index
2748 @param protocol - 0 = AH, 1 = ESP
2750 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
2751 @param crypto_key_length - length of crypto_key in bytes
2752 @param crypto_key - crypto keying material
2754 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
2755 @param integrity_key_length - length of integrity_key in bytes
2756 @param integrity_key - integrity keying material
2758 @param use_extended_sequence_number - use ESN when non-zero
2760 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
2761 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
2762 @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
2763 @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
2767 IPsec tunnel address copy mode (to support GDOI)
2770 define ipsec_sad_add_del_entry {
2781 u8 crypto_algorithm;
2782 u8 crypto_key_length;
2785 u8 integrity_algorithm;
2786 u8 integrity_key_length;
2787 u8 integrity_key[128];
2789 u8 use_extended_sequence_number;
2793 u8 tunnel_src_address[16];
2794 u8 tunnel_dst_address[16];
2797 /** \brief Reply for IPsec: Add/delete Security Association Database entry
2798 @param context - returned sender context, to match reply w/ request
2799 @param retval - return code
2802 define ipsec_sad_add_del_entry_reply {
2807 /** \brief IPsec: Update Security Association keys
2808 @param client_index - opaque cookie to identify the sender
2809 @param context - sender context, to match reply w/ request
2811 @param sa_id - sa id
2813 @param crypto_key_length - length of crypto_key in bytes
2814 @param crypto_key - crypto keying material
2816 @param integrity_key_length - length of integrity_key in bytes
2817 @param integrity_key - integrity keying material
2820 define ipsec_sa_set_key {
2826 u8 crypto_key_length;
2829 u8 integrity_key_length;
2830 u8 integrity_key[128];
2833 /** \brief Reply for IPsec: Update Security Association keys
2834 @param context - returned sender context, to match reply w/ request
2835 @param retval - return code
2838 define ipsec_sa_set_key_reply {
2843 /** \brief IKEv2: Add/delete profile
2844 @param client_index - opaque cookie to identify the sender
2845 @param context - sender context, to match reply w/ request
2847 @param name - IKEv2 profile name
2848 @param is_add - Add IKEv2 profile if non-zero, else delete
2850 define ikev2_profile_add_del {
2858 /** \brief Reply for IKEv2: Add/delete profile
2859 @param context - returned sender context, to match reply w/ request
2860 @param retval - return code
2862 define ikev2_profile_add_del_reply {
2867 /** \brief IKEv2: Set IKEv2 profile authentication method
2868 @param client_index - opaque cookie to identify the sender
2869 @param context - sender context, to match reply w/ request
2871 @param name - IKEv2 profile name
2872 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
2873 @param is_hex - Authentication data in hex format if non-zero, else string
2874 @param data_len - Authentication data length
2875 @param data - Authentication data (for rsa-sig cert file path)
2877 define ikev2_profile_set_auth {
2888 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
2889 @param context - returned sender context, to match reply w/ request
2890 @param retval - return code
2892 define ikev2_profile_set_auth_reply {
2897 /** \brief IKEv2: Set IKEv2 profile local/remote identification
2898 @param client_index - opaque cookie to identify the sender
2899 @param context - sender context, to match reply w/ request
2901 @param name - IKEv2 profile name
2902 @param is_local - Identification is local if non-zero, else remote
2903 @param id_type - Identification type
2904 @param data_len - Identification data length
2905 @param data - Identification data
2907 define ikev2_profile_set_id {
2918 /** \brief Reply for IKEv2:
2919 @param context - returned sender context, to match reply w/ request
2920 @param retval - return code
2922 define ikev2_profile_set_id_reply {
2927 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
2928 @param client_index - opaque cookie to identify the sender
2929 @param context - sender context, to match reply w/ request
2931 @param name - IKEv2 profile name
2932 @param is_local - Traffic selector is local if non-zero, else remote
2933 @param proto - Traffic selector IP protocol (if zero not relevant)
2934 @param start_port - The smallest port number allowed by traffic selector
2935 @param end_port - The largest port number allowed by traffic selector
2936 @param start_addr - The smallest address included in traffic selector
2937 @param end_addr - The largest address included in traffic selector
2939 define ikev2_profile_set_ts {
2952 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
2953 @param context - returned sender context, to match reply w/ request
2954 @param retval - return code
2956 define ikev2_profile_set_ts_reply {
2961 /** \brief IKEv2: Set IKEv2 local RSA private key
2962 @param client_index - opaque cookie to identify the sender
2963 @param context - sender context, to match reply w/ request
2965 @param key_file - Key file absolute path
2967 define ikev2_set_local_key {
2974 /** \brief Reply for IKEv2: Set IKEv2 local key
2975 @param context - returned sender context, to match reply w/ request
2976 @param retval - return code
2978 define ikev2_set_local_key_reply {
2983 /** \brief Tell client about a DHCP completion event
2984 @param client_index - opaque cookie to identify the sender
2985 @param pid - client pid registered to receive notification
2986 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2987 @param host_address - Host IP address
2988 @param router_address - Router IP address
2989 @param host_mac - Host MAC address
2991 manual_java define dhcp_compl_event {
2996 u8 host_address[16];
2997 u8 router_address[16];
3001 /** \brief Add MAP domains
3002 @param client_index - opaque cookie to identify the sender
3003 @param context - sender context, to match reply w/ request
3004 @param ip6_prefix - Rule IPv6 prefix
3005 @param ip4_prefix - Rule IPv4 prefix
3006 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3007 @param ip6_prefix_len - Rule IPv6 prefix length
3008 @param ip4_prefix_len - Rule IPv4 prefix length
3009 @param ea_bits_len - Embedded Address bits length
3010 @param psid_offset - Port Set Identifider (PSID) offset
3011 @param psid_length - PSID length
3012 @param is_translation - MAP-E / MAP-T
3015 define map_add_domain {
3023 u8 ip6_src_prefix_len;
3031 /** \brief Reply for MAP domain add
3032 @param context - returned sender context, to match reply w/ request
3033 @param index - MAP domain index
3034 @param retval - return code
3036 define map_add_domain_reply {
3042 /** \brief Delete MAP domain
3043 @param client_index - opaque cookie to identify the sender
3044 @param context - sender context, to match reply w/ request
3045 @param index - MAP Domain index
3047 define map_del_domain {
3053 /** \brief Reply for MAP domain del
3054 @param context - returned sender context, to match reply w/ request
3055 @param retval - return code
3057 define map_del_domain_reply {
3062 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3063 @param client_index - opaque cookie to identify the sender
3064 @param context - sender context, to match reply w/ request
3065 @param index - MAP Domain index
3066 @param is_add - If 1 add rule, if 0 delete rule
3067 @param ip6_dst - MAP CE IPv6 address
3068 @param psid - Rule PSID
3070 define map_add_del_rule {
3079 /** \brief Reply for MAP rule add/del
3080 @param context - returned sender context, to match reply w/ request
3081 @param retval - return code
3083 define map_add_del_rule_reply {
3088 /** \brief Get list of map domains
3089 @param client_index - opaque cookie to identify the sender
3091 define map_domain_dump {
3096 manual_java define map_domain_details {
3112 define map_rule_dump {
3118 manual_java define map_rule_details {
3123 /** \brief Request for a single block of summary stats
3124 @param client_index - opaque cookie to identify the sender
3125 @param context - sender context, to match reply w/ request
3127 define map_summary_stats {
3132 /** \brief Reply for map_summary_stats request
3133 @param context - sender context, to match reply w/ request
3134 @param retval - return code for request
3135 @param total_bindings -
3137 @param total_ip4_fragments -
3138 @param total_security_check -
3140 define map_summary_stats_reply {
3146 u64 total_ip4_fragments;
3147 u64 total_security_check[2];
3150 /** \brief cop: enable/disable junk filtration features on an interface
3151 @param client_index - opaque cookie to identify the sender
3152 @param context - sender context, to match reply w/ request
3153 @param sw_if_inded - desired interface
3154 @param enable_disable - 1 => enable, 0 => disable
3157 define cop_interface_enable_disable {
3164 /** \brief cop: interface enable/disable junk filtration reply
3165 @param context - returned sender context, to match reply w/ request
3166 @param retval - return code
3169 define cop_interface_enable_disable_reply {
3174 /** \brief cop: enable/disable whitelist filtration features on an interface
3175 Note: the supplied fib_id must match in order to remove the feature!
3177 @param client_index - opaque cookie to identify the sender
3178 @param context - sender context, to match reply w/ request
3179 @param sw_if_index - interface handle, physical interfaces only
3180 @param fib_id - fib identifier for the whitelist / blacklist fib
3181 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3182 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3183 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3186 define cop_whitelist_enable_disable {
3196 /** \brief cop: interface enable/disable junk filtration reply
3197 @param context - returned sender context, to match reply w/ request
3198 @param retval - return code
3201 define cop_whitelist_enable_disable_reply {
3206 /** \brief get_node_graph - get a copy of the vpp node graph
3207 including the current set of graph arcs.
3209 @param client_index - opaque cookie to identify the sender
3210 @param context - sender context, to match reply w/ request
3213 define get_node_graph {
3218 /** \brief get_node_graph_reply
3219 @param context - returned sender context, to match reply w/ request
3220 @param retval - return code
3221 @param reply_in_shmem - result from vlib_node_serialize, in shared
3222 memory. Process with vlib_node_unserialize, remember to switch
3223 heaps and free the result.
3226 define get_node_graph_reply {
3232 /** \brief Clear interface statistics
3233 @param client_index - opaque cookie to identify the sender
3234 @param context - sender context, to match reply w/ request
3235 @param sw_if_index - index of the interface to clear statistics
3237 define sw_interface_clear_stats {
3243 /** \brief Reply to sw_interface_clear_stats
3244 @param context - sender context which was passed in the request
3245 @param retval - return code of the set flags request
3247 define sw_interface_clear_stats_reply {
3252 /** \brief IOAM Trace : Set TRACE profile
3253 @param id - profile id
3254 @param trace_type - Trace type
3255 @param trace_num_elt - Number of nodes in trace path
3256 @param trace_ppc - Trace PPC (none/encap/decap)
3257 @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3258 @param trace_app_data - Trace application data, can be any 4 bytes
3259 @param pow_enable - Proof of Work enabled or not flag
3260 @param node_id - Id of this node
3262 define trace_profile_add {
3275 /** \brief Trace profile add / del response
3276 @param context - sender context, to match reply w/ request
3277 @param retval - return value for request
3279 define trace_profile_add_reply {
3284 /** \brief IOAM Trace enable trace profile for a flow
3285 @param id - id of the trace profile to be applied
3286 @param dest_ipv6 - Destination IPv6 address
3287 @param prefix_length - prefix mask
3288 @param vrf_id - VRF ID
3289 @param trace_op - Trace operation (add/mod/del)
3290 @param enable - apply/remove the trace profile for the flow
3292 define trace_profile_apply {
3303 /** \brief Trace profile apply response
3304 @param context - sender context, to match reply w/ request
3305 @param retval - return value for request
3307 define trace_profile_apply_reply {
3312 /** \brief Delete Trace Profile
3313 @param client_index - opaque cookie to identify the sender
3314 @param context - sender context, to match reply w/ request
3315 @param index - MAP Domain index
3317 define trace_profile_del {
3323 /** \brief Trace profile add / del response
3324 @param context - sender context, to match reply w/ request
3325 @param retval - return value for request
3327 define trace_profile_del_reply {