2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 option version = "2.4.1";
20 * @brief VPP control-plane API messages.
22 * This file defines VPP control-plane API messages which are generally
23 * called through a shared memory interface.
27 * Common NAT plugin APIs
30 /** \brief Control ping from client to api server request
31 @param client_index - opaque cookie to identify the sender
32 @param context - sender context, to match reply w/ request
34 define nat_control_ping
40 /** \brief Control ping from the client to the server response
41 @param client_index - opaque cookie to identify the sender
42 @param context - sender context, to match reply w/ request
43 @param retval - return code for the request
44 @param vpe_pid - the pid of the vpe, returned by the server
46 define nat_control_ping_reply
54 /** \brief Show NAT plugin startup config
55 @param client_index - opaque cookie to identify the sender
56 @param context - sender context, to match reply w/ request
58 define nat_show_config
64 /** \brief Show NAT plugin startup config reply
65 @param context - sender context, to match reply w/ request
66 @param retval - return code for the request
67 @param static_mapping_only - if 1 dynamic translations disabled
68 @param static_mapping_connection_tracking - if 1 create session data
69 @param deterministic - if 1 deterministic mapping
70 @param translation_buckets - number of translation hash buckets
71 @param translation_memory_size - translation hash memory size
72 @param user_buckets - number of user hash buckets
73 @param user_memory_size - user hash memory size
74 @param max_translations_per_user - maximum number of translations per user
75 @param outside_vrf_id - outside VRF id
76 @param inside_vrf_id - default inside VRF id
78 define nat_show_config_reply
82 u8 static_mapping_only;
83 u8 static_mapping_connection_tracking;
85 u32 translation_buckets;
86 u32 translation_memory_size;
89 u32 max_translations_per_user;
94 /** \brief Set NAT workers
95 @param client_index - opaque cookie to identify the sender
96 @param context - sender context, to match reply w/ request
97 @param worker_mask - NAT workers mask
99 autoreply define nat_set_workers {
105 /** \brief Dump NAT workers
106 @param client_index - opaque cookie to identify the sender
107 @param context - sender context, to match reply w/ request
109 define nat_worker_dump {
114 /** \brief NAT workers details response
115 @param context - sender context, to match reply w/ request
116 @param worker_index - worker index
117 @param lcore_id - lcore ID
118 @param name - worker name
120 define nat_worker_details {
127 /** \brief Enable/disable NAT IPFIX logging
128 @param client_index - opaque cookie to identify the sender
129 @param context - sender context, to match reply w/ request
130 @param domain_id - observation domain ID
131 @param src_port - source port number
132 @param enable - 1 if enable, 0 if disable
134 autoreply define nat_ipfix_enable_disable {
142 /** \brief Set NAT virtual fragmentation reassembly
143 @param client_index - opaque cookie to identify the sender
144 @param context - sender context, to match reply w/ request
145 @param timeout - reassembly timeout
146 @param max_reass - maximum number of concurrent reassemblies
147 @param max_frag - maximum number of fragmets per reassembly
148 @param drop_frag - if 0 translate fragments, otherwise drop fragments
149 @param is_ip6 - 1 if IPv6, 0 if IPv4
151 autoreply define nat_set_reass {
161 /** \brief Get NAT virtual fragmentation reassembly configuration
162 @param client_index - opaque cookie to identify the sender
163 @param context - sender context, to match reply w/ request
165 define nat_get_reass {
170 /** \brief Get NAT virtual fragmentation reassembly configuration reply
171 @param context - sender context, to match reply w/ request
172 @param retval - return code
173 @param ip4_timeout - reassembly timeout
174 @param ip4_max_reass - maximum number of concurrent reassemblies
175 @param ip4_max_frag - maximum number of fragmets per reassembly
176 @param ip4_drop_frag - if 0 translate fragments, otherwise drop fragments
177 @param ip6_timeout - reassembly timeout
178 @param ip6_max_reass - maximum number of concurrent reassemblies
179 @param ip6_max_frag - maximum number of fragmets per reassembly
180 @param ip6_drop_frag - if 0 translate fragments, otherwise drop fragments
182 define nat_get_reass_reply {
195 /** \brief Dump NAT virtual fragmentation reassemblies
196 @param client_index - opaque cookie to identify the sender
197 @param context - sender context, to match reply w/ request
199 define nat_reass_dump {
204 /** \brief NAT virtual fragmentation reassemblies response
205 @param context - sender context, to match reply w/ request
206 @param is_ip4 - 1 if address type is IPv4
207 @param src_addr - source IP address
208 @param dst_addr - destination IP address
209 @param frag_id - fragment ID
210 @param proto - protocol
211 @param frag_n - number of cached fragments
213 define nat_reass_details {
227 /** \brief Add/del NAT44 address range
228 @param client_index - opaque cookie to identify the sender
229 @param context - sender context, to match reply w/ request
230 @param first_ip_address - first IPv4 address
231 @param last_ip_address - last IPv4 address
232 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
233 @param twice_nat - twice NAT address range for extenal hosts
234 @param is_add - 1 if add, 0 if delete
236 autoreply define nat44_add_del_address_range {
239 u8 first_ip_address[4];
240 u8 last_ip_address[4];
246 /** \brief Dump NAT44 addresses
247 @param client_index - opaque cookie to identify the sender
248 @param context - sender context, to match reply w/ request
250 define nat44_address_dump {
255 /** \brief NAT44 address details response
256 @param context - sender context, to match reply w/ request
257 @param ip_address - IPv4 address
258 @param twice_nat - twice NAT address range for extenal hosts
259 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
261 define nat44_address_details {
268 /** \brief Enable/disable NAT44 feature on the interface
269 @param client_index - opaque cookie to identify the sender
270 @param context - sender context, to match reply w/ request
271 @param is_add - 1 if add, 0 if delete
272 @param is_inside - 1 if inside, 0 if outside
273 @param sw_if_index - software index of the interface
275 autoreply define nat44_interface_add_del_feature {
283 /** \brief Dump interfaces with NAT44 feature
284 @param client_index - opaque cookie to identify the sender
285 @param context - sender context, to match reply w/ request
287 define nat44_interface_dump {
292 /** \brief NAT44 interface details response
293 @param context - sender context, to match reply w/ request
294 @param is_inside - 1 if inside, 0 if outside, 2 if inside and outside
295 @param sw_if_index - software index of the interface
297 define nat44_interface_details {
303 /** \brief Enable/disbale NAT44 as an interface output feature (postrouting
305 @param client_index - opaque cookie to identify the sender
306 @param context - sender context, to match reply w/ request
307 @param is_add - 1 if add, 0 if delete
308 @param is_inside - 1 if inside, 0 if outside
309 @param sw_if_index - software index of the interface
311 autoreply define nat44_interface_add_del_output_feature {
319 /** \brief Dump interfaces with NAT44 output feature
320 @param client_index - opaque cookie to identify the sender
321 @param context - sender context, to match reply w/ request
323 define nat44_interface_output_feature_dump {
328 /** \brief NAT44 interface with output feature details response
329 @param context - sender context, to match reply w/ request
330 @param is_inside - 1 if inside, 0 if outside
331 @param sw_if_index - software index of the interface
333 define nat44_interface_output_feature_details {
339 /** \brief Add/delete NAT44 static mapping
340 @param client_index - opaque cookie to identify the sender
341 @param context - sender context, to match reply w/ request
342 @param is_add - 1 if add, 0 if delete
343 @param addr_only - 1 if address only mapping
344 @param local_ip_address - local IPv4 address
345 @param external_ip_address - external IPv4 address
346 @param protocol - IP protocol, used only if addr_only=0
347 @param local_port - local port number, used only if addr_only=0
348 @param external_port - external port number, used only if addr_only=0
349 @param external_sw_if_index - external interface (if set
350 external_ip_address is ignored, ~0 means not
352 @param vfr_id - VRF ID
353 @param twice_nat - if 1 translate external host address and port, only for
354 1:1 NAPT (addr_only must be 0)
355 @param out2in_only - if 1 rule match only out2in direction
356 @param tag - opaque string tag
358 autoreply define nat44_add_del_static_mapping {
363 u8 local_ip_address[4];
364 u8 external_ip_address[4];
368 u32 external_sw_if_index;
375 /** \brief Dump NAT44 static mappings
376 @param client_index - opaque cookie to identify the sender
377 @param context - sender context, to match reply w/ request
379 define nat44_static_mapping_dump {
384 /** \brief NAT44 static mapping details response
385 @param context - sender context, to match reply w/ request
386 @param addr_only - 1 if address only mapping
387 @param local_ip_address - local IPv4 address
388 @param external_ip_address - external IPv4 address
389 @param protocol - IP protocol, valid only if addr_only=0
390 @param local_port - local port number, valid only if addr_only=0
391 @param external_port - external port number, valid only if addr_only=0
392 @param external_sw_if_index - external interface
393 @param vfr_id - VRF ID
394 @param twice_nat - if 1 translate external host address and port
395 @param out2in_only - if 1 rule match only out2in direction
396 @param tag - opaque string tag
398 define nat44_static_mapping_details {
401 u8 local_ip_address[4];
402 u8 external_ip_address[4];
406 u32 external_sw_if_index;
413 /** \brief Add/delete NAT44 identity mapping
414 @param client_index - opaque cookie to identify the sender
415 @param context - sender context, to match reply w/ request
416 @param is_add - 1 if add, 0 if delete
417 @param addr_only - 1 if address only mapping
418 @param ip_address - IPv4 address
419 @param protocol - IP protocol
420 @param port - port number
421 @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
423 @param vfr_id - VRF ID (if ~0 use default VRF)
424 @param tag - opaque string tag
426 autoreply define nat44_add_del_identity_mapping {
439 /** \brief Dump NAT44 identity mappings
440 @param client_index - opaque cookie to identify the sender
441 @param context - sender context, to match reply w/ request
443 define nat44_identity_mapping_dump {
448 /** \brief NAT44 identity mapping details response
449 @param context - sender context, to match reply w/ request
450 @param addr_only - 1 if address only mapping
451 @param ip_address - IPv4 address
452 @param protocol - IP protocol
453 @param port - port number
454 @param sw_if_index - interface
455 @param vfr_id - VRF ID
456 @param tag - opaque string tag
458 define nat44_identity_mapping_details {
469 /** \brief Add/delete NAT44 pool address from specific interfce
470 @param client_index - opaque cookie to identify the sender
471 @param context - sender context, to match reply w/ request
472 @param is_add - 1 if add, 0 if delete
473 @param twice_nat - twice NAT address for extenal hosts
474 @param sw_if_index - software index of the interface
476 autoreply define nat44_add_del_interface_addr {
484 /** \brief Dump NAT44 pool addresses interfaces
485 @param client_index - opaque cookie to identify the sender
486 @param context - sender context, to match reply w/ request
488 define nat44_interface_addr_dump {
493 /** \brief NAT44 pool addresses interfaces details response
494 @param context - sender context, to match reply w/ request
495 @param sw_if_index - software index of the interface
496 @param twice_nat - twice NAT address for extenal hosts
498 define nat44_interface_addr_details {
504 /** \brief Dump NAT44 users
505 @param client_index - opaque cookie to identify the sender
506 @param context - sender context, to match reply w/ request
508 define nat44_user_dump {
513 /** \brief NAT44 users response
514 @param context - sender context, to match reply w/ request
516 @param ip_adress - IPv4 address
517 @param nsessions - number of dynamic sessions
518 @param nstaticsessions - number of static sessions
520 define nat44_user_details {
528 /** \brief NAT44 user's sessions
529 @param client_index - opaque cookie to identify the sender
530 @param context - sender context, to match reply w/ request
531 @param is_ip4 - 1 if address type is IPv4
532 @param user_ip - IP address of the user to dump
533 @param vrf_id - VRF_ID
535 define nat44_user_session_dump {
542 /** \brief NAT44 user's sessions response
543 @param context - sender context, to match reply w/ request
544 @param outside_ip_address - outside IPv4 address
545 @param outside_port - outside port
546 @param inside_ip_address - inside IPv4 address
547 @param inside_port - inside port
548 @param protocol - protocol
549 @param is_static - 1 if session is static
550 @param last_heard - last heard timer
551 @param total_bytes - count of bytes sent through session
552 @param total_pkts - count of pakets sent through session
554 define nat44_user_session_details {
556 u8 outside_ip_address[4];
558 u8 inside_ip_address[4];
567 /** \brief NAT44 load-balancing address and port pair
568 @param addr - IPv4 address of the internal node
569 @param port - L4 port number of the internal node
570 @param probability - probability of the internal node to be randomly matched
572 typeonly manual_endian define nat44_lb_addr_port {
578 /** \brief Add/delete NAT44 load-balancing static mapping rule
579 @param client_index - opaque cookie to identify the sender
580 @param context - sender context, to match reply w/ request
581 @param is_add - 1 if add, 0 if delete
582 @param external_addr - external IPv4 address of the service
583 @param external_port - external L4 port number of the service
584 @param protocol - IP protocol number of the service
585 @param vrf_id - internal network VRF ID
586 @param twice_nat - if 1 translate external host address and port
587 @param out2in_only - if 1 rule match only out2in direction
588 @param tag - opaque string tag
589 @param local_num - number of local network nodes
590 @param locals - local network nodes
592 autoreply manual_endian define nat44_add_del_lb_static_mapping {
604 vl_api_nat44_lb_addr_port_t locals[local_num];
607 /** \brief Dump NAT44 load-balancing static mapping rules
608 @param client_index - opaque cookie to identify the sender
609 @param context - sender context, to match reply w/ request
611 define nat44_lb_static_mapping_dump {
616 /** \brief NAT44 load-balancing static mapping rule details response
617 @param context - sender context, to match reply w/ request
618 @param is_add - 1 if add, 0 if delete
619 @param external_addr - external IPv4 address of the service
620 @param external_port - external L4 port number of the service
621 @param protocol - IP protocol number of the service
622 @param vrf_id - internal network VRF ID
623 @param twice_nat - if 1 translate external host address and port
624 @param out2in_only - if 1 rule match only out2in direction
625 @param tag - opaque string tag
626 @param local_num - number of local network nodes
627 @param locals - local network nodes
629 manual_endian define nat44_lb_static_mapping_details {
639 vl_api_nat44_lb_addr_port_t locals[local_num];
642 /** \brief Delete NAT44 session
643 @param client_index - opaque cookie to identify the sender
644 @param context - sender context, to match reply w/ request
645 @param is_in - 1 if inside network addres and port pari, 0 if outside
646 @param ip_address - IPv4 address
647 @param protocol - IP protocol
648 @param port - port number
649 @param vfr_id - VRF ID
651 autoreply define nat44_del_session {
661 /** \brief Enable/disable forwarding for NAT44
662 Forward packets which don't match existing translation
663 or static mapping instead of dropping them.
664 @param client_index - opaque cookie to identify the sender
665 @param context - sender context, to match reply w/ request
666 @param enable - 0 for enable, 1 for disable
668 autoreply define nat44_forwarding_enable_disable {
674 /** \brief Check if forwarding is enabled or disabled
675 @param client_index - opaque cookie to identify the sender
676 @param context - sender context, to match reply w/ request
678 define nat44_forwarding_is_enabled {
683 /** \brief Response to check if forwarding is enabled or disabled
684 @param context - sender context, to match reply w/ request
685 @param enabled - 1 if enabled, 0 if disabled
687 define nat44_forwarding_is_enabled_reply {
694 * Deterministic NAT (CGN) APIs
697 /** \brief Add/delete NAT deterministic mapping
698 @param client_index - opaque cookie to identify the sender
699 @param context - sender context, to match reply w/ request
700 @param is_add - 1 if add, 0 if delete
701 @param is_nat44 - 1 if NAT44
702 @param in_addr - inside IP address
703 @param in_plen - inside IP address prefix length
704 @param out_addr - outside IPv4 address
705 @param out_addr - outside IPv4 address prefix length
707 autoreply define nat_det_add_del_map {
719 /** \brief Get outside address and port range from inside address
720 @param client_index - opaque cookie to identify the sender
721 @param context - sender context, to match reply w/ request
722 @param is_nat44 - 1 if NAT44
723 @param in_addr - inside IP address
725 define nat_det_forward {
732 /** \brief Get outside address and port range from inside address
733 @param context - sender context, to match reply w/ request
734 @param retval - return code
735 @param out_port_lo - outside port range start
736 @param out_port_hi - outside port range end
737 @param out_addr - outside IPv4 address
739 define nat_det_forward_reply {
747 /** \brief Get inside address from outside address and port
748 @param client_index - opaque cookie to identify the sender
749 @param context - sender context, to match reply w/ request
750 @param out_port - outside port
751 @param out_addr - outside IPv4 address
753 define nat_det_reverse {
760 /** \brief Get inside address from outside address and port reply
761 @param context - sender context, to match reply w/ request
762 @param retval - return code
763 @param is_nat44 - 1 if NAT44
764 @param in_addr - inside IP address
766 define nat_det_reverse_reply {
773 /** \brief Dump NAT deterministic mappings
774 @param client_index - opaque cookie to identify the sender
775 @param context - sender context, to match reply w/ request
777 define nat_det_map_dump {
782 /** \brief NAT users response
783 @param context - sender context, to match reply w/ request
784 @param is_nat44 - 1 if NAT44
785 @param in_addr - inside IP address
786 @param in_plen - inside IP address prefix length
787 @param out_addr - outside IPv4 address
788 @param out_plen - outside IPv4 address prefix length
789 @param sharing_ratio - outside to inside address sharing ratio
790 @param ports_per_host - number of ports available to a host
791 @param ses_num - number of sessions belonging to this mapping
793 define nat_det_map_details {
805 /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
806 @param client_index - opaque cookie to identify the sender
807 @param context - sender context, to match reply w/ request
808 @param udp - UDP timeout (default 300sec)
809 @param tcp_established - TCP established timeout (default 7440sec)
810 @param tcp_transitory - TCP transitory timeout (default 240sec)
811 @param icmp - ICMP timeout (default 60sec)
813 autoreply define nat_det_set_timeouts {
822 /** \brief Get values of timeouts for deterministic NAT (seconds)
823 @param client_index - opaque cookie to identify the sender
824 @param context - sender context, to match reply w/ request
826 define nat_det_get_timeouts {
831 /** \brief Get values of timeouts for deterministic NAT reply
832 @param context - sender context, to match reply w/ request
833 @param retval - return code
834 @param udp - UDP timeout (default 300sec)
835 @param tcp_established - TCP established timeout (default 7440sec)
836 @param tcp_transitory - TCP transitory timeout (default 240sec)
837 @param icmp - ICMP timeout (default 60sec)
839 define nat_det_get_timeouts_reply {
848 /** \brief Close deterministic NAT session by outside address and port
849 @param client_index - opaque cookie to identify the sender
850 @param context - sender context, to match reply w/ request
851 @param out_addr - outside IPv4 address
852 @param out_port - outside port
853 @param ext_addr - external host IPv4 address
854 @param ext_port - external host port
856 autoreply define nat_det_close_session_out {
865 /** \brief Close deterministic NAT session by inside address and port
866 @param client_index - opaque cookie to identify the sender
867 @param context - sender context, to match reply w/ request
868 @param is_nat44 - 1 if NAT44
869 @param in_addr - inside IP address
870 @param in_port - inside port
871 @param ext_addr - external host IP address
872 @param ext_port - external host port
874 autoreply define nat_det_close_session_in {
884 /** \brief Dump determinstic NAT sessions
885 @param client_index - opaque cookie to identify the sender
886 @param context - sender context, to match reply w/ request
887 @param is_nat44 - 1 if NAT44
888 @param user_addr - address of an inside user whose sessions to dump
890 define nat_det_session_dump {
897 /** \brief Deterministic NAT sessions reply
898 @param context - sender context, to match reply w/ request
899 @param in_port - inside port
900 @param ext_addr - external host address
901 @param ext_port - external host port
902 @param out_port - outside NAT port
903 @param state - session state
904 @param expire - session expiration timestamp
906 define nat_det_session_details {
921 /** \brief Add/delete address range to NAT64 pool
922 @param client_index - opaque cookie to identify the sender
923 @param context - sender context, to match reply w/ request
924 @param start_addr - start address of the range
925 @param end_addr - end address of the range
926 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
927 @param is_add - 1 if add, 0 if delete
929 autoreply define nat64_add_del_pool_addr_range {
938 /** \brief Dump NAT64 pool addresses
939 @param client_index - opaque cookie to identify the sender
940 @param context - sender context, to match reply w/ request
942 define nat64_pool_addr_dump {
947 /** \brief NAT64 pool address details response
948 @param context - sender context, to match reply w/ request
949 @param address - IPv4 address
950 @param vfr_id - VRF id of tenant, ~0 means independent of VRF
952 define nat64_pool_addr_details {
958 /** \brief Enable/disable NAT64 feature on the interface
959 @param client_index - opaque cookie to identify the sender
960 @param context - sender context, to match reply w/ request
961 @param sw_if_index - index of the interface
962 @param is_inside - 1 if inside, 0 if outside
963 @param is_add - 1 if add, 0 if delete
965 autoreply define nat64_add_del_interface {
973 /** \brief Dump interfaces with NAT64 feature
974 @param client_index - opaque cookie to identify the sender
975 @param context - sender context, to match reply w/ request
977 define nat64_interface_dump {
982 /** \brief NAT64 interface details response
983 @param context - sender context, to match reply w/ request
984 @param is_inside - 1 if inside, 0 if outside
985 @param sw_if_index - index of the interface
987 define nat64_interface_details {
993 /** \brief Add/delete NAT64 static BIB entry
994 @param client_index - opaque cookie to identify the sender
995 @param context - sender context, to match reply w/ request
996 @param i_addr - inside IPv6 address
997 @param o_addr - outside IPv4 address
998 @param i_port - inside port number
999 @param o_port - outside port number
1000 @param vrf_id - VRF id of tenant
1001 @param proto - protocol number
1002 @param is_add - 1 if add, 0 if delete
1004 autoreply define nat64_add_del_static_bib {
1016 /** \brief Dump NAT64 BIB
1017 @param client_index - opaque cookie to identify the sender
1018 @param context - sender context, to match reply w/ request
1019 @param proto - protocol of the BIB: 255 - all BIBs
1023 otherwise - "unknown" protocol BIB
1025 define nat64_bib_dump {
1031 /** \brief NAT64 BIB details response
1032 @param context - sender context, to match reply w/ request
1033 @param i_addr - inside IPv6 address
1034 @param o_addr - outside IPv4 address
1035 @param i_port - inside port number
1036 @param o_port - outside port number
1037 @param vrf_id - VRF id of tenant
1038 @param proto - protocol number
1039 @param is_static - 1 if static BIB entry, 0 if dynamic
1040 @param ses_num - number of sessions associated with the BIB entry
1042 define nat64_bib_details {
1054 /** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
1055 @param client_index - opaque cookie to identify the sender
1056 @param context - sender context, to match reply w/ request
1057 @param udp - UDP timeout (default 300sec)
1058 @param icmp - ICMP timeout (default 60sec)
1059 @param tcp_trans - TCP transitory timeout (default 240sec)
1060 @param tcp_est - TCP established timeout (default 7440sec)
1061 @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
1063 autoreply define nat64_set_timeouts {
1070 u32 tcp_incoming_syn;
1073 /** \brief Get values of timeouts for NAT64 (seconds)
1074 @param client_index - opaque cookie to identify the sender
1075 @param context - sender context, to match reply w/ request
1077 define nat64_get_timeouts {
1082 /** \brief Get values of timeouts for NAT64 reply
1083 @param context - sender context, to match reply w/ request
1084 @param retval - return code
1085 @param udp - UDP timeout
1086 @param icmp - ICMP timeout
1087 @param tcp_trans - TCP transitory timeout
1088 @param tcp_est - TCP established timeout
1089 @param tcp_incoming_syn - TCP incoming SYN timeout
1091 define nat64_get_timeouts_reply {
1098 u32 tcp_incoming_syn;
1101 /** \brief Dump NAT64 session table
1102 @param client_index - opaque cookie to identify the sender
1103 @param context - sender context, to match reply w/ request
1104 @param proto - protocol of the session table: 255 - all STs
1108 otherwise - "unknown" proto ST
1110 define nat64_st_dump {
1116 /** \brief NAT64 session table details response
1117 @param context - sender context, to match reply w/ request
1118 @param il_addr - inside IPv6 address of the local host
1119 @param ol_addr - outside IPv4 address of the local host
1120 @param il_port - inside port number id of the local host/inside ICMP id
1121 @param ol_port - outside port number of the local host/outside ICMP id
1122 @param il_addr - inside IPv6 address of the remote host
1123 @param ol_addr - outside IPv4 address of the remote host
1124 @param l_port - port number of the remote host (not used for ICMP)
1125 @param vrf_id - VRF id of tenant
1126 @param proto - protocol number
1128 define nat64_st_details {
1141 /** \brief Add/del NAT64 prefix
1142 @param client_index - opaque cookie to identify the sender
1143 @param context - sender context, to match reply w/ request
1144 @param prefix - NAT64 prefix
1145 @param prefix - NAT64 prefix length
1146 @param vrf_id - VRF id of tenant
1147 @param is_add - 1 if add, 0 if delete
1149 autoreply define nat64_add_del_prefix {
1158 /** \brief Dump NAT64 prefix
1159 @param client_index - opaque cookie to identify the sender
1160 @param context - sender context, to match reply w/ request
1162 define nat64_prefix_dump {
1167 /** \brief Dump NAT64 prefix details response
1168 @param context - sender context, to match reply w/ request
1169 @param prefix - NAT64 prefix
1170 @param prefix - NAT64 prefix length
1171 @param vrf_id - VRF id of tenant
1173 define nat64_prefix_details {
1180 /** \brief Add/delete NAT64 pool address from specific interfce
1181 @param client_index - opaque cookie to identify the sender
1182 @param context - sender context, to match reply w/ request
1183 @param is_add - 1 if add, 0 if delete
1184 @param sw_if_index - software index of the interface
1186 autoreply define nat64_add_del_interface_addr {
1199 /** \brief Add/delete address range to DS-Lite pool
1200 @param client_index - opaque cookie to identify the sender
1201 @param context - sender context, to match reply w/ request
1202 @param start_addr - start address of the range
1203 @param end_addr - end address of the range
1204 @param is_add - 1 if add, 0 if delete
1206 autoreply define dslite_add_del_pool_addr_range {
1214 /** \brief Set AFTR IPv6 and IPv4 addresses
1215 @param client_index - opaque cookie to identify the sender
1216 @param context - sender context, to match reply w/ request
1217 @param ip4_addr - IPv4 address
1218 @param ip6_addr - IP64 address
1220 autoreply define dslite_set_aftr_addr {
1227 /** \brief Get AFTR IPv6 and IPv4 addresses
1228 @param client_index - opaque cookie to identify the sender
1229 @param context - sender context, to match reply w/ request
1231 define dslite_get_aftr_addr {
1236 /** \brief Response to get AFTR IPv6 and IPv4 addresses
1237 @param context - sender context, to match reply w/ request
1238 @param retval - return code
1239 @param ip4_addr - IPv4 address
1240 @param ip6_addr - IP64 address
1242 define dslite_get_aftr_addr_reply {
1249 /** \brief Set B4 IPv6 and IPv4 addresses
1250 @param client_index - opaque cookie to identify the sender
1251 @param context - sender context, to match reply w/ request
1252 @param ip4_addr - IPv4 address
1253 @param ip6_addr - IP64 address
1255 autoreply define dslite_set_b4_addr {
1262 /** \brief Get B4 IPv6 and IPv4 addresses
1263 @param client_index - opaque cookie to identify the sender
1264 @param context - sender context, to match reply w/ request
1266 define dslite_get_b4_addr {
1271 /** \brief Response to get B4 IPv6 and IPv4 addresses
1272 @param context - sender context, to match reply w/ request
1273 @param retval - return code
1274 @param ip4_addr - IPv4 address
1275 @param ip6_addr - IP64 address
1277 define dslite_get_b4_addr_reply {
1287 /** \brief Enable/disable NAT66 feature on the interface
1288 @param client_index - opaque cookie to identify the sender
1289 @param context - sender context, to match reply w/ request
1290 @param is_add - 1 if add, 0 if delete
1291 @param is_inside - 1 if inside, 0 if outside
1292 @param sw_if_index - software index of the interface
1294 autoreply define nat66_add_del_interface {
1302 /** \brief Dump interfaces with NAT66 feature
1303 @param client_index - opaque cookie to identify the sender
1304 @param context - sender context, to match reply w/ request
1306 define nat66_interface_dump {
1311 /** \brief NAT66 interface details response
1312 @param context - sender context, to match reply w/ request
1313 @param is_inside - 1 if inside, 0 if outside
1314 @param sw_if_index - software index of the interface
1316 define nat66_interface_details {
1322 /** \brief Add/delete 1:1 NAT66
1323 @param client_index - opaque cookie to identify the sender
1324 @param context - sender context, to match reply w/ request
1325 @param is_add - 1 if add, 0 if delete
1326 @param local_ip_address - local IPv6 address
1327 @param external_ip_address - external IPv6 address
1328 @param vrf_id - VRF id of tenant
1330 autoreply define nat66_add_del_static_mapping {
1334 u8 local_ip_address[16];
1335 u8 external_ip_address[16];
1339 /** \brief Dump NAT66 static mappings
1340 @param client_index - opaque cookie to identify the sender
1341 @param context - sender context, to match reply w/ request
1343 define nat66_static_mapping_dump {
1348 /** \brief NAT66 static mapping details response
1349 @param context - sender context, to match reply w/ request
1350 @param local_ip_address - local IPv6 address
1351 @param external_ip_address - external IPv6 address
1352 @param vrf_id - VRF id of tenant
1353 @param total_bytes - count of bytes sent through static mapping
1354 @param total_pkts - count of pakets sent through static mapping
1356 define nat66_static_mapping_details {
1358 u8 local_ip_address[16];
1359 u8 external_ip_address[16];