Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

Embed: (wiki syntax)

« Back to documentation index

snmp.h File Reference
Data Structures | Functions

snmp.h File Reference

SNMP server main API - start and basic configuration. More...

Go to the source code of this file.

Data Structures

struct  snmp_varbind
 SNMP variable binding descriptor (publically needed for traps) More...

Functions

void snmp_init (void)
 Starts SNMP Agent.
void snmp_set_mibs (const struct snmp_mib **mibs, u8_t num_mibs)
 Sets the MIBs to use.
void snmp_set_device_enterprise_oid (const struct snmp_obj_id *device_enterprise_oid)
 'device enterprise oid' is used for 'device OID' field in trap PDU's (for identification of generating device) as well as for value returned by MIB-2 'sysObjectID' field (if internal MIB2 implementation is used).
struct snmp_obj_id * snmp_get_device_enterprise_oid (void)
 Get 'device enterprise oid'.
void snmp_trap_dst_enable (u8_t dst_idx, u8_t enable)
 Sets enable switch for this trap destination.
void snmp_trap_dst_ip_set (u8_t dst_idx, const ip_addr_t *dst)
 Sets IPv4 address for this trap destination.
err_t snmp_send_trap_generic (s32_t generic_trap)
 Send generic SNMP trap.
err_t snmp_send_trap_specific (s32_t specific_trap, struct snmp_varbind *varbinds)
 Send specific SNMP trap with variable bindings.
err_t snmp_send_trap (const struct snmp_obj_id *oid, s32_t generic_trap, s32_t specific_trap, struct snmp_varbind *varbinds)
 Sends a generic or enterprise specific trap message.
void snmp_set_auth_traps_enabled (u8_t enable)
 Enable/disable authentication traps.
u8_t snmp_get_auth_traps_enabled (void)
 Get authentication traps enabled state.
const char * snmp_get_community (void)
 Returns current SNMP community string.
const char * snmp_get_community_write (void)
 Returns current SNMP write-access community string.
const char * snmp_get_community_trap (void)
 Returns current SNMP community string used for sending traps.
void snmp_set_community (const char *const community)
 Sets SNMP community string.
void snmp_set_community_write (const char *const community)
 Sets SNMP community string for write-access.
void snmp_set_community_trap (const char *const community)
 Sets SNMP community string used for sending traps.
void snmp_coldstart_trap (void)
 Send coldstart trap.
void snmp_authfail_trap (void)
 Send authentication failure trap (used internally by agent)
void snmp_set_write_callback (snmp_write_callback_fct write_callback, void *callback_arg)
 Callback fired on every successful write access.

Detailed Description

SNMP server main API - start and basic configuration.

Definition in file apps/snmp.h.

Generated on Sun Jul 17 2022 08:25:36 by  doxygen 1.7.2