net-snmp  5.4.1
Data Fields
snmp_session Struct Reference

The snmp session structure. More...

#include <snmp_api.h>

Data Fields

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

Detailed Description

The snmp session structure.

Definition at line 187 of file snmp_api.h.


Field Documentation

u_char*(* snmp_session::authenticator)(u_char *, size_t *, u_char *, size_t)

Authentication function or NULL if null authentication is used.

Definition at line 212 of file snmp_api.h.

netsnmp_callback snmp_session::callback

Function to interpret incoming data.

Definition at line 214 of file snmp_api.h.

Pointer to data that the callback function may consider important.

Definition at line 218 of file snmp_api.h.

community for outgoing requests.

Definition at line 230 of file snmp_api.h.

Length of community name.

Definition at line 232 of file snmp_api.h.

authoritative snmpEngineID

Definition at line 244 of file snmp_api.h.

Length of contextEngineID.

Definition at line 246 of file snmp_api.h.

authoritative contextName

Definition at line 252 of file snmp_api.h.

Length of contextName.

Definition at line 254 of file snmp_api.h.

initial engineBoots for remote engine

Definition at line 248 of file snmp_api.h.

initial engineTime for remote engine

Definition at line 250 of file snmp_api.h.

are we the authoritative engine?

Definition at line 242 of file snmp_api.h.

My UDP port number, 0 for default, picked randomly.

Definition at line 208 of file snmp_api.h.

My Domain name or dotted IP address, 0 for default.

Definition at line 206 of file snmp_api.h.

use as you want data

Definition at line 305 of file snmp_api.h.

target param name

Definition at line 295 of file snmp_api.h.

name or address of default peer (may include transport specifier and/or port number)

Definition at line 202 of file snmp_api.h.

Largest message to try to receive.

Definition at line 234 of file snmp_api.h.

UDP port number of peer.

(NO LONGER USED - USE peername INSTEAD)

Definition at line 204 of file snmp_api.h.

Number of retries before timeout.

Definition at line 194 of file snmp_api.h.

copy of system errno

Definition at line 220 of file snmp_api.h.

copy of library errno

Definition at line 222 of file snmp_api.h.

u_char snmp_session::securityAuthKey[USM_AUTH_KU_LEN]

Ku for auth protocol XXX.

Definition at line 269 of file snmp_api.h.

Length of Ku for auth protocol.

Definition at line 271 of file snmp_api.h.

Kul for auth protocol.

Definition at line 273 of file snmp_api.h.

Length of Kul for auth protocol XXX.

Definition at line 275 of file snmp_api.h.

auth protocol oid

Definition at line 265 of file snmp_api.h.

Length of auth protocol oid.

Definition at line 267 of file snmp_api.h.

authoritative snmpEngineID

Definition at line 256 of file snmp_api.h.

Length of contextEngineID.

Definition at line 258 of file snmp_api.h.

security module specific

Definition at line 300 of file snmp_api.h.

noAuthNoPriv, authNoPriv, authPriv

Definition at line 293 of file snmp_api.h.

snmp security model, v1, v2c, usm

Definition at line 291 of file snmp_api.h.

on behalf of this principal

Definition at line 260 of file snmp_api.h.

Length of securityName.

Definition at line 262 of file snmp_api.h.

u_char snmp_session::securityPrivKey[USM_PRIV_KU_LEN]

Ku for privacy protocol XXX.

Definition at line 282 of file snmp_api.h.

Length of Ku for priv protocol.

Definition at line 284 of file snmp_api.h.

Kul for priv protocol.

Definition at line 286 of file snmp_api.h.

Length of Kul for priv protocol XXX.

Definition at line 288 of file snmp_api.h.

priv protocol oid

Definition at line 278 of file snmp_api.h.

Length of priv protocol oid.

Definition at line 280 of file snmp_api.h.

Session id - AgentX only.

Definition at line 224 of file snmp_api.h.

Largest message to try to send.

Definition at line 236 of file snmp_api.h.

Number of uS until first timeout, then exponential backoff.

Definition at line 196 of file snmp_api.h.

snmp version

Definition at line 192 of file snmp_api.h.


The documentation for this struct was generated from the following file: