2 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 This file defines vpe control-plane API messages which are generally
19 called through a shared memory interface.
23 * Note: API placement cleanup in progress
24 * If you're looking for interface APIs, please
25 * see .../vnet/vnet/{interface.api,interface_api.c}
26 * IP APIs: see .../vnet/vnet/ip/{ip.api, ip_api.c}
29 /** \brief Initialize a new tap interface with the given paramters
30 @param client_index - opaque cookie to identify the sender
31 @param context - sender context, to match reply w/ request
32 @param use_random_mac - let the system generate a unique mac address
33 @param tap_name - name to associate with the new interface
34 @param mac_address - mac addr to assign to the interface if use_radom not set
44 u32 custom_dev_instance;
48 /** \brief Reply for tap connect request
49 @param context - returned sender context, to match reply w/ request
50 @param retval - return code
51 @param sw_if_index - software index allocated for the new tap interface
53 define tap_connect_reply
60 /** \brief Modify a tap interface with the given paramters
61 @param client_index - opaque cookie to identify the sender
62 @param context - sender context, to match reply w/ request
63 @param sw_if_index - interface index of existing tap interface
64 @param use_random_mac - let the system generate a unique mac address
65 @param tap_name - name to associate with the new interface
66 @param mac_address - mac addr to assign to the interface if use_radom not set
77 u32 custom_dev_instance;
80 /** \brief Reply for tap modify request
81 @param context - returned sender context, to match reply w/ request
82 @param retval - return code
83 @param sw_if_index - software index if the modified tap interface
85 define tap_modify_reply
92 /** \brief Delete tap interface
93 @param client_index - opaque cookie to identify the sender
94 @param context - sender context, to match reply w/ request
95 @param sw_if_index - interface index of existing tap interface
104 /** \brief Reply for tap delete request
105 @param context - returned sender context, to match reply w/ request
106 @param retval - return code
108 define tap_delete_reply
114 /** \brief Dump tap interfaces request */
115 define sw_interface_tap_dump
121 /** \brief Reply for tap dump request
122 @param sw_if_index - software index of tap interface
123 @param dev_name - Linux tap device name
125 define sw_interface_tap_details
132 /** \brief Create a new subinterface with the given vlan id
133 @param client_index - opaque cookie to identify the sender
134 @param context - sender context, to match reply w/ request
135 @param sw_if_index - software index of the new vlan's parent interface
136 @param vlan_id - vlan tag of the new interface
138 define create_vlan_subif
146 /** \brief Reply for the vlan subinterface create request
147 @param context - returned sender context, to match reply w/ request
148 @param retval - return code
149 @param sw_if_index - software index allocated for the new subinterface
151 define create_vlan_subif_reply
158 /** \brief Enable or Disable MPLS on and interface
159 @param client_index - opaque cookie to identify the sender
160 @param context - sender context, to match reply w/ request
161 @param sw_if_index - index of the interface
162 @param enable - if non-zero enable, else disable
164 define sw_interface_set_mpls_enable
172 /** \brief Reply for MPLS state on an interface
173 @param context - returned sender context, to match reply w/ request
174 @param retval - return code
176 define sw_interface_set_mpls_enable_reply
182 /** \brief MPLS Route Add / del route
183 @param client_index - opaque cookie to identify the sender
184 @param context - sender context, to match reply w/ request
185 @param mr_label - The MPLS label value
186 @param mr_eos - The End of stack bit
187 @param mr_table_id - The MPLS table-id the route is added in
188 @param mr_classify_table_index - If this is a classify route,
189 this is the classify table index
190 @param mr_create_table_if_needed - If the MPLS or IP tables do not exist,
192 @param mr_is_add - Is this a route add or delete
193 @param mr_is_classify - Is this route result a classify
194 @param mr_is_multipath - Is this route update a multipath - i.e. is this
195 a path addition to an existing route
196 @param mr_is_resolve_host - Recurse resolution constraint via a host prefix
197 @param mr_is_resolve_attached - Recurse resolution constraint via attached prefix
198 @param mr_next_hop_proto_is_ip4 - The next-hop is IPV4
199 @param mr_next_hop_weight - The weight, for UCMP
200 @param mr_next_hop[16] - the nextop address
201 @param mr_next_hop_sw_if_index - the next-hop SW interface
202 @param mr_next_hop_table_id - the next-hop table-id (if appropriate)
203 @param mr_next_hop_n_out_labels - the number of labels in the label stack
204 @param mr_next_hop_out_label_stack - the next-hop output label stack, outer most first
205 @param next_hop_via_label - The next-hop is a resolved via a local label
207 define mpls_route_add_del
214 u32 mr_classify_table_index;
215 u8 mr_create_table_if_needed;
219 u8 mr_is_resolve_host;
220 u8 mr_is_resolve_attached;
221 u8 mr_next_hop_proto_is_ip4;
222 u8 mr_next_hop_weight;
224 u8 mr_next_hop_n_out_labels;
225 u32 mr_next_hop_sw_if_index;
226 u32 mr_next_hop_table_id;
227 u32 mr_next_hop_via_label;
228 u32 mr_next_hop_out_label_stack[mr_next_hop_n_out_labels];
231 /** \brief Reply for MPLS route add / del request
232 @param context - returned sender context, to match reply w/ request
233 @param retval - return code
235 define mpls_route_add_del_reply
241 /** \brief Dump MPLS fib table
242 @param client_index - opaque cookie to identify the sender
251 @param sw_if_index - index of the interface
252 @param weight - The weight, for UCMP
253 @param is_local - local if non-zero, else remote
254 @param is_drop - Drop the packet
255 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
256 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
257 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
258 @param next_hop[16] - the next hop address
260 WARNING: this type is replicated, pending cleanup completion
263 typeonly manual_print manual_endian define fib_path2
275 /** \brief mpls FIB table response
276 @param table_id - MPLS fib table id
277 @param s_bit - End-of-stack bit
278 @param label - MPLS label value
279 @param count - the number of fib_path in path
280 @param path - array of of fib_path structures
282 manual_endian manual_print define mpls_fib_details
289 vl_api_fib_path2_t path[count];
292 /** \brief Bind/Unbind an MPLS local label to an IP prefix. i.e. create
293 a per-prefix label entry.
294 @param client_index - opaque cookie to identify the sender
295 @param context - sender context, to match reply w/ request
296 @param mb_mpls_table_id - The MPLS table-id the MPLS entry will be added in
297 @param mb_label - The MPLS label value to bind
298 @param mb_ip_table_id - The IP table-id of the IP prefix to bind to.
299 @param mb_create_table_if_needed - Create either/both tables if required.
300 @param mb_is_bind - Bind or unbind
301 @param mb_is_ip4 - The prefix to bind to is IPv4
302 @param mb_address_length - Length of IP prefix
303 @param mb_address[16] - IP prefix/
305 define mpls_ip_bind_unbind
309 u32 mb_mpls_table_id;
312 u8 mb_create_table_if_needed;
315 u8 mb_address_length;
319 /** \brief Reply for MPLS IP bind/unbind request
320 @param context - returned sender context, to match reply w/ request
321 @param retval - return code
323 define mpls_ip_bind_unbind_reply
329 /** \brief MPLS tunnel Add / del route
330 @param client_index - opaque cookie to identify the sender
331 @param context - sender context, to match reply w/ request
332 @param mt_is_add - Is this a route add or delete
333 @param mt_sw_if_index - The SW interface index of the tunnel to delete
334 @param mt_next_hop_proto_is_ip4 - The next-hop is IPV4
335 @param mt_next_hop_weight - The weight, for UCMP
336 @param mt_next_hop[16] - the nextop address
337 @param mt_next_hop_sw_if_index - the next-hop SW interface
338 @param mt_next_hop_table_id - the next-hop table-id (if appropriate)
339 @param mt_next_hop_n_out_labels - the number of next-hop output labels
340 @param mt_next_hop_out_label_stack - the next-hop output label stack, outer most first
342 define mpls_tunnel_add_del
349 u8 mt_next_hop_proto_is_ip4;
350 u8 mt_next_hop_weight;
352 u8 mt_next_hop_n_out_labels;
353 u32 mt_next_hop_sw_if_index;
354 u32 mt_next_hop_table_id;
355 u32 mt_next_hop_out_label_stack[mt_next_hop_n_out_labels];
358 /** \brief Reply for MPLS tunnel add / del request
359 @param context - returned sender context, to match reply w/ request
360 @param retval - return code
361 @param sw_if_index - SW interface index of the tunnel created
363 define mpls_tunnel_add_del_reply
370 /** \brief Dump mpls eth tunnel table
371 @param client_index - opaque cookie to identify the sender
372 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
374 define mpls_tunnel_dump
381 /** \brief mpls eth tunnel operational state response
382 @param tunnel_index - eth tunnel identifier
383 @param intfc_address - interface ipv4 addr
384 @param mask_width - interface ipv4 addr mask
385 @param hw_if_index - interface id
387 @param tunnel_dst_mac -
388 @param tx_sw_if_index -
389 @param encap_index - reference to mpls label table
390 @param nlabels - number of resolved labels
391 @param labels - resolved labels
393 define mpls_tunnel_details
399 u8 mt_next_hop_proto_is_ip4;
401 u32 mt_next_hop_sw_if_index;
402 u32 mt_next_hop_table_id;
403 u32 mt_next_hop_n_labels;
404 u32 mt_next_hop_out_labels[mt_next_hop_n_labels];
407 /** \brief Proxy ARP add / del request
408 @param client_index - opaque cookie to identify the sender
409 @param context - sender context, to match reply w/ request
410 @param vrf_id - VRF / Fib table ID
411 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
412 @param low_address[4] - Low address of the Proxy ARP range
413 @param hi_address[4] - High address of the Proxy ARP range
415 define proxy_arp_add_del
425 /** \brief Reply for proxy arp add / del request
426 @param context - returned sender context, to match reply w/ request
427 @param retval - return code
429 define proxy_arp_add_del_reply
435 /** \brief Proxy ARP add / del request
436 @param client_index - opaque cookie to identify the sender
437 @param context - sender context, to match reply w/ request
438 @param sw_if_index - Which interface to enable / disable Proxy Arp on
439 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
441 define proxy_arp_intfc_enable_disable
446 /* 1 = on, 0 = off */
450 /** \brief Reply for Proxy ARP interface enable / disable request
451 @param context - returned sender context, to match reply w/ request
452 @param retval - return code
454 define proxy_arp_intfc_enable_disable_reply
460 /** \brief Reset VRF (remove all routes etc) request
461 @param client_index - opaque cookie to identify the sender
462 @param context - sender context, to match reply w/ request
463 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
464 @param vrf_id - ID of th FIB table / VRF to reset
474 /** \brief Reply for Reset VRF request
475 @param context - returned sender context, to match reply w/ request
476 @param retval - return code
478 define reset_vrf_reply
484 /** \brief Is Address Reachable request - DISABLED
485 @param client_index - opaque cookie to identify the sender
486 @param context - sender context, to match reply w/ request
487 @param next_hop_sw_if_index - index of interface used to get to next hop
488 @param is_ipv6 - 1 for IPv6, 0 for IPv4
489 @param is_error - address not found or does not match intf
490 @param address[] - Address in question
492 define is_address_reachable
494 u32 client_index; /* (api_main_t *) am->my_client_index */
496 u32 next_hop_sw_if_index;
497 u8 is_known; /* on reply, this is the answer */
499 u8 is_error; /* address not found or does not match intf */
503 /** \brief Want Stats, register for stats updates
504 @param client_index - opaque cookie to identify the sender
505 @param context - sender context, to match reply w/ request
506 @param enable_disable - 1 = enable stats, 0 = disable
507 @param pid - pid of process requesting stats updates
517 /** \brief Reply for Want Stats request
518 @param context - returned sender context, to match reply w/ request
519 @param retval - return code
521 define want_stats_reply
527 typeonly manual_print manual_endian define ip4_fib_counter
535 manual_print manual_endian define vnet_ip4_fib_counters
539 vl_api_ip4_fib_counter_t c[count];
542 typeonly manual_print manual_endian define ip6_fib_counter
550 manual_print manual_endian define vnet_ip6_fib_counters
554 vl_api_ip6_fib_counter_t c[count];
557 /** \brief Request for a single block of summary stats
558 @param client_index - opaque cookie to identify the sender
559 @param context - sender context, to match reply w/ request
561 define vnet_get_summary_stats
567 /** \brief Reply for vnet_get_summary_stats request
568 @param context - sender context, to match reply w/ request
569 @param retval - return code for request
574 define vnet_summary_stats_reply
583 /** \brief OAM event structure
584 @param dst_address[] -
593 /** \brief Want OAM events request
594 @param client_index - opaque cookie to identify the sender
595 @param context - sender context, to match reply w/ request
596 @param enable_disable- enable if non-zero, else disable
597 @param pid - pid of the requesting process
599 define want_oam_events
607 /** \brief Want OAM events response
608 @param context - sender context, to match reply w/ request
609 @param retval - return code for the want oam stats request
611 define want_oam_events_reply
617 /** \brief OAM add / del target request
618 @param client_index - opaque cookie to identify the sender
619 @param context - sender context, to match reply w/ request
620 @param vrf_id - vrf_id of the target
621 @param src_address[] - source address to use for the updates
622 @param dst_address[] - destination address of the target
623 @param is_add - add target if non-zero, else delete
635 /** \brief OAM add / del target response
636 @param context - sender context, to match reply w/ request
637 @param retval - return code of the request
639 define oam_add_del_reply
645 /** \brief Reset fib table request
646 @param client_index - opaque cookie to identify the sender
647 @param context - sender context, to match reply w/ request
648 @param vrf_id - vrf/table id of the fib table to reset
649 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
659 /** \brief Reset fib response
660 @param context - sender context, to match reply w/ request
661 @param retval - return code for the reset bfib request
663 define reset_fib_reply
669 /** \brief DHCP Proxy config add / del request
670 @param client_index - opaque cookie to identify the sender
671 @param context - sender context, to match reply w/ request
672 @param vrf_id - vrf id
673 @param if_ipv6 - ipv6 if non-zero, else ipv4
674 @param is_add - add the config if non-zero, else delete
675 @param insert_circuit_id - option82 suboption 1 fib number
676 @param dhcp_server[] - server address
677 @param dhcp_src_address[] - <fix this, need details>
679 define dhcp_proxy_config
686 u8 insert_circuit_id;
688 u8 dhcp_src_address[16];
691 /** \brief DHCP Proxy config response
692 @param context - sender context, to match reply w/ request
693 @param retval - return code for the request
695 define dhcp_proxy_config_reply
701 /** \brief DHCP Proxy set / unset vss request
702 @param client_index - opaque cookie to identify the sender
703 @param context - sender context, to match reply w/ request
704 @param tbl_id - table id
705 @param oui - first part of vpn id
706 @param fib_id - second part of vpn id
707 @param is_ipv6 - ip6 if non-zero, else ip4
708 @param is_add - set vss if non-zero, else delete
710 define dhcp_proxy_set_vss
721 /** \brief DHCP proxy set / unset vss response
722 @param context - sender context, to match reply w/ request
723 @param retval - return code for the request
725 define dhcp_proxy_set_vss_reply
731 /** \brief Create loopback interface request
732 @param client_index - opaque cookie to identify the sender
733 @param context - sender context, to match reply w/ request
734 @param mac_address - mac addr to assign to the interface if none-zero
736 define create_loopback
743 /** \brief Create loopback interface response
744 @param context - sender context, to match reply w/ request
745 @param sw_if_index - sw index of the interface that was created
746 @param retval - return code for the request
748 define create_loopback_reply
755 /** \brief Delete loopback interface request
756 @param client_index - opaque cookie to identify the sender
757 @param context - sender context, to match reply w/ request
758 @param sw_if_index - sw index of the interface that was created
760 define delete_loopback
767 /** \brief Delete loopback interface response
768 @param context - sender context, to match reply w/ request
769 @param retval - return code for the request
771 define delete_loopback_reply
777 /** \brief Control ping from client to api server request
778 @param client_index - opaque cookie to identify the sender
779 @param context - sender context, to match reply w/ request
787 /** \brief Control ping from the client to the server response
788 @param client_index - opaque cookie to identify the sender
789 @param context - sender context, to match reply w/ request
790 @param retval - return code for the request
791 @param vpe_pid - the pid of the vpe, returned by the server
793 define control_ping_reply
801 /** \brief Process a vpe parser cli string request
802 @param client_index - opaque cookie to identify the sender
803 @param context - sender context, to match reply w/ request
804 @param cmd_in_shmem - pointer to cli command string
820 /** \brief vpe parser cli string response
821 @param context - sender context, to match reply w/ request
822 @param retval - return code for request
823 @param reply_in_shmem - Reply string from cli processing if any
831 define cli_inband_reply
839 /** \brief Set max allowed ARP or ip6 neighbor entries request
840 @param client_index - opaque cookie to identify the sender
841 @param context - sender context, to match reply w/ request
842 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
843 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
845 define set_arp_neighbor_limit
850 u32 arp_neighbor_limit;
853 /** \brief Set max allowed ARP or ip6 neighbor entries response
854 @param context - sender context, to match reply w/ request
855 @param retval - return code for request
857 define set_arp_neighbor_limit_reply
863 /** \brief L2 interface patch add / del request
864 @param client_index - opaque cookie to identify the sender
865 @param context - sender context, to match reply w/ request
866 @param rx_sw_if_index - receive side interface
867 @param tx_sw_if_index - transmit side interface
868 @param is_add - if non-zero set up the interface patch, else remove it
870 define l2_patch_add_del
879 /** \brief L2 interface patch add / del response
880 @param context - sender context, to match reply w/ request
881 @param retval - return code for the request
883 define l2_patch_add_del_reply
889 /** \brief IPv6 segment routing tunnel add / del request
890 @param client_index - opaque cookie to identify the sender
891 @param context - sender context, to match reply w/ request
892 @param is_add - add the tunnel if non-zero, else delete it
893 @param name[] - tunnel name (len. 64)
894 @param src_address[] -
895 @param dst_address[] -
896 @param dst_mask_width -
897 @param inner_vrf_id -
898 @param outer_vrf_id -
899 @param flags_net_byte_order -
902 @param segs_and_tags[] -
903 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
905 define sr_tunnel_add_del
916 u16 flags_net_byte_order;
923 /** \brief IPv6 segment routing tunnel add / del response
924 @param context - sender context, to match reply w/ request
925 @param retval - return value for request
927 define sr_tunnel_add_del_reply
933 /** \brief IPv6 segment routing policy add / del request
934 @param client_index - opaque cookie to identify the sender
935 @param context - sender context, to match reply w/ request
936 @param is_add - add the tunnel if non-zero, else delete it
937 @param name[] - policy name (len. 64)
938 @param tunnel_names[] -
940 define sr_policy_add_del
949 /** \brief IPv6 segment routing policy add / del response
950 @param context - sender context, to match reply w/ request
951 @param retval - return value for request
953 define sr_policy_add_del_reply
959 /** \brief IPv6 segment routing multicast map to policy add / del request
960 @param client_index - opaque cookie to identify the sender
961 @param context - sender context, to match reply w/ request
962 @param is_add - add the tunnel if non-zero, else delete it
963 @param multicast_address[] - IP6 multicast address
964 @param policy_name[] = policy name (len.64)
966 define sr_multicast_map_add_del
971 u8 multicast_address[16];
975 /** \brief IPv6 segment routing multicast map to policy add / del response
976 @param context - sender context, to match reply w/ request
977 @param retval - return value for request
979 define sr_multicast_map_add_del_reply
985 /** \brief Interface set vpath request
986 @param client_index - opaque cookie to identify the sender
987 @param context - sender context, to match reply w/ request
988 @param sw_if_index - interface used to reach neighbor
989 @param enable - if non-zero enable, else disable
991 define sw_interface_set_vpath
999 /** \brief Interface set vpath response
1000 @param context - sender context, to match reply w/ request
1001 @param retval - return code for the request
1003 define sw_interface_set_vpath_reply
1009 /** \brief Interface set vxlan-bypass request
1010 @param client_index - opaque cookie to identify the sender
1011 @param context - sender context, to match reply w/ request
1012 @param sw_if_index - interface used to reach neighbor
1013 @param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
1014 @param enable - if non-zero enable, else disable
1016 define sw_interface_set_vxlan_bypass
1025 /** \brief Interface set vxlan-bypass response
1026 @param context - sender context, to match reply w/ request
1027 @param retval - return code for the request
1029 define sw_interface_set_vxlan_bypass_reply
1035 /** \brief Set L2 XConnect between two interfaces request
1036 @param client_index - opaque cookie to identify the sender
1037 @param context - sender context, to match reply w/ request
1038 @param rx_sw_if_index - Receive interface index
1039 @param tx_sw_if_index - Transmit interface index
1040 @param enable - enable xconnect if not 0, else set to L3 mode
1042 define sw_interface_set_l2_xconnect
1051 /** \brief Set L2 XConnect response
1052 @param context - sender context, to match reply w/ request
1053 @param retval - L2 XConnect request return code
1055 define sw_interface_set_l2_xconnect_reply
1061 /** \brief Interface bridge mode request
1062 @param client_index - opaque cookie to identify the sender
1063 @param context - sender context, to match reply w/ request
1064 @param rx_sw_if_index - the interface
1065 @param bd_id - bridge domain id
1066 @param bvi - Setup interface as a bvi, bridge mode only
1067 @param shg - Shared horizon group, for bridge mode only
1068 @param enable - Enable beige mode if not 0, else set to L3 mode
1070 define sw_interface_set_l2_bridge
1081 /** \brief Interface bridge mode response
1082 @param context - sender context, to match reply w/ request
1083 @param retval - Bridge mode request return code
1085 define sw_interface_set_l2_bridge_reply
1091 /** \brief L2 FIB add entry request
1092 @param client_index - opaque cookie to identify the sender
1093 @param context - sender context, to match reply w/ request
1094 @param mac - the entry's mac address
1095 @param bd_id - the entry's bridge domain id
1096 @param sw_if_index - the interface
1097 @param is_add - If non zero add the entry, else delete it
1101 define l2fib_add_del
1114 /** \brief L2 FIB add entry response
1115 @param context - sender context, to match reply w/ request
1116 @param retval - return code for the add l2fib entry request
1118 define l2fib_add_del_reply
1124 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1125 @param client_index - opaque cookie to identify the sender
1126 @param context - sender context, to match reply w/ request
1127 @param sw_if_index - interface
1128 @param is_set - if non-zero, set the bits, else clear them
1129 @param feature_bitmap - non-zero bits to set or clear
1140 /** \brief Set L2 bits response
1141 @param context - sender context, to match reply w/ request
1142 @param retval - return code for the set l2 bits request
1144 define l2_flags_reply
1148 u32 resulting_feature_bitmap;
1151 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1152 L2_UU_FLOOD, or L2_ARP_TERM) request
1153 @param client_index - opaque cookie to identify the sender
1154 @param context - sender context, to match reply w/ request
1155 @param bd_id - the bridge domain to set the flags for
1156 @param is_set - if non-zero, set the flags, else clear them
1157 @param feature_bitmap - bits that are non-zero to set or clear
1168 /** \brief Set bridge flags response
1169 @param context - sender context, to match reply w/ request
1170 @param retval - return code for the set bridge flags request
1171 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1173 define bridge_flags_reply
1177 u32 resulting_feature_bitmap;
1180 /** \brief Set bridge domain ip to mac entry request
1181 @param client_index - opaque cookie to identify the sender
1182 @param context - sender context, to match reply w/ request
1183 @param bd_id - the bridge domain to set the flags for
1184 @param is_add - if non-zero, add the entry, else clear it
1185 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1186 @param mac_address - MAC address
1189 define bd_ip_mac_add_del
1200 /** \brief Set bridge domain ip to mac entry response
1201 @param context - sender context, to match reply w/ request
1202 @param retval - return code for the set bridge flags request
1204 define bd_ip_mac_add_del_reply
1210 /** \brief Add/Delete classification table request
1211 @param client_index - opaque cookie to identify the sender
1212 @param context - sender context, to match reply w/ request
1213 @param is_add- if non-zero add the table, else delete it
1214 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1215 @param nbuckets - number of buckets when adding a table
1216 @param memory_size - memory size when adding a table
1217 @param match_n_vectors - number of match vectors
1218 @param next_table_index - index of next table
1219 @param miss_next_index - index of miss table
1220 @param current_data_flag - option to use current node's packet payload
1221 as the starting point from where packets are classified,
1222 This option is only valid for L2/L3 input ACL for now.
1223 0: by default, classify data from the buffer's start location
1224 1: classify packets from VPP node’s current data pointer
1225 @param current_data_offset - a signed value to shift the start location of
1226 the packet to be classified
1227 For example, if input IP ACL node is used, L2 header’s first byte
1228 can be accessible by configuring current_data_offset to -14
1229 if there is no vlan tag.
1230 This is valid only if current_data_flag is set to 1.
1231 @param mask[] - match mask
1233 define classify_add_del_table
1242 u32 match_n_vectors;
1243 u32 next_table_index;
1244 u32 miss_next_index;
1245 u32 current_data_flag;
1246 i32 current_data_offset;
1250 /** \brief Add/Delete classification table response
1251 @param context - sender context, to match reply w/ request
1252 @param retval - return code for the table add/del requst
1253 @param new_table_index - for add, returned index of the new table
1254 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1255 @param match_n_vectors -for add, returned value of match_n_vectors in table
1257 define classify_add_del_table_reply
1261 u32 new_table_index;
1263 u32 match_n_vectors;
1266 /** \brief Classify add / del session request
1267 @param client_index - opaque cookie to identify the sender
1268 @param context - sender context, to match reply w/ request
1269 @param is_add - add session if non-zero, else delete
1270 @param table_index - index of the table to add/del the session, required
1271 @param hit_next_index - for add, hit_next_index of new session, required
1272 @param opaque_index - for add, opaque_index of new session
1273 @param advance -for add, advance value for session
1275 0: no action (by default)
1276 metadata is not used.
1277 1: Classified IP packets will be looked up from the
1278 specified ipv4 fib table (configured by metadata as VRF id).
1279 Only valid for L3 input ACL node
1280 2: Classified IP packets will be looked up from the
1281 specified ipv6 fib table (configured by metadata as VRF id).
1282 Only valid for L3 input ACL node
1283 @param metadata - valid only if action != 0
1284 VRF id if action is 1 or 2.
1285 @param match[] - for add, match value for session, required
1287 define classify_add_del_session
1301 /** \brief Classify add / del session response
1302 @param context - sender context, to match reply w/ request
1303 @param retval - return code for the add/del session request
1305 define classify_add_del_session_reply
1311 /** \brief Set/unset the classification table for an interface request
1312 @param client_index - opaque cookie to identify the sender
1313 @param context - sender context, to match reply w/ request
1314 @param is_ipv6 - ipv6 if non-zero, else ipv4
1315 @param sw_if_index - interface to associate with the table
1316 @param table_index - index of the table, if ~0 unset the table
1318 define classify_set_interface_ip_table
1324 u32 table_index; /* ~0 => off */
1327 /** \brief Set/unset interface classification table response
1328 @param context - sender context, to match reply w/ request
1329 @param retval - return code
1331 define classify_set_interface_ip_table_reply
1337 /** \brief Set/unset l2 classification tables for an interface request
1338 @param client_index - opaque cookie to identify the sender
1339 @param context - sender context, to match reply w/ request
1340 @param sw_if_index - interface to set/unset tables for
1341 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1342 @param ip6_table_index - ip6 index
1343 @param other_table_index - other index
1345 define classify_set_interface_l2_tables
1351 u32 ip4_table_index;
1352 u32 ip6_table_index;
1353 u32 other_table_index;
1357 /** \brief Set/unset l2 classification tables for an interface response
1358 @param context - sender context, to match reply w/ request
1359 @param retval - return code for the request
1361 define classify_set_interface_l2_tables_reply
1367 /** \brief Get node index using name request
1368 @param client_index - opaque cookie to identify the sender
1369 @param context - sender context, to match reply w/ request
1370 @param node_name[] - name of the node
1372 define get_node_index
1379 /** \brief Get node index using name request
1380 @param context - sender context, to match reply w/ request
1381 @param retval - return code for the request
1382 @param node_index - index of the desired node if found, else ~0
1384 define get_node_index_reply
1391 /** \brief Set the next node for a given node request
1392 @param client_index - opaque cookie to identify the sender
1393 @param context - sender context, to match reply w/ request
1394 @param node_name[] - node to add the next node to
1395 @param next_name[] - node to add as the next node
1397 define add_node_next
1405 /** \brief IP Set the next node for a given node response
1406 @param context - sender context, to match reply w/ request
1407 @param retval - return code for the add next node request
1408 @param next_index - the index of the next node if success, else ~0
1410 define add_node_next_reply
1417 /** \brief DHCP Proxy config 2 add / del request
1418 @param client_index - opaque cookie to identify the sender
1419 @param context - sender context, to match reply w/ request
1420 @param rx_vrf_id - receive vrf id
1421 @param server_vrf_id - server vrf id
1422 @param if_ipv6 - ipv6 if non-zero, else ipv4
1423 @param is_add - add the config if non-zero, else delete
1424 @param insert_circuit_id - option82 suboption 1 fib number
1425 @param dhcp_server[] - server address
1426 @param dhcp_src_address[] - <fix this, need details>
1428 define dhcp_proxy_config_2
1436 u8 insert_circuit_id;
1438 u8 dhcp_src_address[16];
1441 /** \brief DHCP Proxy config 2 add / del response
1442 @param context - sender context, to match reply w/ request
1443 @param retval - return code for request
1445 define dhcp_proxy_config_2_reply
1451 /** \brief l2tpv3 tunnel interface create request
1452 @param client_index - opaque cookie to identify the sender
1453 @param context - sender context, to match reply w/ request
1454 @param client_address - remote client tunnel ip address
1455 @param client_address - local tunnel ip address
1456 @param is_ipv6 - ipv6 if non-zero, else ipv4
1457 @param local_session_id - local tunnel session id
1458 @param remote_session_id - remote tunnel session id
1459 @param local_cookie - local tunnel cookie
1460 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1461 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1463 define l2tpv3_create_tunnel
1467 u8 client_address[16];
1470 u32 local_session_id;
1471 u32 remote_session_id;
1474 u8 l2_sublayer_present;
1478 /** \brief l2tpv3 tunnel interface create response
1479 @param context - sender context, to match reply w/ request
1480 @param retval - return code for the request
1481 @param sw_if_index - index of the new tunnel interface
1483 define l2tpv3_create_tunnel_reply
1490 define l2tpv3_set_tunnel_cookies
1495 u64 new_local_cookie;
1496 u64 new_remote_cookie;
1499 /** \brief L2TP tunnel set cookies response
1500 @param context - sender context, to match reply w/ request
1501 @param retval - return code for the request
1503 define l2tpv3_set_tunnel_cookies_reply
1509 define sw_if_l2tpv3_tunnel_details
1513 u8 interface_name[64];
1514 u8 client_address[16];
1516 u32 local_session_id;
1517 u32 remote_session_id;
1518 u64 local_cookie[2];
1520 u8 l2_sublayer_present;
1523 define sw_if_l2tpv3_tunnel_dump
1529 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1530 @param client_index - opaque cookie to identify the sender
1531 @param context - sender context, to match reply w/ request
1533 define l2_fib_clear_table
1539 /** \brief L2 fib clear table response
1540 @param context - sender context, to match reply w/ request
1541 @param retval - return code for the request
1543 define l2_fib_clear_table_reply
1549 /** \brief L2 interface ethernet flow point filtering enable/disable request
1550 @param client_index - opaque cookie to identify the sender
1551 @param context - sender context, to match reply w/ request
1552 @param sw_if_index - interface to enable/disable filtering on
1553 @param enable_disable - if non-zero enable filtering, else disable
1555 define l2_interface_efp_filter
1563 /** \brief L2 interface ethernet flow point filtering response
1564 @param context - sender context, to match reply w/ request
1565 @param retval - return code for the request
1567 define l2_interface_efp_filter_reply
1573 define l2tpv3_interface_enable_disable
1581 define l2tpv3_interface_enable_disable_reply
1587 define l2tpv3_set_lookup_key
1591 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1595 define l2tpv3_set_lookup_key_reply
1601 define vxlan_add_del_tunnel
1609 u32 mcast_sw_if_index;
1611 u32 decap_next_index;
1615 define vxlan_add_del_tunnel_reply
1622 define vxlan_tunnel_dump
1629 define vxlan_tunnel_details
1635 u32 mcast_sw_if_index;
1637 u32 decap_next_index;
1642 define gre_add_del_tunnel
1654 define gre_add_del_tunnel_reply
1661 define gre_tunnel_dump
1668 define gre_tunnel_details
1679 /** \brief L2 interface vlan tag rewrite configure request
1680 @param client_index - opaque cookie to identify the sender
1681 @param context - sender context, to match reply w/ request
1682 @param sw_if_index - interface the operation is applied to
1683 @param vtr_op - Choose from l2_vtr_op_t enum values
1684 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1685 @param tag1 - Needed for any push or translate vtr op
1686 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1688 define l2_interface_vlan_tag_rewrite
1694 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1695 u32 tag1; // first pushed tag
1696 u32 tag2; // second pushed tag
1699 /** \brief L2 interface vlan tag rewrite response
1700 @param context - sender context, to match reply w/ request
1701 @param retval - return code for the request
1703 define l2_interface_vlan_tag_rewrite_reply
1709 /** \brief vhost-user interface create request
1710 @param client_index - opaque cookie to identify the sender
1711 @param is_server - our side is socket server
1712 @param sock_filename - unix socket filename, used to speak with frontend
1713 @param use_custom_mac - enable or disable the use of the provided hardware address
1714 @param mac_address - hardware address to use if 'use_custom_mac' is set
1716 define create_vhost_user_if
1721 u8 sock_filename[256];
1723 u32 custom_dev_instance;
1729 /** \brief vhost-user interface create response
1730 @param context - sender context, to match reply w/ request
1731 @param retval - return code for the request
1732 @param sw_if_index - interface the operation is applied to
1734 define create_vhost_user_if_reply
1741 /** \brief vhost-user interface modify request
1742 @param client_index - opaque cookie to identify the sender
1743 @param is_server - our side is socket server
1744 @param sock_filename - unix socket filename, used to speak with frontend
1746 define modify_vhost_user_if
1752 u8 sock_filename[256];
1754 u32 custom_dev_instance;
1757 /** \brief vhost-user interface modify response
1758 @param context - sender context, to match reply w/ request
1759 @param retval - return code for the request
1761 define modify_vhost_user_if_reply
1767 /** \brief vhost-user interface delete request
1768 @param client_index - opaque cookie to identify the sender
1770 define delete_vhost_user_if
1777 /** \brief vhost-user interface delete response
1778 @param context - sender context, to match reply w/ request
1779 @param retval - return code for the request
1781 define delete_vhost_user_if_reply
1794 /* These fields map directly onto the subif template */
1798 u8 dot1ad; // 0 = dot1q, 1=dot1ad
1801 u8 outer_vlan_id_any;
1802 u8 inner_vlan_id_any;
1807 define create_subif_reply
1814 /** \brief show version
1815 @param client_index - opaque cookie to identify the sender
1816 @param context - sender context, to match reply w/ request
1824 /** \brief show version response
1825 @param context - sender context, to match reply w/ request
1826 @param retval - return code for the request
1827 @param program - name of the program (vpe)
1828 @param version - version of the program
1829 @param build_directory - root of the workspace where the program was built
1831 define show_version_reply
1838 u8 build_directory[256];
1841 /** \brief Vhost-user interface details structure (fix this)
1842 @param sw_if_index - index of the interface
1843 @param interface_name - name of interface
1844 @param virtio_net_hdr_sz - net header size
1845 @param features - interface features
1846 @param is_server - vhost-user server socket
1847 @param sock_filename - socket filename
1848 @param num_regions - number of used memory regions
1850 define sw_interface_vhost_user_details
1854 u8 interface_name[64];
1855 u32 virtio_net_hdr_sz;
1858 u8 sock_filename[256];
1864 define sw_interface_vhost_user_dump
1870 /** \brief l2 fib table entry structure
1871 @param bd_id - the l2 fib / bridge domain table id
1872 @param mac - the entry's mac address
1873 @param sw_if_index - index of the interface
1874 @param static_mac - the entry is statically configured.
1875 @param filter_mac - the entry is a mac filter entry.
1876 @param bvi_mac - the mac address is a bridge virtual interface
1878 define l2_fib_table_entry
1889 /** \brief Dump l2 fib (aka bridge domain) table
1890 @param client_index - opaque cookie to identify the sender
1891 @param bd_id - the l2 fib / bridge domain table identifier
1893 define l2_fib_table_dump
1900 define vxlan_gpe_add_del_tunnel
1914 define vxlan_gpe_add_del_tunnel_reply
1921 define vxlan_gpe_tunnel_dump
1928 define vxlan_gpe_tunnel_details
1941 /** \brief add or delete locator_set
1942 @param client_index - opaque cookie to identify the sender
1943 @param context - sender context, to match reply w/ request
1944 @param is_add - add address if non-zero, else delete
1945 @param locator_set_name - locator name
1946 @param locator_num - number of locators
1947 @param locators - LISP locator records
1948 Structure of one locator record is as follows:
1956 define lisp_add_del_locator_set
1961 u8 locator_set_name[64];
1966 /** \brief Reply for locator_set add/del
1967 @param context - returned sender context, to match reply w/ request
1968 @param retval - return code
1969 @param ls_index - locator set index
1971 define lisp_add_del_locator_set_reply
1978 /** \brief add or delete locator for locator_set
1979 @param client_index - opaque cookie to identify the sender
1980 @param context - sender context, to match reply w/ request
1981 @param is_add - add address if non-zero, else delete
1982 @param locator_set_name - name of locator_set to add/del locator
1983 @param sw_if_index - index of the interface
1984 @param priority - priority of the lisp locator
1985 @param weight - weight of the lisp locator
1987 define lisp_add_del_locator
1992 u8 locator_set_name[64];
1998 /** \brief Reply for locator add/del
1999 @param context - returned sender context, to match reply w/ request
2000 @param retval - return code
2002 define lisp_add_del_locator_reply
2008 /** \brief add or delete lisp eid-table
2009 @param client_index - opaque cookie to identify the sender
2010 @param context - sender context, to match reply w/ request
2011 @param is_add - add address if non-zero, else delete
2016 @param eid - EID can be ip4, ip6 or mac
2017 @param prefix_len - prefix len
2018 @param locator_set_name - name of locator_set to add/del eid-table
2019 @param vni - virtual network instance
2024 @param key - secret key
2026 define lisp_add_del_local_eid
2034 u8 locator_set_name[64];
2040 /** \brief Reply for local_eid add/del
2041 @param context - returned sender context, to match reply w/ request
2042 @param retval - return code
2044 define lisp_add_del_local_eid_reply
2050 /** \brief add or delete lisp gpe tunnel
2051 @param client_index - opaque cookie to identify the sender
2052 @param context - sender context, to match reply w/ request
2053 @param is_add - add address if non-zero, else delete
2058 @param rmt_eid - remote eid
2059 @param lcl_eid - local eid
2060 @param rmt_len - remote prefix len
2061 @param lcl_len - local prefix len
2062 @param vni - virtual network identifier
2063 @param dp_table - vrf/bridge domain id
2064 @param loc_num - number of locators
2065 @param lcl_locs - array of local locators
2066 @param rmt_locs - array of remote locators
2067 @param action - negative action when 0 locators configured
2069 define lisp_gpe_add_del_fwd_entry
2082 u8 lcl_locs[loc_num];
2083 u8 rmt_locs[loc_num];
2087 /** \brief Reply for gpe_fwd_entry add/del
2088 @param context - returned sender context, to match reply w/ request
2089 @param retval - return code
2091 define lisp_gpe_add_del_fwd_entry_reply
2097 /** \brief Add/delete map server
2098 @param client_index - opaque cookie to identify the sender
2099 @param context - sender context, to match reply w/ request
2100 @param is_add - add address if non-zero; delete otherwise
2101 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2102 @param ip_address - map server IP address
2104 define lisp_add_del_map_server
2113 /** \brief Reply for lisp_add_del_map_server
2114 @param context - returned sender context, to match reply w/ request
2115 @param retval - return code
2117 define lisp_add_del_map_server_reply
2123 /** \brief add or delete map-resolver
2124 @param client_index - opaque cookie to identify the sender
2125 @param context - sender context, to match reply w/ request
2126 @param is_add - add address if non-zero, else delete
2127 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2128 @param ip_address - array of address bytes
2130 define lisp_add_del_map_resolver
2139 /** \brief Reply for map_resolver add/del
2140 @param context - returned sender context, to match reply w/ request
2141 @param retval - return code
2143 define lisp_add_del_map_resolver_reply
2149 /** \brief enable or disable lisp-gpe protocol
2150 @param client_index - opaque cookie to identify the sender
2151 @param context - sender context, to match reply w/ request
2152 @param is_en - enable protocol if non-zero, else disable
2154 define lisp_gpe_enable_disable
2161 /** \brief Reply for gpe enable/disable
2162 @param context - returned sender context, to match reply w/ request
2163 @param retval - return code
2165 define lisp_gpe_enable_disable_reply
2171 /** \brief enable or disable LISP feature
2172 @param client_index - opaque cookie to identify the sender
2173 @param context - sender context, to match reply w/ request
2174 @param is_en - enable protocol if non-zero, else disable
2176 define lisp_enable_disable
2183 /** \brief Reply for gpe enable/disable
2184 @param context - returned sender context, to match reply w/ request
2185 @param retval - return code
2187 define lisp_enable_disable_reply
2193 /** \brief add or delete gpe_iface
2194 @param client_index - opaque cookie to identify the sender
2195 @param context - sender context, to match reply w/ request
2196 @param is_add - add address if non-zero, else delete
2198 define lisp_gpe_add_del_iface
2208 /** \brief Reply for gpe_iface add/del
2209 @param context - returned sender context, to match reply w/ request
2210 @param retval - return code
2212 define lisp_gpe_add_del_iface_reply
2218 /** \brief configure or disable LISP PITR node
2219 @param client_index - opaque cookie to identify the sender
2220 @param context - sender context, to match reply w/ request
2221 @param ls_name - locator set name
2222 @param is_add - add locator set if non-zero, else disable pitr
2224 define lisp_pitr_set_locator_set
2232 /** \brief Reply for lisp_pitr_set_locator_set
2233 @param context - returned sender context, to match reply w/ request
2234 @param retval - return code
2236 define lisp_pitr_set_locator_set_reply
2242 /** \brief Get state of LISP RLOC probing
2243 @param client_index - opaque cookie to identify the sender
2244 @param context - sender context, to match reply w/ request
2246 define show_lisp_rloc_probe_state
2252 /** \brief Reply for show_lisp_rloc_probe_state
2253 @param context - returned sender context, to match reply w/ request
2254 @param retval - return code
2255 @param is_enabled - state of RLOC probing
2257 define show_lisp_rloc_probe_state_reply
2264 /** \brief enable/disable LISP RLOC probing
2265 @param client_index - opaque cookie to identify the sender
2266 @param context - sender context, to match reply w/ request
2267 @param is_enable - enable if non-zero; disable otherwise
2269 define lisp_rloc_probe_enable_disable
2276 /** \brief Reply for lisp_rloc_probe_enable_disable
2277 @param context - returned sender context, to match reply w/ request
2278 @param retval - return code
2280 define lisp_rloc_probe_enable_disable_reply
2286 /** \brief enable/disable LISP map-register
2287 @param client_index - opaque cookie to identify the sender
2288 @param context - sender context, to match reply w/ request
2289 @param is_enable - enable if non-zero; disable otherwise
2291 define lisp_map_register_enable_disable
2298 /** \brief Reply for lisp_map_register_enable_disable
2299 @param context - returned sender context, to match reply w/ request
2300 @param retval - return code
2302 define lisp_map_register_enable_disable_reply
2308 /** \brief Get state of LISP map-register
2309 @param client_index - opaque cookie to identify the sender
2310 @param context - sender context, to match reply w/ request
2312 define show_lisp_map_register_state
2318 /** \brief Reply for show_lisp_map_register_state
2319 @param context - returned sender context, to match reply w/ request
2320 @param retval - return code
2322 define show_lisp_map_register_state_reply
2329 /** \brief set LISP map-request mode. Based on configuration VPP will send
2330 src/dest or just normal destination map requests.
2331 @param client_index - opaque cookie to identify the sender
2332 @param context - sender context, to match reply w/ request
2333 @param mode - new map-request mode. Supported values are:
2334 0 - destination only
2335 1 - source/destaination
2337 define lisp_map_request_mode
2344 /** \brief Reply for lisp_map_request_mode
2345 @param context - returned sender context, to match reply w/ request
2346 @param retval - return code
2348 define lisp_map_request_mode_reply
2354 /** \brief Request for LISP map-request mode
2355 @param client_index - opaque cookie to identify the sender
2356 @param context - sender context, to match reply w/ request
2358 define show_lisp_map_request_mode
2364 /** \brief Reply for show_lisp_map_request_mode
2365 @param context - returned sender context, to match reply w/ request
2366 @param retval - return code
2367 @param mode - map-request mode
2369 define show_lisp_map_request_mode_reply
2376 /** \brief add or delete remote static mapping
2377 @param client_index - opaque cookie to identify the sender
2378 @param context - sender context, to match reply w/ request
2379 @param is_add - add address if non-zero, else delete
2380 @param is_src_dst - flag indicating src/dst based routing policy
2381 @param del_all - if set, delete all remote mappings
2382 @param vni - virtual network instance
2383 @param action - negative map-reply action
2388 @param deid - dst EID
2389 @param seid - src EID, valid only if is_src_dst is enabled
2390 @param rloc_num - number of remote locators
2391 @param rlocs - remote locator records
2392 Structure of remote locator:
2401 define lisp_add_del_remote_mapping
2419 /** \brief Reply for lisp_add_del_remote_mapping
2420 @param context - returned sender context, to match reply w/ request
2421 @param retval - return code
2423 define lisp_add_del_remote_mapping_reply
2429 /** \brief add or delete LISP adjacency adjacency
2430 @param client_index - opaque cookie to identify the sender
2431 @param context - sender context, to match reply w/ request
2432 @param is_add - add address if non-zero, else delete
2433 @param vni - virtual network instance
2438 @param reid - remote EID
2439 @param leid - local EID
2441 define lisp_add_del_adjacency
2454 /** \brief Reply for lisp_add_del_adjacency
2455 @param context - returned sender context, to match reply w/ request
2456 @param retval - return code
2458 define lisp_add_del_adjacency_reply
2464 /** \brief add or delete map request itr rlocs
2465 @param client_index - opaque cookie to identify the sender
2466 @param context - sender context, to match reply w/ request
2467 @param is_add - add address if non-zero, else delete
2468 @param locator_set_name - locator set name
2470 define lisp_add_del_map_request_itr_rlocs
2475 u8 locator_set_name[64];
2478 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2479 @param context - returned sender context, to match reply w/ request
2480 @param retval - return code
2483 define lisp_add_del_map_request_itr_rlocs_reply
2489 /** \brief map/unmap vni/bd_index to vrf
2490 @param client_index - opaque cookie to identify the sender
2491 @param context - sender context, to match reply w/ request
2492 @param is_add - add or delete mapping
2493 @param dp_table - virtual network id/bridge domain index
2496 define lisp_eid_table_add_del_map
2506 /** \brief Reply for lisp_eid_table_add_del_map
2507 @param context - returned sender context, to match reply w/ request
2508 @param retval - return code
2510 define lisp_eid_table_add_del_map_reply
2516 /** \brief Request for map lisp locator status
2517 @param client_index - opaque cookie to identify the sender
2518 @param context - sender context, to match reply w/ request
2519 @param locator_set_index - index of locator_set
2520 @param ls_name - locator set name
2521 @param is_index_set - flag indicating whether ls_name or ls_index is set
2523 define lisp_locator_dump
2532 /** \brief LISP locator_set status
2533 @param local - if is set, then locator is local
2534 @param locator_set_name - name of the locator_set
2535 @param sw_if_index - sw_if_index of the locator
2536 @param priority - locator priority
2537 @param weight - locator weight
2539 define lisp_locator_details
2550 /** \brief LISP locator_set status
2551 @param context - sender context, to match reply w/ request
2552 @param ls_index - locator set index
2553 @param ls_name - name of the locator set
2555 define lisp_locator_set_details
2562 /** \brief Request for locator_set summary status
2563 @param client_index - opaque cookie to identify the sender
2564 @param context - sender context, to match reply w/ request
2565 @param filter - filter type
2568 1: local locator sets
2569 2: remote locator sets
2571 define lisp_locator_set_dump
2578 /** \brief Dump lisp eid-table
2579 @param client_index - opaque cookie to identify the sender
2580 @param context - sender context, to match reply w/ request
2581 @param locator_set_index - index of locator_set, if ~0 then the mapping
2583 @param action - negative map request action
2584 @param is_local - local if non-zero, else remote
2589 @param is_src_dst - EID is type of source/destination
2590 @param eid - EID can be ip4, ip6 or mac
2591 @param eid_prefix_len - prefix length
2592 @param seid - source EID can be ip4, ip6 or mac
2593 @param seid_prefix_len - source prefix length
2594 @param vni - virtual network instance
2595 @param ttl - time to live
2596 @param authoritative - authoritative
2601 @param key - secret key
2604 define lisp_eid_table_details
2607 u32 locator_set_index;
2623 /** \brief Request for eid table summary status
2624 @param client_index - opaque cookie to identify the sender
2625 @param context - sender context, to match reply w/ request
2626 @param eid_set - if non-zero request info about specific mapping
2627 @param vni - virtual network instance; valid only if eid_set != 0
2628 @param prefix_length - prefix length if EID is IP address;
2629 valid only if eid_set != 0
2630 @param eid_type - EID type; valid only if eid_set != 0
2634 2: EID is ethernet address
2635 @param eid - endpoint identifier
2636 @param filter - filter type;
2642 define lisp_eid_table_dump
2654 /** \brief LISP adjacency
2659 @param reid - remote EID
2660 @param leid - local EID
2661 @param reid_prefix_len - remote EID IP prefix length
2662 @param leid_prefix_len - local EID IP prefix length
2664 typeonly manual_print manual_endian define lisp_adjacency
2673 /** \brief LISP adjacency reply
2674 @param count - number of adjacencies
2675 @param adjacencies - array of adjacencies
2677 manual_endian manual_print define lisp_adjacencies_get_reply
2682 vl_api_lisp_adjacency_t adjacencies[count];
2685 /** \brief Request for LISP adjacencies
2686 @param client_index - opaque cookie to identify the sender
2687 @param context - sender context, to match reply w/ request
2688 @param vni - filter adjacencies by VNI
2690 define lisp_adjacencies_get
2697 /** \brief Shows relationship between vni and vrf/bd
2698 @param dp_table - VRF index or bridge domain index
2699 @param vni - vitual network instance
2701 define lisp_eid_table_map_details
2708 /** \brief Request for lisp_eid_table_map_details
2709 @param client_index - opaque cookie to identify the sender
2710 @param context - sender context, to match reply w/ request
2711 @param is_l2 - if set dump vni/bd mappings else vni/vrf
2713 define lisp_eid_table_map_dump
2720 /** \brief Dumps all VNIs used in mappings
2721 @param client_index - opaque cookie to identify the sender
2722 @param context - sender context, to match reply w/ request
2724 define lisp_eid_table_vni_dump
2730 /** \brief reply to lisp_eid_table_vni_dump
2731 @param client_index - opaque cookie to identify the sender
2732 @param context - sender context, to match reply w/ request
2733 @param vni - virtual network instance
2735 define lisp_eid_table_vni_details
2742 define lisp_gpe_tunnel_details
2748 u8 destination_ip[16];
2760 /** \brief Request for gpe tunnel summary status
2761 @param client_index - opaque cookie to identify the sender
2762 @param context - sender context, to match reply w/ request
2764 define lisp_gpe_tunnel_dump
2770 /** \brief LISP map resolver status
2771 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2772 @param ip_address - array of address bytes
2774 define lisp_map_resolver_details
2781 /** \brief Request for map resolver summary status
2782 @param client_index - opaque cookie to identify the sender
2783 @param context - sender context, to match reply w/ request
2785 define lisp_map_resolver_dump
2791 /** \brief LISP map server details
2792 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2793 @param ip_address - array of address bytes
2795 define lisp_map_server_details
2802 /** \brief Request for map server summary status
2803 @param client_index - opaque cookie to identify the sender
2804 @param context - sender context, to match reply w/ request
2806 define lisp_map_server_dump
2812 /** \brief Request for lisp-gpe protocol status
2813 @param client_index - opaque cookie to identify the sender
2814 @param context - sender context, to match reply w/ request
2816 define show_lisp_status
2822 /** \brief Status of lisp, enable or disable
2823 @param context - sender context, to match reply w/ request
2824 @param feature_status - lisp enable if non-zero, else disable
2825 @param gpe_status - lisp enable if non-zero, else disable
2827 define show_lisp_status_reply
2835 /** \brief Get LISP map request itr rlocs status
2836 @param context - sender context, to match reply w/ request
2837 @param locator_set_name - name of the locator_set
2839 define lisp_get_map_request_itr_rlocs
2845 /** \brief Request for map request itr rlocs summary status
2847 define lisp_get_map_request_itr_rlocs_reply
2851 u8 locator_set_name[64];
2854 /** \brief Request for lisp pitr status
2855 @param client_index - opaque cookie to identify the sender
2856 @param context - sender context, to match reply w/ request
2858 define show_lisp_pitr
2864 /** \brief Status of lisp pitr, enable or disable
2865 @param context - sender context, to match reply w/ request
2866 @param status - lisp pitr enable if non-zero, else disable
2867 @param locator_set_name - name of the locator_set
2869 define show_lisp_pitr_reply
2874 u8 locator_set_name[64];
2877 /* Gross kludge, DGMS */
2878 define interface_name_renumber
2883 u32 new_show_dev_instance;
2886 define interface_name_renumber_reply
2892 /** \brief Register for ip4 arp resolution events
2893 @param client_index - opaque cookie to identify the sender
2894 @param context - sender context, to match reply w/ request
2895 @param enable_disable - 1 => register for events, 0 => cancel registration
2896 @param pid - sender's pid
2897 @param address - the exact ip4 address of interest
2899 define want_ip4_arp_events
2908 /** \brief Reply for interface events registration
2909 @param context - returned sender context, to match reply w/ request
2910 @param retval - return code
2912 define want_ip4_arp_events_reply
2918 /** \brief Tell client about an ip4 arp resolution event
2919 @param client_index - opaque cookie to identify the sender
2920 @param context - sender context, to match reply w/ request
2921 @param address - the exact ip4 address of interest
2922 @param pid - client pid registered to receive notification
2923 @param sw_if_index - interface which received ARP packet
2924 @param new_mac - the new mac address
2925 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
2927 define ip4_arp_event
2938 /** \brief Register for ip6 nd resolution events
2939 @param client_index - opaque cookie to identify the sender
2940 @param context - sender context, to match reply w/ request
2941 @param enable_disable - 1 => register for events, 0 => cancel registration
2942 @param pid - sender's pid
2943 @param address - the exact ip6 address of interest
2945 define want_ip6_nd_events
2954 /** \brief Reply for ip6 nd resolution events registration
2955 @param context - returned sender context, to match reply w/ request
2956 @param retval - return code
2958 define want_ip6_nd_events_reply
2964 /** \brief Tell client about an ip6 nd resolution or mac/ip event
2965 @param client_index - opaque cookie to identify the sender
2966 @param context - sender context, to match reply w/ request
2967 @param pid - client pid registered to receive notification
2968 @param sw_if_index - interface which received ARP packet
2969 @param address - the exact ip6 address of interest
2970 @param new_mac - the new mac address
2971 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
2984 /** \brief L2 bridge domain add or delete request
2985 @param client_index - opaque cookie to identify the sender
2986 @param context - sender context, to match reply w/ request
2987 @param bd_id - the bridge domain to create
2988 @param flood - enable/disable bcast/mcast flooding in the bd
2989 @param uu_flood - enable/disable uknown unicast flood in the bd
2990 @param forward - enable/disable forwarding on all interfaces in the bd
2991 @param learn - enable/disable learning on all interfaces in the bd
2992 @param arp_term - enable/disable arp termination in the bd
2993 @param is_add - add or delete flag
2995 define bridge_domain_add_del
3008 /** \brief L2 bridge domain add or delete response
3009 @param context - sender context, to match reply w/ request
3010 @param retval - return code for the set bridge flags request
3012 define bridge_domain_add_del_reply
3018 /** \brief L2 bridge domain request operational state details
3019 @param client_index - opaque cookie to identify the sender
3020 @param context - sender context, to match reply w/ request
3021 @param bd_id - the bridge domain id desired or ~0 to request all bds
3023 define bridge_domain_dump
3030 /** \brief L2 bridge domain operational state response
3031 @param bd_id - the bridge domain id
3032 @param flood - bcast/mcast flooding state on all interfaces in the bd
3033 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3034 @param forward - forwarding state on all interfaces in the bd
3035 @param learn - learning state on all interfaces in the bd
3036 @param arp_term - arp termination state on all interfaces in the bd
3037 @param n_sw_ifs - number of sw_if_index's in the domain
3039 define bridge_domain_details
3048 u32 bvi_sw_if_index;
3052 /** \brief L2 bridge domain sw interface operational state response
3053 @param bd_id - the bridge domain id
3054 @param sw_if_index - sw_if_index in the domain
3055 @param shg - split horizon group for the interface
3057 define bridge_domain_sw_if_details
3065 /** \brief DHCP Client config add / del request
3066 @param client_index - opaque cookie to identify the sender
3067 @param context - sender context, to match reply w/ request
3068 @param sw_if_index - index of the interface for DHCP client
3069 @param hostname - hostname
3070 @param is_add - add the config if non-zero, else delete
3071 @param want_dhcp_event - DHCP event sent to the sender
3072 via dhcp_compl_event API message if non-zero
3073 @param pid - sender's pid
3075 define dhcp_client_config
3086 /** \brief DHCP Client config response
3087 @param context - sender context, to match reply w/ request
3088 @param retval - return code for the request
3090 define dhcp_client_config_reply
3096 /** \brief Set/unset input ACL interface
3097 @param client_index - opaque cookie to identify the sender
3098 @param context - sender context, to match reply w/ request
3099 @param sw_if_index - interface to set/unset input ACL
3100 @param ip4_table_index - ip4 classify table index (~0 for skip)
3101 @param ip6_table_index - ip6 classify table index (~0 for skip)
3102 @param l2_table_index - l2 classify table index (~0 for skip)
3103 @param is_add - Set input ACL if non-zero, else unset
3104 Note: User is recommeneded to use just one valid table_index per call.
3105 (ip4_table_index, ip6_table_index, or l2_table_index)
3107 define input_acl_set_interface
3112 u32 ip4_table_index;
3113 u32 ip6_table_index;
3118 /** \brief Set/unset input ACL interface response
3119 @param context - sender context, to match reply w/ request
3120 @param retval - return code for the request
3122 define input_acl_set_interface_reply
3128 /** \brief IPsec: Add/delete Security Policy Database
3129 @param client_index - opaque cookie to identify the sender
3130 @param context - sender context, to match reply w/ request
3131 @param is_add - add SPD if non-zero, else delete
3132 @param spd_id - SPD instance id (control plane allocated)
3135 define ipsec_spd_add_del
3143 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3144 @param context - returned sender context, to match reply w/ request
3145 @param retval - return code
3148 define ipsec_spd_add_del_reply
3154 /** \brief IPsec: Add/delete SPD from interface
3156 @param client_index - opaque cookie to identify the sender
3157 @param context - sender context, to match reply w/ request
3158 @param is_add - add security mode if non-zero, else delete
3159 @param sw_if_index - index of the interface
3160 @param spd_id - SPD instance id to use for lookups
3164 define ipsec_interface_add_del_spd
3174 /** \brief Reply for IPsec: Add/delete SPD from interface
3175 @param context - returned sender context, to match reply w/ request
3176 @param retval - return code
3179 define ipsec_interface_add_del_spd_reply
3185 /** \brief IPsec: Add/delete Security Policy Database entry
3187 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3189 @param client_index - opaque cookie to identify the sender
3190 @param context - sender context, to match reply w/ request
3191 @param is_add - add SPD if non-zero, else delete
3192 @param spd_id - SPD instance id (control plane allocated)
3193 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3194 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3195 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3196 @param remote_address_start - start of remote address range to match
3197 @param remote_address_stop - end of remote address range to match
3198 @param local_address_start - start of local address range to match
3199 @param local_address_stop - end of local address range to match
3200 @param protocol - protocol type to match [0 means any]
3201 @param remote_port_start - start of remote port range to match ...
3202 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3203 @param local_port_start - start of local port range to match ...
3204 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3205 @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)
3206 @param sa_id - SAD instance id (control plane allocated)
3210 define ipsec_spd_add_del_entry
3223 u8 remote_address_start[16];
3224 u8 remote_address_stop[16];
3225 u8 local_address_start[16];
3226 u8 local_address_stop[16];
3230 u16 remote_port_start;
3231 u16 remote_port_stop;
3232 u16 local_port_start;
3233 u16 local_port_stop;
3240 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3241 @param context - returned sender context, to match reply w/ request
3242 @param retval - return code
3245 define ipsec_spd_add_del_entry_reply
3251 /** \brief IPsec: Add/delete Security Association Database entry
3252 @param client_index - opaque cookie to identify the sender
3253 @param context - sender context, to match reply w/ request
3254 @param is_add - add SAD entry if non-zero, else delete
3256 @param sad_id - sad id
3258 @param spi - security parameter index
3260 @param protocol - 0 = AH, 1 = ESP
3262 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3263 @param crypto_key_length - length of crypto_key in bytes
3264 @param crypto_key - crypto keying material
3266 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3267 @param integrity_key_length - length of integrity_key in bytes
3268 @param integrity_key - integrity keying material
3270 @param use_extended_sequence_number - use ESN when non-zero
3272 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3273 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3274 @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
3275 @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
3279 IPsec tunnel address copy mode (to support GDOI)
3282 define ipsec_sad_add_del_entry
3294 u8 crypto_algorithm;
3295 u8 crypto_key_length;
3298 u8 integrity_algorithm;
3299 u8 integrity_key_length;
3300 u8 integrity_key[128];
3302 u8 use_extended_sequence_number;
3306 u8 tunnel_src_address[16];
3307 u8 tunnel_dst_address[16];
3310 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3311 @param context - returned sender context, to match reply w/ request
3312 @param retval - return code
3315 define ipsec_sad_add_del_entry_reply
3321 /** \brief IPsec: Update Security Association keys
3322 @param client_index - opaque cookie to identify the sender
3323 @param context - sender context, to match reply w/ request
3325 @param sa_id - sa id
3327 @param crypto_key_length - length of crypto_key in bytes
3328 @param crypto_key - crypto keying material
3330 @param integrity_key_length - length of integrity_key in bytes
3331 @param integrity_key - integrity keying material
3334 define ipsec_sa_set_key
3341 u8 crypto_key_length;
3344 u8 integrity_key_length;
3345 u8 integrity_key[128];
3348 /** \brief Reply for IPsec: Update Security Association keys
3349 @param context - returned sender context, to match reply w/ request
3350 @param retval - return code
3353 define ipsec_sa_set_key_reply
3359 /** \brief IKEv2: Add/delete profile
3360 @param client_index - opaque cookie to identify the sender
3361 @param context - sender context, to match reply w/ request
3363 @param name - IKEv2 profile name
3364 @param is_add - Add IKEv2 profile if non-zero, else delete
3366 define ikev2_profile_add_del
3375 /** \brief Reply for IKEv2: Add/delete profile
3376 @param context - returned sender context, to match reply w/ request
3377 @param retval - return code
3379 define ikev2_profile_add_del_reply
3385 /** \brief IKEv2: Set IKEv2 profile authentication method
3386 @param client_index - opaque cookie to identify the sender
3387 @param context - sender context, to match reply w/ request
3389 @param name - IKEv2 profile name
3390 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3391 @param is_hex - Authentication data in hex format if non-zero, else string
3392 @param data_len - Authentication data length
3393 @param data - Authentication data (for rsa-sig cert file path)
3395 define ikev2_profile_set_auth
3407 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3408 @param context - returned sender context, to match reply w/ request
3409 @param retval - return code
3411 define ikev2_profile_set_auth_reply
3417 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3418 @param client_index - opaque cookie to identify the sender
3419 @param context - sender context, to match reply w/ request
3421 @param name - IKEv2 profile name
3422 @param is_local - Identification is local if non-zero, else remote
3423 @param id_type - Identification type
3424 @param data_len - Identification data length
3425 @param data - Identification data
3427 define ikev2_profile_set_id
3439 /** \brief Reply for IKEv2:
3440 @param context - returned sender context, to match reply w/ request
3441 @param retval - return code
3443 define ikev2_profile_set_id_reply
3449 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3450 @param client_index - opaque cookie to identify the sender
3451 @param context - sender context, to match reply w/ request
3453 @param name - IKEv2 profile name
3454 @param is_local - Traffic selector is local if non-zero, else remote
3455 @param proto - Traffic selector IP protocol (if zero not relevant)
3456 @param start_port - The smallest port number allowed by traffic selector
3457 @param end_port - The largest port number allowed by traffic selector
3458 @param start_addr - The smallest address included in traffic selector
3459 @param end_addr - The largest address included in traffic selector
3461 define ikev2_profile_set_ts
3475 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3476 @param context - returned sender context, to match reply w/ request
3477 @param retval - return code
3479 define ikev2_profile_set_ts_reply
3485 /** \brief IKEv2: Set IKEv2 local RSA private key
3486 @param client_index - opaque cookie to identify the sender
3487 @param context - sender context, to match reply w/ request
3489 @param key_file - Key file absolute path
3491 define ikev2_set_local_key
3499 /** \brief Reply for IKEv2: Set IKEv2 local key
3500 @param context - returned sender context, to match reply w/ request
3501 @param retval - return code
3503 define ikev2_set_local_key_reply
3509 /** \brief Tell client about a DHCP completion event
3510 @param client_index - opaque cookie to identify the sender
3511 @param pid - client pid registered to receive notification
3512 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3513 @param host_address - Host IP address
3514 @param router_address - Router IP address
3515 @param host_mac - Host MAC address
3517 define dhcp_compl_event
3523 u8 host_address[16];
3524 u8 router_address[16];
3528 /** \brief cop: enable/disable junk filtration features on an interface
3529 @param client_index - opaque cookie to identify the sender
3530 @param context - sender context, to match reply w/ request
3531 @param sw_if_inded - desired interface
3532 @param enable_disable - 1 => enable, 0 => disable
3535 define cop_interface_enable_disable
3543 /** \brief cop: interface enable/disable junk filtration reply
3544 @param context - returned sender context, to match reply w/ request
3545 @param retval - return code
3548 define cop_interface_enable_disable_reply
3554 /** \brief cop: enable/disable whitelist filtration features on an interface
3555 Note: the supplied fib_id must match in order to remove the feature!
3557 @param client_index - opaque cookie to identify the sender
3558 @param context - sender context, to match reply w/ request
3559 @param sw_if_index - interface handle, physical interfaces only
3560 @param fib_id - fib identifier for the whitelist / blacklist fib
3561 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3562 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3563 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3566 define cop_whitelist_enable_disable
3577 /** \brief cop: interface enable/disable junk filtration reply
3578 @param context - returned sender context, to match reply w/ request
3579 @param retval - return code
3582 define cop_whitelist_enable_disable_reply
3588 /** \brief get_node_graph - get a copy of the vpp node graph
3589 including the current set of graph arcs.
3591 @param client_index - opaque cookie to identify the sender
3592 @param context - sender context, to match reply w/ request
3595 define get_node_graph
3601 /** \brief get_node_graph_reply
3602 @param context - returned sender context, to match reply w/ request
3603 @param retval - return code
3604 @param reply_in_shmem - result from vlib_node_serialize, in shared
3605 memory. Process with vlib_node_unserialize, remember to switch
3606 heaps and free the result.
3609 define get_node_graph_reply
3616 /** \brief IOAM enable : Enable in-band OAM
3617 @param id - profile id
3618 @param seqno - To enable Seqno Processing
3619 @param analyse - Enabling analysis of iOAM at decap node
3620 @param pow_enable - Proof of Work enabled or not flag
3621 @param trace_enable - iOAM Trace enabled or not flag
3635 /** \brief iOAM Trace profile add / del response
3636 @param context - sender context, to match reply w/ request
3637 @param retval - return value for request
3639 define ioam_enable_reply
3645 /** \brief iOAM disable
3646 @param client_index - opaque cookie to identify the sender
3647 @param context - sender context, to match reply w/ request
3648 @param index - MAP Domain index
3657 /** \brief iOAM disable response
3658 @param context - sender context, to match reply w/ request
3659 @param retval - return value for request
3661 define ioam_disable_reply
3667 /** \brief Create host-interface
3668 @param client_index - opaque cookie to identify the sender
3669 @param context - sender context, to match reply w/ request
3670 @param host_if_name - interface name
3671 @param hw_addr - interface MAC
3672 @param use_random_hw_addr - use random generated MAC
3674 define af_packet_create
3679 u8 host_if_name[64];
3681 u8 use_random_hw_addr;
3684 /** \brief Create host-interface response
3685 @param context - sender context, to match reply w/ request
3686 @param retval - return value for request
3688 define af_packet_create_reply
3695 /** \brief Delete host-interface
3696 @param client_index - opaque cookie to identify the sender
3697 @param context - sender context, to match reply w/ request
3698 @param host_if_name - interface name
3700 define af_packet_delete
3705 u8 host_if_name[64];
3708 /** \brief Delete host-interface response
3709 @param context - sender context, to match reply w/ request
3710 @param retval - return value for request
3712 define af_packet_delete_reply
3718 /** \brief Add/del policer
3719 @param client_index - opaque cookie to identify the sender
3720 @param context - sender context, to match reply w/ request
3721 @param is_add - add policer if non-zero, else delete
3722 @param name - policer name
3725 @param cb - Committed Burst
3726 @param eb - Excess or Peak Burst
3727 @param rate_type - rate type
3728 @param round_type - rounding type
3729 @param type - policer algorithm
3730 @param color_aware - 0=color-blind, 1=color-aware
3731 @param conform_action_type - conform action type
3732 @param conform_dscp - DSCP for conform mar-and-transmit action
3733 @param exceed_action_type - exceed action type
3734 @param exceed_dscp - DSCP for exceed mar-and-transmit action
3735 @param violate_action_type - violate action type
3736 @param violate_dscp - DSCP for violate mar-and-transmit action
3738 define policer_add_del
3753 u8 conform_action_type;
3755 u8 exceed_action_type;
3757 u8 violate_action_type;
3761 /** \brief Add/del policer response
3762 @param context - sender context, to match reply w/ request
3763 @param retval - return value for request
3764 @param policer_index - for add, returned index of the new policer
3766 define policer_add_del_reply
3773 /** \brief Get list of policers
3774 @param client_index - opaque cookie to identify the sender
3775 @param context - sender context, to match reply w/ request
3776 @param match_name_valid - if 0 request all policers otherwise use match_name
3777 @param match_name - policer name
3784 u8 match_name_valid;
3788 /** \brief Policer operational state response.
3789 @param context - sender context, to match reply w/ request
3790 @param name - policer name
3793 @param cb - Committed Burst
3794 @param eb - Excess or Peak Burst
3795 @param rate_type - rate type
3796 @param round_type - rounding type
3797 @param type - policer algorithm
3798 @param conform_action_type - conform action type
3799 @param conform_dscp - DSCP for conform mar-and-transmit action
3800 @param exceed_action_type - exceed action type
3801 @param exceed_dscp - DSCP for exceed mar-and-transmit action
3802 @param violate_action_type - violate action type
3803 @param violate_dscp - DSCP for violate mar-and-transmit action
3804 @param single_rate - 1 = single rate policer, 0 = two rate policer
3805 @param color_aware - for hierarchical policing
3806 @param scale - power-of-2 shift amount for lower rates
3807 @param cir_tokens_per_period - number of tokens for each period
3808 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
3809 @param current_limit - current limit
3810 @param current_bucket - current bucket
3811 @param extended_limit - extended limit
3812 @param extended_bucket - extended bucket
3813 @param last_update_time - last update time
3815 define policer_details
3827 u8 conform_action_type;
3829 u8 exceed_action_type;
3831 u8 violate_action_type;
3836 u32 cir_tokens_per_period;
3837 u32 pir_tokens_per_period;
3841 u32 extended_bucket;
3842 u64 last_update_time;
3845 /** \brief Set/unset policer classify interface
3846 @param client_index - opaque cookie to identify the sender
3847 @param context - sender context, to match reply w/ request
3848 @param sw_if_index - interface to set/unset policer classify
3849 @param ip4_table_index - ip4 classify table index (~0 for skip)
3850 @param ip6_table_index - ip6 classify table index (~0 for skip)
3851 @param l2_table_index - l2 classify table index (~0 for skip)
3852 @param is_add - Set if non-zero, else unset
3853 Note: User is recommeneded to use just one valid table_index per call.
3854 (ip4_table_index, ip6_table_index, or l2_table_index)
3856 define policer_classify_set_interface
3861 u32 ip4_table_index;
3862 u32 ip6_table_index;
3867 /** \brief Set/unset policer classify interface response
3868 @param context - sender context, to match reply w/ request
3869 @param retval - return value for request
3871 define policer_classify_set_interface_reply
3877 /** \brief Get list of policer classify interfaces and tables
3878 @param client_index - opaque cookie to identify the sender
3879 @param context - sender context, to match reply w/ request
3880 @param type - classify table type
3882 define policer_classify_dump
3889 /** \brief Policer iclassify operational state response.
3890 @param context - sender context, to match reply w/ request
3891 @param sw_if_index - software interface index
3892 @param table_index - classify table index
3894 define policer_classify_details
3901 /** \brief Create netmap
3902 @param client_index - opaque cookie to identify the sender
3903 @param context - sender context, to match reply w/ request
3904 @param netmap_if_name - interface name
3905 @param hw_addr - interface MAC
3906 @param use_random_hw_addr - use random generated MAC
3907 @param is_pipe - is pipe
3908 @param is_master - 0=slave, 1=master
3910 define netmap_create
3915 u8 netmap_if_name[64];
3917 u8 use_random_hw_addr;
3922 /** \brief Create netmap response
3923 @param context - sender context, to match reply w/ request
3924 @param retval - return value for request
3926 define netmap_create_reply
3932 /** \brief Delete netmap
3933 @param client_index - opaque cookie to identify the sender
3934 @param context - sender context, to match reply w/ request
3935 @param netmap_if_name - interface name
3937 define netmap_delete
3942 u8 netmap_if_name[64];
3945 /** \brief Delete netmap response
3946 @param context - sender context, to match reply w/ request
3947 @param retval - return value for request
3949 define netmap_delete_reply
3955 /** \brief Classify get table IDs request
3956 @param client_index - opaque cookie to identify the sender
3957 @param context - sender context, to match reply w/ request
3959 define classify_table_ids
3965 /** \brief Reply for classify get table IDs request
3966 @param context - sender context which was passed in the request
3967 @param count - number of ids returned in response
3968 @param ids - array of classify table ids
3970 define classify_table_ids_reply
3978 /** \brief Classify table ids by interface index request
3979 @param client_index - opaque cookie to identify the sender
3980 @param context - sender context, to match reply w/ request
3981 @param sw_if_index - index of the interface
3983 define classify_table_by_interface
3990 /** \brief Reply for classify table id by interface index request
3991 @param context - sender context which was passed in the request
3992 @param count - number of ids returned in response
3993 @param sw_if_index - index of the interface
3994 @param l2_table_id - l2 classify table index
3995 @param ip4_table_id - ip4 classify table index
3996 @param ip6_table_id - ip6 classify table index
3998 define classify_table_by_interface_reply
4008 /** \brief Classify table info
4009 @param client_index - opaque cookie to identify the sender
4010 @param context - sender context, to match reply w/ request
4011 @param table_id - classify table index
4013 define classify_table_info
4020 /** \brief Reply for classify table info request
4021 @param context - sender context which was passed in the request
4022 @param count - number of ids returned in response
4023 @param table_id - classify table index
4024 @param nbuckets - number of buckets when adding a table
4025 @param match_n_vectors - number of match vectors
4026 @param skip_n_vectors - number of skip_n_vectors
4027 @param active_sessions - number of sessions (active entries)
4028 @param next_table_index - index of next table
4029 @param miss_next_index - index of miss table
4030 @param mask[] - match mask
4032 define classify_table_info_reply
4038 u32 match_n_vectors;
4040 u32 active_sessions;
4041 u32 next_table_index;
4042 u32 miss_next_index;
4044 u8 mask[mask_length];
4047 /** \brief Classify sessions dump request
4048 @param client_index - opaque cookie to identify the sender
4049 @param context - sender context, to match reply w/ request
4050 @param table_id - classify table index
4052 define classify_session_dump
4059 /** \brief Reply for classify table session dump request
4060 @param context - sender context which was passed in the request
4061 @param count - number of ids returned in response
4062 @param table_id - classify table index
4063 @param hit_next_index - hit_next_index of session
4064 @param opaque_index - for add, opaque_index of session
4065 @param advance - advance value of session
4066 @param match[] - match value for session
4068 define classify_session_details
4077 u8 match[match_length];
4080 /** \brief Configure IPFIX exporter process request
4081 @param client_index - opaque cookie to identify the sender
4082 @param context - sender context, to match reply w/ request
4083 @param collector_address - address of IPFIX collector
4084 @param collector_port - port of IPFIX collector
4085 @param src_address - address of IPFIX exporter
4086 @param vrf_id - VRF / fib table ID
4087 @param path_mtu - Path MTU between exporter and collector
4088 @param template_interval - number of seconds after which to resend template
4089 @param udp_checksum - UDP checksum calculation enable flag
4091 define set_ipfix_exporter
4095 u8 collector_address[16];
4100 u32 template_interval;
4104 /** \brief Reply to IPFIX exporter configure request
4105 @param context - sender context which was passed in the request
4107 define set_ipfix_exporter_reply
4113 /** \brief IPFIX exporter dump request
4114 @param client_index - opaque cookie to identify the sender
4115 @param context - sender context, to match reply w/ request
4117 define ipfix_exporter_dump
4123 /** \brief Reply to IPFIX exporter dump request
4124 @param context - sender context which was passed in the request
4125 @param collector_address - address of IPFIX collector
4126 @param collector_port - port of IPFIX collector
4127 @param src_address - address of IPFIX exporter
4128 @param fib_index - fib table index
4129 @param path_mtu - Path MTU between exporter and collector
4130 @param template_interval - number of seconds after which to resend template
4131 @param udp_checksum - UDP checksum calculation enable flag
4133 define ipfix_exporter_details
4136 u8 collector_address[16];
4141 u32 template_interval;
4145 /** \brief IPFIX classify stream configure request
4146 @param client_index - opaque cookie to identify the sender
4147 @param context - sender context, to match reply w/ request
4148 @param domain_id - domain ID reported in IPFIX messages for classify stream
4149 @param src_port - source port of UDP session for classify stream
4151 define set_ipfix_classify_stream {
4158 /** \brief IPFIX classify stream configure response
4159 @param context - sender context, to match reply w/ request
4160 @param retval - return value for request
4162 define set_ipfix_classify_stream_reply {
4167 /** \brief IPFIX classify stream dump request
4168 @param client_index - opaque cookie to identify the sender
4169 @param context - sender context, to match reply w/ request
4171 define ipfix_classify_stream_dump {
4176 /** \brief Reply to IPFIX classify stream dump request
4177 @param context - sender context, to match reply w/ request
4178 @param domain_id - domain ID reported in IPFIX messages for classify stream
4179 @param src_port - source port of UDP session for classify stream
4181 define ipfix_classify_stream_details {
4187 /** \brief IPFIX add or delete classifier table request
4188 @param client_index - opaque cookie to identify the sender
4189 @param context - sender context, to match reply w/ request
4190 @param table_id - classifier table ID
4191 @param ip_version - version of IP used in the classifier table
4192 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4194 define ipfix_classify_table_add_del {
4199 u8 transport_protocol;
4203 /** \brief IPFIX add classifier table response
4204 @param context - sender context which was passed in the request
4206 define ipfix_classify_table_add_del_reply {
4211 /** \brief IPFIX classify tables dump request
4212 @param client_index - opaque cookie to identify the sender
4213 @param context - sender context, to match reply w/ request
4215 define ipfix_classify_table_dump {
4220 /** \brief Reply to IPFIX classify tables dump request
4221 @param context - sender context, to match reply w/ request
4222 @param table_id - classifier table ID
4223 @param ip_version - version of IP used in the classifier table
4224 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4226 define ipfix_classify_table_details {
4230 u8 transport_protocol;
4233 /** \brief Set/unset flow classify interface
4234 @param client_index - opaque cookie to identify the sender
4235 @param context - sender context, to match reply w/ request
4236 @param sw_if_index - interface to set/unset flow classify
4237 @param ip4_table_index - ip4 classify table index (~0 for skip)
4238 @param ip6_table_index - ip6 classify table index (~0 for skip)
4239 @param l2_table_index - l2 classify table index (~0 for skip)
4240 @param is_add - Set if non-zero, else unset
4241 Note: User is recommeneded to use just one valid table_index per call.
4242 (ip4_table_index, ip6_table_index, or l2_table_index)
4244 define flow_classify_set_interface {
4248 u32 ip4_table_index;
4249 u32 ip6_table_index;
4253 /** \brief Set/unset flow classify interface response
4254 @param context - sender context, to match reply w/ request
4255 @param retval - return value for request
4257 define flow_classify_set_interface_reply {
4262 /** \brief Get list of flow classify interfaces and tables
4263 @param client_index - opaque cookie to identify the sender
4264 @param context - sender context, to match reply w/ request
4265 @param type - classify table type
4267 define flow_classify_dump {
4273 /** \brief Flow classify operational state response.
4274 @param context - sender context, to match reply w/ request
4275 @param sw_if_index - software interface index
4276 @param table_index - classify table index
4278 define flow_classify_details {
4284 /** \brief Query relative index via node names
4285 @param client_index - opaque cookie to identify the sender
4286 @param context - sender context, to match reply w/ request
4287 @param node_name - name of node to find relative index from
4288 @param next_name - next node from node_name to find relative index of
4290 define get_next_index
4298 /** \brief Reply for get next node index
4299 @param context - sender context which was passed in the request
4300 @param retval - return value
4301 @param next_index - index of the next_node
4303 define get_next_index_reply
4310 /** \brief PacketGenerator create interface request
4311 @param client_index - opaque cookie to identify the sender
4312 @param context - sender context, to match reply w/ request
4313 @param interface_id - interface index
4315 define pg_create_interface
4322 /** \brief PacketGenerator create interface response
4323 @param context - sender context, to match reply w/ request
4324 @param retval - return value for request
4326 define pg_create_interface_reply
4333 /** \brief PacketGenerator capture packets on given interface request
4334 @param client_index - opaque cookie to identify the sender
4335 @param context - sender context, to match reply w/ request
4336 @param interface_id - pg interface index
4337 @param is_enabled - 1 if enabling streams, 0 if disabling
4338 @param count - number of packets to be captured
4339 @param pcap_file - pacp file name to store captured packets
4348 u32 pcap_name_length;
4349 u8 pcap_file_name[pcap_name_length];
4352 /** \brief PacketGenerator capture packets response
4353 @param context - sender context, to match reply w/ request
4354 @param retval - return value for request
4356 define pg_capture_reply
4362 /** \brief Enable / disable packet generator request
4363 @param client_index - opaque cookie to identify the sender
4364 @param context - sender context, to match reply w/ request
4365 @param is_enabled - 1 if enabling streams, 0 if disabling
4366 @param stream - stream name to be enable/disabled, if not specified handle all streams
4368 define pg_enable_disable
4373 u32 stream_name_length;
4374 u8 stream_name[stream_name_length];
4377 /** \brief Reply for enable / disable packet generator
4378 @param context - returned sender context, to match reply w/ request
4379 @param retval - return code
4381 define pg_enable_disable_reply
4387 /** \brief Configure IP source and L4 port-range check
4388 @param client_index - opaque cookie to identify the sender
4389 @param context - sender context, to match reply w/ request
4390 @param is_ip6 - 1 if source address type is IPv6
4391 @param is_add - 1 if add, 0 if delete
4392 @param mask_length - mask length for address entry
4393 @param address - array of address bytes
4394 @param number_of_ranges - length of low_port and high_port arrays (must match)
4395 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
4396 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
4397 @param vrf_id - fib table/vrf id to associate the source and port-range check with
4398 @note To specify a single port set low_port and high_port entry the same
4400 define ip_source_and_port_range_check_add_del
4408 u8 number_of_ranges;
4414 /** \brief Configure IP source and L4 port-range check reply
4415 @param context - returned sender context, to match reply w/ request
4416 @param retval - return code
4418 define ip_source_and_port_range_check_add_del_reply
4424 /** \brief Set interface source and L4 port-range request
4425 @param client_index - opaque cookie to identify the sender
4426 @param context - sender context, to match reply w/ request
4427 @param interface_id - interface index
4428 @param tcp_vrf_id - VRF associated with source and TCP port-range check
4429 @param udp_vrf_id - VRF associated with source and TCP port-range check
4431 define ip_source_and_port_range_check_interface_add_del
4443 /** \brief Set interface source and L4 port-range response
4444 @param context - sender context, to match reply w/ request
4445 @param retval - return value for request
4447 define ip_source_and_port_range_check_interface_add_del_reply
4453 /** \brief Add / del ipsec gre tunnel request
4454 @param client_index - opaque cookie to identify the sender
4455 @param context - sender context, to match reply w/ request
4456 @param local_sa_id - local SA id
4457 @param remote_sa_id - remote SA id
4458 @param is_add - 1 if adding the tunnel, 0 if deleting
4459 @param src_address - tunnel source address
4460 @param dst_address - tunnel destination address
4462 define ipsec_gre_add_del_tunnel {
4472 /** \brief Reply for add / del ipsec gre tunnel request
4473 @param context - returned sender context, to match reply w/ request
4474 @param retval - return code
4475 @param sw_if_index - software index of the new ipsec gre tunnel
4477 define ipsec_gre_add_del_tunnel_reply {
4483 /** \brief Dump ipsec gre tunnel table
4484 @param client_index - opaque cookie to identify the sender
4485 @param context - sender context, to match reply w/ request
4486 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4488 define ipsec_gre_tunnel_dump {
4494 /** \brief mpls gre tunnel operational state response
4495 @param context - returned sender context, to match reply w/ request
4496 @param sw_if_index - software index of the ipsec gre tunnel
4497 @param local_sa_id - local SA id
4498 @param remote_sa_id - remote SA id
4499 @param src_address - tunnel source address
4500 @param dst_address - tunnel destination address
4502 define ipsec_gre_tunnel_details {
4511 /** \brief Delete sub interface request
4512 @param client_index - opaque cookie to identify the sender
4513 @param context - sender context, to match reply w/ request
4514 @param sw_if_index - sw index of the interface that was created by create_subif
4516 define delete_subif {
4522 /** \brief Delete sub interface response
4523 @param context - sender context, to match reply w/ request
4524 @param retval - return code for the request
4526 define delete_subif_reply {
4531 /** \brief DPDK interface HQoS pipe profile set request
4532 @param client_index - opaque cookie to identify the sender
4533 @param context - sender context, to match reply w/ request
4534 @param sw_if_index - the interface
4535 @param subport - subport ID
4536 @param pipe - pipe ID within its subport
4537 @param profile - pipe profile ID
4539 define sw_interface_set_dpdk_hqos_pipe {
4548 /** \brief DPDK interface HQoS pipe profile set reply
4549 @param context - sender context, to match reply w/ request
4550 @param retval - request return code
4552 define sw_interface_set_dpdk_hqos_pipe_reply {
4557 /** \brief DPDK interface HQoS subport parameters set request
4558 @param client_index - opaque cookie to identify the sender
4559 @param context - sender context, to match reply w/ request
4560 @param sw_if_index - the interface
4561 @param subport - subport ID
4562 @param tb_rate - subport token bucket rate (measured in bytes/second)
4563 @param tb_size - subport token bucket size (measured in credits)
4564 @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
4565 @param tc_period - enforcement period for rates (measured in milliseconds)
4567 define sw_interface_set_dpdk_hqos_subport {
4578 /** \brief DPDK interface HQoS subport parameters set reply
4579 @param context - sender context, to match reply w/ request
4580 @param retval - request return code
4582 define sw_interface_set_dpdk_hqos_subport_reply {
4587 /** \brief DPDK interface HQoS tctbl entry set request
4588 @param client_index - opaque cookie to identify the sender
4589 @param context - sender context, to match reply w/ request
4590 @param sw_if_index - the interface
4591 @param entry - entry index ID
4592 @param tc - traffic class (0 .. 3)
4593 @param queue - traffic class queue (0 .. 3)
4595 define sw_interface_set_dpdk_hqos_tctbl {
4604 /** \brief DPDK interface HQoS tctbl entry set reply
4605 @param context - sender context, to match reply w/ request
4606 @param retval - request return code
4608 define sw_interface_set_dpdk_hqos_tctbl_reply {
4613 /** \brief L2 interface pbb tag rewrite configure request
4614 @param client_index - opaque cookie to identify the sender
4615 @param context - sender context, to match reply w/ request
4616 @param sw_if_index - interface the operation is applied to
4617 @param vtr_op - Choose from l2_vtr_op_t enum values
4618 @param inner_tag - needed for translate_qinq vtr op only
4619 @param outer_tag - needed for translate_qinq vtr op only
4620 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
4621 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
4622 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
4623 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
4625 define l2_interface_pbb_tag_rewrite
4638 /** \brief L2 interface pbb tag rewrite response
4639 @param context - sender context, to match reply w/ request
4640 @param retval - return code for the request
4642 define l2_interface_pbb_tag_rewrite_reply
4648 /** \brief Punt traffic to the host
4649 @param client_index - opaque cookie to identify the sender
4650 @param context - sender context, to match reply w/ request
4651 @param is_add - add punt if non-zero, else delete
4652 @param ipv - L3 protocol 4 - IPv4, 6 - IPv6, ~0 - All
4653 @param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
4654 @param l4_port - TCP/UDP port to be punted
4665 /** \brief Reply to the punt request
4666 @param context - sender context which was passed in the request
4667 @param retval - return code of punt request
4675 /** \brief Dump ipsec policy database data
4676 @param client_index - opaque cookie to identify the sender
4677 @param context - sender context, to match reply w/ request
4678 @param spd_id - SPD instance id
4679 @param sa_id - SA id, optional, set to ~0 to see all policies in SPD
4681 define ipsec_spd_dump {
4688 /** \brief IPsec policy database response
4689 @param context - sender context which was passed in the request
4690 @param spd_id - SPD instance id
4691 @param priority - numeric value to control policy evaluation order
4692 @param is_outbound - [1|0] to indicate if direction is [out|in]bound
4693 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
4694 @param local_start_addr - first address in local traffic selector range
4695 @param local_stop_addr - last address in local traffic selector range
4696 @param local_start_port - first port in local traffic selector range
4697 @param local_stop_port - last port in local traffic selector range
4698 @param remote_start_addr - first address in remote traffic selector range
4699 @param remote_stop_addr - last address in remote traffic selector range
4700 @param remote_start_port - first port in remote traffic selector range
4701 @param remote_stop_port - last port in remote traffic selector range
4702 @param protocol - traffic selector protocol
4703 @param policy - policy action
4704 @param sa_id - SA id
4705 @param bytes - byte count of packets matching this policy
4706 @param packets - count of packets matching this policy
4709 define ipsec_spd_details {
4715 u8 local_start_addr[16];
4716 u8 local_stop_addr[16];
4717 u16 local_start_port;
4718 u16 local_stop_port;
4719 u8 remote_start_addr[16];
4720 u8 remote_stop_addr[16];
4721 u16 remote_start_port;
4722 u16 remote_stop_port;
4730 /** \brief Feature path enable/disable request
4731 @param client_index - opaque cookie to identify the sender
4732 @param context - sender context, to match reply w/ request
4733 @param sw_if_index - the interface
4734 @param enable - 1 = on, 0 = off
4736 define feature_enable_disable {
4742 u8 feature_name[64];
4745 /** \brief Reply to the eature path enable/disable request
4746 @param context - sender context which was passed in the request
4747 @param retval - return code for the request
4749 define feature_enable_disable_reply
4757 * eval: (c-set-style "gnu")