snmp_session(3)

NAME
snmp_session - The snmp session structure.

SYNOPSIS

#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
snmp_session * subsession
snmp_session * next
char * peername
Domain name or dotted IP address of default peer.
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.

Referenced by netsnmp_register_agent_nsap().

  netsnmp_callback snmp_session::callback

Function to interpret incoming data.

Definition at line 214 of file snmp_api.h.

Referenced by _sess_read(), netsnmp_register_agent_nsap(), snmp_sess_synch_response(), snmp_sess_timeout(), and snmp_synch_response_cb().

  void* snmp_session::callback_magic

Pointer to data that the callback function may consider important.

Definition at line 218 of file snmp_api.h.

Referenced by _sess_read(), snmp_sess_synch_response(), snmp_sess_timeout(), and snmp_synch_response_cb().

  u_char* snmp_session::community

community for outgoing requests.

Definition at line 230 of file snmp_api.h.

  size_t snmp_session::community_len

Length of community name.

Definition at line 232 of file snmp_api.h.

  u_char* snmp_session::contextEngineID

authoritative snmpEngineID

Definition at line 244 of file snmp_api.h.

  size_t snmp_session::contextEngineIDLen

Length of contextEngineID.

Definition at line 246 of file snmp_api.h.

  char* snmp_session::contextName

authoritative contextName

Definition at line 252 of file snmp_api.h.

Referenced by unregister_mibs_by_session().

  size_t snmp_session::contextNameLen

Length of contextName.

Definition at line 254 of file snmp_api.h.

  u_int snmp_session::engineBoots

initial engineBoots for remote engine

Definition at line 248 of file snmp_api.h.

Referenced by snmpv3_engineID_probe().

  u_int snmp_session::engineTime

initial engineTime for remote engine

Definition at line 250 of file snmp_api.h.

Referenced by snmpv3_engineID_probe().

  u_char snmp_session::isAuthoritative

are we the authoritative engine?

Definition at line 242 of file snmp_api.h.

Referenced by netsnmp_register_agent_nsap().

  u_short snmp_session::local_port

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

Definition at line 208 of file snmp_api.h.

  char* snmp_session::localname

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

Definition at line 206 of file snmp_api.h.

  void* snmp_session::myvoid

use as you want data

Definition at line 305 of file snmp_api.h.

  char* snmp_session::paramName

target param name

Definition at line 295 of file snmp_api.h.

  char* snmp_session::peername

Domain name or dotted IP address of default peer.

Definition at line 202 of file snmp_api.h.

  size_t snmp_session::rcvMsgMaxSize

Largest message to try to receive.

Definition at line 234 of file snmp_api.h.

Referenced by snmp_sess_add_ex(), and snmp_sess_init().

  u_short snmp_session::remote_port

UDP port number of peer.

Definition at line 204 of file snmp_api.h.

Referenced by snmp_sess_init().

  int snmp_session::retries

Number of retries before timeout.

Definition at line 194 of file snmp_api.h.

Referenced by snmp_sess_init(), and snmp_sess_timeout().

  int snmp_session::s_errno

copy of system errno

Definition at line 220 of file snmp_api.h.

Referenced by _sess_read(), and snmp_error().

  int snmp_session::s_snmp_errno

copy of library errno

Definition at line 222 of file snmp_api.h.

Referenced by _sess_read(), handle_snmp_packet(), snmp_build(), snmp_error(), snmp_sess_add_ex(), snmp_sess_async_send(), snmp_sess_open(), snmp_sess_read(), and snmpv3_engineID_probe().

  u_char snmp_session::securityAuthKey[USM_AUTH_KU_LEN]

Ku for auth protocol XXX.

Definition at line 269 of file snmp_api.h.

Referenced by create_user_from_session().

  size_t snmp_session::securityAuthKeyLen

Length of Ku for auth protocol.

Definition at line 271 of file snmp_api.h.

Referenced by create_user_from_session().

  u_char* snmp_session::securityAuthLocalKey

Kul for auth protocol.

Definition at line 273 of file snmp_api.h.

Referenced by create_user_from_session().

  size_t snmp_session::securityAuthLocalKeyLen

Length of Kul for auth protocol XXX.

Definition at line 275 of file snmp_api.h.

Referenced by create_user_from_session().

  oid* snmp_session::securityAuthProto

auth protocol oid

Definition at line 265 of file snmp_api.h.

Referenced by create_user_from_session().

  size_t snmp_session::securityAuthProtoLen

Length of auth protocol oid.

Definition at line 267 of file snmp_api.h.

Referenced by create_user_from_session().

  u_char* snmp_session::securityEngineID

authoritative snmpEngineID

Definition at line 256 of file snmp_api.h.

Referenced by create_user_from_session(), and snmpv3_engineID_probe().

  size_t snmp_session::securityEngineIDLen

Length of contextEngineID.

Definition at line 258 of file snmp_api.h.

Referenced by create_user_from_session(), and snmpv3_engineID_probe().

  void* snmp_session::securityInfo

security module specific

Definition at line 300 of file snmp_api.h.

  int snmp_session::securityLevel

noAuthNoPriv, authNoPriv, authPriv

Definition at line 293 of file snmp_api.h.

  int snmp_session::securityModel

snmp security model, v1, v2c, usm

Definition at line 291 of file snmp_api.h.

Referenced by create_user_from_session(), snmp_sess_close(), and snmp_sess_init().

  char* snmp_session::securityName

on behalf of this principal

Definition at line 260 of file snmp_api.h.

Referenced by create_user_from_session().

  size_t snmp_session::securityNameLen

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.

Referenced by create_user_from_session().

  size_t snmp_session::securityPrivKeyLen

Length of Ku for priv protocol.

Definition at line 284 of file snmp_api.h.

Referenced by create_user_from_session().

  u_char* snmp_session::securityPrivLocalKey

Kul for priv protocol.

Definition at line 286 of file snmp_api.h.

Referenced by create_user_from_session().

  size_t snmp_session::securityPrivLocalKeyLen

Length of Kul for priv protocol XXX.

Definition at line 288 of file snmp_api.h.

Referenced by create_user_from_session().

  oid* snmp_session::securityPrivProto

priv protocol oid

Definition at line 278 of file snmp_api.h.

Referenced by create_user_from_session().

  size_t snmp_session::securityPrivProtoLen

Length of priv protocol oid.

Definition at line 280 of file snmp_api.h.

Referenced by create_user_from_session().

  long snmp_session::sessid

Session id - AgentX only.

Definition at line 224 of file snmp_api.h.

Referenced by send_trap_to_sess().

  size_t snmp_session::sndMsgMaxSize

Largest message to try to send.

Definition at line 236 of file snmp_api.h.

Referenced by snmpv3_parse().

  long snmp_session::timeout

Number of uS until first timeout, then exponential backoff.

Definition at line 196 of file snmp_api.h.

Referenced by snmp_sess_init().

  long snmp_session::version

snmp version

Definition at line 192 of file snmp_api.h.

Referenced by add_trap_session(), create_user_from_session(), netsnmp_register_agent_nsap(), send_trap_to_sess(), snmp_sess_add_ex(), snmp_sess_init(), and snmpv3_engineID_probe().

Author

Generated automatically by Doxygen for net-snmp from the source code.