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
122 /** \brief Set flags on the interface
123 @param client_index - opaque cookie to identify the sender
124 @param context - sender context, to match reply w/ request
125 @param sw_if_index - index of the interface to set flags on
126 @param admin_up_down - set the admin state, 1 = up, 0 = down
127 @param link_up_down - Oper state sent on change event, not used in config.
128 @param deleted - interface was deleted
130 define sw_interface_set_flags
135 /* 1 = up, 0 = down */
141 /** \brief Reply to sw_interface_set_flags
142 @param context - sender context which was passed in the request
143 @param retval - return code of the set flags request
145 define sw_interface_set_flags_reply
152 define sw_interface_dump
156 u8 name_filter_valid;
160 /** \brief Set or delete one or all ip addresses on a specified interface
161 @param client_index - opaque cookie to identify the sender
162 @param context - sender context, to match reply w/ request
163 @param sw_if_index - index of the interface to add/del addresses
164 @param is_add - add address if non-zero, else delete
165 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
166 @param del_all - if non-zero delete all addresses on the interface
167 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
168 @param address - array of address bytes
170 define sw_interface_add_del_address
182 /** \brief Reply for interface events registration
183 @param context - returned sender context, to match reply w/ request
184 @param retval - return code
186 define sw_interface_add_del_address_reply
192 /** \brief Associate the specified interface with a fib table
193 @param client_index - opaque cookie to identify the sender
194 @param context - sender context, to match reply w/ request
195 @param sw_if_index - index of the interface
196 @param is_ipv6 - if non-zero ipv6, else ipv4
197 @param vrf_id - fib table/vrd id to associate the interface with
199 define sw_interface_set_table
208 /** \brief Reply for interface events registration
209 @param context - returned sender context, to match reply w/ request
210 @param retval - return code
212 define sw_interface_set_table_reply
218 /** \brief Enable or Disable MPLS on and interface
219 @param client_index - opaque cookie to identify the sender
220 @param context - sender context, to match reply w/ request
221 @param sw_if_index - index of the interface
222 @param enable - if non-zero enable, else disable
224 define sw_interface_set_mpls_enable
232 /** \brief Reply for MPLS state on an interface
233 @param context - returned sender context, to match reply w/ request
234 @param retval - return code
236 define sw_interface_set_mpls_enable_reply
242 /** \brief Initialize a new tap interface with the given paramters
243 @param client_index - opaque cookie to identify the sender
244 @param context - sender context, to match reply w/ request
245 @param use_random_mac - let the system generate a unique mac address
246 @param tap_name - name to associate with the new interface
247 @param mac_address - mac addr to assign to the interface if use_radom not set
257 u32 custom_dev_instance;
260 /** \brief Reply for tap connect request
261 @param context - returned sender context, to match reply w/ request
262 @param retval - return code
263 @param sw_if_index - software index allocated for the new tap interface
265 define tap_connect_reply
272 /** \brief Modify a tap interface with the given paramters
273 @param client_index - opaque cookie to identify the sender
274 @param context - sender context, to match reply w/ request
275 @param sw_if_index - interface index of existing tap interface
276 @param use_random_mac - let the system generate a unique mac address
277 @param tap_name - name to associate with the new interface
278 @param mac_address - mac addr to assign to the interface if use_radom not set
289 u32 custom_dev_instance;
292 /** \brief Reply for tap modify request
293 @param context - returned sender context, to match reply w/ request
294 @param retval - return code
295 @param sw_if_index - software index if the modified tap interface
297 define tap_modify_reply
304 /** \brief Delete tap interface
305 @param client_index - opaque cookie to identify the sender
306 @param context - sender context, to match reply w/ request
307 @param sw_if_index - interface index of existing tap interface
316 /** \brief Reply for tap delete request
317 @param context - returned sender context, to match reply w/ request
318 @param retval - return code
320 define tap_delete_reply
326 /** \brief Dump tap interfaces request */
327 define sw_interface_tap_dump
333 /** \brief Reply for tap dump request
334 @param sw_if_index - software index of tap interface
335 @param dev_name - Linux tap device name
337 define sw_interface_tap_details
344 /** \brief Create a new subinterface with the given vlan id
345 @param client_index - opaque cookie to identify the sender
346 @param context - sender context, to match reply w/ request
347 @param sw_if_index - software index of the new vlan's parent interface
348 @param vlan_id - vlan tag of the new interface
350 define create_vlan_subif
358 /** \brief Reply for the vlan subinterface create request
359 @param context - returned sender context, to match reply w/ request
360 @param retval - return code
361 @param sw_if_index - software index allocated for the new subinterface
363 define create_vlan_subif_reply
370 /** \brief MPLS Route Add / del route
371 @param client_index - opaque cookie to identify the sender
372 @param context - sender context, to match reply w/ request
373 @param mr_label - The MPLS label value
374 @param mr_eos - The End of stack bit
375 @param mr_table_id - The MPLS table-id the route is added in
376 @param mr_classify_table_index - If this is a classify route,
377 this is the classify table index
378 @param mr_create_table_if_needed - If the MPLS or IP tables do not exist,
380 @param mr_is_add - Is this a route add or delete
381 @param mr_is_classify - Is this route result a classify
382 @param mr_is_multipath - Is this route update a multipath - i.e. is this
383 a path addition to an existing route
384 @param mr_is_resolve_host - Recurse resolution constraint via a host prefix
385 @param mr_is_resolve_attached - Recurse resolution constraint via attached prefix
386 @param mr_next_hop_proto_is_ip4 - The next-hop is IPV4
387 @param mr_next_hop_weight - The weight, for UCMP
388 @param mr_next_hop[16] - the nextop address
389 @param mr_next_hop_sw_if_index - the next-hop SW interface
390 @param mr_next_hop_table_id - the next-hop table-id (if appropriate)
391 @param mr_next_hop_out_label - the next-hop output label
393 define mpls_route_add_del
400 u32 mr_classify_table_index;
401 u8 mr_create_table_if_needed;
405 u8 mr_is_resolve_host;
406 u8 mr_is_resolve_attached;
407 u8 mr_next_hop_proto_is_ip4;
408 u8 mr_next_hop_weight;
410 u32 mr_next_hop_sw_if_index;
411 u32 mr_next_hop_table_id;
412 u32 mr_next_hop_out_label;
415 /** \brief Reply for MPLS route add / del request
416 @param context - returned sender context, to match reply w/ request
417 @param retval - return code
419 define mpls_route_add_del_reply
425 /** \brief Dump MPLS fib table
426 @param client_index - opaque cookie to identify the sender
435 @param sw_if_index - index of the interface
436 @param weight - The weight, for UCMP
437 @param is_local - local if non-zero, else remote
438 @param is_drop - Drop the packet
439 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
440 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
441 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
442 @param next_hop[16] - the next hop address
444 typeonly manual_print manual_endian define fib_path
456 /** \brief mpls FIB table response
457 @param table_id - MPLS fib table id
458 @param s_bit - End-of-stack bit
459 @param label - MPLS label value
460 @param count - the number of fib_path in path
461 @param path - array of of fib_path structures
463 manual_endian manual_print define mpls_fib_details
470 vl_api_fib_path_t path[count];
473 /** \brief Dump IP6 fib table
474 @param client_index - opaque cookie to identify the sender
482 /** \brief IP6 FIB table response
483 @param table_id - IP6 fib table id
484 @address_length - mask length
485 @address - ip6 prefix
486 @param count - the number of fib_path in path
487 @param path - array of of fib_path structures
489 manual_endian manual_print define ip6_fib_details
496 vl_api_fib_path_t path[count];
499 /** \brief Dump IP fib table
500 @param client_index - opaque cookie to identify the sender
508 /** \brief IP FIB table response
509 @param table_id - IP fib table id
510 @address_length - mask length
511 @address - ip4 prefix
512 @param count - the number of fib_path in path
513 @param path - array of of fib_path structures
515 manual_endian manual_print define ip_fib_details
522 vl_api_fib_path_t path[count];
525 /** \brief Bind/Unbind an MPLS local label to an IP prefix. i.e. create
526 a per-prefix label entry.
527 @param client_index - opaque cookie to identify the sender
528 @param context - sender context, to match reply w/ request
529 @param mb_mpls_table_id - The MPLS table-id the MPLS entry will be added in
530 @param mb_label - The MPLS label value to bind
531 @param mb_ip_table_id - The IP table-id of the IP prefix to bind to.
532 @param mb_create_table_if_needed - Create either/both tables if required.
533 @param mb_is_bind - Bind or unbind
534 @param mb_is_ip4 - The prefix to bind to is IPv4
535 @param mb_address_length - Length of IP prefix
536 @param mb_address[16] - IP prefix/
538 define mpls_ip_bind_unbind
542 u32 mb_mpls_table_id;
545 u8 mb_create_table_if_needed;
548 u8 mb_address_length;
552 /** \brief Reply for MPLS IP bind/unbind request
553 @param context - returned sender context, to match reply w/ request
554 @param retval - return code
556 define mpls_ip_bind_unbind_reply
562 /** \brief Add / del route request
563 @param client_index - opaque cookie to identify the sender
564 @param context - sender context, to match reply w/ request
565 @param sw_if_index - software index of the new vlan's parent interface
566 @param vrf_id - fib table /vrf associated with the route
567 @param lookup_in_vrf -
568 @param resolve_attempts -
569 @param classify_table_index -
570 @param create_vrf_if_needed -
571 @param resolve_if_needed -
572 @param is_add - 1 if adding the route, 0 if deleting
573 @param is_drop - Drop the packet
574 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
575 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
576 @param is_ipv6 - 0 if an ip4 route, else ip6
579 @param is_multipath - Set to 1 if this is a multipath route, else 0
580 @param not_last - Is last or not last msg in group of multiple add/del msgs
581 @param next_hop_weight -
582 @param dst_address_length -
583 @param dst_address[16] -
584 @param next_hop_address[16] -
586 define ip_add_del_route
590 u32 next_hop_sw_if_index;
592 u32 resolve_attempts;
593 u32 classify_table_index;
594 u32 next_hop_out_label;
595 u32 next_hop_table_id;
596 u8 create_vrf_if_needed;
597 u8 resolve_if_needed;
607 u8 is_resolve_attached;
608 /* Is last/not-last message in group of multiple add/del messages. */
611 u8 dst_address_length;
613 u8 next_hop_address[16];
616 /** \brief Reply for add / del route request
617 @param context - returned sender context, to match reply w/ request
618 @param retval - return code
620 define ip_add_del_route_reply
626 /** \brief Add / del MPLS encapsulation request
627 @param client_index - opaque cookie to identify the sender
628 @param context - sender context, to match reply w/ request
629 @param vrf_id - vrf id
630 @param dst_address[4] -
631 @param is_add - 1 if adding the encap, 0 if deleting
632 @param nlabels - number of labels
633 @param labels - array of labels
635 define mpls_add_del_encap
641 /* 1 = add, 0 = delete */
647 /** \brief Reply for add / del encapsulation request
648 @param context - returned sender context, to match reply w/ request
649 @param retval - return code
651 define mpls_add_del_encap_reply
657 /** \brief Proxy ARP add / del request
658 @param client_index - opaque cookie to identify the sender
659 @param context - sender context, to match reply w/ request
660 @param vrf_id - VRF / Fib table ID
661 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
662 @param low_address[4] - Low address of the Proxy ARP range
663 @param hi_address[4] - High address of the Proxy ARP range
665 define proxy_arp_add_del
675 /** \brief Reply for proxy arp add / del request
676 @param context - returned sender context, to match reply w/ request
677 @param retval - return code
679 define proxy_arp_add_del_reply
685 /** \brief Proxy ARP add / del request
686 @param client_index - opaque cookie to identify the sender
687 @param context - sender context, to match reply w/ request
688 @param sw_if_index - Which interface to enable / disable Proxy Arp on
689 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
691 define proxy_arp_intfc_enable_disable
696 /* 1 = on, 0 = off */
700 /** \brief Reply for Proxy ARP interface enable / disable request
701 @param context - returned sender context, to match reply w/ request
702 @param retval - return code
704 define proxy_arp_intfc_enable_disable_reply
710 /** \brief IP neighbor 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 vrf_id - vrf_id, only for IP4
714 @param sw_if_index - interface used to reach neighbor
715 @param is_add - 1 to add neighbor, 0 to delete
716 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
718 @param mac_address - l2 address of the neighbor
719 @param dst_address - ip4 or ip6 address of the neighbor
721 define ip_neighbor_add_del
725 u32 vrf_id; /* only makes sense for ip4 */
727 /* 1 = add, 0 = delete */
735 /** \brief Reply for IP Neighbor add / delete request
736 @param context - returned sender context, to match reply w/ request
737 @param retval - return code
739 define ip_neighbor_add_del_reply
745 /** \brief Reset VRF (remove all routes etc) request
746 @param client_index - opaque cookie to identify the sender
747 @param context - sender context, to match reply w/ request
748 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
749 @param vrf_id - ID of th FIB table / VRF to reset
759 /** \brief Reply for Reset VRF request
760 @param context - returned sender context, to match reply w/ request
761 @param retval - return code
763 define reset_vrf_reply
769 /** \brief Is Address Reachable request - DISABLED
770 @param client_index - opaque cookie to identify the sender
771 @param context - sender context, to match reply w/ request
772 @param next_hop_sw_if_index - index of interface used to get to next hop
773 @param is_ipv6 - 1 for IPv6, 0 for IPv4
774 @param is_error - address not found or does not match intf
775 @param address[] - Address in question
777 define is_address_reachable
779 u32 client_index; /* (api_main_t *) am->my_client_index */
781 u32 next_hop_sw_if_index;
782 u8 is_known; /* on reply, this is the answer */
784 u8 is_error; /* address not found or does not match intf */
788 /** \brief Want Stats, register for stats updates
789 @param client_index - opaque cookie to identify the sender
790 @param context - sender context, to match reply w/ request
791 @param enable_disable - 1 = enable stats, 0 = disable
792 @param pid - pid of process requesting stats updates
802 /** \brief Reply for Want Stats request
803 @param context - returned sender context, to match reply w/ request
804 @param retval - return code
806 define want_stats_reply
812 /** \brief Want stats counters structure
813 @param vnet_counter_type- such as ip4, ip6, punts, etc
814 @param is_combined - rx & tx total (all types) counts
815 @param first_sw_if_index - first sw index in block of index, counts
816 @param count - number of interfaces this stats block includes counters for
817 @param data - contiguous block of vlib_counter_t structures
819 define vnet_interface_counters
821 /* enums - plural - in vnet/interface.h */
822 u8 vnet_counter_type;
824 u32 first_sw_if_index;
829 typeonly manual_print manual_endian define ip4_fib_counter
837 manual_print manual_endian define vnet_ip4_fib_counters
841 vl_api_ip4_fib_counter_t c[count];
844 typeonly manual_print manual_endian define ip6_fib_counter
852 manual_print manual_endian define vnet_ip6_fib_counters
856 vl_api_ip6_fib_counter_t c[count];
859 /** \brief Request for a single block of summary stats
860 @param client_index - opaque cookie to identify the sender
861 @param context - sender context, to match reply w/ request
863 define vnet_get_summary_stats
869 /** \brief Reply for vnet_get_summary_stats request
870 @param context - sender context, to match reply w/ request
871 @param retval - return code for request
876 define vnet_summary_stats_reply
885 /** \brief OAM event structure
886 @param dst_address[] -
895 /** \brief Want OAM events request
896 @param client_index - opaque cookie to identify the sender
897 @param context - sender context, to match reply w/ request
898 @param enable_disable- enable if non-zero, else disable
899 @param pid - pid of the requesting process
901 define want_oam_events
909 /** \brief Want OAM events response
910 @param context - sender context, to match reply w/ request
911 @param retval - return code for the want oam stats request
913 define want_oam_events_reply
919 /** \brief OAM add / del target request
920 @param client_index - opaque cookie to identify the sender
921 @param context - sender context, to match reply w/ request
922 @param vrf_id - vrf_id of the target
923 @param src_address[] - source address to use for the updates
924 @param dst_address[] - destination address of the target
925 @param is_add - add target if non-zero, else delete
937 /** \brief OAM add / del target response
938 @param context - sender context, to match reply w/ request
939 @param retval - return code of the request
941 define oam_add_del_reply
947 /** \brief Reset fib table request
948 @param client_index - opaque cookie to identify the sender
949 @param context - sender context, to match reply w/ request
950 @param vrf_id - vrf/table id of the fib table to reset
951 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
961 /** \brief Reset fib response
962 @param context - sender context, to match reply w/ request
963 @param retval - return code for the reset bfib request
965 define reset_fib_reply
971 /** \brief DHCP Proxy config add / del request
972 @param client_index - opaque cookie to identify the sender
973 @param context - sender context, to match reply w/ request
974 @param vrf_id - vrf id
975 @param if_ipv6 - ipv6 if non-zero, else ipv4
976 @param is_add - add the config if non-zero, else delete
977 @param insert_circuit_id - option82 suboption 1 fib number
978 @param dhcp_server[] - server address
979 @param dhcp_src_address[] - <fix this, need details>
981 define dhcp_proxy_config
988 u8 insert_circuit_id;
990 u8 dhcp_src_address[16];
993 /** \brief DHCP Proxy config response
994 @param context - sender context, to match reply w/ request
995 @param retval - return code for the request
997 define dhcp_proxy_config_reply
1003 /** \brief DHCP Proxy set / unset vss request
1004 @param client_index - opaque cookie to identify the sender
1005 @param context - sender context, to match reply w/ request
1006 @param tbl_id - table id
1007 @param oui - first part of vpn id
1008 @param fib_id - second part of vpn id
1009 @param is_ipv6 - ip6 if non-zero, else ip4
1010 @param is_add - set vss if non-zero, else delete
1012 define dhcp_proxy_set_vss
1023 /** \brief DHCP proxy set / unset vss response
1024 @param context - sender context, to match reply w/ request
1025 @param retval - return code for the request
1027 define dhcp_proxy_set_vss_reply
1033 /** \brief Set the ip flow hash config for a fib request
1034 @param client_index - opaque cookie to identify the sender
1035 @param context - sender context, to match reply w/ request
1036 @param vrf_id - vrf/fib id
1037 @param is_ipv6 - if non-zero the fib is ip6, else ip4
1038 @param src - if non-zero include src in flow hash
1039 @param dst - if non-zero include dst in flow hash
1040 @param sport - if non-zero include sport in flow hash
1041 @param dport - if non-zero include dport in flow hash
1042 @param proto -if non-zero include proto in flow hash
1043 @param reverse - if non-zero include reverse in flow hash
1045 define set_ip_flow_hash
1059 /** \brief Set the ip flow hash config for a fib response
1060 @param context - sender context, to match reply w/ request
1061 @param retval - return code for the request
1063 define set_ip_flow_hash_reply
1069 /** \brief IPv6 router advertisement config request
1070 @param client_index - opaque cookie to identify the sender
1071 @param context - sender context, to match reply w/ request
1076 @param send_unicast -
1079 @param default_router -
1080 @param max_interval -
1081 @param min_interval -
1083 @param initial_count -
1084 @param initial_interval -
1086 define sw_interface_ip6nd_ra_config
1103 u32 initial_interval;
1106 /** \brief IPv6 router advertisement config response
1107 @param context - sender context, to match reply w/ request
1108 @param retval - return code for the request
1110 define sw_interface_ip6nd_ra_config_reply
1116 /** \brief IPv6 router advertisement prefix config request
1117 @param client_index - opaque cookie to identify the sender
1118 @param context - sender context, to match reply w/ request
1119 @param sw_if_index -
1121 @param address_length -
1122 @param use_default -
1123 @param no_advertise -
1125 @param no_autoconfig -
1128 @param val_lifetime -
1129 @param pref_lifetime -
1131 define sw_interface_ip6nd_ra_prefix
1148 /** \brief IPv6 router advertisement prefix config response
1149 @param context - sender context, to match reply w/ request
1150 @param retval - return code for the request
1152 define sw_interface_ip6nd_ra_prefix_reply
1158 /** \brief IPv6 interface enable / disable request
1159 @param client_index - opaque cookie to identify the sender
1160 @param context - sender context, to match reply w/ request
1161 @param sw_if_index - interface used to reach neighbor
1162 @param enable - if non-zero enable ip6 on interface, else disable
1164 define sw_interface_ip6_enable_disable
1169 u8 enable; /* set to true if enable */
1172 /** \brief IPv6 interface enable / disable response
1173 @param context - sender context, to match reply w/ request
1174 @param retval - return code for the request
1176 define sw_interface_ip6_enable_disable_reply
1182 /** \brief IPv6 set link local address on interface request
1183 @param client_index - opaque cookie to identify the sender
1184 @param context - sender context, to match reply w/ request
1185 @param sw_if_index - interface to set link local on
1186 @param address[] - the new link local address
1187 @param address_length - link local address length
1189 define sw_interface_ip6_set_link_local_address
1198 /** \brief IPv6 set link local address on interface response
1199 @param context - sender context, to match reply w/ request
1200 @param retval - error code for the request
1202 define sw_interface_ip6_set_link_local_address_reply
1208 /** \brief Set unnumbered interface add / del request
1209 @param client_index - opaque cookie to identify the sender
1210 @param context - sender context, to match reply w/ request
1211 @param sw_if_index - interface with an IP address
1212 @param unnumbered_sw_if_index - interface which will use the address
1213 @param is_add - if non-zero set the association, else unset it
1215 define sw_interface_set_unnumbered
1219 u32 sw_if_index; /* use this intfc address */
1220 u32 unnumbered_sw_if_index; /* on this interface */
1224 /** \brief Set unnumbered interface add / del response
1225 @param context - sender context, to match reply w/ request
1226 @param retval - return code for the request
1228 define sw_interface_set_unnumbered_reply
1234 /** \brief Create loopback interface request
1235 @param client_index - opaque cookie to identify the sender
1236 @param context - sender context, to match reply w/ request
1237 @param mac_address - mac addr to assign to the interface if none-zero
1239 define create_loopback
1246 /** \brief Create loopback interface response
1247 @param context - sender context, to match reply w/ request
1248 @param sw_if_index - sw index of the interface that was created
1249 @param retval - return code for the request
1251 define create_loopback_reply
1258 /** \brief Delete loopback interface request
1259 @param client_index - opaque cookie to identify the sender
1260 @param context - sender context, to match reply w/ request
1261 @param sw_if_index - sw index of the interface that was created
1263 define delete_loopback
1270 /** \brief Delete loopback interface response
1271 @param context - sender context, to match reply w/ request
1272 @param retval - return code for the request
1274 define delete_loopback_reply
1280 /** \brief Control ping from client to api server request
1281 @param client_index - opaque cookie to identify the sender
1282 @param context - sender context, to match reply w/ request
1290 /** \brief Control ping from the client to the server response
1291 @param client_index - opaque cookie to identify the sender
1292 @param context - sender context, to match reply w/ request
1293 @param retval - return code for the request
1294 @param vpe_pid - the pid of the vpe, returned by the server
1296 define control_ping_reply
1304 /** \brief Process a vpe parser cli string request
1305 @param client_index - opaque cookie to identify the sender
1306 @param context - sender context, to match reply w/ request
1307 @param cmd_in_shmem - pointer to cli command string
1323 /** \brief vpe parser cli string response
1324 @param context - sender context, to match reply w/ request
1325 @param retval - return code for request
1326 @param reply_in_shmem - Reply string from cli processing if any
1334 define cli_inband_reply
1342 /** \brief Set max allowed ARP or ip6 neighbor entries request
1343 @param client_index - opaque cookie to identify the sender
1344 @param context - sender context, to match reply w/ request
1345 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1346 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1348 define set_arp_neighbor_limit
1353 u32 arp_neighbor_limit;
1356 /** \brief Set max allowed ARP or ip6 neighbor entries response
1357 @param context - sender context, to match reply w/ request
1358 @param retval - return code for request
1360 define set_arp_neighbor_limit_reply
1366 /** \brief L2 interface patch add / del request
1367 @param client_index - opaque cookie to identify the sender
1368 @param context - sender context, to match reply w/ request
1369 @param rx_sw_if_index - receive side interface
1370 @param tx_sw_if_index - transmit side interface
1371 @param is_add - if non-zero set up the interface patch, else remove it
1373 define l2_patch_add_del
1382 /** \brief L2 interface patch add / del response
1383 @param context - sender context, to match reply w/ request
1384 @param retval - return code for the request
1386 define l2_patch_add_del_reply
1392 /** \brief IPv6 segment routing tunnel add / del request
1393 @param client_index - opaque cookie to identify the sender
1394 @param context - sender context, to match reply w/ request
1395 @param is_add - add the tunnel if non-zero, else delete it
1396 @param name[] - tunnel name (len. 64)
1397 @param src_address[] -
1398 @param dst_address[] -
1399 @param dst_mask_width -
1400 @param inner_vrf_id -
1401 @param outer_vrf_id -
1402 @param flags_net_byte_order -
1405 @param segs_and_tags[] -
1406 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1408 define sr_tunnel_add_del
1419 u16 flags_net_byte_order;
1422 u8 segs_and_tags[0];
1426 /** \brief IPv6 segment routing tunnel add / del response
1427 @param context - sender context, to match reply w/ request
1428 @param retval - return value for request
1430 define sr_tunnel_add_del_reply
1436 /** \brief IPv6 segment routing policy add / del request
1437 @param client_index - opaque cookie to identify the sender
1438 @param context - sender context, to match reply w/ request
1439 @param is_add - add the tunnel if non-zero, else delete it
1440 @param name[] - policy name (len. 64)
1441 @param tunnel_names[] -
1443 define sr_policy_add_del
1452 /** \brief IPv6 segment routing policy add / del response
1453 @param context - sender context, to match reply w/ request
1454 @param retval - return value for request
1456 define sr_policy_add_del_reply
1462 /** \brief IPv6 segment routing multicast map to policy add / del request
1463 @param client_index - opaque cookie to identify the sender
1464 @param context - sender context, to match reply w/ request
1465 @param is_add - add the tunnel if non-zero, else delete it
1466 @param multicast_address[] - IP6 multicast address
1467 @param policy_name[] = policy name (len.64)
1469 define sr_multicast_map_add_del
1474 u8 multicast_address[16];
1478 /** \brief IPv6 segment routing multicast map to policy add / del response
1479 @param context - sender context, to match reply w/ request
1480 @param retval - return value for request
1482 define sr_multicast_map_add_del_reply
1488 /** \brief Interface set vpath request
1489 @param client_index - opaque cookie to identify the sender
1490 @param context - sender context, to match reply w/ request
1491 @param sw_if_index - interface used to reach neighbor
1492 @param enable - if non-zero enable, else disable
1494 define sw_interface_set_vpath
1502 /** \brief Interface set vpath response
1503 @param context - sender context, to match reply w/ request
1504 @param retval - return code for the request
1506 define sw_interface_set_vpath_reply
1512 /** \brief MPLS Ethernet add / del tunnel request
1513 @param client_index - opaque cookie to identify the sender
1514 @param context - sender context, to match reply w/ request
1515 @param vrf_id - vrf_id, only for IP4
1516 @param sw_if_index - interface used to reach neighbor
1517 @param is_add - add if set, tunnel delete if 0
1518 @param dst_mac_address -
1519 @param adj_address -
1520 @param adj_address_length -
1522 define mpls_ethernet_add_del_tunnel
1530 u8 dst_mac_address[6];
1532 u8 adj_address_length;
1535 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1536 @param context - sender context, to match reply w/ request
1537 @param retval - return code for the request
1539 define mpls_ethernet_add_del_tunnel_reply
1543 u32 tunnel_sw_if_index;
1545 /** \brief MPLS Ethernet add/ del tunnel 2
1546 @param client_index - opaque cookie to identify the sender
1547 @param context - sender context, to match reply w/ request
1548 @param inner_vrf_id -
1549 @param outer_vrf_id -
1550 @param resolve_attempts -
1551 @param resolve_opaque -
1552 @param resolve_if_needed -
1554 @param adj_address -
1555 @param adj_address_length -
1556 @param next_hop_ip4_address_in_outer_vrf -
1558 define mpls_ethernet_add_del_tunnel_2
1564 u32 resolve_attempts;
1565 u32 resolve_opaque; /* no need to set this */
1566 u8 resolve_if_needed;
1570 u8 adj_address_length;
1571 u8 next_hop_ip4_address_in_outer_vrf[4];
1574 /** \brief MPLS Ethernet add/ del tunnel 2
1575 @param context - sender context, to match reply w/ request
1576 @param retval - return code for add /del request
1578 define mpls_ethernet_add_del_tunnel_2_reply
1584 /** \brief Set L2 XConnect between two interfaces request
1585 @param client_index - opaque cookie to identify the sender
1586 @param context - sender context, to match reply w/ request
1587 @param rx_sw_if_index - Receive interface index
1588 @param tx_sw_if_index - Transmit interface index
1589 @param enable - enable xconnect if not 0, else set to L3 mode
1591 define sw_interface_set_l2_xconnect
1600 /** \brief Set L2 XConnect response
1601 @param context - sender context, to match reply w/ request
1602 @param retval - L2 XConnect request return code
1604 define sw_interface_set_l2_xconnect_reply
1610 /** \brief Interface bridge mode request
1611 @param client_index - opaque cookie to identify the sender
1612 @param context - sender context, to match reply w/ request
1613 @param rx_sw_if_index - the interface
1614 @param bd_id - bridge domain id
1615 @param bvi - Setup interface as a bvi, bridge mode only
1616 @param shg - Shared horizon group, for bridge mode only
1617 @param enable - Enable beige mode if not 0, else set to L3 mode
1619 define sw_interface_set_l2_bridge
1630 /** \brief Interface bridge mode response
1631 @param context - sender context, to match reply w/ request
1632 @param retval - Bridge mode request return code
1634 define sw_interface_set_l2_bridge_reply
1640 /** \brief L2 FIB add entry request
1641 @param client_index - opaque cookie to identify the sender
1642 @param context - sender context, to match reply w/ request
1643 @param mac - the entry's mac address
1644 @param bd_id - the entry's bridge domain id
1645 @param sw_if_index - the interface
1646 @param is_add - If non zero add the entry, else delete it
1650 define l2fib_add_del
1663 /** \brief L2 FIB add entry response
1664 @param context - sender context, to match reply w/ request
1665 @param retval - return code for the add l2fib entry request
1667 define l2fib_add_del_reply
1673 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1674 @param client_index - opaque cookie to identify the sender
1675 @param context - sender context, to match reply w/ request
1676 @param sw_if_index - interface
1677 @param is_set - if non-zero, set the bits, else clear them
1678 @param feature_bitmap - non-zero bits to set or clear
1689 /** \brief Set L2 bits response
1690 @param context - sender context, to match reply w/ request
1691 @param retval - return code for the set l2 bits request
1693 define l2_flags_reply
1697 u32 resulting_feature_bitmap;
1700 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1701 L2_UU_FLOOD, or L2_ARP_TERM) request
1702 @param client_index - opaque cookie to identify the sender
1703 @param context - sender context, to match reply w/ request
1704 @param bd_id - the bridge domain to set the flags for
1705 @param is_set - if non-zero, set the flags, else clear them
1706 @param feature_bitmap - bits that are non-zero to set or clear
1717 /** \brief Set bridge flags response
1718 @param context - sender context, to match reply w/ request
1719 @param retval - return code for the set bridge flags request
1720 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1722 define bridge_flags_reply
1726 u32 resulting_feature_bitmap;
1729 /** \brief Set bridge domain ip to mac entry request
1730 @param client_index - opaque cookie to identify the sender
1731 @param context - sender context, to match reply w/ request
1732 @param bd_id - the bridge domain to set the flags for
1733 @param is_add - if non-zero, add the entry, else clear it
1734 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1735 @param mac_address - MAC address
1738 define bd_ip_mac_add_del
1749 /** \brief Set bridge domain ip to mac entry response
1750 @param context - sender context, to match reply w/ request
1751 @param retval - return code for the set bridge flags request
1753 define bd_ip_mac_add_del_reply
1759 /** \brief Add/Delete classification table request
1760 @param client_index - opaque cookie to identify the sender
1761 @param context - sender context, to match reply w/ request
1762 @param is_add- if non-zero add the table, else delete it
1763 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1764 @param nbuckets - number of buckets when adding a table
1765 @param memory_size - memory size when adding a table
1766 @param match_n_vectors - number of match vectors
1767 @param next_table_index - index of next table
1768 @param miss_next_index - index of miss table
1769 @param mask[] - match mask
1771 define classify_add_del_table
1780 u32 match_n_vectors;
1781 u32 next_table_index;
1782 u32 miss_next_index;
1786 /** \brief Add/Delete classification table response
1787 @param context - sender context, to match reply w/ request
1788 @param retval - return code for the table add/del requst
1789 @param new_table_index - for add, returned index of the new table
1790 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1791 @param match_n_vectors -for add, returned value of match_n_vectors in table
1793 define classify_add_del_table_reply
1797 u32 new_table_index;
1799 u32 match_n_vectors;
1802 /** \brief Classify add / del session request
1803 @param client_index - opaque cookie to identify the sender
1804 @param context - sender context, to match reply w/ request
1805 @param is_add - add session if non-zero, else delete
1806 @param table_index - index of the table to add/del the session, required
1807 @param hit_next_index - for add, hit_next_index of new session, required
1808 @param opaque_index - for add, opaque_index of new session
1809 @param advance -for add, advance value for session
1810 @param match[] - for add, match value for session, required
1812 define classify_add_del_session
1824 /** \brief Classify add / del session response
1825 @param context - sender context, to match reply w/ request
1826 @param retval - return code for the add/del session request
1828 define classify_add_del_session_reply
1834 /** \brief Set/unset the classification table for an interface request
1835 @param client_index - opaque cookie to identify the sender
1836 @param context - sender context, to match reply w/ request
1837 @param is_ipv6 - ipv6 if non-zero, else ipv4
1838 @param sw_if_index - interface to associate with the table
1839 @param table_index - index of the table, if ~0 unset the table
1841 define classify_set_interface_ip_table
1847 u32 table_index; /* ~0 => off */
1850 /** \brief Set/unset interface classification table response
1851 @param context - sender context, to match reply w/ request
1852 @param retval - return code
1854 define classify_set_interface_ip_table_reply
1860 /** \brief Set/unset l2 classification tables for an interface request
1861 @param client_index - opaque cookie to identify the sender
1862 @param context - sender context, to match reply w/ request
1863 @param sw_if_index - interface to set/unset tables for
1864 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1865 @param ip6_table_index - ip6 index
1866 @param other_table_index - other index
1868 define classify_set_interface_l2_tables
1874 u32 ip4_table_index;
1875 u32 ip6_table_index;
1876 u32 other_table_index;
1880 /** \brief Set/unset l2 classification tables for an interface response
1881 @param context - sender context, to match reply w/ request
1882 @param retval - return code for the request
1884 define classify_set_interface_l2_tables_reply
1890 /** \brief Get node index using name request
1891 @param client_index - opaque cookie to identify the sender
1892 @param context - sender context, to match reply w/ request
1893 @param node_name[] - name of the node
1895 define get_node_index
1902 /** \brief Get node index using name request
1903 @param context - sender context, to match reply w/ request
1904 @param retval - return code for the request
1905 @param node_index - index of the desired node if found, else ~0
1907 define get_node_index_reply
1914 /** \brief Set the next node for a given node request
1915 @param client_index - opaque cookie to identify the sender
1916 @param context - sender context, to match reply w/ request
1917 @param node_name[] - node to add the next node to
1918 @param next_name[] - node to add as the next node
1920 define add_node_next
1928 /** \brief IP Set the next node for a given node response
1929 @param context - sender context, to match reply w/ request
1930 @param retval - return code for the add next node request
1931 @param next_index - the index of the next node if success, else ~0
1933 define add_node_next_reply
1940 /** \brief DHCP Proxy config 2 add / del request
1941 @param client_index - opaque cookie to identify the sender
1942 @param context - sender context, to match reply w/ request
1943 @param rx_vrf_id - receive vrf id
1944 @param server_vrf_id - server vrf id
1945 @param if_ipv6 - ipv6 if non-zero, else ipv4
1946 @param is_add - add the config if non-zero, else delete
1947 @param insert_circuit_id - option82 suboption 1 fib number
1948 @param dhcp_server[] - server address
1949 @param dhcp_src_address[] - <fix this, need details>
1951 define dhcp_proxy_config_2
1959 u8 insert_circuit_id;
1961 u8 dhcp_src_address[16];
1964 /** \brief DHCP Proxy config 2 add / del response
1965 @param context - sender context, to match reply w/ request
1966 @param retval - return code for request
1968 define dhcp_proxy_config_2_reply
1974 /** \brief l2tpv3 tunnel interface create request
1975 @param client_index - opaque cookie to identify the sender
1976 @param context - sender context, to match reply w/ request
1977 @param client_address - remote client tunnel ip address
1978 @param client_address - local tunnel ip address
1979 @param is_ipv6 - ipv6 if non-zero, else ipv4
1980 @param local_session_id - local tunnel session id
1981 @param remote_session_id - remote tunnel session id
1982 @param local_cookie - local tunnel cookie
1983 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1984 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1986 define l2tpv3_create_tunnel
1990 u8 client_address[16];
1993 u32 local_session_id;
1994 u32 remote_session_id;
1997 u8 l2_sublayer_present;
2001 /** \brief l2tpv3 tunnel interface create response
2002 @param context - sender context, to match reply w/ request
2003 @param retval - return code for the request
2004 @param sw_if_index - index of the new tunnel interface
2006 define l2tpv3_create_tunnel_reply
2013 define l2tpv3_set_tunnel_cookies
2018 u64 new_local_cookie;
2019 u64 new_remote_cookie;
2022 /** \brief L2TP tunnel set cookies response
2023 @param context - sender context, to match reply w/ request
2024 @param retval - return code for the request
2026 define l2tpv3_set_tunnel_cookies_reply
2032 define sw_if_l2tpv3_tunnel_details
2036 u8 interface_name[64];
2037 u8 client_address[16];
2039 u32 local_session_id;
2040 u32 remote_session_id;
2041 u64 local_cookie[2];
2043 u8 l2_sublayer_present;
2046 define sw_if_l2tpv3_tunnel_dump
2052 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
2053 @param client_index - opaque cookie to identify the sender
2054 @param context - sender context, to match reply w/ request
2056 define l2_fib_clear_table
2062 /** \brief L2 fib clear table response
2063 @param context - sender context, to match reply w/ request
2064 @param retval - return code for the request
2066 define l2_fib_clear_table_reply
2072 /** \brief L2 interface ethernet flow point filtering enable/disable request
2073 @param client_index - opaque cookie to identify the sender
2074 @param context - sender context, to match reply w/ request
2075 @param sw_if_index - interface to enable/disable filtering on
2076 @param enable_disable - if non-zero enable filtering, else disable
2078 define l2_interface_efp_filter
2086 /** \brief L2 interface ethernet flow point filtering response
2087 @param context - sender context, to match reply w/ request
2088 @param retval - return code for the request
2090 define l2_interface_efp_filter_reply
2096 define l2tpv3_interface_enable_disable
2104 define l2tpv3_interface_enable_disable_reply
2110 define l2tpv3_set_lookup_key
2114 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
2118 define l2tpv3_set_lookup_key_reply
2124 define vxlan_add_del_tunnel
2133 u32 decap_next_index;
2137 define vxlan_add_del_tunnel_reply
2144 define vxlan_tunnel_dump
2151 define vxlan_tunnel_details
2158 u32 decap_next_index;
2163 define gre_add_del_tunnel
2175 define gre_add_del_tunnel_reply
2182 define gre_tunnel_dump
2189 define gre_tunnel_details
2200 /** \brief L2 interface vlan tag rewrite configure request
2201 @param client_index - opaque cookie to identify the sender
2202 @param context - sender context, to match reply w/ request
2203 @param sw_if_index - interface the operation is applied to
2204 @param vtr_op - Choose from l2_vtr_op_t enum values
2205 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
2206 @param tag1 - Needed for any push or translate vtr op
2207 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
2209 define l2_interface_vlan_tag_rewrite
2215 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
2216 u32 tag1; // first pushed tag
2217 u32 tag2; // second pushed tag
2220 /** \brief L2 interface vlan tag rewrite response
2221 @param context - sender context, to match reply w/ request
2222 @param retval - return code for the request
2224 define l2_interface_vlan_tag_rewrite_reply
2230 /** \brief vhost-user interface create request
2231 @param client_index - opaque cookie to identify the sender
2232 @param is_server - our side is socket server
2233 @param sock_filename - unix socket filename, used to speak with frontend
2234 @param use_custom_mac - enable or disable the use of the provided hardware address
2235 @param mac_address - hardware address to use if 'use_custom_mac' is set
2237 define create_vhost_user_if
2242 u8 sock_filename[256];
2244 u32 custom_dev_instance;
2249 /** \brief vhost-user interface create response
2250 @param context - sender context, to match reply w/ request
2251 @param retval - return code for the request
2252 @param sw_if_index - interface the operation is applied to
2254 define create_vhost_user_if_reply
2261 /** \brief vhost-user interface modify request
2262 @param client_index - opaque cookie to identify the sender
2263 @param is_server - our side is socket server
2264 @param sock_filename - unix socket filename, used to speak with frontend
2266 define modify_vhost_user_if
2272 u8 sock_filename[256];
2274 u32 custom_dev_instance;
2277 /** \brief vhost-user interface modify response
2278 @param context - sender context, to match reply w/ request
2279 @param retval - return code for the request
2281 define modify_vhost_user_if_reply
2287 /** \brief vhost-user interface delete request
2288 @param client_index - opaque cookie to identify the sender
2290 define delete_vhost_user_if
2297 /** \brief vhost-user interface delete response
2298 @param context - sender context, to match reply w/ request
2299 @param retval - return code for the request
2301 define delete_vhost_user_if_reply
2314 /* These fields map directly onto the subif template */
2318 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2321 u8 outer_vlan_id_any;
2322 u8 inner_vlan_id_any;
2327 define create_subif_reply
2334 /** \brief show version
2335 @param client_index - opaque cookie to identify the sender
2336 @param context - sender context, to match reply w/ request
2344 /** \brief show version response
2345 @param context - sender context, to match reply w/ request
2346 @param retval - return code for the request
2347 @param program - name of the program (vpe)
2348 @param version - version of the program
2349 @param build_directory - root of the workspace where the program was built
2351 define show_version_reply
2358 u8 build_directory[256];
2361 /** \brief Vhost-user interface details structure (fix this)
2362 @param sw_if_index - index of the interface
2363 @param interface_name - name of interface
2364 @param virtio_net_hdr_sz - net header size
2365 @param features - interface features
2366 @param is_server - vhost-user server socket
2367 @param sock_filename - socket filename
2368 @param num_regions - number of used memory regions
2370 define sw_interface_vhost_user_details
2374 u8 interface_name[64];
2375 u32 virtio_net_hdr_sz;
2378 u8 sock_filename[256];
2384 define sw_interface_vhost_user_dump
2390 define ip_address_details
2398 define ip_address_dump
2419 /** \brief l2 fib table entry structure
2420 @param bd_id - the l2 fib / bridge domain table id
2421 @param mac - the entry's mac address
2422 @param sw_if_index - index of the interface
2423 @param static_mac - the entry is statically configured.
2424 @param filter_mac - the entry is a mac filter entry.
2425 @param bvi_mac - the mac address is a bridge virtual interface
2427 define l2_fib_table_entry
2438 /** \brief Dump l2 fib (aka bridge domain) table
2439 @param client_index - opaque cookie to identify the sender
2440 @param bd_id - the l2 fib / bridge domain table identifier
2442 define l2_fib_table_dump
2449 define vxlan_gpe_add_del_tunnel
2463 define vxlan_gpe_add_del_tunnel_reply
2470 define vxlan_gpe_tunnel_dump
2477 define vxlan_gpe_tunnel_details
2490 /** \brief add or delete locator_set
2491 @param client_index - opaque cookie to identify the sender
2492 @param context - sender context, to match reply w/ request
2493 @param is_add - add address if non-zero, else delete
2494 @param locator_set_name - locator name
2495 @param locator_num - number of locators
2496 @param locators - LISP locator records
2497 Structure of one locator record is as follows:
2505 define lisp_add_del_locator_set
2510 u8 locator_set_name[64];
2515 /** \brief Reply for locator_set add/del
2516 @param context - returned sender context, to match reply w/ request
2517 @param retval - return code
2518 @param ls_index - locator set index
2520 define lisp_add_del_locator_set_reply
2527 /** \brief add or delete locator for locator_set
2528 @param client_index - opaque cookie to identify the sender
2529 @param context - sender context, to match reply w/ request
2530 @param is_add - add address if non-zero, else delete
2531 @param locator_set_name - name of locator_set to add/del locator
2532 @param sw_if_index - index of the interface
2533 @param priority - priority of the lisp locator
2534 @param weight - weight of the lisp locator
2536 define lisp_add_del_locator
2541 u8 locator_set_name[64];
2547 /** \brief Reply for locator add/del
2548 @param context - returned sender context, to match reply w/ request
2549 @param retval - return code
2551 define lisp_add_del_locator_reply
2557 /** \brief add or delete lisp eid-table
2558 @param client_index - opaque cookie to identify the sender
2559 @param context - sender context, to match reply w/ request
2560 @param is_add - add address if non-zero, else delete
2565 @param eid - EID can be ip4, ip6 or mac
2566 @param prefix_len - prefix len
2567 @param locator_set_name - name of locator_set to add/del eid-table
2568 @param vni - virtual network instance
2570 define lisp_add_del_local_eid
2578 u8 locator_set_name[64];
2582 /** \brief Reply for local_eid add/del
2583 @param context - returned sender context, to match reply w/ request
2584 @param retval - return code
2586 define lisp_add_del_local_eid_reply
2592 /** \brief add or delete lisp gpe tunnel
2593 @param client_index - opaque cookie to identify the sender
2594 @param context - sender context, to match reply w/ request
2595 @param is_add - add address if non-zero, else delete
2600 @param rmt_eid - remote eid
2601 @param lcl_eid - local eid
2602 @param rmt_len - remote prefix len
2603 @param lcl_len - local prefix len
2604 @param vni - virtual network identifier
2605 @param dp_table - vrf/bridge domain id
2606 @param loc_num - number of locators
2607 @param lcl_locs - array of local locators
2608 @param rmt_locs - array of remote locators
2609 @param action - negative action when 0 locators configured
2611 define lisp_gpe_add_del_fwd_entry
2624 u8 lcl_locs[loc_num];
2625 u8 rmt_locs[loc_num];
2629 /** \brief Reply for gpe_fwd_entry add/del
2630 @param context - returned sender context, to match reply w/ request
2631 @param retval - return code
2633 define lisp_gpe_add_del_fwd_entry_reply
2639 /** \brief add or delete map-resolver
2640 @param client_index - opaque cookie to identify the sender
2641 @param context - sender context, to match reply w/ request
2642 @param is_add - add address if non-zero, else delete
2643 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2644 @param ip_address - array of address bytes
2646 define lisp_add_del_map_resolver
2655 /** \brief Reply for map_resolver add/del
2656 @param context - returned sender context, to match reply w/ request
2657 @param retval - return code
2659 define lisp_add_del_map_resolver_reply
2665 /** \brief enable or disable lisp-gpe protocol
2666 @param client_index - opaque cookie to identify the sender
2667 @param context - sender context, to match reply w/ request
2668 @param is_en - enable protocol if non-zero, else disable
2670 define lisp_gpe_enable_disable
2677 /** \brief Reply for gpe enable/disable
2678 @param context - returned sender context, to match reply w/ request
2679 @param retval - return code
2681 define lisp_gpe_enable_disable_reply
2687 /** \brief enable or disable LISP feature
2688 @param client_index - opaque cookie to identify the sender
2689 @param context - sender context, to match reply w/ request
2690 @param is_en - enable protocol if non-zero, else disable
2692 define lisp_enable_disable
2699 /** \brief Reply for gpe enable/disable
2700 @param context - returned sender context, to match reply w/ request
2701 @param retval - return code
2703 define lisp_enable_disable_reply
2709 /** \brief add or delete gpe_iface
2710 @param client_index - opaque cookie to identify the sender
2711 @param context - sender context, to match reply w/ request
2712 @param is_add - add address if non-zero, else delete
2714 define lisp_gpe_add_del_iface
2724 /** \brief Reply for gpe_iface add/del
2725 @param context - returned sender context, to match reply w/ request
2726 @param retval - return code
2728 define lisp_gpe_add_del_iface_reply
2734 /** \brief configure or disable LISP PITR node
2735 @param client_index - opaque cookie to identify the sender
2736 @param context - sender context, to match reply w/ request
2737 @param ls_name - locator set name
2738 @param is_add - add locator set if non-zero, else disable pitr
2740 define lisp_pitr_set_locator_set
2748 /** \brief Reply for lisp_pitr_set_locator_set
2749 @param context - returned sender context, to match reply w/ request
2750 @param retval - return code
2752 define lisp_pitr_set_locator_set_reply
2758 /** \brief set LISP map-request mode. Based on configuration VPP will send
2759 src/dest or just normal destination map requests.
2760 @param client_index - opaque cookie to identify the sender
2761 @param context - sender context, to match reply w/ request
2762 @param mode - new map-request mode. Supported values are:
2763 0 - destination only
2764 1 - source/destaination
2766 define lisp_map_request_mode
2773 /** \brief Reply for lisp_map_request_mode
2774 @param context - returned sender context, to match reply w/ request
2775 @param retval - return code
2777 define lisp_map_request_mode_reply
2783 /** \brief Request for LISP map-request mode
2784 @param client_index - opaque cookie to identify the sender
2785 @param context - sender context, to match reply w/ request
2787 define show_lisp_map_request_mode
2793 /** \brief Reply for show_lisp_map_request_mode
2794 @param context - returned sender context, to match reply w/ request
2795 @param retval - return code
2796 @param mode - map-request mode
2798 define show_lisp_map_request_mode_reply
2805 /** \brief add or delete remote static mapping
2806 @param client_index - opaque cookie to identify the sender
2807 @param context - sender context, to match reply w/ request
2808 @param is_add - add address if non-zero, else delete
2809 @param is_src_dst - flag indicating src/dst based routing policy
2810 @param del_all - if set, delete all remote mappings
2811 @param vni - virtual network instance
2812 @param action - negative map-reply action
2817 @param deid - dst EID
2818 @param seid - src EID, valid only if is_src_dst is enabled
2819 @param rloc_num - number of remote locators
2820 @param rlocs - remote locator records
2821 Structure of remote locator:
2830 define lisp_add_del_remote_mapping
2848 /** \brief Reply for lisp_add_del_remote_mapping
2849 @param context - returned sender context, to match reply w/ request
2850 @param retval - return code
2852 define lisp_add_del_remote_mapping_reply
2858 /** \brief add or delete LISP adjacency adjacency
2859 @param client_index - opaque cookie to identify the sender
2860 @param context - sender context, to match reply w/ request
2861 @param is_add - add address if non-zero, else delete
2862 @param vni - virtual network instance
2867 @param reid - remote EID
2868 @param leid - local EID
2870 define lisp_add_del_adjacency
2883 /** \brief Reply for lisp_add_del_adjacency
2884 @param context - returned sender context, to match reply w/ request
2885 @param retval - return code
2887 define lisp_add_del_adjacency_reply
2893 /** \brief add or delete map request itr rlocs
2894 @param client_index - opaque cookie to identify the sender
2895 @param context - sender context, to match reply w/ request
2896 @param is_add - add address if non-zero, else delete
2897 @param locator_set_name - locator set name
2899 define lisp_add_del_map_request_itr_rlocs
2904 u8 locator_set_name[64];
2907 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2908 @param context - returned sender context, to match reply w/ request
2909 @param retval - return code
2912 define lisp_add_del_map_request_itr_rlocs_reply
2918 /** \brief map/unmap vni/bd_index to vrf
2919 @param client_index - opaque cookie to identify the sender
2920 @param context - sender context, to match reply w/ request
2921 @param is_add - add or delete mapping
2922 @param dp_table - virtual network id/bridge domain index
2925 define lisp_eid_table_add_del_map
2935 /** \brief Reply for lisp_eid_table_add_del_map
2936 @param context - returned sender context, to match reply w/ request
2937 @param retval - return code
2939 define lisp_eid_table_add_del_map_reply
2945 /** \brief Request for map lisp locator status
2946 @param client_index - opaque cookie to identify the sender
2947 @param context - sender context, to match reply w/ request
2948 @param locator_set_index - index of locator_set
2949 @param ls_name - locator set name
2950 @param is_index_set - flag indicating whether ls_name or ls_index is set
2952 define lisp_locator_dump
2961 /** \brief LISP locator_set status
2962 @param local - if is set, then locator is local
2963 @param locator_set_name - name of the locator_set
2964 @param sw_if_index - sw_if_index of the locator
2965 @param priority - locator priority
2966 @param weight - locator weight
2968 define lisp_locator_details
2979 /** \brief LISP locator_set status
2980 @param context - sender context, to match reply w/ request
2981 @param ls_index - locator set index
2982 @param ls_name - name of the locator set
2984 define lisp_locator_set_details
2991 /** \brief Request for locator_set summary status
2992 @param client_index - opaque cookie to identify the sender
2993 @param context - sender context, to match reply w/ request
2994 @param filter - filter type
2997 1: local locator sets
2998 2: remote locator sets
3000 define lisp_locator_set_dump
3007 /** \brief Dump lisp eid-table
3008 @param client_index - opaque cookie to identify the sender
3009 @param context - sender context, to match reply w/ request
3010 @param locator_set_index - index of locator_set, if ~0 then the mapping
3012 @param action - negative map request action
3013 @param is_local - local if non-zero, else remote
3018 @param is_src_dst - EID is type of source/destination
3019 @param eid - EID can be ip4, ip6 or mac
3020 @param eid_prefix_len - prefix length
3021 @param seid - source EID can be ip4, ip6 or mac
3022 @param seid_prefix_len - source prefix length
3023 @param vni - virtual network instance
3024 @param ttl - time to live
3025 @param authoritative - authoritative
3028 define lisp_eid_table_details
3031 u32 locator_set_index;
3045 /** \brief Request for eid table summary status
3046 @param client_index - opaque cookie to identify the sender
3047 @param context - sender context, to match reply w/ request
3048 @param eid_set - if non-zero request info about specific mapping
3049 @param vni - virtual network instance; valid only if eid_set != 0
3050 @param prefix_length - prefix length if EID is IP address;
3051 valid only if eid_set != 0
3052 @param eid_type - EID type; valid only if eid_set != 0
3056 2: EID is ethernet address
3057 @param eid - endpoint identifier
3058 @param filter - filter type;
3064 define lisp_eid_table_dump
3076 /** \brief LISP adjacency
3081 @param reid - remote EID
3082 @param leid - local EID
3083 @param reid_prefix_len - remote EID IP prefix length
3084 @param leid_prefix_len - local EID IP prefix length
3086 typeonly manual_print manual_endian define lisp_adjacency
3095 /** \brief LISP adjacency reply
3096 @param count - number of adjacencies
3097 @param adjacencies - array of adjacencies
3099 manual_endian manual_print define lisp_adjacencies_get_reply
3104 vl_api_lisp_adjacency_t adjacencies[count];
3107 /** \brief Request for LISP adjacencies
3108 @param client_index - opaque cookie to identify the sender
3109 @param context - sender context, to match reply w/ request
3110 @param vni - filter adjacencies by VNI
3112 define lisp_adjacencies_get
3119 /** \brief Shows relationship between vni and vrf/bd
3120 @param dp_table - VRF index or bridge domain index
3121 @param vni - vitual network instance
3123 define lisp_eid_table_map_details
3130 /** \brief Request for lisp_eid_table_map_details
3131 @param client_index - opaque cookie to identify the sender
3132 @param context - sender context, to match reply w/ request
3133 @param is_l2 - if set dump vni/bd mappings else vni/vrf
3135 define lisp_eid_table_map_dump
3142 /** \brief Dumps all VNIs used in mappings
3143 @param client_index - opaque cookie to identify the sender
3144 @param context - sender context, to match reply w/ request
3146 define lisp_eid_table_vni_dump
3152 /** \brief reply to lisp_eid_table_vni_dump
3153 @param client_index - opaque cookie to identify the sender
3154 @param context - sender context, to match reply w/ request
3155 @param vni - virtual network instance
3157 define lisp_eid_table_vni_details
3164 define lisp_gpe_tunnel_details
3170 u8 destination_ip[16];
3182 /** \brief Request for gpe tunnel summary status
3183 @param client_index - opaque cookie to identify the sender
3184 @param context - sender context, to match reply w/ request
3186 define lisp_gpe_tunnel_dump
3192 /** \brief LISP map resolver status
3193 @param locator_set_name - name of the locator_set
3194 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3195 @param ip_address - array of address bytes
3197 define lisp_map_resolver_details
3204 /** \brief Request for map resolver summary status
3205 @param client_index - opaque cookie to identify the sender
3206 @param context - sender context, to match reply w/ request
3208 define lisp_map_resolver_dump
3214 /** \brief Request for lisp-gpe protocol status
3215 @param client_index - opaque cookie to identify the sender
3216 @param context - sender context, to match reply w/ request
3218 define show_lisp_status
3224 /** \brief Status of lisp, enable or disable
3225 @param context - sender context, to match reply w/ request
3226 @param feature_status - lisp enable if non-zero, else disable
3227 @param gpe_status - lisp enable if non-zero, else disable
3229 define show_lisp_status_reply
3237 /** \brief Get LISP map request itr rlocs status
3238 @param context - sender context, to match reply w/ request
3239 @param locator_set_name - name of the locator_set
3241 define lisp_get_map_request_itr_rlocs
3247 /** \brief Request for map request itr rlocs summary status
3249 define lisp_get_map_request_itr_rlocs_reply
3253 u8 locator_set_name[64];
3256 /** \brief Request for lisp pitr status
3257 @param client_index - opaque cookie to identify the sender
3258 @param context - sender context, to match reply w/ request
3260 define show_lisp_pitr
3266 /** \brief Status of lisp pitr, enable or disable
3267 @param context - sender context, to match reply w/ request
3268 @param status - lisp pitr enable if non-zero, else disable
3269 @param locator_set_name - name of the locator_set
3271 define show_lisp_pitr_reply
3276 u8 locator_set_name[64];
3279 /* Gross kludge, DGMS */
3280 define interface_name_renumber
3285 u32 new_show_dev_instance;
3288 define interface_name_renumber_reply
3294 /** \brief Register for ip4 arp resolution events
3295 @param client_index - opaque cookie to identify the sender
3296 @param context - sender context, to match reply w/ request
3297 @param enable_disable - 1 => register for events, 0 => cancel registration
3298 @param pid - sender's pid
3299 @param address - the exact ip4 address of interest
3301 define want_ip4_arp_events
3310 /** \brief Reply for interface events registration
3311 @param context - returned sender context, to match reply w/ request
3312 @param retval - return code
3314 define want_ip4_arp_events_reply
3320 /** \brief Tell client about an ip4 arp resolution event
3321 @param client_index - opaque cookie to identify the sender
3322 @param context - sender context, to match reply w/ request
3323 @param address - the exact ip4 address of interest
3324 @param pid - client pid registered to receive notification
3325 @param sw_if_index - interface which received ARP packet
3326 @param new_mac - the new mac address
3327 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3329 define ip4_arp_event
3340 /** \brief Register for ip6 nd resolution events
3341 @param client_index - opaque cookie to identify the sender
3342 @param context - sender context, to match reply w/ request
3343 @param enable_disable - 1 => register for events, 0 => cancel registration
3344 @param pid - sender's pid
3345 @param address - the exact ip6 address of interest
3347 define want_ip6_nd_events
3356 /** \brief Reply for ip6 nd resolution events registration
3357 @param context - returned sender context, to match reply w/ request
3358 @param retval - return code
3360 define want_ip6_nd_events_reply
3366 /** \brief Tell client about an ip6 nd resolution or mac/ip event
3367 @param client_index - opaque cookie to identify the sender
3368 @param context - sender context, to match reply w/ request
3369 @param pid - client pid registered to receive notification
3370 @param sw_if_index - interface which received ARP packet
3371 @param address - the exact ip6 address of interest
3372 @param new_mac - the new mac address
3373 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3386 /** \brief L2 bridge domain add or delete request
3387 @param client_index - opaque cookie to identify the sender
3388 @param context - sender context, to match reply w/ request
3389 @param bd_id - the bridge domain to create
3390 @param flood - enable/disable bcast/mcast flooding in the bd
3391 @param uu_flood - enable/disable uknown unicast flood in the bd
3392 @param forward - enable/disable forwarding on all interfaces in the bd
3393 @param learn - enable/disable learning on all interfaces in the bd
3394 @param arp_term - enable/disable arp termination in the bd
3395 @param is_add - add or delete flag
3397 define bridge_domain_add_del
3410 /** \brief L2 bridge domain add or delete response
3411 @param context - sender context, to match reply w/ request
3412 @param retval - return code for the set bridge flags request
3414 define bridge_domain_add_del_reply
3420 /** \brief L2 bridge domain request operational state details
3421 @param client_index - opaque cookie to identify the sender
3422 @param context - sender context, to match reply w/ request
3423 @param bd_id - the bridge domain id desired or ~0 to request all bds
3425 define bridge_domain_dump
3432 /** \brief L2 bridge domain operational state response
3433 @param bd_id - the bridge domain id
3434 @param flood - bcast/mcast flooding state on all interfaces in the bd
3435 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3436 @param forward - forwarding state on all interfaces in the bd
3437 @param learn - learning state on all interfaces in the bd
3438 @param arp_term - arp termination state on all interfaces in the bd
3439 @param n_sw_ifs - number of sw_if_index's in the domain
3441 define bridge_domain_details
3450 u32 bvi_sw_if_index;
3454 /** \brief L2 bridge domain sw interface operational state response
3455 @param bd_id - the bridge domain id
3456 @param sw_if_index - sw_if_index in the domain
3457 @param shg - split horizon group for the interface
3459 define bridge_domain_sw_if_details
3467 /** \brief DHCP Client config add / del request
3468 @param client_index - opaque cookie to identify the sender
3469 @param context - sender context, to match reply w/ request
3470 @param sw_if_index - index of the interface for DHCP client
3471 @param hostname - hostname
3472 @param is_add - add the config if non-zero, else delete
3473 @param want_dhcp_event - DHCP event sent to the sender
3474 via dhcp_compl_event API message if non-zero
3475 @param pid - sender's pid
3477 define dhcp_client_config
3488 /** \brief DHCP Client config response
3489 @param context - sender context, to match reply w/ request
3490 @param retval - return code for the request
3492 define dhcp_client_config_reply
3498 /** \brief Set/unset input ACL interface
3499 @param client_index - opaque cookie to identify the sender
3500 @param context - sender context, to match reply w/ request
3501 @param sw_if_index - interface to set/unset input ACL
3502 @param ip4_table_index - ip4 classify table index (~0 for skip)
3503 @param ip6_table_index - ip6 classify table index (~0 for skip)
3504 @param l2_table_index - l2 classify table index (~0 for skip)
3505 @param is_add - Set input ACL if non-zero, else unset
3506 Note: User is recommeneded to use just one valid table_index per call.
3507 (ip4_table_index, ip6_table_index, or l2_table_index)
3509 define input_acl_set_interface
3514 u32 ip4_table_index;
3515 u32 ip6_table_index;
3520 /** \brief Set/unset input ACL interface response
3521 @param context - sender context, to match reply w/ request
3522 @param retval - return code for the request
3524 define input_acl_set_interface_reply
3530 /** \brief IPsec: Add/delete Security Policy Database
3531 @param client_index - opaque cookie to identify the sender
3532 @param context - sender context, to match reply w/ request
3533 @param is_add - add SPD if non-zero, else delete
3534 @param spd_id - SPD instance id (control plane allocated)
3537 define ipsec_spd_add_del
3545 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3546 @param context - returned sender context, to match reply w/ request
3547 @param retval - return code
3550 define ipsec_spd_add_del_reply
3556 /** \brief IPsec: Add/delete SPD from interface
3558 @param client_index - opaque cookie to identify the sender
3559 @param context - sender context, to match reply w/ request
3560 @param is_add - add security mode if non-zero, else delete
3561 @param sw_if_index - index of the interface
3562 @param spd_id - SPD instance id to use for lookups
3566 define ipsec_interface_add_del_spd
3576 /** \brief Reply for IPsec: Add/delete SPD from interface
3577 @param context - returned sender context, to match reply w/ request
3578 @param retval - return code
3581 define ipsec_interface_add_del_spd_reply
3587 /** \brief IPsec: Add/delete Security Policy Database entry
3589 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3591 @param client_index - opaque cookie to identify the sender
3592 @param context - sender context, to match reply w/ request
3593 @param is_add - add SPD if non-zero, else delete
3594 @param spd_id - SPD instance id (control plane allocated)
3595 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3596 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3597 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3598 @param remote_address_start - start of remote address range to match
3599 @param remote_address_stop - end of remote address range to match
3600 @param local_address_start - start of local address range to match
3601 @param local_address_stop - end of local address range to match
3602 @param protocol - protocol type to match [0 means any]
3603 @param remote_port_start - start of remote port range to match ...
3604 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3605 @param local_port_start - start of local port range to match ...
3606 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3607 @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)
3608 @param sa_id - SAD instance id (control plane allocated)
3612 define ipsec_spd_add_del_entry
3625 u8 remote_address_start[16];
3626 u8 remote_address_stop[16];
3627 u8 local_address_start[16];
3628 u8 local_address_stop[16];
3632 u16 remote_port_start;
3633 u16 remote_port_stop;
3634 u16 local_port_start;
3635 u16 local_port_stop;
3642 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3643 @param context - returned sender context, to match reply w/ request
3644 @param retval - return code
3647 define ipsec_spd_add_del_entry_reply
3653 /** \brief IPsec: Add/delete Security Association Database entry
3654 @param client_index - opaque cookie to identify the sender
3655 @param context - sender context, to match reply w/ request
3656 @param is_add - add SAD entry if non-zero, else delete
3658 @param sad_id - sad id
3660 @param spi - security parameter index
3662 @param protocol - 0 = AH, 1 = ESP
3664 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3665 @param crypto_key_length - length of crypto_key in bytes
3666 @param crypto_key - crypto keying material
3668 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3669 @param integrity_key_length - length of integrity_key in bytes
3670 @param integrity_key - integrity keying material
3672 @param use_extended_sequence_number - use ESN when non-zero
3674 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3675 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3676 @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
3677 @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
3681 IPsec tunnel address copy mode (to support GDOI)
3684 define ipsec_sad_add_del_entry
3696 u8 crypto_algorithm;
3697 u8 crypto_key_length;
3700 u8 integrity_algorithm;
3701 u8 integrity_key_length;
3702 u8 integrity_key[128];
3704 u8 use_extended_sequence_number;
3708 u8 tunnel_src_address[16];
3709 u8 tunnel_dst_address[16];
3712 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3713 @param context - returned sender context, to match reply w/ request
3714 @param retval - return code
3717 define ipsec_sad_add_del_entry_reply
3723 /** \brief IPsec: Update Security Association keys
3724 @param client_index - opaque cookie to identify the sender
3725 @param context - sender context, to match reply w/ request
3727 @param sa_id - sa id
3729 @param crypto_key_length - length of crypto_key in bytes
3730 @param crypto_key - crypto keying material
3732 @param integrity_key_length - length of integrity_key in bytes
3733 @param integrity_key - integrity keying material
3736 define ipsec_sa_set_key
3743 u8 crypto_key_length;
3746 u8 integrity_key_length;
3747 u8 integrity_key[128];
3750 /** \brief Reply for IPsec: Update Security Association keys
3751 @param context - returned sender context, to match reply w/ request
3752 @param retval - return code
3755 define ipsec_sa_set_key_reply
3761 /** \brief IKEv2: Add/delete profile
3762 @param client_index - opaque cookie to identify the sender
3763 @param context - sender context, to match reply w/ request
3765 @param name - IKEv2 profile name
3766 @param is_add - Add IKEv2 profile if non-zero, else delete
3768 define ikev2_profile_add_del
3777 /** \brief Reply for IKEv2: Add/delete profile
3778 @param context - returned sender context, to match reply w/ request
3779 @param retval - return code
3781 define ikev2_profile_add_del_reply
3787 /** \brief IKEv2: Set IKEv2 profile authentication method
3788 @param client_index - opaque cookie to identify the sender
3789 @param context - sender context, to match reply w/ request
3791 @param name - IKEv2 profile name
3792 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3793 @param is_hex - Authentication data in hex format if non-zero, else string
3794 @param data_len - Authentication data length
3795 @param data - Authentication data (for rsa-sig cert file path)
3797 define ikev2_profile_set_auth
3809 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3810 @param context - returned sender context, to match reply w/ request
3811 @param retval - return code
3813 define ikev2_profile_set_auth_reply
3819 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3820 @param client_index - opaque cookie to identify the sender
3821 @param context - sender context, to match reply w/ request
3823 @param name - IKEv2 profile name
3824 @param is_local - Identification is local if non-zero, else remote
3825 @param id_type - Identification type
3826 @param data_len - Identification data length
3827 @param data - Identification data
3829 define ikev2_profile_set_id
3841 /** \brief Reply for IKEv2:
3842 @param context - returned sender context, to match reply w/ request
3843 @param retval - return code
3845 define ikev2_profile_set_id_reply
3851 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3852 @param client_index - opaque cookie to identify the sender
3853 @param context - sender context, to match reply w/ request
3855 @param name - IKEv2 profile name
3856 @param is_local - Traffic selector is local if non-zero, else remote
3857 @param proto - Traffic selector IP protocol (if zero not relevant)
3858 @param start_port - The smallest port number allowed by traffic selector
3859 @param end_port - The largest port number allowed by traffic selector
3860 @param start_addr - The smallest address included in traffic selector
3861 @param end_addr - The largest address included in traffic selector
3863 define ikev2_profile_set_ts
3877 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3878 @param context - returned sender context, to match reply w/ request
3879 @param retval - return code
3881 define ikev2_profile_set_ts_reply
3887 /** \brief IKEv2: Set IKEv2 local RSA private key
3888 @param client_index - opaque cookie to identify the sender
3889 @param context - sender context, to match reply w/ request
3891 @param key_file - Key file absolute path
3893 define ikev2_set_local_key
3901 /** \brief Reply for IKEv2: Set IKEv2 local key
3902 @param context - returned sender context, to match reply w/ request
3903 @param retval - return code
3905 define ikev2_set_local_key_reply
3911 /** \brief Tell client about a DHCP completion event
3912 @param client_index - opaque cookie to identify the sender
3913 @param pid - client pid registered to receive notification
3914 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3915 @param host_address - Host IP address
3916 @param router_address - Router IP address
3917 @param host_mac - Host MAC address
3919 define dhcp_compl_event
3925 u8 host_address[16];
3926 u8 router_address[16];
3930 /** \brief Add MAP domains
3931 @param client_index - opaque cookie to identify the sender
3932 @param context - sender context, to match reply w/ request
3933 @param ip6_prefix - Rule IPv6 prefix
3934 @param ip4_prefix - Rule IPv4 prefix
3935 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3936 @param ip6_prefix_len - Rule IPv6 prefix length
3937 @param ip4_prefix_len - Rule IPv4 prefix length
3938 @param ea_bits_len - Embedded Address bits length
3939 @param psid_offset - Port Set Identifider (PSID) offset
3940 @param psid_length - PSID length
3941 @param is_translation - MAP-E / MAP-T
3944 define map_add_domain
3953 u8 ip6_src_prefix_len;
3961 /** \brief Reply for MAP domain add
3962 @param context - returned sender context, to match reply w/ request
3963 @param index - MAP domain index
3964 @param retval - return code
3966 define map_add_domain_reply
3973 /** \brief Delete MAP domain
3974 @param client_index - opaque cookie to identify the sender
3975 @param context - sender context, to match reply w/ request
3976 @param index - MAP Domain index
3978 define map_del_domain
3985 /** \brief Reply for MAP domain del
3986 @param context - returned sender context, to match reply w/ request
3987 @param retval - return code
3989 define map_del_domain_reply
3995 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3996 @param client_index - opaque cookie to identify the sender
3997 @param context - sender context, to match reply w/ request
3998 @param index - MAP Domain index
3999 @param is_add - If 1 add rule, if 0 delete rule
4000 @param ip6_dst - MAP CE IPv6 address
4001 @param psid - Rule PSID
4003 define map_add_del_rule
4013 /** \brief Reply for MAP rule add/del
4014 @param context - returned sender context, to match reply w/ request
4015 @param retval - return code
4017 define map_add_del_rule_reply
4023 /** \brief Get list of map domains
4024 @param client_index - opaque cookie to identify the sender
4026 define map_domain_dump
4032 define map_domain_details
4050 define map_rule_dump
4057 define map_rule_details
4064 /** \brief Request for a single block of summary stats
4065 @param client_index - opaque cookie to identify the sender
4066 @param context - sender context, to match reply w/ request
4068 define map_summary_stats
4074 /** \brief Reply for map_summary_stats request
4075 @param context - sender context, to match reply w/ request
4076 @param retval - return code for request
4077 @param total_bindings -
4079 @param total_ip4_fragments -
4080 @param total_security_check -
4082 define map_summary_stats_reply
4089 u64 total_ip4_fragments;
4090 u64 total_security_check[2];
4093 /** \brief cop: enable/disable junk filtration features on an interface
4094 @param client_index - opaque cookie to identify the sender
4095 @param context - sender context, to match reply w/ request
4096 @param sw_if_inded - desired interface
4097 @param enable_disable - 1 => enable, 0 => disable
4100 define cop_interface_enable_disable
4108 /** \brief cop: interface enable/disable junk filtration reply
4109 @param context - returned sender context, to match reply w/ request
4110 @param retval - return code
4113 define cop_interface_enable_disable_reply
4119 /** \brief cop: enable/disable whitelist filtration features on an interface
4120 Note: the supplied fib_id must match in order to remove the feature!
4122 @param client_index - opaque cookie to identify the sender
4123 @param context - sender context, to match reply w/ request
4124 @param sw_if_index - interface handle, physical interfaces only
4125 @param fib_id - fib identifier for the whitelist / blacklist fib
4126 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
4127 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
4128 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
4131 define cop_whitelist_enable_disable
4142 /** \brief cop: interface enable/disable junk filtration reply
4143 @param context - returned sender context, to match reply w/ request
4144 @param retval - return code
4147 define cop_whitelist_enable_disable_reply
4153 /** \brief get_node_graph - get a copy of the vpp node graph
4154 including the current set of graph arcs.
4156 @param client_index - opaque cookie to identify the sender
4157 @param context - sender context, to match reply w/ request
4160 define get_node_graph
4166 /** \brief get_node_graph_reply
4167 @param context - returned sender context, to match reply w/ request
4168 @param retval - return code
4169 @param reply_in_shmem - result from vlib_node_serialize, in shared
4170 memory. Process with vlib_node_unserialize, remember to switch
4171 heaps and free the result.
4174 define get_node_graph_reply
4181 /** \brief Clear interface statistics
4182 @param client_index - opaque cookie to identify the sender
4183 @param context - sender context, to match reply w/ request
4184 @param sw_if_index - index of the interface to clear statistics
4186 define sw_interface_clear_stats
4193 /** \brief Reply to sw_interface_clear_stats
4194 @param context - sender context which was passed in the request
4195 @param retval - return code of the set flags request
4197 define sw_interface_clear_stats_reply
4203 /** \brief IOAM enable : Enable in-band OAM
4204 @param id - profile id
4205 @param seqno - To enable Seqno Processing
4206 @param analyse - Enabling analysis of iOAM at decap node
4207 @param pow_enable - Proof of Work enabled or not flag
4208 @param trace_enable - iOAM Trace enabled or not flag
4222 /** \brief iOAM Trace profile add / del response
4223 @param context - sender context, to match reply w/ request
4224 @param retval - return value for request
4226 define ioam_enable_reply
4232 /** \brief iOAM disable
4233 @param client_index - opaque cookie to identify the sender
4234 @param context - sender context, to match reply w/ request
4235 @param index - MAP Domain index
4244 /** \brief iOAM disable response
4245 @param context - sender context, to match reply w/ request
4246 @param retval - return value for request
4248 define ioam_disable_reply
4254 /** \brief Create host-interface
4255 @param client_index - opaque cookie to identify the sender
4256 @param context - sender context, to match reply w/ request
4257 @param host_if_name - interface name
4258 @param hw_addr - interface MAC
4259 @param use_random_hw_addr - use random generated MAC
4261 define af_packet_create
4266 u8 host_if_name[64];
4268 u8 use_random_hw_addr;
4271 /** \brief Create host-interface response
4272 @param context - sender context, to match reply w/ request
4273 @param retval - return value for request
4275 define af_packet_create_reply
4282 /** \brief Delete host-interface
4283 @param client_index - opaque cookie to identify the sender
4284 @param context - sender context, to match reply w/ request
4285 @param host_if_name - interface name
4287 define af_packet_delete
4292 u8 host_if_name[64];
4295 /** \brief Delete host-interface response
4296 @param context - sender context, to match reply w/ request
4297 @param retval - return value for request
4299 define af_packet_delete_reply
4305 /** \brief Add/del policer
4306 @param client_index - opaque cookie to identify the sender
4307 @param context - sender context, to match reply w/ request
4308 @param is_add - add policer if non-zero, else delete
4309 @param name - policer name
4312 @param cb - Committed Burst
4313 @param eb - Excess or Peak Burst
4314 @param rate_type - rate type
4315 @param round_type - rounding type
4316 @param type - policer algorithm
4317 @param color_aware - 0=color-blind, 1=color-aware
4318 @param conform_action_type - conform action type
4319 @param conform_dscp - DSCP for conform mar-and-transmit action
4320 @param exceed_action_type - exceed action type
4321 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4322 @param violate_action_type - violate action type
4323 @param violate_dscp - DSCP for violate mar-and-transmit action
4325 define policer_add_del
4340 u8 conform_action_type;
4342 u8 exceed_action_type;
4344 u8 violate_action_type;
4348 /** \brief Add/del policer response
4349 @param context - sender context, to match reply w/ request
4350 @param retval - return value for request
4351 @param policer_index - for add, returned index of the new policer
4353 define policer_add_del_reply
4360 /** \brief Get list of policers
4361 @param client_index - opaque cookie to identify the sender
4362 @param context - sender context, to match reply w/ request
4363 @param match_name_valid - if 0 request all policers otherwise use match_name
4364 @param match_name - policer name
4371 u8 match_name_valid;
4375 /** \brief Policer operational state response.
4376 @param context - sender context, to match reply w/ request
4377 @param name - policer name
4380 @param cb - Committed Burst
4381 @param eb - Excess or Peak Burst
4382 @param rate_type - rate type
4383 @param round_type - rounding type
4384 @param type - policer algorithm
4385 @param conform_action_type - conform action type
4386 @param conform_dscp - DSCP for conform mar-and-transmit action
4387 @param exceed_action_type - exceed action type
4388 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4389 @param violate_action_type - violate action type
4390 @param violate_dscp - DSCP for violate mar-and-transmit action
4391 @param single_rate - 1 = single rate policer, 0 = two rate policer
4392 @param color_aware - for hierarchical policing
4393 @param scale - power-of-2 shift amount for lower rates
4394 @param cir_tokens_per_period - number of tokens for each period
4395 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
4396 @param current_limit - current limit
4397 @param current_bucket - current bucket
4398 @param extended_limit - extended limit
4399 @param extended_bucket - extended bucket
4400 @param last_update_time - last update time
4402 define policer_details
4414 u8 conform_action_type;
4416 u8 exceed_action_type;
4418 u8 violate_action_type;
4423 u32 cir_tokens_per_period;
4424 u32 pir_tokens_per_period;
4428 u32 extended_bucket;
4429 u64 last_update_time;
4432 /** \brief Set/unset policer classify interface
4433 @param client_index - opaque cookie to identify the sender
4434 @param context - sender context, to match reply w/ request
4435 @param sw_if_index - interface to set/unset policer classify
4436 @param ip4_table_index - ip4 classify table index (~0 for skip)
4437 @param ip6_table_index - ip6 classify table index (~0 for skip)
4438 @param l2_table_index - l2 classify table index (~0 for skip)
4439 @param is_add - Set if non-zero, else unset
4440 Note: User is recommeneded to use just one valid table_index per call.
4441 (ip4_table_index, ip6_table_index, or l2_table_index)
4443 define policer_classify_set_interface
4448 u32 ip4_table_index;
4449 u32 ip6_table_index;
4454 /** \brief Set/unset policer classify interface response
4455 @param context - sender context, to match reply w/ request
4456 @param retval - return value for request
4458 define policer_classify_set_interface_reply
4464 /** \brief Get list of policer classify interfaces and tables
4465 @param client_index - opaque cookie to identify the sender
4466 @param context - sender context, to match reply w/ request
4467 @param type - classify table type
4469 define policer_classify_dump
4476 /** \brief Policer iclassify operational state response.
4477 @param context - sender context, to match reply w/ request
4478 @param sw_if_index - software interface index
4479 @param table_index - classify table index
4481 define policer_classify_details
4488 /** \brief Create netmap
4489 @param client_index - opaque cookie to identify the sender
4490 @param context - sender context, to match reply w/ request
4491 @param netmap_if_name - interface name
4492 @param hw_addr - interface MAC
4493 @param use_random_hw_addr - use random generated MAC
4494 @param is_pipe - is pipe
4495 @param is_master - 0=slave, 1=master
4497 define netmap_create
4502 u8 netmap_if_name[64];
4504 u8 use_random_hw_addr;
4509 /** \brief Create netmap response
4510 @param context - sender context, to match reply w/ request
4511 @param retval - return value for request
4513 define netmap_create_reply
4519 /** \brief Delete netmap
4520 @param client_index - opaque cookie to identify the sender
4521 @param context - sender context, to match reply w/ request
4522 @param netmap_if_name - interface name
4524 define netmap_delete
4529 u8 netmap_if_name[64];
4532 /** \brief Delete netmap response
4533 @param context - sender context, to match reply w/ request
4534 @param retval - return value for request
4536 define netmap_delete_reply
4542 /** \brief Dump mpls gre tunnel table
4543 @param client_index - opaque cookie to identify the sender
4544 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4546 define mpls_gre_tunnel_dump
4553 /** \brief mpls gre tunnel operational state response
4554 @param tunnel_index - gre tunnel identifier
4555 @param intfc_address - interface ipv4 addr
4556 @param mask_width - interface ipv4 addr mask
4557 @param hw_if_index - interface id
4559 @param tunnel_src - tunnel source ipv4 addr
4560 @param tunnel_dst - tunnel destination ipv4 addr
4561 @param outer_fib_index - gre tunnel identifier
4562 @param encap_index - reference to mpls label table
4563 @param nlabels - number of resolved labels
4564 @param labels - resolved labels
4566 define mpls_gre_tunnel_details
4572 u32 inner_fib_index;
4579 u32 outer_fib_index;
4581 u32 labels[nlabels];
4584 /** \brief Dump mpls eth tunnel table
4585 @param client_index - opaque cookie to identify the sender
4586 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
4588 define mpls_eth_tunnel_dump
4595 /** \brief mpls eth tunnel operational state response
4596 @param tunnel_index - eth tunnel identifier
4597 @param intfc_address - interface ipv4 addr
4598 @param mask_width - interface ipv4 addr mask
4599 @param hw_if_index - interface id
4601 @param tunnel_dst_mac -
4602 @param tx_sw_if_index -
4603 @param encap_index - reference to mpls label table
4604 @param nlabels - number of resolved labels
4605 @param labels - resolved labels
4607 define mpls_eth_tunnel_details
4613 u32 inner_fib_index;
4618 u8 tunnel_dst_mac[6];
4621 u32 labels[nlabels];
4624 /** \brief Dump mpls fib table
4625 @param client_index - opaque cookie to identify the sender
4626 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4628 define mpls_fib_encap_dump
4634 /** \brief mpls fib encap table response
4635 @param fib_index - fib table id
4636 @param dest - destination ipv4 addr
4638 @param entry_index - reference to mpls label table
4639 @param nlabels - number of resolved labels
4640 @param labels - resolved labels
4642 define mpls_fib_encap_details
4651 u32 labels[nlabels];
4654 /** \brief Classify get table IDs request
4655 @param client_index - opaque cookie to identify the sender
4656 @param context - sender context, to match reply w/ request
4658 define classify_table_ids
4664 /** \brief Reply for classify get table IDs request
4665 @param context - sender context which was passed in the request
4666 @param count - number of ids returned in response
4667 @param ids - array of classify table ids
4669 define classify_table_ids_reply
4677 /** \brief Classify table ids by interface index request
4678 @param client_index - opaque cookie to identify the sender
4679 @param context - sender context, to match reply w/ request
4680 @param sw_if_index - index of the interface
4682 define classify_table_by_interface
4689 /** \brief Reply for classify table id by interface index request
4690 @param context - sender context which was passed in the request
4691 @param count - number of ids returned in response
4692 @param sw_if_index - index of the interface
4693 @param l2_table_id - l2 classify table index
4694 @param ip4_table_id - ip4 classify table index
4695 @param ip6_table_id - ip6 classify table index
4697 define classify_table_by_interface_reply
4707 /** \brief Classify table info
4708 @param client_index - opaque cookie to identify the sender
4709 @param context - sender context, to match reply w/ request
4710 @param table_id - classify table index
4712 define classify_table_info
4719 /** \brief Reply for classify table info request
4720 @param context - sender context which was passed in the request
4721 @param count - number of ids returned in response
4722 @param table_id - classify table index
4723 @param nbuckets - number of buckets when adding a table
4724 @param match_n_vectors - number of match vectors
4725 @param skip_n_vectors - number of skip_n_vectors
4726 @param active_sessions - number of sessions (active entries)
4727 @param next_table_index - index of next table
4728 @param miss_next_index - index of miss table
4729 @param mask[] - match mask
4731 define classify_table_info_reply
4737 u32 match_n_vectors;
4739 u32 active_sessions;
4740 u32 next_table_index;
4741 u32 miss_next_index;
4743 u8 mask[mask_length];
4746 /** \brief Classify sessions dump request
4747 @param client_index - opaque cookie to identify the sender
4748 @param context - sender context, to match reply w/ request
4749 @param table_id - classify table index
4751 define classify_session_dump
4758 /** \brief Reply for classify table session dump request
4759 @param context - sender context which was passed in the request
4760 @param count - number of ids returned in response
4761 @param table_id - classify table index
4762 @param hit_next_index - hit_next_index of session
4763 @param opaque_index - for add, opaque_index of session
4764 @param advance - advance value of session
4765 @param match[] - match value for session
4767 define classify_session_details
4776 u8 match[match_length];
4779 /** \brief Configure IPFIX exporter process request
4780 @param client_index - opaque cookie to identify the sender
4781 @param context - sender context, to match reply w/ request
4782 @param collector_address - address of IPFIX collector
4783 @param collector_port - port of IPFIX collector
4784 @param src_address - address of IPFIX exporter
4785 @param vrf_id - VRF / fib table ID
4786 @param path_mtu - Path MTU between exporter and collector
4787 @param template_interval - number of seconds after which to resend template
4788 @param udp_checksum - UDP checksum calculation enable flag
4790 define set_ipfix_exporter
4794 u8 collector_address[16];
4799 u32 template_interval;
4803 /** \brief Reply to IPFIX exporter configure request
4804 @param context - sender context which was passed in the request
4806 define set_ipfix_exporter_reply
4812 /** \brief IPFIX exporter dump request
4813 @param client_index - opaque cookie to identify the sender
4814 @param context - sender context, to match reply w/ request
4816 define ipfix_exporter_dump
4822 /** \brief Reply to IPFIX exporter dump request
4823 @param context - sender context which was passed in the request
4824 @param collector_address - address of IPFIX collector
4825 @param collector_port - port of IPFIX collector
4826 @param src_address - address of IPFIX exporter
4827 @param fib_index - fib table index
4828 @param path_mtu - Path MTU between exporter and collector
4829 @param template_interval - number of seconds after which to resend template
4830 @param udp_checksum - UDP checksum calculation enable flag
4832 define ipfix_exporter_details
4835 u8 collector_address[16];
4840 u32 template_interval;
4844 /** \brief IPFIX classify stream configure request
4845 @param client_index - opaque cookie to identify the sender
4846 @param context - sender context, to match reply w/ request
4847 @param domain_id - domain ID reported in IPFIX messages for classify stream
4848 @param src_port - source port of UDP session for classify stream
4850 define set_ipfix_classify_stream {
4857 /** \brief IPFIX classify stream configure response
4858 @param context - sender context, to match reply w/ request
4859 @param retval - return value for request
4861 define set_ipfix_classify_stream_reply {
4866 /** \brief IPFIX classify stream dump request
4867 @param client_index - opaque cookie to identify the sender
4868 @param context - sender context, to match reply w/ request
4870 define ipfix_classify_stream_dump {
4875 /** \brief Reply to IPFIX classify stream dump request
4876 @param context - sender context, to match reply w/ request
4877 @param domain_id - domain ID reported in IPFIX messages for classify stream
4878 @param src_port - source port of UDP session for classify stream
4880 define ipfix_classify_stream_details {
4886 /** \brief IPFIX add or delete classifier table request
4887 @param client_index - opaque cookie to identify the sender
4888 @param context - sender context, to match reply w/ request
4889 @param table_id - classifier table ID
4890 @param ip_version - version of IP used in the classifier table
4891 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4893 define ipfix_classify_table_add_del {
4898 u8 transport_protocol;
4902 /** \brief IPFIX add classifier table response
4903 @param context - sender context which was passed in the request
4905 define ipfix_classify_table_add_del_reply {
4910 /** \brief IPFIX classify tables dump request
4911 @param client_index - opaque cookie to identify the sender
4912 @param context - sender context, to match reply w/ request
4914 define ipfix_classify_table_dump {
4919 /** \brief Reply to IPFIX classify tables dump request
4920 @param context - sender context, to match reply w/ request
4921 @param table_id - classifier table ID
4922 @param ip_version - version of IP used in the classifier table
4923 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4925 define ipfix_classify_table_details {
4929 u8 transport_protocol;
4932 /** \brief Set/unset flow classify interface
4933 @param client_index - opaque cookie to identify the sender
4934 @param context - sender context, to match reply w/ request
4935 @param sw_if_index - interface to set/unset flow classify
4936 @param ip4_table_index - ip4 classify table index (~0 for skip)
4937 @param ip6_table_index - ip6 classify table index (~0 for skip)
4938 @param l2_table_index - l2 classify table index (~0 for skip)
4939 @param is_add - Set if non-zero, else unset
4940 Note: User is recommeneded to use just one valid table_index per call.
4941 (ip4_table_index, ip6_table_index, or l2_table_index)
4943 define flow_classify_set_interface {
4947 u32 ip4_table_index;
4948 u32 ip6_table_index;
4952 /** \brief Set/unset flow classify interface response
4953 @param context - sender context, to match reply w/ request
4954 @param retval - return value for request
4956 define flow_classify_set_interface_reply {
4961 /** \brief Get list of flow classify interfaces and tables
4962 @param client_index - opaque cookie to identify the sender
4963 @param context - sender context, to match reply w/ request
4964 @param type - classify table type
4966 define flow_classify_dump {
4972 /** \brief Flow classify operational state response.
4973 @param context - sender context, to match reply w/ request
4974 @param sw_if_index - software interface index
4975 @param table_index - classify table index
4977 define flow_classify_details {
4983 /** \brief Enable/Disable span to mirror traffic from one interface to another
4984 @param client_index - opaque cookie to identify the sender
4985 @param context - sender context which was passed in the request
4986 @param sw_if_index_from - interface to be mirorred
4987 @param sw_if_index_to - interface where the traffic is mirrored
4988 @param enable - 1 enable SPAN, 0 SPAN on given interface
4990 define sw_interface_span_enable_disable{
4993 u32 sw_if_index_from;
4998 /** \brief Reply to SPAN enable/disable request
4999 @param context - sender context which was passed in the request
5001 define sw_interface_span_enable_disable_reply {
5006 /** \brief SPAN dump request
5007 @param client_index - opaque cookie to identify the sender
5008 @param context - sender context, to match reply w/ request
5010 define sw_interface_span_dump {
5015 /** \brief Reply to SPAN dump request
5016 @param context - sender context which was passed in the request
5017 @param sw_if_index_from - mirorred interface
5018 @param sw_if_index_to - interface where the traffic is mirrored
5020 define sw_interface_span_details {
5022 u32 sw_if_index_from;
5026 /** \brief Query relative index via node names
5027 @param client_index - opaque cookie to identify the sender
5028 @param context - sender context, to match reply w/ request
5029 @param node_name - name of node to find relative index from
5030 @param next_name - next node from node_name to find relative index of
5032 define get_next_index
5040 /** \brief Reply for get next node index
5041 @param context - sender context which was passed in the request
5042 @param retval - return value
5043 @param next_index - index of the next_node
5045 define get_next_index_reply
5052 /** \brief PacketGenerator create interface request
5053 @param client_index - opaque cookie to identify the sender
5054 @param context - sender context, to match reply w/ request
5055 @param interface_id - interface index
5057 define pg_create_interface
5064 /** \brief PacketGenerator create interface response
5065 @param context - sender context, to match reply w/ request
5066 @param retval - return value for request
5068 define pg_create_interface_reply
5075 /** \brief PacketGenerator capture packets on given interface request
5076 @param client_index - opaque cookie to identify the sender
5077 @param context - sender context, to match reply w/ request
5078 @param interface_id - pg interface index
5079 @param is_enabled - 1 if enabling streams, 0 if disabling
5080 @param count - number of packets to be captured
5081 @param pcap_file - pacp file name to store captured packets
5090 u32 pcap_name_length;
5091 u8 pcap_file_name[pcap_name_length];
5094 /** \brief PacketGenerator capture packets response
5095 @param context - sender context, to match reply w/ request
5096 @param retval - return value for request
5098 define pg_capture_reply
5104 /** \brief Enable / disable packet generator request
5105 @param client_index - opaque cookie to identify the sender
5106 @param context - sender context, to match reply w/ request
5107 @param is_enabled - 1 if enabling streams, 0 if disabling
5108 @param stream - stream name to be enable/disabled, if not specified handle all streams
5110 define pg_enable_disable
5115 u32 stream_name_length;
5116 u8 stream_name[stream_name_length];
5119 /** \brief Reply for enable / disable packet generator
5120 @param context - returned sender context, to match reply w/ request
5121 @param retval - return code
5123 define pg_enable_disable_reply
5129 /** \brief Configure IP source and L4 port-range check
5130 @param client_index - opaque cookie to identify the sender
5131 @param context - sender context, to match reply w/ request
5132 @param is_ip6 - 1 if source address type is IPv6
5133 @param is_add - 1 if add, 0 if delete
5134 @param mask_length - mask length for address entry
5135 @param address - array of address bytes
5136 @param number_of_ranges - length of low_port and high_port arrays (must match)
5137 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
5138 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
5139 @param vrf_id - fib table/vrf id to associate the source and port-range check with
5140 @note To specify a single port set low_port and high_port entry the same
5142 define ip_source_and_port_range_check_add_del
5150 u8 number_of_ranges;
5156 /** \brief Configure IP source and L4 port-range check reply
5157 @param context - returned sender context, to match reply w/ request
5158 @param retval - return code
5160 define ip_source_and_port_range_check_add_del_reply
5166 /** \brief Set interface source and L4 port-range request
5167 @param client_index - opaque cookie to identify the sender
5168 @param context - sender context, to match reply w/ request
5169 @param interface_id - interface index
5170 @param tcp_vrf_id - VRF associated with source and TCP port-range check
5171 @param udp_vrf_id - VRF associated with source and TCP port-range check
5173 define ip_source_and_port_range_check_interface_add_del
5185 /** \brief Set interface source and L4 port-range response
5186 @param context - sender context, to match reply w/ request
5187 @param retval - return value for request
5189 define ip_source_and_port_range_check_interface_add_del_reply
5195 /** \brief Add / del ipsec gre tunnel request
5196 @param client_index - opaque cookie to identify the sender
5197 @param context - sender context, to match reply w/ request
5198 @param local_sa_id - local SA id
5199 @param remote_sa_id - remote SA id
5200 @param is_add - 1 if adding the tunnel, 0 if deleting
5201 @param src_address - tunnel source address
5202 @param dst_address - tunnel destination address
5204 define ipsec_gre_add_del_tunnel {
5214 /** \brief Reply for add / del ipsec gre tunnel request
5215 @param context - returned sender context, to match reply w/ request
5216 @param retval - return code
5217 @param sw_if_index - software index of the new ipsec gre tunnel
5219 define ipsec_gre_add_del_tunnel_reply {
5225 /** \brief Dump ipsec gre tunnel table
5226 @param client_index - opaque cookie to identify the sender
5227 @param context - sender context, to match reply w/ request
5228 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
5230 define ipsec_gre_tunnel_dump {
5236 /** \brief mpls gre tunnel operational state response
5237 @param context - returned sender context, to match reply w/ request
5238 @param sw_if_index - software index of the ipsec gre tunnel
5239 @param local_sa_id - local SA id
5240 @param remote_sa_id - remote SA id
5241 @param src_address - tunnel source address
5242 @param dst_address - tunnel destination address
5244 define ipsec_gre_tunnel_details {
5253 /** \brief Delete sub interface request
5254 @param client_index - opaque cookie to identify the sender
5255 @param context - sender context, to match reply w/ request
5256 @param sw_if_index - sw index of the interface that was created by create_subif
5258 define delete_subif {
5264 /** \brief Delete sub interface response
5265 @param context - sender context, to match reply w/ request
5266 @param retval - return code for the request
5268 define delete_subif_reply {
5273 /** \brief DPDK interface HQoS pipe profile set request
5274 @param client_index - opaque cookie to identify the sender
5275 @param context - sender context, to match reply w/ request
5276 @param sw_if_index - the interface
5277 @param subport - subport ID
5278 @param pipe - pipe ID within its subport
5279 @param profile - pipe profile ID
5281 define sw_interface_set_dpdk_hqos_pipe {
5290 /** \brief DPDK interface HQoS pipe profile set reply
5291 @param context - sender context, to match reply w/ request
5292 @param retval - request return code
5294 define sw_interface_set_dpdk_hqos_pipe_reply {
5299 /** \brief DPDK interface HQoS subport parameters set request
5300 @param client_index - opaque cookie to identify the sender
5301 @param context - sender context, to match reply w/ request
5302 @param sw_if_index - the interface
5303 @param subport - subport ID
5304 @param tb_rate - subport token bucket rate (measured in bytes/second)
5305 @param tb_size - subport token bucket size (measured in credits)
5306 @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
5307 @param tc_period - enforcement period for rates (measured in milliseconds)
5309 define sw_interface_set_dpdk_hqos_subport {
5320 /** \brief DPDK interface HQoS subport parameters set reply
5321 @param context - sender context, to match reply w/ request
5322 @param retval - request return code
5324 define sw_interface_set_dpdk_hqos_subport_reply {
5329 /** \brief DPDK interface HQoS tctbl entry set request
5330 @param client_index - opaque cookie to identify the sender
5331 @param context - sender context, to match reply w/ request
5332 @param sw_if_index - the interface
5333 @param entry - entry index ID
5334 @param tc - traffic class (0 .. 3)
5335 @param queue - traffic class queue (0 .. 3)
5337 define sw_interface_set_dpdk_hqos_tctbl {
5346 /** \brief DPDK interface HQoS tctbl entry set reply
5347 @param context - sender context, to match reply w/ request
5348 @param retval - request return code
5350 define sw_interface_set_dpdk_hqos_tctbl_reply {
5355 /** \brief L2 interface pbb tag rewrite configure request
5356 @param client_index - opaque cookie to identify the sender
5357 @param context - sender context, to match reply w/ request
5358 @param sw_if_index - interface the operation is applied to
5359 @param vtr_op - Choose from l2_vtr_op_t enum values
5360 @param inner_tag - needed for translate_qinq vtr op only
5361 @param outer_tag - needed for translate_qinq vtr op only
5362 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
5363 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
5364 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
5365 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
5367 define l2_interface_pbb_tag_rewrite
5380 /** \brief L2 interface pbb tag rewrite response
5381 @param context - sender context, to match reply w/ request
5382 @param retval - return code for the request
5384 define l2_interface_pbb_tag_rewrite_reply
5390 /** \brief Punt traffic to the host
5391 @param client_index - opaque cookie to identify the sender
5392 @param context - sender context, to match reply w/ request
5393 @param is_add - add punt if non-zero, else delete
5394 @param ipv - L3 protocol 4 - IPv4, 6 - IPv6, ~0 - All
5395 @param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
5396 @param l4_port - TCP/UDP port to be punted
5407 /** \brief Reply to the punt request
5408 @param context - sender context which was passed in the request
5409 @param retval - return code of punt request
5417 /** \brief Dump ipsec policy database data
5418 @param client_index - opaque cookie to identify the sender
5419 @param context - sender context, to match reply w/ request
5420 @param spd_id - SPD instance id
5421 @param sa_id - SA id, optional, set to ~0 to see all policies in SPD
5423 define ipsec_spd_dump {
5430 /** \brief IPsec policy database response
5431 @param context - sender context which was passed in the request
5432 @param spd_id - SPD instance id
5433 @param priority - numeric value to control policy evaluation order
5434 @param is_outbound - [1|0] to indicate if direction is [out|in]bound
5435 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
5436 @param local_start_addr - first address in local traffic selector range
5437 @param local_stop_addr - last address in local traffic selector range
5438 @param local_start_port - first port in local traffic selector range
5439 @param local_stop_port - last port in local traffic selector range
5440 @param remote_start_addr - first address in remote traffic selector range
5441 @param remote_stop_addr - last address in remote traffic selector range
5442 @param remote_start_port - first port in remote traffic selector range
5443 @param remote_stop_port - last port in remote traffic selector range
5444 @param protocol - traffic selector protocol
5445 @param policy - policy action
5446 @param sa_id - SA id
5447 @param bytes - byte count of packets matching this policy
5448 @param packets - count of packets matching this policy
5451 define ipsec_spd_details {
5457 u8 local_start_addr[16];
5458 u8 local_stop_addr[16];
5459 u16 local_start_port;
5460 u16 local_stop_port;
5461 u8 remote_start_addr[16];
5462 u8 remote_stop_addr[16];
5463 u16 remote_start_port;
5464 u16 remote_stop_port;