1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2015-2016 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
38 /** \brief Reply for interface events registration
39 @param context - returned sender context, to match reply w/ request
40 @param retval - return code
42 define want_interface_events_reply
48 /** \brief Interface details structure (fix this)
49 @param sw_if_index - index of the interface
50 @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
51 @param l2_address_length - length of the interface's l2 address
52 @param pid - the interface's l2 address
53 @param interface_name - name of the interface
54 @param link_duplex - 1 if half duplex, 2 if full duplex
55 @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
56 @param link_MTU - max. transmittion unit
57 @param sub_if_id - A number 0-N to uniquely identify this subif on super if
58 @param sub_dot1ad - 0 = dot1q, 1=dot1ad
59 @param sub_number_of_tags - Number of tags (0 - 2)
60 @param sub_outer_vlan_id
61 @param sub_inner_vlan_id
62 @param sub_exact_match
64 @param sub_outer_vlan_id_any
65 @param sub_inner_vlan_id_any
66 @param vtr_op - vlan tag rewrite operation
71 define sw_interface_details
76 /* index of sup interface (e.g. hw interface).
77 equal to sw_if_index for super hw interface. */
80 /* Layer 2 address, if applicable */
81 u32 l2_address_length;
85 u8 interface_name[64];
87 /* 1 = up, 0 = down */
91 /* 1 = half duplex, 2 = full duplex */
94 /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
100 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
103 /* 0 = dot1q, 1=dot1ad */
106 /* Number of tags 0-2 */
107 u8 sub_number_of_tags;
108 u16 sub_outer_vlan_id;
109 u16 sub_inner_vlan_id;
112 u8 sub_outer_vlan_id_any;
113 u8 sub_inner_vlan_id_any;
115 /* vlan tag rewrite state */
117 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
118 u32 vtr_tag1; // first pushed tag
119 u32 vtr_tag2; // second pushed tag
122 /** \brief Set flags on the interface
123 @param client_index - opaque cookie to identify the sender
124 @param context - sender context, to match reply w/ request
125 @param sw_if_index - index of the interface to set flags on
126 @param admin_up_down - set the admin state, 1 = up, 0 = down
127 @param link_up_down - Oper state sent on change event, not used in config.
128 @param deleted - interface was deleted
130 define sw_interface_set_flags
135 /* 1 = up, 0 = down */
141 /** \brief Reply to sw_interface_set_flags
142 @param context - sender context which was passed in the request
143 @param retval - return code of the set flags request
145 define sw_interface_set_flags_reply
152 define sw_interface_dump
156 u8 name_filter_valid;
160 /** \brief Set or delete one or all ip addresses on a specified interface
161 @param client_index - opaque cookie to identify the sender
162 @param context - sender context, to match reply w/ request
163 @param sw_if_index - index of the interface to add/del addresses
164 @param is_add - add address if non-zero, else delete
165 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
166 @param del_all - if non-zero delete all addresses on the interface
167 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
168 @param address - array of address bytes
170 define sw_interface_add_del_address
182 /** \brief Reply for interface events registration
183 @param context - returned sender context, to match reply w/ request
184 @param retval - return code
186 define sw_interface_add_del_address_reply
192 /** \brief Associate the specified interface with a fib table
193 @param client_index - opaque cookie to identify the sender
194 @param context - sender context, to match reply w/ request
195 @param sw_if_index - index of the interface
196 @param is_ipv6 - if non-zero ipv6, else ipv4
197 @param vrf_id - fib table/vrd id to associate the interface with
199 define sw_interface_set_table
208 /** \brief Reply for interface events registration
209 @param context - returned sender context, to match reply w/ request
210 @param retval - return code
212 define sw_interface_set_table_reply
218 /** \brief Enable or Disable MPLS on and interface
219 @param client_index - opaque cookie to identify the sender
220 @param context - sender context, to match reply w/ request
221 @param sw_if_index - index of the interface
222 @param enable - if non-zero enable, else disable
224 define sw_interface_set_mpls_enable
232 /** \brief Reply for MPLS state on an interface
233 @param context - returned sender context, to match reply w/ request
234 @param retval - return code
236 define sw_interface_set_mpls_enable_reply
242 /** \brief Initialize a new tap interface with the given paramters
243 @param client_index - opaque cookie to identify the sender
244 @param context - sender context, to match reply w/ request
245 @param use_random_mac - let the system generate a unique mac address
246 @param tap_name - name to associate with the new interface
247 @param mac_address - mac addr to assign to the interface if use_radom not set
257 u32 custom_dev_instance;
260 /** \brief Reply for tap connect request
261 @param context - returned sender context, to match reply w/ request
262 @param retval - return code
263 @param sw_if_index - software index allocated for the new tap interface
265 define tap_connect_reply
272 /** \brief Modify a tap interface with the given paramters
273 @param client_index - opaque cookie to identify the sender
274 @param context - sender context, to match reply w/ request
275 @param sw_if_index - interface index of existing tap interface
276 @param use_random_mac - let the system generate a unique mac address
277 @param tap_name - name to associate with the new interface
278 @param mac_address - mac addr to assign to the interface if use_radom not set
289 u32 custom_dev_instance;
292 /** \brief Reply for tap modify request
293 @param context - returned sender context, to match reply w/ request
294 @param retval - return code
295 @param sw_if_index - software index if the modified tap interface
297 define tap_modify_reply
304 /** \brief Delete tap interface
305 @param client_index - opaque cookie to identify the sender
306 @param context - sender context, to match reply w/ request
307 @param sw_if_index - interface index of existing tap interface
316 /** \brief Reply for tap delete request
317 @param context - returned sender context, to match reply w/ request
318 @param retval - return code
320 define tap_delete_reply
326 /** \brief Dump tap interfaces request */
327 define sw_interface_tap_dump
333 /** \brief Reply for tap dump request
334 @param sw_if_index - software index of tap interface
335 @param dev_name - Linux tap device name
337 define sw_interface_tap_details
344 /** \brief Create a new subinterface with the given vlan id
345 @param client_index - opaque cookie to identify the sender
346 @param context - sender context, to match reply w/ request
347 @param sw_if_index - software index of the new vlan's parent interface
348 @param vlan_id - vlan tag of the new interface
350 define create_vlan_subif
358 /** \brief Reply for the vlan subinterface create request
359 @param context - returned sender context, to match reply w/ request
360 @param retval - return code
361 @param sw_if_index - software index allocated for the new subinterface
363 define create_vlan_subif_reply
370 /** \brief Add / del route request
371 @param client_index - opaque cookie to identify the sender
372 @param context - sender context, to match reply w/ request
373 @param sw_if_index - software index of the new vlan's parent interface
374 @param vrf_id - fib table /vrf associated with the route
375 @param lookup_in_vrf -
376 @param resolve_attempts -
377 @param classify_table_index -
378 @param create_vrf_if_needed -
379 @param resolve_if_needed -
380 @param is_add - 1 if adding the route, 0 if deleting
382 @param is_ipv6 - 0 if an ip4 route, else ip6
385 @param is_multipath - Set to 1 if this is a multipath route, else 0
386 @param not_last - Is last or not last msg in group of multiple add/del msgs
387 @param next_hop_weight -
388 @param dst_address_length -
389 @param dst_address[16] -
390 @param next_hop_address[16] -
392 define ip_add_del_route
396 u32 next_hop_sw_if_index;
399 u32 resolve_attempts;
400 u32 classify_table_index;
401 u8 create_vrf_if_needed;
402 u8 resolve_if_needed;
410 u8 is_resolve_attached;
411 /* Is last/not-last message in group of multiple add/del messages. */
414 u8 dst_address_length;
416 u8 next_hop_address[16];
419 /** \brief Reply for add / del route request
420 @param context - returned sender context, to match reply w/ request
421 @param retval - return code
423 define ip_add_del_route_reply
430 /** \brief Add / del gre tunnel request
431 @param client_index - opaque cookie to identify the sender
432 @param context - sender context, to match reply w/ request
433 @param sw_if_index - software index of the new vlan's parent interface
434 @param inner_vrf_id -
435 @param outer_vrf_id -
436 @param is_add - 1 if adding the tunnel, 0 if deleting
437 @param src_address[4] - tunnel source address
438 @param dst_address[4] - tunnel destination address
439 @param intf_address -
440 @param intf_address_length -
442 define mpls_gre_add_del_tunnel
453 u8 intfc_address_length;
456 /** \brief Reply for add / del tunnel request
457 @param context - returned sender context, to match reply w/ request
458 @param retval - return code
460 define mpls_gre_add_del_tunnel_reply
464 u32 tunnel_sw_if_index;
467 /** \brief Add / del MPLS encapsulation request
468 @param client_index - opaque cookie to identify the sender
469 @param context - sender context, to match reply w/ request
470 @param vrf_id - vrf id
471 @param dst_address[4] -
472 @param is_add - 1 if adding the encap, 0 if deleting
473 @param nlabels - number of labels
474 @param labels - array of labels
476 define mpls_add_del_encap
482 /* 1 = add, 0 = delete */
488 /** \brief Reply for add / del encapsulation request
489 @param context - returned sender context, to match reply w/ request
490 @param retval - return code
492 define mpls_add_del_encap_reply
498 /** \brief Add / del MPLS decapsulation request
499 @param client_index - opaque cookie to identify the sender
500 @param context - sender context, to match reply w/ request
501 @param rx_vrf_id - receive vrf
502 @param tx_vrf_id - transmit vrf
506 @param is_add - 1 if adding the encap, 0 if deleting
508 define mpls_add_del_decap
520 /** \brief Reply for MPLS decap add / del request
521 @param context - returned sender context, to match reply w/ request
522 @param retval - return code
524 define mpls_add_del_decap_reply
530 /** \brief Proxy ARP add / del request
531 @param client_index - opaque cookie to identify the sender
532 @param context - sender context, to match reply w/ request
533 @param vrf_id - VRF / Fib table ID
534 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
535 @param low_address[4] - Low address of the Proxy ARP range
536 @param hi_address[4] - High address of the Proxy ARP range
538 define proxy_arp_add_del
548 /** \brief Reply for proxy arp add / del request
549 @param context - returned sender context, to match reply w/ request
550 @param retval - return code
552 define proxy_arp_add_del_reply
558 /** \brief Proxy ARP add / del request
559 @param client_index - opaque cookie to identify the sender
560 @param context - sender context, to match reply w/ request
561 @param sw_if_index - Which interface to enable / disable Proxy Arp on
562 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
564 define proxy_arp_intfc_enable_disable
569 /* 1 = on, 0 = off */
573 /** \brief Reply for Proxy ARP interface enable / disable request
574 @param context - returned sender context, to match reply w/ request
575 @param retval - return code
577 define proxy_arp_intfc_enable_disable_reply
583 /** \brief IP neighbor add / del request
584 @param client_index - opaque cookie to identify the sender
585 @param context - sender context, to match reply w/ request
586 @param vrf_id - vrf_id, only for IP4
587 @param sw_if_index - interface used to reach neighbor
588 @param is_add - 1 to add neighbor, 0 to delete
589 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
591 @param mac_address - l2 address of the neighbor
592 @param dst_address - ip4 or ip6 address of the neighbor
594 define ip_neighbor_add_del
598 u32 vrf_id; /* only makes sense for ip4 */
600 /* 1 = add, 0 = delete */
608 /** \brief Reply for IP Neighbor add / delete request
609 @param context - returned sender context, to match reply w/ request
610 @param retval - return code
612 define ip_neighbor_add_del_reply
618 /** \brief Reset VRF (remove all routes etc) request
619 @param client_index - opaque cookie to identify the sender
620 @param context - sender context, to match reply w/ request
621 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
622 @param vrf_id - ID of th FIB table / VRF to reset
632 /** \brief Reply for Reset VRF request
633 @param context - returned sender context, to match reply w/ request
634 @param retval - return code
636 define reset_vrf_reply
642 /** \brief Is Address Reachable request - DISABLED
643 @param client_index - opaque cookie to identify the sender
644 @param context - sender context, to match reply w/ request
645 @param next_hop_sw_if_index - index of interface used to get to next hop
646 @param is_ipv6 - 1 for IPv6, 0 for IPv4
647 @param is_error - address not found or does not match intf
648 @param address[] - Address in question
650 define is_address_reachable
652 u32 client_index; /* (api_main_t *) am->my_client_index */
654 u32 next_hop_sw_if_index;
655 u8 is_known; /* on reply, this is the answer */
657 u8 is_error; /* address not found or does not match intf */
661 /** \brief Want Stats, register for stats updates
662 @param client_index - opaque cookie to identify the sender
663 @param context - sender context, to match reply w/ request
664 @param enable_disable - 1 = enable stats, 0 = disable
665 @param pid - pid of process requesting stats updates
675 /** \brief Reply for Want Stats request
676 @param context - returned sender context, to match reply w/ request
677 @param retval - return code
679 define want_stats_reply
685 /** \brief Want stats counters structure
686 @param vnet_counter_type- such as ip4, ip6, punts, etc
687 @param is_combined - rx & tx total (all types) counts
688 @param first_sw_if_index - first sw index in block of index, counts
689 @param count - number of interfaces this stats block includes counters for
690 @param data - contiguous block of vlib_counter_t structures
692 define vnet_interface_counters
694 /* enums - plural - in vnet/interface.h */
695 u8 vnet_counter_type;
697 u32 first_sw_if_index;
702 typeonly manual_print manual_endian define ip4_fib_counter
710 manual_print manual_endian define vnet_ip4_fib_counters
714 vl_api_ip4_fib_counter_t c[count];
717 typeonly manual_print manual_endian define ip6_fib_counter
725 manual_print manual_endian define vnet_ip6_fib_counters
729 vl_api_ip6_fib_counter_t c[count];
732 /** \brief Request for a single block of summary stats
733 @param client_index - opaque cookie to identify the sender
734 @param context - sender context, to match reply w/ request
736 define vnet_get_summary_stats
742 /** \brief Reply for vnet_get_summary_stats request
743 @param context - sender context, to match reply w/ request
744 @param retval - return code for request
749 define vnet_summary_stats_reply
758 /** \brief OAM event structure
759 @param dst_address[] -
768 /** \brief Want OAM events request
769 @param client_index - opaque cookie to identify the sender
770 @param context - sender context, to match reply w/ request
771 @param enable_disable- enable if non-zero, else disable
772 @param pid - pid of the requesting process
774 define want_oam_events
782 /** \brief Want OAM events response
783 @param context - sender context, to match reply w/ request
784 @param retval - return code for the want oam stats request
786 define want_oam_events_reply
792 /** \brief OAM add / del target request
793 @param client_index - opaque cookie to identify the sender
794 @param context - sender context, to match reply w/ request
795 @param vrf_id - vrf_id of the target
796 @param src_address[] - source address to use for the updates
797 @param dst_address[] - destination address of the target
798 @param is_add - add target if non-zero, else delete
810 /** \brief OAM add / del target response
811 @param context - sender context, to match reply w/ request
812 @param retval - return code of the request
814 define oam_add_del_reply
820 /** \brief Reset fib table request
821 @param client_index - opaque cookie to identify the sender
822 @param context - sender context, to match reply w/ request
823 @param vrf_id - vrf/table id of the fib table to reset
824 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
834 /** \brief Reset fib response
835 @param context - sender context, to match reply w/ request
836 @param retval - return code for the reset bfib request
838 define reset_fib_reply
844 /** \brief DHCP Proxy config add / del request
845 @param client_index - opaque cookie to identify the sender
846 @param context - sender context, to match reply w/ request
847 @param vrf_id - vrf id
848 @param if_ipv6 - ipv6 if non-zero, else ipv4
849 @param is_add - add the config if non-zero, else delete
850 @param insert_circuit_id - option82 suboption 1 fib number
851 @param dhcp_server[] - server address
852 @param dhcp_src_address[] - <fix this, need details>
854 define dhcp_proxy_config
861 u8 insert_circuit_id;
863 u8 dhcp_src_address[16];
866 /** \brief DHCP Proxy config response
867 @param context - sender context, to match reply w/ request
868 @param retval - return code for the request
870 define dhcp_proxy_config_reply
876 /** \brief DHCP Proxy set / unset vss request
877 @param client_index - opaque cookie to identify the sender
878 @param context - sender context, to match reply w/ request
879 @param tbl_id - table id
880 @param oui - first part of vpn id
881 @param fib_id - second part of vpn id
882 @param is_ipv6 - ip6 if non-zero, else ip4
883 @param is_add - set vss if non-zero, else delete
885 define dhcp_proxy_set_vss
896 /** \brief DHCP proxy set / unset vss response
897 @param context - sender context, to match reply w/ request
898 @param retval - return code for the request
900 define dhcp_proxy_set_vss_reply
906 /** \brief Set the ip flow hash config for a fib request
907 @param client_index - opaque cookie to identify the sender
908 @param context - sender context, to match reply w/ request
909 @param vrf_id - vrf/fib id
910 @param is_ipv6 - if non-zero the fib is ip6, else ip4
911 @param src - if non-zero include src in flow hash
912 @param dst - if non-zero include dst in flow hash
913 @param sport - if non-zero include sport in flow hash
914 @param dport - if non-zero include dport in flow hash
915 @param proto -if non-zero include proto in flow hash
916 @param reverse - if non-zero include reverse in flow hash
918 define set_ip_flow_hash
932 /** \brief Set the ip flow hash config for a fib response
933 @param context - sender context, to match reply w/ request
934 @param retval - return code for the request
936 define set_ip_flow_hash_reply
942 /** \brief IPv6 router advertisement config request
943 @param client_index - opaque cookie to identify the sender
944 @param context - sender context, to match reply w/ request
949 @param send_unicast -
952 @param default_router -
953 @param max_interval -
954 @param min_interval -
956 @param initial_count -
957 @param initial_interval -
959 define sw_interface_ip6nd_ra_config
976 u32 initial_interval;
979 /** \brief IPv6 router advertisement config response
980 @param context - sender context, to match reply w/ request
981 @param retval - return code for the request
983 define sw_interface_ip6nd_ra_config_reply
989 /** \brief IPv6 router advertisement prefix config request
990 @param client_index - opaque cookie to identify the sender
991 @param context - sender context, to match reply w/ request
994 @param address_length -
996 @param no_advertise -
998 @param no_autoconfig -
1001 @param val_lifetime -
1002 @param pref_lifetime -
1004 define sw_interface_ip6nd_ra_prefix
1021 /** \brief IPv6 router advertisement prefix config response
1022 @param context - sender context, to match reply w/ request
1023 @param retval - return code for the request
1025 define sw_interface_ip6nd_ra_prefix_reply
1031 /** \brief IPv6 interface enable / disable request
1032 @param client_index - opaque cookie to identify the sender
1033 @param context - sender context, to match reply w/ request
1034 @param sw_if_index - interface used to reach neighbor
1035 @param enable - if non-zero enable ip6 on interface, else disable
1037 define sw_interface_ip6_enable_disable
1042 u8 enable; /* set to true if enable */
1045 /** \brief IPv6 interface enable / disable response
1046 @param context - sender context, to match reply w/ request
1047 @param retval - return code for the request
1049 define sw_interface_ip6_enable_disable_reply
1055 /** \brief IPv6 set link local address on interface request
1056 @param client_index - opaque cookie to identify the sender
1057 @param context - sender context, to match reply w/ request
1058 @param sw_if_index - interface to set link local on
1059 @param address[] - the new link local address
1060 @param address_length - link local address length
1062 define sw_interface_ip6_set_link_local_address
1071 /** \brief IPv6 set link local address on interface response
1072 @param context - sender context, to match reply w/ request
1073 @param retval - error code for the request
1075 define sw_interface_ip6_set_link_local_address_reply
1081 /** \brief Set unnumbered interface add / del request
1082 @param client_index - opaque cookie to identify the sender
1083 @param context - sender context, to match reply w/ request
1084 @param sw_if_index - interface with an IP address
1085 @param unnumbered_sw_if_index - interface which will use the address
1086 @param is_add - if non-zero set the association, else unset it
1088 define sw_interface_set_unnumbered
1092 u32 sw_if_index; /* use this intfc address */
1093 u32 unnumbered_sw_if_index; /* on this interface */
1097 /** \brief Set unnumbered interface add / del response
1098 @param context - sender context, to match reply w/ request
1099 @param retval - return code for the request
1101 define sw_interface_set_unnumbered_reply
1107 /** \brief Create loopback interface request
1108 @param client_index - opaque cookie to identify the sender
1109 @param context - sender context, to match reply w/ request
1110 @param mac_address - mac addr to assign to the interface if none-zero
1112 define create_loopback
1119 /** \brief Create loopback interface response
1120 @param context - sender context, to match reply w/ request
1121 @param sw_if_index - sw index of the interface that was created
1122 @param retval - return code for the request
1124 define create_loopback_reply
1131 /** \brief Delete loopback interface request
1132 @param client_index - opaque cookie to identify the sender
1133 @param context - sender context, to match reply w/ request
1134 @param sw_if_index - sw index of the interface that was created
1136 define delete_loopback
1143 /** \brief Delete loopback interface response
1144 @param context - sender context, to match reply w/ request
1145 @param retval - return code for the request
1147 define delete_loopback_reply
1153 /** \brief Control ping from client to api server request
1154 @param client_index - opaque cookie to identify the sender
1155 @param context - sender context, to match reply w/ request
1163 /** \brief Control ping from the client to the server response
1164 @param client_index - opaque cookie to identify the sender
1165 @param context - sender context, to match reply w/ request
1166 @param retval - return code for the request
1167 @param vpe_pid - the pid of the vpe, returned by the server
1169 define control_ping_reply
1177 /** \brief Process a vpe parser cli string request
1178 @param client_index - opaque cookie to identify the sender
1179 @param context - sender context, to match reply w/ request
1180 @param cmd_in_shmem - pointer to cli command string
1196 /** \brief vpe parser cli string response
1197 @param context - sender context, to match reply w/ request
1198 @param retval - return code for request
1199 @param reply_in_shmem - Reply string from cli processing if any
1207 define cli_inband_reply
1215 /** \brief Set max allowed ARP or ip6 neighbor entries request
1216 @param client_index - opaque cookie to identify the sender
1217 @param context - sender context, to match reply w/ request
1218 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1219 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1221 define set_arp_neighbor_limit
1226 u32 arp_neighbor_limit;
1229 /** \brief Set max allowed ARP or ip6 neighbor entries response
1230 @param context - sender context, to match reply w/ request
1231 @param retval - return code for request
1233 define set_arp_neighbor_limit_reply
1239 /** \brief L2 interface patch add / del request
1240 @param client_index - opaque cookie to identify the sender
1241 @param context - sender context, to match reply w/ request
1242 @param rx_sw_if_index - receive side interface
1243 @param tx_sw_if_index - transmit side interface
1244 @param is_add - if non-zero set up the interface patch, else remove it
1246 define l2_patch_add_del
1255 /** \brief L2 interface patch add / del response
1256 @param context - sender context, to match reply w/ request
1257 @param retval - return code for the request
1259 define l2_patch_add_del_reply
1265 /** \brief IPv6 segment routing tunnel add / del request
1266 @param client_index - opaque cookie to identify the sender
1267 @param context - sender context, to match reply w/ request
1268 @param is_add - add the tunnel if non-zero, else delete it
1269 @param name[] - tunnel name (len. 64)
1270 @param src_address[] -
1271 @param dst_address[] -
1272 @param dst_mask_width -
1273 @param inner_vrf_id -
1274 @param outer_vrf_id -
1275 @param flags_net_byte_order -
1278 @param segs_and_tags[] -
1279 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1281 define sr_tunnel_add_del
1292 u16 flags_net_byte_order;
1295 u8 segs_and_tags[0];
1299 /** \brief IPv6 segment routing tunnel add / del response
1300 @param context - sender context, to match reply w/ request
1301 @param retval - return value for request
1303 define sr_tunnel_add_del_reply
1309 /** \brief IPv6 segment routing policy add / del request
1310 @param client_index - opaque cookie to identify the sender
1311 @param context - sender context, to match reply w/ request
1312 @param is_add - add the tunnel if non-zero, else delete it
1313 @param name[] - policy name (len. 64)
1314 @param tunnel_names[] -
1316 define sr_policy_add_del
1325 /** \brief IPv6 segment routing policy add / del response
1326 @param context - sender context, to match reply w/ request
1327 @param retval - return value for request
1329 define sr_policy_add_del_reply
1335 /** \brief IPv6 segment routing multicast map to policy add / del request
1336 @param client_index - opaque cookie to identify the sender
1337 @param context - sender context, to match reply w/ request
1338 @param is_add - add the tunnel if non-zero, else delete it
1339 @param multicast_address[] - IP6 multicast address
1340 @param policy_name[] = policy name (len.64)
1342 define sr_multicast_map_add_del
1347 u8 multicast_address[16];
1351 /** \brief IPv6 segment routing multicast map to policy add / del response
1352 @param context - sender context, to match reply w/ request
1353 @param retval - return value for request
1355 define sr_multicast_map_add_del_reply
1361 /** \brief Interface set vpath request
1362 @param client_index - opaque cookie to identify the sender
1363 @param context - sender context, to match reply w/ request
1364 @param sw_if_index - interface used to reach neighbor
1365 @param enable - if non-zero enable, else disable
1367 define sw_interface_set_vpath
1375 /** \brief Interface set vpath response
1376 @param context - sender context, to match reply w/ request
1377 @param retval - return code for the request
1379 define sw_interface_set_vpath_reply
1385 /** \brief MPLS Ethernet add / del tunnel request
1386 @param client_index - opaque cookie to identify the sender
1387 @param context - sender context, to match reply w/ request
1388 @param vrf_id - vrf_id, only for IP4
1389 @param sw_if_index - interface used to reach neighbor
1390 @param is_add - add if set, tunnel delete if 0
1391 @param dst_mac_address -
1392 @param adj_address -
1393 @param adj_address_length -
1395 define mpls_ethernet_add_del_tunnel
1403 u8 dst_mac_address[6];
1405 u8 adj_address_length;
1408 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1409 @param context - sender context, to match reply w/ request
1410 @param retval - return code for the request
1412 define mpls_ethernet_add_del_tunnel_reply
1416 u32 tunnel_sw_if_index;
1418 /** \brief MPLS Ethernet add/ del tunnel 2
1419 @param client_index - opaque cookie to identify the sender
1420 @param context - sender context, to match reply w/ request
1421 @param inner_vrf_id -
1422 @param outer_vrf_id -
1423 @param resolve_attempts -
1424 @param resolve_opaque -
1425 @param resolve_if_needed -
1427 @param adj_address -
1428 @param adj_address_length -
1429 @param next_hop_ip4_address_in_outer_vrf -
1431 define mpls_ethernet_add_del_tunnel_2
1437 u32 resolve_attempts;
1438 u32 resolve_opaque; /* no need to set this */
1439 u8 resolve_if_needed;
1443 u8 adj_address_length;
1444 u8 next_hop_ip4_address_in_outer_vrf[4];
1447 /** \brief MPLS Ethernet add/ del tunnel 2
1448 @param context - sender context, to match reply w/ request
1449 @param retval - return code for add /del request
1451 define mpls_ethernet_add_del_tunnel_2_reply
1457 /** \brief Set L2 XConnect between two interfaces request
1458 @param client_index - opaque cookie to identify the sender
1459 @param context - sender context, to match reply w/ request
1460 @param rx_sw_if_index - Receive interface index
1461 @param tx_sw_if_index - Transmit interface index
1462 @param enable - enable xconnect if not 0, else set to L3 mode
1464 define sw_interface_set_l2_xconnect
1473 /** \brief Set L2 XConnect response
1474 @param context - sender context, to match reply w/ request
1475 @param retval - L2 XConnect request return code
1477 define sw_interface_set_l2_xconnect_reply
1483 /** \brief Interface bridge mode request
1484 @param client_index - opaque cookie to identify the sender
1485 @param context - sender context, to match reply w/ request
1486 @param rx_sw_if_index - the interface
1487 @param bd_id - bridge domain id
1488 @param bvi - Setup interface as a bvi, bridge mode only
1489 @param shg - Shared horizon group, for bridge mode only
1490 @param enable - Enable beige mode if not 0, else set to L3 mode
1492 define sw_interface_set_l2_bridge
1503 /** \brief Interface bridge mode response
1504 @param context - sender context, to match reply w/ request
1505 @param retval - Bridge mode request return code
1507 define sw_interface_set_l2_bridge_reply
1513 /** \brief L2 FIB add entry request
1514 @param client_index - opaque cookie to identify the sender
1515 @param context - sender context, to match reply w/ request
1516 @param mac - the entry's mac address
1517 @param bd_id - the entry's bridge domain id
1518 @param sw_if_index - the interface
1519 @param is_add - If non zero add the entry, else delete it
1523 define l2fib_add_del
1536 /** \brief L2 FIB add entry response
1537 @param context - sender context, to match reply w/ request
1538 @param retval - return code for the add l2fib entry request
1540 define l2fib_add_del_reply
1546 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1547 @param client_index - opaque cookie to identify the sender
1548 @param context - sender context, to match reply w/ request
1549 @param sw_if_index - interface
1550 @param is_set - if non-zero, set the bits, else clear them
1551 @param feature_bitmap - non-zero bits to set or clear
1562 /** \brief Set L2 bits response
1563 @param context - sender context, to match reply w/ request
1564 @param retval - return code for the set l2 bits request
1566 define l2_flags_reply
1570 u32 resulting_feature_bitmap;
1573 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1574 L2_UU_FLOOD, or L2_ARP_TERM) request
1575 @param client_index - opaque cookie to identify the sender
1576 @param context - sender context, to match reply w/ request
1577 @param bd_id - the bridge domain to set the flags for
1578 @param is_set - if non-zero, set the flags, else clear them
1579 @param feature_bitmap - bits that are non-zero to set or clear
1590 /** \brief Set bridge flags response
1591 @param context - sender context, to match reply w/ request
1592 @param retval - return code for the set bridge flags request
1593 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1595 define bridge_flags_reply
1599 u32 resulting_feature_bitmap;
1602 /** \brief Set bridge domain ip to mac entry request
1603 @param client_index - opaque cookie to identify the sender
1604 @param context - sender context, to match reply w/ request
1605 @param bd_id - the bridge domain to set the flags for
1606 @param is_add - if non-zero, add the entry, else clear it
1607 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1608 @param mac_address - MAC address
1611 define bd_ip_mac_add_del
1622 /** \brief Set bridge domain ip to mac entry response
1623 @param context - sender context, to match reply w/ request
1624 @param retval - return code for the set bridge flags request
1626 define bd_ip_mac_add_del_reply
1632 /** \brief Add/Delete classification table request
1633 @param client_index - opaque cookie to identify the sender
1634 @param context - sender context, to match reply w/ request
1635 @param is_add- if non-zero add the table, else delete it
1636 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1637 @param nbuckets - number of buckets when adding a table
1638 @param memory_size - memory size when adding a table
1639 @param match_n_vectors - number of match vectors
1640 @param next_table_index - index of next table
1641 @param miss_next_index - index of miss table
1642 @param mask[] - match mask
1644 define classify_add_del_table
1653 u32 match_n_vectors;
1654 u32 next_table_index;
1655 u32 miss_next_index;
1659 /** \brief Add/Delete classification table response
1660 @param context - sender context, to match reply w/ request
1661 @param retval - return code for the table add/del requst
1662 @param new_table_index - for add, returned index of the new table
1663 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1664 @param match_n_vectors -for add, returned value of match_n_vectors in table
1666 define classify_add_del_table_reply
1670 u32 new_table_index;
1672 u32 match_n_vectors;
1675 /** \brief Classify add / del session request
1676 @param client_index - opaque cookie to identify the sender
1677 @param context - sender context, to match reply w/ request
1678 @param is_add - add session if non-zero, else delete
1679 @param table_index - index of the table to add/del the session, required
1680 @param hit_next_index - for add, hit_next_index of new session, required
1681 @param opaque_index - for add, opaque_index of new session
1682 @param advance -for add, advance value for session
1683 @param match[] - for add, match value for session, required
1685 define classify_add_del_session
1697 /** \brief Classify add / del session response
1698 @param context - sender context, to match reply w/ request
1699 @param retval - return code for the add/del session request
1701 define classify_add_del_session_reply
1707 /** \brief Set/unset the classification table for an interface request
1708 @param client_index - opaque cookie to identify the sender
1709 @param context - sender context, to match reply w/ request
1710 @param is_ipv6 - ipv6 if non-zero, else ipv4
1711 @param sw_if_index - interface to associate with the table
1712 @param table_index - index of the table, if ~0 unset the table
1714 define classify_set_interface_ip_table
1720 u32 table_index; /* ~0 => off */
1723 /** \brief Set/unset interface classification table response
1724 @param context - sender context, to match reply w/ request
1725 @param retval - return code
1727 define classify_set_interface_ip_table_reply
1733 /** \brief Set/unset l2 classification tables for an interface request
1734 @param client_index - opaque cookie to identify the sender
1735 @param context - sender context, to match reply w/ request
1736 @param sw_if_index - interface to set/unset tables for
1737 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1738 @param ip6_table_index - ip6 index
1739 @param other_table_index - other index
1741 define classify_set_interface_l2_tables
1747 u32 ip4_table_index;
1748 u32 ip6_table_index;
1749 u32 other_table_index;
1753 /** \brief Set/unset l2 classification tables for an interface response
1754 @param context - sender context, to match reply w/ request
1755 @param retval - return code for the request
1757 define classify_set_interface_l2_tables_reply
1763 /** \brief Get node index using name request
1764 @param client_index - opaque cookie to identify the sender
1765 @param context - sender context, to match reply w/ request
1766 @param node_name[] - name of the node
1768 define get_node_index
1775 /** \brief Get node index using name request
1776 @param context - sender context, to match reply w/ request
1777 @param retval - return code for the request
1778 @param node_index - index of the desired node if found, else ~0
1780 define get_node_index_reply
1787 /** \brief Set the next node for a given node request
1788 @param client_index - opaque cookie to identify the sender
1789 @param context - sender context, to match reply w/ request
1790 @param node_name[] - node to add the next node to
1791 @param next_name[] - node to add as the next node
1793 define add_node_next
1801 /** \brief IP Set the next node for a given node response
1802 @param context - sender context, to match reply w/ request
1803 @param retval - return code for the add next node request
1804 @param next_index - the index of the next node if success, else ~0
1806 define add_node_next_reply
1813 /** \brief DHCP Proxy config 2 add / del request
1814 @param client_index - opaque cookie to identify the sender
1815 @param context - sender context, to match reply w/ request
1816 @param rx_vrf_id - receive vrf id
1817 @param server_vrf_id - server vrf id
1818 @param if_ipv6 - ipv6 if non-zero, else ipv4
1819 @param is_add - add the config if non-zero, else delete
1820 @param insert_circuit_id - option82 suboption 1 fib number
1821 @param dhcp_server[] - server address
1822 @param dhcp_src_address[] - <fix this, need details>
1824 define dhcp_proxy_config_2
1832 u8 insert_circuit_id;
1834 u8 dhcp_src_address[16];
1837 /** \brief DHCP Proxy config 2 add / del response
1838 @param context - sender context, to match reply w/ request
1839 @param retval - return code for request
1841 define dhcp_proxy_config_2_reply
1847 /** \brief l2tpv3 tunnel interface create request
1848 @param client_index - opaque cookie to identify the sender
1849 @param context - sender context, to match reply w/ request
1850 @param client_address - remote client tunnel ip address
1851 @param client_address - local tunnel ip address
1852 @param is_ipv6 - ipv6 if non-zero, else ipv4
1853 @param local_session_id - local tunnel session id
1854 @param remote_session_id - remote tunnel session id
1855 @param local_cookie - local tunnel cookie
1856 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1857 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1859 define l2tpv3_create_tunnel
1863 u8 client_address[16];
1866 u32 local_session_id;
1867 u32 remote_session_id;
1870 u8 l2_sublayer_present;
1874 /** \brief l2tpv3 tunnel interface create response
1875 @param context - sender context, to match reply w/ request
1876 @param retval - return code for the request
1877 @param sw_if_index - index of the new tunnel interface
1879 define l2tpv3_create_tunnel_reply
1886 define l2tpv3_set_tunnel_cookies
1891 u64 new_local_cookie;
1892 u64 new_remote_cookie;
1895 /** \brief L2TP tunnel set cookies response
1896 @param context - sender context, to match reply w/ request
1897 @param retval - return code for the request
1899 define l2tpv3_set_tunnel_cookies_reply
1905 define sw_if_l2tpv3_tunnel_details
1909 u8 interface_name[64];
1910 u8 client_address[16];
1912 u32 local_session_id;
1913 u32 remote_session_id;
1914 u64 local_cookie[2];
1916 u8 l2_sublayer_present;
1919 define sw_if_l2tpv3_tunnel_dump
1925 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1926 @param client_index - opaque cookie to identify the sender
1927 @param context - sender context, to match reply w/ request
1929 define l2_fib_clear_table
1935 /** \brief L2 fib clear table response
1936 @param context - sender context, to match reply w/ request
1937 @param retval - return code for the request
1939 define l2_fib_clear_table_reply
1945 /** \brief L2 interface ethernet flow point filtering enable/disable request
1946 @param client_index - opaque cookie to identify the sender
1947 @param context - sender context, to match reply w/ request
1948 @param sw_if_index - interface to enable/disable filtering on
1949 @param enable_disable - if non-zero enable filtering, else disable
1951 define l2_interface_efp_filter
1959 /** \brief L2 interface ethernet flow point filtering response
1960 @param context - sender context, to match reply w/ request
1961 @param retval - return code for the request
1963 define l2_interface_efp_filter_reply
1969 define l2tpv3_interface_enable_disable
1977 define l2tpv3_interface_enable_disable_reply
1983 define l2tpv3_set_lookup_key
1987 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1991 define l2tpv3_set_lookup_key_reply
1997 define vxlan_add_del_tunnel
2006 u32 decap_next_index;
2010 define vxlan_add_del_tunnel_reply
2017 define vxlan_tunnel_dump
2024 define vxlan_tunnel_details
2031 u32 decap_next_index;
2036 define gre_add_del_tunnel
2048 define gre_add_del_tunnel_reply
2055 define gre_tunnel_dump
2062 define gre_tunnel_details
2073 /** \brief L2 interface vlan tag rewrite configure request
2074 @param client_index - opaque cookie to identify the sender
2075 @param context - sender context, to match reply w/ request
2076 @param sw_if_index - interface the operation is applied to
2077 @param vtr_op - Choose from l2_vtr_op_t enum values
2078 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
2079 @param tag1 - Needed for any push or translate vtr op
2080 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
2082 define l2_interface_vlan_tag_rewrite
2088 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
2089 u32 tag1; // first pushed tag
2090 u32 tag2; // second pushed tag
2093 /** \brief L2 interface vlan tag rewrite response
2094 @param context - sender context, to match reply w/ request
2095 @param retval - return code for the request
2097 define l2_interface_vlan_tag_rewrite_reply
2103 /** \brief vhost-user interface create request
2104 @param client_index - opaque cookie to identify the sender
2105 @param is_server - our side is socket server
2106 @param sock_filename - unix socket filename, used to speak with frontend
2107 @param use_custom_mac - enable or disable the use of the provided hardware address
2108 @param mac_address - hardware address to use if 'use_custom_mac' is set
2110 define create_vhost_user_if
2115 u8 sock_filename[256];
2117 u32 custom_dev_instance;
2122 /** \brief vhost-user interface create response
2123 @param context - sender context, to match reply w/ request
2124 @param retval - return code for the request
2125 @param sw_if_index - interface the operation is applied to
2127 define create_vhost_user_if_reply
2134 /** \brief vhost-user interface modify request
2135 @param client_index - opaque cookie to identify the sender
2136 @param is_server - our side is socket server
2137 @param sock_filename - unix socket filename, used to speak with frontend
2139 define modify_vhost_user_if
2145 u8 sock_filename[256];
2147 u32 custom_dev_instance;
2150 /** \brief vhost-user interface modify response
2151 @param context - sender context, to match reply w/ request
2152 @param retval - return code for the request
2154 define modify_vhost_user_if_reply
2160 /** \brief vhost-user interface delete request
2161 @param client_index - opaque cookie to identify the sender
2163 define delete_vhost_user_if
2170 /** \brief vhost-user interface delete response
2171 @param context - sender context, to match reply w/ request
2172 @param retval - return code for the request
2174 define delete_vhost_user_if_reply
2187 /* These fields map directly onto the subif template */
2191 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2194 u8 outer_vlan_id_any;
2195 u8 inner_vlan_id_any;
2200 define create_subif_reply
2207 /** \brief show version
2208 @param client_index - opaque cookie to identify the sender
2209 @param context - sender context, to match reply w/ request
2217 /** \brief show version response
2218 @param context - sender context, to match reply w/ request
2219 @param retval - return code for the request
2220 @param program - name of the program (vpe)
2221 @param version - version of the program
2222 @param build_directory - root of the workspace where the program was built
2224 define show_version_reply
2231 u8 build_directory[256];
2234 /** \brief Vhost-user interface details structure (fix this)
2235 @param sw_if_index - index of the interface
2236 @param interface_name - name of interface
2237 @param virtio_net_hdr_sz - net header size
2238 @param features - interface features
2239 @param is_server - vhost-user server socket
2240 @param sock_filename - socket filename
2241 @param num_regions - number of used memory regions
2243 define sw_interface_vhost_user_details
2247 u8 interface_name[64];
2248 u32 virtio_net_hdr_sz;
2251 u8 sock_filename[256];
2257 define sw_interface_vhost_user_dump
2263 define ip_address_details
2271 define ip_address_dump
2292 /** \brief l2 fib table entry structure
2293 @param bd_id - the l2 fib / bridge domain table id
2294 @param mac - the entry's mac address
2295 @param sw_if_index - index of the interface
2296 @param static_mac - the entry is statically configured.
2297 @param filter_mac - the entry is a mac filter entry.
2298 @param bvi_mac - the mac address is a bridge virtual interface
2300 define l2_fib_table_entry
2311 /** \brief Dump l2 fib (aka bridge domain) table
2312 @param client_index - opaque cookie to identify the sender
2313 @param bd_id - the l2 fib / bridge domain table identifier
2315 define l2_fib_table_dump
2322 define vxlan_gpe_add_del_tunnel
2336 define vxlan_gpe_add_del_tunnel_reply
2343 define vxlan_gpe_tunnel_dump
2350 define vxlan_gpe_tunnel_details
2363 /** \brief add or delete locator_set
2364 @param client_index - opaque cookie to identify the sender
2365 @param context - sender context, to match reply w/ request
2366 @param is_add - add address if non-zero, else delete
2367 @param locator_set_name - locator name
2368 @param locator_num - number of locators
2369 @param locators - LISP locator records
2370 Structure of one locator record is as follows:
2378 define lisp_add_del_locator_set
2383 u8 locator_set_name[64];
2388 /** \brief Reply for locator_set add/del
2389 @param context - returned sender context, to match reply w/ request
2390 @param retval - return code
2391 @param ls_index - locator set index
2393 define lisp_add_del_locator_set_reply
2400 /** \brief add or delete locator for locator_set
2401 @param client_index - opaque cookie to identify the sender
2402 @param context - sender context, to match reply w/ request
2403 @param is_add - add address if non-zero, else delete
2404 @param locator_set_name - name of locator_set to add/del locator
2405 @param sw_if_index - index of the interface
2406 @param priority - priority of the lisp locator
2407 @param weight - weight of the lisp locator
2409 define lisp_add_del_locator
2414 u8 locator_set_name[64];
2420 /** \brief Reply for locator add/del
2421 @param context - returned sender context, to match reply w/ request
2422 @param retval - return code
2424 define lisp_add_del_locator_reply
2430 /** \brief add or delete lisp eid-table
2431 @param client_index - opaque cookie to identify the sender
2432 @param context - sender context, to match reply w/ request
2433 @param is_add - add address if non-zero, else delete
2438 @param eid - EID can be ip4, ip6 or mac
2439 @param prefix_len - prefix len
2440 @param locator_set_name - name of locator_set to add/del eid-table
2441 @param vni - virtual network instance
2443 define lisp_add_del_local_eid
2451 u8 locator_set_name[64];
2455 /** \brief Reply for local_eid add/del
2456 @param context - returned sender context, to match reply w/ request
2457 @param retval - return code
2459 define lisp_add_del_local_eid_reply
2465 /** \brief add or delete lisp gpe tunnel
2466 @param client_index - opaque cookie to identify the sender
2467 @param context - sender context, to match reply w/ request
2468 @param is_add - add address if non-zero, else delete
2473 @param rmt_eid - remote eid
2474 @param lcl_eid - local eid
2475 @param rmt_len - remote prefix len
2476 @param lcl_len - local prefix len
2477 @param vni - virtual network identifier
2478 @param dp_table - vrf/bridge domain id
2479 @param loc_num - number of locators
2480 @param lcl_locs - array of local locators
2481 @param rmt_locs - array of remote locators
2482 @param action - negative action when 0 locators configured
2484 define lisp_gpe_add_del_fwd_entry
2497 u8 lcl_locs[loc_num];
2498 u8 rmt_locs[loc_num];
2502 /** \brief Reply for gpe_fwd_entry add/del
2503 @param context - returned sender context, to match reply w/ request
2504 @param retval - return code
2506 define lisp_gpe_add_del_fwd_entry_reply
2512 /** \brief add or delete map-resolver
2513 @param client_index - opaque cookie to identify the sender
2514 @param context - sender context, to match reply w/ request
2515 @param is_add - add address if non-zero, else delete
2516 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2517 @param ip_address - array of address bytes
2519 define lisp_add_del_map_resolver
2528 /** \brief Reply for map_resolver add/del
2529 @param context - returned sender context, to match reply w/ request
2530 @param retval - return code
2532 define lisp_add_del_map_resolver_reply
2538 /** \brief enable or disable lisp-gpe protocol
2539 @param client_index - opaque cookie to identify the sender
2540 @param context - sender context, to match reply w/ request
2541 @param is_en - enable protocol if non-zero, else disable
2543 define lisp_gpe_enable_disable
2550 /** \brief Reply for gpe enable/disable
2551 @param context - returned sender context, to match reply w/ request
2552 @param retval - return code
2554 define lisp_gpe_enable_disable_reply
2560 /** \brief enable or disable LISP feature
2561 @param client_index - opaque cookie to identify the sender
2562 @param context - sender context, to match reply w/ request
2563 @param is_en - enable protocol if non-zero, else disable
2565 define lisp_enable_disable
2572 /** \brief Reply for gpe enable/disable
2573 @param context - returned sender context, to match reply w/ request
2574 @param retval - return code
2576 define lisp_enable_disable_reply
2582 /** \brief add or delete gpe_iface
2583 @param client_index - opaque cookie to identify the sender
2584 @param context - sender context, to match reply w/ request
2585 @param is_add - add address if non-zero, else delete
2587 define lisp_gpe_add_del_iface
2597 /** \brief Reply for gpe_iface add/del
2598 @param context - returned sender context, to match reply w/ request
2599 @param retval - return code
2601 define lisp_gpe_add_del_iface_reply
2607 /** \brief configure or disable LISP PITR node
2608 @param client_index - opaque cookie to identify the sender
2609 @param context - sender context, to match reply w/ request
2610 @param ls_name - locator set name
2611 @param is_add - add locator set if non-zero, else disable pitr
2613 define lisp_pitr_set_locator_set
2621 /** \brief Reply for lisp_pitr_set_locator_set
2622 @param context - returned sender context, to match reply w/ request
2623 @param retval - return code
2625 define lisp_pitr_set_locator_set_reply
2631 /** \brief set LISP map-request mode. Based on configuration VPP will send
2632 src/dest or just normal destination map requests.
2633 @param client_index - opaque cookie to identify the sender
2634 @param context - sender context, to match reply w/ request
2635 @param mode - new map-request mode. Supported values are:
2636 0 - destination only
2637 1 - source/destaination
2639 define lisp_map_request_mode
2646 /** \brief Reply for lisp_map_request_mode
2647 @param context - returned sender context, to match reply w/ request
2648 @param retval - return code
2650 define lisp_map_request_mode_reply
2656 /** \brief Request for LISP map-request mode
2657 @param client_index - opaque cookie to identify the sender
2658 @param context - sender context, to match reply w/ request
2660 define show_lisp_map_request_mode
2666 /** \brief Reply for show_lisp_map_request_mode
2667 @param context - returned sender context, to match reply w/ request
2668 @param retval - return code
2669 @param mode - map-request mode
2671 define show_lisp_map_request_mode_reply
2678 /** \brief add or delete remote static mapping
2679 @param client_index - opaque cookie to identify the sender
2680 @param context - sender context, to match reply w/ request
2681 @param is_add - add address if non-zero, else delete
2682 @param is_src_dst - flag indicating src/dst based routing policy
2683 @param del_all - if set, delete all remote mappings
2684 @param vni - virtual network instance
2685 @param action - negative map-reply action
2690 @param deid - dst EID
2691 @param seid - src EID, valid only if is_src_dst is enabled
2692 @param rloc_num - number of remote locators
2693 @param rlocs - remote locator records
2694 Structure of remote locator:
2703 define lisp_add_del_remote_mapping
2721 /** \brief Reply for lisp_add_del_remote_mapping
2722 @param context - returned sender context, to match reply w/ request
2723 @param retval - return code
2725 define lisp_add_del_remote_mapping_reply
2731 /** \brief add or delete LISP adjacency adjacency
2732 @param client_index - opaque cookie to identify the sender
2733 @param context - sender context, to match reply w/ request
2734 @param is_add - add address if non-zero, else delete
2735 @param vni - virtual network instance
2740 @param reid - remote EID
2741 @param leid - local EID
2743 define lisp_add_del_adjacency
2756 /** \brief Reply for lisp_add_del_adjacency
2757 @param context - returned sender context, to match reply w/ request
2758 @param retval - return code
2760 define lisp_add_del_adjacency_reply
2766 /** \brief add or delete map request itr rlocs
2767 @param client_index - opaque cookie to identify the sender
2768 @param context - sender context, to match reply w/ request
2769 @param is_add - add address if non-zero, else delete
2770 @param locator_set_name - locator set name
2772 define lisp_add_del_map_request_itr_rlocs
2777 u8 locator_set_name[64];
2780 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2781 @param context - returned sender context, to match reply w/ request
2782 @param retval - return code
2785 define lisp_add_del_map_request_itr_rlocs_reply
2791 /** \brief map/unmap vni/bd_index to vrf
2792 @param client_index - opaque cookie to identify the sender
2793 @param context - sender context, to match reply w/ request
2794 @param is_add - add or delete mapping
2795 @param dp_table - virtual network id/bridge domain index
2798 define lisp_eid_table_add_del_map
2808 /** \brief Reply for lisp_eid_table_add_del_map
2809 @param context - returned sender context, to match reply w/ request
2810 @param retval - return code
2812 define lisp_eid_table_add_del_map_reply
2818 /** \brief Request for map lisp locator status
2819 @param client_index - opaque cookie to identify the sender
2820 @param context - sender context, to match reply w/ request
2821 @param locator_set_index - index of locator_set
2822 @param ls_name - locator set name
2823 @param is_index_set - flag indicating whether ls_name or ls_index is set
2825 define lisp_locator_dump
2834 /** \brief LISP locator_set status
2835 @param local - if is set, then locator is local
2836 @param locator_set_name - name of the locator_set
2837 @param sw_if_index - sw_if_index of the locator
2838 @param priority - locator priority
2839 @param weight - locator weight
2841 define lisp_locator_details
2852 /** \brief LISP locator_set status
2853 @param context - sender context, to match reply w/ request
2854 @param ls_index - locator set index
2855 @param ls_name - name of the locator set
2857 define lisp_locator_set_details
2864 /** \brief Request for locator_set summary status
2865 @param client_index - opaque cookie to identify the sender
2866 @param context - sender context, to match reply w/ request
2867 @param filter - filter type
2870 1: local locator sets
2871 2: remote locator sets
2873 define lisp_locator_set_dump
2880 /** \brief Dump lisp eid-table
2881 @param client_index - opaque cookie to identify the sender
2882 @param context - sender context, to match reply w/ request
2883 @param locator_set_index - index of locator_set, if ~0 then the mapping
2885 @param action - negative map request action
2886 @param is_local - local if non-zero, else remote
2891 @param is_src_dst - EID is type of source/destination
2892 @param eid - EID can be ip4, ip6 or mac
2893 @param eid_prefix_len - prefix length
2894 @param seid - source EID can be ip4, ip6 or mac
2895 @param seid_prefix_len - source prefix length
2896 @param vni - virtual network instance
2897 @param ttl - time to live
2898 @param authoritative - authoritative
2901 define lisp_eid_table_details
2904 u32 locator_set_index;
2918 /** \brief Request for eid table summary status
2919 @param client_index - opaque cookie to identify the sender
2920 @param context - sender context, to match reply w/ request
2921 @param eid_set - if non-zero request info about specific mapping
2922 @param vni - virtual network instance; valid only if eid_set != 0
2923 @param prefix_length - prefix length if EID is IP address;
2924 valid only if eid_set != 0
2925 @param eid_type - EID type; valid only if eid_set != 0
2929 2: EID is ethernet address
2930 @param eid - endpoint identifier
2931 @param filter - filter type;
2937 define lisp_eid_table_dump
2949 /** \brief Shows relationship between vni and vrf/bd
2950 @param dp_table - VRF index or bridge domain index
2951 @param vni - vitual network instance
2953 define lisp_eid_table_map_details
2960 /** \brief Request for lisp_eid_table_map_details
2961 @param client_index - opaque cookie to identify the sender
2962 @param context - sender context, to match reply w/ request
2963 @param is_l2 - if set dump vni/bd mappings else vni/vrf
2965 define lisp_eid_table_map_dump
2972 /** \brief Dumps all VNIs used in mappings
2973 @param client_index - opaque cookie to identify the sender
2974 @param context - sender context, to match reply w/ request
2976 define lisp_eid_table_vni_dump
2982 /** \brief reply to lisp_eid_table_vni_dump
2983 @param client_index - opaque cookie to identify the sender
2984 @param context - sender context, to match reply w/ request
2985 @param vni - virtual network instance
2987 define lisp_eid_table_vni_details
2994 define lisp_gpe_tunnel_details
3000 u8 destination_ip[16];
3012 /** \brief Request for gpe tunnel summary status
3013 @param client_index - opaque cookie to identify the sender
3014 @param context - sender context, to match reply w/ request
3016 define lisp_gpe_tunnel_dump
3022 /** \brief LISP map resolver status
3023 @param locator_set_name - name of the locator_set
3024 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3025 @param ip_address - array of address bytes
3027 define lisp_map_resolver_details
3034 /** \brief Request for map resolver summary status
3035 @param client_index - opaque cookie to identify the sender
3036 @param context - sender context, to match reply w/ request
3038 define lisp_map_resolver_dump
3044 /** \brief Request for lisp-gpe protocol status
3045 @param client_index - opaque cookie to identify the sender
3046 @param context - sender context, to match reply w/ request
3048 define show_lisp_status
3054 /** \brief Status of lisp, enable or disable
3055 @param context - sender context, to match reply w/ request
3056 @param feature_status - lisp enable if non-zero, else disable
3057 @param gpe_status - lisp enable if non-zero, else disable
3059 define show_lisp_status_reply
3067 /** \brief Get LISP map request itr rlocs status
3068 @param context - sender context, to match reply w/ request
3069 @param locator_set_name - name of the locator_set
3071 define lisp_get_map_request_itr_rlocs
3077 /** \brief Request for map request itr rlocs summary status
3079 define lisp_get_map_request_itr_rlocs_reply
3083 u8 locator_set_name[64];
3086 /** \brief Request for lisp pitr status
3087 @param client_index - opaque cookie to identify the sender
3088 @param context - sender context, to match reply w/ request
3090 define show_lisp_pitr
3096 /** \brief Status of lisp pitr, enable or disable
3097 @param context - sender context, to match reply w/ request
3098 @param status - lisp pitr enable if non-zero, else disable
3099 @param locator_set_name - name of the locator_set
3101 define show_lisp_pitr_reply
3106 u8 locator_set_name[64];
3109 /* Gross kludge, DGMS */
3110 define interface_name_renumber
3115 u32 new_show_dev_instance;
3118 define interface_name_renumber_reply
3124 /** \brief Register for ip4 arp resolution events
3125 @param client_index - opaque cookie to identify the sender
3126 @param context - sender context, to match reply w/ request
3127 @param enable_disable - 1 => register for events, 0 => cancel registration
3128 @param pid - sender's pid
3129 @param address - the exact ip4 address of interest
3131 define want_ip4_arp_events
3140 /** \brief Reply for interface events registration
3141 @param context - returned sender context, to match reply w/ request
3142 @param retval - return code
3144 define want_ip4_arp_events_reply
3150 /** \brief Tell client about an ip4 arp resolution event
3151 @param client_index - opaque cookie to identify the sender
3152 @param context - sender context, to match reply w/ request
3153 @param address - the exact ip4 address of interest
3154 @param pid - client pid registered to receive notification
3155 @param sw_if_index - interface which received ARP packet
3156 @param new_mac - the new mac address
3157 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3159 define ip4_arp_event
3170 /** \brief Register for ip6 nd resolution events
3171 @param client_index - opaque cookie to identify the sender
3172 @param context - sender context, to match reply w/ request
3173 @param enable_disable - 1 => register for events, 0 => cancel registration
3174 @param pid - sender's pid
3175 @param address - the exact ip6 address of interest
3177 define want_ip6_nd_events
3186 /** \brief Reply for ip6 nd resolution events registration
3187 @param context - returned sender context, to match reply w/ request
3188 @param retval - return code
3190 define want_ip6_nd_events_reply
3196 /** \brief Tell client about an ip6 nd resolution or mac/ip event
3197 @param client_index - opaque cookie to identify the sender
3198 @param context - sender context, to match reply w/ request
3199 @param pid - client pid registered to receive notification
3200 @param sw_if_index - interface which received ARP packet
3201 @param address - the exact ip6 address of interest
3202 @param new_mac - the new mac address
3203 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3216 /** \brief L2 bridge domain add or delete request
3217 @param client_index - opaque cookie to identify the sender
3218 @param context - sender context, to match reply w/ request
3219 @param bd_id - the bridge domain to create
3220 @param flood - enable/disable bcast/mcast flooding in the bd
3221 @param uu_flood - enable/disable uknown unicast flood in the bd
3222 @param forward - enable/disable forwarding on all interfaces in the bd
3223 @param learn - enable/disable learning on all interfaces in the bd
3224 @param arp_term - enable/disable arp termination in the bd
3225 @param is_add - add or delete flag
3227 define bridge_domain_add_del
3240 /** \brief L2 bridge domain add or delete response
3241 @param context - sender context, to match reply w/ request
3242 @param retval - return code for the set bridge flags request
3244 define bridge_domain_add_del_reply
3250 /** \brief L2 bridge domain request operational state details
3251 @param client_index - opaque cookie to identify the sender
3252 @param context - sender context, to match reply w/ request
3253 @param bd_id - the bridge domain id desired or ~0 to request all bds
3255 define bridge_domain_dump
3262 /** \brief L2 bridge domain operational state response
3263 @param bd_id - the bridge domain id
3264 @param flood - bcast/mcast flooding state on all interfaces in the bd
3265 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3266 @param forward - forwarding state on all interfaces in the bd
3267 @param learn - learning state on all interfaces in the bd
3268 @param arp_term - arp termination state on all interfaces in the bd
3269 @param n_sw_ifs - number of sw_if_index's in the domain
3271 define bridge_domain_details
3280 u32 bvi_sw_if_index;
3284 /** \brief L2 bridge domain sw interface operational state response
3285 @param bd_id - the bridge domain id
3286 @param sw_if_index - sw_if_index in the domain
3287 @param shg - split horizon group for the interface
3289 define bridge_domain_sw_if_details
3297 /** \brief DHCP Client config add / del request
3298 @param client_index - opaque cookie to identify the sender
3299 @param context - sender context, to match reply w/ request
3300 @param sw_if_index - index of the interface for DHCP client
3301 @param hostname - hostname
3302 @param is_add - add the config if non-zero, else delete
3303 @param want_dhcp_event - DHCP event sent to the sender
3304 via dhcp_compl_event API message if non-zero
3305 @param pid - sender's pid
3307 define dhcp_client_config
3318 /** \brief DHCP Client config response
3319 @param context - sender context, to match reply w/ request
3320 @param retval - return code for the request
3322 define dhcp_client_config_reply
3328 /** \brief Set/unset input ACL interface
3329 @param client_index - opaque cookie to identify the sender
3330 @param context - sender context, to match reply w/ request
3331 @param sw_if_index - interface to set/unset input ACL
3332 @param ip4_table_index - ip4 classify table index (~0 for skip)
3333 @param ip6_table_index - ip6 classify table index (~0 for skip)
3334 @param l2_table_index - l2 classify table index (~0 for skip)
3335 @param is_add - Set input ACL if non-zero, else unset
3336 Note: User is recommeneded to use just one valid table_index per call.
3337 (ip4_table_index, ip6_table_index, or l2_table_index)
3339 define input_acl_set_interface
3344 u32 ip4_table_index;
3345 u32 ip6_table_index;
3350 /** \brief Set/unset input ACL interface response
3351 @param context - sender context, to match reply w/ request
3352 @param retval - return code for the request
3354 define input_acl_set_interface_reply
3360 /** \brief IPsec: Add/delete Security Policy Database
3361 @param client_index - opaque cookie to identify the sender
3362 @param context - sender context, to match reply w/ request
3363 @param is_add - add SPD if non-zero, else delete
3364 @param spd_id - SPD instance id (control plane allocated)
3367 define ipsec_spd_add_del
3375 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3376 @param context - returned sender context, to match reply w/ request
3377 @param retval - return code
3380 define ipsec_spd_add_del_reply
3386 /** \brief IPsec: Add/delete SPD from interface
3388 @param client_index - opaque cookie to identify the sender
3389 @param context - sender context, to match reply w/ request
3390 @param is_add - add security mode if non-zero, else delete
3391 @param sw_if_index - index of the interface
3392 @param spd_id - SPD instance id to use for lookups
3396 define ipsec_interface_add_del_spd
3406 /** \brief Reply for IPsec: Add/delete SPD from interface
3407 @param context - returned sender context, to match reply w/ request
3408 @param retval - return code
3411 define ipsec_interface_add_del_spd_reply
3417 /** \brief IPsec: Add/delete Security Policy Database entry
3419 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3421 @param client_index - opaque cookie to identify the sender
3422 @param context - sender context, to match reply w/ request
3423 @param is_add - add SPD if non-zero, else delete
3424 @param spd_id - SPD instance id (control plane allocated)
3425 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3426 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3427 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3428 @param remote_address_start - start of remote address range to match
3429 @param remote_address_stop - end of remote address range to match
3430 @param local_address_start - start of local address range to match
3431 @param local_address_stop - end of local address range to match
3432 @param protocol - protocol type to match [0 means any]
3433 @param remote_port_start - start of remote port range to match ...
3434 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3435 @param local_port_start - start of local port range to match ...
3436 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3437 @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)
3438 @param sa_id - SAD instance id (control plane allocated)
3442 define ipsec_spd_add_del_entry
3455 u8 remote_address_start[16];
3456 u8 remote_address_stop[16];
3457 u8 local_address_start[16];
3458 u8 local_address_stop[16];
3462 u16 remote_port_start;
3463 u16 remote_port_stop;
3464 u16 local_port_start;
3465 u16 local_port_stop;
3472 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3473 @param context - returned sender context, to match reply w/ request
3474 @param retval - return code
3477 define ipsec_spd_add_del_entry_reply
3483 /** \brief IPsec: Add/delete Security Association Database entry
3484 @param client_index - opaque cookie to identify the sender
3485 @param context - sender context, to match reply w/ request
3486 @param is_add - add SAD entry if non-zero, else delete
3488 @param sad_id - sad id
3490 @param spi - security parameter index
3492 @param protocol - 0 = AH, 1 = ESP
3494 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3495 @param crypto_key_length - length of crypto_key in bytes
3496 @param crypto_key - crypto keying material
3498 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3499 @param integrity_key_length - length of integrity_key in bytes
3500 @param integrity_key - integrity keying material
3502 @param use_extended_sequence_number - use ESN when non-zero
3504 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3505 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3506 @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
3507 @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
3511 IPsec tunnel address copy mode (to support GDOI)
3514 define ipsec_sad_add_del_entry
3526 u8 crypto_algorithm;
3527 u8 crypto_key_length;
3530 u8 integrity_algorithm;
3531 u8 integrity_key_length;
3532 u8 integrity_key[128];
3534 u8 use_extended_sequence_number;
3538 u8 tunnel_src_address[16];
3539 u8 tunnel_dst_address[16];
3542 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3543 @param context - returned sender context, to match reply w/ request
3544 @param retval - return code
3547 define ipsec_sad_add_del_entry_reply
3553 /** \brief IPsec: Update Security Association keys
3554 @param client_index - opaque cookie to identify the sender
3555 @param context - sender context, to match reply w/ request
3557 @param sa_id - sa id
3559 @param crypto_key_length - length of crypto_key in bytes
3560 @param crypto_key - crypto keying material
3562 @param integrity_key_length - length of integrity_key in bytes
3563 @param integrity_key - integrity keying material
3566 define ipsec_sa_set_key
3573 u8 crypto_key_length;
3576 u8 integrity_key_length;
3577 u8 integrity_key[128];
3580 /** \brief Reply for IPsec: Update Security Association keys
3581 @param context - returned sender context, to match reply w/ request
3582 @param retval - return code
3585 define ipsec_sa_set_key_reply
3591 /** \brief IKEv2: Add/delete profile
3592 @param client_index - opaque cookie to identify the sender
3593 @param context - sender context, to match reply w/ request
3595 @param name - IKEv2 profile name
3596 @param is_add - Add IKEv2 profile if non-zero, else delete
3598 define ikev2_profile_add_del
3607 /** \brief Reply for IKEv2: Add/delete profile
3608 @param context - returned sender context, to match reply w/ request
3609 @param retval - return code
3611 define ikev2_profile_add_del_reply
3617 /** \brief IKEv2: Set IKEv2 profile authentication method
3618 @param client_index - opaque cookie to identify the sender
3619 @param context - sender context, to match reply w/ request
3621 @param name - IKEv2 profile name
3622 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3623 @param is_hex - Authentication data in hex format if non-zero, else string
3624 @param data_len - Authentication data length
3625 @param data - Authentication data (for rsa-sig cert file path)
3627 define ikev2_profile_set_auth
3639 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3640 @param context - returned sender context, to match reply w/ request
3641 @param retval - return code
3643 define ikev2_profile_set_auth_reply
3649 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3650 @param client_index - opaque cookie to identify the sender
3651 @param context - sender context, to match reply w/ request
3653 @param name - IKEv2 profile name
3654 @param is_local - Identification is local if non-zero, else remote
3655 @param id_type - Identification type
3656 @param data_len - Identification data length
3657 @param data - Identification data
3659 define ikev2_profile_set_id
3671 /** \brief Reply for IKEv2:
3672 @param context - returned sender context, to match reply w/ request
3673 @param retval - return code
3675 define ikev2_profile_set_id_reply
3681 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3682 @param client_index - opaque cookie to identify the sender
3683 @param context - sender context, to match reply w/ request
3685 @param name - IKEv2 profile name
3686 @param is_local - Traffic selector is local if non-zero, else remote
3687 @param proto - Traffic selector IP protocol (if zero not relevant)
3688 @param start_port - The smallest port number allowed by traffic selector
3689 @param end_port - The largest port number allowed by traffic selector
3690 @param start_addr - The smallest address included in traffic selector
3691 @param end_addr - The largest address included in traffic selector
3693 define ikev2_profile_set_ts
3707 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3708 @param context - returned sender context, to match reply w/ request
3709 @param retval - return code
3711 define ikev2_profile_set_ts_reply
3717 /** \brief IKEv2: Set IKEv2 local RSA private key
3718 @param client_index - opaque cookie to identify the sender
3719 @param context - sender context, to match reply w/ request
3721 @param key_file - Key file absolute path
3723 define ikev2_set_local_key
3731 /** \brief Reply for IKEv2: Set IKEv2 local key
3732 @param context - returned sender context, to match reply w/ request
3733 @param retval - return code
3735 define ikev2_set_local_key_reply
3741 /** \brief Tell client about a DHCP completion event
3742 @param client_index - opaque cookie to identify the sender
3743 @param pid - client pid registered to receive notification
3744 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3745 @param host_address - Host IP address
3746 @param router_address - Router IP address
3747 @param host_mac - Host MAC address
3749 define dhcp_compl_event
3755 u8 host_address[16];
3756 u8 router_address[16];
3760 /** \brief Add MAP domains
3761 @param client_index - opaque cookie to identify the sender
3762 @param context - sender context, to match reply w/ request
3763 @param ip6_prefix - Rule IPv6 prefix
3764 @param ip4_prefix - Rule IPv4 prefix
3765 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3766 @param ip6_prefix_len - Rule IPv6 prefix length
3767 @param ip4_prefix_len - Rule IPv4 prefix length
3768 @param ea_bits_len - Embedded Address bits length
3769 @param psid_offset - Port Set Identifider (PSID) offset
3770 @param psid_length - PSID length
3771 @param is_translation - MAP-E / MAP-T
3774 define map_add_domain
3783 u8 ip6_src_prefix_len;
3791 /** \brief Reply for MAP domain add
3792 @param context - returned sender context, to match reply w/ request
3793 @param index - MAP domain index
3794 @param retval - return code
3796 define map_add_domain_reply
3803 /** \brief Delete MAP domain
3804 @param client_index - opaque cookie to identify the sender
3805 @param context - sender context, to match reply w/ request
3806 @param index - MAP Domain index
3808 define map_del_domain
3815 /** \brief Reply for MAP domain del
3816 @param context - returned sender context, to match reply w/ request
3817 @param retval - return code
3819 define map_del_domain_reply
3825 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3826 @param client_index - opaque cookie to identify the sender
3827 @param context - sender context, to match reply w/ request
3828 @param index - MAP Domain index
3829 @param is_add - If 1 add rule, if 0 delete rule
3830 @param ip6_dst - MAP CE IPv6 address
3831 @param psid - Rule PSID
3833 define map_add_del_rule
3843 /** \brief Reply for MAP rule add/del
3844 @param context - returned sender context, to match reply w/ request
3845 @param retval - return code
3847 define map_add_del_rule_reply
3853 /** \brief Get list of map domains
3854 @param client_index - opaque cookie to identify the sender
3856 define map_domain_dump
3862 define map_domain_details
3880 define map_rule_dump
3887 define map_rule_details
3894 /** \brief Request for a single block of summary stats
3895 @param client_index - opaque cookie to identify the sender
3896 @param context - sender context, to match reply w/ request
3898 define map_summary_stats
3904 /** \brief Reply for map_summary_stats request
3905 @param context - sender context, to match reply w/ request
3906 @param retval - return code for request
3907 @param total_bindings -
3909 @param total_ip4_fragments -
3910 @param total_security_check -
3912 define map_summary_stats_reply
3919 u64 total_ip4_fragments;
3920 u64 total_security_check[2];
3923 /** \brief cop: enable/disable junk filtration features on an interface
3924 @param client_index - opaque cookie to identify the sender
3925 @param context - sender context, to match reply w/ request
3926 @param sw_if_inded - desired interface
3927 @param enable_disable - 1 => enable, 0 => disable
3930 define cop_interface_enable_disable
3938 /** \brief cop: interface enable/disable junk filtration reply
3939 @param context - returned sender context, to match reply w/ request
3940 @param retval - return code
3943 define cop_interface_enable_disable_reply
3949 /** \brief cop: enable/disable whitelist filtration features on an interface
3950 Note: the supplied fib_id must match in order to remove the feature!
3952 @param client_index - opaque cookie to identify the sender
3953 @param context - sender context, to match reply w/ request
3954 @param sw_if_index - interface handle, physical interfaces only
3955 @param fib_id - fib identifier for the whitelist / blacklist fib
3956 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3957 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3958 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3961 define cop_whitelist_enable_disable
3972 /** \brief cop: interface enable/disable junk filtration reply
3973 @param context - returned sender context, to match reply w/ request
3974 @param retval - return code
3977 define cop_whitelist_enable_disable_reply
3983 /** \brief get_node_graph - get a copy of the vpp node graph
3984 including the current set of graph arcs.
3986 @param client_index - opaque cookie to identify the sender
3987 @param context - sender context, to match reply w/ request
3990 define get_node_graph
3996 /** \brief get_node_graph_reply
3997 @param context - returned sender context, to match reply w/ request
3998 @param retval - return code
3999 @param reply_in_shmem - result from vlib_node_serialize, in shared
4000 memory. Process with vlib_node_unserialize, remember to switch
4001 heaps and free the result.
4004 define get_node_graph_reply
4011 /** \brief Clear interface statistics
4012 @param client_index - opaque cookie to identify the sender
4013 @param context - sender context, to match reply w/ request
4014 @param sw_if_index - index of the interface to clear statistics
4016 define sw_interface_clear_stats
4023 /** \brief Reply to sw_interface_clear_stats
4024 @param context - sender context which was passed in the request
4025 @param retval - return code of the set flags request
4027 define sw_interface_clear_stats_reply
4033 /** \brief IOAM enable : Enable in-band OAM
4034 @param id - profile id
4035 @param trace_ppc - Trace PPC (none/encap/decap)
4036 @param pow_enable - Proof of Work enabled or not flag
4037 @param trace_enable - iOAM Trace enabled or not flag
4050 /** \brief iOAM Trace profile add / del response
4051 @param context - sender context, to match reply w/ request
4052 @param retval - return value for request
4054 define ioam_enable_reply
4060 /** \brief iOAM disable
4061 @param client_index - opaque cookie to identify the sender
4062 @param context - sender context, to match reply w/ request
4063 @param index - MAP Domain index
4072 /** \brief iOAM disable response
4073 @param context - sender context, to match reply w/ request
4074 @param retval - return value for request
4076 define ioam_disable_reply
4082 /** \brief Create host-interface
4083 @param client_index - opaque cookie to identify the sender
4084 @param context - sender context, to match reply w/ request
4085 @param host_if_name - interface name
4086 @param hw_addr - interface MAC
4087 @param use_random_hw_addr - use random generated MAC
4089 define af_packet_create
4094 u8 host_if_name[64];
4096 u8 use_random_hw_addr;
4099 /** \brief Create host-interface response
4100 @param context - sender context, to match reply w/ request
4101 @param retval - return value for request
4103 define af_packet_create_reply
4110 /** \brief Delete host-interface
4111 @param client_index - opaque cookie to identify the sender
4112 @param context - sender context, to match reply w/ request
4113 @param host_if_name - interface name
4115 define af_packet_delete
4120 u8 host_if_name[64];
4123 /** \brief Delete host-interface response
4124 @param context - sender context, to match reply w/ request
4125 @param retval - return value for request
4127 define af_packet_delete_reply
4133 /** \brief Add/del policer
4134 @param client_index - opaque cookie to identify the sender
4135 @param context - sender context, to match reply w/ request
4136 @param is_add - add policer if non-zero, else delete
4137 @param name - policer name
4140 @param cb - Committed Burst
4141 @param eb - Excess or Peak Burst
4142 @param rate_type - rate type
4143 @param round_type - rounding type
4144 @param type - policer algorithm
4145 @param color_aware - 0=color-blind, 1=color-aware
4146 @param conform_action_type - conform action type
4147 @param conform_dscp - DSCP for conform mar-and-transmit action
4148 @param exceed_action_type - exceed action type
4149 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4150 @param violate_action_type - violate action type
4151 @param violate_dscp - DSCP for violate mar-and-transmit action
4153 define policer_add_del
4168 u8 conform_action_type;
4170 u8 exceed_action_type;
4172 u8 violate_action_type;
4176 /** \brief Add/del policer response
4177 @param context - sender context, to match reply w/ request
4178 @param retval - return value for request
4179 @param policer_index - for add, returned index of the new policer
4181 define policer_add_del_reply
4188 /** \brief Get list of policers
4189 @param client_index - opaque cookie to identify the sender
4190 @param context - sender context, to match reply w/ request
4191 @param match_name_valid - if 0 request all policers otherwise use match_name
4192 @param match_name - policer name
4199 u8 match_name_valid;
4203 /** \brief Policer operational state response.
4204 @param context - sender context, to match reply w/ request
4205 @param name - policer name
4208 @param cb - Committed Burst
4209 @param eb - Excess or Peak Burst
4210 @param rate_type - rate type
4211 @param round_type - rounding type
4212 @param type - policer algorithm
4213 @param conform_action_type - conform action type
4214 @param conform_dscp - DSCP for conform mar-and-transmit action
4215 @param exceed_action_type - exceed action type
4216 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4217 @param violate_action_type - violate action type
4218 @param violate_dscp - DSCP for violate mar-and-transmit action
4219 @param single_rate - 1 = single rate policer, 0 = two rate policer
4220 @param color_aware - for hierarchical policing
4221 @param scale - power-of-2 shift amount for lower rates
4222 @param cir_tokens_per_period - number of tokens for each period
4223 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
4224 @param current_limit - current limit
4225 @param current_bucket - current bucket
4226 @param extended_limit - extended limit
4227 @param extended_bucket - extended bucket
4228 @param last_update_time - last update time
4230 define policer_details
4242 u8 conform_action_type;
4244 u8 exceed_action_type;
4246 u8 violate_action_type;
4251 u32 cir_tokens_per_period;
4252 u32 pir_tokens_per_period;
4256 u32 extended_bucket;
4257 u64 last_update_time;
4260 /** \brief Set/unset policer classify interface
4261 @param client_index - opaque cookie to identify the sender
4262 @param context - sender context, to match reply w/ request
4263 @param sw_if_index - interface to set/unset policer classify
4264 @param ip4_table_index - ip4 classify table index (~0 for skip)
4265 @param ip6_table_index - ip6 classify table index (~0 for skip)
4266 @param l2_table_index - l2 classify table index (~0 for skip)
4267 @param is_add - Set if non-zero, else unset
4268 Note: User is recommeneded to use just one valid table_index per call.
4269 (ip4_table_index, ip6_table_index, or l2_table_index)
4271 define policer_classify_set_interface
4276 u32 ip4_table_index;
4277 u32 ip6_table_index;
4282 /** \brief Set/unset policer classify interface response
4283 @param context - sender context, to match reply w/ request
4284 @param retval - return value for request
4286 define policer_classify_set_interface_reply
4292 /** \brief Get list of policer classify interfaces and tables
4293 @param client_index - opaque cookie to identify the sender
4294 @param context - sender context, to match reply w/ request
4295 @param type - classify table type
4297 define policer_classify_dump
4304 /** \brief Policer iclassify operational state response.
4305 @param context - sender context, to match reply w/ request
4306 @param sw_if_index - software interface index
4307 @param table_index - classify table index
4309 define policer_classify_details
4316 /** \brief Create netmap
4317 @param client_index - opaque cookie to identify the sender
4318 @param context - sender context, to match reply w/ request
4319 @param netmap_if_name - interface name
4320 @param hw_addr - interface MAC
4321 @param use_random_hw_addr - use random generated MAC
4322 @param is_pipe - is pipe
4323 @param is_master - 0=slave, 1=master
4325 define netmap_create
4330 u8 netmap_if_name[64];
4332 u8 use_random_hw_addr;
4337 /** \brief Create netmap response
4338 @param context - sender context, to match reply w/ request
4339 @param retval - return value for request
4341 define netmap_create_reply
4347 /** \brief Delete netmap
4348 @param client_index - opaque cookie to identify the sender
4349 @param context - sender context, to match reply w/ request
4350 @param netmap_if_name - interface name
4352 define netmap_delete
4357 u8 netmap_if_name[64];
4360 /** \brief Delete netmap response
4361 @param context - sender context, to match reply w/ request
4362 @param retval - return value for request
4364 define netmap_delete_reply
4370 /** \brief Dump mpls gre tunnel table
4371 @param client_index - opaque cookie to identify the sender
4372 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4374 define mpls_gre_tunnel_dump
4381 /** \brief mpls gre tunnel operational state response
4382 @param tunnel_index - gre tunnel identifier
4383 @param intfc_address - interface ipv4 addr
4384 @param mask_width - interface ipv4 addr mask
4385 @param hw_if_index - interface id
4387 @param tunnel_src - tunnel source ipv4 addr
4388 @param tunnel_dst - tunnel destination ipv4 addr
4389 @param outer_fib_index - gre tunnel identifier
4390 @param encap_index - reference to mpls label table
4391 @param nlabels - number of resolved labels
4392 @param labels - resolved labels
4394 define mpls_gre_tunnel_details
4400 u32 inner_fib_index;
4407 u32 outer_fib_index;
4409 u32 labels[nlabels];
4412 /** \brief Dump mpls eth tunnel table
4413 @param client_index - opaque cookie to identify the sender
4414 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
4416 define mpls_eth_tunnel_dump
4423 /** \brief mpls eth tunnel operational state response
4424 @param tunnel_index - eth tunnel identifier
4425 @param intfc_address - interface ipv4 addr
4426 @param mask_width - interface ipv4 addr mask
4427 @param hw_if_index - interface id
4429 @param tunnel_dst_mac -
4430 @param tx_sw_if_index -
4431 @param encap_index - reference to mpls label table
4432 @param nlabels - number of resolved labels
4433 @param labels - resolved labels
4435 define mpls_eth_tunnel_details
4441 u32 inner_fib_index;
4446 u8 tunnel_dst_mac[6];
4449 u32 labels[nlabels];
4452 /** \brief Dump mpls fib table
4453 @param client_index - opaque cookie to identify the sender
4454 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4456 define mpls_fib_encap_dump
4462 /** \brief mpls fib encap table response
4463 @param fib_index - fib table id
4464 @param dest - destination ipv4 addr
4466 @param entry_index - reference to mpls label table
4467 @param nlabels - number of resolved labels
4468 @param labels - resolved labels
4470 define mpls_fib_encap_details
4479 u32 labels[nlabels];
4482 /** \brief Dump mpls fib decap table
4483 @param client_index - opaque cookie to identify the sender
4484 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4486 define mpls_fib_decap_dump
4492 /** \brief mpls fib decap table response
4493 @param fib_index - fib table id
4494 @param entry_index - reference to mpls label table
4495 @param dest - destination ipv4 addr
4497 @param label - mpls labels
4498 @param rx_table_id - rx fib id
4499 @param tx_table_id - tx fib id
4502 define mpls_fib_decap_details
4516 /** \brief Classify get table IDs request
4517 @param client_index - opaque cookie to identify the sender
4518 @param context - sender context, to match reply w/ request
4520 define classify_table_ids
4526 /** \brief Reply for classify get table IDs request
4527 @param context - sender context which was passed in the request
4528 @param count - number of ids returned in response
4529 @param ids - array of classify table ids
4531 define classify_table_ids_reply
4539 /** \brief Classify table ids by interface index request
4540 @param client_index - opaque cookie to identify the sender
4541 @param context - sender context, to match reply w/ request
4542 @param sw_if_index - index of the interface
4544 define classify_table_by_interface
4551 /** \brief Reply for classify table id by interface index request
4552 @param context - sender context which was passed in the request
4553 @param count - number of ids returned in response
4554 @param sw_if_index - index of the interface
4555 @param l2_table_id - l2 classify table index
4556 @param ip4_table_id - ip4 classify table index
4557 @param ip6_table_id - ip6 classify table index
4559 define classify_table_by_interface_reply
4569 /** \brief Classify table info
4570 @param client_index - opaque cookie to identify the sender
4571 @param context - sender context, to match reply w/ request
4572 @param table_id - classify table index
4574 define classify_table_info
4581 /** \brief Reply for classify table info request
4582 @param context - sender context which was passed in the request
4583 @param count - number of ids returned in response
4584 @param table_id - classify table index
4585 @param nbuckets - number of buckets when adding a table
4586 @param match_n_vectors - number of match vectors
4587 @param skip_n_vectors - number of skip_n_vectors
4588 @param active_sessions - number of sessions (active entries)
4589 @param next_table_index - index of next table
4590 @param miss_next_index - index of miss table
4591 @param mask[] - match mask
4593 define classify_table_info_reply
4599 u32 match_n_vectors;
4601 u32 active_sessions;
4602 u32 next_table_index;
4603 u32 miss_next_index;
4605 u8 mask[mask_length];
4608 /** \brief Classify sessions dump request
4609 @param client_index - opaque cookie to identify the sender
4610 @param context - sender context, to match reply w/ request
4611 @param table_id - classify table index
4613 define classify_session_dump
4620 /** \brief Reply for classify table session dump request
4621 @param context - sender context which was passed in the request
4622 @param count - number of ids returned in response
4623 @param table_id - classify table index
4624 @param hit_next_index - hit_next_index of session
4625 @param opaque_index - for add, opaque_index of session
4626 @param advance - advance value of session
4627 @param match[] - match value for session
4629 define classify_session_details
4638 u8 match[match_length];
4641 /** \brief Configure IPFIX exporter process request
4642 @param client_index - opaque cookie to identify the sender
4643 @param context - sender context, to match reply w/ request
4644 @param collector_address - address of IPFIX collector
4645 @param collector_port - port of IPFIX collector
4646 @param src_address - address of IPFIX exporter
4647 @param vrf_id - VRF / fib table ID
4648 @param path_mtu - Path MTU between exporter and collector
4649 @param template_interval - number of seconds after which to resend template
4650 @param udp_checksum - UDP checksum calculation enable flag
4652 define set_ipfix_exporter
4656 u8 collector_address[16];
4661 u32 template_interval;
4665 /** \brief Reply to IPFIX exporter configure request
4666 @param context - sender context which was passed in the request
4668 define set_ipfix_exporter_reply
4674 /** \brief IPFIX exporter dump request
4675 @param client_index - opaque cookie to identify the sender
4676 @param context - sender context, to match reply w/ request
4678 define ipfix_exporter_dump
4684 /** \brief Reply to IPFIX exporter dump request
4685 @param context - sender context which was passed in the request
4686 @param collector_address - address of IPFIX collector
4687 @param collector_port - port of IPFIX collector
4688 @param src_address - address of IPFIX exporter
4689 @param fib_index - fib table index
4690 @param path_mtu - Path MTU between exporter and collector
4691 @param template_interval - number of seconds after which to resend template
4692 @param udp_checksum - UDP checksum calculation enable flag
4694 define ipfix_exporter_details
4697 u8 collector_address[16];
4702 u32 template_interval;
4706 /** \brief IPFIX classify stream configure request
4707 @param client_index - opaque cookie to identify the sender
4708 @param context - sender context, to match reply w/ request
4709 @param domain_id - domain ID reported in IPFIX messages for classify stream
4710 @param src_port - source port of UDP session for classify stream
4712 define set_ipfix_classify_stream {
4719 /** \brief IPFIX classify stream configure response
4720 @param context - sender context, to match reply w/ request
4721 @param retval - return value for request
4723 define set_ipfix_classify_stream_reply {
4728 /** \brief IPFIX classify stream dump request
4729 @param client_index - opaque cookie to identify the sender
4730 @param context - sender context, to match reply w/ request
4732 define ipfix_classify_stream_dump {
4737 /** \brief Reply to IPFIX classify stream dump request
4738 @param context - sender context, to match reply w/ request
4739 @param domain_id - domain ID reported in IPFIX messages for classify stream
4740 @param src_port - source port of UDP session for classify stream
4742 define ipfix_classify_stream_details {
4748 /** \brief IPFIX add or delete classifier table request
4749 @param client_index - opaque cookie to identify the sender
4750 @param context - sender context, to match reply w/ request
4751 @param table_id - classifier table ID
4752 @param ip_version - version of IP used in the classifier table
4753 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4755 define ipfix_classify_table_add_del {
4760 u8 transport_protocol;
4764 /** \brief IPFIX add classifier table response
4765 @param context - sender context which was passed in the request
4767 define ipfix_classify_table_add_del_reply {
4772 /** \brief IPFIX classify tables dump request
4773 @param client_index - opaque cookie to identify the sender
4774 @param context - sender context, to match reply w/ request
4776 define ipfix_classify_table_dump {
4781 /** \brief Reply to IPFIX classify tables dump request
4782 @param context - sender context, to match reply w/ request
4783 @param table_id - classifier table ID
4784 @param ip_version - version of IP used in the classifier table
4785 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4787 define ipfix_classify_table_details {
4791 u8 transport_protocol;
4794 /** \brief Set/unset flow classify interface
4795 @param client_index - opaque cookie to identify the sender
4796 @param context - sender context, to match reply w/ request
4797 @param sw_if_index - interface to set/unset flow classify
4798 @param ip4_table_index - ip4 classify table index (~0 for skip)
4799 @param ip6_table_index - ip6 classify table index (~0 for skip)
4800 @param l2_table_index - l2 classify table index (~0 for skip)
4801 @param is_add - Set if non-zero, else unset
4802 Note: User is recommeneded to use just one valid table_index per call.
4803 (ip4_table_index, ip6_table_index, or l2_table_index)
4805 define flow_classify_set_interface {
4809 u32 ip4_table_index;
4810 u32 ip6_table_index;
4814 /** \brief Set/unset flow classify interface response
4815 @param context - sender context, to match reply w/ request
4816 @param retval - return value for request
4818 define flow_classify_set_interface_reply {
4823 /** \brief Get list of flow classify interfaces and tables
4824 @param client_index - opaque cookie to identify the sender
4825 @param context - sender context, to match reply w/ request
4826 @param type - classify table type
4828 define flow_classify_dump {
4834 /** \brief Flow classify operational state response.
4835 @param context - sender context, to match reply w/ request
4836 @param sw_if_index - software interface index
4837 @param table_index - classify table index
4839 define flow_classify_details {
4845 /** \brief Query relative index via node names
4846 @param client_index - opaque cookie to identify the sender
4847 @param context - sender context, to match reply w/ request
4848 @param node_name - name of node to find relative index from
4849 @param next_name - next node from node_name to find relative index of
4851 define get_next_index
4859 /** \brief Reply for get next node index
4860 @param context - sender context which was passed in the request
4861 @param retval - return value
4862 @param next_index - index of the next_node
4864 define get_next_index_reply
4871 /** \brief PacketGenerator create interface request
4872 @param client_index - opaque cookie to identify the sender
4873 @param context - sender context, to match reply w/ request
4874 @param interface_id - interface index
4876 define pg_create_interface
4883 /** \brief PacketGenerator create interface response
4884 @param context - sender context, to match reply w/ request
4885 @param retval - return value for request
4887 define pg_create_interface_reply
4894 /** \brief PacketGenerator capture packets on given interface request
4895 @param client_index - opaque cookie to identify the sender
4896 @param context - sender context, to match reply w/ request
4897 @param interface_id - pg interface index
4898 @param is_enabled - 1 if enabling streams, 0 if disabling
4899 @param count - number of packets to be captured
4900 @param pcap_file - pacp file name to store captured packets
4909 u32 pcap_name_length;
4910 u8 pcap_file_name[pcap_name_length];
4913 /** \brief PacketGenerator capture packets response
4914 @param context - sender context, to match reply w/ request
4915 @param retval - return value for request
4917 define pg_capture_reply
4923 /** \brief Enable / disable packet generator request
4924 @param client_index - opaque cookie to identify the sender
4925 @param context - sender context, to match reply w/ request
4926 @param is_enabled - 1 if enabling streams, 0 if disabling
4927 @param stream - stream name to be enable/disabled, if not specified handle all streams
4929 define pg_enable_disable
4934 u32 stream_name_length;
4935 u8 stream_name[stream_name_length];
4938 /** \brief Reply for enable / disable packet generator
4939 @param context - returned sender context, to match reply w/ request
4940 @param retval - return code
4942 define pg_enable_disable_reply
4948 /** \brief Configure IP source and L4 port-range check
4949 @param client_index - opaque cookie to identify the sender
4950 @param context - sender context, to match reply w/ request
4951 @param is_ip6 - 1 if source address type is IPv6
4952 @param is_add - 1 if add, 0 if delete
4953 @param mask_length - mask length for address entry
4954 @param address - array of address bytes
4955 @param number_of_ranges - length of low_port and high_port arrays (must match)
4956 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
4957 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
4958 @param vrf_id - fib table/vrf id to associate the source and port-range check with
4959 @note To specify a single port set low_port and high_port entry the same
4961 define ip_source_and_port_range_check_add_del
4969 u8 number_of_ranges;
4975 /** \brief Configure IP source and L4 port-range check reply
4976 @param context - returned sender context, to match reply w/ request
4977 @param retval - return code
4979 define ip_source_and_port_range_check_add_del_reply
4985 /** \brief Set interface source and L4 port-range request
4986 @param client_index - opaque cookie to identify the sender
4987 @param context - sender context, to match reply w/ request
4988 @param interface_id - interface index
4989 @param tcp_vrf_id - VRF associated with source and TCP port-range check
4990 @param udp_vrf_id - VRF associated with source and TCP port-range check
4992 define ip_source_and_port_range_check_interface_add_del
5004 /** \brief Set interface source and L4 port-range response
5005 @param context - sender context, to match reply w/ request
5006 @param retval - return value for request
5008 define ip_source_and_port_range_check_interface_add_del_reply
5014 /** \brief Add / del ipsec gre tunnel request
5015 @param client_index - opaque cookie to identify the sender
5016 @param context - sender context, to match reply w/ request
5017 @param local_sa_id - local SA id
5018 @param remote_sa_id - remote SA id
5019 @param is_add - 1 if adding the tunnel, 0 if deleting
5020 @param src_address - tunnel source address
5021 @param dst_address - tunnel destination address
5023 define ipsec_gre_add_del_tunnel {
5033 /** \brief Reply for add / del ipsec gre tunnel request
5034 @param context - returned sender context, to match reply w/ request
5035 @param retval - return code
5036 @param sw_if_index - software index of the new ipsec gre tunnel
5038 define ipsec_gre_add_del_tunnel_reply {
5044 /** \brief Dump ipsec gre tunnel table
5045 @param client_index - opaque cookie to identify the sender
5046 @param context - sender context, to match reply w/ request
5047 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
5049 define ipsec_gre_tunnel_dump {
5055 /** \brief mpls gre tunnel operational state response
5056 @param context - returned sender context, to match reply w/ request
5057 @param sw_if_index - software index of the ipsec gre tunnel
5058 @param local_sa_id - local SA id
5059 @param remote_sa_id - remote SA id
5060 @param src_address - tunnel source address
5061 @param dst_address - tunnel destination address
5063 define ipsec_gre_tunnel_details {
5072 /** \brief Delete sub interface request
5073 @param client_index - opaque cookie to identify the sender
5074 @param context - sender context, to match reply w/ request
5075 @param sw_if_index - sw index of the interface that was created by create_subif
5077 define delete_subif {
5083 /** \brief Delete sub interface response
5084 @param context - sender context, to match reply w/ request
5085 @param retval - return code for the request
5087 define delete_subif_reply {
5092 /** \brief DPDK interface HQoS pipe profile set request
5093 @param client_index - opaque cookie to identify the sender
5094 @param context - sender context, to match reply w/ request
5095 @param sw_if_index - the interface
5096 @param subport - subport ID
5097 @param pipe - pipe ID within its subport
5098 @param profile - pipe profile ID
5100 define sw_interface_set_dpdk_hqos_pipe {
5109 /** \brief DPDK interface HQoS pipe profile set reply
5110 @param context - sender context, to match reply w/ request
5111 @param retval - request return code
5113 define sw_interface_set_dpdk_hqos_pipe_reply {
5118 /** \brief DPDK interface HQoS subport parameters set request
5119 @param client_index - opaque cookie to identify the sender
5120 @param context - sender context, to match reply w/ request
5121 @param sw_if_index - the interface
5122 @param subport - subport ID
5123 @param tb_rate - subport token bucket rate (measured in bytes/second)
5124 @param tb_size - subport token bucket size (measured in credits)
5125 @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
5126 @param tc_period - enforcement period for rates (measured in milliseconds)
5128 define sw_interface_set_dpdk_hqos_subport {
5139 /** \brief DPDK interface HQoS subport parameters set reply
5140 @param context - sender context, to match reply w/ request
5141 @param retval - request return code
5143 define sw_interface_set_dpdk_hqos_subport_reply {
5148 /** \brief DPDK interface HQoS tctbl entry set request
5149 @param client_index - opaque cookie to identify the sender
5150 @param context - sender context, to match reply w/ request
5151 @param sw_if_index - the interface
5152 @param entry - entry index ID
5153 @param tc - traffic class (0 .. 3)
5154 @param queue - traffic class queue (0 .. 3)
5156 define sw_interface_set_dpdk_hqos_tctbl {
5165 /** \brief DPDK interface HQoS tctbl entry set reply
5166 @param context - sender context, to match reply w/ request
5167 @param retval - request return code
5169 define sw_interface_set_dpdk_hqos_tctbl_reply {
5174 /** \brief L2 interface pbb tag rewrite configure request
5175 @param client_index - opaque cookie to identify the sender
5176 @param context - sender context, to match reply w/ request
5177 @param sw_if_index - interface the operation is applied to
5178 @param vtr_op - Choose from l2_vtr_op_t enum values
5179 @param inner_tag - needed for translate_qinq vtr op only
5180 @param outer_tag - needed for translate_qinq vtr op only
5181 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
5182 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
5183 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
5184 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
5186 define l2_interface_pbb_tag_rewrite
5199 /** \brief L2 interface pbb tag rewrite response
5200 @param context - sender context, to match reply w/ request
5201 @param retval - return code for the request
5203 define l2_interface_pbb_tag_rewrite_reply
5209 /** \brief Punt traffic to the host
5210 @param client_index - opaque cookie to identify the sender
5211 @param context - sender context, to match reply w/ request
5212 @param is_add - add punt if non-zero, else delete
5213 @param ipv - L3 protocol 4 - IPv4, 6 - IPv6, ~0 - All
5214 @param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
5215 @param l4_port - TCP/UDP port to be punted
5226 /** \brief Reply to the punt request
5227 @param context - sender context which was passed in the request
5228 @param retval - return code of punt request