2 * Copyright (c) 2020 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 = "1.0.0";
17 import "vnet/ip/ip_types.api";
18 import "vnet/interface_types.api";
19 import "plugins/nat/lib/nat_types.api";
21 enum nat44_ei_config_flags : u8
24 NAT44_EI_STATIC_MAPPING_ONLY = 0x01,
25 NAT44_EI_CONNECTION_TRACKING = 0x02,
26 NAT44_EI_OUT2IN_DPO = 0x04,
27 NAT44_EI_ADDR_ONLY_MAPPING = 0x08,
28 NAT44_EI_IF_INSIDE = 0x10,
29 NAT44_EI_IF_OUTSIDE = 0x20,
30 NAT44_EI_STATIC_MAPPING = 0x40,
33 /** \brief Enable/disable NAT44 plugin
34 @param client_index - opaque cookie to identify the sender
35 @param context - sender context, to match reply w/ request
36 @param inside_vrf - inside vrf id
37 @param outside_vrf - outside vrf id
38 @param users - maximum number of users per thread
39 @param user_memory - overwrite hash allocation parameter
40 @param sessions - maximum number of sessions per thread
41 @param session_memory - overwrite hash allocation parameter
42 @param user_sessions - maximum number of sessions per user
43 @param enable - true if enable, false if disable
44 @param flags - flag NAT44_EI_IS_STATIC_MAPPING_ONLY,
45 NAT44_EI_IS_CONNECTION_TRACKING,
46 NAT44_EI_IS_OUT2IN_DPO
48 autoreply define nat44_ei_plugin_enable_disable {
60 vl_api_nat44_ei_config_flags_t flags;
63 /** \brief Show NAT44 plugin running config
64 @param client_index - opaque cookie to identify the sender
65 @param context - sender context, to match reply w/ request
67 define nat44_ei_show_running_config
74 /** \brief Show NAT44 plugin running config reply
75 @param context - sender context, to match reply w/ request
76 @param retval - return code for the request
77 @param inside_vrf - default inside VRF id
78 @param outside_vrf - outside VRF id
79 @param users - maximum number of users per worker thread
80 @param sessions - maximum number of sessions per worker thread
81 @param user_sessions - maximum number of sessions per user
82 @param user_buckets - number of user hash buckets
83 @param translation_buckets - number of translation hash buckets
84 @param flags - flag NAT44_EI_IS_STATIC_MAPPING_ONLY,
85 NAT44_EI_IS_CONNECTION_TRACKING,
86 NAT44_EI_IS_OUT2IN_DPO
88 define nat44_ei_show_running_config_reply
99 u32 translation_buckets;
100 bool forwarding_enabled;
101 bool ipfix_logging_enabled;
102 vl_api_nat_timeouts_t timeouts;
103 vl_api_nat_log_level_t log_level;
104 vl_api_nat44_ei_config_flags_t flags;
107 /** \brief Set NAT44 logging level
108 @param client_index - opaque cookie to identify the sender
109 @param context - sender context, to match reply w/ request
110 @param log_level - logging level
112 autoreply define nat44_ei_set_log_level {
116 vl_api_nat_log_level_t log_level;
119 /** \brief Set NAT workers
120 @param client_index - opaque cookie to identify the sender
121 @param context - sender context, to match reply w/ request
122 @param worker_mask - NAT workers mask
124 autoreply define nat44_ei_set_workers {
131 /** \brief Dump NAT workers
132 @param client_index - opaque cookie to identify the sender
133 @param context - sender context, to match reply w/ request
135 define nat44_ei_worker_dump {
141 /** \brief NAT workers details response
142 @param context - sender context, to match reply w/ request
143 @param worker_index - worker index
144 @param lcore_id - lcore ID
145 @param name - worker name
147 define nat44_ei_worker_details {
155 /** \brief Enable/disable NAT IPFIX logging
156 @param client_index - opaque cookie to identify the sender
157 @param context - sender context, to match reply w/ request
158 @param domain_id - observation domain ID
159 @param src_port - source port number
160 @param enable - true if enable, false if disable
162 autoreply define nat44_ei_ipfix_enable_disable {
171 /** \brief Set values of timeouts for NAT sessions (seconds)
172 @param client_index - opaque cookie to identify the sender
173 @param context - sender context, to match reply w/ request
174 @param udp - UDP timeout (default 300sec)
175 @param tcp_established - TCP established timeout (default 7440sec)
176 @param tcp_transitory - TCP transitory timeout (default 240sec)
177 @param icmp - ICMP timeout (default 60sec)
179 autoreply define nat44_ei_set_timeouts {
189 /** \brief Set address and port assignment algorithm
190 @param client_index - opaque cookie to identify the sender
191 @param context - sender context, to match reply w/ request
192 @param alg - address and port assignment algorithm:
193 0 - default, 1 - MAP-E, 2 - port range
194 (see nat44_ei_addr_and_port_alloc_alg_t in nat.h)
195 @param psid_offset - number of offset bits (valid only for MAP-E alg)
196 @param psid_length - length of PSID (valid only for MAP-E alg)
197 @param psid - Port Set Identifier (PSID) value (valid only for MAP-E alg)
198 @param start_port - beginning of the port range
199 @param end_port - end of the port range
201 autoreply define nat44_ei_set_addr_and_port_alloc_alg {
213 /** \brief Get address and port assignment algorithm
214 @param client_index - opaque cookie to identify the sender
215 @param context - sender context, to match reply w/ request
217 define nat44_ei_get_addr_and_port_alloc_alg {
223 /** \brief Get address and port assignment algorithm reply
224 @param context - sender context, to match reply w/ request
225 @param retval - return code
226 @param alg - address and port assignment algorithm:
227 0 - default, 1 - MAP-E, 2 - port range
228 (see nat44_ei_addr_and_port_alloc_alg_t in nat.h)
229 @param psid_offset - number of offset bits (valid only for MAP-E alg)
230 @param psid_length - length of PSID (valid only for MAP-E alg)
231 @param psid - Port Set Identifier (PSID) value (valid only for MAP-E alg)
232 @param start_port - beginning of the port range
233 @param end_port - end of the port range
235 define nat44_ei_get_addr_and_port_alloc_alg_reply {
247 /** \brief Set TCP MSS rewriting configuration
248 @param client_index - opaque cookie to identify the sender
249 @param context - sender context, to match reply w/ request
250 @param mss_value - MSS value to be used for MSS rewriting
251 @param enable - if true enable MSS rewriting feature else disable
253 autoreply define nat44_ei_set_mss_clamping {
261 /** \brief Get TCP MSS rewriting configuration
262 @param client_index - opaque cookie to identify the sender
263 @param context - sender context, to match reply w/ request
265 define nat44_ei_get_mss_clamping {
271 /** \brief Get TCP MSS rewriting configuration reply
272 @param context - sender context, to match reply w/ request
273 @param retval - return code
274 @param mss_value - MSS value to be used for MSS rewriting
275 @param enable - if true enable MSS rewriting feature else disable
277 define nat44_ei_get_mss_clamping_reply {
285 /** \brief Set HA listener (local settings)
286 @param client_index - opaque cookie to identify the sender
287 @param context - sender context, to match reply w/ request
288 @param ip_address - local IP4 address
289 @param port - local UDP port number
290 @param path_mtu - path MTU between local and failover
292 autoreply define nat44_ei_ha_set_listener {
296 vl_api_ip4_address_t ip_address;
301 /** \brief Set HA failover (remote settings)
302 @param client_index - opaque cookie to identify the sender
303 @param context - sender context, to match reply w/ request
304 @param ip_address - failover IP4 address
305 @param port - failvoer UDP port number
306 @param session_refresh_interval - number of seconds after which to send
307 session counters refresh
309 autoreply define nat44_ei_ha_set_failover {
313 vl_api_ip4_address_t ip_address;
315 u32 session_refresh_interval;
318 /** \brief Get HA listener/local configuration
319 @param client_index - opaque cookie to identify the sender
320 @param context - sender context, to match reply w/ request
322 define nat44_ei_ha_get_listener {
328 /** \brief Get HA listener/local configuration reply
329 @param context - sender context, to match reply w/ request
330 @param retval - return code
331 @param ip_address - local IP4 address
332 @param port - local UDP port number
333 @param path_mtu - Path MTU between local and failover
335 define nat44_ei_ha_get_listener_reply {
339 vl_api_ip4_address_t ip_address;
344 /** \brief Get HA failover/remote settings
345 @param client_index - opaque cookie to identify the sender
346 @param context - sender context, to match reply w/ request
348 define nat44_ei_ha_get_failover {
354 /** \brief Get HA failover/remote settings reply
355 @param context - sender context, to match reply w/ request
356 @param retval - return code
357 @param ip_address - failover IP4 address
358 @param port - failvoer UDP port number
359 @param session_refresh_interval - number of seconds after which to send
360 session counters refresh
362 define nat44_ei_ha_get_failover_reply {
366 vl_api_ip4_address_t ip_address;
368 u32 session_refresh_interval;
371 /** \brief Flush the current HA data (for testing)
372 @param client_index - opaque cookie to identify the sender
373 @param context - sender context, to match reply w/ request
375 autoreply define nat44_ei_ha_flush {
381 /** \brief Resync HA (resend existing sessions to new failover)
382 @param client_index - opaque cookie to identify the sender
383 @param context - sender context, to match reply w/ request
384 @param want_resync_event - resync completed event sent to the sender via
385 nat44_ei_ha_resync_completed_event API message if
387 @param pid - sender's pid
389 autoreply define nat44_ei_ha_resync
394 u8 want_resync_event;
398 /** \brief Tell client about a HA resync completion event
399 @param client_index - opaque cookie to identify the sender
400 @param pid - client pid registered to receive notification
401 @param missed_count - number of missed (not ACKed) messages
403 define nat44_ei_ha_resync_completed_event
412 rpc nat44_ei_ha_resync returns nat44_ei_ha_resync_reply events nat44_ei_ha_resync_completed_event;
415 /** \brief Del NAT44 user
416 @param client_index - opaque cookie to identify the sender
417 @param context - sender context, to match reply w/ request
418 @param ip_address - IPv4 address
419 @param fib_index - FIB index
421 autoreply define nat44_ei_del_user {
425 vl_api_ip4_address_t ip_address;
429 /** \brief Add/del NAT44 address range
430 @param client_index - opaque cookie to identify the sender
431 @param context - sender context, to match reply w/ request
432 @param first_ip_address - first IPv4 address
433 @param last_ip_address - last IPv4 address
434 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
435 @param is_add - true if add, false if delete
438 autoreply define nat44_ei_add_del_address_range {
442 vl_api_ip4_address_t first_ip_address;
443 vl_api_ip4_address_t last_ip_address;
448 /** \brief Dump NAT44 addresses
449 @param client_index - opaque cookie to identify the sender
450 @param context - sender context, to match reply w/ request
452 define nat44_ei_address_dump {
458 /** \brief NAT44 address details response
459 @param context - sender context, to match reply w/ request
460 @param ip_address - IPv4 address
461 @param vrf_id - VRF id of tenant, ~0 means independent of VRF
463 define nat44_ei_address_details {
466 vl_api_ip4_address_t ip_address;
470 /** \brief Enable/disable NAT44 feature on the interface
471 @param client_index - opaque cookie to identify the sender
472 @param context - sender context, to match reply w/ request
473 @param is_add - true if add, false if delete
474 @param flags - flag NAT_IS_INSIDE if interface is inside else
476 @param sw_if_index - software index of the interface
478 autoreply define nat44_ei_interface_add_del_feature {
483 vl_api_nat44_ei_config_flags_t flags;
484 vl_api_interface_index_t sw_if_index;
487 /** \brief Dump interfaces with NAT44 feature
488 @param client_index - opaque cookie to identify the sender
489 @param context - sender context, to match reply w/ request
491 define nat44_ei_interface_dump {
497 /** \brief NAT44 interface details response
498 @param context - sender context, to match reply w/ request
499 @param sw_if_index - software index of the interface
500 @param flags - flag NAT_IS_INSIDE if interface is inside,
501 flag NAT_IS_OUTSIDE if interface is outside
502 and if both flags are set the interface is
503 both inside and outside
505 define nat44_ei_interface_details {
508 vl_api_nat44_ei_config_flags_t flags;
509 vl_api_interface_index_t sw_if_index;
512 /** \brief Enable/disbale NAT44 as an interface output feature (postrouting
514 @param client_index - opaque cookie to identify the sender
515 @param context - sender context, to match reply w/ request
516 @param is_add - true if add, false if delete
517 @param flags - flag NAT_IS_INSIDE if interface is inside else
519 @param sw_if_index - software index of the interface
521 autoreply define nat44_ei_interface_add_del_output_feature {
526 vl_api_nat44_ei_config_flags_t flags;
527 vl_api_interface_index_t sw_if_index;
530 /** \brief Dump interfaces with NAT44 output feature
531 @param client_index - opaque cookie to identify the sender
532 @param context - sender context, to match reply w/ request
534 define nat44_ei_interface_output_feature_dump {
540 /** \brief NAT44 interface with output feature details response
541 @param context - sender context, to match reply w/ request
542 @param flags - flag NAT_IS_INSIDE if interface is inside else
544 @param sw_if_index - software index of the interface
546 define nat44_ei_interface_output_feature_details {
549 vl_api_nat44_ei_config_flags_t flags;
550 vl_api_interface_index_t sw_if_index;
553 /** \brief Add/delete NAT44 static mapping
554 @param client_index - opaque cookie to identify the sender
555 @param context - sender context, to match reply w/ request
556 @param is_add - true if add, false if delete
557 @param flags - flag NAT44_EI_IS_ADDR_ONLY if address only mapping
558 @param local_ip_address - local IPv4 address
559 @param external_ip_address - external IPv4 address
560 @param protocol - IP protocol, used only if addr_only=0
561 @param local_port - local port number, used only if addr_only=0
562 @param external_port - external port number, used only if addr_only=0
563 @param external_sw_if_index - external interface (if set
564 external_ip_address is ignored, ~0 means not
566 @param vfr_id - VRF ID
567 @param tag - opaque string tag
569 autoreply define nat44_ei_add_del_static_mapping {
574 vl_api_nat44_ei_config_flags_t flags;
575 vl_api_ip4_address_t local_ip_address;
576 vl_api_ip4_address_t external_ip_address;
580 vl_api_interface_index_t external_sw_if_index;
585 /** \brief Dump NAT44 static mappings
586 @param client_index - opaque cookie to identify the sender
587 @param context - sender context, to match reply w/ request
589 define nat44_ei_static_mapping_dump {
595 /** \brief NAT44 static mapping details response
596 @param context - sender context, to match reply w/ request
597 @param flags - flag NAT44_EI_IS_ADDR_ONLY if address only mapping,
598 @param local_ip_address - local IPv4 address
599 @param external_ip_address - external IPv4 address
600 @param protocol - IP protocol, valid only if no NAT_ADDR_ONLY flag
601 @param local_port - local port number, valid only if no NAT_ADDR_ONLY flag
602 @param external_port - external port number, valid only if no NAT_ADDR_ONLY flag
603 @param external_sw_if_index - external interface
604 @param vfr_id - VRF ID
605 @param tag - opaque string tag
607 define nat44_ei_static_mapping_details {
610 vl_api_nat44_ei_config_flags_t flags;
611 vl_api_ip4_address_t local_ip_address;
612 vl_api_ip4_address_t external_ip_address;
616 vl_api_interface_index_t external_sw_if_index;
621 /** \brief Add/delete NAT44 identity mapping
622 @param client_index - opaque cookie to identify the sender
623 @param context - sender context, to match reply w/ request
624 @param is_add - true if add, false if delete
625 @param flags - flag NAT44_EI_IS_ADDR_ONLY if address only mapping
626 @param ip_address - IPv4 address
627 @param protocol - IP protocol
628 @param port - port number
629 @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
631 @param vfr_id - VRF ID (if ~0 use default VRF)
632 @param tag - opaque string tag
634 autoreply define nat44_ei_add_del_identity_mapping {
639 vl_api_nat44_ei_config_flags_t flags;
640 vl_api_ip4_address_t ip_address;
643 vl_api_interface_index_t sw_if_index;
648 /** \brief Dump NAT44 identity mappings
649 @param client_index - opaque cookie to identify the sender
650 @param context - sender context, to match reply w/ request
652 define nat44_ei_identity_mapping_dump {
658 /** \brief NAT44 identity mapping details response
659 @param context - sender context, to match reply w/ request
660 @param flags - flag NAT44_EI_ADDR_ONLY if address only mapping
661 @param ip_address - IPv4 address
662 @param protocol - IP protocol
663 @param port - port number
664 @param sw_if_index - interface
665 @param vfr_id - VRF ID
666 @param tag - opaque string tag
668 define nat44_ei_identity_mapping_details {
671 vl_api_nat44_ei_config_flags_t flags;
672 vl_api_ip4_address_t ip_address;
675 vl_api_interface_index_t sw_if_index;
680 /** \brief Add/delete NAT44 pool address from specific interfce
681 @param client_index - opaque cookie to identify the sender
682 @param context - sender context, to match reply w/ request
683 @param is_add - true if add, false if delete
684 @param sw_if_index - software index of the interface
685 @param flags - flag NAT_TWICE_NAT if NAT address range for external hosts
687 autoreply define nat44_ei_add_del_interface_addr {
692 vl_api_interface_index_t sw_if_index;
693 vl_api_nat44_ei_config_flags_t flags;
696 /** \brief Dump NAT44 pool addresses interfaces
697 @param client_index - opaque cookie to identify the sender
698 @param context - sender context, to match reply w/ request
700 define nat44_ei_interface_addr_dump {
706 /** \brief NAT44 pool addresses interfaces details response
707 @param context - sender context, to match reply w/ request
708 @param sw_if_index - software index of the interface
711 define nat44_ei_interface_addr_details {
714 vl_api_interface_index_t sw_if_index;
717 /** \brief Dump NAT44 users
718 @param client_index - opaque cookie to identify the sender
719 @param context - sender context, to match reply w/ request
721 define nat44_ei_user_dump {
727 /** \brief NAT44 users response
728 @param context - sender context, to match reply w/ request
730 @param ip_address - IPv4 address
731 @param nsessions - number of dynamic sessions
732 @param nstaticsessions - number of static sessions
734 define nat44_ei_user_details {
738 vl_api_ip4_address_t ip_address;
743 /** \brief NAT44 user's sessions
744 @param client_index - opaque cookie to identify the sender
745 @param context - sender context, to match reply w/ request
746 @param ip_address - IPv4 address of the user to dump
747 @param vrf_id - VRF_ID
749 define nat44_ei_user_session_dump {
753 vl_api_ip4_address_t ip_address;
757 /** \brief NAT44 user's sessions response
758 @param context - sender context, to match reply w/ request
759 @param outside_ip_address - outside IPv4 address
760 @param outside_port - outside port
761 @param inside_ip_address - inside IPv4 address
762 @param inside_port - inside port
763 @param protocol - protocol
764 @param flags - flag NAT_IS_STATIC if session is static
765 @param last_heard - last heard timer
766 @param total_bytes - count of bytes sent through session
767 @param total_pkts - count of pakets sent through session
768 @param ext_host_address - external host IPv4 address
769 @param ext_host_port - external host port
771 define nat44_ei_user_session_details {
774 vl_api_ip4_address_t outside_ip_address;
776 vl_api_ip4_address_t inside_ip_address;
779 vl_api_nat44_ei_config_flags_t flags;
783 vl_api_ip4_address_t ext_host_address;
787 /** \brief Delete NAT44 session
788 @param client_index - opaque cookie to identify the sender
789 @param context - sender context, to match reply w/ request
790 @param ip_address - IPv4 address
791 @param protocol - IP protocol
792 @param port - port number
793 @param vfr_id - VRF ID
794 @param flags - flag NAT_IS_INSIDE if interface is inside or
795 interface is outside,
796 flag NAT_IS_EXT_HOST_VALID if external host address and
798 @param ext_host_address - external host IPv4 address
799 @param ext_host_port - external host port
801 autoreply define nat44_ei_del_session {
805 vl_api_ip4_address_t address;
809 vl_api_nat44_ei_config_flags_t flags;
810 vl_api_ip4_address_t ext_host_address;
814 /** \brief Enable/disable forwarding for NAT44
815 Forward packets which don't match existing translation
816 or static mapping instead of dropping them.
817 @param client_index - opaque cookie to identify the sender
818 @param context - sender context, to match reply w/ request
819 @param enable - true for enable, false for disable
821 autoreply define nat44_ei_forwarding_enable_disable {
828 /** \brief Set NAT handoff frame queue options
829 @param client_index - opaque cookie to identify the sender
830 @param context - sender context, to match reply w/ request
831 @param frame_queue_nelts - number of worker handoff frame queue elements
833 autoreply define nat44_ei_set_fq_options {
837 u32 frame_queue_nelts;
840 /** \brief Show NAT handoff frame queue options
841 @param client_index - opaque cookie to identify the sender
842 @param context - sender context, to match reply w/ request
844 define nat44_ei_show_fq_options
851 /** \brief Show NAT handoff frame queue options reply
852 @param context - sender context, to match reply w/ request
853 @param retval - return code for the request
854 @param frame_queue_nelts - number of worker handoff frame queue elements
856 define nat44_ei_show_fq_options_reply
861 u32 frame_queue_nelts;