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 = "3.0.0";
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 self_twice_nat - if 1 translate external host address and port
356 whenever external host address equals
357 local address of internal host
358 @param out2in_only - if 1 rule match only out2in direction
359 @param tag - opaque string tag
361 autoreply define nat44_add_del_static_mapping {
366 u8 local_ip_address[4];
367 u8 external_ip_address[4];
371 u32 external_sw_if_index;
379 /** \brief Dump NAT44 static mappings
380 @param client_index - opaque cookie to identify the sender
381 @param context - sender context, to match reply w/ request
383 define nat44_static_mapping_dump {
388 /** \brief NAT44 static mapping details response
389 @param context - sender context, to match reply w/ request
390 @param addr_only - 1 if address only mapping
391 @param local_ip_address - local IPv4 address
392 @param external_ip_address - external IPv4 address
393 @param protocol - IP protocol, valid only if addr_only=0
394 @param local_port - local port number, valid only if addr_only=0
395 @param external_port - external port number, valid only if addr_only=0
396 @param external_sw_if_index - external interface
397 @param vfr_id - VRF ID
398 @param twice_nat - if 1 translate external host address and port
399 @param self_twice_nat - if 1 translate external host address and port
400 whenever external host address equals
401 local address of internal host
402 @param out2in_only - if 1 rule match only out2in direction
403 @param tag - opaque string tag
405 define nat44_static_mapping_details {
408 u8 local_ip_address[4];
409 u8 external_ip_address[4];
413 u32 external_sw_if_index;
421 /** \brief Add/delete NAT44 identity mapping
422 @param client_index - opaque cookie to identify the sender
423 @param context - sender context, to match reply w/ request
424 @param is_add - 1 if add, 0 if delete
425 @param addr_only - 1 if address only mapping
426 @param ip_address - IPv4 address
427 @param protocol - IP protocol
428 @param port - port number
429 @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
431 @param vfr_id - VRF ID (if ~0 use default VRF)
432 @param tag - opaque string tag
434 autoreply define nat44_add_del_identity_mapping {
447 /** \brief Dump NAT44 identity mappings
448 @param client_index - opaque cookie to identify the sender
449 @param context - sender context, to match reply w/ request
451 define nat44_identity_mapping_dump {
456 /** \brief NAT44 identity mapping details response
457 @param context - sender context, to match reply w/ request
458 @param addr_only - 1 if address only mapping
459 @param ip_address - IPv4 address
460 @param protocol - IP protocol
461 @param port - port number
462 @param sw_if_index - interface
463 @param vfr_id - VRF ID
464 @param tag - opaque string tag
466 define nat44_identity_mapping_details {
477 /** \brief Add/delete NAT44 pool address from specific interfce
478 @param client_index - opaque cookie to identify the sender
479 @param context - sender context, to match reply w/ request
480 @param is_add - 1 if add, 0 if delete
481 @param twice_nat - twice NAT address for extenal hosts
482 @param sw_if_index - software index of the interface
484 autoreply define nat44_add_del_interface_addr {
492 /** \brief Dump NAT44 pool addresses interfaces
493 @param client_index - opaque cookie to identify the sender
494 @param context - sender context, to match reply w/ request
496 define nat44_interface_addr_dump {
501 /** \brief NAT44 pool addresses interfaces details response
502 @param context - sender context, to match reply w/ request
503 @param sw_if_index - software index of the interface
504 @param twice_nat - twice NAT address for extenal hosts
506 define nat44_interface_addr_details {
512 /** \brief Dump NAT44 users
513 @param client_index - opaque cookie to identify the sender
514 @param context - sender context, to match reply w/ request
516 define nat44_user_dump {
521 /** \brief NAT44 users response
522 @param context - sender context, to match reply w/ request
524 @param ip_adress - IPv4 address
525 @param nsessions - number of dynamic sessions
526 @param nstaticsessions - number of static sessions
528 define nat44_user_details {
536 /** \brief NAT44 user's sessions
537 @param client_index - opaque cookie to identify the sender
538 @param context - sender context, to match reply w/ request
539 @param is_ip4 - 1 if address type is IPv4
540 @param user_ip - IP address of the user to dump
541 @param vrf_id - VRF_ID
543 define nat44_user_session_dump {
550 /** \brief NAT44 user's sessions response
551 @param context - sender context, to match reply w/ request
552 @param outside_ip_address - outside IPv4 address
553 @param outside_port - outside port
554 @param inside_ip_address - inside IPv4 address
555 @param inside_port - inside port
556 @param protocol - protocol
557 @param is_static - 1 if session is static
558 @param last_heard - last heard timer
559 @param total_bytes - count of bytes sent through session
560 @param total_pkts - count of pakets sent through session
561 @param is_twicenat - 1 if session is twice-nat
562 @param ext_host_valid - 1 if external host address and port are valid
563 @param ext_host_address - external host IPv4 address
564 @param ext_host_port - external host port
565 @param ext_host_nat_address - post-NAT external host IPv4 address (valid
566 only if twice-nat session)
567 @param ext_host_nat_port - post-NAT external host port (valid only if
570 define nat44_user_session_details {
572 u8 outside_ip_address[4];
574 u8 inside_ip_address[4];
583 u8 ext_host_address[4];
585 u8 ext_host_nat_address[4];
586 u16 ext_host_nat_port;
589 /** \brief NAT44 load-balancing address and port pair
590 @param addr - IPv4 address of the internal node
591 @param port - L4 port number of the internal node
592 @param probability - probability of the internal node to be randomly matched
594 typeonly manual_endian define nat44_lb_addr_port {
601 /** \brief Add/delete NAT44 load-balancing static mapping rule
602 @param client_index - opaque cookie to identify the sender
603 @param context - sender context, to match reply w/ request
604 @param is_add - 1 if add, 0 if delete
605 @param external_addr - external IPv4 address of the service
606 @param external_port - external L4 port number of the service
607 @param protocol - IP protocol number of the service
608 @param twice_nat - if 1 translate external host address and port
609 @param self_twice_nat - if 1 translate external host address and port
610 whenever external host address equals
611 local address of internal host
612 @param out2in_only - if 1 rule match only out2in direction
613 @param tag - opaque string tag
614 @param local_num - number of local network nodes
615 @param locals - local network nodes
617 autoreply manual_endian define nat44_add_del_lb_static_mapping {
629 vl_api_nat44_lb_addr_port_t locals[local_num];
632 /** \brief Dump NAT44 load-balancing static mapping rules
633 @param client_index - opaque cookie to identify the sender
634 @param context - sender context, to match reply w/ request
636 define nat44_lb_static_mapping_dump {
641 /** \brief NAT44 load-balancing static mapping rule details response
642 @param context - sender context, to match reply w/ request
643 @param is_add - 1 if add, 0 if delete
644 @param external_addr - external IPv4 address of the service
645 @param external_port - external L4 port number of the service
646 @param protocol - IP protocol number of the service
647 @param twice_nat - if 1 translate external host address and port
648 @param self_twice_nat - if 1 translate external host address and port
649 whenever external host address equals
650 local address of internal host
651 @param out2in_only - if 1 rule match only out2in direction
652 @param tag - opaque string tag
653 @param local_num - number of local network nodes
654 @param locals - local network nodes
656 manual_endian define nat44_lb_static_mapping_details {
666 vl_api_nat44_lb_addr_port_t locals[local_num];
669 /** \brief Delete NAT44 session
670 @param client_index - opaque cookie to identify the sender
671 @param context - sender context, to match reply w/ request
672 @param is_in - 1 if inside network addres and port pari, 0 if outside
673 @param ip_address - IPv4 address
674 @param protocol - IP protocol
675 @param port - port number
676 @param vfr_id - VRF ID
677 @param ext_host_valid - 1 if external host address and port are valid
678 @param ext_host_address - external host IPv4 address
679 @param ext_host_port - external host port
681 autoreply define nat44_del_session {
690 u8 ext_host_address[4];
694 /** \brief Enable/disable forwarding for NAT44
695 Forward packets which don't match existing translation
696 or static mapping instead of dropping them.
697 @param client_index - opaque cookie to identify the sender
698 @param context - sender context, to match reply w/ request
699 @param enable - 0 for enable, 1 for disable
701 autoreply define nat44_forwarding_enable_disable {
707 /** \brief Check if forwarding is enabled or disabled
708 @param client_index - opaque cookie to identify the sender
709 @param context - sender context, to match reply w/ request
711 define nat44_forwarding_is_enabled {
716 /** \brief Response to check if forwarding is enabled or disabled
717 @param context - sender context, to match reply w/ request
718 @param enabled - 1 if enabled, 0 if disabled
720 define nat44_forwarding_is_enabled_reply {
727 * Deterministic NAT (CGN) APIs
730 /** \brief Add/delete NAT deterministic mapping
731 @param client_index - opaque cookie to identify the sender
732 @param context - sender context, to match reply w/ request
733 @param is_add - 1 if add, 0 if delete
734 @param is_nat44 - 1 if NAT44
735 @param in_addr - inside IP address
736 @param in_plen - inside IP address prefix length
737 @param out_addr - outside IPv4 address
738 @param out_addr - outside IPv4 address prefix length
740 autoreply define nat_det_add_del_map {
752 /** \brief Get outside address and port range from inside address
753 @param client_index - opaque cookie to identify the sender
754 @param context - sender context, to match reply w/ request
755 @param is_nat44 - 1 if NAT44
756 @param in_addr - inside IP address
758 define nat_det_forward {
765 /** \brief Get outside address and port range from inside address
766 @param context - sender context, to match reply w/ request
767 @param retval - return code
768 @param out_port_lo - outside port range start
769 @param out_port_hi - outside port range end
770 @param out_addr - outside IPv4 address
772 define nat_det_forward_reply {
780 /** \brief Get inside address from outside address and port
781 @param client_index - opaque cookie to identify the sender
782 @param context - sender context, to match reply w/ request
783 @param out_port - outside port
784 @param out_addr - outside IPv4 address
786 define nat_det_reverse {
793 /** \brief Get inside address from outside address and port reply
794 @param context - sender context, to match reply w/ request
795 @param retval - return code
796 @param is_nat44 - 1 if NAT44
797 @param in_addr - inside IP address
799 define nat_det_reverse_reply {
806 /** \brief Dump NAT deterministic mappings
807 @param client_index - opaque cookie to identify the sender
808 @param context - sender context, to match reply w/ request
810 define nat_det_map_dump {
815 /** \brief NAT users response
816 @param context - sender context, to match reply w/ request
817 @param is_nat44 - 1 if NAT44
818 @param in_addr - inside IP address
819 @param in_plen - inside IP address prefix length
820 @param out_addr - outside IPv4 address
821 @param out_plen - outside IPv4 address prefix length
822 @param sharing_ratio - outside to inside address sharing ratio
823 @param ports_per_host - number of ports available to a host
824 @param ses_num - number of sessions belonging to this mapping
826 define nat_det_map_details {
838 /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
839 @param client_index - opaque cookie to identify the sender
840 @param context - sender context, to match reply w/ request
841 @param udp - UDP timeout (default 300sec)
842 @param tcp_established - TCP established timeout (default 7440sec)
843 @param tcp_transitory - TCP transitory timeout (default 240sec)
844 @param icmp - ICMP timeout (default 60sec)
846 autoreply define nat_det_set_timeouts {
855 /** \brief Get values of timeouts for deterministic NAT (seconds)
856 @param client_index - opaque cookie to identify the sender
857 @param context - sender context, to match reply w/ request
859 define nat_det_get_timeouts {
864 /** \brief Get values of timeouts for deterministic NAT reply
865 @param context - sender context, to match reply w/ request
866 @param retval - return code
867 @param udp - UDP timeout (default 300sec)
868 @param tcp_established - TCP established timeout (default 7440sec)
869 @param tcp_transitory - TCP transitory timeout (default 240sec)
870 @param icmp - ICMP timeout (default 60sec)
872 define nat_det_get_timeouts_reply {
881 /** \brief Close deterministic NAT session by outside address and port
882 @param client_index - opaque cookie to identify the sender
883 @param context - sender context, to match reply w/ request
884 @param out_addr - outside IPv4 address
885 @param out_port - outside port
886 @param ext_addr - external host IPv4 address
887 @param ext_port - external host port
889 autoreply define nat_det_close_session_out {
898 /** \brief Close deterministic NAT session by inside address and port
899 @param client_index - opaque cookie to identify the sender
900 @param context - sender context, to match reply w/ request
901 @param is_nat44 - 1 if NAT44
902 @param in_addr - inside IP address
903 @param in_port - inside port
904 @param ext_addr - external host IP address
905 @param ext_port - external host port
907 autoreply define nat_det_close_session_in {
917 /** \brief Dump determinstic NAT sessions
918 @param client_index - opaque cookie to identify the sender
919 @param context - sender context, to match reply w/ request
920 @param is_nat44 - 1 if NAT44
921 @param user_addr - address of an inside user whose sessions to dump
923 define nat_det_session_dump {
930 /** \brief Deterministic NAT sessions reply
931 @param context - sender context, to match reply w/ request
932 @param in_port - inside port
933 @param ext_addr - external host address
934 @param ext_port - external host port
935 @param out_port - outside NAT port
936 @param state - session state
937 @param expire - session expiration timestamp
939 define nat_det_session_details {
954 /** \brief Add/delete address range to NAT64 pool
955 @param client_index - opaque cookie to identify the sender
956 @param context - sender context, to match reply w/ request
957 @param start_addr - start address of the range
958 @param end_addr - end address of the range
959 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
960 @param is_add - 1 if add, 0 if delete
962 autoreply define nat64_add_del_pool_addr_range {
971 /** \brief Dump NAT64 pool addresses
972 @param client_index - opaque cookie to identify the sender
973 @param context - sender context, to match reply w/ request
975 define nat64_pool_addr_dump {
980 /** \brief NAT64 pool address details response
981 @param context - sender context, to match reply w/ request
982 @param address - IPv4 address
983 @param vfr_id - VRF id of tenant, ~0 means independent of VRF
985 define nat64_pool_addr_details {
991 /** \brief Enable/disable NAT64 feature on the interface
992 @param client_index - opaque cookie to identify the sender
993 @param context - sender context, to match reply w/ request
994 @param sw_if_index - index of the interface
995 @param is_inside - 1 if inside, 0 if outside
996 @param is_add - 1 if add, 0 if delete
998 autoreply define nat64_add_del_interface {
1006 /** \brief Dump interfaces with NAT64 feature
1007 @param client_index - opaque cookie to identify the sender
1008 @param context - sender context, to match reply w/ request
1010 define nat64_interface_dump {
1015 /** \brief NAT64 interface details response
1016 @param context - sender context, to match reply w/ request
1017 @param is_inside - 1 if inside, 0 if outside
1018 @param sw_if_index - index of the interface
1020 define nat64_interface_details {
1026 /** \brief Add/delete NAT64 static BIB entry
1027 @param client_index - opaque cookie to identify the sender
1028 @param context - sender context, to match reply w/ request
1029 @param i_addr - inside IPv6 address
1030 @param o_addr - outside IPv4 address
1031 @param i_port - inside port number
1032 @param o_port - outside port number
1033 @param vrf_id - VRF id of tenant
1034 @param proto - protocol number
1035 @param is_add - 1 if add, 0 if delete
1037 autoreply define nat64_add_del_static_bib {
1049 /** \brief Dump NAT64 BIB
1050 @param client_index - opaque cookie to identify the sender
1051 @param context - sender context, to match reply w/ request
1052 @param proto - protocol of the BIB: 255 - all BIBs
1056 otherwise - "unknown" protocol BIB
1058 define nat64_bib_dump {
1064 /** \brief NAT64 BIB details response
1065 @param context - sender context, to match reply w/ request
1066 @param i_addr - inside IPv6 address
1067 @param o_addr - outside IPv4 address
1068 @param i_port - inside port number
1069 @param o_port - outside port number
1070 @param vrf_id - VRF id of tenant
1071 @param proto - protocol number
1072 @param is_static - 1 if static BIB entry, 0 if dynamic
1073 @param ses_num - number of sessions associated with the BIB entry
1075 define nat64_bib_details {
1087 /** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
1088 @param client_index - opaque cookie to identify the sender
1089 @param context - sender context, to match reply w/ request
1090 @param udp - UDP timeout (default 300sec)
1091 @param icmp - ICMP timeout (default 60sec)
1092 @param tcp_trans - TCP transitory timeout (default 240sec)
1093 @param tcp_est - TCP established timeout (default 7440sec)
1094 @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
1096 autoreply define nat64_set_timeouts {
1103 u32 tcp_incoming_syn;
1106 /** \brief Get values of timeouts for NAT64 (seconds)
1107 @param client_index - opaque cookie to identify the sender
1108 @param context - sender context, to match reply w/ request
1110 define nat64_get_timeouts {
1115 /** \brief Get values of timeouts for NAT64 reply
1116 @param context - sender context, to match reply w/ request
1117 @param retval - return code
1118 @param udp - UDP timeout
1119 @param icmp - ICMP timeout
1120 @param tcp_trans - TCP transitory timeout
1121 @param tcp_est - TCP established timeout
1122 @param tcp_incoming_syn - TCP incoming SYN timeout
1124 define nat64_get_timeouts_reply {
1131 u32 tcp_incoming_syn;
1134 /** \brief Dump NAT64 session table
1135 @param client_index - opaque cookie to identify the sender
1136 @param context - sender context, to match reply w/ request
1137 @param proto - protocol of the session table: 255 - all STs
1141 otherwise - "unknown" proto ST
1143 define nat64_st_dump {
1149 /** \brief NAT64 session table details response
1150 @param context - sender context, to match reply w/ request
1151 @param il_addr - inside IPv6 address of the local host
1152 @param ol_addr - outside IPv4 address of the local host
1153 @param il_port - inside port number id of the local host/inside ICMP id
1154 @param ol_port - outside port number of the local host/outside ICMP id
1155 @param il_addr - inside IPv6 address of the remote host
1156 @param ol_addr - outside IPv4 address of the remote host
1157 @param l_port - port number of the remote host (not used for ICMP)
1158 @param vrf_id - VRF id of tenant
1159 @param proto - protocol number
1161 define nat64_st_details {
1174 /** \brief Add/del NAT64 prefix
1175 @param client_index - opaque cookie to identify the sender
1176 @param context - sender context, to match reply w/ request
1177 @param prefix - NAT64 prefix
1178 @param prefix - NAT64 prefix length
1179 @param vrf_id - VRF id of tenant
1180 @param is_add - 1 if add, 0 if delete
1182 autoreply define nat64_add_del_prefix {
1191 /** \brief Dump NAT64 prefix
1192 @param client_index - opaque cookie to identify the sender
1193 @param context - sender context, to match reply w/ request
1195 define nat64_prefix_dump {
1200 /** \brief Dump NAT64 prefix details response
1201 @param context - sender context, to match reply w/ request
1202 @param prefix - NAT64 prefix
1203 @param prefix - NAT64 prefix length
1204 @param vrf_id - VRF id of tenant
1206 define nat64_prefix_details {
1213 /** \brief Add/delete NAT64 pool address from specific interfce
1214 @param client_index - opaque cookie to identify the sender
1215 @param context - sender context, to match reply w/ request
1216 @param is_add - 1 if add, 0 if delete
1217 @param sw_if_index - software index of the interface
1219 autoreply define nat64_add_del_interface_addr {
1232 /** \brief Add/delete address range to DS-Lite pool
1233 @param client_index - opaque cookie to identify the sender
1234 @param context - sender context, to match reply w/ request
1235 @param start_addr - start address of the range
1236 @param end_addr - end address of the range
1237 @param is_add - 1 if add, 0 if delete
1239 autoreply define dslite_add_del_pool_addr_range {
1247 /** \brief Dump DS-Lite addresses
1248 @param client_index - opaque cookie to identify the sender
1249 @param context - sender context, to match reply w/ request
1251 define dslite_address_dump {
1256 /** \brief DS-Lite address details response
1257 @param context - sender context, to match reply w/ request
1258 @param ip_address - IPv4 address
1260 define dslite_address_details {
1265 /** \brief Set AFTR IPv6 and IPv4 addresses
1266 @param client_index - opaque cookie to identify the sender
1267 @param context - sender context, to match reply w/ request
1268 @param ip4_addr - IPv4 address
1269 @param ip6_addr - IP64 address
1271 autoreply define dslite_set_aftr_addr {
1278 /** \brief Get AFTR IPv6 and IPv4 addresses
1279 @param client_index - opaque cookie to identify the sender
1280 @param context - sender context, to match reply w/ request
1282 define dslite_get_aftr_addr {
1287 /** \brief Response to get AFTR IPv6 and IPv4 addresses
1288 @param context - sender context, to match reply w/ request
1289 @param retval - return code
1290 @param ip4_addr - IPv4 address
1291 @param ip6_addr - IP64 address
1293 define dslite_get_aftr_addr_reply {
1300 /** \brief Set B4 IPv6 and IPv4 addresses
1301 @param client_index - opaque cookie to identify the sender
1302 @param context - sender context, to match reply w/ request
1303 @param ip4_addr - IPv4 address
1304 @param ip6_addr - IP64 address
1306 autoreply define dslite_set_b4_addr {
1313 /** \brief Get B4 IPv6 and IPv4 addresses
1314 @param client_index - opaque cookie to identify the sender
1315 @param context - sender context, to match reply w/ request
1317 define dslite_get_b4_addr {
1322 /** \brief Response to get B4 IPv6 and IPv4 addresses
1323 @param context - sender context, to match reply w/ request
1324 @param retval - return code
1325 @param ip4_addr - IPv4 address
1326 @param ip6_addr - IP64 address
1328 define dslite_get_b4_addr_reply {
1338 /** \brief Enable/disable NAT66 feature on the interface
1339 @param client_index - opaque cookie to identify the sender
1340 @param context - sender context, to match reply w/ request
1341 @param is_add - 1 if add, 0 if delete
1342 @param is_inside - 1 if inside, 0 if outside
1343 @param sw_if_index - software index of the interface
1345 autoreply define nat66_add_del_interface {
1353 /** \brief Dump interfaces with NAT66 feature
1354 @param client_index - opaque cookie to identify the sender
1355 @param context - sender context, to match reply w/ request
1357 define nat66_interface_dump {
1362 /** \brief NAT66 interface details response
1363 @param context - sender context, to match reply w/ request
1364 @param is_inside - 1 if inside, 0 if outside
1365 @param sw_if_index - software index of the interface
1367 define nat66_interface_details {
1373 /** \brief Add/delete 1:1 NAT66
1374 @param client_index - opaque cookie to identify the sender
1375 @param context - sender context, to match reply w/ request
1376 @param is_add - 1 if add, 0 if delete
1377 @param local_ip_address - local IPv6 address
1378 @param external_ip_address - external IPv6 address
1379 @param vrf_id - VRF id of tenant
1381 autoreply define nat66_add_del_static_mapping {
1385 u8 local_ip_address[16];
1386 u8 external_ip_address[16];
1390 /** \brief Dump NAT66 static mappings
1391 @param client_index - opaque cookie to identify the sender
1392 @param context - sender context, to match reply w/ request
1394 define nat66_static_mapping_dump {
1399 /** \brief NAT66 static mapping details response
1400 @param context - sender context, to match reply w/ request
1401 @param local_ip_address - local IPv6 address
1402 @param external_ip_address - external IPv6 address
1403 @param vrf_id - VRF id of tenant
1404 @param total_bytes - count of bytes sent through static mapping
1405 @param total_pkts - count of pakets sent through static mapping
1407 define nat66_static_mapping_details {
1409 u8 local_ip_address[16];
1410 u8 external_ip_address[16];