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 Enable or Disable MPLS on and interface
219 @param client_index - opaque cookie to identify the sender
220 @param context - sender context, to match reply w/ request
221 @param sw_if_index - index of the interface
222 @param enable - if non-zero enable, else disable
224 define sw_interface_set_mpls_enable
232 /** \brief Reply for MPLS state on an interface
233 @param context - returned sender context, to match reply w/ request
234 @param retval - return code
236 define sw_interface_set_mpls_enable_reply
242 /** \brief Initialize a new tap interface with the given paramters
243 @param client_index - opaque cookie to identify the sender
244 @param context - sender context, to match reply w/ request
245 @param use_random_mac - let the system generate a unique mac address
246 @param tap_name - name to associate with the new interface
247 @param mac_address - mac addr to assign to the interface if use_radom not set
257 u32 custom_dev_instance;
260 /** \brief Reply for tap connect request
261 @param context - returned sender context, to match reply w/ request
262 @param retval - return code
263 @param sw_if_index - software index allocated for the new tap interface
265 define tap_connect_reply
272 /** \brief Modify a tap interface with the given paramters
273 @param client_index - opaque cookie to identify the sender
274 @param context - sender context, to match reply w/ request
275 @param sw_if_index - interface index of existing tap interface
276 @param use_random_mac - let the system generate a unique mac address
277 @param tap_name - name to associate with the new interface
278 @param mac_address - mac addr to assign to the interface if use_radom not set
289 u32 custom_dev_instance;
292 /** \brief Reply for tap modify request
293 @param context - returned sender context, to match reply w/ request
294 @param retval - return code
295 @param sw_if_index - software index if the modified tap interface
297 define tap_modify_reply
304 /** \brief Delete tap interface
305 @param client_index - opaque cookie to identify the sender
306 @param context - sender context, to match reply w/ request
307 @param sw_if_index - interface index of existing tap interface
316 /** \brief Reply for tap delete request
317 @param context - returned sender context, to match reply w/ request
318 @param retval - return code
320 define tap_delete_reply
326 /** \brief Dump tap interfaces request */
327 define sw_interface_tap_dump
333 /** \brief Reply for tap dump request
334 @param sw_if_index - software index of tap interface
335 @param dev_name - Linux tap device name
337 define sw_interface_tap_details
344 /** \brief Create a new subinterface with the given vlan id
345 @param client_index - opaque cookie to identify the sender
346 @param context - sender context, to match reply w/ request
347 @param sw_if_index - software index of the new vlan's parent interface
348 @param vlan_id - vlan tag of the new interface
350 define create_vlan_subif
358 /** \brief Reply for the vlan subinterface create request
359 @param context - returned sender context, to match reply w/ request
360 @param retval - return code
361 @param sw_if_index - software index allocated for the new subinterface
363 define create_vlan_subif_reply
370 /** \brief Add / del route request
371 @param client_index - opaque cookie to identify the sender
372 @param context - sender context, to match reply w/ request
373 @param sw_if_index - software index of the new vlan's parent interface
374 @param vrf_id - fib table /vrf associated with the route
375 @param lookup_in_vrf -
376 @param resolve_attempts -
377 @param classify_table_index -
378 @param create_vrf_if_needed -
379 @param resolve_if_needed -
380 @param is_add - 1 if adding the route, 0 if deleting
382 @param is_ipv6 - 0 if an ip4 route, else ip6
385 @param is_multipath - Set to 1 if this is a multipath route, else 0
386 @param not_last - Is last or not last msg in group of multiple add/del msgs
387 @param next_hop_weight -
388 @param dst_address_length -
389 @param dst_address[16] -
390 @param next_hop_address[16] -
392 define ip_add_del_route
396 u32 next_hop_sw_if_index;
399 u32 resolve_attempts;
400 u32 classify_table_index;
401 u8 create_vrf_if_needed;
402 u8 resolve_if_needed;
410 u8 is_resolve_attached;
411 /* Is last/not-last message in group of multiple add/del messages. */
414 u8 dst_address_length;
416 u8 next_hop_address[16];
419 /** \brief Reply for add / del route request
420 @param context - returned sender context, to match reply w/ request
421 @param retval - return code
423 define ip_add_del_route_reply
430 /** \brief Add / del gre tunnel request
431 @param client_index - opaque cookie to identify the sender
432 @param context - sender context, to match reply w/ request
433 @param sw_if_index - software index of the new vlan's parent interface
434 @param inner_vrf_id -
435 @param outer_vrf_id -
436 @param is_add - 1 if adding the tunnel, 0 if deleting
437 @param src_address[4] - tunnel source address
438 @param dst_address[4] - tunnel destination address
439 @param intf_address -
440 @param intf_address_length -
442 define mpls_gre_add_del_tunnel
453 u8 intfc_address_length;
456 /** \brief Reply for add / del tunnel request
457 @param context - returned sender context, to match reply w/ request
458 @param retval - return code
460 define mpls_gre_add_del_tunnel_reply
464 u32 tunnel_sw_if_index;
467 /** \brief Add / del MPLS encapsulation request
468 @param client_index - opaque cookie to identify the sender
469 @param context - sender context, to match reply w/ request
470 @param vrf_id - vrf id
471 @param dst_address[4] -
472 @param is_add - 1 if adding the encap, 0 if deleting
473 @param nlabels - number of labels
474 @param labels - array of labels
476 define mpls_add_del_encap
482 /* 1 = add, 0 = delete */
488 /** \brief Reply for add / del encapsulation request
489 @param context - returned sender context, to match reply w/ request
490 @param retval - return code
492 define mpls_add_del_encap_reply
498 /** \brief Add / del MPLS decapsulation request
499 @param client_index - opaque cookie to identify the sender
500 @param context - sender context, to match reply w/ request
501 @param rx_vrf_id - receive vrf
502 @param tx_vrf_id - transmit vrf
506 @param is_add - 1 if adding the encap, 0 if deleting
508 define mpls_add_del_decap
520 /** \brief Reply for MPLS decap add / del request
521 @param context - returned sender context, to match reply w/ request
522 @param retval - return code
524 define mpls_add_del_decap_reply
530 /** \brief Proxy ARP add / del request
531 @param client_index - opaque cookie to identify the sender
532 @param context - sender context, to match reply w/ request
533 @param vrf_id - VRF / Fib table ID
534 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
535 @param low_address[4] - Low address of the Proxy ARP range
536 @param hi_address[4] - High address of the Proxy ARP range
538 define proxy_arp_add_del
548 /** \brief Reply for proxy arp add / del request
549 @param context - returned sender context, to match reply w/ request
550 @param retval - return code
552 define proxy_arp_add_del_reply
558 /** \brief Proxy ARP add / del request
559 @param client_index - opaque cookie to identify the sender
560 @param context - sender context, to match reply w/ request
561 @param sw_if_index - Which interface to enable / disable Proxy Arp on
562 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
564 define proxy_arp_intfc_enable_disable
569 /* 1 = on, 0 = off */
573 /** \brief Reply for Proxy ARP interface enable / disable request
574 @param context - returned sender context, to match reply w/ request
575 @param retval - return code
577 define proxy_arp_intfc_enable_disable_reply
583 /** \brief IP neighbor add / del request
584 @param client_index - opaque cookie to identify the sender
585 @param context - sender context, to match reply w/ request
586 @param vrf_id - vrf_id, only for IP4
587 @param sw_if_index - interface used to reach neighbor
588 @param is_add - 1 to add neighbor, 0 to delete
589 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
591 @param mac_address - l2 address of the neighbor
592 @param dst_address - ip4 or ip6 address of the neighbor
594 define ip_neighbor_add_del
598 u32 vrf_id; /* only makes sense for ip4 */
600 /* 1 = add, 0 = delete */
608 /** \brief Reply for IP Neighbor add / delete request
609 @param context - returned sender context, to match reply w/ request
610 @param retval - return code
612 define ip_neighbor_add_del_reply
618 /** \brief Reset VRF (remove all routes etc) request
619 @param client_index - opaque cookie to identify the sender
620 @param context - sender context, to match reply w/ request
621 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
622 @param vrf_id - ID of th FIB table / VRF to reset
632 /** \brief Reply for Reset VRF request
633 @param context - returned sender context, to match reply w/ request
634 @param retval - return code
636 define reset_vrf_reply
642 /** \brief Is Address Reachable request - DISABLED
643 @param client_index - opaque cookie to identify the sender
644 @param context - sender context, to match reply w/ request
645 @param next_hop_sw_if_index - index of interface used to get to next hop
646 @param is_ipv6 - 1 for IPv6, 0 for IPv4
647 @param is_error - address not found or does not match intf
648 @param address[] - Address in question
650 define is_address_reachable
652 u32 client_index; /* (api_main_t *) am->my_client_index */
654 u32 next_hop_sw_if_index;
655 u8 is_known; /* on reply, this is the answer */
657 u8 is_error; /* address not found or does not match intf */
661 /** \brief Want Stats, register for stats updates
662 @param client_index - opaque cookie to identify the sender
663 @param context - sender context, to match reply w/ request
664 @param enable_disable - 1 = enable stats, 0 = disable
665 @param pid - pid of process requesting stats updates
675 /** \brief Reply for Want Stats request
676 @param context - returned sender context, to match reply w/ request
677 @param retval - return code
679 define want_stats_reply
685 /** \brief Want stats counters structure
686 @param vnet_counter_type- such as ip4, ip6, punts, etc
687 @param is_combined - rx & tx total (all types) counts
688 @param first_sw_if_index - first sw index in block of index, counts
689 @param count - number of interfaces this stats block includes counters for
690 @param data - contiguous block of vlib_counter_t structures
692 define vnet_interface_counters
694 /* enums - plural - in vnet/interface.h */
695 u8 vnet_counter_type;
697 u32 first_sw_if_index;
702 typeonly manual_print manual_endian define ip4_fib_counter
710 manual_print manual_endian define vnet_ip4_fib_counters
714 vl_api_ip4_fib_counter_t c[count];
717 typeonly manual_print manual_endian define ip6_fib_counter
725 manual_print manual_endian define vnet_ip6_fib_counters
729 vl_api_ip6_fib_counter_t c[count];
732 /** \brief Request for a single block of summary stats
733 @param client_index - opaque cookie to identify the sender
734 @param context - sender context, to match reply w/ request
736 define vnet_get_summary_stats
742 /** \brief Reply for vnet_get_summary_stats request
743 @param context - sender context, to match reply w/ request
744 @param retval - return code for request
749 define vnet_summary_stats_reply
758 /** \brief OAM event structure
759 @param dst_address[] -
768 /** \brief Want OAM events request
769 @param client_index - opaque cookie to identify the sender
770 @param context - sender context, to match reply w/ request
771 @param enable_disable- enable if non-zero, else disable
772 @param pid - pid of the requesting process
774 define want_oam_events
782 /** \brief Want OAM events response
783 @param context - sender context, to match reply w/ request
784 @param retval - return code for the want oam stats request
786 define want_oam_events_reply
792 /** \brief OAM add / del target request
793 @param client_index - opaque cookie to identify the sender
794 @param context - sender context, to match reply w/ request
795 @param vrf_id - vrf_id of the target
796 @param src_address[] - source address to use for the updates
797 @param dst_address[] - destination address of the target
798 @param is_add - add target if non-zero, else delete
810 /** \brief OAM add / del target response
811 @param context - sender context, to match reply w/ request
812 @param retval - return code of the request
814 define oam_add_del_reply
820 /** \brief Reset fib table request
821 @param client_index - opaque cookie to identify the sender
822 @param context - sender context, to match reply w/ request
823 @param vrf_id - vrf/table id of the fib table to reset
824 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
834 /** \brief Reset fib response
835 @param context - sender context, to match reply w/ request
836 @param retval - return code for the reset bfib request
838 define reset_fib_reply
844 /** \brief DHCP Proxy config add / del request
845 @param client_index - opaque cookie to identify the sender
846 @param context - sender context, to match reply w/ request
847 @param vrf_id - vrf id
848 @param if_ipv6 - ipv6 if non-zero, else ipv4
849 @param is_add - add the config if non-zero, else delete
850 @param insert_circuit_id - option82 suboption 1 fib number
851 @param dhcp_server[] - server address
852 @param dhcp_src_address[] - <fix this, need details>
854 define dhcp_proxy_config
861 u8 insert_circuit_id;
863 u8 dhcp_src_address[16];
866 /** \brief DHCP Proxy config response
867 @param context - sender context, to match reply w/ request
868 @param retval - return code for the request
870 define dhcp_proxy_config_reply
876 /** \brief DHCP Proxy set / unset vss request
877 @param client_index - opaque cookie to identify the sender
878 @param context - sender context, to match reply w/ request
879 @param tbl_id - table id
880 @param oui - first part of vpn id
881 @param fib_id - second part of vpn id
882 @param is_ipv6 - ip6 if non-zero, else ip4
883 @param is_add - set vss if non-zero, else delete
885 define dhcp_proxy_set_vss
896 /** \brief DHCP proxy set / unset vss response
897 @param context - sender context, to match reply w/ request
898 @param retval - return code for the request
900 define dhcp_proxy_set_vss_reply
906 /** \brief Set the ip flow hash config for a fib request
907 @param client_index - opaque cookie to identify the sender
908 @param context - sender context, to match reply w/ request
909 @param vrf_id - vrf/fib id
910 @param is_ipv6 - if non-zero the fib is ip6, else ip4
911 @param src - if non-zero include src in flow hash
912 @param dst - if non-zero include dst in flow hash
913 @param sport - if non-zero include sport in flow hash
914 @param dport - if non-zero include dport in flow hash
915 @param proto -if non-zero include proto in flow hash
916 @param reverse - if non-zero include reverse in flow hash
918 define set_ip_flow_hash
932 /** \brief Set the ip flow hash config for a fib response
933 @param context - sender context, to match reply w/ request
934 @param retval - return code for the request
936 define set_ip_flow_hash_reply
942 /** \brief IPv6 router advertisement config request
943 @param client_index - opaque cookie to identify the sender
944 @param context - sender context, to match reply w/ request
949 @param send_unicast -
952 @param default_router -
953 @param max_interval -
954 @param min_interval -
956 @param initial_count -
957 @param initial_interval -
959 define sw_interface_ip6nd_ra_config
976 u32 initial_interval;
979 /** \brief IPv6 router advertisement config response
980 @param context - sender context, to match reply w/ request
981 @param retval - return code for the request
983 define sw_interface_ip6nd_ra_config_reply
989 /** \brief IPv6 router advertisement prefix config request
990 @param client_index - opaque cookie to identify the sender
991 @param context - sender context, to match reply w/ request
994 @param address_length -
996 @param no_advertise -
998 @param no_autoconfig -
1001 @param val_lifetime -
1002 @param pref_lifetime -
1004 define sw_interface_ip6nd_ra_prefix
1021 /** \brief IPv6 router advertisement prefix config response
1022 @param context - sender context, to match reply w/ request
1023 @param retval - return code for the request
1025 define sw_interface_ip6nd_ra_prefix_reply
1031 /** \brief IPv6 interface enable / disable request
1032 @param client_index - opaque cookie to identify the sender
1033 @param context - sender context, to match reply w/ request
1034 @param sw_if_index - interface used to reach neighbor
1035 @param enable - if non-zero enable ip6 on interface, else disable
1037 define sw_interface_ip6_enable_disable
1042 u8 enable; /* set to true if enable */
1045 /** \brief IPv6 interface enable / disable response
1046 @param context - sender context, to match reply w/ request
1047 @param retval - return code for the request
1049 define sw_interface_ip6_enable_disable_reply
1055 /** \brief IPv6 set link local address on interface request
1056 @param client_index - opaque cookie to identify the sender
1057 @param context - sender context, to match reply w/ request
1058 @param sw_if_index - interface to set link local on
1059 @param address[] - the new link local address
1060 @param address_length - link local address length
1062 define sw_interface_ip6_set_link_local_address
1071 /** \brief IPv6 set link local address on interface response
1072 @param context - sender context, to match reply w/ request
1073 @param retval - error code for the request
1075 define sw_interface_ip6_set_link_local_address_reply
1081 /** \brief Set unnumbered interface add / del request
1082 @param client_index - opaque cookie to identify the sender
1083 @param context - sender context, to match reply w/ request
1084 @param sw_if_index - interface with an IP address
1085 @param unnumbered_sw_if_index - interface which will use the address
1086 @param is_add - if non-zero set the association, else unset it
1088 define sw_interface_set_unnumbered
1092 u32 sw_if_index; /* use this intfc address */
1093 u32 unnumbered_sw_if_index; /* on this interface */
1097 /** \brief Set unnumbered interface add / del response
1098 @param context - sender context, to match reply w/ request
1099 @param retval - return code for the request
1101 define sw_interface_set_unnumbered_reply
1107 /** \brief Create loopback interface request
1108 @param client_index - opaque cookie to identify the sender
1109 @param context - sender context, to match reply w/ request
1110 @param mac_address - mac addr to assign to the interface if none-zero
1112 define create_loopback
1119 /** \brief Create loopback interface response
1120 @param context - sender context, to match reply w/ request
1121 @param sw_if_index - sw index of the interface that was created
1122 @param retval - return code for the request
1124 define create_loopback_reply
1131 /** \brief Delete loopback interface request
1132 @param client_index - opaque cookie to identify the sender
1133 @param context - sender context, to match reply w/ request
1134 @param sw_if_index - sw index of the interface that was created
1136 define delete_loopback
1143 /** \brief Delete loopback interface response
1144 @param context - sender context, to match reply w/ request
1145 @param retval - return code for the request
1147 define delete_loopback_reply
1153 /** \brief Control ping from client to api server request
1154 @param client_index - opaque cookie to identify the sender
1155 @param context - sender context, to match reply w/ request
1163 /** \brief Control ping from the client to the server response
1164 @param client_index - opaque cookie to identify the sender
1165 @param context - sender context, to match reply w/ request
1166 @param retval - return code for the request
1167 @param vpe_pid - the pid of the vpe, returned by the server
1169 define control_ping_reply
1177 /** \brief Process a vpe parser cli string request
1178 @param client_index - opaque cookie to identify the sender
1179 @param context - sender context, to match reply w/ request
1180 @param cmd_in_shmem - pointer to cli command string
1196 /** \brief vpe parser cli string response
1197 @param context - sender context, to match reply w/ request
1198 @param retval - return code for request
1199 @param reply_in_shmem - Reply string from cli processing if any
1207 define cli_inband_reply
1215 /** \brief Set max allowed ARP or ip6 neighbor entries request
1216 @param client_index - opaque cookie to identify the sender
1217 @param context - sender context, to match reply w/ request
1218 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1219 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1221 define set_arp_neighbor_limit
1226 u32 arp_neighbor_limit;
1229 /** \brief Set max allowed ARP or ip6 neighbor entries response
1230 @param context - sender context, to match reply w/ request
1231 @param retval - return code for request
1233 define set_arp_neighbor_limit_reply
1239 /** \brief L2 interface patch add / del request
1240 @param client_index - opaque cookie to identify the sender
1241 @param context - sender context, to match reply w/ request
1242 @param rx_sw_if_index - receive side interface
1243 @param tx_sw_if_index - transmit side interface
1244 @param is_add - if non-zero set up the interface patch, else remove it
1246 define l2_patch_add_del
1255 /** \brief L2 interface patch add / del response
1256 @param context - sender context, to match reply w/ request
1257 @param retval - return code for the request
1259 define l2_patch_add_del_reply
1265 /** \brief IPv6 segment routing tunnel add / del request
1266 @param client_index - opaque cookie to identify the sender
1267 @param context - sender context, to match reply w/ request
1268 @param is_add - add the tunnel if non-zero, else delete it
1269 @param name[] - tunnel name (len. 64)
1270 @param src_address[] -
1271 @param dst_address[] -
1272 @param dst_mask_width -
1273 @param inner_vrf_id -
1274 @param outer_vrf_id -
1275 @param flags_net_byte_order -
1278 @param segs_and_tags[] -
1279 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1281 define sr_tunnel_add_del
1292 u16 flags_net_byte_order;
1295 u8 segs_and_tags[0];
1299 /** \brief IPv6 segment routing tunnel add / del response
1300 @param context - sender context, to match reply w/ request
1301 @param retval - return value for request
1303 define sr_tunnel_add_del_reply
1309 /** \brief IPv6 segment routing policy add / del request
1310 @param client_index - opaque cookie to identify the sender
1311 @param context - sender context, to match reply w/ request
1312 @param is_add - add the tunnel if non-zero, else delete it
1313 @param name[] - policy name (len. 64)
1314 @param tunnel_names[] -
1316 define sr_policy_add_del
1325 /** \brief IPv6 segment routing policy add / del response
1326 @param context - sender context, to match reply w/ request
1327 @param retval - return value for request
1329 define sr_policy_add_del_reply
1335 /** \brief IPv6 segment routing multicast map to policy add / del request
1336 @param client_index - opaque cookie to identify the sender
1337 @param context - sender context, to match reply w/ request
1338 @param is_add - add the tunnel if non-zero, else delete it
1339 @param multicast_address[] - IP6 multicast address
1340 @param policy_name[] = policy name (len.64)
1342 define sr_multicast_map_add_del
1347 u8 multicast_address[16];
1351 /** \brief IPv6 segment routing multicast map to policy add / del response
1352 @param context - sender context, to match reply w/ request
1353 @param retval - return value for request
1355 define sr_multicast_map_add_del_reply
1361 /** \brief Interface set vpath request
1362 @param client_index - opaque cookie to identify the sender
1363 @param context - sender context, to match reply w/ request
1364 @param sw_if_index - interface used to reach neighbor
1365 @param enable - if non-zero enable, else disable
1367 define sw_interface_set_vpath
1375 /** \brief Interface set vpath response
1376 @param context - sender context, to match reply w/ request
1377 @param retval - return code for the request
1379 define sw_interface_set_vpath_reply
1385 /** \brief MPLS Ethernet add / del tunnel request
1386 @param client_index - opaque cookie to identify the sender
1387 @param context - sender context, to match reply w/ request
1388 @param vrf_id - vrf_id, only for IP4
1389 @param sw_if_index - interface used to reach neighbor
1390 @param is_add - add if set, tunnel delete if 0
1391 @param dst_mac_address -
1392 @param adj_address -
1393 @param adj_address_length -
1395 define mpls_ethernet_add_del_tunnel
1403 u8 dst_mac_address[6];
1405 u8 adj_address_length;
1408 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1409 @param context - sender context, to match reply w/ request
1410 @param retval - return code for the request
1412 define mpls_ethernet_add_del_tunnel_reply
1416 u32 tunnel_sw_if_index;
1418 /** \brief MPLS Ethernet add/ del tunnel 2
1419 @param client_index - opaque cookie to identify the sender
1420 @param context - sender context, to match reply w/ request
1421 @param inner_vrf_id -
1422 @param outer_vrf_id -
1423 @param resolve_attempts -
1424 @param resolve_opaque -
1425 @param resolve_if_needed -
1427 @param adj_address -
1428 @param adj_address_length -
1429 @param next_hop_ip4_address_in_outer_vrf -
1431 define mpls_ethernet_add_del_tunnel_2
1437 u32 resolve_attempts;
1438 u32 resolve_opaque; /* no need to set this */
1439 u8 resolve_if_needed;
1443 u8 adj_address_length;
1444 u8 next_hop_ip4_address_in_outer_vrf[4];
1447 /** \brief MPLS Ethernet add/ del tunnel 2
1448 @param context - sender context, to match reply w/ request
1449 @param retval - return code for add /del request
1451 define mpls_ethernet_add_del_tunnel_2_reply
1457 /** \brief Set L2 XConnect between two interfaces request
1458 @param client_index - opaque cookie to identify the sender
1459 @param context - sender context, to match reply w/ request
1460 @param rx_sw_if_index - Receive interface index
1461 @param tx_sw_if_index - Transmit interface index
1462 @param enable - enable xconnect if not 0, else set to L3 mode
1464 define sw_interface_set_l2_xconnect
1473 /** \brief Set L2 XConnect response
1474 @param context - sender context, to match reply w/ request
1475 @param retval - L2 XConnect request return code
1477 define sw_interface_set_l2_xconnect_reply
1483 /** \brief Interface bridge mode request
1484 @param client_index - opaque cookie to identify the sender
1485 @param context - sender context, to match reply w/ request
1486 @param rx_sw_if_index - the interface
1487 @param bd_id - bridge domain id
1488 @param bvi - Setup interface as a bvi, bridge mode only
1489 @param shg - Shared horizon group, for bridge mode only
1490 @param enable - Enable beige mode if not 0, else set to L3 mode
1492 define sw_interface_set_l2_bridge
1503 /** \brief Interface bridge mode response
1504 @param context - sender context, to match reply w/ request
1505 @param retval - Bridge mode request return code
1507 define sw_interface_set_l2_bridge_reply
1513 /** \brief L2 FIB add entry request
1514 @param client_index - opaque cookie to identify the sender
1515 @param context - sender context, to match reply w/ request
1516 @param mac - the entry's mac address
1517 @param bd_id - the entry's bridge domain id
1518 @param sw_if_index - the interface
1519 @param is_add - If non zero add the entry, else delete it
1523 define l2fib_add_del
1536 /** \brief L2 FIB add entry response
1537 @param context - sender context, to match reply w/ request
1538 @param retval - return code for the add l2fib entry request
1540 define l2fib_add_del_reply
1546 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1547 @param client_index - opaque cookie to identify the sender
1548 @param context - sender context, to match reply w/ request
1549 @param sw_if_index - interface
1550 @param is_set - if non-zero, set the bits, else clear them
1551 @param feature_bitmap - non-zero bits to set or clear
1562 /** \brief Set L2 bits response
1563 @param context - sender context, to match reply w/ request
1564 @param retval - return code for the set l2 bits request
1566 define l2_flags_reply
1570 u32 resulting_feature_bitmap;
1573 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1574 L2_UU_FLOOD, or L2_ARP_TERM) request
1575 @param client_index - opaque cookie to identify the sender
1576 @param context - sender context, to match reply w/ request
1577 @param bd_id - the bridge domain to set the flags for
1578 @param is_set - if non-zero, set the flags, else clear them
1579 @param feature_bitmap - bits that are non-zero to set or clear
1590 /** \brief Set bridge flags response
1591 @param context - sender context, to match reply w/ request
1592 @param retval - return code for the set bridge flags request
1593 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1595 define bridge_flags_reply
1599 u32 resulting_feature_bitmap;
1602 /** \brief Set bridge domain ip to mac entry request
1603 @param client_index - opaque cookie to identify the sender
1604 @param context - sender context, to match reply w/ request
1605 @param bd_id - the bridge domain to set the flags for
1606 @param is_add - if non-zero, add the entry, else clear it
1607 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1608 @param mac_address - MAC address
1611 define bd_ip_mac_add_del
1622 /** \brief Set bridge domain ip to mac entry response
1623 @param context - sender context, to match reply w/ request
1624 @param retval - return code for the set bridge flags request
1626 define bd_ip_mac_add_del_reply
1632 /** \brief Add/Delete classification table request
1633 @param client_index - opaque cookie to identify the sender
1634 @param context - sender context, to match reply w/ request
1635 @param is_add- if non-zero add the table, else delete it
1636 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1637 @param nbuckets - number of buckets when adding a table
1638 @param memory_size - memory size when adding a table
1639 @param match_n_vectors - number of match vectors
1640 @param next_table_index - index of next table
1641 @param miss_next_index - index of miss table
1642 @param mask[] - match mask
1644 define classify_add_del_table
1653 u32 match_n_vectors;
1654 u32 next_table_index;
1655 u32 miss_next_index;
1659 /** \brief Add/Delete classification table response
1660 @param context - sender context, to match reply w/ request
1661 @param retval - return code for the table add/del requst
1662 @param new_table_index - for add, returned index of the new table
1663 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1664 @param match_n_vectors -for add, returned value of match_n_vectors in table
1666 define classify_add_del_table_reply
1670 u32 new_table_index;
1672 u32 match_n_vectors;
1675 /** \brief Classify add / del session request
1676 @param client_index - opaque cookie to identify the sender
1677 @param context - sender context, to match reply w/ request
1678 @param is_add - add session if non-zero, else delete
1679 @param table_index - index of the table to add/del the session, required
1680 @param hit_next_index - for add, hit_next_index of new session, required
1681 @param opaque_index - for add, opaque_index of new session
1682 @param advance -for add, advance value for session
1683 @param match[] - for add, match value for session, required
1685 define classify_add_del_session
1697 /** \brief Classify add / del session response
1698 @param context - sender context, to match reply w/ request
1699 @param retval - return code for the add/del session request
1701 define classify_add_del_session_reply
1707 /** \brief Set/unset the classification table for an interface request
1708 @param client_index - opaque cookie to identify the sender
1709 @param context - sender context, to match reply w/ request
1710 @param is_ipv6 - ipv6 if non-zero, else ipv4
1711 @param sw_if_index - interface to associate with the table
1712 @param table_index - index of the table, if ~0 unset the table
1714 define classify_set_interface_ip_table
1720 u32 table_index; /* ~0 => off */
1723 /** \brief Set/unset interface classification table response
1724 @param context - sender context, to match reply w/ request
1725 @param retval - return code
1727 define classify_set_interface_ip_table_reply
1733 /** \brief Set/unset l2 classification tables for an interface request
1734 @param client_index - opaque cookie to identify the sender
1735 @param context - sender context, to match reply w/ request
1736 @param sw_if_index - interface to set/unset tables for
1737 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1738 @param ip6_table_index - ip6 index
1739 @param other_table_index - other index
1741 define classify_set_interface_l2_tables
1747 u32 ip4_table_index;
1748 u32 ip6_table_index;
1749 u32 other_table_index;
1753 /** \brief Set/unset l2 classification tables for an interface response
1754 @param context - sender context, to match reply w/ request
1755 @param retval - return code for the request
1757 define classify_set_interface_l2_tables_reply
1763 /** \brief Get node index using name request
1764 @param client_index - opaque cookie to identify the sender
1765 @param context - sender context, to match reply w/ request
1766 @param node_name[] - name of the node
1768 define get_node_index
1775 /** \brief Get node index using name request
1776 @param context - sender context, to match reply w/ request
1777 @param retval - return code for the request
1778 @param node_index - index of the desired node if found, else ~0
1780 define get_node_index_reply
1787 /** \brief Set the next node for a given node request
1788 @param client_index - opaque cookie to identify the sender
1789 @param context - sender context, to match reply w/ request
1790 @param node_name[] - node to add the next node to
1791 @param next_name[] - node to add as the next node
1793 define add_node_next
1801 /** \brief IP Set the next node for a given node response
1802 @param context - sender context, to match reply w/ request
1803 @param retval - return code for the add next node request
1804 @param next_index - the index of the next node if success, else ~0
1806 define add_node_next_reply
1813 /** \brief DHCP Proxy config 2 add / del request
1814 @param client_index - opaque cookie to identify the sender
1815 @param context - sender context, to match reply w/ request
1816 @param rx_vrf_id - receive vrf id
1817 @param server_vrf_id - server vrf id
1818 @param if_ipv6 - ipv6 if non-zero, else ipv4
1819 @param is_add - add the config if non-zero, else delete
1820 @param insert_circuit_id - option82 suboption 1 fib number
1821 @param dhcp_server[] - server address
1822 @param dhcp_src_address[] - <fix this, need details>
1824 define dhcp_proxy_config_2
1832 u8 insert_circuit_id;
1834 u8 dhcp_src_address[16];
1837 /** \brief DHCP Proxy config 2 add / del response
1838 @param context - sender context, to match reply w/ request
1839 @param retval - return code for request
1841 define dhcp_proxy_config_2_reply
1847 /** \brief l2tpv3 tunnel interface create request
1848 @param client_index - opaque cookie to identify the sender
1849 @param context - sender context, to match reply w/ request
1850 @param client_address - remote client tunnel ip address
1851 @param client_address - local tunnel ip address
1852 @param is_ipv6 - ipv6 if non-zero, else ipv4
1853 @param local_session_id - local tunnel session id
1854 @param remote_session_id - remote tunnel session id
1855 @param local_cookie - local tunnel cookie
1856 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1857 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1859 define l2tpv3_create_tunnel
1863 u8 client_address[16];
1866 u32 local_session_id;
1867 u32 remote_session_id;
1870 u8 l2_sublayer_present;
1874 /** \brief l2tpv3 tunnel interface create response
1875 @param context - sender context, to match reply w/ request
1876 @param retval - return code for the request
1877 @param sw_if_index - index of the new tunnel interface
1879 define l2tpv3_create_tunnel_reply
1886 define l2tpv3_set_tunnel_cookies
1891 u64 new_local_cookie;
1892 u64 new_remote_cookie;
1895 /** \brief L2TP tunnel set cookies response
1896 @param context - sender context, to match reply w/ request
1897 @param retval - return code for the request
1899 define l2tpv3_set_tunnel_cookies_reply
1905 define sw_if_l2tpv3_tunnel_details
1909 u8 interface_name[64];
1910 u8 client_address[16];
1912 u32 local_session_id;
1913 u32 remote_session_id;
1914 u64 local_cookie[2];
1916 u8 l2_sublayer_present;
1919 define sw_if_l2tpv3_tunnel_dump
1925 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1926 @param client_index - opaque cookie to identify the sender
1927 @param context - sender context, to match reply w/ request
1929 define l2_fib_clear_table
1935 /** \brief L2 fib clear table response
1936 @param context - sender context, to match reply w/ request
1937 @param retval - return code for the request
1939 define l2_fib_clear_table_reply
1945 /** \brief L2 interface ethernet flow point filtering enable/disable request
1946 @param client_index - opaque cookie to identify the sender
1947 @param context - sender context, to match reply w/ request
1948 @param sw_if_index - interface to enable/disable filtering on
1949 @param enable_disable - if non-zero enable filtering, else disable
1951 define l2_interface_efp_filter
1959 /** \brief L2 interface ethernet flow point filtering response
1960 @param context - sender context, to match reply w/ request
1961 @param retval - return code for the request
1963 define l2_interface_efp_filter_reply
1969 define l2tpv3_interface_enable_disable
1977 define l2tpv3_interface_enable_disable_reply
1983 define l2tpv3_set_lookup_key
1987 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1991 define l2tpv3_set_lookup_key_reply
1997 define vxlan_add_del_tunnel
2006 u32 decap_next_index;
2010 define vxlan_add_del_tunnel_reply
2017 define vxlan_tunnel_dump
2024 define vxlan_tunnel_details
2031 u32 decap_next_index;
2036 define gre_add_del_tunnel
2048 define gre_add_del_tunnel_reply
2055 define gre_tunnel_dump
2062 define gre_tunnel_details
2073 /** \brief L2 interface vlan tag rewrite configure request
2074 @param client_index - opaque cookie to identify the sender
2075 @param context - sender context, to match reply w/ request
2076 @param sw_if_index - interface the operation is applied to
2077 @param vtr_op - Choose from l2_vtr_op_t enum values
2078 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
2079 @param tag1 - Needed for any push or translate vtr op
2080 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
2082 define l2_interface_vlan_tag_rewrite
2088 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
2089 u32 tag1; // first pushed tag
2090 u32 tag2; // second pushed tag
2093 /** \brief L2 interface vlan tag rewrite response
2094 @param context - sender context, to match reply w/ request
2095 @param retval - return code for the request
2097 define l2_interface_vlan_tag_rewrite_reply
2103 /** \brief vhost-user interface create request
2104 @param client_index - opaque cookie to identify the sender
2105 @param is_server - our side is socket server
2106 @param sock_filename - unix socket filename, used to speak with frontend
2107 @param use_custom_mac - enable or disable the use of the provided hardware address
2108 @param mac_address - hardware address to use if 'use_custom_mac' is set
2110 define create_vhost_user_if
2115 u8 sock_filename[256];
2117 u32 custom_dev_instance;
2122 /** \brief vhost-user interface create response
2123 @param context - sender context, to match reply w/ request
2124 @param retval - return code for the request
2125 @param sw_if_index - interface the operation is applied to
2127 define create_vhost_user_if_reply
2134 /** \brief vhost-user interface modify request
2135 @param client_index - opaque cookie to identify the sender
2136 @param is_server - our side is socket server
2137 @param sock_filename - unix socket filename, used to speak with frontend
2139 define modify_vhost_user_if
2145 u8 sock_filename[256];
2147 u32 custom_dev_instance;
2150 /** \brief vhost-user interface modify response
2151 @param context - sender context, to match reply w/ request
2152 @param retval - return code for the request
2154 define modify_vhost_user_if_reply
2160 /** \brief vhost-user interface delete request
2161 @param client_index - opaque cookie to identify the sender
2163 define delete_vhost_user_if
2170 /** \brief vhost-user interface delete response
2171 @param context - sender context, to match reply w/ request
2172 @param retval - return code for the request
2174 define delete_vhost_user_if_reply
2187 /* These fields map directly onto the subif template */
2191 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2194 u8 outer_vlan_id_any;
2195 u8 inner_vlan_id_any;
2200 define create_subif_reply
2207 /** \brief show version
2208 @param client_index - opaque cookie to identify the sender
2209 @param context - sender context, to match reply w/ request
2217 /** \brief show version response
2218 @param context - sender context, to match reply w/ request
2219 @param retval - return code for the request
2220 @param program - name of the program (vpe)
2221 @param version - version of the program
2222 @param build_directory - root of the workspace where the program was built
2224 define show_version_reply
2231 u8 build_directory[256];
2234 /** \brief Vhost-user interface details structure (fix this)
2235 @param sw_if_index - index of the interface
2236 @param interface_name - name of interface
2237 @param virtio_net_hdr_sz - net header size
2238 @param features - interface features
2239 @param is_server - vhost-user server socket
2240 @param sock_filename - socket filename
2241 @param num_regions - number of used memory regions
2243 define sw_interface_vhost_user_details
2247 u8 interface_name[64];
2248 u32 virtio_net_hdr_sz;
2251 u8 sock_filename[256];
2257 define sw_interface_vhost_user_dump
2263 define ip_address_details
2271 define ip_address_dump
2292 /** \brief l2 fib table entry structure
2293 @param bd_id - the l2 fib / bridge domain table id
2294 @param mac - the entry's mac address
2295 @param sw_if_index - index of the interface
2296 @param static_mac - the entry is statically configured.
2297 @param filter_mac - the entry is a mac filter entry.
2298 @param bvi_mac - the mac address is a bridge virtual interface
2300 define l2_fib_table_entry
2311 /** \brief Dump l2 fib (aka bridge domain) table
2312 @param client_index - opaque cookie to identify the sender
2313 @param bd_id - the l2 fib / bridge domain table identifier
2315 define l2_fib_table_dump
2322 define vxlan_gpe_add_del_tunnel
2336 define vxlan_gpe_add_del_tunnel_reply
2343 define vxlan_gpe_tunnel_dump
2350 define vxlan_gpe_tunnel_details
2363 /** \brief add or delete locator_set
2364 @param client_index - opaque cookie to identify the sender
2365 @param context - sender context, to match reply w/ request
2366 @param is_add - add address if non-zero, else delete
2367 @param locator_set_name - locator name
2368 @param locator_num - number of locators
2369 @param locators - Lisp locator data
2371 define lisp_add_del_locator_set
2376 u8 locator_set_name[64];
2378 u8 locators[locator_num];
2381 /** \brief Reply for locator_set add/del
2382 @param context - returned sender context, to match reply w/ request
2383 @param retval - return code
2384 @param ls_index - locator set index
2386 define lisp_add_del_locator_set_reply
2393 /** \brief add or delete locator for locator_set
2394 @param client_index - opaque cookie to identify the sender
2395 @param context - sender context, to match reply w/ request
2396 @param is_add - add address if non-zero, else delete
2397 @param locator_set_name - name of locator_set to add/del locator
2398 @param sw_if_index - index of the interface
2399 @param priority - priority of the lisp locator
2400 @param weight - weight of the lisp locator
2402 define lisp_add_del_locator
2407 u8 locator_set_name[64];
2413 /** \brief Reply for locator add/del
2414 @param context - returned sender context, to match reply w/ request
2415 @param retval - return code
2417 define lisp_add_del_locator_reply
2423 /** \brief add or delete lisp eid-table
2424 @param client_index - opaque cookie to identify the sender
2425 @param context - sender context, to match reply w/ request
2426 @param is_add - add address if non-zero, else delete
2431 @param eid - EID can be ip4, ip6 or mac
2432 @param prefix_len - prefix len
2433 @param locator_set_name - name of locator_set to add/del eid-table
2434 @param vni - virtual network instance
2436 define lisp_add_del_local_eid
2444 u8 locator_set_name[64];
2448 /** \brief Reply for local_eid add/del
2449 @param context - returned sender context, to match reply w/ request
2450 @param retval - return code
2452 define lisp_add_del_local_eid_reply
2458 /** \brief add or delete lisp gpe tunnel
2459 @param client_index - opaque cookie to identify the sender
2460 @param context - sender context, to match reply w/ request
2461 @param is_add - add address if non-zero, else delete
2466 @param rmt_eid - remote eid
2467 @param lcl_eid - local eid
2468 @param rmt_len - remote prefix len
2469 @param lcl_len - local prefix len
2470 @param vni - virtual network identifier
2471 @param dp_table - vrf/bridge domain id
2472 @param loc_num - number of locators
2473 @param lcl_locs - array of local locators
2474 @param rmt_locs - array of remote locators
2475 @param action - negative action when 0 locators configured
2477 define lisp_gpe_add_del_fwd_entry
2490 u8 lcl_locs[loc_num];
2491 u8 rmt_locs[loc_num];
2495 /** \brief Reply for gpe_fwd_entry add/del
2496 @param context - returned sender context, to match reply w/ request
2497 @param retval - return code
2499 define lisp_gpe_add_del_fwd_entry_reply
2505 /** \brief add or delete map-resolver
2506 @param client_index - opaque cookie to identify the sender
2507 @param context - sender context, to match reply w/ request
2508 @param is_add - add address if non-zero, else delete
2509 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2510 @param ip_address - array of address bytes
2512 define lisp_add_del_map_resolver
2521 /** \brief Reply for map_resolver add/del
2522 @param context - returned sender context, to match reply w/ request
2523 @param retval - return code
2525 define lisp_add_del_map_resolver_reply
2531 /** \brief enable or disable lisp-gpe protocol
2532 @param client_index - opaque cookie to identify the sender
2533 @param context - sender context, to match reply w/ request
2534 @param is_en - enable protocol if non-zero, else disable
2536 define lisp_gpe_enable_disable
2543 /** \brief Reply for gpe enable/disable
2544 @param context - returned sender context, to match reply w/ request
2545 @param retval - return code
2547 define lisp_gpe_enable_disable_reply
2553 /** \brief enable or disable LISP feature
2554 @param client_index - opaque cookie to identify the sender
2555 @param context - sender context, to match reply w/ request
2556 @param is_en - enable protocol if non-zero, else disable
2558 define lisp_enable_disable
2565 /** \brief Reply for gpe enable/disable
2566 @param context - returned sender context, to match reply w/ request
2567 @param retval - return code
2569 define lisp_enable_disable_reply
2575 /** \brief add or delete gpe_iface
2576 @param client_index - opaque cookie to identify the sender
2577 @param context - sender context, to match reply w/ request
2578 @param is_add - add address if non-zero, else delete
2580 define lisp_gpe_add_del_iface
2590 /** \brief Reply for gpe_iface add/del
2591 @param context - returned sender context, to match reply w/ request
2592 @param retval - return code
2594 define lisp_gpe_add_del_iface_reply
2600 /** \brief configure or disable LISP PITR node
2601 @param client_index - opaque cookie to identify the sender
2602 @param context - sender context, to match reply w/ request
2603 @param ls_name - locator set name
2604 @param is_add - add locator set if non-zero, else disable pitr
2606 define lisp_pitr_set_locator_set
2614 /** \brief Reply for lisp_pitr_set_locator_set
2615 @param context - returned sender context, to match reply w/ request
2616 @param retval - return code
2618 define lisp_pitr_set_locator_set_reply
2624 /** \brief add or delete remote static mapping
2625 @param client_index - opaque cookie to identify the sender
2626 @param context - sender context, to match reply w/ request
2627 @param is_add - add address if non-zero, else delete
2628 @param is_src_dst - flag indicating src/dst based routing policy
2629 @param del_all - if set, delete all remote mappings
2630 @param vni - virtual network instance
2631 @param action - negative map-reply action
2636 @param deid - dst EID
2637 @param seid - src EID, valid only if is_src_dst is enabled
2638 @param rloc_num - number of remote locators
2639 @param rlocs - remote locator data
2641 define lisp_add_del_remote_mapping
2659 /** \brief Reply for lisp_add_del_remote_mapping
2660 @param context - returned sender context, to match reply w/ request
2661 @param retval - return code
2663 define lisp_add_del_remote_mapping_reply
2669 /** \brief add or delete LISP adjacency adjacency
2670 @param client_index - opaque cookie to identify the sender
2671 @param context - sender context, to match reply w/ request
2672 @param is_add - add address if non-zero, else delete
2673 @param vni - virtual network instance
2678 @param deid - destination EID
2679 @param seid - source EID
2681 define lisp_add_del_adjacency
2694 /** \brief Reply for lisp_add_del_adjacency
2695 @param context - returned sender context, to match reply w/ request
2696 @param retval - return code
2698 define lisp_add_del_adjacency_reply
2704 /** \brief add or delete map request itr rlocs
2705 @param client_index - opaque cookie to identify the sender
2706 @param context - sender context, to match reply w/ request
2707 @param is_add - add address if non-zero, else delete
2708 @param locator_set_name - locator set name
2710 define lisp_add_del_map_request_itr_rlocs
2715 u8 locator_set_name[64];
2718 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2719 @param context - returned sender context, to match reply w/ request
2720 @param retval - return code
2723 define lisp_add_del_map_request_itr_rlocs_reply
2729 /** \brief map/unmap vni/bd_index to vrf
2730 @param client_index - opaque cookie to identify the sender
2731 @param context - sender context, to match reply w/ request
2732 @param is_add - add or delete mapping
2733 @param dp_table - virtual network id/bridge domain index
2736 define lisp_eid_table_add_del_map
2746 /** \brief Reply for lisp_eid_table_add_del_map
2747 @param context - returned sender context, to match reply w/ request
2748 @param retval - return code
2750 define lisp_eid_table_add_del_map_reply
2756 /** \brief Request for map lisp locator status
2757 @param client_index - opaque cookie to identify the sender
2758 @param context - sender context, to match reply w/ request
2759 @param locator_set_index - index of locator_set
2760 @param ls_name - locator set name
2761 @param is_index_set - flag indicating whether ls_name or ls_index is set
2763 define lisp_locator_dump
2772 /** \brief LISP locator_set status
2773 @param local - if is set, then locator is local
2774 @param locator_set_name - name of the locator_set
2775 @param sw_if_index - sw_if_index of the locator
2776 @param priority - locator priority
2777 @param weight - locator weight
2779 define lisp_locator_details
2790 /** \brief LISP locator_set status
2791 @param context - sender context, to match reply w/ request
2792 @param ls_index - locator set index
2793 @param ls_name - name of the locator set
2795 define lisp_locator_set_details
2802 /** \brief Request for locator_set summary status
2803 @param client_index - opaque cookie to identify the sender
2804 @param context - sender context, to match reply w/ request
2805 @param filter - filter type
2808 1: local locator sets
2809 2: remote locator sets
2811 define lisp_locator_set_dump
2818 /** \brief Dump lisp eid-table
2819 @param client_index - opaque cookie to identify the sender
2820 @param context - sender context, to match reply w/ request
2821 @param locator_set_index - index of locator_set, if ~0 then the mapping
2823 @param action - negative map request action
2824 @param is_local - local if non-zero, else remote
2829 @param is_src_dst - EID is type of source/destination
2830 @param eid - EID can be ip4, ip6 or mac
2831 @param eid_prefix_len - prefix length
2832 @param seid - source EID can be ip4, ip6 or mac
2833 @param seid_prefix_len - source prefix length
2834 @param vni - virtual network instance
2835 @param ttl - time to live
2836 @param authoritative - authoritative
2839 define lisp_eid_table_details
2842 u32 locator_set_index;
2856 /** \brief Request for eid table summary status
2857 @param client_index - opaque cookie to identify the sender
2858 @param context - sender context, to match reply w/ request
2859 @param eid_set - if non-zero request info about specific mapping
2860 @param vni - virtual network instance; valid only if eid_set != 0
2861 @param prefix_length - prefix length if EID is IP address;
2862 valid only if eid_set != 0
2863 @param eid_type - EID type; valid only if eid_set != 0
2867 2: EID is ethernet address
2868 @param eid - endpoint identifier
2869 @param filter - filter type;
2875 define lisp_eid_table_dump
2887 /** \brief Shows relationship between vni and vrf/bd
2888 @param dp_table - VRF index or bridge domain index
2889 @param vni - vitual network instance
2891 define lisp_eid_table_map_details
2898 /** \brief Request for lisp_eid_table_map_details
2899 @param client_index - opaque cookie to identify the sender
2900 @param context - sender context, to match reply w/ request
2901 @param is_l2 - if set dump vni/bd mappings else vni/vrf
2903 define lisp_eid_table_map_dump
2910 /** \brief Dumps all VNIs used in mappings
2911 @param client_index - opaque cookie to identify the sender
2912 @param context - sender context, to match reply w/ request
2914 define lisp_eid_table_vni_dump
2920 /** \brief reply to lisp_eid_table_vni_dump
2921 @param client_index - opaque cookie to identify the sender
2922 @param context - sender context, to match reply w/ request
2923 @param vni - virtual network instance
2925 define lisp_eid_table_vni_details
2932 define lisp_gpe_tunnel_details
2938 u8 destination_ip[16];
2950 /** \brief Request for gpe tunnel summary status
2951 @param client_index - opaque cookie to identify the sender
2952 @param context - sender context, to match reply w/ request
2954 define lisp_gpe_tunnel_dump
2960 /** \brief LISP map resolver status
2961 @param locator_set_name - name of the locator_set
2962 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2963 @param ip_address - array of address bytes
2965 define lisp_map_resolver_details
2972 /** \brief Request for map resolver summary status
2973 @param client_index - opaque cookie to identify the sender
2974 @param context - sender context, to match reply w/ request
2976 define lisp_map_resolver_dump
2982 /** \brief Request for lisp-gpe protocol status
2983 @param client_index - opaque cookie to identify the sender
2984 @param context - sender context, to match reply w/ request
2986 define show_lisp_status
2992 /** \brief Status of lisp, enable or disable
2993 @param context - sender context, to match reply w/ request
2994 @param feature_status - lisp enable if non-zero, else disable
2995 @param gpe_status - lisp enable if non-zero, else disable
2997 define show_lisp_status_reply
3005 /** \brief Get LISP map request itr rlocs status
3006 @param context - sender context, to match reply w/ request
3007 @param locator_set_name - name of the locator_set
3009 define lisp_get_map_request_itr_rlocs
3015 /** \brief Request for map request itr rlocs summary status
3017 define lisp_get_map_request_itr_rlocs_reply
3021 u8 locator_set_name[64];
3024 /** \brief Request for lisp pitr status
3025 @param client_index - opaque cookie to identify the sender
3026 @param context - sender context, to match reply w/ request
3028 define show_lisp_pitr
3034 /** \brief Status of lisp pitr, enable or disable
3035 @param context - sender context, to match reply w/ request
3036 @param status - lisp pitr enable if non-zero, else disable
3037 @param locator_set_name - name of the locator_set
3039 define show_lisp_pitr_reply
3044 u8 locator_set_name[64];
3047 /* Gross kludge, DGMS */
3048 define interface_name_renumber
3053 u32 new_show_dev_instance;
3056 define interface_name_renumber_reply
3062 /** \brief Register for ip4 arp resolution events
3063 @param client_index - opaque cookie to identify the sender
3064 @param context - sender context, to match reply w/ request
3065 @param enable_disable - 1 => register for events, 0 => cancel registration
3066 @param pid - sender's pid
3067 @param address - the exact ip4 address of interest
3069 define want_ip4_arp_events
3078 /** \brief Reply for interface events registration
3079 @param context - returned sender context, to match reply w/ request
3080 @param retval - return code
3082 define want_ip4_arp_events_reply
3088 /** \brief Tell client about an ip4 arp resolution event
3089 @param client_index - opaque cookie to identify the sender
3090 @param context - sender context, to match reply w/ request
3091 @param address - the exact ip4 address of interest
3092 @param pid - client pid registered to receive notification
3093 @param sw_if_index - interface which received ARP packet
3094 @param new_mac - the new mac address
3095 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3097 define ip4_arp_event
3108 /** \brief Register for ip6 nd resolution events
3109 @param client_index - opaque cookie to identify the sender
3110 @param context - sender context, to match reply w/ request
3111 @param enable_disable - 1 => register for events, 0 => cancel registration
3112 @param pid - sender's pid
3113 @param address - the exact ip6 address of interest
3115 define want_ip6_nd_events
3124 /** \brief Reply for ip6 nd resolution events registration
3125 @param context - returned sender context, to match reply w/ request
3126 @param retval - return code
3128 define want_ip6_nd_events_reply
3134 /** \brief Tell client about an ip6 nd resolution or mac/ip event
3135 @param client_index - opaque cookie to identify the sender
3136 @param context - sender context, to match reply w/ request
3137 @param pid - client pid registered to receive notification
3138 @param sw_if_index - interface which received ARP packet
3139 @param address - the exact ip6 address of interest
3140 @param new_mac - the new mac address
3141 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3154 /** \brief L2 bridge domain add or delete request
3155 @param client_index - opaque cookie to identify the sender
3156 @param context - sender context, to match reply w/ request
3157 @param bd_id - the bridge domain to create
3158 @param flood - enable/disable bcast/mcast flooding in the bd
3159 @param uu_flood - enable/disable uknown unicast flood in the bd
3160 @param forward - enable/disable forwarding on all interfaces in the bd
3161 @param learn - enable/disable learning on all interfaces in the bd
3162 @param arp_term - enable/disable arp termination in the bd
3163 @param is_add - add or delete flag
3165 define bridge_domain_add_del
3178 /** \brief L2 bridge domain add or delete response
3179 @param context - sender context, to match reply w/ request
3180 @param retval - return code for the set bridge flags request
3182 define bridge_domain_add_del_reply
3188 /** \brief L2 bridge domain request operational state details
3189 @param client_index - opaque cookie to identify the sender
3190 @param context - sender context, to match reply w/ request
3191 @param bd_id - the bridge domain id desired or ~0 to request all bds
3193 define bridge_domain_dump
3200 /** \brief L2 bridge domain operational state response
3201 @param bd_id - the bridge domain id
3202 @param flood - bcast/mcast flooding state on all interfaces in the bd
3203 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3204 @param forward - forwarding state on all interfaces in the bd
3205 @param learn - learning state on all interfaces in the bd
3206 @param arp_term - arp termination state on all interfaces in the bd
3207 @param n_sw_ifs - number of sw_if_index's in the domain
3209 define bridge_domain_details
3218 u32 bvi_sw_if_index;
3222 /** \brief L2 bridge domain sw interface operational state response
3223 @param bd_id - the bridge domain id
3224 @param sw_if_index - sw_if_index in the domain
3225 @param shg - split horizon group for the interface
3227 define bridge_domain_sw_if_details
3235 /** \brief DHCP Client config add / del request
3236 @param client_index - opaque cookie to identify the sender
3237 @param context - sender context, to match reply w/ request
3238 @param sw_if_index - index of the interface for DHCP client
3239 @param hostname - hostname
3240 @param is_add - add the config if non-zero, else delete
3241 @param want_dhcp_event - DHCP event sent to the sender
3242 via dhcp_compl_event API message if non-zero
3243 @param pid - sender's pid
3245 define dhcp_client_config
3256 /** \brief DHCP Client config response
3257 @param context - sender context, to match reply w/ request
3258 @param retval - return code for the request
3260 define dhcp_client_config_reply
3266 /** \brief Set/unset input ACL interface
3267 @param client_index - opaque cookie to identify the sender
3268 @param context - sender context, to match reply w/ request
3269 @param sw_if_index - interface to set/unset input ACL
3270 @param ip4_table_index - ip4 classify table index (~0 for skip)
3271 @param ip6_table_index - ip6 classify table index (~0 for skip)
3272 @param l2_table_index - l2 classify table index (~0 for skip)
3273 @param is_add - Set input ACL if non-zero, else unset
3274 Note: User is recommeneded to use just one valid table_index per call.
3275 (ip4_table_index, ip6_table_index, or l2_table_index)
3277 define input_acl_set_interface
3282 u32 ip4_table_index;
3283 u32 ip6_table_index;
3288 /** \brief Set/unset input ACL interface response
3289 @param context - sender context, to match reply w/ request
3290 @param retval - return code for the request
3292 define input_acl_set_interface_reply
3298 /** \brief IPsec: Add/delete Security Policy Database
3299 @param client_index - opaque cookie to identify the sender
3300 @param context - sender context, to match reply w/ request
3301 @param is_add - add SPD if non-zero, else delete
3302 @param spd_id - SPD instance id (control plane allocated)
3305 define ipsec_spd_add_del
3313 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3314 @param context - returned sender context, to match reply w/ request
3315 @param retval - return code
3318 define ipsec_spd_add_del_reply
3324 /** \brief IPsec: Add/delete SPD from interface
3326 @param client_index - opaque cookie to identify the sender
3327 @param context - sender context, to match reply w/ request
3328 @param is_add - add security mode if non-zero, else delete
3329 @param sw_if_index - index of the interface
3330 @param spd_id - SPD instance id to use for lookups
3334 define ipsec_interface_add_del_spd
3344 /** \brief Reply for IPsec: Add/delete SPD from interface
3345 @param context - returned sender context, to match reply w/ request
3346 @param retval - return code
3349 define ipsec_interface_add_del_spd_reply
3355 /** \brief IPsec: Add/delete Security Policy Database entry
3357 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3359 @param client_index - opaque cookie to identify the sender
3360 @param context - sender context, to match reply w/ request
3361 @param is_add - add SPD if non-zero, else delete
3362 @param spd_id - SPD instance id (control plane allocated)
3363 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3364 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3365 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3366 @param remote_address_start - start of remote address range to match
3367 @param remote_address_stop - end of remote address range to match
3368 @param local_address_start - start of local address range to match
3369 @param local_address_stop - end of local address range to match
3370 @param protocol - protocol type to match [0 means any]
3371 @param remote_port_start - start of remote port range to match ...
3372 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3373 @param local_port_start - start of local port range to match ...
3374 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3375 @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)
3376 @param sa_id - SAD instance id (control plane allocated)
3380 define ipsec_spd_add_del_entry
3393 u8 remote_address_start[16];
3394 u8 remote_address_stop[16];
3395 u8 local_address_start[16];
3396 u8 local_address_stop[16];
3400 u16 remote_port_start;
3401 u16 remote_port_stop;
3402 u16 local_port_start;
3403 u16 local_port_stop;
3410 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3411 @param context - returned sender context, to match reply w/ request
3412 @param retval - return code
3415 define ipsec_spd_add_del_entry_reply
3421 /** \brief IPsec: Add/delete Security Association Database entry
3422 @param client_index - opaque cookie to identify the sender
3423 @param context - sender context, to match reply w/ request
3424 @param is_add - add SAD entry if non-zero, else delete
3426 @param sad_id - sad id
3428 @param spi - security parameter index
3430 @param protocol - 0 = AH, 1 = ESP
3432 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3433 @param crypto_key_length - length of crypto_key in bytes
3434 @param crypto_key - crypto keying material
3436 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3437 @param integrity_key_length - length of integrity_key in bytes
3438 @param integrity_key - integrity keying material
3440 @param use_extended_sequence_number - use ESN when non-zero
3442 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3443 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3444 @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
3445 @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
3449 IPsec tunnel address copy mode (to support GDOI)
3452 define ipsec_sad_add_del_entry
3464 u8 crypto_algorithm;
3465 u8 crypto_key_length;
3468 u8 integrity_algorithm;
3469 u8 integrity_key_length;
3470 u8 integrity_key[128];
3472 u8 use_extended_sequence_number;
3476 u8 tunnel_src_address[16];
3477 u8 tunnel_dst_address[16];
3480 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3481 @param context - returned sender context, to match reply w/ request
3482 @param retval - return code
3485 define ipsec_sad_add_del_entry_reply
3491 /** \brief IPsec: Update Security Association keys
3492 @param client_index - opaque cookie to identify the sender
3493 @param context - sender context, to match reply w/ request
3495 @param sa_id - sa id
3497 @param crypto_key_length - length of crypto_key in bytes
3498 @param crypto_key - crypto keying material
3500 @param integrity_key_length - length of integrity_key in bytes
3501 @param integrity_key - integrity keying material
3504 define ipsec_sa_set_key
3511 u8 crypto_key_length;
3514 u8 integrity_key_length;
3515 u8 integrity_key[128];
3518 /** \brief Reply for IPsec: Update Security Association keys
3519 @param context - returned sender context, to match reply w/ request
3520 @param retval - return code
3523 define ipsec_sa_set_key_reply
3529 /** \brief IKEv2: Add/delete profile
3530 @param client_index - opaque cookie to identify the sender
3531 @param context - sender context, to match reply w/ request
3533 @param name - IKEv2 profile name
3534 @param is_add - Add IKEv2 profile if non-zero, else delete
3536 define ikev2_profile_add_del
3545 /** \brief Reply for IKEv2: Add/delete profile
3546 @param context - returned sender context, to match reply w/ request
3547 @param retval - return code
3549 define ikev2_profile_add_del_reply
3555 /** \brief IKEv2: Set IKEv2 profile authentication method
3556 @param client_index - opaque cookie to identify the sender
3557 @param context - sender context, to match reply w/ request
3559 @param name - IKEv2 profile name
3560 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3561 @param is_hex - Authentication data in hex format if non-zero, else string
3562 @param data_len - Authentication data length
3563 @param data - Authentication data (for rsa-sig cert file path)
3565 define ikev2_profile_set_auth
3577 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3578 @param context - returned sender context, to match reply w/ request
3579 @param retval - return code
3581 define ikev2_profile_set_auth_reply
3587 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3588 @param client_index - opaque cookie to identify the sender
3589 @param context - sender context, to match reply w/ request
3591 @param name - IKEv2 profile name
3592 @param is_local - Identification is local if non-zero, else remote
3593 @param id_type - Identification type
3594 @param data_len - Identification data length
3595 @param data - Identification data
3597 define ikev2_profile_set_id
3609 /** \brief Reply for IKEv2:
3610 @param context - returned sender context, to match reply w/ request
3611 @param retval - return code
3613 define ikev2_profile_set_id_reply
3619 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3620 @param client_index - opaque cookie to identify the sender
3621 @param context - sender context, to match reply w/ request
3623 @param name - IKEv2 profile name
3624 @param is_local - Traffic selector is local if non-zero, else remote
3625 @param proto - Traffic selector IP protocol (if zero not relevant)
3626 @param start_port - The smallest port number allowed by traffic selector
3627 @param end_port - The largest port number allowed by traffic selector
3628 @param start_addr - The smallest address included in traffic selector
3629 @param end_addr - The largest address included in traffic selector
3631 define ikev2_profile_set_ts
3645 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3646 @param context - returned sender context, to match reply w/ request
3647 @param retval - return code
3649 define ikev2_profile_set_ts_reply
3655 /** \brief IKEv2: Set IKEv2 local RSA private key
3656 @param client_index - opaque cookie to identify the sender
3657 @param context - sender context, to match reply w/ request
3659 @param key_file - Key file absolute path
3661 define ikev2_set_local_key
3669 /** \brief Reply for IKEv2: Set IKEv2 local key
3670 @param context - returned sender context, to match reply w/ request
3671 @param retval - return code
3673 define ikev2_set_local_key_reply
3679 /** \brief Tell client about a DHCP completion event
3680 @param client_index - opaque cookie to identify the sender
3681 @param pid - client pid registered to receive notification
3682 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3683 @param host_address - Host IP address
3684 @param router_address - Router IP address
3685 @param host_mac - Host MAC address
3687 define dhcp_compl_event
3693 u8 host_address[16];
3694 u8 router_address[16];
3698 /** \brief Add MAP domains
3699 @param client_index - opaque cookie to identify the sender
3700 @param context - sender context, to match reply w/ request
3701 @param ip6_prefix - Rule IPv6 prefix
3702 @param ip4_prefix - Rule IPv4 prefix
3703 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3704 @param ip6_prefix_len - Rule IPv6 prefix length
3705 @param ip4_prefix_len - Rule IPv4 prefix length
3706 @param ea_bits_len - Embedded Address bits length
3707 @param psid_offset - Port Set Identifider (PSID) offset
3708 @param psid_length - PSID length
3709 @param is_translation - MAP-E / MAP-T
3712 define map_add_domain
3721 u8 ip6_src_prefix_len;
3729 /** \brief Reply for MAP domain add
3730 @param context - returned sender context, to match reply w/ request
3731 @param index - MAP domain index
3732 @param retval - return code
3734 define map_add_domain_reply
3741 /** \brief Delete MAP domain
3742 @param client_index - opaque cookie to identify the sender
3743 @param context - sender context, to match reply w/ request
3744 @param index - MAP Domain index
3746 define map_del_domain
3753 /** \brief Reply for MAP domain del
3754 @param context - returned sender context, to match reply w/ request
3755 @param retval - return code
3757 define map_del_domain_reply
3763 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3764 @param client_index - opaque cookie to identify the sender
3765 @param context - sender context, to match reply w/ request
3766 @param index - MAP Domain index
3767 @param is_add - If 1 add rule, if 0 delete rule
3768 @param ip6_dst - MAP CE IPv6 address
3769 @param psid - Rule PSID
3771 define map_add_del_rule
3781 /** \brief Reply for MAP rule add/del
3782 @param context - returned sender context, to match reply w/ request
3783 @param retval - return code
3785 define map_add_del_rule_reply
3791 /** \brief Get list of map domains
3792 @param client_index - opaque cookie to identify the sender
3794 define map_domain_dump
3800 define map_domain_details
3818 define map_rule_dump
3825 define map_rule_details
3832 /** \brief Request for a single block of summary stats
3833 @param client_index - opaque cookie to identify the sender
3834 @param context - sender context, to match reply w/ request
3836 define map_summary_stats
3842 /** \brief Reply for map_summary_stats request
3843 @param context - sender context, to match reply w/ request
3844 @param retval - return code for request
3845 @param total_bindings -
3847 @param total_ip4_fragments -
3848 @param total_security_check -
3850 define map_summary_stats_reply
3857 u64 total_ip4_fragments;
3858 u64 total_security_check[2];
3861 /** \brief cop: enable/disable junk filtration features on an interface
3862 @param client_index - opaque cookie to identify the sender
3863 @param context - sender context, to match reply w/ request
3864 @param sw_if_inded - desired interface
3865 @param enable_disable - 1 => enable, 0 => disable
3868 define cop_interface_enable_disable
3876 /** \brief cop: interface enable/disable junk filtration reply
3877 @param context - returned sender context, to match reply w/ request
3878 @param retval - return code
3881 define cop_interface_enable_disable_reply
3887 /** \brief cop: enable/disable whitelist filtration features on an interface
3888 Note: the supplied fib_id must match in order to remove the feature!
3890 @param client_index - opaque cookie to identify the sender
3891 @param context - sender context, to match reply w/ request
3892 @param sw_if_index - interface handle, physical interfaces only
3893 @param fib_id - fib identifier for the whitelist / blacklist fib
3894 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3895 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3896 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3899 define cop_whitelist_enable_disable
3910 /** \brief cop: interface enable/disable junk filtration reply
3911 @param context - returned sender context, to match reply w/ request
3912 @param retval - return code
3915 define cop_whitelist_enable_disable_reply
3921 /** \brief get_node_graph - get a copy of the vpp node graph
3922 including the current set of graph arcs.
3924 @param client_index - opaque cookie to identify the sender
3925 @param context - sender context, to match reply w/ request
3928 define get_node_graph
3934 /** \brief get_node_graph_reply
3935 @param context - returned sender context, to match reply w/ request
3936 @param retval - return code
3937 @param reply_in_shmem - result from vlib_node_serialize, in shared
3938 memory. Process with vlib_node_unserialize, remember to switch
3939 heaps and free the result.
3942 define get_node_graph_reply
3949 /** \brief Clear interface statistics
3950 @param client_index - opaque cookie to identify the sender
3951 @param context - sender context, to match reply w/ request
3952 @param sw_if_index - index of the interface to clear statistics
3954 define sw_interface_clear_stats
3961 /** \brief Reply to sw_interface_clear_stats
3962 @param context - sender context which was passed in the request
3963 @param retval - return code of the set flags request
3965 define sw_interface_clear_stats_reply
3971 /** \brief IOAM enable : Enable in-band OAM
3972 @param id - profile id
3973 @param trace_ppc - Trace PPC (none/encap/decap)
3974 @param pow_enable - Proof of Work enabled or not flag
3975 @param trace_enable - iOAM Trace enabled or not flag
3988 /** \brief iOAM Trace profile add / del response
3989 @param context - sender context, to match reply w/ request
3990 @param retval - return value for request
3992 define ioam_enable_reply
3998 /** \brief iOAM disable
3999 @param client_index - opaque cookie to identify the sender
4000 @param context - sender context, to match reply w/ request
4001 @param index - MAP Domain index
4010 /** \brief iOAM disable response
4011 @param context - sender context, to match reply w/ request
4012 @param retval - return value for request
4014 define ioam_disable_reply
4020 /** \brief Create host-interface
4021 @param client_index - opaque cookie to identify the sender
4022 @param context - sender context, to match reply w/ request
4023 @param host_if_name - interface name
4024 @param hw_addr - interface MAC
4025 @param use_random_hw_addr - use random generated MAC
4027 define af_packet_create
4032 u8 host_if_name[64];
4034 u8 use_random_hw_addr;
4037 /** \brief Create host-interface response
4038 @param context - sender context, to match reply w/ request
4039 @param retval - return value for request
4041 define af_packet_create_reply
4048 /** \brief Delete host-interface
4049 @param client_index - opaque cookie to identify the sender
4050 @param context - sender context, to match reply w/ request
4051 @param host_if_name - interface name
4053 define af_packet_delete
4058 u8 host_if_name[64];
4061 /** \brief Delete host-interface response
4062 @param context - sender context, to match reply w/ request
4063 @param retval - return value for request
4065 define af_packet_delete_reply
4071 /** \brief Add/del policer
4072 @param client_index - opaque cookie to identify the sender
4073 @param context - sender context, to match reply w/ request
4074 @param is_add - add policer if non-zero, else delete
4075 @param name - policer name
4078 @param cb - Committed Burst
4079 @param eb - Excess or Peak Burst
4080 @param rate_type - rate type
4081 @param round_type - rounding type
4082 @param type - policer algorithm
4083 @param color_aware - 0=color-blind, 1=color-aware
4084 @param conform_action_type - conform action type
4085 @param conform_dscp - DSCP for conform mar-and-transmit action
4086 @param exceed_action_type - exceed action type
4087 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4088 @param violate_action_type - violate action type
4089 @param violate_dscp - DSCP for violate mar-and-transmit action
4091 define policer_add_del
4106 u8 conform_action_type;
4108 u8 exceed_action_type;
4110 u8 violate_action_type;
4114 /** \brief Add/del policer response
4115 @param context - sender context, to match reply w/ request
4116 @param retval - return value for request
4117 @param policer_index - for add, returned index of the new policer
4119 define policer_add_del_reply
4126 /** \brief Get list of policers
4127 @param client_index - opaque cookie to identify the sender
4128 @param context - sender context, to match reply w/ request
4129 @param match_name_valid - if 0 request all policers otherwise use match_name
4130 @param match_name - policer name
4137 u8 match_name_valid;
4141 /** \brief Policer operational state response.
4142 @param context - sender context, to match reply w/ request
4143 @param name - policer name
4146 @param cb - Committed Burst
4147 @param eb - Excess or Peak Burst
4148 @param rate_type - rate type
4149 @param round_type - rounding type
4150 @param type - policer algorithm
4151 @param conform_action_type - conform action type
4152 @param conform_dscp - DSCP for conform mar-and-transmit action
4153 @param exceed_action_type - exceed action type
4154 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4155 @param violate_action_type - violate action type
4156 @param violate_dscp - DSCP for violate mar-and-transmit action
4157 @param single_rate - 1 = single rate policer, 0 = two rate policer
4158 @param color_aware - for hierarchical policing
4159 @param scale - power-of-2 shift amount for lower rates
4160 @param cir_tokens_per_period - number of tokens for each period
4161 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
4162 @param current_limit - current limit
4163 @param current_bucket - current bucket
4164 @param extended_limit - extended limit
4165 @param extended_bucket - extended bucket
4166 @param last_update_time - last update time
4168 define policer_details
4180 u8 conform_action_type;
4182 u8 exceed_action_type;
4184 u8 violate_action_type;
4189 u32 cir_tokens_per_period;
4190 u32 pir_tokens_per_period;
4194 u32 extended_bucket;
4195 u64 last_update_time;
4198 /** \brief Set/unset policer classify interface
4199 @param client_index - opaque cookie to identify the sender
4200 @param context - sender context, to match reply w/ request
4201 @param sw_if_index - interface to set/unset policer classify
4202 @param ip4_table_index - ip4 classify table index (~0 for skip)
4203 @param ip6_table_index - ip6 classify table index (~0 for skip)
4204 @param l2_table_index - l2 classify table index (~0 for skip)
4205 @param is_add - Set if non-zero, else unset
4206 Note: User is recommeneded to use just one valid table_index per call.
4207 (ip4_table_index, ip6_table_index, or l2_table_index)
4209 define policer_classify_set_interface
4214 u32 ip4_table_index;
4215 u32 ip6_table_index;
4220 /** \brief Set/unset policer classify interface response
4221 @param context - sender context, to match reply w/ request
4222 @param retval - return value for request
4224 define policer_classify_set_interface_reply
4230 /** \brief Get list of policer classify interfaces and tables
4231 @param client_index - opaque cookie to identify the sender
4232 @param context - sender context, to match reply w/ request
4233 @param type - classify table type
4235 define policer_classify_dump
4242 /** \brief Policer iclassify operational state response.
4243 @param context - sender context, to match reply w/ request
4244 @param sw_if_index - software interface index
4245 @param table_index - classify table index
4247 define policer_classify_details
4254 /** \brief Create netmap
4255 @param client_index - opaque cookie to identify the sender
4256 @param context - sender context, to match reply w/ request
4257 @param netmap_if_name - interface name
4258 @param hw_addr - interface MAC
4259 @param use_random_hw_addr - use random generated MAC
4260 @param is_pipe - is pipe
4261 @param is_master - 0=slave, 1=master
4263 define netmap_create
4268 u8 netmap_if_name[64];
4270 u8 use_random_hw_addr;
4275 /** \brief Create netmap response
4276 @param context - sender context, to match reply w/ request
4277 @param retval - return value for request
4279 define netmap_create_reply
4285 /** \brief Delete netmap
4286 @param client_index - opaque cookie to identify the sender
4287 @param context - sender context, to match reply w/ request
4288 @param netmap_if_name - interface name
4290 define netmap_delete
4295 u8 netmap_if_name[64];
4298 /** \brief Delete netmap response
4299 @param context - sender context, to match reply w/ request
4300 @param retval - return value for request
4302 define netmap_delete_reply
4308 /** \brief Dump mpls gre tunnel table
4309 @param client_index - opaque cookie to identify the sender
4310 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4312 define mpls_gre_tunnel_dump
4319 /** \brief mpls gre tunnel operational state response
4320 @param tunnel_index - gre tunnel identifier
4321 @param intfc_address - interface ipv4 addr
4322 @param mask_width - interface ipv4 addr mask
4323 @param hw_if_index - interface id
4325 @param tunnel_src - tunnel source ipv4 addr
4326 @param tunnel_dst - tunnel destination ipv4 addr
4327 @param outer_fib_index - gre tunnel identifier
4328 @param encap_index - reference to mpls label table
4329 @param nlabels - number of resolved labels
4330 @param labels - resolved labels
4332 define mpls_gre_tunnel_details
4338 u32 inner_fib_index;
4345 u32 outer_fib_index;
4347 u32 labels[nlabels];
4350 /** \brief Dump mpls eth tunnel table
4351 @param client_index - opaque cookie to identify the sender
4352 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
4354 define mpls_eth_tunnel_dump
4361 /** \brief mpls eth tunnel operational state response
4362 @param tunnel_index - eth tunnel identifier
4363 @param intfc_address - interface ipv4 addr
4364 @param mask_width - interface ipv4 addr mask
4365 @param hw_if_index - interface id
4367 @param tunnel_dst_mac -
4368 @param tx_sw_if_index -
4369 @param encap_index - reference to mpls label table
4370 @param nlabels - number of resolved labels
4371 @param labels - resolved labels
4373 define mpls_eth_tunnel_details
4379 u32 inner_fib_index;
4384 u8 tunnel_dst_mac[6];
4387 u32 labels[nlabels];
4390 /** \brief Dump mpls fib table
4391 @param client_index - opaque cookie to identify the sender
4392 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4394 define mpls_fib_encap_dump
4400 /** \brief mpls fib encap table response
4401 @param fib_index - fib table id
4402 @param dest - destination ipv4 addr
4404 @param entry_index - reference to mpls label table
4405 @param nlabels - number of resolved labels
4406 @param labels - resolved labels
4408 define mpls_fib_encap_details
4417 u32 labels[nlabels];
4420 /** \brief Dump mpls fib decap table
4421 @param client_index - opaque cookie to identify the sender
4422 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4424 define mpls_fib_decap_dump
4430 /** \brief mpls fib decap table response
4431 @param fib_index - fib table id
4432 @param entry_index - reference to mpls label table
4433 @param dest - destination ipv4 addr
4435 @param label - mpls labels
4436 @param rx_table_id - rx fib id
4437 @param tx_table_id - tx fib id
4440 define mpls_fib_decap_details
4454 /** \brief Classify get table IDs request
4455 @param client_index - opaque cookie to identify the sender
4456 @param context - sender context, to match reply w/ request
4458 define classify_table_ids
4464 /** \brief Reply for classify get table IDs request
4465 @param context - sender context which was passed in the request
4466 @param count - number of ids returned in response
4467 @param ids - array of classify table ids
4469 define classify_table_ids_reply
4477 /** \brief Classify table ids by interface index request
4478 @param client_index - opaque cookie to identify the sender
4479 @param context - sender context, to match reply w/ request
4480 @param sw_if_index - index of the interface
4482 define classify_table_by_interface
4489 /** \brief Reply for classify table id by interface index request
4490 @param context - sender context which was passed in the request
4491 @param count - number of ids returned in response
4492 @param sw_if_index - index of the interface
4493 @param l2_table_id - l2 classify table index
4494 @param ip4_table_id - ip4 classify table index
4495 @param ip6_table_id - ip6 classify table index
4497 define classify_table_by_interface_reply
4507 /** \brief Classify table info
4508 @param client_index - opaque cookie to identify the sender
4509 @param context - sender context, to match reply w/ request
4510 @param table_id - classify table index
4512 define classify_table_info
4519 /** \brief Reply for classify table info request
4520 @param context - sender context which was passed in the request
4521 @param count - number of ids returned in response
4522 @param table_id - classify table index
4523 @param nbuckets - number of buckets when adding a table
4524 @param match_n_vectors - number of match vectors
4525 @param skip_n_vectors - number of skip_n_vectors
4526 @param active_sessions - number of sessions (active entries)
4527 @param next_table_index - index of next table
4528 @param miss_next_index - index of miss table
4529 @param mask[] - match mask
4531 define classify_table_info_reply
4537 u32 match_n_vectors;
4539 u32 active_sessions;
4540 u32 next_table_index;
4541 u32 miss_next_index;
4543 u8 mask[mask_length];
4546 /** \brief Classify sessions dump request
4547 @param client_index - opaque cookie to identify the sender
4548 @param context - sender context, to match reply w/ request
4549 @param table_id - classify table index
4551 define classify_session_dump
4558 /** \brief Reply for classify table session dump request
4559 @param context - sender context which was passed in the request
4560 @param count - number of ids returned in response
4561 @param table_id - classify table index
4562 @param hit_next_index - hit_next_index of session
4563 @param opaque_index - for add, opaque_index of session
4564 @param advance - advance value of session
4565 @param match[] - match value for session
4567 define classify_session_details
4576 u8 match[match_length];
4579 /** \brief Configure IPFIX exporter process request
4580 @param client_index - opaque cookie to identify the sender
4581 @param context - sender context, to match reply w/ request
4582 @param collector_address - address of IPFIX collector
4583 @param collector_port - port of IPFIX collector
4584 @param src_address - address of IPFIX exporter
4585 @param vrf_id - VRF / fib table ID
4586 @param path_mtu - Path MTU between exporter and collector
4587 @param template_interval - number of seconds after which to resend template
4588 @param udp_checksum - UDP checksum calculation enable flag
4590 define set_ipfix_exporter
4594 u8 collector_address[16];
4599 u32 template_interval;
4603 /** \brief Reply to IPFIX exporter configure request
4604 @param context - sender context which was passed in the request
4606 define set_ipfix_exporter_reply
4612 /** \brief IPFIX exporter dump request
4613 @param client_index - opaque cookie to identify the sender
4614 @param context - sender context, to match reply w/ request
4616 define ipfix_exporter_dump
4622 /** \brief Reply to IPFIX exporter dump request
4623 @param context - sender context which was passed in the request
4624 @param collector_address - address of IPFIX collector
4625 @param collector_port - port of IPFIX collector
4626 @param src_address - address of IPFIX exporter
4627 @param fib_index - fib table index
4628 @param path_mtu - Path MTU between exporter and collector
4629 @param template_interval - number of seconds after which to resend template
4630 @param udp_checksum - UDP checksum calculation enable flag
4632 define ipfix_exporter_details
4635 u8 collector_address[16];
4640 u32 template_interval;
4644 /** \brief IPFIX classify stream configure request
4645 @param client_index - opaque cookie to identify the sender
4646 @param context - sender context, to match reply w/ request
4647 @param domain_id - domain ID reported in IPFIX messages for classify stream
4648 @param src_port - source port of UDP session for classify stream
4650 define set_ipfix_classify_stream {
4657 /** \brief IPFIX classify stream configure response
4658 @param context - sender context, to match reply w/ request
4659 @param retval - return value for request
4661 define set_ipfix_classify_stream_reply {
4666 /** \brief IPFIX classify stream dump request
4667 @param client_index - opaque cookie to identify the sender
4668 @param context - sender context, to match reply w/ request
4670 define ipfix_classify_stream_dump {
4675 /** \brief Reply to IPFIX classify stream dump request
4676 @param context - sender context, to match reply w/ request
4677 @param domain_id - domain ID reported in IPFIX messages for classify stream
4678 @param src_port - source port of UDP session for classify stream
4680 define ipfix_classify_stream_details {
4686 /** \brief IPFIX add or delete classifier table request
4687 @param client_index - opaque cookie to identify the sender
4688 @param context - sender context, to match reply w/ request
4689 @param table_id - classifier table ID
4690 @param ip_version - version of IP used in the classifier table
4691 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4693 define ipfix_classify_table_add_del {
4698 u8 transport_protocol;
4702 /** \brief IPFIX add classifier table response
4703 @param context - sender context which was passed in the request
4705 define ipfix_classify_table_add_del_reply {
4710 /** \brief IPFIX classify tables dump request
4711 @param client_index - opaque cookie to identify the sender
4712 @param context - sender context, to match reply w/ request
4714 define ipfix_classify_table_dump {
4719 /** \brief Reply to IPFIX classify tables dump request
4720 @param context - sender context, to match reply w/ request
4721 @param table_id - classifier table ID
4722 @param ip_version - version of IP used in the classifier table
4723 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4725 define ipfix_classify_table_details {
4729 u8 transport_protocol;
4732 /** \brief Query relative index via node names
4733 @param client_index - opaque cookie to identify the sender
4734 @param context - sender context, to match reply w/ request
4735 @param node_name - name of node to find relative index from
4736 @param next_name - next node from node_name to find relative index of
4738 define get_next_index
4746 /** \brief Reply for get next node index
4747 @param context - sender context which was passed in the request
4748 @param retval - return value
4749 @param next_index - index of the next_node
4751 define get_next_index_reply
4758 /** \brief PacketGenerator create interface request
4759 @param client_index - opaque cookie to identify the sender
4760 @param context - sender context, to match reply w/ request
4761 @param interface_id - interface index
4763 define pg_create_interface
4770 /** \brief PacketGenerator create interface response
4771 @param context - sender context, to match reply w/ request
4772 @param retval - return value for request
4774 define pg_create_interface_reply
4781 /** \brief PacketGenerator capture packets on given interface request
4782 @param client_index - opaque cookie to identify the sender
4783 @param context - sender context, to match reply w/ request
4784 @param interface_id - pg interface index
4785 @param is_enabled - 1 if enabling streams, 0 if disabling
4786 @param count - number of packets to be captured
4787 @param pcap_file - pacp file name to store captured packets
4796 u32 pcap_name_length;
4797 u8 pcap_file_name[pcap_name_length];
4800 /** \brief PacketGenerator capture packets response
4801 @param context - sender context, to match reply w/ request
4802 @param retval - return value for request
4804 define pg_capture_reply
4810 /** \brief Enable / disable packet generator request
4811 @param client_index - opaque cookie to identify the sender
4812 @param context - sender context, to match reply w/ request
4813 @param is_enabled - 1 if enabling streams, 0 if disabling
4814 @param stream - stream name to be enable/disabled, if not specified handle all streams
4816 define pg_enable_disable
4821 u32 stream_name_length;
4822 u8 stream_name[stream_name_length];
4825 /** \brief Reply for enable / disable packet generator
4826 @param context - returned sender context, to match reply w/ request
4827 @param retval - return code
4829 define pg_enable_disable_reply
4835 /** \brief Configure IP source and L4 port-range check
4836 @param client_index - opaque cookie to identify the sender
4837 @param context - sender context, to match reply w/ request
4838 @param is_ip6 - 1 if source address type is IPv6
4839 @param is_add - 1 if add, 0 if delete
4840 @param mask_length - mask length for address entry
4841 @param address - array of address bytes
4842 @param number_of_ranges - length of low_port and high_port arrays (must match)
4843 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
4844 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
4845 @param vrf_id - fib table/vrf id to associate the source and port-range check with
4846 @note To specify a single port set low_port and high_port entry the same
4848 define ip_source_and_port_range_check_add_del
4856 u8 number_of_ranges;
4862 /** \brief Configure IP source and L4 port-range check reply
4863 @param context - returned sender context, to match reply w/ request
4864 @param retval - return code
4866 define ip_source_and_port_range_check_add_del_reply
4872 /** \brief Set interface source and L4 port-range request
4873 @param client_index - opaque cookie to identify the sender
4874 @param context - sender context, to match reply w/ request
4875 @param interface_id - interface index
4876 @param tcp_vrf_id - VRF associated with source and TCP port-range check
4877 @param udp_vrf_id - VRF associated with source and TCP port-range check
4879 define ip_source_and_port_range_check_interface_add_del
4891 /** \brief Set interface source and L4 port-range response
4892 @param context - sender context, to match reply w/ request
4893 @param retval - return value for request
4895 define ip_source_and_port_range_check_interface_add_del_reply
4901 /** \brief Add / del ipsec gre tunnel request
4902 @param client_index - opaque cookie to identify the sender
4903 @param context - sender context, to match reply w/ request
4904 @param local_sa_id - local SA id
4905 @param remote_sa_id - remote SA id
4906 @param is_add - 1 if adding the tunnel, 0 if deleting
4907 @param src_address - tunnel source address
4908 @param dst_address - tunnel destination address
4910 define ipsec_gre_add_del_tunnel {
4920 /** \brief Reply for add / del ipsec gre tunnel request
4921 @param context - returned sender context, to match reply w/ request
4922 @param retval - return code
4923 @param sw_if_index - software index of the new ipsec gre tunnel
4925 define ipsec_gre_add_del_tunnel_reply {
4931 /** \brief Dump ipsec gre tunnel table
4932 @param client_index - opaque cookie to identify the sender
4933 @param context - sender context, to match reply w/ request
4934 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4936 define ipsec_gre_tunnel_dump {
4942 /** \brief mpls gre tunnel operational state response
4943 @param context - returned sender context, to match reply w/ request
4944 @param sw_if_index - software index of the ipsec gre tunnel
4945 @param local_sa_id - local SA id
4946 @param remote_sa_id - remote SA id
4947 @param src_address - tunnel source address
4948 @param dst_address - tunnel destination address
4950 define ipsec_gre_tunnel_details {
4959 /** \brief Delete sub interface request
4960 @param client_index - opaque cookie to identify the sender
4961 @param context - sender context, to match reply w/ request
4962 @param sw_if_index - sw index of the interface that was created by create_subif
4964 define delete_subif {
4970 /** \brief Delete sub interface response
4971 @param context - sender context, to match reply w/ request
4972 @param retval - return code for the request
4974 define delete_subif_reply {