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 = "4.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 endpoint_dependent - if 1 endpoint-dependent mode
71 @param out2in_dpo - if 1 out2in dpo mode
72 @param translation_buckets - number of translation hash buckets
73 @param translation_memory_size - translation hash memory size
74 @param user_buckets - number of user hash buckets
75 @param user_memory_size - user hash memory size
76 @param max_translations_per_user - maximum number of translations per user
77 @param outside_vrf_id - outside VRF id
78 @param inside_vrf_id - default inside VRF id
79 @param dslite_ce - if DS-Lite is CE/B4 element, if 0 AFTR elemet
80 @param nat64_bib_buckets - number of NAT64 BIB hash buckets
81 @param nat64_bib_memory_size - memory size of NAT64 BIB hash
82 @param nat64_st_buckets - number of NAT64 session table hash buckets
83 @param nat64_st_memory_size - memory size of NAT64 session table hash
85 define nat_show_config_reply
89 u8 static_mapping_only;
90 u8 static_mapping_connection_tracking;
92 u8 endpoint_dependent;
94 u32 translation_buckets;
95 u32 translation_memory_size;
98 u32 max_translations_per_user;
102 u32 nat64_bib_buckets;
103 u32 nat64_bib_memory_size;
104 u32 nat64_st_buckets;
105 u32 nat64_st_memory_size;
108 /** \brief Set NAT workers
109 @param client_index - opaque cookie to identify the sender
110 @param context - sender context, to match reply w/ request
111 @param worker_mask - NAT workers mask
113 autoreply define nat_set_workers {
119 /** \brief Dump NAT workers
120 @param client_index - opaque cookie to identify the sender
121 @param context - sender context, to match reply w/ request
123 define nat_worker_dump {
128 /** \brief NAT workers details response
129 @param context - sender context, to match reply w/ request
130 @param worker_index - worker index
131 @param lcore_id - lcore ID
132 @param name - worker name
134 define nat_worker_details {
141 /** \brief Enable/disable NAT IPFIX logging
142 @param client_index - opaque cookie to identify the sender
143 @param context - sender context, to match reply w/ request
144 @param domain_id - observation domain ID
145 @param src_port - source port number
146 @param enable - 1 if enable, 0 if disable
148 autoreply define nat_ipfix_enable_disable {
156 /** \brief Set NAT virtual fragmentation reassembly
157 @param client_index - opaque cookie to identify the sender
158 @param context - sender context, to match reply w/ request
159 @param timeout - reassembly timeout
160 @param max_reass - maximum number of concurrent reassemblies
161 @param max_frag - maximum number of fragmets per reassembly
162 @param drop_frag - if 0 translate fragments, otherwise drop fragments
163 @param is_ip6 - 1 if IPv6, 0 if IPv4
165 autoreply define nat_set_reass {
175 /** \brief Get NAT virtual fragmentation reassembly configuration
176 @param client_index - opaque cookie to identify the sender
177 @param context - sender context, to match reply w/ request
179 define nat_get_reass {
184 /** \brief Get NAT virtual fragmentation reassembly configuration reply
185 @param context - sender context, to match reply w/ request
186 @param retval - return code
187 @param ip4_timeout - reassembly timeout
188 @param ip4_max_reass - maximum number of concurrent reassemblies
189 @param ip4_max_frag - maximum number of fragmets per reassembly
190 @param ip4_drop_frag - if 0 translate fragments, otherwise drop fragments
191 @param ip6_timeout - reassembly timeout
192 @param ip6_max_reass - maximum number of concurrent reassemblies
193 @param ip6_max_frag - maximum number of fragmets per reassembly
194 @param ip6_drop_frag - if 0 translate fragments, otherwise drop fragments
196 define nat_get_reass_reply {
209 /** \brief Dump NAT virtual fragmentation reassemblies
210 @param client_index - opaque cookie to identify the sender
211 @param context - sender context, to match reply w/ request
213 define nat_reass_dump {
218 /** \brief NAT virtual fragmentation reassemblies response
219 @param context - sender context, to match reply w/ request
220 @param is_ip4 - 1 if address type is IPv4
221 @param src_addr - source IP address
222 @param dst_addr - destination IP address
223 @param frag_id - fragment ID
224 @param proto - protocol
225 @param frag_n - number of cached fragments
227 define nat_reass_details {
237 /** \brief Set values of timeouts for NAT sessions (seconds)
238 @param client_index - opaque cookie to identify the sender
239 @param context - sender context, to match reply w/ request
240 @param udp - UDP timeout (default 300sec)
241 @param tcp_established - TCP established timeout (default 7440sec)
242 @param tcp_transitory - TCP transitory timeout (default 240sec)
243 @param icmp - ICMP timeout (default 60sec)
245 autoreply define nat_set_timeouts {
254 /** \brief Get values of timeouts for NAT sessions (seconds)
255 @param client_index - opaque cookie to identify the sender
256 @param context - sender context, to match reply w/ request
258 define nat_get_timeouts {
263 /** \brief Get values of timeouts for NAT sessions reply
264 @param context - sender context, to match reply w/ request
265 @param retval - return code
266 @param udp - UDP timeout
267 @param tcp_established - TCP established timeout
268 @param tcp_transitory - TCP transitory timeout
269 @param icmp - ICMP timeout
271 define nat_get_timeouts_reply {
284 /** \brief Add/del NAT44 address range
285 @param client_index - opaque cookie to identify the sender
286 @param context - sender context, to match reply w/ request
287 @param first_ip_address - first IPv4 address
288 @param last_ip_address - last IPv4 address
289 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
290 @param twice_nat - twice NAT address range for extenal hosts
291 @param is_add - 1 if add, 0 if delete
293 autoreply define nat44_add_del_address_range {
296 u8 first_ip_address[4];
297 u8 last_ip_address[4];
303 /** \brief Dump NAT44 addresses
304 @param client_index - opaque cookie to identify the sender
305 @param context - sender context, to match reply w/ request
307 define nat44_address_dump {
312 /** \brief NAT44 address details response
313 @param context - sender context, to match reply w/ request
314 @param ip_address - IPv4 address
315 @param twice_nat - twice NAT address range for extenal hosts
316 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
318 define nat44_address_details {
325 /** \brief Enable/disable NAT44 feature on the interface
326 @param client_index - opaque cookie to identify the sender
327 @param context - sender context, to match reply w/ request
328 @param is_add - 1 if add, 0 if delete
329 @param is_inside - 1 if inside, 0 if outside
330 @param sw_if_index - software index of the interface
332 autoreply define nat44_interface_add_del_feature {
340 /** \brief Dump interfaces with NAT44 feature
341 @param client_index - opaque cookie to identify the sender
342 @param context - sender context, to match reply w/ request
344 define nat44_interface_dump {
349 /** \brief NAT44 interface details response
350 @param context - sender context, to match reply w/ request
351 @param is_inside - 1 if inside, 0 if outside, 2 if inside and outside
352 @param sw_if_index - software index of the interface
354 define nat44_interface_details {
360 /** \brief Enable/disbale NAT44 as an interface output feature (postrouting
362 @param client_index - opaque cookie to identify the sender
363 @param context - sender context, to match reply w/ request
364 @param is_add - 1 if add, 0 if delete
365 @param is_inside - 1 if inside, 0 if outside
366 @param sw_if_index - software index of the interface
368 autoreply define nat44_interface_add_del_output_feature {
376 /** \brief Dump interfaces with NAT44 output feature
377 @param client_index - opaque cookie to identify the sender
378 @param context - sender context, to match reply w/ request
380 define nat44_interface_output_feature_dump {
385 /** \brief NAT44 interface with output feature details response
386 @param context - sender context, to match reply w/ request
387 @param is_inside - 1 if inside, 0 if outside
388 @param sw_if_index - software index of the interface
390 define nat44_interface_output_feature_details {
396 /** \brief Add/delete NAT44 static mapping
397 @param client_index - opaque cookie to identify the sender
398 @param context - sender context, to match reply w/ request
399 @param is_add - 1 if add, 0 if delete
400 @param addr_only - 1 if address only mapping
401 @param local_ip_address - local IPv4 address
402 @param external_ip_address - external IPv4 address
403 @param protocol - IP protocol, used only if addr_only=0
404 @param local_port - local port number, used only if addr_only=0
405 @param external_port - external port number, used only if addr_only=0
406 @param external_sw_if_index - external interface (if set
407 external_ip_address is ignored, ~0 means not
409 @param vfr_id - VRF ID
410 @param twice_nat - if 1 translate external host address and port, only for
411 1:1 NAPT (addr_only must be 0)
412 @param self_twice_nat - if 1 translate external host address and port
413 whenever external host address equals
414 local address of internal host
415 @param out2in_only - if 1 rule match only out2in direction
416 @param tag - opaque string tag
418 autoreply define nat44_add_del_static_mapping {
423 u8 local_ip_address[4];
424 u8 external_ip_address[4];
428 u32 external_sw_if_index;
436 /** \brief Dump NAT44 static mappings
437 @param client_index - opaque cookie to identify the sender
438 @param context - sender context, to match reply w/ request
440 define nat44_static_mapping_dump {
445 /** \brief NAT44 static mapping details response
446 @param context - sender context, to match reply w/ request
447 @param addr_only - 1 if address only mapping
448 @param local_ip_address - local IPv4 address
449 @param external_ip_address - external IPv4 address
450 @param protocol - IP protocol, valid only if addr_only=0
451 @param local_port - local port number, valid only if addr_only=0
452 @param external_port - external port number, valid only if addr_only=0
453 @param external_sw_if_index - external interface
454 @param vfr_id - VRF ID
455 @param twice_nat - if 1 translate external host address and port
456 @param self_twice_nat - if 1 translate external host address and port
457 whenever external host address equals
458 local address of internal host
459 @param out2in_only - if 1 rule match only out2in direction
460 @param tag - opaque string tag
462 define nat44_static_mapping_details {
465 u8 local_ip_address[4];
466 u8 external_ip_address[4];
470 u32 external_sw_if_index;
478 /** \brief Add/delete NAT44 identity mapping
479 @param client_index - opaque cookie to identify the sender
480 @param context - sender context, to match reply w/ request
481 @param is_add - 1 if add, 0 if delete
482 @param addr_only - 1 if address only mapping
483 @param ip_address - IPv4 address
484 @param protocol - IP protocol
485 @param port - port number
486 @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
488 @param vfr_id - VRF ID (if ~0 use default VRF)
489 @param tag - opaque string tag
491 autoreply define nat44_add_del_identity_mapping {
504 /** \brief Dump NAT44 identity mappings
505 @param client_index - opaque cookie to identify the sender
506 @param context - sender context, to match reply w/ request
508 define nat44_identity_mapping_dump {
513 /** \brief NAT44 identity mapping details response
514 @param context - sender context, to match reply w/ request
515 @param addr_only - 1 if address only mapping
516 @param ip_address - IPv4 address
517 @param protocol - IP protocol
518 @param port - port number
519 @param sw_if_index - interface
520 @param vfr_id - VRF ID
521 @param tag - opaque string tag
523 define nat44_identity_mapping_details {
534 /** \brief Add/delete NAT44 pool address from specific interfce
535 @param client_index - opaque cookie to identify the sender
536 @param context - sender context, to match reply w/ request
537 @param is_add - 1 if add, 0 if delete
538 @param twice_nat - twice NAT address for extenal hosts
539 @param sw_if_index - software index of the interface
541 autoreply define nat44_add_del_interface_addr {
549 /** \brief Dump NAT44 pool addresses interfaces
550 @param client_index - opaque cookie to identify the sender
551 @param context - sender context, to match reply w/ request
553 define nat44_interface_addr_dump {
558 /** \brief NAT44 pool addresses interfaces details response
559 @param context - sender context, to match reply w/ request
560 @param sw_if_index - software index of the interface
561 @param twice_nat - twice NAT address for extenal hosts
563 define nat44_interface_addr_details {
569 /** \brief Dump NAT44 users
570 @param client_index - opaque cookie to identify the sender
571 @param context - sender context, to match reply w/ request
573 define nat44_user_dump {
578 /** \brief NAT44 users response
579 @param context - sender context, to match reply w/ request
581 @param ip_adress - IPv4 address
582 @param nsessions - number of dynamic sessions
583 @param nstaticsessions - number of static sessions
585 define nat44_user_details {
593 /** \brief NAT44 user's sessions
594 @param client_index - opaque cookie to identify the sender
595 @param context - sender context, to match reply w/ request
596 @param is_ip4 - 1 if address type is IPv4
597 @param user_ip - IP address of the user to dump
598 @param vrf_id - VRF_ID
600 define nat44_user_session_dump {
607 /** \brief NAT44 user's sessions response
608 @param context - sender context, to match reply w/ request
609 @param outside_ip_address - outside IPv4 address
610 @param outside_port - outside port
611 @param inside_ip_address - inside IPv4 address
612 @param inside_port - inside port
613 @param protocol - protocol
614 @param is_static - 1 if session is static
615 @param last_heard - last heard timer
616 @param total_bytes - count of bytes sent through session
617 @param total_pkts - count of pakets sent through session
618 @param is_twicenat - 1 if session is twice-nat
619 @param ext_host_valid - 1 if external host address and port are valid
620 @param ext_host_address - external host IPv4 address
621 @param ext_host_port - external host port
622 @param ext_host_nat_address - post-NAT external host IPv4 address (valid
623 only if twice-nat session)
624 @param ext_host_nat_port - post-NAT external host port (valid only if
627 define nat44_user_session_details {
629 u8 outside_ip_address[4];
631 u8 inside_ip_address[4];
640 u8 ext_host_address[4];
642 u8 ext_host_nat_address[4];
643 u16 ext_host_nat_port;
646 /** \brief NAT44 load-balancing address and port pair
647 @param addr - IPv4 address of the internal node
648 @param port - L4 port number of the internal node
649 @param probability - probability of the internal node to be randomly matched
651 typeonly manual_endian define nat44_lb_addr_port {
658 /** \brief Add/delete NAT44 load-balancing static mapping rule
659 @param client_index - opaque cookie to identify the sender
660 @param context - sender context, to match reply w/ request
661 @param is_add - 1 if add, 0 if delete
662 @param external_addr - external IPv4 address of the service
663 @param external_port - external L4 port number of the service
664 @param protocol - IP protocol number of the service
665 @param twice_nat - if 1 translate external host address and port
666 @param self_twice_nat - if 1 translate external host address and port
667 whenever external host address equals
668 local address of internal host
669 @param out2in_only - if 1 rule match only out2in direction
670 @param tag - opaque string tag
671 @param affinity - if 0 disabled, otherwise client IP affinity sticky time
673 @param local_num - number of local network nodes
674 @param locals - local network nodes
676 autoreply manual_endian define nat44_add_del_lb_static_mapping {
689 vl_api_nat44_lb_addr_port_t locals[local_num];
692 /** \brief Dump NAT44 load-balancing static mapping rules
693 @param client_index - opaque cookie to identify the sender
694 @param context - sender context, to match reply w/ request
696 define nat44_lb_static_mapping_dump {
701 /** \brief NAT44 load-balancing static mapping rule details response
702 @param context - sender context, to match reply w/ request
703 @param is_add - 1 if add, 0 if delete
704 @param external_addr - external IPv4 address of the service
705 @param external_port - external L4 port number of the service
706 @param protocol - IP protocol number of the service
707 @param twice_nat - if 1 translate external host address and port
708 @param self_twice_nat - if 1 translate external host address and port
709 whenever external host address equals
710 local address of internal host
711 @param out2in_only - if 1 rule match only out2in direction
712 @param tag - opaque string tag
713 @param affinity - if 0 disabled, otherwise client IP affinity sticky time
715 @param local_num - number of local network nodes
716 @param locals - local network nodes
718 manual_endian define nat44_lb_static_mapping_details {
729 vl_api_nat44_lb_addr_port_t locals[local_num];
732 /** \brief Delete NAT44 session
733 @param client_index - opaque cookie to identify the sender
734 @param context - sender context, to match reply w/ request
735 @param is_in - 1 if inside network addres and port pari, 0 if outside
736 @param ip_address - IPv4 address
737 @param protocol - IP protocol
738 @param port - port number
739 @param vfr_id - VRF ID
740 @param ext_host_valid - 1 if external host address and port are valid
741 @param ext_host_address - external host IPv4 address
742 @param ext_host_port - external host port
744 autoreply define nat44_del_session {
753 u8 ext_host_address[4];
757 /** \brief Enable/disable forwarding for NAT44
758 Forward packets which don't match existing translation
759 or static mapping instead of dropping them.
760 @param client_index - opaque cookie to identify the sender
761 @param context - sender context, to match reply w/ request
762 @param enable - 0 for enable, 1 for disable
764 autoreply define nat44_forwarding_enable_disable {
770 /** \brief Check if forwarding is enabled or disabled
771 @param client_index - opaque cookie to identify the sender
772 @param context - sender context, to match reply w/ request
774 define nat44_forwarding_is_enabled {
779 /** \brief Response to check if forwarding is enabled or disabled
780 @param context - sender context, to match reply w/ request
781 @param enabled - 1 if enabled, 0 if disabled
783 define nat44_forwarding_is_enabled_reply {
790 * Deterministic NAT (CGN) APIs
793 /** \brief Add/delete NAT deterministic mapping
794 @param client_index - opaque cookie to identify the sender
795 @param context - sender context, to match reply w/ request
796 @param is_add - 1 if add, 0 if delete
797 @param is_nat44 - 1 if NAT44
798 @param in_addr - inside IP address
799 @param in_plen - inside IP address prefix length
800 @param out_addr - outside IPv4 address
801 @param out_addr - outside IPv4 address prefix length
803 autoreply define nat_det_add_del_map {
815 /** \brief Get outside address and port range from inside address
816 @param client_index - opaque cookie to identify the sender
817 @param context - sender context, to match reply w/ request
818 @param is_nat44 - 1 if NAT44
819 @param in_addr - inside IP address
821 define nat_det_forward {
828 /** \brief Get outside address and port range from inside address
829 @param context - sender context, to match reply w/ request
830 @param retval - return code
831 @param out_port_lo - outside port range start
832 @param out_port_hi - outside port range end
833 @param out_addr - outside IPv4 address
835 define nat_det_forward_reply {
843 /** \brief Get inside address from outside address and port
844 @param client_index - opaque cookie to identify the sender
845 @param context - sender context, to match reply w/ request
846 @param out_port - outside port
847 @param out_addr - outside IPv4 address
849 define nat_det_reverse {
856 /** \brief Get inside address from outside address and port reply
857 @param context - sender context, to match reply w/ request
858 @param retval - return code
859 @param is_nat44 - 1 if NAT44
860 @param in_addr - inside IP address
862 define nat_det_reverse_reply {
869 /** \brief Dump NAT deterministic mappings
870 @param client_index - opaque cookie to identify the sender
871 @param context - sender context, to match reply w/ request
873 define nat_det_map_dump {
878 /** \brief NAT users response
879 @param context - sender context, to match reply w/ request
880 @param is_nat44 - 1 if NAT44
881 @param in_addr - inside IP address
882 @param in_plen - inside IP address prefix length
883 @param out_addr - outside IPv4 address
884 @param out_plen - outside IPv4 address prefix length
885 @param sharing_ratio - outside to inside address sharing ratio
886 @param ports_per_host - number of ports available to a host
887 @param ses_num - number of sessions belonging to this mapping
889 define nat_det_map_details {
901 /** \brief Close deterministic NAT session by outside address and port
902 @param client_index - opaque cookie to identify the sender
903 @param context - sender context, to match reply w/ request
904 @param out_addr - outside IPv4 address
905 @param out_port - outside port
906 @param ext_addr - external host IPv4 address
907 @param ext_port - external host port
909 autoreply define nat_det_close_session_out {
918 /** \brief Close deterministic NAT session by inside address and port
919 @param client_index - opaque cookie to identify the sender
920 @param context - sender context, to match reply w/ request
921 @param is_nat44 - 1 if NAT44
922 @param in_addr - inside IP address
923 @param in_port - inside port
924 @param ext_addr - external host IP address
925 @param ext_port - external host port
927 autoreply define nat_det_close_session_in {
937 /** \brief Dump determinstic NAT sessions
938 @param client_index - opaque cookie to identify the sender
939 @param context - sender context, to match reply w/ request
940 @param is_nat44 - 1 if NAT44
941 @param user_addr - address of an inside user whose sessions to dump
943 define nat_det_session_dump {
950 /** \brief Deterministic NAT sessions reply
951 @param context - sender context, to match reply w/ request
952 @param in_port - inside port
953 @param ext_addr - external host address
954 @param ext_port - external host port
955 @param out_port - outside NAT port
956 @param state - session state
957 @param expire - session expiration timestamp
959 define nat_det_session_details {
973 /** \brief Add/delete address range to NAT64 pool
974 @param client_index - opaque cookie to identify the sender
975 @param context - sender context, to match reply w/ request
976 @param start_addr - start address of the range
977 @param end_addr - end address of the range
978 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
979 @param is_add - 1 if add, 0 if delete
981 autoreply define nat64_add_del_pool_addr_range {
990 /** \brief Dump NAT64 pool addresses
991 @param client_index - opaque cookie to identify the sender
992 @param context - sender context, to match reply w/ request
994 define nat64_pool_addr_dump {
999 /** \brief NAT64 pool address details response
1000 @param context - sender context, to match reply w/ request
1001 @param address - IPv4 address
1002 @param vfr_id - VRF id of tenant, ~0 means independent of VRF
1004 define nat64_pool_addr_details {
1010 /** \brief Enable/disable NAT64 feature on the interface
1011 @param client_index - opaque cookie to identify the sender
1012 @param context - sender context, to match reply w/ request
1013 @param sw_if_index - index of the interface
1014 @param is_inside - 1 if inside, 0 if outside
1015 @param is_add - 1 if add, 0 if delete
1017 autoreply define nat64_add_del_interface {
1025 /** \brief Dump interfaces with NAT64 feature
1026 @param client_index - opaque cookie to identify the sender
1027 @param context - sender context, to match reply w/ request
1029 define nat64_interface_dump {
1034 /** \brief NAT64 interface details response
1035 @param context - sender context, to match reply w/ request
1036 @param is_inside - 1 if inside, 0 if outside
1037 @param sw_if_index - index of the interface
1039 define nat64_interface_details {
1045 /** \brief Add/delete NAT64 static BIB entry
1046 @param client_index - opaque cookie to identify the sender
1047 @param context - sender context, to match reply w/ request
1048 @param i_addr - inside IPv6 address
1049 @param o_addr - outside IPv4 address
1050 @param i_port - inside port number
1051 @param o_port - outside port number
1052 @param vrf_id - VRF id of tenant
1053 @param proto - protocol number
1054 @param is_add - 1 if add, 0 if delete
1056 autoreply define nat64_add_del_static_bib {
1068 /** \brief Dump NAT64 BIB
1069 @param client_index - opaque cookie to identify the sender
1070 @param context - sender context, to match reply w/ request
1071 @param proto - protocol of the BIB: 255 - all BIBs
1075 otherwise - "unknown" protocol BIB
1077 define nat64_bib_dump {
1083 /** \brief NAT64 BIB details response
1084 @param context - sender context, to match reply w/ request
1085 @param i_addr - inside IPv6 address
1086 @param o_addr - outside IPv4 address
1087 @param i_port - inside port number
1088 @param o_port - outside port number
1089 @param vrf_id - VRF id of tenant
1090 @param proto - protocol number
1091 @param is_static - 1 if static BIB entry, 0 if dynamic
1092 @param ses_num - number of sessions associated with the BIB entry
1094 define nat64_bib_details {
1106 /** \brief Dump NAT64 session table
1107 @param client_index - opaque cookie to identify the sender
1108 @param context - sender context, to match reply w/ request
1109 @param proto - protocol of the session table: 255 - all STs
1113 otherwise - "unknown" proto ST
1115 define nat64_st_dump {
1121 /** \brief NAT64 session table details response
1122 @param context - sender context, to match reply w/ request
1123 @param il_addr - inside IPv6 address of the local host
1124 @param ol_addr - outside IPv4 address of the local host
1125 @param il_port - inside port number id of the local host/inside ICMP id
1126 @param ol_port - outside port number of the local host/outside ICMP id
1127 @param il_addr - inside IPv6 address of the remote host
1128 @param ol_addr - outside IPv4 address of the remote host
1129 @param l_port - port number of the remote host (not used for ICMP)
1130 @param vrf_id - VRF id of tenant
1131 @param proto - protocol number
1133 define nat64_st_details {
1146 /** \brief Add/del NAT64 prefix
1147 @param client_index - opaque cookie to identify the sender
1148 @param context - sender context, to match reply w/ request
1149 @param prefix - NAT64 prefix
1150 @param prefix - NAT64 prefix length
1151 @param vrf_id - VRF id of tenant
1152 @param is_add - 1 if add, 0 if delete
1154 autoreply define nat64_add_del_prefix {
1163 /** \brief Dump NAT64 prefix
1164 @param client_index - opaque cookie to identify the sender
1165 @param context - sender context, to match reply w/ request
1167 define nat64_prefix_dump {
1172 /** \brief Dump NAT64 prefix details response
1173 @param context - sender context, to match reply w/ request
1174 @param prefix - NAT64 prefix
1175 @param prefix - NAT64 prefix length
1176 @param vrf_id - VRF id of tenant
1178 define nat64_prefix_details {
1185 /** \brief Add/delete NAT64 pool address from specific interfce
1186 @param client_index - opaque cookie to identify the sender
1187 @param context - sender context, to match reply w/ request
1188 @param is_add - 1 if add, 0 if delete
1189 @param sw_if_index - software index of the interface
1191 autoreply define nat64_add_del_interface_addr {
1204 /** \brief Add/delete address range to DS-Lite pool
1205 @param client_index - opaque cookie to identify the sender
1206 @param context - sender context, to match reply w/ request
1207 @param start_addr - start address of the range
1208 @param end_addr - end address of the range
1209 @param is_add - 1 if add, 0 if delete
1211 autoreply define dslite_add_del_pool_addr_range {
1219 /** \brief Dump DS-Lite addresses
1220 @param client_index - opaque cookie to identify the sender
1221 @param context - sender context, to match reply w/ request
1223 define dslite_address_dump {
1228 /** \brief DS-Lite address details response
1229 @param context - sender context, to match reply w/ request
1230 @param ip_address - IPv4 address
1232 define dslite_address_details {
1237 /** \brief Set AFTR IPv6 and IPv4 addresses
1238 @param client_index - opaque cookie to identify the sender
1239 @param context - sender context, to match reply w/ request
1240 @param ip4_addr - IPv4 address
1241 @param ip6_addr - IP64 address
1243 autoreply define dslite_set_aftr_addr {
1250 /** \brief Get AFTR IPv6 and IPv4 addresses
1251 @param client_index - opaque cookie to identify the sender
1252 @param context - sender context, to match reply w/ request
1254 define dslite_get_aftr_addr {
1259 /** \brief Response to get AFTR IPv6 and IPv4 addresses
1260 @param context - sender context, to match reply w/ request
1261 @param retval - return code
1262 @param ip4_addr - IPv4 address
1263 @param ip6_addr - IP64 address
1265 define dslite_get_aftr_addr_reply {
1272 /** \brief Set B4 IPv6 and IPv4 addresses
1273 @param client_index - opaque cookie to identify the sender
1274 @param context - sender context, to match reply w/ request
1275 @param ip4_addr - IPv4 address
1276 @param ip6_addr - IP64 address
1278 autoreply define dslite_set_b4_addr {
1285 /** \brief Get B4 IPv6 and IPv4 addresses
1286 @param client_index - opaque cookie to identify the sender
1287 @param context - sender context, to match reply w/ request
1289 define dslite_get_b4_addr {
1294 /** \brief Response to get B4 IPv6 and IPv4 addresses
1295 @param context - sender context, to match reply w/ request
1296 @param retval - return code
1297 @param ip4_addr - IPv4 address
1298 @param ip6_addr - IP64 address
1300 define dslite_get_b4_addr_reply {
1310 /** \brief Enable/disable NAT66 feature on the interface
1311 @param client_index - opaque cookie to identify the sender
1312 @param context - sender context, to match reply w/ request
1313 @param is_add - 1 if add, 0 if delete
1314 @param is_inside - 1 if inside, 0 if outside
1315 @param sw_if_index - software index of the interface
1317 autoreply define nat66_add_del_interface {
1325 /** \brief Dump interfaces with NAT66 feature
1326 @param client_index - opaque cookie to identify the sender
1327 @param context - sender context, to match reply w/ request
1329 define nat66_interface_dump {
1334 /** \brief NAT66 interface details response
1335 @param context - sender context, to match reply w/ request
1336 @param is_inside - 1 if inside, 0 if outside
1337 @param sw_if_index - software index of the interface
1339 define nat66_interface_details {
1345 /** \brief Add/delete 1:1 NAT66
1346 @param client_index - opaque cookie to identify the sender
1347 @param context - sender context, to match reply w/ request
1348 @param is_add - 1 if add, 0 if delete
1349 @param local_ip_address - local IPv6 address
1350 @param external_ip_address - external IPv6 address
1351 @param vrf_id - VRF id of tenant
1353 autoreply define nat66_add_del_static_mapping {
1357 u8 local_ip_address[16];
1358 u8 external_ip_address[16];
1362 /** \brief Dump NAT66 static mappings
1363 @param client_index - opaque cookie to identify the sender
1364 @param context - sender context, to match reply w/ request
1366 define nat66_static_mapping_dump {
1371 /** \brief NAT66 static mapping details response
1372 @param context - sender context, to match reply w/ request
1373 @param local_ip_address - local IPv6 address
1374 @param external_ip_address - external IPv6 address
1375 @param vrf_id - VRF id of tenant
1376 @param total_bytes - count of bytes sent through static mapping
1377 @param total_pkts - count of pakets sent through static mapping
1379 define nat66_static_mapping_details {
1381 u8 local_ip_address[16];
1382 u8 external_ip_address[16];