X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Fnat%2Fnat.api;h=6bb080189668258a494b19e7fd1ce736a18142c4;hb=bc39e3470c04af56bc45756585b848cd448b990b;hp=78f34509b69612b5bdb099e92bedb2f74c20f52d;hpb=240b5ef57cc79cf32934ba8f218de29b6685406b;p=vpp.git

diff --git a/src/plugins/nat/nat.api b/src/plugins/nat/nat.api
index 78f34509b69..6bb08018966 100644
--- a/src/plugins/nat/nat.api
+++ b/src/plugins/nat/nat.api
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-vl_api_version 2.2.0
+option version = "2.4.0";
 
 /**
  * @file nat.api
@@ -352,6 +352,8 @@ define nat44_interface_output_feature_details {
     @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 out2in_only - if 1 rule match only out2in direction
+    @param tag - opaque string tag
 */
 autoreply define nat44_add_del_static_mapping {
   u32 client_index;
@@ -366,6 +368,8 @@ autoreply define nat44_add_del_static_mapping {
   u32 external_sw_if_index;
   u32 vrf_id;
   u8 twice_nat;
+  u8 out2in_only;
+  u8 tag[64];
 };
 
 /** \brief Dump NAT44 static mappings
@@ -388,6 +392,8 @@ define nat44_static_mapping_dump {
     @param external_sw_if_index - external interface
     @param vfr_id - VRF ID
     @param twice_nat - if 1 translate external host address and port
+    @param out2in_only - if 1 rule match only out2in direction
+    @param tag - opaque string tag
 */
 define nat44_static_mapping_details {
   u32 context;
@@ -400,6 +406,8 @@ define nat44_static_mapping_details {
   u32 external_sw_if_index;
   u32 vrf_id;
   u8 twice_nat;
+  u8 out2in_only;
+  u8 tag[64];
 };
 
 /** \brief Add/delete NAT44 identity mapping
@@ -413,6 +421,7 @@ define nat44_static_mapping_details {
     @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;
@@ -424,6 +433,7 @@ autoreply define nat44_add_del_identity_mapping {
   u16 port;
   u32 sw_if_index;
   u32 vrf_id;
+  u8 tag[64];
 };
 
 /** \brief Dump NAT44 identity mappings
@@ -443,6 +453,7 @@ define nat44_identity_mapping_dump {
     @param port - port number
     @param sw_if_index - interface
     @param vfr_id - VRF ID
+    @param tag - opaque string tag
 */
 define nat44_identity_mapping_details {
   u32 context;
@@ -452,6 +463,7 @@ define nat44_identity_mapping_details {
   u16 port;
   u32 sw_if_index;
   u32 vrf_id;
+  u8 tag[64];
 };
 
 /** \brief Add/delete NAT44 pool address from specific interfce
@@ -552,12 +564,31 @@ define nat44_user_session_details {
   u32 total_pkts;
 };
 
+/** \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;
 };
 
+/** \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 vrf_id - internal network VRF ID
+    @param twice_nat - if 1 translate external host address and port
+    @param out2in_only - if 1 rule match only out2in direction
+    @param tag - opaque string tag
+    @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;
@@ -568,15 +599,33 @@ autoreply manual_endian define nat44_add_del_lb_static_mapping {
   u32 vrf_id;
   u8 twice_nat;
   u8 out2in_only;
+  u8 tag[64];
   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 vrf_id - internal network VRF ID
+    @param twice_nat - if 1 translate external host address and port
+    @param out2in_only - if 1 rule match only out2in direction
+    @param tag - opaque string tag
+    @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];
@@ -585,6 +634,7 @@ manual_endian define nat44_lb_static_mapping_details {
   u32 vrf_id;
   u8 twice_nat;
   u8 out2in_only;
+  u8 tag[64];
   u8 local_num;
   vl_api_nat44_lb_addr_port_t locals[local_num];
 };