:orphan: .. index:: pair: group; SNMP .. _doxid-group__tapi__tad__snmp: SNMP ==== .. toctree:: :hidden: enum_snmp_obj_type.rst enum_tapi_snmp_auth_proto_t.rst enum_tapi_snmp_gen_trap_t.rst enum_tapi_snmp_get_type_t.rst enum_tapi_snmp_mib_access.rst enum_tapi_snmp_mib_status.rst enum_tapi_snmp_priv_proto_t.rst enum_tapi_snmp_sec_level_t.rst enum_tapi_snmp_sec_model_t.rst enum_tapi_snmp_truth_value.rst enum_tapi_snmp_vartypes_t.rst enum_tapi_snmp_vb_cmp_type.rst enum_tapi_snmp_version_t.rst struct_tapi_snmp_common_table_row_s.rst struct_tapi_snmp_message_t.rst struct_tapi_snmp_oct_string_t.rst struct_tapi_snmp_oid_t.rst struct_tapi_snmp_pkt_handler_data.rst struct_tapi_snmp_security_s.rst struct_tapi_snmp_v1_gen_trap_name.rst struct_tapi_snmp_var_access.rst struct_tapi_snmp_varbind_t.rst Overview ~~~~~~~~ Traffic Application Domain Command Handler SNMP protocol implementaion internal declarations. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef enum :ref:`tapi_snmp_version_t` :ref:`tapi_snmp_version_t`; typedef enum :ref:`tapi_snmp_sec_model_t` :ref:`tapi_snmp_sec_model_t`; typedef enum :ref:`tapi_snmp_sec_level_t` :ref:`tapi_snmp_sec_level_t`; typedef enum :ref:`tapi_snmp_auth_proto_t` :ref:`tapi_snmp_auth_proto_t`; typedef enum :ref:`tapi_snmp_priv_proto_t` :ref:`tapi_snmp_priv_proto_t`; typedef enum :ref:`tapi_snmp_vartypes_t` :ref:`tapi_snmp_vartypes_t`; typedef enum :ref:`tapi_snmp_gen_trap_t` :ref:`tapi_snmp_gen_trap_t`; typedef enum :ref:`tapi_snmp_mib_access` :ref:`tapi_snmp_mib_access`; typedef enum :ref:`tapi_snmp_mib_status` :ref:`tapi_snmp_mib_status`; typedef struct :ref:`tapi_snmp_var_access` :ref:`tapi_snmp_var_access`; typedef enum :ref:`tapi_snmp_truth_value` :ref:`tapi_snmp_truth_value`; typedef struct :ref:`tapi_snmp_common_table_row_s` :ref:`tapi_snmp_common_table_row_t`; typedef struct :ref:`tapi_snmp_security_s` :ref:`tapi_snmp_security_t`; typedef int (*:ref:`walk_callback`)( const tapi_snmp_varbind_t *varbind, void *userdata ); typedef void (*:ref:`tapi_snmp_trap_callback`)( const tapi_snmp_message_t *trap, void *user_data ); typedef struct :ref:`tapi_snmp_pkt_handler_data` :ref:`tapi_snmp_pkt_handler_data`; // enums enum :ref:`snmp_obj_type`; enum :ref:`tapi_snmp_auth_proto_t`; enum :ref:`tapi_snmp_gen_trap_t`; enum :ref:`tapi_snmp_get_type_t`; enum :ref:`tapi_snmp_mib_access`; enum :ref:`tapi_snmp_mib_status`; enum :ref:`tapi_snmp_priv_proto_t`; enum :ref:`tapi_snmp_sec_level_t`; enum :ref:`tapi_snmp_sec_model_t`; enum :ref:`tapi_snmp_truth_value`; enum :ref:`tapi_snmp_vartypes_t`; enum :ref:`tapi_snmp_vb_cmp_type`; enum :ref:`tapi_snmp_version_t`; // structs struct :ref:`tapi_snmp_common_table_row_s`; struct :ref:`tapi_snmp_message_t`; struct :ref:`tapi_snmp_oct_string_t`; struct :ref:`tapi_snmp_oid_t`; struct :ref:`tapi_snmp_pkt_handler_data`; struct :ref:`tapi_snmp_security_s`; struct :ref:`tapi_snmp_v1_gen_trap_name`; struct :ref:`tapi_snmp_var_access`; struct :ref:`tapi_snmp_varbind_t`; // global functions int :ref:`tapi_snmp_cat_oid`(:ref:`tapi_snmp_oid_t`* base, const :ref:`tapi_snmp_oid_t`* suffix); int :ref:`tapi_snmp_is_sub_oid`(const :ref:`tapi_snmp_oid_t`* tree, const :ref:`tapi_snmp_oid_t`* node); void :ref:`tapi_snmp_free_varbind`(:ref:`tapi_snmp_varbind_t`* varbind); void :ref:`tapi_snmp_free_message`(:ref:`tapi_snmp_message_t`* snmp_message); :ref:`tapi_snmp_oct_string_t`* :ref:`tapi_snmp_mk_oct_string`(uint8_t* data, size_t data_len); void :ref:`tapi_snmp_free_oct_string`(:ref:`tapi_snmp_oct_string_t`* oct_string); int :ref:`tapi_snmp_packet_to_plain`(:ref:`asn_value`* pkt, :ref:`tapi_snmp_message_t`* snmp_message); :ref:`te_errno` :ref:`tapi_snmp_csap_create`(const char* ta, int sid, const char* snmp_agent, const char* community, :ref:`tapi_snmp_version_t` snmp_version, :ref:`csap_handle_t`* csap_id); :ref:`te_errno` :ref:`tapi_snmp_gen_csap_create`(const char* ta, int sid, const char* snmp_agent, :ref:`tapi_snmp_security_t`* security, :ref:`tapi_snmp_version_t` snmp_version, uint16_t rem_port, uint16_t loc_port, int timeout, :ref:`csap_handle_t`* csap_id); int :ref:`tapi_snmp_set_vbs`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_varbind_t`* var_binds, size_t num_vars, int* errstat, int* errindex); int :ref:`tapi_snmp_set`(const char* ta, int sid, int csap_id, int* errstat, int* errindex, ...); int :ref:`tapi_snmp_set_row`(const char* ta, int sid, int csap_id, int* errstat, int* errindex, const :ref:`tapi_snmp_oid_t`* common_index, ...); int :ref:`tapi_snmp_get_row`(const char* ta, int sid, int csap_id, int* errstatus, int* errindex, const :ref:`tapi_snmp_oid_t`* common_index, ...); int :ref:`tapi_snmp_set_integer`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, int value, int* errstat); int :ref:`tapi_snmp_set_unsigned`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, unsigned int value, int* errstat); int :ref:`tapi_snmp_set_octetstring`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, const uint8_t* value, size_t size, int* errstat); int :ref:`tapi_snmp_set_string`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, const char* value, int* errstat); int :ref:`tapi_snmp_get`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, :ref:`tapi_snmp_get_type_t` next, :ref:`tapi_snmp_varbind_t`* varbind, int* errstatus); int :ref:`tapi_snmp_getbulk`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* v_oid, int* num, :ref:`tapi_snmp_varbind_t`* varbind, int* errstatus); int :ref:`tapi_snmp_walk`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, void* userdata, :ref:`walk_callback` callback); int :ref:`tapi_snmp_get_ipaddr`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, void* addr, int* errstat); int :ref:`tapi_snmp_get_date_and_time`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, time_t* val, int* offset_from_utc, int* errstat); int :ref:`tapi_snmp_get_integer`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, int* val, int* errstat); static unsigned int :ref:`tapi_snmp_get_unsigned`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, unsigned int* val, int* errstat); int :ref:`tapi_snmp_get_string`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, char* buf, size_t buf_size, int* errstat); int :ref:`tapi_snmp_get_oct_string`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, void* buf, size_t* buf_size, int* errstat); int :ref:`tapi_snmp_get_objid`(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, :ref:`tapi_snmp_oid_t`* ret_oid, int* errstat); int :ref:`tapi_snmp_get_table`(const char* ta, int sid, int csap_id, :ref:`tapi_snmp_oid_t`* table_oid, int* num, void** result); int :ref:`tapi_snmp_get_table_rows`(const char* ta, int sid, int csap_id, :ref:`tapi_snmp_oid_t`* table_entry, int num, :ref:`tapi_snmp_oid_t`* suffix, void** result); int :ref:`tapi_snmp_get_table_dimension`(:ref:`tapi_snmp_oid_t`* table_oid, int* dimension); int :ref:`tapi_snmp_make_table_index`(:ref:`tapi_snmp_oid_t`* tbl, :ref:`tapi_snmp_oid_t`* index, ...); int :ref:`tapi_snmp_get_table_columns`(:ref:`tapi_snmp_oid_t`* table_oid, :ref:`tapi_snmp_var_access`** columns); int :ref:`tapi_snmp_load_mib_with_path`(const char* dir_path, const char* mib_file); int :ref:`tapi_snmp_load_cfg_mibs`(const char* dir_path); static void :ref:`tapi_snmp_zero_oid`(:ref:`tapi_snmp_oid_t`* oid); void :ref:`tapi_snmp_append_oid`(:ref:`tapi_snmp_oid_t`* oid, int n, ...); int :ref:`tapi_snmp_make_oid`(const char* oid_str, :ref:`tapi_snmp_oid_t`* oid); int :ref:`tapi_snmp_find_vb`(const :ref:`tapi_snmp_varbind_t`* var_binds, size_t num, const :ref:`tapi_snmp_oid_t`* oid, const :ref:`tapi_snmp_varbind_t`** vb, size_t* pos); static int :ref:`tapi_snmp_find_vb_str`(const :ref:`tapi_snmp_varbind_t`* var_binds, size_t num, const char* oid, const :ref:`tapi_snmp_varbind_t`** vb, size_t* pos); int :ref:`tapi_snmp_get_syntax`(:ref:`tapi_snmp_oid_t`* oid, :ref:`tapi_snmp_vartypes_t`* syntax); void :ref:`tapi_snmp_trap_handler`(const char* fn, void* user_param); int :ref:`tapi_snmp_make_instance`(const char* oid_str, :ref:`tapi_snmp_oid_t`* oid, ...); int :ref:`tapi_snmp_make_vb`(:ref:`tapi_snmp_varbind_t`* vb, const char* oid_str, const char* type, const char* value, ...); int :ref:`tapi_snmp_cmp_vb`(const :ref:`tapi_snmp_varbind_t`* vb1, const :ref:`tapi_snmp_varbind_t`* vb2, :ref:`tapi_snmp_vb_cmp_type` cmp_type); int :ref:`tapi_snmp_cmp_oid`(const :ref:`tapi_snmp_oid_t`* oid1, const :ref:`tapi_snmp_oid_t`* oid2); const char* :ref:`print_oid`(const :ref:`tapi_snmp_oid_t`* oid); const char* :ref:`tapi_snmp_print_oct_str`(const void* data, size_t len); const char* :ref:`snmp_error_h2str`(int error_val); const char* :ref:`snmp_obj_type_h2str`(enum :ref:`snmp_obj_type` obj_type); const char* :ref:`tapi_snmp_obj_status_h2str`(enum :ref:`tapi_snmp_mib_status` obj_status); const char* :ref:`tapi_snmp_truth_value_h2str`(enum :ref:`tapi_snmp_truth_value` val); const char* :ref:`tapi_snmp_val_type_h2str`(enum :ref:`tapi_snmp_vartypes_t` type); const char* :ref:`tapi_snmp_gen_trap_h2str`(enum :ref:`tapi_snmp_gen_trap_t` type); :ref:`tapi_snmp_gen_trap_t` :ref:`tapi_snmp_gen_trap_by_name`(const char* trap_name); // macros #define :ref:`MAX_LABLE_LEN` #define :ref:`MAX_OID_LEN` #define :ref:`TAPI_SNMP_TRAP_PORT` #define :ref:`tapi_snmp_load_mib`(mib_file_) .. _details-group__tapi__tad__snmp: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Traffic Application Domain Command Handler SNMP protocol implementaion internal declarations. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_snmp_version_t .. _doxid-group__tapi__tad__snmp_1gaa70b79b0e58d475c47513b5b3e4dd377: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_version_t` tapi_snmp_version_t SNMP Protocol version .. index:: pair: typedef; tapi_snmp_sec_model_t .. _doxid-group__tapi__tad__snmp_1ga3924cecd49b5d80b839ec8a387d23e8a: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_sec_model_t` tapi_snmp_sec_model_t SNMP Security model .. index:: pair: typedef; tapi_snmp_sec_level_t .. _doxid-group__tapi__tad__snmp_1ga9053cfe711a7175eb99c0bb53a2306d5: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_sec_level_t` tapi_snmp_sec_level_t SNMPv3 USM Security Level .. index:: pair: typedef; tapi_snmp_auth_proto_t .. _doxid-group__tapi__tad__snmp_1gac28eb6830a1d6fa23ab268f92e8f5954: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_auth_proto_t` tapi_snmp_auth_proto_t SNMPv3 USM Authentication protocol .. index:: pair: typedef; tapi_snmp_priv_proto_t .. _doxid-group__tapi__tad__snmp_1ga516f3f2aeccb72f0eb550e33dc155604: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_priv_proto_t` tapi_snmp_priv_proto_t SNMPv3 USM Privacy protocol .. index:: pair: typedef; tapi_snmp_vartypes_t .. _doxid-group__tapi__tad__snmp_1ga3108568196640b7a5f0f7d2add02aadc: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_vartypes_t` tapi_snmp_vartypes_t Type codes for SNMP variable binding values. Really SNMP uses some of ASN.1 codes. Not all possible codes are defined, only usually used and supported in TAD SNMP module. .. index:: pair: typedef; tapi_snmp_gen_trap_t .. _doxid-group__tapi__tad__snmp_1gada00d16fa876dc80e0031f957b2c5bb7: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_gen_trap_t` tapi_snmp_gen_trap_t The list of possible values of "GEN TRAP" field of SNMP V1 Trap. .. index:: pair: typedef; tapi_snmp_mib_access .. _doxid-group__tapi__tad__snmp_1ga427037be10cca557e6878206e1c70a6f: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_mib_access` tapi_snmp_mib_access Store mib access type .. index:: pair: typedef; tapi_snmp_mib_status .. _doxid-group__tapi__tad__snmp_1ga902d8b53b6e35e376fa172a4e06db023: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_mib_status` tapi_snmp_mib_status Store mib status .. index:: pair: typedef; tapi_snmp_var_access .. _doxid-group__tapi__tad__snmp_1ga7cb99baa02e2bf2d3efc837ccb88a317: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_snmp_var_access` tapi_snmp_var_access Structure to contain snmp variable mib access .. index:: pair: typedef; tapi_snmp_truth_value .. _doxid-group__tapi__tad__snmp_1gaa8ee7bd888895020e974a8c11cadfd02: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_snmp_truth_value` tapi_snmp_truth_value Definitions of values for SNMP TruthValue type .. index:: pair: typedef; tapi_snmp_common_table_row_t .. _doxid-group__tapi__tad__snmp_1ga798f3db1c7d3438d25fe98cc1b1e5bcd: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_snmp_common_table_row_s` tapi_snmp_common_table_row_t Structure that contains generic part of all SNMP table rows - INDEX part of row. It could be useful when casting unknown type of table to get at least the value of the row index. .. index:: pair: typedef; tapi_snmp_security_t .. _doxid-group__tapi__tad__snmp_1ga87f6d28008ef7f4d95bc430cd462dfe2: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_snmp_security_s` tapi_snmp_security_t SNMP security parameters .. index:: pair: typedef; walk_callback .. _doxid-group__tapi__tad__snmp_1gac28cb83df589589f9b71830d9876500e: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef int (*walk_callback)( const tapi_snmp_varbind_t *varbind, void *userdata ) Callback function for the :ref:`tapi_snmp_walk() ` routine, it is called for each variable in a walk subtree. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - varbind - Variable binding, for which the callback function is called * - userdata - Parameter, provided by the caller of :ref:`tapi_snmp_walk() ` .. index:: pair: typedef; tapi_snmp_trap_callback .. _doxid-group__tapi__tad__snmp_1ga0592d8046cc6f0d02a4c11216c9acadf: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef void (*tapi_snmp_trap_callback)( const tapi_snmp_message_t *trap, void *user_data ) Callback function for the catching of SNMP traps. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - trap - SNMP message with trap. * - user_data - Parameter, provided by the caller of :ref:`tapi_snmp_walk() `. .. index:: pair: typedef; tapi_snmp_pkt_handler_data .. _doxid-group__tapi__tad__snmp_1ga2cae96c2984fa47ab590c4f6df0a9da0: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_snmp_pkt_handler_data` tapi_snmp_pkt_handler_data FIXME Global Functions ---------------- .. index:: pair: function; tapi_snmp_cat_oid .. _doxid-group__tapi__tad__snmp_1ga335fc34c7b3628b56e38dbcf56ac2021: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_cat_oid(:ref:`tapi_snmp_oid_t`* base, const :ref:`tapi_snmp_oid_t`* suffix) Concatenate two object identifiers and put result into first one. Mainly intended for table indexes. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - base - base OID, will contain result (IN/OUT). * - suffix - second OID, to be added to the base. .. rubric:: Returns: zero on success, otherwise error code. .. index:: pair: function; tapi_snmp_is_sub_oid .. _doxid-group__tapi__tad__snmp_1ga85fa60eba0424410efefb1f162e30554: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_is_sub_oid(const :ref:`tapi_snmp_oid_t`* tree, const :ref:`tapi_snmp_oid_t`* node) Boolean check is the first OID contained in second one. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tree - OID of MIB sub-tree. * - node - OID of node to be checked on presence in sub-tree. * - 1 - node is in tree * - 0 - otherwise .. index:: pair: function; tapi_snmp_free_varbind .. _doxid-group__tapi__tad__snmp_1gad498050050eb15bb79143810ef82e764: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_snmp_free_varbind(:ref:`tapi_snmp_varbind_t`* varbind) Free memory allocated in snmp varbind structure .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - varbind - Varbind to be freed .. rubric:: Returns: N/A .. index:: pair: function; tapi_snmp_free_message .. _doxid-group__tapi__tad__snmp_1ga16e6570b9ac120bcebfcf102f3889905: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_snmp_free_message(:ref:`tapi_snmp_message_t`* snmp_message) Free memory allocated in snmp message structure got from tapi_snmp_packet_to_plain function .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - snmp_message - converted structure .. rubric:: Returns: N/A .. index:: pair: function; tapi_snmp_mk_oct_string .. _doxid-group__tapi__tad__snmp_1ga4113bd2efce97bd8c9513d166b5e682f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_snmp_oct_string_t`* tapi_snmp_mk_oct_string(uint8_t* data, size_t data_len) Allocate octet string data structure based on user specified data buffer. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - data - buffer with data * - data_len - size of data buffer .. rubric:: Returns: Allocated octet sting data structure .. index:: pair: function; tapi_snmp_free_oct_string .. _doxid-group__tapi__tad__snmp_1ga01b702421e4428c6f2efb61c43f09ea7: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_snmp_free_oct_string(:ref:`tapi_snmp_oct_string_t`* oct_string) Free octet string allocated with :ref:`tapi_snmp_mk_oct_string() ` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oct_string - octet string to free .. rubric:: Returns: N/A .. index:: pair: function; tapi_snmp_packet_to_plain .. _doxid-group__tapi__tad__snmp_1ga7f22be65b65626f5da375729ac6f1a29: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_packet_to_plain(:ref:`asn_value`* pkt, :ref:`tapi_snmp_message_t`* snmp_message) Convert SNMP-Message ASN.1 value to plain C structure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pkt - ASN.1 value of type SNMP-Message or Generic-PDU with choice "snmp" * - snmp_message - Converted structure (OUT) .. rubric:: Returns: Zero on success or error code. .. index:: pair: function; tapi_snmp_csap_create .. _doxid-group__tapi__tad__snmp_1ga7ac74299a068670052a1dba901759411: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_snmp_csap_create(const char* ta, int sid, const char* snmp_agent, const char* community, :ref:`tapi_snmp_version_t` snmp_version, :ref:`csap_handle_t`* csap_id) Creates usual SNMP (community-based security model) CSAP on specified Test Agent and got its handle. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session ID * - snmp_agent - Address of SNMP agent * - community - SNMP community * - snmp_version - SNMP version * - csap_id - identifier of an SNMP CSAP (OUT) .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_gen_csap_create .. _doxid-group__tapi__tad__snmp_1gaf3e0dc7a1e3dea4eae972d1cc31cfcde: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_snmp_gen_csap_create(const char* ta, int sid, const char* snmp_agent, :ref:`tapi_snmp_security_t`* security, :ref:`tapi_snmp_version_t` snmp_version, uint16_t rem_port, uint16_t loc_port, int timeout, :ref:`csap_handle_t`* csap_id) Creates generic SNMP CSAP on specified Test Agent and got its handle. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name. * - sid - RCF Session ID. * - snmp_agent - Address of SNMP agent. * - security - SNMP security parameters. * - snmp_version - SNMP version. * - rem_port - Remote UDP port. * - loc_port - Local UDP port. * - timeout - Default timeout, measured in milliseconds. * - csap_id - identifier of an SNMP CSAP. (OUT) .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_set_vbs .. _doxid-group__tapi__tad__snmp_1ga0f28fa7d20341e2f605b3266c80ca17a: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_set_vbs(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_varbind_t`* var_binds, size_t num_vars, int* errstat, int* errindex) The function send SNMP-SET request for specified objects to the SNMP agent, associated with a particular SNMP CSAP. The function waits for SNMP agent response. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - identifier of an SNMP CSAP. * - var_binds - Array with var-binds to be sent in request. * - num_vars - Number of var-binds in array below. * - errstat - Rhe value of error-status field in response message (OUT), may be zero if not need. * - errindex - Rhe value of error-index field in response message (OUT), may be zero if not need. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_set .. _doxid-group__tapi__tad__snmp_1ga57ffefde5a2307bc74aed8da4e788d2b: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_set(const char* ta, int sid, int csap_id, int* errstat, int* errindex, ...) The same as tapi_snmp_set_vbs, but gets sequence of "varbind groups" from free arguments sequence after 'errindex'. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - identifier of an SNMP CSAP. * - errstat - The value of error-status field in response message (OUT), may be zero if not need. * - errindex - The value of error-index field in response message (OUT), may be zero if not need. * - ... - Sequence of "varbind groups": Symbolic label of MIB leaf (usually literal contant) and value, which may be either integer (for INTEGER syntax leafs), or tapi_snmp_oct_string_t\* for OCTET_STRING types, or tapi_snmp_oid_t\*; ended by NULL. Passed pointers are considered as 'const', i.e. OID and data are not changed. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_set_row .. _doxid-group__tapi__tad__snmp_1ga61c1b40aaceb1bcc42cda9f0ecd072fd: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_set_row(const char* ta, int sid, int csap_id, int* errstat, int* errindex, const :ref:`tapi_snmp_oid_t`* common_index, ...) The function send SNMP-SET request for specified objects to the SNMP agent, associated with a particular SNMP CSAP. The function waits for SNMP agent response. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - identifier of an SNMP CSAP. * - errstat - The value of error-status field in response message (OUT), may be zero if not need. * - errindex - The value of error-index field in response message (OUT), may be zero if not need. * - common_index - Common index part of OID, which should be concatened to all varbind's OIDs below; may be NULL. * - ... - Sequence of "varbind groups": label of MIB leaf and value, which may be either integer, or tapi_snmp_oct_string_t\*, for OCTET_STRING types, or tapi_snmp_oid_t\*; ended by NULL. Passed pointers are considered as 'const', i.e. OID and data are not changed. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_get_row .. _doxid-group__tapi__tad__snmp_1gae28265251730be9b37aceaf3cbbd6ace: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_row(const char* ta, int sid, int csap_id, int* errstatus, int* errindex, const :ref:`tapi_snmp_oid_t`* common_index, ...) The function send SNMP-GET request for specified objects to the SNMP agent, associated with a particular SNMP CSAP. Note, that the function waits for SNMP agent response. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - identifier of an SNMP CSAP. * - errstatus - The value of error-status field in response message (OUT), may be zero if not need. * - errindex - The value of error-index field in response message (OUT), may be zero if not need. * - common_index - Common index part of OID, which should be concatened to all varbind's OIDs below; may be NULL. * - ... - Sequence of "varbind groups": label of MIB leaf and value, which may be either integer, or tapi_snmp_oct_string_t\*, for OCTET_STRING types, or tapi_snmp_oid_t\*; ended by NULL. Passed pointers are desired as 'const', i.e. OID and data are not changed. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_set_integer .. _doxid-group__tapi__tad__snmp_1ga49e6e0f688b1ce162ce340abcf9957ac: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_set_integer(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, int value, int* errstat) The function makes an attempt to set an integer value for an SNMP object by means of SNMP Set request, which is sent to the SNMP agent, associated with a particular SNMP CSAP. Note, that the function waits for SNMP agent response. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - identifier of an SNMP CSAP. * - oid - ID of an SNMP object the value is to be set. * - value - integer value. * - errstat - the value of error-status field in response message (OUT), may be zero if not need. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_set_unsigned .. _doxid-group__tapi__tad__snmp_1ga7cd568d58f196745145aff1fa881102f: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_set_unsigned(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, unsigned int value, int* errstat) The function makes an attempt to set an unsigned integer value for an SNMP object by means of SNMP Set request, which is sent to the SNMP agent, associated with a particular SNMP CSAP. Note, that the function waits for SNMP agent response. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - identifier of an SNMP CSAP. * - oid - ID of an SNMP object the value is to be set. * - value - unsigned integer value. * - errstat - the value of error-status field in response message (OUT), may be zero if not need. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_set_octetstring .. _doxid-group__tapi__tad__snmp_1ga89eb28f6fb417138cd3dd4855dcb7abb: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_set_octetstring(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, const uint8_t* value, size_t size, int* errstat) The function makes an attempt to set an octet string value for an SNMP object by means of SNMP Set request, which is sent to the SNMP agent, associated with an SNMP CSAP. Note, that the function waits for SNMP agent response. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - identifier of an SNMP CSAP. * - oid - ID of an SNMP object the value is to be set. * - value - octet string value. * - size - octet string size. * - errstat - the value of error-status field in response message (OUT), may be zero if not need. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_set_string .. _doxid-group__tapi__tad__snmp_1ga8e254ef9fea59c05d78479bd1d781276: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_set_string(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, const char* value, int* errstat) The function makes an attempt to set a string value for an SNMP object by means of SNMP Set request, which is sent to the SNMP agent, associated with an SNMP CSAP. Note, that the argument string should contain only printable characters. For a general octet string use :ref:`tapi_snmp_set_octetstring() ` function. Note, that the function waits for SNMP agent response. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - identifier of an SNMP CSAP. * - oid - ID of an SNMP object the value is to be set. * - value - zero-terminated string. * - errstat - the value of error-status field in response message (OUT), may be zero if not need. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_get .. _doxid-group__tapi__tad__snmp_1gaa9ccc175929f8775c82b075da72fd8d3: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, :ref:`tapi_snmp_get_type_t` next, :ref:`tapi_snmp_varbind_t`* varbind, int* errstatus) The function can be used to send either SNMP Get request or SNMP GetNext request to the SNMP agent, associated with an SNMP CSAP, and obtain a variable binding agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - Identifier of an SNMP CSAP. * - oid - ID of an SNMP object. * - next - The parameter defines which of the SNMP request should be send (GetRequest or GetNextRequest). * - varbind - Location for variable binding, got SNMP agent for the given OID. Pointers in structure (for complex long data) are allocated by this method and should be freed by user. (OUT) * - errstatus - The value of error-status field in response message (OUT), may be zero if not need. .. rubric:: Returns: zero on success or error code. .. index:: pair: function; tapi_snmp_getbulk .. _doxid-group__tapi__tad__snmp_1ga1940b8a5937951aec3516a3357d51510: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_getbulk(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* v_oid, int* num, :ref:`tapi_snmp_varbind_t`* varbind, int* errstatus) The function can be used to send either SNMP Get-Bulk request to the SNMP agent, associated with an SNMP CSAP, and obtain a variable binding agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - Identifier of an SNMP CSAP * - v_oid - ID of an SNMP object * - num - Number of elements in 'varbinds' (IN/OUT) * - varbind - Location for variable bindings, got SNMP agent for the given OID. Pointers in structures (for complex long data) are allocated by this method and should be freed by user. (OUT) * - errstatus - The value of error-status field in response message (OUT), may be zero if not need .. rubric:: Returns: Zero on success or error code. .. index:: pair: function; tapi_snmp_walk .. _doxid-group__tapi__tad__snmp_1ga4c3a579f5c0698421394f7095b847260: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_walk(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, void* userdata, :ref:`walk_callback` callback) The function uses SNMP GetNext requests to query an agent for a tree of information. An object identifier specifies which portion of the object identifier space will be searched using GetNext requests. All variables in the subtree below the given OID are queried, and for every such variable a callback function is called. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - Identifier of an SNMP CSAP * - oid - OID which defines a subtree to work with * - userdata - Opaque data to be passed into the callback function * - callback - Callback function, which is executed for each leaf .. rubric:: Returns: Zero on success or error code. .. index:: pair: function; tapi_snmp_get_ipaddr .. _doxid-group__tapi__tad__snmp_1ga14199ccec4f6aec640ff18bd996db158: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_ipaddr(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, void* addr, int* errstat) The following functions are useful wrappers Sends SNMP Get request on MIB object with type InetAddr to the SNMP agent, associated with an SNMP CSAP and obtains a value the agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - SNMP CSAP handle * - oid - ID of an SNMP object * - addr - Location for returned IPv4 address (OUT) Buffer must be sizeof(struct in_addr) bytes long * - errstat - The value of error-status field in response message (OUT), may be zero if not need .. rubric:: Returns: zero on success or error code .. index:: pair: function; tapi_snmp_get_date_and_time .. _doxid-group__tapi__tad__snmp_1ga1f3fe79e955c06e3320682d8a2520894: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_date_and_time(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, time_t* val, int* offset_from_utc, int* errstat) Sends SNMP Get request on MIB object with type DateAndTime to the SNMP agent, associated with an SNMP CSAP and obtains a value the agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - SNMP CSAP handle * - oid - ID of an SNMP object * - val - Location for returned time (OUT) * - offset_from_utc - Location for signed offset from UTC octet in minutes (OUT) * - errstat - The value of error-status field in response message (OUT), may be zero if not need .. rubric:: Returns: zero on success or error code .. index:: pair: function; tapi_snmp_get_integer .. _doxid-group__tapi__tad__snmp_1gac554f76135da4d80d8dded6d8c77e9a6: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_integer(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, int* val, int* errstat) Sends SNMP Get request on MIB object with type Integer to the SNMP agent, associated with an SNMP CSAP and obtains a value the agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - SNMP CSAP handle * - oid - ID of an SNMP object * - val - Location for returned value (OUT) * - errstat - The value of error-status field in response message (OUT), may be zero if not need .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_get_unsigned .. _doxid-group__tapi__tad__snmp_1gaf2e43f421c69978044231b0acce31cbe: .. ref-code-block:: cpp :class: doxyrest-title-code-block static unsigned int tapi_snmp_get_unsigned(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, unsigned int* val, int* errstat) Sends SNMP Get request on MIB object with type Unsigned (or Gauge) to the SNMP agent, associated with an SNMP CSAP and obtains a value the agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - SNMP CSAP handle * - oid - ID of an SNMP object * - val - Location for returned value (OUT) * - errstat - The value of error-status field in response message (OUT), may be zero if not need .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_get_string .. _doxid-group__tapi__tad__snmp_1ga8b4d7af71390356e7b90fb84e7126e48: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_string(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, char* buf, size_t buf_size, int* errstat) Sends SNMP Get request on MIB object with type DisplayString to the SNMP agent, associated with an SNMP CSAP and obtains a value the agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - SNMP CSAP handle * - oid - ID of an SNMP object * - buf - Location for returned string (OUT) * - buf_size - Number of bytes in 'buf' * - errstat - The value of error-status field in response message (OUT), may be zero if not need .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_get_oct_string .. _doxid-group__tapi__tad__snmp_1ga0783473ba3aa6189fc6ea6325ec7a01e: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_oct_string(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, void* buf, size_t* buf_size, int* errstat) Sends SNMP Get request on MIB object with type OctetString to the SNMP agent, associated with an SNMP CSAP and obtains a value the agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF Session id. * - csap_id - SNMP CSAP handle * - oid - ID of an SNMP object * - buf - Location for returned value (OUT) * - buf_size - Number of bytes in 'buf' on input and the number of bytes actually written on output (IN/OUT) * - errstat - The value of error-status field in response message (OUT), may be zero if not need .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_get_objid .. _doxid-group__tapi__tad__snmp_1gaa6620f39b7814da1f29dbb37c27818d6: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_objid(const char* ta, int sid, int csap_id, const :ref:`tapi_snmp_oid_t`* oid, :ref:`tapi_snmp_oid_t`* ret_oid, int* errstat) Sends SNMP Get request on MIB object with type ObjectIdentifier to the SNMP agent, associated with an SNMP CSAP and obtains a value the agent have responded. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - SNMP CSAP handle * - oid - ID of an SNMP object * - ret_oid - Location for returned value (OUT) * - errstat - The value of error-status field in response message (OUT), may be zero if not need .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_get_table .. _doxid-group__tapi__tad__snmp_1ga1743648ee8178ea1347351d317bc4af2: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_table(const char* ta, int sid, int csap_id, :ref:`tapi_snmp_oid_t`* table_oid, int* num, void** result) Get SNMP table or one column from it, depends on passed OID. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - SNMP CSAP handle * - table_oid - OID of SNMP table Entry object, or one leaf in this entry * - num - Number of raws in table = height of matrix below (OUT) * - result - Pointer to the allocated matrix with results, if only one column should be get, matrix width is 1, otherwise matrix width is greatest subid of Table entry + 1. (OUT) .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_get_table_rows .. _doxid-group__tapi__tad__snmp_1ga93b9379b053b40d0c41c858443b7f86b: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_table_rows(const char* ta, int sid, int csap_id, :ref:`tapi_snmp_oid_t`* table_entry, int num, :ref:`tapi_snmp_oid_t`* suffix, void** result) Get SNMP table row, list of leafs will be got from parsed MIB tree. Operation is performed as single SNMP-GET with multiple OIDs for all table entries, and result is returned as SNMP message with varbind array. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - sid - RCF session ID * - csap_id - SNMP CSAP handle * - table_entry - OID of SNMP table Entry MIB node * - num - number of suffixes * - suffix - Array with index suffixes of desired table rows * - result - Pointer to the allocated matrix with results, matrix width is greatest subid of Table entry (OUT) .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_get_table_dimension .. _doxid-group__tapi__tad__snmp_1ga423655172a080c7397416356311893b9: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_table_dimension(:ref:`tapi_snmp_oid_t`* table_oid, int* dimension) Get SNMP table dimension. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - table_oid - OID of SNMP table Entry object, or one leaf in this entry * - dimension - Table dimension (OUT) .. rubric:: Returns: zero on success or error code .. index:: pair: function; tapi_snmp_make_table_index .. _doxid-group__tapi__tad__snmp_1ga1dbce11e92fbd8ab61a6acebf8cf0a01: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_make_table_index(:ref:`tapi_snmp_oid_t`* tbl, :ref:`tapi_snmp_oid_t`* index, ...) Make table index. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - tbl - Table OID * - index - Table index pointer * - ... - Values to be inserted in index.id .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_get_table_columns .. _doxid-group__tapi__tad__snmp_1ga392ff5b0776a3a6140d5be1c926dc53f: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_table_columns(:ref:`tapi_snmp_oid_t`* table_oid, :ref:`tapi_snmp_var_access`** columns) Get SNMP table columns. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - table_oid - OID of SNMP table Entry object, or one leaf in this entry * - columns - Pointer to the allocated array of columns (OUT) .. rubric:: Returns: Zero on success or error code .. index:: pair: function; tapi_snmp_load_mib_with_path .. _doxid-group__tapi__tad__snmp_1ga0f71402b5006fe3a46e8cc9ea0ce3d27: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_load_mib_with_path(const char* dir_path, const char* mib_file) Loads all text OIDs from MIB file .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - dir_path - Path to directory with MIB files * - mib_file - File name of the MIB file .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_snmp_load_cfg_mibs .. _doxid-group__tapi__tad__snmp_1gab0298ed71087f8ae9d4faf2f17c781a1: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_load_cfg_mibs(const char* dir_path) Load all mibs specified in cs.conf file in "/snmp/mibs/load" list. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - dir_path - Path to directory where to search MIB files .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_snmp_zero_oid .. _doxid-group__tapi__tad__snmp_1gad4154c6481faddc61adb28523d77bcbb: .. ref-code-block:: cpp :class: doxyrest-title-code-block static void tapi_snmp_zero_oid(:ref:`tapi_snmp_oid_t`* oid) Initialize OID to zero length OID .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - OID to initialize .. index:: pair: function; tapi_snmp_append_oid .. _doxid-group__tapi__tad__snmp_1gad8736c26e80439a4568839bfe807487d: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_snmp_append_oid(:ref:`tapi_snmp_oid_t`* oid, int n, ...) Append a set of SUB IDs to the OID .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - OID to be appended * - n - Number of SUB IDs to append * - ... - SUB IDs type of "int" .. index:: pair: function; tapi_snmp_make_oid .. _doxid-group__tapi__tad__snmp_1ga06ff02c40e19faaa9723cbcf7c908b2f: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_make_oid(const char* oid_str, :ref:`tapi_snmp_oid_t`* oid) Parses text representation of OID to TAPI SNMP OID data structure .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid_str - OID string representation * - oid - Location for parsed OID (OUT) .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_snmp_find_vb .. _doxid-group__tapi__tad__snmp_1gab1e3178b25c02cfbbe02a3a1a42ce6d0: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_find_vb(const :ref:`tapi_snmp_varbind_t`* var_binds, size_t num, const :ref:`tapi_snmp_oid_t`* oid, const :ref:`tapi_snmp_varbind_t`** vb, size_t* pos) Finds VarBind by name (OID) among the array of VarBinds. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - var_binds - Pointer to the array of VarBinds * - num - The number of entries in *var_binds* array * - oid - VarBind name we are interested in * - vb - Found VarBind * - pos - Position of found VarBind in the list, can be NULL if does not matter * - 0 - VarBind is found * - TE_ENOENT - There is no required VarBind in the list .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_snmp_find_vb_str .. _doxid-group__tapi__tad__snmp_1gaefb9958ab5fcea864bd25c6a7f3bc7d3: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_snmp_find_vb_str(const :ref:`tapi_snmp_varbind_t`* var_binds, size_t num, const char* oid, const :ref:`tapi_snmp_varbind_t`** vb, size_t* pos) Finds VarBind by name (OID) among the array of VarBinds. Function is the same as *tapi_snmp_find_vb*, but only gets OID in string format rather than in :ref:`tapi_snmp_oid_t `. .. index:: pair: function; tapi_snmp_get_syntax .. _doxid-group__tapi__tad__snmp_1ga4e61b9631eb72717ecb4ec36613a7b9c: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_get_syntax(:ref:`tapi_snmp_oid_t`* oid, :ref:`tapi_snmp_vartypes_t`* syntax) Get SNMP object syntax from MIB. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - OID of SNMP object * - syntax - syntax of SNMP object (OUT) .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_snmp_trap_handler .. _doxid-group__tapi__tad__snmp_1gad11727aaf4df22fb2c2d2eeb35f681ca: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_snmp_trap_handler(const char* fn, void* user_param) FIXME .. index:: pair: function; tapi_snmp_make_instance .. _doxid-group__tapi__tad__snmp_1gabf6cdde9b32b7869641e8797bffc5cc5: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_make_instance(const char* oid_str, :ref:`tapi_snmp_oid_t`* oid, ...) Parses text representation of OID to TAPI SNMP OID data structure then adds instance indexes to the TAPI SNMP OID data structure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid_str - OID string representation * - oid - Location for parsed OID (OUT) * - ... - Indexes of table field instance .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_snmp_make_vb .. _doxid-group__tapi__tad__snmp_1ga0e7390588ed3b9b022161be3c1130cb4: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_make_vb(:ref:`tapi_snmp_varbind_t`* vb, const char* oid_str, const char* type, const char* value, ...) Create VarBind for specified OID with the particular value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - vb - Pointer to VarBind data structure to be filled in by the function (OUT) * - oid_str - OID string representation * - type - Type of the value, can be one of the following: i INTEGER u UNSIGNED s STRING x HEX STRING d DECIMAL STRING n NULLOBJ o OBJID t TIMETICKS a IPADDRESS b BITS * - value - VarBind value * - ... - For tabular objects, index of the entry - type :ref:`tapi_snmp_oid_t ` .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_snmp_cmp_vb .. _doxid-group__tapi__tad__snmp_1ga09f400256cd00bd891ba0cf2f2cbab1c: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_cmp_vb(const :ref:`tapi_snmp_varbind_t`* vb1, const :ref:`tapi_snmp_varbind_t`* vb2, :ref:`tapi_snmp_vb_cmp_type` cmp_type) Compare two VarBinds .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - vb1 - First VarBind * - vb2 - Second VarBind * - cmp_type - Type of comparision * - 0 - The values are the same * - -1 - The values are different .. rubric:: Returns: Result of comparision .. index:: pair: function; tapi_snmp_cmp_oid .. _doxid-group__tapi__tad__snmp_1ga1a760c92500133778556b9aef1e8d0b9: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_snmp_cmp_oid(const :ref:`tapi_snmp_oid_t`* oid1, const :ref:`tapi_snmp_oid_t`* oid2) Compare two OIDs .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid1 - First OID * - oid2 - Second OID .. rubric:: Returns: Function return an integer less than, equal to, or greater than zero if *oid1* is found, respectively, to be less than, to match, or be greater than *oid2*. .. index:: pair: function; print_oid .. _doxid-group__tapi__tad__snmp_1gab51915657f704cebfdfcc91092412cb9: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* print_oid(const :ref:`tapi_snmp_oid_t`* oid) Print SNMP OID struct to string and return pointer to this string. Note, that buffer with string is static and behaviour of this function in multithread usage may be unpredictable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - - pointer to structure with OID to be printed. .. rubric:: Returns: Pointer to buffer with printed OID. .. index:: pair: function; tapi_snmp_print_oct_str .. _doxid-group__tapi__tad__snmp_1ga09c3422856ae6230d056ea103343bc2e: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_snmp_print_oct_str(const void* data, size_t len) Print array of bytes to string and return pointer to this string. Note, that buffer with string is static and behaviour of this function in multithread usage may be unpredictable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - data - Pointer to the data to be printed * - len - Number of bytes in *data* array .. rubric:: Returns: Pointer to buffer with printed data. .. index:: pair: function; snmp_error_h2str .. _doxid-group__tapi__tad__snmp_1ga5808d9545e9a01df7b8a70eb4bff9962: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* snmp_error_h2str(int error_val) Convert SNMP ERROR constants to string format .. index:: pair: function; snmp_obj_type_h2str .. _doxid-group__tapi__tad__snmp_1ga5a83cac1c3b441b0a9c7c8d393b168d7: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* snmp_obj_type_h2str(enum :ref:`snmp_obj_type` obj_type) Convert SNMP Object type constants to string format .. index:: pair: function; tapi_snmp_obj_status_h2str .. _doxid-group__tapi__tad__snmp_1gab51a1f8ac4401afda2cc6a651e294a92: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_snmp_obj_status_h2str(enum :ref:`tapi_snmp_mib_status` obj_status) Convert SNMP MIB Object status constants to string format .. index:: pair: function; tapi_snmp_truth_value_h2str .. _doxid-group__tapi__tad__snmp_1ga3ef5179ccb5f81a9c618b2c56b9387c3: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_snmp_truth_value_h2str(enum :ref:`tapi_snmp_truth_value` val) Convert SNMP TruthValue constants to string format .. index:: pair: function; tapi_snmp_val_type_h2str .. _doxid-group__tapi__tad__snmp_1gaf6a159dffd5ae4535beb131820edfa91: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_snmp_val_type_h2str(enum :ref:`tapi_snmp_vartypes_t` type) Convert SNMP value types constants to string format .. index:: pair: function; tapi_snmp_gen_trap_h2str .. _doxid-group__tapi__tad__snmp_1ga416c9426d4f9d70351b6afbefe5a8a39: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_snmp_gen_trap_h2str(enum :ref:`tapi_snmp_gen_trap_t` type) Convert SNMP Trap type constants to string format .. index:: pair: function; tapi_snmp_gen_trap_by_name .. _doxid-group__tapi__tad__snmp_1gaf81b288027cff1f9b4f1378990f2f411: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`tapi_snmp_gen_trap_t` tapi_snmp_gen_trap_by_name(const char* trap_name) Get SNMPv1 generic trap id by its name .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - trap_name - Name of trap .. rubric:: Returns: Trap ID for generic traps or TAPI_SNMP_TRAP_ENTERPRISESPECIFIC otherwise Macros ------ .. index:: pair: define; MAX_LABLE_LEN .. _doxid-group__tapi__tad__snmp_1ga93f6a24061263773334943e274adf4f5: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define MAX_LABLE_LEN Maximum length of label .. index:: pair: define; MAX_OID_LEN .. _doxid-group__tapi__tad__snmp_1ga688aa666f110b5e82612b122e06e0ab8: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define MAX_OID_LEN Strongly restricted maximal length of Object Identifier - this value is not succeded for all MIBs which are under testing. Really, it seems that this length can be exceeded only for "string" table indixes. Maximum length of object identifier .. index:: pair: define; TAPI_SNMP_TRAP_PORT .. _doxid-group__tapi__tad__snmp_1gafd755280561e705680b00fe1d00a7efc: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_SNMP_TRAP_PORT Default port for SNMP trap receiver application .. index:: pair: define; tapi_snmp_load_mib .. _doxid-group__tapi__tad__snmp_1gae3a0832f85dbb418a64717d441d5db93: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define tapi_snmp_load_mib(mib_file_) The macro simplify usage of tapi_snmp_load_mib function with using only one argument instead of two. In the caller context SUITE_SRCDIR macro MUST be defined.