SAI Metadata
Loading...
Searching...
No Matches
SAI - Isolation group specific API definitions

Classes

struct  _sai_isolation_group_api_t
 Isolation group method table retrieved with sai_api_query() More...
 

Typedefs

typedef enum _sai_isolation_group_type_t sai_isolation_group_type_t
 Isolation group type.
 
typedef enum _sai_isolation_group_attr_t sai_isolation_group_attr_t
 Attributes for isolation group.
 
typedef enum _sai_isolation_group_member_attr_t sai_isolation_group_member_attr_t
 
typedef sai_status_t(* sai_create_isolation_group_fn) (_Out_ sai_object_id_t *isolation_group_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
 Create isolation group.
 
typedef sai_status_t(* sai_remove_isolation_group_fn) (_In_ sai_object_id_t isolation_group_id)
 Remove isolation group.
 
typedef sai_status_t(* sai_set_isolation_group_attribute_fn) (_In_ sai_object_id_t isolation_group_id, _In_ const sai_attribute_t *attr)
 Set isolation group attribute.
 
typedef sai_status_t(* sai_get_isolation_group_attribute_fn) (_In_ sai_object_id_t isolation_group_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
 Get isolation group attribute.
 
typedef sai_status_t(* sai_create_isolation_group_member_fn) (_Out_ sai_object_id_t *isolation_group_member_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
 Create isolation group member.
 
typedef sai_status_t(* sai_remove_isolation_group_member_fn) (_In_ sai_object_id_t isolation_group_member_id)
 Remove isolation group member.
 
typedef sai_status_t(* sai_set_isolation_group_member_attribute_fn) (_In_ sai_object_id_t isolation_group_member_id, _In_ const sai_attribute_t *attr)
 Set isolation group member attribute.
 
typedef sai_status_t(* sai_get_isolation_group_member_attribute_fn) (_In_ sai_object_id_t isolation_group_member_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
 Get isolation group member attribute.
 
typedef struct _sai_isolation_group_api_t sai_isolation_group_api_t
 Isolation group method table retrieved with sai_api_query()
 

Enumerations

enum  _sai_isolation_group_type_t { SAI_ISOLATION_GROUP_TYPE_PORT , SAI_ISOLATION_GROUP_TYPE_BRIDGE_PORT }
 Isolation group type. More...
 
enum  _sai_isolation_group_attr_t {
  SAI_ISOLATION_GROUP_ATTR_START , SAI_ISOLATION_GROUP_ATTR_TYPE = SAI_ISOLATION_GROUP_ATTR_START , SAI_ISOLATION_GROUP_ATTR_ISOLATION_MEMBER_LIST , SAI_ISOLATION_GROUP_ATTR_END ,
  SAI_ISOLATION_GROUP_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_ISOLATION_GROUP_ATTR_CUSTOM_RANGE_END
}
 Attributes for isolation group. More...
 
enum  _sai_isolation_group_member_attr_t {
  SAI_ISOLATION_GROUP_MEMBER_ATTR_START , SAI_ISOLATION_GROUP_MEMBER_ATTR_ISOLATION_GROUP_ID = SAI_ISOLATION_GROUP_MEMBER_ATTR_START , SAI_ISOLATION_GROUP_MEMBER_ATTR_ISOLATION_OBJECT , SAI_ISOLATION_GROUP_MEMBER_ATTR_END ,
  SAI_ISOLATION_GROUP_MEMBER_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_ISOLATION_GROUP_MEMBER_ATTR_CUSTOM_RANGE_END
}
 

Detailed Description

Typedef Documentation

◆ sai_create_isolation_group_fn

typedef sai_status_t(* sai_create_isolation_group_fn) (_Out_ sai_object_id_t *isolation_group_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create isolation group.

Parameters
[out]isolation_group_idIsolation 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 142 of file saiisolationgroup.h.

◆ sai_create_isolation_group_member_fn

typedef sai_status_t(* sai_create_isolation_group_member_fn) (_Out_ sai_object_id_t *isolation_group_member_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create isolation group member.

Parameters
[out]isolation_group_member_idIsolation 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 194 of file saiisolationgroup.h.

◆ sai_get_isolation_group_attribute_fn

typedef sai_status_t(* sai_get_isolation_group_attribute_fn) (_In_ sai_object_id_t isolation_group_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get isolation group attribute.

Parameters
[in]isolation_group_idIsolation 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 179 of file saiisolationgroup.h.

◆ sai_get_isolation_group_member_attribute_fn

typedef sai_status_t(* sai_get_isolation_group_member_attribute_fn) (_In_ sai_object_id_t isolation_group_member_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get isolation group member attribute.

Parameters
[in]isolation_group_member_idIsolation 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 231 of file saiisolationgroup.h.

◆ sai_remove_isolation_group_fn

typedef sai_status_t(* sai_remove_isolation_group_fn) (_In_ sai_object_id_t isolation_group_id)

Remove isolation group.

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

Definition at line 155 of file saiisolationgroup.h.

◆ sai_remove_isolation_group_member_fn

typedef sai_status_t(* sai_remove_isolation_group_member_fn) (_In_ sai_object_id_t isolation_group_member_id)

Remove isolation group member.

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

Definition at line 207 of file saiisolationgroup.h.

◆ sai_set_isolation_group_attribute_fn

typedef sai_status_t(* sai_set_isolation_group_attribute_fn) (_In_ sai_object_id_t isolation_group_id, _In_ const sai_attribute_t *attr)

Set isolation group attribute.

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

Definition at line 166 of file saiisolationgroup.h.

◆ sai_set_isolation_group_member_attribute_fn

typedef sai_status_t(* sai_set_isolation_group_member_attribute_fn) (_In_ sai_object_id_t isolation_group_member_id, _In_ const sai_attribute_t *attr)

Set isolation group member attribute.

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

Definition at line 218 of file saiisolationgroup.h.

Enumeration Type Documentation

◆ _sai_isolation_group_attr_t

Attributes for isolation group.

Enumerator
SAI_ISOLATION_GROUP_ATTR_START 

Start of attributes.

SAI_ISOLATION_GROUP_ATTR_TYPE 

Isolation group type.

Value Type:
sai_isolation_group_type_t
Flags:
MANDATORY_ON_CREATE | CREATE_ONLY
SAI_ISOLATION_GROUP_ATTR_ISOLATION_MEMBER_LIST 

Isolation group member list.

Value Type:
sai_object_list_t
Flags:
READ_ONLY
Allowed object types
SAI_OBJECT_TYPE_ISOLATION_GROUP_MEMBER
SAI_ISOLATION_GROUP_ATTR_END 

End of attributes.

SAI_ISOLATION_GROUP_ATTR_CUSTOM_RANGE_START 

Custom range base value

SAI_ISOLATION_GROUP_ATTR_CUSTOM_RANGE_END 

End of custom range base

Definition at line 52 of file saiisolationgroup.h.

◆ _sai_isolation_group_member_attr_t

Enumerator
SAI_ISOLATION_GROUP_MEMBER_ATTR_START 

Start of attributes.

SAI_ISOLATION_GROUP_MEMBER_ATTR_ISOLATION_GROUP_ID 

Isolation group id.

Value Type:
sai_object_id_t
Flags:
MANDATORY_ON_CREATE | CREATE_ONLY
Allowed object types
SAI_OBJECT_TYPE_ISOLATION_GROUP
SAI_ISOLATION_GROUP_MEMBER_ATTR_ISOLATION_OBJECT 

Isolation group member object.

If the isolation group type is SAI_ISOLATION_GROUP_TYPE_PORT, then the object should be of type SAI_OBJECT_TYPE_PORT. If the isolation group type is SAI_ISOLATION_GROUP_TYPE_BRIDGE_PORT, then the object should be of type SAI_OBJECT_TYPE_BRIDGE_PORT.

Value Type:
sai_object_id_t
Flags:
MANDATORY_ON_CREATE | CREATE_ONLY
Allowed object types
SAI_OBJECT_TYPE_PORT, SAI_OBJECT_TYPE_BRIDGE_PORT
SAI_ISOLATION_GROUP_MEMBER_ATTR_END 

End of attributes.

SAI_ISOLATION_GROUP_MEMBER_ATTR_CUSTOM_RANGE_START 

Custom range base value

SAI_ISOLATION_GROUP_MEMBER_ATTR_CUSTOM_RANGE_END 

End of custom range base

Definition at line 89 of file saiisolationgroup.h.

◆ _sai_isolation_group_type_t

Isolation group type.

Enumerator
SAI_ISOLATION_GROUP_TYPE_PORT 

Isolation group consists of ports.

SAI_ISOLATION_GROUP_TYPE_BRIDGE_PORT 

Isolation group consists of bridge ports.

Definition at line 39 of file saiisolationgroup.h.