snmp_api.h

Introduction

Typedefs

struct snmp_pdu to netsnmp_pdu

/** @struct snmp_pdu
The snmp protocol data unit.
    */
typedef struct snmp_pdu {  
    /*
 * Protocol-version independent fields
        */
    /** snmp version */
    long version; 
    /** Type of this PDU */
    int command; 
    /** Request id - note: not incremented on retries */
    long reqid; 
    /** Message id for V3 messages note: incremented for each retry 
        */
    long msgid; 
    /** Unique ID for incoming transactions */
    long transid; 
    /** Session id for AgentX messages */
    long sessid; 
    /** Error status (non_repeaters in GetBulk) */
    long errstat; 
    /** Error index (max_repetitions in GetBulk) */
    long errindex; 
    /** Uptime */
    u_long time; 
    u_long flags;  
    int securityModel; 
    /** noAuthNoPriv, authNoPriv, authPriv */
    int securityLevel; 
    int msgParseModel;  
    /**
Transport-specific opaque data. This replaces the IP-centric address
field. 
        */
    void *transport_data; 
    int transport_data_length;  
    /**
The actual transport domain. This SHOULD NOT BE FREE()D. 
        */
    const oid *tDomain; 
    size_t tDomainLen;  
    netsnmp_variable_list *variables;   
    /*
 * SNMPv1 & SNMPv2c fields
        */
    /** community for outgoing requests. */
    u_char *community; 
    /** length of community name. */
    size_t community_len;  
    /*
 * Trap information
        */
    /** System OID */
    oid *enterprise; 
    size_t enterprise_length; 
    /** trap type */
    long trap_type; 
    /** specific type */
    long specific_type; 
    /** This is ONLY used for v1 TRAPs */
    unsigned char agent_addr[4];  
    /*
 * SNMPv3 fields
        */
    /** context snmpEngineID */
    u_char *contextEngineID; 
    /** Length of contextEngineID */
    size_t contextEngineIDLen; 
    /** authoritative contextName */
    char *contextName; 
    /** Length of contextName */
    size_t contextNameLen; 
    /** authoritative snmpEngineID for security */
    u_char *securityEngineID; 
    /** Length of securityEngineID */
    size_t securityEngineIDLen; 
    /** on behalf of this principal */
    char *securityName; 
    /** Length of securityName. */
    size_t securityNameLen;  
    /*
 * AgentX fields
 * (also uses SNMPv1 community field)
        */
    int priority; 
    int range_subid;  
    void *securityStateRef; 
} netsnmp_pdu;  

Discussion

* Typedefs the snmp_pdu struct into netsnmp_pdu

struct snmp_session netsnmp_session

typedef struct snmp_session netsnmp_session;  

Discussion

* Typedefs the snmp_session struct intonetsnmp_session

variable_list

struct variable_list netsnmp_variable_list

typedef struct variable_list netsnmp_variable_list;  

Discussion

* Typedefs the variable_list struct into netsnmp_variable_list

netsnmp_pdu

/** @struct snmp_pdu
The snmp protocol data unit.
    */
typedef struct snmp_pdu {  
    /*
 * Protocol-version independent fields
        */
    /** snmp version */
    long version; 
    /** Type of this PDU */
    int command; 
    /** Request id - note: not incremented on retries */
    long reqid; 
    /** Message id for V3 messages note: incremented for each retry 
        */
    long msgid; 
    /** Unique ID for incoming transactions */
    long transid; 
    /** Session id for AgentX messages */
    long sessid; 
    /** Error status (non_repeaters in GetBulk) */
    long errstat; 
    /** Error index (max_repetitions in GetBulk) */
    long errindex; 
    /** Uptime */
    u_long time; 
    u_long flags;  
    int securityModel; 
    /** noAuthNoPriv, authNoPriv, authPriv */
    int securityLevel; 
    int msgParseModel;  
    /**
Transport-specific opaque data. This replaces the IP-centric address
field. 
        */
    void *transport_data; 
    int transport_data_length;  
    /**
The actual transport domain. This SHOULD NOT BE FREE()D. 
        */
    const oid *tDomain; 
    size_t tDomainLen;  
    netsnmp_variable_list *variables;   
    /*
 * SNMPv1 & SNMPv2c fields
        */
    /** community for outgoing requests. */
    u_char *community; 
    /** length of community name. */
    size_t community_len;  
    /*
 * Trap information
        */
    /** System OID */
    oid *enterprise; 
    size_t enterprise_length; 
    /** trap type */
    long trap_type; 
    /** specific type */
    long specific_type; 
    /** This is ONLY used for v1 TRAPs */
    unsigned char agent_addr[4];  
    /*
 * SNMPv3 fields
        */
    /** context snmpEngineID */
    u_char *contextEngineID; 
    /** Length of contextEngineID */
    size_t contextEngineIDLen; 
    /** authoritative contextName */
    char *contextName; 
    /** Length of contextName */
    size_t contextNameLen; 
    /** authoritative snmpEngineID for security */
    u_char *securityEngineID; 
    /** Length of securityEngineID */
    size_t securityEngineIDLen; 
    /** on behalf of this principal */
    char *securityName; 
    /** Length of securityName. */
    size_t securityNameLen;  
    /*
 * AgentX fields
 * (also uses SNMPv1 community field)
        */
    int priority; 
    int range_subid;  
    void *securityStateRef; 
} netsnmp_pdu;  

Discussion

* Typedefs the snmp_pdu struct into netsnmp_pdu

netsnmp_session

typedef struct snmp_session netsnmp_session;  

Discussion

* Typedefs the snmp_session struct intonetsnmp_session

variable_list

netsnmp_variable_list

typedef struct variable_list netsnmp_variable_list;  

Discussion

* Typedefs the variable_list struct into netsnmp_variable_list

Structs and Unions

struct snmp_session { 
    /*
 * Protocol-version independent fields
        */
    /** snmp version */
    long version; 
    /** Number of retries before timeout. */
    int retries; 
    /** Number of uS until first timeout, then exponential backoff 
        */
    long timeout; 
    u_long flags; 
    struct snmp_session *subsession; 
    struct snmp_session *next;  
    /** Domain name or dotted IP address of default peer */
    char *peername; 
    /** UDP port number of peer. */
    u_short remote_port; 
    /** My Domain name or dotted IP address, 0 for default */
    char *localname; 
    /** My UDP port number, 0 for default, picked randomly */
    u_short local_port; 
    /**
Authentication function or NULL if null authentication is used 
        */
    u_char *(*authenticator) (
        u_char *,
        size_t *,
        u_char *,
        size_t); 
    /** Function to interpret incoming data */
    netsnmp_callback callback; 
    /**
Pointer to data that the callback function may consider important 
        */
    void *callback_magic; 
    /** copy of system errno */
    int s_errno; 
    /** copy of library errno */
    int s_snmp_errno; 
    /** Session id - AgentX only */
    long sessid;  
    /*
 * SNMPv1 & SNMPv2c fields
        */
    /** community for outgoing requests. */
    u_char *community; 
    /** Length of community name. */
    size_t community_len; 
    /** Largest message to try to receive. */
    size_t rcvMsgMaxSize; 
    /** Largest message to try to send. */
    size_t sndMsgMaxSize;  
    /*
 * SNMPv3 fields
        */
    /** are we the authoritative engine? */
    u_char isAuthoritative; 
    /** authoritative snmpEngineID */
    u_char *contextEngineID; 
    /** Length of contextEngineID */
    size_t contextEngineIDLen; 
    /** initial engineBoots for remote engine */
    u_int engineBoots; 
    /** initial engineTime for remote engine */
    u_int engineTime; 
    /** authoritative contextName */
    char *contextName; 
    /** Length of contextName */
    size_t contextNameLen; 
    /** authoritative snmpEngineID */
    u_char *securityEngineID; 
    /** Length of contextEngineID */
    size_t securityEngineIDLen; 
    /** on behalf of this principal */
    char *securityName; 
    /** Length of securityName. */
    size_t securityNameLen;  
    /** auth protocol oid */
    oid *securityAuthProto; 
    /** Length of auth protocol oid */
    size_t securityAuthProtoLen; 
    /** Ku for auth protocol XXX */
    u_char securityAuthKey[USM_AUTH_KU_LEN]; 
    /** Length of Ku for auth protocol */
    size_t securityAuthKeyLen; 
    /** Kul for auth protocol */
    u_char *securityAuthLocalKey; 
    /** Length of Kul for auth protocol XXX */
    size_t securityAuthLocalKeyLen;  
    /** priv protocol oid */
    oid *securityPrivProto; 
    /** Length of priv protocol oid */
    size_t securityPrivProtoLen; 
    /** Ku for privacy protocol XXX */
    u_char securityPrivKey[USM_PRIV_KU_LEN]; 
    /** Length of Ku for priv protocol */
    size_t securityPrivKeyLen; 
    /** Kul for priv protocol */
    u_char *securityPrivLocalKey; 
    /** Length of Kul for priv protocol XXX */
    size_t securityPrivLocalKeyLen;  
    /** snmp security model, v1, v2c, usm */
    int securityModel; 
    /** noAuthNoPriv, authNoPriv, authPriv */
    int securityLevel;  
    /**
security module specific 
        */
    void *securityInfo;  
    /**
use as you want data 
        */
    void *myvoid; 
};  

Discussion

The snmp session structure.

struct variable_list netsnmp_variable_list

netsnmp_variable_list

struct variable_list;  

Discussion

* Typedefs the variable_list struct into netsnmp_variable_list

struct variable_list { 
    /** NULL for last variable */
    struct variable_list *next_variable; 
    /** Object identifier of variable */
    oid *name; 
    /** number of subid's in name */
    size_t name_length; 
    /** ASN type of variable */
    u_char type; 
    /** value of variable */
    netsnmp_vardata val; 
    /** the length of the value to be copied into buf */
    size_t val_len; 
    /** 90 percentile < 24. */
    oid name_loc[MAX_OID_LEN]; 
    /** 90 percentile < 40. */
    u_char buf[40]; 
    /** (Opaque) hook for additional data */
    void *data; 
    /** callback to free above */
    void (*dataFreeHook)(
        void *); 
    int index; 
};  

Discussion

The netsnmp variable list binding structure, it's typedef'd to netsnmp_variable_list.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2006-06-20