* limitations under the License.
*/
-vl_api_version 1.0.0
+option version = "4.0.0";
/**
* @file nat.api
*/
/*
- * Old "snat" APIs, will be deprecated after 17.10
+ * Common NAT plugin APIs
*/
-/** \brief Add/del NAT44 address range
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param first_ip_address - first IP address
- @param last_ip_address - last IP address
- @param vrf_id - VRF id of tenant, ~0 means independent of VRF
- @param is_add - 1 if add, 0 if delete
-*/
-autoreply define snat_add_address_range {
- u32 client_index;
- u32 context;
- u8 is_ip4;
- u8 first_ip_address[16];
- u8 last_ip_address[16];
- u32 vrf_id;
- u8 is_add;
-};
-
-/** \brief Dump NAT44 addresses
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
-*/
-define snat_address_dump {
- u32 client_index;
- u32 context;
-};
-
-/** \brief NAT44 address details response
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param ip_address - IP address
- @param vrf_id - VRF id of tenant, ~0 means independent of VRF
-*/
-define snat_address_details {
- u32 context;
- u8 is_ip4;
- u8 ip_address[16];
- u32 vrf_id;
-};
-
-/** \brief Enable/disable NAT44 feature on the interface
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_add - 1 if add, 0 if delete
- @param is_inside - 1 if inside, 0 if outside
- @param sw_if_index - software index of the interface
-*/
-autoreply define snat_interface_add_del_feature {
- u32 client_index;
- u32 context;
- u8 is_add;
- u8 is_inside;
- u32 sw_if_index;
-};
-
-/** \brief Dump interfaces with NAT44 feature
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
-*/
-define snat_interface_dump {
- u32 client_index;
- u32 context;
-};
-
-/** \brief NAT44 interface details response
- @param context - sender context, to match reply w/ request
- @param is_inside - 1 if inside, 0 if outside
- @param sw_if_index - software index of the interface
-*/
-define snat_interface_details {
- u32 context;
- u8 is_inside;
- u32 sw_if_index;
-};
-
-/** \brief Enable/disbale NAT44 as an interface output feature (postrouting
- in2out translation)
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_add - 1 if add, 0 if delete
- @param is_inside - 1 if inside, 0 if outside
- @param sw_if_index - software index of the interface
-*/
-autoreply define snat_interface_add_del_output_feature {
- u32 client_index;
- u32 context;
- u8 is_add;
- u8 is_inside;
- u32 sw_if_index;
-};
-
-/** \brief Dump interfaces with NAT44 output feature
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
-*/
-define snat_interface_output_feature_dump {
- u32 client_index;
- u32 context;
-};
-
-/** \brief NAT44 interface with output feature details response
- @param context - sender context, to match reply w/ request
- @param is_inside - 1 if inside, 0 if outside
- @param sw_if_index - software index of the interface
-*/
-define snat_interface_output_feature_details {
- u32 context;
- u8 is_inside;
- u32 sw_if_index;
-};
-
-/** \brief Add/delete NAT44 static mapping
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_add - 1 if add, 0 if delete
- @param is_ip4 - 1 if address type is IPv4
- @param addr_only - 1 if address only mapping
- @param local_ip_address - local IP address
- @param external_ip_address - external IP address
- @param protocol - IP protocol
- @param local_port - local port number
- @param external_port - external port number
- @param external_sw_if_index - external interface (if set
- external_ip_address is ignored, ~0 means not
- used)
- @param vfr_id - VRF ID
-*/
-autoreply define snat_add_static_mapping {
- u32 client_index;
- u32 context;
- u8 is_add;
- u8 is_ip4;
- u8 addr_only;
- u8 local_ip_address[16];
- u8 external_ip_address[16];
- u8 protocol;
- u16 local_port;
- u16 external_port;
- u32 external_sw_if_index;
- u32 vrf_id;
-};
-
-/** \brief Dump NAT44 static mappings
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
-*/
-define snat_static_mapping_dump {
- u32 client_index;
- u32 context;
-};
-
-/** \brief NAT44 static mapping details response
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param addr_only - 1 if address only mapping
- @param local_ip_address - local IP address
- @param external_ip_address - external IP address
- @param protocol - IP protocol
- @param local_port - local port number
- @param external_port - external port number
- @param external_sw_if_index - external interface
- @param vfr_id - VRF ID
-*/
-define snat_static_mapping_details {
- u32 context;
- u8 is_ip4;
- u8 addr_only;
- u8 local_ip_address[16];
- u8 external_ip_address[16];
- u8 protocol;
- u16 local_port;
- u16 external_port;
- u32 external_sw_if_index;
- u32 vrf_id;
-};
-
/** \brief Control ping from client to api server request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
-define snat_control_ping
+define nat_control_ping
{
u32 client_index;
u32 context;
@param retval - return code for the request
@param vpe_pid - the pid of the vpe, returned by the server
*/
-define snat_control_ping_reply
+define nat_control_ping_reply
{
u32 context;
i32 retval;
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
-define snat_show_config
+define nat_show_config
{
u32 client_index;
u32 context;
@param static_mapping_only - if 1 dynamic translations disabled
@param static_mapping_connection_tracking - if 1 create session data
@param deterministic - if 1 deterministic mapping
+ @param endpoint_dependent - if 1 endpoint-dependent mode
+ @param out2in_dpo - if 1 out2in dpo mode
@param translation_buckets - number of translation hash buckets
@param translation_memory_size - translation hash memory size
@param user_buckets - number of user hash buckets
@param max_translations_per_user - maximum number of translations per user
@param outside_vrf_id - outside VRF id
@param inside_vrf_id - default inside VRF id
+ @param dslite_ce - if DS-Lite is CE/B4 element, if 0 AFTR elemet
+ @param nat64_bib_buckets - number of NAT64 BIB hash buckets
+ @param nat64_bib_memory_size - memory size of NAT64 BIB hash
+ @param nat64_st_buckets - number of NAT64 session table hash buckets
+ @param nat64_st_memory_size - memory size of NAT64 session table hash
*/
-define snat_show_config_reply
+define nat_show_config_reply
{
u32 context;
i32 retval;
u8 static_mapping_only;
u8 static_mapping_connection_tracking;
u8 deterministic;
+ u8 endpoint_dependent;
+ u8 out2in_dpo;
u32 translation_buckets;
u32 translation_memory_size;
u32 user_buckets;
u32 max_translations_per_user;
u32 outside_vrf_id;
u32 inside_vrf_id;
+ u8 dslite_ce;
+ u32 nat64_bib_buckets;
+ u32 nat64_bib_memory_size;
+ u32 nat64_st_buckets;
+ u32 nat64_st_memory_size;
};
/** \brief Set NAT workers
@param context - sender context, to match reply w/ request
@param worker_mask - NAT workers mask
*/
-autoreply define snat_set_workers {
+autoreply define nat_set_workers {
u32 client_index;
u32 context;
u64 worker_mask;
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
-define snat_worker_dump {
+define nat_worker_dump {
u32 client_index;
u32 context;
};
@param lcore_id - lcore ID
@param name - worker name
*/
-define snat_worker_details {
+define nat_worker_details {
u32 context;
u32 worker_index;
u32 lcore_id;
u8 name[64];
};
-/** \brief Add/delete NAT44 pool address from specific interfce
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_add - 1 if add, 0 if delete
- @param sw_if_index - software index of the interface
-*/
-autoreply define snat_add_del_interface_addr {
- u32 client_index;
- u32 context;
- u8 is_add;
- u8 is_inside;
- u32 sw_if_index;
-};
-
-/** \brief Dump NAT44 pool addresses interfaces
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
-*/
-define snat_interface_addr_dump {
- u32 client_index;
- u32 context;
-};
-
-/** \brief NAT44 pool addresses interfaces details response
- @param context - sender context, to match reply w/ request
- @param sw_if_index - software index of the interface
-*/
-define snat_interface_addr_details {
- u32 context;
- u32 sw_if_index;
-};
-
/** \brief Enable/disable NAT IPFIX logging
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param src_port - source port number
@param enable - 1 if enable, 0 if disable
*/
-autoreply define snat_ipfix_enable_disable {
+autoreply define nat_ipfix_enable_disable {
u32 client_index;
u32 context;
u32 domain_id;
u8 enable;
};
-/** \brief Dump NAT44 users
+/** \brief Set NAT virtual fragmentation reassembly
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
+ @param timeout - reassembly timeout
+ @param max_reass - maximum number of concurrent reassemblies
+ @param max_frag - maximum number of fragmets per reassembly
+ @param drop_frag - if 0 translate fragments, otherwise drop fragments
+ @param is_ip6 - 1 if IPv6, 0 if IPv4
*/
-define snat_user_dump {
+autoreply define nat_set_reass {
u32 client_index;
u32 context;
+ u32 timeout;
+ u16 max_reass;
+ u8 max_frag;
+ u8 drop_frag;
+ u8 is_ip6;
};
-/** \brief NAT44 users response
- @param context - sender context, to match reply w/ request
- @vrf_id - VRF ID
- @param is_ip4 - 1 if address type is IPv4
- @param ip_adress - IP address
- @param nsessions - number of dynamic sessions
- @param nstaticsessions - number of static sessions
-*/
-define snat_user_details {
- u32 context;
- u32 vrf_id;
- u8 is_ip4;
- u8 ip_address[16];
- u32 nsessions;
- u32 nstaticsessions;
-};
-
-/** \brief NAT44 user's sessions
+/** \brief Get NAT virtual fragmentation reassembly configuration
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param user_ip - IP address of the user to dump
- @param vrf_id - VRF_ID
*/
-define snat_user_session_dump {
+define nat_get_reass {
u32 client_index;
u32 context;
- u8 is_ip4;
- u8 ip_address[16];
- u32 vrf_id;
};
-/** \brief NAT44 user's sessions response
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param outside_ip_address - outside IP address
- @param outside_port - outside port
- @param inside_ip_address - inside IP address
- @param inside_port - inside port
- @param protocol - protocol
- @param is_static - 1 if session is static
- @param last_heard - last heard timer
- @param total_bytes - count of bytes sent through session
- @param total_pkts - count of pakets sent through session
-*/
-define snat_user_session_details {
- u32 context;
- u8 is_ip4;
- u8 outside_ip_address[16];
- u16 outside_port;
- u8 inside_ip_address[16];
- u16 inside_port;
- u16 protocol;
- u8 is_static;
- u64 last_heard;
- u64 total_bytes;
- u32 total_pkts;
-};
-
-/** \brief Add/delete NAT deterministic mapping
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_add - 1 if add, 0 if delete
- @param is_ip4 - 1 if address type is IPv4
- @param in_addr - inside IP address
- @param in_plen - inside IP address prefix length
- @param out_addr - outside IP address
- @param out_addr - outside IP address prefix length
-*/
-autoreply define snat_add_det_map {
- u32 client_index;
- u32 context;
- u8 is_add;
- u8 is_ip4;
- u8 addr_only;
- u8 in_addr[16];
- u8 in_plen;
- u8 out_addr[16];
- u8 out_plen;
-};
-
-/** \brief Get outside address and port range from inside address
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param in_addr - inside IP address
-*/
-define snat_det_forward {
- u32 client_index;
- u32 context;
- u8 is_ip4;
- u8 in_addr[16];
-};
-
-/** \brief Get outside address and port range from inside address
- @param context - sender context, to match reply w/ request
- @param retval - return code
- @param out_port_lo - outside port range start
- @param out_port_hi - outside port range end
- @param is_ip4 - 1 if address type is IPv4
- @param out_addr - outside IP address
-*/
-define snat_det_forward_reply {
- u32 context;
- i32 retval;
- u16 out_port_lo;
- u16 out_port_hi;
- u8 is_ip4;
- u8 out_addr[16];
-};
-
-/** \brief Get inside address from outside address and port
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param out_port - outside port
- @param is_ip4 - 1 if address type is IPv4
- @param out_addr - outside IP address
-*/
-define snat_det_reverse {
- u32 client_index;
- u32 context;
- u16 out_port;
- u8 is_ip4;
- u8 out_addr[16];
-};
-
-/** \brief Get inside address from outside address and port reply
+/** \brief Get NAT virtual fragmentation reassembly configuration reply
@param context - sender context, to match reply w/ request
@param retval - return code
- @param is_ip4 - 1 if address type is IPv4
- @param in_addr - inside IP address
+ @param ip4_timeout - reassembly timeout
+ @param ip4_max_reass - maximum number of concurrent reassemblies
+ @param ip4_max_frag - maximum number of fragmets per reassembly
+ @param ip4_drop_frag - if 0 translate fragments, otherwise drop fragments
+ @param ip6_timeout - reassembly timeout
+ @param ip6_max_reass - maximum number of concurrent reassemblies
+ @param ip6_max_frag - maximum number of fragmets per reassembly
+ @param ip6_drop_frag - if 0 translate fragments, otherwise drop fragments
*/
-define snat_det_reverse_reply {
+define nat_get_reass_reply {
u32 context;
i32 retval;
- u8 is_ip4;
- u8 in_addr[16];
+ u32 ip4_timeout;
+ u16 ip4_max_reass;
+ u8 ip4_max_frag;
+ u8 ip4_drop_frag;
+ u32 ip6_timeout;
+ u16 ip6_max_reass;
+ u8 ip6_max_frag;
+ u8 ip6_drop_frag;
};
-/** \brief Dump NAT deterministic mappings
+/** \brief Dump NAT virtual fragmentation reassemblies
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
-define snat_det_map_dump {
+define nat_reass_dump {
u32 client_index;
u32 context;
};
-/** \brief NAT users response
+/** \brief NAT virtual fragmentation reassemblies response
@param context - sender context, to match reply w/ request
@param is_ip4 - 1 if address type is IPv4
- @param in_addr - inside IP address
- @param in_plen - inside IP address prefix length
- @param out_addr - outside IP address
- @param out_plen - outside IP address prefix length
- @param sharing_ratio - outside to inside address sharing ratio
- @param ports_per_host - number of ports available to a host
- @param ses_num - number of sessions belonging to this mapping
+ @param src_addr - source IP address
+ @param dst_addr - destination IP address
+ @param frag_id - fragment ID
+ @param proto - protocol
+ @param frag_n - number of cached fragments
*/
-define snat_det_map_details {
+define nat_reass_details {
u32 context;
u8 is_ip4;
- u8 in_addr[16];
- u8 in_plen;
- u8 out_addr[16];
- u8 out_plen;
- u32 sharing_ratio;
- u16 ports_per_host;
- u32 ses_num;
+ u8 src_addr[16];
+ u8 dst_addr[16];
+ u32 frag_id;
+ u8 proto;
+ u8 frag_n;
};
-/** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
+/** \brief Set values of timeouts for NAT sessions (seconds)
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param udp - UDP timeout (default 300sec)
@param tcp_transitory - TCP transitory timeout (default 240sec)
@param icmp - ICMP timeout (default 60sec)
*/
-autoreply define snat_det_set_timeouts {
+autoreply define nat_set_timeouts {
u32 client_index;
u32 context;
u32 udp;
u32 icmp;
};
-/** \brief Get values of timeouts for deterministic NAT (seconds)
+/** \brief Get values of timeouts for NAT sessions (seconds)
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
-define snat_det_get_timeouts {
+define nat_get_timeouts {
u32 client_index;
u32 context;
};
-/** \brief Get values of timeouts for deterministic NAT reply
+/** \brief Get values of timeouts for NAT sessions reply
@param context - sender context, to match reply w/ request
@param retval - return code
- @param udp - UDP timeout (default 300sec)
- @param tcp_established - TCP established timeout (default 7440sec)
- @param tcp_transitory - TCP transitory timeout (default 240sec)
- @param icmp - ICMP timeout (default 60sec)
+ @param udp - UDP timeout
+ @param tcp_established - TCP established timeout
+ @param tcp_transitory - TCP transitory timeout
+ @param icmp - ICMP timeout
*/
-define snat_det_get_timeouts_reply {
+define nat_get_timeouts_reply {
u32 context;
i32 retval;
u32 udp;
u32 icmp;
};
-/** \brief Close deterministic NAT session by outside address and port
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param out_addr - outside IP address
- @param out_port - outside port
- @param ext_addr - external host address
- @param ext_port - external host port
-*/
-autoreply define snat_det_close_session_out {
- u32 client_index;
- u32 context;
- u8 is_ip4;
- u8 out_addr[16];
- u16 out_port;
- u8 ext_addr[16];
- u16 ext_port;
-};
-
-/** \brief Close deterministic NAT session by inside address and port
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param in_addr - inside IP address
- @param in_port - inside port
- @param ext_addr - external host address
- @param ext_port - external host port
-*/
-autoreply define snat_det_close_session_in {
- u32 client_index;
- u32 context;
- u8 is_ip4;
- u8 in_addr[16];
- u16 in_port;
- u8 ext_addr[16];
- u16 ext_port;
-};
-
-/** \brief Dump determinstic NAT sessions
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param user_addr - address of an inside user whose sessions to dump
-*/
-define snat_det_session_dump {
- u32 client_index;
- u32 context;
- u8 is_ip4;
- u8 user_addr[16];
-};
-
-/** \brief Deterministic NAT sessions reply
- @param context - sender context, to match reply w/ request
- @param is_ip4 - 1 if address type is IPv4
- @param in_port - inside port
- @param ext_addr - external host address
- @param ext_port - external host port
- @param out_port - outside NAT port
- @param state - session state
- @param expire - session expiration timestamp
-*/
-define snat_det_session_details {
- u32 client_index;
- u32 context;
- u8 is_ip4;
- u16 in_port;
- u8 ext_addr[16];
- u16 ext_port;
- u16 out_port;
- u8 state;
- u32 expire;
-};
-
-/*
- * Common NAT plugin APIs
- */
-
-/** \brief Control ping from client to api server request
+/** \brief Set address and port assignment algorithm
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
+ @param alg - address and port assignment algorithm:
+ 0 - default, 1 - MAP-E, 2 - port range
+ (see nat_addr_and_port_alloc_alg_t in nat.h)
+ @param psid_offset - number of offset bits (valid only for MAP-E alg)
+ @param psid_length - length of PSID (valid only for MAP-E alg)
+ @param psid - Port Set Identifier (PSID) value (valid only for MAP-E alg)
+ @param start_port - beginning of the port range
+ @param end_port - end of the port range
*/
-define nat_control_ping
-{
+autoreply define nat_set_addr_and_port_alloc_alg {
u32 client_index;
u32 context;
+ u8 alg;
+ u8 psid_offset;
+ u8 psid_length;
+ u16 psid;
+ u16 start_port;
+ u16 end_port;
};
-/** \brief Control ping from the client to the server response
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param retval - return code for the request
- @param vpe_pid - the pid of the vpe, returned by the server
-*/
-define nat_control_ping_reply
-{
- u32 context;
- i32 retval;
- u32 client_index;
- u32 vpe_pid;
-};
-
-/** \brief Show NAT plugin startup config
+/** \brief Get address and port assignment algorithm
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
-define nat_show_config
-{
+define nat_get_addr_and_port_alloc_alg {
u32 client_index;
u32 context;
};
-/** \brief Show NAT plugin startup config reply
+/** \brief Get address and port assignment algorithm reply
@param context - sender context, to match reply w/ request
- @param retval - return code for the request
- @param static_mapping_only - if 1 dynamic translations disabled
- @param static_mapping_connection_tracking - if 1 create session data
- @param deterministic - if 1 deterministic mapping
- @param translation_buckets - number of translation hash buckets
- @param translation_memory_size - translation hash memory size
- @param user_buckets - number of user hash buckets
- @param user_memory_size - user hash memory size
- @param max_translations_per_user - maximum number of translations per user
- @param outside_vrf_id - outside VRF id
- @param inside_vrf_id - default inside VRF id
+ @param retval - return code
+ @param alg - address and port assignment algorithm:
+ 0 - default, 1 - MAP-E, 2 - port range
+ (see nat_addr_and_port_alloc_alg_t in nat.h)
+ @param psid_offset - number of offset bits (valid only for MAP-E alg)
+ @param psid_length - length of PSID (valid only for MAP-E alg)
+ @param psid - Port Set Identifier (PSID) value (valid only for MAP-E alg)
+ @param start_port - beginning of the port range
+ @param end_port - end of the port range
*/
-define nat_show_config_reply
-{
+define nat_get_addr_and_port_alloc_alg_reply {
u32 context;
i32 retval;
- u8 static_mapping_only;
- u8 static_mapping_connection_tracking;
- u8 deterministic;
- u32 translation_buckets;
- u32 translation_memory_size;
- u32 user_buckets;
- u32 user_memory_size;
- u32 max_translations_per_user;
- u32 outside_vrf_id;
- u32 inside_vrf_id;
+ u8 alg;
+ u8 psid_offset;
+ u8 psid_length;
+ u16 psid;
+ u16 start_port;
+ u16 end_port;
};
-/** \brief Set NAT workers
+/** \brief Set TCP MSS rewriting configuration
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param worker_mask - NAT workers mask
+ @param mss_value - MSS value to be used for MSS rewriting
+ @param enable - disable(0)/enable(1) MSS rewriting feature
*/
-autoreply define nat_set_workers {
+autoreply define nat_set_mss_clamping {
u32 client_index;
u32 context;
- u64 worker_mask;
+ u16 mss_value;
+ u8 enable;
};
-/** \brief Dump NAT workers
+/** \brief Get TCP MSS rewriting configuration
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
-define nat_worker_dump {
+define nat_get_mss_clamping {
u32 client_index;
u32 context;
};
-/** \brief NAT workers details response
+/** \brief Get TCP MSS rewriting configuration reply
@param context - sender context, to match reply w/ request
- @param worker_index - worker index
- @param lcore_id - lcore ID
- @param name - worker name
-*/
-define nat_worker_details {
- u32 context;
- u32 worker_index;
- u32 lcore_id;
- u8 name[64];
-};
-
-/** \brief Enable/disable NAT IPFIX logging
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param domain_id - observation domain ID
- @param src_port - source port number
- @param enable - 1 if enable, 0 if disable
+ @param retval - return code
+ @param mss_value - MSS value to be used for MSS rewriting
+ @param enable - disable(0)/enable(1) MSS rewriting feature
*/
-autoreply define nat_ipfix_enable_disable {
- u32 client_index;
+define nat_get_mss_clamping_reply {
u32 context;
- u32 domain_id;
- u16 src_port;
+ i32 retval;
+ u16 mss_value;
u8 enable;
};
@param first_ip_address - first IPv4 address
@param last_ip_address - last IPv4 address
@param vrf_id - VRF id of tenant, ~0 means independent of VRF
+ @param twice_nat - twice NAT address range for extenal hosts
@param is_add - 1 if add, 0 if delete
*/
autoreply define nat44_add_del_address_range {
u8 first_ip_address[4];
u8 last_ip_address[4];
u32 vrf_id;
+ u8 twice_nat;
u8 is_add;
};
/** \brief NAT44 address details response
@param context - sender context, to match reply w/ request
@param ip_address - IPv4 address
+ @param twice_nat - twice NAT address range for extenal hosts
@param vrf_id - VRF id of tenant, ~0 means independent of VRF
*/
define nat44_address_details {
u32 context;
u8 ip_address[4];
+ u8 twice_nat;
u32 vrf_id;
};
@param addr_only - 1 if address only mapping
@param local_ip_address - local IPv4 address
@param external_ip_address - external IPv4 address
- @param protocol - IP protocol
- @param local_port - local port number
- @param external_port - external port number
+ @param protocol - IP protocol, used only if addr_only=0
+ @param local_port - local port number, used only if addr_only=0
+ @param external_port - external port number, used only if addr_only=0
@param external_sw_if_index - external interface (if set
external_ip_address is ignored, ~0 means not
used)
@param vfr_id - VRF ID
+ @param twice_nat - if 1 translate external host address and port, only for
+ 1:1 NAPT (addr_only must be 0)
+ @param self_twice_nat - if 1 translate external host address and port
+ whenever external host address equals
+ local address of internal host
+ @param out2in_only - if 1 rule match only out2in direction
+ @param tag - opaque string tag
*/
autoreply define nat44_add_del_static_mapping {
u32 client_index;
u8 local_ip_address[4];
u8 external_ip_address[4];
u8 protocol;
- u16 local_port;
- u16 external_port;
- u32 external_sw_if_index;
+ u16 local_port;
+ u16 external_port;
+ u32 external_sw_if_index;
+ u32 vrf_id;
+ u8 twice_nat;
+ u8 self_twice_nat;
+ u8 out2in_only;
+ u8 tag[64];
+};
+
+/** \brief Dump NAT44 static mappings
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+define nat44_static_mapping_dump {
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief NAT44 static mapping details response
+ @param context - sender context, to match reply w/ request
+ @param addr_only - 1 if address only mapping
+ @param local_ip_address - local IPv4 address
+ @param external_ip_address - external IPv4 address
+ @param protocol - IP protocol, valid only if addr_only=0
+ @param local_port - local port number, valid only if addr_only=0
+ @param external_port - external port number, valid only if addr_only=0
+ @param external_sw_if_index - external interface
+ @param vfr_id - VRF ID
+ @param twice_nat - if 1 translate external host address and port
+ @param self_twice_nat - if 1 translate external host address and port
+ whenever external host address equals
+ local address of internal host
+ @param out2in_only - if 1 rule match only out2in direction
+ @param tag - opaque string tag
+*/
+define nat44_static_mapping_details {
+ u32 context;
+ u8 addr_only;
+ u8 local_ip_address[4];
+ u8 external_ip_address[4];
+ u8 protocol;
+ u16 local_port;
+ u16 external_port;
+ u32 external_sw_if_index;
+ u32 vrf_id;
+ u8 twice_nat;
+ u8 self_twice_nat;
+ u8 out2in_only;
+ u8 tag[64];
+};
+
+/** \brief Add/delete NAT44 identity mapping
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param is_add - 1 if add, 0 if delete
+ @param addr_only - 1 if address only mapping
+ @param ip_address - IPv4 address
+ @param protocol - IP protocol
+ @param port - port number
+ @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
+ used)
+ @param vfr_id - VRF ID (if ~0 use default VRF)
+ @param tag - opaque string tag
+*/
+autoreply define nat44_add_del_identity_mapping {
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ u8 addr_only;
+ u8 ip_address[4];
+ u8 protocol;
+ u16 port;
+ u32 sw_if_index;
u32 vrf_id;
+ u8 tag[64];
};
-/** \brief Dump NAT44 static mappings
+/** \brief Dump NAT44 identity mappings
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
-define nat44_static_mapping_dump {
+define nat44_identity_mapping_dump {
u32 client_index;
u32 context;
};
-/** \brief NAT44 static mapping details response
+/** \brief NAT44 identity mapping details response
@param context - sender context, to match reply w/ request
@param addr_only - 1 if address only mapping
- @param local_ip_address - local IPv4 address
- @param external_ip_address - external IPv4 address
+ @param ip_address - IPv4 address
@param protocol - IP protocol
- @param local_port - local port number
- @param external_port - external port number
- @param external_sw_if_index - external interface
+ @param port - port number
+ @param sw_if_index - interface
@param vfr_id - VRF ID
+ @param tag - opaque string tag
*/
-define nat44_static_mapping_details {
+define nat44_identity_mapping_details {
u32 context;
u8 addr_only;
- u8 local_ip_address[4];
- u8 external_ip_address[4];
+ u8 ip_address[4];
u8 protocol;
- u16 local_port;
- u16 external_port;
- u32 external_sw_if_index;
+ u16 port;
+ u32 sw_if_index;
u32 vrf_id;
+ u8 tag[64];
};
/** \brief Add/delete NAT44 pool address from specific interfce
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - 1 if add, 0 if delete
+ @param twice_nat - twice NAT address for extenal hosts
@param sw_if_index - software index of the interface
*/
autoreply define nat44_add_del_interface_addr {
u32 client_index;
u32 context;
u8 is_add;
- u8 is_inside;
+ u8 twice_nat;
u32 sw_if_index;
};
/** \brief NAT44 pool addresses interfaces details response
@param context - sender context, to match reply w/ request
@param sw_if_index - software index of the interface
+ @param twice_nat - twice NAT address for extenal hosts
*/
define nat44_interface_addr_details {
u32 context;
u32 sw_if_index;
+ u8 twice_nat;
};
/** \brief Dump NAT44 users
@param last_heard - last heard timer
@param total_bytes - count of bytes sent through session
@param total_pkts - count of pakets sent through session
+ @param is_twicenat - 1 if session is twice-nat
+ @param ext_host_valid - 1 if external host address and port are valid
+ @param ext_host_address - external host IPv4 address
+ @param ext_host_port - external host port
+ @param ext_host_nat_address - post-NAT external host IPv4 address (valid
+ only if twice-nat session)
+ @param ext_host_nat_port - post-NAT external host port (valid only if
+ twice-nat session)
*/
define nat44_user_session_details {
u32 context;
u64 last_heard;
u64 total_bytes;
u32 total_pkts;
+ u8 is_twicenat;
+ u8 ext_host_valid;
+ u8 ext_host_address[4];
+ u16 ext_host_port;
+ u8 ext_host_nat_address[4];
+ u16 ext_host_nat_port;
};
+/** \brief NAT44 load-balancing address and port pair
+ @param addr - IPv4 address of the internal node
+ @param port - L4 port number of the internal node
+ @param probability - probability of the internal node to be randomly matched
+*/
typeonly manual_endian define nat44_lb_addr_port {
u8 addr[4];
u16 port;
u8 probability;
+ u32 vrf_id;
};
+/** \brief Add/delete NAT44 load-balancing static mapping rule
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param is_add - 1 if add, 0 if delete
+ @param external_addr - external IPv4 address of the service
+ @param external_port - external L4 port number of the service
+ @param protocol - IP protocol number of the service
+ @param twice_nat - if 1 translate external host address and port
+ @param self_twice_nat - if 1 translate external host address and port
+ whenever external host address equals
+ local address of internal host
+ @param out2in_only - if 1 rule match only out2in direction
+ @param tag - opaque string tag
+ @param affinity - if 0 disabled, otherwise client IP affinity sticky time
+ in seconds
+ @param local_num - number of local network nodes
+ @param locals - local network nodes
+*/
autoreply manual_endian define nat44_add_del_lb_static_mapping {
u32 client_index;
u32 context;
u8 external_addr[4];
u16 external_port;
u8 protocol;
- u32 vrf_id;
+ u8 twice_nat;
+ u8 self_twice_nat;
+ u8 out2in_only;
+ u8 tag[64];
+ u32 affinity;
u8 local_num;
vl_api_nat44_lb_addr_port_t locals[local_num];
};
+/** \brief Dump NAT44 load-balancing static mapping rules
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
define nat44_lb_static_mapping_dump {
u32 client_index;
u32 context;
};
+/** \brief NAT44 load-balancing static mapping rule details response
+ @param context - sender context, to match reply w/ request
+ @param is_add - 1 if add, 0 if delete
+ @param external_addr - external IPv4 address of the service
+ @param external_port - external L4 port number of the service
+ @param protocol - IP protocol number of the service
+ @param twice_nat - if 1 translate external host address and port
+ @param self_twice_nat - if 1 translate external host address and port
+ whenever external host address equals
+ local address of internal host
+ @param out2in_only - if 1 rule match only out2in direction
+ @param tag - opaque string tag
+ @param affinity - if 0 disabled, otherwise client IP affinity sticky time
+ in seconds
+ @param local_num - number of local network nodes
+ @param locals - local network nodes
+*/
manual_endian define nat44_lb_static_mapping_details {
u32 context;
u8 external_addr[4];
u16 external_port;
u8 protocol;
- u32 vrf_id;
+ u8 twice_nat;
+ u8 self_twice_nat;
+ u8 out2in_only;
+ u8 tag[64];
+ u32 affinity;
u8 local_num;
vl_api_nat44_lb_addr_port_t locals[local_num];
};
@param protocol - IP protocol
@param port - port number
@param vfr_id - VRF ID
+ @param ext_host_valid - 1 if external host address and port are valid
+ @param ext_host_address - external host IPv4 address
+ @param ext_host_port - external host port
*/
autoreply define nat44_del_session {
u32 client_index;
u8 protocol;
u16 port;
u32 vrf_id;
+ u8 ext_host_valid;
+ u8 ext_host_address[4];
+ u16 ext_host_port;
+};
+
+/** \brief Enable/disable forwarding for NAT44
+ Forward packets which don't match existing translation
+ or static mapping instead of dropping them.
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param enable - 0 for enable, 1 for disable
+*/
+autoreply define nat44_forwarding_enable_disable {
+ u32 client_index;
+ u32 context;
+ u8 enable;
+};
+
+/** \brief Check if forwarding is enabled or disabled
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+define nat44_forwarding_is_enabled {
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief Response to check if forwarding is enabled or disabled
+ @param context - sender context, to match reply w/ request
+ @param enabled - 1 if enabled, 0 if disabled
+*/
+define nat44_forwarding_is_enabled_reply {
+ u32 context;
+ u8 enabled;
};
u32 ses_num;
};
-/** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default)
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param udp - UDP timeout (default 300sec)
- @param tcp_established - TCP established timeout (default 7440sec)
- @param tcp_transitory - TCP transitory timeout (default 240sec)
- @param icmp - ICMP timeout (default 60sec)
-*/
-autoreply define nat_det_set_timeouts {
- u32 client_index;
- u32 context;
- u32 udp;
- u32 tcp_established;
- u32 tcp_transitory;
- u32 icmp;
-};
-
-/** \brief Get values of timeouts for deterministic NAT (seconds)
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
-*/
-define nat_det_get_timeouts {
- u32 client_index;
- u32 context;
-};
-
-/** \brief Get values of timeouts for deterministic NAT reply
- @param context - sender context, to match reply w/ request
- @param retval - return code
- @param udp - UDP timeout (default 300sec)
- @param tcp_established - TCP established timeout (default 7440sec)
- @param tcp_transitory - TCP transitory timeout (default 240sec)
- @param icmp - ICMP timeout (default 60sec)
-*/
-define nat_det_get_timeouts_reply {
- u32 context;
- i32 retval;
- u32 udp;
- u32 tcp_established;
- u32 tcp_transitory;
- u32 icmp;
-};
-
/** \brief Close deterministic NAT session by outside address and port
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param expire - session expiration timestamp
*/
define nat_det_session_details {
- u32 client_index;
u32 context;
u16 in_port;
u8 ext_addr[4];
u32 ses_num;
};
-/** \brief Set values of timeouts for NAT64 (seconds, 0 = default)
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
- @param udp - UDP timeout (default 300sec)
- @param icmp - ICMP timeout (default 60sec)
- @param tcp_trans - TCP transitory timeout (default 240sec)
- @param tcp_est - TCP established timeout (default 7440sec)
- @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec)
-*/
-autoreply define nat64_set_timeouts {
- u32 client_index;
- u32 context;
- u32 udp;
- u32 icmp;
- u32 tcp_trans;
- u32 tcp_est;
- u32 tcp_incoming_syn;
-};
-
-/** \brief Get values of timeouts for NAT64 (seconds)
- @param client_index - opaque cookie to identify the sender
- @param context - sender context, to match reply w/ request
-*/
-define nat64_get_timeouts {
- u32 client_index;
- u32 context;
-};
-
-/** \brief Get values of timeouts for NAT64 reply
- @param context - sender context, to match reply w/ request
- @param retval - return code
- @param udp - UDP timeout
- @param icmp - ICMP timeout
- @param tcp_trans - TCP transitory timeout
- @param tcp_est - TCP established timeout
- @param tcp_incoming_syn - TCP incoming SYN timeout
-*/
-define nat64_get_timeouts_reply {
- u32 context;
- i32 retval;
- u32 udp;
- u32 icmp;
- u32 tcp_trans;
- u32 tcp_est;
- u32 tcp_incoming_syn;
-};
-
/** \brief Dump NAT64 session table
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
u32 vrf_id;
};
+/** \brief Add/delete NAT64 pool address from specific interfce
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param is_add - 1 if add, 0 if delete
+ @param sw_if_index - software index of the interface
+*/
+autoreply define nat64_add_del_interface_addr {
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ u8 is_inside;
+ u32 sw_if_index;
+};
+
/*
* DS-Lite APIs
u8 is_add;
};
+/** \brief Dump DS-Lite addresses
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+define dslite_address_dump {
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief DS-Lite address details response
+ @param context - sender context, to match reply w/ request
+ @param ip_address - IPv4 address
+*/
+define dslite_address_details {
+ u32 context;
+ u8 ip_address[4];
+};
+
+/** \brief Set AFTR IPv6 and IPv4 addresses
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param ip4_addr - IPv4 address
+ @param ip6_addr - IP64 address
+*/
autoreply define dslite_set_aftr_addr {
u32 client_index;
u32 context;
u8 ip4_addr[4];
u8 ip6_addr[16];
};
+
+/** \brief Get AFTR IPv6 and IPv4 addresses
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+define dslite_get_aftr_addr {
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief Response to get AFTR IPv6 and IPv4 addresses
+ @param context - sender context, to match reply w/ request
+ @param retval - return code
+ @param ip4_addr - IPv4 address
+ @param ip6_addr - IP64 address
+*/
+define dslite_get_aftr_addr_reply {
+ u32 context;
+ i32 retval;
+ u8 ip4_addr[4];
+ u8 ip6_addr[16];
+};
+
+/** \brief Set B4 IPv6 and IPv4 addresses
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param ip4_addr - IPv4 address
+ @param ip6_addr - IP64 address
+*/
+autoreply define dslite_set_b4_addr {
+ u32 client_index;
+ u32 context;
+ u8 ip4_addr[4];
+ u8 ip6_addr[16];
+};
+
+/** \brief Get B4 IPv6 and IPv4 addresses
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+define dslite_get_b4_addr {
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief Response to get B4 IPv6 and IPv4 addresses
+ @param context - sender context, to match reply w/ request
+ @param retval - return code
+ @param ip4_addr - IPv4 address
+ @param ip6_addr - IP64 address
+*/
+define dslite_get_b4_addr_reply {
+ u32 context;
+ i32 retval;
+ u8 ip4_addr[4];
+ u8 ip6_addr[16];
+};
+
+/*
+ * NAT66 APIs
+ */
+/** \brief Enable/disable NAT66 feature on the interface
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param is_add - 1 if add, 0 if delete
+ @param is_inside - 1 if inside, 0 if outside
+ @param sw_if_index - software index of the interface
+*/
+autoreply define nat66_add_del_interface {
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ u8 is_inside;
+ u32 sw_if_index;
+};
+
+/** \brief Dump interfaces with NAT66 feature
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+define nat66_interface_dump {
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief NAT66 interface details response
+ @param context - sender context, to match reply w/ request
+ @param is_inside - 1 if inside, 0 if outside
+ @param sw_if_index - software index of the interface
+*/
+define nat66_interface_details {
+ u32 context;
+ u8 is_inside;
+ u32 sw_if_index;
+};
+
+/** \brief Add/delete 1:1 NAT66
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param is_add - 1 if add, 0 if delete
+ @param local_ip_address - local IPv6 address
+ @param external_ip_address - external IPv6 address
+ @param vrf_id - VRF id of tenant
+*/
+autoreply define nat66_add_del_static_mapping {
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ u8 local_ip_address[16];
+ u8 external_ip_address[16];
+ u32 vrf_id;
+};
+
+/** \brief Dump NAT66 static mappings
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+define nat66_static_mapping_dump {
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief NAT66 static mapping details response
+ @param context - sender context, to match reply w/ request
+ @param local_ip_address - local IPv6 address
+ @param external_ip_address - external IPv6 address
+ @param vrf_id - VRF id of tenant
+ @param total_bytes - count of bytes sent through static mapping
+ @param total_pkts - count of pakets sent through static mapping
+*/
+define nat66_static_mapping_details {
+ u32 context;
+ u8 local_ip_address[16];
+ u8 external_ip_address[16];
+ u32 vrf_id;
+ u64 total_bytes;
+ u64 total_pkts;
+};