SAI Metadata
Loading...
Searching...
No Matches
SAI - Extension specific API definitions

Classes

struct  _sai_outbound_ca_to_pa_entry_t
 Entry for outbound_ca_to_pa_entry. More...
 
struct  _sai_dash_outbound_ca_to_pa_api_t
 

Typedefs

typedef enum _sai_outbound_ca_to_pa_entry_action_t sai_outbound_ca_to_pa_entry_action_t
 Attribute data for SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION.
 
typedef struct _sai_outbound_ca_to_pa_entry_t sai_outbound_ca_to_pa_entry_t
 Entry for outbound_ca_to_pa_entry.
 
typedef enum _sai_outbound_ca_to_pa_entry_attr_t sai_outbound_ca_to_pa_entry_attr_t
 Attribute ID for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.
 
typedef sai_status_t(* sai_create_outbound_ca_to_pa_entry_fn) (_In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
 Create dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.
 
typedef sai_status_t(* sai_remove_outbound_ca_to_pa_entry_fn) (_In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry)
 Remove dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.
 
typedef sai_status_t(* sai_set_outbound_ca_to_pa_entry_attribute_fn) (_In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry, _In_ const sai_attribute_t *attr)
 Set attribute for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.
 
typedef sai_status_t(* sai_get_outbound_ca_to_pa_entry_attribute_fn) (_In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
 Get attribute for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.
 
typedef sai_status_t(* sai_bulk_create_outbound_ca_to_pa_entry_fn) (_In_ uint32_t object_count, _In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_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 dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.
 
typedef sai_status_t(* sai_bulk_remove_outbound_ca_to_pa_entry_fn) (_In_ uint32_t object_count, _In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)
 Bulk remove dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.
 
typedef struct _sai_dash_outbound_ca_to_pa_api_t sai_dash_outbound_ca_to_pa_api_t
 

Enumerations

enum  _sai_outbound_ca_to_pa_entry_action_t { SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_TUNNEL_MAPPING , SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_PRIVATE_LINK_MAPPING }
 Attribute data for SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION. More...
 
enum  _sai_outbound_ca_to_pa_entry_attr_t {
  SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_START , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION = SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_START , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_UNDERLAY_DIP , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_DMAC ,
  SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_USE_DST_VNET_VNI , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_METER_CLASS , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_METER_CLASS_OVERRIDE , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_SIP ,
  SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_DIP , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_DASH_ENCAPSULATION , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_TUNNEL_KEY , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_COUNTER_ID ,
  SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_IP_ADDR_FAMILY , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_END , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_CUSTOM_RANGE_END
}
 Attribute ID for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry. More...
 

Detailed Description

Typedef Documentation

◆ sai_bulk_create_outbound_ca_to_pa_entry_fn

typedef sai_status_t(* sai_bulk_create_outbound_ca_to_pa_entry_fn) (_In_ uint32_t object_count, _In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_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 dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.

Parameters
[in]object_countNumber of objects to create
[in]outbound_ca_to_pa_entryList of object to create
[in]attr_countList of attr_count. Caller passes the number of attribute for each object to create.
[in]attr_listList of attributes for every object.
[in]modeBulk operation error handling mode.
[out]object_statusesList of status for every object. Caller needs to allocate the buffer
Returns
SAI_STATUS_SUCCESS on success when all objects are created or SAI_STATUS_FAILURE when any of the objects fails to create. When there is failure, Caller is expected to go through the list of returned statuses to find out which fails and which succeeds.

Definition at line 285 of file saiexperimentaldashoutboundcatopa.h.

◆ sai_bulk_remove_outbound_ca_to_pa_entry_fn

typedef sai_status_t(* sai_bulk_remove_outbound_ca_to_pa_entry_fn) (_In_ uint32_t object_count, _In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry, _In_ sai_bulk_op_error_mode_t mode, _Out_ sai_status_t *object_statuses)

Bulk remove dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.

Parameters
[in]object_countNumber of objects to remove
[in]outbound_ca_to_pa_entryList of objects to remove
[in]modeBulk operation error handling mode.
[out]object_statusesList of status for every object. Caller needs to allocate the buffer
Returns
SAI_STATUS_SUCCESS on success when all objects are removed or SAI_STATUS_FAILURE when any of the objects fails to remove. When there is failure, Caller is expected to go through the list of returned statuses to find out which fails and which succeeds.

Definition at line 307 of file saiexperimentaldashoutboundcatopa.h.

◆ sai_create_outbound_ca_to_pa_entry_fn

typedef sai_status_t(* sai_create_outbound_ca_to_pa_entry_fn) (_In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.

Parameters
[in]outbound_ca_to_pa_entryEntry
[in]attr_countNumber of attributes
[in]attr_listArray of attributes
Returns
SAI_STATUS_SUCCESS on success Failure status code on error

Definition at line 227 of file saiexperimentaldashoutboundcatopa.h.

◆ sai_get_outbound_ca_to_pa_entry_attribute_fn

typedef sai_status_t(* sai_get_outbound_ca_to_pa_entry_attribute_fn) (_In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get attribute for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.

Parameters
[in]outbound_ca_to_pa_entryEntry
[in]attr_countNumber of attributes
[in,out]attr_listArray of attributes
Returns
SAI_STATUS_SUCCESS on success Failure status code on error

Definition at line 263 of file saiexperimentaldashoutboundcatopa.h.

◆ sai_remove_outbound_ca_to_pa_entry_fn

typedef sai_status_t(* sai_remove_outbound_ca_to_pa_entry_fn) (_In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry)

Remove dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.

Parameters
[in]outbound_ca_to_pa_entryEntry
Returns
SAI_STATUS_SUCCESS on success Failure status code on error

Definition at line 239 of file saiexperimentaldashoutboundcatopa.h.

◆ sai_set_outbound_ca_to_pa_entry_attribute_fn

typedef sai_status_t(* sai_set_outbound_ca_to_pa_entry_attribute_fn) (_In_ const sai_outbound_ca_to_pa_entry_t *outbound_ca_to_pa_entry, _In_ const sai_attribute_t *attr)

Set attribute for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.

Parameters
[in]outbound_ca_to_pa_entryEntry
[in]attrAttribute
Returns
SAI_STATUS_SUCCESS on success Failure status code on error

Definition at line 250 of file saiexperimentaldashoutboundcatopa.h.

Enumeration Type Documentation

◆ _sai_outbound_ca_to_pa_entry_action_t

◆ _sai_outbound_ca_to_pa_entry_attr_t

Attribute ID for dash_outbound_ca_to_pa_outbound_ca_to_pa_entry.

Enumerator
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_START 

Start of attributes.

SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION 

Action.

Value Type:
sai_outbound_ca_to_pa_entry_action_t
Flags:
CREATE_AND_SET
Default value:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_TUNNEL_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_UNDERLAY_DIP 

Action set_tunnel_mapping, set_private_link_mapping parameter UNDERLAY_DIP.

Value Type:
sai_ip_address_t
Flags:
CREATE_AND_SET
Default value:
0.0.0.0
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_TUNNEL_MAPPING or SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_PRIVATE_LINK_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_DMAC 

Action set_tunnel_mapping parameter OVERLAY_DMAC.

Value Type:
sai_mac_t
Flags:
CREATE_AND_SET
Default value:
0:0:0:0:0:0
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_TUNNEL_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_USE_DST_VNET_VNI 

Action set_tunnel_mapping parameter USE_DST_VNET_VNI.

Value Type:
bool
Flags:
CREATE_AND_SET
Default value:
false
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_TUNNEL_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_METER_CLASS 

Action set_tunnel_mapping, set_private_link_mapping parameter METER_CLASS.

Value Type:
sai_uint16_t
Flags:
CREATE_AND_SET
IsVlan:
false
Default value:
0
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_TUNNEL_MAPPING or SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_PRIVATE_LINK_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_METER_CLASS_OVERRIDE 

Action set_tunnel_mapping, set_private_link_mapping parameter METER_CLASS_OVERRIDE.

Value Type:
bool
Flags:
CREATE_AND_SET
Default value:
false
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_TUNNEL_MAPPING or SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_PRIVATE_LINK_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_SIP 

Action set_private_link_mapping parameter OVERLAY_SIP.

Value Type:
sai_ip_address_t
Flags:
CREATE_AND_SET
Default value:
0.0.0.0
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_PRIVATE_LINK_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_OVERLAY_DIP 

Action set_private_link_mapping parameter OVERLAY_DIP.

Value Type:
sai_ip_address_t
Flags:
CREATE_AND_SET
Default value:
0.0.0.0
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_PRIVATE_LINK_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_DASH_ENCAPSULATION 

Action set_private_link_mapping parameter DASH_ENCAPSULATION.

Value Type:
sai_dash_encapsulation_t
Flags:
CREATE_AND_SET
Default value:
SAI_DASH_ENCAPSULATION_INVALID
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_PRIVATE_LINK_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_TUNNEL_KEY 

Action set_private_link_mapping parameter TUNNEL_KEY.

Value Type:
sai_uint32_t
Flags:
CREATE_AND_SET
Default value:
0
Valid only when:
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_ACTION == SAI_OUTBOUND_CA_TO_PA_ENTRY_ACTION_SET_PRIVATE_LINK_MAPPING
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_COUNTER_ID 

Attach a counter.

When it is empty, then packet hits won't be counted

Value Type:
sai_object_id_t
Flags:
CREATE_AND_SET
Allowed object types
SAI_OBJECT_TYPE_COUNTER
Allows NULL object ID
true
Default value:
SAI_NULL_OBJECT_ID
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_IP_ADDR_FAMILY 

IP address family for resource accounting.

Value Type:
sai_ip_addr_family_t
Flags:
READ_ONLY
IsResourceType:
true
SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_END 

End of attributes.

SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_CUSTOM_RANGE_START 

Custom range base value

SAI_OUTBOUND_CA_TO_PA_ENTRY_ATTR_CUSTOM_RANGE_END 

End of custom range base

Definition at line 76 of file saiexperimentaldashoutboundcatopa.h.