FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
src/plugins/nat/nat44-ed

nat ipfix logging

Summary/usage

nat ipfix logging disable|<enable [domain <domain-id>] [src-port <port>]>.

Description

Example usage
vpp# snat ipfix logging
To enable NAT IPFIX logging use:
 vpp# nat ipfix logging
To set IPFIX exporter use:
 vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1

Declaration and implementation

Declaration: snat_ipfix_logging_enable_disable_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1775)

Implementation: snat_ipfix_logging_enable_disable_command_fn.

nat mss-clamping

Summary/usage

nat mss-clamping <mss-value>|disable.

Description

Example usage
vpp# nat mss-clamping
Set TCP MSS rewriting configuration
To enable TCP MSS rewriting use:
 vpp# nat mss-clamping 1452
To disbale TCP MSS rewriting use:
 vpp# nat mss-clamping disable

Declaration and implementation

Declaration: nat_set_mss_clamping_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1792)

Implementation: nat_set_mss_clamping_command_fn.

nat set logging level

Summary/usage

nat set logging level <level>.

Description

Example usage
vpp# nat set logging level
To set NAT logging level use:
Set nat logging level

Declaration and implementation

Declaration: snat_set_log_level_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1760)

Implementation: snat_set_log_level_command_fn.

nat44

Summary/usage

nat44 <enable [sessions <max-number>] [static-mapping-only connection-tracking] [inside-vrf <vrf-id>] [outside-vrf <vrf-id>]>|disable.

Description

Example usage
vpp# nat44
Enable nat44 plugin
To enable nat44-ed, use:
 vpp# nat44 enable
To disable nat44-ed, use:
 vpp# nat44 disable
To enable nat44-ed static mapping with connection tracking, use:
 vpp# nat44-ed enable static-mapping connection-tracking
To set inside-vrf outside-vrf, use:
 vpp# nat44 enable inside-vrf <id> outside-vrf <id>

Declaration and implementation

Declaration: nat44_ed_enable_disable_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1670)

Implementation: nat44_ed_enable_disable_command_fn.

nat44 add address

Summary/usage

nat44 add address &lt;ip4-range-start&gt; [- &lt;ip4-range-end&gt;] [tenant-vrf &lt;vrf-id&gt;] [twice-nat] [del].

Description

Example usage
vpp# nat44 add address
Add/delete NAT44 pool address.
To add NAT44 pool address use:
 vpp# nat44 add address 172.16.1.3
 vpp# nat44 add address 172.16.2.2 - 172.16.2.24
To add NAT44 pool address for specific tenant (identified by VRF id) use:
 vpp# nat44 add address 172.16.1.3 tenant-vrf 10

Declaration and implementation

Declaration: add_address_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1833)

Implementation: add_address_command_fn.

nat44 add identity mapping

Summary/usage

nat44 add identity mapping &lt;ip4-addr&gt;|external &lt;interface&gt; [&lt;protocol&gt; &lt;port&gt;] [vrf &lt;table-id&gt;] [del].

Description

Example usage
vpp# nat44 add identity mapping
Identity mapping translate an IP address to itself.
To create identity mapping for address 10.0.0.3 port 6303 for TCP protocol
use:
 vpp# nat44 add identity mapping 10.0.0.3 tcp 6303
To create identity mapping for address 10.0.0.3 use:
 vpp# nat44 add identity mapping 10.0.0.3
To create identity mapping for DHCP addressed interface use:
 vpp# nat44 add identity mapping external GigabitEthernet0/a/0 tcp 3606

Declaration and implementation

Declaration: add_identity_mapping_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1957)

Implementation: add_identity_mapping_command_fn.

nat44 add interface address

Summary/usage

nat44 add interface address &lt;interface&gt; [twice-nat] [del].

Description

Example usage
vpp# nat44 add interface address
Use NAT44 pool address from specific interfce
To add NAT44 pool address from specific interface use:
 vpp# nat44 add interface address GigabitEthernet0/8/0

Declaration and implementation

Declaration: snat_add_interface_address_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 2031)

Implementation: snat_add_interface_address_command_fn.

nat44 add load-balancing back-end

Summary/usage

nat44 add load-balancing back-end protocol tcp|udp external &lt;addr&gt;:&lt;port&gt; local &lt;addr&gt;:&lt;port&gt; [vrf &lt;table-id&gt;] probability &lt;n&gt; [del].

Description

Example usage
vpp# nat44 add load-balancing static mapping
Modify service load balancing using NAT44
To add new back-end server 10.100.10.30:8080 for service load balancing
static mapping with external IP address 1.2.3.4 and TCP port 80 use:
 vpp# nat44 add load-balancing back-end protocol tcp external 1.2.3.4:80 local 10.100.10.30:8080 probability 25

Declaration and implementation

Declaration: add_lb_backend_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1993)

Implementation: add_lb_backend_command_fn.

nat44 add load-balancing static mapping

Summary/usage

nat44 add load-balancing static mapping protocol tcp|udp external &lt;addr&gt;:&lt;port&gt; local &lt;addr&gt;:&lt;port&gt; [vrf &lt;table-id&gt;] probability &lt;n&gt; [twice-nat|self-twice-nat] [out2in-only] [affinity &lt;timeout-seconds&gt;] [del].

Description

Example usage
vpp# nat44 add load-balancing static mapping
Service load balancing using NAT44
To add static mapping with load balancing for service with external IP
address 1.2.3.4 and TCP port 80 and mapped to 2 local servers
10.100.10.10:8080 and 10.100.10.20:8080 with probability 80% resp. 20% use:
 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

Declaration and implementation

Declaration: add_lb_static_mapping_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1974)

Implementation: add_lb_static_mapping_command_fn.

nat44 add static mapping

Summary/usage

nat44 add static mapping tcp|udp|icmp local &lt;addr&gt; [&lt;port|icmp-echo-id&gt;] external &lt;addr&gt; [&lt;port|icmp-echo-id&gt;] [vrf &lt;table-id&gt;] [twice-nat|self-twice-nat] [out2in-only] [exact &lt;pool-addr&gt;] [del].

Description

Example usage
vpp# nat44 add static mapping
Static mapping allows hosts on the external network to initiate connection
to to the local network host.
To create static mapping between local host address 10.0.0.3 port 6303 and
external address 4.4.4.4 port 3606 for TCP protocol use:
 vpp# nat44 add static mapping tcp local 10.0.0.3 6303 external 4.4.4.4 3606
If not runnig &#34;static mapping only&#34; NAT plugin mode use before:
 vpp# nat44 add address 4.4.4.4
To create address only static mapping between local and external address use:
 vpp# nat44 add static mapping local 10.0.0.3 external 4.4.4.4
To create ICMP static mapping between local and external with ICMP echo
identifier 10 use:
 vpp# nat44 add static mapping icmp local 10.0.0.3 10 external 4.4.4.4 10
To force use of specific pool address, vrf independent
 vpp# nat44 add static mapping local 10.0.0.2 1234 external 10.0.2.2 1234 twice-nat exact 10.0.1.2

Declaration and implementation

Declaration: add_static_mapping_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1935)

Implementation: add_static_mapping_command_fn.

nat44 del session

Summary/usage

nat44 del session in|out &lt;addr&gt;:&lt;port&gt; tcp|udp|icmp [vrf &lt;id&gt;] [external-host &lt;addr&gt;:&lt;port&gt;].

Description

Example usage
vpp# nat44 del session
To administratively delete NAT44 session by inside address and port use:
 vpp# nat44 del session in 10.0.0.3:6303 tcp
To administratively delete NAT44 session by outside address and port use:
 vpp# nat44 del session out 1.0.0.3:6033 udp

Declaration and implementation

Declaration: nat44_del_session_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 2087)

Implementation: nat44_del_session_command_fn.

nat44 forwarding

Summary/usage

nat44 forwarding enable|disable.

Description

Example usage
vpp# nat44 forwarding
Enable or disable forwarding
Forward packets which don&#39;t match existing translation
or static mapping instead of dropping them.
To enable forwarding, use:
 vpp# nat44 forwarding enable
To disable forwarding, use:
 vpp# nat44 forwarding disable

Declaration and implementation

Declaration: snat_forwarding_set_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 2105)

Implementation: snat_forwarding_set_command_fn.

set interface nat44

Summary/usage

set interface nat44 in &lt;intfc&gt; out &lt;intfc&gt; [output-feature] [del].

Description

Example usage
vpp# set interface nat44
Enable/disable NAT44 feature on the interface.
To enable NAT44 feature with local network interface use:
 vpp# set interface nat44 in GigabitEthernet0/8/0
To enable NAT44 feature with external network interface use:
 vpp# set interface nat44 out GigabitEthernet0/a/0

Declaration and implementation

Declaration: set_interface_snat_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1893)

Implementation: snat_feature_command_fn.

set nat frame-queue-nelts

Summary/usage

set nat frame-queue-nelts &lt;number&gt;.

Description

Example usage
vpp# set nat frame-queue-nelts
Set number of worker handoff frame queue elements.

Declaration and implementation

Declaration: set_frame_queue_nelts_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1747)

Implementation: set_frame_queue_nelts_command_fn.

set nat timeout

Summary/usage

set nat timeout [udp &lt;sec&gt; | tcp-established &lt;sec&gt; tcp-transitory &lt;sec&gt; | icmp &lt;sec&gt; | reset].

Description

Example usage
vpp# set nat timeout
Set values of timeouts for NAT sessions (in seconds), use:
 vpp# set nat timeout udp 120 tcp-established 7500 tcp-transitory 250 icmp 90
To reset default values use:
 vpp# set nat timeout reset

Declaration and implementation

Declaration: set_timeout_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1716)

Implementation: set_timeout_command_fn.

set nat workers

Summary/usage

set nat workers &lt;workers-list&gt;.

Description

Example usage
vpp# set snat workers
Set NAT workers if 2 or more workers available, use:
 vpp# set snat workers 0-2,5

Declaration and implementation

Declaration: set_workers_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1685)

Implementation: set_workers_command_fn.

set nat44 session limit

Summary/usage

set nat44 session limit &lt;limit&gt; [vrf &lt;table-id&gt;].

Description

Example usage
vpp# set nat44 session limit
Set NAT44 session limit.

Declaration and implementation

Declaration: nat44_set_session_limit_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 2072)

Implementation: nat44_set_session_limit_command_fn.

show nat mss-clamping

Summary/usage

show nat mss-clamping.

Description

Example usage
vpp# show nat mss-clamping
Show TCP MSS rewriting configuration

Declaration and implementation

Declaration: nat_show_mss_clamping_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1804)

Implementation: nat_show_mss_clamping_command_fn.

show nat timeouts

Summary/usage

show nat timeouts.

Description

Example usage
vpp# show nat timeouts
Show values of timeouts for NAT sessions.
vpp# show nat timeouts
udp timeout: 300sec
tcp-established timeout: 7440sec
tcp-transitory timeout: 240sec
icmp timeout: 60sec

Declaration and implementation

Declaration: nat_show_timeouts_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1735)

Implementation: nat_show_timeouts_command_fn.

show nat workers

Summary/usage

show nat workers.

Description

Example usage
vpp# show nat workers
Show NAT workers.
 vpp# show nat workers:
 2 workers
   vpp_wk_0
   vpp_wk_1

Declaration and implementation

Declaration: nat_show_workers_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1701)

Implementation: nat_show_workers_commnad_fn.

show nat44 addresses

Summary/usage

show nat44 addresses.

Description

Example usage
vpp# show nat44 addresses
Show NAT44 pool addresses.
vpp# show nat44 addresses
NAT44 pool addresses:
172.16.2.2
  tenant VRF independent
  10 busy udp ports
  0 busy tcp ports
  0 busy icmp ports
172.16.1.3
  tenant VRF: 10
  0 busy udp ports
  2 busy tcp ports
  0 busy icmp ports
NAT44 twice-nat pool addresses:
10.20.30.72
  tenant VRF independent
  0 busy udp ports
  0 busy tcp ports
  0 busy icmp ports

Declaration and implementation

Declaration: nat44_show_addresses_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1877)

Implementation: nat44_show_addresses_command_fn.

show nat44 hash tables

Summary/usage

show nat44 hash tables [detail|verbose].

Description

Example usage
vpp# show nat44 hash tables
Show NAT44 hash tables

Declaration and implementation

Declaration: nat44_show_hash (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1816)

Implementation: nat44_show_hash_command_fn.

show nat44 interface address

Summary/usage

show nat44 interface address.

Description

Example usage
vpp# show nat44 interface address
Show NAT44 pool address interfaces
vpp# show nat44 interface address
NAT44 pool address interfaces:
 GigabitEthernet0/a/0
NAT44 twice-nat pool address interfaces:
 GigabitEthernet0/8/0

Declaration and implementation

Declaration: nat44_show_interface_address_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 2048)

Implementation: nat44_show_interface_address_command_fn.

show nat44 interfaces

Summary/usage

show nat44 interfaces.

Description

Example usage
vpp# show nat44 interfaces
Show interfaces with NAT44 feature.
vpp# show nat44 interfaces
NAT44 interfaces:
 GigabitEthernet0/8/0 in
 GigabitEthernet0/a/0 out

Declaration and implementation

Declaration: nat44_show_interfaces_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1910)

Implementation: nat44_show_interfaces_command_fn.

show nat44 sessions

Summary/usage

show nat44 sessions.

Description

Example usage
vpp# show nat44 sessions
Show NAT44 sessions.

Declaration and implementation

Declaration: nat44_show_sessions_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 2060)

Implementation: nat44_show_sessions_command_fn.

show nat44 static mappings

Summary/usage

show nat44 static mappings.

Description

Example usage
vpp# show nat44 static mappings
Show NAT44 static mappings.
vpp# show nat44 static mappings
NAT44 static mappings:
 local 10.0.0.3 external 4.4.4.4 vrf 0
 tcp local 192.168.0.4:6303 external 4.4.4.3:3606 vrf 0
 tcp vrf 0 external 1.2.3.4:80  out2in-only
  local 10.100.10.10:8080 probability 80
  local 10.100.10.20:8080 probability 20
 tcp local 10.100.3.8:8080 external 169.10.10.1:80 vrf 0 twice-nat
 tcp local 10.0.0.10:3603 external GigabitEthernet0/a/0:6306 vrf 10

Declaration and implementation

Declaration: nat44_show_static_mappings_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 2017)

Implementation: nat44_show_static_mappings_command_fn.

show nat44 summary

Summary/usage

show nat44 summary.

Description

Example usage
vpp# show nat44 summary
Show NAT44 summary
vpp# show nat44 summary

Declaration and implementation

Declaration: nat44_show_summary_command (src/plugins/nat/nat44-ed/nat44_ed_cli.c line 1847)

Implementation: nat44_show_summary_command_fn.