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;
485 } udp = { 0 }, tcp = { 0 }, tcp_established = { 0 }, tcp_transitory = { 0 },
486 icmp = { 0 }, other = { 0 };
490 for (fib = 0; fib < vec_len (sm->max_translations_per_fib); fib++)
491 vlib_cli_output (vm, "max translations per thread: %u fib %u",
492 sm->max_translations_per_fib[fib], fib);
494 if (sm->num_workers > 1)
496 vec_foreach (tsm, sm->per_thread_data)
498 pool_foreach (s, tsm->sessions)
501 s->last_heard + (f64) nat44_session_get_timeout (sm, s);
505 case IP_PROTOCOL_ICMP:
507 if (now >= sess_timeout_time)
510 case IP_PROTOCOL_TCP:
512 if (now >= sess_timeout_time)
514 if (nat44_ed_tcp_is_established (s->tcp_state))
516 ++tcp_established.total;
517 if (now >= sess_timeout_time)
518 ++tcp_established.timed_out;
522 ++tcp_transitory.total;
523 if (now >= sess_timeout_time)
524 ++tcp_transitory.timed_out;
527 case IP_PROTOCOL_UDP:
529 if (now >= sess_timeout_time)
534 if (now >= sess_timeout_time)
539 nat44_show_lru_summary (vm, tsm, now, sess_timeout_time);
540 count += pool_elts (tsm->sessions);
545 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
546 pool_foreach (s, tsm->sessions)
548 sess_timeout_time = s->last_heard +
549 (f64) nat44_session_get_timeout (sm, s);
553 case IP_PROTOCOL_ICMP:
555 if (now >= sess_timeout_time)
558 case IP_PROTOCOL_TCP:
560 if (now >= sess_timeout_time)
562 if (nat44_ed_tcp_is_established (s->tcp_state))
564 ++tcp_established.total;
565 if (now >= sess_timeout_time)
566 ++tcp_established.timed_out;
570 ++tcp_transitory.total;
571 if (now >= sess_timeout_time)
572 ++tcp_transitory.timed_out;
575 case IP_PROTOCOL_UDP:
577 if (now >= sess_timeout_time)
582 if (now >= sess_timeout_time)
587 nat44_show_lru_summary (vm, tsm, now, sess_timeout_time);
588 count = pool_elts (tsm->sessions);
592 tcp.timed_out + icmp.timed_out + udp.timed_out + other.timed_out;
593 vlib_cli_output (vm, "total sessions: %u (timed out: %u)", count, timed_out);
594 vlib_cli_output (vm, "tcp sessions:");
595 vlib_cli_output (vm, " total: %u (timed out: %u)", tcp.total,
597 vlib_cli_output (vm, " established: %u (timed out: %u)",
598 tcp_established.total, tcp_established.timed_out);
599 vlib_cli_output (vm, " transitory: %u (timed out: %u)",
600 tcp_transitory.total, tcp_transitory.timed_out);
601 vlib_cli_output (vm, "udp sessions:");
602 vlib_cli_output (vm, " total: %u (timed out: %u)", udp.total,
604 vlib_cli_output (vm, "icmp sessions:");
605 vlib_cli_output (vm, " total: %u (timed out: %u)", icmp.total,
607 vlib_cli_output (vm, "other sessions:");
608 vlib_cli_output (vm, " total: %u (timed out: %u)", other.total,
613 static clib_error_t *
614 nat44_show_addresses_command_fn (vlib_main_t * vm, unformat_input_t * input,
615 vlib_cli_command_t * cmd)
617 snat_main_t *sm = &snat_main;
620 vlib_cli_output (vm, "NAT44 pool addresses:");
621 vec_foreach (ap, sm->addresses)
623 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
624 if (ap->fib_index != ~0)
626 vm, " tenant VRF: %u",
627 fib_table_get (ap->fib_index, FIB_PROTOCOL_IP4)->ft_table_id);
629 vlib_cli_output (vm, " tenant VRF independent");
631 if (ap->addr_len != ~0)
632 vlib_cli_output (vm, " synced with interface address");
634 vlib_cli_output (vm, "NAT44 twice-nat pool addresses:");
635 vec_foreach (ap, sm->twice_nat_addresses)
637 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
638 if (ap->fib_index != ~0)
639 vlib_cli_output (vm, " tenant VRF: %u",
640 fib_table_get(ap->fib_index, FIB_PROTOCOL_IP4)->ft_table_id);
642 vlib_cli_output (vm, " tenant VRF independent");
644 if (ap->addr_len != ~0)
645 vlib_cli_output (vm, " synced with interface address");
650 static clib_error_t *
651 snat_feature_command_fn (vlib_main_t * vm,
652 unformat_input_t * input, vlib_cli_command_t * cmd)
654 unformat_input_t _line_input, *line_input = &_line_input;
655 vnet_main_t *vnm = vnet_get_main ();
656 clib_error_t *error = 0;
658 u32 *inside_sw_if_indices = 0;
659 u32 *outside_sw_if_indices = 0;
660 u8 is_output_feature = 0;
661 int i, rv, is_del = 0;
665 /* Get a line of input. */
666 if (!unformat_user (input, unformat_line_input, line_input))
667 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
669 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
671 if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
673 vec_add1 (inside_sw_if_indices, sw_if_index);
674 else if (unformat (line_input, "out %U", unformat_vnet_sw_interface,
676 vec_add1 (outside_sw_if_indices, sw_if_index);
677 else if (unformat (line_input, "output-feature"))
678 is_output_feature = 1;
679 else if (unformat (line_input, "del"))
683 error = clib_error_return (0, "unknown input '%U'",
684 format_unformat_error, line_input);
689 if (vec_len (inside_sw_if_indices))
691 for (i = 0; i < vec_len (inside_sw_if_indices); i++)
693 sw_if_index = inside_sw_if_indices[i];
694 if (is_output_feature)
698 rv = nat44_ed_del_output_interface (sw_if_index);
702 rv = nat44_ed_add_output_interface (sw_if_index);
706 error = clib_error_return (0, "%s %U failed",
707 is_del ? "del" : "add",
708 format_vnet_sw_if_index_name,
717 rv = nat44_ed_del_interface (sw_if_index, 1);
721 rv = nat44_ed_add_interface (sw_if_index, 1);
725 error = clib_error_return (0, "%s %U failed",
726 is_del ? "del" : "add",
727 format_vnet_sw_if_index_name,
735 if (vec_len (outside_sw_if_indices))
737 for (i = 0; i < vec_len (outside_sw_if_indices); i++)
739 sw_if_index = outside_sw_if_indices[i];
740 if (is_output_feature)
744 rv = nat44_ed_del_output_interface (sw_if_index);
748 rv = nat44_ed_add_output_interface (sw_if_index);
752 error = clib_error_return (0, "%s %U failed",
753 is_del ? "del" : "add",
754 format_vnet_sw_if_index_name,
763 rv = nat44_ed_del_interface (sw_if_index, 0);
767 rv = nat44_ed_add_interface (sw_if_index, 0);
771 error = clib_error_return (0, "%s %U failed",
772 is_del ? "del" : "add",
773 format_vnet_sw_if_index_name,
782 unformat_free (line_input);
783 vec_free (inside_sw_if_indices);
784 vec_free (outside_sw_if_indices);
789 static clib_error_t *
790 nat44_show_interfaces_command_fn (vlib_main_t * vm, unformat_input_t * input,
791 vlib_cli_command_t * cmd)
793 snat_main_t *sm = &snat_main;
795 vnet_main_t *vnm = vnet_get_main ();
797 vlib_cli_output (vm, "NAT44 interfaces:");
798 pool_foreach (i, sm->interfaces)
800 vlib_cli_output (vm, " %U %s", format_vnet_sw_if_index_name, vnm,
802 (nat44_ed_is_interface_inside (i) &&
803 nat44_ed_is_interface_outside (i)) ?
805 (nat44_ed_is_interface_inside (i) ? "in" : "out"));
808 pool_foreach (i, sm->output_feature_interfaces)
810 vlib_cli_output (vm, " %U output-feature %s",
811 format_vnet_sw_if_index_name, vnm, i->sw_if_index,
812 (nat44_ed_is_interface_inside (i) &&
813 nat44_ed_is_interface_outside (i)) ?
815 (nat44_ed_is_interface_inside (i) ? "in" : "out"));
821 static clib_error_t *
822 add_static_mapping_command_fn (vlib_main_t * vm,
823 unformat_input_t * input,
824 vlib_cli_command_t * cmd)
826 unformat_input_t _line_input, *line_input = &_line_input;
827 vnet_main_t *vnm = vnet_get_main ();
828 clib_error_t *error = 0;
829 ip4_address_t l_addr, e_addr, pool_addr;
830 u32 l_port = 0, e_port = 0, vrf_id = ~0;
831 u8 l_port_set = 0, e_port_set = 0;
834 u32 sw_if_index = ~0;
835 ip_protocol_t proto = 0;
837 if (!unformat_user (input, unformat_line_input, line_input))
838 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
840 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
842 if (unformat (line_input, "local %U %u", unformat_ip4_address, &l_addr,
848 if (unformat (line_input, "local %U", unformat_ip4_address, &l_addr))
850 else if (unformat (line_input, "external %U %u", unformat_ip4_address,
855 else if (unformat (line_input, "external %U", unformat_ip4_address,
858 else if (unformat (line_input, "external %U %u",
859 unformat_vnet_sw_interface, vnm, &sw_if_index,
862 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
865 else if (unformat (line_input, "external %U",
866 unformat_vnet_sw_interface, vnm, &sw_if_index))
868 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
870 else if (unformat (line_input, "exact %U", unformat_ip4_address,
873 flags |= NAT_SM_FLAG_EXACT_ADDRESS;
875 else if (unformat (line_input, "vrf %u", &vrf_id))
877 else if (unformat (line_input, "%U", unformat_ip_protocol, &proto))
879 else if (unformat (line_input, "self-twice-nat"))
881 flags |= NAT_SM_FLAG_SELF_TWICE_NAT;
883 else if (unformat (line_input, "twice-nat"))
885 flags |= NAT_SM_FLAG_TWICE_NAT;
887 else if (unformat (line_input, "out2in-only"))
889 flags |= NAT_SM_FLAG_OUT2IN_ONLY;
891 else if (unformat (line_input, "del"))
897 error = clib_error_return (0, "unknown input: '%U'",
898 format_unformat_error, line_input);
903 if (l_port_set != e_port_set)
905 error = clib_error_return (0, "Either both ports are set or none.");
911 flags |= NAT_SM_FLAG_ADDR_ONLY;
915 l_port = clib_host_to_net_u16 (l_port);
916 e_port = clib_host_to_net_u16 (e_port);
922 nat44_ed_add_static_mapping (l_addr, e_addr, l_port, e_port, proto,
923 vrf_id, sw_if_index, flags, pool_addr, 0);
927 rv = nat44_ed_del_static_mapping (l_addr, e_addr, l_port, e_port, proto,
928 vrf_id, sw_if_index, flags);
933 case VNET_API_ERROR_UNSUPPORTED:
934 error = clib_error_return (0, "Plugin disabled.");
936 case VNET_API_ERROR_NO_SUCH_ENTRY:
937 error = clib_error_return (0, "Mapping not exist.");
939 case VNET_API_ERROR_VALUE_EXIST:
940 error = clib_error_return (0, "Mapping already exist.");
947 unformat_free (line_input);
952 static clib_error_t *
953 add_identity_mapping_command_fn (vlib_main_t * vm,
954 unformat_input_t * input,
955 vlib_cli_command_t * cmd)
957 unformat_input_t _line_input, *line_input = &_line_input;
958 vnet_main_t *vnm = vnet_get_main ();
959 clib_error_t *error = 0;
961 int rv, is_add = 1, port_set = 0;
962 u32 sw_if_index, port, flags, vrf_id = ~0;
963 ip_protocol_t proto = 0;
966 flags = NAT_SM_FLAG_IDENTITY_NAT;
968 if (!unformat_user (input, unformat_line_input, line_input))
969 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
971 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
973 if (unformat (line_input, "%U", unformat_ip4_address, &addr))
975 else if (unformat (line_input, "external %U",
976 unformat_vnet_sw_interface, vnm, &sw_if_index))
978 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
980 else if (unformat (line_input, "vrf %u", &vrf_id))
982 else if (unformat (line_input, "%U %u", unformat_ip_protocol, &proto,
987 else if (unformat (line_input, "del"))
993 error = clib_error_return (0, "unknown input: '%U'",
994 format_unformat_error, line_input);
1001 flags |= NAT_SM_FLAG_ADDR_ONLY;
1005 port = clib_host_to_net_u16 (port);
1011 rv = nat44_ed_add_static_mapping (addr, addr, port, port, proto, vrf_id,
1012 sw_if_index, flags, addr, 0);
1016 rv = nat44_ed_del_static_mapping (addr, addr, port, port, proto, vrf_id,
1017 sw_if_index, flags);
1022 case VNET_API_ERROR_UNSUPPORTED:
1023 error = clib_error_return (0, "Plugin disabled.");
1025 case VNET_API_ERROR_NO_SUCH_ENTRY:
1026 error = clib_error_return (0, "Mapping not exist.");
1028 case VNET_API_ERROR_VALUE_EXIST:
1029 error = clib_error_return (0, "Mapping already exist.");
1036 unformat_free (line_input);
1041 static clib_error_t *
1042 add_lb_static_mapping_command_fn (vlib_main_t * vm,
1043 unformat_input_t * input,
1044 vlib_cli_command_t * cmd)
1046 unformat_input_t _line_input, *line_input = &_line_input;
1047 clib_error_t *error = 0;
1048 ip4_address_t l_addr, e_addr;
1049 u32 l_port = 0, e_port = 0, vrf_id = 0, probability = 0, affinity = 0;
1051 ip_protocol_t proto;
1052 nat44_lb_addr_port_t *locals = 0, local;
1056 if (!unformat_user (input, unformat_line_input, line_input))
1057 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1059 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1061 if (unformat (line_input, "local %U:%u probability %u",
1062 unformat_ip4_address, &l_addr, &l_port, &probability))
1064 clib_memset (&local, 0, sizeof (local));
1065 local.addr = l_addr;
1066 local.port = (u16) l_port;
1067 local.probability = (u8) probability;
1068 vec_add1 (locals, local);
1070 else if (unformat (line_input, "local %U:%u vrf %u probability %u",
1071 unformat_ip4_address, &l_addr, &l_port, &vrf_id,
1074 clib_memset (&local, 0, sizeof (local));
1075 local.addr = l_addr;
1076 local.port = (u16) l_port;
1077 local.probability = (u8) probability;
1078 local.vrf_id = vrf_id;
1079 vec_add1 (locals, local);
1081 else if (unformat (line_input, "external %U:%u", unformat_ip4_address,
1084 else if (unformat (line_input, "protocol %U", unformat_ip_protocol,
1089 else if (unformat (line_input, "twice-nat"))
1091 flags |= NAT_SM_FLAG_TWICE_NAT;
1093 else if (unformat (line_input, "self-twice-nat"))
1095 flags |= NAT_SM_FLAG_SELF_TWICE_NAT;
1097 else if (unformat (line_input, "out2in-only"))
1099 flags |= NAT_SM_FLAG_OUT2IN_ONLY;
1101 else if (unformat (line_input, "del"))
1105 else if (unformat (line_input, "affinity %u", &affinity))
1109 error = clib_error_return (0, "unknown input: '%U'",
1110 format_unformat_error, line_input);
1115 if (vec_len (locals) < 2)
1117 error = clib_error_return (0, "at least two local must be set");
1123 error = clib_error_return (0, "missing protocol");
1129 rv = nat44_ed_add_lb_static_mapping (e_addr, (u16) e_port, proto, locals,
1130 flags, 0, affinity);
1134 rv = nat44_ed_del_lb_static_mapping (e_addr, (u16) e_port, proto, flags);
1139 case VNET_API_ERROR_INVALID_VALUE:
1140 error = clib_error_return (0, "External port already in use.");
1142 case VNET_API_ERROR_NO_SUCH_ENTRY:
1144 error = clib_error_return (0, "External address must be allocated.");
1146 error = clib_error_return (0, "Mapping not exist.");
1148 case VNET_API_ERROR_VALUE_EXIST:
1149 error = clib_error_return (0, "Mapping already exist.");
1156 unformat_free (line_input);
1162 static clib_error_t *
1163 add_lb_backend_command_fn (vlib_main_t * vm,
1164 unformat_input_t * input, vlib_cli_command_t * cmd)
1166 unformat_input_t _line_input, *line_input = &_line_input;
1167 clib_error_t *error = 0;
1168 ip4_address_t l_addr, e_addr;
1169 u32 l_port = 0, e_port = 0, vrf_id = 0, probability = 0;
1172 ip_protocol_t proto;
1175 /* Get a line of input. */
1176 if (!unformat_user (input, unformat_line_input, line_input))
1177 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1179 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1181 if (unformat (line_input, "local %U:%u probability %u",
1182 unformat_ip4_address, &l_addr, &l_port, &probability))
1184 else if (unformat (line_input, "local %U:%u vrf %u probability %u",
1185 unformat_ip4_address, &l_addr, &l_port, &vrf_id,
1188 else if (unformat (line_input, "external %U:%u", unformat_ip4_address,
1191 else if (unformat (line_input, "protocol %U", unformat_ip_protocol,
1194 else if (unformat (line_input, "del"))
1198 error = clib_error_return (0, "unknown input: '%U'",
1199 format_unformat_error, line_input);
1204 if (!l_port || !e_port)
1206 error = clib_error_return (0, "local or external must be set");
1212 error = clib_error_return (0, "missing protocol");
1216 rv = nat44_ed_add_del_lb_static_mapping_local (
1217 e_addr, (u16) e_port, l_addr, l_port, proto, vrf_id, probability, is_add);
1221 case VNET_API_ERROR_INVALID_VALUE:
1222 error = clib_error_return (0, "External is not load-balancing static "
1225 case VNET_API_ERROR_NO_SUCH_ENTRY:
1226 error = clib_error_return (0, "Mapping or back-end not exist.");
1228 case VNET_API_ERROR_VALUE_EXIST:
1229 error = clib_error_return (0, "Back-end already exist.");
1231 case VNET_API_ERROR_UNSPECIFIED:
1232 error = clib_error_return (0, "At least two back-ends must remain");
1239 unformat_free (line_input);
1244 static clib_error_t *
1245 nat44_show_static_mappings_command_fn (vlib_main_t * vm,
1246 unformat_input_t * input,
1247 vlib_cli_command_t * cmd)
1249 snat_main_t *sm = &snat_main;
1250 snat_static_mapping_t *m;
1251 snat_static_mapping_resolve_t *rp;
1253 vlib_cli_output (vm, "NAT44 static mappings:");
1254 pool_foreach (m, sm->static_mappings)
1256 vlib_cli_output (vm, " %U", format_snat_static_mapping, m);
1258 vec_foreach (rp, sm->sm_to_resolve)
1259 vlib_cli_output (vm, " %U", format_snat_static_map_to_resolve, rp);
1264 static clib_error_t *
1265 snat_add_interface_address_command_fn (vlib_main_t * vm,
1266 unformat_input_t * input,
1267 vlib_cli_command_t * cmd)
1269 unformat_input_t _line_input, *line_input = &_line_input;
1270 snat_main_t *sm = &snat_main;
1271 clib_error_t *error = 0;
1276 if (!unformat_user (input, unformat_line_input, line_input))
1277 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1279 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1281 if (unformat (line_input, "%U", unformat_vnet_sw_interface,
1282 sm->vnet_main, &sw_if_index))
1284 else if (unformat (line_input, "twice-nat"))
1288 else if (unformat (line_input, "del"))
1294 error = clib_error_return (0, "unknown input '%U'",
1295 format_unformat_error, line_input);
1302 rv = nat44_ed_add_interface_address (sw_if_index, twice_nat);
1305 error = clib_error_return (0, "add address returned %d", rv);
1310 rv = nat44_ed_del_interface_address (sw_if_index, twice_nat);
1313 error = clib_error_return (0, "del address returned %d", rv);
1318 unformat_free (line_input);
1323 static clib_error_t *
1324 nat44_ed_add_del_vrf_table_command_fn (vlib_main_t *vm,
1325 unformat_input_t *input,
1326 vlib_cli_command_t *cmd)
1328 unformat_input_t _line_input, *line_input = &_line_input;
1329 clib_error_t *error = 0;
1330 bool is_add = true, not_set = true;
1334 if (!unformat_user (input, unformat_line_input, line_input))
1335 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1337 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1339 if (unformat (line_input, "%u", &vrf_id))
1343 if (unformat (line_input, "add"))
1347 else if (unformat (line_input, "del"))
1355 error = clib_error_return (0, "unknown input '%U'",
1356 format_unformat_error, line_input);
1363 error = clib_error_return (0, "missing required parameter");
1369 error = clib_error_return (0, "missing vrf id");
1373 rv = nat44_ed_add_del_vrf_table (vrf_id, is_add);
1376 error = clib_error_return (0, "%s vrf table returned %d",
1377 is_add ? "add" : "del", rv);
1381 unformat_free (line_input);
1386 static clib_error_t *
1387 nat44_ed_add_del_vrf_route_command_fn (vlib_main_t *vm,
1388 unformat_input_t *input,
1389 vlib_cli_command_t *cmd)
1391 unformat_input_t _line_input, *line_input = &_line_input;
1392 clib_error_t *error = 0;
1393 bool is_add = true, not_set = true;
1394 u32 vrf_id = ~0, table_vrf_id = ~0;
1397 if (!unformat_user (input, unformat_line_input, line_input))
1398 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1400 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1402 if (unformat (line_input, "table %u", &table_vrf_id))
1404 else if (unformat (line_input, "%u", &vrf_id))
1408 if (unformat (line_input, "add"))
1412 else if (unformat (line_input, "del"))
1420 error = clib_error_return (0, "unknown input '%U'",
1421 format_unformat_error, line_input);
1428 error = clib_error_return (0, "missing required parameter");
1432 if ((~0 == vrf_id) || (~0 == table_vrf_id))
1434 error = clib_error_return (0, "missing vrf id");
1438 rv = nat44_ed_add_del_vrf_route (table_vrf_id, vrf_id, is_add);
1441 error = clib_error_return (0, "%s vrf table returned %d",
1442 is_add ? "add" : "del", rv);
1446 unformat_free (line_input);
1451 static clib_error_t *
1452 nat44_ed_show_vrf_tables_command_fn (vlib_main_t *vm, unformat_input_t *input,
1453 vlib_cli_command_t *cmd)
1455 snat_main_t *sm = &snat_main;
1460 pool_foreach (t, sm->vrf_tables)
1462 vlib_cli_output (vm, "table %u:", t->table_vrf_id);
1463 pool_foreach (r, t->routes)
1465 vlib_cli_output (vm, "[%u] vrf-id %u", i, r->vrf_id);
1473 static clib_error_t *
1474 nat44_show_interface_address_command_fn (vlib_main_t * vm,
1475 unformat_input_t * input,
1476 vlib_cli_command_t * cmd)
1478 snat_main_t *sm = &snat_main;
1479 vnet_main_t *vnm = vnet_get_main ();
1480 snat_address_resolve_t *ap;
1482 vlib_cli_output (vm, "NAT44 pool address interfaces:");
1483 vec_foreach (ap, sm->addr_to_resolve)
1485 vlib_cli_output (vm, " %U%s", format_vnet_sw_if_index_name, vnm,
1486 ap->sw_if_index, ap->is_twice_nat ? " twice-nat" : "");
1491 static clib_error_t *
1492 nat44_show_sessions_command_fn (vlib_main_t * vm, unformat_input_t * input,
1493 vlib_cli_command_t * cmd)
1495 unformat_input_t _line_input, *line_input = &_line_input;
1496 clib_error_t *error = 0;
1497 snat_main_per_thread_data_t *tsm;
1498 snat_main_t *sm = &snat_main;
1499 ip4_address_t i2o_sa, i2o_da, o2i_sa, o2i_da;
1500 u8 filter_i2o_sa = 0, filter_i2o_da = 0;
1501 u8 filter_o2i_sa = 0, filter_o2i_da = 0;
1502 u16 i2o_sp, i2o_dp, o2i_sp, o2i_dp;
1503 u8 filter_i2o_sp = 0, filter_i2o_dp = 0;
1504 u8 filter_o2i_sp = 0, filter_o2i_dp = 0;
1505 ip_protocol_t proto;
1506 u8 filter_proto = 0;
1507 u8 had_input = 1, filtering = 0;
1508 int i = 0, showed_sessions;
1510 if (!unformat_user (input, unformat_line_input, line_input))
1516 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1518 if (unformat (line_input, "filter i2o saddr %U", unformat_ip4_address,
1520 filter_i2o_sa = filtering = 1;
1521 else if (unformat (line_input, "filter i2o daddr %U",
1522 unformat_ip4_address, &i2o_da))
1523 filter_i2o_da = filtering = 1;
1524 else if (unformat (line_input, "filter o2i saddr %U",
1525 unformat_ip4_address, &o2i_sa))
1526 filter_o2i_sa = filtering = 1;
1527 else if (unformat (line_input, "filter o2i daddr %U",
1528 unformat_ip4_address, &o2i_da))
1529 filter_o2i_da = filtering = 1;
1530 else if (unformat (line_input, "filter i2o sport %u", &i2o_sp))
1531 filter_i2o_sp = filtering = 1;
1532 else if (unformat (line_input, "filter i2o dport %u", &i2o_dp))
1533 filter_i2o_dp = filtering = 1;
1534 else if (unformat (line_input, "filter o2i sport %u", &o2i_sp))
1535 filter_o2i_sp = filtering = 1;
1536 else if (unformat (line_input, "filter o2i dport %u", &o2i_dp))
1537 filter_o2i_dp = filtering = 1;
1538 else if (unformat (line_input, "filter i2o proto %U",
1539 unformat_ip_protocol, &proto))
1540 filter_proto = filtering = 1;
1541 else if (unformat (line_input, "filter o2i proto %U",
1542 unformat_ip_protocol, &proto))
1543 filter_proto = filtering = 1;
1546 error = clib_error_return (0, "unknown input '%U'",
1547 format_unformat_error, line_input);
1553 vlib_cli_output (vm, "NAT44 ED sessions:");
1555 vec_foreach_index (i, sm->per_thread_data)
1557 tsm = vec_elt_at_index (sm->per_thread_data, i);
1559 vlib_cli_output (vm, "-------- thread %d %s: %d sessions --------\n",
1560 i, vlib_worker_threads[i].name,
1561 pool_elts (tsm->sessions));
1563 showed_sessions = 0;
1565 pool_foreach (s, tsm->sessions)
1569 if (filter_i2o_sa && i2o_sa.as_u32 != s->i2o.match.saddr.as_u32)
1571 if (filter_i2o_da && i2o_da.as_u32 != s->i2o.match.daddr.as_u32)
1573 if (filter_o2i_sa && o2i_sa.as_u32 != s->o2i.match.saddr.as_u32)
1575 if (filter_o2i_da && o2i_da.as_u32 != s->o2i.match.daddr.as_u32)
1577 if (filter_i2o_sp &&
1578 i2o_sp != clib_net_to_host_u16 (s->i2o.match.sport))
1580 if (filter_i2o_dp &&
1581 i2o_dp != clib_net_to_host_u16 (s->i2o.match.dport))
1583 if (filter_o2i_sp &&
1584 o2i_sp != clib_net_to_host_u16 (s->o2i.match.sport))
1586 if (filter_o2i_dp &&
1587 o2i_dp != clib_net_to_host_u16 (s->o2i.match.dport))
1589 if (filter_proto && proto != s->proto)
1593 vlib_cli_output (vm, " %U\n", format_snat_session, sm, tsm, s,
1594 vlib_time_now (vm));
1598 vlib_cli_output (vm,
1599 "Showed: %d, Filtered: %d of total %d "
1600 "sessions of thread %d\n\n",
1602 pool_elts (tsm->sessions) - showed_sessions,
1603 pool_elts (tsm->sessions), i);
1609 unformat_free (line_input);
1613 static clib_error_t *
1614 nat44_set_session_limit_command_fn (vlib_main_t * vm,
1615 unformat_input_t * input,
1616 vlib_cli_command_t * cmd)
1618 unformat_input_t _line_input, *line_input = &_line_input;
1619 clib_error_t *error = 0;
1621 u32 session_limit = 0, vrf_id = 0;
1623 if (!unformat_user (input, unformat_line_input, line_input))
1624 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1626 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1628 if (unformat (line_input, "%u", &session_limit))
1630 else if (unformat (line_input, "vrf %u", &vrf_id))
1634 error = clib_error_return (0, "unknown input '%U'",
1635 format_unformat_error, line_input);
1641 error = clib_error_return (0, "missing value of session limit");
1642 else if (nat44_update_session_limit (session_limit, vrf_id))
1643 error = clib_error_return (0, "nat44_set_session_limit failed");
1646 unformat_free (line_input);
1651 static clib_error_t *
1652 nat44_del_session_command_fn (vlib_main_t * vm,
1653 unformat_input_t * input,
1654 vlib_cli_command_t * cmd)
1656 snat_main_t *sm = &snat_main;
1657 unformat_input_t _line_input, *line_input = &_line_input;
1658 u32 port = 0, eh_port = 0, vrf_id = sm->outside_vrf_id;
1659 clib_error_t *error = 0;
1660 ip4_address_t addr, eh_addr;
1661 ip_protocol_t proto;
1665 if (!unformat_user (input, unformat_line_input, line_input))
1666 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1668 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1670 if (unformat (line_input, "%U:%u %U", unformat_ip4_address, &addr, &port,
1671 unformat_ip_protocol, &proto))
1673 else if (unformat (line_input, "in"))
1676 vrf_id = sm->inside_vrf_id;
1678 else if (unformat (line_input, "out"))
1681 vrf_id = sm->outside_vrf_id;
1683 else if (unformat (line_input, "vrf %u", &vrf_id))
1685 else if (unformat (line_input, "external-host %U:%u",
1686 unformat_ip4_address, &eh_addr, &eh_port))
1690 error = clib_error_return (0, "unknown input '%U'",
1691 format_unformat_error, line_input);
1696 rv = nat44_ed_del_session (sm, &addr, clib_host_to_net_u16 (port), &eh_addr,
1697 clib_host_to_net_u16 (eh_port), proto, vrf_id,
1706 error = clib_error_return (0, "nat44_del_session returned %d", rv);
1711 unformat_free (line_input);
1716 static clib_error_t *
1717 snat_forwarding_set_command_fn (vlib_main_t * vm,
1718 unformat_input_t * input,
1719 vlib_cli_command_t * cmd)
1721 snat_main_t *sm = &snat_main;
1722 unformat_input_t _line_input, *line_input = &_line_input;
1723 clib_error_t *error = 0;
1725 u8 enable_set = 0, enable = 0;
1727 if (!unformat_user (input, unformat_line_input, line_input))
1728 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1730 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1735 if (unformat (line_input, "disable"))
1737 else if (unformat (line_input, "enable"))
1742 error = clib_error_return (0, "unknown input '%U'",
1743 format_unformat_error, line_input);
1749 error = clib_error_return (0, "expected enable | disable");
1751 sm->forwarding_enabled = enable;
1754 unformat_free (line_input);
1758 static clib_error_t *
1759 set_timeout_command_fn (vlib_main_t * vm,
1760 unformat_input_t * input, vlib_cli_command_t * cmd)
1762 snat_main_t *sm = &snat_main;
1763 unformat_input_t _line_input, *line_input = &_line_input;
1764 clib_error_t *error = 0;
1766 if (!unformat_user (input, unformat_line_input, line_input))
1767 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1769 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1771 if (unformat (line_input, "udp %u", &sm->timeouts.udp));
1772 else if (unformat (line_input, "tcp-established %u",
1773 &sm->timeouts.tcp.established));
1774 else if (unformat (line_input, "tcp-transitory %u",
1775 &sm->timeouts.tcp.transitory));
1776 else if (unformat (line_input, "icmp %u", &sm->timeouts.icmp));
1777 else if (unformat (line_input, "reset"))
1778 nat_reset_timeouts (&sm->timeouts);
1781 error = clib_error_return (0, "unknown input '%U'",
1782 format_unformat_error, line_input);
1787 unformat_free (line_input);
1791 static clib_error_t *
1792 nat_show_timeouts_command_fn (vlib_main_t * vm,
1793 unformat_input_t * input,
1794 vlib_cli_command_t * cmd)
1796 snat_main_t *sm = &snat_main;
1798 vlib_cli_output (vm, "udp timeout: %dsec", sm->timeouts.udp);
1799 vlib_cli_output (vm, "tcp-established timeout: %dsec",
1800 sm->timeouts.tcp.established);
1801 vlib_cli_output (vm, "tcp-transitory timeout: %dsec",
1802 sm->timeouts.tcp.transitory);
1803 vlib_cli_output (vm, "icmp timeout: %dsec", sm->timeouts.icmp);
1808 static clib_error_t *
1809 set_frame_queue_nelts_command_fn (vlib_main_t *vm, unformat_input_t *input,
1810 vlib_cli_command_t *cmd)
1812 unformat_input_t _line_input, *line_input = &_line_input;
1813 clib_error_t *error = 0;
1814 u32 frame_queue_nelts = 0;
1816 if (!unformat_user (input, unformat_line_input, line_input))
1817 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1819 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1821 if (unformat (line_input, "%u", &frame_queue_nelts))
1825 error = clib_error_return (0, "unknown input '%U'",
1826 format_unformat_error, line_input);
1830 if (!frame_queue_nelts)
1832 error = clib_error_return (0, "frame_queue_nelts cannot be zero");
1835 if (nat44_ed_set_frame_queue_nelts (frame_queue_nelts) != 0)
1837 error = clib_error_return (0, "snat_set_frame_queue_nelts failed");
1841 unformat_free (line_input);
1847 * @cliexstart{nat44}
1848 * Enable nat44 plugin
1849 * To enable nat44-ed, use:
1851 * To disable nat44-ed, use:
1852 * vpp# nat44 disable
1853 * To set inside-vrf outside-vrf, use:
1854 * vpp# nat44 enable inside-vrf <id> outside-vrf <id>
1857 VLIB_CLI_COMMAND (nat44_ed_enable_disable_command, static) = {
1859 .short_help = "nat44 <enable [sessions <max-number>] [inside-vrf <vrf-id>] "
1860 "[outside-vrf <vrf-id>]>|disable",
1861 .function = nat44_ed_enable_disable_command_fn,
1866 * @cliexstart{set snat workers}
1867 * Set NAT workers if 2 or more workers available, use:
1868 * vpp# set snat workers 0-2,5
1871 VLIB_CLI_COMMAND (set_workers_command, static) = {
1872 .path = "set nat workers",
1873 .function = set_workers_command_fn,
1874 .short_help = "set nat workers <workers-list>",
1879 * @cliexstart{show nat workers}
1881 * vpp# show nat workers:
1887 VLIB_CLI_COMMAND (nat_show_workers_command, static) = {
1888 .path = "show nat workers",
1889 .short_help = "show nat workers",
1890 .function = nat_show_workers_command_fn,
1895 * @cliexstart{set nat timeout}
1896 * Set values of timeouts for NAT sessions (in seconds), use:
1897 * vpp# set nat timeout udp 120 tcp-established 7500 tcp-transitory 250 icmp 90
1898 * To reset default values use:
1899 * vpp# set nat timeout reset
1902 VLIB_CLI_COMMAND (set_timeout_command, static) = {
1903 .path = "set nat timeout",
1904 .function = set_timeout_command_fn,
1906 "set nat timeout [udp <sec> | tcp-established <sec> "
1907 "tcp-transitory <sec> | icmp <sec> | reset]",
1912 * @cliexstart{show nat timeouts}
1913 * Show values of timeouts for NAT sessions.
1914 * vpp# show nat timeouts
1915 * udp timeout: 300sec
1916 * tcp-established timeout: 7440sec
1917 * tcp-transitory timeout: 240sec
1918 * icmp timeout: 60sec
1921 VLIB_CLI_COMMAND (nat_show_timeouts_command, static) = {
1922 .path = "show nat timeouts",
1923 .short_help = "show nat timeouts",
1924 .function = nat_show_timeouts_command_fn,
1929 * @cliexstart{set nat frame-queue-nelts}
1930 * Set number of worker handoff frame queue elements.
1933 VLIB_CLI_COMMAND (set_frame_queue_nelts_command, static) = {
1934 .path = "set nat frame-queue-nelts",
1935 .function = set_frame_queue_nelts_command_fn,
1936 .short_help = "set nat frame-queue-nelts <number>",
1941 * @cliexstart{nat set logging level}
1942 * To set NAT logging level use:
1943 * Set nat logging level
1946 VLIB_CLI_COMMAND (snat_set_log_level_command, static) = {
1947 .path = "nat set logging level",
1948 .function = snat_set_log_level_command_fn,
1949 .short_help = "nat set logging level <level>",
1954 * @cliexstart{snat ipfix logging}
1955 * To enable NAT IPFIX logging use:
1956 * vpp# nat ipfix logging
1957 * To set IPFIX exporter use:
1958 * vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1
1961 VLIB_CLI_COMMAND (snat_ipfix_logging_enable_disable_command, static) = {
1962 .path = "nat ipfix logging",
1963 .function = snat_ipfix_logging_enable_disable_command_fn,
1964 .short_help = "nat ipfix logging disable|<enable [domain <domain-id>] "
1965 "[src-port <port>]>",
1970 * @cliexstart{nat mss-clamping}
1971 * Set TCP MSS rewriting configuration
1972 * To enable TCP MSS rewriting use:
1973 * vpp# nat mss-clamping 1452
1974 * To disbale TCP MSS rewriting use:
1975 * vpp# nat mss-clamping disable
1978 VLIB_CLI_COMMAND (nat_set_mss_clamping_command, static) = {
1979 .path = "nat mss-clamping",
1980 .short_help = "nat mss-clamping <mss-value>|disable",
1981 .function = nat_set_mss_clamping_command_fn,
1986 * @cliexstart{show nat mss-clamping}
1987 * Show TCP MSS rewriting configuration
1990 VLIB_CLI_COMMAND (nat_show_mss_clamping_command, static) = {
1991 .path = "show nat mss-clamping",
1992 .short_help = "show nat mss-clamping",
1993 .function = nat_show_mss_clamping_command_fn,
1998 * @cliexstart{show nat44 hash tables}
1999 * Show NAT44 hash tables
2002 VLIB_CLI_COMMAND (nat44_show_hash, static) = {
2003 .path = "show nat44 hash tables",
2004 .short_help = "show nat44 hash tables [detail|verbose]",
2005 .function = nat44_show_hash_command_fn,
2010 * @cliexstart{nat44 add address}
2011 * Add/delete NAT44 pool address.
2012 * To add NAT44 pool address use:
2013 * vpp# nat44 add address 172.16.1.3
2014 * vpp# nat44 add address 172.16.2.2 - 172.16.2.24
2015 * To add NAT44 pool address for specific tenant (identified by VRF id) use:
2016 * vpp# nat44 add address 172.16.1.3 tenant-vrf 10
2019 VLIB_CLI_COMMAND (add_address_command, static) = {
2020 .path = "nat44 add address",
2021 .short_help = "nat44 add address <ip4-range-start> [- <ip4-range-end>] "
2022 "[tenant-vrf <vrf-id>] [twice-nat] [del]",
2023 .function = add_address_command_fn,
2028 * @cliexstart{show nat44 summary}
2029 * Show NAT44 summary
2030 * vpp# show nat44 summary
2033 VLIB_CLI_COMMAND (nat44_show_summary_command, static) = {
2034 .path = "show nat44 summary",
2035 .short_help = "show nat44 summary",
2036 .function = nat44_show_summary_command_fn,
2041 * @cliexstart{show nat44 addresses}
2042 * Show NAT44 pool addresses.
2043 * vpp# show nat44 addresses
2044 * NAT44 pool addresses:
2046 * tenant VRF independent
2055 * NAT44 twice-nat pool addresses:
2057 * tenant VRF independent
2063 VLIB_CLI_COMMAND (nat44_show_addresses_command, static) = {
2064 .path = "show nat44 addresses",
2065 .short_help = "show nat44 addresses",
2066 .function = nat44_show_addresses_command_fn,
2071 * @cliexstart{set interface nat44}
2072 * Enable/disable NAT44 feature on the interface.
2073 * To enable NAT44 feature with local network interface use:
2074 * vpp# set interface nat44 in GigabitEthernet0/8/0
2075 * To enable NAT44 feature with external network interface use:
2076 * vpp# set interface nat44 out GigabitEthernet0/a/0
2079 VLIB_CLI_COMMAND (set_interface_snat_command, static) = {
2080 .path = "set interface nat44",
2081 .function = snat_feature_command_fn,
2082 .short_help = "set interface nat44 in <intfc> out <intfc> [output-feature] "
2088 * @cliexstart{show nat44 interfaces}
2089 * Show interfaces with NAT44 feature.
2090 * vpp# show nat44 interfaces
2092 * GigabitEthernet0/8/0 in
2093 * GigabitEthernet0/a/0 out
2096 VLIB_CLI_COMMAND (nat44_show_interfaces_command, static) = {
2097 .path = "show nat44 interfaces",
2098 .short_help = "show nat44 interfaces",
2099 .function = nat44_show_interfaces_command_fn,
2104 * @cliexstart{nat44 add static mapping}
2105 * Static mapping allows hosts on the external network to initiate connection
2106 * to to the local network host.
2107 * To create static mapping between local host address 10.0.0.3 port 6303 and
2108 * external address 4.4.4.4 port 3606 for TCP protocol use:
2109 * vpp# nat44 add static mapping tcp local 10.0.0.3 6303 external 4.4.4.4 3606
2110 * If not runnig "static mapping only" NAT plugin mode use before:
2111 * vpp# nat44 add address 4.4.4.4
2112 * To create address only static mapping between local and external address use:
2113 * vpp# nat44 add static mapping local 10.0.0.3 external 4.4.4.4
2114 * To create ICMP static mapping between local and external with ICMP echo
2115 * identifier 10 use:
2116 * vpp# nat44 add static mapping icmp local 10.0.0.3 10 external 4.4.4.4 10
2117 * To force use of specific pool address, vrf independent
2118 * vpp# nat44 add static mapping local 10.0.0.2 1234 external 10.0.2.2 1234 twice-nat exact 10.0.1.2
2121 VLIB_CLI_COMMAND (add_static_mapping_command, static) = {
2122 .path = "nat44 add static mapping",
2123 .function = add_static_mapping_command_fn,
2125 "nat44 add static mapping tcp|udp|icmp local <addr> [<port|icmp-echo-id>] "
2126 "external <addr> [<port|icmp-echo-id>] [vrf <table-id>] [twice-nat|self-twice-nat] "
2127 "[out2in-only] [exact <pool-addr>] [del]",
2132 * @cliexstart{nat44 add identity mapping}
2133 * Identity mapping translate an IP address to itself.
2134 * To create identity mapping for address 10.0.0.3 port 6303 for TCP protocol
2136 * vpp# nat44 add identity mapping 10.0.0.3 tcp 6303
2137 * To create identity mapping for address 10.0.0.3 use:
2138 * vpp# nat44 add identity mapping 10.0.0.3
2139 * To create identity mapping for DHCP addressed interface use:
2140 * vpp# nat44 add identity mapping external GigabitEthernet0/a/0 tcp 3606
2143 VLIB_CLI_COMMAND (add_identity_mapping_command, static) = {
2144 .path = "nat44 add identity mapping",
2145 .function = add_identity_mapping_command_fn,
2146 .short_help = "nat44 add identity mapping <ip4-addr>|external <interface> "
2147 "[<protocol> <port>] [vrf <table-id>] [del]",
2152 * @cliexstart{nat44 add load-balancing static mapping}
2153 * Service load balancing using NAT44
2154 * To add static mapping with load balancing for service with external IP
2155 * address 1.2.3.4 and TCP port 80 and mapped to 2 local servers
2156 * 10.100.10.10:8080 and 10.100.10.20:8080 with probability 80% resp. 20% use:
2157 * 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
2160 VLIB_CLI_COMMAND (add_lb_static_mapping_command, static) = {
2161 .path = "nat44 add load-balancing static mapping",
2162 .function = add_lb_static_mapping_command_fn,
2164 "nat44 add load-balancing static mapping protocol tcp|udp "
2165 "external <addr>:<port> local <addr>:<port> [vrf <table-id>] "
2166 "probability <n> [twice-nat|self-twice-nat] [out2in-only] "
2167 "[affinity <timeout-seconds>] [del]",
2172 * @cliexstart{nat44 add load-balancing static mapping}
2173 * Modify service load balancing using NAT44
2174 * To add new back-end server 10.100.10.30:8080 for service load balancing
2175 * static mapping with external IP address 1.2.3.4 and TCP port 80 use:
2176 * vpp# nat44 add load-balancing back-end protocol tcp external 1.2.3.4:80 local 10.100.10.30:8080 probability 25
2179 VLIB_CLI_COMMAND (add_lb_backend_command, static) = {
2180 .path = "nat44 add load-balancing back-end",
2181 .function = add_lb_backend_command_fn,
2183 "nat44 add load-balancing back-end protocol tcp|udp "
2184 "external <addr>:<port> local <addr>:<port> [vrf <table-id>] "
2185 "probability <n> [del]",
2190 * @cliexstart{show nat44 static mappings}
2191 * Show NAT44 static mappings.
2192 * vpp# show nat44 static mappings
2193 * NAT44 static mappings:
2194 * local 10.0.0.3 external 4.4.4.4 vrf 0
2195 * tcp local 192.168.0.4:6303 external 4.4.4.3:3606 vrf 0
2196 * tcp vrf 0 external 1.2.3.4:80 out2in-only
2197 * local 10.100.10.10:8080 probability 80
2198 * local 10.100.10.20:8080 probability 20
2199 * tcp local 10.100.3.8:8080 external 169.10.10.1:80 vrf 0 twice-nat
2200 * tcp local 10.0.0.10:3603 external GigabitEthernet0/a/0:6306 vrf 10
2203 VLIB_CLI_COMMAND (nat44_show_static_mappings_command, static) = {
2204 .path = "show nat44 static mappings",
2205 .short_help = "show nat44 static mappings",
2206 .function = nat44_show_static_mappings_command_fn,
2211 * @cliexstart{nat44 add interface address}
2212 * Use NAT44 pool address from specific interfce
2213 * To add NAT44 pool address from specific interface use:
2214 * vpp# nat44 add interface address GigabitEthernet0/8/0
2217 VLIB_CLI_COMMAND (snat_add_interface_address_command, static) = {
2218 .path = "nat44 add interface address",
2219 .short_help = "nat44 add interface address <interface> [twice-nat] [del]",
2220 .function = snat_add_interface_address_command_fn,
2225 * @cliexstart{nat44 vrf table}
2226 * Add empty inter VRF routing table
2227 * vpp# nat44 vrf table add 10
2230 VLIB_CLI_COMMAND (nat44_ed_add_del_vrf_table_command, static) = {
2231 .path = "nat44 vrf table",
2232 .short_help = "nat44 vrf table [add|del] <vrf-id>",
2233 .function = nat44_ed_add_del_vrf_table_command_fn,
2238 * @cliexstart{nat44 vrf route}
2239 * Add inter VRF route record to VRF routing table
2240 * vpp# nat44 vrf route add table 10 20
2243 VLIB_CLI_COMMAND (nat44_ed_add_del_vrf_route_command, static) = {
2244 .path = "nat44 vrf route",
2245 .short_help = "nat44 vrf route [add|del] table <vrf-id> <vrf-id>",
2246 .function = nat44_ed_add_del_vrf_route_command_fn,
2251 * @cliexstart{show nat44 vrf tables}
2252 * Show inter VRF route tables
2253 * vpp# show nat44 vrf tables
2256 VLIB_CLI_COMMAND (nat44_ed_show_vrf_tables_command, static) = {
2257 .path = "show nat44 vrf tables",
2258 .short_help = "show nat44 vrf tables",
2259 .function = nat44_ed_show_vrf_tables_command_fn,
2264 * @cliexstart{show nat44 interface address}
2265 * Show NAT44 pool address interfaces
2266 * vpp# show nat44 interface address
2267 * NAT44 pool address interfaces:
2268 * GigabitEthernet0/a/0
2269 * NAT44 twice-nat pool address interfaces:
2270 * GigabitEthernet0/8/0
2273 VLIB_CLI_COMMAND (nat44_show_interface_address_command, static) = {
2274 .path = "show nat44 interface address",
2275 .short_help = "show nat44 interface address",
2276 .function = nat44_show_interface_address_command_fn,
2281 * @cliexstart{show nat44 sessions}
2282 * Show NAT44 sessions.
2285 VLIB_CLI_COMMAND (nat44_show_sessions_command, static) = {
2286 .path = "show nat44 sessions",
2287 .short_help = "show nat44 sessions [filter {i2o | o2i} {saddr <ip4-addr> "
2288 "| sport <n> | daddr <ip4-addr> | dport <n> | proto <proto>} "
2289 "[filter .. [..]]]",
2290 .function = nat44_show_sessions_command_fn,
2295 * @cliexstart{set nat44 session limit}
2296 * Set NAT44 session limit.
2299 VLIB_CLI_COMMAND (nat44_set_session_limit_command, static) = {
2300 .path = "set nat44 session limit",
2301 .short_help = "set nat44 session limit <limit> [vrf <table-id>]",
2302 .function = nat44_set_session_limit_command_fn,
2307 * @cliexstart{nat44 del session}
2308 * To administratively delete NAT44 session by inside address and port use:
2309 * vpp# nat44 del session in 10.0.0.3:6303 tcp
2310 * To administratively delete NAT44 session by outside address and port use:
2311 * vpp# nat44 del session out 1.0.0.3:6033 udp
2314 VLIB_CLI_COMMAND (nat44_del_session_command, static) = {
2315 .path = "nat44 del session",
2316 .short_help = "nat44 del session in|out <addr>:<port> tcp|udp|icmp [vrf <id>] [external-host <addr>:<port>]",
2317 .function = nat44_del_session_command_fn,
2322 * @cliexstart{nat44 forwarding}
2323 * Enable or disable forwarding
2324 * Forward packets which don't match existing translation
2325 * or static mapping instead of dropping them.
2326 * To enable forwarding, use:
2327 * vpp# nat44 forwarding enable
2328 * To disable forwarding, use:
2329 * vpp# nat44 forwarding disable
2332 VLIB_CLI_COMMAND (snat_forwarding_set_command, static) = {
2333 .path = "nat44 forwarding",
2334 .short_help = "nat44 forwarding enable|disable",
2335 .function = snat_forwarding_set_command_fn,
2339 * fd.io coding-style-patch-verification: ON
2342 * eval: (c-set-style "gnu")