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.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
347 @param local_port - local port number
348 @param external_port - external port number
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
390 @param local_port - local port number
391 @param external_port - external port number
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 typeonly manual_endian define nat44_lb_addr_port {
573 autoreply manual_endian define nat44_add_del_lb_static_mapping {
585 vl_api_nat44_lb_addr_port_t locals[local_num];
588 define nat44_lb_static_mapping_dump {
593 manual_endian define nat44_lb_static_mapping_details {
603 vl_api_nat44_lb_addr_port_t locals[local_num];
606 /** \brief Delete NAT44 session
607 @param client_index - opaque cookie to identify the sender
608 @param context - sender context, to match reply w/ request
609 @param is_in - 1 if inside network addres and port pari, 0 if outside
610 @param ip_address - IPv4 address
611 @param protocol - IP protocol
612 @param port - port number
613 @param vfr_id - VRF ID
615 autoreply define nat44_del_session {
625 /** \brief Enable/disable forwarding for NAT44
626 Forward packets which don't match existing translation
627 or static mapping instead of dropping them.
628 @param client_index - opaque cookie to identify the sender
629 @param context - sender context, to match reply w/ request
630 @param enable - 0 for enable, 1 for disable
632 autoreply define nat44_forwarding_enable_disable {
638 /** \brief Check if forwarding is enabled or disabled
639 @param client_index - opaque cookie to identify the sender
640 @param context - sender context, to match reply w/ request
642 define nat44_forwarding_is_enabled {
647 /** \brief Response to check if forwarding is enabled or disabled
648 @param context - sender context, to match reply w/ request
649 @param enabled - 1 if enabled, 0 if disabled
651 define nat44_forwarding_is_enabled_reply {
658 * Deterministic NAT (CGN) APIs
661 /** \brief Add/delete NAT deterministic mapping
662 @param client_index - opaque cookie to identify the sender
663 @param context - sender context, to match reply w/ request
664 @param is_add - 1 if add, 0 if delete
665 @param is_nat44 - 1 if NAT44
666 @param in_addr - inside IP address
667 @param in_plen - inside IP address prefix length
668 @param out_addr - outside IPv4 address
669 @param out_addr - outside IPv4 address prefix length
671 autoreply define nat_det_add_del_map {
683 /** \brief Get outside address and port range from inside address
684 @param client_index - opaque cookie to identify the sender
685 @param context - sender context, to match reply w/ request
686 @param is_nat44 - 1 if NAT44
687 @param in_addr - inside IP address
689 define nat_det_forward {
696 /** \brief Get outside address and port range from inside address
697 @param context - sender context, to match reply w/ request
698 @param retval - return code
699 @param out_port_lo - outside port range start
700 @param out_port_hi - outside port range end
701 @param out_addr - outside IPv4 address
703 define nat_det_forward_reply {
711 /** \brief Get inside address from outside address and port
712 @param client_index - opaque cookie to identify the sender
713 @param context - sender context, to match reply w/ request
714 @param out_port - outside port
715 @param out_addr - outside IPv4 address
717 define nat_det_reverse {
724 /** \brief Get inside address from outside address and port reply
725 @param context - sender context, to match reply w/ request
726 @param retval - return code
727 @param is_nat44 - 1 if NAT44
728 @param in_addr - inside IP address
730 define nat_det_reverse_reply {
737 /** \brief Dump NAT deterministic mappings
738 @param client_index - opaque cookie to identify the sender
739 @param context - sender context, to match reply w/ request
741 define nat_det_map_dump {
746 /** \brief NAT users response
747 @param context - sender context, to match reply w/ request
748 @param is_nat44 - 1 if NAT44
749 @param in_addr - inside IP address
750 @param in_plen - inside IP address prefix length
751 @param out_addr - outside IPv4 address
752 @param out_plen - outside IPv4 address prefix length
753 @param sharing_ratio - outside to inside address sharing ratio
754 @param ports_per_host - number of ports available to a host
755 @param ses_num - number of sessions belonging to this mapping
757 define nat_det_map_details {
769 /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
770 @param client_index - opaque cookie to identify the sender
771 @param context - sender context, to match reply w/ request
772 @param udp - UDP timeout (default 300sec)
773 @param tcp_established - TCP established timeout (default 7440sec)
774 @param tcp_transitory - TCP transitory timeout (default 240sec)
775 @param icmp - ICMP timeout (default 60sec)
777 autoreply define nat_det_set_timeouts {
786 /** \brief Get values of timeouts for deterministic NAT (seconds)
787 @param client_index - opaque cookie to identify the sender
788 @param context - sender context, to match reply w/ request
790 define nat_det_get_timeouts {
795 /** \brief Get values of timeouts for deterministic NAT reply
796 @param context - sender context, to match reply w/ request
797 @param retval - return code
798 @param udp - UDP timeout (default 300sec)
799 @param tcp_established - TCP established timeout (default 7440sec)
800 @param tcp_transitory - TCP transitory timeout (default 240sec)
801 @param icmp - ICMP timeout (default 60sec)
803 define nat_det_get_timeouts_reply {
812 /** \brief Close deterministic NAT session by outside address and port
813 @param client_index - opaque cookie to identify the sender
814 @param context - sender context, to match reply w/ request
815 @param out_addr - outside IPv4 address
816 @param out_port - outside port
817 @param ext_addr - external host IPv4 address
818 @param ext_port - external host port
820 autoreply define nat_det_close_session_out {
829 /** \brief Close deterministic NAT session by inside address and port
830 @param client_index - opaque cookie to identify the sender
831 @param context - sender context, to match reply w/ request
832 @param is_nat44 - 1 if NAT44
833 @param in_addr - inside IP address
834 @param in_port - inside port
835 @param ext_addr - external host IP address
836 @param ext_port - external host port
838 autoreply define nat_det_close_session_in {
848 /** \brief Dump determinstic NAT sessions
849 @param client_index - opaque cookie to identify the sender
850 @param context - sender context, to match reply w/ request
851 @param is_nat44 - 1 if NAT44
852 @param user_addr - address of an inside user whose sessions to dump
854 define nat_det_session_dump {
861 /** \brief Deterministic NAT sessions reply
862 @param context - sender context, to match reply w/ request
863 @param in_port - inside port
864 @param ext_addr - external host address
865 @param ext_port - external host port
866 @param out_port - outside NAT port
867 @param state - session state
868 @param expire - session expiration timestamp
870 define nat_det_session_details {
885 /** \brief Add/delete address range to NAT64 pool
886 @param client_index - opaque cookie to identify the sender
887 @param context - sender context, to match reply w/ request
888 @param start_addr - start address of the range
889 @param end_addr - end address of the range
890 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
891 @param is_add - 1 if add, 0 if delete
893 autoreply define nat64_add_del_pool_addr_range {
902 /** \brief Dump NAT64 pool addresses
903 @param client_index - opaque cookie to identify the sender
904 @param context - sender context, to match reply w/ request
906 define nat64_pool_addr_dump {
911 /** \brief NAT64 pool address details response
912 @param context - sender context, to match reply w/ request
913 @param address - IPv4 address
914 @param vfr_id - VRF id of tenant, ~0 means independent of VRF
916 define nat64_pool_addr_details {
922 /** \brief Enable/disable NAT64 feature on the interface
923 @param client_index - opaque cookie to identify the sender
924 @param context - sender context, to match reply w/ request
925 @param sw_if_index - index of the interface
926 @param is_inside - 1 if inside, 0 if outside
927 @param is_add - 1 if add, 0 if delete
929 autoreply define nat64_add_del_interface {
937 /** \brief Dump interfaces with NAT64 feature
938 @param client_index - opaque cookie to identify the sender
939 @param context - sender context, to match reply w/ request
941 define nat64_interface_dump {
946 /** \brief NAT64 interface details response
947 @param context - sender context, to match reply w/ request
948 @param is_inside - 1 if inside, 0 if outside
949 @param sw_if_index - index of the interface
951 define nat64_interface_details {
957 /** \brief Add/delete NAT64 static BIB entry
958 @param client_index - opaque cookie to identify the sender
959 @param context - sender context, to match reply w/ request
960 @param i_addr - inside IPv6 address
961 @param o_addr - outside IPv4 address
962 @param i_port - inside port number
963 @param o_port - outside port number
964 @param vrf_id - VRF id of tenant
965 @param proto - protocol number
966 @param is_add - 1 if add, 0 if delete
968 autoreply define nat64_add_del_static_bib {
980 /** \brief Dump NAT64 BIB
981 @param client_index - opaque cookie to identify the sender
982 @param context - sender context, to match reply w/ request
983 @param proto - protocol of the BIB: 255 - all BIBs
987 otherwise - "unknown" protocol BIB
989 define nat64_bib_dump {
995 /** \brief NAT64 BIB details response
996 @param context - sender context, to match reply w/ request
997 @param i_addr - inside IPv6 address
998 @param o_addr - outside IPv4 address
999 @param i_port - inside port number
1000 @param o_port - outside port number
1001 @param vrf_id - VRF id of tenant
1002 @param proto - protocol number
1003 @param is_static - 1 if static BIB entry, 0 if dynamic
1004 @param ses_num - number of sessions associated with the BIB entry
1006 define nat64_bib_details {
1018 /** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
1019 @param client_index - opaque cookie to identify the sender
1020 @param context - sender context, to match reply w/ request
1021 @param udp - UDP timeout (default 300sec)
1022 @param icmp - ICMP timeout (default 60sec)
1023 @param tcp_trans - TCP transitory timeout (default 240sec)
1024 @param tcp_est - TCP established timeout (default 7440sec)
1025 @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
1027 autoreply define nat64_set_timeouts {
1034 u32 tcp_incoming_syn;
1037 /** \brief Get values of timeouts for NAT64 (seconds)
1038 @param client_index - opaque cookie to identify the sender
1039 @param context - sender context, to match reply w/ request
1041 define nat64_get_timeouts {
1046 /** \brief Get values of timeouts for NAT64 reply
1047 @param context - sender context, to match reply w/ request
1048 @param retval - return code
1049 @param udp - UDP timeout
1050 @param icmp - ICMP timeout
1051 @param tcp_trans - TCP transitory timeout
1052 @param tcp_est - TCP established timeout
1053 @param tcp_incoming_syn - TCP incoming SYN timeout
1055 define nat64_get_timeouts_reply {
1062 u32 tcp_incoming_syn;
1065 /** \brief Dump NAT64 session table
1066 @param client_index - opaque cookie to identify the sender
1067 @param context - sender context, to match reply w/ request
1068 @param proto - protocol of the session table: 255 - all STs
1072 otherwise - "unknown" proto ST
1074 define nat64_st_dump {
1080 /** \brief NAT64 session table details response
1081 @param context - sender context, to match reply w/ request
1082 @param il_addr - inside IPv6 address of the local host
1083 @param ol_addr - outside IPv4 address of the local host
1084 @param il_port - inside port number id of the local host/inside ICMP id
1085 @param ol_port - outside port number of the local host/outside ICMP id
1086 @param il_addr - inside IPv6 address of the remote host
1087 @param ol_addr - outside IPv4 address of the remote host
1088 @param l_port - port number of the remote host (not used for ICMP)
1089 @param vrf_id - VRF id of tenant
1090 @param proto - protocol number
1092 define nat64_st_details {
1105 /** \brief Add/del NAT64 prefix
1106 @param client_index - opaque cookie to identify the sender
1107 @param context - sender context, to match reply w/ request
1108 @param prefix - NAT64 prefix
1109 @param prefix - NAT64 prefix length
1110 @param vrf_id - VRF id of tenant
1111 @param is_add - 1 if add, 0 if delete
1113 autoreply define nat64_add_del_prefix {
1122 /** \brief Dump NAT64 prefix
1123 @param client_index - opaque cookie to identify the sender
1124 @param context - sender context, to match reply w/ request
1126 define nat64_prefix_dump {
1131 /** \brief Dump NAT64 prefix details response
1132 @param context - sender context, to match reply w/ request
1133 @param prefix - NAT64 prefix
1134 @param prefix - NAT64 prefix length
1135 @param vrf_id - VRF id of tenant
1137 define nat64_prefix_details {
1144 /** \brief Add/delete NAT64 pool address from specific interfce
1145 @param client_index - opaque cookie to identify the sender
1146 @param context - sender context, to match reply w/ request
1147 @param is_add - 1 if add, 0 if delete
1148 @param sw_if_index - software index of the interface
1150 autoreply define nat64_add_del_interface_addr {
1163 /** \brief Add/delete address range to DS-Lite pool
1164 @param client_index - opaque cookie to identify the sender
1165 @param context - sender context, to match reply w/ request
1166 @param start_addr - start address of the range
1167 @param end_addr - end address of the range
1168 @param is_add - 1 if add, 0 if delete
1170 autoreply define dslite_add_del_pool_addr_range {
1178 /** \brief Set AFTR IPv6 and IPv4 addresses
1179 @param client_index - opaque cookie to identify the sender
1180 @param context - sender context, to match reply w/ request
1181 @param ip4_addr - IPv4 address
1182 @param ip6_addr - IP64 address
1184 autoreply define dslite_set_aftr_addr {
1191 /** \brief Get AFTR IPv6 and IPv4 addresses
1192 @param client_index - opaque cookie to identify the sender
1193 @param context - sender context, to match reply w/ request
1195 define dslite_get_aftr_addr {
1200 /** \brief Response to get AFTR IPv6 and IPv4 addresses
1201 @param context - sender context, to match reply w/ request
1202 @param retval - return code
1203 @param ip4_addr - IPv4 address
1204 @param ip6_addr - IP64 address
1206 define dslite_get_aftr_addr_reply {
1213 /** \brief Set B4 IPv6 and IPv4 addresses
1214 @param client_index - opaque cookie to identify the sender
1215 @param context - sender context, to match reply w/ request
1216 @param ip4_addr - IPv4 address
1217 @param ip6_addr - IP64 address
1219 autoreply define dslite_set_b4_addr {
1226 /** \brief Get B4 IPv6 and IPv4 addresses
1227 @param client_index - opaque cookie to identify the sender
1228 @param context - sender context, to match reply w/ request
1230 define dslite_get_b4_addr {
1235 /** \brief Response to get B4 IPv6 and IPv4 addresses
1236 @param context - sender context, to match reply w/ request
1237 @param retval - return code
1238 @param ip4_addr - IPv4 address
1239 @param ip6_addr - IP64 address
1241 define dslite_get_b4_addr_reply {