# Functions
Messages returns list of all messages in this module.
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
# Structs
Add/del NAT44 address range - first_ip_address - first IPv4 address - last_ip_address - last IPv4 address - vrf_id - VRF id of tenant, ~0 means independent of VRF - is_add - true if add, false if delete - flags - flag NAT_IS_TWICE_NAT if NAT address range for external hosts
Nat44AddDelAddressRange defines message 'nat44_add_del_address_range'.
Nat44AddDelAddressRangeReply defines message 'nat44_add_del_address_range_reply'.
Add/delete NAT44 identity mapping - is_add - true if add, false if delete - flags - flag NAT_ADDR_ONLY if address only mapping - ip_address - IPv4 address - protocol - IP protocol - port - port number - sw_if_index - interface (if set ip_address is ignored, ~0 means not used) - vfr_id - VRF ID (if ~0 use default VRF) - tag - opaque string tag
Nat44AddDelIdentityMapping defines message 'nat44_add_del_identity_mapping'.
Nat44AddDelIdentityMappingReply defines message 'nat44_add_del_identity_mapping_reply'.
Add/delete NAT44 pool address from specific interfce - is_add - true if add, false if delete - sw_if_index - software index of the interface - flags - flag NAT_TWICE_NAT if NAT address range for external hosts
Nat44AddDelInterfaceAddr defines message 'nat44_add_del_interface_addr'.
Nat44AddDelInterfaceAddrReply defines message 'nat44_add_del_interface_addr_reply'.
Add/delete NAT44 load-balancing static mapping rule - is_add - true if add, false if delete - flags - flag NAT_TWICE_NAT if NAT address range for external hosts, flag NAT_SELF_TWICE_NAT if translate external host address and port whenever external host address equals local address of internal host, flag NAT_OUT2IN_ONLY if rule match only out2in direction - external_addr - external IPv4 address of the service - external_port - external L4 port number of the service - protocol - IP protocol number of the service - affinity - if 0 disabled, otherwise client IP affinity sticky time in seconds - local_num - number of local network nodes - locals - local network nodes - tag - opaque string tag
Nat44AddDelLbStaticMapping defines message 'nat44_add_del_lb_static_mapping'.
Nat44AddDelLbStaticMappingReply defines message 'nat44_add_del_lb_static_mapping_reply'.
Add/delete NAT44 static mapping - is_add - true if add, false if delete - flags - flag NAT_IS_ADDR_ONLY if address only mapping, flag nat_is_twice_nat if nat address range for external hosts, flag NAT_IS_SELF_TWICE_NAT if translate external host address and port whenever external host address equals local address of internal host, flag NAT_IS_OUT2IN_ONLY if rule match only out2in direction - local_ip_address - local IPv4 address - external_ip_address - external IPv4 address - protocol - IP protocol, used only if addr_only=0 - local_port - local port number, used only if addr_only=0 - external_port - external port number, used only if addr_only=0 - external_sw_if_index - external interface (if set external_ip_address is ignored, ~0 means not used) - vfr_id - VRF ID - tag - opaque string tag
Nat44AddDelStaticMapping defines message 'nat44_add_del_static_mapping'.
Nat44AddDelStaticMappingReply defines message 'nat44_add_del_static_mapping_reply'.
Add/delete NAT44 static mapping - is_add - true if add, false if delete - match_pool - true if use specific pool_ip_address - flags - flag NAT_IS_ADDR_ONLY if address only mapping, flag nat_is_twice_nat if nat address range for external hosts, flag NAT_IS_SELF_TWICE_NAT if translate external host address and port whenever external host address equals local address of internal host, flag NAT_IS_OUT2IN_ONLY if rule match only out2in direction - pool_ip_address - pool IPv4 address to match with pool - local_ip_address - local IPv4 address - external_ip_address - external IPv4 address - protocol - IP protocol, used only if addr_only=0 - local_port - local port number, used only if addr_only=0 - external_port - external port number, used only if addr_only=0 - external_sw_if_index - external interface (if set external_ip_address is ignored, ~0 means not used) - vfr_id - VRF ID - tag - opaque string tag
Nat44AddDelStaticMappingV2 defines message 'nat44_add_del_static_mapping_v2'.
Nat44AddDelStaticMappingV2Reply defines message 'nat44_add_del_static_mapping_v2_reply'.
NAT44 address details response - ip_address - IPv4 address - flags - flag NAT_IS_TWICE_NAT if NAT address range for external hosts - vrf_id - VRF id of tenant, ~0 means independent of VRF
Nat44AddressDetails defines message 'nat44_address_details'.
Dump NAT44 addresses Nat44AddressDump defines message 'nat44_address_dump'.
Delete NAT44 session - ip_address - IPv4 address - protocol - IP protocol - port - port number - vfr_id - VRF ID - flags - flag NAT_IS_INSIDE if interface is inside or interface is outside, flag NAT_IS_EXT_HOST_VALID if external host address and port are valid - ext_host_address - external host IPv4 address - ext_host_port - external host port
Nat44DelSession defines message 'nat44_del_session'.
Nat44DelSessionReply defines message 'nat44_del_session_reply'.
add/del NAT output interface (postrouting
in2out translation) - is_add - true if add, false if delete - sw_if_index - software index of the interface
Nat44EdAddDelOutputInterface defines message 'nat44_ed_add_del_output_interface'.
Nat44EdAddDelOutputInterfaceReply defines message 'nat44_ed_add_del_output_interface_reply'.
Add/del inter VRF NAT44-ED route record - table_vrf_id - id of the VRF NAT routing table - vrf_id - id of resolving destination (tx) VRF table - is_add - if true add else del
Nat44EdAddDelVrfRoute defines message 'nat44_ed_add_del_vrf_route'.
Nat44EdAddDelVrfRouteReply defines message 'nat44_ed_add_del_vrf_route_reply'.
Add/delete inter VRF NAT44-ED routing table - table_vrf_id - id of (rx) VRF used for resolving destination (tx) VRF during dynamic session creation - is_add - if true add else del
Nat44EdAddDelVrfTable defines message 'nat44_ed_add_del_vrf_table'.
Nat44EdAddDelVrfTableReply defines message 'nat44_ed_add_del_vrf_table_reply'.
Nat44EdOutputInterfaceDetails defines message 'nat44_ed_output_interface_details'.
Nat44EdOutputInterfaceGet defines message 'nat44_ed_output_interface_get'.
Nat44EdOutputInterfaceGetReply defines message 'nat44_ed_output_interface_get_reply'.
Enable/disable NAT44ED plugin - inside_vrf - inside vrf id - outside_vrf - outside vrf id - sessions - maximum number of sessions per thread - session_memory - overwrite hash allocation parameter - enable - true if enable, false if disable - flags - flag NAT44_IS_STATIC_MAPPING_ONLY, NAT44_IS_CONNECTION_TRACKING
Nat44EdPluginEnableDisable defines message 'nat44_ed_plugin_enable_disable'.
Nat44EdPluginEnableDisableReply defines message 'nat44_ed_plugin_enable_disable_reply'.
Set NAT handoff frame queue options - frame_queue_nelts - number of worker handoff frame queue elements
Nat44EdSetFqOptions defines message 'nat44_ed_set_fq_options'.
Nat44EdSetFqOptionsReply defines message 'nat44_ed_set_fq_options_reply'.
Show NAT handoff frame queue options Nat44EdShowFqOptions defines message 'nat44_ed_show_fq_options'.
Show NAT handoff frame queue options reply - retval - return code for the request - frame_queue_nelts - number of worker handoff frame queue elements
Nat44EdShowFqOptionsReply defines message 'nat44_ed_show_fq_options_reply'.
NAT44-ED inter VRF NAT routing table details response - table_vrf_id - id of the VRF NAT routing table - n_vrf_ids - number of vrf_ids - vrf_ids - ids of resolving destination (tx) VRFs
Nat44EdVrfTablesDetails defines message 'nat44_ed_vrf_tables_details'.
Dump NAT44-ED inter VRF NAT routing tables Nat44EdVrfTablesDump defines message 'nat44_ed_vrf_tables_dump'.
NAT44-ED inter VRF NAT routing table details response - table_vrf_id - id of the VRF NAT routing table - n_vrf_ids - number of vrf_ids - vrf_ids - ids of resolving destination (tx) VRFs
Nat44EdVrfTablesV2Details defines message 'nat44_ed_vrf_tables_v2_details'.
Dump NAT44-ED inter VRF NAT routing tables Nat44EdVrfTablesV2Dump defines message 'nat44_ed_vrf_tables_v2_dump'.
Enable/disable forwarding for NAT44
Forward packets which don't match existing translation or static mapping instead of dropping them.
Nat44ForwardingEnableDisableReply defines message 'nat44_forwarding_enable_disable_reply'.
NAT44 identity mapping details response - flags - flag NAT_ADDR_ONLY if address only mapping - ip_address - IPv4 address - protocol - IP protocol - port - port number - sw_if_index - interface - vfr_id - VRF ID - tag - opaque string tag
Nat44IdentityMappingDetails defines message 'nat44_identity_mapping_details'.
Dump NAT44 identity mappings Nat44IdentityMappingDump defines message 'nat44_identity_mapping_dump'.
Enable/disable NAT44 feature on the interface - is_add - true if add, false if delete - flags - flag NAT_IS_INSIDE if interface is inside else interface is outside - sw_if_index - software index of the interface
Nat44InterfaceAddDelFeature defines message 'nat44_interface_add_del_feature'.
Nat44InterfaceAddDelFeatureReply defines message 'nat44_interface_add_del_feature_reply'.
NAT44 pool addresses interfaces details response - sw_if_index - software index of the interface - flags - flag NAT_TWICE_NAT if NAT address range for external hosts
Nat44InterfaceAddrDetails defines message 'nat44_interface_addr_details'.
Dump NAT44 pool addresses interfaces Nat44InterfaceAddrDump defines message 'nat44_interface_addr_dump'.
NAT44 interface details response - sw_if_index - software index of the interface - flags - flag NAT_IS_INSIDE if interface is inside, flag NAT_IS_OUTSIDE if interface is outside and if both flags are set the interface is both inside and outside
Nat44InterfaceDetails defines message 'nat44_interface_details'.
Dump interfaces with NAT44 feature Nat44InterfaceDump defines message 'nat44_interface_dump'.
Nat44LbAddrPort defines type 'nat44_lb_addr_port'.
Add/delete NAT44 load-balancing static mapping rule backend - is_add - true if add, false if delete - external_addr - external IPv4 address of the service - external_port - external L4 port number of the service - protocol - IP protocol number of the service - local - local network node
Nat44LbStaticMappingAddDelLocal defines message 'nat44_lb_static_mapping_add_del_local'.
Nat44LbStaticMappingAddDelLocalReply defines message 'nat44_lb_static_mapping_add_del_local_reply'.
NAT44 load-balancing static mapping rule details response - external_addr - external IPv4 address of the service - external_port - external L4 port number of the service - protocol - IP protocol number of the service - flags - flag NAT_TWICE_NAT if NAT address range for external hosts, flag NAT_SELF_TWICE_NAT if translate external host address and port whenever external host address equals local address of internal host, flag NAT_OUT2IN_ONLY if rule match only out2in direction - affinity - if 0 disabled, otherwise client IP affinity sticky time in seconds - local_num - number of local network nodes - locals - local network nodes - tag - opaque string tag
Nat44LbStaticMappingDetails defines message 'nat44_lb_static_mapping_details'.
Dump NAT44 load-balancing static mapping rules Nat44LbStaticMappingDump defines message 'nat44_lb_static_mapping_dump'.
NAT44 set session limit - session_limit - session limit - vrf_id - vrf id
Nat44SetSessionLimit defines message 'nat44_set_session_limit'.
Nat44SetSessionLimitReply defines message 'nat44_set_session_limit_reply'.
Show NAT44 plugin running config Nat44ShowRunningConfig defines message 'nat44_show_running_config'.
Show NAT44 plugin running config reply - retval - return code for the request - inside_vrf - default inside VRF id - outside_vrf - outside VRF id - users - maximum number of users per worker thread (NAT44_IS_ENDPOINT_INDEPENDENT) - sessions - maximum number of sessions per worker thread - user_sessions - maximum number of sessions per user (NAT44_IS_ENDPOINT_INDEPENDENT) - user_buckets - number of user hash buckets (NAT44_IS_ENDPOINT_INDEPENDENT) - translation_buckets - number of translation hash buckets - flags - flag NAT44_IS_ENDPOINT_INDEPENDENT, NAT44_IS_ENDPOINT_DEPENDENT, NAT44_IS_STATIC_MAPPING_ONLY, NAT44_IS_CONNECTION_TRACKING, NAT44_IS_OUT2IN_DPO
Nat44ShowRunningConfigReply defines message 'nat44_show_running_config_reply'.
NAT44 static mapping details response - flags - flag NAT_ADDR_ONLY if address only mapping, flag NAT_TWICE_NAT if NAT address range for external hosts, flag NAT_SELF_TWICE_NAT if translate external host address and port whenever external host address equals local address of internal host, flag NAT_OUT2IN_ONLY if rule match only out2in direction - local_ip_address - local IPv4 address - external_ip_address - external IPv4 address - protocol - IP protocol, valid only if no NAT_ADDR_ONLY flag - local_port - local port number, valid only if no NAT_ADDR_ONLY flag - external_port - external port number, valid only if no NAT_ADDR_ONLY flag - external_sw_if_index - external interface - vfr_id - VRF ID - tag - opaque string tag
Nat44StaticMappingDetails defines message 'nat44_static_mapping_details'.
Dump NAT44 static mappings Nat44StaticMappingDump defines message 'nat44_static_mapping_dump'.
NAT44 users response
@vrf_id - VRF ID - ip_address - IPv4 address - nsessions - number of dynamic sessions - nstaticsessions - number of static sessions
Nat44UserDetails defines message 'nat44_user_details'.
Dump NAT44 users Nat44UserDump defines message 'nat44_user_dump'.
NAT44 user's sessions response - outside_ip_address - outside IPv4 address - outside_port - outside port - inside_ip_address - inside IPv4 address - inside_port - inside port - protocol - protocol - flags - flag NAT_IS_STATIC if session is static, flag NAT_IS_TWICE_NAT if session is twice-nat, flag NAT_IS_EXT_HOST_VALID if external host address and port are valid - last_heard - last heard timer - total_bytes - count of bytes sent through session - total_pkts - count of pakets sent through session - ext_host_address - external host IPv4 address - ext_host_port - external host port - ext_host_nat_address - post-NAT external host IPv4 address (valid only if twice-nat session) - ext_host_nat_port - post-NAT external host port (valid only if twice-nat session)
Nat44UserSessionDetails defines message 'nat44_user_session_details'.
NAT44 user's sessions - ip_address - IPv4 address of the user to dump - vrf_id - VRF_ID
Nat44UserSessionDump defines message 'nat44_user_session_dump'.
NAT44 user's sessions response - outside_ip_address - outside IPv4 address - outside_port - outside port - inside_ip_address - inside IPv4 address - inside_port - inside port - protocol - protocol - flags - flag NAT_IS_STATIC if session is static, flag NAT_IS_TWICE_NAT if session is twice-nat, flag NAT_IS_EXT_HOST_VALID if external host address and port are valid - last_heard - last heard timer - total_bytes - count of bytes sent through session - total_pkts - count of pakets sent through session - ext_host_address - external host IPv4 address - ext_host_port - external host port - ext_host_nat_address - post-NAT external host IPv4 address (valid only if twice-nat session) - ext_host_nat_port - post-NAT external host port (valid only if twice-nat session) - is_timed_out - true, if session is timed out, and false, if session is active
Nat44UserSessionV2Details defines message 'nat44_user_session_v2_details'.
NAT44 user's sessions - ip_address - IPv4 address of the user to dump - vrf_id - VRF_ID
Nat44UserSessionV2Dump defines message 'nat44_user_session_v2_dump'.
NAT44 user's sessions response - outside_ip_address - outside IPv4 address - outside_port - outside port - inside_ip_address - inside IPv4 address - inside_port - inside port - protocol - protocol - flags - flag NAT_IS_STATIC if session is static, flag NAT_IS_TWICE_NAT if session is twice-nat, flag NAT_IS_EXT_HOST_VALID if external host address and port are valid - last_heard - last heard timer since VPP start - time_since_last_heard - difference between current vpp time and last_heard value - total_bytes - count of bytes sent through session - total_pkts - count of pakets sent through session - ext_host_address - external host IPv4 address - ext_host_port - external host port - ext_host_nat_address - post-NAT external host IPv4 address (valid only if twice-nat session) - ext_host_nat_port - post-NAT external host port (valid only if twice-nat session) - is_timed_out - true, if session is timed out, and false, if session is active
Nat44UserSessionV3Details defines message 'nat44_user_session_v3_details'.
NAT44 user's sessions - ip_address - IPv4 address of the user to dump - vrf_id - VRF_ID
Nat44UserSessionV3Dump defines message 'nat44_user_session_v3_dump'.
Get TCP MSS rewriting configuration NatGetMssClamping defines message 'nat_get_mss_clamping'.
Get TCP MSS rewriting configuration reply - retval - return code - mss_value - MSS value to be used for MSS rewriting - enable - if true enable MSS rewriting feature else disable
NatGetMssClampingReply defines message 'nat_get_mss_clamping_reply'.
Enable/disable NAT IPFIX logging - domain_id - observation domain ID - src_port - source port number - enable - true if enable, false if disable
NatIpfixEnableDisable defines message 'nat_ipfix_enable_disable'.
NatIpfixEnableDisableReply defines message 'nat_ipfix_enable_disable_reply'.
Set TCP MSS rewriting configuration - mss_value - MSS value to be used for MSS rewriting - enable - if true enable MSS rewriting feature else disable
NatSetMssClamping defines message 'nat_set_mss_clamping'.
NatSetMssClampingReply defines message 'nat_set_mss_clamping_reply'.
Set values of timeouts for NAT sessions (seconds) - udp - UDP timeout (default 300sec) - tcp_established - TCP established timeout (default 7440sec) - tcp_transitory - TCP transitory timeout (default 240sec) - icmp - ICMP timeout (default 60sec)
NatSetTimeouts defines message 'nat_set_timeouts'.
NatSetTimeoutsReply defines message 'nat_set_timeouts_reply'.
Set NAT workers - worker_mask - NAT workers mask
NatSetWorkers defines message 'nat_set_workers'.
NatSetWorkersReply defines message 'nat_set_workers_reply'.
NAT workers details response - worker_index - worker index - lcore_id - lcore ID - name - worker name
NatWorkerDetails defines message 'nat_worker_details'.
Dump NAT workers NatWorkerDump defines message 'nat_worker_dump'.
# Interfaces
RPCService defines RPC service nat44_ed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
Nat44ConfigFlags defines enum 'nat44_config_flags'.