← Back to branch summary

~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

« back to all changes in this revision

Viewing changes to man/netsnmp_snmp_session.3

  • Committer: Bazaar Package Importer
  • Author(s): Jochen Friedrich
  • Date: 2010-06-10 18:02:54 UTC
  • mto: (1.4.1 experimental)
  • mto: This revision was merged to the branch mainline in revision 44.
  • Revision ID: james.westby@ubuntu.com-20100610180254-6ezvupl2clicwdqf
Import upstream version 5.4.3~dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_snmp_session.3
1
 
.TH "snmp_session" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
 
1
.TH "snmp_session" 3 "23 May 2010" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
5
 
snmp_session \- The snmp session structure.  
 
5
snmp_session \- 
 
6
.PP
 
7
The snmp session structure.  
6
8
 
7
 
.PP
8
9
.SH SYNOPSIS
9
10
.br
10
11
.PP
 
12
.PP
11
13
\fC#include <snmp_api.h>\fP
12
 
.PP
13
14
.SS "Data Fields"
14
15
 
15
16
.in +1c
29
30
.RI "u_long \fBflags\fP"
30
31
.br
31
32
.ti -1c
32
 
.RI "\fBsnmp_session\fP * \fBsubsession\fP"
 
33
.RI "struct \fBsnmp_session\fP * \fBsubsession\fP"
33
34
.br
34
35
.ti -1c
35
 
.RI "\fBsnmp_session\fP * \fBnext\fP"
 
36
.RI "struct \fBsnmp_session\fP * \fBnext\fP"
36
37
.br
37
38
.ti -1c
38
39
.RI "char * \fBpeername\fP"
197
198
.ti -1c
198
199
.RI "void * \fBsecurityInfo\fP"
199
200
.br
200
 
.RI "\fIsecurity module specific \fP"
 
201
.RI "\fIsecurity \fBmodule\fP specific \fP"
201
202
.ti -1c
202
203
.RI "void * \fBmyvoid\fP"
203
204
.br
210
211
Definition at line 187 of file snmp_api.h.
211
212
.SH "Field Documentation"
212
213
.PP 
213
 
.SS "long \fBsnmp_session::version\fP"
214
 
.PP
215
 
snmp version 
216
 
.PP
217
 
Definition at line 192 of file snmp_api.h.
218
 
.PP
219
 
Referenced by add_trap_session(), create_user_from_session(), netsnmp_register_agent_nsap(), send_trap_to_sess(), snmp_sess_add_ex(), snmp_sess_init(), snmpd_parse_config_trapsess(), and snmpv3_engineID_probe().
220
 
.SS "int \fBsnmp_session::retries\fP"
221
 
.PP
222
 
Number of retries before timeout. 
223
 
.PP
224
 
Definition at line 194 of file snmp_api.h.
225
 
.PP
226
 
Referenced by snmp_sess_init(), and snmp_sess_timeout().
227
 
.SS "long \fBsnmp_session::timeout\fP"
228
 
.PP
229
 
Number of uS until first timeout, then exponential backoff. 
230
 
.PP
231
 
Definition at line 196 of file snmp_api.h.
232
 
.PP
233
 
Referenced by snmp_sess_init().
234
 
.SS "char* \fBsnmp_session::peername\fP"
235
 
.PP
236
 
name or address of default peer (may include transport specifier and/or port number) 
237
 
.PP
238
 
Definition at line 202 of file snmp_api.h.
239
 
.PP
240
 
Referenced by snmpd_parse_config_trapsess().
241
 
.SS "u_short \fBsnmp_session::remote_port\fP"
242
 
.PP
243
 
UDP port number of peer. 
244
 
.PP
245
 
(NO LONGER USED - USE peername INSTEAD) 
246
 
.PP
247
 
Definition at line 204 of file snmp_api.h.
248
 
.PP
249
 
Referenced by snmp_sess_init().
250
 
.SS "char* \fBsnmp_session::localname\fP"
251
 
.PP
252
 
My Domain name or dotted IP address, 0 for default. 
253
 
.PP
254
 
Definition at line 206 of file snmp_api.h.
255
 
.SS "u_short \fBsnmp_session::local_port\fP"
256
 
.PP
257
 
My UDP port number, 0 for default, picked randomly. 
258
 
.PP
259
 
Definition at line 208 of file snmp_api.h.
260
214
.SS "u_char*(* \fBsnmp_session::authenticator\fP)(u_char *, size_t *, u_char *, size_t)"
261
215
.PP
262
216
Authentication function or NULL if null authentication is used. 
263
 
.PP
264
 
Referenced by netsnmp_register_agent_nsap().
265
217
.SS "netsnmp_callback \fBsnmp_session::callback\fP"
266
218
.PP
267
219
Function to interpret incoming data. 
268
220
.PP
269
221
Definition at line 214 of file snmp_api.h.
270
 
.PP
271
 
Referenced by _sess_read(), netsnmp_register_agent_nsap(), snmp_sess_synch_response(), snmp_sess_timeout(), and snmp_synch_response_cb().
272
222
.SS "void* \fBsnmp_session::callback_magic\fP"
273
223
.PP
274
224
Pointer to data that the callback function may consider important. 
275
225
.PP
276
226
Definition at line 218 of file snmp_api.h.
277
 
.PP
278
 
Referenced by _sess_read(), snmp_sess_synch_response(), snmp_sess_timeout(), and snmp_synch_response_cb().
279
 
.SS "int \fBsnmp_session::s_errno\fP"
280
 
.PP
281
 
copy of system errno 
282
 
.PP
283
 
Definition at line 220 of file snmp_api.h.
284
 
.PP
285
 
Referenced by _sess_read(), and snmp_error().
286
 
.SS "int \fBsnmp_session::s_snmp_errno\fP"
287
 
.PP
288
 
copy of library errno 
289
 
.PP
290
 
Definition at line 222 of file snmp_api.h.
291
 
.PP
292
 
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().
293
 
.SS "long \fBsnmp_session::sessid\fP"
294
 
.PP
295
 
Session id - AgentX only. 
296
 
.PP
297
 
Definition at line 224 of file snmp_api.h.
298
 
.PP
299
 
Referenced by send_trap_to_sess().
300
227
.SS "u_char* \fBsnmp_session::community\fP"
301
228
.PP
302
229
community for outgoing requests. 
307
234
Length of community name. 
308
235
.PP
309
236
Definition at line 232 of file snmp_api.h.
310
 
.SS "size_t \fBsnmp_session::rcvMsgMaxSize\fP"
311
 
.PP
312
 
Largest message to try to receive. 
313
 
.PP
314
 
Definition at line 234 of file snmp_api.h.
315
 
.PP
316
 
Referenced by snmp_sess_add_ex(), and snmp_sess_init().
317
 
.SS "size_t \fBsnmp_session::sndMsgMaxSize\fP"
318
 
.PP
319
 
Largest message to try to send. 
320
 
.PP
321
 
Definition at line 236 of file snmp_api.h.
322
 
.PP
323
 
Referenced by snmpv3_parse().
324
 
.SS "u_char \fBsnmp_session::isAuthoritative\fP"
325
 
.PP
326
 
are we the authoritative engine? 
327
 
.PP
328
 
Definition at line 242 of file snmp_api.h.
329
 
.PP
330
 
Referenced by netsnmp_register_agent_nsap().
331
237
.SS "u_char* \fBsnmp_session::contextEngineID\fP"
332
238
.PP
333
239
authoritative snmpEngineID 
338
244
Length of contextEngineID. 
339
245
.PP
340
246
Definition at line 246 of file snmp_api.h.
 
247
.SS "char* \fBsnmp_session::contextName\fP"
 
248
.PP
 
249
authoritative contextName 
 
250
.PP
 
251
Definition at line 252 of file snmp_api.h.
 
252
.SS "size_t \fBsnmp_session::contextNameLen\fP"
 
253
.PP
 
254
Length of contextName. 
 
255
.PP
 
256
Definition at line 254 of file snmp_api.h.
341
257
.SS "u_int \fBsnmp_session::engineBoots\fP"
342
258
.PP
343
259
initial engineBoots for remote engine 
344
260
.PP
345
261
Definition at line 248 of file snmp_api.h.
346
 
.PP
347
 
Referenced by snmpv3_engineID_probe().
348
262
.SS "u_int \fBsnmp_session::engineTime\fP"
349
263
.PP
350
264
initial engineTime for remote engine 
351
265
.PP
352
266
Definition at line 250 of file snmp_api.h.
353
 
.PP
354
 
Referenced by snmpv3_engineID_probe().
355
 
.SS "char* \fBsnmp_session::contextName\fP"
356
 
.PP
357
 
authoritative contextName 
358
 
.PP
359
 
Definition at line 252 of file snmp_api.h.
360
 
.PP
361
 
Referenced by unregister_mibs_by_session().
362
 
.SS "size_t \fBsnmp_session::contextNameLen\fP"
363
 
.PP
364
 
Length of contextName. 
365
 
.PP
366
 
Definition at line 254 of file snmp_api.h.
367
 
.SS "u_char* \fBsnmp_session::securityEngineID\fP"
368
 
.PP
369
 
authoritative snmpEngineID 
370
 
.PP
371
 
Definition at line 256 of file snmp_api.h.
372
 
.PP
373
 
Referenced by create_user_from_session(), snmpd_parse_config_trapsess(), and snmpv3_engineID_probe().
374
 
.SS "size_t \fBsnmp_session::securityEngineIDLen\fP"
375
 
.PP
376
 
Length of contextEngineID. 
377
 
.PP
378
 
Definition at line 258 of file snmp_api.h.
379
 
.PP
380
 
Referenced by create_user_from_session(), snmpd_parse_config_trapsess(), and snmpv3_engineID_probe().
381
 
.SS "char* \fBsnmp_session::securityName\fP"
382
 
.PP
383
 
on behalf of this principal 
384
 
.PP
385
 
Definition at line 260 of file snmp_api.h.
386
 
.PP
387
 
Referenced by create_user_from_session().
388
 
.SS "size_t \fBsnmp_session::securityNameLen\fP"
389
 
.PP
390
 
Length of securityName. 
391
 
.PP
392
 
Definition at line 262 of file snmp_api.h.
393
 
.PP
394
 
Referenced by create_user_from_session().
395
 
.SS "oid* \fBsnmp_session::securityAuthProto\fP"
396
 
.PP
397
 
auth protocol oid 
398
 
.PP
399
 
Definition at line 265 of file snmp_api.h.
400
 
.PP
401
 
Referenced by create_user_from_session().
402
 
.SS "size_t \fBsnmp_session::securityAuthProtoLen\fP"
403
 
.PP
404
 
Length of auth protocol oid. 
405
 
.PP
406
 
Definition at line 267 of file snmp_api.h.
407
 
.PP
408
 
Referenced by create_user_from_session().
 
267
.SS "u_char \fBsnmp_session::isAuthoritative\fP"
 
268
.PP
 
269
are we the authoritative engine? 
 
270
.PP
 
271
Definition at line 242 of file snmp_api.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 208 of file snmp_api.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 206 of file snmp_api.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 308 of file snmp_api.h.
 
287
.SS "char* \fBsnmp_session::paramName\fP"
 
288
.PP
 
289
target param name 
 
290
.PP
 
291
Definition at line 295 of file snmp_api.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 202 of file snmp_api.h.
 
297
.SS "size_t \fBsnmp_session::rcvMsgMaxSize\fP"
 
298
.PP
 
299
Largest message to try to receive. 
 
300
.PP
 
301
Definition at line 234 of file snmp_api.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 204 of file snmp_api.h.
 
307
.SS "int \fBsnmp_session::retries\fP"
 
308
.PP
 
309
Number of retries before timeout. 
 
310
.PP
 
311
Definition at line 194 of file snmp_api.h.
 
312
.SS "int \fBsnmp_session::s_errno\fP"
 
313
.PP
 
314
copy of system errno 
 
315
.PP
 
316
Definition at line 220 of file snmp_api.h.
 
317
.SS "int \fBsnmp_session::s_snmp_errno\fP"
 
318
.PP
 
319
copy of library errno 
 
320
.PP
 
321
Definition at line 222 of file snmp_api.h.
409
322
.SS "u_char \fBsnmp_session::securityAuthKey\fP[USM_AUTH_KU_LEN]"
410
323
.PP
411
324
Ku for auth protocol XXX. 
412
325
.PP
413
326
Definition at line 269 of file snmp_api.h.
414
 
.PP
415
 
Referenced by create_user_from_session().
416
327
.SS "size_t \fBsnmp_session::securityAuthKeyLen\fP"
417
328
.PP
418
329
Length of Ku for auth protocol. 
419
330
.PP
420
331
Definition at line 271 of file snmp_api.h.
421
 
.PP
422
 
Referenced by create_user_from_session().
423
332
.SS "u_char* \fBsnmp_session::securityAuthLocalKey\fP"
424
333
.PP
425
334
Kul for auth protocol. 
426
335
.PP
427
336
Definition at line 273 of file snmp_api.h.
428
 
.PP
429
 
Referenced by create_user_from_session().
430
337
.SS "size_t \fBsnmp_session::securityAuthLocalKeyLen\fP"
431
338
.PP
432
339
Length of Kul for auth protocol XXX. 
433
340
.PP
434
341
Definition at line 275 of file snmp_api.h.
435
 
.PP
436
 
Referenced by create_user_from_session().
437
 
.SS "oid* \fBsnmp_session::securityPrivProto\fP"
438
 
.PP
439
 
priv protocol oid 
440
 
.PP
441
 
Definition at line 278 of file snmp_api.h.
442
 
.PP
443
 
Referenced by create_user_from_session().
444
 
.SS "size_t \fBsnmp_session::securityPrivProtoLen\fP"
445
 
.PP
446
 
Length of priv protocol oid. 
447
 
.PP
448
 
Definition at line 280 of file snmp_api.h.
449
 
.PP
450
 
Referenced by create_user_from_session().
 
342
.SS "oid* \fBsnmp_session::securityAuthProto\fP"
 
343
.PP
 
344
auth protocol oid 
 
345
.PP
 
346
Definition at line 265 of file snmp_api.h.
 
347
.SS "size_t \fBsnmp_session::securityAuthProtoLen\fP"
 
348
.PP
 
349
Length of auth protocol oid. 
 
350
.PP
 
351
Definition at line 267 of file snmp_api.h.
 
352
.SS "u_char* \fBsnmp_session::securityEngineID\fP"
 
353
.PP
 
354
authoritative snmpEngineID 
 
355
.PP
 
356
Definition at line 256 of file snmp_api.h.
 
357
.SS "size_t \fBsnmp_session::securityEngineIDLen\fP"
 
358
.PP
 
359
Length of contextEngineID. 
 
360
.PP
 
361
Definition at line 258 of file snmp_api.h.
 
362
.SS "void* \fBsnmp_session::securityInfo\fP"
 
363
.PP
 
364
security \fBmodule\fP specific 
 
365
.PP
 
366
Definition at line 300 of file snmp_api.h.
 
367
.SS "int \fBsnmp_session::securityLevel\fP"
 
368
.PP
 
369
noAuthNoPriv, authNoPriv, authPriv 
 
370
.PP
 
371
Definition at line 293 of file snmp_api.h.
 
372
.SS "int \fBsnmp_session::securityModel\fP"
 
373
.PP
 
374
snmp security model, v1, v2c, usm 
 
375
.PP
 
376
Definition at line 291 of file snmp_api.h.
 
377
.SS "char* \fBsnmp_session::securityName\fP"
 
378
.PP
 
379
on behalf of this principal 
 
380
.PP
 
381
Definition at line 260 of file snmp_api.h.
 
382
.SS "size_t \fBsnmp_session::securityNameLen\fP"
 
383
.PP
 
384
Length of securityName. 
 
385
.PP
 
386
Definition at line 262 of file snmp_api.h.
451
387
.SS "u_char \fBsnmp_session::securityPrivKey\fP[USM_PRIV_KU_LEN]"
452
388
.PP
453
389
Ku for privacy protocol XXX. 
454
390
.PP
455
391
Definition at line 282 of file snmp_api.h.
456
 
.PP
457
 
Referenced by create_user_from_session().
458
392
.SS "size_t \fBsnmp_session::securityPrivKeyLen\fP"
459
393
.PP
460
394
Length of Ku for priv protocol. 
461
395
.PP
462
396
Definition at line 284 of file snmp_api.h.
463
 
.PP
464
 
Referenced by create_user_from_session().
465
397
.SS "u_char* \fBsnmp_session::securityPrivLocalKey\fP"
466
398
.PP
467
399
Kul for priv protocol. 
468
400
.PP
469
401
Definition at line 286 of file snmp_api.h.
470
 
.PP
471
 
Referenced by create_user_from_session().
472
402
.SS "size_t \fBsnmp_session::securityPrivLocalKeyLen\fP"
473
403
.PP
474
404
Length of Kul for priv protocol XXX. 
475
405
.PP
476
406
Definition at line 288 of file snmp_api.h.
477
 
.PP
478
 
Referenced by create_user_from_session().
479
 
.SS "int \fBsnmp_session::securityModel\fP"
480
 
.PP
481
 
snmp security model, v1, v2c, usm 
482
 
.PP
483
 
Definition at line 291 of file snmp_api.h.
484
 
.PP
485
 
Referenced by create_user_from_session(), snmp_sess_close(), and snmp_sess_init().
486
 
.SS "int \fBsnmp_session::securityLevel\fP"
487
 
.PP
488
 
noAuthNoPriv, authNoPriv, authPriv 
489
 
.PP
490
 
Definition at line 293 of file snmp_api.h.
491
 
.SS "char* \fBsnmp_session::paramName\fP"
492
 
.PP
493
 
target param name 
494
 
.PP
495
 
Definition at line 295 of file snmp_api.h.
496
 
.SS "void* \fBsnmp_session::securityInfo\fP"
497
 
.PP
498
 
security module specific 
499
 
.PP
500
 
Definition at line 300 of file snmp_api.h.
501
 
.SS "void* \fBsnmp_session::myvoid\fP"
502
 
.PP
503
 
use as you want data 
504
 
.PP
505
 
used by 'SNMP_FLAGS_RESP_CALLBACK' handling in the agent XXX: or should we add a new field into this structure? 
506
 
.PP
507
 
Definition at line 308 of file snmp_api.h.
508
 
.PP
509
 
Referenced by snmp_synch_response_cb().
 
407
.SS "oid* \fBsnmp_session::securityPrivProto\fP"
 
408
.PP
 
409
priv protocol oid 
 
410
.PP
 
411
Definition at line 278 of file snmp_api.h.
 
412
.SS "size_t \fBsnmp_session::securityPrivProtoLen\fP"
 
413
.PP
 
414
Length of priv protocol oid. 
 
415
.PP
 
416
Definition at line 280 of file snmp_api.h.
 
417
.SS "long \fBsnmp_session::sessid\fP"
 
418
.PP
 
419
Session id - AgentX only. 
 
420
.PP
 
421
Definition at line 224 of file snmp_api.h.
 
422
.SS "size_t \fBsnmp_session::sndMsgMaxSize\fP"
 
423
.PP
 
424
Largest message to try to send. 
 
425
.PP
 
426
Definition at line 236 of file snmp_api.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 196 of file snmp_api.h.
 
432
.SS "long \fBsnmp_session::version\fP"
 
433
.PP
 
434
snmp version 
 
435
.PP
 
436
Definition at line 192 of file snmp_api.h.
510
437
 
511
438
.SH "Author"
512
439
.PP