X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Fsnat%2Fsnat.api;h=573b67537118b833d96a4952cea529a6d0e07aba;hb=11b8dbf78af49d270a0e72abe7dea73eec30d85f;hp=decbacf5c2f6cde8e04ca003a8b496e046560289;hpb=09d96f4a611fa989bfbbfb7e683d668dbe73ac1a;p=vpp.git

diff --git a/src/plugins/snat/snat.api b/src/plugins/snat/snat.api
index decbacf5c2f..573b6753711 100644
--- a/src/plugins/snat/snat.api
+++ b/src/plugins/snat/snat.api
@@ -26,26 +26,19 @@
     @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
 */
-define snat_add_address_range {
+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 Add S-NAT address range reply
-    @param context - sender context, to match reply w/ request
-    @param retval - return code
-*/
-define snat_add_address_range_reply {
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Dump S-NAT addresses
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -59,11 +52,13 @@ define snat_address_dump {
     @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 S-NAT feature on the interface
@@ -73,7 +68,7 @@ define snat_address_details {
     @param is_inside - 1 if inside, 0 if outside
     @param sw_if_index - software index of the interface
 */
-define snat_interface_add_del_feature {
+autoreply define snat_interface_add_del_feature {
   u32 client_index;
   u32 context;
   u8 is_add;
@@ -81,15 +76,6 @@ define snat_interface_add_del_feature {
   u32 sw_if_index;
 };
 
-/** \brief Enable/disable S-NAT feature on the interface reply
-    @param context - sender context, to match reply w/ request
-    @param retval - return code
-*/
-define snat_interface_add_del_feature_reply {
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Dump interfaces with S-NAT feature
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -122,10 +108,11 @@ define snat_interface_details {
     @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)
+                                  external_ip_address is ignored, ~0 means not
+                                  used)
     @param vfr_id - VRF ID
 */
-define snat_add_static_mapping {
+autoreply define snat_add_static_mapping {
   u32 client_index;
   u32 context;
   u8 is_add;
@@ -140,15 +127,6 @@ define snat_add_static_mapping {
   u32 vrf_id;
 };
 
-/** \brief Add/delete S-NAT static mapping reply
-    @param context - sender context, to match reply w/ request
-    @param retval - return code
-*/
-define snat_add_static_mapping_reply {
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Dump S-NAT static mappings
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -167,6 +145,7 @@ define snat_static_mapping_dump {
     @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 {
@@ -178,6 +157,7 @@ define snat_static_mapping_details {
   u8 protocol;
   u16 local_port;
   u16 external_port;
+  u32 external_sw_if_index;
   u32 vrf_id;
 };
 
@@ -220,6 +200,7 @@ define snat_show_config
     @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
@@ -234,6 +215,7 @@ define snat_show_config_reply
   i32 retval;
   u8 static_mapping_only;
   u8 static_mapping_connection_tracking;
+  u8 deterministic;
   u32 translation_buckets;
   u32 translation_memory_size;
   u32 user_buckets;
@@ -248,21 +230,12 @@ define snat_show_config_reply
     @param context - sender context, to match reply w/ request
     @param worker_mask - S-NAT workers mask
 */
-define snat_set_workers {
+autoreply define snat_set_workers {
   u32 client_index;
   u32 context;
   u64 worker_mask;
 };
 
-/** \brief Set S-NAT workers reply
-    @param context - sender context, to match reply w/ request
-    @param retval - return code
-*/
-define snat_set_workers_reply {
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Dump S-NAT workers
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -291,7 +264,7 @@ define snat_worker_details {
     @param is_add - 1 if add, 0 if delete
     @param sw_if_index - software index of the interface
 */
-define snat_add_del_interface_addr {
+autoreply define snat_add_del_interface_addr {
   u32 client_index;
   u32 context;
   u8 is_add;
@@ -299,15 +272,6 @@ define snat_add_del_interface_addr {
   u32 sw_if_index;
 };
 
-/** \brief Add/delete S-NAT pool address from specific interfce reply
-    @param context - sender context, to match reply w/ request
-    @param retval - return code
-*/
-define snat_add_del_interface_addr_reply {
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Dump S-NAT pool addresses interfaces
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -333,7 +297,7 @@ define snat_interface_addr_details {
     @param src_port - source port number
     @param enable - 1 if enable, 0 if disable
 */
-define snat_ipfix_enable_disable {
+autoreply define snat_ipfix_enable_disable {
   u32 client_index;
   u32 context;
   u32 domain_id;
@@ -341,11 +305,225 @@ define snat_ipfix_enable_disable {
   u8 enable;
 };
 
-/** \brief Enable/disable S-NAT IPFIX logging reply
+/** \brief Dump S-NAT users
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define snat_user_dump {
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief S-NAT 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 S-NAT user's 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_ip - IP address of the user to dump
+    @param vrf_id - VRF_ID
+*/
+define snat_user_session_dump {
+  u32 client_index;
+  u32 context;
+  u8 is_ip4;
+  u8 ip_address[16];
+  u32 vrf_id;
+};
+
+/** \brief S-NAT 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 S-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
+    @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
+*/
+define snat_det_reverse_reply {
+  u32 context;
+  i32 retval;
+  u8 is_ip4;
+  u8 in_addr[16];
+};
+
+/** \brief Dump S-NAT deterministic mappings
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define snat_det_map_dump {
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief S-NAT users 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
+*/
+define snat_det_map_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;
+};
+
+/** \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 snat_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 snat_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 snat_ipfix_enable_disable_reply {
+define snat_det_get_timeouts_reply {
   u32 context;
   i32 retval;
+  u32 udp;
+  u32 tcp_established;
+  u32 tcp_transitory;
+  u32 icmp;
 };