user/net-snmp/man/netsnmp_snmp_session.3

   1 .TH "snmp_session" 3 "23 Sep 2009" "Version 5.5" "net-snmp" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 snmp_session \-
   6 .PP
   7 The snmp session structure.
   8
   9 .SH SYNOPSIS
  10 .br
  11 .PP
  12 .PP
  13 \fC#include <types.h>\fP
  14 .SS "Data Fields"
  15
  16 .in +1c
  17 .ti -1c
  18 .RI "long \fBversion\fP"
  19 .br
  20 .RI "\fIsnmp version \fP"
  21 .ti -1c
  22 .RI "int \fBretries\fP"
  23 .br
  24 .RI "\fINumber of retries before timeout. \fP"
  25 .ti -1c
  26 .RI "long \fBtimeout\fP"
  27 .br
  28 .RI "\fINumber of uS until first timeout, then exponential backoff. \fP"
  29 .ti -1c
  30 .RI "u_long \fBflags\fP"
  31 .br
  32 .ti -1c
  33 .RI "struct \fBsnmp_session\fP * \fBsubsession\fP"
  34 .br
  35 .ti -1c
  36 .RI "struct \fBsnmp_session\fP * \fBnext\fP"
  37 .br
  38 .ti -1c
  39 .RI "char * \fBpeername\fP"
  40 .br
  41 .RI "\fIname or address of default peer (may include transport specifier and/or port number) \fP"
  42 .ti -1c
  43 .RI "u_short \fBremote_port\fP"
  44 .br
  45 .RI "\fIUDP port number of peer. \fP"
  46 .ti -1c
  47 .RI "char * \fBlocalname\fP"
  48 .br
  49 .RI "\fIMy Domain name or dotted IP address, 0 for default. \fP"
  50 .ti -1c
  51 .RI "u_short \fBlocal_port\fP"
  52 .br
  53 .RI "\fIMy UDP port number, 0 for default, picked randomly. \fP"
  54 .ti -1c
  55 .RI "u_char *(* \fBauthenticator\fP )(u_char *, size_t *, u_char *, size_t)"
  56 .br
  57 .RI "\fIAuthentication function or NULL if null authentication is used. \fP"
  58 .ti -1c
  59 .RI "netsnmp_callback \fBcallback\fP"
  60 .br
  61 .RI "\fIFunction to interpret incoming data. \fP"
  62 .ti -1c
  63 .RI "void * \fBcallback_magic\fP"
  64 .br
  65 .RI "\fIPointer to data that the callback function may consider important. \fP"
  66 .ti -1c
  67 .RI "int \fBs_errno\fP"
  68 .br
  69 .RI "\fIcopy of system errno \fP"
  70 .ti -1c
  71 .RI "int \fBs_snmp_errno\fP"
  72 .br
  73 .RI "\fIcopy of library errno \fP"
  74 .ti -1c
  75 .RI "long \fBsessid\fP"
  76 .br
  77 .RI "\fISession id - AgentX only. \fP"
  78 .ti -1c
  79 .RI "u_char * \fBcommunity\fP"
  80 .br
  81 .RI "\fIcommunity for outgoing requests. \fP"
  82 .ti -1c
  83 .RI "size_t \fBcommunity_len\fP"
  84 .br
  85 .RI "\fILength of community name. \fP"
  86 .ti -1c
  87 .RI "size_t \fBrcvMsgMaxSize\fP"
  88 .br
  89 .RI "\fILargest message to try to receive. \fP"
  90 .ti -1c
  91 .RI "size_t \fBsndMsgMaxSize\fP"
  92 .br
  93 .RI "\fILargest message to try to send. \fP"
  94 .ti -1c
  95 .RI "u_char \fBisAuthoritative\fP"
  96 .br
  97 .RI "\fIare we the authoritative engine? \fP"
  98 .ti -1c
  99 .RI "u_char * \fBcontextEngineID\fP"
 100 .br
 101 .RI "\fIauthoritative snmpEngineID \fP"
 102 .ti -1c
 103 .RI "size_t \fBcontextEngineIDLen\fP"
 104 .br
 105 .RI "\fILength of contextEngineID. \fP"
 106 .ti -1c
 107 .RI "u_int \fBengineBoots\fP"
 108 .br
 109 .RI "\fIinitial engineBoots for remote engine \fP"
 110 .ti -1c
 111 .RI "u_int \fBengineTime\fP"
 112 .br
 113 .RI "\fIinitial engineTime for remote engine \fP"
 114 .ti -1c
 115 .RI "char * \fBcontextName\fP"
 116 .br
 117 .RI "\fIauthoritative contextName \fP"
 118 .ti -1c
 119 .RI "size_t \fBcontextNameLen\fP"
 120 .br
 121 .RI "\fILength of contextName. \fP"
 122 .ti -1c
 123 .RI "u_char * \fBsecurityEngineID\fP"
 124 .br
 125 .RI "\fIauthoritative snmpEngineID \fP"
 126 .ti -1c
 127 .RI "size_t \fBsecurityEngineIDLen\fP"
 128 .br
 129 .RI "\fILength of contextEngineID. \fP"
 130 .ti -1c
 131 .RI "char * \fBsecurityName\fP"
 132 .br
 133 .RI "\fIon behalf of this principal \fP"
 134 .ti -1c
 135 .RI "size_t \fBsecurityNameLen\fP"
 136 .br
 137 .RI "\fILength of securityName. \fP"
 138 .ti -1c
 139 .RI "oid * \fBsecurityAuthProto\fP"
 140 .br
 141 .RI "\fIauth protocol oid \fP"
 142 .ti -1c
 143 .RI "size_t \fBsecurityAuthProtoLen\fP"
 144 .br
 145 .RI "\fILength of auth protocol oid. \fP"
 146 .ti -1c
 147 .RI "u_char \fBsecurityAuthKey\fP [USM_AUTH_KU_LEN]"
 148 .br
 149 .RI "\fIKu for auth protocol XXX. \fP"
 150 .ti -1c
 151 .RI "size_t \fBsecurityAuthKeyLen\fP"
 152 .br
 153 .RI "\fILength of Ku for auth protocol. \fP"
 154 .ti -1c
 155 .RI "u_char * \fBsecurityAuthLocalKey\fP"
 156 .br
 157 .RI "\fIKul for auth protocol. \fP"
 158 .ti -1c
 159 .RI "size_t \fBsecurityAuthLocalKeyLen\fP"
 160 .br
 161 .RI "\fILength of Kul for auth protocol XXX. \fP"
 162 .ti -1c
 163 .RI "oid * \fBsecurityPrivProto\fP"
 164 .br
 165 .RI "\fIpriv protocol oid \fP"
 166 .ti -1c
 167 .RI "size_t \fBsecurityPrivProtoLen\fP"
 168 .br
 169 .RI "\fILength of priv protocol oid. \fP"
 170 .ti -1c
 171 .RI "u_char \fBsecurityPrivKey\fP [USM_PRIV_KU_LEN]"
 172 .br
 173 .RI "\fIKu for privacy protocol XXX. \fP"
 174 .ti -1c
 175 .RI "size_t \fBsecurityPrivKeyLen\fP"
 176 .br
 177 .RI "\fILength of Ku for priv protocol. \fP"
 178 .ti -1c
 179 .RI "u_char * \fBsecurityPrivLocalKey\fP"
 180 .br
 181 .RI "\fIKul for priv protocol. \fP"
 182 .ti -1c
 183 .RI "size_t \fBsecurityPrivLocalKeyLen\fP"
 184 .br
 185 .RI "\fILength of Kul for priv protocol XXX. \fP"
 186 .ti -1c
 187 .RI "int \fBsecurityModel\fP"
 188 .br
 189 .RI "\fIsnmp security model, v1, v2c, usm \fP"
 190 .ti -1c
 191 .RI "int \fBsecurityLevel\fP"
 192 .br
 193 .RI "\fInoAuthNoPriv, authNoPriv, authPriv \fP"
 194 .ti -1c
 195 .RI "char * \fBparamName\fP"
 196 .br
 197 .RI "\fItarget param name \fP"
 198 .ti -1c
 199 .RI "void * \fBsecurityInfo\fP"
 200 .br
 201 .RI "\fIsecurity \fBmodule\fP specific \fP"
 202 .ti -1c
 203 .RI "void * \fBmyvoid\fP"
 204 .br
 205 .RI "\fIuse as you want data \fP"
 206 .in -1c
 207 .SH "Detailed Description"
 208 .PP
 209 The snmp session structure.
 210 .PP
 211 Definition at line 260 of file types.h.
 212 .SH "Field Documentation"
 213 .PP
 214 .SS "u_char*(* \fBsnmp_session::authenticator\fP)(u_char *, size_t *, u_char *, size_t)"
 215 .PP
 216 Authentication function or NULL if null authentication is used.
 217 .SS "netsnmp_callback \fBsnmp_session::callback\fP"
 218 .PP
 219 Function to interpret incoming data.
 220 .PP
 221 Definition at line 287 of file types.h.
 222 .SS "void* \fBsnmp_session::callback_magic\fP"
 223 .PP
 224 Pointer to data that the callback function may consider important.
 225 .PP
 226 Definition at line 291 of file types.h.
 227 .SS "u_char* \fBsnmp_session::community\fP"
 228 .PP
 229 community for outgoing requests.
 230 .PP
 231 Definition at line 303 of file types.h.
 232 .SS "size_t \fBsnmp_session::community_len\fP"
 233 .PP
 234 Length of community name.
 235 .PP
 236 Definition at line 305 of file types.h.
 237 .SS "u_char* \fBsnmp_session::contextEngineID\fP"
 238 .PP
 239 authoritative snmpEngineID
 240 .PP
 241 Definition at line 317 of file types.h.
 242 .SS "size_t \fBsnmp_session::contextEngineIDLen\fP"
 243 .PP
 244 Length of contextEngineID.
 245 .PP
 246 Definition at line 319 of file types.h.
 247 .SS "char* \fBsnmp_session::contextName\fP"
 248 .PP
 249 authoritative contextName
 250 .PP
 251 Definition at line 325 of file types.h.
 252 .SS "size_t \fBsnmp_session::contextNameLen\fP"
 253 .PP
 254 Length of contextName.
 255 .PP
 256 Definition at line 327 of file types.h.
 257 .SS "u_int \fBsnmp_session::engineBoots\fP"
 258 .PP
 259 initial engineBoots for remote engine
 260 .PP
 261 Definition at line 321 of file types.h.
 262 .SS "u_int \fBsnmp_session::engineTime\fP"
 263 .PP
 264 initial engineTime for remote engine
 265 .PP
 266 Definition at line 323 of file types.h.
 267 .SS "u_char \fBsnmp_session::isAuthoritative\fP"
 268 .PP
 269 are we the authoritative engine?
 270 .PP
 271 Definition at line 315 of file types.h.
 272 .SS "u_short \fBsnmp_session::local_port\fP"
 273 .PP
 274 My UDP port number, 0 for default, picked randomly.
 275 .PP
 276 Definition at line 281 of file types.h.
 277 .SS "char* \fBsnmp_session::localname\fP"
 278 .PP
 279 My Domain name or dotted IP address, 0 for default.
 280 .PP
 281 Definition at line 279 of file types.h.
 282 .SS "void* \fBsnmp_session::myvoid\fP"
 283 .PP
 284 use as you want data used by 'SNMP_FLAGS_RESP_CALLBACK' handling in the agent XXX: or should we add a new field into this structure?
 285 .PP
 286 Definition at line 381 of file types.h.
 287 .SS "char* \fBsnmp_session::paramName\fP"
 288 .PP
 289 target param name
 290 .PP
 291 Definition at line 368 of file types.h.
 292 .SS "char* \fBsnmp_session::peername\fP"
 293 .PP
 294 name or address of default peer (may include transport specifier and/or port number)
 295 .PP
 296 Definition at line 275 of file types.h.
 297 .SS "size_t \fBsnmp_session::rcvMsgMaxSize\fP"
 298 .PP
 299 Largest message to try to receive.
 300 .PP
 301 Definition at line 307 of file types.h.
 302 .SS "u_short \fBsnmp_session::remote_port\fP"
 303 .PP
 304 UDP port number of peer. (NO LONGER USED - USE peername INSTEAD)
 305 .PP
 306 Definition at line 277 of file types.h.
 307 .SS "int \fBsnmp_session::retries\fP"
 308 .PP
 309 Number of retries before timeout.
 310 .PP
 311 Definition at line 267 of file types.h.
 312 .SS "int \fBsnmp_session::s_errno\fP"
 313 .PP
 314 copy of system errno
 315 .PP
 316 Definition at line 293 of file types.h.
 317 .SS "int \fBsnmp_session::s_snmp_errno\fP"
 318 .PP
 319 copy of library errno
 320 .PP
 321 Definition at line 295 of file types.h.
 322 .SS "u_char \fBsnmp_session::securityAuthKey\fP[USM_AUTH_KU_LEN]"
 323 .PP
 324 Ku for auth protocol XXX.
 325 .PP
 326 Definition at line 342 of file types.h.
 327 .SS "size_t \fBsnmp_session::securityAuthKeyLen\fP"
 328 .PP
 329 Length of Ku for auth protocol.
 330 .PP
 331 Definition at line 344 of file types.h.
 332 .SS "u_char* \fBsnmp_session::securityAuthLocalKey\fP"
 333 .PP
 334 Kul for auth protocol.
 335 .PP
 336 Definition at line 346 of file types.h.
 337 .SS "size_t \fBsnmp_session::securityAuthLocalKeyLen\fP"
 338 .PP
 339 Length of Kul for auth protocol XXX.
 340 .PP
 341 Definition at line 348 of file types.h.
 342 .SS "oid* \fBsnmp_session::securityAuthProto\fP"
 343 .PP
 344 auth protocol oid
 345 .PP
 346 Definition at line 338 of file types.h.
 347 .SS "size_t \fBsnmp_session::securityAuthProtoLen\fP"
 348 .PP
 349 Length of auth protocol oid.
 350 .PP
 351 Definition at line 340 of file types.h.
 352 .SS "u_char* \fBsnmp_session::securityEngineID\fP"
 353 .PP
 354 authoritative snmpEngineID
 355 .PP
 356 Definition at line 329 of file types.h.
 357 .SS "size_t \fBsnmp_session::securityEngineIDLen\fP"
 358 .PP
 359 Length of contextEngineID.
 360 .PP
 361 Definition at line 331 of file types.h.
 362 .SS "void* \fBsnmp_session::securityInfo\fP"
 363 .PP
 364 security \fBmodule\fP specific
 365 .PP
 366 Definition at line 373 of file types.h.
 367 .SS "int \fBsnmp_session::securityLevel\fP"
 368 .PP
 369 noAuthNoPriv, authNoPriv, authPriv
 370 .PP
 371 Definition at line 366 of file types.h.
 372 .SS "int \fBsnmp_session::securityModel\fP"
 373 .PP
 374 snmp security model, v1, v2c, usm
 375 .PP
 376 Definition at line 364 of file types.h.
 377 .SS "char* \fBsnmp_session::securityName\fP"
 378 .PP
 379 on behalf of this principal
 380 .PP
 381 Definition at line 333 of file types.h.
 382 .SS "size_t \fBsnmp_session::securityNameLen\fP"
 383 .PP
 384 Length of securityName.
 385 .PP
 386 Definition at line 335 of file types.h.
 387 .SS "u_char \fBsnmp_session::securityPrivKey\fP[USM_PRIV_KU_LEN]"
 388 .PP
 389 Ku for privacy protocol XXX.
 390 .PP
 391 Definition at line 355 of file types.h.
 392 .SS "size_t \fBsnmp_session::securityPrivKeyLen\fP"
 393 .PP
 394 Length of Ku for priv protocol.
 395 .PP
 396 Definition at line 357 of file types.h.
 397 .SS "u_char* \fBsnmp_session::securityPrivLocalKey\fP"
 398 .PP
 399 Kul for priv protocol.
 400 .PP
 401 Definition at line 359 of file types.h.
 402 .SS "size_t \fBsnmp_session::securityPrivLocalKeyLen\fP"
 403 .PP
 404 Length of Kul for priv protocol XXX.
 405 .PP
 406 Definition at line 361 of file types.h.
 407 .SS "oid* \fBsnmp_session::securityPrivProto\fP"
 408 .PP
 409 priv protocol oid
 410 .PP
 411 Definition at line 351 of file types.h.
 412 .SS "size_t \fBsnmp_session::securityPrivProtoLen\fP"
 413 .PP
 414 Length of priv protocol oid.
 415 .PP
 416 Definition at line 353 of file types.h.
 417 .SS "long \fBsnmp_session::sessid\fP"
 418 .PP
 419 Session id - AgentX only.
 420 .PP
 421 Definition at line 297 of file types.h.
 422 .SS "size_t \fBsnmp_session::sndMsgMaxSize\fP"
 423 .PP
 424 Largest message to try to send.
 425 .PP
 426 Definition at line 309 of file types.h.
 427 .SS "long \fBsnmp_session::timeout\fP"
 428 .PP
 429 Number of uS until first timeout, then exponential backoff.
 430 .PP
 431 Definition at line 269 of file types.h.
 432 .SS "long \fBsnmp_session::version\fP"
 433 .PP
 434 snmp version
 435 .PP
 436 Definition at line 265 of file types.h.
 437
 438 .SH "Author"
 439 .PP
 440 Generated automatically by Doxygen for net-snmp from the source code.