← Back to branch summary

~ubuntu-branches/ubuntu/edgy/net-snmp/edgy-updates

« back to all changes in this revision

Viewing changes to man/netsnmp_snmp_pdu.3

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-03-31 04:21:37 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050331042137-z0vw1grslj6cek9k
Tags: 5.1.2-6ubuntu2
Apply safe-but-hackish patch by Henrique de Moraes Holschuh to
fix the libdir in libsnmp5-dev's .la files (Ubuntu bug #8393)

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_snmp_pdu.3
1
 
.TH "snmp_pdu" 3 "19 Mar 2004" "net-snmp" \" -*- nroff -*-
 
1
.TH "snmp_pdu" 3 "7 Aug 2004" "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 \- The snmp protocol data unit.  
 
6
 
 
7
.PP
6
8
.SH SYNOPSIS
7
9
.br
8
10
.PP
14
16
.ti -1c
15
17
.RI "long \fBversion\fP"
16
18
.br
17
 
.RI "\fIsnmp version\fP"
 
19
.RI "\fIsnmp version \fP"
18
20
.ti -1c
19
21
.RI "int \fBcommand\fP"
20
22
.br
21
 
.RI "\fIType of this PDU.\fP"
 
23
.RI "\fIType of this PDU. \fP"
22
24
.ti -1c
23
25
.RI "long \fBreqid\fP"
24
26
.br
25
 
.RI "\fIRequest id - note: not incremented on retries.\fP"
 
27
.RI "\fIRequest id - note: not incremented on retries. \fP"
26
28
.ti -1c
27
29
.RI "long \fBmsgid\fP"
28
30
.br
29
 
.RI "\fIMessage id for V3 messages note: incremented for each retry.\fP"
 
31
.RI "\fIMessage id for V3 messages note: incremented for each retry. \fP"
30
32
.ti -1c
31
33
.RI "long \fBtransid\fP"
32
34
.br
33
 
.RI "\fIUnique ID for incoming transactions.\fP"
 
35
.RI "\fIUnique ID for incoming transactions. \fP"
34
36
.ti -1c
35
37
.RI "long \fBsessid\fP"
36
38
.br
37
 
.RI "\fISession id for AgentX messages.\fP"
 
39
.RI "\fISession id for AgentX messages. \fP"
38
40
.ti -1c
39
41
.RI "long \fBerrstat\fP"
40
42
.br
41
 
.RI "\fIError status (non_repeaters in GetBulk).\fP"
 
43
.RI "\fIError status (non_repeaters in GetBulk). \fP"
42
44
.ti -1c
43
45
.RI "long \fBerrindex\fP"
44
46
.br
45
 
.RI "\fIError index (max_repetitions in GetBulk).\fP"
 
47
.RI "\fIError index (max_repetitions in GetBulk). \fP"
46
48
.ti -1c
47
49
.RI "u_long \fBtime\fP"
48
50
.br
49
 
.RI "\fIUptime.\fP"
 
51
.RI "\fIUptime. \fP"
 
52
.ti -1c
 
53
.RI "u_long \fBflags\fP"
 
54
.br
 
55
.ti -1c
 
56
.RI "int \fBsecurityModel\fP"
 
57
.br
50
58
.ti -1c
51
59
.RI "int \fBsecurityLevel\fP"
52
60
.br
53
 
.RI "\fInoAuthNoPriv, authNoPriv, authPriv\fP"
 
61
.RI "\fInoAuthNoPriv, authNoPriv, authPriv \fP"
 
62
.ti -1c
 
63
.RI "int \fBmsgParseModel\fP"
 
64
.br
54
65
.ti -1c
55
66
.RI "void * \fBtransport_data\fP"
56
67
.br
57
 
.RI "\fITransport-specific opaque data.\fP"
 
68
.RI "\fITransport-specific opaque data. \fP"
 
69
.ti -1c
 
70
.RI "int \fBtransport_data_length\fP"
 
71
.br
58
72
.ti -1c
59
73
.RI "const oid * \fBtDomain\fP"
60
74
.br
61
 
.RI "\fIThe actual transport domain.\fP"
 
75
.RI "\fIThe actual transport domain. \fP"
 
76
.ti -1c
 
77
.RI "size_t \fBtDomainLen\fP"
 
78
.br
 
79
.ti -1c
 
80
.RI "\fBnetsnmp_variable_list\fP * \fBvariables\fP"
 
81
.br
62
82
.ti -1c
63
83
.RI "u_char * \fBcommunity\fP"
64
84
.br
65
 
.RI "\fIcommunity for outgoing requests.\fP"
 
85
.RI "\fIcommunity for outgoing requests. \fP"
66
86
.ti -1c
67
87
.RI "size_t \fBcommunity_len\fP"
68
88
.br
69
 
.RI "\fIlength of community name.\fP"
 
89
.RI "\fIlength of community name. \fP"
70
90
.ti -1c
71
91
.RI "oid * \fBenterprise\fP"
72
92
.br
73
 
.RI "\fISystem OID.\fP"
 
93
.RI "\fISystem OID. \fP"
 
94
.ti -1c
 
95
.RI "size_t \fBenterprise_length\fP"
 
96
.br
74
97
.ti -1c
75
98
.RI "long \fBtrap_type\fP"
76
99
.br
77
 
.RI "\fItrap type\fP"
 
100
.RI "\fItrap type \fP"
78
101
.ti -1c
79
102
.RI "long \fBspecific_type\fP"
80
103
.br
81
 
.RI "\fIspecific type\fP"
 
104
.RI "\fIspecific type \fP"
82
105
.ti -1c
83
106
.RI "unsigned char \fBagent_addr\fP [4]"
84
107
.br
85
 
.RI "\fIThis is ONLY used for v1 TRAPs.\fP"
 
108
.RI "\fIThis is ONLY used for v1 TRAPs. \fP"
86
109
.ti -1c
87
110
.RI "u_char * \fBcontextEngineID\fP"
88
111
.br
89
 
.RI "\fIcontext snmpEngineID\fP"
 
112
.RI "\fIcontext snmpEngineID \fP"
90
113
.ti -1c
91
114
.RI "size_t \fBcontextEngineIDLen\fP"
92
115
.br
93
 
.RI "\fILength of contextEngineID.\fP"
 
116
.RI "\fILength of contextEngineID. \fP"
94
117
.ti -1c
95
118
.RI "char * \fBcontextName\fP"
96
119
.br
97
 
.RI "\fIauthoritative contextName\fP"
 
120
.RI "\fIauthoritative contextName \fP"
98
121
.ti -1c
99
122
.RI "size_t \fBcontextNameLen\fP"
100
123
.br
101
 
.RI "\fILength of contextName.\fP"
 
124
.RI "\fILength of contextName. \fP"
102
125
.ti -1c
103
126
.RI "u_char * \fBsecurityEngineID\fP"
104
127
.br
105
 
.RI "\fIauthoritative snmpEngineID for security\fP"
 
128
.RI "\fIauthoritative snmpEngineID for security \fP"
106
129
.ti -1c
107
130
.RI "size_t \fBsecurityEngineIDLen\fP"
108
131
.br
109
 
.RI "\fILength of securityEngineID.\fP"
 
132
.RI "\fILength of securityEngineID. \fP"
110
133
.ti -1c
111
134
.RI "char * \fBsecurityName\fP"
112
135
.br
113
 
.RI "\fIon behalf of this principal\fP"
 
136
.RI "\fIon behalf of this principal \fP"
114
137
.ti -1c
115
138
.RI "size_t \fBsecurityNameLen\fP"
116
139
.br
117
 
.RI "\fILength of securityName.\fP"
 
140
.RI "\fILength of securityName. \fP"
 
141
.ti -1c
 
142
.RI "int \fBpriority\fP"
 
143
.br
 
144
.ti -1c
 
145
.RI "int \fBrange_subid\fP"
 
146
.br
 
147
.ti -1c
 
148
.RI "void * \fBsecurityStateRef\fP"
 
149
.br
118
150
.in -1c
119
 
.SH "DETAILED DESCRIPTION"
120
 
.PP 
121
 
The snmp protocol data unit.
122
 
.PP
123
 
Definition at line 75 of file snmp_api.h.
124
 
.SH "FIELD DOCUMENTATION"
125
 
.PP 
126
 
.SS "unsigned char snmp_pdu::agent_addr[4]"
127
 
.PP
128
 
This is ONLY used for v1 TRAPs.
129
 
.PP
130
 
Definition at line 142 of file snmp_api.h.
131
 
.SS "int snmp_pdu::command"
132
 
.PP
133
 
Type of this PDU.
134
 
.PP
135
 
Definition at line 83 of file snmp_api.h.
 
151
.SH "Detailed Description"
 
152
.PP 
 
153
The snmp protocol data unit. Definition at line 75 of file snmp_api.h.
 
154
.SH "Field Documentation"
 
155
.PP 
 
156
.SS "unsigned char \fBsnmp_pdu::agent_addr\fP[4]"
 
157
.PP
 
158
This is ONLY used for v1 TRAPs. Definition at line 142 of file snmp_api.h.
 
159
.SS "int \fBsnmp_pdu::command\fP"
 
160
.PP
 
161
Type of this PDU. Definition at line 83 of file snmp_api.h.
136
162
.PP
137
163
Referenced by handle_snmp_packet().
138
 
.SS "u_char* snmp_pdu::community"
139
 
.PP
140
 
community for outgoing requests.
141
 
.PP
142
 
Definition at line 127 of file snmp_api.h.
143
 
.SS "size_t snmp_pdu::community_len"
144
 
.PP
145
 
length of community name.
146
 
.PP
147
 
Definition at line 129 of file snmp_api.h.
148
 
.SS "u_char* snmp_pdu::contextEngineID"
149
 
.PP
150
 
context snmpEngineID
151
 
.PP
152
 
Definition at line 148 of file snmp_api.h.
153
 
.SS "size_t snmp_pdu::contextEngineIDLen"
154
 
.PP
155
 
Length of contextEngineID.
156
 
.PP
157
 
Definition at line 150 of file snmp_api.h.
158
 
.SS "char* snmp_pdu::contextName"
159
 
.PP
160
 
authoritative contextName
161
 
.PP
162
 
Definition at line 152 of file snmp_api.h.
163
 
.SS "size_t snmp_pdu::contextNameLen"
164
 
.PP
165
 
Length of contextName.
166
 
.PP
167
 
Definition at line 154 of file snmp_api.h.
168
 
.SS "oid* snmp_pdu::enterprise"
169
 
.PP
170
 
System OID.
171
 
.PP
172
 
Definition at line 135 of file snmp_api.h.
173
 
.SS "long snmp_pdu::errindex"
174
 
.PP
175
 
Error index (max_repetitions in GetBulk).
176
 
.PP
177
 
Definition at line 95 of file snmp_api.h.
178
 
.SS "long snmp_pdu::errstat"
179
 
.PP
180
 
Error status (non_repeaters in GetBulk).
181
 
.PP
182
 
Definition at line 93 of file snmp_api.h.
183
 
.SS "long snmp_pdu::msgid"
184
 
.PP
185
 
Message id for V3 messages note: incremented for each retry.
186
 
.PP
187
 
Definition at line 87 of file snmp_api.h.
188
 
.SS "long snmp_pdu::reqid"
189
 
.PP
190
 
Request id - note: not incremented on retries.
191
 
.PP
192
 
Definition at line 85 of file snmp_api.h.
193
 
.SS "u_char* snmp_pdu::securityEngineID"
194
 
.PP
195
 
authoritative snmpEngineID for security
196
 
.PP
197
 
Definition at line 156 of file snmp_api.h.
198
 
.SS "size_t snmp_pdu::securityEngineIDLen"
199
 
.PP
200
 
Length of securityEngineID.
201
 
.PP
202
 
Definition at line 158 of file snmp_api.h.
203
 
.SS "int snmp_pdu::securityLevel"
204
 
.PP
205
 
noAuthNoPriv, authNoPriv, authPriv
206
 
.PP
207
 
Definition at line 102 of file snmp_api.h.
208
 
.SS "char* snmp_pdu::securityName"
209
 
.PP
210
 
on behalf of this principal
211
 
.PP
212
 
Definition at line 160 of file snmp_api.h.
213
 
.SS "size_t snmp_pdu::securityNameLen"
214
 
.PP
215
 
Length of securityName.
216
 
.PP
217
 
Definition at line 162 of file snmp_api.h.
218
 
.SS "long snmp_pdu::sessid"
219
 
.PP
220
 
Session id for AgentX messages.
221
 
.PP
222
 
Definition at line 91 of file snmp_api.h.
223
 
.SS "long snmp_pdu::specific_type"
224
 
.PP
225
 
specific type
226
 
.PP
227
 
Definition at line 140 of file snmp_api.h.
228
 
.SS "const oid* snmp_pdu::tDomain"
229
 
.PP
230
 
The actual transport domain.
231
 
.PP
232
 
This SHOULD NOT BE \fBFREE()\fPD. 
233
 
.PP
234
 
Definition at line 117 of file snmp_api.h.
235
 
.SS "u_long snmp_pdu::time"
236
 
.PP
237
 
Uptime.
238
 
.PP
239
 
Definition at line 97 of file snmp_api.h.
240
 
.SS "long snmp_pdu::transid"
241
 
.PP
242
 
Unique ID for incoming transactions.
243
 
.PP
244
 
Definition at line 89 of file snmp_api.h.
245
 
.SS "void* snmp_pdu::transport_data"
246
 
.PP
247
 
Transport-specific opaque data.
248
 
.PP
249
 
This replaces the IP-centric address field. 
250
 
.PP
251
 
Definition at line 110 of file snmp_api.h.
252
 
.SS "long snmp_pdu::trap_type"
253
 
.PP
254
 
trap type
255
 
.PP
256
 
Definition at line 138 of file snmp_api.h.
257
 
.SS "long snmp_pdu::version"
258
 
.PP
259
 
snmp version
260
 
.PP
261
 
Definition at line 81 of file snmp_api.h.
 
164
.SS "u_char* \fBsnmp_pdu::community\fP"
 
165
.PP
 
166
community for outgoing requests. Definition at line 127 of file snmp_api.h.
 
167
.SS "size_t \fBsnmp_pdu::community_len\fP"
 
168
.PP
 
169
length of community name. Definition at line 129 of file snmp_api.h.
 
170
.SS "u_char* \fBsnmp_pdu::contextEngineID\fP"
 
171
.PP
 
172
context snmpEngineID Definition at line 148 of file snmp_api.h.
 
173
.SS "size_t \fBsnmp_pdu::contextEngineIDLen\fP"
 
174
.PP
 
175
Length of contextEngineID. Definition at line 150 of file snmp_api.h.
 
176
.SS "char* \fBsnmp_pdu::contextName\fP"
 
177
.PP
 
178
authoritative contextName Definition at line 152 of file snmp_api.h.
 
179
.SS "size_t \fBsnmp_pdu::contextNameLen\fP"
 
180
.PP
 
181
Length of contextName. Definition at line 154 of file snmp_api.h.
 
182
.SS "oid* \fBsnmp_pdu::enterprise\fP"
 
183
.PP
 
184
System OID. Definition at line 135 of file snmp_api.h.
 
185
.SS "long \fBsnmp_pdu::errindex\fP"
 
186
.PP
 
187
Error index (max_repetitions in GetBulk). Definition at line 95 of file snmp_api.h.
 
188
.SS "long \fBsnmp_pdu::errstat\fP"
 
189
.PP
 
190
Error status (non_repeaters in GetBulk). Definition at line 93 of file snmp_api.h.
 
191
.SS "long \fBsnmp_pdu::msgid\fP"
 
192
.PP
 
193
Message id for V3 messages note: incremented for each retry. Definition at line 87 of file snmp_api.h.
 
194
.SS "long \fBsnmp_pdu::reqid\fP"
 
195
.PP
 
196
Request id - note: not incremented on retries. Definition at line 85 of file snmp_api.h.
 
197
.SS "u_char* \fBsnmp_pdu::securityEngineID\fP"
 
198
.PP
 
199
authoritative snmpEngineID for security Definition at line 156 of file snmp_api.h.
 
200
.SS "size_t \fBsnmp_pdu::securityEngineIDLen\fP"
 
201
.PP
 
202
Length of securityEngineID. Definition at line 158 of file snmp_api.h.
 
203
.SS "int \fBsnmp_pdu::securityLevel\fP"
 
204
.PP
 
205
noAuthNoPriv, authNoPriv, authPriv Definition at line 102 of file snmp_api.h.
 
206
.SS "char* \fBsnmp_pdu::securityName\fP"
 
207
.PP
 
208
on behalf of this principal Definition at line 160 of file snmp_api.h.
 
209
.SS "size_t \fBsnmp_pdu::securityNameLen\fP"
 
210
.PP
 
211
Length of securityName. Definition at line 162 of file snmp_api.h.
 
212
.SS "long \fBsnmp_pdu::sessid\fP"
 
213
.PP
 
214
Session id for AgentX messages. Definition at line 91 of file snmp_api.h.
 
215
.SS "long \fBsnmp_pdu::specific_type\fP"
 
216
.PP
 
217
specific type Definition at line 140 of file snmp_api.h.
 
218
.SS "const oid* \fBsnmp_pdu::tDomain\fP"
 
219
.PP
 
220
The actual transport domain. This SHOULD NOT BE FREE()D. Definition at line 117 of file snmp_api.h.
 
221
.SS "u_long \fBsnmp_pdu::time\fP"
 
222
.PP
 
223
Uptime. Definition at line 97 of file snmp_api.h.
 
224
.SS "long \fBsnmp_pdu::transid\fP"
 
225
.PP
 
226
Unique ID for incoming transactions. Definition at line 89 of file snmp_api.h.
 
227
.SS "void* \fBsnmp_pdu::transport_data\fP"
 
228
.PP
 
229
Transport-specific opaque data. This replaces the IP-centric address field. Definition at line 110 of file snmp_api.h.
 
230
.SS "long \fBsnmp_pdu::trap_type\fP"
 
231
.PP
 
232
trap type Definition at line 138 of file snmp_api.h.
 
233
.SS "long \fBsnmp_pdu::version\fP"
 
234
.PP
 
235
snmp version Definition at line 81 of file snmp_api.h.
262
236
.PP
263
237
Referenced by handle_snmp_packet(), and netsnmp_acm_check_subtree().
264
238
 
265
 
.SH "AUTHOR"
 
239
.SH "Author"
266
240
.PP 
267
241
Generated automatically by Doxygen for net-snmp from the source code.