This module defines SAI NAT (Network Address Translation) spec. More...

#include <saitypes.h>

Classes
struct	_sai_nat_entry_key_t
	NAT entry keys API can be invoked with extra keys present. Driver MUST pick the right set of keys for a given NAT type. More...

struct	_sai_nat_entry_mask_t
	NAT entry key masks. More...

struct	_sai_nat_entry_data_t

struct	_sai_nat_entry_t
	NAT entry. More...

struct	_sai_nat_event_notification_data_t
	Notification data format received from SAI NAT callback. More...

struct	_sai_nat_api_t
	NAT API Router entry methods table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_nat_type_t	sai_nat_type_t
	NAT Type.

typedef enum _sai_nat_entry_attr_t	sai_nat_entry_attr_t
	NAT Entry Attributes for Match.

typedef struct _sai_nat_entry_key_t	sai_nat_entry_key_t
	NAT entry keys API can be invoked with extra keys present. Driver MUST pick the right set of keys for a given NAT type.

typedef struct _sai_nat_entry_mask_t	sai_nat_entry_mask_t
	NAT entry key masks.

typedef struct _sai_nat_entry_data_t	sai_nat_entry_data_t

typedef struct _sai_nat_entry_t	sai_nat_entry_t
	NAT entry.

typedef enum _sai_nat_event_t	sai_nat_event_t
	NAT event type.

typedef struct _sai_nat_event_notification_data_t	sai_nat_event_notification_data_t
	Notification data format received from SAI NAT callback.

typedef sai_status_t(*	sai_create_nat_entry_fn) (_In_ const sai_nat_entry_t nat_entry, _In_ uint32_t attr_count, _In_ const sai_attribute_t attr_list)
	Create and return a NAT object.

typedef sai_status_t(*	sai_remove_nat_entry_fn) (_In_ const sai_nat_entry_t *nat_entry)
	Remove NAT entry.

typedef sai_status_t(*	sai_set_nat_entry_attribute_fn) (_In_ const sai_nat_entry_t nat_entry, _In_ const sai_attribute_t attr)
	Set NAT entry attribute value(s).

typedef sai_status_t(*	sai_get_nat_entry_attribute_fn) (_In_ const sai_nat_entry_t nat_entry, _In_ uint32_t attr_count, _Inout_ sai_attribute_t attr_list)
	Get values for specified NAT entry attributes.

typedef void(*	sai_nat_event_notification_fn) (_In_ uint32_t count, _In_ const sai_nat_event_notification_data_t *data)
	NAT notifications.

typedef sai_status_t(*	sai_bulk_create_nat_entry_fn) (_In_ uint32_t object_count, _In_ const sai_nat_entry_t nat_entry, _In_ const uint32_t attr_count, _In_ const sai_attribute_t *attr_list, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t object_statuses)
	Bulk create NAT entry.

typedef sai_status_t(*	sai_bulk_remove_nat_entry_fn) (_In_ uint32_t object_count, _In_ const sai_nat_entry_t nat_entry, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t object_statuses)
	Bulk remove NAT entry.

typedef sai_status_t(*	sai_bulk_set_nat_entry_attribute_fn) (_In_ uint32_t object_count, _In_ const sai_nat_entry_t nat_entry, _In_ const sai_attribute_t attr_list, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)
	Bulk set attribute on NAT entry.

typedef sai_status_t(*	sai_bulk_get_nat_entry_attribute_fn) (_In_ uint32_t object_count, _In_ const sai_nat_entry_t nat_entry, _In_ const uint32_t attr_count, _Inout_ sai_attribute_t *attr_list, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t object_statuses)
	Bulk get attribute on NAT entry.

typedef enum _sai_nat_zone_counter_attr_t	sai_nat_zone_counter_attr_t
	NAT zone counters for each NAT type.

typedef sai_status_t(*	sai_create_nat_zone_counter_fn) (_Out_ sai_object_id_t nat_zone_counter_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t attr_list)
	Create and return a NAT zone counter object.

typedef sai_status_t(*	sai_remove_nat_zone_counter_fn) (_In_ sai_object_id_t nat_zone_counter_id)
	Deletes a specified NAT zone_counter object.

typedef sai_status_t(*	sai_set_nat_zone_counter_attribute_fn) (_In_ sai_object_id_t nat_zone_counter_id, _In_ const sai_attribute_t *attr)
	Set NAT zone counter attribute value(s).

typedef sai_status_t(*	sai_get_nat_zone_counter_attribute_fn) (_In_ sai_object_id_t nat_zone_counter_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get values for specified NAT zone counter attributes.

typedef struct _sai_nat_api_t	sai_nat_api_t
	NAT API Router entry methods table retrieved with sai_api_query()

Enumerations
enum	_sai_nat_type_t { SAI_NAT_TYPE_NONE , SAI_NAT_TYPE_SOURCE_NAT , SAI_NAT_TYPE_DESTINATION_NAT , SAI_NAT_TYPE_DOUBLE_NAT , SAI_NAT_TYPE_DESTINATION_NAT_POOL }
	NAT Type. More...

enum	_sai_nat_entry_attr_t { SAI_NAT_ENTRY_ATTR_START , SAI_NAT_ENTRY_ATTR_NAT_TYPE = SAI_NAT_ENTRY_ATTR_START , SAI_NAT_ENTRY_ATTR_SRC_IP , SAI_NAT_ENTRY_ATTR_SRC_IP_MASK , SAI_NAT_ENTRY_ATTR_VR_ID , SAI_NAT_ENTRY_ATTR_DST_IP , SAI_NAT_ENTRY_ATTR_DST_IP_MASK , SAI_NAT_ENTRY_ATTR_L4_SRC_PORT , SAI_NAT_ENTRY_ATTR_L4_DST_PORT , SAI_NAT_ENTRY_ATTR_ENABLE_PACKET_COUNT , SAI_NAT_ENTRY_ATTR_PACKET_COUNT , SAI_NAT_ENTRY_ATTR_ENABLE_BYTE_COUNT , SAI_NAT_ENTRY_ATTR_BYTE_COUNT , SAI_NAT_ENTRY_ATTR_HIT_BIT_COR , SAI_NAT_ENTRY_ATTR_HIT_BIT , SAI_NAT_ENTRY_ATTR_AGING_TIME , SAI_NAT_ENTRY_ATTR_END , SAI_NAT_ENTRY_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_NAT_ENTRY_ATTR_CUSTOM_RANGE_END }
	NAT Entry Attributes for Match. More...

enum	_sai_nat_event_t { SAI_NAT_EVENT_NONE , SAI_NAT_EVENT_AGED }
	NAT event type. More...

enum	_sai_nat_zone_counter_attr_t { SAI_NAT_ZONE_COUNTER_ATTR_START , SAI_NAT_ZONE_COUNTER_ATTR_NAT_TYPE = SAI_NAT_ZONE_COUNTER_ATTR_START , SAI_NAT_ZONE_COUNTER_ATTR_ZONE_ID , SAI_NAT_ZONE_COUNTER_ATTR_ENABLE_DISCARD , SAI_NAT_ZONE_COUNTER_ATTR_DISCARD_PACKET_COUNT , SAI_NAT_ZONE_COUNTER_ATTR_ENABLE_TRANSLATION_NEEDED , SAI_NAT_ZONE_COUNTER_ATTR_TRANSLATION_NEEDED_PACKET_COUNT , SAI_NAT_ZONE_COUNTER_ATTR_ENABLE_TRANSLATIONS , SAI_NAT_ZONE_COUNTER_ATTR_TRANSLATIONS_PACKET_COUNT , SAI_NAT_ZONE_COUNTER_ATTR_END , SAI_NAT_ZONE_COUNTER_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_NAT_ZONE_COUNTER_ATTR_CUSTOM_RANGE_END }
	NAT zone counters for each NAT type. More...

Detailed Description

This module defines SAI NAT (Network Address Translation) spec.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

THIS CODE IS PROVIDED ON AN AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.

See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.

Microsoft would like to thank the following companies for their review and assistance with these files: Intel Corporation, Mellanox Technologies Ltd, Dell Products, L.P., Facebook, Inc., Marvell International Ltd.

Definition in file sainat.h.

Classes

Typedefs

Enumerations

Detailed Description