SAI - Router specific API definitions

Classes
struct	_sai_virtual_router_api_t
	Virtual router methods table retrieved with sai_api_query() More...

Typedefs
typedef enum _sai_virtual_router_attr_t	sai_virtual_router_attr_t
	Attribute Id in sai_set_virtual_router_attribute() and sai_get_virtual_router_attribute() calls.
typedef sai_status_t(*	sai_create_virtual_router_fn) (_Out_ sai_object_id_t *virtual_router_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)
	Create virtual router.
typedef sai_status_t(*	sai_remove_virtual_router_fn) (_In_ sai_object_id_t virtual_router_id)
	Remove virtual router.
typedef sai_status_t(*	sai_set_virtual_router_attribute_fn) (_In_ sai_object_id_t virtual_router_id, _In_ const sai_attribute_t *attr)
	Set virtual router attribute Value.
typedef sai_status_t(*	sai_get_virtual_router_attribute_fn) (_In_ sai_object_id_t virtual_router_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)
	Get virtual router attribute Value.
typedef struct _sai_virtual_router_api_t	sai_virtual_router_api_t
	Virtual router methods table retrieved with sai_api_query()

Enumerations
enum	_sai_virtual_router_attr_t {   SAI_VIRTUAL_ROUTER_ATTR_START , SAI_VIRTUAL_ROUTER_ATTR_ADMIN_V4_STATE = SAI_VIRTUAL_ROUTER_ATTR_START , SAI_VIRTUAL_ROUTER_ATTR_ADMIN_V6_STATE , SAI_VIRTUAL_ROUTER_ATTR_SRC_MAC_ADDRESS ,   SAI_VIRTUAL_ROUTER_ATTR_VIOLATION_TTL1_PACKET_ACTION , SAI_VIRTUAL_ROUTER_ATTR_VIOLATION_IP_OPTIONS_PACKET_ACTION , SAI_VIRTUAL_ROUTER_ATTR_UNKNOWN_L3_MULTICAST_PACKET_ACTION , SAI_VIRTUAL_ROUTER_ATTR_LABEL ,   SAI_VIRTUAL_ROUTER_ATTR_END , SAI_VIRTUAL_ROUTER_ATTR_CUSTOM_RANGE_START = 0x10000000 , SAI_VIRTUAL_ROUTER_ATTR_CUSTOM_RANGE_END }
	Attribute Id in sai_set_virtual_router_attribute() and sai_get_virtual_router_attribute() calls. More...

Detailed Description

Typedef Documentation

sai_create_virtual_router_fn

typedef sai_status_t(* sai_create_virtual_router_fn) (_Out_ sai_object_id_t *virtual_router_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list)

Create virtual router.

Parameters

[out]	virtual_router_id	Virtual router id
[in]	switch_id	Switch id
[in]	attr_count	Number of attributes
[in]	attr_list	Array of attributes

Returns

SAI_STATUS_SUCCESS on success SAI_STATUS_ADDR_NOT_FOUND if neither SAI_SWITCH_ATTR_SRC_MAC_ADDRESS nor SAI_VIRTUAL_ROUTER_ATTR_SRC_MAC_ADDRESS is set.

Definition at line 143 of file saivirtualrouter.h.

sai_get_virtual_router_attribute_fn

typedef sai_status_t(* sai_get_virtual_router_attribute_fn) (_In_ sai_object_id_t virtual_router_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list)

Get virtual router attribute Value.

Parameters

[in]	virtual_router_id	Virtual router id
[in]	attr_count	Number of attributes
[in,out]	attr_list	Array of attributes

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 180 of file saivirtualrouter.h.

sai_remove_virtual_router_fn

typedef sai_status_t(* sai_remove_virtual_router_fn) (_In_ sai_object_id_t virtual_router_id)

Remove virtual router.

Parameters

[in]

virtual_router_id

Virtual router id

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 156 of file saivirtualrouter.h.

sai_set_virtual_router_attribute_fn

typedef sai_status_t(* sai_set_virtual_router_attribute_fn) (_In_ sai_object_id_t virtual_router_id, _In_ const sai_attribute_t *attr)

Set virtual router attribute Value.

Parameters

[in]	virtual_router_id	Virtual router id
[in]	attr	Attribute

Returns

SAI_STATUS_SUCCESS on success, failure status code on error

Definition at line 167 of file saivirtualrouter.h.

Enumeration Type Documentation

_sai_virtual_router_attr_t

enum _sai_virtual_router_attr_t

Attribute Id in sai_set_virtual_router_attribute() and sai_get_virtual_router_attribute() calls.

Enumerator
SAI_VIRTUAL_ROUTER_ATTR_START	Start of attributes.
SAI_VIRTUAL_ROUTER_ATTR_ADMIN_V4_STATE	Admin V4 state. Value Type: bool Flags: CREATE_AND_SET Default value: true
SAI_VIRTUAL_ROUTER_ATTR_ADMIN_V6_STATE	Admin V6 state. Value Type: bool Flags: CREATE_AND_SET Default value: true
SAI_VIRTUAL_ROUTER_ATTR_SRC_MAC_ADDRESS	MAC Address. Value Type: sai_mac_t Flags: CREATE_AND_SET Default value: attrvalue SAI_SWITCH_ATTR_SRC_MAC_ADDRESS
SAI_VIRTUAL_ROUTER_ATTR_VIOLATION_TTL1_PACKET_ACTION	Action for Packets with TTL 0 or 1. Value Type: sai_packet_action_t Flags: CREATE_AND_SET Default value: SAI_PACKET_ACTION_TRAP
SAI_VIRTUAL_ROUTER_ATTR_VIOLATION_IP_OPTIONS_PACKET_ACTION	Action for Packets with IP options. Value Type: sai_packet_action_t Flags: CREATE_AND_SET Default value: SAI_PACKET_ACTION_TRAP
SAI_VIRTUAL_ROUTER_ATTR_UNKNOWN_L3_MULTICAST_PACKET_ACTION	Action for Unknown L3 multicast Packets. Value Type: sai_packet_action_t Flags: CREATE_AND_SET Default value: SAI_PACKET_ACTION_DROP
SAI_VIRTUAL_ROUTER_ATTR_LABEL	Label attribute used to unique identify empty VR. Value Type: char Flags: CREATE_AND_SET Default value: ""
SAI_VIRTUAL_ROUTER_ATTR_END	End of attributes.
SAI_VIRTUAL_ROUTER_ATTR_CUSTOM_RANGE_START	Custom range base value
SAI_VIRTUAL_ROUTER_ATTR_CUSTOM_RANGE_END	End of custom range base

Definition at line 46 of file saivirtualrouter.h.