← Back to branch summary

~ubuntu-branches/ubuntu/wily/net-snmp/wily-proposed

« back to all changes in this revision

Viewing changes to man/netsnmp_snmp_pdu.3

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2010-06-28 14:59:36 UTC
  • mfrom: (1.2.3 upstream) (1.1.12 sid)
  • Revision ID: james.westby@ubuntu.com-20100628145936-cbiallic69pn044g
Tags: 5.4.3~dfsg-1ubuntu1
https://launchpad.net/bugs/104738
https://launchpad.net/bugs/254261
https://launchpad.net/bugs/250459
https://launchpad.net/bugs/589056
https://launchpad.net/bugs/573391
https://launchpad.net/bugs/533603
* Merge from debian unstable.  Remaining changes:
  - Set Ubuntu maintainer address.
  - net-snmp-config: Use bash. (LP: #104738)
  - Removed multiuser option when calling update-rc.d. (LP: #254261)
  - debian/snmpd.init: LSBify the init script.
  - debian/patches/52_fix_snmpcmd_1_typo.patch: Adjust a typo in snmpcmd.1
    (LP: #250459)
  - debian/snmpd.postinst: source debconf before doing work, LP: #589056
  - debian/snmp.preinst, debian/snmp.prerm: kill any/all processes owned by
    snmp user before install/uninstall, LP: #573391
  - Add apport hook (LP: #533603):
  - debian/{snmp,snmpd}.apport: Added.
  - debian/control: Build-depends on dh-apport.
  - debian/rules: 
    + Add --with apport.
    + override_dh_apport to install hook on snmpd package only.
 * Dropped patches:
   - debian/patches/99-fix-ubuntu-div0.patch: Fix dvision by zero.. 

Show diffs side-by-side

added added

removed removed

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