← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/netsnmp_snmp_pdu.3

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-12-08 14:59:50 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20071208145950-u1tykhpw56nyzqik
Tags: 5.4.1~dfsg-4ubuntu1
* Merge from debian unstable.
* Remaining Ubuntu changes:
  - Remove stop links from rc0 and rc6
  - Munge Maintainer field as per spec.
* Ubuntu changes dropped:
  - Symlink common files between the packages, CDBS ought to handle that
    for us automatically.
* The latest Debian changes has dropped history from the changelog. Slot in
  the Ubuntu changes as best I can. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_snmp_pdu.3
1
 
.TH "snmp_pdu" 3 "13 Jul 2006" "Version 5.3.1" "net-snmp" \" -*- nroff -*-
 
1
.TH "snmp_pdu" 3 "27 Jul 2007" "Version 5.4.1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
155
155
Definition at line 75 of file snmp_api.h.
156
156
.SH "Field Documentation"
157
157
.PP 
158
 
.SS "unsigned char \fBsnmp_pdu::agent_addr\fP[4]"
159
 
.PP
160
 
This is ONLY used for v1 TRAPs. 
161
 
.PP
162
 
Definition at line 142 of file snmp_api.h.
163
 
.PP
164
 
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
 
158
.SS "long \fBsnmp_pdu::version\fP"
 
159
.PP
 
160
snmp version 
 
161
.PP
 
162
Definition at line 81 of file snmp_api.h.
 
163
.PP
 
164
Referenced by check_access(), handle_snmp_packet(), in_a_view(), netsnmp_acm_check_subtree(), netsnmp_wrap_up_request(), send_trap_to_sess(), snmp_pdu_create(), and snmpv3_parse().
165
165
.SS "int \fBsnmp_pdu::command\fP"
166
166
.PP
167
167
Type of this PDU. 
168
168
.PP
169
169
Definition at line 83 of file snmp_api.h.
170
170
.PP
171
 
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), handle_pdu(), handle_snmp_packet(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_handle_request(), netsnmp_wrap_up_request(), save_set_cache(), send_trap_to_sess(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
 
171
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), handle_pdu(), handle_snmp_packet(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_check_outstanding_agent_requests(), netsnmp_create_subtree_cache(), netsnmp_handle_request(), netsnmp_wrap_up_request(), save_set_cache(), send_trap_to_sess(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
 
172
.SS "long \fBsnmp_pdu::reqid\fP"
 
173
.PP
 
174
Request id - note: not incremented on retries. 
 
175
.PP
 
176
Definition at line 85 of file snmp_api.h.
 
177
.PP
 
178
Referenced by snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().
 
179
.SS "long \fBsnmp_pdu::msgid\fP"
 
180
.PP
 
181
Message id for V3 messages note: incremented for each retry. 
 
182
.PP
 
183
Definition at line 87 of file snmp_api.h.
 
184
.PP
 
185
Referenced by snmp_fix_pdu(), snmp_pdu_create(), and snmpv3_parse().
 
186
.SS "long \fBsnmp_pdu::transid\fP"
 
187
.PP
 
188
Unique ID for incoming transactions. 
 
189
.PP
 
190
Definition at line 89 of file snmp_api.h.
 
191
.PP
 
192
Referenced by check_delayed_request(), get_set_cache(), netsnmp_create_delegated_cache(), and save_set_cache().
 
193
.SS "long \fBsnmp_pdu::sessid\fP"
 
194
.PP
 
195
Session id for AgentX messages. 
 
196
.PP
 
197
Definition at line 91 of file snmp_api.h.
 
198
.PP
 
199
Referenced by send_trap_to_sess().
 
200
.SS "long \fBsnmp_pdu::errstat\fP"
 
201
.PP
 
202
Error status (non_repeaters in GetBulk). 
 
203
.PP
 
204
Definition at line 93 of file snmp_api.h.
 
205
.PP
 
206
Referenced by _reorder_getbulk(), handle_snmp_packet(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().
 
207
.SS "long \fBsnmp_pdu::errindex\fP"
 
208
.PP
 
209
Error index (max_repetitions in GetBulk). 
 
210
.PP
 
211
Definition at line 95 of file snmp_api.h.
 
212
.PP
 
213
Referenced by _reorder_getbulk(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().
 
214
.SS "u_long \fBsnmp_pdu::time\fP"
 
215
.PP
 
216
Uptime. 
 
217
.PP
 
218
Definition at line 97 of file snmp_api.h.
 
219
.PP
 
220
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().
 
221
.SS "int \fBsnmp_pdu::securityLevel\fP"
 
222
.PP
 
223
noAuthNoPriv, authNoPriv, authPriv 
 
224
.PP
 
225
Definition at line 102 of file snmp_api.h.
 
226
.PP
 
227
Referenced by snmpv3_make_report(), snmpv3_packet_build(), and snmpv3_parse().
 
228
.SS "void* \fBsnmp_pdu::transport_data\fP"
 
229
.PP
 
230
Transport-specific opaque data. 
 
231
.PP
 
232
This replaces the IP-centric address field. 
 
233
.PP
 
234
Definition at line 110 of file snmp_api.h.
 
235
.PP
 
236
Referenced by snmp_create_sess_pdu(), snmp_free_pdu(), and snmp_pdu_create().
 
237
.SS "const oid* \fBsnmp_pdu::tDomain\fP"
 
238
.PP
 
239
The actual transport domain. 
 
240
.PP
 
241
This SHOULD NOT BE FREE()D. 
 
242
.PP
 
243
Definition at line 117 of file snmp_api.h.
 
244
.PP
 
245
Referenced by snmp_create_sess_pdu().
172
246
.SS "u_char* \fBsnmp_pdu::community\fP"
173
247
.PP
174
248
community for outgoing requests. 
183
257
Definition at line 129 of file snmp_api.h.
184
258
.PP
185
259
Referenced by convert_v1pdu_to_v2().
 
260
.SS "oid* \fBsnmp_pdu::enterprise\fP"
 
261
.PP
 
262
System OID. 
 
263
.PP
 
264
Definition at line 135 of file snmp_api.h.
 
265
.PP
 
266
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_free_pdu(), snmp_pdu_build(), and snmp_pdu_parse().
 
267
.SS "long \fBsnmp_pdu::trap_type\fP"
 
268
.PP
 
269
trap type 
 
270
.PP
 
271
Definition at line 138 of file snmp_api.h.
 
272
.PP
 
273
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
 
274
.SS "long \fBsnmp_pdu::specific_type\fP"
 
275
.PP
 
276
specific type 
 
277
.PP
 
278
Definition at line 140 of file snmp_api.h.
 
279
.PP
 
280
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
 
281
.SS "unsigned char \fBsnmp_pdu::agent_addr\fP[4]"
 
282
.PP
 
283
This is ONLY used for v1 TRAPs. 
 
284
.PP
 
285
Definition at line 142 of file snmp_api.h.
 
286
.PP
 
287
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
186
288
.SS "u_char* \fBsnmp_pdu::contextEngineID\fP"
187
289
.PP
188
290
context snmpEngineID 
203
305
.PP
204
306
Definition at line 152 of file snmp_api.h.
205
307
.PP
206
 
Referenced by snmp_free_pdu(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
 
308
Referenced by netsnmp_create_subtree_cache(), snmp_free_pdu(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
207
309
.SS "size_t \fBsnmp_pdu::contextNameLen\fP"
208
310
.PP
209
311
Length of contextName. 
211
313
Definition at line 154 of file snmp_api.h.
212
314
.PP
213
315
Referenced by snmp_pdu_create(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
214
 
.SS "oid* \fBsnmp_pdu::enterprise\fP"
215
 
.PP
216
 
System OID. 
217
 
.PP
218
 
Definition at line 135 of file snmp_api.h.
219
 
.PP
220
 
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_free_pdu(), snmp_pdu_build(), and snmp_pdu_parse().
221
 
.SS "long \fBsnmp_pdu::errindex\fP"
222
 
.PP
223
 
Error index (max_repetitions in GetBulk). 
224
 
.PP
225
 
Definition at line 95 of file snmp_api.h.
226
 
.PP
227
 
Referenced by _reorder_getbulk(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().
228
 
.SS "long \fBsnmp_pdu::errstat\fP"
229
 
.PP
230
 
Error status (non_repeaters in GetBulk). 
231
 
.PP
232
 
Definition at line 93 of file snmp_api.h.
233
 
.PP
234
 
Referenced by _reorder_getbulk(), handle_snmp_packet(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().
235
 
.SS "long \fBsnmp_pdu::msgid\fP"
236
 
.PP
237
 
Message id for V3 messages note: incremented for each retry. 
238
 
.PP
239
 
Definition at line 87 of file snmp_api.h.
240
 
.PP
241
 
Referenced by snmp_fix_pdu(), snmp_pdu_create(), and snmpv3_parse().
242
 
.SS "long \fBsnmp_pdu::reqid\fP"
243
 
.PP
244
 
Request id - note: not incremented on retries. 
245
 
.PP
246
 
Definition at line 85 of file snmp_api.h.
247
 
.PP
248
 
Referenced by snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().
249
316
.SS "u_char* \fBsnmp_pdu::securityEngineID\fP"
250
317
.PP
251
318
authoritative snmpEngineID for security 
252
319
.PP
253
320
Definition at line 156 of file snmp_api.h.
254
321
.PP
255
 
Referenced by snmp_free_pdu(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
 
322
Referenced by send_trap_to_sess(), snmp_free_pdu(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
256
323
.SS "size_t \fBsnmp_pdu::securityEngineIDLen\fP"
257
324
.PP
258
325
Length of securityEngineID. 
259
326
.PP
260
327
Definition at line 158 of file snmp_api.h.
261
328
.PP
262
 
Referenced by snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
263
 
.SS "int \fBsnmp_pdu::securityLevel\fP"
264
 
.PP
265
 
noAuthNoPriv, authNoPriv, authPriv 
266
 
.PP
267
 
Definition at line 102 of file snmp_api.h.
268
 
.PP
269
 
Referenced by snmpv3_make_report(), snmpv3_packet_build(), and snmpv3_parse().
 
329
Referenced by send_trap_to_sess(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
270
330
.SS "char* \fBsnmp_pdu::securityName\fP"
271
331
.PP
272
332
on behalf of this principal 
281
341
Definition at line 162 of file snmp_api.h.
282
342
.PP
283
343
Referenced by snmp_pdu_create(), snmpv3_packet_build(), and snmpv3_parse().
284
 
.SS "long \fBsnmp_pdu::sessid\fP"
285
 
.PP
286
 
Session id for AgentX messages. 
287
 
.PP
288
 
Definition at line 91 of file snmp_api.h.
289
 
.PP
290
 
Referenced by send_trap_to_sess().
291
 
.SS "long \fBsnmp_pdu::specific_type\fP"
292
 
.PP
293
 
specific type 
294
 
.PP
295
 
Definition at line 140 of file snmp_api.h.
296
 
.PP
297
 
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
298
 
.SS "const oid* \fBsnmp_pdu::tDomain\fP"
299
 
.PP
300
 
The actual transport domain. 
301
 
.PP
302
 
This SHOULD NOT BE FREE()D. 
303
 
.PP
304
 
Definition at line 117 of file snmp_api.h.
305
 
.PP
306
 
Referenced by snmp_create_sess_pdu().
307
 
.SS "u_long \fBsnmp_pdu::time\fP"
308
 
.PP
309
 
Uptime. 
310
 
.PP
311
 
Definition at line 97 of file snmp_api.h.
312
 
.PP
313
 
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().
314
 
.SS "long \fBsnmp_pdu::transid\fP"
315
 
.PP
316
 
Unique ID for incoming transactions. 
317
 
.PP
318
 
Definition at line 89 of file snmp_api.h.
319
 
.PP
320
 
Referenced by check_delayed_request(), get_set_cache(), netsnmp_create_delegated_cache(), and save_set_cache().
321
 
.SS "void* \fBsnmp_pdu::transport_data\fP"
322
 
.PP
323
 
Transport-specific opaque data. 
324
 
.PP
325
 
This replaces the IP-centric address field. 
326
 
.PP
327
 
Definition at line 110 of file snmp_api.h.
328
 
.PP
329
 
Referenced by snmp_create_sess_pdu(), snmp_free_pdu(), and snmp_pdu_create().
330
 
.SS "long \fBsnmp_pdu::trap_type\fP"
331
 
.PP
332
 
trap type 
333
 
.PP
334
 
Definition at line 138 of file snmp_api.h.
335
 
.PP
336
 
Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
337
 
.SS "long \fBsnmp_pdu::version\fP"
338
 
.PP
339
 
snmp version 
340
 
.PP
341
 
Definition at line 81 of file snmp_api.h.
342
 
.PP
343
 
Referenced by check_access(), handle_snmp_packet(), in_a_view(), netsnmp_acm_check_subtree(), netsnmp_wrap_up_request(), send_trap_to_sess(), snmp_pdu_create(), and snmpv3_parse().
344
344
 
345
345
.SH "Author"
346
346
.PP