Classes
struct	_sai_twamp_session_stats_data_t
	Notification data format received from SAI TWAMP callback. More...

struct	_sai_twamp_session_event_notification_data_t
	Defines the operational status of the TWAMP session. More...

struct	_sai_twamp_api_t
	Two-Way Active Measurement Protocol method table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_twamp_session_auth_mode_t	sai_twamp_session_auth_mode_t
	SAI Two-Way Active Measurement Protocol session authentication mode, there are three modes: unauthenticated, authenticated, and encrypted.

typedef enum _sai_twamp_session_role_t	sai_twamp_session_role_t
	SAI Two-Way Active Measurement Protocol role.

typedef enum _sai_twamp_mode_t	sai_twamp_mode_t
	SAI Two-Way Active Measurement Protocol mode.

typedef enum _sai_twamp_pkt_tx_mode_t	sai_twamp_pkt_tx_mode_t
	SAI Two-Way Active Measurement transmitting mode.

typedef enum _sai_twamp_timestamp_format_t	sai_twamp_timestamp_format_t
	SAI Two-Way Active Measurement format of timestamp.

typedef enum _sai_twamp_encapsulation_type_t	sai_twamp_encapsulation_type_t
	SAI Two-Way Active Measurement Protocol type of encapsulation.

typedef enum _sai_twamp_session_attr_t	sai_twamp_session_attr_t
	SAI attributes for Two-Way Active Measurement Protocol session.

typedef enum _sai_twamp_session_stat_t	sai_twamp_session_stat_t
	Two-Way Active Measurement Protocol Session counter IDs in sai_get_twamp_session_stats() call.

typedef enum _sai_twamp_session_state_t	sai_twamp_session_state_t
	SAI TWAMP session state.

typedef struct _sai_twamp_session_stats_data_t	sai_twamp_session_stats_data_t
	Notification data format received from SAI TWAMP callback.

typedef struct _sai_twamp_session_event_notification_data_t	sai_twamp_session_event_notification_data_t
	Defines the operational status of the TWAMP session.

typedef sai_status_t(*	sai_create_twamp_session_fn) (_Out_ sai_object_id_t twamp_session_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t attr_list)
	Create Two-Way Active Measurement Protocol session.

typedef sai_status_t(*	sai_remove_twamp_session_fn) (_In_ sai_object_id_t twamp_session_id)
	Remove Two-Way Active Measurement Protocol session.

typedef sai_status_t(*	sai_set_twamp_session_attribute_fn) (_In_ sai_object_id_t twamp_session_id, _In_ const sai_attribute_t *attr)
	Set Two-Way Active Measurement Protocol session attributes.

typedef sai_status_t(*	sai_get_twamp_session_attribute_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get Two-Way Active Measurement Protocol session attributes.

typedef sai_status_t(*	sai_get_twamp_session_stats_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t counter_ids, _Out_ uint64_t counters)
	Get Two-Way Active Measurement Protocol session statistics counters.

typedef sai_status_t(*	sai_get_twamp_session_stats_ext_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t counter_ids, _In_ sai_stats_mode_t mode, _Out_ uint64_t counters)
	Get Two-Way Active Measurement Protocol session statistics counters extended.

typedef sai_status_t(*	sai_clear_twamp_session_stats_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids)
	Clear Two-Way Active Measurement Protocol session statistics counters.

typedef void(*	sai_twamp_session_event_notification_fn) (_In_ uint32_t count, _In_ const sai_twamp_session_event_notification_data_t *data)
	TWAMP session notification.

typedef struct _sai_twamp_api_t	sai_twamp_api_t
	Two-Way Active Measurement Protocol method table retrieved with sai_api_query()

Enumerations
enum	_sai_twamp_session_auth_mode_t { SAI_TWAMP_SESSION_AUTH_MODE_UNAUTHENTICATED = 0 , SAI_TWAMP_SESSION_AUTH_MODE_AUTHENTICATED , SAI_TWAMP_SESSION_AUTH_MODE_ENCRYPTED }
	SAI Two-Way Active Measurement Protocol session authentication mode, there are three modes: unauthenticated, authenticated, and encrypted. More...

enum	_sai_twamp_session_role_t { SAI_TWAMP_SESSION_ROLE_SENDER = 0 , SAI_TWAMP_SESSION_ROLE_REFLECTOR }
	SAI Two-Way Active Measurement Protocol role. More...

enum	_sai_twamp_mode_t { SAI_TWAMP_MODE_FULL = 0 , SAI_TWAMP_MODE_LIGHT }
	SAI Two-Way Active Measurement Protocol mode. More...

enum	_sai_twamp_pkt_tx_mode_t { SAI_TWAMP_PKT_TX_MODE_CONTINUOUS = 0 , SAI_TWAMP_PKT_TX_MODE_PACKET_COUNT , SAI_TWAMP_PKT_TX_MODE_PERIOD }
	SAI Two-Way Active Measurement transmitting mode. More...

enum	_sai_twamp_timestamp_format_t { SAI_TWAMP_TIMESTAMP_FORMAT_NTP = 0 , SAI_TWAMP_TIMESTAMP_FORMAT_PTP }
	SAI Two-Way Active Measurement format of timestamp. More...

enum	_sai_twamp_encapsulation_type_t { SAI_TWAMP_ENCAPSULATION_TYPE_IP = 0 , SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L2VPN , SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L3VPN , SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN }
	SAI Two-Way Active Measurement Protocol type of encapsulation. More...

enum	_sai_twamp_session_attr_t { SAI_TWAMP_SESSION_ATTR_START , SAI_TWAMP_SESSION_ATTR_TWAMP_MODE = SAI_TWAMP_SESSION_ATTR_START , SAI_TWAMP_SESSION_ATTR_SESSION_ROLE , SAI_TWAMP_SESSION_ATTR_AUTH_MODE , SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID , SAI_TWAMP_SESSION_ATTR_VIRTUAL_ROUTER , SAI_TWAMP_SESSION_ATTR_SRC_MAC , SAI_TWAMP_SESSION_ATTR_DST_MAC , SAI_TWAMP_SESSION_ATTR_VLAN_ID , SAI_TWAMP_SESSION_ATTR_VLAN_PRI , SAI_TWAMP_SESSION_ATTR_VLAN_CFI , SAI_TWAMP_SESSION_ATTR_VLAN_HEADER_VALID , SAI_TWAMP_SESSION_ATTR_SRC_IP , SAI_TWAMP_SESSION_ATTR_DST_IP , SAI_TWAMP_SESSION_ATTR_UDP_SRC_PORT , SAI_TWAMP_SESSION_ATTR_UDP_DST_PORT , SAI_TWAMP_SESSION_ATTR_DSCP , SAI_TWAMP_SESSION_ATTR_TTL , SAI_TWAMP_SESSION_ATTR_TUNNEL_SRC_MAC , SAI_TWAMP_SESSION_ATTR_TUNNEL_DST_MAC , SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_ID , SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_PRI , SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_CFI , SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_HEADER_VALID , SAI_TWAMP_SESSION_ATTR_TUNNEL_LABELSTACK , SAI_TWAMP_SESSION_ATTR_TUNNEL_SRC_IP , SAI_TWAMP_SESSION_ATTR_TUNNEL_DST_IP , SAI_TWAMP_SESSION_ATTR_TUNNEL_VNI , SAI_TWAMP_SESSION_ATTR_TUNNEL_UDP_SRC_PORT , SAI_TWAMP_SESSION_ATTR_TUNNEL_UDP_DST_PORT , SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE , SAI_TWAMP_SESSION_ATTR_TWAMP_TIMESTAMP_FORMAT , SAI_TWAMP_SESSION_ATTR_SESSION_ENABLE_TRANSMIT , SAI_TWAMP_SESSION_ATTR_PACKET_LENGTH , SAI_TWAMP_SESSION_ATTR_PORT , SAI_TWAMP_SESSION_ATTR_TRANSMIT_PORT , SAI_TWAMP_SESSION_ATTR_RECEIVE_PORT , SAI_TWAMP_SESSION_ATTR_TWAMP_PKT_TX_MODE , SAI_TWAMP_SESSION_ATTR_TX_PKT_CNT , SAI_TWAMP_SESSION_ATTR_TX_PKT_PERIOD , SAI_TWAMP_SESSION_ATTR_TX_INTERVAL , SAI_TWAMP_SESSION_ATTR_TIMEOUT , SAI_TWAMP_SESSION_ATTR_STATISTICS_INTERVAL , SAI_TWAMP_SESSION_ATTR_END , SAI_TWAMP_SESSION_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_TWAMP_SESSION_ATTR_CUSTOM_RANGE_END }
	SAI attributes for Two-Way Active Measurement Protocol session. More...

enum	_sai_twamp_session_stat_t { SAI_TWAMP_SESSION_STAT_RX_PACKETS , SAI_TWAMP_SESSION_STAT_RX_BYTE , SAI_TWAMP_SESSION_STAT_TX_PACKETS , SAI_TWAMP_SESSION_STAT_TX_BYTE , SAI_TWAMP_SESSION_STAT_DROP_PACKETS , SAI_TWAMP_SESSION_STAT_MAX_LATENCY , SAI_TWAMP_SESSION_STAT_MIN_LATENCY , SAI_TWAMP_SESSION_STAT_AVG_LATENCY , SAI_TWAMP_SESSION_STAT_MAX_JITTER , SAI_TWAMP_SESSION_STAT_MIN_JITTER , SAI_TWAMP_SESSION_STAT_AVG_JITTER , SAI_TWAMP_SESSION_STAT_FIRST_TS , SAI_TWAMP_SESSION_STAT_LAST_TS , SAI_TWAMP_SESSION_STAT_DURATION_TS }
	Two-Way Active Measurement Protocol Session counter IDs in sai_get_twamp_session_stats() call. More...

enum	_sai_twamp_session_state_t { SAI_TWAMP_SESSION_STATE_INACTIVE , SAI_TWAMP_SESSION_STATE_ACTIVE }
	SAI TWAMP session state. More...

Detailed Description

Typedef Documentation

◆ sai_clear_twamp_session_stats_fn

typedef sai_status_t(* sai_clear_twamp_session_stats_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids)

Clear Two-Way Active Measurement Protocol session statistics counters.

Parameters

[in]	twamp_session_id	Two-Way Active Measurement Protocol session id
[in]	number_of_counters	Number of counters in the array
[in]	counter_ids	Specifies the array of counter ids

Returns: SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 773 of file saitwamp.h.

◆ sai_create_twamp_session_fn

typedef sai_status_t(* sai_create_twamp_session_fn) (_Out_ sai_object_id_t *twamp_session_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create Two-Way Active Measurement Protocol session.

Parameters

[out]	twamp_session_id	Two-Way Active Measurement Protocol session id
[in]	switch_id	Switch id
[in]	attr_count	Number of attributes
[in]	attr_list	Value of attributes

Returns: SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 685 of file saitwamp.h.

◆ sai_get_twamp_session_attribute_fn

typedef sai_status_t(* sai_get_twamp_session_attribute_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get Two-Way Active Measurement Protocol session attributes.

Parameters

[in]	twamp_session_id	Two-Way Active Measurement Protocol session id
[in]	attr_count	Number of attributes
[in,out]	attr_list	Value of attribute

Returns: SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 725 of file saitwamp.h.

◆ sai_get_twamp_session_stats_ext_fn

typedef sai_status_t(* sai_get_twamp_session_stats_ext_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _In_ sai_stats_mode_t mode, _Out_ uint64_t *counters)

Get Two-Way Active Measurement Protocol session statistics counters extended.

Parameters

[in]	twamp_session_id	Two-Way Active Measurement Protocol session id
[in]	number_of_counters	Number of counters in the array
[in]	counter_ids	Specifies the array of counter ids
[in]	mode	Statistics mode
[out]	counters	Array of resulting counter values.

Returns: SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 757 of file saitwamp.h.

◆ sai_get_twamp_session_stats_fn

typedef sai_status_t(* sai_get_twamp_session_stats_fn) (_In_ sai_object_id_t twamp_session_id, _In_ uint32_t number_of_counters, _In_ const sai_stat_id_t *counter_ids, _Out_ uint64_t *counters)

Get Two-Way Active Measurement Protocol session statistics counters.

Parameters

[in]	twamp_session_id	Two-Way Active Measurement Protocol session id
[in]	number_of_counters	Number of counters in the array
[in]	counter_ids	Specifies the array of counter ids
[out]	counters	Array of resulting counter values.

Returns: SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 740 of file saitwamp.h.

◆ sai_remove_twamp_session_fn

typedef sai_status_t(* sai_remove_twamp_session_fn) (_In_ sai_object_id_t twamp_session_id)

Remove Two-Way Active Measurement Protocol session.

Parameters

[in] twamp_session_id Two-Way Active Measurement Protocol session id

Returns: SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 699 of file saitwamp.h.

◆ sai_set_twamp_session_attribute_fn

typedef sai_status_t(* sai_set_twamp_session_attribute_fn) (_In_ sai_object_id_t twamp_session_id, _In_ const sai_attribute_t *attr)

Set Two-Way Active Measurement Protocol session attributes.

Parameters

[in]	twamp_session_id	Two-Way Active Measurement Protocol session id
[in]	attr	Value of attribute

Returns: SAI_STATUS_SUCCESS if operation is successful otherwise a different error code is returned.

Definition at line 711 of file saitwamp.h.

◆ sai_twamp_session_event_notification_fn

typedef void(* sai_twamp_session_event_notification_fn) (_In_ uint32_t count, _In_ const sai_twamp_session_event_notification_data_t *data)

TWAMP session notification.

Count:: data[count]

Parameters

[in]	count	Number of notifications
[in]	data	Pointer to TWAMP session notification data array

Definition at line 786 of file saitwamp.h.

◆ sai_twamp_session_stats_data_t

typedef struct _sai_twamp_session_stats_data_t sai_twamp_session_stats_data_t

Notification data format received from SAI TWAMP callback.

Count:: counters_ids[number_of_counters]

Count:: counters[number_of_counters]

Enumeration Type Documentation

◆ _sai_twamp_encapsulation_type_t

enum _sai_twamp_encapsulation_type_t

SAI Two-Way Active Measurement Protocol type of encapsulation.

Enumerator
SAI_TWAMP_ENCAPSULATION_TYPE_IP	IP Encapsulation, L2 header \| IP(v4/v6) header \| UDP header \| Two-Way Active Measurement Protocol test packet.
SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L2VPN	L2 Virtual Private Network Encapsulation, L2 header \| MPLS Label List \| L2 header \| IP(v4/v6) header \| UDP header \| Two-Way Active Measurement Protocol test packet.
SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L3VPN	L3 Virtual Private Network Encapsulation, L2 header \| MPLS Label List \| IP(v4/v6) header \| UDP header \| Two-Way Active Measurement Protocol test packet.
SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN	VXLAN Network Encapsulation, L2 header \| IP(v4/v6) header \| UDP header \| VXLAN header \| L2 header \| IP(v4/v6) header \| UDP header \| Two-Way Active Measurement Protocol test packet.

Definition at line 119 of file saitwamp.h.

◆ _sai_twamp_mode_t

enum _sai_twamp_mode_t

SAI Two-Way Active Measurement Protocol mode.

Enumerator
SAI_TWAMP_MODE_FULL	Means TWAMP protocol when enabling Two-Way Active Measurement Protocol full mode.
SAI_TWAMP_MODE_LIGHT	Means TWAMP Light protocol when enabling Two-Way Active Measurement Protocol light mode.

Definition at line 69 of file saitwamp.h.

◆ _sai_twamp_pkt_tx_mode_t

enum _sai_twamp_pkt_tx_mode_t

SAI Two-Way Active Measurement transmitting mode.

Enumerator
SAI_TWAMP_PKT_TX_MODE_CONTINUOUS	Continue to send Two-Way Active Measurement Protocol test packet.
SAI_TWAMP_PKT_TX_MODE_PACKET_COUNT	Only send Two-Way Active Measurement Protocol test packets with assigned number.
SAI_TWAMP_PKT_TX_MODE_PERIOD	Send Two-Way Active Measurement Protocol test packets during period time.

Definition at line 86 of file saitwamp.h.

◆ _sai_twamp_session_attr_t

enum _sai_twamp_session_attr_t

SAI attributes for Two-Way Active Measurement Protocol session.

Enumerator
SAI_TWAMP_SESSION_ATTR_START	Start of attributes.
SAI_TWAMP_SESSION_ATTR_TWAMP_MODE	Two-Way Active Measurement Protocol mode: light mode and full mode. Value Type: sai_twamp_mode_t Flags: MANDATORY_ON_CREATE \| CREATE_ONLY
SAI_TWAMP_SESSION_ATTR_SESSION_ROLE	Two-Way Active Measurement Protocol session role of sender or reflector. Value Type: sai_twamp_session_role_t Flags: MANDATORY_ON_CREATE \| CREATE_ONLY
SAI_TWAMP_SESSION_ATTR_AUTH_MODE	Two-Way Active Measurement Protocol Session mode: unauthenticated, authenticated, and encrypted. Value Type: sai_twamp_session_auth_mode_t Flags: CREATE_ONLY Default value: SAI_TWAMP_SESSION_AUTH_MODE_UNAUTHENTICATED
SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID	Hardware lookup valid. Value Type: bool Flags: CREATE_ONLY Default value: true
SAI_TWAMP_SESSION_ATTR_VIRTUAL_ROUTER	Virtual router object. Value Type: sai_object_id_t Flags: CREATE_AND_SET Allowed object types SAI_OBJECT_TYPE_VIRTUAL_ROUTER Allows NULL object ID true Default value: SAI_NULL_OBJECT_ID Valid only when: SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID == true
SAI_TWAMP_SESSION_ATTR_SRC_MAC	L2 source MAC address. Value Type: sai_mac_t Flags: MANDATORY_ON_CREATE \| CREATE_AND_SET Condition: SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID == false
SAI_TWAMP_SESSION_ATTR_DST_MAC	L2 destination MAC address. Value Type: sai_mac_t Flags: MANDATORY_ON_CREATE \| CREATE_AND_SET Condition: SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID == false
SAI_TWAMP_SESSION_ATTR_VLAN_ID	L2 header VLAN Id. Value Type: sai_uint16_t Flags: MANDATORY_ON_CREATE \| CREATE_ONLY IsVlan: true Condition: SAI_TWAMP_SESSION_ATTR_VLAN_HEADER_VALID == true
SAI_TWAMP_SESSION_ATTR_VLAN_PRI	L2 header packet priority (3 bits). Value Type: sai_uint8_t Flags: CREATE_AND_SET Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_VLAN_HEADER_VALID == true
SAI_TWAMP_SESSION_ATTR_VLAN_CFI	L2 header Vlan CFI (1 bit). Value Type: sai_uint8_t Flags: CREATE_AND_SET Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_VLAN_HEADER_VALID == true
SAI_TWAMP_SESSION_ATTR_VLAN_HEADER_VALID	Vlan header valid. Value Type: bool Flags: CREATE_ONLY Default value: false Valid only when: SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID == false
SAI_TWAMP_SESSION_ATTR_SRC_IP	Local source IP address. Value Type: sai_ip_address_t Flags: MANDATORY_ON_CREATE \| CREATE_ONLY
SAI_TWAMP_SESSION_ATTR_DST_IP	Remote Destination IP address. Value Type: sai_ip_address_t Flags: MANDATORY_ON_CREATE \| CREATE_ONLY
SAI_TWAMP_SESSION_ATTR_UDP_SRC_PORT	UDP Source port. Value Type: sai_uint32_t Flags: MANDATORY_ON_CREATE \| CREATE_ONLY
SAI_TWAMP_SESSION_ATTR_UDP_DST_PORT	UDP Destination port. Value Type: sai_uint32_t Flags: MANDATORY_ON_CREATE \| CREATE_ONLY
SAI_TWAMP_SESSION_ATTR_DSCP	DSCP of IP header. Value Type: sai_uint8_t Flags: CREATE_AND_SET Default value: 0
SAI_TWAMP_SESSION_ATTR_TTL	TTL of IP header. Value Type: sai_uint8_t Flags: CREATE_AND_SET Default value: 255
SAI_TWAMP_SESSION_ATTR_TUNNEL_SRC_MAC	MPLS L2 Virtual Private Network, MPLS L3 Virtual Private Network or VXLAN tunnel L2 header Src MAC Address, when hardware lookup is disable. Value Type: sai_mac_t Flags: CREATE_ONLY Default value: vendor Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L2VPN or SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L3VPN or SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
SAI_TWAMP_SESSION_ATTR_TUNNEL_DST_MAC	MPLS L2 Virtual Private Network, MPLS L3 Virtual Private Network or VXLAN tunnel L2 header Dst MAC Address, when hardware lookup is disable. Value Type: sai_mac_t Flags: CREATE_ONLY Default value: vendor Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L2VPN or SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L3VPN or SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_ID	MPLS L2 Virtual Private Network, MPLS L3 Virtual Private Network or VXLAN tunnel L2 header outer VLAN Id, when hardware lookup is disable. Value Type: sai_uint16_t Flags: CREATE_ONLY IsVlan: true Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_HEADER_VALID == true
SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_PRI	MPLS L2 Virtual Private Network, MPLS L3 Virtual Private Network or VXLAN tunnel L2 header outer Vlan priority (3 bits), when hardware lookup is disable. Value Type: sai_uint8_t Flags: CREATE_ONLY Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_HEADER_VALID == true
SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_CFI	MPLS L2 Virtual Private Network, MPLS L3 Virtual Private Network or VXLAN tunnel L2 header outer Vlan CFI (1 bit), when hardware lookup is disable. Value Type: sai_uint8_t Flags: CREATE_ONLY Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_HEADER_VALID == true
SAI_TWAMP_SESSION_ATTR_TUNNEL_OUTER_VLAN_HEADER_VALID	Tunnel outer vlan header valid. Value Type: bool Flags: CREATE_ONLY Default value: false Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L2VPN or SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L3VPN or SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
SAI_TWAMP_SESSION_ATTR_TUNNEL_LABELSTACK	MPLS L2 Virtual Private Network, MPLS L3 Virtual Private Network tunnel push label, when hardware lookup is disable. Value Type: sai_u32_list_t Flags: CREATE_ONLY Default value: empty Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L2VPN or SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_MPLS_L3VPN
SAI_TWAMP_SESSION_ATTR_TUNNEL_SRC_IP	VXLAN tunnel L3 header Src IPv4 Address, when hardware lookup is disable. Value Type: sai_ip_address_t Flags: CREATE_ONLY Default value: 0.0.0.0 Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
SAI_TWAMP_SESSION_ATTR_TUNNEL_DST_IP	VXLAN tunnel L3 header Dst IPv4 Address, when hardware lookup is disable. Value Type: sai_ip_address_t Flags: CREATE_ONLY Default value: 0.0.0.0 Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
SAI_TWAMP_SESSION_ATTR_TUNNEL_VNI	VXLAN tunnel VNI, when hardware lookup is disable. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
SAI_TWAMP_SESSION_ATTR_TUNNEL_UDP_SRC_PORT	VXLAN tunnel L4 header UDP Source port, when hardware lookup is disable. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
SAI_TWAMP_SESSION_ATTR_TUNNEL_UDP_DST_PORT	VXLAN tunnel L4 header UDP Destination port, when hardware lookup is disable. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE == SAI_TWAMP_ENCAPSULATION_TYPE_VXLAN
SAI_TWAMP_SESSION_ATTR_TWAMP_ENCAPSULATION_TYPE	Encapsulation type. Value Type: sai_twamp_encapsulation_type_t Flags: CREATE_ONLY Default value: SAI_TWAMP_ENCAPSULATION_TYPE_IP
SAI_TWAMP_SESSION_ATTR_TWAMP_TIMESTAMP_FORMAT	The format of timestamp in test packets. Value Type: sai_twamp_timestamp_format_t Flags: CREATE_ONLY Default value: SAI_TWAMP_TIMESTAMP_FORMAT_NTP
SAI_TWAMP_SESSION_ATTR_SESSION_ENABLE_TRANSMIT	To enable Two-Way Active Measurement Protocol session transmitting packets. Value Type: bool Flags: CREATE_AND_SET Default value: false Valid only when: SAI_TWAMP_SESSION_ATTR_SESSION_ROLE == SAI_TWAMP_SESSION_ROLE_SENDER
SAI_TWAMP_SESSION_ATTR_PACKET_LENGTH	Two-Way Active Measurement Protocol packet length. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 256
SAI_TWAMP_SESSION_ATTR_PORT	Two-Way Active Measurement Protocol test port. Value Type: sai_object_id_t Flags: CREATE_ONLY Allowed object types SAI_OBJECT_TYPE_PORT Allows NULL object ID true Default value: SAI_NULL_OBJECT_ID
SAI_TWAMP_SESSION_ATTR_TRANSMIT_PORT	Two-Way Active Measurement Protocol egress port. Value Type: sai_object_id_t Flags: MANDATORY_ON_CREATE \| CREATE_AND_SET Allowed object types SAI_OBJECT_TYPE_PORT Allows NULL object ID true Condition: SAI_TWAMP_SESSION_ATTR_HW_LOOKUP_VALID == false
SAI_TWAMP_SESSION_ATTR_RECEIVE_PORT	Receiving port of Two-Way Active Measurement Protocol sender and reflector, enable ACL lookup on this port for match test packets to Two-Way Active Measurement Protocol engine. Value Type: sai_object_list_t Flags: CREATE_AND_SET Allowed object types SAI_OBJECT_TYPE_PORT Default value: empty
SAI_TWAMP_SESSION_ATTR_TWAMP_PKT_TX_MODE	Two-Way Active Measurement Protocol packets transmitting mode: CONTINUOUS, PACKET_COUNT, PERIOD. Value Type: sai_twamp_pkt_tx_mode_t Flags: CREATE_ONLY Default value: SAI_TWAMP_PKT_TX_MODE_CONTINUOUS Valid only when: SAI_TWAMP_SESSION_ATTR_SESSION_ROLE == SAI_TWAMP_SESSION_ROLE_SENDER
SAI_TWAMP_SESSION_ATTR_TX_PKT_CNT	Packet count of transmitting test packets. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_SESSION_ROLE == SAI_TWAMP_SESSION_ROLE_SENDER and SAI_TWAMP_SESSION_ATTR_TWAMP_PKT_TX_MODE == SAI_TWAMP_PKT_TX_MODE_PACKET_COUNT
SAI_TWAMP_SESSION_ATTR_TX_PKT_PERIOD	Period duration of transmitting test packets. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 0 Valid only when: SAI_TWAMP_SESSION_ATTR_SESSION_ROLE == SAI_TWAMP_SESSION_ROLE_SENDER and SAI_TWAMP_SESSION_ATTR_TWAMP_PKT_TX_MODE == SAI_TWAMP_PKT_TX_MODE_PERIOD
SAI_TWAMP_SESSION_ATTR_TX_INTERVAL	Interval of transmitting test packets. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 1000 Valid only when: SAI_TWAMP_SESSION_ATTR_SESSION_ROLE == SAI_TWAMP_SESSION_ROLE_SENDER
SAI_TWAMP_SESSION_ATTR_TIMEOUT	Timeout of receiving test packets. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 3 Valid only when: SAI_TWAMP_SESSION_ATTR_SESSION_ROLE == SAI_TWAMP_SESSION_ROLE_SENDER
SAI_TWAMP_SESSION_ATTR_STATISTICS_INTERVAL	Interval of getting statistics and measurement data. Value Type: sai_uint32_t Flags: CREATE_ONLY Default value: 10000 Valid only when: SAI_TWAMP_SESSION_ATTR_SESSION_ROLE == SAI_TWAMP_SESSION_ROLE_SENDER
SAI_TWAMP_SESSION_ATTR_END	End of attributes.
SAI_TWAMP_SESSION_ATTR_CUSTOM_RANGE_START	Custom range base value
SAI_TWAMP_SESSION_ATTR_CUSTOM_RANGE_END	End of custom range base

Definition at line 146 of file saitwamp.h.

◆ _sai_twamp_session_auth_mode_t

enum _sai_twamp_session_auth_mode_t

SAI Two-Way Active Measurement Protocol session authentication mode, there are three modes: unauthenticated, authenticated, and encrypted.

Enumerator
SAI_TWAMP_SESSION_AUTH_MODE_UNAUTHENTICATED	Session session unauthenticated mode
SAI_TWAMP_SESSION_AUTH_MODE_AUTHENTICATED	Session session authenticated mode
SAI_TWAMP_SESSION_AUTH_MODE_ENCRYPTED	Session session encrypted mode

Definition at line 40 of file saitwamp.h.

◆ _sai_twamp_session_role_t

enum _sai_twamp_session_role_t

SAI Two-Way Active Measurement Protocol role.

Enumerator
SAI_TWAMP_SESSION_ROLE_SENDER	Session-sender sends test request packets
SAI_TWAMP_SESSION_ROLE_REFLECTOR	Session-reflector reflects test response packets

Definition at line 56 of file saitwamp.h.

◆ _sai_twamp_session_stat_t

enum _sai_twamp_session_stat_t

Two-Way Active Measurement Protocol Session counter IDs in sai_get_twamp_session_stats() call.

Enumerator
SAI_TWAMP_SESSION_STAT_RX_PACKETS	Rx packet stat
SAI_TWAMP_SESSION_STAT_RX_BYTE	Rx byte stat
SAI_TWAMP_SESSION_STAT_TX_PACKETS	Tx packet stat
SAI_TWAMP_SESSION_STAT_TX_BYTE	Tx byte stat
SAI_TWAMP_SESSION_STAT_DROP_PACKETS	Drop packet stat
SAI_TWAMP_SESSION_STAT_MAX_LATENCY	Packet max latency
SAI_TWAMP_SESSION_STAT_MIN_LATENCY	Packet min latency
SAI_TWAMP_SESSION_STAT_AVG_LATENCY	Packet avg latency
SAI_TWAMP_SESSION_STAT_MAX_JITTER	Packet max jitters
SAI_TWAMP_SESSION_STAT_MIN_JITTER	Packet min jitters
SAI_TWAMP_SESSION_STAT_AVG_JITTER	Packet avg jitters
SAI_TWAMP_SESSION_STAT_FIRST_TS	Session first timestamp
SAI_TWAMP_SESSION_STAT_LAST_TS	Session last timestamp
SAI_TWAMP_SESSION_STAT_DURATION_TS	Session duration timestamp

Definition at line 573 of file saitwamp.h.

◆ _sai_twamp_session_state_t

enum _sai_twamp_session_state_t

SAI TWAMP session state.

Enumerator
SAI_TWAMP_SESSION_STATE_INACTIVE	TWAMP Session is inactive
SAI_TWAMP_SESSION_STATE_ACTIVE	TWAMP Session is active

Definition at line 622 of file saitwamp.h.

◆ _sai_twamp_timestamp_format_t

enum _sai_twamp_timestamp_format_t

SAI Two-Way Active Measurement format of timestamp.

Enumerator
SAI_TWAMP_TIMESTAMP_FORMAT_NTP	Packet timestamp format is Network Time Protocol format, 32 bit second and 32 bit fractional part of second.
SAI_TWAMP_TIMESTAMP_FORMAT_PTP	Packet timestamp format is PTP format, 32 bit second and 32 bit nanosecond.

Definition at line 102 of file saitwamp.h.

Classes

Typedefs

Enumerations

Detailed Description

Typedef Documentation

◆ sai_clear_twamp_session_stats_fn

◆ sai_create_twamp_session_fn

◆ sai_get_twamp_session_attribute_fn

◆ sai_get_twamp_session_stats_ext_fn

◆ sai_get_twamp_session_stats_fn

◆ sai_remove_twamp_session_fn

◆ sai_set_twamp_session_attribute_fn

◆ sai_twamp_session_event_notification_fn

◆ sai_twamp_session_stats_data_t

Enumeration Type Documentation

◆ _sai_twamp_encapsulation_type_t

◆ _sai_twamp_mode_t

◆ _sai_twamp_pkt_tx_mode_t

◆ _sai_twamp_session_attr_t

◆ _sai_twamp_session_auth_mode_t

◆ _sai_twamp_session_role_t

◆ _sai_twamp_session_stat_t

◆ _sai_twamp_session_state_t

◆ _sai_twamp_timestamp_format_t