1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 This file defines vpe control-plane API messages which are generally
20 called through a shared memory interface.
24 /** \brief Register for interface events
25 @param client_index - opaque cookie to identify the sender
26 @param context - sender context, to match reply w/ request
27 @param enable_disable - 1 => register for events, 0 => cancel registration
28 @param pid - sender's pid
30 define want_interface_events
38 /** \brief Reply for interface events registration
39 @param context - returned sender context, to match reply w/ request
40 @param retval - return code
42 define want_interface_events_reply
48 /** \brief Interface details structure (fix this)
49 @param sw_if_index - index of the interface
50 @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
51 @param l2_address_length - length of the interface's l2 address
52 @param pid - the interface's l2 address
53 @param interface_name - name of the interface
54 @param link_duplex - 1 if half duplex, 2 if full duplex
55 @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
56 @param link_MTU - max. transmittion unit
57 @param sub_if_id - A number 0-N to uniquely identify this subif on super if
58 @param sub_dot1ad - 0 = dot1q, 1=dot1ad
59 @param sub_number_of_tags - Number of tags (0 - 2)
60 @param sub_outer_vlan_id
61 @param sub_inner_vlan_id
62 @param sub_exact_match
64 @param sub_outer_vlan_id_any
65 @param sub_inner_vlan_id_any
66 @param vtr_op - vlan tag rewrite operation
71 define sw_interface_details
76 /* index of sup interface (e.g. hw interface).
77 equal to sw_if_index for super hw interface. */
80 /* Layer 2 address, if applicable */
81 u32 l2_address_length;
85 u8 interface_name[64];
87 /* 1 = up, 0 = down */
91 /* 1 = half duplex, 2 = full duplex */
94 /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
100 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
103 /* 0 = dot1q, 1=dot1ad */
106 /* Number of tags 0-2 */
107 u8 sub_number_of_tags;
108 u16 sub_outer_vlan_id;
109 u16 sub_inner_vlan_id;
112 u8 sub_outer_vlan_id_any;
113 u8 sub_inner_vlan_id_any;
115 /* vlan tag rewrite state */
117 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
118 u32 vtr_tag1; // first pushed tag
119 u32 vtr_tag2; // second pushed tag
124 define sw_interface_dump
128 u8 name_filter_valid;
132 /** \brief Set or delete one or all ip addresses on a specified interface
133 @param client_index - opaque cookie to identify the sender
134 @param context - sender context, to match reply w/ request
135 @param sw_if_index - index of the interface to add/del addresses
136 @param is_add - add address if non-zero, else delete
137 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
138 @param del_all - if non-zero delete all addresses on the interface
139 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
140 @param address - array of address bytes
142 define sw_interface_add_del_address
154 /** \brief Reply for interface events registration
155 @param context - returned sender context, to match reply w/ request
156 @param retval - return code
158 define sw_interface_add_del_address_reply
164 /** \brief Associate the specified interface with a fib table
165 @param client_index - opaque cookie to identify the sender
166 @param context - sender context, to match reply w/ request
167 @param sw_if_index - index of the interface
168 @param is_ipv6 - if non-zero ipv6, else ipv4
169 @param vrf_id - fib table/vrd id to associate the interface with
171 define sw_interface_set_table
180 /** \brief Reply for interface events registration
181 @param context - returned sender context, to match reply w/ request
182 @param retval - return code
184 define sw_interface_set_table_reply
190 /** \brief Enable or Disable MPLS on and interface
191 @param client_index - opaque cookie to identify the sender
192 @param context - sender context, to match reply w/ request
193 @param sw_if_index - index of the interface
194 @param enable - if non-zero enable, else disable
196 define sw_interface_set_mpls_enable
204 /** \brief Reply for MPLS state on an interface
205 @param context - returned sender context, to match reply w/ request
206 @param retval - return code
208 define sw_interface_set_mpls_enable_reply
214 /** \brief Initialize a new tap interface with the given paramters
215 @param client_index - opaque cookie to identify the sender
216 @param context - sender context, to match reply w/ request
217 @param use_random_mac - let the system generate a unique mac address
218 @param tap_name - name to associate with the new interface
219 @param mac_address - mac addr to assign to the interface if use_radom not set
229 u32 custom_dev_instance;
233 /** \brief Reply for tap connect request
234 @param context - returned sender context, to match reply w/ request
235 @param retval - return code
236 @param sw_if_index - software index allocated for the new tap interface
238 define tap_connect_reply
245 /** \brief Modify a tap interface with the given paramters
246 @param client_index - opaque cookie to identify the sender
247 @param context - sender context, to match reply w/ request
248 @param sw_if_index - interface index of existing tap interface
249 @param use_random_mac - let the system generate a unique mac address
250 @param tap_name - name to associate with the new interface
251 @param mac_address - mac addr to assign to the interface if use_radom not set
262 u32 custom_dev_instance;
265 /** \brief Reply for tap modify request
266 @param context - returned sender context, to match reply w/ request
267 @param retval - return code
268 @param sw_if_index - software index if the modified tap interface
270 define tap_modify_reply
277 /** \brief Delete tap interface
278 @param client_index - opaque cookie to identify the sender
279 @param context - sender context, to match reply w/ request
280 @param sw_if_index - interface index of existing tap interface
289 /** \brief Reply for tap delete request
290 @param context - returned sender context, to match reply w/ request
291 @param retval - return code
293 define tap_delete_reply
299 /** \brief Dump tap interfaces request */
300 define sw_interface_tap_dump
306 /** \brief Reply for tap dump request
307 @param sw_if_index - software index of tap interface
308 @param dev_name - Linux tap device name
310 define sw_interface_tap_details
317 /** \brief Create a new subinterface with the given vlan id
318 @param client_index - opaque cookie to identify the sender
319 @param context - sender context, to match reply w/ request
320 @param sw_if_index - software index of the new vlan's parent interface
321 @param vlan_id - vlan tag of the new interface
323 define create_vlan_subif
331 /** \brief Reply for the vlan subinterface create request
332 @param context - returned sender context, to match reply w/ request
333 @param retval - return code
334 @param sw_if_index - software index allocated for the new subinterface
336 define create_vlan_subif_reply
343 /** \brief MPLS Route Add / del route
344 @param client_index - opaque cookie to identify the sender
345 @param context - sender context, to match reply w/ request
346 @param mr_label - The MPLS label value
347 @param mr_eos - The End of stack bit
348 @param mr_table_id - The MPLS table-id the route is added in
349 @param mr_classify_table_index - If this is a classify route,
350 this is the classify table index
351 @param mr_create_table_if_needed - If the MPLS or IP tables do not exist,
353 @param mr_is_add - Is this a route add or delete
354 @param mr_is_classify - Is this route result a classify
355 @param mr_is_multipath - Is this route update a multipath - i.e. is this
356 a path addition to an existing route
357 @param mr_is_resolve_host - Recurse resolution constraint via a host prefix
358 @param mr_is_resolve_attached - Recurse resolution constraint via attached prefix
359 @param mr_next_hop_proto_is_ip4 - The next-hop is IPV4
360 @param mr_next_hop_weight - The weight, for UCMP
361 @param mr_next_hop[16] - the nextop address
362 @param mr_next_hop_sw_if_index - the next-hop SW interface
363 @param mr_next_hop_table_id - the next-hop table-id (if appropriate)
364 @param mr_next_hop_n_out_labels - the number of labels in the label stack
365 @param mr_next_hop_out_label_stack - the next-hop output label stack, outer most first
366 @param next_hop_via_label - The next-hop is a resolved via a local label
368 define mpls_route_add_del
375 u32 mr_classify_table_index;
376 u8 mr_create_table_if_needed;
380 u8 mr_is_resolve_host;
381 u8 mr_is_resolve_attached;
382 u8 mr_next_hop_proto_is_ip4;
383 u8 mr_next_hop_weight;
385 u8 mr_next_hop_n_out_labels;
386 u32 mr_next_hop_sw_if_index;
387 u32 mr_next_hop_table_id;
388 u32 mr_next_hop_via_label;
389 u32 mr_next_hop_out_label_stack[mr_next_hop_n_out_labels];
392 /** \brief Reply for MPLS route add / del request
393 @param context - returned sender context, to match reply w/ request
394 @param retval - return code
396 define mpls_route_add_del_reply
402 /** \brief Dump MPLS fib table
403 @param client_index - opaque cookie to identify the sender
412 @param sw_if_index - index of the interface
413 @param weight - The weight, for UCMP
414 @param is_local - local if non-zero, else remote
415 @param is_drop - Drop the packet
416 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
417 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
418 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
419 @param next_hop[16] - the next hop address
421 typeonly manual_print manual_endian define fib_path
433 /** \brief mpls FIB table response
434 @param table_id - MPLS fib table id
435 @param s_bit - End-of-stack bit
436 @param label - MPLS label value
437 @param count - the number of fib_path in path
438 @param path - array of of fib_path structures
440 manual_endian manual_print define mpls_fib_details
447 vl_api_fib_path_t path[count];
450 /** \brief Dump IP6 fib table
451 @param client_index - opaque cookie to identify the sender
459 /** \brief IP6 FIB table response
460 @param table_id - IP6 fib table id
461 @address_length - mask length
462 @address - ip6 prefix
463 @param count - the number of fib_path in path
464 @param path - array of of fib_path structures
466 manual_endian manual_print define ip6_fib_details
473 vl_api_fib_path_t path[count];
476 /** \brief Dump IP fib table
477 @param client_index - opaque cookie to identify the sender
485 /** \brief IP FIB table response
486 @param table_id - IP fib table id
487 @address_length - mask length
488 @address - ip4 prefix
489 @param count - the number of fib_path in path
490 @param path - array of of fib_path structures
492 manual_endian manual_print define ip_fib_details
499 vl_api_fib_path_t path[count];
502 /** \brief Bind/Unbind an MPLS local label to an IP prefix. i.e. create
503 a per-prefix label entry.
504 @param client_index - opaque cookie to identify the sender
505 @param context - sender context, to match reply w/ request
506 @param mb_mpls_table_id - The MPLS table-id the MPLS entry will be added in
507 @param mb_label - The MPLS label value to bind
508 @param mb_ip_table_id - The IP table-id of the IP prefix to bind to.
509 @param mb_create_table_if_needed - Create either/both tables if required.
510 @param mb_is_bind - Bind or unbind
511 @param mb_is_ip4 - The prefix to bind to is IPv4
512 @param mb_address_length - Length of IP prefix
513 @param mb_address[16] - IP prefix/
515 define mpls_ip_bind_unbind
519 u32 mb_mpls_table_id;
522 u8 mb_create_table_if_needed;
525 u8 mb_address_length;
529 /** \brief Reply for MPLS IP bind/unbind request
530 @param context - returned sender context, to match reply w/ request
531 @param retval - return code
533 define mpls_ip_bind_unbind_reply
539 /** \brief MPLS tunnel Add / del route
540 @param client_index - opaque cookie to identify the sender
541 @param context - sender context, to match reply w/ request
542 @param mt_is_add - Is this a route add or delete
543 @param mt_sw_if_index - The SW interface index of the tunnel to delete
544 @param mt_next_hop_proto_is_ip4 - The next-hop is IPV4
545 @param mt_next_hop_weight - The weight, for UCMP
546 @param mt_next_hop[16] - the nextop address
547 @param mt_next_hop_sw_if_index - the next-hop SW interface
548 @param mt_next_hop_table_id - the next-hop table-id (if appropriate)
549 @param mt_next_hop_n_out_labels - the number of next-hop output labels
550 @param mt_next_hop_out_label_stack - the next-hop output label stack, outer most first
552 define mpls_tunnel_add_del
559 u8 mt_next_hop_proto_is_ip4;
560 u8 mt_next_hop_weight;
562 u8 mt_next_hop_n_out_labels;
563 u32 mt_next_hop_sw_if_index;
564 u32 mt_next_hop_table_id;
565 u32 mt_next_hop_out_label_stack[mt_next_hop_n_out_labels];
568 /** \brief Reply for MPLS tunnel add / del request
569 @param context - returned sender context, to match reply w/ request
570 @param retval - return code
571 @param sw_if_index - SW interface index of the tunnel created
573 define mpls_tunnel_add_del_reply
580 /** \brief Dump mpls eth tunnel table
581 @param client_index - opaque cookie to identify the sender
582 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
584 define mpls_tunnel_dump
591 /** \brief mpls eth tunnel operational state response
592 @param tunnel_index - eth tunnel identifier
593 @param intfc_address - interface ipv4 addr
594 @param mask_width - interface ipv4 addr mask
595 @param hw_if_index - interface id
597 @param tunnel_dst_mac -
598 @param tx_sw_if_index -
599 @param encap_index - reference to mpls label table
600 @param nlabels - number of resolved labels
601 @param labels - resolved labels
603 define mpls_tunnel_details
609 u8 mt_next_hop_proto_is_ip4;
611 u32 mt_next_hop_sw_if_index;
612 u32 mt_next_hop_table_id;
613 u32 mt_next_hop_n_labels;
614 u32 mt_next_hop_out_labels[mt_next_hop_n_labels];
617 /** \brief Add / del route request
618 @param client_index - opaque cookie to identify the sender
619 @param context - sender context, to match reply w/ request
620 @param sw_if_index - software index of the new vlan's parent interface
621 @param vrf_id - fib table /vrf associated with the route
622 @param lookup_in_vrf -
623 @param classify_table_index -
624 @param create_vrf_if_needed -
625 @param is_add - 1 if adding the route, 0 if deleting
626 @param is_drop - Drop the packet
627 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
628 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
629 @param is_ipv6 - 0 if an ip4 route, else ip6
632 @param is_multipath - Set to 1 if this is a multipath route, else 0
633 @param not_last - Is last or not last msg in group of multiple add/del msgs
634 @param next_hop_weight -
635 @param dst_address_length -
636 @param dst_address[16] -
637 @param next_hop_address[16] -
638 @param next_hop_n_out_labels - the number of labels in the label stack
639 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
640 @param next_hop_via_label - The next-hop is a resolved via a local label
642 define ip_add_del_route
646 u32 next_hop_sw_if_index;
648 u32 classify_table_index;
649 u32 next_hop_table_id;
650 u8 create_vrf_if_needed;
660 u8 is_resolve_attached;
661 /* Is last/not-last message in group of multiple add/del messages. */
664 u8 dst_address_length;
666 u8 next_hop_address[16];
667 u8 next_hop_n_out_labels;
668 u32 next_hop_via_label;
669 u32 next_hop_out_label_stack[next_hop_n_out_labels];
672 /** \brief Reply for add / del route request
673 @param context - returned sender context, to match reply w/ request
674 @param retval - return code
676 define ip_add_del_route_reply
682 /** \brief Proxy ARP add / del request
683 @param client_index - opaque cookie to identify the sender
684 @param context - sender context, to match reply w/ request
685 @param vrf_id - VRF / Fib table ID
686 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
687 @param low_address[4] - Low address of the Proxy ARP range
688 @param hi_address[4] - High address of the Proxy ARP range
690 define proxy_arp_add_del
700 /** \brief Reply for proxy arp add / del request
701 @param context - returned sender context, to match reply w/ request
702 @param retval - return code
704 define proxy_arp_add_del_reply
710 /** \brief Proxy ARP add / del request
711 @param client_index - opaque cookie to identify the sender
712 @param context - sender context, to match reply w/ request
713 @param sw_if_index - Which interface to enable / disable Proxy Arp on
714 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
716 define proxy_arp_intfc_enable_disable
721 /* 1 = on, 0 = off */
725 /** \brief Reply for Proxy ARP interface enable / disable request
726 @param context - returned sender context, to match reply w/ request
727 @param retval - return code
729 define proxy_arp_intfc_enable_disable_reply
735 /** \brief IP neighbor add / del request
736 @param client_index - opaque cookie to identify the sender
737 @param context - sender context, to match reply w/ request
738 @param vrf_id - vrf_id, only for IP4
739 @param sw_if_index - interface used to reach neighbor
740 @param is_add - 1 to add neighbor, 0 to delete
741 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
743 @param mac_address - l2 address of the neighbor
744 @param dst_address - ip4 or ip6 address of the neighbor
746 define ip_neighbor_add_del
750 u32 vrf_id; /* only makes sense for ip4 */
752 /* 1 = add, 0 = delete */
760 /** \brief Reply for IP Neighbor add / delete request
761 @param context - returned sender context, to match reply w/ request
762 @param retval - return code
764 define ip_neighbor_add_del_reply
770 /** \brief Reset VRF (remove all routes etc) request
771 @param client_index - opaque cookie to identify the sender
772 @param context - sender context, to match reply w/ request
773 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
774 @param vrf_id - ID of th FIB table / VRF to reset
784 /** \brief Reply for Reset VRF request
785 @param context - returned sender context, to match reply w/ request
786 @param retval - return code
788 define reset_vrf_reply
794 /** \brief Is Address Reachable request - DISABLED
795 @param client_index - opaque cookie to identify the sender
796 @param context - sender context, to match reply w/ request
797 @param next_hop_sw_if_index - index of interface used to get to next hop
798 @param is_ipv6 - 1 for IPv6, 0 for IPv4
799 @param is_error - address not found or does not match intf
800 @param address[] - Address in question
802 define is_address_reachable
804 u32 client_index; /* (api_main_t *) am->my_client_index */
806 u32 next_hop_sw_if_index;
807 u8 is_known; /* on reply, this is the answer */
809 u8 is_error; /* address not found or does not match intf */
813 /** \brief Want Stats, register for stats updates
814 @param client_index - opaque cookie to identify the sender
815 @param context - sender context, to match reply w/ request
816 @param enable_disable - 1 = enable stats, 0 = disable
817 @param pid - pid of process requesting stats updates
827 /** \brief Reply for Want Stats request
828 @param context - returned sender context, to match reply w/ request
829 @param retval - return code
831 define want_stats_reply
837 /** \brief Want stats counters structure
838 @param vnet_counter_type- such as ip4, ip6, punts, etc
839 @param is_combined - rx & tx total (all types) counts
840 @param first_sw_if_index - first sw index in block of index, counts
841 @param count - number of interfaces this stats block includes counters for
842 @param data - contiguous block of vlib_counter_t structures
844 define vnet_interface_counters
846 /* enums - plural - in vnet/interface.h */
847 u8 vnet_counter_type;
849 u32 first_sw_if_index;
854 typeonly manual_print manual_endian define ip4_fib_counter
862 manual_print manual_endian define vnet_ip4_fib_counters
866 vl_api_ip4_fib_counter_t c[count];
869 typeonly manual_print manual_endian define ip6_fib_counter
877 manual_print manual_endian define vnet_ip6_fib_counters
881 vl_api_ip6_fib_counter_t c[count];
884 /** \brief Request for a single block of summary stats
885 @param client_index - opaque cookie to identify the sender
886 @param context - sender context, to match reply w/ request
888 define vnet_get_summary_stats
894 /** \brief Reply for vnet_get_summary_stats request
895 @param context - sender context, to match reply w/ request
896 @param retval - return code for request
901 define vnet_summary_stats_reply
910 /** \brief OAM event structure
911 @param dst_address[] -
920 /** \brief Want OAM events request
921 @param client_index - opaque cookie to identify the sender
922 @param context - sender context, to match reply w/ request
923 @param enable_disable- enable if non-zero, else disable
924 @param pid - pid of the requesting process
926 define want_oam_events
934 /** \brief Want OAM events response
935 @param context - sender context, to match reply w/ request
936 @param retval - return code for the want oam stats request
938 define want_oam_events_reply
944 /** \brief OAM add / del target request
945 @param client_index - opaque cookie to identify the sender
946 @param context - sender context, to match reply w/ request
947 @param vrf_id - vrf_id of the target
948 @param src_address[] - source address to use for the updates
949 @param dst_address[] - destination address of the target
950 @param is_add - add target if non-zero, else delete
962 /** \brief OAM add / del target response
963 @param context - sender context, to match reply w/ request
964 @param retval - return code of the request
966 define oam_add_del_reply
972 /** \brief Reset fib table request
973 @param client_index - opaque cookie to identify the sender
974 @param context - sender context, to match reply w/ request
975 @param vrf_id - vrf/table id of the fib table to reset
976 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
986 /** \brief Reset fib response
987 @param context - sender context, to match reply w/ request
988 @param retval - return code for the reset bfib request
990 define reset_fib_reply
996 /** \brief DHCP Proxy config add / del request
997 @param client_index - opaque cookie to identify the sender
998 @param context - sender context, to match reply w/ request
999 @param vrf_id - vrf id
1000 @param if_ipv6 - ipv6 if non-zero, else ipv4
1001 @param is_add - add the config if non-zero, else delete
1002 @param insert_circuit_id - option82 suboption 1 fib number
1003 @param dhcp_server[] - server address
1004 @param dhcp_src_address[] - <fix this, need details>
1006 define dhcp_proxy_config
1013 u8 insert_circuit_id;
1015 u8 dhcp_src_address[16];
1018 /** \brief DHCP Proxy config response
1019 @param context - sender context, to match reply w/ request
1020 @param retval - return code for the request
1022 define dhcp_proxy_config_reply
1028 /** \brief DHCP Proxy set / unset vss request
1029 @param client_index - opaque cookie to identify the sender
1030 @param context - sender context, to match reply w/ request
1031 @param tbl_id - table id
1032 @param oui - first part of vpn id
1033 @param fib_id - second part of vpn id
1034 @param is_ipv6 - ip6 if non-zero, else ip4
1035 @param is_add - set vss if non-zero, else delete
1037 define dhcp_proxy_set_vss
1048 /** \brief DHCP proxy set / unset vss response
1049 @param context - sender context, to match reply w/ request
1050 @param retval - return code for the request
1052 define dhcp_proxy_set_vss_reply
1058 /** \brief Set the ip flow hash config for a fib request
1059 @param client_index - opaque cookie to identify the sender
1060 @param context - sender context, to match reply w/ request
1061 @param vrf_id - vrf/fib id
1062 @param is_ipv6 - if non-zero the fib is ip6, else ip4
1063 @param src - if non-zero include src in flow hash
1064 @param dst - if non-zero include dst in flow hash
1065 @param sport - if non-zero include sport in flow hash
1066 @param dport - if non-zero include dport in flow hash
1067 @param proto -if non-zero include proto in flow hash
1068 @param reverse - if non-zero include reverse in flow hash
1070 define set_ip_flow_hash
1084 /** \brief Set the ip flow hash config for a fib response
1085 @param context - sender context, to match reply w/ request
1086 @param retval - return code for the request
1088 define set_ip_flow_hash_reply
1094 /** \brief IPv6 router advertisement config request
1095 @param client_index - opaque cookie to identify the sender
1096 @param context - sender context, to match reply w/ request
1101 @param send_unicast -
1104 @param default_router -
1105 @param max_interval -
1106 @param min_interval -
1108 @param initial_count -
1109 @param initial_interval -
1111 define sw_interface_ip6nd_ra_config
1128 u32 initial_interval;
1131 /** \brief IPv6 router advertisement config response
1132 @param context - sender context, to match reply w/ request
1133 @param retval - return code for the request
1135 define sw_interface_ip6nd_ra_config_reply
1141 /** \brief IPv6 router advertisement prefix config request
1142 @param client_index - opaque cookie to identify the sender
1143 @param context - sender context, to match reply w/ request
1144 @param sw_if_index -
1146 @param address_length -
1147 @param use_default -
1148 @param no_advertise -
1150 @param no_autoconfig -
1153 @param val_lifetime -
1154 @param pref_lifetime -
1156 define sw_interface_ip6nd_ra_prefix
1173 /** \brief IPv6 router advertisement prefix config response
1174 @param context - sender context, to match reply w/ request
1175 @param retval - return code for the request
1177 define sw_interface_ip6nd_ra_prefix_reply
1183 /** \brief IPv6 interface enable / disable request
1184 @param client_index - opaque cookie to identify the sender
1185 @param context - sender context, to match reply w/ request
1186 @param sw_if_index - interface used to reach neighbor
1187 @param enable - if non-zero enable ip6 on interface, else disable
1189 define sw_interface_ip6_enable_disable
1194 u8 enable; /* set to true if enable */
1197 /** \brief IPv6 interface enable / disable response
1198 @param context - sender context, to match reply w/ request
1199 @param retval - return code for the request
1201 define sw_interface_ip6_enable_disable_reply
1207 /** \brief IPv6 set link local address on interface request
1208 @param client_index - opaque cookie to identify the sender
1209 @param context - sender context, to match reply w/ request
1210 @param sw_if_index - interface to set link local on
1211 @param address[] - the new link local address
1212 @param address_length - link local address length
1214 define sw_interface_ip6_set_link_local_address
1223 /** \brief IPv6 set link local address on interface response
1224 @param context - sender context, to match reply w/ request
1225 @param retval - error code for the request
1227 define sw_interface_ip6_set_link_local_address_reply
1233 /** \brief Set unnumbered interface add / del request
1234 @param client_index - opaque cookie to identify the sender
1235 @param context - sender context, to match reply w/ request
1236 @param sw_if_index - interface with an IP address
1237 @param unnumbered_sw_if_index - interface which will use the address
1238 @param is_add - if non-zero set the association, else unset it
1240 define sw_interface_set_unnumbered
1244 u32 sw_if_index; /* use this intfc address */
1245 u32 unnumbered_sw_if_index; /* on this interface */
1249 /** \brief Set unnumbered interface add / del response
1250 @param context - sender context, to match reply w/ request
1251 @param retval - return code for the request
1253 define sw_interface_set_unnumbered_reply
1259 /** \brief Create loopback interface request
1260 @param client_index - opaque cookie to identify the sender
1261 @param context - sender context, to match reply w/ request
1262 @param mac_address - mac addr to assign to the interface if none-zero
1264 define create_loopback
1271 /** \brief Create loopback interface response
1272 @param context - sender context, to match reply w/ request
1273 @param sw_if_index - sw index of the interface that was created
1274 @param retval - return code for the request
1276 define create_loopback_reply
1283 /** \brief Delete loopback interface request
1284 @param client_index - opaque cookie to identify the sender
1285 @param context - sender context, to match reply w/ request
1286 @param sw_if_index - sw index of the interface that was created
1288 define delete_loopback
1295 /** \brief Delete loopback interface response
1296 @param context - sender context, to match reply w/ request
1297 @param retval - return code for the request
1299 define delete_loopback_reply
1305 /** \brief Control ping from client to api server request
1306 @param client_index - opaque cookie to identify the sender
1307 @param context - sender context, to match reply w/ request
1315 /** \brief Control ping from the client to the server response
1316 @param client_index - opaque cookie to identify the sender
1317 @param context - sender context, to match reply w/ request
1318 @param retval - return code for the request
1319 @param vpe_pid - the pid of the vpe, returned by the server
1321 define control_ping_reply
1329 /** \brief Process a vpe parser cli string request
1330 @param client_index - opaque cookie to identify the sender
1331 @param context - sender context, to match reply w/ request
1332 @param cmd_in_shmem - pointer to cli command string
1348 /** \brief vpe parser cli string response
1349 @param context - sender context, to match reply w/ request
1350 @param retval - return code for request
1351 @param reply_in_shmem - Reply string from cli processing if any
1359 define cli_inband_reply
1367 /** \brief Set max allowed ARP or ip6 neighbor entries request
1368 @param client_index - opaque cookie to identify the sender
1369 @param context - sender context, to match reply w/ request
1370 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1371 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1373 define set_arp_neighbor_limit
1378 u32 arp_neighbor_limit;
1381 /** \brief Set max allowed ARP or ip6 neighbor entries response
1382 @param context - sender context, to match reply w/ request
1383 @param retval - return code for request
1385 define set_arp_neighbor_limit_reply
1391 /** \brief L2 interface patch add / del request
1392 @param client_index - opaque cookie to identify the sender
1393 @param context - sender context, to match reply w/ request
1394 @param rx_sw_if_index - receive side interface
1395 @param tx_sw_if_index - transmit side interface
1396 @param is_add - if non-zero set up the interface patch, else remove it
1398 define l2_patch_add_del
1407 /** \brief L2 interface patch add / del response
1408 @param context - sender context, to match reply w/ request
1409 @param retval - return code for the request
1411 define l2_patch_add_del_reply
1417 /** \brief IPv6 segment routing tunnel add / del request
1418 @param client_index - opaque cookie to identify the sender
1419 @param context - sender context, to match reply w/ request
1420 @param is_add - add the tunnel if non-zero, else delete it
1421 @param name[] - tunnel name (len. 64)
1422 @param src_address[] -
1423 @param dst_address[] -
1424 @param dst_mask_width -
1425 @param inner_vrf_id -
1426 @param outer_vrf_id -
1427 @param flags_net_byte_order -
1430 @param segs_and_tags[] -
1431 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1433 define sr_tunnel_add_del
1444 u16 flags_net_byte_order;
1447 u8 segs_and_tags[0];
1451 /** \brief IPv6 segment routing tunnel add / del response
1452 @param context - sender context, to match reply w/ request
1453 @param retval - return value for request
1455 define sr_tunnel_add_del_reply
1461 /** \brief IPv6 segment routing policy add / del request
1462 @param client_index - opaque cookie to identify the sender
1463 @param context - sender context, to match reply w/ request
1464 @param is_add - add the tunnel if non-zero, else delete it
1465 @param name[] - policy name (len. 64)
1466 @param tunnel_names[] -
1468 define sr_policy_add_del
1477 /** \brief IPv6 segment routing policy add / del response
1478 @param context - sender context, to match reply w/ request
1479 @param retval - return value for request
1481 define sr_policy_add_del_reply
1487 /** \brief IPv6 segment routing multicast map to policy add / del request
1488 @param client_index - opaque cookie to identify the sender
1489 @param context - sender context, to match reply w/ request
1490 @param is_add - add the tunnel if non-zero, else delete it
1491 @param multicast_address[] - IP6 multicast address
1492 @param policy_name[] = policy name (len.64)
1494 define sr_multicast_map_add_del
1499 u8 multicast_address[16];
1503 /** \brief IPv6 segment routing multicast map to policy add / del response
1504 @param context - sender context, to match reply w/ request
1505 @param retval - return value for request
1507 define sr_multicast_map_add_del_reply
1513 /** \brief Interface set vpath request
1514 @param client_index - opaque cookie to identify the sender
1515 @param context - sender context, to match reply w/ request
1516 @param sw_if_index - interface used to reach neighbor
1517 @param enable - if non-zero enable, else disable
1519 define sw_interface_set_vpath
1527 /** \brief Interface set vpath response
1528 @param context - sender context, to match reply w/ request
1529 @param retval - return code for the request
1531 define sw_interface_set_vpath_reply
1537 /** \brief Interface set vxlan-bypass request
1538 @param client_index - opaque cookie to identify the sender
1539 @param context - sender context, to match reply w/ request
1540 @param sw_if_index - interface used to reach neighbor
1541 @param is_ipv6 - if non-zero, enable ipv6-vxlan-bypass, else ipv4-vxlan-bypass
1542 @param enable - if non-zero enable, else disable
1544 define sw_interface_set_vxlan_bypass
1553 /** \brief Interface set vxlan-bypass response
1554 @param context - sender context, to match reply w/ request
1555 @param retval - return code for the request
1557 define sw_interface_set_vxlan_bypass_reply
1563 /** \brief Set L2 XConnect between two interfaces request
1564 @param client_index - opaque cookie to identify the sender
1565 @param context - sender context, to match reply w/ request
1566 @param rx_sw_if_index - Receive interface index
1567 @param tx_sw_if_index - Transmit interface index
1568 @param enable - enable xconnect if not 0, else set to L3 mode
1570 define sw_interface_set_l2_xconnect
1579 /** \brief Set L2 XConnect response
1580 @param context - sender context, to match reply w/ request
1581 @param retval - L2 XConnect request return code
1583 define sw_interface_set_l2_xconnect_reply
1589 /** \brief Interface bridge mode request
1590 @param client_index - opaque cookie to identify the sender
1591 @param context - sender context, to match reply w/ request
1592 @param rx_sw_if_index - the interface
1593 @param bd_id - bridge domain id
1594 @param bvi - Setup interface as a bvi, bridge mode only
1595 @param shg - Shared horizon group, for bridge mode only
1596 @param enable - Enable beige mode if not 0, else set to L3 mode
1598 define sw_interface_set_l2_bridge
1609 /** \brief Interface bridge mode response
1610 @param context - sender context, to match reply w/ request
1611 @param retval - Bridge mode request return code
1613 define sw_interface_set_l2_bridge_reply
1619 /** \brief L2 FIB add entry request
1620 @param client_index - opaque cookie to identify the sender
1621 @param context - sender context, to match reply w/ request
1622 @param mac - the entry's mac address
1623 @param bd_id - the entry's bridge domain id
1624 @param sw_if_index - the interface
1625 @param is_add - If non zero add the entry, else delete it
1629 define l2fib_add_del
1642 /** \brief L2 FIB add entry response
1643 @param context - sender context, to match reply w/ request
1644 @param retval - return code for the add l2fib entry request
1646 define l2fib_add_del_reply
1652 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1653 @param client_index - opaque cookie to identify the sender
1654 @param context - sender context, to match reply w/ request
1655 @param sw_if_index - interface
1656 @param is_set - if non-zero, set the bits, else clear them
1657 @param feature_bitmap - non-zero bits to set or clear
1668 /** \brief Set L2 bits response
1669 @param context - sender context, to match reply w/ request
1670 @param retval - return code for the set l2 bits request
1672 define l2_flags_reply
1676 u32 resulting_feature_bitmap;
1679 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1680 L2_UU_FLOOD, or L2_ARP_TERM) request
1681 @param client_index - opaque cookie to identify the sender
1682 @param context - sender context, to match reply w/ request
1683 @param bd_id - the bridge domain to set the flags for
1684 @param is_set - if non-zero, set the flags, else clear them
1685 @param feature_bitmap - bits that are non-zero to set or clear
1696 /** \brief Set bridge flags response
1697 @param context - sender context, to match reply w/ request
1698 @param retval - return code for the set bridge flags request
1699 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1701 define bridge_flags_reply
1705 u32 resulting_feature_bitmap;
1708 /** \brief Set bridge domain ip to mac entry request
1709 @param client_index - opaque cookie to identify the sender
1710 @param context - sender context, to match reply w/ request
1711 @param bd_id - the bridge domain to set the flags for
1712 @param is_add - if non-zero, add the entry, else clear it
1713 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1714 @param mac_address - MAC address
1717 define bd_ip_mac_add_del
1728 /** \brief Set bridge domain ip to mac entry response
1729 @param context - sender context, to match reply w/ request
1730 @param retval - return code for the set bridge flags request
1732 define bd_ip_mac_add_del_reply
1738 /** \brief Add/Delete classification table request
1739 @param client_index - opaque cookie to identify the sender
1740 @param context - sender context, to match reply w/ request
1741 @param is_add- if non-zero add the table, else delete it
1742 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1743 @param nbuckets - number of buckets when adding a table
1744 @param memory_size - memory size when adding a table
1745 @param match_n_vectors - number of match vectors
1746 @param next_table_index - index of next table
1747 @param miss_next_index - index of miss table
1748 @param current_data_flag - option to use current node's packet payload
1749 as the starting point from where packets are classified,
1750 This option is only valid for L2/L3 input ACL for now.
1751 0: by default, classify data from the buffer's start location
1752 1: classify packets from VPP node’s current data pointer
1753 @param current_data_offset - a signed value to shift the start location of
1754 the packet to be classified
1755 For example, if input IP ACL node is used, L2 header’s first byte
1756 can be accessible by configuring current_data_offset to -14
1757 if there is no vlan tag.
1758 This is valid only if current_data_flag is set to 1.
1759 @param mask[] - match mask
1761 define classify_add_del_table
1770 u32 match_n_vectors;
1771 u32 next_table_index;
1772 u32 miss_next_index;
1773 u32 current_data_flag;
1774 i32 current_data_offset;
1778 /** \brief Add/Delete classification table response
1779 @param context - sender context, to match reply w/ request
1780 @param retval - return code for the table add/del requst
1781 @param new_table_index - for add, returned index of the new table
1782 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1783 @param match_n_vectors -for add, returned value of match_n_vectors in table
1785 define classify_add_del_table_reply
1789 u32 new_table_index;
1791 u32 match_n_vectors;
1794 /** \brief Classify add / del session request
1795 @param client_index - opaque cookie to identify the sender
1796 @param context - sender context, to match reply w/ request
1797 @param is_add - add session if non-zero, else delete
1798 @param table_index - index of the table to add/del the session, required
1799 @param hit_next_index - for add, hit_next_index of new session, required
1800 @param opaque_index - for add, opaque_index of new session
1801 @param advance -for add, advance value for session
1803 0: no action (by default)
1804 metadata is not used.
1805 1: Classified IP packets will be looked up from the
1806 specified ipv4 fib table (configured by metadata as VRF id).
1807 Only valid for L3 input ACL node
1808 2: Classified IP packets will be looked up from the
1809 specified ipv6 fib table (configured by metadata as VRF id).
1810 Only valid for L3 input ACL node
1811 @param metadata - valid only if action != 0
1812 VRF id if action is 1 or 2.
1813 @param match[] - for add, match value for session, required
1815 define classify_add_del_session
1829 /** \brief Classify add / del session response
1830 @param context - sender context, to match reply w/ request
1831 @param retval - return code for the add/del session request
1833 define classify_add_del_session_reply
1839 /** \brief Set/unset the classification table for an interface request
1840 @param client_index - opaque cookie to identify the sender
1841 @param context - sender context, to match reply w/ request
1842 @param is_ipv6 - ipv6 if non-zero, else ipv4
1843 @param sw_if_index - interface to associate with the table
1844 @param table_index - index of the table, if ~0 unset the table
1846 define classify_set_interface_ip_table
1852 u32 table_index; /* ~0 => off */
1855 /** \brief Set/unset interface classification table response
1856 @param context - sender context, to match reply w/ request
1857 @param retval - return code
1859 define classify_set_interface_ip_table_reply
1865 /** \brief Set/unset l2 classification tables for an interface request
1866 @param client_index - opaque cookie to identify the sender
1867 @param context - sender context, to match reply w/ request
1868 @param sw_if_index - interface to set/unset tables for
1869 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1870 @param ip6_table_index - ip6 index
1871 @param other_table_index - other index
1873 define classify_set_interface_l2_tables
1879 u32 ip4_table_index;
1880 u32 ip6_table_index;
1881 u32 other_table_index;
1885 /** \brief Set/unset l2 classification tables for an interface response
1886 @param context - sender context, to match reply w/ request
1887 @param retval - return code for the request
1889 define classify_set_interface_l2_tables_reply
1895 /** \brief Get node index using name request
1896 @param client_index - opaque cookie to identify the sender
1897 @param context - sender context, to match reply w/ request
1898 @param node_name[] - name of the node
1900 define get_node_index
1907 /** \brief Get node index using name request
1908 @param context - sender context, to match reply w/ request
1909 @param retval - return code for the request
1910 @param node_index - index of the desired node if found, else ~0
1912 define get_node_index_reply
1919 /** \brief Set the next node for a given node request
1920 @param client_index - opaque cookie to identify the sender
1921 @param context - sender context, to match reply w/ request
1922 @param node_name[] - node to add the next node to
1923 @param next_name[] - node to add as the next node
1925 define add_node_next
1933 /** \brief IP Set the next node for a given node response
1934 @param context - sender context, to match reply w/ request
1935 @param retval - return code for the add next node request
1936 @param next_index - the index of the next node if success, else ~0
1938 define add_node_next_reply
1945 /** \brief DHCP Proxy config 2 add / del request
1946 @param client_index - opaque cookie to identify the sender
1947 @param context - sender context, to match reply w/ request
1948 @param rx_vrf_id - receive vrf id
1949 @param server_vrf_id - server vrf id
1950 @param if_ipv6 - ipv6 if non-zero, else ipv4
1951 @param is_add - add the config if non-zero, else delete
1952 @param insert_circuit_id - option82 suboption 1 fib number
1953 @param dhcp_server[] - server address
1954 @param dhcp_src_address[] - <fix this, need details>
1956 define dhcp_proxy_config_2
1964 u8 insert_circuit_id;
1966 u8 dhcp_src_address[16];
1969 /** \brief DHCP Proxy config 2 add / del response
1970 @param context - sender context, to match reply w/ request
1971 @param retval - return code for request
1973 define dhcp_proxy_config_2_reply
1979 /** \brief l2tpv3 tunnel interface create request
1980 @param client_index - opaque cookie to identify the sender
1981 @param context - sender context, to match reply w/ request
1982 @param client_address - remote client tunnel ip address
1983 @param client_address - local tunnel ip address
1984 @param is_ipv6 - ipv6 if non-zero, else ipv4
1985 @param local_session_id - local tunnel session id
1986 @param remote_session_id - remote tunnel session id
1987 @param local_cookie - local tunnel cookie
1988 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1989 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1991 define l2tpv3_create_tunnel
1995 u8 client_address[16];
1998 u32 local_session_id;
1999 u32 remote_session_id;
2002 u8 l2_sublayer_present;
2006 /** \brief l2tpv3 tunnel interface create response
2007 @param context - sender context, to match reply w/ request
2008 @param retval - return code for the request
2009 @param sw_if_index - index of the new tunnel interface
2011 define l2tpv3_create_tunnel_reply
2018 define l2tpv3_set_tunnel_cookies
2023 u64 new_local_cookie;
2024 u64 new_remote_cookie;
2027 /** \brief L2TP tunnel set cookies response
2028 @param context - sender context, to match reply w/ request
2029 @param retval - return code for the request
2031 define l2tpv3_set_tunnel_cookies_reply
2037 define sw_if_l2tpv3_tunnel_details
2041 u8 interface_name[64];
2042 u8 client_address[16];
2044 u32 local_session_id;
2045 u32 remote_session_id;
2046 u64 local_cookie[2];
2048 u8 l2_sublayer_present;
2051 define sw_if_l2tpv3_tunnel_dump
2057 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
2058 @param client_index - opaque cookie to identify the sender
2059 @param context - sender context, to match reply w/ request
2061 define l2_fib_clear_table
2067 /** \brief L2 fib clear table response
2068 @param context - sender context, to match reply w/ request
2069 @param retval - return code for the request
2071 define l2_fib_clear_table_reply
2077 /** \brief L2 interface ethernet flow point filtering enable/disable request
2078 @param client_index - opaque cookie to identify the sender
2079 @param context - sender context, to match reply w/ request
2080 @param sw_if_index - interface to enable/disable filtering on
2081 @param enable_disable - if non-zero enable filtering, else disable
2083 define l2_interface_efp_filter
2091 /** \brief L2 interface ethernet flow point filtering response
2092 @param context - sender context, to match reply w/ request
2093 @param retval - return code for the request
2095 define l2_interface_efp_filter_reply
2101 define l2tpv3_interface_enable_disable
2109 define l2tpv3_interface_enable_disable_reply
2115 define l2tpv3_set_lookup_key
2119 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
2123 define l2tpv3_set_lookup_key_reply
2129 define vxlan_add_del_tunnel
2137 u32 mcast_sw_if_index;
2139 u32 decap_next_index;
2143 define vxlan_add_del_tunnel_reply
2150 define vxlan_tunnel_dump
2157 define vxlan_tunnel_details
2163 u32 mcast_sw_if_index;
2165 u32 decap_next_index;
2170 define gre_add_del_tunnel
2182 define gre_add_del_tunnel_reply
2189 define gre_tunnel_dump
2196 define gre_tunnel_details
2207 /** \brief L2 interface vlan tag rewrite configure request
2208 @param client_index - opaque cookie to identify the sender
2209 @param context - sender context, to match reply w/ request
2210 @param sw_if_index - interface the operation is applied to
2211 @param vtr_op - Choose from l2_vtr_op_t enum values
2212 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
2213 @param tag1 - Needed for any push or translate vtr op
2214 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
2216 define l2_interface_vlan_tag_rewrite
2222 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
2223 u32 tag1; // first pushed tag
2224 u32 tag2; // second pushed tag
2227 /** \brief L2 interface vlan tag rewrite response
2228 @param context - sender context, to match reply w/ request
2229 @param retval - return code for the request
2231 define l2_interface_vlan_tag_rewrite_reply
2237 /** \brief vhost-user interface create request
2238 @param client_index - opaque cookie to identify the sender
2239 @param is_server - our side is socket server
2240 @param sock_filename - unix socket filename, used to speak with frontend
2241 @param use_custom_mac - enable or disable the use of the provided hardware address
2242 @param mac_address - hardware address to use if 'use_custom_mac' is set
2244 define create_vhost_user_if
2249 u8 sock_filename[256];
2251 u32 custom_dev_instance;
2257 /** \brief vhost-user interface create response
2258 @param context - sender context, to match reply w/ request
2259 @param retval - return code for the request
2260 @param sw_if_index - interface the operation is applied to
2262 define create_vhost_user_if_reply
2269 /** \brief vhost-user interface modify request
2270 @param client_index - opaque cookie to identify the sender
2271 @param is_server - our side is socket server
2272 @param sock_filename - unix socket filename, used to speak with frontend
2274 define modify_vhost_user_if
2280 u8 sock_filename[256];
2282 u32 custom_dev_instance;
2285 /** \brief vhost-user interface modify response
2286 @param context - sender context, to match reply w/ request
2287 @param retval - return code for the request
2289 define modify_vhost_user_if_reply
2295 /** \brief vhost-user interface delete request
2296 @param client_index - opaque cookie to identify the sender
2298 define delete_vhost_user_if
2305 /** \brief vhost-user interface delete response
2306 @param context - sender context, to match reply w/ request
2307 @param retval - return code for the request
2309 define delete_vhost_user_if_reply
2322 /* These fields map directly onto the subif template */
2326 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2329 u8 outer_vlan_id_any;
2330 u8 inner_vlan_id_any;
2335 define create_subif_reply
2342 /** \brief show version
2343 @param client_index - opaque cookie to identify the sender
2344 @param context - sender context, to match reply w/ request
2352 /** \brief show version response
2353 @param context - sender context, to match reply w/ request
2354 @param retval - return code for the request
2355 @param program - name of the program (vpe)
2356 @param version - version of the program
2357 @param build_directory - root of the workspace where the program was built
2359 define show_version_reply
2366 u8 build_directory[256];
2369 /** \brief Vhost-user interface details structure (fix this)
2370 @param sw_if_index - index of the interface
2371 @param interface_name - name of interface
2372 @param virtio_net_hdr_sz - net header size
2373 @param features - interface features
2374 @param is_server - vhost-user server socket
2375 @param sock_filename - socket filename
2376 @param num_regions - number of used memory regions
2378 define sw_interface_vhost_user_details
2382 u8 interface_name[64];
2383 u32 virtio_net_hdr_sz;
2386 u8 sock_filename[256];
2392 define sw_interface_vhost_user_dump
2398 define ip_address_details
2406 define ip_address_dump
2427 /** \brief l2 fib table entry structure
2428 @param bd_id - the l2 fib / bridge domain table id
2429 @param mac - the entry's mac address
2430 @param sw_if_index - index of the interface
2431 @param static_mac - the entry is statically configured.
2432 @param filter_mac - the entry is a mac filter entry.
2433 @param bvi_mac - the mac address is a bridge virtual interface
2435 define l2_fib_table_entry
2446 /** \brief Dump l2 fib (aka bridge domain) table
2447 @param client_index - opaque cookie to identify the sender
2448 @param bd_id - the l2 fib / bridge domain table identifier
2450 define l2_fib_table_dump
2457 define vxlan_gpe_add_del_tunnel
2471 define vxlan_gpe_add_del_tunnel_reply
2478 define vxlan_gpe_tunnel_dump
2485 define vxlan_gpe_tunnel_details
2498 /** \brief add or delete locator_set
2499 @param client_index - opaque cookie to identify the sender
2500 @param context - sender context, to match reply w/ request
2501 @param is_add - add address if non-zero, else delete
2502 @param locator_set_name - locator name
2503 @param locator_num - number of locators
2504 @param locators - LISP locator records
2505 Structure of one locator record is as follows:
2513 define lisp_add_del_locator_set
2518 u8 locator_set_name[64];
2523 /** \brief Reply for locator_set add/del
2524 @param context - returned sender context, to match reply w/ request
2525 @param retval - return code
2526 @param ls_index - locator set index
2528 define lisp_add_del_locator_set_reply
2535 /** \brief add or delete locator for locator_set
2536 @param client_index - opaque cookie to identify the sender
2537 @param context - sender context, to match reply w/ request
2538 @param is_add - add address if non-zero, else delete
2539 @param locator_set_name - name of locator_set to add/del locator
2540 @param sw_if_index - index of the interface
2541 @param priority - priority of the lisp locator
2542 @param weight - weight of the lisp locator
2544 define lisp_add_del_locator
2549 u8 locator_set_name[64];
2555 /** \brief Reply for locator add/del
2556 @param context - returned sender context, to match reply w/ request
2557 @param retval - return code
2559 define lisp_add_del_locator_reply
2565 /** \brief add or delete lisp eid-table
2566 @param client_index - opaque cookie to identify the sender
2567 @param context - sender context, to match reply w/ request
2568 @param is_add - add address if non-zero, else delete
2573 @param eid - EID can be ip4, ip6 or mac
2574 @param prefix_len - prefix len
2575 @param locator_set_name - name of locator_set to add/del eid-table
2576 @param vni - virtual network instance
2578 define lisp_add_del_local_eid
2586 u8 locator_set_name[64];
2590 /** \brief Reply for local_eid add/del
2591 @param context - returned sender context, to match reply w/ request
2592 @param retval - return code
2594 define lisp_add_del_local_eid_reply
2600 /** \brief add or delete lisp gpe tunnel
2601 @param client_index - opaque cookie to identify the sender
2602 @param context - sender context, to match reply w/ request
2603 @param is_add - add address if non-zero, else delete
2608 @param rmt_eid - remote eid
2609 @param lcl_eid - local eid
2610 @param rmt_len - remote prefix len
2611 @param lcl_len - local prefix len
2612 @param vni - virtual network identifier
2613 @param dp_table - vrf/bridge domain id
2614 @param loc_num - number of locators
2615 @param lcl_locs - array of local locators
2616 @param rmt_locs - array of remote locators
2617 @param action - negative action when 0 locators configured
2619 define lisp_gpe_add_del_fwd_entry
2632 u8 lcl_locs[loc_num];
2633 u8 rmt_locs[loc_num];
2637 /** \brief Reply for gpe_fwd_entry add/del
2638 @param context - returned sender context, to match reply w/ request
2639 @param retval - return code
2641 define lisp_gpe_add_del_fwd_entry_reply
2647 /** \brief add or delete map-resolver
2648 @param client_index - opaque cookie to identify the sender
2649 @param context - sender context, to match reply w/ request
2650 @param is_add - add address if non-zero, else delete
2651 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2652 @param ip_address - array of address bytes
2654 define lisp_add_del_map_resolver
2663 /** \brief Reply for map_resolver add/del
2664 @param context - returned sender context, to match reply w/ request
2665 @param retval - return code
2667 define lisp_add_del_map_resolver_reply
2673 /** \brief enable or disable lisp-gpe protocol
2674 @param client_index - opaque cookie to identify the sender
2675 @param context - sender context, to match reply w/ request
2676 @param is_en - enable protocol if non-zero, else disable
2678 define lisp_gpe_enable_disable
2685 /** \brief Reply for gpe enable/disable
2686 @param context - returned sender context, to match reply w/ request
2687 @param retval - return code
2689 define lisp_gpe_enable_disable_reply
2695 /** \brief enable or disable LISP feature
2696 @param client_index - opaque cookie to identify the sender
2697 @param context - sender context, to match reply w/ request
2698 @param is_en - enable protocol if non-zero, else disable
2700 define lisp_enable_disable
2707 /** \brief Reply for gpe enable/disable
2708 @param context - returned sender context, to match reply w/ request
2709 @param retval - return code
2711 define lisp_enable_disable_reply
2717 /** \brief add or delete gpe_iface
2718 @param client_index - opaque cookie to identify the sender
2719 @param context - sender context, to match reply w/ request
2720 @param is_add - add address if non-zero, else delete
2722 define lisp_gpe_add_del_iface
2732 /** \brief Reply for gpe_iface add/del
2733 @param context - returned sender context, to match reply w/ request
2734 @param retval - return code
2736 define lisp_gpe_add_del_iface_reply
2742 /** \brief configure or disable LISP PITR node
2743 @param client_index - opaque cookie to identify the sender
2744 @param context - sender context, to match reply w/ request
2745 @param ls_name - locator set name
2746 @param is_add - add locator set if non-zero, else disable pitr
2748 define lisp_pitr_set_locator_set
2756 /** \brief Reply for lisp_pitr_set_locator_set
2757 @param context - returned sender context, to match reply w/ request
2758 @param retval - return code
2760 define lisp_pitr_set_locator_set_reply
2766 /** \brief set LISP map-request mode. Based on configuration VPP will send
2767 src/dest or just normal destination map requests.
2768 @param client_index - opaque cookie to identify the sender
2769 @param context - sender context, to match reply w/ request
2770 @param mode - new map-request mode. Supported values are:
2771 0 - destination only
2772 1 - source/destaination
2774 define lisp_map_request_mode
2781 /** \brief Reply for lisp_map_request_mode
2782 @param context - returned sender context, to match reply w/ request
2783 @param retval - return code
2785 define lisp_map_request_mode_reply
2791 /** \brief Request for LISP map-request mode
2792 @param client_index - opaque cookie to identify the sender
2793 @param context - sender context, to match reply w/ request
2795 define show_lisp_map_request_mode
2801 /** \brief Reply for show_lisp_map_request_mode
2802 @param context - returned sender context, to match reply w/ request
2803 @param retval - return code
2804 @param mode - map-request mode
2806 define show_lisp_map_request_mode_reply
2813 /** \brief add or delete remote static mapping
2814 @param client_index - opaque cookie to identify the sender
2815 @param context - sender context, to match reply w/ request
2816 @param is_add - add address if non-zero, else delete
2817 @param is_src_dst - flag indicating src/dst based routing policy
2818 @param del_all - if set, delete all remote mappings
2819 @param vni - virtual network instance
2820 @param action - negative map-reply action
2825 @param deid - dst EID
2826 @param seid - src EID, valid only if is_src_dst is enabled
2827 @param rloc_num - number of remote locators
2828 @param rlocs - remote locator records
2829 Structure of remote locator:
2838 define lisp_add_del_remote_mapping
2856 /** \brief Reply for lisp_add_del_remote_mapping
2857 @param context - returned sender context, to match reply w/ request
2858 @param retval - return code
2860 define lisp_add_del_remote_mapping_reply
2866 /** \brief add or delete LISP adjacency adjacency
2867 @param client_index - opaque cookie to identify the sender
2868 @param context - sender context, to match reply w/ request
2869 @param is_add - add address if non-zero, else delete
2870 @param vni - virtual network instance
2875 @param reid - remote EID
2876 @param leid - local EID
2878 define lisp_add_del_adjacency
2891 /** \brief Reply for lisp_add_del_adjacency
2892 @param context - returned sender context, to match reply w/ request
2893 @param retval - return code
2895 define lisp_add_del_adjacency_reply
2901 /** \brief add or delete map request itr rlocs
2902 @param client_index - opaque cookie to identify the sender
2903 @param context - sender context, to match reply w/ request
2904 @param is_add - add address if non-zero, else delete
2905 @param locator_set_name - locator set name
2907 define lisp_add_del_map_request_itr_rlocs
2912 u8 locator_set_name[64];
2915 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2916 @param context - returned sender context, to match reply w/ request
2917 @param retval - return code
2920 define lisp_add_del_map_request_itr_rlocs_reply
2926 /** \brief map/unmap vni/bd_index to vrf
2927 @param client_index - opaque cookie to identify the sender
2928 @param context - sender context, to match reply w/ request
2929 @param is_add - add or delete mapping
2930 @param dp_table - virtual network id/bridge domain index
2933 define lisp_eid_table_add_del_map
2943 /** \brief Reply for lisp_eid_table_add_del_map
2944 @param context - returned sender context, to match reply w/ request
2945 @param retval - return code
2947 define lisp_eid_table_add_del_map_reply
2953 /** \brief Request for map lisp locator status
2954 @param client_index - opaque cookie to identify the sender
2955 @param context - sender context, to match reply w/ request
2956 @param locator_set_index - index of locator_set
2957 @param ls_name - locator set name
2958 @param is_index_set - flag indicating whether ls_name or ls_index is set
2960 define lisp_locator_dump
2969 /** \brief LISP locator_set status
2970 @param local - if is set, then locator is local
2971 @param locator_set_name - name of the locator_set
2972 @param sw_if_index - sw_if_index of the locator
2973 @param priority - locator priority
2974 @param weight - locator weight
2976 define lisp_locator_details
2987 /** \brief LISP locator_set status
2988 @param context - sender context, to match reply w/ request
2989 @param ls_index - locator set index
2990 @param ls_name - name of the locator set
2992 define lisp_locator_set_details
2999 /** \brief Request for locator_set summary status
3000 @param client_index - opaque cookie to identify the sender
3001 @param context - sender context, to match reply w/ request
3002 @param filter - filter type
3005 1: local locator sets
3006 2: remote locator sets
3008 define lisp_locator_set_dump
3015 /** \brief Dump lisp eid-table
3016 @param client_index - opaque cookie to identify the sender
3017 @param context - sender context, to match reply w/ request
3018 @param locator_set_index - index of locator_set, if ~0 then the mapping
3020 @param action - negative map request action
3021 @param is_local - local if non-zero, else remote
3026 @param is_src_dst - EID is type of source/destination
3027 @param eid - EID can be ip4, ip6 or mac
3028 @param eid_prefix_len - prefix length
3029 @param seid - source EID can be ip4, ip6 or mac
3030 @param seid_prefix_len - source prefix length
3031 @param vni - virtual network instance
3032 @param ttl - time to live
3033 @param authoritative - authoritative
3036 define lisp_eid_table_details
3039 u32 locator_set_index;
3053 /** \brief Request for eid table summary status
3054 @param client_index - opaque cookie to identify the sender
3055 @param context - sender context, to match reply w/ request
3056 @param eid_set - if non-zero request info about specific mapping
3057 @param vni - virtual network instance; valid only if eid_set != 0
3058 @param prefix_length - prefix length if EID is IP address;
3059 valid only if eid_set != 0
3060 @param eid_type - EID type; valid only if eid_set != 0
3064 2: EID is ethernet address
3065 @param eid - endpoint identifier
3066 @param filter - filter type;
3072 define lisp_eid_table_dump
3084 /** \brief LISP adjacency
3089 @param reid - remote EID
3090 @param leid - local EID
3091 @param reid_prefix_len - remote EID IP prefix length
3092 @param leid_prefix_len - local EID IP prefix length
3094 typeonly manual_print manual_endian define lisp_adjacency
3103 /** \brief LISP adjacency reply
3104 @param count - number of adjacencies
3105 @param adjacencies - array of adjacencies
3107 manual_endian manual_print define lisp_adjacencies_get_reply
3112 vl_api_lisp_adjacency_t adjacencies[count];
3115 /** \brief Request for LISP adjacencies
3116 @param client_index - opaque cookie to identify the sender
3117 @param context - sender context, to match reply w/ request
3118 @param vni - filter adjacencies by VNI
3120 define lisp_adjacencies_get
3127 /** \brief Shows relationship between vni and vrf/bd
3128 @param dp_table - VRF index or bridge domain index
3129 @param vni - vitual network instance
3131 define lisp_eid_table_map_details
3138 /** \brief Request for lisp_eid_table_map_details
3139 @param client_index - opaque cookie to identify the sender
3140 @param context - sender context, to match reply w/ request
3141 @param is_l2 - if set dump vni/bd mappings else vni/vrf
3143 define lisp_eid_table_map_dump
3150 /** \brief Dumps all VNIs used in mappings
3151 @param client_index - opaque cookie to identify the sender
3152 @param context - sender context, to match reply w/ request
3154 define lisp_eid_table_vni_dump
3160 /** \brief reply to lisp_eid_table_vni_dump
3161 @param client_index - opaque cookie to identify the sender
3162 @param context - sender context, to match reply w/ request
3163 @param vni - virtual network instance
3165 define lisp_eid_table_vni_details
3172 define lisp_gpe_tunnel_details
3178 u8 destination_ip[16];
3190 /** \brief Request for gpe tunnel summary status
3191 @param client_index - opaque cookie to identify the sender
3192 @param context - sender context, to match reply w/ request
3194 define lisp_gpe_tunnel_dump
3200 /** \brief LISP map resolver status
3201 @param locator_set_name - name of the locator_set
3202 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3203 @param ip_address - array of address bytes
3205 define lisp_map_resolver_details
3212 /** \brief Request for map resolver summary status
3213 @param client_index - opaque cookie to identify the sender
3214 @param context - sender context, to match reply w/ request
3216 define lisp_map_resolver_dump
3222 /** \brief Request for lisp-gpe protocol status
3223 @param client_index - opaque cookie to identify the sender
3224 @param context - sender context, to match reply w/ request
3226 define show_lisp_status
3232 /** \brief Status of lisp, enable or disable
3233 @param context - sender context, to match reply w/ request
3234 @param feature_status - lisp enable if non-zero, else disable
3235 @param gpe_status - lisp enable if non-zero, else disable
3237 define show_lisp_status_reply
3245 /** \brief Get LISP map request itr rlocs status
3246 @param context - sender context, to match reply w/ request
3247 @param locator_set_name - name of the locator_set
3249 define lisp_get_map_request_itr_rlocs
3255 /** \brief Request for map request itr rlocs summary status
3257 define lisp_get_map_request_itr_rlocs_reply
3261 u8 locator_set_name[64];
3264 /** \brief Request for lisp pitr status
3265 @param client_index - opaque cookie to identify the sender
3266 @param context - sender context, to match reply w/ request
3268 define show_lisp_pitr
3274 /** \brief Status of lisp pitr, enable or disable
3275 @param context - sender context, to match reply w/ request
3276 @param status - lisp pitr enable if non-zero, else disable
3277 @param locator_set_name - name of the locator_set
3279 define show_lisp_pitr_reply
3284 u8 locator_set_name[64];
3287 /* Gross kludge, DGMS */
3288 define interface_name_renumber
3293 u32 new_show_dev_instance;
3296 define interface_name_renumber_reply
3302 /** \brief Register for ip4 arp resolution events
3303 @param client_index - opaque cookie to identify the sender
3304 @param context - sender context, to match reply w/ request
3305 @param enable_disable - 1 => register for events, 0 => cancel registration
3306 @param pid - sender's pid
3307 @param address - the exact ip4 address of interest
3309 define want_ip4_arp_events
3318 /** \brief Reply for interface events registration
3319 @param context - returned sender context, to match reply w/ request
3320 @param retval - return code
3322 define want_ip4_arp_events_reply
3328 /** \brief Tell client about an ip4 arp resolution event
3329 @param client_index - opaque cookie to identify the sender
3330 @param context - sender context, to match reply w/ request
3331 @param address - the exact ip4 address of interest
3332 @param pid - client pid registered to receive notification
3333 @param sw_if_index - interface which received ARP packet
3334 @param new_mac - the new mac address
3335 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3337 define ip4_arp_event
3348 /** \brief Register for ip6 nd resolution events
3349 @param client_index - opaque cookie to identify the sender
3350 @param context - sender context, to match reply w/ request
3351 @param enable_disable - 1 => register for events, 0 => cancel registration
3352 @param pid - sender's pid
3353 @param address - the exact ip6 address of interest
3355 define want_ip6_nd_events
3364 /** \brief Reply for ip6 nd resolution events registration
3365 @param context - returned sender context, to match reply w/ request
3366 @param retval - return code
3368 define want_ip6_nd_events_reply
3374 /** \brief Tell client about an ip6 nd resolution or mac/ip event
3375 @param client_index - opaque cookie to identify the sender
3376 @param context - sender context, to match reply w/ request
3377 @param pid - client pid registered to receive notification
3378 @param sw_if_index - interface which received ARP packet
3379 @param address - the exact ip6 address of interest
3380 @param new_mac - the new mac address
3381 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3394 /** \brief L2 bridge domain add or delete request
3395 @param client_index - opaque cookie to identify the sender
3396 @param context - sender context, to match reply w/ request
3397 @param bd_id - the bridge domain to create
3398 @param flood - enable/disable bcast/mcast flooding in the bd
3399 @param uu_flood - enable/disable uknown unicast flood in the bd
3400 @param forward - enable/disable forwarding on all interfaces in the bd
3401 @param learn - enable/disable learning on all interfaces in the bd
3402 @param arp_term - enable/disable arp termination in the bd
3403 @param is_add - add or delete flag
3405 define bridge_domain_add_del
3418 /** \brief L2 bridge domain add or delete response
3419 @param context - sender context, to match reply w/ request
3420 @param retval - return code for the set bridge flags request
3422 define bridge_domain_add_del_reply
3428 /** \brief L2 bridge domain request operational state details
3429 @param client_index - opaque cookie to identify the sender
3430 @param context - sender context, to match reply w/ request
3431 @param bd_id - the bridge domain id desired or ~0 to request all bds
3433 define bridge_domain_dump
3440 /** \brief L2 bridge domain operational state response
3441 @param bd_id - the bridge domain id
3442 @param flood - bcast/mcast flooding state on all interfaces in the bd
3443 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3444 @param forward - forwarding state on all interfaces in the bd
3445 @param learn - learning state on all interfaces in the bd
3446 @param arp_term - arp termination state on all interfaces in the bd
3447 @param n_sw_ifs - number of sw_if_index's in the domain
3449 define bridge_domain_details
3458 u32 bvi_sw_if_index;
3462 /** \brief L2 bridge domain sw interface operational state response
3463 @param bd_id - the bridge domain id
3464 @param sw_if_index - sw_if_index in the domain
3465 @param shg - split horizon group for the interface
3467 define bridge_domain_sw_if_details
3475 /** \brief DHCP Client config add / del request
3476 @param client_index - opaque cookie to identify the sender
3477 @param context - sender context, to match reply w/ request
3478 @param sw_if_index - index of the interface for DHCP client
3479 @param hostname - hostname
3480 @param is_add - add the config if non-zero, else delete
3481 @param want_dhcp_event - DHCP event sent to the sender
3482 via dhcp_compl_event API message if non-zero
3483 @param pid - sender's pid
3485 define dhcp_client_config
3496 /** \brief DHCP Client config response
3497 @param context - sender context, to match reply w/ request
3498 @param retval - return code for the request
3500 define dhcp_client_config_reply
3506 /** \brief Set/unset input ACL interface
3507 @param client_index - opaque cookie to identify the sender
3508 @param context - sender context, to match reply w/ request
3509 @param sw_if_index - interface to set/unset input ACL
3510 @param ip4_table_index - ip4 classify table index (~0 for skip)
3511 @param ip6_table_index - ip6 classify table index (~0 for skip)
3512 @param l2_table_index - l2 classify table index (~0 for skip)
3513 @param is_add - Set input ACL if non-zero, else unset
3514 Note: User is recommeneded to use just one valid table_index per call.
3515 (ip4_table_index, ip6_table_index, or l2_table_index)
3517 define input_acl_set_interface
3522 u32 ip4_table_index;
3523 u32 ip6_table_index;
3528 /** \brief Set/unset input ACL interface response
3529 @param context - sender context, to match reply w/ request
3530 @param retval - return code for the request
3532 define input_acl_set_interface_reply
3538 /** \brief IPsec: Add/delete Security Policy Database
3539 @param client_index - opaque cookie to identify the sender
3540 @param context - sender context, to match reply w/ request
3541 @param is_add - add SPD if non-zero, else delete
3542 @param spd_id - SPD instance id (control plane allocated)
3545 define ipsec_spd_add_del
3553 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3554 @param context - returned sender context, to match reply w/ request
3555 @param retval - return code
3558 define ipsec_spd_add_del_reply
3564 /** \brief IPsec: Add/delete SPD from interface
3566 @param client_index - opaque cookie to identify the sender
3567 @param context - sender context, to match reply w/ request
3568 @param is_add - add security mode if non-zero, else delete
3569 @param sw_if_index - index of the interface
3570 @param spd_id - SPD instance id to use for lookups
3574 define ipsec_interface_add_del_spd
3584 /** \brief Reply for IPsec: Add/delete SPD from interface
3585 @param context - returned sender context, to match reply w/ request
3586 @param retval - return code
3589 define ipsec_interface_add_del_spd_reply
3595 /** \brief IPsec: Add/delete Security Policy Database entry
3597 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3599 @param client_index - opaque cookie to identify the sender
3600 @param context - sender context, to match reply w/ request
3601 @param is_add - add SPD if non-zero, else delete
3602 @param spd_id - SPD instance id (control plane allocated)
3603 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3604 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3605 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3606 @param remote_address_start - start of remote address range to match
3607 @param remote_address_stop - end of remote address range to match
3608 @param local_address_start - start of local address range to match
3609 @param local_address_stop - end of local address range to match
3610 @param protocol - protocol type to match [0 means any]
3611 @param remote_port_start - start of remote port range to match ...
3612 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3613 @param local_port_start - start of local port range to match ...
3614 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3615 @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)
3616 @param sa_id - SAD instance id (control plane allocated)
3620 define ipsec_spd_add_del_entry
3633 u8 remote_address_start[16];
3634 u8 remote_address_stop[16];
3635 u8 local_address_start[16];
3636 u8 local_address_stop[16];
3640 u16 remote_port_start;
3641 u16 remote_port_stop;
3642 u16 local_port_start;
3643 u16 local_port_stop;
3650 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3651 @param context - returned sender context, to match reply w/ request
3652 @param retval - return code
3655 define ipsec_spd_add_del_entry_reply
3661 /** \brief IPsec: Add/delete Security Association Database entry
3662 @param client_index - opaque cookie to identify the sender
3663 @param context - sender context, to match reply w/ request
3664 @param is_add - add SAD entry if non-zero, else delete
3666 @param sad_id - sad id
3668 @param spi - security parameter index
3670 @param protocol - 0 = AH, 1 = ESP
3672 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3673 @param crypto_key_length - length of crypto_key in bytes
3674 @param crypto_key - crypto keying material
3676 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3677 @param integrity_key_length - length of integrity_key in bytes
3678 @param integrity_key - integrity keying material
3680 @param use_extended_sequence_number - use ESN when non-zero
3682 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3683 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3684 @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
3685 @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
3689 IPsec tunnel address copy mode (to support GDOI)
3692 define ipsec_sad_add_del_entry
3704 u8 crypto_algorithm;
3705 u8 crypto_key_length;
3708 u8 integrity_algorithm;
3709 u8 integrity_key_length;
3710 u8 integrity_key[128];
3712 u8 use_extended_sequence_number;
3716 u8 tunnel_src_address[16];
3717 u8 tunnel_dst_address[16];
3720 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3721 @param context - returned sender context, to match reply w/ request
3722 @param retval - return code
3725 define ipsec_sad_add_del_entry_reply
3731 /** \brief IPsec: Update Security Association keys
3732 @param client_index - opaque cookie to identify the sender
3733 @param context - sender context, to match reply w/ request
3735 @param sa_id - sa id
3737 @param crypto_key_length - length of crypto_key in bytes
3738 @param crypto_key - crypto keying material
3740 @param integrity_key_length - length of integrity_key in bytes
3741 @param integrity_key - integrity keying material
3744 define ipsec_sa_set_key
3751 u8 crypto_key_length;
3754 u8 integrity_key_length;
3755 u8 integrity_key[128];
3758 /** \brief Reply for IPsec: Update Security Association keys
3759 @param context - returned sender context, to match reply w/ request
3760 @param retval - return code
3763 define ipsec_sa_set_key_reply
3769 /** \brief IKEv2: Add/delete profile
3770 @param client_index - opaque cookie to identify the sender
3771 @param context - sender context, to match reply w/ request
3773 @param name - IKEv2 profile name
3774 @param is_add - Add IKEv2 profile if non-zero, else delete
3776 define ikev2_profile_add_del
3785 /** \brief Reply for IKEv2: Add/delete profile
3786 @param context - returned sender context, to match reply w/ request
3787 @param retval - return code
3789 define ikev2_profile_add_del_reply
3795 /** \brief IKEv2: Set IKEv2 profile authentication method
3796 @param client_index - opaque cookie to identify the sender
3797 @param context - sender context, to match reply w/ request
3799 @param name - IKEv2 profile name
3800 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3801 @param is_hex - Authentication data in hex format if non-zero, else string
3802 @param data_len - Authentication data length
3803 @param data - Authentication data (for rsa-sig cert file path)
3805 define ikev2_profile_set_auth
3817 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3818 @param context - returned sender context, to match reply w/ request
3819 @param retval - return code
3821 define ikev2_profile_set_auth_reply
3827 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3828 @param client_index - opaque cookie to identify the sender
3829 @param context - sender context, to match reply w/ request
3831 @param name - IKEv2 profile name
3832 @param is_local - Identification is local if non-zero, else remote
3833 @param id_type - Identification type
3834 @param data_len - Identification data length
3835 @param data - Identification data
3837 define ikev2_profile_set_id
3849 /** \brief Reply for IKEv2:
3850 @param context - returned sender context, to match reply w/ request
3851 @param retval - return code
3853 define ikev2_profile_set_id_reply
3859 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3860 @param client_index - opaque cookie to identify the sender
3861 @param context - sender context, to match reply w/ request
3863 @param name - IKEv2 profile name
3864 @param is_local - Traffic selector is local if non-zero, else remote
3865 @param proto - Traffic selector IP protocol (if zero not relevant)
3866 @param start_port - The smallest port number allowed by traffic selector
3867 @param end_port - The largest port number allowed by traffic selector
3868 @param start_addr - The smallest address included in traffic selector
3869 @param end_addr - The largest address included in traffic selector
3871 define ikev2_profile_set_ts
3885 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3886 @param context - returned sender context, to match reply w/ request
3887 @param retval - return code
3889 define ikev2_profile_set_ts_reply
3895 /** \brief IKEv2: Set IKEv2 local RSA private key
3896 @param client_index - opaque cookie to identify the sender
3897 @param context - sender context, to match reply w/ request
3899 @param key_file - Key file absolute path
3901 define ikev2_set_local_key
3909 /** \brief Reply for IKEv2: Set IKEv2 local key
3910 @param context - returned sender context, to match reply w/ request
3911 @param retval - return code
3913 define ikev2_set_local_key_reply
3919 /** \brief Tell client about a DHCP completion event
3920 @param client_index - opaque cookie to identify the sender
3921 @param pid - client pid registered to receive notification
3922 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3923 @param host_address - Host IP address
3924 @param router_address - Router IP address
3925 @param host_mac - Host MAC address
3927 define dhcp_compl_event
3933 u8 host_address[16];
3934 u8 router_address[16];
3938 /** \brief Add MAP domains
3939 @param client_index - opaque cookie to identify the sender
3940 @param context - sender context, to match reply w/ request
3941 @param ip6_prefix - Rule IPv6 prefix
3942 @param ip4_prefix - Rule IPv4 prefix
3943 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3944 @param ip6_prefix_len - Rule IPv6 prefix length
3945 @param ip4_prefix_len - Rule IPv4 prefix length
3946 @param ea_bits_len - Embedded Address bits length
3947 @param psid_offset - Port Set Identifider (PSID) offset
3948 @param psid_length - PSID length
3949 @param is_translation - MAP-E / MAP-T
3952 define map_add_domain
3961 u8 ip6_src_prefix_len;
3969 /** \brief Reply for MAP domain add
3970 @param context - returned sender context, to match reply w/ request
3971 @param index - MAP domain index
3972 @param retval - return code
3974 define map_add_domain_reply
3981 /** \brief Delete MAP domain
3982 @param client_index - opaque cookie to identify the sender
3983 @param context - sender context, to match reply w/ request
3984 @param index - MAP Domain index
3986 define map_del_domain
3993 /** \brief Reply for MAP domain del
3994 @param context - returned sender context, to match reply w/ request
3995 @param retval - return code
3997 define map_del_domain_reply
4003 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
4004 @param client_index - opaque cookie to identify the sender
4005 @param context - sender context, to match reply w/ request
4006 @param index - MAP Domain index
4007 @param is_add - If 1 add rule, if 0 delete rule
4008 @param ip6_dst - MAP CE IPv6 address
4009 @param psid - Rule PSID
4011 define map_add_del_rule
4021 /** \brief Reply for MAP rule add/del
4022 @param context - returned sender context, to match reply w/ request
4023 @param retval - return code
4025 define map_add_del_rule_reply
4031 /** \brief Get list of map domains
4032 @param client_index - opaque cookie to identify the sender
4034 define map_domain_dump
4040 define map_domain_details
4058 define map_rule_dump
4065 define map_rule_details
4072 /** \brief Request for a single block of summary stats
4073 @param client_index - opaque cookie to identify the sender
4074 @param context - sender context, to match reply w/ request
4076 define map_summary_stats
4082 /** \brief Reply for map_summary_stats request
4083 @param context - sender context, to match reply w/ request
4084 @param retval - return code for request
4085 @param total_bindings -
4087 @param total_ip4_fragments -
4088 @param total_security_check -
4090 define map_summary_stats_reply
4097 u64 total_ip4_fragments;
4098 u64 total_security_check[2];
4101 /** \brief cop: enable/disable junk filtration features on an interface
4102 @param client_index - opaque cookie to identify the sender
4103 @param context - sender context, to match reply w/ request
4104 @param sw_if_inded - desired interface
4105 @param enable_disable - 1 => enable, 0 => disable
4108 define cop_interface_enable_disable
4116 /** \brief cop: interface enable/disable junk filtration reply
4117 @param context - returned sender context, to match reply w/ request
4118 @param retval - return code
4121 define cop_interface_enable_disable_reply
4127 /** \brief cop: enable/disable whitelist filtration features on an interface
4128 Note: the supplied fib_id must match in order to remove the feature!
4130 @param client_index - opaque cookie to identify the sender
4131 @param context - sender context, to match reply w/ request
4132 @param sw_if_index - interface handle, physical interfaces only
4133 @param fib_id - fib identifier for the whitelist / blacklist fib
4134 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
4135 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
4136 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
4139 define cop_whitelist_enable_disable
4150 /** \brief cop: interface enable/disable junk filtration reply
4151 @param context - returned sender context, to match reply w/ request
4152 @param retval - return code
4155 define cop_whitelist_enable_disable_reply
4161 /** \brief get_node_graph - get a copy of the vpp node graph
4162 including the current set of graph arcs.
4164 @param client_index - opaque cookie to identify the sender
4165 @param context - sender context, to match reply w/ request
4168 define get_node_graph
4174 /** \brief get_node_graph_reply
4175 @param context - returned sender context, to match reply w/ request
4176 @param retval - return code
4177 @param reply_in_shmem - result from vlib_node_serialize, in shared
4178 memory. Process with vlib_node_unserialize, remember to switch
4179 heaps and free the result.
4182 define get_node_graph_reply
4189 /** \brief Clear interface statistics
4190 @param client_index - opaque cookie to identify the sender
4191 @param context - sender context, to match reply w/ request
4192 @param sw_if_index - index of the interface to clear statistics
4194 define sw_interface_clear_stats
4201 /** \brief Reply to sw_interface_clear_stats
4202 @param context - sender context which was passed in the request
4203 @param retval - return code of the set flags request
4205 define sw_interface_clear_stats_reply
4211 /** \brief IOAM enable : Enable in-band OAM
4212 @param id - profile id
4213 @param seqno - To enable Seqno Processing
4214 @param analyse - Enabling analysis of iOAM at decap node
4215 @param pow_enable - Proof of Work enabled or not flag
4216 @param trace_enable - iOAM Trace enabled or not flag
4230 /** \brief iOAM Trace profile add / del response
4231 @param context - sender context, to match reply w/ request
4232 @param retval - return value for request
4234 define ioam_enable_reply
4240 /** \brief iOAM disable
4241 @param client_index - opaque cookie to identify the sender
4242 @param context - sender context, to match reply w/ request
4243 @param index - MAP Domain index
4252 /** \brief iOAM disable response
4253 @param context - sender context, to match reply w/ request
4254 @param retval - return value for request
4256 define ioam_disable_reply
4262 /** \brief Create host-interface
4263 @param client_index - opaque cookie to identify the sender
4264 @param context - sender context, to match reply w/ request
4265 @param host_if_name - interface name
4266 @param hw_addr - interface MAC
4267 @param use_random_hw_addr - use random generated MAC
4269 define af_packet_create
4274 u8 host_if_name[64];
4276 u8 use_random_hw_addr;
4279 /** \brief Create host-interface response
4280 @param context - sender context, to match reply w/ request
4281 @param retval - return value for request
4283 define af_packet_create_reply
4290 /** \brief Delete host-interface
4291 @param client_index - opaque cookie to identify the sender
4292 @param context - sender context, to match reply w/ request
4293 @param host_if_name - interface name
4295 define af_packet_delete
4300 u8 host_if_name[64];
4303 /** \brief Delete host-interface response
4304 @param context - sender context, to match reply w/ request
4305 @param retval - return value for request
4307 define af_packet_delete_reply
4313 /** \brief Add/del policer
4314 @param client_index - opaque cookie to identify the sender
4315 @param context - sender context, to match reply w/ request
4316 @param is_add - add policer if non-zero, else delete
4317 @param name - policer name
4320 @param cb - Committed Burst
4321 @param eb - Excess or Peak Burst
4322 @param rate_type - rate type
4323 @param round_type - rounding type
4324 @param type - policer algorithm
4325 @param color_aware - 0=color-blind, 1=color-aware
4326 @param conform_action_type - conform action type
4327 @param conform_dscp - DSCP for conform mar-and-transmit action
4328 @param exceed_action_type - exceed action type
4329 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4330 @param violate_action_type - violate action type
4331 @param violate_dscp - DSCP for violate mar-and-transmit action
4333 define policer_add_del
4348 u8 conform_action_type;
4350 u8 exceed_action_type;
4352 u8 violate_action_type;
4356 /** \brief Add/del policer response
4357 @param context - sender context, to match reply w/ request
4358 @param retval - return value for request
4359 @param policer_index - for add, returned index of the new policer
4361 define policer_add_del_reply
4368 /** \brief Get list of policers
4369 @param client_index - opaque cookie to identify the sender
4370 @param context - sender context, to match reply w/ request
4371 @param match_name_valid - if 0 request all policers otherwise use match_name
4372 @param match_name - policer name
4379 u8 match_name_valid;
4383 /** \brief Policer operational state response.
4384 @param context - sender context, to match reply w/ request
4385 @param name - policer name
4388 @param cb - Committed Burst
4389 @param eb - Excess or Peak Burst
4390 @param rate_type - rate type
4391 @param round_type - rounding type
4392 @param type - policer algorithm
4393 @param conform_action_type - conform action type
4394 @param conform_dscp - DSCP for conform mar-and-transmit action
4395 @param exceed_action_type - exceed action type
4396 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4397 @param violate_action_type - violate action type
4398 @param violate_dscp - DSCP for violate mar-and-transmit action
4399 @param single_rate - 1 = single rate policer, 0 = two rate policer
4400 @param color_aware - for hierarchical policing
4401 @param scale - power-of-2 shift amount for lower rates
4402 @param cir_tokens_per_period - number of tokens for each period
4403 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
4404 @param current_limit - current limit
4405 @param current_bucket - current bucket
4406 @param extended_limit - extended limit
4407 @param extended_bucket - extended bucket
4408 @param last_update_time - last update time
4410 define policer_details
4422 u8 conform_action_type;
4424 u8 exceed_action_type;
4426 u8 violate_action_type;
4431 u32 cir_tokens_per_period;
4432 u32 pir_tokens_per_period;
4436 u32 extended_bucket;
4437 u64 last_update_time;
4440 /** \brief Set/unset policer classify interface
4441 @param client_index - opaque cookie to identify the sender
4442 @param context - sender context, to match reply w/ request
4443 @param sw_if_index - interface to set/unset policer classify
4444 @param ip4_table_index - ip4 classify table index (~0 for skip)
4445 @param ip6_table_index - ip6 classify table index (~0 for skip)
4446 @param l2_table_index - l2 classify table index (~0 for skip)
4447 @param is_add - Set if non-zero, else unset
4448 Note: User is recommeneded to use just one valid table_index per call.
4449 (ip4_table_index, ip6_table_index, or l2_table_index)
4451 define policer_classify_set_interface
4456 u32 ip4_table_index;
4457 u32 ip6_table_index;
4462 /** \brief Set/unset policer classify interface response
4463 @param context - sender context, to match reply w/ request
4464 @param retval - return value for request
4466 define policer_classify_set_interface_reply
4472 /** \brief Get list of policer classify interfaces and tables
4473 @param client_index - opaque cookie to identify the sender
4474 @param context - sender context, to match reply w/ request
4475 @param type - classify table type
4477 define policer_classify_dump
4484 /** \brief Policer iclassify operational state response.
4485 @param context - sender context, to match reply w/ request
4486 @param sw_if_index - software interface index
4487 @param table_index - classify table index
4489 define policer_classify_details
4496 /** \brief Create netmap
4497 @param client_index - opaque cookie to identify the sender
4498 @param context - sender context, to match reply w/ request
4499 @param netmap_if_name - interface name
4500 @param hw_addr - interface MAC
4501 @param use_random_hw_addr - use random generated MAC
4502 @param is_pipe - is pipe
4503 @param is_master - 0=slave, 1=master
4505 define netmap_create
4510 u8 netmap_if_name[64];
4512 u8 use_random_hw_addr;
4517 /** \brief Create netmap response
4518 @param context - sender context, to match reply w/ request
4519 @param retval - return value for request
4521 define netmap_create_reply
4527 /** \brief Delete netmap
4528 @param client_index - opaque cookie to identify the sender
4529 @param context - sender context, to match reply w/ request
4530 @param netmap_if_name - interface name
4532 define netmap_delete
4537 u8 netmap_if_name[64];
4540 /** \brief Delete netmap response
4541 @param context - sender context, to match reply w/ request
4542 @param retval - return value for request
4544 define netmap_delete_reply
4550 /** \brief Classify get table IDs request
4551 @param client_index - opaque cookie to identify the sender
4552 @param context - sender context, to match reply w/ request
4554 define classify_table_ids
4560 /** \brief Reply for classify get table IDs request
4561 @param context - sender context which was passed in the request
4562 @param count - number of ids returned in response
4563 @param ids - array of classify table ids
4565 define classify_table_ids_reply
4573 /** \brief Classify table ids by interface index request
4574 @param client_index - opaque cookie to identify the sender
4575 @param context - sender context, to match reply w/ request
4576 @param sw_if_index - index of the interface
4578 define classify_table_by_interface
4585 /** \brief Reply for classify table id by interface index request
4586 @param context - sender context which was passed in the request
4587 @param count - number of ids returned in response
4588 @param sw_if_index - index of the interface
4589 @param l2_table_id - l2 classify table index
4590 @param ip4_table_id - ip4 classify table index
4591 @param ip6_table_id - ip6 classify table index
4593 define classify_table_by_interface_reply
4603 /** \brief Classify table info
4604 @param client_index - opaque cookie to identify the sender
4605 @param context - sender context, to match reply w/ request
4606 @param table_id - classify table index
4608 define classify_table_info
4615 /** \brief Reply for classify table info request
4616 @param context - sender context which was passed in the request
4617 @param count - number of ids returned in response
4618 @param table_id - classify table index
4619 @param nbuckets - number of buckets when adding a table
4620 @param match_n_vectors - number of match vectors
4621 @param skip_n_vectors - number of skip_n_vectors
4622 @param active_sessions - number of sessions (active entries)
4623 @param next_table_index - index of next table
4624 @param miss_next_index - index of miss table
4625 @param mask[] - match mask
4627 define classify_table_info_reply
4633 u32 match_n_vectors;
4635 u32 active_sessions;
4636 u32 next_table_index;
4637 u32 miss_next_index;
4639 u8 mask[mask_length];
4642 /** \brief Classify sessions dump request
4643 @param client_index - opaque cookie to identify the sender
4644 @param context - sender context, to match reply w/ request
4645 @param table_id - classify table index
4647 define classify_session_dump
4654 /** \brief Reply for classify table session dump request
4655 @param context - sender context which was passed in the request
4656 @param count - number of ids returned in response
4657 @param table_id - classify table index
4658 @param hit_next_index - hit_next_index of session
4659 @param opaque_index - for add, opaque_index of session
4660 @param advance - advance value of session
4661 @param match[] - match value for session
4663 define classify_session_details
4672 u8 match[match_length];
4675 /** \brief Configure IPFIX exporter process request
4676 @param client_index - opaque cookie to identify the sender
4677 @param context - sender context, to match reply w/ request
4678 @param collector_address - address of IPFIX collector
4679 @param collector_port - port of IPFIX collector
4680 @param src_address - address of IPFIX exporter
4681 @param vrf_id - VRF / fib table ID
4682 @param path_mtu - Path MTU between exporter and collector
4683 @param template_interval - number of seconds after which to resend template
4684 @param udp_checksum - UDP checksum calculation enable flag
4686 define set_ipfix_exporter
4690 u8 collector_address[16];
4695 u32 template_interval;
4699 /** \brief Reply to IPFIX exporter configure request
4700 @param context - sender context which was passed in the request
4702 define set_ipfix_exporter_reply
4708 /** \brief IPFIX exporter dump request
4709 @param client_index - opaque cookie to identify the sender
4710 @param context - sender context, to match reply w/ request
4712 define ipfix_exporter_dump
4718 /** \brief Reply to IPFIX exporter dump request
4719 @param context - sender context which was passed in the request
4720 @param collector_address - address of IPFIX collector
4721 @param collector_port - port of IPFIX collector
4722 @param src_address - address of IPFIX exporter
4723 @param fib_index - fib table index
4724 @param path_mtu - Path MTU between exporter and collector
4725 @param template_interval - number of seconds after which to resend template
4726 @param udp_checksum - UDP checksum calculation enable flag
4728 define ipfix_exporter_details
4731 u8 collector_address[16];
4736 u32 template_interval;
4740 /** \brief IPFIX classify stream configure request
4741 @param client_index - opaque cookie to identify the sender
4742 @param context - sender context, to match reply w/ request
4743 @param domain_id - domain ID reported in IPFIX messages for classify stream
4744 @param src_port - source port of UDP session for classify stream
4746 define set_ipfix_classify_stream {
4753 /** \brief IPFIX classify stream configure response
4754 @param context - sender context, to match reply w/ request
4755 @param retval - return value for request
4757 define set_ipfix_classify_stream_reply {
4762 /** \brief IPFIX classify stream dump request
4763 @param client_index - opaque cookie to identify the sender
4764 @param context - sender context, to match reply w/ request
4766 define ipfix_classify_stream_dump {
4771 /** \brief Reply to IPFIX classify stream dump request
4772 @param context - sender context, to match reply w/ request
4773 @param domain_id - domain ID reported in IPFIX messages for classify stream
4774 @param src_port - source port of UDP session for classify stream
4776 define ipfix_classify_stream_details {
4782 /** \brief IPFIX add or delete classifier table request
4783 @param client_index - opaque cookie to identify the sender
4784 @param context - sender context, to match reply w/ request
4785 @param table_id - classifier table ID
4786 @param ip_version - version of IP used in the classifier table
4787 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4789 define ipfix_classify_table_add_del {
4794 u8 transport_protocol;
4798 /** \brief IPFIX add classifier table response
4799 @param context - sender context which was passed in the request
4801 define ipfix_classify_table_add_del_reply {
4806 /** \brief IPFIX classify tables dump request
4807 @param client_index - opaque cookie to identify the sender
4808 @param context - sender context, to match reply w/ request
4810 define ipfix_classify_table_dump {
4815 /** \brief Reply to IPFIX classify tables dump request
4816 @param context - sender context, to match reply w/ request
4817 @param table_id - classifier table ID
4818 @param ip_version - version of IP used in the classifier table
4819 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4821 define ipfix_classify_table_details {
4825 u8 transport_protocol;
4828 /** \brief Set/unset flow classify interface
4829 @param client_index - opaque cookie to identify the sender
4830 @param context - sender context, to match reply w/ request
4831 @param sw_if_index - interface to set/unset flow classify
4832 @param ip4_table_index - ip4 classify table index (~0 for skip)
4833 @param ip6_table_index - ip6 classify table index (~0 for skip)
4834 @param l2_table_index - l2 classify table index (~0 for skip)
4835 @param is_add - Set if non-zero, else unset
4836 Note: User is recommeneded to use just one valid table_index per call.
4837 (ip4_table_index, ip6_table_index, or l2_table_index)
4839 define flow_classify_set_interface {
4843 u32 ip4_table_index;
4844 u32 ip6_table_index;
4848 /** \brief Set/unset flow classify interface response
4849 @param context - sender context, to match reply w/ request
4850 @param retval - return value for request
4852 define flow_classify_set_interface_reply {
4857 /** \brief Get list of flow classify interfaces and tables
4858 @param client_index - opaque cookie to identify the sender
4859 @param context - sender context, to match reply w/ request
4860 @param type - classify table type
4862 define flow_classify_dump {
4868 /** \brief Flow classify operational state response.
4869 @param context - sender context, to match reply w/ request
4870 @param sw_if_index - software interface index
4871 @param table_index - classify table index
4873 define flow_classify_details {
4879 /** \brief Enable/Disable span to mirror traffic from one interface to another
4880 @param client_index - opaque cookie to identify the sender
4881 @param context - sender context which was passed in the request
4882 @param sw_if_index_from - interface to be mirorred
4883 @param sw_if_index_to - interface where the traffic is mirrored
4884 @param enable - 1 enable SPAN, 0 SPAN on given interface
4886 define sw_interface_span_enable_disable{
4889 u32 sw_if_index_from;
4894 /** \brief Reply to SPAN enable/disable request
4895 @param context - sender context which was passed in the request
4897 define sw_interface_span_enable_disable_reply {
4902 /** \brief SPAN dump request
4903 @param client_index - opaque cookie to identify the sender
4904 @param context - sender context, to match reply w/ request
4906 define sw_interface_span_dump {
4911 /** \brief Reply to SPAN dump request
4912 @param context - sender context which was passed in the request
4913 @param sw_if_index_from - mirorred interface
4914 @param sw_if_index_to - interface where the traffic is mirrored
4916 define sw_interface_span_details {
4918 u32 sw_if_index_from;
4922 /** \brief Query relative index via node names
4923 @param client_index - opaque cookie to identify the sender
4924 @param context - sender context, to match reply w/ request
4925 @param node_name - name of node to find relative index from
4926 @param next_name - next node from node_name to find relative index of
4928 define get_next_index
4936 /** \brief Reply for get next node index
4937 @param context - sender context which was passed in the request
4938 @param retval - return value
4939 @param next_index - index of the next_node
4941 define get_next_index_reply
4948 /** \brief PacketGenerator create interface request
4949 @param client_index - opaque cookie to identify the sender
4950 @param context - sender context, to match reply w/ request
4951 @param interface_id - interface index
4953 define pg_create_interface
4960 /** \brief PacketGenerator create interface response
4961 @param context - sender context, to match reply w/ request
4962 @param retval - return value for request
4964 define pg_create_interface_reply
4971 /** \brief PacketGenerator capture packets on given interface request
4972 @param client_index - opaque cookie to identify the sender
4973 @param context - sender context, to match reply w/ request
4974 @param interface_id - pg interface index
4975 @param is_enabled - 1 if enabling streams, 0 if disabling
4976 @param count - number of packets to be captured
4977 @param pcap_file - pacp file name to store captured packets
4986 u32 pcap_name_length;
4987 u8 pcap_file_name[pcap_name_length];
4990 /** \brief PacketGenerator capture packets response
4991 @param context - sender context, to match reply w/ request
4992 @param retval - return value for request
4994 define pg_capture_reply
5000 /** \brief Enable / disable packet generator request
5001 @param client_index - opaque cookie to identify the sender
5002 @param context - sender context, to match reply w/ request
5003 @param is_enabled - 1 if enabling streams, 0 if disabling
5004 @param stream - stream name to be enable/disabled, if not specified handle all streams
5006 define pg_enable_disable
5011 u32 stream_name_length;
5012 u8 stream_name[stream_name_length];
5015 /** \brief Reply for enable / disable packet generator
5016 @param context - returned sender context, to match reply w/ request
5017 @param retval - return code
5019 define pg_enable_disable_reply
5025 /** \brief Configure IP source and L4 port-range check
5026 @param client_index - opaque cookie to identify the sender
5027 @param context - sender context, to match reply w/ request
5028 @param is_ip6 - 1 if source address type is IPv6
5029 @param is_add - 1 if add, 0 if delete
5030 @param mask_length - mask length for address entry
5031 @param address - array of address bytes
5032 @param number_of_ranges - length of low_port and high_port arrays (must match)
5033 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
5034 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
5035 @param vrf_id - fib table/vrf id to associate the source and port-range check with
5036 @note To specify a single port set low_port and high_port entry the same
5038 define ip_source_and_port_range_check_add_del
5046 u8 number_of_ranges;
5052 /** \brief Configure IP source and L4 port-range check reply
5053 @param context - returned sender context, to match reply w/ request
5054 @param retval - return code
5056 define ip_source_and_port_range_check_add_del_reply
5062 /** \brief Set interface source and L4 port-range request
5063 @param client_index - opaque cookie to identify the sender
5064 @param context - sender context, to match reply w/ request
5065 @param interface_id - interface index
5066 @param tcp_vrf_id - VRF associated with source and TCP port-range check
5067 @param udp_vrf_id - VRF associated with source and TCP port-range check
5069 define ip_source_and_port_range_check_interface_add_del
5081 /** \brief Set interface source and L4 port-range response
5082 @param context - sender context, to match reply w/ request
5083 @param retval - return value for request
5085 define ip_source_and_port_range_check_interface_add_del_reply
5091 /** \brief Add / del ipsec gre tunnel request
5092 @param client_index - opaque cookie to identify the sender
5093 @param context - sender context, to match reply w/ request
5094 @param local_sa_id - local SA id
5095 @param remote_sa_id - remote SA id
5096 @param is_add - 1 if adding the tunnel, 0 if deleting
5097 @param src_address - tunnel source address
5098 @param dst_address - tunnel destination address
5100 define ipsec_gre_add_del_tunnel {
5110 /** \brief Reply for add / del ipsec gre tunnel request
5111 @param context - returned sender context, to match reply w/ request
5112 @param retval - return code
5113 @param sw_if_index - software index of the new ipsec gre tunnel
5115 define ipsec_gre_add_del_tunnel_reply {
5121 /** \brief Dump ipsec gre tunnel table
5122 @param client_index - opaque cookie to identify the sender
5123 @param context - sender context, to match reply w/ request
5124 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
5126 define ipsec_gre_tunnel_dump {
5132 /** \brief mpls gre tunnel operational state response
5133 @param context - returned sender context, to match reply w/ request
5134 @param sw_if_index - software index of the ipsec gre tunnel
5135 @param local_sa_id - local SA id
5136 @param remote_sa_id - remote SA id
5137 @param src_address - tunnel source address
5138 @param dst_address - tunnel destination address
5140 define ipsec_gre_tunnel_details {
5149 /** \brief Delete sub interface request
5150 @param client_index - opaque cookie to identify the sender
5151 @param context - sender context, to match reply w/ request
5152 @param sw_if_index - sw index of the interface that was created by create_subif
5154 define delete_subif {
5160 /** \brief Delete sub interface response
5161 @param context - sender context, to match reply w/ request
5162 @param retval - return code for the request
5164 define delete_subif_reply {
5169 /** \brief DPDK interface HQoS pipe profile set request
5170 @param client_index - opaque cookie to identify the sender
5171 @param context - sender context, to match reply w/ request
5172 @param sw_if_index - the interface
5173 @param subport - subport ID
5174 @param pipe - pipe ID within its subport
5175 @param profile - pipe profile ID
5177 define sw_interface_set_dpdk_hqos_pipe {
5186 /** \brief DPDK interface HQoS pipe profile set reply
5187 @param context - sender context, to match reply w/ request
5188 @param retval - request return code
5190 define sw_interface_set_dpdk_hqos_pipe_reply {
5195 /** \brief DPDK interface HQoS subport parameters set request
5196 @param client_index - opaque cookie to identify the sender
5197 @param context - sender context, to match reply w/ request
5198 @param sw_if_index - the interface
5199 @param subport - subport ID
5200 @param tb_rate - subport token bucket rate (measured in bytes/second)
5201 @param tb_size - subport token bucket size (measured in credits)
5202 @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
5203 @param tc_period - enforcement period for rates (measured in milliseconds)
5205 define sw_interface_set_dpdk_hqos_subport {
5216 /** \brief DPDK interface HQoS subport parameters set reply
5217 @param context - sender context, to match reply w/ request
5218 @param retval - request return code
5220 define sw_interface_set_dpdk_hqos_subport_reply {
5225 /** \brief DPDK interface HQoS tctbl entry set request
5226 @param client_index - opaque cookie to identify the sender
5227 @param context - sender context, to match reply w/ request
5228 @param sw_if_index - the interface
5229 @param entry - entry index ID
5230 @param tc - traffic class (0 .. 3)
5231 @param queue - traffic class queue (0 .. 3)
5233 define sw_interface_set_dpdk_hqos_tctbl {
5242 /** \brief DPDK interface HQoS tctbl entry set reply
5243 @param context - sender context, to match reply w/ request
5244 @param retval - request return code
5246 define sw_interface_set_dpdk_hqos_tctbl_reply {
5251 /** \brief L2 interface pbb tag rewrite configure request
5252 @param client_index - opaque cookie to identify the sender
5253 @param context - sender context, to match reply w/ request
5254 @param sw_if_index - interface the operation is applied to
5255 @param vtr_op - Choose from l2_vtr_op_t enum values
5256 @param inner_tag - needed for translate_qinq vtr op only
5257 @param outer_tag - needed for translate_qinq vtr op only
5258 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
5259 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
5260 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
5261 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
5263 define l2_interface_pbb_tag_rewrite
5276 /** \brief L2 interface pbb tag rewrite response
5277 @param context - sender context, to match reply w/ request
5278 @param retval - return code for the request
5280 define l2_interface_pbb_tag_rewrite_reply
5286 /** \brief Punt traffic to the host
5287 @param client_index - opaque cookie to identify the sender
5288 @param context - sender context, to match reply w/ request
5289 @param is_add - add punt if non-zero, else delete
5290 @param ipv - L3 protocol 4 - IPv4, 6 - IPv6, ~0 - All
5291 @param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
5292 @param l4_port - TCP/UDP port to be punted
5303 /** \brief Reply to the punt request
5304 @param context - sender context which was passed in the request
5305 @param retval - return code of punt request
5313 /** \brief Dump ipsec policy database data
5314 @param client_index - opaque cookie to identify the sender
5315 @param context - sender context, to match reply w/ request
5316 @param spd_id - SPD instance id
5317 @param sa_id - SA id, optional, set to ~0 to see all policies in SPD
5319 define ipsec_spd_dump {
5326 /** \brief IPsec policy database response
5327 @param context - sender context which was passed in the request
5328 @param spd_id - SPD instance id
5329 @param priority - numeric value to control policy evaluation order
5330 @param is_outbound - [1|0] to indicate if direction is [out|in]bound
5331 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
5332 @param local_start_addr - first address in local traffic selector range
5333 @param local_stop_addr - last address in local traffic selector range
5334 @param local_start_port - first port in local traffic selector range
5335 @param local_stop_port - last port in local traffic selector range
5336 @param remote_start_addr - first address in remote traffic selector range
5337 @param remote_stop_addr - last address in remote traffic selector range
5338 @param remote_start_port - first port in remote traffic selector range
5339 @param remote_stop_port - last port in remote traffic selector range
5340 @param protocol - traffic selector protocol
5341 @param policy - policy action
5342 @param sa_id - SA id
5343 @param bytes - byte count of packets matching this policy
5344 @param packets - count of packets matching this policy
5347 define ipsec_spd_details {
5353 u8 local_start_addr[16];
5354 u8 local_stop_addr[16];
5355 u16 local_start_port;
5356 u16 local_stop_port;
5357 u8 remote_start_addr[16];
5358 u8 remote_stop_addr[16];
5359 u16 remote_start_port;
5360 u16 remote_stop_port;
5368 /** \brief Feature path enable/disable request
5369 @param client_index - opaque cookie to identify the sender
5370 @param context - sender context, to match reply w/ request
5371 @param sw_if_index - the interface
5372 @param enable - 1 = on, 0 = off
5374 define feature_enable_disable {
5380 u8 feature_name[64];
5383 /** \brief Reply to the eature path enable/disable request
5384 @param context - sender context which was passed in the request
5385 @param retval - return code for the request
5387 define feature_enable_disable_reply
5393 /** \brief Set / clear software interface tag
5394 @param client_index - opaque cookie to identify the sender
5395 @param context - sender context, to match reply w/ request
5396 @param sw_if_index - the interface
5397 @param add_del - 1 = add, 0 = delete
5398 @param tag - an ascii tag
5400 define sw_interface_tag_add_del {
5408 /** \brief Reply to set / clear software interface tag
5409 @param context - sender context which was passed in the request
5410 @param retval - return code for the request
5412 define sw_interface_tag_add_del_reply