2 * Copyright (c) 2018 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.
20 #include <vnet/fib/fib_table.h>
22 #include <nat/lib/log.h>
23 #include <nat/lib/nat_inlines.h>
24 #include <nat/lib/ipfix_logging.h>
26 #include <nat/nat44-ed/nat44_ed.h>
27 #include <nat/nat44-ed/nat44_ed_inlines.h>
28 #include <nat/nat44-ed/nat44_ed_affinity.h>
30 #define NAT44_ED_EXPECTED_ARGUMENT "expected required argument(s)"
33 nat44_ed_enable_disable_command_fn (vlib_main_t *vm, unformat_input_t *input,
34 vlib_cli_command_t *cmd)
36 snat_main_t *sm = &snat_main;
37 unformat_input_t _line_input, *line_input = &_line_input;
38 clib_error_t *error = 0;
40 nat44_config_t c = { 0 };
41 u8 enable_set = 0, enable = 0;
43 if (!unformat_user (input, unformat_line_input, line_input))
44 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
46 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
48 if (unformat (line_input, "inside-vrf %u", &c.inside_vrf))
50 else if (unformat (line_input, "outside-vrf %u", &c.outside_vrf));
51 else if (unformat (line_input, "sessions %u", &c.sessions));
55 if (unformat (line_input, "disable"))
57 else if (unformat (line_input, "enable"))
62 error = clib_error_return (0, "unknown input '%U'",
63 format_unformat_error, line_input);
70 error = clib_error_return (0, "expected enable | disable");
78 error = clib_error_return (0, "already enabled");
82 if (nat44_plugin_enable (c) != 0)
83 error = clib_error_return (0, "enable failed");
89 error = clib_error_return (0, "already disabled");
93 if (nat44_plugin_disable () != 0)
94 error = clib_error_return (0, "disable failed");
98 unformat_free (line_input);
102 static clib_error_t *
103 set_workers_command_fn (vlib_main_t * vm,
104 unformat_input_t * input, vlib_cli_command_t * cmd)
106 unformat_input_t _line_input, *line_input = &_line_input;
109 clib_error_t *error = 0;
111 /* Get a line of input. */
112 if (!unformat_user (input, unformat_line_input, line_input))
113 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
115 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
117 if (unformat (line_input, "%U", unformat_bitmap_list, &bitmap))
121 error = clib_error_return (0, "unknown input '%U'",
122 format_unformat_error, line_input);
129 error = clib_error_return (0, "List of workers must be specified.");
133 rv = snat_set_workers (bitmap);
135 clib_bitmap_free (bitmap);
139 case VNET_API_ERROR_INVALID_WORKER:
140 error = clib_error_return (0, "Invalid worker(s).");
142 case VNET_API_ERROR_FEATURE_DISABLED:
143 error = clib_error_return (0,
144 "Supported only if 2 or more workes available.");
151 unformat_free (line_input);
156 static clib_error_t *
157 nat_show_workers_command_fn (vlib_main_t *vm, unformat_input_t *input,
158 vlib_cli_command_t *cmd)
160 snat_main_t *sm = &snat_main;
163 if (sm->num_workers > 1)
165 vlib_cli_output (vm, "%d workers", vec_len (sm->workers));
166 vec_foreach (worker, sm->workers)
168 vlib_worker_thread_t *w =
169 vlib_worker_threads + *worker + sm->first_worker_index;
170 vlib_cli_output (vm, " %s", w->name);
177 static clib_error_t *
178 snat_set_log_level_command_fn (vlib_main_t * vm,
179 unformat_input_t * input,
180 vlib_cli_command_t * cmd)
182 unformat_input_t _line_input, *line_input = &_line_input;
183 snat_main_t *sm = &snat_main;
184 u8 log_level = NAT_LOG_NONE;
185 clib_error_t *error = 0;
187 /* Get a line of input. */
188 if (!unformat_user (input, unformat_line_input, line_input))
189 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
191 if (!unformat (line_input, "%d", &log_level))
193 error = clib_error_return (0, "unknown input '%U'",
194 format_unformat_error, line_input);
197 if (log_level > NAT_LOG_DEBUG)
199 error = clib_error_return (0, "unknown logging level '%d'", log_level);
202 sm->log_level = log_level;
205 unformat_free (line_input);
210 static clib_error_t *
211 snat_ipfix_logging_enable_disable_command_fn (vlib_main_t * vm,
212 unformat_input_t * input,
213 vlib_cli_command_t * cmd)
215 unformat_input_t _line_input, *line_input = &_line_input;
216 clib_error_t *error = 0;
218 u32 domain_id = 0, src_port = 0;
219 u8 enable_set = 0, enable = 0;
221 if (!unformat_user (input, unformat_line_input, line_input))
222 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
224 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
226 if (unformat (line_input, "domain %d", &domain_id))
228 else if (unformat (line_input, "src-port %d", &src_port))
230 else if (!enable_set)
233 if (unformat (line_input, "disable"))
235 else if (unformat (line_input, "enable"))
240 error = clib_error_return (0, "unknown input '%U'",
241 format_unformat_error, line_input);
248 error = clib_error_return (0, "expected enable | disable");
252 if (nat_ipfix_logging_enable_disable (enable, domain_id, (u16) src_port))
254 error = clib_error_return (0, "ipfix logging enable failed");
259 unformat_free (line_input);
264 static clib_error_t *
265 nat44_show_hash_command_fn (vlib_main_t * vm, unformat_input_t * input,
266 vlib_cli_command_t * cmd)
268 snat_main_t *sm = &snat_main;
269 nat_affinity_main_t *nam = &nat_affinity_main;
273 if (unformat (input, "detail"))
275 else if (unformat (input, "verbose"))
278 vlib_cli_output (vm, "%U", format_bihash_16_8, &sm->flow_hash, verbose);
279 vec_foreach_index (i, sm->per_thread_data)
281 vlib_cli_output (vm, "-------- thread %d %s --------\n",
282 i, vlib_worker_threads[i].name);
283 vlib_cli_output (vm, "%U", format_bihash_16_8, &sm->flow_hash, verbose);
286 vlib_cli_output (vm, "%U", format_bihash_16_8, &nam->affinity_hash, verbose);
288 vlib_cli_output (vm, "-------- hash table parameters --------\n");
289 vlib_cli_output (vm, "translation buckets: %u", sm->translation_buckets);
293 static clib_error_t *
294 nat_set_mss_clamping_command_fn (vlib_main_t * vm, unformat_input_t * input,
295 vlib_cli_command_t * cmd)
297 unformat_input_t _line_input, *line_input = &_line_input;
298 snat_main_t *sm = &snat_main;
299 clib_error_t *error = 0;
302 /* Get a line of input. */
303 if (!unformat_user (input, unformat_line_input, line_input))
304 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
306 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
308 if (unformat (line_input, "disable"))
309 sm->mss_clamping = 0;
310 else if (unformat (line_input, "%d", &mss))
311 sm->mss_clamping = (u16) mss;
314 error = clib_error_return (0, "unknown input '%U'",
315 format_unformat_error, line_input);
321 unformat_free (line_input);
326 static clib_error_t *
327 nat_show_mss_clamping_command_fn (vlib_main_t * vm, unformat_input_t * input,
328 vlib_cli_command_t * cmd)
330 snat_main_t *sm = &snat_main;
332 if (sm->mss_clamping)
333 vlib_cli_output (vm, "mss-clamping %d", sm->mss_clamping);
335 vlib_cli_output (vm, "mss-clamping disabled");
340 static clib_error_t *
341 add_address_command_fn (vlib_main_t * vm,
342 unformat_input_t * input, vlib_cli_command_t * cmd)
344 unformat_input_t _line_input, *line_input = &_line_input;
345 ip4_address_t start_addr, end_addr, this_addr;
346 u32 start_host_order, end_host_order;
351 clib_error_t *error = 0;
354 /* Get a line of input. */
355 if (!unformat_user (input, unformat_line_input, line_input))
356 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
358 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
360 if (unformat (line_input, "%U - %U",
361 unformat_ip4_address, &start_addr,
362 unformat_ip4_address, &end_addr))
364 else if (unformat (line_input, "tenant-vrf %u", &vrf_id))
366 else if (unformat (line_input, "%U", unformat_ip4_address, &start_addr))
367 end_addr = start_addr;
368 else if (unformat (line_input, "twice-nat"))
370 else if (unformat (line_input, "del"))
374 error = clib_error_return (0, "unknown input '%U'",
375 format_unformat_error, line_input);
380 start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
381 end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
383 if (end_host_order < start_host_order)
385 error = clib_error_return (0, "end address less than start address");
389 count = (end_host_order - start_host_order) + 1;
392 nat_log_info ("%U - %U, %d addresses...",
393 format_ip4_address, &start_addr,
394 format_ip4_address, &end_addr, count);
396 this_addr = start_addr;
398 for (i = 0; i < count; i++)
402 rv = nat44_ed_add_address (&this_addr, vrf_id, twice_nat);
406 rv = nat44_ed_del_address (this_addr, twice_nat);
411 case VNET_API_ERROR_VALUE_EXIST:
412 error = clib_error_return (0, "NAT address already in use.");
414 case VNET_API_ERROR_NO_SUCH_ENTRY:
415 error = clib_error_return (0, "NAT address not exist.");
417 case VNET_API_ERROR_UNSPECIFIED:
419 clib_error_return (0, "NAT address used in static mapping.");
425 increment_v4_address (&this_addr);
429 unformat_free (line_input);
435 nat44_show_lru_summary (vlib_main_t * vm, snat_main_per_thread_data_t * tsm,
436 u64 now, u64 sess_timeout_time)
438 snat_main_t *sm = &snat_main;
439 dlist_elt_t *oldest_elt;
447 clib_dlist_remove_head (tsm->lru_pool, tsm->n##_lru_head_index); \
448 if (~0 != oldest_index) \
450 oldest_elt = pool_elt_at_index (tsm->lru_pool, oldest_index); \
451 s = pool_elt_at_index (tsm->sessions, oldest_elt->value); \
452 sess_timeout_time = \
453 s->last_heard + (f64) nat44_session_get_timeout (sm, s); \
454 vlib_cli_output (vm, d " LRU min session timeout %llu (now %llu)", \
455 sess_timeout_time, now); \
456 clib_dlist_addhead (tsm->lru_pool, tsm->n##_lru_head_index, \
459 _ (tcp_estab, "established tcp");
460 _ (tcp_trans, "transitory tcp");
462 _ (unk_proto, "unknown protocol");
468 static clib_error_t *
469 nat44_show_summary_command_fn (vlib_main_t * vm, unformat_input_t * input,
470 vlib_cli_command_t * cmd)
472 snat_main_per_thread_data_t *tsm;
473 snat_main_t *sm = &snat_main;
478 u64 now = vlib_time_now (vm);
479 u64 sess_timeout_time = 0;
481 u32 udp_sessions = 0;
482 u32 tcp_sessions = 0;
483 u32 icmp_sessions = 0;
484 u32 other_sessions = 0;
488 u32 transitory_wait_closed = 0;
489 u32 transitory_closed = 0;
494 for (fib = 0; fib < vec_len (sm->max_translations_per_fib); fib++)
495 vlib_cli_output (vm, "max translations per thread: %u fib %u",
496 sm->max_translations_per_fib[fib], fib);
498 if (sm->num_workers > 1)
500 vec_foreach (tsm, sm->per_thread_data)
502 pool_foreach (s, tsm->sessions)
504 sess_timeout_time = s->last_heard +
505 (f64) nat44_session_get_timeout (sm, s);
506 if (now >= sess_timeout_time)
511 case IP_PROTOCOL_ICMP:
514 case IP_PROTOCOL_TCP:
518 if (s->tcp_closed_timestamp)
520 if (now >= s->tcp_closed_timestamp)
526 ++transitory_wait_closed;
534 case IP_PROTOCOL_UDP:
542 nat44_show_lru_summary (vm, tsm, now, sess_timeout_time);
543 count += pool_elts (tsm->sessions);
548 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
549 pool_foreach (s, tsm->sessions)
551 sess_timeout_time = s->last_heard +
552 (f64) nat44_session_get_timeout (sm, s);
553 if (now >= sess_timeout_time)
558 case IP_PROTOCOL_ICMP:
561 case IP_PROTOCOL_TCP:
565 if (s->tcp_closed_timestamp)
567 if (now >= s->tcp_closed_timestamp)
573 ++transitory_wait_closed;
581 case IP_PROTOCOL_UDP:
589 nat44_show_lru_summary (vm, tsm, now, sess_timeout_time);
590 count = pool_elts (tsm->sessions);
593 vlib_cli_output (vm, "total timed out sessions: %u", timed_out);
594 vlib_cli_output (vm, "total sessions: %u", count);
595 vlib_cli_output (vm, "total tcp sessions: %u", tcp_sessions);
596 vlib_cli_output (vm, "total tcp established sessions: %u", established);
597 vlib_cli_output (vm, "total tcp transitory sessions: %u", transitory);
598 vlib_cli_output (vm, "total tcp transitory (WAIT-CLOSED) sessions: %u",
599 transitory_wait_closed);
600 vlib_cli_output (vm, "total tcp transitory (CLOSED) sessions: %u",
602 vlib_cli_output (vm, "total udp sessions: %u", udp_sessions);
603 vlib_cli_output (vm, "total icmp sessions: %u", icmp_sessions);
604 vlib_cli_output (vm, "total other sessions: %u", other_sessions);
608 static clib_error_t *
609 nat44_show_addresses_command_fn (vlib_main_t * vm, unformat_input_t * input,
610 vlib_cli_command_t * cmd)
612 snat_main_t *sm = &snat_main;
615 vlib_cli_output (vm, "NAT44 pool addresses:");
616 vec_foreach (ap, sm->addresses)
618 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
619 if (ap->fib_index != ~0)
621 vm, " tenant VRF: %u",
622 fib_table_get (ap->fib_index, FIB_PROTOCOL_IP4)->ft_table_id);
624 vlib_cli_output (vm, " tenant VRF independent");
626 if (ap->addr_len != ~0)
627 vlib_cli_output (vm, " synced with interface address");
629 vlib_cli_output (vm, "NAT44 twice-nat pool addresses:");
630 vec_foreach (ap, sm->twice_nat_addresses)
632 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
633 if (ap->fib_index != ~0)
634 vlib_cli_output (vm, " tenant VRF: %u",
635 fib_table_get(ap->fib_index, FIB_PROTOCOL_IP4)->ft_table_id);
637 vlib_cli_output (vm, " tenant VRF independent");
639 if (ap->addr_len != ~0)
640 vlib_cli_output (vm, " synced with interface address");
645 static clib_error_t *
646 snat_feature_command_fn (vlib_main_t * vm,
647 unformat_input_t * input, vlib_cli_command_t * cmd)
649 unformat_input_t _line_input, *line_input = &_line_input;
650 vnet_main_t *vnm = vnet_get_main ();
651 clib_error_t *error = 0;
653 u32 *inside_sw_if_indices = 0;
654 u32 *outside_sw_if_indices = 0;
655 u8 is_output_feature = 0;
656 int i, rv, is_del = 0;
660 /* Get a line of input. */
661 if (!unformat_user (input, unformat_line_input, line_input))
662 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
664 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
666 if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
668 vec_add1 (inside_sw_if_indices, sw_if_index);
669 else if (unformat (line_input, "out %U", unformat_vnet_sw_interface,
671 vec_add1 (outside_sw_if_indices, sw_if_index);
672 else if (unformat (line_input, "output-feature"))
673 is_output_feature = 1;
674 else if (unformat (line_input, "del"))
678 error = clib_error_return (0, "unknown input '%U'",
679 format_unformat_error, line_input);
684 if (vec_len (inside_sw_if_indices))
686 for (i = 0; i < vec_len (inside_sw_if_indices); i++)
688 sw_if_index = inside_sw_if_indices[i];
689 if (is_output_feature)
693 rv = nat44_ed_del_output_interface (sw_if_index);
697 rv = nat44_ed_add_output_interface (sw_if_index);
701 error = clib_error_return (0, "%s %U failed",
702 is_del ? "del" : "add",
703 format_vnet_sw_if_index_name,
712 rv = nat44_ed_del_interface (sw_if_index, 1);
716 rv = nat44_ed_add_interface (sw_if_index, 1);
720 error = clib_error_return (0, "%s %U failed",
721 is_del ? "del" : "add",
722 format_vnet_sw_if_index_name,
730 if (vec_len (outside_sw_if_indices))
732 for (i = 0; i < vec_len (outside_sw_if_indices); i++)
734 sw_if_index = outside_sw_if_indices[i];
735 if (is_output_feature)
739 rv = nat44_ed_del_output_interface (sw_if_index);
743 rv = nat44_ed_add_output_interface (sw_if_index);
747 error = clib_error_return (0, "%s %U failed",
748 is_del ? "del" : "add",
749 format_vnet_sw_if_index_name,
758 rv = nat44_ed_del_interface (sw_if_index, 0);
762 rv = nat44_ed_add_interface (sw_if_index, 0);
766 error = clib_error_return (0, "%s %U failed",
767 is_del ? "del" : "add",
768 format_vnet_sw_if_index_name,
777 unformat_free (line_input);
778 vec_free (inside_sw_if_indices);
779 vec_free (outside_sw_if_indices);
784 static clib_error_t *
785 nat44_show_interfaces_command_fn (vlib_main_t * vm, unformat_input_t * input,
786 vlib_cli_command_t * cmd)
788 snat_main_t *sm = &snat_main;
790 vnet_main_t *vnm = vnet_get_main ();
792 vlib_cli_output (vm, "NAT44 interfaces:");
793 pool_foreach (i, sm->interfaces)
795 vlib_cli_output (vm, " %U %s", format_vnet_sw_if_index_name, vnm,
797 (nat44_ed_is_interface_inside (i) &&
798 nat44_ed_is_interface_outside (i)) ?
800 (nat44_ed_is_interface_inside (i) ? "in" : "out"));
803 pool_foreach (i, sm->output_feature_interfaces)
805 vlib_cli_output (vm, " %U output-feature %s",
806 format_vnet_sw_if_index_name, vnm, i->sw_if_index,
807 (nat44_ed_is_interface_inside (i) &&
808 nat44_ed_is_interface_outside (i)) ?
810 (nat44_ed_is_interface_inside (i) ? "in" : "out"));
816 static clib_error_t *
817 add_static_mapping_command_fn (vlib_main_t * vm,
818 unformat_input_t * input,
819 vlib_cli_command_t * cmd)
821 unformat_input_t _line_input, *line_input = &_line_input;
822 vnet_main_t *vnm = vnet_get_main ();
823 clib_error_t *error = 0;
824 ip4_address_t l_addr, e_addr, pool_addr;
825 u32 l_port = 0, e_port = 0, vrf_id = ~0;
826 u8 l_port_set = 0, e_port_set = 0;
829 u32 sw_if_index = ~0;
830 ip_protocol_t proto = 0;
832 if (!unformat_user (input, unformat_line_input, line_input))
833 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
835 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
837 if (unformat (line_input, "local %U %u", unformat_ip4_address, &l_addr,
843 if (unformat (line_input, "local %U", unformat_ip4_address, &l_addr))
845 else if (unformat (line_input, "external %U %u", unformat_ip4_address,
850 else if (unformat (line_input, "external %U", unformat_ip4_address,
853 else if (unformat (line_input, "external %U %u",
854 unformat_vnet_sw_interface, vnm, &sw_if_index,
857 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
860 else if (unformat (line_input, "external %U",
861 unformat_vnet_sw_interface, vnm, &sw_if_index))
863 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
865 else if (unformat (line_input, "exact %U", unformat_ip4_address,
868 flags |= NAT_SM_FLAG_EXACT_ADDRESS;
870 else if (unformat (line_input, "vrf %u", &vrf_id))
872 else if (unformat (line_input, "%U", unformat_ip_protocol, &proto))
874 else if (unformat (line_input, "self-twice-nat"))
876 flags |= NAT_SM_FLAG_SELF_TWICE_NAT;
878 else if (unformat (line_input, "twice-nat"))
880 flags |= NAT_SM_FLAG_TWICE_NAT;
882 else if (unformat (line_input, "out2in-only"))
884 flags |= NAT_SM_FLAG_OUT2IN_ONLY;
886 else if (unformat (line_input, "del"))
892 error = clib_error_return (0, "unknown input: '%U'",
893 format_unformat_error, line_input);
898 if (l_port_set != e_port_set)
900 error = clib_error_return (0, "Either both ports are set or none.");
906 flags |= NAT_SM_FLAG_ADDR_ONLY;
910 l_port = clib_host_to_net_u16 (l_port);
911 e_port = clib_host_to_net_u16 (e_port);
914 // TODO: specific pool_addr for both pool & twice nat pool ?
919 nat44_ed_add_static_mapping (l_addr, e_addr, l_port, e_port, proto,
920 vrf_id, sw_if_index, flags, pool_addr, 0);
924 rv = nat44_ed_del_static_mapping (l_addr, e_addr, l_port, e_port, proto,
925 vrf_id, sw_if_index, flags);
932 case VNET_API_ERROR_INVALID_VALUE:
933 error = clib_error_return (0, "External port already in use.");
935 case VNET_API_ERROR_NO_SUCH_ENTRY:
937 error = clib_error_return (0, "External address must be allocated.");
939 error = clib_error_return (0, "Mapping not exist.");
941 case VNET_API_ERROR_NO_SUCH_FIB:
942 error = clib_error_return (0, "No such VRF id.");
944 case VNET_API_ERROR_VALUE_EXIST:
945 error = clib_error_return (0, "Mapping already exist.");
952 unformat_free (line_input);
957 // TODO: either delete this bullshit or update it
958 static clib_error_t *
959 add_identity_mapping_command_fn (vlib_main_t * vm,
960 unformat_input_t * input,
961 vlib_cli_command_t * cmd)
963 unformat_input_t _line_input, *line_input = &_line_input;
964 vnet_main_t *vnm = vnet_get_main ();
965 clib_error_t *error = 0;
967 int rv, is_add = 1, port_set = 0;
968 u32 sw_if_index, port, flags, vrf_id = ~0;
969 ip_protocol_t proto = 0;
972 flags = NAT_SM_FLAG_IDENTITY_NAT;
974 /* Get a line of input. */
975 if (!unformat_user (input, unformat_line_input, line_input))
976 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
978 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
980 if (unformat (line_input, "%U", unformat_ip4_address, &addr))
982 else if (unformat (line_input, "external %U",
983 unformat_vnet_sw_interface, vnm, &sw_if_index))
985 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
987 else if (unformat (line_input, "vrf %u", &vrf_id))
989 else if (unformat (line_input, "%U %u", unformat_ip_protocol, &proto,
994 else if (unformat (line_input, "del"))
1000 error = clib_error_return (0, "unknown input: '%U'",
1001 format_unformat_error, line_input);
1008 flags |= NAT_SM_FLAG_ADDR_ONLY;
1012 port = clib_host_to_net_u16 (port);
1018 rv = nat44_ed_add_static_mapping (addr, addr, port, port, proto, vrf_id,
1019 sw_if_index, flags, addr, 0);
1023 rv = nat44_ed_del_static_mapping (addr, addr, port, port, proto, vrf_id,
1024 sw_if_index, flags);
1027 // TODO: fix returns
1031 case VNET_API_ERROR_INVALID_VALUE:
1032 error = clib_error_return (0, "External port already in use.");
1034 case VNET_API_ERROR_NO_SUCH_ENTRY:
1036 error = clib_error_return (0, "External address must be allocated.");
1038 error = clib_error_return (0, "Mapping not exist.");
1040 case VNET_API_ERROR_NO_SUCH_FIB:
1041 error = clib_error_return (0, "No such VRF id.");
1043 case VNET_API_ERROR_VALUE_EXIST:
1044 error = clib_error_return (0, "Mapping already exist.");
1051 unformat_free (line_input);
1056 static clib_error_t *
1057 add_lb_static_mapping_command_fn (vlib_main_t * vm,
1058 unformat_input_t * input,
1059 vlib_cli_command_t * cmd)
1061 unformat_input_t _line_input, *line_input = &_line_input;
1062 clib_error_t *error = 0;
1063 ip4_address_t l_addr, e_addr;
1064 u32 l_port = 0, e_port = 0, vrf_id = 0, probability = 0, affinity = 0;
1066 ip_protocol_t proto;
1067 nat44_lb_addr_port_t *locals = 0, local;
1071 /* Get a line of input. */
1072 if (!unformat_user (input, unformat_line_input, line_input))
1073 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1075 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1077 if (unformat (line_input, "local %U:%u probability %u",
1078 unformat_ip4_address, &l_addr, &l_port, &probability))
1080 clib_memset (&local, 0, sizeof (local));
1081 local.addr = l_addr;
1082 local.port = (u16) l_port;
1083 local.probability = (u8) probability;
1084 vec_add1 (locals, local);
1086 else if (unformat (line_input, "local %U:%u vrf %u probability %u",
1087 unformat_ip4_address, &l_addr, &l_port, &vrf_id,
1090 clib_memset (&local, 0, sizeof (local));
1091 local.addr = l_addr;
1092 local.port = (u16) l_port;
1093 local.probability = (u8) probability;
1094 local.vrf_id = vrf_id;
1095 vec_add1 (locals, local);
1097 else if (unformat (line_input, "external %U:%u", unformat_ip4_address,
1100 else if (unformat (line_input, "protocol %U", unformat_ip_protocol,
1105 else if (unformat (line_input, "twice-nat"))
1107 flags |= NAT_SM_FLAG_TWICE_NAT;
1109 else if (unformat (line_input, "self-twice-nat"))
1111 flags |= NAT_SM_FLAG_SELF_TWICE_NAT;
1113 else if (unformat (line_input, "out2in-only"))
1115 flags |= NAT_SM_FLAG_OUT2IN_ONLY;
1117 else if (unformat (line_input, "del"))
1121 else if (unformat (line_input, "affinity %u", &affinity))
1125 error = clib_error_return (0, "unknown input: '%U'",
1126 format_unformat_error, line_input);
1131 if (vec_len (locals) < 2)
1133 error = clib_error_return (0, "at least two local must be set");
1139 error = clib_error_return (0, "missing protocol");
1145 rv = nat44_ed_add_lb_static_mapping (e_addr, (u16) e_port, proto, locals,
1146 flags, 0, affinity);
1150 rv = nat44_ed_del_lb_static_mapping (e_addr, (u16) e_port, proto, flags);
1155 case VNET_API_ERROR_INVALID_VALUE:
1156 error = clib_error_return (0, "External port already in use.");
1158 case VNET_API_ERROR_NO_SUCH_ENTRY:
1160 error = clib_error_return (0, "External address must be allocated.");
1162 error = clib_error_return (0, "Mapping not exist.");
1164 case VNET_API_ERROR_VALUE_EXIST:
1165 error = clib_error_return (0, "Mapping already exist.");
1172 unformat_free (line_input);
1178 static clib_error_t *
1179 add_lb_backend_command_fn (vlib_main_t * vm,
1180 unformat_input_t * input, vlib_cli_command_t * cmd)
1182 unformat_input_t _line_input, *line_input = &_line_input;
1183 clib_error_t *error = 0;
1184 ip4_address_t l_addr, e_addr;
1185 u32 l_port = 0, e_port = 0, vrf_id = 0, probability = 0;
1188 ip_protocol_t proto;
1191 /* Get a line of input. */
1192 if (!unformat_user (input, unformat_line_input, line_input))
1193 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1195 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1197 if (unformat (line_input, "local %U:%u probability %u",
1198 unformat_ip4_address, &l_addr, &l_port, &probability))
1200 else if (unformat (line_input, "local %U:%u vrf %u probability %u",
1201 unformat_ip4_address, &l_addr, &l_port, &vrf_id,
1204 else if (unformat (line_input, "external %U:%u", unformat_ip4_address,
1207 else if (unformat (line_input, "protocol %U", unformat_ip_protocol,
1210 else if (unformat (line_input, "del"))
1214 error = clib_error_return (0, "unknown input: '%U'",
1215 format_unformat_error, line_input);
1220 if (!l_port || !e_port)
1222 error = clib_error_return (0, "local or external must be set");
1228 error = clib_error_return (0, "missing protocol");
1232 rv = nat44_ed_add_del_lb_static_mapping_local (
1233 e_addr, (u16) e_port, l_addr, l_port, proto, vrf_id, probability, is_add);
1237 case VNET_API_ERROR_INVALID_VALUE:
1238 error = clib_error_return (0, "External is not load-balancing static "
1241 case VNET_API_ERROR_NO_SUCH_ENTRY:
1242 error = clib_error_return (0, "Mapping or back-end not exist.");
1244 case VNET_API_ERROR_VALUE_EXIST:
1245 error = clib_error_return (0, "Back-end already exist.");
1247 case VNET_API_ERROR_UNSPECIFIED:
1248 error = clib_error_return (0, "At least two back-ends must remain");
1255 unformat_free (line_input);
1260 static clib_error_t *
1261 nat44_show_static_mappings_command_fn (vlib_main_t * vm,
1262 unformat_input_t * input,
1263 vlib_cli_command_t * cmd)
1265 snat_main_t *sm = &snat_main;
1266 snat_static_mapping_t *m;
1267 snat_static_mapping_resolve_t *rp;
1269 vlib_cli_output (vm, "NAT44 static mappings:");
1270 pool_foreach (m, sm->static_mappings)
1272 vlib_cli_output (vm, " %U", format_snat_static_mapping, m);
1274 vec_foreach (rp, sm->sm_to_resolve)
1275 vlib_cli_output (vm, " %U", format_snat_static_map_to_resolve, rp);
1280 static clib_error_t *
1281 snat_add_interface_address_command_fn (vlib_main_t * vm,
1282 unformat_input_t * input,
1283 vlib_cli_command_t * cmd)
1285 unformat_input_t _line_input, *line_input = &_line_input;
1286 snat_main_t *sm = &snat_main;
1287 clib_error_t *error = 0;
1292 if (!unformat_user (input, unformat_line_input, line_input))
1293 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1295 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1297 if (unformat (line_input, "%U", unformat_vnet_sw_interface,
1298 sm->vnet_main, &sw_if_index))
1300 else if (unformat (line_input, "twice-nat"))
1304 else if (unformat (line_input, "del"))
1310 error = clib_error_return (0, "unknown input '%U'",
1311 format_unformat_error, line_input);
1318 rv = nat44_ed_add_interface_address (sw_if_index, twice_nat);
1321 error = clib_error_return (0, "add address returned %d", rv);
1326 rv = nat44_ed_del_interface_address (sw_if_index, twice_nat);
1329 error = clib_error_return (0, "del address returned %d", rv);
1334 unformat_free (line_input);
1339 static clib_error_t *
1340 nat44_show_interface_address_command_fn (vlib_main_t * vm,
1341 unformat_input_t * input,
1342 vlib_cli_command_t * cmd)
1344 snat_main_t *sm = &snat_main;
1345 vnet_main_t *vnm = vnet_get_main ();
1346 snat_address_resolve_t *ap;
1348 vlib_cli_output (vm, "NAT44 pool address interfaces:");
1349 vec_foreach (ap, sm->addr_to_resolve)
1351 vlib_cli_output (vm, " %U%s", format_vnet_sw_if_index_name, vnm,
1352 ap->sw_if_index, ap->is_twice_nat ? " twice-nat" : "");
1357 static clib_error_t *
1358 nat44_show_sessions_command_fn (vlib_main_t * vm, unformat_input_t * input,
1359 vlib_cli_command_t * cmd)
1361 unformat_input_t _line_input, *line_input = &_line_input;
1362 clib_error_t *error = 0;
1363 snat_main_per_thread_data_t *tsm;
1364 snat_main_t *sm = &snat_main;
1365 ip4_address_t i2o_sa, i2o_da, o2i_sa, o2i_da;
1366 u8 filter_i2o_sa = 0, filter_i2o_da = 0;
1367 u8 filter_o2i_sa = 0, filter_o2i_da = 0;
1368 u16 i2o_sp, i2o_dp, o2i_sp, o2i_dp;
1369 u8 filter_i2o_sp = 0, filter_i2o_dp = 0;
1370 u8 filter_o2i_sp = 0, filter_o2i_dp = 0;
1371 ip_protocol_t proto;
1372 u8 filter_proto = 0;
1373 u8 had_input = 1, filtering = 0;
1374 int i = 0, showed_sessions;
1376 if (!unformat_user (input, unformat_line_input, line_input))
1382 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1384 if (unformat (line_input, "filter i2o saddr %U", unformat_ip4_address,
1386 filter_i2o_sa = filtering = 1;
1387 else if (unformat (line_input, "filter i2o daddr %U",
1388 unformat_ip4_address, &i2o_da))
1389 filter_i2o_da = filtering = 1;
1390 else if (unformat (line_input, "filter o2i saddr %U",
1391 unformat_ip4_address, &o2i_sa))
1392 filter_o2i_sa = filtering = 1;
1393 else if (unformat (line_input, "filter o2i daddr %U",
1394 unformat_ip4_address, &o2i_da))
1395 filter_o2i_da = filtering = 1;
1396 else if (unformat (line_input, "filter i2o sport %u", &i2o_sp))
1397 filter_i2o_sp = filtering = 1;
1398 else if (unformat (line_input, "filter i2o dport %u", &i2o_dp))
1399 filter_i2o_dp = filtering = 1;
1400 else if (unformat (line_input, "filter o2i sport %u", &o2i_sp))
1401 filter_o2i_sp = filtering = 1;
1402 else if (unformat (line_input, "filter o2i dport %u", &o2i_dp))
1403 filter_o2i_dp = filtering = 1;
1404 else if (unformat (line_input, "filter i2o proto %U",
1405 unformat_ip_protocol, &proto))
1406 filter_proto = filtering = 1;
1407 else if (unformat (line_input, "filter o2i proto %U",
1408 unformat_ip_protocol, &proto))
1409 filter_proto = filtering = 1;
1412 error = clib_error_return (0, "unknown input '%U'",
1413 format_unformat_error, line_input);
1419 vlib_cli_output (vm, "NAT44 ED sessions:");
1421 vec_foreach_index (i, sm->per_thread_data)
1423 tsm = vec_elt_at_index (sm->per_thread_data, i);
1425 vlib_cli_output (vm, "-------- thread %d %s: %d sessions --------\n",
1426 i, vlib_worker_threads[i].name,
1427 pool_elts (tsm->sessions));
1429 showed_sessions = 0;
1431 pool_foreach (s, tsm->sessions)
1435 if (filter_i2o_sa && i2o_sa.as_u32 != s->i2o.match.saddr.as_u32)
1437 if (filter_i2o_da && i2o_da.as_u32 != s->i2o.match.daddr.as_u32)
1439 if (filter_o2i_sa && o2i_sa.as_u32 != s->o2i.match.saddr.as_u32)
1441 if (filter_o2i_da && o2i_da.as_u32 != s->o2i.match.daddr.as_u32)
1443 if (filter_i2o_sp &&
1444 i2o_sp != clib_net_to_host_u16 (s->i2o.match.sport))
1446 if (filter_i2o_dp &&
1447 i2o_dp != clib_net_to_host_u16 (s->i2o.match.dport))
1449 if (filter_o2i_sp &&
1450 o2i_sp != clib_net_to_host_u16 (s->o2i.match.sport))
1452 if (filter_o2i_dp &&
1453 o2i_dp != clib_net_to_host_u16 (s->o2i.match.dport))
1455 if (filter_proto && proto != s->proto)
1459 vlib_cli_output (vm, " %U\n", format_snat_session, tsm, s);
1463 vlib_cli_output (vm,
1464 "Showed: %d, Filtered: %d of total %d "
1465 "sessions of thread %d\n\n",
1467 pool_elts (tsm->sessions) - showed_sessions,
1468 pool_elts (tsm->sessions), i);
1474 unformat_free (line_input);
1478 static clib_error_t *
1479 nat44_set_session_limit_command_fn (vlib_main_t * vm,
1480 unformat_input_t * input,
1481 vlib_cli_command_t * cmd)
1483 unformat_input_t _line_input, *line_input = &_line_input;
1484 clib_error_t *error = 0;
1486 u32 session_limit = 0, vrf_id = 0;
1488 if (!unformat_user (input, unformat_line_input, line_input))
1489 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1491 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1493 if (unformat (line_input, "%u", &session_limit))
1495 else if (unformat (line_input, "vrf %u", &vrf_id))
1499 error = clib_error_return (0, "unknown input '%U'",
1500 format_unformat_error, line_input);
1506 error = clib_error_return (0, "missing value of session limit");
1507 else if (nat44_update_session_limit (session_limit, vrf_id))
1508 error = clib_error_return (0, "nat44_set_session_limit failed");
1511 unformat_free (line_input);
1516 static clib_error_t *
1517 nat44_del_session_command_fn (vlib_main_t * vm,
1518 unformat_input_t * input,
1519 vlib_cli_command_t * cmd)
1521 snat_main_t *sm = &snat_main;
1522 unformat_input_t _line_input, *line_input = &_line_input;
1523 u32 port = 0, eh_port = 0, vrf_id = sm->outside_vrf_id;
1524 clib_error_t *error = 0;
1525 ip4_address_t addr, eh_addr;
1526 ip_protocol_t proto;
1530 if (!unformat_user (input, unformat_line_input, line_input))
1531 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1533 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1535 if (unformat (line_input, "%U:%u %U", unformat_ip4_address, &addr, &port,
1536 unformat_ip_protocol, &proto))
1538 else if (unformat (line_input, "in"))
1541 vrf_id = sm->inside_vrf_id;
1543 else if (unformat (line_input, "out"))
1546 vrf_id = sm->outside_vrf_id;
1548 else if (unformat (line_input, "vrf %u", &vrf_id))
1550 else if (unformat (line_input, "external-host %U:%u",
1551 unformat_ip4_address, &eh_addr, &eh_port))
1555 error = clib_error_return (0, "unknown input '%U'",
1556 format_unformat_error, line_input);
1561 rv = nat44_ed_del_session (sm, &addr, clib_host_to_net_u16 (port), &eh_addr,
1562 clib_host_to_net_u16 (eh_port), proto, vrf_id,
1571 error = clib_error_return (0, "nat44_del_session returned %d", rv);
1576 unformat_free (line_input);
1581 static clib_error_t *
1582 snat_forwarding_set_command_fn (vlib_main_t * vm,
1583 unformat_input_t * input,
1584 vlib_cli_command_t * cmd)
1586 snat_main_t *sm = &snat_main;
1587 unformat_input_t _line_input, *line_input = &_line_input;
1588 clib_error_t *error = 0;
1590 u8 enable_set = 0, enable = 0;
1592 if (!unformat_user (input, unformat_line_input, line_input))
1593 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1595 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1600 if (unformat (line_input, "disable"))
1602 else if (unformat (line_input, "enable"))
1607 error = clib_error_return (0, "unknown input '%U'",
1608 format_unformat_error, line_input);
1614 error = clib_error_return (0, "expected enable | disable");
1616 sm->forwarding_enabled = enable;
1619 unformat_free (line_input);
1623 static clib_error_t *
1624 set_timeout_command_fn (vlib_main_t * vm,
1625 unformat_input_t * input, vlib_cli_command_t * cmd)
1627 snat_main_t *sm = &snat_main;
1628 unformat_input_t _line_input, *line_input = &_line_input;
1629 clib_error_t *error = 0;
1631 if (!unformat_user (input, unformat_line_input, line_input))
1632 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1634 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1636 if (unformat (line_input, "udp %u", &sm->timeouts.udp));
1637 else if (unformat (line_input, "tcp-established %u",
1638 &sm->timeouts.tcp.established));
1639 else if (unformat (line_input, "tcp-transitory %u",
1640 &sm->timeouts.tcp.transitory));
1641 else if (unformat (line_input, "icmp %u", &sm->timeouts.icmp));
1642 else if (unformat (line_input, "reset"))
1643 nat_reset_timeouts (&sm->timeouts);
1646 error = clib_error_return (0, "unknown input '%U'",
1647 format_unformat_error, line_input);
1652 unformat_free (line_input);
1656 static clib_error_t *
1657 nat_show_timeouts_command_fn (vlib_main_t * vm,
1658 unformat_input_t * input,
1659 vlib_cli_command_t * cmd)
1661 snat_main_t *sm = &snat_main;
1663 vlib_cli_output (vm, "udp timeout: %dsec", sm->timeouts.udp);
1664 vlib_cli_output (vm, "tcp-established timeout: %dsec",
1665 sm->timeouts.tcp.established);
1666 vlib_cli_output (vm, "tcp-transitory timeout: %dsec",
1667 sm->timeouts.tcp.transitory);
1668 vlib_cli_output (vm, "icmp timeout: %dsec", sm->timeouts.icmp);
1673 static clib_error_t *
1674 set_frame_queue_nelts_command_fn (vlib_main_t *vm, unformat_input_t *input,
1675 vlib_cli_command_t *cmd)
1677 unformat_input_t _line_input, *line_input = &_line_input;
1678 clib_error_t *error = 0;
1679 u32 frame_queue_nelts = 0;
1681 if (!unformat_user (input, unformat_line_input, line_input))
1682 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1684 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1686 if (unformat (line_input, "%u", &frame_queue_nelts))
1690 error = clib_error_return (0, "unknown input '%U'",
1691 format_unformat_error, line_input);
1695 if (!frame_queue_nelts)
1697 error = clib_error_return (0, "frame_queue_nelts cannot be zero");
1700 if (nat44_ed_set_frame_queue_nelts (frame_queue_nelts) != 0)
1702 error = clib_error_return (0, "snat_set_frame_queue_nelts failed");
1706 unformat_free (line_input);
1712 * @cliexstart{nat44}
1713 * Enable nat44 plugin
1714 * To enable nat44-ed, use:
1716 * To disable nat44-ed, use:
1717 * vpp# nat44 disable
1718 * To set inside-vrf outside-vrf, use:
1719 * vpp# nat44 enable inside-vrf <id> outside-vrf <id>
1722 VLIB_CLI_COMMAND (nat44_ed_enable_disable_command, static) = {
1724 .short_help = "nat44 <enable [sessions <max-number>] [inside-vrf <vrf-id>] "
1725 "[outside-vrf <vrf-id>]>|disable",
1726 .function = nat44_ed_enable_disable_command_fn,
1731 * @cliexstart{set snat workers}
1732 * Set NAT workers if 2 or more workers available, use:
1733 * vpp# set snat workers 0-2,5
1736 VLIB_CLI_COMMAND (set_workers_command, static) = {
1737 .path = "set nat workers",
1738 .function = set_workers_command_fn,
1739 .short_help = "set nat workers <workers-list>",
1744 * @cliexstart{show nat workers}
1746 * vpp# show nat workers:
1752 VLIB_CLI_COMMAND (nat_show_workers_command, static) = {
1753 .path = "show nat workers",
1754 .short_help = "show nat workers",
1755 .function = nat_show_workers_command_fn,
1760 * @cliexstart{set nat timeout}
1761 * Set values of timeouts for NAT sessions (in seconds), use:
1762 * vpp# set nat timeout udp 120 tcp-established 7500 tcp-transitory 250 icmp 90
1763 * To reset default values use:
1764 * vpp# set nat timeout reset
1767 VLIB_CLI_COMMAND (set_timeout_command, static) = {
1768 .path = "set nat timeout",
1769 .function = set_timeout_command_fn,
1771 "set nat timeout [udp <sec> | tcp-established <sec> "
1772 "tcp-transitory <sec> | icmp <sec> | reset]",
1777 * @cliexstart{show nat timeouts}
1778 * Show values of timeouts for NAT sessions.
1779 * vpp# show nat timeouts
1780 * udp timeout: 300sec
1781 * tcp-established timeout: 7440sec
1782 * tcp-transitory timeout: 240sec
1783 * icmp timeout: 60sec
1786 VLIB_CLI_COMMAND (nat_show_timeouts_command, static) = {
1787 .path = "show nat timeouts",
1788 .short_help = "show nat timeouts",
1789 .function = nat_show_timeouts_command_fn,
1794 * @cliexstart{set nat frame-queue-nelts}
1795 * Set number of worker handoff frame queue elements.
1798 VLIB_CLI_COMMAND (set_frame_queue_nelts_command, static) = {
1799 .path = "set nat frame-queue-nelts",
1800 .function = set_frame_queue_nelts_command_fn,
1801 .short_help = "set nat frame-queue-nelts <number>",
1806 * @cliexstart{nat set logging level}
1807 * To set NAT logging level use:
1808 * Set nat logging level
1811 VLIB_CLI_COMMAND (snat_set_log_level_command, static) = {
1812 .path = "nat set logging level",
1813 .function = snat_set_log_level_command_fn,
1814 .short_help = "nat set logging level <level>",
1819 * @cliexstart{snat ipfix logging}
1820 * To enable NAT IPFIX logging use:
1821 * vpp# nat ipfix logging
1822 * To set IPFIX exporter use:
1823 * vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1
1826 VLIB_CLI_COMMAND (snat_ipfix_logging_enable_disable_command, static) = {
1827 .path = "nat ipfix logging",
1828 .function = snat_ipfix_logging_enable_disable_command_fn,
1829 .short_help = "nat ipfix logging disable|<enable [domain <domain-id>] "
1830 "[src-port <port>]>",
1835 * @cliexstart{nat mss-clamping}
1836 * Set TCP MSS rewriting configuration
1837 * To enable TCP MSS rewriting use:
1838 * vpp# nat mss-clamping 1452
1839 * To disbale TCP MSS rewriting use:
1840 * vpp# nat mss-clamping disable
1843 VLIB_CLI_COMMAND (nat_set_mss_clamping_command, static) = {
1844 .path = "nat mss-clamping",
1845 .short_help = "nat mss-clamping <mss-value>|disable",
1846 .function = nat_set_mss_clamping_command_fn,
1851 * @cliexstart{show nat mss-clamping}
1852 * Show TCP MSS rewriting configuration
1855 VLIB_CLI_COMMAND (nat_show_mss_clamping_command, static) = {
1856 .path = "show nat mss-clamping",
1857 .short_help = "show nat mss-clamping",
1858 .function = nat_show_mss_clamping_command_fn,
1863 * @cliexstart{show nat44 hash tables}
1864 * Show NAT44 hash tables
1867 VLIB_CLI_COMMAND (nat44_show_hash, static) = {
1868 .path = "show nat44 hash tables",
1869 .short_help = "show nat44 hash tables [detail|verbose]",
1870 .function = nat44_show_hash_command_fn,
1875 * @cliexstart{nat44 add address}
1876 * Add/delete NAT44 pool address.
1877 * To add NAT44 pool address use:
1878 * vpp# nat44 add address 172.16.1.3
1879 * vpp# nat44 add address 172.16.2.2 - 172.16.2.24
1880 * To add NAT44 pool address for specific tenant (identified by VRF id) use:
1881 * vpp# nat44 add address 172.16.1.3 tenant-vrf 10
1884 VLIB_CLI_COMMAND (add_address_command, static) = {
1885 .path = "nat44 add address",
1886 .short_help = "nat44 add address <ip4-range-start> [- <ip4-range-end>] "
1887 "[tenant-vrf <vrf-id>] [twice-nat] [del]",
1888 .function = add_address_command_fn,
1893 * @cliexstart{show nat44 summary}
1894 * Show NAT44 summary
1895 * vpp# show nat44 summary
1898 VLIB_CLI_COMMAND (nat44_show_summary_command, static) = {
1899 .path = "show nat44 summary",
1900 .short_help = "show nat44 summary",
1901 .function = nat44_show_summary_command_fn,
1906 * @cliexstart{show nat44 addresses}
1907 * Show NAT44 pool addresses.
1908 * vpp# show nat44 addresses
1909 * NAT44 pool addresses:
1911 * tenant VRF independent
1920 * NAT44 twice-nat pool addresses:
1922 * tenant VRF independent
1928 VLIB_CLI_COMMAND (nat44_show_addresses_command, static) = {
1929 .path = "show nat44 addresses",
1930 .short_help = "show nat44 addresses",
1931 .function = nat44_show_addresses_command_fn,
1936 * @cliexstart{set interface nat44}
1937 * Enable/disable NAT44 feature on the interface.
1938 * To enable NAT44 feature with local network interface use:
1939 * vpp# set interface nat44 in GigabitEthernet0/8/0
1940 * To enable NAT44 feature with external network interface use:
1941 * vpp# set interface nat44 out GigabitEthernet0/a/0
1944 VLIB_CLI_COMMAND (set_interface_snat_command, static) = {
1945 .path = "set interface nat44",
1946 .function = snat_feature_command_fn,
1947 .short_help = "set interface nat44 in <intfc> out <intfc> [output-feature] "
1953 * @cliexstart{show nat44 interfaces}
1954 * Show interfaces with NAT44 feature.
1955 * vpp# show nat44 interfaces
1957 * GigabitEthernet0/8/0 in
1958 * GigabitEthernet0/a/0 out
1961 VLIB_CLI_COMMAND (nat44_show_interfaces_command, static) = {
1962 .path = "show nat44 interfaces",
1963 .short_help = "show nat44 interfaces",
1964 .function = nat44_show_interfaces_command_fn,
1969 * @cliexstart{nat44 add static mapping}
1970 * Static mapping allows hosts on the external network to initiate connection
1971 * to to the local network host.
1972 * To create static mapping between local host address 10.0.0.3 port 6303 and
1973 * external address 4.4.4.4 port 3606 for TCP protocol use:
1974 * vpp# nat44 add static mapping tcp local 10.0.0.3 6303 external 4.4.4.4 3606
1975 * If not runnig "static mapping only" NAT plugin mode use before:
1976 * vpp# nat44 add address 4.4.4.4
1977 * To create address only static mapping between local and external address use:
1978 * vpp# nat44 add static mapping local 10.0.0.3 external 4.4.4.4
1979 * To create ICMP static mapping between local and external with ICMP echo
1980 * identifier 10 use:
1981 * vpp# nat44 add static mapping icmp local 10.0.0.3 10 external 4.4.4.4 10
1982 * To force use of specific pool address, vrf independent
1983 * vpp# nat44 add static mapping local 10.0.0.2 1234 external 10.0.2.2 1234 twice-nat exact 10.0.1.2
1986 VLIB_CLI_COMMAND (add_static_mapping_command, static) = {
1987 .path = "nat44 add static mapping",
1988 .function = add_static_mapping_command_fn,
1990 "nat44 add static mapping tcp|udp|icmp local <addr> [<port|icmp-echo-id>] "
1991 "external <addr> [<port|icmp-echo-id>] [vrf <table-id>] [twice-nat|self-twice-nat] "
1992 "[out2in-only] [exact <pool-addr>] [del]",
1997 * @cliexstart{nat44 add identity mapping}
1998 * Identity mapping translate an IP address to itself.
1999 * To create identity mapping for address 10.0.0.3 port 6303 for TCP protocol
2001 * vpp# nat44 add identity mapping 10.0.0.3 tcp 6303
2002 * To create identity mapping for address 10.0.0.3 use:
2003 * vpp# nat44 add identity mapping 10.0.0.3
2004 * To create identity mapping for DHCP addressed interface use:
2005 * vpp# nat44 add identity mapping external GigabitEthernet0/a/0 tcp 3606
2008 VLIB_CLI_COMMAND (add_identity_mapping_command, static) = {
2009 .path = "nat44 add identity mapping",
2010 .function = add_identity_mapping_command_fn,
2011 .short_help = "nat44 add identity mapping <ip4-addr>|external <interface> "
2012 "[<protocol> <port>] [vrf <table-id>] [del]",
2017 * @cliexstart{nat44 add load-balancing static mapping}
2018 * Service load balancing using NAT44
2019 * To add static mapping with load balancing for service with external IP
2020 * address 1.2.3.4 and TCP port 80 and mapped to 2 local servers
2021 * 10.100.10.10:8080 and 10.100.10.20:8080 with probability 80% resp. 20% use:
2022 * vpp# nat44 add load-balancing static mapping protocol tcp external 1.2.3.4:80 local 10.100.10.10:8080 probability 80 local 10.100.10.20:8080 probability 20
2025 VLIB_CLI_COMMAND (add_lb_static_mapping_command, static) = {
2026 .path = "nat44 add load-balancing static mapping",
2027 .function = add_lb_static_mapping_command_fn,
2029 "nat44 add load-balancing static mapping protocol tcp|udp "
2030 "external <addr>:<port> local <addr>:<port> [vrf <table-id>] "
2031 "probability <n> [twice-nat|self-twice-nat] [out2in-only] "
2032 "[affinity <timeout-seconds>] [del]",
2037 * @cliexstart{nat44 add load-balancing static mapping}
2038 * Modify service load balancing using NAT44
2039 * To add new back-end server 10.100.10.30:8080 for service load balancing
2040 * static mapping with external IP address 1.2.3.4 and TCP port 80 use:
2041 * vpp# nat44 add load-balancing back-end protocol tcp external 1.2.3.4:80 local 10.100.10.30:8080 probability 25
2044 VLIB_CLI_COMMAND (add_lb_backend_command, static) = {
2045 .path = "nat44 add load-balancing back-end",
2046 .function = add_lb_backend_command_fn,
2048 "nat44 add load-balancing back-end protocol tcp|udp "
2049 "external <addr>:<port> local <addr>:<port> [vrf <table-id>] "
2050 "probability <n> [del]",
2055 * @cliexstart{show nat44 static mappings}
2056 * Show NAT44 static mappings.
2057 * vpp# show nat44 static mappings
2058 * NAT44 static mappings:
2059 * local 10.0.0.3 external 4.4.4.4 vrf 0
2060 * tcp local 192.168.0.4:6303 external 4.4.4.3:3606 vrf 0
2061 * tcp vrf 0 external 1.2.3.4:80 out2in-only
2062 * local 10.100.10.10:8080 probability 80
2063 * local 10.100.10.20:8080 probability 20
2064 * tcp local 10.100.3.8:8080 external 169.10.10.1:80 vrf 0 twice-nat
2065 * tcp local 10.0.0.10:3603 external GigabitEthernet0/a/0:6306 vrf 10
2068 VLIB_CLI_COMMAND (nat44_show_static_mappings_command, static) = {
2069 .path = "show nat44 static mappings",
2070 .short_help = "show nat44 static mappings",
2071 .function = nat44_show_static_mappings_command_fn,
2076 * @cliexstart{nat44 add interface address}
2077 * Use NAT44 pool address from specific interfce
2078 * To add NAT44 pool address from specific interface use:
2079 * vpp# nat44 add interface address GigabitEthernet0/8/0
2082 VLIB_CLI_COMMAND (snat_add_interface_address_command, static) = {
2083 .path = "nat44 add interface address",
2084 .short_help = "nat44 add interface address <interface> [twice-nat] [del]",
2085 .function = snat_add_interface_address_command_fn,
2090 * @cliexstart{show nat44 interface address}
2091 * Show NAT44 pool address interfaces
2092 * vpp# show nat44 interface address
2093 * NAT44 pool address interfaces:
2094 * GigabitEthernet0/a/0
2095 * NAT44 twice-nat pool address interfaces:
2096 * GigabitEthernet0/8/0
2099 VLIB_CLI_COMMAND (nat44_show_interface_address_command, static) = {
2100 .path = "show nat44 interface address",
2101 .short_help = "show nat44 interface address",
2102 .function = nat44_show_interface_address_command_fn,
2107 * @cliexstart{show nat44 sessions}
2108 * Show NAT44 sessions.
2111 VLIB_CLI_COMMAND (nat44_show_sessions_command, static) = {
2112 .path = "show nat44 sessions",
2113 .short_help = "show nat44 sessions [filter {i2o | o2i} {saddr <ip4-addr> "
2114 "| sport <n> | daddr <ip4-addr> | dport <n> | proto <proto>} "
2115 "[filter .. [..]]]",
2116 .function = nat44_show_sessions_command_fn,
2121 * @cliexstart{set nat44 session limit}
2122 * Set NAT44 session limit.
2125 VLIB_CLI_COMMAND (nat44_set_session_limit_command, static) = {
2126 .path = "set nat44 session limit",
2127 .short_help = "set nat44 session limit <limit> [vrf <table-id>]",
2128 .function = nat44_set_session_limit_command_fn,
2133 * @cliexstart{nat44 del session}
2134 * To administratively delete NAT44 session by inside address and port use:
2135 * vpp# nat44 del session in 10.0.0.3:6303 tcp
2136 * To administratively delete NAT44 session by outside address and port use:
2137 * vpp# nat44 del session out 1.0.0.3:6033 udp
2140 VLIB_CLI_COMMAND (nat44_del_session_command, static) = {
2141 .path = "nat44 del session",
2142 .short_help = "nat44 del session in|out <addr>:<port> tcp|udp|icmp [vrf <id>] [external-host <addr>:<port>]",
2143 .function = nat44_del_session_command_fn,
2148 * @cliexstart{nat44 forwarding}
2149 * Enable or disable forwarding
2150 * Forward packets which don't match existing translation
2151 * or static mapping instead of dropping them.
2152 * To enable forwarding, use:
2153 * vpp# nat44 forwarding enable
2154 * To disable forwarding, use:
2155 * vpp# nat44 forwarding disable
2158 VLIB_CLI_COMMAND (snat_forwarding_set_command, static) = {
2159 .path = "nat44 forwarding",
2160 .short_help = "nat44 forwarding enable|disable",
2161 .function = snat_forwarding_set_command_fn,
2165 * fd.io coding-style-patch-verification: ON
2168 * eval: (c-set-style "gnu")