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 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 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 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 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 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_print manual_endian define vnet_ip4_fib_counters {
646 vl_api_ip4_fib_counter_t c[count];
649 typeonly manual_print manual_endian define ip6_fib_counter {
656 manual_print manual_endian define vnet_ip6_fib_counters {
659 vl_api_ip6_fib_counter_t c[count];
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[] -
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 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 define control_ping_reply {
1076 /** \brief Control ping from client to api server request, no print json output
1077 @param client_index - opaque cookie to identify the sender
1078 @param context - sender context, to match reply w/ request
1080 define noprint_control_ping {
1085 /** \brief Control ping from the client to the server response
1086 @param client_index - opaque cookie to identify the sender
1087 @param context - sender context, to match reply w/ request
1088 @param retval - return code for the request
1089 @param vpe_pid - the pid of the vpe, returned by the server
1091 define noprint_control_ping_reply {
1098 /** \brief Process a vpe parser cli string request
1099 @param client_index - opaque cookie to identify the sender
1100 @param context - sender context, to match reply w/ request
1101 @param cmd_in_shmem - pointer to cli command string
1103 define cli_request {
1109 /** \brief vpe parser cli string response
1110 @param context - sender context, to match reply w/ request
1111 @param retval - return code for request
1112 @param reply_in_shmem - Reply string from cli processing if any
1120 /** \brief Set max allowed ARP or ip6 neighbor entries request
1121 @param client_index - opaque cookie to identify the sender
1122 @param context - sender context, to match reply w/ request
1123 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1124 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1126 define set_arp_neighbor_limit {
1130 u32 arp_neighbor_limit;
1133 /** \brief Set max allowed ARP or ip6 neighbor entries response
1134 @param context - sender context, to match reply w/ request
1135 @param retval - return code for request
1137 define set_arp_neighbor_limit_reply {
1142 /** \brief L2 interface patch add / del request
1143 @param client_index - opaque cookie to identify the sender
1144 @param context - sender context, to match reply w/ request
1145 @param rx_sw_if_index - receive side interface
1146 @param tx_sw_if_index - transmit side interface
1147 @param is_add - if non-zero set up the interface patch, else remove it
1149 define l2_patch_add_del {
1157 /** \brief L2 interface patch add / del response
1158 @param context - sender context, to match reply w/ request
1159 @param retval - return code for the request
1161 define l2_patch_add_del_reply {
1166 /** \brief IPv6 segment routing tunnel add / del request
1167 @param client_index - opaque cookie to identify the sender
1168 @param context - sender context, to match reply w/ request
1169 @param is_add - add the tunnel if non-zero, else delete it
1170 @param name[] - tunnel name (len. 64)
1171 @param src_address[] -
1172 @param dst_address[] -
1173 @param dst_mask_width -
1174 @param inner_vrf_id -
1175 @param outer_vrf_id -
1176 @param flags_net_byte_order -
1179 @param segs_and_tags[] -
1180 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1182 define sr_tunnel_add_del {
1192 u16 flags_net_byte_order;
1195 u8 segs_and_tags[0];
1199 /** \brief IPv6 segment routing tunnel add / del response
1200 @param context - sender context, to match reply w/ request
1201 @param retval - return value for request
1203 define sr_tunnel_add_del_reply {
1208 /** \brief IPv6 segment routing policy add / del request
1209 @param client_index - opaque cookie to identify the sender
1210 @param context - sender context, to match reply w/ request
1211 @param is_add - add the tunnel if non-zero, else delete it
1212 @param name[] - policy name (len. 64)
1213 @param tunnel_names[] -
1215 define sr_policy_add_del {
1223 /** \brief IPv6 segment routing policy add / del response
1224 @param context - sender context, to match reply w/ request
1225 @param retval - return value for request
1227 define sr_policy_add_del_reply {
1232 /** \brief IPv6 segment routing multicast map to policy add / del request
1233 @param client_index - opaque cookie to identify the sender
1234 @param context - sender context, to match reply w/ request
1235 @param is_add - add the tunnel if non-zero, else delete it
1236 @param multicast_address[] - IP6 multicast address
1237 @param policy_name[] = policy name (len.64)
1239 define sr_multicast_map_add_del {
1243 u8 multicast_address[16];
1247 /** \brief IPv6 segment routing multicast map to policy add / del response
1248 @param context - sender context, to match reply w/ request
1249 @param retval - return value for request
1251 define sr_multicast_map_add_del_reply {
1256 /** \brief Interface set vpath request
1257 @param client_index - opaque cookie to identify the sender
1258 @param context - sender context, to match reply w/ request
1259 @param sw_if_index - interface used to reach neighbor
1260 @param enable - if non-zero enable, else disable
1262 define sw_interface_set_vpath {
1269 /** \brief Interface set vpath response
1270 @param context - sender context, to match reply w/ request
1271 @param retval - return code for the request
1273 define sw_interface_set_vpath_reply {
1278 /** \brief MPLS Ethernet add / del tunnel request
1279 @param client_index - opaque cookie to identify the sender
1280 @param context - sender context, to match reply w/ request
1281 @param vrf_id - vrf_id, only for IP4
1282 @param sw_if_index - interface used to reach neighbor
1283 @param is_add - add if set, tunnel delete if 0
1284 @param dst_mac_address -
1285 @param adj_address -
1286 @param adj_address_length -
1288 define mpls_ethernet_add_del_tunnel {
1295 u8 dst_mac_address[6];
1297 u8 adj_address_length;
1300 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1301 @param context - sender context, to match reply w/ request
1302 @param retval - return code for the request
1304 define mpls_ethernet_add_del_tunnel_reply {
1307 u32 tunnel_sw_if_index;
1309 /** \brief MPLS Ethernet add/ del tunnel 2
1310 @param client_index - opaque cookie to identify the sender
1311 @param context - sender context, to match reply w/ request
1312 @param inner_vrf_id -
1313 @param outer_vrf_id -
1314 @param resolve_attempts -
1315 @param resolve_opaque -
1316 @param resolve_if_needed -
1318 @param adj_address -
1319 @param adj_address_length -
1320 @param next_hop_ip4_address_in_outer_vrf -
1322 define mpls_ethernet_add_del_tunnel_2 {
1327 u32 resolve_attempts;
1328 u32 resolve_opaque; /* no need to set this */
1329 u8 resolve_if_needed;
1333 u8 adj_address_length;
1334 u8 next_hop_ip4_address_in_outer_vrf [4];
1337 /** \brief MPLS Ethernet add/ del tunnel 2
1338 @param context - sender context, to match reply w/ request
1339 @param retval - return code for add /del request
1341 define mpls_ethernet_add_del_tunnel_2_reply {
1346 /** \brief Set L2 XConnect between two interfaces request
1347 @param client_index - opaque cookie to identify the sender
1348 @param context - sender context, to match reply w/ request
1349 @param rx_sw_if_index - Receive interface index
1350 @param tx_sw_if_index - Transmit interface index
1351 @param enable - enable xconnect if not 0, else set to L3 mode
1353 define sw_interface_set_l2_xconnect {
1361 /** \brief Set L2 XConnect response
1362 @param context - sender context, to match reply w/ request
1363 @param retval - L2 XConnect request return code
1365 define sw_interface_set_l2_xconnect_reply {
1370 /** \brief Interface bridge mode request
1371 @param client_index - opaque cookie to identify the sender
1372 @param context - sender context, to match reply w/ request
1373 @param rx_sw_if_index - the interface
1374 @param bd_id - bridge domain id
1375 @param bvi - Setup interface as a bvi, bridge mode only
1376 @param shg - Shared horizon group, for bridge mode only
1377 @param enable - Enable beige mode if not 0, else set to L3 mode
1379 define sw_interface_set_l2_bridge {
1389 /** \brief Interface bridge mode response
1390 @param context - sender context, to match reply w/ request
1391 @param retval - Bridge mode request return code
1393 define sw_interface_set_l2_bridge_reply {
1398 /** \brief L2 FIB add entry request
1399 @param client_index - opaque cookie to identify the sender
1400 @param context - sender context, to match reply w/ request
1401 @param mac - the entry's mac address
1402 @param bd_id - the entry's bridge domain id
1403 @param sw_if_index - the interface
1404 @param is_add - If non zero add the entry, else delete it
1408 define l2fib_add_del {
1420 /** \brief L2 FIB add entry response
1421 @param context - sender context, to match reply w/ request
1422 @param retval - return code for the add l2fib entry request
1424 define l2fib_add_del_reply {
1429 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1430 @param client_index - opaque cookie to identify the sender
1431 @param context - sender context, to match reply w/ request
1432 @param sw_if_index - interface
1433 @param is_set - if non-zero, set the bits, else clear them
1434 @param feature_bitmap - non-zero bits to set or clear
1444 /** \brief Set L2 bits response
1445 @param context - sender context, to match reply w/ request
1446 @param retval - return code for the set l2 bits request
1448 define l2_flags_reply {
1451 u32 resulting_feature_bitmap;
1454 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1455 L2_UU_FLOOD, or L2_ARP_TERM) request
1456 @param client_index - opaque cookie to identify the sender
1457 @param context - sender context, to match reply w/ request
1458 @param bd_id - the bridge domain to set the flags for
1459 @param is_set - if non-zero, set the flags, else clear them
1460 @param feature_bitmap - bits that are non-zero to set or clear
1462 define bridge_flags {
1470 /** \brief Set bridge flags response
1471 @param context - sender context, to match reply w/ request
1472 @param retval - return code for the set bridge flags request
1473 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1475 define bridge_flags_reply {
1478 u32 resulting_feature_bitmap;
1481 /** \brief Set bridge domain ip to mac entry request
1482 @param client_index - opaque cookie to identify the sender
1483 @param context - sender context, to match reply w/ request
1484 @param bd_id - the bridge domain to set the flags for
1485 @param is_add - if non-zero, add the entry, else clear it
1486 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1487 @param mac_address - MAC address
1490 define bd_ip_mac_add_del {
1500 /** \brief Set bridge domain ip to mac entry response
1501 @param context - sender context, to match reply w/ request
1502 @param retval - return code for the set bridge flags request
1504 define bd_ip_mac_add_del_reply {
1509 /** \brief Add/Delete classification table request
1510 @param client_index - opaque cookie to identify the sender
1511 @param context - sender context, to match reply w/ request
1512 @param is_add- if non-zero add the table, else delete it
1513 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1514 @param nbuckets - number of buckets when adding a table
1515 @param memory_size - memory size when adding a table
1516 @param match_n_vectors - number of match vectors
1517 @param next_table_index - index of next table
1518 @param miss_next_index - index of miss table
1519 @param mask[] - match mask
1521 define classify_add_del_table {
1529 u32 match_n_vectors;
1530 u32 next_table_index;
1531 u32 miss_next_index;
1535 /** \brief Add/Delete classification table response
1536 @param context - sender context, to match reply w/ request
1537 @param retval - return code for the table add/del requst
1538 @param new_table_index - for add, returned index of the new table
1539 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1540 @param match_n_vectors -for add, returned value of match_n_vectors in table
1542 define classify_add_del_table_reply {
1545 u32 new_table_index;
1547 u32 match_n_vectors;
1550 /** \brief Classify add / del session request
1551 @param client_index - opaque cookie to identify the sender
1552 @param context - sender context, to match reply w/ request
1553 @param is_add - add session if non-zero, else delete
1554 @param table_index - index of the table to add/del the session, required
1555 @param hit_next_index - for add, hit_next_index of new session, required
1556 @param opaque_index - for add, opaque_index of new session
1557 @param advance -for add, advance value for session
1558 @param match[] - for add, match value for session, required
1560 define classify_add_del_session {
1571 /** \brief Classify add / del session response
1572 @param context - sender context, to match reply w/ request
1573 @param retval - return code for the add/del session request
1575 define classify_add_del_session_reply {
1580 /** \brief Set/unset the classification table for an interface request
1581 @param client_index - opaque cookie to identify the sender
1582 @param context - sender context, to match reply w/ request
1583 @param is_ipv6 - ipv6 if non-zero, else ipv4
1584 @param sw_if_index - interface to associate with the table
1585 @param table_index - index of the table, if ~0 unset the table
1587 define classify_set_interface_ip_table {
1592 u32 table_index; /* ~0 => off */
1595 /** \brief Set/unset interface classification table response
1596 @param context - sender context, to match reply w/ request
1597 @param retval - return code
1599 define classify_set_interface_ip_table_reply {
1604 /** \brief Set/unset l2 classification tables for an interface request
1605 @param client_index - opaque cookie to identify the sender
1606 @param context - sender context, to match reply w/ request
1607 @param sw_if_index - interface to set/unset tables for
1608 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1609 @param ip6_table_index - ip6 index
1610 @param other_table_index - other index
1612 define classify_set_interface_l2_tables {
1617 u32 ip4_table_index;
1618 u32 ip6_table_index;
1619 u32 other_table_index;
1622 /** \brief Set/unset l2 classification tables for an interface response
1623 @param context - sender context, to match reply w/ request
1624 @param retval - return code for the request
1626 define classify_set_interface_l2_tables_reply {
1631 /** \brief Get node index using name request
1632 @param client_index - opaque cookie to identify the sender
1633 @param context - sender context, to match reply w/ request
1634 @param node_name[] - name of the node
1636 define get_node_index {
1642 /** \brief Get node index using name request
1643 @param context - sender context, to match reply w/ request
1644 @param retval - return code for the request
1645 @param node_index - index of the desired node if found, else ~0
1647 define get_node_index_reply {
1653 /** \brief Set the next node for a given node request
1654 @param client_index - opaque cookie to identify the sender
1655 @param context - sender context, to match reply w/ request
1656 @param node_name[] - node to add the next node to
1657 @param next_name[] - node to add as the next node
1659 define add_node_next {
1666 /** \brief IP Set the next node for a given node response
1667 @param context - sender context, to match reply w/ request
1668 @param retval - return code for the add next node request
1669 @param next_index - the index of the next node if success, else ~0
1671 define add_node_next_reply {
1677 /** \brief DHCP Proxy config 2 add / del request
1678 @param client_index - opaque cookie to identify the sender
1679 @param context - sender context, to match reply w/ request
1680 @param rx_vrf_id - receive vrf id
1681 @param server_vrf_id - server vrf id
1682 @param if_ipv6 - ipv6 if non-zero, else ipv4
1683 @param is_add - add the config if non-zero, else delete
1684 @param insert_circuit_id - option82 suboption 1 fib number
1685 @param dhcp_server[] - server address
1686 @param dhcp_src_address[] - <fix this, need details>
1688 define dhcp_proxy_config_2 {
1695 u8 insert_circuit_id;
1697 u8 dhcp_src_address[16];
1700 /** \brief DHCP Proxy config 2 add / del response
1701 @param context - sender context, to match reply w/ request
1702 @param retval - return code for request
1704 define dhcp_proxy_config_2_reply {
1709 /** \brief l2tpv3 tunnel interface create request
1710 @param client_index - opaque cookie to identify the sender
1711 @param context - sender context, to match reply w/ request
1712 @param client_address - remote client tunnel ip address
1713 @param client_address - local tunnel ip address
1714 @param is_ipv6 - ipv6 if non-zero, else ipv4
1715 @param local_session_id - local tunnel session id
1716 @param remote_session_id - remote tunnel session id
1717 @param local_cookie - local tunnel cookie
1718 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1719 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1721 define l2tpv3_create_tunnel {
1724 u8 client_address [16];
1725 u8 our_address [16];
1727 u32 local_session_id;
1728 u32 remote_session_id;
1731 u8 l2_sublayer_present;
1735 /** \brief l2tpv3 tunnel interface create response
1736 @param context - sender context, to match reply w/ request
1737 @param retval - return code for the request
1738 @param sw_if_index - index of the new tunnel interface
1740 define l2tpv3_create_tunnel_reply {
1746 define l2tpv3_set_tunnel_cookies {
1750 u64 new_local_cookie;
1751 u64 new_remote_cookie;
1754 /** \brief L2TP tunnel set cookies response
1755 @param context - sender context, to match reply w/ request
1756 @param retval - return code for the request
1758 define l2tpv3_set_tunnel_cookies_reply {
1763 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 {
1853 u32 decap_next_index;
1857 define vxlan_add_del_tunnel_reply {
1863 define vxlan_tunnel_dump {
1869 define vxlan_tunnel_details {
1875 u32 decap_next_index;
1880 define gre_add_del_tunnel {
1890 define gre_add_del_tunnel_reply {
1896 define gre_tunnel_dump {
1902 define gre_tunnel_details {
1911 /** \brief L2 interface vlan tag rewrite configure request
1912 @param client_index - opaque cookie to identify the sender
1913 @param context - sender context, to match reply w/ request
1914 @param sw_if_index - interface the operation is applied to
1915 @param vtr_op - Choose from l2_vtr_op_t enum values
1916 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1917 @param tag1 - Needed for any push or translate vtr op
1918 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1920 define l2_interface_vlan_tag_rewrite {
1925 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1926 u32 tag1; // first pushed tag
1927 u32 tag2; // second pushed tag
1930 /** \brief L2 interface vlan tag rewrite response
1931 @param context - sender context, to match reply w/ request
1932 @param retval - return code for the request
1934 define l2_interface_vlan_tag_rewrite_reply {
1939 /** \brief vhost-user interface create request
1940 @param client_index - opaque cookie to identify the sender
1941 @param is_server - our side is socket server
1942 @param sock_filename - unix socket filename, used to speak with frontend
1943 @param use_custom_mac - enable or disable the use of the provided hardware address
1944 @param mac_address - hardware address to use if 'use_custom_mac' is set
1946 define create_vhost_user_if {
1950 u8 sock_filename[256];
1952 u32 custom_dev_instance;
1957 /** \brief vhost-user interface create response
1958 @param context - sender context, to match reply w/ request
1959 @param retval - return code for the request
1960 @param sw_if_index - interface the operation is applied to
1962 define create_vhost_user_if_reply {
1968 /** \brief vhost-user interface modify request
1969 @param client_index - opaque cookie to identify the sender
1970 @param is_server - our side is socket server
1971 @param sock_filename - unix socket filename, used to speak with frontend
1973 define modify_vhost_user_if {
1978 u8 sock_filename[256];
1980 u32 custom_dev_instance;
1983 /** \brief vhost-user interface modify response
1984 @param context - sender context, to match reply w/ request
1985 @param retval - return code for the request
1987 define modify_vhost_user_if_reply {
1992 /** \brief vhost-user interface delete request
1993 @param client_index - opaque cookie to identify the sender
1995 define delete_vhost_user_if {
2001 /** \brief vhost-user interface delete response
2002 @param context - sender context, to match reply w/ request
2003 @param retval - return code for the request
2005 define delete_vhost_user_if_reply {
2010 define create_subif {
2016 /* These fields map directly onto the subif template */
2020 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2023 u8 outer_vlan_id_any;
2024 u8 inner_vlan_id_any;
2029 define create_subif_reply {
2035 /** \brief show version
2036 @param client_index - opaque cookie to identify the sender
2037 @param context - sender context, to match reply w/ request
2039 define show_version {
2044 /** \brief show version response
2045 @param context - sender context, to match reply w/ request
2046 @param retval - return code for the request
2047 @param program - name of the program (vpe)
2048 @param version - version of the program
2049 @param build_directory - root of the workspace where the program was built
2051 define show_version_reply {
2057 u8 build_directory[256];
2060 /** \brief Vhost-user interface details structure (fix this)
2061 @param sw_if_index - index of the interface
2062 @param interface_name - name of interface
2063 @param virtio_net_hdr_sz - net header size
2064 @param features - interface features
2065 @param is_server - vhost-user server socket
2066 @param sock_filename - socket filename
2067 @param num_regions - number of used memory regions
2069 define sw_interface_vhost_user_details {
2072 u8 interface_name[64];
2073 u32 virtio_net_hdr_sz;
2076 u8 sock_filename[256];
2082 define sw_interface_vhost_user_dump {
2087 define ip_address_details {
2094 define ip_address_dump {
2112 /** \brief l2 fib table entry structure
2113 @param bd_id - the l2 fib / bridge domain table id
2114 @param mac - the entry's mac address
2115 @param sw_if_index - index of the interface
2116 @param static_mac - the entry is statically configured.
2117 @param filter_mac - the entry is a mac filter entry.
2118 @param bvi_mac - the mac address is a bridge virtual interface
2120 define l2_fib_table_entry {
2130 /** \brief Dump l2 fib (aka bridge domain) table
2131 @param client_index - opaque cookie to identify the sender
2132 @param bd_id - the l2 fib / bridge domain table identifier
2134 define l2_fib_table_dump {
2140 define vxlan_gpe_add_del_tunnel {
2153 define vxlan_gpe_add_del_tunnel_reply {
2159 define vxlan_gpe_tunnel_dump {
2165 define vxlan_gpe_tunnel_details {
2177 /** \brief add or delete locator_set
2178 @param client_index - opaque cookie to identify the sender
2179 @param context - sender context, to match reply w/ request
2180 @param is_add - add address if non-zero, else delete
2181 @param locator_set_name - locator name
2182 @param locator_num - number of locators
2183 @param locators - Lisp locator data
2185 define lisp_add_del_locator_set {
2189 u8 locator_set_name[64];
2191 u8 locators[locator_num];
2194 /** \brief Reply for locator_set add/del
2195 @param context - returned sender context, to match reply w/ request
2196 @param retval - return code
2198 define lisp_add_del_locator_set_reply {
2203 /** \brief add or delete locator for locator_set
2204 @param client_index - opaque cookie to identify the sender
2205 @param context - sender context, to match reply w/ request
2206 @param is_add - add address if non-zero, else delete
2207 @param locator_set_name - name of locator_set to add/del locator
2208 @param sw_if_index - index of the interface
2209 @param priority - priority of the lisp locator
2210 @param weight - weight of the lisp locator
2212 define lisp_add_del_locator {
2216 u8 locator_set_name[64];
2222 /** \brief Reply for locator add/del
2223 @param context - returned sender context, to match reply w/ request
2224 @param retval - return code
2226 define lisp_add_del_locator_reply {
2231 /** \brief add or delete lisp eid-table
2232 @param client_index - opaque cookie to identify the sender
2233 @param context - sender context, to match reply w/ request
2234 @param is_add - add address if non-zero, else delete
2239 @param eid - EID can be ip4, ip6 or mac
2240 @param prefix_len - prefix len
2241 @param locator_set_name - name of locator_set to add/del eid-table
2242 @param vni - virtual network instance
2244 define lisp_add_del_local_eid {
2251 u8 locator_set_name[64];
2255 /** \brief Reply for local_eid add/del
2256 @param context - returned sender context, to match reply w/ request
2257 @param retval - return code
2259 define lisp_add_del_local_eid_reply {
2264 /** \brief add or delete lisp gpe maptunel
2265 @param client_index - opaque cookie to identify the sender
2266 @param context - sender context, to match reply w/ request
2267 @param is_add - add address if non-zero, else delete
2268 @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2269 @param eid_ip_address - array of address bytes
2270 @param eid_prefix_len - prefix len
2271 @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2272 @param source_ip_address - array of address bytes
2273 @param destination_ip_address - array of address bytes
2275 define lisp_gpe_add_del_fwd_entry {
2280 u8 eid_ip_address[16];
2283 u8 source_ip_address[16];
2284 u8 destination_ip_address[16];
2287 /** \brief Reply for gpe_fwd_entry add/del
2288 @param context - returned sender context, to match reply w/ request
2289 @param retval - return code
2291 define lisp_gpe_add_del_fwd_entry_reply {
2296 /** \brief add or delete map-resolver
2297 @param client_index - opaque cookie to identify the sender
2298 @param context - sender context, to match reply w/ request
2299 @param is_add - add address if non-zero, else delete
2300 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2301 @param ip_address - array of address bytes
2303 define lisp_add_del_map_resolver {
2311 /** \brief Reply for map_resolver add/del
2312 @param context - returned sender context, to match reply w/ request
2313 @param retval - return code
2315 define lisp_add_del_map_resolver_reply {
2320 /** \brief enable or disable lisp-gpe protocol
2321 @param client_index - opaque cookie to identify the sender
2322 @param context - sender context, to match reply w/ request
2323 @param is_en - enable protocol if non-zero, else disable
2325 define lisp_gpe_enable_disable {
2331 /** \brief Reply for gpe enable/disable
2332 @param context - returned sender context, to match reply w/ request
2333 @param retval - return code
2335 define lisp_gpe_enable_disable_reply {
2340 /** \brief enable or disable LISP feature
2341 @param client_index - opaque cookie to identify the sender
2342 @param context - sender context, to match reply w/ request
2343 @param is_en - enable protocol if non-zero, else disable
2345 define lisp_enable_disable {
2351 /** \brief Reply for gpe enable/disable
2352 @param context - returned sender context, to match reply w/ request
2353 @param retval - return code
2355 define lisp_enable_disable_reply {
2360 /** \brief add or delete gpe_iface
2361 @param client_index - opaque cookie to identify the sender
2362 @param context - sender context, to match reply w/ request
2363 @param is_add - add address if non-zero, else delete
2365 define lisp_gpe_add_del_iface {
2373 /** \brief Reply for gpe_iface add/del
2374 @param context - returned sender context, to match reply w/ request
2375 @param retval - return code
2377 define lisp_gpe_add_del_iface_reply {
2382 /** \brief configure or disable LISP PITR node
2383 @param client_index - opaque cookie to identify the sender
2384 @param context - sender context, to match reply w/ request
2385 @param ls_name - locator set name
2386 @param is_add - add locator set if non-zero, else disable pitr
2388 define lisp_pitr_set_locator_set {
2395 /** \brief Reply for lisp_pitr_set_locator_set
2396 @param context - returned sender context, to match reply w/ request
2397 @param retval - return code
2399 define lisp_pitr_set_locator_set_reply {
2404 /** \brief add or delete remote static mapping
2405 @param client_index - opaque cookie to identify the sender
2406 @param context - sender context, to match reply w/ request
2407 @param is_add - add address if non-zero, else delete
2408 @param del_all - if set, delete all remote mappings
2409 @param vni - virtual network instance
2410 @param action - negative map-reply action
2416 @param rloc_num - number of remote locators
2417 @param rlocs - remote locator data
2419 define lisp_add_del_remote_mapping {
2433 /** \brief Reply for lisp_add_del_remote_mapping
2434 @param context - returned sender context, to match reply w/ request
2435 @param retval - return code
2437 define lisp_add_del_remote_mapping_reply {
2442 /** \brief add or delete LISP adjacency adjacency
2443 @param client_index - opaque cookie to identify the sender
2444 @param context - sender context, to match reply w/ request
2445 @param is_add - add address if non-zero, else delete
2446 @param vni - virtual network instance
2451 @param deid - destination EID
2452 @param seid - source EID
2454 define lisp_add_del_adjacency {
2466 /** \brief Reply for lisp_add_del_adjacency
2467 @param context - returned sender context, to match reply w/ request
2468 @param retval - return code
2470 define lisp_add_del_adjacency_reply {
2475 /** \brief add or delete map request itr rlocs
2476 @param client_index - opaque cookie to identify the sender
2477 @param context - sender context, to match reply w/ request
2478 @param is_add - add address if non-zero, else delete
2479 @param locator_set_name - locator set name
2481 define lisp_add_del_map_request_itr_rlocs {
2485 u8 locator_set_name[64];
2488 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2489 @param context - returned sender context, to match reply w/ request
2490 @param retval - return code
2493 define lisp_add_del_map_request_itr_rlocs_reply {
2498 /** \brief map/unmap vni/bd_index to vrf
2499 @param client_index - opaque cookie to identify the sender
2500 @param context - sender context, to match reply w/ request
2501 @param is_add - add or delete mapping
2502 @param dp_table - virtual network id/bridge domain index
2505 define lisp_eid_table_add_del_map {
2514 /** \brief Reply for lisp_eid_table_add_del_map
2515 @param context - returned sender context, to match reply w/ request
2516 @param retval - return code
2518 define lisp_eid_table_add_del_map_reply {
2523 /** \brief Request for map lisp locator status
2524 @param client_index - opaque cookie to identify the sender
2525 @param context - sender context, to match reply w/ request
2526 @param locator_set_index - index of locator_set
2527 @param filter - filter type;
2533 define lisp_locator_dump {
2536 u32 locator_set_index;
2540 /** \brief LISP locator_set status
2541 @param local - if is set, then locator is local
2542 @param locator_set_name - name of the locator_set
2543 @param sw_if_index - sw_if_index of the locator
2544 @param priority - locator priority
2545 @param weight - locator weight
2547 define lisp_locator_details {
2557 /** \brief LISP locator_set status
2558 @param locator_set_name - name of the locator_set
2559 @param local - if is set, then locator_set is local
2560 @param locator_count - number of locator this stats block includes
2561 @param locator - locator data
2563 define lisp_locator_set_details {
2566 u32 locator_set_index;
2567 u8 locator_set_name[64];
2570 /** \brief Request for locator_set summary status
2571 @param client_index - opaque cookie to identify the sender
2572 @param context - sender context, to match reply w/ request
2573 @param filter - filter type;
2576 1: local locator_set
2577 2: remote locator_set
2579 define lisp_locator_set_dump {
2585 /** \brief Dump lisp eid-table
2586 @param client_index - opaque cookie to identify the sender
2587 @param context - sender context, to match reply w/ request
2588 @param locator_set_index - index of locator_set
2589 @param is_local - local if non-zero, else remote
2594 @param eid - EID can be ip4, ip6 or mac
2595 @param prefix_len - prefix len
2596 @param vni - virtual network instance
2597 @param ttl - time to live
2598 @param authoritative - authoritative
2601 define lisp_eid_table_details {
2603 u32 locator_set_index;
2613 /** \brief Request for eid table summary status
2614 @param client_index - opaque cookie to identify the sender
2615 @param context - sender context, to match reply w/ request
2616 @param eid_set - if non-zero request info about specific mapping
2617 @param vni - virtual network instance; valid only if eid_set != 0
2618 @param prefix_length - prefix length if EID is IP address;
2619 valid only if eid_set != 0
2620 @param eid_type - EID type; valid only if eid_set != 0
2624 2: EID is ethernet address
2625 @param eid - endpoint identifier
2626 @param filter - filter type;
2632 define lisp_eid_table_dump {
2643 /** \brief Shows relationship between vni and vrf
2644 @param vrf - VRF index
2645 @param vni - vitual network instance
2647 define lisp_eid_table_map_details {
2653 /** \brief Request for lisp_eid_table_map_details
2654 @param client_index - opaque cookie to identify the sender
2655 @param context - sender context, to match reply w/ request
2657 define lisp_eid_table_map_dump {
2662 define lisp_gpe_tunnel_details {
2667 u8 destination_ip[16];
2679 /** \brief Request for gpe tunnel summary status
2680 @param client_index - opaque cookie to identify the sender
2681 @param context - sender context, to match reply w/ request
2683 define lisp_gpe_tunnel_dump {
2688 /** \brief LISP map resolver status
2689 @param locator_set_name - name of the locator_set
2690 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2691 @param ip_address - array of address bytes
2693 define lisp_map_resolver_details {
2699 /** \brief Request for map resolver summary status
2700 @param client_index - opaque cookie to identify the sender
2701 @param context - sender context, to match reply w/ request
2703 define lisp_map_resolver_dump {
2708 /** \brief Request for lisp-gpe protocol status
2709 @param client_index - opaque cookie to identify the sender
2710 @param context - sender context, to match reply w/ request
2712 define show_lisp_status{
2717 /** \brief Status of lisp, enable or disable
2718 @param context - sender context, to match reply w/ request
2719 @param feature_status - lisp enable if non-zero, else disable
2720 @param gpe_status - lisp enable if non-zero, else disable
2722 define show_lisp_status_reply{
2729 /** \brief Get LISP map request itr rlocs status
2730 @param context - sender context, to match reply w/ request
2731 @param locator_set_name - name of the locator_set
2733 define lisp_get_map_request_itr_rlocs {
2738 /** \brief Request for map request itr rlocs summary status
2740 define lisp_get_map_request_itr_rlocs_reply {
2743 u8 locator_set_name[64];
2746 /** \brief Request for lisp pitr status
2747 @param client_index - opaque cookie to identify the sender
2748 @param context - sender context, to match reply w/ request
2750 define show_lisp_pitr {
2755 /** \brief Status of lisp pitr, enable or disable
2756 @param context - sender context, to match reply w/ request
2757 @param status - lisp pitr enable if non-zero, else disable
2758 @param locator_set_name - name of the locator_set
2760 define show_lisp_pitr_reply {
2764 u8 locator_set_name[64];
2767 /* Gross kludge, DGMS */
2768 define interface_name_renumber {
2772 u32 new_show_dev_instance;
2775 define interface_name_renumber_reply {
2780 /** \brief Register for ip4 arp resolution events
2781 @param client_index - opaque cookie to identify the sender
2782 @param context - sender context, to match reply w/ request
2783 @param enable_disable - 1 => register for events, 0 => cancel registration
2784 @param pid - sender's pid
2785 @param address - the exact ip4 address of interest
2787 define want_ip4_arp_events {
2795 /** \brief Reply for interface events registration
2796 @param context - returned sender context, to match reply w/ request
2797 @param retval - return code
2799 define want_ip4_arp_events_reply {
2804 /** \brief Tell client about an ip4 arp resolution event
2805 @param client_index - opaque cookie to identify the sender
2806 @param context - sender context, to match reply w/ request
2807 @param address - the exact ip4 address of interest
2808 @param pid - client pid registered to receive notification
2809 @param sw_if_index - interface which received ARP packet
2810 @param new_mac - the new mac address
2812 define ip4_arp_event {
2821 /** \brief L2 bridge domain add or delete request
2822 @param client_index - opaque cookie to identify the sender
2823 @param context - sender context, to match reply w/ request
2824 @param bd_id - the bridge domain to create
2825 @param flood - enable/disable bcast/mcast flooding in the bd
2826 @param uu_flood - enable/disable uknown unicast flood in the bd
2827 @param forward - enable/disable forwarding on all interfaces in the bd
2828 @param learn - enable/disable learning on all interfaces in the bd
2829 @param arp_term - enable/disable arp termination in the bd
2830 @param is_add - add or delete flag
2832 define bridge_domain_add_del {
2844 /** \brief L2 bridge domain add or delete response
2845 @param context - sender context, to match reply w/ request
2846 @param retval - return code for the set bridge flags request
2848 define bridge_domain_add_del_reply {
2853 /** \brief L2 bridge domain request operational state details
2854 @param client_index - opaque cookie to identify the sender
2855 @param context - sender context, to match reply w/ request
2856 @param bd_id - the bridge domain id desired or ~0 to request all bds
2858 define bridge_domain_dump {
2864 /** \brief L2 bridge domain operational state response
2865 @param bd_id - the bridge domain id
2866 @param flood - bcast/mcast flooding state on all interfaces in the bd
2867 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2868 @param forward - forwarding state on all interfaces in the bd
2869 @param learn - learning state on all interfaces in the bd
2870 @param arp_term - arp termination state on all interfaces in the bd
2871 @param n_sw_ifs - number of sw_if_index's in the domain
2873 define bridge_domain_details {
2881 u32 bvi_sw_if_index;
2885 /** \brief L2 bridge domain sw interface operational state response
2886 @param bd_id - the bridge domain id
2887 @param sw_if_index - sw_if_index in the domain
2888 @param shg - split horizon group for the interface
2890 define bridge_domain_sw_if_details {
2897 /** \brief DHCP Client config add / del request
2898 @param client_index - opaque cookie to identify the sender
2899 @param context - sender context, to match reply w/ request
2900 @param sw_if_index - index of the interface for DHCP client
2901 @param hostname - hostname
2902 @param is_add - add the config if non-zero, else delete
2903 @param want_dhcp_event - DHCP event sent to the sender
2904 via dhcp_compl_event API message if non-zero
2905 @param pid - sender's pid
2907 define dhcp_client_config {
2917 /** \brief DHCP Client config response
2918 @param context - sender context, to match reply w/ request
2919 @param retval - return code for the request
2921 define dhcp_client_config_reply {
2926 /** \brief Set/unset input ACL interface
2927 @param client_index - opaque cookie to identify the sender
2928 @param context - sender context, to match reply w/ request
2929 @param sw_if_index - interface to set/unset input ACL
2930 @param ip4_table_index - ip4 classify table index (~0 for skip)
2931 @param ip6_table_index - ip6 classify table index (~0 for skip)
2932 @param l2_table_index - l2 classify table index (~0 for skip)
2933 @param is_add - Set input ACL if non-zero, else unset
2934 Note: User is recommeneded to use just one valid table_index per call.
2935 (ip4_table_index, ip6_table_index, or l2_table_index)
2937 define input_acl_set_interface {
2941 u32 ip4_table_index;
2942 u32 ip6_table_index;
2947 /** \brief Set/unset input ACL interface response
2948 @param context - sender context, to match reply w/ request
2949 @param retval - return code for the request
2951 define input_acl_set_interface_reply {
2956 /** \brief IPsec: Add/delete Security Policy Database
2957 @param client_index - opaque cookie to identify the sender
2958 @param context - sender context, to match reply w/ request
2959 @param is_add - add SPD if non-zero, else delete
2960 @param spd_id - SPD instance id (control plane allocated)
2963 define ipsec_spd_add_del {
2970 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2971 @param context - returned sender context, to match reply w/ request
2972 @param retval - return code
2975 define ipsec_spd_add_del_reply {
2980 /** \brief IPsec: Add/delete SPD from interface
2982 @param client_index - opaque cookie to identify the sender
2983 @param context - sender context, to match reply w/ request
2984 @param is_add - add security mode if non-zero, else delete
2985 @param sw_if_index - index of the interface
2986 @param spd_id - SPD instance id to use for lookups
2990 define ipsec_interface_add_del_spd {
2999 /** \brief Reply for IPsec: Add/delete SPD from interface
3000 @param context - returned sender context, to match reply w/ request
3001 @param retval - return code
3004 define ipsec_interface_add_del_spd_reply {
3009 /** \brief IPsec: Add/delete Security Policy Database entry
3011 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3013 @param client_index - opaque cookie to identify the sender
3014 @param context - sender context, to match reply w/ request
3015 @param is_add - add SPD if non-zero, else delete
3016 @param spd_id - SPD instance id (control plane allocated)
3017 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3018 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3019 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3020 @param remote_address_start - start of remote address range to match
3021 @param remote_address_stop - end of remote address range to match
3022 @param local_address_start - start of local address range to match
3023 @param local_address_stop - end of local address range to match
3024 @param protocol - protocol type to match [0 means any]
3025 @param remote_port_start - start of remote port range to match ...
3026 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3027 @param local_port_start - start of local port range to match ...
3028 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3029 @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)
3030 @param sa_id - SAD instance id (control plane allocated)
3034 define ipsec_spd_add_del_entry {
3046 u8 remote_address_start[16];
3047 u8 remote_address_stop[16];
3048 u8 local_address_start[16];
3049 u8 local_address_stop[16];
3053 u16 remote_port_start;
3054 u16 remote_port_stop;
3055 u16 local_port_start;
3056 u16 local_port_stop;
3063 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3064 @param context - returned sender context, to match reply w/ request
3065 @param retval - return code
3068 define ipsec_spd_add_del_entry_reply {
3073 /** \brief IPsec: Add/delete Security Association Database entry
3074 @param client_index - opaque cookie to identify the sender
3075 @param context - sender context, to match reply w/ request
3076 @param is_add - add SAD entry if non-zero, else delete
3078 @param sad_id - sad id
3080 @param spi - security parameter index
3082 @param protocol - 0 = AH, 1 = ESP
3084 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3085 @param crypto_key_length - length of crypto_key in bytes
3086 @param crypto_key - crypto keying material
3088 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3089 @param integrity_key_length - length of integrity_key in bytes
3090 @param integrity_key - integrity keying material
3092 @param use_extended_sequence_number - use ESN when non-zero
3094 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3095 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3096 @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
3097 @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
3101 IPsec tunnel address copy mode (to support GDOI)
3104 define ipsec_sad_add_del_entry {
3115 u8 crypto_algorithm;
3116 u8 crypto_key_length;
3119 u8 integrity_algorithm;
3120 u8 integrity_key_length;
3121 u8 integrity_key[128];
3123 u8 use_extended_sequence_number;
3127 u8 tunnel_src_address[16];
3128 u8 tunnel_dst_address[16];
3131 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3132 @param context - returned sender context, to match reply w/ request
3133 @param retval - return code
3136 define ipsec_sad_add_del_entry_reply {
3141 /** \brief IPsec: Update Security Association keys
3142 @param client_index - opaque cookie to identify the sender
3143 @param context - sender context, to match reply w/ request
3145 @param sa_id - sa id
3147 @param crypto_key_length - length of crypto_key in bytes
3148 @param crypto_key - crypto keying material
3150 @param integrity_key_length - length of integrity_key in bytes
3151 @param integrity_key - integrity keying material
3154 define ipsec_sa_set_key {
3160 u8 crypto_key_length;
3163 u8 integrity_key_length;
3164 u8 integrity_key[128];
3167 /** \brief Reply for IPsec: Update Security Association keys
3168 @param context - returned sender context, to match reply w/ request
3169 @param retval - return code
3172 define ipsec_sa_set_key_reply {
3177 /** \brief IKEv2: Add/delete profile
3178 @param client_index - opaque cookie to identify the sender
3179 @param context - sender context, to match reply w/ request
3181 @param name - IKEv2 profile name
3182 @param is_add - Add IKEv2 profile if non-zero, else delete
3184 define ikev2_profile_add_del {
3192 /** \brief Reply for IKEv2: Add/delete profile
3193 @param context - returned sender context, to match reply w/ request
3194 @param retval - return code
3196 define ikev2_profile_add_del_reply {
3201 /** \brief IKEv2: Set IKEv2 profile authentication method
3202 @param client_index - opaque cookie to identify the sender
3203 @param context - sender context, to match reply w/ request
3205 @param name - IKEv2 profile name
3206 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3207 @param is_hex - Authentication data in hex format if non-zero, else string
3208 @param data_len - Authentication data length
3209 @param data - Authentication data (for rsa-sig cert file path)
3211 define ikev2_profile_set_auth {
3222 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3223 @param context - returned sender context, to match reply w/ request
3224 @param retval - return code
3226 define ikev2_profile_set_auth_reply {
3231 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3232 @param client_index - opaque cookie to identify the sender
3233 @param context - sender context, to match reply w/ request
3235 @param name - IKEv2 profile name
3236 @param is_local - Identification is local if non-zero, else remote
3237 @param id_type - Identification type
3238 @param data_len - Identification data length
3239 @param data - Identification data
3241 define ikev2_profile_set_id {
3252 /** \brief Reply for IKEv2:
3253 @param context - returned sender context, to match reply w/ request
3254 @param retval - return code
3256 define ikev2_profile_set_id_reply {
3261 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3262 @param client_index - opaque cookie to identify the sender
3263 @param context - sender context, to match reply w/ request
3265 @param name - IKEv2 profile name
3266 @param is_local - Traffic selector is local if non-zero, else remote
3267 @param proto - Traffic selector IP protocol (if zero not relevant)
3268 @param start_port - The smallest port number allowed by traffic selector
3269 @param end_port - The largest port number allowed by traffic selector
3270 @param start_addr - The smallest address included in traffic selector
3271 @param end_addr - The largest address included in traffic selector
3273 define ikev2_profile_set_ts {
3286 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3287 @param context - returned sender context, to match reply w/ request
3288 @param retval - return code
3290 define ikev2_profile_set_ts_reply {
3295 /** \brief IKEv2: Set IKEv2 local RSA private key
3296 @param client_index - opaque cookie to identify the sender
3297 @param context - sender context, to match reply w/ request
3299 @param key_file - Key file absolute path
3301 define ikev2_set_local_key {
3308 /** \brief Reply for IKEv2: Set IKEv2 local key
3309 @param context - returned sender context, to match reply w/ request
3310 @param retval - return code
3312 define ikev2_set_local_key_reply {
3317 /** \brief Tell client about a DHCP completion event
3318 @param client_index - opaque cookie to identify the sender
3319 @param pid - client pid registered to receive notification
3320 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3321 @param host_address - Host IP address
3322 @param router_address - Router IP address
3323 @param host_mac - Host MAC address
3325 define dhcp_compl_event {
3330 u8 host_address[16];
3331 u8 router_address[16];
3335 /** \brief Add MAP domains
3336 @param client_index - opaque cookie to identify the sender
3337 @param context - sender context, to match reply w/ request
3338 @param ip6_prefix - Rule IPv6 prefix
3339 @param ip4_prefix - Rule IPv4 prefix
3340 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3341 @param ip6_prefix_len - Rule IPv6 prefix length
3342 @param ip4_prefix_len - Rule IPv4 prefix length
3343 @param ea_bits_len - Embedded Address bits length
3344 @param psid_offset - Port Set Identifider (PSID) offset
3345 @param psid_length - PSID length
3346 @param is_translation - MAP-E / MAP-T
3349 define map_add_domain {
3357 u8 ip6_src_prefix_len;
3365 /** \brief Reply for MAP domain add
3366 @param context - returned sender context, to match reply w/ request
3367 @param index - MAP domain index
3368 @param retval - return code
3370 define map_add_domain_reply {
3376 /** \brief Delete MAP domain
3377 @param client_index - opaque cookie to identify the sender
3378 @param context - sender context, to match reply w/ request
3379 @param index - MAP Domain index
3381 define map_del_domain {
3387 /** \brief Reply for MAP domain del
3388 @param context - returned sender context, to match reply w/ request
3389 @param retval - return code
3391 define map_del_domain_reply {
3396 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3397 @param client_index - opaque cookie to identify the sender
3398 @param context - sender context, to match reply w/ request
3399 @param index - MAP Domain index
3400 @param is_add - If 1 add rule, if 0 delete rule
3401 @param ip6_dst - MAP CE IPv6 address
3402 @param psid - Rule PSID
3404 define map_add_del_rule {
3413 /** \brief Reply for MAP rule add/del
3414 @param context - returned sender context, to match reply w/ request
3415 @param retval - return code
3417 define map_add_del_rule_reply {
3422 /** \brief Get list of map domains
3423 @param client_index - opaque cookie to identify the sender
3425 define map_domain_dump {
3430 define map_domain_details {
3447 define map_rule_dump {
3453 define map_rule_details {
3459 /** \brief Request for a single block of summary stats
3460 @param client_index - opaque cookie to identify the sender
3461 @param context - sender context, to match reply w/ request
3463 define map_summary_stats {
3468 /** \brief Reply for map_summary_stats request
3469 @param context - sender context, to match reply w/ request
3470 @param retval - return code for request
3471 @param total_bindings -
3473 @param total_ip4_fragments -
3474 @param total_security_check -
3476 define map_summary_stats_reply {
3482 u64 total_ip4_fragments;
3483 u64 total_security_check[2];
3486 /** \brief cop: enable/disable junk filtration features on an interface
3487 @param client_index - opaque cookie to identify the sender
3488 @param context - sender context, to match reply w/ request
3489 @param sw_if_inded - desired interface
3490 @param enable_disable - 1 => enable, 0 => disable
3493 define cop_interface_enable_disable {
3500 /** \brief cop: interface enable/disable junk filtration reply
3501 @param context - returned sender context, to match reply w/ request
3502 @param retval - return code
3505 define cop_interface_enable_disable_reply {
3510 /** \brief cop: enable/disable whitelist filtration features on an interface
3511 Note: the supplied fib_id must match in order to remove the feature!
3513 @param client_index - opaque cookie to identify the sender
3514 @param context - sender context, to match reply w/ request
3515 @param sw_if_index - interface handle, physical interfaces only
3516 @param fib_id - fib identifier for the whitelist / blacklist fib
3517 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3518 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3519 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3522 define cop_whitelist_enable_disable {
3532 /** \brief cop: interface enable/disable junk filtration reply
3533 @param context - returned sender context, to match reply w/ request
3534 @param retval - return code
3537 define cop_whitelist_enable_disable_reply {
3542 /** \brief get_node_graph - get a copy of the vpp node graph
3543 including the current set of graph arcs.
3545 @param client_index - opaque cookie to identify the sender
3546 @param context - sender context, to match reply w/ request
3549 define get_node_graph {
3554 /** \brief get_node_graph_reply
3555 @param context - returned sender context, to match reply w/ request
3556 @param retval - return code
3557 @param reply_in_shmem - result from vlib_node_serialize, in shared
3558 memory. Process with vlib_node_unserialize, remember to switch
3559 heaps and free the result.
3562 define get_node_graph_reply {
3568 /** \brief Clear interface statistics
3569 @param client_index - opaque cookie to identify the sender
3570 @param context - sender context, to match reply w/ request
3571 @param sw_if_index - index of the interface to clear statistics
3573 define sw_interface_clear_stats {
3579 /** \brief Reply to sw_interface_clear_stats
3580 @param context - sender context which was passed in the request
3581 @param retval - return code of the set flags request
3583 define sw_interface_clear_stats_reply {
3588 /** \brief IOAM Trace : Set TRACE profile
3589 @param id - profile id
3590 @param trace_type - Trace type
3591 @param trace_num_elt - Number of nodes in trace path
3592 @param trace_ppc - Trace PPC (none/encap/decap)
3593 @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3594 @param trace_app_data - Trace application data, can be any 4 bytes
3595 @param pow_enable - Proof of Work enabled or not flag
3596 @param node_id - Id of this node
3598 define trace_profile_add {
3611 /** \brief Trace profile add / del response
3612 @param context - sender context, to match reply w/ request
3613 @param retval - return value for request
3615 define trace_profile_add_reply {
3620 /** \brief IOAM Trace enable trace profile for a flow
3621 @param id - id of the trace profile to be applied
3622 @param dest_ipv6 - Destination IPv6 address
3623 @param prefix_length - prefix mask
3624 @param vrf_id - VRF ID
3625 @param trace_op - Trace operation (add/mod/del)
3626 @param enable - apply/remove the trace profile for the flow
3628 define trace_profile_apply {
3639 /** \brief Trace profile apply response
3640 @param context - sender context, to match reply w/ request
3641 @param retval - return value for request
3643 define trace_profile_apply_reply {
3648 /** \brief Delete Trace Profile
3649 @param client_index - opaque cookie to identify the sender
3650 @param context - sender context, to match reply w/ request
3651 @param index - MAP Domain index
3653 define trace_profile_del {
3659 /** \brief Trace profile add / del response
3660 @param context - sender context, to match reply w/ request
3661 @param retval - return value for request
3663 define trace_profile_del_reply {
3668 /** \brief Create host-interface
3669 @param client_index - opaque cookie to identify the sender
3670 @param context - sender context, to match reply w/ request
3671 @param host_if_name - interface name
3672 @param hw_addr - interface MAC
3673 @param use_random_hw_addr - use random generated MAC
3675 define af_packet_create {
3679 u8 host_if_name[64];
3681 u8 use_random_hw_addr;
3684 /** \brief Create host-interface response
3685 @param context - sender context, to match reply w/ request
3686 @param retval - return value for request
3688 define af_packet_create_reply {
3694 /** \brief Delete host-interface
3695 @param client_index - opaque cookie to identify the sender
3696 @param context - sender context, to match reply w/ request
3697 @param host_if_name - interface name
3699 define af_packet_delete {
3703 u8 host_if_name[64];
3706 /** \brief Delete host-interface response
3707 @param context - sender context, to match reply w/ request
3708 @param retval - return value for request
3710 define af_packet_delete_reply {
3715 /** \brief Add/del policer
3716 @param client_index - opaque cookie to identify the sender
3717 @param context - sender context, to match reply w/ request
3718 @param is_add - add policer if non-zero, else delete
3719 @param name - policer name
3722 @param cb - Committed Burst
3723 @param eb - Excess or Peak Burst
3724 @param rate_type - rate type
3725 @param round_type - rounding type
3726 @param type - policer algorithm
3727 @param color_aware - 0=color-blind, 1=color-aware
3728 @param conform_action_type - conform action type
3729 @param conform_dscp - DSCP for conform mar-and-transmit action
3730 @param exceed_action_type - exceed action type
3731 @param exceed_dscp - DSCP for exceed mar-and-transmit action
3732 @param violate_action_type - violate action type
3733 @param violate_dscp - DSCP for violate mar-and-transmit action
3735 define policer_add_del {
3749 u8 conform_action_type;
3751 u8 exceed_action_type;
3753 u8 violate_action_type;
3757 /** \brief Add/del policer response
3758 @param context - sender context, to match reply w/ request
3759 @param retval - return value for request
3760 @param policer_index - for add, returned index of the new policer
3762 define policer_add_del_reply {
3768 /** \brief Get list of policers
3769 @param client_index - opaque cookie to identify the sender
3770 @param context - sender context, to match reply w/ request
3771 @param match_name_valid - if 0 request all policers otherwise use match_name
3772 @param match_name - policer name
3774 define policer_dump {
3778 u8 match_name_valid;
3782 /** \brief Policer operational state response.
3783 @param context - sender context, to match reply w/ request
3784 @param name - policer name
3787 @param cb - Committed Burst
3788 @param eb - Excess or Peak Burst
3789 @param rate_type - rate type
3790 @param round_type - rounding type
3791 @param type - policer algorithm
3792 @param conform_action_type - conform action type
3793 @param conform_dscp - DSCP for conform mar-and-transmit action
3794 @param exceed_action_type - exceed action type
3795 @param exceed_dscp - DSCP for exceed mar-and-transmit action
3796 @param violate_action_type - violate action type
3797 @param violate_dscp - DSCP for violate mar-and-transmit action
3798 @param single_rate - 1 = single rate policer, 0 = two rate policer
3799 @param color_aware - for hierarchical policing
3800 @param scale - power-of-2 shift amount for lower rates
3801 @param cir_tokens_per_period - number of tokens for each period
3802 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
3803 @param current_limit - current limit
3804 @param current_bucket - current bucket
3805 @param extended_limit - extended limit
3806 @param extended_bucket - extended bucket
3807 @param last_update_time - last update time
3809 define policer_details {
3820 u8 conform_action_type;
3822 u8 exceed_action_type;
3824 u8 violate_action_type;
3829 u32 cir_tokens_per_period;
3830 u32 pir_tokens_per_period;
3834 u32 extended_bucket;
3835 u64 last_update_time;
3838 /** \brief Set/unset policer classify interface
3839 @param client_index - opaque cookie to identify the sender
3840 @param context - sender context, to match reply w/ request
3841 @param sw_if_index - interface to set/unset policer classify
3842 @param ip4_table_index - ip4 classify table index (~0 for skip)
3843 @param ip6_table_index - ip6 classify table index (~0 for skip)
3844 @param l2_table_index - l2 classify table index (~0 for skip)
3845 @param is_add - Set if non-zero, else unset
3846 Note: User is recommeneded to use just one valid table_index per call.
3847 (ip4_table_index, ip6_table_index, or l2_table_index)
3849 define policer_classify_set_interface {
3853 u32 ip4_table_index;
3854 u32 ip6_table_index;
3859 /** \brief Set/unset policer classify interface response
3860 @param context - sender context, to match reply w/ request
3861 @param retval - return value for request
3863 define policer_classify_set_interface_reply {
3868 /** \brief Get list of policer classify interfaces and tables
3869 @param client_index - opaque cookie to identify the sender
3870 @param context - sender context, to match reply w/ request
3871 @param type - classify table type
3873 define policer_classify_dump {
3879 /** \brief Policer iclassify operational state response.
3880 @param context - sender context, to match reply w/ request
3881 @param sw_if_index - software interface index
3882 @param table_index - classify table index
3884 define policer_classify_details {
3890 /** \brief Create netmap
3891 @param client_index - opaque cookie to identify the sender
3892 @param context - sender context, to match reply w/ request
3893 @param netmap_if_name - interface name
3894 @param hw_addr - interface MAC
3895 @param use_random_hw_addr - use random generated MAC
3896 @param is_pipe - is pipe
3897 @param is_master - 0=slave, 1=master
3899 define netmap_create {
3903 u8 netmap_if_name[64];
3905 u8 use_random_hw_addr;
3910 /** \brief Create netmap response
3911 @param context - sender context, to match reply w/ request
3912 @param retval - return value for request
3914 define netmap_create_reply {
3919 /** \brief Delete netmap
3920 @param client_index - opaque cookie to identify the sender
3921 @param context - sender context, to match reply w/ request
3922 @param netmap_if_name - interface name
3924 define netmap_delete {
3928 u8 netmap_if_name[64];
3931 /** \brief Delete netmap response
3932 @param context - sender context, to match reply w/ request
3933 @param retval - return value for request
3935 define netmap_delete_reply {
3940 /** \brief Dump mpls gre tunnel table
3941 @param client_index - opaque cookie to identify the sender
3942 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
3944 define mpls_gre_tunnel_dump {
3950 /** \brief mpls gre tunnel operational state response
3951 @param tunnel_index - gre tunnel identifier
3952 @param intfc_address - interface ipv4 addr
3953 @param mask_width - interface ipv4 addr mask
3954 @param hw_if_index - interface id
3956 @param tunnel_src - tunnel source ipv4 addr
3957 @param tunnel_dst - tunnel destination ipv4 addr
3958 @param outer_fib_index - gre tunnel identifier
3959 @param encap_index - reference to mpls label table
3960 @param nlabels - number of resolved labels
3961 @param labels - resolved labels
3963 define mpls_gre_tunnel_details {
3968 u32 inner_fib_index;
3975 u32 outer_fib_index;
3980 /** \brief Dump mpls eth tunnel table
3981 @param client_index - opaque cookie to identify the sender
3982 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
3984 define mpls_eth_tunnel_dump {
3990 /** \brief mpls eth tunnel operational state response
3991 @param tunnel_index - eth tunnel identifier
3992 @param intfc_address - interface ipv4 addr
3993 @param mask_width - interface ipv4 addr mask
3994 @param hw_if_index - interface id
3996 @param tunnel_dst_mac -
3997 @param tx_sw_if_index -
3998 @param encap_index - reference to mpls label table
3999 @param nlabels - number of resolved labels
4000 @param labels - resolved labels
4002 define mpls_eth_tunnel_details {
4007 u32 inner_fib_index;
4012 u8 tunnel_dst_mac[6];
4018 /** \brief Dump mpls fib table
4019 @param client_index - opaque cookie to identify the sender
4020 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4022 define mpls_fib_encap_dump {
4027 /** \brief mpls fib encap table response
4028 @param fib_index - fib table id
4029 @param dest - destination ipv4 addr
4031 @param entry_index - reference to mpls label table
4032 @param nlabels - number of resolved labels
4033 @param labels - resolved labels
4035 define mpls_fib_encap_details {
4046 /** \brief Dump mpls fib decap table
4047 @param client_index - opaque cookie to identify the sender
4048 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4050 define mpls_fib_decap_dump {
4055 /** \brief mpls fib decap table response
4056 @param fib_index - fib table id
4057 @param entry_index - reference to mpls label table
4058 @param dest - destination ipv4 addr
4060 @param label - mpls labels
4061 @param rx_table_id - rx fib id
4062 @param tx_table_id - tx fib id
4065 define mpls_fib_decap_details {
4078 /** \brief Classify get table IDs request
4079 @param client_index - opaque cookie to identify the sender
4080 @param context - sender context, to match reply w/ request
4082 define classify_table_ids {
4087 /** \brief Reply for classify get table IDs request
4088 @param context - sender context which was passed in the request
4089 @param count - number of ids returned in response
4090 @param ids - array of classify table ids
4092 define classify_table_ids_reply {
4099 /** \brief Classify table ids by interface index request
4100 @param client_index - opaque cookie to identify the sender
4101 @param context - sender context, to match reply w/ request
4102 @param sw_if_index - index of the interface
4104 define classify_table_by_interface {
4110 /** \brief Reply for classify table id by interface index request
4111 @param context - sender context which was passed in the request
4112 @param count - number of ids returned in response
4113 @param sw_if_index - index of the interface
4114 @param l2_table_id - l2 classify table index
4115 @param ip4_table_id - ip4 classify table index
4116 @param ip6_table_id - ip6 classify table index
4118 define classify_table_by_interface_reply {
4127 /** \brief Classify table info
4128 @param client_index - opaque cookie to identify the sender
4129 @param context - sender context, to match reply w/ request
4130 @param table_id - classify table index
4132 define classify_table_info {
4138 /** \brief Reply for classify table info request
4139 @param context - sender context which was passed in the request
4140 @param count - number of ids returned in response
4141 @param table_id - classify table index
4142 @param nbuckets - number of buckets when adding a table
4143 @param match_n_vectors - number of match vectors
4144 @param skip_n_vectors - number of skip_n_vectors
4145 @param active_sessions - number of sessions (active entries)
4146 @param next_table_index - index of next table
4147 @param miss_next_index - index of miss table
4148 @param mask[] - match mask
4150 define classify_table_info_reply {
4155 u32 match_n_vectors;
4157 u32 active_sessions;
4158 u32 next_table_index;
4159 u32 miss_next_index;
4161 u8 mask[mask_length];
4164 /** \brief Classify sessions dump request
4165 @param client_index - opaque cookie to identify the sender
4166 @param context - sender context, to match reply w/ request
4167 @param table_id - classify table index
4169 define classify_session_dump {
4175 /** \brief Reply for classify table session dump request
4176 @param context - sender context which was passed in the request
4177 @param count - number of ids returned in response
4178 @param table_id - classify table index
4179 @param hit_next_index - hit_next_index of session
4180 @param opaque_index - for add, opaque_index of session
4181 @param advance - advance value of session
4182 @param match[] - match value for session
4184 define classify_session_details {
4192 u8 match[match_length];
4195 /** \brief Enable and configure IPFIX exporter process request
4196 @param client_index - opaque cookie to identify the sender
4197 @param context - sender context, to match reply w/ request
4198 @param collector_address - address of IPFIX collector
4199 @param collector_port - port of IPFIX IPFIX collector
4200 @param src_address - address of IPFIX exporter
4201 @param vrf_id - VRF / fib table ID
4202 @param path_mtu - Path MTU between exporter and collector
4203 @param template_interval - number of seconds after which to resend template
4205 define ipfix_enable {
4208 u8 collector_address[16];
4213 u32 template_interval;
4216 /** \brief Reply to IPFIX enable and configure request
4217 @param context - sender context which was passed in the request
4219 define ipfix_enable_reply {
4224 /** \brief IPFIX dump request
4225 @param client_index - opaque cookie to identify the sender
4226 @param context - sender context, to match reply w/ request
4233 /** \brief Reply to IPFIX dump request
4234 @param context - sender context which was passed in the request
4235 @param collector_address - address of IPFIX collector
4236 @param collector_port - port of IPFIX IPFIX collector
4237 @param src_address - address of IPFIX exporter
4238 @param fib_index - fib table index
4239 @param path_mtu - Path MTU between exporter and collector
4240 @param template_interval - number of seconds after which to resend template
4242 define ipfix_details {
4244 u8 collector_address[16];
4249 u32 template_interval;
4252 /** \brief Query relative index via node names
4253 @param client_index - opaque cookie to identify the sender
4254 @param context - sender context, to match reply w/ request
4255 @param node_name - name of node to find relative index from
4256 @param next_name - next node from node_name to find relative index of
4258 define get_next_index {
4265 /** \brief Reply for get next node index
4266 @param context - sender context which was passed in the request
4267 @param retval - return value
4268 @param next_index - index of the next_node
4270 define get_next_index_reply {
4276 /** \brief PacketGenerator create interface request
4277 @param client_index - opaque cookie to identify the sender
4278 @param context - sender context, to match reply w/ request
4279 @param interface_id - interface index
4281 define pg_create_interface {
4287 /** \brief PacketGenerator create interface response
4288 @param context - sender context, to match reply w/ request
4289 @param retval - return value for request
4291 define pg_create_interface_reply {
4297 /** \brief PacketGenerator capture packets on given interface request
4298 @param client_index - opaque cookie to identify the sender
4299 @param context - sender context, to match reply w/ request
4300 @param interface_id - pg interface index
4301 @param is_enabled - 1 if enabling streams, 0 if disabling
4302 @param count - number of packets to be captured
4303 @param pcap_file - pacp file name to store captured packets
4311 u32 pcap_name_length;
4312 u8 pcap_file_name[pcap_name_length];
4315 /** \brief PacketGenerator capture packets response
4316 @param context - sender context, to match reply w/ request
4317 @param retval - return value for request
4319 define pg_capture_reply {
4324 /** \brief Enable / disable packet generator request
4325 @param client_index - opaque cookie to identify the sender
4326 @param context - sender context, to match reply w/ request
4327 @param is_enabled - 1 if enabling streams, 0 if disabling
4328 @param stream - stream name to be enable/disabled, if not specified handle all streams
4330 define pg_enable_disable {
4334 u32 stream_name_length;
4335 u8 stream_name[stream_name_length];
4338 /** \brief Reply for enable / disable packet generator
4339 @param context - returned sender context, to match reply w/ request
4340 @param retval - return code
4342 define pg_enable_disable_reply {
4347 /** \brief Configure IP source and L4 port-range check
4348 @param client_index - opaque cookie to identify the sender
4349 @param context - sender context, to match reply w/ request
4350 @param is_ip6 - 1 if source address type is IPv6
4351 @param is_add - 1 if add, 0 if delete
4352 @param mask_length - mask length for address entry
4353 @param address - array of address bytes
4354 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
4355 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
4356 @param vrf_id - fib table/vrf id to associate the source and port-range check with
4357 @note To specify a single port set low_port and high_port entry the same
4359 define ip_source_and_port_range_check_add_del {
4366 u8 number_of_ranges;
4372 /** \brief Configure IP source and L4 port-range check reply
4373 @param context - returned sender context, to match reply w/ request
4374 @param retval - return code
4376 define ip_source_and_port_range_check_add_del_reply {
4381 /** \brief Set interface source and L4 port-range request
4382 @param client_index - opaque cookie to identify the sender
4383 @param context - sender context, to match reply w/ request
4384 @param interface_id - interface index
4385 @param vrf_id - VRF associated with source and L4 port-range check
4387 define ip_source_and_port_range_check_interface_add_del {
4395 /** \brief Set interface source and L4 port-range response
4396 @param context - sender context, to match reply w/ request
4397 @param retval - return value for request
4399 define ip_source_and_port_range_check_interface_add_del_reply {