FD.io VPP  v20.05.1-5-g09f167997
Vector Packet Processing
nat.api File Reference

VPP control-plane API messages. More...

Go to the source code of this file.

Data Structures

struct  vl_api_nat_control_ping_t
 Control ping from client to api server request. More...
 
struct  vl_api_nat_control_ping_reply_t
 Control ping from the client to the server response. More...
 
struct  vl_api_nat_show_config_t
 Show NAT plugin startup config. More...
 
struct  vl_api_nat_show_config_reply_t
 Show NAT plugin startup config reply. More...
 
struct  vl_api_nat44_session_cleanup_t
 Run nat44 garbage collection. More...
 
struct  vl_api_nat44_set_session_limit_t
 NAT44 set session limit. More...
 
struct  vl_api_nat_set_log_level_t
 Set NAT logging level. More...
 
struct  vl_api_nat_set_workers_t
 Set NAT workers. More...
 
struct  vl_api_nat_worker_dump_t
 Dump NAT workers. More...
 
struct  vl_api_nat_worker_details_t
 NAT workers details response. More...
 
struct  vl_api_nat_ipfix_enable_disable_t
 Enable/disable NAT IPFIX logging. More...
 
struct  vl_api_nat_set_timeouts_t
 Set values of timeouts for NAT sessions (seconds) More...
 
struct  vl_api_nat_get_timeouts_t
 Get values of timeouts for NAT sessions (seconds) More...
 
struct  vl_api_nat_get_timeouts_reply_t
 Get values of timeouts for NAT sessions reply. More...
 
struct  vl_api_nat_set_addr_and_port_alloc_alg_t
 Set address and port assignment algorithm. More...
 
struct  vl_api_nat_get_addr_and_port_alloc_alg_t
 Get address and port assignment algorithm. More...
 
struct  vl_api_nat_get_addr_and_port_alloc_alg_reply_t
 Get address and port assignment algorithm reply. More...
 
struct  vl_api_nat_set_mss_clamping_t
 Set TCP MSS rewriting configuration. More...
 
struct  vl_api_nat_get_mss_clamping_t
 Get TCP MSS rewriting configuration. More...
 
struct  vl_api_nat_get_mss_clamping_reply_t
 Get TCP MSS rewriting configuration reply. More...
 
struct  vl_api_nat_ha_set_listener_t
 Set HA listener (local settings) More...
 
struct  vl_api_nat_ha_set_failover_t
 Set HA failover (remote settings) More...
 
struct  vl_api_nat_ha_get_listener_t
 Get HA listener/local configuration. More...
 
struct  vl_api_nat_ha_get_listener_reply_t
 Get HA listener/local configuration reply. More...
 
struct  vl_api_nat_ha_get_failover_t
 Get HA failover/remote settings. More...
 
struct  vl_api_nat_ha_get_failover_reply_t
 Get HA failover/remote settings reply. More...
 
struct  vl_api_nat_ha_flush_t
 Flush the current HA data (for testing) More...
 
struct  vl_api_nat_ha_resync_t
 Resync HA (resend existing sessions to new failover) More...
 
struct  vl_api_nat_ha_resync_completed_event_t
 Tell client about a HA resync completion event. More...
 
struct  vl_api_nat44_del_user_t
 Del NAT44 user. More...
 
struct  vl_api_nat44_add_del_address_range_t
 Add/del NAT44 address range. More...
 
struct  vl_api_nat44_address_dump_t
 Dump NAT44 addresses. More...
 
struct  vl_api_nat44_address_details_t
 NAT44 address details response. More...
 
struct  vl_api_nat44_interface_add_del_feature_t
 Enable/disable NAT44 feature on the interface. More...
 
struct  vl_api_nat44_interface_dump_t
 Dump interfaces with NAT44 feature. More...
 
struct  vl_api_nat44_interface_details_t
 NAT44 interface details response. More...
 
struct  vl_api_nat44_interface_add_del_output_feature_t
 Enable/disbale NAT44 as an interface output feature (postrouting in2out translation) More...
 
struct  vl_api_nat44_interface_output_feature_dump_t
 Dump interfaces with NAT44 output feature. More...
 
struct  vl_api_nat44_interface_output_feature_details_t
 NAT44 interface with output feature details response. More...
 
struct  vl_api_nat44_add_del_static_mapping_t
 Add/delete NAT44 static mapping. More...
 
struct  vl_api_nat44_static_mapping_dump_t
 Dump NAT44 static mappings. More...
 
struct  vl_api_nat44_static_mapping_details_t
 NAT44 static mapping details response. More...
 
struct  vl_api_nat44_add_del_identity_mapping_t
 Add/delete NAT44 identity mapping. More...
 
struct  vl_api_nat44_identity_mapping_dump_t
 Dump NAT44 identity mappings. More...
 
struct  vl_api_nat44_identity_mapping_details_t
 NAT44 identity mapping details response. More...
 
struct  vl_api_nat44_add_del_interface_addr_t
 Add/delete NAT44 pool address from specific interfce. More...
 
struct  vl_api_nat44_interface_addr_dump_t
 Dump NAT44 pool addresses interfaces. More...
 
struct  vl_api_nat44_interface_addr_details_t
 NAT44 pool addresses interfaces details response. More...
 
struct  vl_api_nat44_user_dump_t
 Dump NAT44 users. More...
 
struct  vl_api_nat44_user_details_t
 NAT44 users response. More...
 
struct  vl_api_nat44_user_session_dump_t
 NAT44 user's sessions. More...
 
struct  vl_api_nat44_user_session_details_t
 NAT44 user's sessions response. More...
 
struct  vl_api_nat44_add_del_lb_static_mapping_t
 Add/delete NAT44 load-balancing static mapping rule. More...
 
struct  vl_api_nat44_lb_static_mapping_add_del_local_t
 Add/delete NAT44 load-balancing static mapping rule backend. More...
 
struct  vl_api_nat44_lb_static_mapping_dump_t
 Dump NAT44 load-balancing static mapping rules. More...
 
struct  vl_api_nat44_lb_static_mapping_details_t
 NAT44 load-balancing static mapping rule details response. More...
 
struct  vl_api_nat44_del_session_t
 Delete NAT44 session. More...
 
struct  vl_api_nat44_forwarding_enable_disable_t
 Enable/disable forwarding for NAT44 Forward packets which don't match existing translation or static mapping instead of dropping them. More...
 
struct  vl_api_nat44_forwarding_is_enabled_t
 Check if forwarding is enabled or disabled. More...
 
struct  vl_api_nat44_forwarding_is_enabled_reply_t
 Response to check if forwarding is enabled or disabled. More...
 
struct  vl_api_nat_det_add_del_map_t
 Add/delete NAT deterministic mapping. More...
 
struct  vl_api_nat_det_forward_t
 Get outside address and port range from inside address. More...
 
struct  vl_api_nat_det_forward_reply_t
 Get outside address and port range from inside address. More...
 
struct  vl_api_nat_det_reverse_t
 Get inside address from outside address and port. More...
 
struct  vl_api_nat_det_reverse_reply_t
 Get inside address from outside address and port reply. More...
 
struct  vl_api_nat_det_map_dump_t
 Dump NAT deterministic mappings. More...
 
struct  vl_api_nat_det_map_details_t
 NAT users response. More...
 
struct  vl_api_nat_det_close_session_out_t
 Close deterministic NAT session by outside address and port. More...
 
struct  vl_api_nat_det_close_session_in_t
 Close deterministic NAT session by inside address and port. More...
 
struct  vl_api_nat_det_session_dump_t
 Dump determinstic NAT sessions. More...
 
struct  vl_api_nat_det_session_details_t
 Deterministic NAT sessions reply. More...
 
struct  vl_api_nat64_add_del_pool_addr_range_t
 Add/delete address range to NAT64 pool. More...
 
struct  vl_api_nat64_pool_addr_dump_t
 Dump NAT64 pool addresses. More...
 
struct  vl_api_nat64_pool_addr_details_t
 NAT64 pool address details response. More...
 
struct  vl_api_nat64_add_del_interface_t
 Enable/disable NAT64 feature on the interface. More...
 
struct  vl_api_nat64_interface_dump_t
 Dump interfaces with NAT64 feature. More...
 
struct  vl_api_nat64_interface_details_t
 NAT64 interface details response. More...
 
struct  vl_api_nat64_add_del_static_bib_t
 Add/delete NAT64 static BIB entry. More...
 
struct  vl_api_nat64_bib_dump_t
 Dump NAT64 BIB. More...
 
struct  vl_api_nat64_bib_details_t
 NAT64 BIB details response. More...
 
struct  vl_api_nat64_st_dump_t
 Dump NAT64 session table. More...
 
struct  vl_api_nat64_st_details_t
 NAT64 session table details response. More...
 
struct  vl_api_nat64_add_del_prefix_t
 Add/del NAT64 prefix. More...
 
struct  vl_api_nat64_prefix_dump_t
 Dump NAT64 prefix. More...
 
struct  vl_api_nat64_prefix_details_t
 Dump NAT64 prefix details response. More...
 
struct  vl_api_nat64_add_del_interface_addr_t
 Add/delete NAT64 pool address from specific interfce. More...
 
struct  vl_api_nat66_add_del_interface_t
 Enable/disable NAT66 feature on the interface. More...
 
struct  vl_api_nat66_interface_dump_t
 Dump interfaces with NAT66 feature. More...
 
struct  vl_api_nat66_interface_details_t
 NAT66 interface details response. More...
 
struct  vl_api_nat66_add_del_static_mapping_t
 Add/delete 1:1 NAT66. More...
 
struct  vl_api_nat66_static_mapping_dump_t
 Dump NAT66 static mappings. More...
 
struct  vl_api_nat66_static_mapping_details_t
 NAT66 static mapping details response. More...
 

Enumerations

enum  nat_config_flags : u8 {
  NAT_IS_NONE = 0x00, NAT_IS_TWICE_NAT = 0x01, NAT_IS_SELF_TWICE_NAT = 0x02, NAT_IS_OUT2IN_ONLY = 0x04,
  NAT_IS_ADDR_ONLY = 0x08, NAT_IS_OUTSIDE = 0x10, NAT_IS_INSIDE = 0x20, NAT_IS_STATIC = 0x40,
  NAT_IS_EXT_HOST_VALID = 0x80
}
 
enum  nat_log_level : u8 {
  NAT_LOG_NONE = 0x00, NAT_LOG_ERROR = 0x01, NAT_LOG_WARNING = 0x02, NAT_LOG_NOTICE = 0x03,
  NAT_LOG_INFO = 0x04, NAT_LOG_DEBUG = 0x05
}
 

Variables

option version = "5.2.0"
 
import vnet ip ip_types api
 
 service
 
typedef nat44_lb_addr_port
 NAT44 load-balancing address and port pair. More...
 
u16 port
 
u8 probability
 
u32 vrf_id
 

Detailed Description

VPP control-plane API messages.

This file defines VPP control-plane API messages which are generally called through a shared memory interface.

Definition in file nat.api.

Enumeration Type Documentation

◆ nat_config_flags

Enumerator
NAT_IS_NONE 
NAT_IS_TWICE_NAT 
NAT_IS_SELF_TWICE_NAT 
NAT_IS_OUT2IN_ONLY 
NAT_IS_ADDR_ONLY 
NAT_IS_OUTSIDE 
NAT_IS_INSIDE 
NAT_IS_STATIC 
NAT_IS_EXT_HOST_VALID 

Definition at line 32 of file nat.api.

◆ nat_log_level

enum nat_log_level : u8
Enumerator
NAT_LOG_NONE 
NAT_LOG_ERROR 
NAT_LOG_WARNING 
NAT_LOG_NOTICE 
NAT_LOG_INFO 
NAT_LOG_DEBUG 

Definition at line 123 of file nat.api.

Variable Documentation

◆ api

import vnet interface_types api

Definition at line 17 of file nat.api.

◆ nat44_lb_addr_port

typedef nat44_lb_addr_port
Initial value:
{
vl_api_ip4_address_t addr
vhost_vring_addr_t addr
Definition: vhost_user.h:254

NAT44 load-balancing address and port pair.

Template Parameters
addr- IPv4 address of the internal node
port- L4 port number of the internal node
probability- probability of the internal node to be randomly matched
vrf_id- VRF id

Definition at line 852 of file nat.api.

◆ port

u16 port

Definition at line 854 of file nat.api.

◆ probability

u8 probability

Definition at line 855 of file nat.api.

◆ service

service
Initial value:
{
rpc nat_ha_resync returns nat_ha_resync_reply events nat_ha_resync_completed_event
int nat_ha_resync(u32 client_index, u32 pid, nat_ha_resync_event_cb_t event_callback)
Resync HA (resend existing sessions to new failover)

Definition at line 464 of file nat.api.

◆ version

option version = "5.2.0"

Definition at line 16 of file nat.api.

◆ vrf_id

u32 vrf_id

Definition at line 856 of file nat.api.