Documentation

Documentation

Includes

lwip/apps/snmp_opts.h

#include "lwip/apps/snmp_opts.h"
#include "lwip/apps/snmp_opts.h"

lwip/err.h

#include "lwip/err.h"
#include "lwip/err.h"

lwip/apps/snmp_core.h

#include "lwip/apps/snmp_core.h"
#include "lwip/apps/snmp_core.h"

Macros

Marco LWIP_HDR_APPS_SNMP_H

#define LWIP_HDR_APPS_SNMP_H


      

Marco SNMP_GENTRAP_COLDSTART

#define SNMP_GENTRAP_COLDSTART 0
/** Generic trap: cold start */

Marco SNMP_GENTRAP_WARMSTART

#define SNMP_GENTRAP_WARMSTART 1
/** Generic trap: warm start */

Marco SNMP_GENTRAP_LINKDOWN

#define SNMP_GENTRAP_LINKDOWN 2
/** Generic trap: link down */

Marco SNMP_GENTRAP_LINKUP

#define SNMP_GENTRAP_LINKUP 3
/** Generic trap: link up */

Marco SNMP_GENTRAP_AUTH_FAILURE

#define SNMP_GENTRAP_AUTH_FAILURE 4
/** Generic trap: authentication failure */

Marco SNMP_GENTRAP_EGP_NEIGHBOR_LOSS

#define SNMP_GENTRAP_EGP_NEIGHBOR_LOSS 5
/** Generic trap: EGP neighbor lost */

Marco SNMP_GENTRAP_ENTERPRISE_SPECIFIC

#define SNMP_GENTRAP_ENTERPRISE_SPECIFIC 6
/** Generic trap: enterprise specific */

Marco SNMP_AUTH_TRAPS_DISABLED

#define SNMP_AUTH_TRAPS_DISABLED 0


      

Marco SNMP_AUTH_TRAPS_ENABLED

#define SNMP_AUTH_TRAPS_ENABLED 1

      

Functions

Func snmp_init

void snmp_init(void);
/**
 * @ingroup snmp_core
 * Agent setup, start listening to port 161.
 */

Func snmp_set_mibs

void snmp_set_mibs(const struct snmp_mib **mibs, u8_t num_mibs);


      

Func snmp_set_device_enterprise_oid

void snmp_set_device_enterprise_oid(const struct snmp_obj_id* device_enterprise_oid);


      

Func snmp_trap_dst_enable

void snmp_trap_dst_enable(u8_t dst_idx, u8_t enable);


      

Func snmp_trap_dst_ip_set

void snmp_trap_dst_ip_set(u8_t dst_idx, const ip_addr_t *dst);


      

Func snmp_send_trap_generic

err_t snmp_send_trap_generic(s32_t generic_trap);


      

Func snmp_send_trap_specific

err_t snmp_send_trap_specific(s32_t specific_trap, struct snmp_varbind *varbinds);


      

Func snmp_send_trap

err_t snmp_send_trap(const struct snmp_obj_id* oid, s32_t generic_trap, s32_t specific_trap, struct snmp_varbind *varbinds);


      

Func snmp_set_auth_traps_enabled

void snmp_set_auth_traps_enabled(u8_t enable);


      

Func snmp_get_auth_traps_enabled

u8_t snmp_get_auth_traps_enabled(void);


      

Func snmp_v1_enabled

u8_t snmp_v1_enabled(void);


      

Func snmp_v2c_enabled

u8_t snmp_v2c_enabled(void);


      

Func snmp_v3_enabled

u8_t snmp_v3_enabled(void);


      

Func snmp_v1_enable

void snmp_v1_enable(u8_t enable);


      

Func snmp_v2c_enable

void snmp_v2c_enable(u8_t enable);


      

Func snmp_v3_enable

void snmp_v3_enable(u8_t enable);


      

Func snmp_set_community

void snmp_set_community(const char * const community);


      

Func snmp_set_community_write

void snmp_set_community_write(const char * const community);


      

Func snmp_set_community_trap

void snmp_set_community_trap(const char * const community);


      

Func snmp_coldstart_trap

void snmp_coldstart_trap(void);


      

Func snmp_authfail_trap

void snmp_authfail_trap(void);


      

Func snmp_set_write_callback

void snmp_set_write_callback(snmp_write_callback_fct write_callback, void* callback_arg);

      

Vars

Consts

Const

const struct snmp_obj_id* snmp_get_device_enterprise_oid(void);


      

Const

const char * snmp_get_community(void);


      

Const

const char * snmp_get_community_write(void);


      

Const

const char * snmp_get_community_trap(void);

      

Types

Typedefs

Typedef snmp_write_callback_fct

typedef void (*snmp_write_callback_fct)(const u32_t* oid, u8_t oid_len, void* callback_arg);