1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2015 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 This file defines vpe control-plane API messages which are generally
20 called through a shared memory interface.
24 /** \brief Register for interface events
25 @param client_index - opaque cookie to identify the sender
26 @param context - sender context, to match reply w/ request
27 @param enable_disable - 1 => register for events, 0 => cancel registration
28 @param pid - sender's pid
30 define want_interface_events
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 Initialize a new tap interface with the given paramters
219 @param client_index - opaque cookie to identify the sender
220 @param context - sender context, to match reply w/ request
221 @param use_random_mac - let the system generate a unique mac address
222 @param tap_name - name to associate with the new interface
223 @param mac_address - mac addr to assign to the interface if use_radom not set
233 u32 custom_dev_instance;
236 /** \brief Reply for tap connect request
237 @param context - returned sender context, to match reply w/ request
238 @param retval - return code
239 @param sw_if_index - software index allocated for the new tap interface
241 define tap_connect_reply
248 /** \brief Modify a tap interface with the given paramters
249 @param client_index - opaque cookie to identify the sender
250 @param context - sender context, to match reply w/ request
251 @param sw_if_index - interface index of existing tap interface
252 @param use_random_mac - let the system generate a unique mac address
253 @param tap_name - name to associate with the new interface
254 @param mac_address - mac addr to assign to the interface if use_radom not set
265 u32 custom_dev_instance;
268 /** \brief Reply for tap modify request
269 @param context - returned sender context, to match reply w/ request
270 @param retval - return code
271 @param sw_if_index - software index if the modified tap interface
273 define tap_modify_reply
280 /** \brief Delete tap interface
281 @param client_index - opaque cookie to identify the sender
282 @param context - sender context, to match reply w/ request
283 @param sw_if_index - interface index of existing tap interface
292 /** \brief Reply for tap delete request
293 @param context - returned sender context, to match reply w/ request
294 @param retval - return code
296 define tap_delete_reply
302 /** \brief Dump tap interfaces request */
303 define sw_interface_tap_dump
309 /** \brief Reply for tap dump request
310 @param sw_if_index - software index of tap interface
311 @param dev_name - Linux tap device name
313 define sw_interface_tap_details
320 /** \brief Create a new subinterface with the given vlan id
321 @param client_index - opaque cookie to identify the sender
322 @param context - sender context, to match reply w/ request
323 @param sw_if_index - software index of the new vlan's parent interface
324 @param vlan_id - vlan tag of the new interface
326 define create_vlan_subif
334 /** \brief Reply for the vlan subinterface create request
335 @param context - returned sender context, to match reply w/ request
336 @param retval - return code
337 @param sw_if_index - software index allocated for the new subinterface
339 define create_vlan_subif_reply
346 /** \brief Add / del route request
347 @param client_index - opaque cookie to identify the sender
348 @param context - sender context, to match reply w/ request
349 @param sw_if_index - software index of the new vlan's parent interface
350 @param vrf_id - fib table /vrf associated with the route
351 @param lookup_in_vrf -
352 @param resolve_attempts -
353 @param classify_table_index -
354 @param create_vrf_if_needed -
355 @param resolve_if_needed -
356 @param is_add - 1 if adding the route, 0 if deleting
358 @param is_ipv6 - 0 if an ip4 route, else ip6
361 @param is_multipath - Set to 1 if this is a multipath route, else 0
362 @param not_last - Is last or not last msg in group of multiple add/del msgs
363 @param next_hop_weight -
364 @param dst_address_length -
365 @param dst_address[16] -
366 @param next_hop_address[16] -
368 define ip_add_del_route
372 u32 next_hop_sw_if_index;
375 u32 resolve_attempts;
376 u32 classify_table_index;
377 u8 create_vrf_if_needed;
378 u8 resolve_if_needed;
384 /* Is last/not-last message in group of multiple add/del messages. */
388 u8 dst_address_length;
390 u8 next_hop_address[16];
393 /** \brief Reply for add / del route request
394 @param context - returned sender context, to match reply w/ request
395 @param retval - return code
397 define ip_add_del_route_reply
404 /** \brief Add / del gre tunnel request
405 @param client_index - opaque cookie to identify the sender
406 @param context - sender context, to match reply w/ request
407 @param sw_if_index - software index of the new vlan's parent interface
408 @param inner_vrf_id -
409 @param outer_vrf_id -
410 @param is_add - 1 if adding the tunnel, 0 if deleting
411 @param src_address[4] - tunnel source address
412 @param dst_address[4] - tunnel destination address
413 @param intf_address -
414 @param intf_address_length -
416 define mpls_gre_add_del_tunnel
427 u8 intfc_address_length;
430 /** \brief Reply for add / del tunnel request
431 @param context - returned sender context, to match reply w/ request
432 @param retval - return code
434 define mpls_gre_add_del_tunnel_reply
438 u32 tunnel_sw_if_index;
441 /** \brief Add / del MPLS encapsulation request
442 @param client_index - opaque cookie to identify the sender
443 @param context - sender context, to match reply w/ request
444 @param vrf_id - vrf id
445 @param dst_address[4] -
446 @param is_add - 1 if adding the encap, 0 if deleting
447 @param nlabels - number of labels
448 @param labels - array of labels
450 define mpls_add_del_encap
456 /* 1 = add, 0 = delete */
462 /** \brief Reply for add / del encapsulation request
463 @param context - returned sender context, to match reply w/ request
464 @param retval - return code
466 define mpls_add_del_encap_reply
472 /** \brief Add / del MPLS decapsulation request
473 @param client_index - opaque cookie to identify the sender
474 @param context - sender context, to match reply w/ request
475 @param rx_vrf_id - receive vrf
476 @param tx_vrf_id - transmit vrf
480 @param is_add - 1 if adding the encap, 0 if deleting
482 define mpls_add_del_decap
494 /** \brief Reply for MPLS decap add / del request
495 @param context - returned sender context, to match reply w/ request
496 @param retval - return code
498 define mpls_add_del_decap_reply
504 /** \brief Proxy ARP add / del request
505 @param client_index - opaque cookie to identify the sender
506 @param context - sender context, to match reply w/ request
507 @param vrf_id - VRF / Fib table ID
508 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
509 @param low_address[4] - Low address of the Proxy ARP range
510 @param hi_address[4] - High address of the Proxy ARP range
512 define proxy_arp_add_del
522 /** \brief Reply for proxy arp add / del request
523 @param context - returned sender context, to match reply w/ request
524 @param retval - return code
526 define proxy_arp_add_del_reply
532 /** \brief Proxy ARP add / del request
533 @param client_index - opaque cookie to identify the sender
534 @param context - sender context, to match reply w/ request
535 @param sw_if_index - Which interface to enable / disable Proxy Arp on
536 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
538 define proxy_arp_intfc_enable_disable
543 /* 1 = on, 0 = off */
547 /** \brief Reply for Proxy ARP interface enable / disable request
548 @param context - returned sender context, to match reply w/ request
549 @param retval - return code
551 define proxy_arp_intfc_enable_disable_reply
557 /** \brief IP neighbor add / del request
558 @param client_index - opaque cookie to identify the sender
559 @param context - sender context, to match reply w/ request
560 @param vrf_id - vrf_id, only for IP4
561 @param sw_if_index - interface used to reach neighbor
562 @param is_add - 1 to add neighbor, 0 to delete
563 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
565 @param mac_address - l2 address of the neighbor
566 @param dst_address - ip4 or ip6 address of the neighbor
568 define ip_neighbor_add_del
572 u32 vrf_id; /* only makes sense for ip4 */
574 /* 1 = add, 0 = delete */
582 /** \brief Reply for IP Neighbor add / delete request
583 @param context - returned sender context, to match reply w/ request
584 @param retval - return code
586 define ip_neighbor_add_del_reply
592 /** \brief Reset VRF (remove all routes etc) request
593 @param client_index - opaque cookie to identify the sender
594 @param context - sender context, to match reply w/ request
595 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
596 @param vrf_id - ID of th FIB table / VRF to reset
606 /** \brief Reply for Reset VRF request
607 @param context - returned sender context, to match reply w/ request
608 @param retval - return code
610 define reset_vrf_reply
616 /** \brief Is Address Reachable request - DISABLED
617 @param client_index - opaque cookie to identify the sender
618 @param context - sender context, to match reply w/ request
619 @param next_hop_sw_if_index - index of interface used to get to next hop
620 @param is_ipv6 - 1 for IPv6, 0 for IPv4
621 @param is_error - address not found or does not match intf
622 @param address[] - Address in question
624 define is_address_reachable
626 u32 client_index; /* (api_main_t *) am->my_client_index */
628 u32 next_hop_sw_if_index;
629 u8 is_known; /* on reply, this is the answer */
631 u8 is_error; /* address not found or does not match intf */
635 /** \brief Want Stats, register for stats updates
636 @param client_index - opaque cookie to identify the sender
637 @param context - sender context, to match reply w/ request
638 @param enable_disable - 1 = enable stats, 0 = disable
639 @param pid - pid of process requesting stats updates
649 /** \brief Reply for Want Stats request
650 @param context - returned sender context, to match reply w/ request
651 @param retval - return code
653 define want_stats_reply
659 /** \brief Want stats counters structure
660 @param vnet_counter_type- such as ip4, ip6, punts, etc
661 @param is_combined - rx & tx total (all types) counts
662 @param first_sw_if_index - first sw index in block of index, counts
663 @param count - number of interfaces this stats block includes counters for
664 @param data - contiguous block of vlib_counter_t structures
666 define vnet_interface_counters
668 /* enums - plural - in vnet/interface.h */
669 u8 vnet_counter_type;
671 u32 first_sw_if_index;
676 typeonly manual_print manual_endian define ip4_fib_counter
684 manual_print manual_endian define vnet_ip4_fib_counters
688 vl_api_ip4_fib_counter_t c[count];
691 typeonly manual_print manual_endian define ip6_fib_counter
699 manual_print manual_endian define vnet_ip6_fib_counters
703 vl_api_ip6_fib_counter_t c[count];
706 /** \brief Request for a single block of summary stats
707 @param client_index - opaque cookie to identify the sender
708 @param context - sender context, to match reply w/ request
710 define vnet_get_summary_stats
716 /** \brief Reply for vnet_get_summary_stats request
717 @param context - sender context, to match reply w/ request
718 @param retval - return code for request
723 define vnet_summary_stats_reply
732 /** \brief OAM event structure
733 @param dst_address[] -
742 /** \brief Want OAM events request
743 @param client_index - opaque cookie to identify the sender
744 @param context - sender context, to match reply w/ request
745 @param enable_disable- enable if non-zero, else disable
746 @param pid - pid of the requesting process
748 define want_oam_events
756 /** \brief Want OAM events response
757 @param context - sender context, to match reply w/ request
758 @param retval - return code for the want oam stats request
760 define want_oam_events_reply
766 /** \brief OAM add / del target request
767 @param client_index - opaque cookie to identify the sender
768 @param context - sender context, to match reply w/ request
769 @param vrf_id - vrf_id of the target
770 @param src_address[] - source address to use for the updates
771 @param dst_address[] - destination address of the target
772 @param is_add - add target if non-zero, else delete
784 /** \brief OAM add / del target response
785 @param context - sender context, to match reply w/ request
786 @param retval - return code of the request
788 define oam_add_del_reply
794 /** \brief Reset fib table request
795 @param client_index - opaque cookie to identify the sender
796 @param context - sender context, to match reply w/ request
797 @param vrf_id - vrf/table id of the fib table to reset
798 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
808 /** \brief Reset fib response
809 @param context - sender context, to match reply w/ request
810 @param retval - return code for the reset bfib request
812 define reset_fib_reply
818 /** \brief DHCP Proxy config add / del request
819 @param client_index - opaque cookie to identify the sender
820 @param context - sender context, to match reply w/ request
821 @param vrf_id - vrf id
822 @param if_ipv6 - ipv6 if non-zero, else ipv4
823 @param is_add - add the config if non-zero, else delete
824 @param insert_circuit_id - option82 suboption 1 fib number
825 @param dhcp_server[] - server address
826 @param dhcp_src_address[] - <fix this, need details>
828 define dhcp_proxy_config
835 u8 insert_circuit_id;
837 u8 dhcp_src_address[16];
840 /** \brief DHCP Proxy config response
841 @param context - sender context, to match reply w/ request
842 @param retval - return code for the request
844 define dhcp_proxy_config_reply
850 /** \brief DHCP Proxy set / unset vss request
851 @param client_index - opaque cookie to identify the sender
852 @param context - sender context, to match reply w/ request
853 @param tbl_id - table id
854 @param oui - first part of vpn id
855 @param fib_id - second part of vpn id
856 @param is_ipv6 - ip6 if non-zero, else ip4
857 @param is_add - set vss if non-zero, else delete
859 define dhcp_proxy_set_vss
870 /** \brief DHCP proxy set / unset vss response
871 @param context - sender context, to match reply w/ request
872 @param retval - return code for the request
874 define dhcp_proxy_set_vss_reply
880 /** \brief Set the ip flow hash config for a fib request
881 @param client_index - opaque cookie to identify the sender
882 @param context - sender context, to match reply w/ request
883 @param vrf_id - vrf/fib id
884 @param is_ipv6 - if non-zero the fib is ip6, else ip4
885 @param src - if non-zero include src in flow hash
886 @param dst - if non-zero include dst in flow hash
887 @param sport - if non-zero include sport in flow hash
888 @param dport - if non-zero include dport in flow hash
889 @param proto -if non-zero include proto in flow hash
890 @param reverse - if non-zero include reverse in flow hash
892 define set_ip_flow_hash
906 /** \brief Set the ip flow hash config for a fib response
907 @param context - sender context, to match reply w/ request
908 @param retval - return code for the request
910 define set_ip_flow_hash_reply
916 /** \brief IPv6 router advertisement config request
917 @param client_index - opaque cookie to identify the sender
918 @param context - sender context, to match reply w/ request
923 @param send_unicast -
926 @param default_router -
927 @param max_interval -
928 @param min_interval -
930 @param initial_count -
931 @param initial_interval -
933 define sw_interface_ip6nd_ra_config
950 u32 initial_interval;
953 /** \brief IPv6 router advertisement config response
954 @param context - sender context, to match reply w/ request
955 @param retval - return code for the request
957 define sw_interface_ip6nd_ra_config_reply
963 /** \brief IPv6 router advertisement prefix config request
964 @param client_index - opaque cookie to identify the sender
965 @param context - sender context, to match reply w/ request
968 @param address_length -
970 @param no_advertise -
972 @param no_autoconfig -
975 @param val_lifetime -
976 @param pref_lifetime -
978 define sw_interface_ip6nd_ra_prefix
995 /** \brief IPv6 router advertisement prefix config response
996 @param context - sender context, to match reply w/ request
997 @param retval - return code for the request
999 define sw_interface_ip6nd_ra_prefix_reply
1005 /** \brief IPv6 interface enable / disable request
1006 @param client_index - opaque cookie to identify the sender
1007 @param context - sender context, to match reply w/ request
1008 @param sw_if_index - interface used to reach neighbor
1009 @param enable - if non-zero enable ip6 on interface, else disable
1011 define sw_interface_ip6_enable_disable
1016 u8 enable; /* set to true if enable */
1019 /** \brief IPv6 interface enable / disable response
1020 @param context - sender context, to match reply w/ request
1021 @param retval - return code for the request
1023 define sw_interface_ip6_enable_disable_reply
1029 /** \brief IPv6 set link local address on interface request
1030 @param client_index - opaque cookie to identify the sender
1031 @param context - sender context, to match reply w/ request
1032 @param sw_if_index - interface to set link local on
1033 @param address[] - the new link local address
1034 @param address_length - link local address length
1036 define sw_interface_ip6_set_link_local_address
1045 /** \brief IPv6 set link local address on interface response
1046 @param context - sender context, to match reply w/ request
1047 @param retval - error code for the request
1049 define sw_interface_ip6_set_link_local_address_reply
1055 /** \brief Set unnumbered interface add / del 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 with an IP address
1059 @param unnumbered_sw_if_index - interface which will use the address
1060 @param is_add - if non-zero set the association, else unset it
1062 define sw_interface_set_unnumbered
1066 u32 sw_if_index; /* use this intfc address */
1067 u32 unnumbered_sw_if_index; /* on this interface */
1071 /** \brief Set unnumbered interface add / del response
1072 @param context - sender context, to match reply w/ request
1073 @param retval - return code for the request
1075 define sw_interface_set_unnumbered_reply
1081 /** \brief Create loopback interface request
1082 @param client_index - opaque cookie to identify the sender
1083 @param context - sender context, to match reply w/ request
1084 @param mac_address - mac addr to assign to the interface if none-zero
1086 define create_loopback
1093 /** \brief Create loopback interface response
1094 @param context - sender context, to match reply w/ request
1095 @param sw_if_index - sw index of the interface that was created
1096 @param retval - return code for the request
1098 define create_loopback_reply
1105 /** \brief Delete loopback interface request
1106 @param client_index - opaque cookie to identify the sender
1107 @param context - sender context, to match reply w/ request
1108 @param sw_if_index - sw index of the interface that was created
1110 define delete_loopback
1117 /** \brief Delete loopback interface response
1118 @param context - sender context, to match reply w/ request
1119 @param retval - return code for the request
1121 define delete_loopback_reply
1127 /** \brief Control ping from client to api server request
1128 @param client_index - opaque cookie to identify the sender
1129 @param context - sender context, to match reply w/ request
1137 /** \brief Control ping from the client to the server response
1138 @param client_index - opaque cookie to identify the sender
1139 @param context - sender context, to match reply w/ request
1140 @param retval - return code for the request
1141 @param vpe_pid - the pid of the vpe, returned by the server
1143 define control_ping_reply
1151 /** \brief Control ping from client to api server request, no print json output
1152 @param client_index - opaque cookie to identify the sender
1153 @param context - sender context, to match reply w/ request
1155 define noprint_control_ping
1161 /** \brief Control ping from the client to the server response
1162 @param client_index - opaque cookie to identify the sender
1163 @param context - sender context, to match reply w/ request
1164 @param retval - return code for the request
1165 @param vpe_pid - the pid of the vpe, returned by the server
1167 define noprint_control_ping_reply
1175 /** \brief Process a vpe parser cli string request
1176 @param client_index - opaque cookie to identify the sender
1177 @param context - sender context, to match reply w/ request
1178 @param cmd_in_shmem - pointer to cli command string
1187 /** \brief vpe parser cli string response
1188 @param context - sender context, to match reply w/ request
1189 @param retval - return code for request
1190 @param reply_in_shmem - Reply string from cli processing if any
1199 /** \brief Set max allowed ARP or ip6 neighbor entries request
1200 @param client_index - opaque cookie to identify the sender
1201 @param context - sender context, to match reply w/ request
1202 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1203 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1205 define set_arp_neighbor_limit
1210 u32 arp_neighbor_limit;
1213 /** \brief Set max allowed ARP or ip6 neighbor entries response
1214 @param context - sender context, to match reply w/ request
1215 @param retval - return code for request
1217 define set_arp_neighbor_limit_reply
1223 /** \brief L2 interface patch add / del request
1224 @param client_index - opaque cookie to identify the sender
1225 @param context - sender context, to match reply w/ request
1226 @param rx_sw_if_index - receive side interface
1227 @param tx_sw_if_index - transmit side interface
1228 @param is_add - if non-zero set up the interface patch, else remove it
1230 define l2_patch_add_del
1239 /** \brief L2 interface patch add / del response
1240 @param context - sender context, to match reply w/ request
1241 @param retval - return code for the request
1243 define l2_patch_add_del_reply
1249 /** \brief IPv6 segment routing tunnel add / del request
1250 @param client_index - opaque cookie to identify the sender
1251 @param context - sender context, to match reply w/ request
1252 @param is_add - add the tunnel if non-zero, else delete it
1253 @param name[] - tunnel name (len. 64)
1254 @param src_address[] -
1255 @param dst_address[] -
1256 @param dst_mask_width -
1257 @param inner_vrf_id -
1258 @param outer_vrf_id -
1259 @param flags_net_byte_order -
1262 @param segs_and_tags[] -
1263 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1265 define sr_tunnel_add_del
1276 u16 flags_net_byte_order;
1279 u8 segs_and_tags[0];
1283 /** \brief IPv6 segment routing tunnel add / del response
1284 @param context - sender context, to match reply w/ request
1285 @param retval - return value for request
1287 define sr_tunnel_add_del_reply
1293 /** \brief IPv6 segment routing policy add / del request
1294 @param client_index - opaque cookie to identify the sender
1295 @param context - sender context, to match reply w/ request
1296 @param is_add - add the tunnel if non-zero, else delete it
1297 @param name[] - policy name (len. 64)
1298 @param tunnel_names[] -
1300 define sr_policy_add_del
1309 /** \brief IPv6 segment routing policy add / del response
1310 @param context - sender context, to match reply w/ request
1311 @param retval - return value for request
1313 define sr_policy_add_del_reply
1319 /** \brief IPv6 segment routing multicast map to policy add / del request
1320 @param client_index - opaque cookie to identify the sender
1321 @param context - sender context, to match reply w/ request
1322 @param is_add - add the tunnel if non-zero, else delete it
1323 @param multicast_address[] - IP6 multicast address
1324 @param policy_name[] = policy name (len.64)
1326 define sr_multicast_map_add_del
1331 u8 multicast_address[16];
1335 /** \brief IPv6 segment routing multicast map to policy add / del response
1336 @param context - sender context, to match reply w/ request
1337 @param retval - return value for request
1339 define sr_multicast_map_add_del_reply
1345 /** \brief Interface set vpath request
1346 @param client_index - opaque cookie to identify the sender
1347 @param context - sender context, to match reply w/ request
1348 @param sw_if_index - interface used to reach neighbor
1349 @param enable - if non-zero enable, else disable
1351 define sw_interface_set_vpath
1359 /** \brief Interface set vpath response
1360 @param context - sender context, to match reply w/ request
1361 @param retval - return code for the request
1363 define sw_interface_set_vpath_reply
1369 /** \brief MPLS Ethernet add / del tunnel request
1370 @param client_index - opaque cookie to identify the sender
1371 @param context - sender context, to match reply w/ request
1372 @param vrf_id - vrf_id, only for IP4
1373 @param sw_if_index - interface used to reach neighbor
1374 @param is_add - add if set, tunnel delete if 0
1375 @param dst_mac_address -
1376 @param adj_address -
1377 @param adj_address_length -
1379 define mpls_ethernet_add_del_tunnel
1387 u8 dst_mac_address[6];
1389 u8 adj_address_length;
1392 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1393 @param context - sender context, to match reply w/ request
1394 @param retval - return code for the request
1396 define mpls_ethernet_add_del_tunnel_reply
1400 u32 tunnel_sw_if_index;
1402 /** \brief MPLS Ethernet add/ del tunnel 2
1403 @param client_index - opaque cookie to identify the sender
1404 @param context - sender context, to match reply w/ request
1405 @param inner_vrf_id -
1406 @param outer_vrf_id -
1407 @param resolve_attempts -
1408 @param resolve_opaque -
1409 @param resolve_if_needed -
1411 @param adj_address -
1412 @param adj_address_length -
1413 @param next_hop_ip4_address_in_outer_vrf -
1415 define mpls_ethernet_add_del_tunnel_2
1421 u32 resolve_attempts;
1422 u32 resolve_opaque; /* no need to set this */
1423 u8 resolve_if_needed;
1427 u8 adj_address_length;
1428 u8 next_hop_ip4_address_in_outer_vrf[4];
1431 /** \brief MPLS Ethernet add/ del tunnel 2
1432 @param context - sender context, to match reply w/ request
1433 @param retval - return code for add /del request
1435 define mpls_ethernet_add_del_tunnel_2_reply
1441 /** \brief Set L2 XConnect between two interfaces request
1442 @param client_index - opaque cookie to identify the sender
1443 @param context - sender context, to match reply w/ request
1444 @param rx_sw_if_index - Receive interface index
1445 @param tx_sw_if_index - Transmit interface index
1446 @param enable - enable xconnect if not 0, else set to L3 mode
1448 define sw_interface_set_l2_xconnect
1457 /** \brief Set L2 XConnect response
1458 @param context - sender context, to match reply w/ request
1459 @param retval - L2 XConnect request return code
1461 define sw_interface_set_l2_xconnect_reply
1467 /** \brief Interface bridge mode request
1468 @param client_index - opaque cookie to identify the sender
1469 @param context - sender context, to match reply w/ request
1470 @param rx_sw_if_index - the interface
1471 @param bd_id - bridge domain id
1472 @param bvi - Setup interface as a bvi, bridge mode only
1473 @param shg - Shared horizon group, for bridge mode only
1474 @param enable - Enable beige mode if not 0, else set to L3 mode
1476 define sw_interface_set_l2_bridge
1487 /** \brief Interface bridge mode response
1488 @param context - sender context, to match reply w/ request
1489 @param retval - Bridge mode request return code
1491 define sw_interface_set_l2_bridge_reply
1497 /** \brief L2 FIB add entry request
1498 @param client_index - opaque cookie to identify the sender
1499 @param context - sender context, to match reply w/ request
1500 @param mac - the entry's mac address
1501 @param bd_id - the entry's bridge domain id
1502 @param sw_if_index - the interface
1503 @param is_add - If non zero add the entry, else delete it
1507 define l2fib_add_del
1520 /** \brief L2 FIB add entry response
1521 @param context - sender context, to match reply w/ request
1522 @param retval - return code for the add l2fib entry request
1524 define l2fib_add_del_reply
1530 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1531 @param client_index - opaque cookie to identify the sender
1532 @param context - sender context, to match reply w/ request
1533 @param sw_if_index - interface
1534 @param is_set - if non-zero, set the bits, else clear them
1535 @param feature_bitmap - non-zero bits to set or clear
1546 /** \brief Set L2 bits response
1547 @param context - sender context, to match reply w/ request
1548 @param retval - return code for the set l2 bits request
1550 define l2_flags_reply
1554 u32 resulting_feature_bitmap;
1557 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1558 L2_UU_FLOOD, or L2_ARP_TERM) request
1559 @param client_index - opaque cookie to identify the sender
1560 @param context - sender context, to match reply w/ request
1561 @param bd_id - the bridge domain to set the flags for
1562 @param is_set - if non-zero, set the flags, else clear them
1563 @param feature_bitmap - bits that are non-zero to set or clear
1574 /** \brief Set bridge flags response
1575 @param context - sender context, to match reply w/ request
1576 @param retval - return code for the set bridge flags request
1577 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1579 define bridge_flags_reply
1583 u32 resulting_feature_bitmap;
1586 /** \brief Set bridge domain ip to mac entry request
1587 @param client_index - opaque cookie to identify the sender
1588 @param context - sender context, to match reply w/ request
1589 @param bd_id - the bridge domain to set the flags for
1590 @param is_add - if non-zero, add the entry, else clear it
1591 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1592 @param mac_address - MAC address
1595 define bd_ip_mac_add_del
1606 /** \brief Set bridge domain ip to mac entry response
1607 @param context - sender context, to match reply w/ request
1608 @param retval - return code for the set bridge flags request
1610 define bd_ip_mac_add_del_reply
1616 /** \brief Add/Delete classification table request
1617 @param client_index - opaque cookie to identify the sender
1618 @param context - sender context, to match reply w/ request
1619 @param is_add- if non-zero add the table, else delete it
1620 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1621 @param nbuckets - number of buckets when adding a table
1622 @param memory_size - memory size when adding a table
1623 @param match_n_vectors - number of match vectors
1624 @param next_table_index - index of next table
1625 @param miss_next_index - index of miss table
1626 @param mask[] - match mask
1628 define classify_add_del_table
1637 u32 match_n_vectors;
1638 u32 next_table_index;
1639 u32 miss_next_index;
1643 /** \brief Add/Delete classification table response
1644 @param context - sender context, to match reply w/ request
1645 @param retval - return code for the table add/del requst
1646 @param new_table_index - for add, returned index of the new table
1647 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1648 @param match_n_vectors -for add, returned value of match_n_vectors in table
1650 define classify_add_del_table_reply
1654 u32 new_table_index;
1656 u32 match_n_vectors;
1659 /** \brief Classify add / del session request
1660 @param client_index - opaque cookie to identify the sender
1661 @param context - sender context, to match reply w/ request
1662 @param is_add - add session if non-zero, else delete
1663 @param table_index - index of the table to add/del the session, required
1664 @param hit_next_index - for add, hit_next_index of new session, required
1665 @param opaque_index - for add, opaque_index of new session
1666 @param advance -for add, advance value for session
1667 @param match[] - for add, match value for session, required
1669 define classify_add_del_session
1681 /** \brief Classify add / del session response
1682 @param context - sender context, to match reply w/ request
1683 @param retval - return code for the add/del session request
1685 define classify_add_del_session_reply
1691 /** \brief Set/unset the classification table for an interface request
1692 @param client_index - opaque cookie to identify the sender
1693 @param context - sender context, to match reply w/ request
1694 @param is_ipv6 - ipv6 if non-zero, else ipv4
1695 @param sw_if_index - interface to associate with the table
1696 @param table_index - index of the table, if ~0 unset the table
1698 define classify_set_interface_ip_table
1704 u32 table_index; /* ~0 => off */
1707 /** \brief Set/unset interface classification table response
1708 @param context - sender context, to match reply w/ request
1709 @param retval - return code
1711 define classify_set_interface_ip_table_reply
1717 /** \brief Set/unset l2 classification tables for an interface request
1718 @param client_index - opaque cookie to identify the sender
1719 @param context - sender context, to match reply w/ request
1720 @param sw_if_index - interface to set/unset tables for
1721 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1722 @param ip6_table_index - ip6 index
1723 @param other_table_index - other index
1725 define classify_set_interface_l2_tables
1731 u32 ip4_table_index;
1732 u32 ip6_table_index;
1733 u32 other_table_index;
1736 /** \brief Set/unset l2 classification tables for an interface response
1737 @param context - sender context, to match reply w/ request
1738 @param retval - return code for the request
1740 define classify_set_interface_l2_tables_reply
1746 /** \brief Get node index using name request
1747 @param client_index - opaque cookie to identify the sender
1748 @param context - sender context, to match reply w/ request
1749 @param node_name[] - name of the node
1751 define get_node_index
1758 /** \brief Get node index using name request
1759 @param context - sender context, to match reply w/ request
1760 @param retval - return code for the request
1761 @param node_index - index of the desired node if found, else ~0
1763 define get_node_index_reply
1770 /** \brief Set the next node for a given node request
1771 @param client_index - opaque cookie to identify the sender
1772 @param context - sender context, to match reply w/ request
1773 @param node_name[] - node to add the next node to
1774 @param next_name[] - node to add as the next node
1776 define add_node_next
1784 /** \brief IP Set the next node for a given node response
1785 @param context - sender context, to match reply w/ request
1786 @param retval - return code for the add next node request
1787 @param next_index - the index of the next node if success, else ~0
1789 define add_node_next_reply
1796 /** \brief DHCP Proxy config 2 add / del request
1797 @param client_index - opaque cookie to identify the sender
1798 @param context - sender context, to match reply w/ request
1799 @param rx_vrf_id - receive vrf id
1800 @param server_vrf_id - server vrf id
1801 @param if_ipv6 - ipv6 if non-zero, else ipv4
1802 @param is_add - add the config if non-zero, else delete
1803 @param insert_circuit_id - option82 suboption 1 fib number
1804 @param dhcp_server[] - server address
1805 @param dhcp_src_address[] - <fix this, need details>
1807 define dhcp_proxy_config_2
1815 u8 insert_circuit_id;
1817 u8 dhcp_src_address[16];
1820 /** \brief DHCP Proxy config 2 add / del response
1821 @param context - sender context, to match reply w/ request
1822 @param retval - return code for request
1824 define dhcp_proxy_config_2_reply
1830 /** \brief l2tpv3 tunnel interface create request
1831 @param client_index - opaque cookie to identify the sender
1832 @param context - sender context, to match reply w/ request
1833 @param client_address - remote client tunnel ip address
1834 @param client_address - local tunnel ip address
1835 @param is_ipv6 - ipv6 if non-zero, else ipv4
1836 @param local_session_id - local tunnel session id
1837 @param remote_session_id - remote tunnel session id
1838 @param local_cookie - local tunnel cookie
1839 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1840 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1842 define l2tpv3_create_tunnel
1846 u8 client_address[16];
1849 u32 local_session_id;
1850 u32 remote_session_id;
1853 u8 l2_sublayer_present;
1857 /** \brief l2tpv3 tunnel interface create response
1858 @param context - sender context, to match reply w/ request
1859 @param retval - return code for the request
1860 @param sw_if_index - index of the new tunnel interface
1862 define l2tpv3_create_tunnel_reply
1869 define l2tpv3_set_tunnel_cookies
1874 u64 new_local_cookie;
1875 u64 new_remote_cookie;
1878 /** \brief L2TP tunnel set cookies response
1879 @param context - sender context, to match reply w/ request
1880 @param retval - return code for the request
1882 define l2tpv3_set_tunnel_cookies_reply
1888 define sw_if_l2tpv3_tunnel_details
1892 u8 interface_name[64];
1893 u8 client_address[16];
1895 u32 local_session_id;
1896 u32 remote_session_id;
1897 u64 local_cookie[2];
1899 u8 l2_sublayer_present;
1902 define sw_if_l2tpv3_tunnel_dump
1908 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1909 @param client_index - opaque cookie to identify the sender
1910 @param context - sender context, to match reply w/ request
1912 define l2_fib_clear_table
1918 /** \brief L2 fib clear table response
1919 @param context - sender context, to match reply w/ request
1920 @param retval - return code for the request
1922 define l2_fib_clear_table_reply
1928 /** \brief L2 interface ethernet flow point filtering enable/disable request
1929 @param client_index - opaque cookie to identify the sender
1930 @param context - sender context, to match reply w/ request
1931 @param sw_if_index - interface to enable/disable filtering on
1932 @param enable_disable - if non-zero enable filtering, else disable
1934 define l2_interface_efp_filter
1942 /** \brief L2 interface ethernet flow point filtering response
1943 @param context - sender context, to match reply w/ request
1944 @param retval - return code for the request
1946 define l2_interface_efp_filter_reply
1952 define l2tpv3_interface_enable_disable
1960 define l2tpv3_interface_enable_disable_reply
1966 define l2tpv3_set_lookup_key
1970 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1974 define l2tpv3_set_lookup_key_reply
1980 define vxlan_add_del_tunnel
1989 u32 decap_next_index;
1993 define vxlan_add_del_tunnel_reply
2000 define vxlan_tunnel_dump
2007 define vxlan_tunnel_details
2014 u32 decap_next_index;
2019 define gre_add_del_tunnel
2030 define gre_add_del_tunnel_reply
2037 define gre_tunnel_dump
2044 define gre_tunnel_details
2054 /** \brief L2 interface vlan tag rewrite configure request
2055 @param client_index - opaque cookie to identify the sender
2056 @param context - sender context, to match reply w/ request
2057 @param sw_if_index - interface the operation is applied to
2058 @param vtr_op - Choose from l2_vtr_op_t enum values
2059 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
2060 @param tag1 - Needed for any push or translate vtr op
2061 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
2063 define l2_interface_vlan_tag_rewrite
2069 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
2070 u32 tag1; // first pushed tag
2071 u32 tag2; // second pushed tag
2074 /** \brief L2 interface vlan tag rewrite response
2075 @param context - sender context, to match reply w/ request
2076 @param retval - return code for the request
2078 define l2_interface_vlan_tag_rewrite_reply
2084 /** \brief vhost-user interface create request
2085 @param client_index - opaque cookie to identify the sender
2086 @param is_server - our side is socket server
2087 @param sock_filename - unix socket filename, used to speak with frontend
2088 @param use_custom_mac - enable or disable the use of the provided hardware address
2089 @param mac_address - hardware address to use if 'use_custom_mac' is set
2091 define create_vhost_user_if
2096 u8 sock_filename[256];
2098 u32 custom_dev_instance;
2103 /** \brief vhost-user interface create response
2104 @param context - sender context, to match reply w/ request
2105 @param retval - return code for the request
2106 @param sw_if_index - interface the operation is applied to
2108 define create_vhost_user_if_reply
2115 /** \brief vhost-user interface modify request
2116 @param client_index - opaque cookie to identify the sender
2117 @param is_server - our side is socket server
2118 @param sock_filename - unix socket filename, used to speak with frontend
2120 define modify_vhost_user_if
2126 u8 sock_filename[256];
2128 u32 custom_dev_instance;
2131 /** \brief vhost-user interface modify response
2132 @param context - sender context, to match reply w/ request
2133 @param retval - return code for the request
2135 define modify_vhost_user_if_reply
2141 /** \brief vhost-user interface delete request
2142 @param client_index - opaque cookie to identify the sender
2144 define delete_vhost_user_if
2151 /** \brief vhost-user interface delete response
2152 @param context - sender context, to match reply w/ request
2153 @param retval - return code for the request
2155 define delete_vhost_user_if_reply
2168 /* These fields map directly onto the subif template */
2172 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2175 u8 outer_vlan_id_any;
2176 u8 inner_vlan_id_any;
2181 define create_subif_reply
2188 /** \brief show version
2189 @param client_index - opaque cookie to identify the sender
2190 @param context - sender context, to match reply w/ request
2198 /** \brief show version response
2199 @param context - sender context, to match reply w/ request
2200 @param retval - return code for the request
2201 @param program - name of the program (vpe)
2202 @param version - version of the program
2203 @param build_directory - root of the workspace where the program was built
2205 define show_version_reply
2212 u8 build_directory[256];
2215 /** \brief Vhost-user interface details structure (fix this)
2216 @param sw_if_index - index of the interface
2217 @param interface_name - name of interface
2218 @param virtio_net_hdr_sz - net header size
2219 @param features - interface features
2220 @param is_server - vhost-user server socket
2221 @param sock_filename - socket filename
2222 @param num_regions - number of used memory regions
2224 define sw_interface_vhost_user_details
2228 u8 interface_name[64];
2229 u32 virtio_net_hdr_sz;
2232 u8 sock_filename[256];
2238 define sw_interface_vhost_user_dump
2244 define ip_address_details
2252 define ip_address_dump
2273 /** \brief l2 fib table entry structure
2274 @param bd_id - the l2 fib / bridge domain table id
2275 @param mac - the entry's mac address
2276 @param sw_if_index - index of the interface
2277 @param static_mac - the entry is statically configured.
2278 @param filter_mac - the entry is a mac filter entry.
2279 @param bvi_mac - the mac address is a bridge virtual interface
2281 define l2_fib_table_entry
2292 /** \brief Dump l2 fib (aka bridge domain) table
2293 @param client_index - opaque cookie to identify the sender
2294 @param bd_id - the l2 fib / bridge domain table identifier
2296 define l2_fib_table_dump
2303 define vxlan_gpe_add_del_tunnel
2317 define vxlan_gpe_add_del_tunnel_reply
2324 define vxlan_gpe_tunnel_dump
2331 define vxlan_gpe_tunnel_details
2344 /** \brief add or delete locator_set
2345 @param client_index - opaque cookie to identify the sender
2346 @param context - sender context, to match reply w/ request
2347 @param is_add - add address if non-zero, else delete
2348 @param locator_set_name - locator name
2349 @param locator_num - number of locators
2350 @param locators - Lisp locator data
2352 define lisp_add_del_locator_set
2357 u8 locator_set_name[64];
2359 u8 locators[locator_num];
2362 /** \brief Reply for locator_set add/del
2363 @param context - returned sender context, to match reply w/ request
2364 @param retval - return code
2365 @param ls_index - locator set index
2367 define lisp_add_del_locator_set_reply
2374 /** \brief add or delete locator for locator_set
2375 @param client_index - opaque cookie to identify the sender
2376 @param context - sender context, to match reply w/ request
2377 @param is_add - add address if non-zero, else delete
2378 @param locator_set_name - name of locator_set to add/del locator
2379 @param sw_if_index - index of the interface
2380 @param priority - priority of the lisp locator
2381 @param weight - weight of the lisp locator
2383 define lisp_add_del_locator
2388 u8 locator_set_name[64];
2394 /** \brief Reply for locator add/del
2395 @param context - returned sender context, to match reply w/ request
2396 @param retval - return code
2398 define lisp_add_del_locator_reply
2404 /** \brief add or delete lisp eid-table
2405 @param client_index - opaque cookie to identify the sender
2406 @param context - sender context, to match reply w/ request
2407 @param is_add - add address if non-zero, else delete
2412 @param eid - EID can be ip4, ip6 or mac
2413 @param prefix_len - prefix len
2414 @param locator_set_name - name of locator_set to add/del eid-table
2415 @param vni - virtual network instance
2417 define lisp_add_del_local_eid
2425 u8 locator_set_name[64];
2429 /** \brief Reply for local_eid add/del
2430 @param context - returned sender context, to match reply w/ request
2431 @param retval - return code
2433 define lisp_add_del_local_eid_reply
2439 /** \brief add or delete lisp gpe tunnel
2440 @param client_index - opaque cookie to identify the sender
2441 @param context - sender context, to match reply w/ request
2442 @param is_add - add address if non-zero, else delete
2447 @param rmt_eid - remote eid
2448 @param lcl_eid - local eid
2449 @param rmt_len - remote prefix len
2450 @param lcl_len - local prefix len
2451 @param vni - virtual network identifier
2452 @param dp_table - vrf/bridge domain id
2453 @param loc_num - number of locators
2454 @param lcl_locs - array of local locators
2455 @param rmt_locs - array of remote locators
2456 @param action - negative action when 0 locators configured
2458 define lisp_gpe_add_del_fwd_entry
2471 u8 lcl_locs[loc_num];
2472 u8 rmt_locs[loc_num];
2476 /** \brief Reply for gpe_fwd_entry add/del
2477 @param context - returned sender context, to match reply w/ request
2478 @param retval - return code
2480 define lisp_gpe_add_del_fwd_entry_reply
2486 /** \brief add or delete map-resolver
2487 @param client_index - opaque cookie to identify the sender
2488 @param context - sender context, to match reply w/ request
2489 @param is_add - add address if non-zero, else delete
2490 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2491 @param ip_address - array of address bytes
2493 define lisp_add_del_map_resolver
2502 /** \brief Reply for map_resolver add/del
2503 @param context - returned sender context, to match reply w/ request
2504 @param retval - return code
2506 define lisp_add_del_map_resolver_reply
2512 /** \brief enable or disable lisp-gpe protocol
2513 @param client_index - opaque cookie to identify the sender
2514 @param context - sender context, to match reply w/ request
2515 @param is_en - enable protocol if non-zero, else disable
2517 define lisp_gpe_enable_disable
2524 /** \brief Reply for gpe enable/disable
2525 @param context - returned sender context, to match reply w/ request
2526 @param retval - return code
2528 define lisp_gpe_enable_disable_reply
2534 /** \brief enable or disable LISP feature
2535 @param client_index - opaque cookie to identify the sender
2536 @param context - sender context, to match reply w/ request
2537 @param is_en - enable protocol if non-zero, else disable
2539 define lisp_enable_disable
2546 /** \brief Reply for gpe enable/disable
2547 @param context - returned sender context, to match reply w/ request
2548 @param retval - return code
2550 define lisp_enable_disable_reply
2556 /** \brief add or delete gpe_iface
2557 @param client_index - opaque cookie to identify the sender
2558 @param context - sender context, to match reply w/ request
2559 @param is_add - add address if non-zero, else delete
2561 define lisp_gpe_add_del_iface
2571 /** \brief Reply for gpe_iface add/del
2572 @param context - returned sender context, to match reply w/ request
2573 @param retval - return code
2575 define lisp_gpe_add_del_iface_reply
2581 /** \brief configure or disable LISP PITR node
2582 @param client_index - opaque cookie to identify the sender
2583 @param context - sender context, to match reply w/ request
2584 @param ls_name - locator set name
2585 @param is_add - add locator set if non-zero, else disable pitr
2587 define lisp_pitr_set_locator_set
2595 /** \brief Reply for lisp_pitr_set_locator_set
2596 @param context - returned sender context, to match reply w/ request
2597 @param retval - return code
2599 define lisp_pitr_set_locator_set_reply
2605 /** \brief add or delete remote static mapping
2606 @param client_index - opaque cookie to identify the sender
2607 @param context - sender context, to match reply w/ request
2608 @param is_add - add address if non-zero, else delete
2609 @param is_src_dst - flag indicating src/dst based routing policy
2610 @param del_all - if set, delete all remote mappings
2611 @param vni - virtual network instance
2612 @param action - negative map-reply action
2617 @param deid - dst EID
2618 @param seid - src EID, valid only if is_src_dst is enabled
2619 @param rloc_num - number of remote locators
2620 @param rlocs - remote locator data
2622 define lisp_add_del_remote_mapping
2640 /** \brief Reply for lisp_add_del_remote_mapping
2641 @param context - returned sender context, to match reply w/ request
2642 @param retval - return code
2644 define lisp_add_del_remote_mapping_reply
2650 /** \brief add or delete LISP adjacency adjacency
2651 @param client_index - opaque cookie to identify the sender
2652 @param context - sender context, to match reply w/ request
2653 @param is_add - add address if non-zero, else delete
2654 @param vni - virtual network instance
2659 @param deid - destination EID
2660 @param seid - source EID
2662 define lisp_add_del_adjacency
2675 /** \brief Reply for lisp_add_del_adjacency
2676 @param context - returned sender context, to match reply w/ request
2677 @param retval - return code
2679 define lisp_add_del_adjacency_reply
2685 /** \brief add or delete map request itr rlocs
2686 @param client_index - opaque cookie to identify the sender
2687 @param context - sender context, to match reply w/ request
2688 @param is_add - add address if non-zero, else delete
2689 @param locator_set_name - locator set name
2691 define lisp_add_del_map_request_itr_rlocs
2696 u8 locator_set_name[64];
2699 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2700 @param context - returned sender context, to match reply w/ request
2701 @param retval - return code
2704 define lisp_add_del_map_request_itr_rlocs_reply
2710 /** \brief map/unmap vni/bd_index to vrf
2711 @param client_index - opaque cookie to identify the sender
2712 @param context - sender context, to match reply w/ request
2713 @param is_add - add or delete mapping
2714 @param dp_table - virtual network id/bridge domain index
2717 define lisp_eid_table_add_del_map
2727 /** \brief Reply for lisp_eid_table_add_del_map
2728 @param context - returned sender context, to match reply w/ request
2729 @param retval - return code
2731 define lisp_eid_table_add_del_map_reply
2737 /** \brief Request for map lisp locator status
2738 @param client_index - opaque cookie to identify the sender
2739 @param context - sender context, to match reply w/ request
2740 @param locator_set_index - index of locator_set
2741 @param filter - filter type;
2747 define lisp_locator_dump
2751 u32 locator_set_index;
2755 /** \brief LISP locator_set status
2756 @param local - if is set, then locator is local
2757 @param locator_set_name - name of the locator_set
2758 @param sw_if_index - sw_if_index of the locator
2759 @param priority - locator priority
2760 @param weight - locator weight
2762 define lisp_locator_details
2773 /** \brief LISP locator_set status
2774 @param locator_set_name - name of the locator_set
2775 @param local - if is set, then locator_set is local
2776 @param locator_count - number of locator this stats block includes
2777 @param locator - locator data
2779 define lisp_locator_set_details
2783 u32 locator_set_index;
2784 u8 locator_set_name[64];
2787 /** \brief Request for locator_set summary status
2788 @param client_index - opaque cookie to identify the sender
2789 @param context - sender context, to match reply w/ request
2790 @param filter - filter type;
2793 1: local locator_set
2794 2: remote locator_set
2796 define lisp_locator_set_dump
2803 /** \brief Dump lisp eid-table
2804 @param client_index - opaque cookie to identify the sender
2805 @param context - sender context, to match reply w/ request
2806 @param locator_set_index - index of locator_set
2807 @param is_local - local if non-zero, else remote
2812 @param eid - EID can be ip4, ip6 or mac
2813 @param prefix_len - prefix len
2814 @param vni - virtual network instance
2815 @param ttl - time to live
2816 @param authoritative - authoritative
2819 define lisp_eid_table_details
2822 u32 locator_set_index;
2832 /** \brief Request for eid table summary status
2833 @param client_index - opaque cookie to identify the sender
2834 @param context - sender context, to match reply w/ request
2835 @param eid_set - if non-zero request info about specific mapping
2836 @param vni - virtual network instance; valid only if eid_set != 0
2837 @param prefix_length - prefix length if EID is IP address;
2838 valid only if eid_set != 0
2839 @param eid_type - EID type; valid only if eid_set != 0
2843 2: EID is ethernet address
2844 @param eid - endpoint identifier
2845 @param filter - filter type;
2851 define lisp_eid_table_dump
2863 /** \brief Shows relationship between vni and vrf/bd
2864 @param dp_table - VRF index or bridge domain index
2865 @param vni - vitual network instance
2867 define lisp_eid_table_map_details
2874 /** \brief Request for lisp_eid_table_map_details
2875 @param client_index - opaque cookie to identify the sender
2876 @param context - sender context, to match reply w/ request
2877 @param is_l2 - if set dump vni/bd mappings else vni/vrf
2879 define lisp_eid_table_map_dump
2886 /** \brief Dumps all VNIs used in mappings
2887 @param client_index - opaque cookie to identify the sender
2888 @param context - sender context, to match reply w/ request
2890 define lisp_eid_table_vni_dump
2896 /** \brief reply to lisp_eid_table_vni_dump
2897 @param client_index - opaque cookie to identify the sender
2898 @param context - sender context, to match reply w/ request
2899 @param vni - virtual network instance
2901 define lisp_eid_table_vni_details
2908 define lisp_gpe_tunnel_details
2914 u8 destination_ip[16];
2926 /** \brief Request for gpe tunnel summary status
2927 @param client_index - opaque cookie to identify the sender
2928 @param context - sender context, to match reply w/ request
2930 define lisp_gpe_tunnel_dump
2936 /** \brief LISP map resolver status
2937 @param locator_set_name - name of the locator_set
2938 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2939 @param ip_address - array of address bytes
2941 define lisp_map_resolver_details
2948 /** \brief Request for map resolver summary status
2949 @param client_index - opaque cookie to identify the sender
2950 @param context - sender context, to match reply w/ request
2952 define lisp_map_resolver_dump
2958 /** \brief Request for lisp-gpe protocol status
2959 @param client_index - opaque cookie to identify the sender
2960 @param context - sender context, to match reply w/ request
2962 define show_lisp_status
2968 /** \brief Status of lisp, enable or disable
2969 @param context - sender context, to match reply w/ request
2970 @param feature_status - lisp enable if non-zero, else disable
2971 @param gpe_status - lisp enable if non-zero, else disable
2973 define show_lisp_status_reply
2981 /** \brief Get LISP map request itr rlocs status
2982 @param context - sender context, to match reply w/ request
2983 @param locator_set_name - name of the locator_set
2985 define lisp_get_map_request_itr_rlocs
2991 /** \brief Request for map request itr rlocs summary status
2993 define lisp_get_map_request_itr_rlocs_reply
2997 u8 locator_set_name[64];
3000 /** \brief Request for lisp pitr status
3001 @param client_index - opaque cookie to identify the sender
3002 @param context - sender context, to match reply w/ request
3004 define show_lisp_pitr
3010 /** \brief Status of lisp pitr, enable or disable
3011 @param context - sender context, to match reply w/ request
3012 @param status - lisp pitr enable if non-zero, else disable
3013 @param locator_set_name - name of the locator_set
3015 define show_lisp_pitr_reply
3020 u8 locator_set_name[64];
3023 /* Gross kludge, DGMS */
3024 define interface_name_renumber
3029 u32 new_show_dev_instance;
3032 define interface_name_renumber_reply
3038 /** \brief Register for ip4 arp resolution events
3039 @param client_index - opaque cookie to identify the sender
3040 @param context - sender context, to match reply w/ request
3041 @param enable_disable - 1 => register for events, 0 => cancel registration
3042 @param pid - sender's pid
3043 @param address - the exact ip4 address of interest
3045 define want_ip4_arp_events
3054 /** \brief Reply for interface events registration
3055 @param context - returned sender context, to match reply w/ request
3056 @param retval - return code
3058 define want_ip4_arp_events_reply
3064 /** \brief Tell client about an ip4 arp resolution event
3065 @param client_index - opaque cookie to identify the sender
3066 @param context - sender context, to match reply w/ request
3067 @param address - the exact ip4 address of interest
3068 @param pid - client pid registered to receive notification
3069 @param sw_if_index - interface which received ARP packet
3070 @param new_mac - the new mac address
3072 define ip4_arp_event
3082 /** \brief L2 bridge domain add or delete request
3083 @param client_index - opaque cookie to identify the sender
3084 @param context - sender context, to match reply w/ request
3085 @param bd_id - the bridge domain to create
3086 @param flood - enable/disable bcast/mcast flooding in the bd
3087 @param uu_flood - enable/disable uknown unicast flood in the bd
3088 @param forward - enable/disable forwarding on all interfaces in the bd
3089 @param learn - enable/disable learning on all interfaces in the bd
3090 @param arp_term - enable/disable arp termination in the bd
3091 @param is_add - add or delete flag
3093 define bridge_domain_add_del
3106 /** \brief L2 bridge domain add or delete response
3107 @param context - sender context, to match reply w/ request
3108 @param retval - return code for the set bridge flags request
3110 define bridge_domain_add_del_reply
3116 /** \brief L2 bridge domain request operational state details
3117 @param client_index - opaque cookie to identify the sender
3118 @param context - sender context, to match reply w/ request
3119 @param bd_id - the bridge domain id desired or ~0 to request all bds
3121 define bridge_domain_dump
3128 /** \brief L2 bridge domain operational state response
3129 @param bd_id - the bridge domain id
3130 @param flood - bcast/mcast flooding state on all interfaces in the bd
3131 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3132 @param forward - forwarding state on all interfaces in the bd
3133 @param learn - learning state on all interfaces in the bd
3134 @param arp_term - arp termination state on all interfaces in the bd
3135 @param n_sw_ifs - number of sw_if_index's in the domain
3137 define bridge_domain_details
3146 u32 bvi_sw_if_index;
3150 /** \brief L2 bridge domain sw interface operational state response
3151 @param bd_id - the bridge domain id
3152 @param sw_if_index - sw_if_index in the domain
3153 @param shg - split horizon group for the interface
3155 define bridge_domain_sw_if_details
3163 /** \brief DHCP Client config add / del request
3164 @param client_index - opaque cookie to identify the sender
3165 @param context - sender context, to match reply w/ request
3166 @param sw_if_index - index of the interface for DHCP client
3167 @param hostname - hostname
3168 @param is_add - add the config if non-zero, else delete
3169 @param want_dhcp_event - DHCP event sent to the sender
3170 via dhcp_compl_event API message if non-zero
3171 @param pid - sender's pid
3173 define dhcp_client_config
3184 /** \brief DHCP Client config response
3185 @param context - sender context, to match reply w/ request
3186 @param retval - return code for the request
3188 define dhcp_client_config_reply
3194 /** \brief Set/unset input ACL interface
3195 @param client_index - opaque cookie to identify the sender
3196 @param context - sender context, to match reply w/ request
3197 @param sw_if_index - interface to set/unset input ACL
3198 @param ip4_table_index - ip4 classify table index (~0 for skip)
3199 @param ip6_table_index - ip6 classify table index (~0 for skip)
3200 @param l2_table_index - l2 classify table index (~0 for skip)
3201 @param is_add - Set input ACL if non-zero, else unset
3202 Note: User is recommeneded to use just one valid table_index per call.
3203 (ip4_table_index, ip6_table_index, or l2_table_index)
3205 define input_acl_set_interface
3210 u32 ip4_table_index;
3211 u32 ip6_table_index;
3216 /** \brief Set/unset input ACL interface response
3217 @param context - sender context, to match reply w/ request
3218 @param retval - return code for the request
3220 define input_acl_set_interface_reply
3226 /** \brief IPsec: Add/delete Security Policy Database
3227 @param client_index - opaque cookie to identify the sender
3228 @param context - sender context, to match reply w/ request
3229 @param is_add - add SPD if non-zero, else delete
3230 @param spd_id - SPD instance id (control plane allocated)
3233 define ipsec_spd_add_del
3241 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3242 @param context - returned sender context, to match reply w/ request
3243 @param retval - return code
3246 define ipsec_spd_add_del_reply
3252 /** \brief IPsec: Add/delete SPD from interface
3254 @param client_index - opaque cookie to identify the sender
3255 @param context - sender context, to match reply w/ request
3256 @param is_add - add security mode if non-zero, else delete
3257 @param sw_if_index - index of the interface
3258 @param spd_id - SPD instance id to use for lookups
3262 define ipsec_interface_add_del_spd
3272 /** \brief Reply for IPsec: Add/delete SPD from interface
3273 @param context - returned sender context, to match reply w/ request
3274 @param retval - return code
3277 define ipsec_interface_add_del_spd_reply
3283 /** \brief IPsec: Add/delete Security Policy Database entry
3285 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3287 @param client_index - opaque cookie to identify the sender
3288 @param context - sender context, to match reply w/ request
3289 @param is_add - add SPD if non-zero, else delete
3290 @param spd_id - SPD instance id (control plane allocated)
3291 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3292 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3293 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3294 @param remote_address_start - start of remote address range to match
3295 @param remote_address_stop - end of remote address range to match
3296 @param local_address_start - start of local address range to match
3297 @param local_address_stop - end of local address range to match
3298 @param protocol - protocol type to match [0 means any]
3299 @param remote_port_start - start of remote port range to match ...
3300 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3301 @param local_port_start - start of local port range to match ...
3302 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3303 @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)
3304 @param sa_id - SAD instance id (control plane allocated)
3308 define ipsec_spd_add_del_entry
3321 u8 remote_address_start[16];
3322 u8 remote_address_stop[16];
3323 u8 local_address_start[16];
3324 u8 local_address_stop[16];
3328 u16 remote_port_start;
3329 u16 remote_port_stop;
3330 u16 local_port_start;
3331 u16 local_port_stop;
3338 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3339 @param context - returned sender context, to match reply w/ request
3340 @param retval - return code
3343 define ipsec_spd_add_del_entry_reply
3349 /** \brief IPsec: Add/delete Security Association Database entry
3350 @param client_index - opaque cookie to identify the sender
3351 @param context - sender context, to match reply w/ request
3352 @param is_add - add SAD entry if non-zero, else delete
3354 @param sad_id - sad id
3356 @param spi - security parameter index
3358 @param protocol - 0 = AH, 1 = ESP
3360 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3361 @param crypto_key_length - length of crypto_key in bytes
3362 @param crypto_key - crypto keying material
3364 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3365 @param integrity_key_length - length of integrity_key in bytes
3366 @param integrity_key - integrity keying material
3368 @param use_extended_sequence_number - use ESN when non-zero
3370 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3371 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3372 @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
3373 @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
3377 IPsec tunnel address copy mode (to support GDOI)
3380 define ipsec_sad_add_del_entry
3392 u8 crypto_algorithm;
3393 u8 crypto_key_length;
3396 u8 integrity_algorithm;
3397 u8 integrity_key_length;
3398 u8 integrity_key[128];
3400 u8 use_extended_sequence_number;
3404 u8 tunnel_src_address[16];
3405 u8 tunnel_dst_address[16];
3408 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3409 @param context - returned sender context, to match reply w/ request
3410 @param retval - return code
3413 define ipsec_sad_add_del_entry_reply
3419 /** \brief IPsec: Update Security Association keys
3420 @param client_index - opaque cookie to identify the sender
3421 @param context - sender context, to match reply w/ request
3423 @param sa_id - sa id
3425 @param crypto_key_length - length of crypto_key in bytes
3426 @param crypto_key - crypto keying material
3428 @param integrity_key_length - length of integrity_key in bytes
3429 @param integrity_key - integrity keying material
3432 define ipsec_sa_set_key
3439 u8 crypto_key_length;
3442 u8 integrity_key_length;
3443 u8 integrity_key[128];
3446 /** \brief Reply for IPsec: Update Security Association keys
3447 @param context - returned sender context, to match reply w/ request
3448 @param retval - return code
3451 define ipsec_sa_set_key_reply
3457 /** \brief IKEv2: Add/delete profile
3458 @param client_index - opaque cookie to identify the sender
3459 @param context - sender context, to match reply w/ request
3461 @param name - IKEv2 profile name
3462 @param is_add - Add IKEv2 profile if non-zero, else delete
3464 define ikev2_profile_add_del
3473 /** \brief Reply for IKEv2: Add/delete profile
3474 @param context - returned sender context, to match reply w/ request
3475 @param retval - return code
3477 define ikev2_profile_add_del_reply
3483 /** \brief IKEv2: Set IKEv2 profile authentication method
3484 @param client_index - opaque cookie to identify the sender
3485 @param context - sender context, to match reply w/ request
3487 @param name - IKEv2 profile name
3488 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3489 @param is_hex - Authentication data in hex format if non-zero, else string
3490 @param data_len - Authentication data length
3491 @param data - Authentication data (for rsa-sig cert file path)
3493 define ikev2_profile_set_auth
3505 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3506 @param context - returned sender context, to match reply w/ request
3507 @param retval - return code
3509 define ikev2_profile_set_auth_reply
3515 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3516 @param client_index - opaque cookie to identify the sender
3517 @param context - sender context, to match reply w/ request
3519 @param name - IKEv2 profile name
3520 @param is_local - Identification is local if non-zero, else remote
3521 @param id_type - Identification type
3522 @param data_len - Identification data length
3523 @param data - Identification data
3525 define ikev2_profile_set_id
3537 /** \brief Reply for IKEv2:
3538 @param context - returned sender context, to match reply w/ request
3539 @param retval - return code
3541 define ikev2_profile_set_id_reply
3547 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3548 @param client_index - opaque cookie to identify the sender
3549 @param context - sender context, to match reply w/ request
3551 @param name - IKEv2 profile name
3552 @param is_local - Traffic selector is local if non-zero, else remote
3553 @param proto - Traffic selector IP protocol (if zero not relevant)
3554 @param start_port - The smallest port number allowed by traffic selector
3555 @param end_port - The largest port number allowed by traffic selector
3556 @param start_addr - The smallest address included in traffic selector
3557 @param end_addr - The largest address included in traffic selector
3559 define ikev2_profile_set_ts
3573 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3574 @param context - returned sender context, to match reply w/ request
3575 @param retval - return code
3577 define ikev2_profile_set_ts_reply
3583 /** \brief IKEv2: Set IKEv2 local RSA private key
3584 @param client_index - opaque cookie to identify the sender
3585 @param context - sender context, to match reply w/ request
3587 @param key_file - Key file absolute path
3589 define ikev2_set_local_key
3597 /** \brief Reply for IKEv2: Set IKEv2 local key
3598 @param context - returned sender context, to match reply w/ request
3599 @param retval - return code
3601 define ikev2_set_local_key_reply
3607 /** \brief Tell client about a DHCP completion event
3608 @param client_index - opaque cookie to identify the sender
3609 @param pid - client pid registered to receive notification
3610 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3611 @param host_address - Host IP address
3612 @param router_address - Router IP address
3613 @param host_mac - Host MAC address
3615 define dhcp_compl_event
3621 u8 host_address[16];
3622 u8 router_address[16];
3626 /** \brief Add MAP domains
3627 @param client_index - opaque cookie to identify the sender
3628 @param context - sender context, to match reply w/ request
3629 @param ip6_prefix - Rule IPv6 prefix
3630 @param ip4_prefix - Rule IPv4 prefix
3631 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3632 @param ip6_prefix_len - Rule IPv6 prefix length
3633 @param ip4_prefix_len - Rule IPv4 prefix length
3634 @param ea_bits_len - Embedded Address bits length
3635 @param psid_offset - Port Set Identifider (PSID) offset
3636 @param psid_length - PSID length
3637 @param is_translation - MAP-E / MAP-T
3640 define map_add_domain
3649 u8 ip6_src_prefix_len;
3657 /** \brief Reply for MAP domain add
3658 @param context - returned sender context, to match reply w/ request
3659 @param index - MAP domain index
3660 @param retval - return code
3662 define map_add_domain_reply
3669 /** \brief Delete MAP domain
3670 @param client_index - opaque cookie to identify the sender
3671 @param context - sender context, to match reply w/ request
3672 @param index - MAP Domain index
3674 define map_del_domain
3681 /** \brief Reply for MAP domain del
3682 @param context - returned sender context, to match reply w/ request
3683 @param retval - return code
3685 define map_del_domain_reply
3691 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3692 @param client_index - opaque cookie to identify the sender
3693 @param context - sender context, to match reply w/ request
3694 @param index - MAP Domain index
3695 @param is_add - If 1 add rule, if 0 delete rule
3696 @param ip6_dst - MAP CE IPv6 address
3697 @param psid - Rule PSID
3699 define map_add_del_rule
3709 /** \brief Reply for MAP rule add/del
3710 @param context - returned sender context, to match reply w/ request
3711 @param retval - return code
3713 define map_add_del_rule_reply
3719 /** \brief Get list of map domains
3720 @param client_index - opaque cookie to identify the sender
3722 define map_domain_dump
3728 define map_domain_details
3746 define map_rule_dump
3753 define map_rule_details
3760 /** \brief Request for a single block of summary stats
3761 @param client_index - opaque cookie to identify the sender
3762 @param context - sender context, to match reply w/ request
3764 define map_summary_stats
3770 /** \brief Reply for map_summary_stats request
3771 @param context - sender context, to match reply w/ request
3772 @param retval - return code for request
3773 @param total_bindings -
3775 @param total_ip4_fragments -
3776 @param total_security_check -
3778 define map_summary_stats_reply
3785 u64 total_ip4_fragments;
3786 u64 total_security_check[2];
3789 /** \brief cop: enable/disable junk filtration features on an interface
3790 @param client_index - opaque cookie to identify the sender
3791 @param context - sender context, to match reply w/ request
3792 @param sw_if_inded - desired interface
3793 @param enable_disable - 1 => enable, 0 => disable
3796 define cop_interface_enable_disable
3804 /** \brief cop: interface enable/disable junk filtration reply
3805 @param context - returned sender context, to match reply w/ request
3806 @param retval - return code
3809 define cop_interface_enable_disable_reply
3815 /** \brief cop: enable/disable whitelist filtration features on an interface
3816 Note: the supplied fib_id must match in order to remove the feature!
3818 @param client_index - opaque cookie to identify the sender
3819 @param context - sender context, to match reply w/ request
3820 @param sw_if_index - interface handle, physical interfaces only
3821 @param fib_id - fib identifier for the whitelist / blacklist fib
3822 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3823 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3824 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3827 define cop_whitelist_enable_disable
3838 /** \brief cop: interface enable/disable junk filtration reply
3839 @param context - returned sender context, to match reply w/ request
3840 @param retval - return code
3843 define cop_whitelist_enable_disable_reply
3849 /** \brief get_node_graph - get a copy of the vpp node graph
3850 including the current set of graph arcs.
3852 @param client_index - opaque cookie to identify the sender
3853 @param context - sender context, to match reply w/ request
3856 define get_node_graph
3862 /** \brief get_node_graph_reply
3863 @param context - returned sender context, to match reply w/ request
3864 @param retval - return code
3865 @param reply_in_shmem - result from vlib_node_serialize, in shared
3866 memory. Process with vlib_node_unserialize, remember to switch
3867 heaps and free the result.
3870 define get_node_graph_reply
3877 /** \brief Clear interface statistics
3878 @param client_index - opaque cookie to identify the sender
3879 @param context - sender context, to match reply w/ request
3880 @param sw_if_index - index of the interface to clear statistics
3882 define sw_interface_clear_stats
3889 /** \brief Reply to sw_interface_clear_stats
3890 @param context - sender context which was passed in the request
3891 @param retval - return code of the set flags request
3893 define sw_interface_clear_stats_reply
3899 /** \brief IOAM Trace : Set TRACE profile
3900 @param id - profile id
3901 @param trace_type - Trace type
3902 @param trace_num_elt - Number of nodes in trace path
3903 @param trace_ppc - Trace PPC (none/encap/decap)
3904 @param trace_tsp - Trace timestamp precision (0-sec,1-ms,2-us,3-ns)
3905 @param trace_app_data - Trace application data, can be any 4 bytes
3906 @param pow_enable - Proof of Work enabled or not flag
3907 @param node_id - Id of this node
3909 define trace_profile_add
3923 /** \brief Trace profile add / del response
3924 @param context - sender context, to match reply w/ request
3925 @param retval - return value for request
3927 define trace_profile_add_reply
3933 /** \brief IOAM Trace enable trace profile for a flow
3934 @param id - id of the trace profile to be applied
3935 @param dest_ipv6 - Destination IPv6 address
3936 @param prefix_length - prefix mask
3937 @param vrf_id - VRF ID
3938 @param trace_op - Trace operation (add/mod/del)
3939 @param enable - apply/remove the trace profile for the flow
3941 define trace_profile_apply
3953 /** \brief Trace profile apply response
3954 @param context - sender context, to match reply w/ request
3955 @param retval - return value for request
3957 define trace_profile_apply_reply
3963 /** \brief Delete Trace Profile
3964 @param client_index - opaque cookie to identify the sender
3965 @param context - sender context, to match reply w/ request
3966 @param index - MAP Domain index
3968 define trace_profile_del
3975 /** \brief Trace profile add / del response
3976 @param context - sender context, to match reply w/ request
3977 @param retval - return value for request
3979 define trace_profile_del_reply
3985 /** \brief Create host-interface
3986 @param client_index - opaque cookie to identify the sender
3987 @param context - sender context, to match reply w/ request
3988 @param host_if_name - interface name
3989 @param hw_addr - interface MAC
3990 @param use_random_hw_addr - use random generated MAC
3992 define af_packet_create
3997 u8 host_if_name[64];
3999 u8 use_random_hw_addr;
4002 /** \brief Create host-interface response
4003 @param context - sender context, to match reply w/ request
4004 @param retval - return value for request
4006 define af_packet_create_reply
4013 /** \brief Delete host-interface
4014 @param client_index - opaque cookie to identify the sender
4015 @param context - sender context, to match reply w/ request
4016 @param host_if_name - interface name
4018 define af_packet_delete
4023 u8 host_if_name[64];
4026 /** \brief Delete host-interface response
4027 @param context - sender context, to match reply w/ request
4028 @param retval - return value for request
4030 define af_packet_delete_reply
4036 /** \brief Add/del policer
4037 @param client_index - opaque cookie to identify the sender
4038 @param context - sender context, to match reply w/ request
4039 @param is_add - add policer if non-zero, else delete
4040 @param name - policer name
4043 @param cb - Committed Burst
4044 @param eb - Excess or Peak Burst
4045 @param rate_type - rate type
4046 @param round_type - rounding type
4047 @param type - policer algorithm
4048 @param color_aware - 0=color-blind, 1=color-aware
4049 @param conform_action_type - conform action type
4050 @param conform_dscp - DSCP for conform mar-and-transmit action
4051 @param exceed_action_type - exceed action type
4052 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4053 @param violate_action_type - violate action type
4054 @param violate_dscp - DSCP for violate mar-and-transmit action
4056 define policer_add_del
4071 u8 conform_action_type;
4073 u8 exceed_action_type;
4075 u8 violate_action_type;
4079 /** \brief Add/del policer response
4080 @param context - sender context, to match reply w/ request
4081 @param retval - return value for request
4082 @param policer_index - for add, returned index of the new policer
4084 define policer_add_del_reply
4091 /** \brief Get list of policers
4092 @param client_index - opaque cookie to identify the sender
4093 @param context - sender context, to match reply w/ request
4094 @param match_name_valid - if 0 request all policers otherwise use match_name
4095 @param match_name - policer name
4102 u8 match_name_valid;
4106 /** \brief Policer operational state response.
4107 @param context - sender context, to match reply w/ request
4108 @param name - policer name
4111 @param cb - Committed Burst
4112 @param eb - Excess or Peak Burst
4113 @param rate_type - rate type
4114 @param round_type - rounding type
4115 @param type - policer algorithm
4116 @param conform_action_type - conform action type
4117 @param conform_dscp - DSCP for conform mar-and-transmit action
4118 @param exceed_action_type - exceed action type
4119 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4120 @param violate_action_type - violate action type
4121 @param violate_dscp - DSCP for violate mar-and-transmit action
4122 @param single_rate - 1 = single rate policer, 0 = two rate policer
4123 @param color_aware - for hierarchical policing
4124 @param scale - power-of-2 shift amount for lower rates
4125 @param cir_tokens_per_period - number of tokens for each period
4126 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
4127 @param current_limit - current limit
4128 @param current_bucket - current bucket
4129 @param extended_limit - extended limit
4130 @param extended_bucket - extended bucket
4131 @param last_update_time - last update time
4133 define policer_details
4145 u8 conform_action_type;
4147 u8 exceed_action_type;
4149 u8 violate_action_type;
4154 u32 cir_tokens_per_period;
4155 u32 pir_tokens_per_period;
4159 u32 extended_bucket;
4160 u64 last_update_time;
4163 /** \brief Set/unset policer classify interface
4164 @param client_index - opaque cookie to identify the sender
4165 @param context - sender context, to match reply w/ request
4166 @param sw_if_index - interface to set/unset policer classify
4167 @param ip4_table_index - ip4 classify table index (~0 for skip)
4168 @param ip6_table_index - ip6 classify table index (~0 for skip)
4169 @param l2_table_index - l2 classify table index (~0 for skip)
4170 @param is_add - Set if non-zero, else unset
4171 Note: User is recommeneded to use just one valid table_index per call.
4172 (ip4_table_index, ip6_table_index, or l2_table_index)
4174 define policer_classify_set_interface
4179 u32 ip4_table_index;
4180 u32 ip6_table_index;
4185 /** \brief Set/unset policer classify interface response
4186 @param context - sender context, to match reply w/ request
4187 @param retval - return value for request
4189 define policer_classify_set_interface_reply
4195 /** \brief Get list of policer classify interfaces and tables
4196 @param client_index - opaque cookie to identify the sender
4197 @param context - sender context, to match reply w/ request
4198 @param type - classify table type
4200 define policer_classify_dump
4207 /** \brief Policer iclassify operational state response.
4208 @param context - sender context, to match reply w/ request
4209 @param sw_if_index - software interface index
4210 @param table_index - classify table index
4212 define policer_classify_details
4219 /** \brief Create netmap
4220 @param client_index - opaque cookie to identify the sender
4221 @param context - sender context, to match reply w/ request
4222 @param netmap_if_name - interface name
4223 @param hw_addr - interface MAC
4224 @param use_random_hw_addr - use random generated MAC
4225 @param is_pipe - is pipe
4226 @param is_master - 0=slave, 1=master
4228 define netmap_create
4233 u8 netmap_if_name[64];
4235 u8 use_random_hw_addr;
4240 /** \brief Create netmap response
4241 @param context - sender context, to match reply w/ request
4242 @param retval - return value for request
4244 define netmap_create_reply
4250 /** \brief Delete netmap
4251 @param client_index - opaque cookie to identify the sender
4252 @param context - sender context, to match reply w/ request
4253 @param netmap_if_name - interface name
4255 define netmap_delete
4260 u8 netmap_if_name[64];
4263 /** \brief Delete netmap response
4264 @param context - sender context, to match reply w/ request
4265 @param retval - return value for request
4267 define netmap_delete_reply
4273 /** \brief Dump mpls gre tunnel table
4274 @param client_index - opaque cookie to identify the sender
4275 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4277 define mpls_gre_tunnel_dump
4284 /** \brief mpls gre tunnel operational state response
4285 @param tunnel_index - gre tunnel identifier
4286 @param intfc_address - interface ipv4 addr
4287 @param mask_width - interface ipv4 addr mask
4288 @param hw_if_index - interface id
4290 @param tunnel_src - tunnel source ipv4 addr
4291 @param tunnel_dst - tunnel destination ipv4 addr
4292 @param outer_fib_index - gre tunnel identifier
4293 @param encap_index - reference to mpls label table
4294 @param nlabels - number of resolved labels
4295 @param labels - resolved labels
4297 define mpls_gre_tunnel_details
4303 u32 inner_fib_index;
4310 u32 outer_fib_index;
4312 u32 labels[nlabels];
4315 /** \brief Dump mpls eth tunnel table
4316 @param client_index - opaque cookie to identify the sender
4317 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
4319 define mpls_eth_tunnel_dump
4326 /** \brief mpls eth tunnel operational state response
4327 @param tunnel_index - eth tunnel identifier
4328 @param intfc_address - interface ipv4 addr
4329 @param mask_width - interface ipv4 addr mask
4330 @param hw_if_index - interface id
4332 @param tunnel_dst_mac -
4333 @param tx_sw_if_index -
4334 @param encap_index - reference to mpls label table
4335 @param nlabels - number of resolved labels
4336 @param labels - resolved labels
4338 define mpls_eth_tunnel_details
4344 u32 inner_fib_index;
4349 u8 tunnel_dst_mac[6];
4352 u32 labels[nlabels];
4355 /** \brief Dump mpls fib table
4356 @param client_index - opaque cookie to identify the sender
4357 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4359 define mpls_fib_encap_dump
4365 /** \brief mpls fib encap table response
4366 @param fib_index - fib table id
4367 @param dest - destination ipv4 addr
4369 @param entry_index - reference to mpls label table
4370 @param nlabels - number of resolved labels
4371 @param labels - resolved labels
4373 define mpls_fib_encap_details
4382 u32 labels[nlabels];
4385 /** \brief Dump mpls fib decap table
4386 @param client_index - opaque cookie to identify the sender
4387 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4389 define mpls_fib_decap_dump
4395 /** \brief mpls fib decap table response
4396 @param fib_index - fib table id
4397 @param entry_index - reference to mpls label table
4398 @param dest - destination ipv4 addr
4400 @param label - mpls labels
4401 @param rx_table_id - rx fib id
4402 @param tx_table_id - tx fib id
4405 define mpls_fib_decap_details
4419 /** \brief Classify get table IDs request
4420 @param client_index - opaque cookie to identify the sender
4421 @param context - sender context, to match reply w/ request
4423 define classify_table_ids
4429 /** \brief Reply for classify get table IDs request
4430 @param context - sender context which was passed in the request
4431 @param count - number of ids returned in response
4432 @param ids - array of classify table ids
4434 define classify_table_ids_reply
4442 /** \brief Classify table ids by interface index request
4443 @param client_index - opaque cookie to identify the sender
4444 @param context - sender context, to match reply w/ request
4445 @param sw_if_index - index of the interface
4447 define classify_table_by_interface
4454 /** \brief Reply for classify table id by interface index request
4455 @param context - sender context which was passed in the request
4456 @param count - number of ids returned in response
4457 @param sw_if_index - index of the interface
4458 @param l2_table_id - l2 classify table index
4459 @param ip4_table_id - ip4 classify table index
4460 @param ip6_table_id - ip6 classify table index
4462 define classify_table_by_interface_reply
4472 /** \brief Classify table info
4473 @param client_index - opaque cookie to identify the sender
4474 @param context - sender context, to match reply w/ request
4475 @param table_id - classify table index
4477 define classify_table_info
4484 /** \brief Reply for classify table info request
4485 @param context - sender context which was passed in the request
4486 @param count - number of ids returned in response
4487 @param table_id - classify table index
4488 @param nbuckets - number of buckets when adding a table
4489 @param match_n_vectors - number of match vectors
4490 @param skip_n_vectors - number of skip_n_vectors
4491 @param active_sessions - number of sessions (active entries)
4492 @param next_table_index - index of next table
4493 @param miss_next_index - index of miss table
4494 @param mask[] - match mask
4496 define classify_table_info_reply
4502 u32 match_n_vectors;
4504 u32 active_sessions;
4505 u32 next_table_index;
4506 u32 miss_next_index;
4508 u8 mask[mask_length];
4511 /** \brief Classify sessions dump request
4512 @param client_index - opaque cookie to identify the sender
4513 @param context - sender context, to match reply w/ request
4514 @param table_id - classify table index
4516 define classify_session_dump
4523 /** \brief Reply for classify table session dump request
4524 @param context - sender context which was passed in the request
4525 @param count - number of ids returned in response
4526 @param table_id - classify table index
4527 @param hit_next_index - hit_next_index of session
4528 @param opaque_index - for add, opaque_index of session
4529 @param advance - advance value of session
4530 @param match[] - match value for session
4532 define classify_session_details
4541 u8 match[match_length];
4544 /** \brief Enable and configure IPFIX exporter process request
4545 @param client_index - opaque cookie to identify the sender
4546 @param context - sender context, to match reply w/ request
4547 @param collector_address - address of IPFIX collector
4548 @param collector_port - port of IPFIX IPFIX collector
4549 @param src_address - address of IPFIX exporter
4550 @param vrf_id - VRF / fib table ID
4551 @param path_mtu - Path MTU between exporter and collector
4552 @param template_interval - number of seconds after which to resend template
4558 u8 collector_address[16];
4563 u32 template_interval;
4566 /** \brief Reply to IPFIX enable and configure request
4567 @param context - sender context which was passed in the request
4569 define ipfix_enable_reply
4575 /** \brief IPFIX dump request
4576 @param client_index - opaque cookie to identify the sender
4577 @param context - sender context, to match reply w/ request
4585 /** \brief Reply to IPFIX dump request
4586 @param context - sender context which was passed in the request
4587 @param collector_address - address of IPFIX collector
4588 @param collector_port - port of IPFIX IPFIX collector
4589 @param src_address - address of IPFIX exporter
4590 @param fib_index - fib table index
4591 @param path_mtu - Path MTU between exporter and collector
4592 @param template_interval - number of seconds after which to resend template
4594 define ipfix_details
4597 u8 collector_address[16];
4602 u32 template_interval;
4605 /** \brief Query relative index via node names
4606 @param client_index - opaque cookie to identify the sender
4607 @param context - sender context, to match reply w/ request
4608 @param node_name - name of node to find relative index from
4609 @param next_name - next node from node_name to find relative index of
4611 define get_next_index
4619 /** \brief Reply for get next node index
4620 @param context - sender context which was passed in the request
4621 @param retval - return value
4622 @param next_index - index of the next_node
4624 define get_next_index_reply
4631 /** \brief PacketGenerator create interface request
4632 @param client_index - opaque cookie to identify the sender
4633 @param context - sender context, to match reply w/ request
4634 @param interface_id - interface index
4636 define pg_create_interface
4643 /** \brief PacketGenerator create interface response
4644 @param context - sender context, to match reply w/ request
4645 @param retval - return value for request
4647 define pg_create_interface_reply
4654 /** \brief PacketGenerator capture packets on given interface request
4655 @param client_index - opaque cookie to identify the sender
4656 @param context - sender context, to match reply w/ request
4657 @param interface_id - pg interface index
4658 @param is_enabled - 1 if enabling streams, 0 if disabling
4659 @param count - number of packets to be captured
4660 @param pcap_file - pacp file name to store captured packets
4669 u32 pcap_name_length;
4670 u8 pcap_file_name[pcap_name_length];
4673 /** \brief PacketGenerator capture packets response
4674 @param context - sender context, to match reply w/ request
4675 @param retval - return value for request
4677 define pg_capture_reply
4683 /** \brief Enable / disable packet generator request
4684 @param client_index - opaque cookie to identify the sender
4685 @param context - sender context, to match reply w/ request
4686 @param is_enabled - 1 if enabling streams, 0 if disabling
4687 @param stream - stream name to be enable/disabled, if not specified handle all streams
4689 define pg_enable_disable
4694 u32 stream_name_length;
4695 u8 stream_name[stream_name_length];
4698 /** \brief Reply for enable / disable packet generator
4699 @param context - returned sender context, to match reply w/ request
4700 @param retval - return code
4702 define pg_enable_disable_reply
4708 /** \brief Configure IP source and L4 port-range check
4709 @param client_index - opaque cookie to identify the sender
4710 @param context - sender context, to match reply w/ request
4711 @param is_ip6 - 1 if source address type is IPv6
4712 @param is_add - 1 if add, 0 if delete
4713 @param mask_length - mask length for address entry
4714 @param address - array of address bytes
4715 @param number_of_ranges - length of low_port and high_port arrays (must match)
4716 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
4717 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
4718 @param vrf_id - fib table/vrf id to associate the source and port-range check with
4719 @note To specify a single port set low_port and high_port entry the same
4721 define ip_source_and_port_range_check_add_del
4729 u8 number_of_ranges;
4735 /** \brief Configure IP source and L4 port-range check reply
4736 @param context - returned sender context, to match reply w/ request
4737 @param retval - return code
4739 define ip_source_and_port_range_check_add_del_reply
4745 /** \brief Set interface source and L4 port-range request
4746 @param client_index - opaque cookie to identify the sender
4747 @param context - sender context, to match reply w/ request
4748 @param interface_id - interface index
4749 @param tcp_vrf_id - VRF associated with source and TCP port-range check
4750 @param udp_vrf_id - VRF associated with source and TCP port-range check
4752 define ip_source_and_port_range_check_interface_add_del
4764 /** \brief Set interface source and L4 port-range response
4765 @param context - sender context, to match reply w/ request
4766 @param retval - return value for request
4768 define ip_source_and_port_range_check_interface_add_del_reply
4774 /** \brief Add / del ipsec gre tunnel request
4775 @param client_index - opaque cookie to identify the sender
4776 @param context - sender context, to match reply w/ request
4777 @param local_sa_id - local SA id
4778 @param remote_sa_id - remote SA id
4779 @param is_add - 1 if adding the tunnel, 0 if deleting
4780 @param src_address - tunnel source address
4781 @param dst_address - tunnel destination address
4783 define ipsec_gre_add_del_tunnel {
4793 /** \brief Reply for add / del ipsec gre tunnel request
4794 @param context - returned sender context, to match reply w/ request
4795 @param retval - return code
4796 @param sw_if_index - software index of the new ipsec gre tunnel
4798 define ipsec_gre_add_del_tunnel_reply {
4804 /** \brief Dump ipsec gre tunnel table
4805 @param client_index - opaque cookie to identify the sender
4806 @param context - sender context, to match reply w/ request
4807 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4809 define ipsec_gre_tunnel_dump {
4815 /** \brief mpls gre tunnel operational state response
4816 @param context - returned sender context, to match reply w/ request
4817 @param sw_if_index - software index of the ipsec gre tunnel
4818 @param local_sa_id - local SA id
4819 @param remote_sa_id - remote SA id
4820 @param src_address - tunnel source address
4821 @param dst_address - tunnel destination address
4823 define ipsec_gre_tunnel_details {