1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2015 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 {
37 /** \brief Reply for interface events registration
38 @param context - returned sender context, to match reply w/ request
39 @param retval - return code
41 define want_interface_events_reply {
46 /** \brief Interface details structure (fix this)
47 @param sw_if_index - index of the interface
48 @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
49 @param l2_address_length - length of the interface's l2 address
50 @param pid - the interface's l2 address
51 @param interface_name - name of the interface
52 @param link_duplex - 1 if half duplex, 2 if full duplex
53 @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
54 @param sub_if_id - A number 0-N to uniquely identify this subif on super if
55 @param sub_dot1ad - 0 = dot1q, 1=dot1ad
56 @param sub_number_of_tags - Number of tags (0 - 2)
57 @param sub_outer_vlan_id
58 @param sub_inner_vlan_id
59 @param sub_exact_match
61 @param sub_outer_vlan_id_any
62 @param sub_inner_vlan_id_any
63 @param vtr_op - vlan tag rewrite operation
68 manual_java define sw_interface_details {
71 /* index of sup interface (e.g. hw interface).
72 equal to sw_if_index for super hw interface. */
75 /* Layer 2 address, if applicable */
76 u32 l2_address_length;
80 u8 interface_name[64];
82 /* 1 = up, 0 = down */
86 /* 1 = half duplex, 2 = full duplex */
89 /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
92 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface*/
95 /* 0 = dot1q, 1=dot1ad */
98 /* Number of tags 0-2 */
99 u8 sub_number_of_tags;
100 u16 sub_outer_vlan_id;
101 u16 sub_inner_vlan_id;
104 u8 sub_outer_vlan_id_any;
105 u8 sub_inner_vlan_id_any;
107 /* vlan tag rewrite state */
109 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
110 u32 vtr_tag1; // first pushed tag
111 u32 vtr_tag2; // second pushed tag
114 /** \brief Set flags on the interface
115 @param client_index - opaque cookie to identify the sender
116 @param context - sender context, to match reply w/ request
117 @param sw_if_index - index of the interface to set flags on
118 @param admin_up_down - set the admin state, 1 = up, 0 = down
119 @param link_up_down - Oper state sent on change event, not used in config.
120 @param deleted - interface was deleted
122 define sw_interface_set_flags {
126 /* 1 = up, 0 = down */
132 /** \brief Reply to sw_interface_set_flags
133 @param context - sender context which was passed in the request
134 @param retval - return code of the set flags request
136 define sw_interface_set_flags_reply {
142 manual_java define sw_interface_dump {
145 u8 name_filter_valid;
149 /** \brief Set or delete one or all ip addresses on a specified interface
150 @param client_index - opaque cookie to identify the sender
151 @param context - sender context, to match reply w/ request
152 @param sw_if_index - index of the interface to add/del addresses
153 @param is_add - add address if non-zero, else delete
154 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
155 @param del_all - if non-zero delete all addresses on the interface
156 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
157 @param address - array of address bytes
159 define sw_interface_add_del_address {
170 /** \brief Reply for interface events registration
171 @param context - returned sender context, to match reply w/ request
172 @param retval - return code
174 define sw_interface_add_del_address_reply {
179 /** \brief Associate the specified interface with a fib table
180 @param client_index - opaque cookie to identify the sender
181 @param context - sender context, to match reply w/ request
182 @param sw_if_index - index of the interface
183 @param is_ipv6 - if non-zero ipv6, else ipv4
184 @param vrf_id - fib table/vrd id to associate the interface with
186 define sw_interface_set_table {
194 /** \brief Reply for interface events registration
195 @param context - returned sender context, to match reply w/ request
196 @param retval - return code
198 define sw_interface_set_table_reply {
203 /** \brief Initialize a new tap interface with the given paramters
204 @param client_index - opaque cookie to identify the sender
205 @param context - sender context, to match reply w/ request
206 @param use_random_mac - let the system generate a unique mac address
207 @param tap_name - name to associate with the new interface
208 @param mac_address - mac addr to assign to the interface if use_radom not set
217 u32 custom_dev_instance;
220 /** \brief Reply for tap connect request
221 @param context - returned sender context, to match reply w/ request
222 @param retval - return code
223 @param sw_if_index - software index allocated for the new tap interface
225 define tap_connect_reply {
231 /** \brief Modify a tap interface with the given paramters
232 @param client_index - opaque cookie to identify the sender
233 @param context - sender context, to match reply w/ request
234 @param sw_if_index - interface index of existing tap interface
235 @param use_random_mac - let the system generate a unique mac address
236 @param tap_name - name to associate with the new interface
237 @param mac_address - mac addr to assign to the interface if use_radom not set
247 u32 custom_dev_instance;
250 /** \brief Reply for tap modify request
251 @param context - returned sender context, to match reply w/ request
252 @param retval - return code
253 @param sw_if_index - software index if the modified tap interface
255 define tap_modify_reply {
261 /** \brief Delete tap interface
262 @param client_index - opaque cookie to identify the sender
263 @param context - sender context, to match reply w/ request
264 @param sw_if_index - interface index of existing tap interface
272 /** \brief Reply for tap delete request
273 @param context - returned sender context, to match reply w/ request
274 @param retval - return code
276 define tap_delete_reply {
281 /** \brief Dump tap interfaces request */
282 define sw_interface_tap_dump {
287 /** \brief Reply for tap dump request
288 @param sw_if_index - software index of tap interface
289 @param dev_name - Linux tap device name
291 manual_java define sw_interface_tap_details {
297 /** \brief Create a new subinterface with the given vlan id
298 @param client_index - opaque cookie to identify the sender
299 @param context - sender context, to match reply w/ request
300 @param sw_if_index - software index of the new vlan's parent interface
301 @param vlan_id - vlan tag of the new interface
303 define create_vlan_subif {
310 /** \brief Reply for the vlan subinterface create request
311 @param context - returned sender context, to match reply w/ request
312 @param retval - return code
313 @param sw_if_index - software index allocated for the new subinterface
315 define create_vlan_subif_reply {
321 /** \brief Add / del route request
322 @param client_index - opaque cookie to identify the sender
323 @param context - sender context, to match reply w/ request
324 @param sw_if_index - software index of the new vlan's parent interface
325 @param vrf_id - fib table /vrf associated with the route
326 @param lookup_in_vrf -
327 @param resolve_attempts -
328 @param classify_table_index -
329 @param create_vrf_if_needed -
330 @param resolve_if_needed -
331 @param is_add - 1 if adding the route, 0 if deleting
333 @param is_ipv6 - 0 if an ip4 route, else ip6
336 @param is_multipath - Set to 1 if this is a multipath route, else 0
337 @param not_last - Is last or not last msg in group of multiple add/del msgs
338 @param next_hop_weight -
339 @param dst_address_length -
340 @param dst_address[16] -
341 @param next_hop_address[16] -
343 define ip_add_del_route {
346 u32 next_hop_sw_if_index;
349 u32 resolve_attempts;
350 u32 classify_table_index;
351 u8 create_vrf_if_needed;
352 u8 resolve_if_needed;
358 /* Is last/not-last message in group of multiple add/del messages. */
362 u8 dst_address_length;
364 u8 next_hop_address[16];
367 /** \brief Reply for add / del route request
368 @param context - returned sender context, to match reply w/ request
369 @param retval - return code
371 define ip_add_del_route_reply {
377 /** \brief Add / del gre tunnel request
378 @param client_index - opaque cookie to identify the sender
379 @param context - sender context, to match reply w/ request
380 @param sw_if_index - software index of the new vlan's parent interface
381 @param inner_vrf_id -
382 @param outer_vrf_id -
383 @param is_add - 1 if adding the tunnel, 0 if deleting
384 @param src_address[4] - tunnel source address
385 @param dst_address[4] - tunnel destination address
386 @param intf_address -
387 @param intf_address_length -
389 define mpls_gre_add_del_tunnel {
399 u8 intfc_address_length;
402 /** \brief Reply for add / del tunnel request
403 @param context - returned sender context, to match reply w/ request
404 @param retval - return code
406 define mpls_gre_add_del_tunnel_reply {
409 u32 tunnel_sw_if_index;
412 /** \brief Add / del MPLS encapsulation request
413 @param client_index - opaque cookie to identify the sender
414 @param context - sender context, to match reply w/ request
415 @param vrf_id - vrf id
416 @param dst_address[4] -
417 @param is_add - 1 if adding the encap, 0 if deleting
418 @param nlabels - number of labels
419 @param labels - array of labels
421 define mpls_add_del_encap {
426 /* 1 = add, 0 = delete */
432 /** \brief Reply for add / del encapsulation request
433 @param context - returned sender context, to match reply w/ request
434 @param retval - return code
436 define mpls_add_del_encap_reply {
441 /** \brief Add / del MPLS decapsulation request
442 @param client_index - opaque cookie to identify the sender
443 @param context - sender context, to match reply w/ request
444 @param rx_vrf_id - receive vrf
445 @param tx_vrf_id - transmit vrf
449 @param is_add - 1 if adding the encap, 0 if deleting
451 define mpls_add_del_decap {
462 /** \brief Reply for MPLS decap add / del request
463 @param context - returned sender context, to match reply w/ request
464 @param retval - return code
466 define mpls_add_del_decap_reply {
471 /** \brief Proxy ARP add / del request
472 @param client_index - opaque cookie to identify the sender
473 @param context - sender context, to match reply w/ request
474 @param vrf_id - VRF / Fib table ID
475 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
476 @param low_address[4] - Low address of the Proxy ARP range
477 @param hi_address[4] - High address of the Proxy ARP range
479 define proxy_arp_add_del {
488 /** \brief Reply for proxy arp add / del request
489 @param context - returned sender context, to match reply w/ request
490 @param retval - return code
492 define proxy_arp_add_del_reply {
497 /** \brief Proxy ARP add / del request
498 @param client_index - opaque cookie to identify the sender
499 @param context - sender context, to match reply w/ request
500 @param sw_if_index - Which interface to enable / disable Proxy Arp on
501 @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
503 define proxy_arp_intfc_enable_disable {
507 /* 1 = on, 0 = off */
511 /** \brief Reply for Proxy ARP interface enable / disable request
512 @param context - returned sender context, to match reply w/ request
513 @param retval - return code
515 define proxy_arp_intfc_enable_disable_reply {
520 /** \brief IP neighbor add / del request
521 @param client_index - opaque cookie to identify the sender
522 @param context - sender context, to match reply w/ request
523 @param vrf_id - vrf_id, only for IP4
524 @param sw_if_index - interface used to reach neighbor
525 @param is_add - 1 to add neighbor, 0 to delete
526 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
528 @param mac_address - l2 address of the neighbor
529 @param dst_address - ip4 or ip6 address of the neighbor
531 define ip_neighbor_add_del {
534 u32 vrf_id; /* only makes sense for ip4 */
536 /* 1 = add, 0 = delete */
544 /** \brief Reply for IP Neighbor add / delete request
545 @param context - returned sender context, to match reply w/ request
546 @param retval - return code
548 define ip_neighbor_add_del_reply {
553 /** \brief Reset VRF (remove all routes etc) request
554 @param client_index - opaque cookie to identify the sender
555 @param context - sender context, to match reply w/ request
556 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
557 @param vrf_id - ID of th FIB table / VRF to reset
566 /** \brief Reply for Reset VRF request
567 @param context - returned sender context, to match reply w/ request
568 @param retval - return code
570 define reset_vrf_reply {
575 /** \brief Is Address Reachable request - DISABLED
576 @param client_index - opaque cookie to identify the sender
577 @param context - sender context, to match reply w/ request
578 @param next_hop_sw_if_index - index of interface used to get to next hop
579 @param is_ipv6 - 1 for IPv6, 0 for IPv4
580 @param is_error - address not found or does not match intf
581 @param address[] - Address in question
583 define is_address_reachable {
584 u32 client_index; /* (api_main_t *) am->my_client_index */
586 u32 next_hop_sw_if_index;
587 u8 is_known; /* on reply, this is the answer */
589 u8 is_error; /* address not found or does not match intf */
593 /** \brief Want Stats, register for stats updates
594 @param client_index - opaque cookie to identify the sender
595 @param context - sender context, to match reply w/ request
596 @param enable_disable - 1 = enable stats, 0 = disable
597 @param pid - pid of process requesting stats updates
606 /** \brief Reply for Want Stats request
607 @param context - returned sender context, to match reply w/ request
608 @param retval - return code
610 manual_java define want_stats_reply {
615 /** \brief Want stats counters structure
616 @param vnet_counter_type- such as ip4, ip6, punts, etc
617 @param is_combined - rx & tx total (all types) counts
618 @param first_sw_if_index - first sw index in block of index, counts
619 @param count - number of interfaces this stats block includes counters for
620 @param data - contiguous block of vlib_counter_t structures
622 manual_java define vnet_interface_counters {
623 /* enums - plural - in vnet/interface.h */
624 u8 vnet_counter_type;
626 u32 first_sw_if_index;
631 typeonly manual_print manual_endian define ip4_fib_counter {
638 manual_java manual_print manual_endian define vnet_ip4_fib_counters {
641 vl_api_ip4_fib_counter_t c[0];
644 typeonly manual_print manual_endian define ip6_fib_counter {
651 manual_java manual_print manual_endian define vnet_ip6_fib_counters {
654 vl_api_ip6_fib_counter_t c[0];
657 /** \brief Request for a single block of summary stats
658 @param client_index - opaque cookie to identify the sender
659 @param context - sender context, to match reply w/ request
661 define vnet_get_summary_stats {
666 /** \brief Reply for vnet_get_summary_stats request
667 @param context - sender context, to match reply w/ request
668 @param retval - return code for request
673 define vnet_summary_stats_reply {
681 /** \brief OAM event structure
682 @param dst_address[] -
685 manual_java define oam_event {
690 /** \brief Want OAM events request
691 @param client_index - opaque cookie to identify the sender
692 @param context - sender context, to match reply w/ request
693 @param enable_disable- enable if non-zero, else disable
694 @param pid - pid of the requesting process
696 define want_oam_events {
703 /** \brief Want OAM events response
704 @param context - sender context, to match reply w/ request
705 @param retval - return code for the want oam stats request
707 define want_oam_events_reply {
712 /** \brief OAM add / del target request
713 @param client_index - opaque cookie to identify the sender
714 @param context - sender context, to match reply w/ request
715 @param vrf_id - vrf_id of the target
716 @param src_address[] - source address to use for the updates
717 @param dst_address[] - destination address of the target
718 @param is_add - add target if non-zero, else delete
729 /** \brief OAM add / del target response
730 @param context - sender context, to match reply w/ request
731 @param retval - return code of the request
733 define oam_add_del_reply {
738 /** \brief Reset fib table request
739 @param client_index - opaque cookie to identify the sender
740 @param context - sender context, to match reply w/ request
741 @param vrf_id - vrf/table id of the fib table to reset
742 @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
751 /** \brief Reset fib response
752 @param context - sender context, to match reply w/ request
753 @param retval - return code for the reset bfib request
755 define reset_fib_reply {
760 /** \brief DHCP Proxy config add / del request
761 @param client_index - opaque cookie to identify the sender
762 @param context - sender context, to match reply w/ request
763 @param vrf_id - vrf id
764 @param if_ipv6 - ipv6 if non-zero, else ipv4
765 @param is_add - add the config if non-zero, else delete
766 @param insert_circuit_id - option82 suboption 1 fib number
767 @param dhcp_server[] - server address
768 @param dhcp_src_address[] - <fix this, need details>
770 define dhcp_proxy_config {
776 u8 insert_circuit_id;
778 u8 dhcp_src_address[16];
781 /** \brief DHCP Proxy config response
782 @param context - sender context, to match reply w/ request
783 @param retval - return code for the request
785 define dhcp_proxy_config_reply {
790 /** \brief DHCP Proxy set / unset vss request
791 @param client_index - opaque cookie to identify the sender
792 @param context - sender context, to match reply w/ request
793 @param tbl_id - table id
794 @param oui - first part of vpn id
795 @param fib_id - second part of vpn id
796 @param is_ipv6 - ip6 if non-zero, else ip4
797 @param is_add - set vss if non-zero, else delete
799 define dhcp_proxy_set_vss {
809 /** \brief DHCP proxy set / unset vss response
810 @param context - sender context, to match reply w/ request
811 @param retval - return code for the request
813 define dhcp_proxy_set_vss_reply {
819 * These messages bounce off the dataplane and are not otherwise
820 * interpreted; each has its own publish / subscribe API.
821 * If the dataplane receives one of these and doesn't have an
822 * active subscription for it, the message will be silently freed.
825 define from_netconf_server {
831 define want_from_netconf_server {
838 define want_from_netconf_server_reply {
843 define to_netconf_server {
849 define want_to_netconf_server {
856 define want_to_netconf_server_reply {
861 define from_netconf_client {
867 define want_from_netconf_client {
874 define want_from_netconf_client_reply {
879 define to_netconf_client {
885 define want_to_netconf_client {
892 define want_to_netconf_client_reply {
897 /** \brief Set the ip flow hash config for a fib request
898 @param client_index - opaque cookie to identify the sender
899 @param context - sender context, to match reply w/ request
900 @param vrf_id - vrf/fib id
901 @param is_ipv6 - if non-zero the fib is ip6, else ip4
902 @param src - if non-zero include src in flow hash
903 @param dst - if non-zero include dst in flow hash
904 @param sport - if non-zero include sport in flow hash
905 @param dport - if non-zero include dport in flow hash
906 @param proto -if non-zero include proto in flow hash
907 @param reverse - if non-zero include reverse in flow hash
909 define set_ip_flow_hash {
922 /** \brief Set the ip flow hash config for a fib response
923 @param context - sender context, to match reply w/ request
924 @param retval - return code for the request
926 define set_ip_flow_hash_reply {
931 /** \brief IPv6 router advertisement config request
932 @param client_index - opaque cookie to identify the sender
933 @param context - sender context, to match reply w/ request
938 @param send_unicast -
941 @param default_router -
942 @param max_interval -
943 @param min_interval -
945 @param initial_count -
946 @param initial_interval -
948 define sw_interface_ip6nd_ra_config {
964 u32 initial_interval;
967 /** \brief IPv6 router advertisement config response
968 @param context - sender context, to match reply w/ request
969 @param retval - return code for the request
971 define sw_interface_ip6nd_ra_config_reply {
976 /** \brief IPv6 router advertisement prefix config request
977 @param client_index - opaque cookie to identify the sender
978 @param context - sender context, to match reply w/ request
981 @param address_length -
983 @param no_advertise -
985 @param no_autoconfig -
988 @param val_lifetime -
989 @param pref_lifetime -
991 define sw_interface_ip6nd_ra_prefix {
1007 /** \brief IPv6 router advertisement prefix config response
1008 @param context - sender context, to match reply w/ request
1009 @param retval - return code for the request
1011 define sw_interface_ip6nd_ra_prefix_reply {
1016 /** \brief IPv6 interface enable / disable request
1017 @param client_index - opaque cookie to identify the sender
1018 @param context - sender context, to match reply w/ request
1019 @param sw_if_index - interface used to reach neighbor
1020 @param enable - if non-zero enable ip6 on interface, else disable
1022 define sw_interface_ip6_enable_disable {
1026 u8 enable; /* set to true if enable*/
1029 /** \brief IPv6 interface enable / disable response
1030 @param context - sender context, to match reply w/ request
1031 @param retval - return code for the request
1033 define sw_interface_ip6_enable_disable_reply {
1038 /** \brief IPv6 set link local address on interface request
1039 @param client_index - opaque cookie to identify the sender
1040 @param context - sender context, to match reply w/ request
1041 @param sw_if_index - interface to set link local on
1042 @param address[] - the new link local address
1043 @param address_length - link local address length
1045 define sw_interface_ip6_set_link_local_address {
1053 /** \brief IPv6 set link local address on interface response
1054 @param context - sender context, to match reply w/ request
1055 @param retval - error code for the request
1057 define sw_interface_ip6_set_link_local_address_reply {
1062 /** \brief Set unnumbered interface add / del request
1063 @param client_index - opaque cookie to identify the sender
1064 @param context - sender context, to match reply w/ request
1065 @param sw_if_index - interface with an IP address
1066 @param unnumbered_sw_if_index - interface which will use the address
1067 @param is_add - if non-zero set the association, else unset it
1069 define sw_interface_set_unnumbered {
1072 u32 sw_if_index; /* use this intfc address */
1073 u32 unnumbered_sw_if_index; /* on this interface */
1077 /** \brief Set unnumbered interface add / del response
1078 @param context - sender context, to match reply w/ request
1079 @param retval - return code for the request
1081 define sw_interface_set_unnumbered_reply {
1086 /** \brief Create loopback interface request
1087 @param client_index - opaque cookie to identify the sender
1088 @param context - sender context, to match reply w/ request
1089 @param mac_address - mac addr to assign to the interface if none-zero
1091 define create_loopback {
1097 /** \brief Create loopback interface response
1098 @param context - sender context, to match reply w/ request
1099 @param sw_if_index - sw index of the interface that was created
1100 @param retval - return code for the request
1102 define create_loopback_reply {
1108 /** \brief Delete loopback interface request
1109 @param client_index - opaque cookie to identify the sender
1110 @param context - sender context, to match reply w/ request
1111 @param sw_if_index - sw index of the interface that was created
1113 define delete_loopback {
1119 /** \brief Delete loopback interface response
1120 @param context - sender context, to match reply w/ request
1121 @param retval - return code for the request
1123 define delete_loopback_reply {
1128 /** \brief Control ping from client to api server request
1129 @param client_index - opaque cookie to identify the sender
1130 @param context - sender context, to match reply w/ request
1132 manual_java define control_ping {
1137 /** \brief Control ping from the client to the server response
1138 @param client_index - opaque cookie to identify the sender
1139 @param context - sender context, to match reply w/ request
1140 @param retval - return code for the request
1141 @param vpe_pid - the pid of the vpe, returned by the server
1143 manual_java define control_ping_reply {
1150 /** \brief Process a vpe parser cli string request
1151 @param client_index - opaque cookie to identify the sender
1152 @param context - sender context, to match reply w/ request
1153 @param cmd_in_shmem - pointer to cli command string
1155 define cli_request {
1161 /** \brief vpe parser cli string response
1162 @param context - sender context, to match reply w/ request
1163 @param retval - return code for request
1164 @param reply_in_shmem - Reply string from cli processing if any
1172 /** \brief Set max allowed ARP or ip6 neighbor entries request
1173 @param client_index - opaque cookie to identify the sender
1174 @param context - sender context, to match reply w/ request
1175 @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1176 @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1178 define set_arp_neighbor_limit {
1182 u32 arp_neighbor_limit;
1185 /** \brief Set max allowed ARP or ip6 neighbor entries response
1186 @param context - sender context, to match reply w/ request
1187 @param retval - return code for request
1189 define set_arp_neighbor_limit_reply {
1194 /** \brief L2 interface patch add / del request
1195 @param client_index - opaque cookie to identify the sender
1196 @param context - sender context, to match reply w/ request
1197 @param rx_sw_if_index - receive side interface
1198 @param tx_sw_if_index - transmit side interface
1199 @param is_add - if non-zero set up the interface patch, else remove it
1201 define l2_patch_add_del {
1209 /** \brief L2 interface patch add / del response
1210 @param context - sender context, to match reply w/ request
1211 @param retval - return code for the request
1213 define l2_patch_add_del_reply {
1218 /** \brief IPv6 segment routing tunnel add / del request
1219 @param client_index - opaque cookie to identify the sender
1220 @param context - sender context, to match reply w/ request
1221 @param is_add - add the tunnel if non-zero, else delete it
1222 @param src_address[] -
1223 @param dst_address[] -
1224 @param dst_mask_width -
1225 @param inner_vrf_id -
1226 @param outer_vrf_id -
1227 @param flags_net_byte_order -
1230 @param segs_and_tags[] -
1232 define sr_tunnel_add_del {
1241 u16 flags_net_byte_order;
1244 u8 segs_and_tags[0];
1247 /** \brief IPv6 segment routing tunnel add / del response
1248 @param context - sender context, to match reply w/ request
1249 @param retval - return value for request
1251 define sr_tunnel_add_del_reply {
1256 /** \brief Interface set vpath request
1257 @param client_index - opaque cookie to identify the sender
1258 @param context - sender context, to match reply w/ request
1259 @param sw_if_index - interface used to reach neighbor
1260 @param enable - if non-zero enable, else disable
1262 define sw_interface_set_vpath {
1269 /** \brief Interface set vpath response
1270 @param context - sender context, to match reply w/ request
1271 @param retval - return code for the request
1273 define sw_interface_set_vpath_reply {
1278 /** \brief MPLS Ethernet add / del tunnel request
1279 @param client_index - opaque cookie to identify the sender
1280 @param context - sender context, to match reply w/ request
1281 @param vrf_id - vrf_id, only for IP4
1282 @param sw_if_index - interface used to reach neighbor
1283 @param is_add - add if set, tunnel delete if 0
1284 @param dst_mac_address -
1285 @param adj_address -
1286 @param adj_address_length -
1288 define mpls_ethernet_add_del_tunnel {
1295 u8 dst_mac_address[6];
1297 u8 adj_address_length;
1300 /** \brief Reply for MPLS Ethernet add / delete tunnel request
1301 @param context - sender context, to match reply w/ request
1302 @param retval - return code for the request
1304 define mpls_ethernet_add_del_tunnel_reply {
1307 u32 tunnel_sw_if_index;
1309 /** \brief MPLS Ethernet add/ del tunnel 2
1310 @param client_index - opaque cookie to identify the sender
1311 @param context - sender context, to match reply w/ request
1312 @param inner_vrf_id -
1313 @param outer_vrf_id -
1314 @param resolve_attempts -
1315 @param resolve_opaque -
1316 @param resolve_if_needed -
1318 @param adj_address -
1319 @param adj_address_length -
1320 @param next_hop_ip4_address_in_outer_vrf -
1322 define mpls_ethernet_add_del_tunnel_2 {
1327 u32 resolve_attempts;
1328 u32 resolve_opaque; /* no need to set this */
1329 u8 resolve_if_needed;
1333 u8 adj_address_length;
1334 u8 next_hop_ip4_address_in_outer_vrf [4];
1337 /** \brief MPLS Ethernet add/ del tunnel 2
1338 @param context - sender context, to match reply w/ request
1339 @param retval - return code for add /del request
1341 define mpls_ethernet_add_del_tunnel_2_reply {
1346 /** \brief Set L2 XConnect between two interfaces request
1347 @param client_index - opaque cookie to identify the sender
1348 @param context - sender context, to match reply w/ request
1349 @param rx_sw_if_index - Receive interface index
1350 @param tx_sw_if_index - Transmit interface index
1351 @param enable - enable xconnect if not 0, else set to L3 mode
1353 define sw_interface_set_l2_xconnect {
1361 /** \brief Set L2 XConnect response
1362 @param context - sender context, to match reply w/ request
1363 @param retval - L2 XConnect request return code
1365 define sw_interface_set_l2_xconnect_reply {
1370 /** \brief Interface bridge mode request
1371 @param client_index - opaque cookie to identify the sender
1372 @param context - sender context, to match reply w/ request
1373 @param rx_sw_if_index - the interface
1374 @param bd_id - bridge domain id
1375 @param bvi - Setup interface as a bvi, bridge mode only
1376 @param shg - Shared horizon group, for bridge mode only
1377 @param enable - Enable beige mode if not 0, else set to L3 mode
1379 define sw_interface_set_l2_bridge {
1389 /** \brief Interface bridge mode response
1390 @param context - sender context, to match reply w/ request
1391 @param retval - Bridge mode request return code
1393 define sw_interface_set_l2_bridge_reply {
1398 /** \brief L2 FIB add entry request
1399 @param client_index - opaque cookie to identify the sender
1400 @param context - sender context, to match reply w/ request
1401 @param mac - the entry's mac address
1402 @param bd_id - the entry's bridge domain id
1403 @param sw_if_index - the interface
1404 @param is_add - If non zero add the entry, else delete it
1408 define l2fib_add_del {
1419 /** \brief L2 FIB add entry response
1420 @param context - sender context, to match reply w/ request
1421 @param retval - return code for the add l2fib entry request
1423 define l2fib_add_del_reply {
1428 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
1429 @param client_index - opaque cookie to identify the sender
1430 @param context - sender context, to match reply w/ request
1431 @param sw_if_index - interface
1432 @param is_set - if non-zero, set the bits, else clear them
1433 @param feature_bitmap - non-zero bits to set or clear
1443 /** \brief Set L2 bits response
1444 @param context - sender context, to match reply w/ request
1445 @param retval - return code for the set l2 bits request
1447 define l2_flags_reply {
1450 u32 resulting_feature_bitmap;
1453 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
1454 L2_UU_FLOOD, or L2_ARP_TERM) request
1455 @param client_index - opaque cookie to identify the sender
1456 @param context - sender context, to match reply w/ request
1457 @param bd_id - the bridge domain to set the flags for
1458 @param is_set - if non-zero, set the flags, else clear them
1459 @param feature_bitmap - bits that are non-zero to set or clear
1461 define bridge_flags {
1469 /** \brief Set bridge flags response
1470 @param context - sender context, to match reply w/ request
1471 @param retval - return code for the set bridge flags request
1472 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
1474 define bridge_flags_reply {
1477 u32 resulting_feature_bitmap;
1480 /** \brief Set bridge domain ip to mac entry request
1481 @param client_index - opaque cookie to identify the sender
1482 @param context - sender context, to match reply w/ request
1483 @param bd_id - the bridge domain to set the flags for
1484 @param is_add - if non-zero, add the entry, else clear it
1485 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
1486 @param mac_address - MAC address
1489 define bd_ip_mac_add_del {
1499 /** \brief Set bridge domain ip to mac entry response
1500 @param context - sender context, to match reply w/ request
1501 @param retval - return code for the set bridge flags request
1503 define bd_ip_mac_add_del_reply {
1508 /** \brief Add/Delete classification table request
1509 @param client_index - opaque cookie to identify the sender
1510 @param context - sender context, to match reply w/ request
1511 @param is_add- if non-zero add the table, else delete it
1512 @param table_index - if add, reuturns index of the created table, else specifies the table to delete
1513 @param nbuckets - number of buckets when adding a table
1514 @param memory_size - memory size when adding a table
1515 @param match_n_vectors - number of match vectors
1516 @param next_table_index - index of next table
1517 @param miss_next_index - index of miss table
1518 @param mask[] - match mask
1520 define classify_add_del_table {
1528 u32 match_n_vectors;
1529 u32 next_table_index;
1530 u32 miss_next_index;
1534 /** \brief Add/Delete classification table response
1535 @param context - sender context, to match reply w/ request
1536 @param retval - return code for the table add/del requst
1537 @param new_table_index - for add, returned index of the new table
1538 @param skip_n_vectors - for add, returned value of skip_n_vectors in table
1539 @param match_n_vectors -for add, returned value of match_n_vectors in table
1541 define classify_add_del_table_reply {
1544 u32 new_table_index;
1546 u32 match_n_vectors;
1549 /** \brief Classify add / del session request
1550 @param client_index - opaque cookie to identify the sender
1551 @param context - sender context, to match reply w/ request
1552 @param is_add - add session if non-zero, else delete
1553 @param table_index - index of the table to add/del the session, required
1554 @param hit_next_index - for add, hit_next_index of new session, required
1555 @param opaque_index - for add, opaque_index of new session
1556 @param advance -for add, advance value for session
1557 @param match[] - for add, match value for session, required
1559 define classify_add_del_session {
1570 /** \brief Classify add / del session response
1571 @param context - sender context, to match reply w/ request
1572 @param retval - return code for the add/del session request
1574 define classify_add_del_session_reply {
1579 /** \brief Set/unset the classification table for an interface request
1580 @param client_index - opaque cookie to identify the sender
1581 @param context - sender context, to match reply w/ request
1582 @param is_ipv6 - ipv6 if non-zero, else ipv4
1583 @param sw_if_index - interface to associate with the table
1584 @param table_index - index of the table, if ~0 unset the table
1586 define classify_set_interface_ip_table {
1591 u32 table_index; /* ~0 => off */
1594 /** \brief Set/unset interface classification table response
1595 @param context - sender context, to match reply w/ request
1596 @param retval - return code
1598 define classify_set_interface_ip_table_reply {
1603 /** \brief Set/unset l2 classification tables for an interface request
1604 @param client_index - opaque cookie to identify the sender
1605 @param context - sender context, to match reply w/ request
1606 @param sw_if_index - interface to set/unset tables for
1607 @param ip4_table_index - ip4 index, use ~0 for all 3 indexes to unset
1608 @param ip6_table_index - ip6 index
1609 @param other_table_index - other index
1611 define classify_set_interface_l2_tables {
1616 u32 ip4_table_index;
1617 u32 ip6_table_index;
1618 u32 other_table_index;
1621 /** \brief Set/unset l2 classification tables for an interface response
1622 @param context - sender context, to match reply w/ request
1623 @param retval - return code for the request
1625 define classify_set_interface_l2_tables_reply {
1630 /** \brief Get node index using name request
1631 @param client_index - opaque cookie to identify the sender
1632 @param context - sender context, to match reply w/ request
1633 @param node_name[] - name of the node
1635 define get_node_index {
1641 /** \brief Get node index using name request
1642 @param context - sender context, to match reply w/ request
1643 @param retval - return code for the request
1644 @param node_index - index of the desired node if found, else ~0
1646 define get_node_index_reply {
1652 /** \brief Set the next node for a given node request
1653 @param client_index - opaque cookie to identify the sender
1654 @param context - sender context, to match reply w/ request
1655 @param node_name[] - node to add the next node to
1656 @param next_name[] - node to add as the next node
1658 define add_node_next {
1665 /** \brief IP Set the next node for a given node response
1666 @param context - sender context, to match reply w/ request
1667 @param retval - return code for the add next node request
1668 @param next_index - the index of the next node if success, else ~0
1670 define add_node_next_reply {
1676 /** \brief DHCP Proxy config 2 add / del request
1677 @param client_index - opaque cookie to identify the sender
1678 @param context - sender context, to match reply w/ request
1679 @param rx_vrf_id - receive vrf id
1680 @param server_vrf_id - server vrf id
1681 @param if_ipv6 - ipv6 if non-zero, else ipv4
1682 @param is_add - add the config if non-zero, else delete
1683 @param insert_circuit_id - option82 suboption 1 fib number
1684 @param dhcp_server[] - server address
1685 @param dhcp_src_address[] - <fix this, need details>
1687 define dhcp_proxy_config_2 {
1694 u8 insert_circuit_id;
1696 u8 dhcp_src_address[16];
1699 /** \brief DHCP Proxy config 2 add / del response
1700 @param context - sender context, to match reply w/ request
1701 @param retval - return code for request
1703 define dhcp_proxy_config_2_reply {
1708 /** \brief l2tpv3 tunnel interface create request
1709 @param client_index - opaque cookie to identify the sender
1710 @param context - sender context, to match reply w/ request
1711 @param client_address - remote client tunnel ip address
1712 @param client_address - local tunnel ip address
1713 @param is_ipv6 - ipv6 if non-zero, else ipv4
1714 @param local_session_id - local tunnel session id
1715 @param remote_session_id - remote tunnel session id
1716 @param local_cookie - local tunnel cookie
1717 @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
1719 define l2tpv3_create_tunnel {
1722 u8 client_address [16];
1723 u8 our_address [16];
1725 u32 local_session_id;
1726 u32 remote_session_id;
1729 u8 l2_sublayer_present;
1732 /** \brief l2tpv3 tunnel interface create response
1733 @param context - sender context, to match reply w/ request
1734 @param retval - return code for the request
1735 @param sw_if_index - index of the new tunnel interface
1737 define l2tpv3_create_tunnel_reply {
1743 define l2tpv3_set_tunnel_cookies {
1747 u64 new_local_cookie;
1748 u64 new_remote_cookie;
1751 /** \brief L2TP tunnel set cookies response
1752 @param context - sender context, to match reply w/ request
1753 @param retval - return code for the request
1755 define l2tpv3_set_tunnel_cookies_reply {
1760 manual_java define sw_if_l2tpv3_tunnel_details {
1762 u8 interface_name[64];
1763 u8 client_address [16];
1764 u8 our_address [16];
1765 u32 local_session_id;
1766 u32 remote_session_id;
1767 u64 local_cookie[2];
1769 u8 l2_sublayer_present;
1772 define sw_if_l2tpv3_tunnel_dump {
1777 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
1778 @param client_index - opaque cookie to identify the sender
1779 @param context - sender context, to match reply w/ request
1781 define l2_fib_clear_table {
1786 /** \brief L2 fib clear table response
1787 @param context - sender context, to match reply w/ request
1788 @param retval - return code for the request
1790 define l2_fib_clear_table_reply {
1795 /** \brief L2 interface ethernet flow point filtering enable/disable request
1796 @param client_index - opaque cookie to identify the sender
1797 @param context - sender context, to match reply w/ request
1798 @param sw_if_index - interface to enable/disable filtering on
1799 @param enable_disable - if non-zero enable filtering, else disable
1801 define l2_interface_efp_filter {
1808 /** \brief L2 interface ethernet flow point filtering response
1809 @param context - sender context, to match reply w/ request
1810 @param retval - return code for the request
1812 define l2_interface_efp_filter_reply {
1817 define l2tpv3_interface_enable_disable {
1824 define l2tpv3_interface_enable_disable_reply {
1829 define l2tpv3_set_lookup_key {
1832 /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
1836 define l2tpv3_set_lookup_key_reply {
1841 define vxlan_add_del_tunnel {
1848 u32 decap_next_index;
1852 define vxlan_add_del_tunnel_reply {
1858 manual_java define vxlan_tunnel_dump {
1864 manual_java define vxlan_tunnel_details {
1870 u32 decap_next_index;
1874 /** \brief L2 interface vlan tag rewrite configure request
1875 @param client_index - opaque cookie to identify the sender
1876 @param context - sender context, to match reply w/ request
1877 @param sw_if_index - interface the operation is applied to
1878 @param vtr_op - Choose from l2_vtr_op_t enum values
1879 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
1880 @param tag1 - Needed for any push or translate vtr op
1881 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
1883 define l2_interface_vlan_tag_rewrite {
1888 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
1889 u32 tag1; // first pushed tag
1890 u32 tag2; // second pushed tag
1893 /** \brief L2 interface vlan tag rewrite response
1894 @param context - sender context, to match reply w/ request
1895 @param retval - return code for the request
1897 define l2_interface_vlan_tag_rewrite_reply {
1902 /** \brief vhost-user interface create request
1903 @param client_index - opaque cookie to identify the sender
1904 @param is_server - our side is socket server
1905 @param sock_filename - unix socket filename, used to speak with frontend
1907 define create_vhost_user_if {
1911 u8 sock_filename[256];
1913 u32 custom_dev_instance;
1916 /** \brief vhost-user interface create response
1917 @param context - sender context, to match reply w/ request
1918 @param retval - return code for the request
1919 @param sw_if_index - interface the operation is applied to
1921 define create_vhost_user_if_reply {
1927 /** \brief vhost-user interface modify request
1928 @param client_index - opaque cookie to identify the sender
1929 @param is_server - our side is socket server
1930 @param sock_filename - unix socket filename, used to speak with frontend
1932 define modify_vhost_user_if {
1937 u8 sock_filename[256];
1939 u32 custom_dev_instance;
1942 /** \brief vhost-user interface modify response
1943 @param context - sender context, to match reply w/ request
1944 @param retval - return code for the request
1946 define modify_vhost_user_if_reply {
1951 /** \brief vhost-user interface delete request
1952 @param client_index - opaque cookie to identify the sender
1954 define delete_vhost_user_if {
1960 /** \brief vhost-user interface delete response
1961 @param context - sender context, to match reply w/ request
1962 @param retval - return code for the request
1964 define delete_vhost_user_if_reply {
1969 define create_subif {
1975 /* These fields map directly onto the subif template */
1979 u8 dot1ad; // 0 = dot1q, 1=dot1ad
1982 u8 outer_vlan_id_any;
1983 u8 inner_vlan_id_any;
1988 define create_subif_reply {
1994 /** \brief show version
1995 @param client_index - opaque cookie to identify the sender
1996 @param context - sender context, to match reply w/ request
1998 define show_version {
2003 /** \brief show version response
2004 @param context - sender context, to match reply w/ request
2005 @param retval - return code for the request
2006 @param program - name of the program (vpe)
2007 @param version - version of the program
2008 @param build_directory - root of the workspace where the program was built
2010 manual_java define show_version_reply {
2016 u8 build_directory[256];
2019 define nsh_gre_add_del_tunnel {
2026 u32 decap_next_index;
2027 u8 tlv_len_in_words;
2033 /* in network byte order */
2042 define nsh_gre_add_del_tunnel_reply {
2048 /** \brief Vhost-user interface details structure (fix this)
2049 @param sw_if_index - index of the interface
2050 @param interface_name - name of interface
2051 @param virtio_net_hdr_sz - net header size
2052 @param features - interface features
2053 @param is_server - vhost-user server socket
2054 @param sock_filename - socket filename
2055 @param num_regions - number of used memory regions
2057 manual_java define sw_interface_vhost_user_details {
2059 u8 interface_name[64];
2060 u32 virtio_net_hdr_sz;
2063 u8 sock_filename[256];
2069 define sw_interface_vhost_user_dump {
2074 manual_java define ip_address_details {
2081 manual_java define ip_address_dump {
2088 manual_java define ip_details {
2099 /** \brief l2 fib table entry structure
2100 @param bd_id - the l2 fib / bridge domain table id
2101 @param mac - the entry's mac address
2102 @param sw_if_index - index of the interface
2103 @param static_mac - the entry is statically configured.
2104 @param filter_mac - the entry is a mac filter entry.
2105 @param bvi_mac - the mac address is a bridge virtual interface
2107 manual_java define l2_fib_table_entry {
2116 /** \brief Dump l2 fib (aka bridge domain) table
2117 @param client_index - opaque cookie to identify the sender
2118 @param bd_id - the l2 fib / bridge domain table identifier
2120 manual_java define l2_fib_table_dump {
2126 define nsh_vxlan_gpe_add_del_tunnel {
2133 u32 decap_next_index;
2135 u8 tlv_len_in_words;
2141 /* in network byte order */
2150 define nsh_vxlan_gpe_add_del_tunnel_reply {
2156 define lisp_gpe_add_del_tunnel {
2163 u32 decap_next_index;
2169 /* in network byte order */
2173 define lisp_gpe_add_del_tunnel_reply {
2179 /* Gross kludge, DGMS */
2180 define interface_name_renumber {
2184 u32 new_show_dev_instance;
2187 define interface_name_renumber_reply {
2192 /** \brief Register for ip4 arp resolution events
2193 @param client_index - opaque cookie to identify the sender
2194 @param context - sender context, to match reply w/ request
2195 @param enable_disable - 1 => register for events, 0 => cancel registration
2196 @param pid - sender's pid
2197 @param address - the exact ip4 address of interest
2199 define want_ip4_arp_events {
2207 /** \brief Reply for interface events registration
2208 @param context - returned sender context, to match reply w/ request
2209 @param retval - return code
2211 define want_ip4_arp_events_reply {
2216 /** \brief Tell client about an ip4 arp resolution event
2217 @param client_index - opaque cookie to identify the sender
2218 @param context - sender context, to match reply w/ request
2219 @param address - the exact ip4 address of interest
2220 @param pid - client pid registered to receive notification
2221 @param sw_if_index - interface which received ARP packet
2222 @param new_mac - the new mac address
2224 define ip4_arp_event {
2233 /** \brief L2 bridge domain add or delete request
2234 @param client_index - opaque cookie to identify the sender
2235 @param context - sender context, to match reply w/ request
2236 @param bd_id - the bridge domain to create
2237 @param flood - enable/disable bcast/mcast flooding in the bd
2238 @param uu_flood - enable/disable uknown unicast flood in the bd
2239 @param forward - enable/disable forwarding on all interfaces in the bd
2240 @param learn - enable/disable learning on all interfaces in the bd
2241 @param arp_term - enable/disable arp termination in the bd
2242 @param is_add - add or delete flag
2244 define bridge_domain_add_del {
2256 /** \brief L2 bridge domain add or delete response
2257 @param context - sender context, to match reply w/ request
2258 @param retval - return code for the set bridge flags request
2260 define bridge_domain_add_del_reply {
2265 /** \brief L2 bridge domain request operational state details
2266 @param client_index - opaque cookie to identify the sender
2267 @param context - sender context, to match reply w/ request
2268 @param bd_id - the bridge domain id desired or ~0 to request all bds
2270 manual_java define bridge_domain_dump {
2276 /** \brief L2 bridge domain operational state response
2277 @param bd_id - the bridge domain id
2278 @param flood - bcast/mcast flooding state on all interfaces in the bd
2279 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
2280 @param forward - forwarding state on all interfaces in the bd
2281 @param learn - learning state on all interfaces in the bd
2282 @param arp_term - arp termination state on all interfaces in the bd
2283 @param n_sw_ifs - number of sw_if_index's in the domain
2285 manual_java define bridge_domain_details {
2293 u32 bvi_sw_if_index;
2297 /** \brief L2 bridge domain sw interface operational state response
2298 @param bd_id - the bridge domain id
2299 @param sw_if_index - sw_if_index in the domain
2300 @param shg - split horizon group for the interface
2302 manual_java define bridge_domain_sw_if_details {
2309 /** \brief DHCP Client config add / del request
2310 @param client_index - opaque cookie to identify the sender
2311 @param context - sender context, to match reply w/ request
2312 @param sw_if_index - index of the interface for DHCP client
2313 @param hostname - hostname
2314 @param is_add - add the config if non-zero, else delete
2315 @param want_dhcp_event - DHCP event sent to the sender
2316 via dhcp_compl_event API message if non-zero
2317 @param pid - sender's pid
2319 define dhcp_client_config {
2329 /** \brief DHCP Client config response
2330 @param context - sender context, to match reply w/ request
2331 @param retval - return code for the request
2333 define dhcp_client_config_reply {
2338 /** \brief Set/unset input ACL interface
2339 @param client_index - opaque cookie to identify the sender
2340 @param context - sender context, to match reply w/ request
2341 @param sw_if_index - interface to set/unset input ACL
2342 @param ip4_table_index - ip4 classify table index (~0 for skip)
2343 @param ip6_table_index - ip6 classify table index (~0 for skip)
2344 @param l2_table_index - l2 classify table index (~0 for skip)
2345 @param is_add - Set input ACL if non-zero, else unset
2346 Note: User is recommeneded to use just one valid table_index per call.
2347 (ip4_table_index, ip6_table_index, or l2_table_index)
2349 define input_acl_set_interface {
2353 u32 ip4_table_index;
2354 u32 ip6_table_index;
2359 /** \brief Set/unset input ACL interface response
2360 @param context - sender context, to match reply w/ request
2361 @param retval - return code for the request
2363 define input_acl_set_interface_reply {
2368 /** \brief IPsec: Add/delete Security Policy Database
2369 @param client_index - opaque cookie to identify the sender
2370 @param context - sender context, to match reply w/ request
2371 @param is_add - add SPD if non-zero, else delete
2372 @param spd_id - SPD instance id (control plane allocated)
2375 define ipsec_spd_add_del {
2382 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2383 @param context - returned sender context, to match reply w/ request
2384 @param retval - return code
2387 define ipsec_spd_add_del_reply {
2392 /** \brief IPsec: Add/delete SPD from interface
2394 @param client_index - opaque cookie to identify the sender
2395 @param context - sender context, to match reply w/ request
2396 @param is_add - add security mode if non-zero, else delete
2397 @param sw_if_index - index of the interface
2398 @param spd_id - SPD instance id to use for lookups
2402 define ipsec_interface_add_del_spd {
2411 /** \brief Reply for IPsec: Add/delete SPD from interface
2412 @param context - returned sender context, to match reply w/ request
2413 @param retval - return code
2416 define ipsec_interface_add_del_spd_reply {
2421 /** \brief IPsec: Add/delete Security Policy Database entry
2423 See RFC 4301, 4.4.1.1 on how to match packet to selectors
2425 @param client_index - opaque cookie to identify the sender
2426 @param context - sender context, to match reply w/ request
2427 @param is_add - add SPD if non-zero, else delete
2428 @param spd_id - SPD instance id (control plane allocated)
2429 @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower
2430 @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
2431 @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4
2432 @param remote_address_start - start of remote address range to match
2433 @param remote_address_stop - end of remote address range to match
2434 @param local_address_start - start of local address range to match
2435 @param local_address_stop - end of local address range to match
2436 @param protocol - protocol type to match [0 means any]
2437 @param remote_port_start - start of remote port range to match ...
2438 @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2439 @param local_port_start - start of local port range to match ...
2440 @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
2441 @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)
2442 @param sa_id - SAD instance id (control plane allocated)
2446 define ipsec_spd_add_del_entry {
2458 u8 remote_address_start[16];
2459 u8 remote_address_stop[16];
2460 u8 local_address_start[16];
2461 u8 local_address_stop[16];
2465 u16 remote_port_start;
2466 u16 remote_port_stop;
2467 u16 local_port_start;
2468 u16 local_port_stop;
2475 /** \brief Reply for IPsec: Add/delete Security Policy Database entry
2476 @param context - returned sender context, to match reply w/ request
2477 @param retval - return code
2480 define ipsec_spd_add_del_entry_reply {
2485 /** \brief IPsec: Add/delete Security Association Database entry
2486 @param client_index - opaque cookie to identify the sender
2487 @param context - sender context, to match reply w/ request
2488 @param is_add - add SAD entry if non-zero, else delete
2490 @param sad_id - sad id
2492 @param spi - security parameter index
2494 @param protocol - 0 = AH, 1 = ESP
2496 @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC
2497 @param crypto_key_length - length of crypto_key in bytes
2498 @param crypto_key - crypto keying material
2500 @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512
2501 @param integrity_key_length - length of integrity_key in bytes
2502 @param integrity_key - integrity keying material
2504 @param use_extended_sequence_number - use ESN when non-zero
2506 @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode
2507 @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero
2508 @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
2509 @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
2513 IPsec tunnel address copy mode (to support GDOI)
2516 define ipsec_sad_add_del_entry {
2527 u8 crypto_algorithm;
2528 u8 crypto_key_length;
2531 u8 integrity_algorithm;
2532 u8 integrity_key_length;
2533 u8 integrity_key[128];
2535 u8 use_extended_sequence_number;
2539 u8 tunnel_src_address[16];
2540 u8 tunnel_dst_address[16];
2543 /** \brief Reply for IPsec: Add/delete Security Association Database entry
2544 @param context - returned sender context, to match reply w/ request
2545 @param retval - return code
2548 define ipsec_sad_add_del_entry_reply {
2553 /** \brief IPsec: Update Security Association keys
2554 @param client_index - opaque cookie to identify the sender
2555 @param context - sender context, to match reply w/ request
2557 @param sa_id - sa id
2559 @param crypto_key_length - length of crypto_key in bytes
2560 @param crypto_key - crypto keying material
2562 @param integrity_key_length - length of integrity_key in bytes
2563 @param integrity_key - integrity keying material
2566 define ipsec_sa_set_key {
2572 u8 crypto_key_length;
2575 u8 integrity_key_length;
2576 u8 integrity_key[128];
2579 /** \brief Reply for IPsec: Update Security Association keys
2580 @param context - returned sender context, to match reply w/ request
2581 @param retval - return code
2584 define ipsec_sa_set_key_reply {
2589 /** \brief Tell client about a DHCP completion event
2590 @param client_index - opaque cookie to identify the sender
2591 @param pid - client pid registered to receive notification
2592 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
2593 @param host_address - Host IP address
2594 @param router_address - Router IP address
2595 @param host_mac - Host MAC address
2597 manual_java define dhcp_compl_event {
2602 u8 host_address[16];
2603 u8 router_address[16];
2607 /** \brief Add MAP domains
2608 @param client_index - opaque cookie to identify the sender
2609 @param context - sender context, to match reply w/ request
2610 @param ip6_prefix - Rule IPv6 prefix
2611 @param ip4_prefix - Rule IPv4 prefix
2612 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
2613 @param ip6_prefix_len - Rule IPv6 prefix length
2614 @param ip4_prefix_len - Rule IPv4 prefix length
2615 @param ea_bits_len - Embedded Address bits length
2616 @param psid_offset - Port Set Identifider (PSID) offset
2617 @param psid_length - PSID length
2618 @param is_translation - MAP-E / MAP-T
2621 define map_add_domain {
2629 u8 ip6_src_prefix_len;
2637 /** \brief Reply for MAP domain add
2638 @param context - returned sender context, to match reply w/ request
2639 @param index - MAP domain index
2640 @param retval - return code
2642 define map_add_domain_reply {
2648 /** \brief Delete MAP domain
2649 @param client_index - opaque cookie to identify the sender
2650 @param context - sender context, to match reply w/ request
2651 @param index - MAP Domain index
2653 define map_del_domain {
2659 /** \brief Reply for MAP domain del
2660 @param context - returned sender context, to match reply w/ request
2661 @param retval - return code
2663 define map_del_domain_reply {
2668 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
2669 @param client_index - opaque cookie to identify the sender
2670 @param context - sender context, to match reply w/ request
2671 @param index - MAP Domain index
2672 @param is_add - If 1 add rule, if 0 delete rule
2673 @param ip6_dst - MAP CE IPv6 address
2674 @param psid - Rule PSID
2676 define map_add_del_rule {
2685 /** \brief Reply for MAP rule add/del
2686 @param context - returned sender context, to match reply w/ request
2687 @param retval - return code
2689 define map_add_del_rule_reply {
2694 /** \brief Get list of map domains
2695 @param client_index - opaque cookie to identify the sender
2697 define map_domain_dump {
2702 manual_java define map_domain_details {
2718 define map_rule_dump {
2724 manual_java define map_rule_details {
2729 /** \brief Request for a single block of summary stats
2730 @param client_index - opaque cookie to identify the sender
2731 @param context - sender context, to match reply w/ request
2733 define map_summary_stats {
2738 /** \brief Reply for map_summary_stats request
2739 @param context - sender context, to match reply w/ request
2740 @param retval - return code for request
2741 @param total_bindings -
2743 @param total_ip4_fragments -
2744 @param total_security_check -
2746 define map_summary_stats_reply {
2752 u64 total_ip4_fragments;
2753 u64 total_security_check[2];