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
434 /** \brief mpls FIB table response
435 @param table_id - MPLS fib table id
436 @param s_bit - End-of-stack bit
437 @param label - MPLS label value
439 define mpls_fib_details
447 /** \brief Bind/Unbind an MPLS local label to an IP prefix. i.e. create
448 a per-prefix label entry.
449 @param client_index - opaque cookie to identify the sender
450 @param context - sender context, to match reply w/ request
451 @param mb_mpls_table_id - The MPLS table-id the MPLS entry will be added in
452 @param mb_label - The MPLS label value to bind
453 @param mb_ip_table_id - The IP table-id of the IP prefix to bind to.
454 @param mb_create_table_if_needed - Create either/both tables if required.
455 @param mb_is_bind - Bind or unbind
456 @param mb_is_ip4 - The prefix to bind to is IPv4
457 @param mb_address_length - Length of IP prefix
458 @param mb_address[16] - IP prefix/
460 define mpls_ip_bind_unbind
464 u32 mb_mpls_table_id;
467 u8 mb_create_table_if_needed;
470 u8 mb_address_length;
474 /** \brief Reply for MPLS IP bind/unbind request
475 @param context - returned sender context, to match reply w/ request
476 @param retval - return code
478 define mpls_ip_bind_unbind_reply
484 /** \brief Add / del route request
485 @param client_index - opaque cookie to identify the sender
486 @param context - sender context, to match reply w/ request
487 @param sw_if_index - software index of the new vlan's parent interface
488 @param vrf_id - fib table /vrf associated with the route
489 @param lookup_in_vrf -
490 @param resolve_attempts -
491 @param classify_table_index -
492 @param create_vrf_if_needed -
493 @param resolve_if_needed -
494 @param is_add - 1 if adding the route, 0 if deleting
496 @param is_ipv6 - 0 if an ip4 route, else ip6
499 @param is_multipath - Set to 1 if this is a multipath route, else 0
500 @param not_last - Is last or not last msg in group of multiple add/del msgs
501 @param next_hop_weight -
502 @param dst_address_length -
503 @param dst_address[16] -
504 @param next_hop_address[16] -
506 define ip_add_del_route
510 u32 next_hop_sw_if_index;
512 u32 resolve_attempts;
513 u32 classify_table_index;
514 u32 next_hop_out_label;
515 u32 next_hop_table_id;
516 u8 create_vrf_if_needed;
517 u8 resolve_if_needed;
525 u8 is_resolve_attached;
526 /* Is last/not-last message in group of multiple add/del messages. */
529 u8 dst_address_length;
531 u8 next_hop_address[16];
534 /** \brief Reply for add / del route request
535 @param context - returned sender context, to match reply w/ request
536 @param retval - return code
538 define ip_add_del_route_reply
544 /** \brief Add / del MPLS encapsulation request
545 @param client_index - opaque cookie to identify the sender
546 @param context - sender context, to match reply w/ request
547 @param vrf_id - vrf id
548 @param dst_address[4] -
549 @param is_add - 1 if adding the encap, 0 if deleting
550 @param nlabels - number of labels
551 @param labels - array of labels
553 define mpls_add_del_encap
559 /* 1 = add, 0 = delete */
565 /** \brief Reply for add / del encapsulation request
566 @param context - returned sender context, to match reply w/ request
567 @param retval - return code
569 define mpls_add_del_encap_reply
575 /** \brief Proxy ARP add / del request
576 @param client_index - opaque cookie to identify the sender
577 @param context - sender context, to match reply w/ request
578 @param vrf_id - VRF / Fib table ID
579 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
580 @param low_address[4] - Low address of the Proxy ARP range
581 @param hi_address[4] - High address of the Proxy ARP range
583 define proxy_arp_add_del
593 /** \brief Reply for proxy arp add / del request
594 @param context - returned sender context, to match reply w/ request
595 @param retval - return code
597 define proxy_arp_add_del_reply
603 /** \brief Proxy ARP add / del request
604 @param client_index - opaque cookie to identify the sender
605 @param context - sender context, to match reply w/ request
606 @param sw_if_index - Which interface to enable / disable Proxy Arp on
607 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
609 define proxy_arp_intfc_enable_disable
614 /* 1 = on, 0 = off */
618 /** \brief Reply for Proxy ARP interface enable / disable request
619 @param context - returned sender context, to match reply w/ request
620 @param retval - return code
622 define proxy_arp_intfc_enable_disable_reply
628 /** \brief IP neighbor add / del request
629 @param client_index - opaque cookie to identify the sender
630 @param context - sender context, to match reply w/ request
631 @param vrf_id - vrf_id, only for IP4
632 @param sw_if_index - interface used to reach neighbor
633 @param is_add - 1 to add neighbor, 0 to delete
634 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
636 @param mac_address - l2 address of the neighbor
637 @param dst_address - ip4 or ip6 address of the neighbor
639 define ip_neighbor_add_del
643 u32 vrf_id; /* only makes sense for ip4 */
645 /* 1 = add, 0 = delete */
653 /** \brief Reply for IP Neighbor add / delete request
654 @param context - returned sender context, to match reply w/ request
655 @param retval - return code
657 define ip_neighbor_add_del_reply
663 /** \brief Reset VRF (remove all routes etc) request
664 @param client_index - opaque cookie to identify the sender
665 @param context - sender context, to match reply w/ request
666 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
667 @param vrf_id - ID of th FIB table / VRF to reset
677 /** \brief Reply for Reset VRF request
678 @param context - returned sender context, to match reply w/ request
679 @param retval - return code
681 define reset_vrf_reply
687 /** \brief Is Address Reachable request - DISABLED
688 @param client_index - opaque cookie to identify the sender
689 @param context - sender context, to match reply w/ request
690 @param next_hop_sw_if_index - index of interface used to get to next hop
691 @param is_ipv6 - 1 for IPv6, 0 for IPv4
692 @param is_error - address not found or does not match intf
693 @param address[] - Address in question
695 define is_address_reachable
697 u32 client_index; /* (api_main_t *) am->my_client_index */
699 u32 next_hop_sw_if_index;
700 u8 is_known; /* on reply, this is the answer */
702 u8 is_error; /* address not found or does not match intf */
706 /** \brief Want Stats, register for stats updates
707 @param client_index - opaque cookie to identify the sender
708 @param context - sender context, to match reply w/ request
709 @param enable_disable - 1 = enable stats, 0 = disable
710 @param pid - pid of process requesting stats updates
720 /** \brief Reply for Want Stats request
721 @param context - returned sender context, to match reply w/ request
722 @param retval - return code
724 define want_stats_reply
730 /** \brief Want stats counters structure
731 @param vnet_counter_type- such as ip4, ip6, punts, etc
732 @param is_combined - rx & tx total (all types) counts
733 @param first_sw_if_index - first sw index in block of index, counts
734 @param count - number of interfaces this stats block includes counters for
735 @param data - contiguous block of vlib_counter_t structures
737 define vnet_interface_counters
739 /* enums - plural - in vnet/interface.h */
740 u8 vnet_counter_type;
742 u32 first_sw_if_index;
747 typeonly manual_print manual_endian define ip4_fib_counter
755 manual_print manual_endian define vnet_ip4_fib_counters
759 vl_api_ip4_fib_counter_t c[count];
762 typeonly manual_print manual_endian define ip6_fib_counter
770 manual_print manual_endian define vnet_ip6_fib_counters
774 vl_api_ip6_fib_counter_t c[count];
777 /** \brief Request for a single block of summary stats
778 @param client_index - opaque cookie to identify the sender
779 @param context - sender context, to match reply w/ request
781 define vnet_get_summary_stats
787 /** \brief Reply for vnet_get_summary_stats request
788 @param context - sender context, to match reply w/ request
789 @param retval - return code for request
794 define vnet_summary_stats_reply
803 /** \brief OAM event structure
804 @param dst_address[] -
813 /** \brief Want OAM events request
814 @param client_index - opaque cookie to identify the sender
815 @param context - sender context, to match reply w/ request
816 @param enable_disable- enable if non-zero, else disable
817 @param pid - pid of the requesting process
819 define want_oam_events
827 /** \brief Want OAM events response
828 @param context - sender context, to match reply w/ request
829 @param retval - return code for the want oam stats request
831 define want_oam_events_reply
837 /** \brief OAM add / del target request
838 @param client_index - opaque cookie to identify the sender
839 @param context - sender context, to match reply w/ request
840 @param vrf_id - vrf_id of the target
841 @param src_address[] - source address to use for the updates
842 @param dst_address[] - destination address of the target
843 @param is_add - add target if non-zero, else delete
855 /** \brief OAM add / del target response
856 @param context - sender context, to match reply w/ request
857 @param retval - return code of the request
859 define oam_add_del_reply
865 /** \brief Reset fib table request
866 @param client_index - opaque cookie to identify the sender
867 @param context - sender context, to match reply w/ request
868 @param vrf_id - vrf/table id of the fib table to reset
869 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
879 /** \brief Reset fib response
880 @param context - sender context, to match reply w/ request
881 @param retval - return code for the reset bfib request
883 define reset_fib_reply
889 /** \brief DHCP Proxy config add / del request
890 @param client_index - opaque cookie to identify the sender
891 @param context - sender context, to match reply w/ request
892 @param vrf_id - vrf id
893 @param if_ipv6 - ipv6 if non-zero, else ipv4
894 @param is_add - add the config if non-zero, else delete
895 @param insert_circuit_id - option82 suboption 1 fib number
896 @param dhcp_server[] - server address
897 @param dhcp_src_address[] - <fix this, need details>
899 define dhcp_proxy_config
906 u8 insert_circuit_id;
908 u8 dhcp_src_address[16];
911 /** \brief DHCP Proxy config response
912 @param context - sender context, to match reply w/ request
913 @param retval - return code for the request
915 define dhcp_proxy_config_reply
921 /** \brief DHCP Proxy set / unset vss request
922 @param client_index - opaque cookie to identify the sender
923 @param context - sender context, to match reply w/ request
924 @param tbl_id - table id
925 @param oui - first part of vpn id
926 @param fib_id - second part of vpn id
927 @param is_ipv6 - ip6 if non-zero, else ip4
928 @param is_add - set vss if non-zero, else delete
930 define dhcp_proxy_set_vss
941 /** \brief DHCP proxy set / unset vss response
942 @param context - sender context, to match reply w/ request
943 @param retval - return code for the request
945 define dhcp_proxy_set_vss_reply
951 /** \brief Set the ip flow hash config for a fib request
952 @param client_index - opaque cookie to identify the sender
953 @param context - sender context, to match reply w/ request
954 @param vrf_id - vrf/fib id
955 @param is_ipv6 - if non-zero the fib is ip6, else ip4
956 @param src - if non-zero include src in flow hash
957 @param dst - if non-zero include dst in flow hash
958 @param sport - if non-zero include sport in flow hash
959 @param dport - if non-zero include dport in flow hash
960 @param proto -if non-zero include proto in flow hash
961 @param reverse - if non-zero include reverse in flow hash
963 define set_ip_flow_hash
977 /** \brief Set the ip flow hash config for a fib response
978 @param context - sender context, to match reply w/ request
979 @param retval - return code for the request
981 define set_ip_flow_hash_reply
987 /** \brief IPv6 router advertisement config request
988 @param client_index - opaque cookie to identify the sender
989 @param context - sender context, to match reply w/ request
994 @param send_unicast -
997 @param default_router -
998 @param max_interval -
999 @param min_interval -
1001 @param initial_count -
1002 @param initial_interval -
1004 define sw_interface_ip6nd_ra_config
1021 u32 initial_interval;
1024 /** \brief IPv6 router advertisement config response
1025 @param context - sender context, to match reply w/ request
1026 @param retval - return code for the request
1028 define sw_interface_ip6nd_ra_config_reply
1034 /** \brief IPv6 router advertisement prefix config request
1035 @param client_index - opaque cookie to identify the sender
1036 @param context - sender context, to match reply w/ request
1037 @param sw_if_index -
1039 @param address_length -
1040 @param use_default -
1041 @param no_advertise -
1043 @param no_autoconfig -
1046 @param val_lifetime -
1047 @param pref_lifetime -
1049 define sw_interface_ip6nd_ra_prefix
1066 /** \brief IPv6 router advertisement prefix config response
1067 @param context - sender context, to match reply w/ request
1068 @param retval - return code for the request
1070 define sw_interface_ip6nd_ra_prefix_reply
1076 /** \brief IPv6 interface enable / disable request
1077 @param client_index - opaque cookie to identify the sender
1078 @param context - sender context, to match reply w/ request
1079 @param sw_if_index - interface used to reach neighbor
1080 @param enable - if non-zero enable ip6 on interface, else disable
1082 define sw_interface_ip6_enable_disable
1087 u8 enable; /* set to true if enable */
1090 /** \brief IPv6 interface enable / disable response
1091 @param context - sender context, to match reply w/ request
1092 @param retval - return code for the request
1094 define sw_interface_ip6_enable_disable_reply
1100 /** \brief IPv6 set link local address on interface request
1101 @param client_index - opaque cookie to identify the sender
1102 @param context - sender context, to match reply w/ request
1103 @param sw_if_index - interface to set link local on
1104 @param address[] - the new link local address
1105 @param address_length - link local address length
1107 define sw_interface_ip6_set_link_local_address
1116 /** \brief IPv6 set link local address on interface response
1117 @param context - sender context, to match reply w/ request
1118 @param retval - error code for the request
1120 define sw_interface_ip6_set_link_local_address_reply
1126 /** \brief Set unnumbered interface add / del request
1127 @param client_index - opaque cookie to identify the sender
1128 @param context - sender context, to match reply w/ request
1129 @param sw_if_index - interface with an IP address
1130 @param unnumbered_sw_if_index - interface which will use the address
1131 @param is_add - if non-zero set the association, else unset it
1133 define sw_interface_set_unnumbered
1137 u32 sw_if_index; /* use this intfc address */
1138 u32 unnumbered_sw_if_index; /* on this interface */
1142 /** \brief Set unnumbered interface add / del response
1143 @param context - sender context, to match reply w/ request
1144 @param retval - return code for the request
1146 define sw_interface_set_unnumbered_reply
1152 /** \brief Create loopback interface request
1153 @param client_index - opaque cookie to identify the sender
1154 @param context - sender context, to match reply w/ request
1155 @param mac_address - mac addr to assign to the interface if none-zero
1157 define create_loopback
1164 /** \brief Create loopback interface response
1165 @param context - sender context, to match reply w/ request
1166 @param sw_if_index - sw index of the interface that was created
1167 @param retval - return code for the request
1169 define create_loopback_reply
1176 /** \brief Delete loopback interface request
1177 @param client_index - opaque cookie to identify the sender
1178 @param context - sender context, to match reply w/ request
1179 @param sw_if_index - sw index of the interface that was created
1181 define delete_loopback
1188 /** \brief Delete loopback interface response
1189 @param context - sender context, to match reply w/ request
1190 @param retval - return code for the request
1192 define delete_loopback_reply
1198 /** \brief Control ping from client to api server request
1199 @param client_index - opaque cookie to identify the sender
1200 @param context - sender context, to match reply w/ request
1208 /** \brief Control ping from the client to the server response
1209 @param client_index - opaque cookie to identify the sender
1210 @param context - sender context, to match reply w/ request
1211 @param retval - return code for the request
1212 @param vpe_pid - the pid of the vpe, returned by the server
1214 define control_ping_reply
1222 /** \brief Process a vpe parser cli string request
1223 @param client_index - opaque cookie to identify the sender
1224 @param context - sender context, to match reply w/ request
1225 @param cmd_in_shmem - pointer to cli command string
1241 /** \brief vpe parser cli string response
1242 @param context - sender context, to match reply w/ request
1243 @param retval - return code for request
1244 @param reply_in_shmem - Reply string from cli processing if any
1252 define cli_inband_reply
1260 /** \brief Set max allowed ARP or ip6 neighbor entries request
1261 @param client_index - opaque cookie to identify the sender
1262 @param context - sender context, to match reply w/ request
1263 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1264 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1266 define set_arp_neighbor_limit
1271 u32 arp_neighbor_limit;
1274 /** \brief Set max allowed ARP or ip6 neighbor entries response
1275 @param context - sender context, to match reply w/ request
1276 @param retval - return code for request
1278 define set_arp_neighbor_limit_reply
1284 /** \brief L2 interface patch add / del request
1285 @param client_index - opaque cookie to identify the sender
1286 @param context - sender context, to match reply w/ request
1287 @param rx_sw_if_index - receive side interface
1288 @param tx_sw_if_index - transmit side interface
1289 @param is_add - if non-zero set up the interface patch, else remove it
1291 define l2_patch_add_del
1300 /** \brief L2 interface patch add / del response
1301 @param context - sender context, to match reply w/ request
1302 @param retval - return code for the request
1304 define l2_patch_add_del_reply
1310 /** \brief IPv6 segment routing tunnel add / del request
1311 @param client_index - opaque cookie to identify the sender
1312 @param context - sender context, to match reply w/ request
1313 @param is_add - add the tunnel if non-zero, else delete it
1314 @param name[] - tunnel name (len. 64)
1315 @param src_address[] -
1316 @param dst_address[] -
1317 @param dst_mask_width -
1318 @param inner_vrf_id -
1319 @param outer_vrf_id -
1320 @param flags_net_byte_order -
1323 @param segs_and_tags[] -
1324 @param policy_name[] - name of policy to associate this tunnel to (len. 64)
1326 define sr_tunnel_add_del
1337 u16 flags_net_byte_order;
1340 u8 segs_and_tags[0];
1344 /** \brief IPv6 segment routing tunnel add / del response
1345 @param context - sender context, to match reply w/ request
1346 @param retval - return value for request
1348 define sr_tunnel_add_del_reply
1354 /** \brief IPv6 segment routing policy add / del request
1355 @param client_index - opaque cookie to identify the sender
1356 @param context - sender context, to match reply w/ request
1357 @param is_add - add the tunnel if non-zero, else delete it
1358 @param name[] - policy name (len. 64)
1359 @param tunnel_names[] -
1361 define sr_policy_add_del
1370 /** \brief IPv6 segment routing policy add / del response
1371 @param context - sender context, to match reply w/ request
1372 @param retval - return value for request
1374 define sr_policy_add_del_reply
1380 /** \brief IPv6 segment routing multicast map to policy add / del request
1381 @param client_index - opaque cookie to identify the sender
1382 @param context - sender context, to match reply w/ request
1383 @param is_add - add the tunnel if non-zero, else delete it
1384 @param multicast_address[] - IP6 multicast address
1385 @param policy_name[] = policy name (len.64)
1387 define sr_multicast_map_add_del
1392 u8 multicast_address[16];
1396 /** \brief IPv6 segment routing multicast map to policy add / del response
1397 @param context - sender context, to match reply w/ request
1398 @param retval - return value for request
1400 define sr_multicast_map_add_del_reply
1406 /** \brief Interface set vpath request
1407 @param client_index - opaque cookie to identify the sender
1408 @param context - sender context, to match reply w/ request
1409 @param sw_if_index - interface used to reach neighbor
1410 @param enable - if non-zero enable, else disable
1412 define sw_interface_set_vpath
1420 /** \brief Interface set vpath response
1421 @param context - sender context, to match reply w/ request
1422 @param retval - return code for the request
1424 define sw_interface_set_vpath_reply
1430 /** \brief MPLS Ethernet add / del tunnel request
1431 @param client_index - opaque cookie to identify the sender
1432 @param context - sender context, to match reply w/ request
1433 @param vrf_id - vrf_id, only for IP4
1434 @param sw_if_index - interface used to reach neighbor
1435 @param is_add - add if set, tunnel delete if 0
1436 @param dst_mac_address -
1437 @param adj_address -
1438 @param adj_address_length -
1440 define mpls_ethernet_add_del_tunnel
1448 u8 dst_mac_address[6];
1450 u8 adj_address_length;
1453 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1454 @param context - sender context, to match reply w/ request
1455 @param retval - return code for the request
1457 define mpls_ethernet_add_del_tunnel_reply
1461 u32 tunnel_sw_if_index;
1463 /** \brief MPLS Ethernet add/ del tunnel 2
1464 @param client_index - opaque cookie to identify the sender
1465 @param context - sender context, to match reply w/ request
1466 @param inner_vrf_id -
1467 @param outer_vrf_id -
1468 @param resolve_attempts -
1469 @param resolve_opaque -
1470 @param resolve_if_needed -
1472 @param adj_address -
1473 @param adj_address_length -
1474 @param next_hop_ip4_address_in_outer_vrf -
1476 define mpls_ethernet_add_del_tunnel_2
1482 u32 resolve_attempts;
1483 u32 resolve_opaque; /* no need to set this */
1484 u8 resolve_if_needed;
1488 u8 adj_address_length;
1489 u8 next_hop_ip4_address_in_outer_vrf[4];
1492 /** \brief MPLS Ethernet add/ del tunnel 2
1493 @param context - sender context, to match reply w/ request
1494 @param retval - return code for add /del request
1496 define mpls_ethernet_add_del_tunnel_2_reply
1502 /** \brief Set L2 XConnect between two interfaces request
1503 @param client_index - opaque cookie to identify the sender
1504 @param context - sender context, to match reply w/ request
1505 @param rx_sw_if_index - Receive interface index
1506 @param tx_sw_if_index - Transmit interface index
1507 @param enable - enable xconnect if not 0, else set to L3 mode
1509 define sw_interface_set_l2_xconnect
1518 /** \brief Set L2 XConnect response
1519 @param context - sender context, to match reply w/ request
1520 @param retval - L2 XConnect request return code
1522 define sw_interface_set_l2_xconnect_reply
1528 /** \brief Interface bridge mode request
1529 @param client_index - opaque cookie to identify the sender
1530 @param context - sender context, to match reply w/ request
1531 @param rx_sw_if_index - the interface
1532 @param bd_id - bridge domain id
1533 @param bvi - Setup interface as a bvi, bridge mode only
1534 @param shg - Shared horizon group, for bridge mode only
1535 @param enable - Enable beige mode if not 0, else set to L3 mode
1537 define sw_interface_set_l2_bridge
1548 /** \brief Interface bridge mode response
1549 @param context - sender context, to match reply w/ request
1550 @param retval - Bridge mode request return code
1552 define sw_interface_set_l2_bridge_reply
1558 /** \brief L2 FIB add entry request
1559 @param client_index - opaque cookie to identify the sender
1560 @param context - sender context, to match reply w/ request
1561 @param mac - the entry's mac address
1562 @param bd_id - the entry's bridge domain id
1563 @param sw_if_index - the interface
1564 @param is_add - If non zero add the entry, else delete it
1568 define l2fib_add_del
1581 /** \brief L2 FIB add entry response
1582 @param context - sender context, to match reply w/ request
1583 @param retval - return code for the add l2fib entry request
1585 define l2fib_add_del_reply
1591 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1592 @param client_index - opaque cookie to identify the sender
1593 @param context - sender context, to match reply w/ request
1594 @param sw_if_index - interface
1595 @param is_set - if non-zero, set the bits, else clear them
1596 @param feature_bitmap - non-zero bits to set or clear
1607 /** \brief Set L2 bits response
1608 @param context - sender context, to match reply w/ request
1609 @param retval - return code for the set l2 bits request
1611 define l2_flags_reply
1615 u32 resulting_feature_bitmap;
1618 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1619 L2_UU_FLOOD, or L2_ARP_TERM) request
1620 @param client_index - opaque cookie to identify the sender
1621 @param context - sender context, to match reply w/ request
1622 @param bd_id - the bridge domain to set the flags for
1623 @param is_set - if non-zero, set the flags, else clear them
1624 @param feature_bitmap - bits that are non-zero to set or clear
1635 /** \brief Set bridge flags response
1636 @param context - sender context, to match reply w/ request
1637 @param retval - return code for the set bridge flags request
1638 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1640 define bridge_flags_reply
1644 u32 resulting_feature_bitmap;
1647 /** \brief Set bridge domain ip to mac entry request
1648 @param client_index - opaque cookie to identify the sender
1649 @param context - sender context, to match reply w/ request
1650 @param bd_id - the bridge domain to set the flags for
1651 @param is_add - if non-zero, add the entry, else clear it
1652 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1653 @param mac_address - MAC address
1656 define bd_ip_mac_add_del
1667 /** \brief Set bridge domain ip to mac entry response
1668 @param context - sender context, to match reply w/ request
1669 @param retval - return code for the set bridge flags request
1671 define bd_ip_mac_add_del_reply
1677 /** \brief Add/Delete classification table request
1678 @param client_index - opaque cookie to identify the sender
1679 @param context - sender context, to match reply w/ request
1680 @param is_add- if non-zero add the table, else delete it
1681 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1682 @param nbuckets - number of buckets when adding a table
1683 @param memory_size - memory size when adding a table
1684 @param match_n_vectors - number of match vectors
1685 @param next_table_index - index of next table
1686 @param miss_next_index - index of miss table
1687 @param mask[] - match mask
1689 define classify_add_del_table
1698 u32 match_n_vectors;
1699 u32 next_table_index;
1700 u32 miss_next_index;
1704 /** \brief Add/Delete classification table response
1705 @param context - sender context, to match reply w/ request
1706 @param retval - return code for the table add/del requst
1707 @param new_table_index - for add, returned index of the new table
1708 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1709 @param match_n_vectors -for add, returned value of match_n_vectors in table
1711 define classify_add_del_table_reply
1715 u32 new_table_index;
1717 u32 match_n_vectors;
1720 /** \brief Classify add / del session request
1721 @param client_index - opaque cookie to identify the sender
1722 @param context - sender context, to match reply w/ request
1723 @param is_add - add session if non-zero, else delete
1724 @param table_index - index of the table to add/del the session, required
1725 @param hit_next_index - for add, hit_next_index of new session, required
1726 @param opaque_index - for add, opaque_index of new session
1727 @param advance -for add, advance value for session
1728 @param match[] - for add, match value for session, required
1730 define classify_add_del_session
1742 /** \brief Classify add / del session response
1743 @param context - sender context, to match reply w/ request
1744 @param retval - return code for the add/del session request
1746 define classify_add_del_session_reply
1752 /** \brief Set/unset the classification table for an interface request
1753 @param client_index - opaque cookie to identify the sender
1754 @param context - sender context, to match reply w/ request
1755 @param is_ipv6 - ipv6 if non-zero, else ipv4
1756 @param sw_if_index - interface to associate with the table
1757 @param table_index - index of the table, if ~0 unset the table
1759 define classify_set_interface_ip_table
1765 u32 table_index; /* ~0 => off */
1768 /** \brief Set/unset interface classification table response
1769 @param context - sender context, to match reply w/ request
1770 @param retval - return code
1772 define classify_set_interface_ip_table_reply
1778 /** \brief Set/unset l2 classification tables for an interface request
1779 @param client_index - opaque cookie to identify the sender
1780 @param context - sender context, to match reply w/ request
1781 @param sw_if_index - interface to set/unset tables for
1782 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1783 @param ip6_table_index - ip6 index
1784 @param other_table_index - other index
1786 define classify_set_interface_l2_tables
1792 u32 ip4_table_index;
1793 u32 ip6_table_index;
1794 u32 other_table_index;
1798 /** \brief Set/unset l2 classification tables for an interface response
1799 @param context - sender context, to match reply w/ request
1800 @param retval - return code for the request
1802 define classify_set_interface_l2_tables_reply
1808 /** \brief Get node index using name request
1809 @param client_index - opaque cookie to identify the sender
1810 @param context - sender context, to match reply w/ request
1811 @param node_name[] - name of the node
1813 define get_node_index
1820 /** \brief Get node index using name request
1821 @param context - sender context, to match reply w/ request
1822 @param retval - return code for the request
1823 @param node_index - index of the desired node if found, else ~0
1825 define get_node_index_reply
1832 /** \brief Set the next node for a given node request
1833 @param client_index - opaque cookie to identify the sender
1834 @param context - sender context, to match reply w/ request
1835 @param node_name[] - node to add the next node to
1836 @param next_name[] - node to add as the next node
1838 define add_node_next
1846 /** \brief IP Set the next node for a given node response
1847 @param context - sender context, to match reply w/ request
1848 @param retval - return code for the add next node request
1849 @param next_index - the index of the next node if success, else ~0
1851 define add_node_next_reply
1858 /** \brief DHCP Proxy config 2 add / del request
1859 @param client_index - opaque cookie to identify the sender
1860 @param context - sender context, to match reply w/ request
1861 @param rx_vrf_id - receive vrf id
1862 @param server_vrf_id - server vrf id
1863 @param if_ipv6 - ipv6 if non-zero, else ipv4
1864 @param is_add - add the config if non-zero, else delete
1865 @param insert_circuit_id - option82 suboption 1 fib number
1866 @param dhcp_server[] - server address
1867 @param dhcp_src_address[] - <fix this, need details>
1869 define dhcp_proxy_config_2
1877 u8 insert_circuit_id;
1879 u8 dhcp_src_address[16];
1882 /** \brief DHCP Proxy config 2 add / del response
1883 @param context - sender context, to match reply w/ request
1884 @param retval - return code for request
1886 define dhcp_proxy_config_2_reply
1892 /** \brief l2tpv3 tunnel interface create request
1893 @param client_index - opaque cookie to identify the sender
1894 @param context - sender context, to match reply w/ request
1895 @param client_address - remote client tunnel ip address
1896 @param client_address - local tunnel ip address
1897 @param is_ipv6 - ipv6 if non-zero, else ipv4
1898 @param local_session_id - local tunnel session id
1899 @param remote_session_id - remote tunnel session id
1900 @param local_cookie - local tunnel cookie
1901 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1902 @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
1904 define l2tpv3_create_tunnel
1908 u8 client_address[16];
1911 u32 local_session_id;
1912 u32 remote_session_id;
1915 u8 l2_sublayer_present;
1919 /** \brief l2tpv3 tunnel interface create response
1920 @param context - sender context, to match reply w/ request
1921 @param retval - return code for the request
1922 @param sw_if_index - index of the new tunnel interface
1924 define l2tpv3_create_tunnel_reply
1931 define l2tpv3_set_tunnel_cookies
1936 u64 new_local_cookie;
1937 u64 new_remote_cookie;
1940 /** \brief L2TP tunnel set cookies response
1941 @param context - sender context, to match reply w/ request
1942 @param retval - return code for the request
1944 define l2tpv3_set_tunnel_cookies_reply
1950 define sw_if_l2tpv3_tunnel_details
1954 u8 interface_name[64];
1955 u8 client_address[16];
1957 u32 local_session_id;
1958 u32 remote_session_id;
1959 u64 local_cookie[2];
1961 u8 l2_sublayer_present;
1964 define sw_if_l2tpv3_tunnel_dump
1970 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1971 @param client_index - opaque cookie to identify the sender
1972 @param context - sender context, to match reply w/ request
1974 define l2_fib_clear_table
1980 /** \brief L2 fib clear table response
1981 @param context - sender context, to match reply w/ request
1982 @param retval - return code for the request
1984 define l2_fib_clear_table_reply
1990 /** \brief L2 interface ethernet flow point filtering enable/disable request
1991 @param client_index - opaque cookie to identify the sender
1992 @param context - sender context, to match reply w/ request
1993 @param sw_if_index - interface to enable/disable filtering on
1994 @param enable_disable - if non-zero enable filtering, else disable
1996 define l2_interface_efp_filter
2004 /** \brief L2 interface ethernet flow point filtering response
2005 @param context - sender context, to match reply w/ request
2006 @param retval - return code for the request
2008 define l2_interface_efp_filter_reply
2014 define l2tpv3_interface_enable_disable
2022 define l2tpv3_interface_enable_disable_reply
2028 define l2tpv3_set_lookup_key
2032 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
2036 define l2tpv3_set_lookup_key_reply
2042 define vxlan_add_del_tunnel
2051 u32 decap_next_index;
2055 define vxlan_add_del_tunnel_reply
2062 define vxlan_tunnel_dump
2069 define vxlan_tunnel_details
2076 u32 decap_next_index;
2081 define gre_add_del_tunnel
2093 define gre_add_del_tunnel_reply
2100 define gre_tunnel_dump
2107 define gre_tunnel_details
2118 /** \brief L2 interface vlan tag rewrite configure request
2119 @param client_index - opaque cookie to identify the sender
2120 @param context - sender context, to match reply w/ request
2121 @param sw_if_index - interface the operation is applied to
2122 @param vtr_op - Choose from l2_vtr_op_t enum values
2123 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
2124 @param tag1 - Needed for any push or translate vtr op
2125 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
2127 define l2_interface_vlan_tag_rewrite
2133 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
2134 u32 tag1; // first pushed tag
2135 u32 tag2; // second pushed tag
2138 /** \brief L2 interface vlan tag rewrite response
2139 @param context - sender context, to match reply w/ request
2140 @param retval - return code for the request
2142 define l2_interface_vlan_tag_rewrite_reply
2148 /** \brief vhost-user interface create request
2149 @param client_index - opaque cookie to identify the sender
2150 @param is_server - our side is socket server
2151 @param sock_filename - unix socket filename, used to speak with frontend
2152 @param use_custom_mac - enable or disable the use of the provided hardware address
2153 @param mac_address - hardware address to use if 'use_custom_mac' is set
2155 define create_vhost_user_if
2160 u8 sock_filename[256];
2162 u32 custom_dev_instance;
2167 /** \brief vhost-user interface create response
2168 @param context - sender context, to match reply w/ request
2169 @param retval - return code for the request
2170 @param sw_if_index - interface the operation is applied to
2172 define create_vhost_user_if_reply
2179 /** \brief vhost-user interface modify request
2180 @param client_index - opaque cookie to identify the sender
2181 @param is_server - our side is socket server
2182 @param sock_filename - unix socket filename, used to speak with frontend
2184 define modify_vhost_user_if
2190 u8 sock_filename[256];
2192 u32 custom_dev_instance;
2195 /** \brief vhost-user interface modify response
2196 @param context - sender context, to match reply w/ request
2197 @param retval - return code for the request
2199 define modify_vhost_user_if_reply
2205 /** \brief vhost-user interface delete request
2206 @param client_index - opaque cookie to identify the sender
2208 define delete_vhost_user_if
2215 /** \brief vhost-user interface delete response
2216 @param context - sender context, to match reply w/ request
2217 @param retval - return code for the request
2219 define delete_vhost_user_if_reply
2232 /* These fields map directly onto the subif template */
2236 u8 dot1ad; // 0 = dot1q, 1=dot1ad
2239 u8 outer_vlan_id_any;
2240 u8 inner_vlan_id_any;
2245 define create_subif_reply
2252 /** \brief show version
2253 @param client_index - opaque cookie to identify the sender
2254 @param context - sender context, to match reply w/ request
2262 /** \brief show version response
2263 @param context - sender context, to match reply w/ request
2264 @param retval - return code for the request
2265 @param program - name of the program (vpe)
2266 @param version - version of the program
2267 @param build_directory - root of the workspace where the program was built
2269 define show_version_reply
2276 u8 build_directory[256];
2279 /** \brief Vhost-user interface details structure (fix this)
2280 @param sw_if_index - index of the interface
2281 @param interface_name - name of interface
2282 @param virtio_net_hdr_sz - net header size
2283 @param features - interface features
2284 @param is_server - vhost-user server socket
2285 @param sock_filename - socket filename
2286 @param num_regions - number of used memory regions
2288 define sw_interface_vhost_user_details
2292 u8 interface_name[64];
2293 u32 virtio_net_hdr_sz;
2296 u8 sock_filename[256];
2302 define sw_interface_vhost_user_dump
2308 define ip_address_details
2316 define ip_address_dump
2337 /** \brief l2 fib table entry structure
2338 @param bd_id - the l2 fib / bridge domain table id
2339 @param mac - the entry's mac address
2340 @param sw_if_index - index of the interface
2341 @param static_mac - the entry is statically configured.
2342 @param filter_mac - the entry is a mac filter entry.
2343 @param bvi_mac - the mac address is a bridge virtual interface
2345 define l2_fib_table_entry
2356 /** \brief Dump l2 fib (aka bridge domain) table
2357 @param client_index - opaque cookie to identify the sender
2358 @param bd_id - the l2 fib / bridge domain table identifier
2360 define l2_fib_table_dump
2367 define vxlan_gpe_add_del_tunnel
2381 define vxlan_gpe_add_del_tunnel_reply
2388 define vxlan_gpe_tunnel_dump
2395 define vxlan_gpe_tunnel_details
2408 /** \brief add or delete locator_set
2409 @param client_index - opaque cookie to identify the sender
2410 @param context - sender context, to match reply w/ request
2411 @param is_add - add address if non-zero, else delete
2412 @param locator_set_name - locator name
2413 @param locator_num - number of locators
2414 @param locators - LISP locator records
2415 Structure of one locator record is as follows:
2423 define lisp_add_del_locator_set
2428 u8 locator_set_name[64];
2433 /** \brief Reply for locator_set add/del
2434 @param context - returned sender context, to match reply w/ request
2435 @param retval - return code
2436 @param ls_index - locator set index
2438 define lisp_add_del_locator_set_reply
2445 /** \brief add or delete locator for locator_set
2446 @param client_index - opaque cookie to identify the sender
2447 @param context - sender context, to match reply w/ request
2448 @param is_add - add address if non-zero, else delete
2449 @param locator_set_name - name of locator_set to add/del locator
2450 @param sw_if_index - index of the interface
2451 @param priority - priority of the lisp locator
2452 @param weight - weight of the lisp locator
2454 define lisp_add_del_locator
2459 u8 locator_set_name[64];
2465 /** \brief Reply for locator add/del
2466 @param context - returned sender context, to match reply w/ request
2467 @param retval - return code
2469 define lisp_add_del_locator_reply
2475 /** \brief add or delete lisp eid-table
2476 @param client_index - opaque cookie to identify the sender
2477 @param context - sender context, to match reply w/ request
2478 @param is_add - add address if non-zero, else delete
2483 @param eid - EID can be ip4, ip6 or mac
2484 @param prefix_len - prefix len
2485 @param locator_set_name - name of locator_set to add/del eid-table
2486 @param vni - virtual network instance
2488 define lisp_add_del_local_eid
2496 u8 locator_set_name[64];
2500 /** \brief Reply for local_eid add/del
2501 @param context - returned sender context, to match reply w/ request
2502 @param retval - return code
2504 define lisp_add_del_local_eid_reply
2510 /** \brief add or delete lisp gpe tunnel
2511 @param client_index - opaque cookie to identify the sender
2512 @param context - sender context, to match reply w/ request
2513 @param is_add - add address if non-zero, else delete
2518 @param rmt_eid - remote eid
2519 @param lcl_eid - local eid
2520 @param rmt_len - remote prefix len
2521 @param lcl_len - local prefix len
2522 @param vni - virtual network identifier
2523 @param dp_table - vrf/bridge domain id
2524 @param loc_num - number of locators
2525 @param lcl_locs - array of local locators
2526 @param rmt_locs - array of remote locators
2527 @param action - negative action when 0 locators configured
2529 define lisp_gpe_add_del_fwd_entry
2542 u8 lcl_locs[loc_num];
2543 u8 rmt_locs[loc_num];
2547 /** \brief Reply for gpe_fwd_entry add/del
2548 @param context - returned sender context, to match reply w/ request
2549 @param retval - return code
2551 define lisp_gpe_add_del_fwd_entry_reply
2557 /** \brief add or delete map-resolver
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
2561 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2562 @param ip_address - array of address bytes
2564 define lisp_add_del_map_resolver
2573 /** \brief Reply for map_resolver add/del
2574 @param context - returned sender context, to match reply w/ request
2575 @param retval - return code
2577 define lisp_add_del_map_resolver_reply
2583 /** \brief enable or disable lisp-gpe protocol
2584 @param client_index - opaque cookie to identify the sender
2585 @param context - sender context, to match reply w/ request
2586 @param is_en - enable protocol if non-zero, else disable
2588 define lisp_gpe_enable_disable
2595 /** \brief Reply for gpe enable/disable
2596 @param context - returned sender context, to match reply w/ request
2597 @param retval - return code
2599 define lisp_gpe_enable_disable_reply
2605 /** \brief enable or disable LISP feature
2606 @param client_index - opaque cookie to identify the sender
2607 @param context - sender context, to match reply w/ request
2608 @param is_en - enable protocol if non-zero, else disable
2610 define lisp_enable_disable
2617 /** \brief Reply for gpe enable/disable
2618 @param context - returned sender context, to match reply w/ request
2619 @param retval - return code
2621 define lisp_enable_disable_reply
2627 /** \brief add or delete gpe_iface
2628 @param client_index - opaque cookie to identify the sender
2629 @param context - sender context, to match reply w/ request
2630 @param is_add - add address if non-zero, else delete
2632 define lisp_gpe_add_del_iface
2642 /** \brief Reply for gpe_iface add/del
2643 @param context - returned sender context, to match reply w/ request
2644 @param retval - return code
2646 define lisp_gpe_add_del_iface_reply
2652 /** \brief configure or disable LISP PITR node
2653 @param client_index - opaque cookie to identify the sender
2654 @param context - sender context, to match reply w/ request
2655 @param ls_name - locator set name
2656 @param is_add - add locator set if non-zero, else disable pitr
2658 define lisp_pitr_set_locator_set
2666 /** \brief Reply for lisp_pitr_set_locator_set
2667 @param context - returned sender context, to match reply w/ request
2668 @param retval - return code
2670 define lisp_pitr_set_locator_set_reply
2676 /** \brief set LISP map-request mode. Based on configuration VPP will send
2677 src/dest or just normal destination map requests.
2678 @param client_index - opaque cookie to identify the sender
2679 @param context - sender context, to match reply w/ request
2680 @param mode - new map-request mode. Supported values are:
2681 0 - destination only
2682 1 - source/destaination
2684 define lisp_map_request_mode
2691 /** \brief Reply for lisp_map_request_mode
2692 @param context - returned sender context, to match reply w/ request
2693 @param retval - return code
2695 define lisp_map_request_mode_reply
2701 /** \brief Request for LISP map-request mode
2702 @param client_index - opaque cookie to identify the sender
2703 @param context - sender context, to match reply w/ request
2705 define show_lisp_map_request_mode
2711 /** \brief Reply for show_lisp_map_request_mode
2712 @param context - returned sender context, to match reply w/ request
2713 @param retval - return code
2714 @param mode - map-request mode
2716 define show_lisp_map_request_mode_reply
2723 /** \brief add or delete remote static mapping
2724 @param client_index - opaque cookie to identify the sender
2725 @param context - sender context, to match reply w/ request
2726 @param is_add - add address if non-zero, else delete
2727 @param is_src_dst - flag indicating src/dst based routing policy
2728 @param del_all - if set, delete all remote mappings
2729 @param vni - virtual network instance
2730 @param action - negative map-reply action
2735 @param deid - dst EID
2736 @param seid - src EID, valid only if is_src_dst is enabled
2737 @param rloc_num - number of remote locators
2738 @param rlocs - remote locator records
2739 Structure of remote locator:
2748 define lisp_add_del_remote_mapping
2766 /** \brief Reply for lisp_add_del_remote_mapping
2767 @param context - returned sender context, to match reply w/ request
2768 @param retval - return code
2770 define lisp_add_del_remote_mapping_reply
2776 /** \brief add or delete LISP adjacency adjacency
2777 @param client_index - opaque cookie to identify the sender
2778 @param context - sender context, to match reply w/ request
2779 @param is_add - add address if non-zero, else delete
2780 @param vni - virtual network instance
2785 @param reid - remote EID
2786 @param leid - local EID
2788 define lisp_add_del_adjacency
2801 /** \brief Reply for lisp_add_del_adjacency
2802 @param context - returned sender context, to match reply w/ request
2803 @param retval - return code
2805 define lisp_add_del_adjacency_reply
2811 /** \brief add or delete map request itr rlocs
2812 @param client_index - opaque cookie to identify the sender
2813 @param context - sender context, to match reply w/ request
2814 @param is_add - add address if non-zero, else delete
2815 @param locator_set_name - locator set name
2817 define lisp_add_del_map_request_itr_rlocs
2822 u8 locator_set_name[64];
2825 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
2826 @param context - returned sender context, to match reply w/ request
2827 @param retval - return code
2830 define lisp_add_del_map_request_itr_rlocs_reply
2836 /** \brief map/unmap vni/bd_index to vrf
2837 @param client_index - opaque cookie to identify the sender
2838 @param context - sender context, to match reply w/ request
2839 @param is_add - add or delete mapping
2840 @param dp_table - virtual network id/bridge domain index
2843 define lisp_eid_table_add_del_map
2853 /** \brief Reply for lisp_eid_table_add_del_map
2854 @param context - returned sender context, to match reply w/ request
2855 @param retval - return code
2857 define lisp_eid_table_add_del_map_reply
2863 /** \brief Request for map lisp locator status
2864 @param client_index - opaque cookie to identify the sender
2865 @param context - sender context, to match reply w/ request
2866 @param locator_set_index - index of locator_set
2867 @param ls_name - locator set name
2868 @param is_index_set - flag indicating whether ls_name or ls_index is set
2870 define lisp_locator_dump
2879 /** \brief LISP locator_set status
2880 @param local - if is set, then locator is local
2881 @param locator_set_name - name of the locator_set
2882 @param sw_if_index - sw_if_index of the locator
2883 @param priority - locator priority
2884 @param weight - locator weight
2886 define lisp_locator_details
2897 /** \brief LISP locator_set status
2898 @param context - sender context, to match reply w/ request
2899 @param ls_index - locator set index
2900 @param ls_name - name of the locator set
2902 define lisp_locator_set_details
2909 /** \brief Request for locator_set summary status
2910 @param client_index - opaque cookie to identify the sender
2911 @param context - sender context, to match reply w/ request
2912 @param filter - filter type
2915 1: local locator sets
2916 2: remote locator sets
2918 define lisp_locator_set_dump
2925 /** \brief Dump lisp eid-table
2926 @param client_index - opaque cookie to identify the sender
2927 @param context - sender context, to match reply w/ request
2928 @param locator_set_index - index of locator_set, if ~0 then the mapping
2930 @param action - negative map request action
2931 @param is_local - local if non-zero, else remote
2936 @param is_src_dst - EID is type of source/destination
2937 @param eid - EID can be ip4, ip6 or mac
2938 @param eid_prefix_len - prefix length
2939 @param seid - source EID can be ip4, ip6 or mac
2940 @param seid_prefix_len - source prefix length
2941 @param vni - virtual network instance
2942 @param ttl - time to live
2943 @param authoritative - authoritative
2946 define lisp_eid_table_details
2949 u32 locator_set_index;
2963 /** \brief Request for eid table summary status
2964 @param client_index - opaque cookie to identify the sender
2965 @param context - sender context, to match reply w/ request
2966 @param eid_set - if non-zero request info about specific mapping
2967 @param vni - virtual network instance; valid only if eid_set != 0
2968 @param prefix_length - prefix length if EID is IP address;
2969 valid only if eid_set != 0
2970 @param eid_type - EID type; valid only if eid_set != 0
2974 2: EID is ethernet address
2975 @param eid - endpoint identifier
2976 @param filter - filter type;
2982 define lisp_eid_table_dump
2994 /** \brief LISP adjacency
2999 @param reid - remote EID
3000 @param leid - local EID
3001 @param reid_prefix_len - remote EID IP prefix length
3002 @param leid_prefix_len - local EID IP prefix length
3004 typeonly manual_print manual_endian define lisp_adjacency
3013 /** \brief LISP adjacency reply
3014 @param count - number of adjacencies
3015 @param adjacencies - array of adjacencies
3017 manual_endian manual_print define lisp_adjacencies_get_reply
3022 vl_api_lisp_adjacency_t adjacencies[count];
3025 /** \brief Request for LISP adjacencies
3026 @param client_index - opaque cookie to identify the sender
3027 @param context - sender context, to match reply w/ request
3028 @param vni - filter adjacencies by VNI
3030 define lisp_adjacencies_get
3037 /** \brief Shows relationship between vni and vrf/bd
3038 @param dp_table - VRF index or bridge domain index
3039 @param vni - vitual network instance
3041 define lisp_eid_table_map_details
3048 /** \brief Request for lisp_eid_table_map_details
3049 @param client_index - opaque cookie to identify the sender
3050 @param context - sender context, to match reply w/ request
3051 @param is_l2 - if set dump vni/bd mappings else vni/vrf
3053 define lisp_eid_table_map_dump
3060 /** \brief Dumps all VNIs used in mappings
3061 @param client_index - opaque cookie to identify the sender
3062 @param context - sender context, to match reply w/ request
3064 define lisp_eid_table_vni_dump
3070 /** \brief reply to lisp_eid_table_vni_dump
3071 @param client_index - opaque cookie to identify the sender
3072 @param context - sender context, to match reply w/ request
3073 @param vni - virtual network instance
3075 define lisp_eid_table_vni_details
3082 define lisp_gpe_tunnel_details
3088 u8 destination_ip[16];
3100 /** \brief Request for gpe tunnel summary status
3101 @param client_index - opaque cookie to identify the sender
3102 @param context - sender context, to match reply w/ request
3104 define lisp_gpe_tunnel_dump
3110 /** \brief LISP map resolver status
3111 @param locator_set_name - name of the locator_set
3112 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3113 @param ip_address - array of address bytes
3115 define lisp_map_resolver_details
3122 /** \brief Request for map resolver summary status
3123 @param client_index - opaque cookie to identify the sender
3124 @param context - sender context, to match reply w/ request
3126 define lisp_map_resolver_dump
3132 /** \brief Request for lisp-gpe protocol status
3133 @param client_index - opaque cookie to identify the sender
3134 @param context - sender context, to match reply w/ request
3136 define show_lisp_status
3142 /** \brief Status of lisp, enable or disable
3143 @param context - sender context, to match reply w/ request
3144 @param feature_status - lisp enable if non-zero, else disable
3145 @param gpe_status - lisp enable if non-zero, else disable
3147 define show_lisp_status_reply
3155 /** \brief Get LISP map request itr rlocs status
3156 @param context - sender context, to match reply w/ request
3157 @param locator_set_name - name of the locator_set
3159 define lisp_get_map_request_itr_rlocs
3165 /** \brief Request for map request itr rlocs summary status
3167 define lisp_get_map_request_itr_rlocs_reply
3171 u8 locator_set_name[64];
3174 /** \brief Request for lisp pitr status
3175 @param client_index - opaque cookie to identify the sender
3176 @param context - sender context, to match reply w/ request
3178 define show_lisp_pitr
3184 /** \brief Status of lisp pitr, enable or disable
3185 @param context - sender context, to match reply w/ request
3186 @param status - lisp pitr enable if non-zero, else disable
3187 @param locator_set_name - name of the locator_set
3189 define show_lisp_pitr_reply
3194 u8 locator_set_name[64];
3197 /* Gross kludge, DGMS */
3198 define interface_name_renumber
3203 u32 new_show_dev_instance;
3206 define interface_name_renumber_reply
3212 /** \brief Register for ip4 arp resolution events
3213 @param client_index - opaque cookie to identify the sender
3214 @param context - sender context, to match reply w/ request
3215 @param enable_disable - 1 => register for events, 0 => cancel registration
3216 @param pid - sender's pid
3217 @param address - the exact ip4 address of interest
3219 define want_ip4_arp_events
3228 /** \brief Reply for interface events registration
3229 @param context - returned sender context, to match reply w/ request
3230 @param retval - return code
3232 define want_ip4_arp_events_reply
3238 /** \brief Tell client about an ip4 arp resolution event
3239 @param client_index - opaque cookie to identify the sender
3240 @param context - sender context, to match reply w/ request
3241 @param address - the exact ip4 address of interest
3242 @param pid - client pid registered to receive notification
3243 @param sw_if_index - interface which received ARP packet
3244 @param new_mac - the new mac address
3245 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3247 define ip4_arp_event
3258 /** \brief Register for ip6 nd resolution events
3259 @param client_index - opaque cookie to identify the sender
3260 @param context - sender context, to match reply w/ request
3261 @param enable_disable - 1 => register for events, 0 => cancel registration
3262 @param pid - sender's pid
3263 @param address - the exact ip6 address of interest
3265 define want_ip6_nd_events
3274 /** \brief Reply for ip6 nd resolution events registration
3275 @param context - returned sender context, to match reply w/ request
3276 @param retval - return code
3278 define want_ip6_nd_events_reply
3284 /** \brief Tell client about an ip6 nd resolution or mac/ip event
3285 @param client_index - opaque cookie to identify the sender
3286 @param context - sender context, to match reply w/ request
3287 @param pid - client pid registered to receive notification
3288 @param sw_if_index - interface which received ARP packet
3289 @param address - the exact ip6 address of interest
3290 @param new_mac - the new mac address
3291 @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
3304 /** \brief L2 bridge domain add or delete request
3305 @param client_index - opaque cookie to identify the sender
3306 @param context - sender context, to match reply w/ request
3307 @param bd_id - the bridge domain to create
3308 @param flood - enable/disable bcast/mcast flooding in the bd
3309 @param uu_flood - enable/disable uknown unicast flood in the bd
3310 @param forward - enable/disable forwarding on all interfaces in the bd
3311 @param learn - enable/disable learning on all interfaces in the bd
3312 @param arp_term - enable/disable arp termination in the bd
3313 @param is_add - add or delete flag
3315 define bridge_domain_add_del
3328 /** \brief L2 bridge domain add or delete response
3329 @param context - sender context, to match reply w/ request
3330 @param retval - return code for the set bridge flags request
3332 define bridge_domain_add_del_reply
3338 /** \brief L2 bridge domain request operational state details
3339 @param client_index - opaque cookie to identify the sender
3340 @param context - sender context, to match reply w/ request
3341 @param bd_id - the bridge domain id desired or ~0 to request all bds
3343 define bridge_domain_dump
3350 /** \brief L2 bridge domain operational state response
3351 @param bd_id - the bridge domain id
3352 @param flood - bcast/mcast flooding state on all interfaces in the bd
3353 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
3354 @param forward - forwarding state on all interfaces in the bd
3355 @param learn - learning state on all interfaces in the bd
3356 @param arp_term - arp termination state on all interfaces in the bd
3357 @param n_sw_ifs - number of sw_if_index's in the domain
3359 define bridge_domain_details
3368 u32 bvi_sw_if_index;
3372 /** \brief L2 bridge domain sw interface operational state response
3373 @param bd_id - the bridge domain id
3374 @param sw_if_index - sw_if_index in the domain
3375 @param shg - split horizon group for the interface
3377 define bridge_domain_sw_if_details
3385 /** \brief DHCP Client config add / del request
3386 @param client_index - opaque cookie to identify the sender
3387 @param context - sender context, to match reply w/ request
3388 @param sw_if_index - index of the interface for DHCP client
3389 @param hostname - hostname
3390 @param is_add - add the config if non-zero, else delete
3391 @param want_dhcp_event - DHCP event sent to the sender
3392 via dhcp_compl_event API message if non-zero
3393 @param pid - sender's pid
3395 define dhcp_client_config
3406 /** \brief DHCP Client config response
3407 @param context - sender context, to match reply w/ request
3408 @param retval - return code for the request
3410 define dhcp_client_config_reply
3416 /** \brief Set/unset input ACL interface
3417 @param client_index - opaque cookie to identify the sender
3418 @param context - sender context, to match reply w/ request
3419 @param sw_if_index - interface to set/unset input ACL
3420 @param ip4_table_index - ip4 classify table index (~0 for skip)
3421 @param ip6_table_index - ip6 classify table index (~0 for skip)
3422 @param l2_table_index - l2 classify table index (~0 for skip)
3423 @param is_add - Set input ACL if non-zero, else unset
3424 Note: User is recommeneded to use just one valid table_index per call.
3425 (ip4_table_index, ip6_table_index, or l2_table_index)
3427 define input_acl_set_interface
3432 u32 ip4_table_index;
3433 u32 ip6_table_index;
3438 /** \brief Set/unset input ACL interface response
3439 @param context - sender context, to match reply w/ request
3440 @param retval - return code for the request
3442 define input_acl_set_interface_reply
3448 /** \brief IPsec: Add/delete Security Policy Database
3449 @param client_index - opaque cookie to identify the sender
3450 @param context - sender context, to match reply w/ request
3451 @param is_add - add SPD if non-zero, else delete
3452 @param spd_id - SPD instance id (control plane allocated)
3455 define ipsec_spd_add_del
3463 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3464 @param context - returned sender context, to match reply w/ request
3465 @param retval - return code
3468 define ipsec_spd_add_del_reply
3474 /** \brief IPsec: Add/delete SPD from interface
3476 @param client_index - opaque cookie to identify the sender
3477 @param context - sender context, to match reply w/ request
3478 @param is_add - add security mode if non-zero, else delete
3479 @param sw_if_index - index of the interface
3480 @param spd_id - SPD instance id to use for lookups
3484 define ipsec_interface_add_del_spd
3494 /** \brief Reply for IPsec: Add/delete SPD from interface
3495 @param context - returned sender context, to match reply w/ request
3496 @param retval - return code
3499 define ipsec_interface_add_del_spd_reply
3505 /** \brief IPsec: Add/delete Security Policy Database entry
3507 See RFC 4301, 4.4.1.1 on how to match packet to selectors
3509 @param client_index - opaque cookie to identify the sender
3510 @param context - sender context, to match reply w/ request
3511 @param is_add - add SPD if non-zero, else delete
3512 @param spd_id - SPD instance id (control plane allocated)
3513 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
3514 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
3515 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
3516 @param remote_address_start - start of remote address range to match
3517 @param remote_address_stop - end of remote address range to match
3518 @param local_address_start - start of local address range to match
3519 @param local_address_stop - end of local address range to match
3520 @param protocol - protocol type to match [0 means any]
3521 @param remote_port_start - start of remote port range to match ...
3522 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3523 @param local_port_start - start of local port range to match ...
3524 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
3525 @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)
3526 @param sa_id - SAD instance id (control plane allocated)
3530 define ipsec_spd_add_del_entry
3543 u8 remote_address_start[16];
3544 u8 remote_address_stop[16];
3545 u8 local_address_start[16];
3546 u8 local_address_stop[16];
3550 u16 remote_port_start;
3551 u16 remote_port_stop;
3552 u16 local_port_start;
3553 u16 local_port_stop;
3560 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
3561 @param context - returned sender context, to match reply w/ request
3562 @param retval - return code
3565 define ipsec_spd_add_del_entry_reply
3571 /** \brief IPsec: Add/delete Security Association Database entry
3572 @param client_index - opaque cookie to identify the sender
3573 @param context - sender context, to match reply w/ request
3574 @param is_add - add SAD entry if non-zero, else delete
3576 @param sad_id - sad id
3578 @param spi - security parameter index
3580 @param protocol - 0 = AH, 1 = ESP
3582 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
3583 @param crypto_key_length - length of crypto_key in bytes
3584 @param crypto_key - crypto keying material
3586 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
3587 @param integrity_key_length - length of integrity_key in bytes
3588 @param integrity_key - integrity keying material
3590 @param use_extended_sequence_number - use ESN when non-zero
3592 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
3593 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
3594 @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
3595 @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
3599 IPsec tunnel address copy mode (to support GDOI)
3602 define ipsec_sad_add_del_entry
3614 u8 crypto_algorithm;
3615 u8 crypto_key_length;
3618 u8 integrity_algorithm;
3619 u8 integrity_key_length;
3620 u8 integrity_key[128];
3622 u8 use_extended_sequence_number;
3626 u8 tunnel_src_address[16];
3627 u8 tunnel_dst_address[16];
3630 /** \brief Reply for IPsec: Add/delete Security Association Database entry
3631 @param context - returned sender context, to match reply w/ request
3632 @param retval - return code
3635 define ipsec_sad_add_del_entry_reply
3641 /** \brief IPsec: Update Security Association keys
3642 @param client_index - opaque cookie to identify the sender
3643 @param context - sender context, to match reply w/ request
3645 @param sa_id - sa id
3647 @param crypto_key_length - length of crypto_key in bytes
3648 @param crypto_key - crypto keying material
3650 @param integrity_key_length - length of integrity_key in bytes
3651 @param integrity_key - integrity keying material
3654 define ipsec_sa_set_key
3661 u8 crypto_key_length;
3664 u8 integrity_key_length;
3665 u8 integrity_key[128];
3668 /** \brief Reply for IPsec: Update Security Association keys
3669 @param context - returned sender context, to match reply w/ request
3670 @param retval - return code
3673 define ipsec_sa_set_key_reply
3679 /** \brief IKEv2: Add/delete profile
3680 @param client_index - opaque cookie to identify the sender
3681 @param context - sender context, to match reply w/ request
3683 @param name - IKEv2 profile name
3684 @param is_add - Add IKEv2 profile if non-zero, else delete
3686 define ikev2_profile_add_del
3695 /** \brief Reply for IKEv2: Add/delete profile
3696 @param context - returned sender context, to match reply w/ request
3697 @param retval - return code
3699 define ikev2_profile_add_del_reply
3705 /** \brief IKEv2: Set IKEv2 profile authentication method
3706 @param client_index - opaque cookie to identify the sender
3707 @param context - sender context, to match reply w/ request
3709 @param name - IKEv2 profile name
3710 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
3711 @param is_hex - Authentication data in hex format if non-zero, else string
3712 @param data_len - Authentication data length
3713 @param data - Authentication data (for rsa-sig cert file path)
3715 define ikev2_profile_set_auth
3727 /** \brief Reply for IKEv2: Set IKEv2 profile authentication method
3728 @param context - returned sender context, to match reply w/ request
3729 @param retval - return code
3731 define ikev2_profile_set_auth_reply
3737 /** \brief IKEv2: Set IKEv2 profile local/remote identification
3738 @param client_index - opaque cookie to identify the sender
3739 @param context - sender context, to match reply w/ request
3741 @param name - IKEv2 profile name
3742 @param is_local - Identification is local if non-zero, else remote
3743 @param id_type - Identification type
3744 @param data_len - Identification data length
3745 @param data - Identification data
3747 define ikev2_profile_set_id
3759 /** \brief Reply for IKEv2:
3760 @param context - returned sender context, to match reply w/ request
3761 @param retval - return code
3763 define ikev2_profile_set_id_reply
3769 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
3770 @param client_index - opaque cookie to identify the sender
3771 @param context - sender context, to match reply w/ request
3773 @param name - IKEv2 profile name
3774 @param is_local - Traffic selector is local if non-zero, else remote
3775 @param proto - Traffic selector IP protocol (if zero not relevant)
3776 @param start_port - The smallest port number allowed by traffic selector
3777 @param end_port - The largest port number allowed by traffic selector
3778 @param start_addr - The smallest address included in traffic selector
3779 @param end_addr - The largest address included in traffic selector
3781 define ikev2_profile_set_ts
3795 /** \brief Reply for IKEv2: Set IKEv2 profile traffic selector parameters
3796 @param context - returned sender context, to match reply w/ request
3797 @param retval - return code
3799 define ikev2_profile_set_ts_reply
3805 /** \brief IKEv2: Set IKEv2 local RSA private key
3806 @param client_index - opaque cookie to identify the sender
3807 @param context - sender context, to match reply w/ request
3809 @param key_file - Key file absolute path
3811 define ikev2_set_local_key
3819 /** \brief Reply for IKEv2: Set IKEv2 local key
3820 @param context - returned sender context, to match reply w/ request
3821 @param retval - return code
3823 define ikev2_set_local_key_reply
3829 /** \brief Tell client about a DHCP completion event
3830 @param client_index - opaque cookie to identify the sender
3831 @param pid - client pid registered to receive notification
3832 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
3833 @param host_address - Host IP address
3834 @param router_address - Router IP address
3835 @param host_mac - Host MAC address
3837 define dhcp_compl_event
3843 u8 host_address[16];
3844 u8 router_address[16];
3848 /** \brief Add MAP domains
3849 @param client_index - opaque cookie to identify the sender
3850 @param context - sender context, to match reply w/ request
3851 @param ip6_prefix - Rule IPv6 prefix
3852 @param ip4_prefix - Rule IPv4 prefix
3853 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
3854 @param ip6_prefix_len - Rule IPv6 prefix length
3855 @param ip4_prefix_len - Rule IPv4 prefix length
3856 @param ea_bits_len - Embedded Address bits length
3857 @param psid_offset - Port Set Identifider (PSID) offset
3858 @param psid_length - PSID length
3859 @param is_translation - MAP-E / MAP-T
3862 define map_add_domain
3871 u8 ip6_src_prefix_len;
3879 /** \brief Reply for MAP domain add
3880 @param context - returned sender context, to match reply w/ request
3881 @param index - MAP domain index
3882 @param retval - return code
3884 define map_add_domain_reply
3891 /** \brief Delete MAP domain
3892 @param client_index - opaque cookie to identify the sender
3893 @param context - sender context, to match reply w/ request
3894 @param index - MAP Domain index
3896 define map_del_domain
3903 /** \brief Reply for MAP domain del
3904 @param context - returned sender context, to match reply w/ request
3905 @param retval - return code
3907 define map_del_domain_reply
3913 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
3914 @param client_index - opaque cookie to identify the sender
3915 @param context - sender context, to match reply w/ request
3916 @param index - MAP Domain index
3917 @param is_add - If 1 add rule, if 0 delete rule
3918 @param ip6_dst - MAP CE IPv6 address
3919 @param psid - Rule PSID
3921 define map_add_del_rule
3931 /** \brief Reply for MAP rule add/del
3932 @param context - returned sender context, to match reply w/ request
3933 @param retval - return code
3935 define map_add_del_rule_reply
3941 /** \brief Get list of map domains
3942 @param client_index - opaque cookie to identify the sender
3944 define map_domain_dump
3950 define map_domain_details
3968 define map_rule_dump
3975 define map_rule_details
3982 /** \brief Request for a single block of summary stats
3983 @param client_index - opaque cookie to identify the sender
3984 @param context - sender context, to match reply w/ request
3986 define map_summary_stats
3992 /** \brief Reply for map_summary_stats request
3993 @param context - sender context, to match reply w/ request
3994 @param retval - return code for request
3995 @param total_bindings -
3997 @param total_ip4_fragments -
3998 @param total_security_check -
4000 define map_summary_stats_reply
4007 u64 total_ip4_fragments;
4008 u64 total_security_check[2];
4011 /** \brief cop: enable/disable junk filtration features on an interface
4012 @param client_index - opaque cookie to identify the sender
4013 @param context - sender context, to match reply w/ request
4014 @param sw_if_inded - desired interface
4015 @param enable_disable - 1 => enable, 0 => disable
4018 define cop_interface_enable_disable
4026 /** \brief cop: interface enable/disable junk filtration reply
4027 @param context - returned sender context, to match reply w/ request
4028 @param retval - return code
4031 define cop_interface_enable_disable_reply
4037 /** \brief cop: enable/disable whitelist filtration features on an interface
4038 Note: the supplied fib_id must match in order to remove the feature!
4040 @param client_index - opaque cookie to identify the sender
4041 @param context - sender context, to match reply w/ request
4042 @param sw_if_index - interface handle, physical interfaces only
4043 @param fib_id - fib identifier for the whitelist / blacklist fib
4044 @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
4045 @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
4046 @param default_cop - 1 => enable non-ip4, non-ip6 filtration 0=> disable it
4049 define cop_whitelist_enable_disable
4060 /** \brief cop: interface enable/disable junk filtration reply
4061 @param context - returned sender context, to match reply w/ request
4062 @param retval - return code
4065 define cop_whitelist_enable_disable_reply
4071 /** \brief get_node_graph - get a copy of the vpp node graph
4072 including the current set of graph arcs.
4074 @param client_index - opaque cookie to identify the sender
4075 @param context - sender context, to match reply w/ request
4078 define get_node_graph
4084 /** \brief get_node_graph_reply
4085 @param context - returned sender context, to match reply w/ request
4086 @param retval - return code
4087 @param reply_in_shmem - result from vlib_node_serialize, in shared
4088 memory. Process with vlib_node_unserialize, remember to switch
4089 heaps and free the result.
4092 define get_node_graph_reply
4099 /** \brief Clear interface statistics
4100 @param client_index - opaque cookie to identify the sender
4101 @param context - sender context, to match reply w/ request
4102 @param sw_if_index - index of the interface to clear statistics
4104 define sw_interface_clear_stats
4111 /** \brief Reply to sw_interface_clear_stats
4112 @param context - sender context which was passed in the request
4113 @param retval - return code of the set flags request
4115 define sw_interface_clear_stats_reply
4121 /** \brief IOAM enable : Enable in-band OAM
4122 @param id - profile id
4123 @param trace_ppc - Trace PPC (none/encap/decap)
4124 @param pow_enable - Proof of Work enabled or not flag
4125 @param trace_enable - iOAM Trace enabled or not flag
4138 /** \brief iOAM Trace profile add / del response
4139 @param context - sender context, to match reply w/ request
4140 @param retval - return value for request
4142 define ioam_enable_reply
4148 /** \brief iOAM disable
4149 @param client_index - opaque cookie to identify the sender
4150 @param context - sender context, to match reply w/ request
4151 @param index - MAP Domain index
4160 /** \brief iOAM disable response
4161 @param context - sender context, to match reply w/ request
4162 @param retval - return value for request
4164 define ioam_disable_reply
4170 /** \brief Create host-interface
4171 @param client_index - opaque cookie to identify the sender
4172 @param context - sender context, to match reply w/ request
4173 @param host_if_name - interface name
4174 @param hw_addr - interface MAC
4175 @param use_random_hw_addr - use random generated MAC
4177 define af_packet_create
4182 u8 host_if_name[64];
4184 u8 use_random_hw_addr;
4187 /** \brief Create host-interface response
4188 @param context - sender context, to match reply w/ request
4189 @param retval - return value for request
4191 define af_packet_create_reply
4198 /** \brief Delete host-interface
4199 @param client_index - opaque cookie to identify the sender
4200 @param context - sender context, to match reply w/ request
4201 @param host_if_name - interface name
4203 define af_packet_delete
4208 u8 host_if_name[64];
4211 /** \brief Delete host-interface response
4212 @param context - sender context, to match reply w/ request
4213 @param retval - return value for request
4215 define af_packet_delete_reply
4221 /** \brief Add/del policer
4222 @param client_index - opaque cookie to identify the sender
4223 @param context - sender context, to match reply w/ request
4224 @param is_add - add policer if non-zero, else delete
4225 @param name - policer name
4228 @param cb - Committed Burst
4229 @param eb - Excess or Peak Burst
4230 @param rate_type - rate type
4231 @param round_type - rounding type
4232 @param type - policer algorithm
4233 @param color_aware - 0=color-blind, 1=color-aware
4234 @param conform_action_type - conform action type
4235 @param conform_dscp - DSCP for conform mar-and-transmit action
4236 @param exceed_action_type - exceed action type
4237 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4238 @param violate_action_type - violate action type
4239 @param violate_dscp - DSCP for violate mar-and-transmit action
4241 define policer_add_del
4256 u8 conform_action_type;
4258 u8 exceed_action_type;
4260 u8 violate_action_type;
4264 /** \brief Add/del policer response
4265 @param context - sender context, to match reply w/ request
4266 @param retval - return value for request
4267 @param policer_index - for add, returned index of the new policer
4269 define policer_add_del_reply
4276 /** \brief Get list of policers
4277 @param client_index - opaque cookie to identify the sender
4278 @param context - sender context, to match reply w/ request
4279 @param match_name_valid - if 0 request all policers otherwise use match_name
4280 @param match_name - policer name
4287 u8 match_name_valid;
4291 /** \brief Policer operational state response.
4292 @param context - sender context, to match reply w/ request
4293 @param name - policer name
4296 @param cb - Committed Burst
4297 @param eb - Excess or Peak Burst
4298 @param rate_type - rate type
4299 @param round_type - rounding type
4300 @param type - policer algorithm
4301 @param conform_action_type - conform action type
4302 @param conform_dscp - DSCP for conform mar-and-transmit action
4303 @param exceed_action_type - exceed action type
4304 @param exceed_dscp - DSCP for exceed mar-and-transmit action
4305 @param violate_action_type - violate action type
4306 @param violate_dscp - DSCP for violate mar-and-transmit action
4307 @param single_rate - 1 = single rate policer, 0 = two rate policer
4308 @param color_aware - for hierarchical policing
4309 @param scale - power-of-2 shift amount for lower rates
4310 @param cir_tokens_per_period - number of tokens for each period
4311 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
4312 @param current_limit - current limit
4313 @param current_bucket - current bucket
4314 @param extended_limit - extended limit
4315 @param extended_bucket - extended bucket
4316 @param last_update_time - last update time
4318 define policer_details
4330 u8 conform_action_type;
4332 u8 exceed_action_type;
4334 u8 violate_action_type;
4339 u32 cir_tokens_per_period;
4340 u32 pir_tokens_per_period;
4344 u32 extended_bucket;
4345 u64 last_update_time;
4348 /** \brief Set/unset policer classify interface
4349 @param client_index - opaque cookie to identify the sender
4350 @param context - sender context, to match reply w/ request
4351 @param sw_if_index - interface to set/unset policer classify
4352 @param ip4_table_index - ip4 classify table index (~0 for skip)
4353 @param ip6_table_index - ip6 classify table index (~0 for skip)
4354 @param l2_table_index - l2 classify table index (~0 for skip)
4355 @param is_add - Set if non-zero, else unset
4356 Note: User is recommeneded to use just one valid table_index per call.
4357 (ip4_table_index, ip6_table_index, or l2_table_index)
4359 define policer_classify_set_interface
4364 u32 ip4_table_index;
4365 u32 ip6_table_index;
4370 /** \brief Set/unset policer classify interface response
4371 @param context - sender context, to match reply w/ request
4372 @param retval - return value for request
4374 define policer_classify_set_interface_reply
4380 /** \brief Get list of policer classify interfaces and tables
4381 @param client_index - opaque cookie to identify the sender
4382 @param context - sender context, to match reply w/ request
4383 @param type - classify table type
4385 define policer_classify_dump
4392 /** \brief Policer iclassify operational state response.
4393 @param context - sender context, to match reply w/ request
4394 @param sw_if_index - software interface index
4395 @param table_index - classify table index
4397 define policer_classify_details
4404 /** \brief Create netmap
4405 @param client_index - opaque cookie to identify the sender
4406 @param context - sender context, to match reply w/ request
4407 @param netmap_if_name - interface name
4408 @param hw_addr - interface MAC
4409 @param use_random_hw_addr - use random generated MAC
4410 @param is_pipe - is pipe
4411 @param is_master - 0=slave, 1=master
4413 define netmap_create
4418 u8 netmap_if_name[64];
4420 u8 use_random_hw_addr;
4425 /** \brief Create netmap response
4426 @param context - sender context, to match reply w/ request
4427 @param retval - return value for request
4429 define netmap_create_reply
4435 /** \brief Delete netmap
4436 @param client_index - opaque cookie to identify the sender
4437 @param context - sender context, to match reply w/ request
4438 @param netmap_if_name - interface name
4440 define netmap_delete
4445 u8 netmap_if_name[64];
4448 /** \brief Delete netmap response
4449 @param context - sender context, to match reply w/ request
4450 @param retval - return value for request
4452 define netmap_delete_reply
4458 /** \brief Dump mpls gre tunnel table
4459 @param client_index - opaque cookie to identify the sender
4460 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
4462 define mpls_gre_tunnel_dump
4469 /** \brief mpls gre tunnel operational state response
4470 @param tunnel_index - gre tunnel identifier
4471 @param intfc_address - interface ipv4 addr
4472 @param mask_width - interface ipv4 addr mask
4473 @param hw_if_index - interface id
4475 @param tunnel_src - tunnel source ipv4 addr
4476 @param tunnel_dst - tunnel destination ipv4 addr
4477 @param outer_fib_index - gre tunnel identifier
4478 @param encap_index - reference to mpls label table
4479 @param nlabels - number of resolved labels
4480 @param labels - resolved labels
4482 define mpls_gre_tunnel_details
4488 u32 inner_fib_index;
4495 u32 outer_fib_index;
4497 u32 labels[nlabels];
4500 /** \brief Dump mpls eth tunnel table
4501 @param client_index - opaque cookie to identify the sender
4502 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
4504 define mpls_eth_tunnel_dump
4511 /** \brief mpls eth tunnel operational state response
4512 @param tunnel_index - eth tunnel identifier
4513 @param intfc_address - interface ipv4 addr
4514 @param mask_width - interface ipv4 addr mask
4515 @param hw_if_index - interface id
4517 @param tunnel_dst_mac -
4518 @param tx_sw_if_index -
4519 @param encap_index - reference to mpls label table
4520 @param nlabels - number of resolved labels
4521 @param labels - resolved labels
4523 define mpls_eth_tunnel_details
4529 u32 inner_fib_index;
4534 u8 tunnel_dst_mac[6];
4537 u32 labels[nlabels];
4540 /** \brief Dump mpls fib table
4541 @param client_index - opaque cookie to identify the sender
4542 @param fib_index - mpls fib entry identifier or -1 in case of all entries
4544 define mpls_fib_encap_dump
4550 /** \brief mpls fib encap table response
4551 @param fib_index - fib table id
4552 @param dest - destination ipv4 addr
4554 @param entry_index - reference to mpls label table
4555 @param nlabels - number of resolved labels
4556 @param labels - resolved labels
4558 define mpls_fib_encap_details
4567 u32 labels[nlabels];
4570 /** \brief Classify get table IDs request
4571 @param client_index - opaque cookie to identify the sender
4572 @param context - sender context, to match reply w/ request
4574 define classify_table_ids
4580 /** \brief Reply for classify get table IDs request
4581 @param context - sender context which was passed in the request
4582 @param count - number of ids returned in response
4583 @param ids - array of classify table ids
4585 define classify_table_ids_reply
4593 /** \brief Classify table ids by interface index request
4594 @param client_index - opaque cookie to identify the sender
4595 @param context - sender context, to match reply w/ request
4596 @param sw_if_index - index of the interface
4598 define classify_table_by_interface
4605 /** \brief Reply for classify table id by interface index request
4606 @param context - sender context which was passed in the request
4607 @param count - number of ids returned in response
4608 @param sw_if_index - index of the interface
4609 @param l2_table_id - l2 classify table index
4610 @param ip4_table_id - ip4 classify table index
4611 @param ip6_table_id - ip6 classify table index
4613 define classify_table_by_interface_reply
4623 /** \brief Classify table info
4624 @param client_index - opaque cookie to identify the sender
4625 @param context - sender context, to match reply w/ request
4626 @param table_id - classify table index
4628 define classify_table_info
4635 /** \brief Reply for classify table info request
4636 @param context - sender context which was passed in the request
4637 @param count - number of ids returned in response
4638 @param table_id - classify table index
4639 @param nbuckets - number of buckets when adding a table
4640 @param match_n_vectors - number of match vectors
4641 @param skip_n_vectors - number of skip_n_vectors
4642 @param active_sessions - number of sessions (active entries)
4643 @param next_table_index - index of next table
4644 @param miss_next_index - index of miss table
4645 @param mask[] - match mask
4647 define classify_table_info_reply
4653 u32 match_n_vectors;
4655 u32 active_sessions;
4656 u32 next_table_index;
4657 u32 miss_next_index;
4659 u8 mask[mask_length];
4662 /** \brief Classify sessions dump request
4663 @param client_index - opaque cookie to identify the sender
4664 @param context - sender context, to match reply w/ request
4665 @param table_id - classify table index
4667 define classify_session_dump
4674 /** \brief Reply for classify table session dump request
4675 @param context - sender context which was passed in the request
4676 @param count - number of ids returned in response
4677 @param table_id - classify table index
4678 @param hit_next_index - hit_next_index of session
4679 @param opaque_index - for add, opaque_index of session
4680 @param advance - advance value of session
4681 @param match[] - match value for session
4683 define classify_session_details
4692 u8 match[match_length];
4695 /** \brief Configure IPFIX exporter process request
4696 @param client_index - opaque cookie to identify the sender
4697 @param context - sender context, to match reply w/ request
4698 @param collector_address - address of IPFIX collector
4699 @param collector_port - port of IPFIX collector
4700 @param src_address - address of IPFIX exporter
4701 @param vrf_id - VRF / fib table ID
4702 @param path_mtu - Path MTU between exporter and collector
4703 @param template_interval - number of seconds after which to resend template
4704 @param udp_checksum - UDP checksum calculation enable flag
4706 define set_ipfix_exporter
4710 u8 collector_address[16];
4715 u32 template_interval;
4719 /** \brief Reply to IPFIX exporter configure request
4720 @param context - sender context which was passed in the request
4722 define set_ipfix_exporter_reply
4728 /** \brief IPFIX exporter dump request
4729 @param client_index - opaque cookie to identify the sender
4730 @param context - sender context, to match reply w/ request
4732 define ipfix_exporter_dump
4738 /** \brief Reply to IPFIX exporter dump request
4739 @param context - sender context which was passed in the request
4740 @param collector_address - address of IPFIX collector
4741 @param collector_port - port of IPFIX collector
4742 @param src_address - address of IPFIX exporter
4743 @param fib_index - fib table index
4744 @param path_mtu - Path MTU between exporter and collector
4745 @param template_interval - number of seconds after which to resend template
4746 @param udp_checksum - UDP checksum calculation enable flag
4748 define ipfix_exporter_details
4751 u8 collector_address[16];
4756 u32 template_interval;
4760 /** \brief IPFIX classify stream configure request
4761 @param client_index - opaque cookie to identify the sender
4762 @param context - sender context, to match reply w/ request
4763 @param domain_id - domain ID reported in IPFIX messages for classify stream
4764 @param src_port - source port of UDP session for classify stream
4766 define set_ipfix_classify_stream {
4773 /** \brief IPFIX classify stream configure response
4774 @param context - sender context, to match reply w/ request
4775 @param retval - return value for request
4777 define set_ipfix_classify_stream_reply {
4782 /** \brief IPFIX classify stream dump request
4783 @param client_index - opaque cookie to identify the sender
4784 @param context - sender context, to match reply w/ request
4786 define ipfix_classify_stream_dump {
4791 /** \brief Reply to IPFIX classify stream dump request
4792 @param context - sender context, to match reply w/ request
4793 @param domain_id - domain ID reported in IPFIX messages for classify stream
4794 @param src_port - source port of UDP session for classify stream
4796 define ipfix_classify_stream_details {
4802 /** \brief IPFIX add or delete classifier table request
4803 @param client_index - opaque cookie to identify the sender
4804 @param context - sender context, to match reply w/ request
4805 @param table_id - classifier table ID
4806 @param ip_version - version of IP used in the classifier table
4807 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4809 define ipfix_classify_table_add_del {
4814 u8 transport_protocol;
4818 /** \brief IPFIX add classifier table response
4819 @param context - sender context which was passed in the request
4821 define ipfix_classify_table_add_del_reply {
4826 /** \brief IPFIX classify tables dump request
4827 @param client_index - opaque cookie to identify the sender
4828 @param context - sender context, to match reply w/ request
4830 define ipfix_classify_table_dump {
4835 /** \brief Reply to IPFIX classify tables dump request
4836 @param context - sender context, to match reply w/ request
4837 @param table_id - classifier table ID
4838 @param ip_version - version of IP used in the classifier table
4839 @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
4841 define ipfix_classify_table_details {
4845 u8 transport_protocol;
4848 /** \brief Set/unset flow classify interface
4849 @param client_index - opaque cookie to identify the sender
4850 @param context - sender context, to match reply w/ request
4851 @param sw_if_index - interface to set/unset flow classify
4852 @param ip4_table_index - ip4 classify table index (~0 for skip)
4853 @param ip6_table_index - ip6 classify table index (~0 for skip)
4854 @param l2_table_index - l2 classify table index (~0 for skip)
4855 @param is_add - Set if non-zero, else unset
4856 Note: User is recommeneded to use just one valid table_index per call.
4857 (ip4_table_index, ip6_table_index, or l2_table_index)
4859 define flow_classify_set_interface {
4863 u32 ip4_table_index;
4864 u32 ip6_table_index;
4868 /** \brief Set/unset flow classify interface response
4869 @param context - sender context, to match reply w/ request
4870 @param retval - return value for request
4872 define flow_classify_set_interface_reply {
4877 /** \brief Get list of flow classify interfaces and tables
4878 @param client_index - opaque cookie to identify the sender
4879 @param context - sender context, to match reply w/ request
4880 @param type - classify table type
4882 define flow_classify_dump {
4888 /** \brief Flow classify operational state response.
4889 @param context - sender context, to match reply w/ request
4890 @param sw_if_index - software interface index
4891 @param table_index - classify table index
4893 define flow_classify_details {
4899 /** \brief Query relative index via node names
4900 @param client_index - opaque cookie to identify the sender
4901 @param context - sender context, to match reply w/ request
4902 @param node_name - name of node to find relative index from
4903 @param next_name - next node from node_name to find relative index of
4905 define get_next_index
4913 /** \brief Reply for get next node index
4914 @param context - sender context which was passed in the request
4915 @param retval - return value
4916 @param next_index - index of the next_node
4918 define get_next_index_reply
4925 /** \brief PacketGenerator create interface request
4926 @param client_index - opaque cookie to identify the sender
4927 @param context - sender context, to match reply w/ request
4928 @param interface_id - interface index
4930 define pg_create_interface
4937 /** \brief PacketGenerator create interface response
4938 @param context - sender context, to match reply w/ request
4939 @param retval - return value for request
4941 define pg_create_interface_reply
4948 /** \brief PacketGenerator capture packets on given interface request
4949 @param client_index - opaque cookie to identify the sender
4950 @param context - sender context, to match reply w/ request
4951 @param interface_id - pg interface index
4952 @param is_enabled - 1 if enabling streams, 0 if disabling
4953 @param count - number of packets to be captured
4954 @param pcap_file - pacp file name to store captured packets
4963 u32 pcap_name_length;
4964 u8 pcap_file_name[pcap_name_length];
4967 /** \brief PacketGenerator capture packets response
4968 @param context - sender context, to match reply w/ request
4969 @param retval - return value for request
4971 define pg_capture_reply
4977 /** \brief Enable / disable packet generator request
4978 @param client_index - opaque cookie to identify the sender
4979 @param context - sender context, to match reply w/ request
4980 @param is_enabled - 1 if enabling streams, 0 if disabling
4981 @param stream - stream name to be enable/disabled, if not specified handle all streams
4983 define pg_enable_disable
4988 u32 stream_name_length;
4989 u8 stream_name[stream_name_length];
4992 /** \brief Reply for enable / disable packet generator
4993 @param context - returned sender context, to match reply w/ request
4994 @param retval - return code
4996 define pg_enable_disable_reply
5002 /** \brief Configure IP source and L4 port-range check
5003 @param client_index - opaque cookie to identify the sender
5004 @param context - sender context, to match reply w/ request
5005 @param is_ip6 - 1 if source address type is IPv6
5006 @param is_add - 1 if add, 0 if delete
5007 @param mask_length - mask length for address entry
5008 @param address - array of address bytes
5009 @param number_of_ranges - length of low_port and high_port arrays (must match)
5010 @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
5011 @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
5012 @param vrf_id - fib table/vrf id to associate the source and port-range check with
5013 @note To specify a single port set low_port and high_port entry the same
5015 define ip_source_and_port_range_check_add_del
5023 u8 number_of_ranges;
5029 /** \brief Configure IP source and L4 port-range check reply
5030 @param context - returned sender context, to match reply w/ request
5031 @param retval - return code
5033 define ip_source_and_port_range_check_add_del_reply
5039 /** \brief Set interface source and L4 port-range request
5040 @param client_index - opaque cookie to identify the sender
5041 @param context - sender context, to match reply w/ request
5042 @param interface_id - interface index
5043 @param tcp_vrf_id - VRF associated with source and TCP port-range check
5044 @param udp_vrf_id - VRF associated with source and TCP port-range check
5046 define ip_source_and_port_range_check_interface_add_del
5058 /** \brief Set interface source and L4 port-range response
5059 @param context - sender context, to match reply w/ request
5060 @param retval - return value for request
5062 define ip_source_and_port_range_check_interface_add_del_reply
5068 /** \brief Add / del ipsec gre tunnel request
5069 @param client_index - opaque cookie to identify the sender
5070 @param context - sender context, to match reply w/ request
5071 @param local_sa_id - local SA id
5072 @param remote_sa_id - remote SA id
5073 @param is_add - 1 if adding the tunnel, 0 if deleting
5074 @param src_address - tunnel source address
5075 @param dst_address - tunnel destination address
5077 define ipsec_gre_add_del_tunnel {
5087 /** \brief Reply for add / del ipsec gre tunnel request
5088 @param context - returned sender context, to match reply w/ request
5089 @param retval - return code
5090 @param sw_if_index - software index of the new ipsec gre tunnel
5092 define ipsec_gre_add_del_tunnel_reply {
5098 /** \brief Dump ipsec gre tunnel table
5099 @param client_index - opaque cookie to identify the sender
5100 @param context - sender context, to match reply w/ request
5101 @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
5103 define ipsec_gre_tunnel_dump {
5109 /** \brief mpls gre tunnel operational state response
5110 @param context - returned sender context, to match reply w/ request
5111 @param sw_if_index - software index of the ipsec gre tunnel
5112 @param local_sa_id - local SA id
5113 @param remote_sa_id - remote SA id
5114 @param src_address - tunnel source address
5115 @param dst_address - tunnel destination address
5117 define ipsec_gre_tunnel_details {
5126 /** \brief Delete sub interface request
5127 @param client_index - opaque cookie to identify the sender
5128 @param context - sender context, to match reply w/ request
5129 @param sw_if_index - sw index of the interface that was created by create_subif
5131 define delete_subif {
5137 /** \brief Delete sub interface response
5138 @param context - sender context, to match reply w/ request
5139 @param retval - return code for the request
5141 define delete_subif_reply {
5146 /** \brief DPDK interface HQoS pipe profile set request
5147 @param client_index - opaque cookie to identify the sender
5148 @param context - sender context, to match reply w/ request
5149 @param sw_if_index - the interface
5150 @param subport - subport ID
5151 @param pipe - pipe ID within its subport
5152 @param profile - pipe profile ID
5154 define sw_interface_set_dpdk_hqos_pipe {
5163 /** \brief DPDK interface HQoS pipe profile set reply
5164 @param context - sender context, to match reply w/ request
5165 @param retval - request return code
5167 define sw_interface_set_dpdk_hqos_pipe_reply {
5172 /** \brief DPDK interface HQoS subport parameters set request
5173 @param client_index - opaque cookie to identify the sender
5174 @param context - sender context, to match reply w/ request
5175 @param sw_if_index - the interface
5176 @param subport - subport ID
5177 @param tb_rate - subport token bucket rate (measured in bytes/second)
5178 @param tb_size - subport token bucket size (measured in credits)
5179 @param tc_rate - subport traffic class 0 .. 3 rates (measured in bytes/second)
5180 @param tc_period - enforcement period for rates (measured in milliseconds)
5182 define sw_interface_set_dpdk_hqos_subport {
5193 /** \brief DPDK interface HQoS subport parameters set reply
5194 @param context - sender context, to match reply w/ request
5195 @param retval - request return code
5197 define sw_interface_set_dpdk_hqos_subport_reply {
5202 /** \brief DPDK interface HQoS tctbl entry set request
5203 @param client_index - opaque cookie to identify the sender
5204 @param context - sender context, to match reply w/ request
5205 @param sw_if_index - the interface
5206 @param entry - entry index ID
5207 @param tc - traffic class (0 .. 3)
5208 @param queue - traffic class queue (0 .. 3)
5210 define sw_interface_set_dpdk_hqos_tctbl {
5219 /** \brief DPDK interface HQoS tctbl entry set reply
5220 @param context - sender context, to match reply w/ request
5221 @param retval - request return code
5223 define sw_interface_set_dpdk_hqos_tctbl_reply {
5228 /** \brief L2 interface pbb tag rewrite configure request
5229 @param client_index - opaque cookie to identify the sender
5230 @param context - sender context, to match reply w/ request
5231 @param sw_if_index - interface the operation is applied to
5232 @param vtr_op - Choose from l2_vtr_op_t enum values
5233 @param inner_tag - needed for translate_qinq vtr op only
5234 @param outer_tag - needed for translate_qinq vtr op only
5235 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
5236 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
5237 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
5238 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
5240 define l2_interface_pbb_tag_rewrite
5253 /** \brief L2 interface pbb tag rewrite response
5254 @param context - sender context, to match reply w/ request
5255 @param retval - return code for the request
5257 define l2_interface_pbb_tag_rewrite_reply
5263 /** \brief Punt traffic to the host
5264 @param client_index - opaque cookie to identify the sender
5265 @param context - sender context, to match reply w/ request
5266 @param is_add - add punt if non-zero, else delete
5267 @param ipv - L3 protocol 4 - IPv4, 6 - IPv6, ~0 - All
5268 @param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
5269 @param l4_port - TCP/UDP port to be punted
5280 /** \brief Reply to the punt request
5281 @param context - sender context which was passed in the request
5282 @param retval - return code of punt request