X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Fnat%2Fnat.api;h=26d0fbac094cdcb319bec03aa9dc800346072aed;hb=c6c0d2a0;hp=aff8f1d3818cd34c5ae16a23e7256da0e3d03d4d;hpb=5f22499e8836066a268dcb3f4d16cfcd0244b2a2;p=vpp.git diff --git a/src/plugins/nat/nat.api b/src/plugins/nat/nat.api index aff8f1d3818..26d0fbac094 100644 --- a/src/plugins/nat/nat.api +++ b/src/plugins/nat/nat.api @@ -13,7 +13,7 @@ * limitations under the License. */ -option version = "2.4.0"; +option version = "3.0.0"; /** * @file nat.api @@ -343,15 +343,18 @@ define nat44_interface_output_feature_details { @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 */ @@ -368,6 +371,7 @@ autoreply define nat44_add_del_static_mapping { u32 external_sw_if_index; u32 vrf_id; u8 twice_nat; + u8 self_twice_nat; u8 out2in_only; u8 tag[64]; }; @@ -386,12 +390,15 @@ define nat44_static_mapping_dump { @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, 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 */ @@ -406,6 +413,7 @@ define nat44_static_mapping_details { u32 external_sw_if_index; u32 vrf_id; u8 twice_nat; + u8 self_twice_nat; u8 out2in_only; u8 tag[64]; }; @@ -550,6 +558,14 @@ define nat44_user_session_dump { @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; @@ -562,14 +578,42 @@ define nat44_user_session_details { 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 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; @@ -577,26 +621,45 @@ autoreply manual_endian define nat44_add_del_lb_static_mapping { 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]; 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 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]; u8 local_num; @@ -611,6 +674,9 @@ manual_endian define nat44_lb_static_mapping_details { @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; @@ -620,6 +686,9 @@ autoreply define nat44_del_session { 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 @@ -1175,6 +1244,24 @@ autoreply define dslite_add_del_pool_addr_range { 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 @@ -1244,3 +1331,84 @@ define dslite_get_b4_addr_reply { 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; +};