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}
27 * TAP APIs: see .../vnet/vnet/unix/{tap.api, tap_api.c}
28 * VXLAN APIs: see .../vnet/vnet/vxlan/{vxlan.api, vxlan_api.c}
29 * AF-PACKET APIs: ... see /vnet/devices/af_packet/{af_packet.api, af_packet_api.c}
30 * NETMAP APIs: see ... /vnet/vnet/devices/netmap/{netmap.api, netmap_api.c}
31 * VHOST-USER APIs: see .../vnet/devices/virtio/{vhost_user.api, vhost_user_api.c}
32 * VXLAN GPE APIs: see .../vnet/vnet/vxlan-gpe/{vxlan_gpe.api, vxlan_gpe_api.c}
35 /** \brief Create a new subinterface with the given vlan id
36 @param client_index - opaque cookie to identify the sender
37 @param context - sender context, to match reply w/ request
38 @param sw_if_index - software index of the new vlan's parent interface
39 @param vlan_id - vlan tag of the new interface
41 define create_vlan_subif
49 /** \brief Reply for the vlan subinterface create request
50 @param context - returned sender context, to match reply w/ request
51 @param retval - return code
52 @param sw_if_index - software index allocated for the new subinterface
54 define create_vlan_subif_reply
61 /** \brief Enable or Disable MPLS on and interface
62 @param client_index - opaque cookie to identify the sender
63 @param context - sender context, to match reply w/ request
64 @param sw_if_index - index of the interface
65 @param enable - if non-zero enable, else disable
67 define sw_interface_set_mpls_enable
75 /** \brief Reply for MPLS state on an interface
76 @param context - returned sender context, to match reply w/ request
77 @param retval - return code
79 define sw_interface_set_mpls_enable_reply
85 /** \brief MPLS Route Add / del route
86 @param client_index - opaque cookie to identify the sender
87 @param context - sender context, to match reply w/ request
88 @param mr_label - The MPLS label value
89 @param mr_eos - The End of stack bit
90 @param mr_table_id - The MPLS table-id the route is added in
91 @param mr_classify_table_index - If this is a classify route,
92 this is the classify table index
93 @param mr_create_table_if_needed - If the MPLS or IP tables do not exist,
95 @param mr_is_add - Is this a route add or delete
96 @param mr_is_classify - Is this route result a classify
97 @param mr_is_multipath - Is this route update a multipath - i.e. is this
98 a path addition to an existing route
99 @param mr_is_resolve_host - Recurse resolution constraint via a host prefix
100 @param mr_is_resolve_attached - Recurse resolution constraint via attached prefix
101 @param mr_next_hop_proto_is_ip4 - The next-hop is IPV4
102 @param mr_next_hop_weight - The weight, for UCMP
103 @param mr_next_hop[16] - the nextop address
104 @param mr_next_hop_sw_if_index - the next-hop SW interface
105 @param mr_next_hop_table_id - the next-hop table-id (if appropriate)
106 @param mr_next_hop_n_out_labels - the number of labels in the label stack
107 @param mr_next_hop_out_label_stack - the next-hop output label stack, outer most first
108 @param next_hop_via_label - The next-hop is a resolved via a local label
110 define mpls_route_add_del
117 u32 mr_classify_table_index;
118 u8 mr_create_table_if_needed;
122 u8 mr_is_resolve_host;
123 u8 mr_is_resolve_attached;
124 u8 mr_next_hop_proto_is_ip4;
125 u8 mr_next_hop_weight;
127 u8 mr_next_hop_n_out_labels;
128 u32 mr_next_hop_sw_if_index;
129 u32 mr_next_hop_table_id;
130 u32 mr_next_hop_via_label;
131 u32 mr_next_hop_out_label_stack[mr_next_hop_n_out_labels];
134 /** \brief Reply for MPLS route add / del request
135 @param context - returned sender context, to match reply w/ request
136 @param retval - return code
138 define mpls_route_add_del_reply
144 /** \brief Dump MPLS fib table
145 @param client_index - opaque cookie to identify the sender
154 @param sw_if_index - index of the interface
155 @param weight - The weight, for UCMP
156 @param is_local - local if non-zero, else remote
157 @param is_drop - Drop the packet
158 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
159 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
160 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
161 @param next_hop[16] - the next hop address
163 WARNING: this type is replicated, pending cleanup completion
166 typeonly manual_print manual_endian define fib_path2
178 /** \brief mpls FIB table response
179 @param table_id - MPLS fib table id
180 @param s_bit - End-of-stack bit
181 @param label - MPLS label value
182 @param count - the number of fib_path in path
183 @param path - array of of fib_path structures
185 manual_endian manual_print define mpls_fib_details
192 vl_api_fib_path2_t path[count];
195 /** \brief Bind/Unbind an MPLS local label to an IP prefix. i.e. create
196 a per-prefix label entry.
197 @param client_index - opaque cookie to identify the sender
198 @param context - sender context, to match reply w/ request
199 @param mb_mpls_table_id - The MPLS table-id the MPLS entry will be added in
200 @param mb_label - The MPLS label value to bind
201 @param mb_ip_table_id - The IP table-id of the IP prefix to bind to.
202 @param mb_create_table_if_needed - Create either/both tables if required.
203 @param mb_is_bind - Bind or unbind
204 @param mb_is_ip4 - The prefix to bind to is IPv4
205 @param mb_address_length - Length of IP prefix
206 @param mb_address[16] - IP prefix/
208 define mpls_ip_bind_unbind
212 u32 mb_mpls_table_id;
215 u8 mb_create_table_if_needed;
218 u8 mb_address_length;
222 /** \brief Reply for MPLS IP bind/unbind request
223 @param context - returned sender context, to match reply w/ request
224 @param retval - return code
226 define mpls_ip_bind_unbind_reply
232 /** \brief MPLS tunnel Add / del route
233 @param client_index - opaque cookie to identify the sender
234 @param context - sender context, to match reply w/ request
235 @param mt_is_add - Is this a route add or delete
236 @param mt_sw_if_index - The SW interface index of the tunnel to delete
237 @param mt_next_hop_proto_is_ip4 - The next-hop is IPV4
238 @param mt_next_hop_weight - The weight, for UCMP
239 @param mt_next_hop[16] - the nextop address
240 @param mt_next_hop_sw_if_index - the next-hop SW interface
241 @param mt_next_hop_table_id - the next-hop table-id (if appropriate)
242 @param mt_next_hop_n_out_labels - the number of next-hop output labels
243 @param mt_next_hop_out_label_stack - the next-hop output label stack, outer most first
245 define mpls_tunnel_add_del
252 u8 mt_next_hop_proto_is_ip4;
253 u8 mt_next_hop_weight;
255 u8 mt_next_hop_n_out_labels;
256 u32 mt_next_hop_sw_if_index;
257 u32 mt_next_hop_table_id;
258 u32 mt_next_hop_out_label_stack[mt_next_hop_n_out_labels];
261 /** \brief Reply for MPLS tunnel add / del request
262 @param context - returned sender context, to match reply w/ request
263 @param retval - return code
264 @param sw_if_index - SW interface index of the tunnel created
266 define mpls_tunnel_add_del_reply
273 /** \brief Dump mpls eth tunnel table
274 @param client_index - opaque cookie to identify the sender
275 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
277 define mpls_tunnel_dump
284 /** \brief mpls eth tunnel operational state response
285 @param tunnel_index - eth tunnel identifier
286 @param intfc_address - interface ipv4 addr
287 @param mask_width - interface ipv4 addr mask
288 @param hw_if_index - interface id
290 @param tunnel_dst_mac -
291 @param tx_sw_if_index -
292 @param encap_index - reference to mpls label table
293 @param nlabels - number of resolved labels
294 @param labels - resolved labels
296 define mpls_tunnel_details
302 u8 mt_next_hop_proto_is_ip4;
304 u32 mt_next_hop_sw_if_index;
305 u32 mt_next_hop_table_id;
306 u32 mt_next_hop_n_labels;
307 u32 mt_next_hop_out_labels[mt_next_hop_n_labels];
310 /** \brief Proxy ARP add / del request
311 @param client_index - opaque cookie to identify the sender
312 @param context - sender context, to match reply w/ request
313 @param vrf_id - VRF / Fib table ID
314 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
315 @param low_address[4] - Low address of the Proxy ARP range
316 @param hi_address[4] - High address of the Proxy ARP range
318 define proxy_arp_add_del
328 /** \brief Reply for proxy arp add / del request
329 @param context - returned sender context, to match reply w/ request
330 @param retval - return code
332 define proxy_arp_add_del_reply
338 /** \brief Proxy ARP add / del request
339 @param client_index - opaque cookie to identify the sender
340 @param context - sender context, to match reply w/ request
341 @param sw_if_index - Which interface to enable / disable Proxy Arp on
342 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
344 define proxy_arp_intfc_enable_disable
349 /* 1 = on, 0 = off */
353 /** \brief Reply for Proxy ARP interface enable / disable request
354 @param context - returned sender context, to match reply w/ request
355 @param retval - return code
357 define proxy_arp_intfc_enable_disable_reply
363 /** \brief Reset VRF (remove all routes etc) request
364 @param client_index - opaque cookie to identify the sender
365 @param context - sender context, to match reply w/ request
366 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
367 @param vrf_id - ID of th FIB table / VRF to reset
377 /** \brief Reply for Reset VRF request
378 @param context - returned sender context, to match reply w/ request
379 @param retval - return code
381 define reset_vrf_reply
387 /** \brief Is Address Reachable request - DISABLED
388 @param client_index - opaque cookie to identify the sender
389 @param context - sender context, to match reply w/ request
390 @param next_hop_sw_if_index - index of interface used to get to next hop
391 @param is_ipv6 - 1 for IPv6, 0 for IPv4
392 @param is_error - address not found or does not match intf
393 @param address[] - Address in question
395 define is_address_reachable
397 u32 client_index; /* (api_main_t *) am->my_client_index */
399 u32 next_hop_sw_if_index;
400 u8 is_known; /* on reply, this is the answer */
402 u8 is_error; /* address not found or does not match intf */
406 /** \brief Want Stats, register for stats updates
407 @param client_index - opaque cookie to identify the sender
408 @param context - sender context, to match reply w/ request
409 @param enable_disable - 1 = enable stats, 0 = disable
410 @param pid - pid of process requesting stats updates
420 /** \brief Reply for Want Stats request
421 @param context - returned sender context, to match reply w/ request
422 @param retval - return code
424 define want_stats_reply
430 typeonly manual_print manual_endian define ip4_fib_counter
438 manual_print manual_endian define vnet_ip4_fib_counters
442 vl_api_ip4_fib_counter_t c[count];
445 typeonly manual_print manual_endian define ip6_fib_counter
453 manual_print manual_endian define vnet_ip6_fib_counters
457 vl_api_ip6_fib_counter_t c[count];
460 /** \brief Request for a single block of summary stats
461 @param client_index - opaque cookie to identify the sender
462 @param context - sender context, to match reply w/ request
464 define vnet_get_summary_stats
470 /** \brief Reply for vnet_get_summary_stats request
471 @param context - sender context, to match reply w/ request
472 @param retval - return code for request
477 define vnet_summary_stats_reply
486 /** \brief OAM event structure
487 @param dst_address[] -
496 /** \brief Want OAM events request
497 @param client_index - opaque cookie to identify the sender
498 @param context - sender context, to match reply w/ request
499 @param enable_disable- enable if non-zero, else disable
500 @param pid - pid of the requesting process
502 define want_oam_events
510 /** \brief Want OAM events response
511 @param context - sender context, to match reply w/ request
512 @param retval - return code for the want oam stats request
514 define want_oam_events_reply
520 /** \brief OAM add / del target request
521 @param client_index - opaque cookie to identify the sender
522 @param context - sender context, to match reply w/ request
523 @param vrf_id - vrf_id of the target
524 @param src_address[] - source address to use for the updates
525 @param dst_address[] - destination address of the target
526 @param is_add - add target if non-zero, else delete
538 /** \brief OAM add / del target response
539 @param context - sender context, to match reply w/ request
540 @param retval - return code of the request
542 define oam_add_del_reply
548 /** \brief Reset fib table request
549 @param client_index - opaque cookie to identify the sender
550 @param context - sender context, to match reply w/ request
551 @param vrf_id - vrf/table id of the fib table to reset
552 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
562 /** \brief Reset fib response
563 @param context - sender context, to match reply w/ request
564 @param retval - return code for the reset bfib request
566 define reset_fib_reply
572 /** \brief DHCP Proxy config add / del request
573 @param client_index - opaque cookie to identify the sender
574 @param context - sender context, to match reply w/ request
575 @param vrf_id - vrf id
576 @param if_ipv6 - ipv6 if non-zero, else ipv4
577 @param is_add - add the config if non-zero, else delete
578 @param insert_circuit_id - option82 suboption 1 fib number
579 @param dhcp_server[] - server address
580 @param dhcp_src_address[] - <fix this, need details>
582 define dhcp_proxy_config
589 u8 insert_circuit_id;
591 u8 dhcp_src_address[16];
594 /** \brief DHCP Proxy config response
595 @param context - sender context, to match reply w/ request
596 @param retval - return code for the request
598 define dhcp_proxy_config_reply
604 /** \brief DHCP Proxy set / unset vss request
605 @param client_index - opaque cookie to identify the sender
606 @param context - sender context, to match reply w/ request
607 @param tbl_id - table id
608 @param oui - first part of vpn id
609 @param fib_id - second part of vpn id
610 @param is_ipv6 - ip6 if non-zero, else ip4
611 @param is_add - set vss if non-zero, else delete
613 define dhcp_proxy_set_vss
624 /** \brief DHCP proxy set / unset vss response
625 @param context - sender context, to match reply w/ request
626 @param retval - return code for the request
628 define dhcp_proxy_set_vss_reply
634 /** \brief Create loopback interface request
635 @param client_index - opaque cookie to identify the sender
636 @param context - sender context, to match reply w/ request
637 @param mac_address - mac addr to assign to the interface if none-zero
639 define create_loopback
646 /** \brief Create loopback interface response
647 @param context - sender context, to match reply w/ request
648 @param sw_if_index - sw index of the interface that was created
649 @param retval - return code for the request
651 define create_loopback_reply
658 /** \brief Delete loopback interface request
659 @param client_index - opaque cookie to identify the sender
660 @param context - sender context, to match reply w/ request
661 @param sw_if_index - sw index of the interface that was created
663 define delete_loopback
670 /** \brief Delete loopback interface response
671 @param context - sender context, to match reply w/ request
672 @param retval - return code for the request
674 define delete_loopback_reply
680 /** \brief Control ping from client to api server request
681 @param client_index - opaque cookie to identify the sender
682 @param context - sender context, to match reply w/ request
690 /** \brief Control ping from the client to the server response
691 @param client_index - opaque cookie to identify the sender
692 @param context - sender context, to match reply w/ request
693 @param retval - return code for the request
694 @param vpe_pid - the pid of the vpe, returned by the server
696 define control_ping_reply
704 /** \brief Process a vpe parser cli string request
705 @param client_index - opaque cookie to identify the sender
706 @param context - sender context, to match reply w/ request
707 @param cmd_in_shmem - pointer to cli command string
723 /** \brief vpe parser cli string response
724 @param context - sender context, to match reply w/ request
725 @param retval - return code for request
726 @param reply_in_shmem - Reply string from cli processing if any
734 define cli_inband_reply
742 /** \brief Set max allowed ARP or ip6 neighbor entries request
743 @param client_index - opaque cookie to identify the sender
744 @param context - sender context, to match reply w/ request
745 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
746 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
748 define set_arp_neighbor_limit
753 u32 arp_neighbor_limit;
756 /** \brief Set max allowed ARP or ip6 neighbor entries response
757 @param context - sender context, to match reply w/ request
758 @param retval - return code for request
760 define set_arp_neighbor_limit_reply
766 /** \brief L2 interface patch add / del request
767 @param client_index - opaque cookie to identify the sender
768 @param context - sender context, to match reply w/ request
769 @param rx_sw_if_index - receive side interface
770 @param tx_sw_if_index - transmit side interface
771 @param is_add - if non-zero set up the interface patch, else remove it
773 define l2_patch_add_del
782 /** \brief L2 interface patch add / del response
783 @param context - sender context, to match reply w/ request
784 @param retval - return code for the request
786 define l2_patch_add_del_reply
792 /** \brief IPv6 segment routing tunnel add / del request
793 @param client_index - opaque cookie to identify the sender
794 @param context - sender context, to match reply w/ request
795 @param is_add - add the tunnel if non-zero, else delete it
796 @param name[] - tunnel name (len. 64)
797 @param src_address[] -
798 @param dst_address[] -
799 @param dst_mask_width -
800 @param inner_vrf_id -
801 @param outer_vrf_id -
802 @param flags_net_byte_order -
805 @param segs_and_tags[] -
806 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
808 define sr_tunnel_add_del
819 u16 flags_net_byte_order;
826 /** \brief IPv6 segment routing tunnel add / del response
827 @param context - sender context, to match reply w/ request
828 @param retval - return value for request
830 define sr_tunnel_add_del_reply
836 /** \brief IPv6 segment routing policy add / del request
837 @param client_index - opaque cookie to identify the sender
838 @param context - sender context, to match reply w/ request
839 @param is_add - add the tunnel if non-zero, else delete it
840 @param name[] - policy name (len. 64)
841 @param tunnel_names[] -
843 define sr_policy_add_del
852 /** \brief IPv6 segment routing policy add / del response
853 @param context - sender context, to match reply w/ request
854 @param retval - return value for request
856 define sr_policy_add_del_reply
862 /** \brief IPv6 segment routing multicast map to policy add / del request
863 @param client_index - opaque cookie to identify the sender
864 @param context - sender context, to match reply w/ request
865 @param is_add - add the tunnel if non-zero, else delete it
866 @param multicast_address[] - IP6 multicast address
867 @param policy_name[] = policy name (len.64)
869 define sr_multicast_map_add_del
874 u8 multicast_address[16];
878 /** \brief IPv6 segment routing multicast map to policy add / del response
879 @param context - sender context, to match reply w/ request
880 @param retval - return value for request
882 define sr_multicast_map_add_del_reply
888 /** \brief Interface set vpath request
889 @param client_index - opaque cookie to identify the sender
890 @param context - sender context, to match reply w/ request
891 @param sw_if_index - interface used to reach neighbor
892 @param enable - if non-zero enable, else disable
894 define sw_interface_set_vpath
902 /** \brief Interface set vpath response
903 @param context - sender context, to match reply w/ request
904 @param retval - return code for the request
906 define sw_interface_set_vpath_reply
912 /** \brief Set L2 XConnect between two interfaces request
913 @param client_index - opaque cookie to identify the sender
914 @param context - sender context, to match reply w/ request
915 @param rx_sw_if_index - Receive interface index
916 @param tx_sw_if_index - Transmit interface index
917 @param enable - enable xconnect if not 0, else set to L3 mode
919 define sw_interface_set_l2_xconnect
928 /** \brief Set L2 XConnect response
929 @param context - sender context, to match reply w/ request
930 @param retval - L2 XConnect request return code
932 define sw_interface_set_l2_xconnect_reply
938 /** \brief Interface bridge mode request
939 @param client_index - opaque cookie to identify the sender
940 @param context - sender context, to match reply w/ request
941 @param rx_sw_if_index - the interface
942 @param bd_id - bridge domain id
943 @param bvi - Setup interface as a bvi, bridge mode only
944 @param shg - Shared horizon group, for bridge mode only
945 @param enable - Enable beige mode if not 0, else set to L3 mode
947 define sw_interface_set_l2_bridge
958 /** \brief Interface bridge mode response
959 @param context - sender context, to match reply w/ request
960 @param retval - Bridge mode request return code
962 define sw_interface_set_l2_bridge_reply
968 /** \brief L2 FIB add entry request
969 @param client_index - opaque cookie to identify the sender
970 @param context - sender context, to match reply w/ request
971 @param mac - the entry's mac address
972 @param bd_id - the entry's bridge domain id
973 @param sw_if_index - the interface
974 @param is_add - If non zero add the entry, else delete it
991 /** \brief L2 FIB add entry response
992 @param context - sender context, to match reply w/ request
993 @param retval - return code for the add l2fib entry request
995 define l2fib_add_del_reply
1001 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1002 @param client_index - opaque cookie to identify the sender
1003 @param context - sender context, to match reply w/ request
1004 @param sw_if_index - interface
1005 @param is_set - if non-zero, set the bits, else clear them
1006 @param feature_bitmap - non-zero bits to set or clear
1017 /** \brief Set L2 bits response
1018 @param context - sender context, to match reply w/ request
1019 @param retval - return code for the set l2 bits request
1021 define l2_flags_reply
1025 u32 resulting_feature_bitmap;
1028 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1029 L2_UU_FLOOD, or L2_ARP_TERM) request
1030 @param client_index - opaque cookie to identify the sender
1031 @param context - sender context, to match reply w/ request
1032 @param bd_id - the bridge domain to set the flags for
1033 @param is_set - if non-zero, set the flags, else clear them
1034 @param feature_bitmap - bits that are non-zero to set or clear
1045 /** \brief Set bridge flags response
1046 @param context - sender context, to match reply w/ request
1047 @param retval - return code for the set bridge flags request
1048 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1050 define bridge_flags_reply
1054 u32 resulting_feature_bitmap;
1057 /** \brief Set bridge domain ip to mac entry request
1058 @param client_index - opaque cookie to identify the sender
1059 @param context - sender context, to match reply w/ request
1060 @param bd_id - the bridge domain to set the flags for
1061 @param is_add - if non-zero, add the entry, else clear it
1062 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1063 @param mac_address - MAC address
1066 define bd_ip_mac_add_del
1077 /** \brief Set bridge domain ip to mac entry response
1078 @param context - sender context, to match reply w/ request
1079 @param retval - return code for the set bridge flags request
1081 define bd_ip_mac_add_del_reply
1087 /** \brief Add/Delete classification table request
1088 @param client_index - opaque cookie to identify the sender
1089 @param context - sender context, to match reply w/ request
1090 @param is_add- if non-zero add the table, else delete it
1091 @param del_chain - if non-zero delete the whole chain of tables
1092 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1093 @param nbuckets - number of buckets when adding a table
1094 @param memory_size - memory size when adding a table
1095 @param match_n_vectors - number of match vectors
1096 @param next_table_index - index of next table
1097 @param miss_next_index - index of miss table
1098 @param current_data_flag - option to use current node's packet payload
1099 as the starting point from where packets are classified,
1100 This option is only valid for L2/L3 input ACL for now.
1101 0: by default, classify data from the buffer's start location
1102 1: classify packets from VPP node’s current data pointer
1103 @param current_data_offset - a signed value to shift the start location of
1104 the packet to be classified
1105 For example, if input IP ACL node is used, L2 header’s first byte
1106 can be accessible by configuring current_data_offset to -14
1107 if there is no vlan tag.
1108 This is valid only if current_data_flag is set to 1.
1109 @param mask[] - match mask
1111 define classify_add_del_table
1121 u32 match_n_vectors;
1122 u32 next_table_index;
1123 u32 miss_next_index;
1124 u32 current_data_flag;
1125 i32 current_data_offset;
1129 /** \brief Add/Delete classification table response
1130 @param context - sender context, to match reply w/ request
1131 @param retval - return code for the table add/del requst
1132 @param new_table_index - for add, returned index of the new table
1133 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1134 @param match_n_vectors -for add, returned value of match_n_vectors in table
1136 define classify_add_del_table_reply
1140 u32 new_table_index;
1142 u32 match_n_vectors;
1145 /** \brief Classify add / del session request
1146 @param client_index - opaque cookie to identify the sender
1147 @param context - sender context, to match reply w/ request
1148 @param is_add - add session if non-zero, else delete
1149 @param table_index - index of the table to add/del the session, required
1150 @param hit_next_index - for add, hit_next_index of new session, required
1151 @param opaque_index - for add, opaque_index of new session
1152 @param advance -for add, advance value for session
1154 0: no action (by default)
1155 metadata is not used.
1156 1: Classified IP packets will be looked up from the
1157 specified ipv4 fib table (configured by metadata as VRF id).
1158 Only valid for L3 input ACL node
1159 2: Classified IP packets will be looked up from the
1160 specified ipv6 fib table (configured by metadata as VRF id).
1161 Only valid for L3 input ACL node
1162 @param metadata - valid only if action != 0
1163 VRF id if action is 1 or 2.
1164 @param match[] - for add, match value for session, required
1166 define classify_add_del_session
1180 /** \brief Classify add / del session response
1181 @param context - sender context, to match reply w/ request
1182 @param retval - return code for the add/del session request
1184 define classify_add_del_session_reply
1190 /** \brief Set/unset the classification table for an interface request
1191 @param client_index - opaque cookie to identify the sender
1192 @param context - sender context, to match reply w/ request
1193 @param is_ipv6 - ipv6 if non-zero, else ipv4
1194 @param sw_if_index - interface to associate with the table
1195 @param table_index - index of the table, if ~0 unset the table
1197 define classify_set_interface_ip_table
1203 u32 table_index; /* ~0 => off */
1206 /** \brief Set/unset interface classification table response
1207 @param context - sender context, to match reply w/ request
1208 @param retval - return code
1210 define classify_set_interface_ip_table_reply
1216 /** \brief Set/unset l2 classification tables for an interface request
1217 @param client_index - opaque cookie to identify the sender
1218 @param context - sender context, to match reply w/ request
1219 @param sw_if_index - interface to set/unset tables for
1220 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1221 @param ip6_table_index - ip6 index
1222 @param other_table_index - other index
1224 define classify_set_interface_l2_tables
1230 u32 ip4_table_index;
1231 u32 ip6_table_index;
1232 u32 other_table_index;
1236 /** \brief Set/unset l2 classification tables for an interface response
1237 @param context - sender context, to match reply w/ request
1238 @param retval - return code for the request
1240 define classify_set_interface_l2_tables_reply
1246 /** \brief Get node index using name request
1247 @param client_index - opaque cookie to identify the sender
1248 @param context - sender context, to match reply w/ request
1249 @param node_name[] - name of the node
1251 define get_node_index
1258 /** \brief Get node index using name request
1259 @param context - sender context, to match reply w/ request
1260 @param retval - return code for the request
1261 @param node_index - index of the desired node if found, else ~0
1263 define get_node_index_reply
1270 /** \brief Set the next node for a given node request
1271 @param client_index - opaque cookie to identify the sender
1272 @param context - sender context, to match reply w/ request
1273 @param node_name[] - node to add the next node to
1274 @param next_name[] - node to add as the next node
1276 define add_node_next
1284 /** \brief IP Set the next node for a given node response
1285 @param context - sender context, to match reply w/ request
1286 @param retval - return code for the add next node request
1287 @param next_index - the index of the next node if success, else ~0
1289 define add_node_next_reply
1296 /** \brief DHCP Proxy config 2 add / del request
1297 @param client_index - opaque cookie to identify the sender
1298 @param context - sender context, to match reply w/ request
1299 @param rx_vrf_id - receive vrf id
1300 @param server_vrf_id - server vrf id
1301 @param if_ipv6 - ipv6 if non-zero, else ipv4
1302 @param is_add - add the config if non-zero, else delete
1303 @param insert_circuit_id - option82 suboption 1 fib number
1304 @param dhcp_server[] - server address
1305 @param dhcp_src_address[] - <fix this, need details>
1307 define dhcp_proxy_config_2
1315 u8 insert_circuit_id;
1317 u8 dhcp_src_address[16];
1320 /** \brief DHCP Proxy config 2 add / del response
1321 @param context - sender context, to match reply w/ request
1322 @param retval - return code for request
1324 define dhcp_proxy_config_2_reply
1330 /** \brief l2tpv3 tunnel interface create request
1331 @param client_index - opaque cookie to identify the sender
1332 @param context - sender context, to match reply w/ request
1333 @param client_address - remote client tunnel ip address
1334 @param client_address - local tunnel ip address
1335 @param is_ipv6 - ipv6 if non-zero, else ipv4
1336 @param local_session_id - local tunnel session id
1337 @param remote_session_id - remote tunnel session id
1338 @param local_cookie - local tunnel cookie
1339 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1340 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1342 define l2tpv3_create_tunnel
1346 u8 client_address[16];
1349 u32 local_session_id;
1350 u32 remote_session_id;
1353 u8 l2_sublayer_present;
1357 /** \brief l2tpv3 tunnel interface create response
1358 @param context - sender context, to match reply w/ request
1359 @param retval - return code for the request
1360 @param sw_if_index - index of the new tunnel interface
1362 define l2tpv3_create_tunnel_reply
1369 define l2tpv3_set_tunnel_cookies
1374 u64 new_local_cookie;
1375 u64 new_remote_cookie;
1378 /** \brief L2TP tunnel set cookies response
1379 @param context - sender context, to match reply w/ request
1380 @param retval - return code for the request
1382 define l2tpv3_set_tunnel_cookies_reply
1388 define sw_if_l2tpv3_tunnel_details
1392 u8 interface_name[64];
1393 u8 client_address[16];
1395 u32 local_session_id;
1396 u32 remote_session_id;
1397 u64 local_cookie[2];
1399 u8 l2_sublayer_present;
1402 define sw_if_l2tpv3_tunnel_dump
1408 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1409 @param client_index - opaque cookie to identify the sender
1410 @param context - sender context, to match reply w/ request
1412 define l2_fib_clear_table
1418 /** \brief L2 fib clear table response
1419 @param context - sender context, to match reply w/ request
1420 @param retval - return code for the request
1422 define l2_fib_clear_table_reply
1428 /** \brief L2 interface ethernet flow point filtering enable/disable request
1429 @param client_index - opaque cookie to identify the sender
1430 @param context - sender context, to match reply w/ request
1431 @param sw_if_index - interface to enable/disable filtering on
1432 @param enable_disable - if non-zero enable filtering, else disable
1434 define l2_interface_efp_filter
1442 /** \brief L2 interface ethernet flow point filtering response
1443 @param context - sender context, to match reply w/ request
1444 @param retval - return code for the request
1446 define l2_interface_efp_filter_reply
1452 define l2tpv3_interface_enable_disable
1460 define l2tpv3_interface_enable_disable_reply
1466 define l2tpv3_set_lookup_key
1470 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1474 define l2tpv3_set_lookup_key_reply
1480 define gre_add_del_tunnel
1492 define gre_add_del_tunnel_reply
1499 define gre_tunnel_dump
1506 define gre_tunnel_details
1517 /** \brief L2 interface vlan tag rewrite configure request
1518 @param client_index - opaque cookie to identify the sender
1519 @param context - sender context, to match reply w/ request
1520 @param sw_if_index - interface the operation is applied to
1521 @param vtr_op - Choose from l2_vtr_op_t enum values
1522 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1523 @param tag1 - Needed for any push or translate vtr op
1524 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1526 define l2_interface_vlan_tag_rewrite
1532 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1533 u32 tag1; // first pushed tag
1534 u32 tag2; // second pushed tag
1537 /** \brief L2 interface vlan tag rewrite response
1538 @param context - sender context, to match reply w/ request
1539 @param retval - return code for the request
1541 define l2_interface_vlan_tag_rewrite_reply
1554 /* These fields map directly onto the subif template */
1558 u8 dot1ad; // 0 = dot1q, 1=dot1ad
1561 u8 outer_vlan_id_any;
1562 u8 inner_vlan_id_any;
1567 define create_subif_reply
1574 /** \brief show version
1575 @param client_index - opaque cookie to identify the sender
1576 @param context - sender context, to match reply w/ request
1584 /** \brief show version response
1585 @param context - sender context, to match reply w/ request
1586 @param retval - return code for the request
1587 @param program - name of the program (vpe)
1588 @param version - version of the program
1589 @param build_directory - root of the workspace where the program was built
1591 define show_version_reply
1598 u8 build_directory[256];
1601 /** \brief l2 fib table entry structure
1602 @param bd_id - the l2 fib / bridge domain table id
1603 @param mac - the entry's mac address
1604 @param sw_if_index - index of the interface
1605 @param static_mac - the entry is statically configured.
1606 @param filter_mac - the entry is a mac filter entry.
1607 @param bvi_mac - the mac address is a bridge virtual interface
1609 define l2_fib_table_entry
1620 /** \brief Dump l2 fib (aka bridge domain) table
1621 @param client_index - opaque cookie to identify the sender
1622 @param bd_id - the l2 fib / bridge domain table identifier
1624 define l2_fib_table_dump
1631 /** \brief add or delete locator_set
1632 @param client_index - opaque cookie to identify the sender
1633 @param context - sender context, to match reply w/ request
1634 @param is_add - add address if non-zero, else delete
1635 @param locator_set_name - locator name
1636 @param locator_num - number of locators
1637 @param locators - LISP locator records
1638 Structure of one locator record is as follows:
1646 define lisp_add_del_locator_set
1651 u8 locator_set_name[64];
1656 /** \brief Reply for locator_set add/del
1657 @param context - returned sender context, to match reply w/ request
1658 @param retval - return code
1659 @param ls_index - locator set index
1661 define lisp_add_del_locator_set_reply
1668 /** \brief add or delete locator for locator_set
1669 @param client_index - opaque cookie to identify the sender
1670 @param context - sender context, to match reply w/ request
1671 @param is_add - add address if non-zero, else delete
1672 @param locator_set_name - name of locator_set to add/del locator
1673 @param sw_if_index - index of the interface
1674 @param priority - priority of the lisp locator
1675 @param weight - weight of the lisp locator
1677 define lisp_add_del_locator
1682 u8 locator_set_name[64];
1688 /** \brief Reply for locator add/del
1689 @param context - returned sender context, to match reply w/ request
1690 @param retval - return code
1692 define lisp_add_del_locator_reply
1698 /** \brief add or delete lisp eid-table
1699 @param client_index - opaque cookie to identify the sender
1700 @param context - sender context, to match reply w/ request
1701 @param is_add - add address if non-zero, else delete
1706 @param eid - EID can be ip4, ip6 or mac
1707 @param prefix_len - prefix len
1708 @param locator_set_name - name of locator_set to add/del eid-table
1709 @param vni - virtual network instance
1714 @param key - secret key
1716 define lisp_add_del_local_eid
1724 u8 locator_set_name[64];
1730 /** \brief Reply for local_eid add/del
1731 @param context - returned sender context, to match reply w/ request
1732 @param retval - return code
1734 define lisp_add_del_local_eid_reply
1740 /** \brief add or delete lisp gpe tunnel
1741 @param client_index - opaque cookie to identify the sender
1742 @param context - sender context, to match reply w/ request
1743 @param is_add - add address if non-zero, else delete
1748 @param rmt_eid - remote eid
1749 @param lcl_eid - local eid
1750 @param rmt_len - remote prefix len
1751 @param lcl_len - local prefix len
1752 @param vni - virtual network identifier
1753 @param dp_table - vrf/bridge domain id
1754 @param loc_num - number of locators
1755 @param lcl_locs - array of local locators
1756 @param rmt_locs - array of remote locators
1757 @param action - negative action when 0 locators configured
1759 define lisp_gpe_add_del_fwd_entry
1772 u8 lcl_locs[loc_num];
1773 u8 rmt_locs[loc_num];
1777 /** \brief Reply for gpe_fwd_entry add/del
1778 @param context - returned sender context, to match reply w/ request
1779 @param retval - return code
1781 define lisp_gpe_add_del_fwd_entry_reply
1787 /** \brief Add/delete map server
1788 @param client_index - opaque cookie to identify the sender
1789 @param context - sender context, to match reply w/ request
1790 @param is_add - add address if non-zero; delete otherwise
1791 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
1792 @param ip_address - map server IP address
1794 define lisp_add_del_map_server
1803 /** \brief Reply for lisp_add_del_map_server
1804 @param context - returned sender context, to match reply w/ request
1805 @param retval - return code
1807 define lisp_add_del_map_server_reply
1813 /** \brief add or delete map-resolver
1814 @param client_index - opaque cookie to identify the sender
1815 @param context - sender context, to match reply w/ request
1816 @param is_add - add address if non-zero, else delete
1817 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
1818 @param ip_address - array of address bytes
1820 define lisp_add_del_map_resolver
1829 /** \brief Reply for map_resolver add/del
1830 @param context - returned sender context, to match reply w/ request
1831 @param retval - return code
1833 define lisp_add_del_map_resolver_reply
1839 /** \brief enable or disable lisp-gpe protocol
1840 @param client_index - opaque cookie to identify the sender
1841 @param context - sender context, to match reply w/ request
1842 @param is_en - enable protocol if non-zero, else disable
1844 define lisp_gpe_enable_disable
1851 /** \brief Reply for gpe enable/disable
1852 @param context - returned sender context, to match reply w/ request
1853 @param retval - return code
1855 define lisp_gpe_enable_disable_reply
1861 /** \brief enable or disable LISP feature
1862 @param client_index - opaque cookie to identify the sender
1863 @param context - sender context, to match reply w/ request
1864 @param is_en - enable protocol if non-zero, else disable
1866 define lisp_enable_disable
1873 /** \brief Reply for gpe enable/disable
1874 @param context - returned sender context, to match reply w/ request
1875 @param retval - return code
1877 define lisp_enable_disable_reply
1883 /** \brief add or delete gpe_iface
1884 @param client_index - opaque cookie to identify the sender
1885 @param context - sender context, to match reply w/ request
1886 @param is_add - add address if non-zero, else delete
1888 define lisp_gpe_add_del_iface
1898 /** \brief Reply for gpe_iface add/del
1899 @param context - returned sender context, to match reply w/ request
1900 @param retval - return code
1902 define lisp_gpe_add_del_iface_reply
1908 /** \brief configure or disable LISP PITR node
1909 @param client_index - opaque cookie to identify the sender
1910 @param context - sender context, to match reply w/ request
1911 @param ls_name - locator set name
1912 @param is_add - add locator set if non-zero, else disable pitr
1914 define lisp_pitr_set_locator_set
1922 /** \brief Reply for lisp_pitr_set_locator_set
1923 @param context - returned sender context, to match reply w/ request
1924 @param retval - return code
1926 define lisp_pitr_set_locator_set_reply
1932 /** \brief Get state of LISP RLOC probing
1933 @param client_index - opaque cookie to identify the sender
1934 @param context - sender context, to match reply w/ request
1936 define show_lisp_rloc_probe_state
1942 /** \brief Reply for show_lisp_rloc_probe_state
1943 @param context - returned sender context, to match reply w/ request
1944 @param retval - return code
1945 @param is_enabled - state of RLOC probing
1947 define show_lisp_rloc_probe_state_reply
1954 /** \brief enable/disable LISP RLOC probing
1955 @param client_index - opaque cookie to identify the sender
1956 @param context - sender context, to match reply w/ request
1957 @param is_enable - enable if non-zero; disable otherwise
1959 define lisp_rloc_probe_enable_disable
1966 /** \brief Reply for lisp_rloc_probe_enable_disable
1967 @param context - returned sender context, to match reply w/ request
1968 @param retval - return code
1970 define lisp_rloc_probe_enable_disable_reply
1976 /** \brief enable/disable LISP map-register
1977 @param client_index - opaque cookie to identify the sender
1978 @param context - sender context, to match reply w/ request
1979 @param is_enable - enable if non-zero; disable otherwise
1981 define lisp_map_register_enable_disable
1988 /** \brief Reply for lisp_map_register_enable_disable
1989 @param context - returned sender context, to match reply w/ request
1990 @param retval - return code
1992 define lisp_map_register_enable_disable_reply
1998 /** \brief Get state of LISP map-register
1999 @param client_index - opaque cookie to identify the sender
2000 @param context - sender context, to match reply w/ request
2002 define show_lisp_map_register_state
2008 /** \brief Reply for show_lisp_map_register_state
2009 @param context - returned sender context, to match reply w/ request
2010 @param retval - return code
2012 define show_lisp_map_register_state_reply
2019 /** \brief set LISP map-request mode. Based on configuration VPP will send
2020 src/dest or just normal destination map requests.
2021 @param client_index - opaque cookie to identify the sender
2022 @param context - sender context, to match reply w/ request
2023 @param mode - new map-request mode. Supported values are:
2024 0 - destination only
2025 1 - source/destaination
2027 define lisp_map_request_mode
2034 /** \brief Reply for lisp_map_request_mode
2035 @param context - returned sender context, to match reply w/ request
2036 @param retval - return code
2038 define lisp_map_request_mode_reply
2044 /** \brief Request for LISP map-request mode
2045 @param client_index - opaque cookie to identify the sender
2046 @param context - sender context, to match reply w/ request
2048 define show_lisp_map_request_mode
2054 /** \brief Reply for show_lisp_map_request_mode
2055 @param context - returned sender context, to match reply w/ request
2056 @param retval - return code
2057 @param mode - map-request mode
2059 define show_lisp_map_request_mode_reply
2066 /** \brief add or delete remote static mapping
2067 @param client_index - opaque cookie to identify the sender
2068 @param context - sender context, to match reply w/ request
2069 @param is_add - add address if non-zero, else delete
2070 @param is_src_dst - flag indicating src/dst based routing policy
2071 @param del_all - if set, delete all remote mappings
2072 @param vni - virtual network instance
2073 @param action - negative map-reply action
2078 @param deid - dst EID
2079 @param seid - src EID, valid only if is_src_dst is enabled
2080 @param rloc_num - number of remote locators
2081 @param rlocs - remote locator records
2082 Structure of remote locator:
2091 define lisp_add_del_remote_mapping
2109 /** \brief Reply for lisp_add_del_remote_mapping
2110 @param context - returned sender context, to match reply w/ request
2111 @param retval - return code
2113 define lisp_add_del_remote_mapping_reply
2119 /** \brief add or delete LISP adjacency adjacency
2120 @param client_index - opaque cookie to identify the sender
2121 @param context - sender context, to match reply w/ request
2122 @param is_add - add address if non-zero, else delete
2123 @param vni - virtual network instance
2128 @param reid - remote EID
2129 @param leid - local EID
2131 define lisp_add_del_adjacency
2144 /** \brief Reply for lisp_add_del_adjacency
2145 @param context - returned sender context, to match reply w/ request
2146 @param retval - return code
2148 define lisp_add_del_adjacency_reply
2154 /** \brief add or delete map request itr rlocs
2155 @param client_index - opaque cookie to identify the sender
2156 @param context - sender context, to match reply w/ request
2157 @param is_add - add address if non-zero, else delete
2158 @param locator_set_name - locator set name
2160 define lisp_add_del_map_request_itr_rlocs
2165 u8 locator_set_name[64];
2168 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2169 @param context - returned sender context, to match reply w/ request
2170 @param retval - return code
2173 define lisp_add_del_map_request_itr_rlocs_reply
2179 /** \brief map/unmap vni/bd_index to vrf
2180 @param client_index - opaque cookie to identify the sender
2181 @param context - sender context, to match reply w/ request
2182 @param is_add - add or delete mapping
2183 @param dp_table - virtual network id/bridge domain index
2186 define lisp_eid_table_add_del_map
2196 /** \brief Reply for lisp_eid_table_add_del_map
2197 @param context - returned sender context, to match reply w/ request
2198 @param retval - return code
2200 define lisp_eid_table_add_del_map_reply
2206 /** \brief Request for map lisp locator status
2207 @param client_index - opaque cookie to identify the sender
2208 @param context - sender context, to match reply w/ request
2209 @param locator_set_index - index of locator_set
2210 @param ls_name - locator set name
2211 @param is_index_set - flag indicating whether ls_name or ls_index is set
2213 define lisp_locator_dump
2222 /** \brief LISP locator_set status
2223 @param local - if is set, then locator is local
2224 @param locator_set_name - name of the locator_set
2225 @param sw_if_index - sw_if_index of the locator
2226 @param priority - locator priority
2227 @param weight - locator weight
2229 define lisp_locator_details
2240 /** \brief LISP locator_set status
2241 @param context - sender context, to match reply w/ request
2242 @param ls_index - locator set index
2243 @param ls_name - name of the locator set
2245 define lisp_locator_set_details
2252 /** \brief Request for locator_set summary status
2253 @param client_index - opaque cookie to identify the sender
2254 @param context - sender context, to match reply w/ request
2255 @param filter - filter type
2258 1: local locator sets
2259 2: remote locator sets
2261 define lisp_locator_set_dump
2268 /** \brief Dump lisp eid-table
2269 @param client_index - opaque cookie to identify the sender
2270 @param context - sender context, to match reply w/ request
2271 @param locator_set_index - index of locator_set, if ~0 then the mapping
2273 @param action - negative map request action
2274 @param is_local - local if non-zero, else remote
2279 @param is_src_dst - EID is type of source/destination
2280 @param eid - EID can be ip4, ip6 or mac
2281 @param eid_prefix_len - prefix length
2282 @param seid - source EID can be ip4, ip6 or mac
2283 @param seid_prefix_len - source prefix length
2284 @param vni - virtual network instance
2285 @param ttl - time to live
2286 @param authoritative - authoritative
2291 @param key - secret key
2294 define lisp_eid_table_details
2297 u32 locator_set_index;
2313 /** \brief Request for eid table summary status
2314 @param client_index - opaque cookie to identify the sender
2315 @param context - sender context, to match reply w/ request
2316 @param eid_set - if non-zero request info about specific mapping
2317 @param vni - virtual network instance; valid only if eid_set != 0
2318 @param prefix_length - prefix length if EID is IP address;
2319 valid only if eid_set != 0
2320 @param eid_type - EID type; valid only if eid_set != 0
2324 2: EID is ethernet address
2325 @param eid - endpoint identifier
2326 @param filter - filter type;
2332 define lisp_eid_table_dump
2344 /** \brief LISP adjacency
2349 @param reid - remote EID
2350 @param leid - local EID
2351 @param reid_prefix_len - remote EID IP prefix length
2352 @param leid_prefix_len - local EID IP prefix length
2354 typeonly manual_print manual_endian define lisp_adjacency
2363 /** \brief LISP adjacency reply
2364 @param count - number of adjacencies
2365 @param adjacencies - array of adjacencies
2367 manual_endian manual_print define lisp_adjacencies_get_reply
2372 vl_api_lisp_adjacency_t adjacencies[count];
2375 /** \brief Request for LISP adjacencies
2376 @param client_index - opaque cookie to identify the sender
2377 @param context - sender context, to match reply w/ request
2378 @param vni - filter adjacencies by VNI
2380 define lisp_adjacencies_get
2387 /** \brief Shows relationship between vni and vrf/bd
2388 @param dp_table - VRF index or bridge domain index
2389 @param vni - vitual network instance
2391 define lisp_eid_table_map_details
2398 /** \brief Request for lisp_eid_table_map_details
2399 @param client_index - opaque cookie to identify the sender
2400 @param context - sender context, to match reply w/ request
2401 @param is_l2 - if set dump vni/bd mappings else vni/vrf
2403 define lisp_eid_table_map_dump
2410 /** \brief Dumps all VNIs used in mappings
2411 @param client_index - opaque cookie to identify the sender
2412 @param context - sender context, to match reply w/ request
2414 define lisp_eid_table_vni_dump
2420 /** \brief reply to lisp_eid_table_vni_dump
2421 @param client_index - opaque cookie to identify the sender
2422 @param context - sender context, to match reply w/ request
2423 @param vni - virtual network instance
2425 define lisp_eid_table_vni_details
2432 define lisp_gpe_tunnel_details
2438 u8 destination_ip[16];
2450 /** \brief Request for gpe tunnel summary status
2451 @param client_index - opaque cookie to identify the sender
2452 @param context - sender context, to match reply w/ request
2454 define lisp_gpe_tunnel_dump
2460 /** \brief LISP map resolver status
2461 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2462 @param ip_address - array of address bytes
2464 define lisp_map_resolver_details
2471 /** \brief Request for map resolver summary status
2472 @param client_index - opaque cookie to identify the sender
2473 @param context - sender context, to match reply w/ request
2475 define lisp_map_resolver_dump
2481 /** \brief LISP map server details
2482 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2483 @param ip_address - array of address bytes
2485 define lisp_map_server_details
2492 /** \brief Request for map server summary status
2493 @param client_index - opaque cookie to identify the sender
2494 @param context - sender context, to match reply w/ request
2496 define lisp_map_server_dump
2502 /** \brief Request for lisp-gpe protocol status
2503 @param client_index - opaque cookie to identify the sender
2504 @param context - sender context, to match reply w/ request
2506 define show_lisp_status
2512 /** \brief Status of lisp, enable or disable
2513 @param context - sender context, to match reply w/ request
2514 @param feature_status - lisp enable if non-zero, else disable
2515 @param gpe_status - lisp enable if non-zero, else disable
2517 define show_lisp_status_reply
2525 /** \brief Get LISP map request itr rlocs status
2526 @param context - sender context, to match reply w/ request
2527 @param locator_set_name - name of the locator_set
2529 define lisp_get_map_request_itr_rlocs
2535 /** \brief Request for map request itr rlocs summary status
2537 define lisp_get_map_request_itr_rlocs_reply
2541 u8 locator_set_name[64];
2544 /** \brief Request for lisp pitr status
2545 @param client_index - opaque cookie to identify the sender
2546 @param context - sender context, to match reply w/ request
2548 define show_lisp_pitr
2554 /** \brief Status of lisp pitr, enable or disable
2555 @param context - sender context, to match reply w/ request
2556 @param status - lisp pitr enable if non-zero, else disable
2557 @param locator_set_name - name of the locator_set
2559 define show_lisp_pitr_reply
2564 u8 locator_set_name[64];
2567 /* Gross kludge, DGMS */
2568 define interface_name_renumber
2573 u32 new_show_dev_instance;
2576 define interface_name_renumber_reply
2582 /** \brief Register for ip4 arp resolution events
2583 @param client_index - opaque cookie to identify the sender
2584 @param context - sender context, to match reply w/ request
2585 @param enable_disable - 1 => register for events, 0 => cancel registration
2586 @param pid - sender's pid
2587 @param address - the exact ip4 address of interest
2589 define want_ip4_arp_events
2598 /** \brief Reply for interface events registration
2599 @param context - returned sender context, to match reply w/ request
2600 @param retval - return code
2602 define want_ip4_arp_events_reply
2608 /** \brief Tell client about an ip4 arp resolution event
2609 @param client_index - opaque cookie to identify the sender
2610 @param context - sender context, to match reply w/ request
2611 @param address - the exact ip4 address of interest
2612 @param pid - client pid registered to receive notification
2613 @param sw_if_index - interface which received ARP packet
2614 @param new_mac - the new mac address
2615 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
2617 define ip4_arp_event
2628 /** \brief Register for ip6 nd resolution events
2629 @param client_index - opaque cookie to identify the sender
2630 @param context - sender context, to match reply w/ request
2631 @param enable_disable - 1 => register for events, 0 => cancel registration
2632 @param pid - sender's pid
2633 @param address - the exact ip6 address of interest
2635 define want_ip6_nd_events
2644 /** \brief Reply for ip6 nd resolution events registration
2645 @param context - returned sender context, to match reply w/ request
2646 @param retval - return code
2648 define want_ip6_nd_events_reply
2654 /** \brief Tell client about an ip6 nd resolution or mac/ip event
2655 @param client_index - opaque cookie to identify the sender
2656 @param context - sender context, to match reply w/ request
2657 @param pid - client pid registered to receive notification
2658 @param sw_if_index - interface which received ARP packet
2659 @param address - the exact ip6 address of interest
2660 @param new_mac - the new mac address
2661 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
2674 /** \brief L2 bridge domain add or delete request
2675 @param client_index - opaque cookie to identify the sender
2676 @param context - sender context, to match reply w/ request
2677 @param bd_id - the bridge domain to create
2678 @param flood - enable/disable bcast/mcast flooding in the bd
2679 @param uu_flood - enable/disable uknown unicast flood in the bd
2680 @param forward - enable/disable forwarding on all interfaces in the bd
2681 @param learn - enable/disable learning on all interfaces in the bd
2682 @param arp_term - enable/disable arp termination in the bd
2683 @param mac_age - mac aging time in min, 0 for disabled
2684 @param is_add - add or delete flag
2686 define bridge_domain_add_del
2700 /** \brief L2 bridge domain add or delete response
2701 @param context - sender context, to match reply w/ request
2702 @param retval - return code for the set bridge flags request
2704 define bridge_domain_add_del_reply
2710 /** \brief L2 bridge domain request operational state details
2711 @param client_index - opaque cookie to identify the sender
2712 @param context - sender context, to match reply w/ request
2713 @param bd_id - the bridge domain id desired or ~0 to request all bds
2715 define bridge_domain_dump
2722 /** \brief L2 bridge domain operational state response
2723 @param bd_id - the bridge domain id
2724 @param flood - bcast/mcast flooding state on all interfaces in the bd
2725 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2726 @param forward - forwarding state on all interfaces in the bd
2727 @param learn - learning state on all interfaces in the bd
2728 @param arp_term - arp termination state on all interfaces in the bd
2729 @param mac_age - mac aging time in min, 0 for disabled
2730 @param n_sw_ifs - number of sw_if_index's in the domain
2732 define bridge_domain_details
2742 u32 bvi_sw_if_index;
2746 /** \brief L2 bridge domain sw interface operational state response
2747 @param bd_id - the bridge domain id
2748 @param sw_if_index - sw_if_index in the domain
2749 @param shg - split horizon group for the interface
2751 define bridge_domain_sw_if_details
2759 /** \brief DHCP Client config add / del request
2760 @param client_index - opaque cookie to identify the sender
2761 @param context - sender context, to match reply w/ request
2762 @param sw_if_index - index of the interface for DHCP client
2763 @param hostname - hostname
2764 @param is_add - add the config if non-zero, else delete
2765 @param want_dhcp_event - DHCP event sent to the sender
2766 via dhcp_compl_event API message if non-zero
2767 @param pid - sender's pid
2769 define dhcp_client_config
2780 /** \brief DHCP Client config response
2781 @param context - sender context, to match reply w/ request
2782 @param retval - return code for the request
2784 define dhcp_client_config_reply
2790 /** \brief Set/unset input ACL interface
2791 @param client_index - opaque cookie to identify the sender
2792 @param context - sender context, to match reply w/ request
2793 @param sw_if_index - interface to set/unset input ACL
2794 @param ip4_table_index - ip4 classify table index (~0 for skip)
2795 @param ip6_table_index - ip6 classify table index (~0 for skip)
2796 @param l2_table_index - l2 classify table index (~0 for skip)
2797 @param is_add - Set input ACL if non-zero, else unset
2798 Note: User is recommeneded to use just one valid table_index per call.
2799 (ip4_table_index, ip6_table_index, or l2_table_index)
2801 define input_acl_set_interface
2806 u32 ip4_table_index;
2807 u32 ip6_table_index;
2812 /** \brief Set/unset input ACL interface response
2813 @param context - sender context, to match reply w/ request
2814 @param retval - return code for the request
2816 define input_acl_set_interface_reply
2822 /** \brief IPsec: Add/delete Security Policy Database
2823 @param client_index - opaque cookie to identify the sender
2824 @param context - sender context, to match reply w/ request
2825 @param is_add - add SPD if non-zero, else delete
2826 @param spd_id - SPD instance id (control plane allocated)
2829 define ipsec_spd_add_del
2837 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2838 @param context - returned sender context, to match reply w/ request
2839 @param retval - return code
2842 define ipsec_spd_add_del_reply
2848 /** \brief IPsec: Add/delete SPD from interface
2850 @param client_index - opaque cookie to identify the sender
2851 @param context - sender context, to match reply w/ request
2852 @param is_add - add security mode if non-zero, else delete
2853 @param sw_if_index - index of the interface
2854 @param spd_id - SPD instance id to use for lookups
2858 define ipsec_interface_add_del_spd
2868 /** \brief Reply for IPsec: Add/delete SPD from interface
2869 @param context - returned sender context, to match reply w/ request
2870 @param retval - return code
2873 define ipsec_interface_add_del_spd_reply
2879 /** \brief IPsec: Add/delete Security Policy Database entry
2881 See RFC 4301, 4.4.1.1 on how to match packet to selectors
2883 @param client_index - opaque cookie to identify the sender
2884 @param context - sender context, to match reply w/ request
2885 @param is_add - add SPD if non-zero, else delete
2886 @param spd_id - SPD instance id (control plane allocated)
2887 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
2888 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2889 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2890 @param remote_address_start - start of remote address range to match
2891 @param remote_address_stop - end of remote address range to match
2892 @param local_address_start - start of local address range to match
2893 @param local_address_stop - end of local address range to match
2894 @param protocol - protocol type to match [0 means any]
2895 @param remote_port_start - start of remote port range to match ...
2896 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2897 @param local_port_start - start of local port range to match ...
2898 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2899 @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)
2900 @param sa_id - SAD instance id (control plane allocated)
2904 define ipsec_spd_add_del_entry
2917 u8 remote_address_start[16];
2918 u8 remote_address_stop[16];
2919 u8 local_address_start[16];
2920 u8 local_address_stop[16];
2924 u16 remote_port_start;
2925 u16 remote_port_stop;
2926 u16 local_port_start;
2927 u16 local_port_stop;
2934 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2935 @param context - returned sender context, to match reply w/ request
2936 @param retval - return code
2939 define ipsec_spd_add_del_entry_reply
2945 /** \brief IPsec: Add/delete Security Association Database entry
2946 @param client_index - opaque cookie to identify the sender
2947 @param context - sender context, to match reply w/ request
2948 @param is_add - add SAD entry if non-zero, else delete
2950 @param sad_id - sad id
2952 @param spi - security parameter index
2954 @param protocol - 0 = AH, 1 = ESP
2956 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
2957 @param crypto_key_length - length of crypto_key in bytes
2958 @param crypto_key - crypto keying material
2960 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
2961 @param integrity_key_length - length of integrity_key in bytes
2962 @param integrity_key - integrity keying material
2964 @param use_extended_sequence_number - use ESN when non-zero
2966 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
2967 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
2968 @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
2969 @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
2973 IPsec tunnel address copy mode (to support GDOI)
2976 define ipsec_sad_add_del_entry
2988 u8 crypto_algorithm;
2989 u8 crypto_key_length;
2992 u8 integrity_algorithm;
2993 u8 integrity_key_length;
2994 u8 integrity_key[128];
2996 u8 use_extended_sequence_number;
3000 u8 tunnel_src_address[16];
3001 u8 tunnel_dst_address[16];
3004 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3005 @param context - returned sender context, to match reply w/ request
3006 @param retval - return code
3009 define ipsec_sad_add_del_entry_reply
3015 /** \brief IPsec: Update Security Association keys
3016 @param client_index - opaque cookie to identify the sender
3017 @param context - sender context, to match reply w/ request
3019 @param sa_id - sa id
3021 @param crypto_key_length - length of crypto_key in bytes
3022 @param crypto_key - crypto keying material
3024 @param integrity_key_length - length of integrity_key in bytes
3025 @param integrity_key - integrity keying material
3028 define ipsec_sa_set_key
3035 u8 crypto_key_length;
3038 u8 integrity_key_length;
3039 u8 integrity_key[128];
3042 /** \brief Reply for IPsec: Update Security Association keys
3043 @param context - returned sender context, to match reply w/ request
3044 @param retval - return code
3047 define ipsec_sa_set_key_reply
3053 /** \brief IKEv2: Add/delete profile
3054 @param client_index - opaque cookie to identify the sender
3055 @param context - sender context, to match reply w/ request
3057 @param name - IKEv2 profile name
3058 @param is_add - Add IKEv2 profile if non-zero, else delete
3060 define ikev2_profile_add_del
3069 /** \brief Reply for IKEv2: Add/delete profile
3070 @param context - returned sender context, to match reply w/ request
3071 @param retval - return code
3073 define ikev2_profile_add_del_reply
3079 /** \brief IKEv2: Set IKEv2 profile authentication method
3080 @param client_index - opaque cookie to identify the sender
3081 @param context - sender context, to match reply w/ request
3083 @param name - IKEv2 profile name
3084 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3085 @param is_hex - Authentication data in hex format if non-zero, else string
3086 @param data_len - Authentication data length
3087 @param data - Authentication data (for rsa-sig cert file path)
3089 define ikev2_profile_set_auth
3101 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3102 @param context - returned sender context, to match reply w/ request
3103 @param retval - return code
3105 define ikev2_profile_set_auth_reply
3111 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3112 @param client_index - opaque cookie to identify the sender
3113 @param context - sender context, to match reply w/ request
3115 @param name - IKEv2 profile name
3116 @param is_local - Identification is local if non-zero, else remote
3117 @param id_type - Identification type
3118 @param data_len - Identification data length
3119 @param data - Identification data
3121 define ikev2_profile_set_id
3133 /** \brief Reply for IKEv2:
3134 @param context - returned sender context, to match reply w/ request
3135 @param retval - return code
3137 define ikev2_profile_set_id_reply
3143 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3144 @param client_index - opaque cookie to identify the sender
3145 @param context - sender context, to match reply w/ request
3147 @param name - IKEv2 profile name
3148 @param is_local - Traffic selector is local if non-zero, else remote
3149 @param proto - Traffic selector IP protocol (if zero not relevant)
3150 @param start_port - The smallest port number allowed by traffic selector
3151 @param end_port - The largest port number allowed by traffic selector
3152 @param start_addr - The smallest address included in traffic selector
3153 @param end_addr - The largest address included in traffic selector
3155 define ikev2_profile_set_ts
3169 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3170 @param context - returned sender context, to match reply w/ request
3171 @param retval - return code
3173 define ikev2_profile_set_ts_reply
3179 /** \brief IKEv2: Set IKEv2 local RSA private key
3180 @param client_index - opaque cookie to identify the sender
3181 @param context - sender context, to match reply w/ request
3183 @param key_file - Key file absolute path
3185 define ikev2_set_local_key
3193 /** \brief Reply for IKEv2: Set IKEv2 local key
3194 @param context - returned sender context, to match reply w/ request
3195 @param retval - return code
3197 define ikev2_set_local_key_reply
3203 /** \brief Tell client about a DHCP completion event
3204 @param client_index - opaque cookie to identify the sender
3205 @param pid - client pid registered to receive notification
3206 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3207 @param host_address - Host IP address
3208 @param router_address - Router IP address
3209 @param host_mac - Host MAC address
3211 define dhcp_compl_event
3217 u8 host_address[16];
3218 u8 router_address[16];
3222 /** \brief cop: enable/disable junk filtration features on an interface
3223 @param client_index - opaque cookie to identify the sender
3224 @param context - sender context, to match reply w/ request
3225 @param sw_if_inded - desired interface
3226 @param enable_disable - 1 => enable, 0 => disable
3229 define cop_interface_enable_disable
3237 /** \brief cop: interface enable/disable junk filtration reply
3238 @param context - returned sender context, to match reply w/ request
3239 @param retval - return code
3242 define cop_interface_enable_disable_reply
3248 /** \brief cop: enable/disable whitelist filtration features on an interface
3249 Note: the supplied fib_id must match in order to remove the feature!
3251 @param client_index - opaque cookie to identify the sender
3252 @param context - sender context, to match reply w/ request
3253 @param sw_if_index - interface handle, physical interfaces only
3254 @param fib_id - fib identifier for the whitelist / blacklist fib
3255 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
3256 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
3257 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
3260 define cop_whitelist_enable_disable
3271 /** \brief cop: interface enable/disable junk filtration reply
3272 @param context - returned sender context, to match reply w/ request
3273 @param retval - return code
3276 define cop_whitelist_enable_disable_reply
3282 /** \brief get_node_graph - get a copy of the vpp node graph
3283 including the current set of graph arcs.
3285 @param client_index - opaque cookie to identify the sender
3286 @param context - sender context, to match reply w/ request
3289 define get_node_graph
3295 /** \brief get_node_graph_reply
3296 @param context - returned sender context, to match reply w/ request
3297 @param retval - return code
3298 @param reply_in_shmem - result from vlib_node_serialize, in shared
3299 memory. Process with vlib_node_unserialize, remember to switch
3300 heaps and free the result.
3303 define get_node_graph_reply
3310 /** \brief IOAM enable : Enable in-band OAM
3311 @param id - profile id
3312 @param seqno - To enable Seqno Processing
3313 @param analyse - Enabling analysis of iOAM at decap node
3314 @param pow_enable - Proof of Work enabled or not flag
3315 @param trace_enable - iOAM Trace enabled or not flag
3329 /** \brief iOAM Trace profile add / del response
3330 @param context - sender context, to match reply w/ request
3331 @param retval - return value for request
3333 define ioam_enable_reply
3339 /** \brief iOAM disable
3340 @param client_index - opaque cookie to identify the sender
3341 @param context - sender context, to match reply w/ request
3342 @param index - MAP Domain index
3351 /** \brief iOAM disable response
3352 @param context - sender context, to match reply w/ request
3353 @param retval - return value for request
3355 define ioam_disable_reply
3361 /** \brief Add/del policer
3362 @param client_index - opaque cookie to identify the sender
3363 @param context - sender context, to match reply w/ request
3364 @param is_add - add policer if non-zero, else delete
3365 @param name - policer name
3368 @param cb - Committed Burst
3369 @param eb - Excess or Peak Burst
3370 @param rate_type - rate type
3371 @param round_type - rounding type
3372 @param type - policer algorithm
3373 @param color_aware - 0=color-blind, 1=color-aware
3374 @param conform_action_type - conform action type
3375 @param conform_dscp - DSCP for conform mar-and-transmit action
3376 @param exceed_action_type - exceed action type
3377 @param exceed_dscp - DSCP for exceed mar-and-transmit action
3378 @param violate_action_type - violate action type
3379 @param violate_dscp - DSCP for violate mar-and-transmit action
3381 define policer_add_del
3396 u8 conform_action_type;
3398 u8 exceed_action_type;
3400 u8 violate_action_type;
3404 /** \brief Add/del policer response
3405 @param context - sender context, to match reply w/ request
3406 @param retval - return value for request
3407 @param policer_index - for add, returned index of the new policer
3409 define policer_add_del_reply
3416 /** \brief Get list of policers
3417 @param client_index - opaque cookie to identify the sender
3418 @param context - sender context, to match reply w/ request
3419 @param match_name_valid - if 0 request all policers otherwise use match_name
3420 @param match_name - policer name
3427 u8 match_name_valid;
3431 /** \brief Policer operational state response.
3432 @param context - sender context, to match reply w/ request
3433 @param name - policer name
3436 @param cb - Committed Burst
3437 @param eb - Excess or Peak Burst
3438 @param rate_type - rate type
3439 @param round_type - rounding type
3440 @param type - policer algorithm
3441 @param conform_action_type - conform action type
3442 @param conform_dscp - DSCP for conform mar-and-transmit action
3443 @param exceed_action_type - exceed action type
3444 @param exceed_dscp - DSCP for exceed mar-and-transmit action
3445 @param violate_action_type - violate action type
3446 @param violate_dscp - DSCP for violate mar-and-transmit action
3447 @param single_rate - 1 = single rate policer, 0 = two rate policer
3448 @param color_aware - for hierarchical policing
3449 @param scale - power-of-2 shift amount for lower rates
3450 @param cir_tokens_per_period - number of tokens for each period
3451 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
3452 @param current_limit - current limit
3453 @param current_bucket - current bucket
3454 @param extended_limit - extended limit
3455 @param extended_bucket - extended bucket
3456 @param last_update_time - last update time
3458 define policer_details
3470 u8 conform_action_type;
3472 u8 exceed_action_type;
3474 u8 violate_action_type;
3479 u32 cir_tokens_per_period;
3480 u32 pir_tokens_per_period;
3484 u32 extended_bucket;
3485 u64 last_update_time;
3488 /** \brief Set/unset policer classify interface
3489 @param client_index - opaque cookie to identify the sender
3490 @param context - sender context, to match reply w/ request
3491 @param sw_if_index - interface to set/unset policer classify
3492 @param ip4_table_index - ip4 classify table index (~0 for skip)
3493 @param ip6_table_index - ip6 classify table index (~0 for skip)
3494 @param l2_table_index - l2 classify table index (~0 for skip)
3495 @param is_add - Set if non-zero, else unset
3496 Note: User is recommeneded to use just one valid table_index per call.
3497 (ip4_table_index, ip6_table_index, or l2_table_index)
3499 define policer_classify_set_interface
3504 u32 ip4_table_index;
3505 u32 ip6_table_index;
3510 /** \brief Set/unset policer classify interface response
3511 @param context - sender context, to match reply w/ request
3512 @param retval - return value for request
3514 define policer_classify_set_interface_reply
3520 /** \brief Get list of policer classify interfaces and tables
3521 @param client_index - opaque cookie to identify the sender
3522 @param context - sender context, to match reply w/ request
3523 @param type - classify table type
3525 define policer_classify_dump
3532 /** \brief Policer iclassify operational state response.
3533 @param context - sender context, to match reply w/ request
3534 @param sw_if_index - software interface index
3535 @param table_index - classify table index
3537 define policer_classify_details
3544 /** \brief Classify get table IDs request
3545 @param client_index - opaque cookie to identify the sender
3546 @param context - sender context, to match reply w/ request
3548 define classify_table_ids
3554 /** \brief Reply for classify get table IDs request
3555 @param context - sender context which was passed in the request
3556 @param count - number of ids returned in response
3557 @param ids - array of classify table ids
3559 define classify_table_ids_reply
3567 /** \brief Classify table ids by interface index request
3568 @param client_index - opaque cookie to identify the sender
3569 @param context - sender context, to match reply w/ request
3570 @param sw_if_index - index of the interface
3572 define classify_table_by_interface
3579 /** \brief Reply for classify table id by interface index request
3580 @param context - sender context which was passed in the request
3581 @param count - number of ids returned in response
3582 @param sw_if_index - index of the interface
3583 @param l2_table_id - l2 classify table index
3584 @param ip4_table_id - ip4 classify table index
3585 @param ip6_table_id - ip6 classify table index
3587 define classify_table_by_interface_reply
3597 /** \brief Classify table info
3598 @param client_index - opaque cookie to identify the sender
3599 @param context - sender context, to match reply w/ request
3600 @param table_id - classify table index
3602 define classify_table_info
3609 /** \brief Reply for classify table info request
3610 @param context - sender context which was passed in the request
3611 @param count - number of ids returned in response
3612 @param table_id - classify table index
3613 @param nbuckets - number of buckets when adding a table
3614 @param match_n_vectors - number of match vectors
3615 @param skip_n_vectors - number of skip_n_vectors
3616 @param active_sessions - number of sessions (active entries)
3617 @param next_table_index - index of next table
3618 @param miss_next_index - index of miss table
3619 @param mask[] - match mask
3621 define classify_table_info_reply
3627 u32 match_n_vectors;
3629 u32 active_sessions;
3630 u32 next_table_index;
3631 u32 miss_next_index;
3633 u8 mask[mask_length];
3636 /** \brief Classify sessions dump request
3637 @param client_index - opaque cookie to identify the sender
3638 @param context - sender context, to match reply w/ request
3639 @param table_id - classify table index
3641 define classify_session_dump
3648 /** \brief Reply for classify table session dump request
3649 @param context - sender context which was passed in the request
3650 @param count - number of ids returned in response
3651 @param table_id - classify table index
3652 @param hit_next_index - hit_next_index of session
3653 @param opaque_index - for add, opaque_index of session
3654 @param advance - advance value of session
3655 @param match[] - match value for session
3657 define classify_session_details
3666 u8 match[match_length];
3669 /** \brief Configure IPFIX exporter process request
3670 @param client_index - opaque cookie to identify the sender
3671 @param context - sender context, to match reply w/ request
3672 @param collector_address - address of IPFIX collector
3673 @param collector_port - port of IPFIX collector
3674 @param src_address - address of IPFIX exporter
3675 @param vrf_id - VRF / fib table ID
3676 @param path_mtu - Path MTU between exporter and collector
3677 @param template_interval - number of seconds after which to resend template
3678 @param udp_checksum - UDP checksum calculation enable flag
3680 define set_ipfix_exporter
3684 u8 collector_address[16];
3689 u32 template_interval;
3693 /** \brief Reply to IPFIX exporter configure request
3694 @param context - sender context which was passed in the request
3696 define set_ipfix_exporter_reply
3702 /** \brief IPFIX exporter dump request
3703 @param client_index - opaque cookie to identify the sender
3704 @param context - sender context, to match reply w/ request
3706 define ipfix_exporter_dump
3712 /** \brief Reply to IPFIX exporter dump request
3713 @param context - sender context which was passed in the request
3714 @param collector_address - address of IPFIX collector
3715 @param collector_port - port of IPFIX collector
3716 @param src_address - address of IPFIX exporter
3717 @param fib_index - fib table index
3718 @param path_mtu - Path MTU between exporter and collector
3719 @param template_interval - number of seconds after which to resend template
3720 @param udp_checksum - UDP checksum calculation enable flag
3722 define ipfix_exporter_details
3725 u8 collector_address[16];
3730 u32 template_interval;
3734 /** \brief IPFIX classify stream configure request
3735 @param client_index - opaque cookie to identify the sender
3736 @param context - sender context, to match reply w/ request
3737 @param domain_id - domain ID reported in IPFIX messages for classify stream
3738 @param src_port - source port of UDP session for classify stream
3740 define set_ipfix_classify_stream {
3747 /** \brief IPFIX classify stream configure response
3748 @param context - sender context, to match reply w/ request
3749 @param retval - return value for request
3751 define set_ipfix_classify_stream_reply {
3756 /** \brief IPFIX classify stream dump request
3757 @param client_index - opaque cookie to identify the sender
3758 @param context - sender context, to match reply w/ request
3760 define ipfix_classify_stream_dump {
3765 /** \brief Reply to IPFIX classify stream dump request
3766 @param context - sender context, to match reply w/ request
3767 @param domain_id - domain ID reported in IPFIX messages for classify stream
3768 @param src_port - source port of UDP session for classify stream
3770 define ipfix_classify_stream_details {
3776 /** \brief IPFIX add or delete classifier table request
3777 @param client_index - opaque cookie to identify the sender
3778 @param context - sender context, to match reply w/ request
3779 @param table_id - classifier table ID
3780 @param ip_version - version of IP used in the classifier table
3781 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
3783 define ipfix_classify_table_add_del {
3788 u8 transport_protocol;
3792 /** \brief IPFIX add classifier table response
3793 @param context - sender context which was passed in the request
3795 define ipfix_classify_table_add_del_reply {
3800 /** \brief IPFIX classify tables dump request
3801 @param client_index - opaque cookie to identify the sender
3802 @param context - sender context, to match reply w/ request
3804 define ipfix_classify_table_dump {
3809 /** \brief Reply to IPFIX classify tables dump request
3810 @param context - sender context, to match reply w/ request
3811 @param table_id - classifier table ID
3812 @param ip_version - version of IP used in the classifier table
3813 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
3815 define ipfix_classify_table_details {
3819 u8 transport_protocol;
3822 /** \brief Set/unset flow classify interface
3823 @param client_index - opaque cookie to identify the sender
3824 @param context - sender context, to match reply w/ request
3825 @param sw_if_index - interface to set/unset flow classify
3826 @param ip4_table_index - ip4 classify table index (~0 for skip)
3827 @param ip6_table_index - ip6 classify table index (~0 for skip)
3828 @param l2_table_index - l2 classify table index (~0 for skip)
3829 @param is_add - Set if non-zero, else unset
3830 Note: User is recommeneded to use just one valid table_index per call.
3831 (ip4_table_index, ip6_table_index, or l2_table_index)
3833 define flow_classify_set_interface {
3837 u32 ip4_table_index;
3838 u32 ip6_table_index;
3842 /** \brief Set/unset flow classify interface response
3843 @param context - sender context, to match reply w/ request
3844 @param retval - return value for request
3846 define flow_classify_set_interface_reply {
3851 /** \brief Get list of flow classify interfaces and tables
3852 @param client_index - opaque cookie to identify the sender
3853 @param context - sender context, to match reply w/ request
3854 @param type - classify table type
3856 define flow_classify_dump {
3862 /** \brief Flow classify operational state response.
3863 @param context - sender context, to match reply w/ request
3864 @param sw_if_index - software interface index
3865 @param table_index - classify table index
3867 define flow_classify_details {
3873 /** \brief Query relative index via node names
3874 @param client_index - opaque cookie to identify the sender
3875 @param context - sender context, to match reply w/ request
3876 @param node_name - name of node to find relative index from
3877 @param next_name - next node from node_name to find relative index of
3879 define get_next_index
3887 /** \brief Reply for get next node index
3888 @param context - sender context which was passed in the request
3889 @param retval - return value
3890 @param next_index - index of the next_node
3892 define get_next_index_reply
3899 /** \brief PacketGenerator create interface request
3900 @param client_index - opaque cookie to identify the sender
3901 @param context - sender context, to match reply w/ request
3902 @param interface_id - interface index
3904 define pg_create_interface
3911 /** \brief PacketGenerator create interface response
3912 @param context - sender context, to match reply w/ request
3913 @param retval - return value for request
3915 define pg_create_interface_reply
3922 /** \brief PacketGenerator capture packets on given interface request
3923 @param client_index - opaque cookie to identify the sender
3924 @param context - sender context, to match reply w/ request
3925 @param interface_id - pg interface index
3926 @param is_enabled - 1 if enabling streams, 0 if disabling
3927 @param count - number of packets to be captured
3928 @param pcap_file - pacp file name to store captured packets
3937 u32 pcap_name_length;
3938 u8 pcap_file_name[pcap_name_length];
3941 /** \brief PacketGenerator capture packets response
3942 @param context - sender context, to match reply w/ request
3943 @param retval - return value for request
3945 define pg_capture_reply
3951 /** \brief Enable / disable packet generator request
3952 @param client_index - opaque cookie to identify the sender
3953 @param context - sender context, to match reply w/ request
3954 @param is_enabled - 1 if enabling streams, 0 if disabling
3955 @param stream - stream name to be enable/disabled, if not specified handle all streams
3957 define pg_enable_disable
3962 u32 stream_name_length;
3963 u8 stream_name[stream_name_length];
3966 /** \brief Reply for enable / disable packet generator
3967 @param context - returned sender context, to match reply w/ request
3968 @param retval - return code
3970 define pg_enable_disable_reply
3976 /** \brief Configure IP source and L4 port-range check
3977 @param client_index - opaque cookie to identify the sender
3978 @param context - sender context, to match reply w/ request
3979 @param is_ip6 - 1 if source address type is IPv6
3980 @param is_add - 1 if add, 0 if delete
3981 @param mask_length - mask length for address entry
3982 @param address - array of address bytes
3983 @param number_of_ranges - length of low_port and high_port arrays (must match)
3984 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
3985 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
3986 @param vrf_id - fib table/vrf id to associate the source and port-range check with
3987 @note To specify a single port set low_port and high_port entry the same
3989 define ip_source_and_port_range_check_add_del
3997 u8 number_of_ranges;
4003 /** \brief Configure IP source and L4 port-range check reply
4004 @param context - returned sender context, to match reply w/ request
4005 @param retval - return code
4007 define ip_source_and_port_range_check_add_del_reply
4013 /** \brief Set interface source and L4 port-range request
4014 @param client_index - opaque cookie to identify the sender
4015 @param context - sender context, to match reply w/ request
4016 @param interface_id - interface index
4017 @param tcp_vrf_id - VRF associated with source and TCP port-range check
4018 @param udp_vrf_id - VRF associated with source and TCP port-range check
4020 define ip_source_and_port_range_check_interface_add_del
4032 /** \brief Set interface source and L4 port-range response
4033 @param context - sender context, to match reply w/ request
4034 @param retval - return value for request
4036 define ip_source_and_port_range_check_interface_add_del_reply
4042 /** \brief Add / del ipsec gre tunnel request
4043 @param client_index - opaque cookie to identify the sender
4044 @param context - sender context, to match reply w/ request
4045 @param local_sa_id - local SA id
4046 @param remote_sa_id - remote SA id
4047 @param is_add - 1 if adding the tunnel, 0 if deleting
4048 @param src_address - tunnel source address
4049 @param dst_address - tunnel destination address
4051 define ipsec_gre_add_del_tunnel {
4061 /** \brief Reply for add / del ipsec gre tunnel request
4062 @param context - returned sender context, to match reply w/ request
4063 @param retval - return code
4064 @param sw_if_index - software index of the new ipsec gre tunnel
4066 define ipsec_gre_add_del_tunnel_reply {
4072 /** \brief Dump ipsec gre tunnel table
4073 @param client_index - opaque cookie to identify the sender
4074 @param context - sender context, to match reply w/ request
4075 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4077 define ipsec_gre_tunnel_dump {
4083 /** \brief mpls gre tunnel operational state response
4084 @param context - returned sender context, to match reply w/ request
4085 @param sw_if_index - software index of the ipsec gre tunnel
4086 @param local_sa_id - local SA id
4087 @param remote_sa_id - remote SA id
4088 @param src_address - tunnel source address
4089 @param dst_address - tunnel destination address
4091 define ipsec_gre_tunnel_details {
4100 /** \brief Delete sub interface request
4101 @param client_index - opaque cookie to identify the sender
4102 @param context - sender context, to match reply w/ request
4103 @param sw_if_index - sw index of the interface that was created by create_subif
4105 define delete_subif {
4111 /** \brief Delete sub interface response
4112 @param context - sender context, to match reply w/ request
4113 @param retval - return code for the request
4115 define delete_subif_reply {
4120 /** \brief DPDK interface HQoS pipe profile set request
4121 @param client_index - opaque cookie to identify the sender
4122 @param context - sender context, to match reply w/ request
4123 @param sw_if_index - the interface
4124 @param subport - subport ID
4125 @param pipe - pipe ID within its subport
4126 @param profile - pipe profile ID
4128 define sw_interface_set_dpdk_hqos_pipe {
4137 /** \brief DPDK interface HQoS pipe profile set reply
4138 @param context - sender context, to match reply w/ request
4139 @param retval - request return code
4141 define sw_interface_set_dpdk_hqos_pipe_reply {
4146 /** \brief DPDK interface HQoS subport parameters set request
4147 @param client_index - opaque cookie to identify the sender
4148 @param context - sender context, to match reply w/ request
4149 @param sw_if_index - the interface
4150 @param subport - subport ID
4151 @param tb_rate - subport token bucket rate (measured in bytes/second)
4152 @param tb_size - subport token bucket size (measured in credits)
4153 @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
4154 @param tc_period - enforcement period for rates (measured in milliseconds)
4156 define sw_interface_set_dpdk_hqos_subport {
4167 /** \brief DPDK interface HQoS subport parameters set reply
4168 @param context - sender context, to match reply w/ request
4169 @param retval - request return code
4171 define sw_interface_set_dpdk_hqos_subport_reply {
4176 /** \brief DPDK interface HQoS tctbl entry set request
4177 @param client_index - opaque cookie to identify the sender
4178 @param context - sender context, to match reply w/ request
4179 @param sw_if_index - the interface
4180 @param entry - entry index ID
4181 @param tc - traffic class (0 .. 3)
4182 @param queue - traffic class queue (0 .. 3)
4184 define sw_interface_set_dpdk_hqos_tctbl {
4193 /** \brief DPDK interface HQoS tctbl entry set reply
4194 @param context - sender context, to match reply w/ request
4195 @param retval - request return code
4197 define sw_interface_set_dpdk_hqos_tctbl_reply {
4202 /** \brief L2 interface pbb tag rewrite configure request
4203 @param client_index - opaque cookie to identify the sender
4204 @param context - sender context, to match reply w/ request
4205 @param sw_if_index - interface the operation is applied to
4206 @param vtr_op - Choose from l2_vtr_op_t enum values
4207 @param inner_tag - needed for translate_qinq vtr op only
4208 @param outer_tag - needed for translate_qinq vtr op only
4209 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
4210 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
4211 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
4212 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
4214 define l2_interface_pbb_tag_rewrite
4227 /** \brief L2 interface pbb tag rewrite response
4228 @param context - sender context, to match reply w/ request
4229 @param retval - return code for the request
4231 define l2_interface_pbb_tag_rewrite_reply
4237 /** \brief Punt traffic to the host
4238 @param client_index - opaque cookie to identify the sender
4239 @param context - sender context, to match reply w/ request
4240 @param is_add - add punt if non-zero, else delete
4241 @param ipv - L3 protocol 4 - IPv4, 6 - IPv6, ~0 - All
4242 @param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
4243 @param l4_port - TCP/UDP port to be punted
4254 /** \brief Reply to the punt request
4255 @param context - sender context which was passed in the request
4256 @param retval - return code of punt request
4264 /** \brief Dump ipsec policy database data
4265 @param client_index - opaque cookie to identify the sender
4266 @param context - sender context, to match reply w/ request
4267 @param spd_id - SPD instance id
4268 @param sa_id - SA id, optional, set to ~0 to see all policies in SPD
4270 define ipsec_spd_dump {
4277 /** \brief IPsec policy database response
4278 @param context - sender context which was passed in the request
4279 @param spd_id - SPD instance id
4280 @param priority - numeric value to control policy evaluation order
4281 @param is_outbound - [1|0] to indicate if direction is [out|in]bound
4282 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
4283 @param local_start_addr - first address in local traffic selector range
4284 @param local_stop_addr - last address in local traffic selector range
4285 @param local_start_port - first port in local traffic selector range
4286 @param local_stop_port - last port in local traffic selector range
4287 @param remote_start_addr - first address in remote traffic selector range
4288 @param remote_stop_addr - last address in remote traffic selector range
4289 @param remote_start_port - first port in remote traffic selector range
4290 @param remote_stop_port - last port in remote traffic selector range
4291 @param protocol - traffic selector protocol
4292 @param policy - policy action
4293 @param sa_id - SA id
4294 @param bytes - byte count of packets matching this policy
4295 @param packets - count of packets matching this policy
4298 define ipsec_spd_details {
4304 u8 local_start_addr[16];
4305 u8 local_stop_addr[16];
4306 u16 local_start_port;
4307 u16 local_stop_port;
4308 u8 remote_start_addr[16];
4309 u8 remote_stop_addr[16];
4310 u16 remote_start_port;
4311 u16 remote_stop_port;
4319 /** \brief Feature path enable/disable request
4320 @param client_index - opaque cookie to identify the sender
4321 @param context - sender context, to match reply w/ request
4322 @param sw_if_index - the interface
4323 @param enable - 1 = on, 0 = off
4325 define feature_enable_disable {
4331 u8 feature_name[64];
4334 /** \brief Reply to the eature path enable/disable request
4335 @param context - sender context which was passed in the request
4336 @param retval - return code for the request
4338 define feature_enable_disable_reply
4344 /** \brief Configure BFD feature
4345 @param client_index - opaque cookie to identify the sender
4346 @param context - sender context, to match reply w/ request
4347 @param slow_timer - slow timer (seconds)
4348 @param min_tx - desired min tx interval
4349 @param min_rx - desired min rx interval
4350 @param detect_mult - desired detection multiplier
4352 define bfd_set_config {
4361 /** \brief Configure BFD feature response
4362 @param context - sender context, to match reply w/ request
4363 @param retval - return code for the request
4365 define bfd_set_config_reply {
4370 /** \brief Get BFD configuration
4372 define bfd_get_config {
4377 /** \brief Get BFD configuration response
4378 @param context - sender context, to match reply w/ request
4379 @param retval - return code for the request
4380 @param slow_timer - slow timer (seconds)
4381 @param min_tx - desired min tx interval
4382 @param min_rx - desired min rx interval
4383 @param detect_mult - desired detection multiplier
4385 define bfd_get_config_reply {
4394 /** \brief Add UDP BFD session on interface
4395 @param client_index - opaque cookie to identify the sender
4396 @param context - sender context, to match reply w/ request
4397 @param sw_if_index - sw index of the interface
4398 @param desired_min_tx - desired min transmit interval (microseconds)
4399 @param required_min_rx - required min receive interval (microseconds)
4400 @param detect_mult - detect multiplier (# of packets missed between connection goes down)
4401 @param local_addr - local address
4402 @param peer_addr - peer address
4403 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
4405 define bfd_udp_add {
4410 u32 required_min_rx;
4417 /** \brief Add UDP BFD session response
4418 @param context - sender context, to match reply w/ request
4419 @param retval - return code for the request
4420 @param bs_index - index of the session created
4422 define bfd_udp_add_reply {
4428 /** \brief Delete UDP BFD session on interface
4429 @param client_index - opaque cookie to identify the sender
4430 @param context - sender context, to match reply w/ request
4431 @param sw_if_index - sw index of the interface
4432 @param local_addr - local address
4433 @param peer_addr - peer address
4434 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
4436 define bfd_udp_del {
4445 /** \brief Delete UDP BFD session response
4446 @param context - sender context, to match reply w/ request
4447 @param retval - return code for the request
4449 define bfd_udp_del_reply {
4454 /** \brief Get all BFD sessions
4455 @param client_index - opaque cookie to identify the sender
4456 @param context - sender context, to match reply w/ request
4458 define bfd_udp_session_dump {
4463 /** \brief BFD session details structure
4464 @param context - sender context, to match reply w/ request
4465 @param bs_index - index of the session
4466 @param sw_if_index - sw index of the interface
4467 @param local_addr - local address
4468 @param peer_addr - peer address
4469 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
4470 @param state - session state
4472 define bfd_udp_session_details {
4482 /** \brief Set flags of BFD session
4483 @param client_index - opaque cookie to identify the sender
4484 @param context - sender context, to match reply w/ request
4485 @param bs_index - index of the bfd session to set flags on
4486 @param admin_up_down - set the admin state, 1 = up, 0 = down
4488 define bfd_session_set_flags {
4495 /** \brief Reply to bfd_session_set_flags
4496 @param context - sender context which was passed in the request
4497 @param retval - return code of the set flags request
4499 define bfd_session_set_flags_reply
4505 /** \brief Register for BFD events
4506 @param client_index - opaque cookie to identify the sender
4507 @param context - sender context, to match reply w/ request
4508 @param enable_disable - 1 => register for events, 0 => cancel registration
4509 @param pid - sender's pid
4511 define want_bfd_events
4519 /** \brief Reply for BFD events registration
4520 @param context - returned sender context, to match reply w/ request
4521 @param retval - return code
4523 define want_bfd_events_reply
4531 * eval: (c-set-style "gnu")