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 Process a vpe parser cli string request
1077 @param client_index - opaque cookie to identify the sender
1078 @param context - sender context, to match reply w/ request
1079 @param cmd_in_shmem - pointer to cli command string
1081 define cli_request {
1087 /** \brief vpe parser cli string response
1088 @param context - sender context, to match reply w/ request
1089 @param retval - return code for request
1090 @param reply_in_shmem - Reply string from cli processing if any
1098 /** \brief Set max allowed ARP or ip6 neighbor entries request
1099 @param client_index - opaque cookie to identify the sender
1100 @param context - sender context, to match reply w/ request
1101 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1102 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1104 define set_arp_neighbor_limit {
1108 u32 arp_neighbor_limit;
1111 /** \brief Set max allowed ARP or ip6 neighbor entries response
1112 @param context - sender context, to match reply w/ request
1113 @param retval - return code for request
1115 define set_arp_neighbor_limit_reply {
1120 /** \brief L2 interface patch add / del request
1121 @param client_index - opaque cookie to identify the sender
1122 @param context - sender context, to match reply w/ request
1123 @param rx_sw_if_index - receive side interface
1124 @param tx_sw_if_index - transmit side interface
1125 @param is_add - if non-zero set up the interface patch, else remove it
1127 define l2_patch_add_del {
1135 /** \brief L2 interface patch add / del response
1136 @param context - sender context, to match reply w/ request
1137 @param retval - return code for the request
1139 define l2_patch_add_del_reply {
1144 /** \brief IPv6 segment routing tunnel add / del request
1145 @param client_index - opaque cookie to identify the sender
1146 @param context - sender context, to match reply w/ request
1147 @param is_add - add the tunnel if non-zero, else delete it
1148 @param name[] - tunnel name (len. 64)
1149 @param src_address[] -
1150 @param dst_address[] -
1151 @param dst_mask_width -
1152 @param inner_vrf_id -
1153 @param outer_vrf_id -
1154 @param flags_net_byte_order -
1157 @param segs_and_tags[] -
1158 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1160 define sr_tunnel_add_del {
1170 u16 flags_net_byte_order;
1173 u8 segs_and_tags[0];
1177 /** \brief IPv6 segment routing tunnel add / del response
1178 @param context - sender context, to match reply w/ request
1179 @param retval - return value for request
1181 define sr_tunnel_add_del_reply {
1186 /** \brief IPv6 segment routing policy add / del request
1187 @param client_index - opaque cookie to identify the sender
1188 @param context - sender context, to match reply w/ request
1189 @param is_add - add the tunnel if non-zero, else delete it
1190 @param name[] - policy name (len. 64)
1191 @param tunnel_names[] -
1193 define sr_policy_add_del {
1201 /** \brief IPv6 segment routing policy add / del response
1202 @param context - sender context, to match reply w/ request
1203 @param retval - return value for request
1205 define sr_policy_add_del_reply {
1210 /** \brief IPv6 segment routing multicast map to policy add / del request
1211 @param client_index - opaque cookie to identify the sender
1212 @param context - sender context, to match reply w/ request
1213 @param is_add - add the tunnel if non-zero, else delete it
1214 @param multicast_address[] - IP6 multicast address
1215 @param policy_name[] = policy name (len.64)
1217 define sr_multicast_map_add_del {
1221 u8 multicast_address[16];
1225 /** \brief IPv6 segment routing multicast map to policy add / del response
1226 @param context - sender context, to match reply w/ request
1227 @param retval - return value for request
1229 define sr_multicast_map_add_del_reply {
1234 /** \brief Interface set vpath request
1235 @param client_index - opaque cookie to identify the sender
1236 @param context - sender context, to match reply w/ request
1237 @param sw_if_index - interface used to reach neighbor
1238 @param enable - if non-zero enable, else disable
1240 define sw_interface_set_vpath {
1247 /** \brief Interface set vpath response
1248 @param context - sender context, to match reply w/ request
1249 @param retval - return code for the request
1251 define sw_interface_set_vpath_reply {
1256 /** \brief MPLS Ethernet add / del tunnel request
1257 @param client_index - opaque cookie to identify the sender
1258 @param context - sender context, to match reply w/ request
1259 @param vrf_id - vrf_id, only for IP4
1260 @param sw_if_index - interface used to reach neighbor
1261 @param is_add - add if set, tunnel delete if 0
1262 @param dst_mac_address -
1263 @param adj_address -
1264 @param adj_address_length -
1266 define mpls_ethernet_add_del_tunnel {
1273 u8 dst_mac_address[6];
1275 u8 adj_address_length;
1278 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1279 @param context - sender context, to match reply w/ request
1280 @param retval - return code for the request
1282 define mpls_ethernet_add_del_tunnel_reply {
1285 u32 tunnel_sw_if_index;
1287 /** \brief MPLS Ethernet add/ del tunnel 2
1288 @param client_index - opaque cookie to identify the sender
1289 @param context - sender context, to match reply w/ request
1290 @param inner_vrf_id -
1291 @param outer_vrf_id -
1292 @param resolve_attempts -
1293 @param resolve_opaque -
1294 @param resolve_if_needed -
1296 @param adj_address -
1297 @param adj_address_length -
1298 @param next_hop_ip4_address_in_outer_vrf -
1300 define mpls_ethernet_add_del_tunnel_2 {
1305 u32 resolve_attempts;
1306 u32 resolve_opaque; /* no need to set this */
1307 u8 resolve_if_needed;
1311 u8 adj_address_length;
1312 u8 next_hop_ip4_address_in_outer_vrf [4];
1315 /** \brief MPLS Ethernet add/ del tunnel 2
1316 @param context - sender context, to match reply w/ request
1317 @param retval - return code for add /del request
1319 define mpls_ethernet_add_del_tunnel_2_reply {
1324 /** \brief Set L2 XConnect between two interfaces request
1325 @param client_index - opaque cookie to identify the sender
1326 @param context - sender context, to match reply w/ request
1327 @param rx_sw_if_index - Receive interface index
1328 @param tx_sw_if_index - Transmit interface index
1329 @param enable - enable xconnect if not 0, else set to L3 mode
1331 define sw_interface_set_l2_xconnect {
1339 /** \brief Set L2 XConnect response
1340 @param context - sender context, to match reply w/ request
1341 @param retval - L2 XConnect request return code
1343 define sw_interface_set_l2_xconnect_reply {
1348 /** \brief Interface bridge mode request
1349 @param client_index - opaque cookie to identify the sender
1350 @param context - sender context, to match reply w/ request
1351 @param rx_sw_if_index - the interface
1352 @param bd_id - bridge domain id
1353 @param bvi - Setup interface as a bvi, bridge mode only
1354 @param shg - Shared horizon group, for bridge mode only
1355 @param enable - Enable beige mode if not 0, else set to L3 mode
1357 define sw_interface_set_l2_bridge {
1367 /** \brief Interface bridge mode response
1368 @param context - sender context, to match reply w/ request
1369 @param retval - Bridge mode request return code
1371 define sw_interface_set_l2_bridge_reply {
1376 /** \brief L2 FIB add entry request
1377 @param client_index - opaque cookie to identify the sender
1378 @param context - sender context, to match reply w/ request
1379 @param mac - the entry's mac address
1380 @param bd_id - the entry's bridge domain id
1381 @param sw_if_index - the interface
1382 @param is_add - If non zero add the entry, else delete it
1386 define l2fib_add_del {
1398 /** \brief L2 FIB add entry response
1399 @param context - sender context, to match reply w/ request
1400 @param retval - return code for the add l2fib entry request
1402 define l2fib_add_del_reply {
1407 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1408 @param client_index - opaque cookie to identify the sender
1409 @param context - sender context, to match reply w/ request
1410 @param sw_if_index - interface
1411 @param is_set - if non-zero, set the bits, else clear them
1412 @param feature_bitmap - non-zero bits to set or clear
1422 /** \brief Set L2 bits response
1423 @param context - sender context, to match reply w/ request
1424 @param retval - return code for the set l2 bits request
1426 define l2_flags_reply {
1429 u32 resulting_feature_bitmap;
1432 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1433 L2_UU_FLOOD, or L2_ARP_TERM) request
1434 @param client_index - opaque cookie to identify the sender
1435 @param context - sender context, to match reply w/ request
1436 @param bd_id - the bridge domain to set the flags for
1437 @param is_set - if non-zero, set the flags, else clear them
1438 @param feature_bitmap - bits that are non-zero to set or clear
1440 define bridge_flags {
1448 /** \brief Set bridge flags response
1449 @param context - sender context, to match reply w/ request
1450 @param retval - return code for the set bridge flags request
1451 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1453 define bridge_flags_reply {
1456 u32 resulting_feature_bitmap;
1459 /** \brief Set bridge domain ip to mac entry request
1460 @param client_index - opaque cookie to identify the sender
1461 @param context - sender context, to match reply w/ request
1462 @param bd_id - the bridge domain to set the flags for
1463 @param is_add - if non-zero, add the entry, else clear it
1464 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1465 @param mac_address - MAC address
1468 define bd_ip_mac_add_del {
1478 /** \brief Set bridge domain ip to mac entry response
1479 @param context - sender context, to match reply w/ request
1480 @param retval - return code for the set bridge flags request
1482 define bd_ip_mac_add_del_reply {
1487 /** \brief Add/Delete classification table request
1488 @param client_index - opaque cookie to identify the sender
1489 @param context - sender context, to match reply w/ request
1490 @param is_add- if non-zero add the table, else delete it
1491 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1492 @param nbuckets - number of buckets when adding a table
1493 @param memory_size - memory size when adding a table
1494 @param match_n_vectors - number of match vectors
1495 @param next_table_index - index of next table
1496 @param miss_next_index - index of miss table
1497 @param mask[] - match mask
1499 define classify_add_del_table {
1507 u32 match_n_vectors;
1508 u32 next_table_index;
1509 u32 miss_next_index;
1513 /** \brief Add/Delete classification table response
1514 @param context - sender context, to match reply w/ request
1515 @param retval - return code for the table add/del requst
1516 @param new_table_index - for add, returned index of the new table
1517 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1518 @param match_n_vectors -for add, returned value of match_n_vectors in table
1520 define classify_add_del_table_reply {
1523 u32 new_table_index;
1525 u32 match_n_vectors;
1528 /** \brief Classify add / del session request
1529 @param client_index - opaque cookie to identify the sender
1530 @param context - sender context, to match reply w/ request
1531 @param is_add - add session if non-zero, else delete
1532 @param table_index - index of the table to add/del the session, required
1533 @param hit_next_index - for add, hit_next_index of new session, required
1534 @param opaque_index - for add, opaque_index of new session
1535 @param advance -for add, advance value for session
1536 @param match[] - for add, match value for session, required
1538 define classify_add_del_session {
1549 /** \brief Classify add / del session response
1550 @param context - sender context, to match reply w/ request
1551 @param retval - return code for the add/del session request
1553 define classify_add_del_session_reply {
1558 /** \brief Set/unset the classification table for an interface request
1559 @param client_index - opaque cookie to identify the sender
1560 @param context - sender context, to match reply w/ request
1561 @param is_ipv6 - ipv6 if non-zero, else ipv4
1562 @param sw_if_index - interface to associate with the table
1563 @param table_index - index of the table, if ~0 unset the table
1565 define classify_set_interface_ip_table {
1570 u32 table_index; /* ~0 => off */
1573 /** \brief Set/unset interface classification table response
1574 @param context - sender context, to match reply w/ request
1575 @param retval - return code
1577 define classify_set_interface_ip_table_reply {
1582 /** \brief Set/unset l2 classification tables for an interface request
1583 @param client_index - opaque cookie to identify the sender
1584 @param context - sender context, to match reply w/ request
1585 @param sw_if_index - interface to set/unset tables for
1586 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1587 @param ip6_table_index - ip6 index
1588 @param other_table_index - other index
1590 define classify_set_interface_l2_tables {
1595 u32 ip4_table_index;
1596 u32 ip6_table_index;
1597 u32 other_table_index;
1600 /** \brief Set/unset l2 classification tables for an interface response
1601 @param context - sender context, to match reply w/ request
1602 @param retval - return code for the request
1604 define classify_set_interface_l2_tables_reply {
1609 /** \brief Get node index using name request
1610 @param client_index - opaque cookie to identify the sender
1611 @param context - sender context, to match reply w/ request
1612 @param node_name[] - name of the node
1614 define get_node_index {
1620 /** \brief Get node index using name request
1621 @param context - sender context, to match reply w/ request
1622 @param retval - return code for the request
1623 @param node_index - index of the desired node if found, else ~0
1625 define get_node_index_reply {
1631 /** \brief Set the next node for a given node 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[] - node to add the next node to
1635 @param next_name[] - node to add as the next node
1637 define add_node_next {
1644 /** \brief IP Set the next node for a given node response
1645 @param context - sender context, to match reply w/ request
1646 @param retval - return code for the add next node request
1647 @param next_index - the index of the next node if success, else ~0
1649 define add_node_next_reply {
1655 /** \brief DHCP Proxy config 2 add / del request
1656 @param client_index - opaque cookie to identify the sender
1657 @param context - sender context, to match reply w/ request
1658 @param rx_vrf_id - receive vrf id
1659 @param server_vrf_id - server vrf id
1660 @param if_ipv6 - ipv6 if non-zero, else ipv4
1661 @param is_add - add the config if non-zero, else delete
1662 @param insert_circuit_id - option82 suboption 1 fib number
1663 @param dhcp_server[] - server address
1664 @param dhcp_src_address[] - <fix this, need details>
1666 define dhcp_proxy_config_2 {
1673 u8 insert_circuit_id;
1675 u8 dhcp_src_address[16];
1678 /** \brief DHCP Proxy config 2 add / del response
1679 @param context - sender context, to match reply w/ request
1680 @param retval - return code for request
1682 define dhcp_proxy_config_2_reply {
1687 /** \brief l2tpv3 tunnel interface create request
1688 @param client_index - opaque cookie to identify the sender
1689 @param context - sender context, to match reply w/ request
1690 @param client_address - remote client tunnel ip address
1691 @param client_address - local tunnel ip address
1692 @param is_ipv6 - ipv6 if non-zero, else ipv4
1693 @param local_session_id - local tunnel session id
1694 @param remote_session_id - remote tunnel session id
1695 @param local_cookie - local tunnel cookie
1696 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1697 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1699 define l2tpv3_create_tunnel {
1702 u8 client_address [16];
1703 u8 our_address [16];
1705 u32 local_session_id;
1706 u32 remote_session_id;
1709 u8 l2_sublayer_present;
1713 /** \brief l2tpv3 tunnel interface create response
1714 @param context - sender context, to match reply w/ request
1715 @param retval - return code for the request
1716 @param sw_if_index - index of the new tunnel interface
1718 define l2tpv3_create_tunnel_reply {
1724 define l2tpv3_set_tunnel_cookies {
1728 u64 new_local_cookie;
1729 u64 new_remote_cookie;
1732 /** \brief L2TP tunnel set cookies response
1733 @param context - sender context, to match reply w/ request
1734 @param retval - return code for the request
1736 define l2tpv3_set_tunnel_cookies_reply {
1741 define sw_if_l2tpv3_tunnel_details {
1744 u8 interface_name[64];
1745 u8 client_address [16];
1746 u8 our_address [16];
1747 u32 local_session_id;
1748 u32 remote_session_id;
1749 u64 local_cookie[2];
1751 u8 l2_sublayer_present;
1754 define sw_if_l2tpv3_tunnel_dump {
1759 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1760 @param client_index - opaque cookie to identify the sender
1761 @param context - sender context, to match reply w/ request
1763 define l2_fib_clear_table {
1768 /** \brief L2 fib clear table response
1769 @param context - sender context, to match reply w/ request
1770 @param retval - return code for the request
1772 define l2_fib_clear_table_reply {
1777 /** \brief L2 interface ethernet flow point filtering enable/disable request
1778 @param client_index - opaque cookie to identify the sender
1779 @param context - sender context, to match reply w/ request
1780 @param sw_if_index - interface to enable/disable filtering on
1781 @param enable_disable - if non-zero enable filtering, else disable
1783 define l2_interface_efp_filter {
1790 /** \brief L2 interface ethernet flow point filtering response
1791 @param context - sender context, to match reply w/ request
1792 @param retval - return code for the request
1794 define l2_interface_efp_filter_reply {
1799 define l2tpv3_interface_enable_disable {
1806 define l2tpv3_interface_enable_disable_reply {
1811 define l2tpv3_set_lookup_key {
1814 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1818 define l2tpv3_set_lookup_key_reply {
1823 define vxlan_add_del_tunnel {
1831 u32 decap_next_index;
1835 define vxlan_add_del_tunnel_reply {
1841 define vxlan_tunnel_dump {
1847 define vxlan_tunnel_details {
1853 u32 decap_next_index;
1858 define gre_add_del_tunnel {
1868 define gre_add_del_tunnel_reply {
1874 define gre_tunnel_dump {
1880 define gre_tunnel_details {
1889 /** \brief L2 interface vlan tag rewrite configure request
1890 @param client_index - opaque cookie to identify the sender
1891 @param context - sender context, to match reply w/ request
1892 @param sw_if_index - interface the operation is applied to
1893 @param vtr_op - Choose from l2_vtr_op_t enum values
1894 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1895 @param tag1 - Needed for any push or translate vtr op
1896 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1898 define l2_interface_vlan_tag_rewrite {
1903 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1904 u32 tag1; // first pushed tag
1905 u32 tag2; // second pushed tag
1908 /** \brief L2 interface vlan tag rewrite response
1909 @param context - sender context, to match reply w/ request
1910 @param retval - return code for the request
1912 define l2_interface_vlan_tag_rewrite_reply {
1917 /** \brief vhost-user interface create request
1918 @param client_index - opaque cookie to identify the sender
1919 @param is_server - our side is socket server
1920 @param sock_filename - unix socket filename, used to speak with frontend
1921 @param use_custom_mac - enable or disable the use of the provided hardware address
1922 @param mac_address - hardware address to use if 'use_custom_mac' is set
1924 define create_vhost_user_if {
1928 u8 sock_filename[256];
1930 u32 custom_dev_instance;
1935 /** \brief vhost-user interface create response
1936 @param context - sender context, to match reply w/ request
1937 @param retval - return code for the request
1938 @param sw_if_index - interface the operation is applied to
1940 define create_vhost_user_if_reply {
1946 /** \brief vhost-user interface modify request
1947 @param client_index - opaque cookie to identify the sender
1948 @param is_server - our side is socket server
1949 @param sock_filename - unix socket filename, used to speak with frontend
1951 define modify_vhost_user_if {
1956 u8 sock_filename[256];
1958 u32 custom_dev_instance;
1961 /** \brief vhost-user interface modify response
1962 @param context - sender context, to match reply w/ request
1963 @param retval - return code for the request
1965 define modify_vhost_user_if_reply {
1970 /** \brief vhost-user interface delete request
1971 @param client_index - opaque cookie to identify the sender
1973 define delete_vhost_user_if {
1979 /** \brief vhost-user interface delete response
1980 @param context - sender context, to match reply w/ request
1981 @param retval - return code for the request
1983 define delete_vhost_user_if_reply {
1988 define create_subif {
1994 /* These fields map directly onto the subif template */
1998 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2001 u8 outer_vlan_id_any;
2002 u8 inner_vlan_id_any;
2007 define create_subif_reply {
2013 /** \brief show version
2014 @param client_index - opaque cookie to identify the sender
2015 @param context - sender context, to match reply w/ request
2017 define show_version {
2022 /** \brief show version response
2023 @param context - sender context, to match reply w/ request
2024 @param retval - return code for the request
2025 @param program - name of the program (vpe)
2026 @param version - version of the program
2027 @param build_directory - root of the workspace where the program was built
2029 define show_version_reply {
2035 u8 build_directory[256];
2038 /** \brief Vhost-user interface details structure (fix this)
2039 @param sw_if_index - index of the interface
2040 @param interface_name - name of interface
2041 @param virtio_net_hdr_sz - net header size
2042 @param features - interface features
2043 @param is_server - vhost-user server socket
2044 @param sock_filename - socket filename
2045 @param num_regions - number of used memory regions
2047 define sw_interface_vhost_user_details {
2050 u8 interface_name[64];
2051 u32 virtio_net_hdr_sz;
2054 u8 sock_filename[256];
2060 define sw_interface_vhost_user_dump {
2065 define ip_address_details {
2072 define ip_address_dump {
2090 /** \brief l2 fib table entry structure
2091 @param bd_id - the l2 fib / bridge domain table id
2092 @param mac - the entry's mac address
2093 @param sw_if_index - index of the interface
2094 @param static_mac - the entry is statically configured.
2095 @param filter_mac - the entry is a mac filter entry.
2096 @param bvi_mac - the mac address is a bridge virtual interface
2098 define l2_fib_table_entry {
2108 /** \brief Dump l2 fib (aka bridge domain) table
2109 @param client_index - opaque cookie to identify the sender
2110 @param bd_id - the l2 fib / bridge domain table identifier
2112 define l2_fib_table_dump {
2118 define vxlan_gpe_add_del_tunnel {
2131 define vxlan_gpe_add_del_tunnel_reply {
2137 define vxlan_gpe_tunnel_dump {
2143 define vxlan_gpe_tunnel_details {
2155 /** \brief add or delete locator_set
2156 @param client_index - opaque cookie to identify the sender
2157 @param context - sender context, to match reply w/ request
2158 @param is_add - add address if non-zero, else delete
2159 @param locator_set_name - locator name
2161 define lisp_add_del_locator_set {
2165 u8 locator_set_name[64];
2170 /** \brief Reply for locator_set add/del
2171 @param context - returned sender context, to match reply w/ request
2172 @param retval - return code
2174 define lisp_add_del_locator_set_reply {
2179 /** \brief add or delete locator for locator_set
2180 @param client_index - opaque cookie to identify the sender
2181 @param context - sender context, to match reply w/ request
2182 @param is_add - add address if non-zero, else delete
2183 @param locator_set_name - name of locator_set to add/del locator
2184 @param sw_if_index - index of the interface
2185 @param priority - priority of the lisp locator
2186 @param weight - weight of the lisp locator
2188 define lisp_add_del_locator {
2192 u8 locator_set_name[64];
2198 /** \brief Reply for locator add/del
2199 @param context - returned sender context, to match reply w/ request
2200 @param retval - return code
2202 define lisp_add_del_locator_reply {
2207 /** \brief add or delete lisp eid-table
2208 @param client_index - opaque cookie to identify the sender
2209 @param context - sender context, to match reply w/ request
2210 @param is_add - add address if non-zero, else delete
2215 @param eid - EID can be ip4, ip6 or mac
2216 @param prefix_len - prefix len
2217 @param locator_set_name - name of locator_set to add/del eid-table
2218 @param vni - virtual network instance
2220 define lisp_add_del_local_eid {
2227 u8 locator_set_name[64];
2231 /** \brief Reply for local_eid add/del
2232 @param context - returned sender context, to match reply w/ request
2233 @param retval - return code
2235 define lisp_add_del_local_eid_reply {
2240 /** \brief add or delete lisp gpe maptunel
2241 @param client_index - opaque cookie to identify the sender
2242 @param context - sender context, to match reply w/ request
2243 @param is_add - add address if non-zero, else delete
2244 @param eid_is_ipv6 - if non-zero the address is ipv6, else ipv4
2245 @param eid_ip_address - array of address bytes
2246 @param eid_prefix_len - prefix len
2247 @param address_is_ipv6 - if non-zero the address is ipv6, else ipv4
2248 @param source_ip_address - array of address bytes
2249 @param destination_ip_address - array of address bytes
2251 define lisp_gpe_add_del_fwd_entry {
2256 u8 eid_ip_address[16];
2259 u8 source_ip_address[16];
2260 u8 destination_ip_address[16];
2263 /** \brief Reply for gpe_fwd_entry add/del
2264 @param context - returned sender context, to match reply w/ request
2265 @param retval - return code
2267 define lisp_gpe_add_del_fwd_entry_reply {
2272 /** \brief add or delete map-resolver
2273 @param client_index - opaque cookie to identify the sender
2274 @param context - sender context, to match reply w/ request
2275 @param is_add - add address if non-zero, else delete
2276 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2277 @param ip_address - array of address bytes
2279 define lisp_add_del_map_resolver {
2287 /** \brief Reply for map_resolver add/del
2288 @param context - returned sender context, to match reply w/ request
2289 @param retval - return code
2291 define lisp_add_del_map_resolver_reply {
2296 /** \brief enable or disable lisp-gpe protocol
2297 @param client_index - opaque cookie to identify the sender
2298 @param context - sender context, to match reply w/ request
2299 @param is_en - enable protocol if non-zero, else disable
2301 define lisp_gpe_enable_disable {
2307 /** \brief Reply for gpe enable/disable
2308 @param context - returned sender context, to match reply w/ request
2309 @param retval - return code
2311 define lisp_gpe_enable_disable_reply {
2316 /** \brief enable or disable LISP feature
2317 @param client_index - opaque cookie to identify the sender
2318 @param context - sender context, to match reply w/ request
2319 @param is_en - enable protocol if non-zero, else disable
2321 define lisp_enable_disable {
2327 /** \brief Reply for gpe enable/disable
2328 @param context - returned sender context, to match reply w/ request
2329 @param retval - return code
2331 define lisp_enable_disable_reply {
2336 /** \brief add or delete gpe_iface
2337 @param client_index - opaque cookie to identify the sender
2338 @param context - sender context, to match reply w/ request
2339 @param is_add - add address if non-zero, else delete
2341 define lisp_gpe_add_del_iface {
2349 /** \brief Reply for gpe_iface add/del
2350 @param context - returned sender context, to match reply w/ request
2351 @param retval - return code
2353 define lisp_gpe_add_del_iface_reply {
2358 /** \brief configure or disable LISP PITR node
2359 @param client_index - opaque cookie to identify the sender
2360 @param context - sender context, to match reply w/ request
2361 @param ls_name - locator set name
2362 @param is_add - add locator set if non-zero, else disable pitr
2364 define lisp_pitr_set_locator_set {
2371 /** \brief Reply for lisp_pitr_set_locator_set
2372 @param context - returned sender context, to match reply w/ request
2373 @param retval - return code
2375 define lisp_pitr_set_locator_set_reply {
2380 /** \brief add or delete remote static mapping
2381 @param client_index - opaque cookie to identify the sender
2382 @param context - sender context, to match reply w/ request
2383 @param is_add - add address if non-zero, else delete
2384 @param del_all - if set, delete all remote mappings
2385 @param vni - virtual network instance
2386 @param action - negative map-reply action
2391 @param deid - destination EID
2392 @param seid - source EID
2393 @param rloc_num - number of remote locators
2394 @param rlocs - remote locator data
2396 define lisp_add_del_remote_mapping {
2412 /** \brief Reply for lisp_add_del_remote_mapping
2413 @param context - returned sender context, to match reply w/ request
2414 @param retval - return code
2416 define lisp_add_del_remote_mapping_reply {
2421 /** \brief add or delete LISP adjacency adjacency
2422 @param client_index - opaque cookie to identify the sender
2423 @param context - sender context, to match reply w/ request
2424 @param is_add - add address if non-zero, else delete
2425 @param vni - virtual network instance
2430 @param deid - destination EID
2431 @param seid - source EID
2433 define lisp_add_del_adjacency {
2445 /** \brief Reply for lisp_add_del_adjacency
2446 @param context - returned sender context, to match reply w/ request
2447 @param retval - return code
2449 define lisp_add_del_adjacency_reply {
2454 /** \brief add or delete map request itr rlocs
2455 @param client_index - opaque cookie to identify the sender
2456 @param context - sender context, to match reply w/ request
2457 @param is_add - add address if non-zero, else delete
2458 @param locator_set_name - locator set name
2460 define lisp_add_del_map_request_itr_rlocs {
2464 u8 locator_set_name[64];
2467 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2468 @param context - returned sender context, to match reply w/ request
2469 @param retval - return code
2472 define lisp_add_del_map_request_itr_rlocs_reply {
2477 /** \brief map/unmap vni to vrf
2478 @param client_index - opaque cookie to identify the sender
2479 @param context - sender context, to match reply w/ request
2480 @param is_add - add or delete mapping
2481 @param vni - virtual network id
2484 define lisp_eid_table_add_del_map {
2492 /** \brief Reply for lisp_eid_table_add_del_map
2493 @param context - returned sender context, to match reply w/ request
2494 @param retval - return code
2496 define lisp_eid_table_add_del_map_reply {
2501 /** \brief LISP locator_set status
2502 @param locator_set_name - name of the locator_set
2503 @param sw_if_index - sw_if_index of the locator
2504 @param priority - locator priority
2505 @param weight - locator weight
2507 define lisp_locator_set_details {
2510 u8 locator_set_name[64];
2519 /** \brief Request for locator_set summary status
2520 @param client_index - opaque cookie to identify the sender
2521 @param context - sender context, to match reply w/ request
2523 define lisp_locator_set_dump {
2528 /** \brief LISP local eid table status
2529 @param locator_set_name - name of the locator_set
2530 @param eid_type - ip4, ip6 or l2 mac address
2531 @param eid - array of address bytes
2532 @param eid_prefix_len - prefix len
2534 define lisp_local_eid_table_details {
2536 u8 locator_set_name[64];
2543 /** \brief Request for local eid table summary status
2544 @param client_index - opaque cookie to identify the sender
2545 @param context - sender context, to match reply w/ request
2546 @param eid_set - if non-zero request info about specific mapping
2547 @param vni - virtual network instance; valid only if eid_set != 0
2548 @param prefix_length - prefix length if EID is IP address;
2549 valid only if eid_set != 0
2550 @param eid_type - EID type; valid only if eid_set != 0
2554 2: EID is ethernet address
2555 @param eid - endpoint identifier
2557 define lisp_local_eid_table_dump {
2567 /** \brief Shows relationship between vni and vrf
2568 @param vrf - VRF index
2569 @param vni - vitual network instance
2571 define lisp_eid_table_map_details {
2577 /** \brief Request for lisp_eid_table_map_details
2578 @param client_index - opaque cookie to identify the sender
2579 @param context - sender context, to match reply w/ request
2581 define lisp_eid_table_map_dump {
2586 define lisp_gpe_tunnel_details {
2591 u8 destination_ip[16];
2603 /** \brief Request for gpe tunnel summary status
2604 @param client_index - opaque cookie to identify the sender
2605 @param context - sender context, to match reply w/ request
2607 define lisp_gpe_tunnel_dump {
2612 /** \brief LISP map resolver status
2613 @param locator_set_name - name of the locator_set
2614 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2615 @param ip_address - array of address bytes
2617 define lisp_map_resolver_details {
2623 /** \brief Request for map resolver summary status
2624 @param client_index - opaque cookie to identify the sender
2625 @param context - sender context, to match reply w/ request
2627 define lisp_map_resolver_dump {
2632 /** \brief Status of lisp-gpe protocol, enable or disable
2633 @param context - sender context, to match reply w/ request
2634 @param is_en - enable protocol if non-zero, else disable
2636 define lisp_enable_disable_status_details {
2642 /** \brief Request for lisp-gpe protocol status
2643 @param client_index - opaque cookie to identify the sender
2644 @param context - sender context, to match reply w/ request
2646 define lisp_enable_disable_status_dump {
2651 /** \brief Get LISP map request itr rlocs status
2652 @param context - sender context, to match reply w/ request
2653 @param locator_set_name - name of the locator_set
2655 define lisp_get_map_request_itr_rlocs {
2660 /** \brief Request for map request itr rlocs summary status
2662 define lisp_get_map_request_itr_rlocs_reply {
2665 u8 locator_set_name[64];
2668 /** \brief Request for lisp pitr status
2669 @param client_index - opaque cookie to identify the sender
2670 @param context - sender context, to match reply w/ request
2672 define show_lisp_pitr {
2677 /** \brief Status of lisp pitr, enable or disable
2678 @param context - sender context, to match reply w/ request
2679 @param status - lisp pitr enable if non-zero, else disable
2680 @param locator_set_name - name of the locator_set
2682 define show_lisp_pitr_reply {
2686 u8 locator_set_name[64];
2689 /* Gross kludge, DGMS */
2690 define interface_name_renumber {
2694 u32 new_show_dev_instance;
2697 define interface_name_renumber_reply {
2702 /** \brief Register for ip4 arp resolution events
2703 @param client_index - opaque cookie to identify the sender
2704 @param context - sender context, to match reply w/ request
2705 @param enable_disable - 1 => register for events, 0 => cancel registration
2706 @param pid - sender's pid
2707 @param address - the exact ip4 address of interest
2709 define want_ip4_arp_events {
2717 /** \brief Reply for interface events registration
2718 @param context - returned sender context, to match reply w/ request
2719 @param retval - return code
2721 define want_ip4_arp_events_reply {
2726 /** \brief Tell client about an ip4 arp resolution event
2727 @param client_index - opaque cookie to identify the sender
2728 @param context - sender context, to match reply w/ request
2729 @param address - the exact ip4 address of interest
2730 @param pid - client pid registered to receive notification
2731 @param sw_if_index - interface which received ARP packet
2732 @param new_mac - the new mac address
2734 define ip4_arp_event {
2743 /** \brief L2 bridge domain add or delete request
2744 @param client_index - opaque cookie to identify the sender
2745 @param context - sender context, to match reply w/ request
2746 @param bd_id - the bridge domain to create
2747 @param flood - enable/disable bcast/mcast flooding in the bd
2748 @param uu_flood - enable/disable uknown unicast flood in the bd
2749 @param forward - enable/disable forwarding on all interfaces in the bd
2750 @param learn - enable/disable learning on all interfaces in the bd
2751 @param arp_term - enable/disable arp termination in the bd
2752 @param is_add - add or delete flag
2754 define bridge_domain_add_del {
2766 /** \brief L2 bridge domain add or delete response
2767 @param context - sender context, to match reply w/ request
2768 @param retval - return code for the set bridge flags request
2770 define bridge_domain_add_del_reply {
2775 /** \brief L2 bridge domain request operational state details
2776 @param client_index - opaque cookie to identify the sender
2777 @param context - sender context, to match reply w/ request
2778 @param bd_id - the bridge domain id desired or ~0 to request all bds
2780 define bridge_domain_dump {
2786 /** \brief L2 bridge domain operational state response
2787 @param bd_id - the bridge domain id
2788 @param flood - bcast/mcast flooding state on all interfaces in the bd
2789 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2790 @param forward - forwarding state on all interfaces in the bd
2791 @param learn - learning state on all interfaces in the bd
2792 @param arp_term - arp termination state on all interfaces in the bd
2793 @param n_sw_ifs - number of sw_if_index's in the domain
2795 define bridge_domain_details {
2803 u32 bvi_sw_if_index;
2807 /** \brief L2 bridge domain sw interface operational state response
2808 @param bd_id - the bridge domain id
2809 @param sw_if_index - sw_if_index in the domain
2810 @param shg - split horizon group for the interface
2812 define bridge_domain_sw_if_details {
2819 /** \brief DHCP Client config add / del request
2820 @param client_index - opaque cookie to identify the sender
2821 @param context - sender context, to match reply w/ request
2822 @param sw_if_index - index of the interface for DHCP client
2823 @param hostname - hostname
2824 @param is_add - add the config if non-zero, else delete
2825 @param want_dhcp_event - DHCP event sent to the sender
2826 via dhcp_compl_event API message if non-zero
2827 @param pid - sender's pid
2829 define dhcp_client_config {
2839 /** \brief DHCP Client config response
2840 @param context - sender context, to match reply w/ request
2841 @param retval - return code for the request
2843 define dhcp_client_config_reply {
2848 /** \brief Set/unset input ACL interface
2849 @param client_index - opaque cookie to identify the sender
2850 @param context - sender context, to match reply w/ request
2851 @param sw_if_index - interface to set/unset input ACL
2852 @param ip4_table_index - ip4 classify table index (~0 for skip)
2853 @param ip6_table_index - ip6 classify table index (~0 for skip)
2854 @param l2_table_index - l2 classify table index (~0 for skip)
2855 @param is_add - Set input ACL if non-zero, else unset
2856 Note: User is recommeneded to use just one valid table_index per call.
2857 (ip4_table_index, ip6_table_index, or l2_table_index)
2859 define input_acl_set_interface {
2863 u32 ip4_table_index;
2864 u32 ip6_table_index;
2869 /** \brief Set/unset input ACL interface response
2870 @param context - sender context, to match reply w/ request
2871 @param retval - return code for the request
2873 define input_acl_set_interface_reply {
2878 /** \brief IPsec: Add/delete Security Policy Database
2879 @param client_index - opaque cookie to identify the sender
2880 @param context - sender context, to match reply w/ request
2881 @param is_add - add SPD if non-zero, else delete
2882 @param spd_id - SPD instance id (control plane allocated)
2885 define ipsec_spd_add_del {
2892 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2893 @param context - returned sender context, to match reply w/ request
2894 @param retval - return code
2897 define ipsec_spd_add_del_reply {
2902 /** \brief IPsec: Add/delete SPD from interface
2904 @param client_index - opaque cookie to identify the sender
2905 @param context - sender context, to match reply w/ request
2906 @param is_add - add security mode if non-zero, else delete
2907 @param sw_if_index - index of the interface
2908 @param spd_id - SPD instance id to use for lookups
2912 define ipsec_interface_add_del_spd {
2921 /** \brief Reply for IPsec: Add/delete SPD from interface
2922 @param context - returned sender context, to match reply w/ request
2923 @param retval - return code
2926 define ipsec_interface_add_del_spd_reply {
2931 /** \brief IPsec: Add/delete Security Policy Database entry
2933 See RFC 4301, 4.4.1.1 on how to match packet to selectors
2935 @param client_index - opaque cookie to identify the sender
2936 @param context - sender context, to match reply w/ request
2937 @param is_add - add SPD if non-zero, else delete
2938 @param spd_id - SPD instance id (control plane allocated)
2939 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
2940 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2941 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2942 @param remote_address_start - start of remote address range to match
2943 @param remote_address_stop - end of remote address range to match
2944 @param local_address_start - start of local address range to match
2945 @param local_address_stop - end of local address range to match
2946 @param protocol - protocol type to match [0 means any]
2947 @param remote_port_start - start of remote port range to match ...
2948 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2949 @param local_port_start - start of local port range to match ...
2950 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2951 @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)
2952 @param sa_id - SAD instance id (control plane allocated)
2956 define ipsec_spd_add_del_entry {
2968 u8 remote_address_start[16];
2969 u8 remote_address_stop[16];
2970 u8 local_address_start[16];
2971 u8 local_address_stop[16];
2975 u16 remote_port_start;
2976 u16 remote_port_stop;
2977 u16 local_port_start;
2978 u16 local_port_stop;
2985 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2986 @param context - returned sender context, to match reply w/ request
2987 @param retval - return code
2990 define ipsec_spd_add_del_entry_reply {
2995 /** \brief IPsec: Add/delete Security Association Database entry
2996 @param client_index - opaque cookie to identify the sender
2997 @param context - sender context, to match reply w/ request
2998 @param is_add - add SAD entry if non-zero, else delete
3000 @param sad_id - sad id
3002 @param spi - security parameter index
3004 @param protocol - 0 = AH, 1 = ESP
3006 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3007 @param crypto_key_length - length of crypto_key in bytes
3008 @param crypto_key - crypto keying material
3010 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3011 @param integrity_key_length - length of integrity_key in bytes
3012 @param integrity_key - integrity keying material
3014 @param use_extended_sequence_number - use ESN when non-zero
3016 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3017 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3018 @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
3019 @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
3023 IPsec tunnel address copy mode (to support GDOI)
3026 define ipsec_sad_add_del_entry {
3037 u8 crypto_algorithm;
3038 u8 crypto_key_length;
3041 u8 integrity_algorithm;
3042 u8 integrity_key_length;
3043 u8 integrity_key[128];
3045 u8 use_extended_sequence_number;
3049 u8 tunnel_src_address[16];
3050 u8 tunnel_dst_address[16];
3053 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3054 @param context - returned sender context, to match reply w/ request
3055 @param retval - return code
3058 define ipsec_sad_add_del_entry_reply {
3063 /** \brief IPsec: Update Security Association keys
3064 @param client_index - opaque cookie to identify the sender
3065 @param context - sender context, to match reply w/ request
3067 @param sa_id - sa id
3069 @param crypto_key_length - length of crypto_key in bytes
3070 @param crypto_key - crypto keying material
3072 @param integrity_key_length - length of integrity_key in bytes
3073 @param integrity_key - integrity keying material
3076 define ipsec_sa_set_key {
3082 u8 crypto_key_length;
3085 u8 integrity_key_length;
3086 u8 integrity_key[128];
3089 /** \brief Reply for IPsec: Update Security Association keys
3090 @param context - returned sender context, to match reply w/ request
3091 @param retval - return code
3094 define ipsec_sa_set_key_reply {
3099 /** \brief IKEv2: Add/delete profile
3100 @param client_index - opaque cookie to identify the sender
3101 @param context - sender context, to match reply w/ request
3103 @param name - IKEv2 profile name
3104 @param is_add - Add IKEv2 profile if non-zero, else delete
3106 define ikev2_profile_add_del {
3114 /** \brief Reply for IKEv2: Add/delete profile
3115 @param context - returned sender context, to match reply w/ request
3116 @param retval - return code
3118 define ikev2_profile_add_del_reply {
3123 /** \brief IKEv2: Set IKEv2 profile authentication method
3124 @param client_index - opaque cookie to identify the sender
3125 @param context - sender context, to match reply w/ request
3127 @param name - IKEv2 profile name
3128 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3129 @param is_hex - Authentication data in hex format if non-zero, else string
3130 @param data_len - Authentication data length
3131 @param data - Authentication data (for rsa-sig cert file path)
3133 define ikev2_profile_set_auth {
3144 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3145 @param context - returned sender context, to match reply w/ request
3146 @param retval - return code
3148 define ikev2_profile_set_auth_reply {
3153 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3154 @param client_index - opaque cookie to identify the sender
3155 @param context - sender context, to match reply w/ request
3157 @param name - IKEv2 profile name
3158 @param is_local - Identification is local if non-zero, else remote
3159 @param id_type - Identification type
3160 @param data_len - Identification data length
3161 @param data - Identification data
3163 define ikev2_profile_set_id {
3174 /** \brief Reply for IKEv2:
3175 @param context - returned sender context, to match reply w/ request
3176 @param retval - return code
3178 define ikev2_profile_set_id_reply {
3183 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3184 @param client_index - opaque cookie to identify the sender
3185 @param context - sender context, to match reply w/ request
3187 @param name - IKEv2 profile name
3188 @param is_local - Traffic selector is local if non-zero, else remote
3189 @param proto - Traffic selector IP protocol (if zero not relevant)
3190 @param start_port - The smallest port number allowed by traffic selector
3191 @param end_port - The largest port number allowed by traffic selector
3192 @param start_addr - The smallest address included in traffic selector
3193 @param end_addr - The largest address included in traffic selector
3195 define ikev2_profile_set_ts {
3208 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3209 @param context - returned sender context, to match reply w/ request
3210 @param retval - return code
3212 define ikev2_profile_set_ts_reply {
3217 /** \brief IKEv2: Set IKEv2 local RSA private key
3218 @param client_index - opaque cookie to identify the sender
3219 @param context - sender context, to match reply w/ request
3221 @param key_file - Key file absolute path
3223 define ikev2_set_local_key {
3230 /** \brief Reply for IKEv2: Set IKEv2 local key
3231 @param context - returned sender context, to match reply w/ request
3232 @param retval - return code
3234 define ikev2_set_local_key_reply {
3239 /** \brief Tell client about a DHCP completion event
3240 @param client_index - opaque cookie to identify the sender
3241 @param pid - client pid registered to receive notification
3242 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3243 @param host_address - Host IP address
3244 @param router_address - Router IP address
3245 @param host_mac - Host MAC address
3247 define dhcp_compl_event {
3252 u8 host_address[16];
3253 u8 router_address[16];
3257 /** \brief Add MAP domains
3258 @param client_index - opaque cookie to identify the sender
3259 @param context - sender context, to match reply w/ request
3260 @param ip6_prefix - Rule IPv6 prefix
3261 @param ip4_prefix - Rule IPv4 prefix
3262 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3263 @param ip6_prefix_len - Rule IPv6 prefix length
3264 @param ip4_prefix_len - Rule IPv4 prefix length
3265 @param ea_bits_len - Embedded Address bits length
3266 @param psid_offset - Port Set Identifider (PSID) offset
3267 @param psid_length - PSID length
3268 @param is_translation - MAP-E / MAP-T
3271 define map_add_domain {
3279 u8 ip6_src_prefix_len;
3287 /** \brief Reply for MAP domain add
3288 @param context - returned sender context, to match reply w/ request
3289 @param index - MAP domain index
3290 @param retval - return code
3292 define map_add_domain_reply {
3298 /** \brief Delete MAP domain
3299 @param client_index - opaque cookie to identify the sender
3300 @param context - sender context, to match reply w/ request
3301 @param index - MAP Domain index
3303 define map_del_domain {
3309 /** \brief Reply for MAP domain del
3310 @param context - returned sender context, to match reply w/ request
3311 @param retval - return code
3313 define map_del_domain_reply {
3318 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3319 @param client_index - opaque cookie to identify the sender
3320 @param context - sender context, to match reply w/ request
3321 @param index - MAP Domain index
3322 @param is_add - If 1 add rule, if 0 delete rule
3323 @param ip6_dst - MAP CE IPv6 address
3324 @param psid - Rule PSID
3326 define map_add_del_rule {
3335 /** \brief Reply for MAP rule add/del
3336 @param context - returned sender context, to match reply w/ request
3337 @param retval - return code
3339 define map_add_del_rule_reply {
3344 /** \brief Get list of map domains
3345 @param client_index - opaque cookie to identify the sender
3347 define map_domain_dump {
3352 define map_domain_details {
3369 define map_rule_dump {
3375 define map_rule_details {
3381 /** \brief Request for a single block of summary stats
3382 @param client_index - opaque cookie to identify the sender
3383 @param context - sender context, to match reply w/ request
3385 define map_summary_stats {
3390 /** \brief Reply for map_summary_stats request
3391 @param context - sender context, to match reply w/ request
3392 @param retval - return code for request
3393 @param total_bindings -
3395 @param total_ip4_fragments -
3396 @param total_security_check -
3398 define map_summary_stats_reply {
3404 u64 total_ip4_fragments;
3405 u64 total_security_check[2];
3408 /** \brief cop: enable/disable junk filtration features on an interface
3409 @param client_index - opaque cookie to identify the sender
3410 @param context - sender context, to match reply w/ request
3411 @param sw_if_inded - desired interface
3412 @param enable_disable - 1 => enable, 0 => disable
3415 define cop_interface_enable_disable {
3422 /** \brief cop: interface enable/disable junk filtration reply
3423 @param context - returned sender context, to match reply w/ request
3424 @param retval - return code
3427 define cop_interface_enable_disable_reply {
3432 /** \brief cop: enable/disable whitelist filtration features on an interface
3433 Note: the supplied fib_id must match in order to remove the feature!
3435 @param client_index - opaque cookie to identify the sender
3436 @param context - sender context, to match reply w/ request
3437 @param sw_if_index - interface handle, physical interfaces only
3438 @param fib_id - fib identifier for the whitelist / blacklist fib
3439 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3440 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3441 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3444 define cop_whitelist_enable_disable {
3454 /** \brief cop: interface enable/disable junk filtration reply
3455 @param context - returned sender context, to match reply w/ request
3456 @param retval - return code
3459 define cop_whitelist_enable_disable_reply {
3464 /** \brief get_node_graph - get a copy of the vpp node graph
3465 including the current set of graph arcs.
3467 @param client_index - opaque cookie to identify the sender
3468 @param context - sender context, to match reply w/ request
3471 define get_node_graph {
3476 /** \brief get_node_graph_reply
3477 @param context - returned sender context, to match reply w/ request
3478 @param retval - return code
3479 @param reply_in_shmem - result from vlib_node_serialize, in shared
3480 memory. Process with vlib_node_unserialize, remember to switch
3481 heaps and free the result.
3484 define get_node_graph_reply {
3490 /** \brief Clear interface statistics
3491 @param client_index - opaque cookie to identify the sender
3492 @param context - sender context, to match reply w/ request
3493 @param sw_if_index - index of the interface to clear statistics
3495 define sw_interface_clear_stats {
3501 /** \brief Reply to sw_interface_clear_stats
3502 @param context - sender context which was passed in the request
3503 @param retval - return code of the set flags request
3505 define sw_interface_clear_stats_reply {
3510 /** \brief IOAM Trace : Set TRACE profile
3511 @param id - profile id
3512 @param trace_type - Trace type
3513 @param trace_num_elt - Number of nodes in trace path
3514 @param trace_ppc - Trace PPC (none/encap/decap)
3515 @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3516 @param trace_app_data - Trace application data, can be any 4 bytes
3517 @param pow_enable - Proof of Work enabled or not flag
3518 @param node_id - Id of this node
3520 define trace_profile_add {
3533 /** \brief Trace profile add / del response
3534 @param context - sender context, to match reply w/ request
3535 @param retval - return value for request
3537 define trace_profile_add_reply {
3542 /** \brief IOAM Trace enable trace profile for a flow
3543 @param id - id of the trace profile to be applied
3544 @param dest_ipv6 - Destination IPv6 address
3545 @param prefix_length - prefix mask
3546 @param vrf_id - VRF ID
3547 @param trace_op - Trace operation (add/mod/del)
3548 @param enable - apply/remove the trace profile for the flow
3550 define trace_profile_apply {
3561 /** \brief Trace profile apply response
3562 @param context - sender context, to match reply w/ request
3563 @param retval - return value for request
3565 define trace_profile_apply_reply {
3570 /** \brief Delete Trace Profile
3571 @param client_index - opaque cookie to identify the sender
3572 @param context - sender context, to match reply w/ request
3573 @param index - MAP Domain index
3575 define trace_profile_del {
3581 /** \brief Trace profile add / del response
3582 @param context - sender context, to match reply w/ request
3583 @param retval - return value for request
3585 define trace_profile_del_reply {
3590 /** \brief Create host-interface
3591 @param client_index - opaque cookie to identify the sender
3592 @param context - sender context, to match reply w/ request
3593 @param host_if_name - interface name
3594 @param hw_addr - interface MAC
3595 @param use_random_hw_addr - use random generated MAC
3597 define af_packet_create {
3601 u8 host_if_name[64];
3603 u8 use_random_hw_addr;
3606 /** \brief Create host-interface response
3607 @param context - sender context, to match reply w/ request
3608 @param retval - return value for request
3610 define af_packet_create_reply {
3616 /** \brief Delete host-interface
3617 @param client_index - opaque cookie to identify the sender
3618 @param context - sender context, to match reply w/ request
3619 @param host_if_name - interface name
3621 define af_packet_delete {
3625 u8 host_if_name[64];
3628 /** \brief Delete host-interface response
3629 @param context - sender context, to match reply w/ request
3630 @param retval - return value for request
3632 define af_packet_delete_reply {
3637 /** \brief Add/del policer
3638 @param client_index - opaque cookie to identify the sender
3639 @param context - sender context, to match reply w/ request
3640 @param is_add - add policer if non-zero, else delete
3641 @param name - policer name
3644 @param cb - Committed Burst
3645 @param eb - Excess or Peak Burst
3646 @param rate_type - rate type
3647 @param round_type - rounding type
3648 @param type - policer algorithm
3649 @param color_aware - 0=color-blind, 1=color-aware
3650 @param conform_action_type - conform action type
3651 @param conform_dscp - DSCP for conform mar-and-transmit action
3652 @param exceed_action_type - exceed action type
3653 @param exceed_dscp - DSCP for exceed mar-and-transmit action
3654 @param violate_action_type - violate action type
3655 @param violate_dscp - DSCP for violate mar-and-transmit action
3657 define policer_add_del {
3671 u8 conform_action_type;
3673 u8 exceed_action_type;
3675 u8 violate_action_type;
3679 /** \brief Add/del policer response
3680 @param context - sender context, to match reply w/ request
3681 @param retval - return value for request
3682 @param policer_index - for add, returned index of the new policer
3684 define policer_add_del_reply {
3690 /** \brief Get list of policers
3691 @param client_index - opaque cookie to identify the sender
3692 @param context - sender context, to match reply w/ request
3693 @param match_name_valid - if 0 request all policers otherwise use match_name
3694 @param match_name - policer name
3696 define policer_dump {
3700 u8 match_name_valid;
3704 /** \brief Policer operational state response.
3705 @param context - sender context, to match reply w/ request
3706 @param name - policer name
3709 @param cb - Committed Burst
3710 @param eb - Excess or Peak Burst
3711 @param rate_type - rate type
3712 @param round_type - rounding type
3713 @param type - policer algorithm
3714 @param conform_action_type - conform action type
3715 @param conform_dscp - DSCP for conform mar-and-transmit action
3716 @param exceed_action_type - exceed action type
3717 @param exceed_dscp - DSCP for exceed mar-and-transmit action
3718 @param violate_action_type - violate action type
3719 @param violate_dscp - DSCP for violate mar-and-transmit action
3720 @param single_rate - 1 = single rate policer, 0 = two rate policer
3721 @param color_aware - for hierarchical policing
3722 @param scale - power-of-2 shift amount for lower rates
3723 @param cir_tokens_per_period - number of tokens for each period
3724 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
3725 @param current_limit - current limit
3726 @param current_bucket - current bucket
3727 @param extended_limit - extended limit
3728 @param extended_bucket - extended bucket
3729 @param last_update_time - last update time
3731 define policer_details {
3742 u8 conform_action_type;
3744 u8 exceed_action_type;
3746 u8 violate_action_type;
3751 u32 cir_tokens_per_period;
3752 u32 pir_tokens_per_period;
3756 u32 extended_bucket;
3757 u64 last_update_time;
3760 /** \brief Set/unset policer classify interface
3761 @param client_index - opaque cookie to identify the sender
3762 @param context - sender context, to match reply w/ request
3763 @param sw_if_index - interface to set/unset policer classify
3764 @param ip4_table_index - ip4 classify table index (~0 for skip)
3765 @param ip6_table_index - ip6 classify table index (~0 for skip)
3766 @param l2_table_index - l2 classify table index (~0 for skip)
3767 @param is_add - Set if non-zero, else unset
3768 Note: User is recommeneded to use just one valid table_index per call.
3769 (ip4_table_index, ip6_table_index, or l2_table_index)
3771 define policer_classify_set_interface {
3775 u32 ip4_table_index;
3776 u32 ip6_table_index;
3781 /** \brief Set/unset policer classify interface response
3782 @param context - sender context, to match reply w/ request
3783 @param retval - return value for request
3785 define policer_classify_set_interface_reply {
3790 /** \brief Get list of policer classify interfaces and tables
3791 @param client_index - opaque cookie to identify the sender
3792 @param context - sender context, to match reply w/ request
3793 @param type - classify table type
3795 define policer_classify_dump {
3801 /** \brief Policer iclassify operational state response.
3802 @param context - sender context, to match reply w/ request
3803 @param sw_if_index - software interface index
3804 @param table_index - classify table index
3806 define policer_classify_details {
3812 /** \brief Create netmap
3813 @param client_index - opaque cookie to identify the sender
3814 @param context - sender context, to match reply w/ request
3815 @param netmap_if_name - interface name
3816 @param hw_addr - interface MAC
3817 @param use_random_hw_addr - use random generated MAC
3818 @param is_pipe - is pipe
3819 @param is_master - 0=slave, 1=master
3821 define netmap_create {
3825 u8 netmap_if_name[64];
3827 u8 use_random_hw_addr;
3832 /** \brief Create netmap response
3833 @param context - sender context, to match reply w/ request
3834 @param retval - return value for request
3836 define netmap_create_reply {
3841 /** \brief Delete netmap
3842 @param client_index - opaque cookie to identify the sender
3843 @param context - sender context, to match reply w/ request
3844 @param netmap_if_name - interface name
3846 define netmap_delete {
3850 u8 netmap_if_name[64];
3853 /** \brief Delete netmap response
3854 @param context - sender context, to match reply w/ request
3855 @param retval - return value for request
3857 define netmap_delete_reply {
3862 /** \brief Dump mpls gre tunnel table
3863 @param client_index - opaque cookie to identify the sender
3864 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
3866 define mpls_gre_tunnel_dump {
3872 /** \brief mpls gre tunnel operational state response
3873 @param tunnel_index - gre tunnel identifier
3874 @param intfc_address - interface ipv4 addr
3875 @param mask_width - interface ipv4 addr mask
3876 @param hw_if_index - interface id
3878 @param tunnel_src - tunnel source ipv4 addr
3879 @param tunnel_dst - tunnel destination ipv4 addr
3880 @param outer_fib_index - gre tunnel identifier
3881 @param encap_index - reference to mpls label table
3882 @param nlabels - number of resolved labels
3883 @param labels - resolved labels
3885 define mpls_gre_tunnel_details {
3890 u32 inner_fib_index;
3897 u32 outer_fib_index;
3902 /** \brief Dump mpls eth tunnel table
3903 @param client_index - opaque cookie to identify the sender
3904 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
3906 define mpls_eth_tunnel_dump {
3912 /** \brief mpls eth tunnel operational state response
3913 @param tunnel_index - eth tunnel identifier
3914 @param intfc_address - interface ipv4 addr
3915 @param mask_width - interface ipv4 addr mask
3916 @param hw_if_index - interface id
3918 @param tunnel_dst_mac -
3919 @param tx_sw_if_index -
3920 @param encap_index - reference to mpls label table
3921 @param nlabels - number of resolved labels
3922 @param labels - resolved labels
3924 define mpls_eth_tunnel_details {
3929 u32 inner_fib_index;
3934 u8 tunnel_dst_mac[6];
3940 /** \brief Dump mpls fib table
3941 @param client_index - opaque cookie to identify the sender
3942 @param fib_index - mpls fib entry identifier or -1 in case of all entries
3944 define mpls_fib_encap_dump {
3949 /** \brief mpls fib encap table response
3950 @param fib_index - fib table id
3951 @param dest - destination ipv4 addr
3953 @param entry_index - reference to mpls label table
3954 @param nlabels - number of resolved labels
3955 @param labels - resolved labels
3957 define mpls_fib_encap_details {
3968 /** \brief Dump mpls fib decap table
3969 @param client_index - opaque cookie to identify the sender
3970 @param fib_index - mpls fib entry identifier or -1 in case of all entries
3972 define mpls_fib_decap_dump {
3977 /** \brief mpls fib decap table response
3978 @param fib_index - fib table id
3979 @param entry_index - reference to mpls label table
3980 @param dest - destination ipv4 addr
3982 @param label - mpls labels
3983 @param rx_table_id - rx fib id
3984 @param tx_table_id - tx fib id
3987 define mpls_fib_decap_details {
4000 /** \brief Classify get table IDs request
4001 @param client_index - opaque cookie to identify the sender
4002 @param context - sender context, to match reply w/ request
4004 define classify_table_ids {
4009 /** \brief Reply for classify get table IDs request
4010 @param context - sender context which was passed in the request
4011 @param count - number of ids returned in response
4012 @param ids - array of classify table ids
4014 define classify_table_ids_reply {
4021 /** \brief Classify table ids by interface index request
4022 @param client_index - opaque cookie to identify the sender
4023 @param context - sender context, to match reply w/ request
4024 @param sw_if_index - index of the interface
4026 define classify_table_by_interface {
4032 /** \brief Reply for classify table id by interface index request
4033 @param context - sender context which was passed in the request
4034 @param count - number of ids returned in response
4035 @param sw_if_index - index of the interface
4036 @param l2_table_id - l2 classify table index
4037 @param ip4_table_id - ip4 classify table index
4038 @param ip6_table_id - ip6 classify table index
4040 define classify_table_by_interface_reply {
4049 /** \brief Classify table info
4050 @param client_index - opaque cookie to identify the sender
4051 @param context - sender context, to match reply w/ request
4052 @param table_id - classify table index
4054 define classify_table_info {
4060 /** \brief Reply for classify table info request
4061 @param context - sender context which was passed in the request
4062 @param count - number of ids returned in response
4063 @param table_id - classify table index
4064 @param nbuckets - number of buckets when adding a table
4065 @param match_n_vectors - number of match vectors
4066 @param skip_n_vectors - number of skip_n_vectors
4067 @param active_sessions - number of sessions (active entries)
4068 @param next_table_index - index of next table
4069 @param miss_next_index - index of miss table
4070 @param mask[] - match mask
4072 define classify_table_info_reply {
4077 u32 match_n_vectors;
4079 u32 active_sessions;
4080 u32 next_table_index;
4081 u32 miss_next_index;
4083 u8 mask[mask_length];
4086 /** \brief Classify sessions dump request
4087 @param client_index - opaque cookie to identify the sender
4088 @param context - sender context, to match reply w/ request
4089 @param table_id - classify table index
4091 define classify_session_dump {
4097 /** \brief Reply for classify table session dump request
4098 @param context - sender context which was passed in the request
4099 @param count - number of ids returned in response
4100 @param table_id - classify table index
4101 @param hit_next_index - hit_next_index of session
4102 @param opaque_index - for add, opaque_index of session
4103 @param advance - advance value of session
4104 @param match[] - match value for session
4106 define classify_session_details {
4114 u8 match[match_length];
4117 /** \brief Enable and configure IPFIX exporter process request
4118 @param client_index - opaque cookie to identify the sender
4119 @param context - sender context, to match reply w/ request
4120 @param collector_address - address of IPFIX collector
4121 @param collector_port - port of IPFIX IPFIX collector
4122 @param src_address - address of IPFIX exporter
4123 @param vrf_id - VRF / fib table ID
4124 @param path_mtu - Path MTU between exporter and collector
4125 @param template_interval - number of seconds after which to resend template
4127 define ipfix_enable {
4130 u8 collector_address[16];
4135 u32 template_interval;
4138 /** \brief Reply to IPFIX enable and configure request
4139 @param context - sender context which was passed in the request
4141 define ipfix_enable_reply {
4146 /** \brief IPFIX dump request
4147 @param client_index - opaque cookie to identify the sender
4148 @param context - sender context, to match reply w/ request
4155 /** \brief Reply to IPFIX dump request
4156 @param context - sender context which was passed in the request
4157 @param collector_address - address of IPFIX collector
4158 @param collector_port - port of IPFIX IPFIX collector
4159 @param src_address - address of IPFIX exporter
4160 @param fib_index - fib table index
4161 @param path_mtu - Path MTU between exporter and collector
4162 @param template_interval - number of seconds after which to resend template
4164 define ipfix_details {
4166 u8 collector_address[16];
4171 u32 template_interval;
4174 /** \brief Query relative index via node names
4175 @param client_index - opaque cookie to identify the sender
4176 @param context - sender context, to match reply w/ request
4177 @param node_name - name of node to find relative index from
4178 @param next_name - next node from node_name to find relative index of
4180 define get_next_index {
4187 /** \brief Reply for get next node index
4188 @param context - sender context which was passed in the request
4189 @param retval - return value
4190 @param next_index - index of the next_node
4192 define get_next_index_reply {
4198 /** \brief PacketGenerator create interface request
4199 @param client_index - opaque cookie to identify the sender
4200 @param context - sender context, to match reply w/ request
4201 @param interface_id - interface index
4203 define pg_create_interface {
4209 /** \brief PacketGenerator create interface response
4210 @param context - sender context, to match reply w/ request
4211 @param retval - return value for request
4213 define pg_create_interface_reply {
4219 /** \brief PacketGenerator capture packets on given interface request
4220 @param client_index - opaque cookie to identify the sender
4221 @param context - sender context, to match reply w/ request
4222 @param interface_id - pg interface index
4223 @param is_enabled - 1 if enabling streams, 0 if disabling
4224 @param count - number of packets to be captured
4225 @param pcap_file - pacp file name to store captured packets
4233 u32 pcap_name_length;
4234 u8 pcap_file_name[pcap_name_length];
4237 /** \brief PacketGenerator capture packets response
4238 @param context - sender context, to match reply w/ request
4239 @param retval - return value for request
4241 define pg_capture_reply {
4246 /** \brief Enable / disable packet generator request
4247 @param client_index - opaque cookie to identify the sender
4248 @param context - sender context, to match reply w/ request
4249 @param is_enabled - 1 if enabling streams, 0 if disabling
4250 @param stream - stream name to be enable/disabled, if not specified handle all streams
4252 define pg_enable_disable {
4256 u32 stream_name_length;
4257 u8 stream_name[stream_name_length];
4260 /** \brief Reply for enable / disable packet generator
4261 @param context - returned sender context, to match reply w/ request
4262 @param retval - return code
4264 define pg_enable_disable_reply {