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, mode_set = 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 (!mode_set && unformat (line_input, "static-mapping-only"))
51 c.static_mapping_only = 1;
52 if (unformat (line_input, "connection-tracking"))
54 c.connection_tracking = 1;
57 else if (unformat (line_input, "inside-vrf %u", &c.inside_vrf));
58 else if (unformat (line_input, "outside-vrf %u", &c.outside_vrf));
59 else if (unformat (line_input, "sessions %u", &c.sessions));
63 if (unformat (line_input, "disable"))
65 else if (unformat (line_input, "enable"))
70 error = clib_error_return (0, "unknown input '%U'",
71 format_unformat_error, line_input);
78 error = clib_error_return (0, "expected enable | disable");
86 error = clib_error_return (0, "already enabled");
90 if (nat44_plugin_enable (c) != 0)
91 error = clib_error_return (0, "enable failed");
97 error = clib_error_return (0, "already disabled");
101 if (nat44_plugin_disable () != 0)
102 error = clib_error_return (0, "disable failed");
106 unformat_free (line_input);
110 static clib_error_t *
111 set_workers_command_fn (vlib_main_t * vm,
112 unformat_input_t * input, vlib_cli_command_t * cmd)
114 unformat_input_t _line_input, *line_input = &_line_input;
117 clib_error_t *error = 0;
119 /* Get a line of input. */
120 if (!unformat_user (input, unformat_line_input, line_input))
121 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
123 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
125 if (unformat (line_input, "%U", unformat_bitmap_list, &bitmap))
129 error = clib_error_return (0, "unknown input '%U'",
130 format_unformat_error, line_input);
137 error = clib_error_return (0, "List of workers must be specified.");
141 rv = snat_set_workers (bitmap);
143 clib_bitmap_free (bitmap);
147 case VNET_API_ERROR_INVALID_WORKER:
148 error = clib_error_return (0, "Invalid worker(s).");
150 case VNET_API_ERROR_FEATURE_DISABLED:
151 error = clib_error_return (0,
152 "Supported only if 2 or more workes available.");
159 unformat_free (line_input);
164 static clib_error_t *
165 nat_show_workers_commnad_fn (vlib_main_t * vm, unformat_input_t * input,
166 vlib_cli_command_t * cmd)
168 snat_main_t *sm = &snat_main;
171 if (sm->num_workers > 1)
173 vlib_cli_output (vm, "%d workers", vec_len (sm->workers));
174 vec_foreach (worker, sm->workers)
176 vlib_worker_thread_t *w =
177 vlib_worker_threads + *worker + sm->first_worker_index;
178 vlib_cli_output (vm, " %s", w->name);
185 static clib_error_t *
186 snat_set_log_level_command_fn (vlib_main_t * vm,
187 unformat_input_t * input,
188 vlib_cli_command_t * cmd)
190 unformat_input_t _line_input, *line_input = &_line_input;
191 snat_main_t *sm = &snat_main;
192 u8 log_level = NAT_LOG_NONE;
193 clib_error_t *error = 0;
195 /* Get a line of input. */
196 if (!unformat_user (input, unformat_line_input, line_input))
197 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
199 if (!unformat (line_input, "%d", &log_level))
201 error = clib_error_return (0, "unknown input '%U'",
202 format_unformat_error, line_input);
205 if (log_level > NAT_LOG_DEBUG)
207 error = clib_error_return (0, "unknown logging level '%d'", log_level);
210 sm->log_level = log_level;
213 unformat_free (line_input);
218 static clib_error_t *
219 snat_ipfix_logging_enable_disable_command_fn (vlib_main_t * vm,
220 unformat_input_t * input,
221 vlib_cli_command_t * cmd)
223 unformat_input_t _line_input, *line_input = &_line_input;
224 clib_error_t *error = 0;
226 u32 domain_id = 0, src_port = 0;
227 u8 enable_set = 0, enable = 0;
229 if (!unformat_user (input, unformat_line_input, line_input))
230 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
232 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
234 if (unformat (line_input, "domain %d", &domain_id))
236 else if (unformat (line_input, "src-port %d", &src_port))
238 else if (!enable_set)
241 if (unformat (line_input, "disable"))
243 else if (unformat (line_input, "enable"))
248 error = clib_error_return (0, "unknown input '%U'",
249 format_unformat_error, line_input);
256 error = clib_error_return (0, "expected enable | disable");
260 if (nat_ipfix_logging_enable_disable (enable, domain_id, (u16) src_port))
262 error = clib_error_return (0, "ipfix logging enable failed");
267 unformat_free (line_input);
272 static clib_error_t *
273 nat44_show_hash_command_fn (vlib_main_t * vm, unformat_input_t * input,
274 vlib_cli_command_t * cmd)
276 snat_main_t *sm = &snat_main;
277 nat_affinity_main_t *nam = &nat_affinity_main;
281 if (unformat (input, "detail"))
283 else if (unformat (input, "verbose"))
286 vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->static_mapping_by_local,
288 vlib_cli_output (vm, "%U",
289 format_bihash_8_8, &sm->static_mapping_by_external,
291 vlib_cli_output (vm, "%U", format_bihash_16_8, &sm->flow_hash, verbose);
292 vec_foreach_index (i, sm->per_thread_data)
294 vlib_cli_output (vm, "-------- thread %d %s --------\n",
295 i, vlib_worker_threads[i].name);
296 vlib_cli_output (vm, "%U", format_bihash_16_8, &sm->flow_hash, verbose);
299 vlib_cli_output (vm, "%U", format_bihash_16_8, &nam->affinity_hash,
302 vlib_cli_output (vm, "-------- hash table parameters --------\n");
303 vlib_cli_output (vm, "translation buckets: %u", sm->translation_buckets);
307 static clib_error_t *
308 nat_set_mss_clamping_command_fn (vlib_main_t * vm, unformat_input_t * input,
309 vlib_cli_command_t * cmd)
311 unformat_input_t _line_input, *line_input = &_line_input;
312 snat_main_t *sm = &snat_main;
313 clib_error_t *error = 0;
316 /* Get a line of input. */
317 if (!unformat_user (input, unformat_line_input, line_input))
318 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
320 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
322 if (unformat (line_input, "disable"))
323 sm->mss_clamping = 0;
324 else if (unformat (line_input, "%d", &mss))
325 sm->mss_clamping = (u16) mss;
328 error = clib_error_return (0, "unknown input '%U'",
329 format_unformat_error, line_input);
335 unformat_free (line_input);
340 static clib_error_t *
341 nat_show_mss_clamping_command_fn (vlib_main_t * vm, unformat_input_t * input,
342 vlib_cli_command_t * cmd)
344 snat_main_t *sm = &snat_main;
346 if (sm->mss_clamping)
347 vlib_cli_output (vm, "mss-clamping %d", sm->mss_clamping);
349 vlib_cli_output (vm, "mss-clamping disabled");
354 static clib_error_t *
355 add_address_command_fn (vlib_main_t * vm,
356 unformat_input_t * input, vlib_cli_command_t * cmd)
358 unformat_input_t _line_input, *line_input = &_line_input;
359 snat_main_t *sm = &snat_main;
360 ip4_address_t start_addr, end_addr, this_addr;
361 u32 start_host_order, end_host_order;
366 clib_error_t *error = 0;
369 /* Get a line of input. */
370 if (!unformat_user (input, unformat_line_input, line_input))
371 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
373 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
375 if (unformat (line_input, "%U - %U",
376 unformat_ip4_address, &start_addr,
377 unformat_ip4_address, &end_addr))
379 else if (unformat (line_input, "tenant-vrf %u", &vrf_id))
381 else if (unformat (line_input, "%U", unformat_ip4_address, &start_addr))
382 end_addr = start_addr;
383 else if (unformat (line_input, "twice-nat"))
385 else if (unformat (line_input, "del"))
389 error = clib_error_return (0, "unknown input '%U'",
390 format_unformat_error, line_input);
395 if (sm->static_mapping_only)
397 error = clib_error_return (0, "static mapping only mode");
401 start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
402 end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
404 if (end_host_order < start_host_order)
406 error = clib_error_return (0, "end address less than start address");
410 count = (end_host_order - start_host_order) + 1;
413 nat_log_info ("%U - %U, %d addresses...",
414 format_ip4_address, &start_addr,
415 format_ip4_address, &end_addr, count);
417 this_addr = start_addr;
419 for (i = 0; i < count; i++)
423 rv = nat44_ed_add_address (&this_addr, vrf_id, twice_nat);
427 rv = nat44_ed_del_address (this_addr, 0, twice_nat);
432 case VNET_API_ERROR_VALUE_EXIST:
433 error = clib_error_return (0, "NAT address already in use.");
435 case VNET_API_ERROR_NO_SUCH_ENTRY:
436 error = clib_error_return (0, "NAT address not exist.");
438 case VNET_API_ERROR_UNSPECIFIED:
440 clib_error_return (0, "NAT address used in static mapping.");
446 increment_v4_address (&this_addr);
450 unformat_free (line_input);
456 nat44_show_lru_summary (vlib_main_t * vm, snat_main_per_thread_data_t * tsm,
457 u64 now, u64 sess_timeout_time)
459 snat_main_t *sm = &snat_main;
460 dlist_elt_t *oldest_elt;
468 clib_dlist_remove_head (tsm->lru_pool, tsm->n##_lru_head_index); \
469 if (~0 != oldest_index) \
471 oldest_elt = pool_elt_at_index (tsm->lru_pool, oldest_index); \
472 s = pool_elt_at_index (tsm->sessions, oldest_elt->value); \
473 sess_timeout_time = \
474 s->last_heard + (f64) nat44_session_get_timeout (sm, s); \
475 vlib_cli_output (vm, d " LRU min session timeout %llu (now %llu)", \
476 sess_timeout_time, now); \
477 clib_dlist_addhead (tsm->lru_pool, tsm->n##_lru_head_index, \
480 _ (tcp_estab, "established tcp");
481 _ (tcp_trans, "transitory tcp");
483 _ (unk_proto, "unknown protocol");
489 static clib_error_t *
490 nat44_show_summary_command_fn (vlib_main_t * vm, unformat_input_t * input,
491 vlib_cli_command_t * cmd)
493 snat_main_per_thread_data_t *tsm;
494 snat_main_t *sm = &snat_main;
499 u64 now = vlib_time_now (vm);
500 u64 sess_timeout_time = 0;
502 u32 udp_sessions = 0;
503 u32 tcp_sessions = 0;
504 u32 icmp_sessions = 0;
508 u32 transitory_wait_closed = 0;
509 u32 transitory_closed = 0;
514 for (fib = 0; fib < vec_len (sm->max_translations_per_fib); fib++)
515 vlib_cli_output (vm, "max translations per thread: %u fib %u",
516 sm->max_translations_per_fib[fib], fib);
518 if (sm->num_workers > 1)
520 vec_foreach (tsm, sm->per_thread_data)
522 pool_foreach (s, tsm->sessions)
524 sess_timeout_time = s->last_heard +
525 (f64) nat44_session_get_timeout (sm, s);
526 if (now >= sess_timeout_time)
529 switch (s->nat_proto)
531 case NAT_PROTOCOL_ICMP:
534 case NAT_PROTOCOL_TCP:
538 if (s->tcp_closed_timestamp)
540 if (now >= s->tcp_closed_timestamp)
546 ++transitory_wait_closed;
554 case NAT_PROTOCOL_UDP:
560 nat44_show_lru_summary (vm, tsm, now, sess_timeout_time);
561 count += pool_elts (tsm->sessions);
566 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
567 pool_foreach (s, tsm->sessions)
569 sess_timeout_time = s->last_heard +
570 (f64) nat44_session_get_timeout (sm, s);
571 if (now >= sess_timeout_time)
574 switch (s->nat_proto)
576 case NAT_PROTOCOL_ICMP:
579 case NAT_PROTOCOL_TCP:
583 if (s->tcp_closed_timestamp)
585 if (now >= s->tcp_closed_timestamp)
591 ++transitory_wait_closed;
599 case NAT_PROTOCOL_UDP:
605 nat44_show_lru_summary (vm, tsm, now, sess_timeout_time);
606 count = pool_elts (tsm->sessions);
609 vlib_cli_output (vm, "total timed out sessions: %u", timed_out);
610 vlib_cli_output (vm, "total sessions: %u", count);
611 vlib_cli_output (vm, "total tcp sessions: %u", tcp_sessions);
612 vlib_cli_output (vm, "total tcp established sessions: %u", established);
613 vlib_cli_output (vm, "total tcp transitory sessions: %u", transitory);
614 vlib_cli_output (vm, "total tcp transitory (WAIT-CLOSED) sessions: %u",
615 transitory_wait_closed);
616 vlib_cli_output (vm, "total tcp transitory (CLOSED) sessions: %u",
618 vlib_cli_output (vm, "total udp sessions: %u", udp_sessions);
619 vlib_cli_output (vm, "total icmp sessions: %u", icmp_sessions);
623 static clib_error_t *
624 nat44_show_addresses_command_fn (vlib_main_t * vm, unformat_input_t * input,
625 vlib_cli_command_t * cmd)
627 snat_main_t *sm = &snat_main;
630 vlib_cli_output (vm, "NAT44 pool addresses:");
631 vec_foreach (ap, sm->addresses)
633 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
634 if (ap->fib_index != ~0)
635 vlib_cli_output (vm, " tenant VRF: %u",
636 fib_table_get(ap->fib_index, FIB_PROTOCOL_IP4)->ft_table_id);
638 vlib_cli_output (vm, " tenant VRF independent");
639 #define _(N, i, n, s) \
640 vlib_cli_output (vm, " %d busy %s ports", ap->busy_##n##_ports, s);
644 vlib_cli_output (vm, "NAT44 twice-nat pool addresses:");
645 vec_foreach (ap, sm->twice_nat_addresses)
647 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
648 if (ap->fib_index != ~0)
649 vlib_cli_output (vm, " tenant VRF: %u",
650 fib_table_get(ap->fib_index, FIB_PROTOCOL_IP4)->ft_table_id);
652 vlib_cli_output (vm, " tenant VRF independent");
653 #define _(N, i, n, s) \
654 vlib_cli_output (vm, " %d busy %s ports", ap->busy_##n##_ports, s);
661 static clib_error_t *
662 snat_feature_command_fn (vlib_main_t * vm,
663 unformat_input_t * input, vlib_cli_command_t * cmd)
665 unformat_input_t _line_input, *line_input = &_line_input;
666 vnet_main_t *vnm = vnet_get_main ();
667 clib_error_t *error = 0;
669 u32 *inside_sw_if_indices = 0;
670 u32 *outside_sw_if_indices = 0;
671 u8 is_output_feature = 0;
672 int i, rv, is_del = 0;
676 /* Get a line of input. */
677 if (!unformat_user (input, unformat_line_input, line_input))
678 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
680 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
682 if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
684 vec_add1 (inside_sw_if_indices, sw_if_index);
685 else if (unformat (line_input, "out %U", unformat_vnet_sw_interface,
687 vec_add1 (outside_sw_if_indices, sw_if_index);
688 else if (unformat (line_input, "output-feature"))
689 is_output_feature = 1;
690 else if (unformat (line_input, "del"))
694 error = clib_error_return (0, "unknown input '%U'",
695 format_unformat_error, line_input);
700 if (vec_len (inside_sw_if_indices))
702 for (i = 0; i < vec_len (inside_sw_if_indices); i++)
704 sw_if_index = inside_sw_if_indices[i];
705 if (is_output_feature)
709 rv = nat44_ed_del_output_interface (sw_if_index);
713 rv = nat44_ed_add_output_interface (sw_if_index);
717 error = clib_error_return (0, "%s %U failed",
718 is_del ? "del" : "add",
719 format_vnet_sw_if_index_name,
728 rv = nat44_ed_del_interface (sw_if_index, 1);
732 rv = nat44_ed_add_interface (sw_if_index, 1);
736 error = clib_error_return (0, "%s %U failed",
737 is_del ? "del" : "add",
738 format_vnet_sw_if_index_name,
746 if (vec_len (outside_sw_if_indices))
748 for (i = 0; i < vec_len (outside_sw_if_indices); i++)
750 sw_if_index = outside_sw_if_indices[i];
751 if (is_output_feature)
755 rv = nat44_ed_del_output_interface (sw_if_index);
759 rv = nat44_ed_add_output_interface (sw_if_index);
763 error = clib_error_return (0, "%s %U failed",
764 is_del ? "del" : "add",
765 format_vnet_sw_if_index_name,
774 rv = nat44_ed_del_interface (sw_if_index, 0);
778 rv = nat44_ed_add_interface (sw_if_index, 0);
782 error = clib_error_return (0, "%s %U failed",
783 is_del ? "del" : "add",
784 format_vnet_sw_if_index_name,
793 unformat_free (line_input);
794 vec_free (inside_sw_if_indices);
795 vec_free (outside_sw_if_indices);
800 static clib_error_t *
801 nat44_show_interfaces_command_fn (vlib_main_t * vm, unformat_input_t * input,
802 vlib_cli_command_t * cmd)
804 snat_main_t *sm = &snat_main;
806 vnet_main_t *vnm = vnet_get_main ();
808 vlib_cli_output (vm, "NAT44 interfaces:");
809 pool_foreach (i, sm->interfaces)
811 vlib_cli_output (vm, " %U %s", format_vnet_sw_if_index_name, vnm,
813 (nat_interface_is_inside(i) &&
814 nat_interface_is_outside(i)) ? "in out" :
815 (nat_interface_is_inside(i) ? "in" : "out"));
818 pool_foreach (i, sm->output_feature_interfaces)
820 vlib_cli_output (vm, " %U output-feature %s",
821 format_vnet_sw_if_index_name, vnm,
823 (nat_interface_is_inside(i) &&
824 nat_interface_is_outside(i)) ? "in out" :
825 (nat_interface_is_inside(i) ? "in" : "out"));
831 static clib_error_t *
832 add_static_mapping_command_fn (vlib_main_t * vm,
833 unformat_input_t * input,
834 vlib_cli_command_t * cmd)
836 unformat_input_t _line_input, *line_input = &_line_input;
837 vnet_main_t *vnm = vnet_get_main ();
838 clib_error_t *error = 0;
841 nat_protocol_t proto = NAT_PROTOCOL_OTHER;
842 ip4_address_t l_addr, e_addr, pool_addr;
843 u32 l_port = 0, e_port = 0, vrf_id = ~0;
844 u8 l_port_set = 0, e_port_set = 0;
845 u32 sw_if_index, flags = 0;
848 if (!unformat_user (input, unformat_line_input, line_input))
849 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
851 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
853 if (unformat (line_input, "local %U %u", unformat_ip4_address, &l_addr,
859 if (unformat (line_input, "local %U", unformat_ip4_address, &l_addr))
861 else if (unformat (line_input, "external %U %u", unformat_ip4_address,
866 else if (unformat (line_input, "external %U", unformat_ip4_address,
869 else if (unformat (line_input, "external %U %u",
870 unformat_vnet_sw_interface, vnm, &sw_if_index,
873 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
876 else if (unformat (line_input, "external %U",
877 unformat_vnet_sw_interface, vnm, &sw_if_index))
879 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
881 else if (unformat (line_input, "exact %U", unformat_ip4_address,
884 flags |= NAT_SM_FLAG_EXACT_ADDRESS;
886 else if (unformat (line_input, "vrf %u", &vrf_id))
888 else if (unformat (line_input, "%U", unformat_nat_protocol, &proto))
890 else if (unformat (line_input, "self-twice-nat"))
892 flags |= NAT_SM_FLAG_SELF_TWICE_NAT;
894 else if (unformat (line_input, "twice-nat"))
896 flags |= NAT_SM_FLAG_TWICE_NAT;
898 else if (unformat (line_input, "out2in-only"))
900 flags |= NAT_SM_FLAG_OUT2IN_ONLY;
902 else if (unformat (line_input, "del"))
908 error = clib_error_return (0, "unknown input: '%U'",
909 format_unformat_error, line_input);
914 if (l_port_set != e_port_set)
916 error = clib_error_return (0, "Either both ports are set or none.");
922 flags |= NAT_SM_FLAG_ADDR_ONLY;
926 l_port = clib_host_to_net_u16 (l_port);
927 e_port = clib_host_to_net_u16 (e_port);
930 // TODO: specific pool_addr for both pool & twice nat pool ?
935 nat44_ed_add_static_mapping (l_addr, e_addr, l_port, e_port, proto,
936 vrf_id, sw_if_index, flags, pool_addr, 0);
940 rv = nat44_ed_del_static_mapping (l_addr, e_addr, l_port, e_port, proto,
941 vrf_id, sw_if_index, flags);
948 case VNET_API_ERROR_INVALID_VALUE:
949 error = clib_error_return (0, "External port already in use.");
951 case VNET_API_ERROR_NO_SUCH_ENTRY:
953 error = clib_error_return (0, "External address must be allocated.");
955 error = clib_error_return (0, "Mapping not exist.");
957 case VNET_API_ERROR_NO_SUCH_FIB:
958 error = clib_error_return (0, "No such VRF id.");
960 case VNET_API_ERROR_VALUE_EXIST:
961 error = clib_error_return (0, "Mapping already exist.");
968 unformat_free (line_input);
973 // TODO: either delete this bullshit or update it
974 static clib_error_t *
975 add_identity_mapping_command_fn (vlib_main_t * vm,
976 unformat_input_t * input,
977 vlib_cli_command_t * cmd)
979 unformat_input_t _line_input, *line_input = &_line_input;
980 vnet_main_t *vnm = vnet_get_main ();
981 clib_error_t *error = 0;
983 int rv, is_add = 1, port_set = 0;
984 u32 sw_if_index, port, flags, vrf_id = ~0;
985 nat_protocol_t proto;
988 flags = NAT_SM_FLAG_IDENTITY_NAT;
990 /* Get a line of input. */
991 if (!unformat_user (input, unformat_line_input, line_input))
992 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
994 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
996 if (unformat (line_input, "%U", unformat_ip4_address, &addr))
998 else if (unformat (line_input, "external %U",
999 unformat_vnet_sw_interface, vnm, &sw_if_index))
1001 flags |= NAT_SM_FLAG_SWITCH_ADDRESS;
1003 else if (unformat (line_input, "vrf %u", &vrf_id))
1005 else if (unformat (line_input, "%U %u", unformat_nat_protocol, &proto,
1010 else if (unformat (line_input, "del"))
1016 error = clib_error_return (0, "unknown input: '%U'",
1017 format_unformat_error, line_input);
1024 flags |= NAT_SM_FLAG_ADDR_ONLY;
1028 port = clib_host_to_net_u16 (port);
1034 rv = nat44_ed_add_static_mapping (addr, addr, port, port, proto, vrf_id,
1035 sw_if_index, flags, addr, 0);
1039 rv = nat44_ed_del_static_mapping (addr, addr, port, port, proto, vrf_id,
1040 sw_if_index, flags);
1043 // TODO: fix returns
1047 case VNET_API_ERROR_INVALID_VALUE:
1048 error = clib_error_return (0, "External port already in use.");
1050 case VNET_API_ERROR_NO_SUCH_ENTRY:
1052 error = clib_error_return (0, "External address must be allocated.");
1054 error = clib_error_return (0, "Mapping not exist.");
1056 case VNET_API_ERROR_NO_SUCH_FIB:
1057 error = clib_error_return (0, "No such VRF id.");
1059 case VNET_API_ERROR_VALUE_EXIST:
1060 error = clib_error_return (0, "Mapping already exist.");
1067 unformat_free (line_input);
1072 static clib_error_t *
1073 add_lb_static_mapping_command_fn (vlib_main_t * vm,
1074 unformat_input_t * input,
1075 vlib_cli_command_t * cmd)
1077 unformat_input_t _line_input, *line_input = &_line_input;
1078 clib_error_t *error = 0;
1079 ip4_address_t l_addr, e_addr;
1080 u32 l_port = 0, e_port = 0, vrf_id = 0, probability = 0, affinity = 0;
1082 nat_protocol_t proto;
1083 nat44_lb_addr_port_t *locals = 0, local;
1087 /* Get a line of input. */
1088 if (!unformat_user (input, unformat_line_input, line_input))
1089 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1091 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1093 if (unformat (line_input, "local %U:%u probability %u",
1094 unformat_ip4_address, &l_addr, &l_port, &probability))
1096 clib_memset (&local, 0, sizeof (local));
1097 local.addr = l_addr;
1098 local.port = (u16) l_port;
1099 local.probability = (u8) probability;
1100 vec_add1 (locals, local);
1102 else if (unformat (line_input, "local %U:%u vrf %u probability %u",
1103 unformat_ip4_address, &l_addr, &l_port, &vrf_id,
1106 clib_memset (&local, 0, sizeof (local));
1107 local.addr = l_addr;
1108 local.port = (u16) l_port;
1109 local.probability = (u8) probability;
1110 local.vrf_id = vrf_id;
1111 vec_add1 (locals, local);
1113 else if (unformat (line_input, "external %U:%u", unformat_ip4_address,
1116 else if (unformat (line_input, "protocol %U", unformat_nat_protocol,
1121 else if (unformat (line_input, "twice-nat"))
1123 flags |= NAT_SM_FLAG_TWICE_NAT;
1125 else if (unformat (line_input, "self-twice-nat"))
1127 flags |= NAT_SM_FLAG_SELF_TWICE_NAT;
1129 else if (unformat (line_input, "out2in-only"))
1131 flags |= NAT_SM_FLAG_OUT2IN_ONLY;
1133 else if (unformat (line_input, "del"))
1137 else if (unformat (line_input, "affinity %u", &affinity))
1141 error = clib_error_return (0, "unknown input: '%U'",
1142 format_unformat_error, line_input);
1147 if (vec_len (locals) < 2)
1149 error = clib_error_return (0, "at least two local must be set");
1155 error = clib_error_return (0, "missing protocol");
1161 rv = nat44_ed_add_lb_static_mapping (e_addr, (u16) e_port, proto, locals,
1162 flags, 0, affinity);
1166 rv = nat44_ed_del_lb_static_mapping (e_addr, (u16) e_port, proto, flags);
1171 case VNET_API_ERROR_INVALID_VALUE:
1172 error = clib_error_return (0, "External port already in use.");
1174 case VNET_API_ERROR_NO_SUCH_ENTRY:
1176 error = clib_error_return (0, "External address must be allocated.");
1178 error = clib_error_return (0, "Mapping not exist.");
1180 case VNET_API_ERROR_VALUE_EXIST:
1181 error = clib_error_return (0, "Mapping already exist.");
1188 unformat_free (line_input);
1194 static clib_error_t *
1195 add_lb_backend_command_fn (vlib_main_t * vm,
1196 unformat_input_t * input, vlib_cli_command_t * cmd)
1198 unformat_input_t _line_input, *line_input = &_line_input;
1199 clib_error_t *error = 0;
1200 ip4_address_t l_addr, e_addr;
1201 u32 l_port = 0, e_port = 0, vrf_id = 0, probability = 0;
1204 nat_protocol_t proto;
1207 /* Get a line of input. */
1208 if (!unformat_user (input, unformat_line_input, line_input))
1209 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1211 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1213 if (unformat (line_input, "local %U:%u probability %u",
1214 unformat_ip4_address, &l_addr, &l_port, &probability))
1216 else if (unformat (line_input, "local %U:%u vrf %u probability %u",
1217 unformat_ip4_address, &l_addr, &l_port, &vrf_id,
1220 else if (unformat (line_input, "external %U:%u", unformat_ip4_address,
1223 else if (unformat (line_input, "protocol %U", unformat_nat_protocol,
1226 else if (unformat (line_input, "del"))
1230 error = clib_error_return (0, "unknown input: '%U'",
1231 format_unformat_error, line_input);
1236 if (!l_port || !e_port)
1238 error = clib_error_return (0, "local or external must be set");
1244 error = clib_error_return (0, "missing protocol");
1248 rv = nat44_ed_add_del_lb_static_mapping_local (
1249 e_addr, (u16) e_port, l_addr, l_port, proto, vrf_id, probability, is_add);
1253 case VNET_API_ERROR_INVALID_VALUE:
1254 error = clib_error_return (0, "External is not load-balancing static "
1257 case VNET_API_ERROR_NO_SUCH_ENTRY:
1258 error = clib_error_return (0, "Mapping or back-end not exist.");
1260 case VNET_API_ERROR_VALUE_EXIST:
1261 error = clib_error_return (0, "Back-end already exist.");
1263 case VNET_API_ERROR_UNSPECIFIED:
1264 error = clib_error_return (0, "At least two back-ends must remain");
1271 unformat_free (line_input);
1276 static clib_error_t *
1277 nat44_show_static_mappings_command_fn (vlib_main_t * vm,
1278 unformat_input_t * input,
1279 vlib_cli_command_t * cmd)
1281 snat_main_t *sm = &snat_main;
1282 snat_static_mapping_t *m;
1283 snat_static_map_resolve_t *rp;
1285 vlib_cli_output (vm, "NAT44 static mappings:");
1286 pool_foreach (m, sm->static_mappings)
1288 vlib_cli_output (vm, " %U", format_snat_static_mapping, m);
1290 vec_foreach (rp, sm->to_resolve)
1291 vlib_cli_output (vm, " %U", format_snat_static_map_to_resolve, rp);
1296 static clib_error_t *
1297 snat_add_interface_address_command_fn (vlib_main_t * vm,
1298 unformat_input_t * input,
1299 vlib_cli_command_t * cmd)
1301 unformat_input_t _line_input, *line_input = &_line_input;
1302 snat_main_t *sm = &snat_main;
1303 clib_error_t *error = 0;
1308 if (!unformat_user (input, unformat_line_input, line_input))
1309 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1311 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1313 if (unformat (line_input, "%U", unformat_vnet_sw_interface,
1314 sm->vnet_main, &sw_if_index))
1316 else if (unformat (line_input, "twice-nat"))
1320 else if (unformat (line_input, "del"))
1326 error = clib_error_return (0, "unknown input '%U'",
1327 format_unformat_error, line_input);
1334 rv = nat44_ed_add_interface_address (sw_if_index, twice_nat);
1337 error = clib_error_return (0, "add address returned %d", rv);
1342 rv = nat44_ed_del_interface_address (sw_if_index, twice_nat);
1345 error = clib_error_return (0, "del address returned %d", rv);
1350 unformat_free (line_input);
1355 static clib_error_t *
1356 nat44_show_interface_address_command_fn (vlib_main_t * vm,
1357 unformat_input_t * input,
1358 vlib_cli_command_t * cmd)
1360 snat_main_t *sm = &snat_main;
1361 vnet_main_t *vnm = vnet_get_main ();
1364 vlib_cli_output (vm, "NAT44 pool address interfaces:");
1365 vec_foreach (sw_if_index, sm->auto_add_sw_if_indices)
1367 vlib_cli_output (vm, " %U", format_vnet_sw_if_index_name, vnm,
1370 vlib_cli_output (vm, "NAT44 twice-nat pool address interfaces:");
1371 vec_foreach (sw_if_index, sm->auto_add_sw_if_indices_twice_nat)
1373 vlib_cli_output (vm, " %U", format_vnet_sw_if_index_name, vnm,
1380 static clib_error_t *
1381 nat44_show_sessions_command_fn (vlib_main_t * vm, unformat_input_t * input,
1382 vlib_cli_command_t * cmd)
1384 unformat_input_t _line_input, *line_input = &_line_input;
1385 clib_error_t *error = 0;
1386 snat_main_per_thread_data_t *tsm;
1387 snat_main_t *sm = &snat_main;
1391 if (!unformat_user (input, unformat_line_input, line_input))
1394 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1396 error = clib_error_return (0, "unknown input '%U'",
1397 format_unformat_error, line_input);
1400 unformat_free (line_input);
1403 vlib_cli_output (vm, "NAT44 ED sessions:");
1405 vec_foreach_index (i, sm->per_thread_data)
1407 tsm = vec_elt_at_index (sm->per_thread_data, i);
1409 vlib_cli_output (vm, "-------- thread %d %s: %d sessions --------\n",
1410 i, vlib_worker_threads[i].name,
1411 pool_elts (tsm->sessions));
1414 pool_foreach (s, tsm->sessions)
1416 vlib_cli_output (vm, " %U\n", format_snat_session, tsm, s);
1422 static clib_error_t *
1423 nat44_set_session_limit_command_fn (vlib_main_t * vm,
1424 unformat_input_t * input,
1425 vlib_cli_command_t * cmd)
1427 unformat_input_t _line_input, *line_input = &_line_input;
1428 clib_error_t *error = 0;
1430 u32 session_limit = 0, vrf_id = 0;
1432 if (!unformat_user (input, unformat_line_input, line_input))
1433 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1435 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1437 if (unformat (line_input, "%u", &session_limit))
1439 else if (unformat (line_input, "vrf %u", &vrf_id))
1443 error = clib_error_return (0, "unknown input '%U'",
1444 format_unformat_error, line_input);
1450 error = clib_error_return (0, "missing value of session limit");
1451 else if (nat44_update_session_limit (session_limit, vrf_id))
1452 error = clib_error_return (0, "nat44_set_session_limit failed");
1455 unformat_free (line_input);
1460 static clib_error_t *
1461 nat44_del_session_command_fn (vlib_main_t * vm,
1462 unformat_input_t * input,
1463 vlib_cli_command_t * cmd)
1465 snat_main_t *sm = &snat_main;
1466 unformat_input_t _line_input, *line_input = &_line_input;
1467 u32 port = 0, eh_port = 0, vrf_id = sm->outside_vrf_id;
1468 clib_error_t *error = 0;
1469 ip4_address_t addr, eh_addr;
1470 nat_protocol_t proto;
1474 if (!unformat_user (input, unformat_line_input, line_input))
1475 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1477 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1480 (line_input, "%U:%u %U", unformat_ip4_address, &addr, &port,
1481 unformat_nat_protocol, &proto))
1483 else if (unformat (line_input, "in"))
1486 vrf_id = sm->inside_vrf_id;
1488 else if (unformat (line_input, "out"))
1491 vrf_id = sm->outside_vrf_id;
1493 else if (unformat (line_input, "vrf %u", &vrf_id))
1495 else if (unformat (line_input, "external-host %U:%u",
1496 unformat_ip4_address, &eh_addr, &eh_port))
1500 error = clib_error_return (0, "unknown input '%U'",
1501 format_unformat_error, line_input);
1506 rv = nat44_ed_del_session (sm, &addr, clib_host_to_net_u16 (port), &eh_addr,
1507 clib_host_to_net_u16 (eh_port),
1508 nat_proto_to_ip_proto (proto), vrf_id, is_in);
1516 error = clib_error_return (0, "nat44_del_session returned %d", rv);
1521 unformat_free (line_input);
1526 static clib_error_t *
1527 snat_forwarding_set_command_fn (vlib_main_t * vm,
1528 unformat_input_t * input,
1529 vlib_cli_command_t * cmd)
1531 snat_main_t *sm = &snat_main;
1532 unformat_input_t _line_input, *line_input = &_line_input;
1533 clib_error_t *error = 0;
1535 u8 enable_set = 0, enable = 0;
1537 if (!unformat_user (input, unformat_line_input, line_input))
1538 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1540 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1545 if (unformat (line_input, "disable"))
1547 else if (unformat (line_input, "enable"))
1552 error = clib_error_return (0, "unknown input '%U'",
1553 format_unformat_error, line_input);
1559 error = clib_error_return (0, "expected enable | disable");
1561 sm->forwarding_enabled = enable;
1564 unformat_free (line_input);
1568 static clib_error_t *
1569 set_timeout_command_fn (vlib_main_t * vm,
1570 unformat_input_t * input, vlib_cli_command_t * cmd)
1572 snat_main_t *sm = &snat_main;
1573 unformat_input_t _line_input, *line_input = &_line_input;
1574 clib_error_t *error = 0;
1576 if (!unformat_user (input, unformat_line_input, line_input))
1577 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1579 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1581 if (unformat (line_input, "udp %u", &sm->timeouts.udp));
1582 else if (unformat (line_input, "tcp-established %u",
1583 &sm->timeouts.tcp.established));
1584 else if (unformat (line_input, "tcp-transitory %u",
1585 &sm->timeouts.tcp.transitory));
1586 else if (unformat (line_input, "icmp %u", &sm->timeouts.icmp));
1587 else if (unformat (line_input, "reset"))
1588 nat_reset_timeouts (&sm->timeouts);
1591 error = clib_error_return (0, "unknown input '%U'",
1592 format_unformat_error, line_input);
1597 unformat_free (line_input);
1601 static clib_error_t *
1602 nat_show_timeouts_command_fn (vlib_main_t * vm,
1603 unformat_input_t * input,
1604 vlib_cli_command_t * cmd)
1606 snat_main_t *sm = &snat_main;
1608 vlib_cli_output (vm, "udp timeout: %dsec", sm->timeouts.udp);
1609 vlib_cli_output (vm, "tcp-established timeout: %dsec",
1610 sm->timeouts.tcp.established);
1611 vlib_cli_output (vm, "tcp-transitory timeout: %dsec",
1612 sm->timeouts.tcp.transitory);
1613 vlib_cli_output (vm, "icmp timeout: %dsec", sm->timeouts.icmp);
1618 static clib_error_t *
1619 set_frame_queue_nelts_command_fn (vlib_main_t *vm, unformat_input_t *input,
1620 vlib_cli_command_t *cmd)
1622 unformat_input_t _line_input, *line_input = &_line_input;
1623 clib_error_t *error = 0;
1624 u32 frame_queue_nelts = 0;
1626 if (!unformat_user (input, unformat_line_input, line_input))
1627 return clib_error_return (0, NAT44_ED_EXPECTED_ARGUMENT);
1629 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1631 if (unformat (line_input, "%u", &frame_queue_nelts))
1635 error = clib_error_return (0, "unknown input '%U'",
1636 format_unformat_error, line_input);
1640 if (!frame_queue_nelts)
1642 error = clib_error_return (0, "frame_queue_nelts cannot be zero");
1645 if (nat44_ed_set_frame_queue_nelts (frame_queue_nelts) != 0)
1647 error = clib_error_return (0, "snat_set_frame_queue_nelts failed");
1651 unformat_free (line_input);
1657 * @cliexstart{nat44}
1658 * Enable nat44 plugin
1659 * To enable nat44-ed, use:
1661 * To disable nat44-ed, use:
1662 * vpp# nat44 disable
1663 * To enable nat44-ed static mapping with connection tracking, use:
1664 * vpp# nat44-ed enable static-mapping connection-tracking
1665 * To set inside-vrf outside-vrf, use:
1666 * vpp# nat44 enable inside-vrf <id> outside-vrf <id>
1669 VLIB_CLI_COMMAND (nat44_ed_enable_disable_command, static) = {
1671 .short_help = "nat44 <enable [sessions <max-number>] [static-mapping-only "
1672 "connection-tracking] [inside-vrf <vrf-id>] "
1673 "[outside-vrf <vrf-id>]>|disable",
1674 .function = nat44_ed_enable_disable_command_fn,
1679 * @cliexstart{set snat workers}
1680 * Set NAT workers if 2 or more workers available, use:
1681 * vpp# set snat workers 0-2,5
1684 VLIB_CLI_COMMAND (set_workers_command, static) = {
1685 .path = "set nat workers",
1686 .function = set_workers_command_fn,
1687 .short_help = "set nat workers <workers-list>",
1692 * @cliexstart{show nat workers}
1694 * vpp# show nat workers:
1700 VLIB_CLI_COMMAND (nat_show_workers_command, static) = {
1701 .path = "show nat workers",
1702 .short_help = "show nat workers",
1703 .function = nat_show_workers_commnad_fn,
1708 * @cliexstart{set nat timeout}
1709 * Set values of timeouts for NAT sessions (in seconds), use:
1710 * vpp# set nat timeout udp 120 tcp-established 7500 tcp-transitory 250 icmp 90
1711 * To reset default values use:
1712 * vpp# set nat timeout reset
1715 VLIB_CLI_COMMAND (set_timeout_command, static) = {
1716 .path = "set nat timeout",
1717 .function = set_timeout_command_fn,
1719 "set nat timeout [udp <sec> | tcp-established <sec> "
1720 "tcp-transitory <sec> | icmp <sec> | reset]",
1725 * @cliexstart{show nat timeouts}
1726 * Show values of timeouts for NAT sessions.
1727 * vpp# show nat timeouts
1728 * udp timeout: 300sec
1729 * tcp-established timeout: 7440sec
1730 * tcp-transitory timeout: 240sec
1731 * icmp timeout: 60sec
1734 VLIB_CLI_COMMAND (nat_show_timeouts_command, static) = {
1735 .path = "show nat timeouts",
1736 .short_help = "show nat timeouts",
1737 .function = nat_show_timeouts_command_fn,
1742 * @cliexstart{set nat frame-queue-nelts}
1743 * Set number of worker handoff frame queue elements.
1746 VLIB_CLI_COMMAND (set_frame_queue_nelts_command, static) = {
1747 .path = "set nat frame-queue-nelts",
1748 .function = set_frame_queue_nelts_command_fn,
1749 .short_help = "set nat frame-queue-nelts <number>",
1754 * @cliexstart{nat set logging level}
1755 * To set NAT logging level use:
1756 * Set nat logging level
1759 VLIB_CLI_COMMAND (snat_set_log_level_command, static) = {
1760 .path = "nat set logging level",
1761 .function = snat_set_log_level_command_fn,
1762 .short_help = "nat set logging level <level>",
1767 * @cliexstart{snat ipfix logging}
1768 * To enable NAT IPFIX logging use:
1769 * vpp# nat ipfix logging
1770 * To set IPFIX exporter use:
1771 * vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1
1774 VLIB_CLI_COMMAND (snat_ipfix_logging_enable_disable_command, static) = {
1775 .path = "nat ipfix logging",
1776 .function = snat_ipfix_logging_enable_disable_command_fn,
1777 .short_help = "nat ipfix logging disable|<enable [domain <domain-id>] "
1778 "[src-port <port>]>",
1783 * @cliexstart{nat mss-clamping}
1784 * Set TCP MSS rewriting configuration
1785 * To enable TCP MSS rewriting use:
1786 * vpp# nat mss-clamping 1452
1787 * To disbale TCP MSS rewriting use:
1788 * vpp# nat mss-clamping disable
1791 VLIB_CLI_COMMAND (nat_set_mss_clamping_command, static) = {
1792 .path = "nat mss-clamping",
1793 .short_help = "nat mss-clamping <mss-value>|disable",
1794 .function = nat_set_mss_clamping_command_fn,
1799 * @cliexstart{show nat mss-clamping}
1800 * Show TCP MSS rewriting configuration
1803 VLIB_CLI_COMMAND (nat_show_mss_clamping_command, static) = {
1804 .path = "show nat mss-clamping",
1805 .short_help = "show nat mss-clamping",
1806 .function = nat_show_mss_clamping_command_fn,
1811 * @cliexstart{show nat44 hash tables}
1812 * Show NAT44 hash tables
1815 VLIB_CLI_COMMAND (nat44_show_hash, static) = {
1816 .path = "show nat44 hash tables",
1817 .short_help = "show nat44 hash tables [detail|verbose]",
1818 .function = nat44_show_hash_command_fn,
1823 * @cliexstart{nat44 add address}
1824 * Add/delete NAT44 pool address.
1825 * To add NAT44 pool address use:
1826 * vpp# nat44 add address 172.16.1.3
1827 * vpp# nat44 add address 172.16.2.2 - 172.16.2.24
1828 * To add NAT44 pool address for specific tenant (identified by VRF id) use:
1829 * vpp# nat44 add address 172.16.1.3 tenant-vrf 10
1832 VLIB_CLI_COMMAND (add_address_command, static) = {
1833 .path = "nat44 add address",
1834 .short_help = "nat44 add address <ip4-range-start> [- <ip4-range-end>] "
1835 "[tenant-vrf <vrf-id>] [twice-nat] [del]",
1836 .function = add_address_command_fn,
1841 * @cliexstart{show nat44 summary}
1842 * Show NAT44 summary
1843 * vpp# show nat44 summary
1846 VLIB_CLI_COMMAND (nat44_show_summary_command, static) = {
1847 .path = "show nat44 summary",
1848 .short_help = "show nat44 summary",
1849 .function = nat44_show_summary_command_fn,
1854 * @cliexstart{show nat44 addresses}
1855 * Show NAT44 pool addresses.
1856 * vpp# show nat44 addresses
1857 * NAT44 pool addresses:
1859 * tenant VRF independent
1868 * NAT44 twice-nat pool addresses:
1870 * tenant VRF independent
1876 VLIB_CLI_COMMAND (nat44_show_addresses_command, static) = {
1877 .path = "show nat44 addresses",
1878 .short_help = "show nat44 addresses",
1879 .function = nat44_show_addresses_command_fn,
1884 * @cliexstart{set interface nat44}
1885 * Enable/disable NAT44 feature on the interface.
1886 * To enable NAT44 feature with local network interface use:
1887 * vpp# set interface nat44 in GigabitEthernet0/8/0
1888 * To enable NAT44 feature with external network interface use:
1889 * vpp# set interface nat44 out GigabitEthernet0/a/0
1892 VLIB_CLI_COMMAND (set_interface_snat_command, static) = {
1893 .path = "set interface nat44",
1894 .function = snat_feature_command_fn,
1895 .short_help = "set interface nat44 in <intfc> out <intfc> [output-feature] "
1901 * @cliexstart{show nat44 interfaces}
1902 * Show interfaces with NAT44 feature.
1903 * vpp# show nat44 interfaces
1905 * GigabitEthernet0/8/0 in
1906 * GigabitEthernet0/a/0 out
1909 VLIB_CLI_COMMAND (nat44_show_interfaces_command, static) = {
1910 .path = "show nat44 interfaces",
1911 .short_help = "show nat44 interfaces",
1912 .function = nat44_show_interfaces_command_fn,
1917 * @cliexstart{nat44 add static mapping}
1918 * Static mapping allows hosts on the external network to initiate connection
1919 * to to the local network host.
1920 * To create static mapping between local host address 10.0.0.3 port 6303 and
1921 * external address 4.4.4.4 port 3606 for TCP protocol use:
1922 * vpp# nat44 add static mapping tcp local 10.0.0.3 6303 external 4.4.4.4 3606
1923 * If not runnig "static mapping only" NAT plugin mode use before:
1924 * vpp# nat44 add address 4.4.4.4
1925 * To create address only static mapping between local and external address use:
1926 * vpp# nat44 add static mapping local 10.0.0.3 external 4.4.4.4
1927 * To create ICMP static mapping between local and external with ICMP echo
1928 * identifier 10 use:
1929 * vpp# nat44 add static mapping icmp local 10.0.0.3 10 external 4.4.4.4 10
1930 * To force use of specific pool address, vrf independent
1931 * vpp# nat44 add static mapping local 10.0.0.2 1234 external 10.0.2.2 1234 twice-nat exact 10.0.1.2
1934 VLIB_CLI_COMMAND (add_static_mapping_command, static) = {
1935 .path = "nat44 add static mapping",
1936 .function = add_static_mapping_command_fn,
1938 "nat44 add static mapping tcp|udp|icmp local <addr> [<port|icmp-echo-id>] "
1939 "external <addr> [<port|icmp-echo-id>] [vrf <table-id>] [twice-nat|self-twice-nat] "
1940 "[out2in-only] [exact <pool-addr>] [del]",
1945 * @cliexstart{nat44 add identity mapping}
1946 * Identity mapping translate an IP address to itself.
1947 * To create identity mapping for address 10.0.0.3 port 6303 for TCP protocol
1949 * vpp# nat44 add identity mapping 10.0.0.3 tcp 6303
1950 * To create identity mapping for address 10.0.0.3 use:
1951 * vpp# nat44 add identity mapping 10.0.0.3
1952 * To create identity mapping for DHCP addressed interface use:
1953 * vpp# nat44 add identity mapping external GigabitEthernet0/a/0 tcp 3606
1956 VLIB_CLI_COMMAND (add_identity_mapping_command, static) = {
1957 .path = "nat44 add identity mapping",
1958 .function = add_identity_mapping_command_fn,
1959 .short_help = "nat44 add identity mapping <ip4-addr>|external <interface> "
1960 "[<protocol> <port>] [vrf <table-id>] [del]",
1965 * @cliexstart{nat44 add load-balancing static mapping}
1966 * Service load balancing using NAT44
1967 * To add static mapping with load balancing for service with external IP
1968 * address 1.2.3.4 and TCP port 80 and mapped to 2 local servers
1969 * 10.100.10.10:8080 and 10.100.10.20:8080 with probability 80% resp. 20% use:
1970 * 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
1973 VLIB_CLI_COMMAND (add_lb_static_mapping_command, static) = {
1974 .path = "nat44 add load-balancing static mapping",
1975 .function = add_lb_static_mapping_command_fn,
1977 "nat44 add load-balancing static mapping protocol tcp|udp "
1978 "external <addr>:<port> local <addr>:<port> [vrf <table-id>] "
1979 "probability <n> [twice-nat|self-twice-nat] [out2in-only] "
1980 "[affinity <timeout-seconds>] [del]",
1985 * @cliexstart{nat44 add load-balancing static mapping}
1986 * Modify service load balancing using NAT44
1987 * To add new back-end server 10.100.10.30:8080 for service load balancing
1988 * static mapping with external IP address 1.2.3.4 and TCP port 80 use:
1989 * vpp# nat44 add load-balancing back-end protocol tcp external 1.2.3.4:80 local 10.100.10.30:8080 probability 25
1992 VLIB_CLI_COMMAND (add_lb_backend_command, static) = {
1993 .path = "nat44 add load-balancing back-end",
1994 .function = add_lb_backend_command_fn,
1996 "nat44 add load-balancing back-end protocol tcp|udp "
1997 "external <addr>:<port> local <addr>:<port> [vrf <table-id>] "
1998 "probability <n> [del]",
2003 * @cliexstart{show nat44 static mappings}
2004 * Show NAT44 static mappings.
2005 * vpp# show nat44 static mappings
2006 * NAT44 static mappings:
2007 * local 10.0.0.3 external 4.4.4.4 vrf 0
2008 * tcp local 192.168.0.4:6303 external 4.4.4.3:3606 vrf 0
2009 * tcp vrf 0 external 1.2.3.4:80 out2in-only
2010 * local 10.100.10.10:8080 probability 80
2011 * local 10.100.10.20:8080 probability 20
2012 * tcp local 10.100.3.8:8080 external 169.10.10.1:80 vrf 0 twice-nat
2013 * tcp local 10.0.0.10:3603 external GigabitEthernet0/a/0:6306 vrf 10
2016 VLIB_CLI_COMMAND (nat44_show_static_mappings_command, static) = {
2017 .path = "show nat44 static mappings",
2018 .short_help = "show nat44 static mappings",
2019 .function = nat44_show_static_mappings_command_fn,
2024 * @cliexstart{nat44 add interface address}
2025 * Use NAT44 pool address from specific interfce
2026 * To add NAT44 pool address from specific interface use:
2027 * vpp# nat44 add interface address GigabitEthernet0/8/0
2030 VLIB_CLI_COMMAND (snat_add_interface_address_command, static) = {
2031 .path = "nat44 add interface address",
2032 .short_help = "nat44 add interface address <interface> [twice-nat] [del]",
2033 .function = snat_add_interface_address_command_fn,
2038 * @cliexstart{show nat44 interface address}
2039 * Show NAT44 pool address interfaces
2040 * vpp# show nat44 interface address
2041 * NAT44 pool address interfaces:
2042 * GigabitEthernet0/a/0
2043 * NAT44 twice-nat pool address interfaces:
2044 * GigabitEthernet0/8/0
2047 VLIB_CLI_COMMAND (nat44_show_interface_address_command, static) = {
2048 .path = "show nat44 interface address",
2049 .short_help = "show nat44 interface address",
2050 .function = nat44_show_interface_address_command_fn,
2055 * @cliexstart{show nat44 sessions}
2056 * Show NAT44 sessions.
2059 VLIB_CLI_COMMAND (nat44_show_sessions_command, static) = {
2060 .path = "show nat44 sessions",
2061 .short_help = "show nat44 sessions",
2062 .function = nat44_show_sessions_command_fn,
2067 * @cliexstart{set nat44 session limit}
2068 * Set NAT44 session limit.
2071 VLIB_CLI_COMMAND (nat44_set_session_limit_command, static) = {
2072 .path = "set nat44 session limit",
2073 .short_help = "set nat44 session limit <limit> [vrf <table-id>]",
2074 .function = nat44_set_session_limit_command_fn,
2079 * @cliexstart{nat44 del session}
2080 * To administratively delete NAT44 session by inside address and port use:
2081 * vpp# nat44 del session in 10.0.0.3:6303 tcp
2082 * To administratively delete NAT44 session by outside address and port use:
2083 * vpp# nat44 del session out 1.0.0.3:6033 udp
2086 VLIB_CLI_COMMAND (nat44_del_session_command, static) = {
2087 .path = "nat44 del session",
2088 .short_help = "nat44 del session in|out <addr>:<port> tcp|udp|icmp [vrf <id>] [external-host <addr>:<port>]",
2089 .function = nat44_del_session_command_fn,
2094 * @cliexstart{nat44 forwarding}
2095 * Enable or disable forwarding
2096 * Forward packets which don't match existing translation
2097 * or static mapping instead of dropping them.
2098 * To enable forwarding, use:
2099 * vpp# nat44 forwarding enable
2100 * To disable forwarding, use:
2101 * vpp# nat44 forwarding disable
2104 VLIB_CLI_COMMAND (snat_forwarding_set_command, static) = {
2105 .path = "nat44 forwarding",
2106 .short_help = "nat44 forwarding enable|disable",
2107 .function = snat_forwarding_set_command_fn,
2111 * fd.io coding-style-patch-verification: ON
2114 * eval: (c-set-style "gnu")