SAI Metadata
|
This module defines SAI TAM (Telemetry And Monitoring) spec. More...
#include <saitypes.h>
Go to the source code of this file.
Classes | |
struct | _sai_tam_api_t |
SAI TAM API set. More... | |
Typedefs | |
typedef enum _sai_tam_attr_t | sai_tam_attr_t |
TAM Attributes. | |
typedef sai_status_t(* | sai_create_tam_fn) (_Out_ sai_object_id_t *tam_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a TAM object. | |
typedef sai_status_t(* | sai_remove_tam_fn) (_In_ sai_object_id_t tam_id) |
Deletes a specified tam object. | |
typedef sai_status_t(* | sai_set_tam_attribute_fn) (_In_ sai_object_id_t tam_id, _In_ const sai_attribute_t *attr) |
Set TAM attribute value(s). | |
typedef sai_status_t(* | sai_get_tam_attribute_fn) (_In_ sai_object_id_t tam_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified TAM attributes. | |
typedef enum _sai_tam_tel_math_func_type_t | sai_tam_tel_math_func_type_t |
TAM Telemetry Math Function types. | |
typedef enum _sai_tam_math_func_attr_t | sai_tam_math_func_attr_t |
Attributes for Math function. | |
typedef sai_status_t(* | sai_create_tam_math_func_fn) (_Out_ sai_object_id_t *tam_math_func_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a math function object. | |
typedef sai_status_t(* | sai_remove_tam_math_func_fn) (_In_ sai_object_id_t tam_math_func_id) |
Deletes a specified Match function object. | |
typedef sai_status_t(* | sai_get_tam_math_func_attribute_fn) (_In_ sai_object_id_t tam_math_func_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified Math function attributes. | |
typedef sai_status_t(* | sai_set_tam_math_func_attribute_fn) (_In_ sai_object_id_t tam_math_func_id, _In_ const sai_attribute_t *attr) |
Set value for specified Math function attribute. | |
typedef enum _sai_tam_event_threshold_unit_t | sai_tam_event_threshold_unit_t |
TAM event threshold unit. | |
typedef enum _sai_tam_event_threshold_attr_t | sai_tam_event_threshold_attr_t |
Event Threshold Attributes. | |
typedef sai_status_t(* | sai_create_tam_event_threshold_fn) (_Out_ sai_object_id_t *tam_event_threshold_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a threshold object. | |
typedef sai_status_t(* | sai_remove_tam_event_threshold_fn) (_In_ sai_object_id_t tam_event_threshold_id) |
Deletes a specified threshold object. | |
typedef sai_status_t(* | sai_get_tam_event_threshold_attribute_fn) (_In_ sai_object_id_t tam_event_threshold_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified threshold object attributes. | |
typedef sai_status_t(* | sai_set_tam_event_threshold_attribute_fn) (_In_ sai_object_id_t tam_event_threshold_id, _In_ const sai_attribute_t *attr) |
Set value for a specified threshold object attribute. | |
typedef enum _sai_tam_int_type_t | sai_tam_int_type_t |
TAM INT types. | |
typedef enum _sai_tam_int_presence_type_t | sai_tam_int_presence_type_t |
Type of indication of INT presence in a packet. | |
typedef enum _sai_tam_int_attr_t | sai_tam_int_attr_t |
Attributes for TAM INT. | |
typedef sai_status_t(* | sai_create_tam_int_fn) (_Out_ sai_object_id_t *tam_int_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a INT type object. | |
typedef sai_status_t(* | sai_remove_tam_int_fn) (_In_ sai_object_id_t tam_int_id) |
Deletes a specified INT object. | |
typedef sai_status_t(* | sai_get_tam_int_attribute_fn) (_In_ sai_object_id_t tam_int_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified INT object attributes. | |
typedef sai_status_t(* | sai_set_tam_int_attribute_fn) (_In_ sai_object_id_t tam_int_id, _In_ const sai_attribute_t *attr) |
Set value for a specified INT object attribute. | |
typedef enum _sai_tam_telemetry_type_t | sai_tam_telemetry_type_t |
TAM telemetry types supported. | |
typedef enum _sai_tam_tel_type_attr_t | sai_tam_tel_type_attr_t |
Telemetry type attributes. | |
typedef sai_status_t(* | sai_create_tam_tel_type_fn) (_Out_ sai_object_id_t *tam_tel_type_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a telemetry type object. | |
typedef sai_status_t(* | sai_remove_tam_tel_type_fn) (_In_ sai_object_id_t tam_tel_type_id) |
Deletes a specified telemetry type object. | |
typedef sai_status_t(* | sai_get_tam_tel_type_attribute_fn) (_In_ sai_object_id_t tam_tel_type_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified telemetry type object attributes. | |
typedef sai_status_t(* | sai_set_tam_tel_type_attribute_fn) (_In_ sai_object_id_t tam_tel_type_id, _In_ const sai_attribute_t *attr) |
Set value for a specified telemetry type object attribute. | |
typedef enum _sai_tam_report_type_t | sai_tam_report_type_t |
TAM report types. | |
typedef enum _sai_tam_report_mode_t | sai_tam_report_mode_t |
Enum defining reporting modes. | |
typedef enum _sai_tam_report_interval_unit_t | sai_tam_report_interval_unit_t |
TAM report interval units. | |
typedef enum _sai_tam_report_attr_t | sai_tam_report_attr_t |
Attributes for TAM report. | |
typedef sai_status_t(* | sai_create_tam_report_fn) (_Out_ sai_object_id_t *tam_report_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a report object id. | |
typedef sai_status_t(* | sai_remove_tam_report_fn) (_In_ sai_object_id_t tam_report_id) |
Deletes a specified report object. | |
typedef sai_status_t(* | sai_get_tam_report_attribute_fn) (_In_ sai_object_id_t tam_report_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified report object attributes. | |
typedef sai_status_t(* | sai_set_tam_report_attribute_fn) (_In_ sai_object_id_t tam_report_id, _In_ const sai_attribute_t *attr) |
Set value for a specified report object attribute. | |
typedef enum _sai_tam_reporting_unit_t | sai_tam_reporting_unit_t |
TAM reporting unit. | |
typedef enum _sai_tam_telemetry_attr_t | sai_tam_telemetry_attr_t |
TAM telemetry attributes. | |
typedef sai_status_t(* | sai_create_tam_telemetry_fn) (_Out_ sai_object_id_t *tam_telemetry_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a telemetry object. | |
typedef sai_status_t(* | sai_remove_tam_telemetry_fn) (_In_ sai_object_id_t tam_telemetry_id) |
Deletes a specified telemetry object. | |
typedef sai_status_t(* | sai_get_tam_telemetry_attribute_fn) (_In_ sai_object_id_t tam_telemetry_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified telemetry object attributes. | |
typedef sai_status_t(* | sai_set_tam_telemetry_attribute_fn) (_In_ sai_object_id_t tam_telemetry_id, _In_ const sai_attribute_t *attr) |
Set value for a specified telemetry object attribute. | |
typedef enum _sai_tam_transport_type_t | sai_tam_transport_type_t |
Transport Types. | |
typedef enum _sai_tam_transport_auth_type_t | sai_tam_transport_auth_type_t |
Transport Authentication Types. | |
typedef enum _sai_tam_transport_attr_t | sai_tam_transport_attr_t |
Transport object Attributes. | |
typedef sai_status_t(* | sai_create_tam_transport_fn) (_Out_ sai_object_id_t *tam_transport_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a transport object id. | |
typedef sai_status_t(* | sai_remove_tam_transport_fn) (_In_ sai_object_id_t tam_transport_id) |
Deletes a specified transport object. | |
typedef sai_status_t(* | sai_get_tam_transport_attribute_fn) (_In_ sai_object_id_t tam_transport_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified transport object attributes. | |
typedef sai_status_t(* | sai_set_tam_transport_attribute_fn) (_In_ sai_object_id_t tam_transport_id, _In_ const sai_attribute_t *attr) |
Set value for a specified transport object attribute. | |
typedef enum _sai_tam_collector_attr_t | sai_tam_collector_attr_t |
TAM collector attributes. | |
typedef sai_status_t(* | sai_create_tam_collector_fn) (_Out_ sai_object_id_t *tam_collector_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a collector object id. | |
typedef sai_status_t(* | sai_remove_tam_collector_fn) (_In_ sai_object_id_t tam_collector_id) |
Deletes a specified collector object. | |
typedef sai_status_t(* | sai_get_tam_collector_attribute_fn) (_In_ sai_object_id_t tam_collector_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified collector object attributes. | |
typedef sai_status_t(* | sai_set_tam_collector_attribute_fn) (_In_ sai_object_id_t tam_collector_id, _In_ const sai_attribute_t *attr) |
Set value for a specified collector object attribute. | |
typedef enum _sai_tam_event_type_t | sai_tam_event_type_t |
Enum defining event types. | |
typedef enum _sai_tam_event_action_attr_t | sai_tam_event_action_attr_t |
Enum defining event types. | |
typedef sai_status_t(* | sai_create_tam_event_action_fn) (_Out_ sai_object_id_t *tam_event_action_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a event action object id. | |
typedef sai_status_t(* | sai_remove_tam_event_action_fn) (_In_ sai_object_id_t tam_event_action_id) |
Deletes a specified event object. | |
typedef sai_status_t(* | sai_get_tam_event_action_attribute_fn) (_In_ sai_object_id_t tam_event_action_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified event object attributes. | |
typedef sai_status_t(* | sai_set_tam_event_action_attribute_fn) (_In_ sai_object_id_t tam_event_action_id, _In_ const sai_attribute_t *attr) |
Set value for a specified event object attribute. | |
typedef enum _sai_tam_event_attr_t | sai_tam_event_attr_t |
Tam event attributes. | |
typedef sai_status_t(* | sai_create_tam_event_fn) (_Out_ sai_object_id_t *tam_event_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create and return a event object id. | |
typedef sai_status_t(* | sai_remove_tam_event_fn) (_In_ sai_object_id_t tam_event_id) |
Deletes a specified event object. | |
typedef sai_status_t(* | sai_get_tam_event_attribute_fn) (_In_ sai_object_id_t tam_event_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified event object attributes. | |
typedef sai_status_t(* | sai_set_tam_event_attribute_fn) (_In_ sai_object_id_t tam_event_id, _In_ const sai_attribute_t *attr) |
Set value for a specified event object attribute. | |
typedef enum _sai_tam_counter_subscription_attr_t | sai_tam_counter_subscription_attr_t |
Counter Subscription attributes. | |
typedef sai_status_t(* | sai_create_tam_counter_subscription_fn) (_Out_ sai_object_id_t *tam_counter_subscription_id, _In_ sai_object_id_t switch_id, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
Create a counter subscription. | |
typedef sai_status_t(* | sai_remove_tam_counter_subscription_fn) (_In_ sai_object_id_t tam_counter_subscription_id) |
Delete a specified counter subscription. | |
typedef sai_status_t(* | sai_set_tam_counter_subscription_attribute_fn) (_In_ sai_object_id_t tam_counter_subscription_id, _In_ const sai_attribute_t *attr) |
Set value for a specified counter subscription object attribute. | |
typedef sai_status_t(* | sai_get_tam_counter_subscription_attribute_fn) (_In_ sai_object_id_t tam_counter_subscription_id, _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list) |
Get values for specified event object attributes. | |
typedef void(* | sai_tam_event_notification_fn) (_In_ sai_object_id_t tam_event_id, _In_ sai_size_t buffer_size, _In_ const void *buffer, _In_ uint32_t attr_count, _In_ const sai_attribute_t *attr_list) |
TAM event callback. | |
typedef struct _sai_tam_api_t | sai_tam_api_t |
SAI TAM API set. | |
Functions | |
sai_status_t | sai_tam_telemetry_get_data (_In_ sai_object_id_t switch_id, _In_ sai_object_list_t obj_list, _In_ bool clear_on_read, _Inout_ sai_size_t *buffer_size, _Out_ void *buffer) |
TAM telemetry data get API. | |
This module defines SAI TAM (Telemetry And Monitoring) spec.
Copyright (c) 2014 Microsoft Open Technologies, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
THIS CODE IS PROVIDED ON AN AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY OR NON-INFRINGEMENT.
See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.
Microsoft would like to thank the following companies for their review and assistance with these files: Intel Corporation, Mellanox Technologies Ltd, Dell Products, L.P., Facebook, Inc., Marvell International Ltd.
Definition in file saitam.h.