SAI Metadata
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations
SAI - RPF group specific API definitions

Classes

struct  _sai_rpf_group_api_t
 RPF group methods table retrieved with sai_api_query() More...
 

Typedefs

typedef enum _sai_rpf_group_attr_t sai_rpf_group_attr_t
 Attributes for RPF interface group.
 
typedef enum _sai_rpf_group_member_attr_t sai_rpf_group_member_attr_t
 
typedef sai_status_t(* sai_create_rpf_group_fn) (_Out_ sai_object_id_t *rpf_group_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
 Create RPF interface group.
 
typedef sai_status_t(* sai_remove_rpf_group_fn) (_In_ sai_object_id_t rpf_group_id)
 Remove RPF interface group.
 
typedef sai_status_t(* sai_set_rpf_group_attribute_fn) (_In_ sai_object_id_t rpf_group_id, _In_ const sai_attribute_t *attr)
 Set RPF interface Group attribute.
 
typedef sai_status_t(* sai_get_rpf_group_attribute_fn) (_In_ sai_object_id_t rpf_group_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
 Get RPF interface Group attribute.
 
typedef sai_status_t(* sai_create_rpf_group_member_fn) (_Out_ sai_object_id_t *rpf_group_member_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
 Create RPF interface group member.
 
typedef sai_status_t(* sai_remove_rpf_group_member_fn) (_In_ sai_object_id_t rpf_group_member_id)
 Remove RPF interface group member.
 
typedef sai_status_t(* sai_set_rpf_group_member_attribute_fn) (_In_ sai_object_id_t rpf_group_member_id, _In_ const sai_attribute_t *attr)
 Set RPF interface Group attribute.
 
typedef sai_status_t(* sai_get_rpf_group_member_attribute_fn) (_In_ sai_object_id_t rpf_group_member_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
 Get RPF interface Group attribute.
 
typedef struct _sai_rpf_group_api_t sai_rpf_group_api_t
 RPF group methods table retrieved with sai_api_query()
 

Enumerations

enum  _sai_rpf_group_attr_t {
  SAI_RPF_GROUP_ATTR_START , SAI_RPF_GROUP_ATTR_RPF_INTERFACE_COUNT = SAI_RPF_GROUP_ATTR_START , SAI_RPF_GROUP_ATTR_RPF_MEMBER_LIST , SAI_RPF_GROUP_ATTR_END ,
  SAI_RPF_GROUP_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_RPF_GROUP_ATTR_CUSTOM_RANGE_END
}
 Attributes for RPF interface group. More...
 
enum  _sai_rpf_group_member_attr_t {
  SAI_RPF_GROUP_MEMBER_ATTR_START , SAI_RPF_GROUP_MEMBER_ATTR_RPF_GROUP_ID = SAI_RPF_GROUP_MEMBER_ATTR_START , SAI_RPF_GROUP_MEMBER_ATTR_RPF_INTERFACE_ID , SAI_RPF_GROUP_MEMBER_ATTR_END ,
  SAI_RPF_GROUP_MEMBER_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_RPF_GROUP_MEMBER_ATTR_CUSTOM_RANGE_END
}
 

Detailed Description

Typedef Documentation

◆ sai_create_rpf_group_fn

typedef sai_status_t(* sai_create_rpf_group_fn) (_Out_ sai_object_id_t *rpf_group_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create RPF interface group.

Parameters
[out]rpf_group_idRPF interface group id
[in]switch_idSwitch id
[in]attr_countNumber of attributes
[in]attr_listArray of attributes
Returns
SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 124 of file sairpfgroup.h.

◆ sai_create_rpf_group_member_fn

typedef sai_status_t(* sai_create_rpf_group_member_fn) (_Out_ sai_object_id_t *rpf_group_member_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create RPF interface group member.

Parameters
[out]rpf_group_member_idRPF interface group member id
[in]switch_idSwitch ID
[in]attr_countNumber of attributes
[in]attr_listArray of attributes
Returns
SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 176 of file sairpfgroup.h.

◆ sai_get_rpf_group_attribute_fn

typedef sai_status_t(* sai_get_rpf_group_attribute_fn) (_In_ sai_object_id_t rpf_group_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get RPF interface Group attribute.

Parameters
[in]rpf_group_idRPF interface group id
[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 161 of file sairpfgroup.h.

◆ sai_get_rpf_group_member_attribute_fn

typedef sai_status_t(* sai_get_rpf_group_member_attribute_fn) (_In_ sai_object_id_t rpf_group_member_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get RPF interface Group attribute.

Parameters
[in]rpf_group_member_idRPF group member ID
[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 213 of file sairpfgroup.h.

◆ sai_remove_rpf_group_fn

typedef sai_status_t(* sai_remove_rpf_group_fn) (_In_ sai_object_id_t rpf_group_id)

Remove RPF interface group.

Parameters
[in]rpf_group_idRPF interface group id
Returns
SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 137 of file sairpfgroup.h.

◆ sai_remove_rpf_group_member_fn

typedef sai_status_t(* sai_remove_rpf_group_member_fn) (_In_ sai_object_id_t rpf_group_member_id)

Remove RPF interface group member.

Parameters
[in]rpf_group_member_idRPF interface group member id
Returns
SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 189 of file sairpfgroup.h.

◆ sai_set_rpf_group_attribute_fn

typedef sai_status_t(* sai_set_rpf_group_attribute_fn) (_In_ sai_object_id_t rpf_group_id, _In_ const sai_attribute_t *attr)

Set RPF interface Group attribute.

Parameters
[in]rpf_group_idRPF interface group id
[in]attrAttribute
Returns
SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 148 of file sairpfgroup.h.

◆ sai_set_rpf_group_member_attribute_fn

typedef sai_status_t(* sai_set_rpf_group_member_attribute_fn) (_In_ sai_object_id_t rpf_group_member_id, _In_ const sai_attribute_t *attr)

Set RPF interface Group attribute.

Parameters
[in]rpf_group_member_idRPF interface group member id
[in]attrAttribute
Returns
SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 200 of file sairpfgroup.h.

Enumeration Type Documentation

◆ _sai_rpf_group_attr_t

enum _sai_rpf_group_attr_t

Attributes for RPF interface group.

Enumerator
SAI_RPF_GROUP_ATTR_START 

Start of attributes.

SAI_RPF_GROUP_ATTR_RPF_INTERFACE_COUNT 

Number of RPF interfaces in the group.

Value Type:
sai_uint32_t
Flags:
READ_ONLY
SAI_RPF_GROUP_ATTR_RPF_MEMBER_LIST 

RPF member list.

Value Type:
sai_object_list_t
Flags:
READ_ONLY
Allowed object types
SAI_OBJECT_TYPE_RPF_GROUP_MEMBER
SAI_RPF_GROUP_ATTR_END 

End of attributes.

SAI_RPF_GROUP_ATTR_CUSTOM_RANGE_START 

Custom range base value

SAI_RPF_GROUP_ATTR_CUSTOM_RANGE_END 

End of custom range base

Definition at line 39 of file sairpfgroup.h.

◆ _sai_rpf_group_member_attr_t

enum _sai_rpf_group_member_attr_t
Enumerator
SAI_RPF_GROUP_MEMBER_ATTR_START 

Start of attributes.

SAI_RPF_GROUP_MEMBER_ATTR_RPF_GROUP_ID 

RPF interface group id.

Value Type:
sai_object_id_t
Flags:
MANDATORY_ON_CREATE | CREATE_ONLY
Allowed object types
SAI_OBJECT_TYPE_RPF_GROUP
SAI_RPF_GROUP_MEMBER_ATTR_RPF_INTERFACE_ID 

RPF interface id.

Value Type:
sai_object_id_t
Flags:
MANDATORY_ON_CREATE | CREATE_ONLY
Allowed object types
SAI_OBJECT_TYPE_ROUTER_INTERFACE
SAI_RPF_GROUP_MEMBER_ATTR_END 

End of attributes.

SAI_RPF_GROUP_MEMBER_ATTR_CUSTOM_RANGE_START 

Custom range base value

SAI_RPF_GROUP_MEMBER_ATTR_CUSTOM_RANGE_END 

End of custom range base

Definition at line 76 of file sairpfgroup.h.