net-snmp 1.2.1 → 1.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,1739 +1,1739 @@
1
-
2
-
3
-
4
-
5
-
6
-
7
- Network Working Group Editor of this version:
8
- Request for Comments: 3416 R. Presuhn
9
- STD: 62 BMC Software, Inc.
10
- Obsoletes: 1905 Authors of previous version:
11
- Category: Standards Track J. Case
12
- SNMP Research, Inc.
13
- K. McCloghrie
14
- Cisco Systems, Inc.
15
- M. Rose
16
- Dover Beach Consulting, Inc.
17
- S. Waldbusser
18
- International Network Services
19
- December 2002
20
-
21
-
22
- Version 2 of the Protocol Operations for
23
- the Simple Network Management Protocol (SNMP)
24
-
25
- Status of this Memo
26
-
27
- This document specifies an Internet standards track protocol for the
28
- Internet community, and requests discussion and suggestions for
29
- improvements. Please refer to the current edition of the "Internet
30
- Official Protocol Standards" (STD 1) for the standardization state
31
- and status of this protocol. Distribution of this memo is unlimited.
32
-
33
- Copyright Notice
34
-
35
- Copyright (C) The Internet Society (2002). All Rights Reserved.
36
-
37
- Abstract
38
-
39
- This document defines version 2 of the protocol operations for the
40
- Simple Network Management Protocol (SNMP). It defines the syntax and
41
- elements of procedure for sending, receiving, and processing SNMP
42
- PDUs. This document obsoletes RFC 1905.
43
-
44
-
45
-
46
-
47
-
48
-
49
-
50
-
51
-
52
-
53
-
54
-
55
-
56
-
57
-
58
- Presuhn, et al. Standards Track [Page 1]
59
-
60
- RFC 3416 Protocol Operations for SNMP December 2002
61
-
62
-
63
- Table of Contents
64
-
65
- 1. Introduction ................................................ 3
66
- 2. Overview .................................................... 4
67
- 2.1. Management Information .................................... 4
68
- 2.2. Retransmission of Requests ................................ 4
69
- 2.3. Message Sizes ............................................. 4
70
- 2.4. Transport Mappings ........................................ 5
71
- 2.5. SMIv2 Data Type Mappings .................................. 6
72
- 3. Definitions ................................................. 6
73
- 4. Protocol Specification ...................................... 9
74
- 4.1. Common Constructs ......................................... 9
75
- 4.2. PDU Processing ............................................ 10
76
- 4.2.1. The GetRequest-PDU ...................................... 10
77
- 4.2.2. The GetNextRequest-PDU .................................. 11
78
- 4.2.2.1. Example of Table Traversal ............................ 12
79
- 4.2.3. The GetBulkRequest-PDU .................................. 14
80
- 4.2.3.1. Another Example of Table Traversal .................... 17
81
- 4.2.4. The Response-PDU ........................................ 18
82
- 4.2.5. The SetRequest-PDU ...................................... 19
83
- 4.2.6. The SNMPv2-Trap-PDU ..................................... 22
84
- 4.2.7. The InformRequest-PDU ................................... 23
85
- 5. Notice on Intellectual Property ............................. 24
86
- 6. Acknowledgments ............................................. 24
87
- 7. Security Considerations ..................................... 26
88
- 8. References .................................................. 26
89
- 8.1. Normative References ...................................... 26
90
- 8.2. Informative References .................................... 27
91
- 9. Changes from RFC 1905 ....................................... 28
92
- 10. Editor's Address ........................................... 30
93
- 11. Full Copyright Statement ................................... 31
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
- Presuhn, et al. Standards Track [Page 2]
115
-
116
- RFC 3416 Protocol Operations for SNMP December 2002
117
-
118
-
119
- 1. Introduction
120
-
121
- The SNMP Management Framework at the time of this writing consists of
122
- five major components:
123
-
124
- - An overall architecture, described in STD 62, RFC 3411
125
- [RFC3411].
126
-
127
- - Mechanisms for describing and naming objects and events for the
128
- purpose of management. The first version of this Structure of
129
- Management Information (SMI) is called SMIv1 and described in
130
- STD 16, RFC 1155 [RFC1155], STD 16, RFC 1212 [RFC1212] and RFC
131
- 1215 [RFC1215]. The second version, called SMIv2, is described
132
- in STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and
133
- STD 58, RFC 2580 [RFC2580].
134
-
135
- - Message protocols for transferring management information. The
136
- first version of the SNMP message protocol is called SNMPv1 and
137
- described in STD 15, RFC 1157 [RFC1157]. A second version of
138
- the SNMP message protocol, which is not an Internet standards
139
- track protocol, is called SNMPv2c and described in RFC 1901
140
- [RFC1901] and STD 62, RFC 3417 [RFC3417]. The third version of
141
- the message protocol is called SNMPv3 and described in STD 62,
142
- RFC 3417 [RFC3417], RFC 3412 [RFC3412] and RFC 3414 [RFC3414].
143
-
144
- - Protocol operations for accessing management information. The
145
- first set of protocol operations and associated PDU formats is
146
- described in STD 15, RFC 1157 [RFC1157]. A second set of
147
- protocol operations and associated PDU formats is described in
148
- this document.
149
-
150
- - A set of fundamental applications described in STD 62, RFC 3413
151
- [RFC3413] and the view-based access control mechanism described
152
- in STD 62, RFC 3415 [RFC3415].
153
-
154
- A more detailed introduction to the SNMP Management Framework at the
155
- time of this writing can be found in RFC 3410 [RFC3410].
156
-
157
- Managed objects are accessed via a virtual information store, termed
158
- the Management Information Base or MIB. Objects in the MIB are
159
- defined using the mechanisms defined in the SMI.
160
-
161
- This document, Version 2 of the Protocol Operations for the Simple
162
- Network Management Protocol, defines the operations of the protocol
163
- with respect to the sending and receiving of PDUs to be carried by
164
- the message protocol.
165
-
166
-
167
-
168
-
169
-
170
- Presuhn, et al. Standards Track [Page 3]
171
-
172
- RFC 3416 Protocol Operations for SNMP December 2002
173
-
174
-
175
- 2. Overview
176
-
177
- SNMP entities supporting command generator or notification receiver
178
- applications (traditionally called "managers") communicate with SNMP
179
- entities supporting command responder or notification originator
180
- applications (traditionally called "agents"). The purpose of this
181
- protocol is the transport of management information and operations.
182
-
183
- 2.1. Management Information
184
-
185
- The term "variable" refers to an instance of a non-aggregate object
186
- type defined according to the conventions set forth in the SMI
187
- [RFC2578] or the textual conventions based on the SMI [RFC2579]. The
188
- term "variable binding" normally refers to the pairing of the name of
189
- a variable and its associated value. However, if certain kinds of
190
- exceptional conditions occur during processing of a retrieval
191
- request, a variable binding will pair a name and an indication of
192
- that exception.
193
-
194
- A variable-binding list is a simple list of variable bindings.
195
-
196
- The name of a variable is an OBJECT IDENTIFIER which is the
197
- concatenation of the OBJECT IDENTIFIER of the corresponding object-
198
- type together with an OBJECT IDENTIFIER fragment identifying the
199
- instance. The OBJECT IDENTIFIER of the corresponding object-type is
200
- called the OBJECT IDENTIFIER prefix of the variable.
201
-
202
- 2.2. Retransmission of Requests
203
-
204
- For all types of request in this protocol, the receiver is required
205
- under normal circumstances, to generate and transmit a response to
206
- the originator of the request. Whether or not a request should be
207
- retransmitted if no corresponding response is received in an
208
- appropriate time interval, is at the discretion of the application
209
- originating the request. This will normally depend on the urgency of
210
- the request. However, such an application needs to act responsibly
211
- in respect to the frequency and duration of re-transmissions. See
212
- BCP 41 [RFC2914] for discussion of relevant congestion control
213
- principles.
214
-
215
- 2.3. Message Sizes
216
-
217
- The maximum size of an SNMP message is limited to the minimum of:
218
-
219
- (1) the maximum message size which the destination SNMP entity can
220
- accept; and,
221
-
222
-
223
-
224
-
225
-
226
- Presuhn, et al. Standards Track [Page 4]
227
-
228
- RFC 3416 Protocol Operations for SNMP December 2002
229
-
230
-
231
- (2) the maximum message size which the source SNMP entity can
232
- generate.
233
-
234
- The former may be known on a per-recipient basis; and in the absence
235
- of such knowledge, is indicated by transport domain used when sending
236
- the message. The latter is imposed by implementation-specific local
237
- constraints.
238
-
239
- Each transport mapping for the SNMP indicates the minimum message
240
- size which a SNMP implementation must be able to produce or consume.
241
- Although implementations are encouraged to support larger values
242
- whenever possible, a conformant implementation must never generate
243
- messages larger than allowed by the receiving SNMP entity.
244
-
245
- One of the aims of the GetBulkRequest-PDU, specified in this
246
- protocol, is to minimize the number of protocol exchanges required to
247
- retrieve a large amount of management information. As such, this PDU
248
- type allows an SNMP entity supporting command generator applications
249
- to request that the response be as large as possible given the
250
- constraints on message sizes. These constraints include the limits
251
- on the size of messages which the SNMP entity supporting command
252
- responder applications can generate, and the SNMP entity supporting
253
- command generator applications can receive.
254
-
255
- However, it is possible that such maximum sized messages may be
256
- larger than the Path MTU of the path across the network traversed by
257
- the messages. In this situation, such messages are subject to
258
- fragmentation. Fragmentation is generally considered to be harmful
259
- [FRAG], since among other problems, it leads to a decrease in the
260
- reliability of the transfer of the messages. Thus, an SNMP entity
261
- which sends a GetBulkRequest-PDU must take care to set its parameters
262
- accordingly, so as to reduce the risk of fragmentation. In
263
- particular, under conditions of network stress, only small values
264
- should be used for max-repetitions.
265
-
266
- 2.4. Transport Mappings
267
-
268
- It is important to note that the exchange of SNMP messages requires
269
- only an unreliable datagram service, with every message being
270
- entirely and independently contained in a single transport datagram.
271
- Specific transport mappings and encoding rules are specified
272
- elsewhere [RFC3417]. However, the preferred mapping is the use of
273
- the User Datagram Protocol [RFC768].
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
- Presuhn, et al. Standards Track [Page 5]
283
-
284
- RFC 3416 Protocol Operations for SNMP December 2002
285
-
286
-
287
- 2.5. SMIv2 Data Type Mappings
288
-
289
- The SMIv2 [RFC2578] defines 11 base types (INTEGER, OCTET STRING,
290
- OBJECT IDENTIFIER, Integer32, IpAddress, Counter32, Gauge32,
291
- Unsigned32, TimeTicks, Opaque, Counter64) and the BITS construct.
292
- The SMIv2 base types are mapped to the corresponding selection type
293
- in the SimpleSyntax and ApplicationSyntax choices of the ASN.1 SNMP
294
- protocol definition. Note that the INTEGER and Integer32 SMIv2 base
295
- types are mapped to the integer-value selection type of the
296
- SimpleSyntax choice. Similarly, the Gauge32 and Unsigned32 SMIv2
297
- base types are mapped to the unsigned-integer-value selection type of
298
- the ApplicationSyntax choice.
299
-
300
- The SMIv2 BITS construct is mapped to the string-value selection type
301
- of the SimpleSyntax choice. A BITS value is encoded as an OCTET
302
- STRING, in which all the named bits in (the definition of) the
303
- bitstring, commencing with the first bit and proceeding to the last
304
- bit, are placed in bits 8 (high order bit) to 1 (low order bit) of
305
- the first octet, followed by bits 8 to 1 of each subsequent octet in
306
- turn, followed by as many bits as are needed of the final subsequent
307
- octet, commencing with bit 8. Remaining bits, if any, of the final
308
- octet are set to zero on generation and ignored on receipt.
309
-
310
- 3. Definitions
311
-
312
- The PDU syntax is defined using ASN.1 notation [ASN1].
313
-
314
- SNMPv2-PDU DEFINITIONS ::= BEGIN
315
-
316
- ObjectName ::= OBJECT IDENTIFIER
317
-
318
- ObjectSyntax ::= CHOICE {
319
- simple SimpleSyntax,
320
- application-wide ApplicationSyntax }
321
-
322
- SimpleSyntax ::= CHOICE {
323
- integer-value INTEGER (-2147483648..2147483647),
324
- string-value OCTET STRING (SIZE (0..65535)),
325
- objectID-value OBJECT IDENTIFIER }
326
-
327
- ApplicationSyntax ::= CHOICE {
328
- ipAddress-value IpAddress,
329
- counter-value Counter32,
330
- timeticks-value TimeTicks,
331
- arbitrary-value Opaque,
332
- big-counter-value Counter64,
333
- unsigned-integer-value Unsigned32 }
334
-
335
-
336
-
337
-
338
- Presuhn, et al. Standards Track [Page 6]
339
-
340
- RFC 3416 Protocol Operations for SNMP December 2002
341
-
342
-
343
- IpAddress ::= [APPLICATION 0] IMPLICIT OCTET STRING (SIZE (4))
344
-
345
- Counter32 ::= [APPLICATION 1] IMPLICIT INTEGER (0..4294967295)
346
-
347
- Unsigned32 ::= [APPLICATION 2] IMPLICIT INTEGER (0..4294967295)
348
-
349
- Gauge32 ::= Unsigned32
350
-
351
- TimeTicks ::= [APPLICATION 3] IMPLICIT INTEGER (0..4294967295)
352
-
353
- Opaque ::= [APPLICATION 4] IMPLICIT OCTET STRING
354
-
355
- Counter64 ::= [APPLICATION 6]
356
- IMPLICIT INTEGER (0..18446744073709551615)
357
-
358
- -- protocol data units
359
-
360
- PDUs ::= CHOICE {
361
- get-request GetRequest-PDU,
362
- get-next-request GetNextRequest-PDU,
363
- get-bulk-request GetBulkRequest-PDU,
364
- response Response-PDU,
365
- set-request SetRequest-PDU,
366
- inform-request InformRequest-PDU,
367
- snmpV2-trap SNMPv2-Trap-PDU,
368
- report Report-PDU }
369
-
370
- -- PDUs
371
-
372
- GetRequest-PDU ::= [0] IMPLICIT PDU
373
-
374
- GetNextRequest-PDU ::= [1] IMPLICIT PDU
375
-
376
- Response-PDU ::= [2] IMPLICIT PDU
377
-
378
- SetRequest-PDU ::= [3] IMPLICIT PDU
379
-
380
- -- [4] is obsolete
381
-
382
- GetBulkRequest-PDU ::= [5] IMPLICIT BulkPDU
383
-
384
- InformRequest-PDU ::= [6] IMPLICIT PDU
385
-
386
- SNMPv2-Trap-PDU ::= [7] IMPLICIT PDU
387
-
388
- -- Usage and precise semantics of Report-PDU are not defined
389
- -- in this document. Any SNMP administrative framework making
390
- -- use of this PDU must define its usage and semantics.
391
-
392
-
393
-
394
- Presuhn, et al. Standards Track [Page 7]
395
-
396
- RFC 3416 Protocol Operations for SNMP December 2002
397
-
398
-
399
- Report-PDU ::= [8] IMPLICIT PDU
400
-
401
- max-bindings INTEGER ::= 2147483647
402
-
403
- PDU ::= SEQUENCE {
404
- request-id INTEGER (-214783648..214783647),
405
-
406
- error-status -- sometimes ignored
407
- INTEGER {
408
- noError(0),
409
- tooBig(1),
410
- noSuchName(2), -- for proxy compatibility
411
- badValue(3), -- for proxy compatibility
412
- readOnly(4), -- for proxy compatibility
413
- genErr(5),
414
- noAccess(6),
415
- wrongType(7),
416
- wrongLength(8),
417
- wrongEncoding(9),
418
- wrongValue(10),
419
- noCreation(11),
420
- inconsistentValue(12),
421
- resourceUnavailable(13),
422
- commitFailed(14),
423
- undoFailed(15),
424
- authorizationError(16),
425
- notWritable(17),
426
- inconsistentName(18)
427
- },
428
-
429
- error-index -- sometimes ignored
430
- INTEGER (0..max-bindings),
431
-
432
- variable-bindings -- values are sometimes ignored
433
- VarBindList
434
- }
435
-
436
- BulkPDU ::= -- must be identical in
437
- SEQUENCE { -- structure to PDU
438
- request-id INTEGER (-214783648..214783647),
439
- non-repeaters INTEGER (0..max-bindings),
440
- max-repetitions INTEGER (0..max-bindings),
441
-
442
- variable-bindings -- values are ignored
443
- VarBindList
444
- }
445
-
446
- -- variable binding
447
-
448
-
449
-
450
- Presuhn, et al. Standards Track [Page 8]
451
-
452
- RFC 3416 Protocol Operations for SNMP December 2002
453
-
454
-
455
- VarBind ::= SEQUENCE {
456
- name ObjectName,
457
-
458
- CHOICE {
459
- value ObjectSyntax,
460
- unSpecified NULL, -- in retrieval requests
461
-
462
- -- exceptions in responses
463
- noSuchObject [0] IMPLICIT NULL,
464
- noSuchInstance [1] IMPLICIT NULL,
465
- endOfMibView [2] IMPLICIT NULL
466
- }
467
- }
468
-
469
- -- variable-binding list
470
-
471
- VarBindList ::= SEQUENCE (SIZE (0..max-bindings)) OF VarBind
472
-
473
- END
474
-
475
- 4. Protocol Specification
476
-
477
- 4.1. Common Constructs
478
-
479
- The value of the request-id field in a Response-PDU takes the value
480
- of the request-id field in the request PDU to which it is a response.
481
- By use of the request-id value, an application can distinguish the
482
- (potentially multiple) outstanding requests, and thereby correlate
483
- incoming responses with outstanding requests. In cases where an
484
- unreliable datagram service is used, the request-id also provides a
485
- simple means of identifying messages duplicated by the network. Use
486
- of the same request-id on a retransmission of a request allows the
487
- response to either the original transmission or the retransmission to
488
- satisfy the request. However, in order to calculate the round trip
489
- time for transmission and processing of a request-response
490
- transaction, the application needs to use a different request-id
491
- value on a retransmitted request. The latter strategy is recommended
492
- for use in the majority of situations.
493
-
494
- A non-zero value of the error-status field in a Response-PDU is used
495
- to indicate that an error occurred to prevent the processing of the
496
- request. In these cases, a non-zero value of the Response-PDU's
497
- error-index field provides additional information by identifying
498
- which variable binding in the list caused the error. A variable
499
- binding is identified by its index value. The first variable binding
500
- in a variable-binding list is index one, the second is index two,
501
- etc.
502
-
503
-
504
-
505
-
506
- Presuhn, et al. Standards Track [Page 9]
507
-
508
- RFC 3416 Protocol Operations for SNMP December 2002
509
-
510
-
511
- SNMP limits OBJECT IDENTIFIER values to a maximum of 128 sub-
512
- identifiers, where each sub-identifier has a maximum value of
513
- 2**32-1.
514
-
515
- 4.2. PDU Processing
516
-
517
- In the elements of procedure below, any field of a PDU which is not
518
- referenced by the relevant procedure is ignored by the receiving SNMP
519
- entity. However, all components of a PDU, including those whose
520
- values are ignored by the receiving SNMP entity, must have valid
521
- ASN.1 syntax and encoding. For example, some PDUs (e.g., the
522
- GetRequest-PDU) are concerned only with the name of a variable and
523
- not its value. In this case, the value portion of the variable
524
- binding is ignored by the receiving SNMP entity. The unSpecified
525
- value is defined for use as the value portion of such bindings.
526
-
527
- On generating a management communication, the message "wrapper" to
528
- encapsulate the PDU is generated according to the "Elements of
529
- Procedure" of the administrative framework in use. The definition of
530
- "max-bindings" imposes an upper bound on the number of variable
531
- bindings. In practice, the size of a message is also limited by
532
- constraints on the maximum message size. A compliant implementation
533
- must support as many variable bindings in a PDU or BulkPDU as fit
534
- into the overall maximum message size limit of the SNMP engine, but
535
- no more than 2147483647 variable bindings.
536
-
537
- On receiving a management communication, the "Elements of Procedure"
538
- of the administrative framework in use is followed, and if those
539
- procedures indicate that the operation contained within the message
540
- is to be performed locally, then those procedures also indicate the
541
- MIB view which is visible to the operation.
542
-
543
- 4.2.1. The GetRequest-PDU
544
-
545
- A GetRequest-PDU is generated and transmitted at the request of an
546
- application.
547
-
548
- Upon receipt of a GetRequest-PDU, the receiving SNMP entity processes
549
- each variable binding in the variable-binding list to produce a
550
- Response-PDU. All fields of the Response-PDU have the same values as
551
- the corresponding fields of the received request except as indicated
552
- below. Each variable binding is processed as follows:
553
-
554
- (1) If the variable binding's name exactly matches the name of a
555
- variable accessible by this request, then the variable
556
- binding's value field is set to the value of the named
557
- variable.
558
-
559
-
560
-
561
-
562
- Presuhn, et al. Standards Track [Page 10]
563
-
564
- RFC 3416 Protocol Operations for SNMP December 2002
565
-
566
-
567
- (2) Otherwise, if the variable binding's name does not have an
568
- OBJECT IDENTIFIER prefix which exactly matches the OBJECT
569
- IDENTIFIER prefix of any (potential) variable accessible by
570
- this request, then its value field is set to "noSuchObject".
571
-
572
- (3) Otherwise, the variable binding's value field is set to
573
- "noSuchInstance".
574
-
575
- If the processing of any variable binding fails for a reason other
576
- than listed above, then the Response-PDU is re-formatted with the
577
- same values in its request-id and variable-bindings fields as the
578
- received GetRequest-PDU, with the value of its error-status field set
579
- to "genErr", and the value of its error-index field is set to the
580
- index of the failed variable binding.
581
-
582
- Otherwise, the value of the Response-PDU's error-status field is set
583
- to "noError", and the value of its error-index field is zero.
584
-
585
- The generated Response-PDU is then encapsulated into a message. If
586
- the size of the resultant message is less than or equal to both a
587
- local constraint and the maximum message size of the originator, it
588
- is transmitted to the originator of the GetRequest-PDU.
589
-
590
- Otherwise, an alternate Response-PDU is generated. This alternate
591
- Response-PDU is formatted with the same value in its request-id field
592
- as the received GetRequest-PDU, with the value of its error-status
593
- field set to "tooBig", the value of its error-index field set to
594
- zero, and an empty variable-bindings field. This alternate
595
- Response-PDU is then encapsulated into a message. If the size of the
596
- resultant message is less than or equal to both a local constraint
597
- and the maximum message size of the originator, it is transmitted to
598
- the originator of the GetRequest-PDU. Otherwise, the snmpSilentDrops
599
- [RFC3418] counter is incremented and the resultant message is
600
- discarded.
601
-
602
- 4.2.2. The GetNextRequest-PDU
603
-
604
- A GetNextRequest-PDU is generated and transmitted at the request of
605
- an application.
606
-
607
- Upon receipt of a GetNextRequest-PDU, the receiving SNMP entity
608
- processes each variable binding in the variable-binding list to
609
- produce a Response-PDU. All fields of the Response-PDU have the same
610
- values as the corresponding fields of the received request except as
611
- indicated below. Each variable binding is processed as follows:
612
-
613
- (1) The variable is located which is in the lexicographically
614
- ordered list of the names of all variables which are
615
-
616
-
617
-
618
- Presuhn, et al. Standards Track [Page 11]
619
-
620
- RFC 3416 Protocol Operations for SNMP December 2002
621
-
622
-
623
- accessible by this request and whose name is the first
624
- lexicographic successor of the variable binding's name in
625
- the incoming GetNextRequest-PDU. The corresponding variable
626
- binding's name and value fields in the Response-PDU are set
627
- to the name and value of the located variable.
628
-
629
- (2) If the requested variable binding's name does not
630
- lexicographically precede the name of any variable
631
- accessible by this request, i.e., there is no lexicographic
632
- successor, then the corresponding variable binding produced
633
- in the Response-PDU has its value field set to
634
- "endOfMibView", and its name field set to the variable
635
- binding's name in the request.
636
-
637
- If the processing of any variable binding fails for a reason other
638
- than listed above, then the Response-PDU is re-formatted with the
639
- same values in its request-id and variable-bindings fields as the
640
- received GetNextRequest-PDU, with the value of its error-status field
641
- set to "genErr", and the value of its error-index field is set to the
642
- index of the failed variable binding.
643
-
644
- Otherwise, the value of the Response-PDU's error-status field is set
645
- to "noError", and the value of its error-index field is zero.
646
-
647
- The generated Response-PDU is then encapsulated into a message. If
648
- the size of the resultant message is less than or equal to both a
649
- local constraint and the maximum message size of the originator, it
650
- is transmitted to the originator of the GetNextRequest-PDU.
651
-
652
- Otherwise, an alternate Response-PDU is generated. This alternate
653
- Response-PDU is formatted with the same values in its request-id
654
- field as the received GetNextRequest-PDU, with the value of its
655
- error-status field set to "tooBig", the value of its error-index
656
- field set to zero, and an empty variable-bindings field. This
657
- alternate Response-PDU is then encapsulated into a message. If the
658
- size of the resultant message is less than or equal to both a local
659
- constraint and the maximum message size of the originator, it is
660
- transmitted to the originator of the GetNextRequest-PDU. Otherwise,
661
- the snmpSilentDrops [RFC3418] counter is incremented and the
662
- resultant message is discarded.
663
-
664
- 4.2.2.1. Example of Table Traversal
665
-
666
- An important use of the GetNextRequest-PDU is the traversal of
667
- conceptual tables of information within a MIB. The semantics of this
668
- type of request, together with the method of identifying individual
669
- instances of objects in the MIB, provides access to related objects
670
- in the MIB as if they enjoyed a tabular organization.
671
-
672
-
673
-
674
- Presuhn, et al. Standards Track [Page 12]
675
-
676
- RFC 3416 Protocol Operations for SNMP December 2002
677
-
678
-
679
- In the protocol exchange sketched below, an application retrieves the
680
- media-dependent physical address and the address-mapping type for
681
- each entry in the IP net-to-media Address Translation Table [RFC1213]
682
- of a particular network element. It also retrieves the value of
683
- sysUpTime [RFC3418], at which the mappings existed. Suppose that the
684
- command responder's IP net-to-media table has three entries:
685
-
686
- Interface-Number Network-Address Physical-Address Type
687
-
688
- 1 10.0.0.51 00:00:10:01:23:45 static
689
- 1 9.2.3.4 00:00:10:54:32:10 dynamic
690
- 2 10.0.0.15 00:00:10:98:76:54 dynamic
691
-
692
- The SNMP entity supporting a command generator application begins by
693
- sending a GetNextRequest-PDU containing the indicated OBJECT
694
- IDENTIFIER values as the requested variable names:
695
-
696
- GetNextRequest ( sysUpTime,
697
- ipNetToMediaPhysAddress,
698
- ipNetToMediaType )
699
-
700
- The SNMP entity supporting a command responder application responds
701
- with a Response-PDU:
702
-
703
- Response (( sysUpTime.0 = "123456" ),
704
- ( ipNetToMediaPhysAddress.1.9.2.3.4 = "000010543210" ),
705
- ( ipNetToMediaType.1.9.2.3.4 = "dynamic" ))
706
-
707
- The SNMP entity supporting the command generator application
708
- continues with:
709
-
710
- GetNextRequest ( sysUpTime,
711
- ipNetToMediaPhysAddress.1.9.2.3.4,
712
- ipNetToMediaType.1.9.2.3.4 )
713
-
714
- The SNMP entity supporting the command responder application responds
715
- with:
716
-
717
- Response (( sysUpTime.0 = "123461" ),
718
- ( ipNetToMediaPhysAddress.1.10.0.0.51 = "000010012345" ),
719
- ( ipNetToMediaType.1.10.0.0.51 = "static" ))
720
-
721
- The SNMP entity supporting the command generator application
722
- continues with:
723
-
724
- GetNextRequest ( sysUpTime,
725
- ipNetToMediaPhysAddress.1.10.0.0.51,
726
- ipNetToMediaType.1.10.0.0.51 )
727
-
728
-
729
-
730
- Presuhn, et al. Standards Track [Page 13]
731
-
732
- RFC 3416 Protocol Operations for SNMP December 2002
733
-
734
-
735
- The SNMP entity supporting the command responder application responds
736
- with:
737
-
738
- Response (( sysUpTime.0 = "123466" ),
739
- ( ipNetToMediaPhysAddress.2.10.0.0.15 = "000010987654" ),
740
- ( ipNetToMediaType.2.10.0.0.15 = "dynamic" ))
741
-
742
- The SNMP entity supporting the command generator application
743
- continues with:
744
-
745
- GetNextRequest ( sysUpTime,
746
- ipNetToMediaPhysAddress.2.10.0.0.15,
747
- ipNetToMediaType.2.10.0.0.15 )
748
-
749
- As there are no further entries in the table, the SNMP entity
750
- supporting the command responder application responds with the
751
- variables that are next in the lexicographical ordering of the
752
- accessible object names, for example:
753
-
754
- Response (( sysUpTime.0 = "123471" ),
755
- ( ipNetToMediaNetAddress.1.9.2.3.4 = "9.2.3.4" ),
756
- ( ipRoutingDiscards.0 = "2" ))
757
-
758
- Note how, having reached the end of the column for
759
- ipNetToMediaPhysAddress, the second variable binding from the command
760
- responder application has now "wrapped" to the first row in the next
761
- column. Furthermore, note how, having reached the end of the
762
- ipNetToMediaTable for the third variable binding, the command
763
- responder application has responded with the next available object,
764
- which is outside that table. This response signals the end of the
765
- table to the command generator application.
766
-
767
- 4.2.3. The GetBulkRequest-PDU
768
-
769
- A GetBulkRequest-PDU is generated and transmitted at the request of
770
- an application. The purpose of the GetBulkRequest-PDU is to request
771
- the transfer of a potentially large amount of data, including, but
772
- not limited to, the efficient and rapid retrieval of large tables.
773
-
774
- Upon receipt of a GetBulkRequest-PDU, the receiving SNMP entity
775
- processes each variable binding in the variable-binding list to
776
- produce a Response-PDU with its request-id field having the same
777
- value as in the request.
778
-
779
- For the GetBulkRequest-PDU type, the successful processing of each
780
- variable binding in the request generates zero or more variable
781
- bindings in the Response-PDU. That is, the one-to-one mapping
782
- between the variable bindings of the GetRequest-PDU, GetNextRequest-
783
-
784
-
785
-
786
- Presuhn, et al. Standards Track [Page 14]
787
-
788
- RFC 3416 Protocol Operations for SNMP December 2002
789
-
790
-
791
- PDU, and SetRequest-PDU types and the resultant Response-PDUs does
792
- not apply for the mapping between the variable bindings of a
793
- GetBulkRequest-PDU and the resultant Response-PDU.
794
-
795
- The values of the non-repeaters and max-repetitions fields in the
796
- request specify the processing requested. One variable binding in
797
- the Response-PDU is requested for the first N variable bindings in
798
- the request and M variable bindings are requested for each of the R
799
- remaining variable bindings in the request. Consequently, the total
800
- number of requested variable bindings communicated by the request is
801
- given by N + (M * R), where N is the minimum of: a) the value of the
802
- non-repeaters field in the request, and b) the number of variable
803
- bindings in the request; M is the value of the max-repetitions field
804
- in the request; and R is the maximum of: a) number of variable
805
- bindings in the request - N, and b) zero.
806
-
807
- The receiving SNMP entity produces a Response-PDU with up to the
808
- total number of requested variable bindings communicated by the
809
- request. The request-id shall have the same value as the received
810
- GetBulkRequest-PDU.
811
-
812
- If N is greater than zero, the first through the (N)-th variable
813
- bindings of the Response-PDU are each produced as follows:
814
-
815
- (1) The variable is located which is in the lexicographically
816
- ordered list of the names of all variables which are accessible
817
- by this request and whose name is the first lexicographic
818
- successor of the variable binding's name in the incoming
819
- GetBulkRequest-PDU. The corresponding variable binding's name
820
- and value fields in the Response-PDU are set to the name and
821
- value of the located variable.
822
-
823
- (2) If the requested variable binding's name does not
824
- lexicographically precede the name of any variable accessible
825
- by this request, i.e., there is no lexicographic successor,
826
- then the corresponding variable binding produced in the
827
- Response-PDU has its value field set to "endOfMibView", and its
828
- name field set to the variable binding's name in the request.
829
-
830
- If M and R are non-zero, the (N + 1)-th and subsequent variable
831
- bindings of the Response-PDU are each produced in a similar manner.
832
- For each iteration i, such that i is greater than zero and less than
833
- or equal to M, and for each repeated variable, r, such that r is
834
- greater than zero and less than or equal to R, the (N + ( (i-1) * R )
835
- + r)-th variable binding of the Response-PDU is produced as follows:
836
-
837
-
838
-
839
-
840
-
841
-
842
- Presuhn, et al. Standards Track [Page 15]
843
-
844
- RFC 3416 Protocol Operations for SNMP December 2002
845
-
846
-
847
- (1) The variable which is in the lexicographically ordered list of
848
- the names of all variables which are accessible by this request
849
- and whose name is the (i)-th lexicographic successor of the (N
850
- + r)-th variable binding's name in the incoming
851
- GetBulkRequest-PDU is located and the variable binding's name
852
- and value fields are set to the name and value of the located
853
- variable.
854
-
855
- (2) If there is no (i)-th lexicographic successor, then the
856
- corresponding variable binding produced in the Response-PDU has
857
- its value field set to "endOfMibView", and its name field set
858
- to either the last lexicographic successor, or if there are no
859
- lexicographic successors, to the (N + r)-th variable binding's
860
- name in the request.
861
-
862
- While the maximum number of variable bindings in the Response-PDU is
863
- bounded by N + (M * R), the response may be generated with a lesser
864
- number of variable bindings (possibly zero) for either of three
865
- reasons.
866
-
867
- (1) If the size of the message encapsulating the Response-PDU
868
- containing the requested number of variable bindings would be
869
- greater than either a local constraint or the maximum message
870
- size of the originator, then the response is generated with a
871
- lesser number of variable bindings. This lesser number is the
872
- ordered set of variable bindings with some of the variable
873
- bindings at the end of the set removed, such that the size of
874
- the message encapsulating the Response-PDU is approximately
875
- equal to but no greater than either a local constraint or the
876
- maximum message size of the originator. Note that the number
877
- of variable bindings removed has no relationship to the values
878
- of N, M, or R.
879
-
880
- (2) The response may also be generated with a lesser number of
881
- variable bindings if for some value of iteration i, such that i
882
- is greater than zero and less than or equal to M, that all of
883
- the generated variable bindings have the value field set to
884
- "endOfMibView". In this case, the variable bindings may be
885
- truncated after the (N + (i * R))-th variable binding.
886
-
887
- (3) In the event that the processing of a request with many
888
- repetitions requires a significantly greater amount of
889
- processing time than a normal request, then a command responder
890
- application may terminate the request with less than the full
891
- number of repetitions, providing at least one repetition is
892
- completed.
893
-
894
-
895
-
896
-
897
-
898
- Presuhn, et al. Standards Track [Page 16]
899
-
900
- RFC 3416 Protocol Operations for SNMP December 2002
901
-
902
-
903
- If the processing of any variable binding fails for a reason other
904
- than listed above, then the Response-PDU is re-formatted with the
905
- same values in its request-id and variable-bindings fields as the
906
- received GetBulkRequest-PDU, with the value of its error-status field
907
- set to "genErr", and the value of its error-index field is set to the
908
- index of the variable binding in the original request which
909
- corresponds to the failed variable binding.
910
-
911
- Otherwise, the value of the Response-PDU's error-status field is set
912
- to "noError", and the value of its error-index field to zero.
913
-
914
- The generated Response-PDU (possibly with an empty variable-bindings
915
- field) is then encapsulated into a message. If the size of the
916
- resultant message is less than or equal to both a local constraint
917
- and the maximum message size of the originator, it is transmitted to
918
- the originator of the GetBulkRequest-PDU. Otherwise, the
919
- snmpSilentDrops [RFC3418] counter is incremented and the resultant
920
- message is discarded.
921
-
922
- 4.2.3.1. Another Example of Table Traversal
923
-
924
- This example demonstrates how the GetBulkRequest-PDU can be used as
925
- an alternative to the GetNextRequest-PDU. The same traversal of the
926
- IP net-to-media table as shown in Section 4.2.2.1 is achieved with
927
- fewer exchanges.
928
-
929
- The SNMP entity supporting the command generator application begins
930
- by sending a GetBulkRequest-PDU with the modest max-repetitions value
931
- of 2, and containing the indicated OBJECT IDENTIFIER values as the
932
- requested variable names:
933
-
934
- GetBulkRequest [ non-repeaters = 1, max-repetitions = 2 ]
935
- ( sysUpTime,
936
- ipNetToMediaPhysAddress,
937
- ipNetToMediaType )
938
-
939
- The SNMP entity supporting the command responder application responds
940
- with a Response-PDU:
941
-
942
- Response (( sysUpTime.0 = "123456" ),
943
- ( ipNetToMediaPhysAddress.1.9.2.3.4 = "000010543210" ),
944
- ( ipNetToMediaType.1.9.2.3.4 = "dynamic" ),
945
- ( ipNetToMediaPhysAddress.1.10.0.0.51 = "000010012345" ),
946
- ( ipNetToMediaType.1.10.0.0.51 = "static" ))
947
-
948
-
949
-
950
-
951
-
952
-
953
-
954
- Presuhn, et al. Standards Track [Page 17]
955
-
956
- RFC 3416 Protocol Operations for SNMP December 2002
957
-
958
-
959
- The SNMP entity supporting the command generator application
960
- continues with:
961
-
962
- GetBulkRequest [ non-repeaters = 1, max-repetitions = 2 ]
963
- ( sysUpTime,
964
- ipNetToMediaPhysAddress.1.10.0.0.51,
965
- ipNetToMediaType.1.10.0.0.51 )
966
-
967
- The SNMP entity supporting the command responder application responds
968
- with:
969
-
970
- Response (( sysUpTime.0 = "123466" ),
971
- ( ipNetToMediaPhysAddress.2.10.0.0.15 = "000010987654" ),
972
- ( ipNetToMediaType.2.10.0.0.15 = "dynamic" ),
973
- ( ipNetToMediaNetAddress.1.9.2.3.4 = "9.2.3.4" ),
974
- ( ipRoutingDiscards.0 = "2" ))
975
-
976
- Note how, as in the first example, the variable bindings in the
977
- response indicate that the end of the table has been reached. The
978
- fourth variable binding does so by returning information from the
979
- next available column; the fifth variable binding does so by
980
- returning information from the first available object
981
- lexicographically following the table. This response signals the end
982
- of the table to the command generator application.
983
-
984
- 4.2.4. The Response-PDU
985
-
986
- The Response-PDU is generated by an SNMP entity only upon receipt of
987
- a GetRequest-PDU, GetNextRequest-PDU, GetBulkRequest-PDU,
988
- SetRequest-PDU, or InformRequest-PDU, as described elsewhere in this
989
- document.
990
-
991
- If the error-status field of the Response-PDU is non-zero, the value
992
- fields of the variable bindings in the variable binding list are
993
- ignored.
994
-
995
- If both the error-status field and the error-index field of the
996
- Response-PDU are non-zero, then the value of the error-index field is
997
- the index of the variable binding (in the variable-binding list of
998
- the corresponding request) for which the request failed. The first
999
- variable binding in a request's variable-binding list is index one,
1000
- the second is index two, etc.
1001
-
1002
- A compliant SNMP entity supporting a command generator application
1003
- must be able to properly receive and handle a Response-PDU with an
1004
- error-status field equal to "noSuchName", "badValue", or "readOnly".
1005
- (See sections 1.3 and 4.3 of [RFC2576].)
1006
-
1007
-
1008
-
1009
-
1010
- Presuhn, et al. Standards Track [Page 18]
1011
-
1012
- RFC 3416 Protocol Operations for SNMP December 2002
1013
-
1014
-
1015
- Upon receipt of a Response-PDU, the receiving SNMP entity presents
1016
- its contents to the application which generated the request with the
1017
- same request-id value. For more details, see [RFC3412].
1018
-
1019
- 4.2.5. The SetRequest-PDU
1020
-
1021
- A SetRequest-PDU is generated and transmitted at the request of an
1022
- application.
1023
-
1024
- Upon receipt of a SetRequest-PDU, the receiving SNMP entity
1025
- determines the size of a message encapsulating a Response-PDU having
1026
- the same values in its request-id and variable-bindings fields as the
1027
- received SetRequest-PDU, and the largest possible sizes of the
1028
- error-status and error-index fields. If the determined message size
1029
- is greater than either a local constraint or the maximum message size
1030
- of the originator, then an alternate Response-PDU is generated,
1031
- transmitted to the originator of the SetRequest-PDU, and processing
1032
- of the SetRequest-PDU terminates immediately thereafter. This
1033
- alternate Response-PDU is formatted with the same values in its
1034
- request-id field as the received SetRequest-PDU, with the value of
1035
- its error-status field set to "tooBig", the value of its error-index
1036
- field set to zero, and an empty variable-bindings field. This
1037
- alternate Response-PDU is then encapsulated into a message. If the
1038
- size of the resultant message is less than or equal to both a local
1039
- constraint and the maximum message size of the originator, it is
1040
- transmitted to the originator of the SetRequest-PDU. Otherwise, the
1041
- snmpSilentDrops [RFC3418] counter is incremented and the resultant
1042
- message is discarded. Regardless, processing of the SetRequest-PDU
1043
- terminates.
1044
-
1045
- Otherwise, the receiving SNMP entity processes each variable binding
1046
- in the variable-binding list to produce a Response-PDU. All fields
1047
- of the Response-PDU have the same values as the corresponding fields
1048
- of the received request except as indicated below.
1049
-
1050
- The variable bindings are conceptually processed as a two phase
1051
- operation. In the first phase, each variable binding is validated;
1052
- if all validations are successful, then each variable is altered in
1053
- the second phase. Of course, implementors are at liberty to
1054
- implement either the first, or second, or both, of these conceptual
1055
- phases as multiple implementation phases. Indeed, such multiple
1056
- implementation phases may be necessary in some cases to ensure
1057
- consistency.
1058
-
1059
-
1060
-
1061
-
1062
-
1063
-
1064
-
1065
-
1066
- Presuhn, et al. Standards Track [Page 19]
1067
-
1068
- RFC 3416 Protocol Operations for SNMP December 2002
1069
-
1070
-
1071
- The following validations are performed in the first phase on each
1072
- variable binding until they are all successful, or until one fails:
1073
-
1074
- (1) If the variable binding's name specifies an existing or non-
1075
- existent variable to which this request is/would be denied
1076
- access because it is/would not be in the appropriate MIB view,
1077
- then the value of the Response-PDU's error-status field is set
1078
- to "noAccess", and the value of its error-index field is set to
1079
- the index of the failed variable binding.
1080
-
1081
- (2) Otherwise, if there are no variables which share the same
1082
- OBJECT IDENTIFIER prefix as the variable binding's name, and
1083
- which are able to be created or modified no matter what new
1084
- value is specified, then the value of the Response-PDU's
1085
- error-status field is set to "notWritable", and the value of
1086
- its error-index field is set to the index of the failed
1087
- variable binding.
1088
-
1089
- (3) Otherwise, if the variable binding's value field specifies,
1090
- according to the ASN.1 language, a type which is inconsistent
1091
- with that required for all variables which share the same
1092
- OBJECT IDENTIFIER prefix as the variable binding's name, then
1093
- the value of the Response-PDU's error-status field is set to
1094
- "wrongType", and the value of its error-index field is set to
1095
- the index of the failed variable binding.
1096
-
1097
- (4) Otherwise, if the variable binding's value field specifies,
1098
- according to the ASN.1 language, a length which is inconsistent
1099
- with that required for all variables which share the same
1100
- OBJECT IDENTIFIER prefix as the variable binding's name, then
1101
- the value of the Response-PDU's error-status field is set to
1102
- "wrongLength", and the value of its error-index field is set to
1103
- the index of the failed variable binding.
1104
-
1105
- (5) Otherwise, if the variable binding's value field contains an
1106
- ASN.1 encoding which is inconsistent with that field's ASN.1
1107
- tag, then the value of the Response-PDU's error-status field is
1108
- set to "wrongEncoding", and the value of its error-index field
1109
- is set to the index of the failed variable binding. (Note that
1110
- not all implementation strategies will generate this error.)
1111
-
1112
- (6) Otherwise, if the variable binding's value field specifies a
1113
- value which could under no circumstances be assigned to the
1114
- variable, then the value of the Response-PDU's error-status
1115
- field is set to "wrongValue", and the value of its error-index
1116
- field is set to the index of the failed variable binding.
1117
-
1118
-
1119
-
1120
-
1121
-
1122
- Presuhn, et al. Standards Track [Page 20]
1123
-
1124
- RFC 3416 Protocol Operations for SNMP December 2002
1125
-
1126
-
1127
- (7) Otherwise, if the variable binding's name specifies a variable
1128
- which does not exist and could not ever be created (even though
1129
- some variables sharing the same OBJECT IDENTIFIER prefix might
1130
- under some circumstances be able to be created), then the value
1131
- of the Response-PDU's error-status field is set to
1132
- "noCreation", and the value of its error-index field is set to
1133
- the index of the failed variable binding.
1134
-
1135
- (8) Otherwise, if the variable binding's name specifies a variable
1136
- which does not exist but can not be created under the present
1137
- circumstances (even though it could be created under other
1138
- circumstances), then the value of the Response-PDU's error-
1139
- status field is set to "inconsistentName", and the value of its
1140
- error-index field is set to the index of the failed variable
1141
- binding.
1142
-
1143
- (9) Otherwise, if the variable binding's name specifies a variable
1144
- which exists but can not be modified no matter what new value
1145
- is specified, then the value of the Response-PDU's error-status
1146
- field is set to "notWritable", and the value of its error-index
1147
- field is set to the index of the failed variable binding.
1148
-
1149
- (10) Otherwise, if the variable binding's value field specifies a
1150
- value that could under other circumstances be held by the
1151
- variable, but is presently inconsistent or otherwise unable to
1152
- be assigned to the variable, then the value of the Response-
1153
- PDU's error-status field is set to "inconsistentValue", and the
1154
- value of its error-index field is set to the index of the
1155
- failed variable binding.
1156
-
1157
- (11) When, during the above steps, the assignment of the value
1158
- specified by the variable binding's value field to the
1159
- specified variable requires the allocation of a resource which
1160
- is presently unavailable, then the value of the Response-PDU's
1161
- error-status field is set to "resourceUnavailable", and the
1162
- value of its error-index field is set to the index of the
1163
- failed variable binding.
1164
-
1165
- (12) If the processing of the variable binding fails for a reason
1166
- other than listed above, then the value of the Response-PDU's
1167
- error-status field is set to "genErr", and the value of its
1168
- error-index field is set to the index of the failed variable
1169
- binding.
1170
-
1171
- (13) Otherwise, the validation of the variable binding succeeds.
1172
-
1173
-
1174
-
1175
-
1176
-
1177
-
1178
- Presuhn, et al. Standards Track [Page 21]
1179
-
1180
- RFC 3416 Protocol Operations for SNMP December 2002
1181
-
1182
-
1183
- At the end of the first phase, if the validation of all variable
1184
- bindings succeeded, then the value of the Response-PDU's error-status
1185
- field is set to "noError" and the value of its error-index field is
1186
- zero, and processing continues as follows.
1187
-
1188
- For each variable binding in the request, the named variable is
1189
- created if necessary, and the specified value is assigned to it.
1190
- Each of these variable assignments occurs as if simultaneously with
1191
- respect to all other assignments specified in the same request.
1192
- However, if the same variable is named more than once in a single
1193
- request, with different associated values, then the actual assignment
1194
- made to that variable is implementation-specific.
1195
-
1196
- If any of these assignments fail (even after all the previous
1197
- validations), then all other assignments are undone, and the
1198
- Response-PDU is modified to have the value of its error-status field
1199
- set to "commitFailed", and the value of its error-index field set to
1200
- the index of the failed variable binding.
1201
-
1202
- If and only if it is not possible to undo all the assignments, then
1203
- the Response-PDU is modified to have the value of its error-status
1204
- field set to "undoFailed", and the value of its error-index field is
1205
- set to zero. Note that implementations are strongly encouraged to
1206
- take all possible measures to avoid use of either "commitFailed" or
1207
- "undoFailed" - these two error-status codes are not to be taken as
1208
- license to take the easy way out in an implementation.
1209
-
1210
- Finally, the generated Response-PDU is encapsulated into a message,
1211
- and transmitted to the originator of the SetRequest-PDU.
1212
-
1213
- 4.2.6. The SNMPv2-Trap-PDU
1214
-
1215
- An SNMPv2-Trap-PDU is generated and transmitted by an SNMP entity on
1216
- behalf of a notification originator application. The SNMPv2-Trap-PDU
1217
- is often used to notify a notification receiver application at a
1218
- logically remote SNMP entity that an event has occurred or that a
1219
- condition is present. There is no confirmation associated with this
1220
- notification delivery mechanism.
1221
-
1222
- The destination(s) to which an SNMPv2-Trap-PDU is sent is determined
1223
- in an implementation-dependent fashion by the SNMP entity. The first
1224
- two variable bindings in the variable binding list of an SNMPv2-
1225
- Trap-PDU are sysUpTime.0 [RFC3418] and snmpTrapOID.0 [RFC3418]
1226
- respectively. If the OBJECTS clause is present in the invocation of
1227
- the corresponding NOTIFICATION-TYPE macro, then each corresponding
1228
- variable, as instantiated by this notification, is copied, in order,
1229
-
1230
-
1231
-
1232
-
1233
-
1234
- Presuhn, et al. Standards Track [Page 22]
1235
-
1236
- RFC 3416 Protocol Operations for SNMP December 2002
1237
-
1238
-
1239
- to the variable-bindings field. If any additional variables are
1240
- being included (at the option of the generating SNMP entity), then
1241
- each is copied to the variable-bindings field.
1242
-
1243
- 4.2.7. The InformRequest-PDU
1244
-
1245
- An InformRequest-PDU is generated and transmitted by an SNMP entity
1246
- on behalf of a notification originator application. The
1247
- InformRequest-PDU is often used to notify a notification receiver
1248
- application that an event has occurred or that a condition is
1249
- present. This is a confirmed notification delivery mechanism,
1250
- although there is, of course, no guarantee of delivery.
1251
-
1252
- The destination(s) to which an InformRequest-PDU is sent is specified
1253
- by the notification originator application. The first two variable
1254
- bindings in the variable binding list of an InformRequest-PDU are
1255
- sysUpTime.0 [RFC3418] and snmpTrapOID.0 [RFC3418] respectively. If
1256
- the OBJECTS clause is present in the invocation of the corresponding
1257
- NOTIFICATION-TYPE macro, then each corresponding variable, as
1258
- instantiated by this notification, is copied, in order, to the
1259
- variable-bindings field. If any additional variables are being
1260
- included (at the option of the generating SNMP entity), then each is
1261
- copied to the variable-bindings field.
1262
-
1263
- Upon receipt of an InformRequest-PDU, the receiving SNMP entity
1264
- determines the size of a message encapsulating a Response-PDU with
1265
- the same values in its request-id, error-status, error-index and
1266
- variable-bindings fields as the received InformRequest-PDU. If the
1267
- determined message size is greater than either a local constraint or
1268
- the maximum message size of the originator, then an alternate
1269
- Response-PDU is generated, transmitted to the originator of the
1270
- InformRequest-PDU, and processing of the InformRequest-PDU terminates
1271
- immediately thereafter. This alternate Response-PDU is formatted
1272
- with the same values in its request-id field as the received
1273
- InformRequest-PDU, with the value of its error-status field set to
1274
- "tooBig", the value of its error-index field set to zero, and an
1275
- empty variable-bindings field. This alternate Response-PDU is then
1276
- encapsulated into a message. If the size of the resultant message is
1277
- less than or equal to both a local constraint and the maximum message
1278
- size of the originator, it is transmitted to the originator of the
1279
- InformRequest-PDU. Otherwise, the snmpSilentDrops [RFC3418] counter
1280
- is incremented and the resultant message is discarded. Regardless,
1281
- processing of the InformRequest-PDU terminates.
1282
-
1283
- Otherwise, the receiving SNMP entity:
1284
-
1285
- (1) presents its contents to the appropriate application;
1286
-
1287
-
1288
-
1289
-
1290
- Presuhn, et al. Standards Track [Page 23]
1291
-
1292
- RFC 3416 Protocol Operations for SNMP December 2002
1293
-
1294
-
1295
- (2) generates a Response-PDU with the same values in its request-id
1296
- and variable-bindings fields as the received InformRequest-PDU,
1297
- with the value of its error-status field set to "noError" and
1298
- the value of its error-index field set to zero; and
1299
-
1300
- (3) transmits the generated Response-PDU to the originator of the
1301
- InformRequest-PDU.
1302
-
1303
- 5. Notice on Intellectual Property
1304
-
1305
- The IETF takes no position regarding the validity or scope of any
1306
- intellectual property or other rights that might be claimed to
1307
- pertain to the implementation or use of the technology described in
1308
- this document or the extent to which any license under such rights
1309
- might or might not be available; neither does it represent that it
1310
- has made any effort to identify any such rights. Information on the
1311
- IETF's procedures with respect to rights in standards-track and
1312
- standards-related documentation can be found in BCP-11. Copies of
1313
- claims of rights made available for publication and any assurances of
1314
- licenses to be made available, or the result of an attempt made to
1315
- obtain a general license or permission for the use of such
1316
- proprietary rights by implementors or users of this specification can
1317
- be obtained from the IETF Secretariat.
1318
-
1319
- The IETF invites any interested party to bring to its attention any
1320
- copyrights, patents or patent applications, or other proprietary
1321
- rights which may cover technology that may be required to practice
1322
- this standard. Please address the information to the IETF Executive
1323
- Director.
1324
-
1325
- 6. Acknowledgments
1326
-
1327
- This document is the product of the SNMPv3 Working Group. Some
1328
- special thanks are in order to the following Working Group members:
1329
-
1330
- Randy Bush
1331
- Jeffrey D. Case
1332
- Mike Daniele
1333
- Rob Frye
1334
- Lauren Heintz
1335
- Keith McCloghrie
1336
- Russ Mundy
1337
- David T. Perkins
1338
- Randy Presuhn
1339
- Aleksey Romanov
1340
- Juergen Schoenwaelder
1341
- Bert Wijnen
1342
-
1343
-
1344
-
1345
-
1346
- Presuhn, et al. Standards Track [Page 24]
1347
-
1348
- RFC 3416 Protocol Operations for SNMP December 2002
1349
-
1350
-
1351
- This version of the document, edited by Randy Presuhn, was initially
1352
- based on the work of a design team whose members were:
1353
-
1354
- Jeffrey D. Case
1355
- Keith McCloghrie
1356
- David T. Perkins
1357
- Randy Presuhn
1358
- Juergen Schoenwaelder
1359
-
1360
- The previous versions of this document, edited by Keith McCloghrie,
1361
- was the result of significant work by four major contributors:
1362
-
1363
- Jeffrey D. Case
1364
- Keith McCloghrie
1365
- Marshall T. Rose
1366
- Steven Waldbusser
1367
-
1368
- Additionally, the contributions of the SNMPv2 Working Group to the
1369
- previous versions are also acknowledged. In particular, a special
1370
- thanks is extended for the contributions of:
1371
-
1372
- Alexander I. Alten
1373
- Dave Arneson
1374
- Uri Blumenthal
1375
- Doug Book
1376
- Kim Curran
1377
- Jim Galvin
1378
- Maria Greene
1379
- Iain Hanson
1380
- Dave Harrington
1381
- Nguyen Hien
1382
- Jeff Johnson
1383
- Michael Kornegay
1384
- Deirdre Kostick
1385
- David Levi
1386
- Daniel Mahoney
1387
- Bob Natale
1388
- Brian O'Keefe
1389
- Andrew Pearson
1390
- Dave Perkins
1391
- Randy Presuhn
1392
- Aleksey Romanov
1393
- Shawn Routhier
1394
- Jon Saperia
1395
- Juergen Schoenwaelder
1396
- Bob Stewart
1397
-
1398
-
1399
-
1400
-
1401
-
1402
- Presuhn, et al. Standards Track [Page 25]
1403
-
1404
- RFC 3416 Protocol Operations for SNMP December 2002
1405
-
1406
-
1407
- Kaj Tesink
1408
- Glenn Waters
1409
- Bert Wijnen
1410
-
1411
- 7. Security Considerations
1412
-
1413
- The protocol defined in this document by itself does not provide a
1414
- secure environment. Even if the network itself is secure (for
1415
- example by using IPSec), there is no control as to who on the secure
1416
- network is allowed access to management information.
1417
-
1418
- It is recommended that the implementors consider the security
1419
- features as provided by the SNMPv3 framework. Specifically, the use
1420
- of the User-based Security Model STD 62, RFC 3414 [RFC3414] and the
1421
- View-based Access Control Model STD 62, RFC 3415 [RFC3415] is
1422
- recommended.
1423
-
1424
- It is then a customer/user responsibility to ensure that the SNMP
1425
- entity is properly configured so that:
1426
-
1427
- - only those principals (users) having legitimate rights can
1428
- access or modify the values of any MIB objects supported by
1429
- that entity;
1430
-
1431
- - the occurrence of particular events on the entity will be
1432
- communicated appropriately;
1433
-
1434
- - the entity responds appropriately and with due credence to
1435
- events and information that have been communicated to it.
1436
-
1437
- 8. References
1438
-
1439
- 8.1. Normative References
1440
-
1441
- [RFC768] Postel, J., "User Datagram Protocol", STD 6, RFC 768,
1442
- August 1980.
1443
-
1444
- [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
1445
- Rose, M. and S. Waldbusser, "Structure of Management
1446
- Information Version 2 (SMIv2)", STD 58, RFC 2578, April
1447
- 1999.
1448
-
1449
- [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
1450
- Rose, M. and S. Waldbusser, "Textual Conventions for
1451
- SMIv2", STD 58, RFC 2579, April 1999.
1452
-
1453
-
1454
-
1455
-
1456
-
1457
-
1458
- Presuhn, et al. Standards Track [Page 26]
1459
-
1460
- RFC 3416 Protocol Operations for SNMP December 2002
1461
-
1462
-
1463
- [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
1464
- Rose, M. and S. Waldbusser, "Conformance Statements for
1465
- SMIv2", STD 58, RFC 2580, April 1999.
1466
-
1467
- [RFC3411] Harrington, D., Presuhn, R. and B. Wijnen, "An
1468
- Architecture for Describing Simple Network Management
1469
- Protocol (SNMP) Management Frameworks", STD 62, RFC 3411,
1470
- December 2002.
1471
-
1472
- [RFC3412] Case, J., Harrington, D., Presuhn, R. and B. Wijnen,
1473
- "Message Processing and Dispatching for the Simple
1474
- Network Management Protocol (SNMP)", STD 62, RFC 3412,
1475
- December 2002.
1476
-
1477
- [RFC3413] Levi, D., Meyer, P. and B. Stewart, "Simple Network
1478
- Management Protocol (SNMP) Applications", STD 62, RFC
1479
- 3413, December 2002.
1480
-
1481
- [RFC3414] Blumenthal, U. and B. Wijnen, "The User-Based Security
1482
- Model (USM) for Version 3 of the Simple Network
1483
- Management Protocol (SNMPv3)", STD 62, RFC 3414, December
1484
- 2002.
1485
-
1486
- [RFC3415] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based
1487
- Access Control Model (VACM) for the Simple Network
1488
- Management Protocol (SNMP)", STD 62, RFC 3415, December
1489
- 2002.
1490
-
1491
- [RFC3417] Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S.
1492
- Waldbusser, "Transport Mappings for the Simple Network
1493
- Management Protocol", STD 62, RFC 3417, December 2002.
1494
-
1495
- [RFC3418] Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S.
1496
- Waldbusser, "Management Information Base (MIB) for the
1497
- Simple Network Management Protocol (SNMP)", STD 62, RFC
1498
- 3418, December 2002.
1499
-
1500
- [ASN1] Information processing systems - Open Systems
1501
- Interconnection - Specification of Abstract Syntax
1502
- Notation One (ASN.1), International Organization for
1503
- Standardization. International Standard 8824, December
1504
- 1987.
1505
-
1506
- 8.2. Informative References
1507
-
1508
- [FRAG] Kent, C. and J. Mogul, "Fragmentation Considered
1509
- Harmful," Proceedings, ACM SIGCOMM '87, Stowe, VT, August
1510
- 1987.
1511
-
1512
-
1513
-
1514
- Presuhn, et al. Standards Track [Page 27]
1515
-
1516
- RFC 3416 Protocol Operations for SNMP December 2002
1517
-
1518
-
1519
- [RFC1155] Rose, M. and K. McCloghrie, "Structure and Identification
1520
- of Management Information for TCP/IP-based Internets",
1521
- STD 16, RFC 1155, May 1990.
1522
-
1523
- [RFC1157] Case, J., Fedor, M., Schoffstall, M. and J. Davin,
1524
- "Simple Network Management Protocol", STD 15, RFC 1157,
1525
- May 1990.
1526
-
1527
- [RFC1212] Rose, M. and K. McCloghrie, "Concise MIB Definitions",
1528
- STD 16, RFC 1212, March 1991.
1529
-
1530
- [RFC1213] McCloghrie, K. and M. Rose, Editors, "Management
1531
- Information Base for Network Management of TCP/IP-based
1532
- internets: MIB-II", STD 17, RFC 1213, March 1991.
1533
-
1534
- [RFC1215] Rose, M., "A Convention for Defining Traps for use with
1535
- the SNMP", RFC 1215, March 1991.
1536
-
1537
- [RFC1901] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
1538
- "Introduction to Community-based SNMPv2", RFC 1901,
1539
- January 1996.
1540
-
1541
- [RFC2576] Frye, R., Levi, D., Routhier, S. and B. Wijnen,
1542
- "Coexistence between Version 1, Version 2, and Version 3
1543
- of the Internet-Standard Network Management Framework",
1544
- RFC 2576, March 2000.
1545
-
1546
- [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group
1547
- MIB", RFC 2863, June 2000.
1548
-
1549
- [RFC2914] Floyd, S., "Congestion Control Principles", BCP 41, RFC
1550
- 2914, September 2000.
1551
-
1552
- [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart,
1553
- "Introduction and Applicability Statements for Internet-
1554
- Standard Management Framework", RFC 3410, December 2002.
1555
-
1556
- 9. Changes from RFC 1905
1557
-
1558
- These are the changes from RFC 1905:
1559
-
1560
- - Corrected spelling error in copyright statement;
1561
-
1562
- - Updated copyright date;
1563
-
1564
- - Updated with new editor's name and contact information;
1565
-
1566
- - Added notice on intellectual property;
1567
-
1568
-
1569
-
1570
- Presuhn, et al. Standards Track [Page 28]
1571
-
1572
- RFC 3416 Protocol Operations for SNMP December 2002
1573
-
1574
-
1575
- - Cosmetic fixes to layout and typography;
1576
-
1577
- - Added table of contents;
1578
-
1579
- - Title changed;
1580
-
1581
- - Updated document headers and footers;
1582
-
1583
- - Deleted the old clause 2.3, entitled "Access to Management
1584
- Information";
1585
-
1586
- - Changed the way in which request-id was defined, though with
1587
- the same ultimate syntax and semantics, to avoid coupling with
1588
- SMI. This does not affect the protocol in any way;
1589
-
1590
- - Replaced the word "exception" with the word "error" in the old
1591
- clause 4.1. This does not affect the protocol in any way;
1592
-
1593
- - Deleted the first two paragraphs of the old clause 4.2;
1594
-
1595
- - Clarified the maximum number of variable bindings that an
1596
- implementation must support in a PDU. This does not affect the
1597
- protocol in any way;
1598
-
1599
- - Replaced occurrences of "SNMPv2 application" with
1600
- "application";
1601
-
1602
- - Deleted three sentences in old clause 4.2.3 describing the
1603
- handling of an impossible situation. This does not affect the
1604
- protocol in any way;
1605
-
1606
- - Clarified the use of the SNMPv2-Trap-Pdu in the old clause
1607
- 4.2.6. This does not affect the protocol in any way;
1608
-
1609
- - Aligned description of the use of the InformRequest-Pdu in old
1610
- clause 4.2.7 with the architecture. This does not affect the
1611
- protocol in any way;
1612
-
1613
- - Updated references;
1614
-
1615
- - Re-wrote introduction clause;
1616
-
1617
- - Replaced manager/agent/SNMPv2 entity terminology with
1618
- terminology from RFC 2571. This does not affect the protocol
1619
- in any way;
1620
-
1621
- - Eliminated IMPORTS from the SMI, replaced with equivalent in-
1622
- line ASN.1. This does not affect the protocol in any way;
1623
-
1624
-
1625
-
1626
- Presuhn, et al. Standards Track [Page 29]
1627
-
1628
- RFC 3416 Protocol Operations for SNMP December 2002
1629
-
1630
-
1631
- - Added notes calling attention to two different manifestations
1632
- of reaching the end of a table in the table walk examples;
1633
-
1634
- - Added content to security considerations clause;
1635
-
1636
- - Updated ASN.1 comment on use of Report-PDU. This does not
1637
- affect the protocol in any way;
1638
-
1639
- - Updated acknowledgments section;
1640
-
1641
- - Included information on handling of BITS;
1642
-
1643
- - Deleted spurious comma in ASN.1 definition of PDUs;
1644
-
1645
- - Added abstract;
1646
-
1647
- - Made handling of additional variable bindings in informs
1648
- consistent with that for traps. This was a correction of an
1649
- editorial oversight, and reflects implementation practice;
1650
-
1651
- - Added reference to RFC 2914.
1652
-
1653
- 10. Editor's Address
1654
-
1655
- Randy Presuhn
1656
- BMC Software, Inc.
1657
- 2141 North First Street
1658
- San Jose, CA 95131
1659
- USA
1660
-
1661
- Phone: +1 408 546 1006
1662
- EMail: randy_presuhn@bmc.com
1663
-
1664
-
1665
-
1666
-
1667
-
1668
-
1669
-
1670
-
1671
-
1672
-
1673
-
1674
-
1675
-
1676
-
1677
-
1678
-
1679
-
1680
-
1681
-
1682
- Presuhn, et al. Standards Track [Page 30]
1683
-
1684
- RFC 3416 Protocol Operations for SNMP December 2002
1685
-
1686
-
1687
- 11. Full Copyright Statement
1688
-
1689
- Copyright (C) The Internet Society (2002). All Rights Reserved.
1690
-
1691
- This document and translations of it may be copied and furnished to
1692
- others, and derivative works that comment on or otherwise explain it
1693
- or assist in its implementation may be prepared, copied, published
1694
- and distributed, in whole or in part, without restriction of any
1695
- kind, provided that the above copyright notice and this paragraph are
1696
- included on all such copies and derivative works. However, this
1697
- document itself may not be modified in any way, such as by removing
1698
- the copyright notice or references to the Internet Society or other
1699
- Internet organizations, except as needed for the purpose of
1700
- developing Internet standards in which case the procedures for
1701
- copyrights defined in the Internet Standards process must be
1702
- followed, or as required to translate it into languages other than
1703
- English.
1704
-
1705
- The limited permissions granted above are perpetual and will not be
1706
- revoked by the Internet Society or its successors or assigns.
1707
-
1708
- This document and the information contained herein is provided on an
1709
- "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
1710
- TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
1711
- BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
1712
- HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
1713
- MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
1714
-
1715
- Acknowledgement
1716
-
1717
- Funding for the RFC Editor function is currently provided by the
1718
- Internet Society.
1719
-
1720
-
1721
-
1722
-
1723
-
1724
-
1725
-
1726
-
1727
-
1728
-
1729
-
1730
-
1731
-
1732
-
1733
-
1734
-
1735
-
1736
-
1737
-
1738
- Presuhn, et al. Standards Track [Page 31]
1739
-
1
+
2
+
3
+
4
+
5
+
6
+
7
+ Network Working Group Editor of this version:
8
+ Request for Comments: 3416 R. Presuhn
9
+ STD: 62 BMC Software, Inc.
10
+ Obsoletes: 1905 Authors of previous version:
11
+ Category: Standards Track J. Case
12
+ SNMP Research, Inc.
13
+ K. McCloghrie
14
+ Cisco Systems, Inc.
15
+ M. Rose
16
+ Dover Beach Consulting, Inc.
17
+ S. Waldbusser
18
+ International Network Services
19
+ December 2002
20
+
21
+
22
+ Version 2 of the Protocol Operations for
23
+ the Simple Network Management Protocol (SNMP)
24
+
25
+ Status of this Memo
26
+
27
+ This document specifies an Internet standards track protocol for the
28
+ Internet community, and requests discussion and suggestions for
29
+ improvements. Please refer to the current edition of the "Internet
30
+ Official Protocol Standards" (STD 1) for the standardization state
31
+ and status of this protocol. Distribution of this memo is unlimited.
32
+
33
+ Copyright Notice
34
+
35
+ Copyright (C) The Internet Society (2002). All Rights Reserved.
36
+
37
+ Abstract
38
+
39
+ This document defines version 2 of the protocol operations for the
40
+ Simple Network Management Protocol (SNMP). It defines the syntax and
41
+ elements of procedure for sending, receiving, and processing SNMP
42
+ PDUs. This document obsoletes RFC 1905.
43
+
44
+
45
+
46
+
47
+
48
+
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+ Presuhn, et al. Standards Track [Page 1]
59
+
60
+ RFC 3416 Protocol Operations for SNMP December 2002
61
+
62
+
63
+ Table of Contents
64
+
65
+ 1. Introduction ................................................ 3
66
+ 2. Overview .................................................... 4
67
+ 2.1. Management Information .................................... 4
68
+ 2.2. Retransmission of Requests ................................ 4
69
+ 2.3. Message Sizes ............................................. 4
70
+ 2.4. Transport Mappings ........................................ 5
71
+ 2.5. SMIv2 Data Type Mappings .................................. 6
72
+ 3. Definitions ................................................. 6
73
+ 4. Protocol Specification ...................................... 9
74
+ 4.1. Common Constructs ......................................... 9
75
+ 4.2. PDU Processing ............................................ 10
76
+ 4.2.1. The GetRequest-PDU ...................................... 10
77
+ 4.2.2. The GetNextRequest-PDU .................................. 11
78
+ 4.2.2.1. Example of Table Traversal ............................ 12
79
+ 4.2.3. The GetBulkRequest-PDU .................................. 14
80
+ 4.2.3.1. Another Example of Table Traversal .................... 17
81
+ 4.2.4. The Response-PDU ........................................ 18
82
+ 4.2.5. The SetRequest-PDU ...................................... 19
83
+ 4.2.6. The SNMPv2-Trap-PDU ..................................... 22
84
+ 4.2.7. The InformRequest-PDU ................................... 23
85
+ 5. Notice on Intellectual Property ............................. 24
86
+ 6. Acknowledgments ............................................. 24
87
+ 7. Security Considerations ..................................... 26
88
+ 8. References .................................................. 26
89
+ 8.1. Normative References ...................................... 26
90
+ 8.2. Informative References .................................... 27
91
+ 9. Changes from RFC 1905 ....................................... 28
92
+ 10. Editor's Address ........................................... 30
93
+ 11. Full Copyright Statement ................................... 31
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+ Presuhn, et al. Standards Track [Page 2]
115
+
116
+ RFC 3416 Protocol Operations for SNMP December 2002
117
+
118
+
119
+ 1. Introduction
120
+
121
+ The SNMP Management Framework at the time of this writing consists of
122
+ five major components:
123
+
124
+ - An overall architecture, described in STD 62, RFC 3411
125
+ [RFC3411].
126
+
127
+ - Mechanisms for describing and naming objects and events for the
128
+ purpose of management. The first version of this Structure of
129
+ Management Information (SMI) is called SMIv1 and described in
130
+ STD 16, RFC 1155 [RFC1155], STD 16, RFC 1212 [RFC1212] and RFC
131
+ 1215 [RFC1215]. The second version, called SMIv2, is described
132
+ in STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and
133
+ STD 58, RFC 2580 [RFC2580].
134
+
135
+ - Message protocols for transferring management information. The
136
+ first version of the SNMP message protocol is called SNMPv1 and
137
+ described in STD 15, RFC 1157 [RFC1157]. A second version of
138
+ the SNMP message protocol, which is not an Internet standards
139
+ track protocol, is called SNMPv2c and described in RFC 1901
140
+ [RFC1901] and STD 62, RFC 3417 [RFC3417]. The third version of
141
+ the message protocol is called SNMPv3 and described in STD 62,
142
+ RFC 3417 [RFC3417], RFC 3412 [RFC3412] and RFC 3414 [RFC3414].
143
+
144
+ - Protocol operations for accessing management information. The
145
+ first set of protocol operations and associated PDU formats is
146
+ described in STD 15, RFC 1157 [RFC1157]. A second set of
147
+ protocol operations and associated PDU formats is described in
148
+ this document.
149
+
150
+ - A set of fundamental applications described in STD 62, RFC 3413
151
+ [RFC3413] and the view-based access control mechanism described
152
+ in STD 62, RFC 3415 [RFC3415].
153
+
154
+ A more detailed introduction to the SNMP Management Framework at the
155
+ time of this writing can be found in RFC 3410 [RFC3410].
156
+
157
+ Managed objects are accessed via a virtual information store, termed
158
+ the Management Information Base or MIB. Objects in the MIB are
159
+ defined using the mechanisms defined in the SMI.
160
+
161
+ This document, Version 2 of the Protocol Operations for the Simple
162
+ Network Management Protocol, defines the operations of the protocol
163
+ with respect to the sending and receiving of PDUs to be carried by
164
+ the message protocol.
165
+
166
+
167
+
168
+
169
+
170
+ Presuhn, et al. Standards Track [Page 3]
171
+
172
+ RFC 3416 Protocol Operations for SNMP December 2002
173
+
174
+
175
+ 2. Overview
176
+
177
+ SNMP entities supporting command generator or notification receiver
178
+ applications (traditionally called "managers") communicate with SNMP
179
+ entities supporting command responder or notification originator
180
+ applications (traditionally called "agents"). The purpose of this
181
+ protocol is the transport of management information and operations.
182
+
183
+ 2.1. Management Information
184
+
185
+ The term "variable" refers to an instance of a non-aggregate object
186
+ type defined according to the conventions set forth in the SMI
187
+ [RFC2578] or the textual conventions based on the SMI [RFC2579]. The
188
+ term "variable binding" normally refers to the pairing of the name of
189
+ a variable and its associated value. However, if certain kinds of
190
+ exceptional conditions occur during processing of a retrieval
191
+ request, a variable binding will pair a name and an indication of
192
+ that exception.
193
+
194
+ A variable-binding list is a simple list of variable bindings.
195
+
196
+ The name of a variable is an OBJECT IDENTIFIER which is the
197
+ concatenation of the OBJECT IDENTIFIER of the corresponding object-
198
+ type together with an OBJECT IDENTIFIER fragment identifying the
199
+ instance. The OBJECT IDENTIFIER of the corresponding object-type is
200
+ called the OBJECT IDENTIFIER prefix of the variable.
201
+
202
+ 2.2. Retransmission of Requests
203
+
204
+ For all types of request in this protocol, the receiver is required
205
+ under normal circumstances, to generate and transmit a response to
206
+ the originator of the request. Whether or not a request should be
207
+ retransmitted if no corresponding response is received in an
208
+ appropriate time interval, is at the discretion of the application
209
+ originating the request. This will normally depend on the urgency of
210
+ the request. However, such an application needs to act responsibly
211
+ in respect to the frequency and duration of re-transmissions. See
212
+ BCP 41 [RFC2914] for discussion of relevant congestion control
213
+ principles.
214
+
215
+ 2.3. Message Sizes
216
+
217
+ The maximum size of an SNMP message is limited to the minimum of:
218
+
219
+ (1) the maximum message size which the destination SNMP entity can
220
+ accept; and,
221
+
222
+
223
+
224
+
225
+
226
+ Presuhn, et al. Standards Track [Page 4]
227
+
228
+ RFC 3416 Protocol Operations for SNMP December 2002
229
+
230
+
231
+ (2) the maximum message size which the source SNMP entity can
232
+ generate.
233
+
234
+ The former may be known on a per-recipient basis; and in the absence
235
+ of such knowledge, is indicated by transport domain used when sending
236
+ the message. The latter is imposed by implementation-specific local
237
+ constraints.
238
+
239
+ Each transport mapping for the SNMP indicates the minimum message
240
+ size which a SNMP implementation must be able to produce or consume.
241
+ Although implementations are encouraged to support larger values
242
+ whenever possible, a conformant implementation must never generate
243
+ messages larger than allowed by the receiving SNMP entity.
244
+
245
+ One of the aims of the GetBulkRequest-PDU, specified in this
246
+ protocol, is to minimize the number of protocol exchanges required to
247
+ retrieve a large amount of management information. As such, this PDU
248
+ type allows an SNMP entity supporting command generator applications
249
+ to request that the response be as large as possible given the
250
+ constraints on message sizes. These constraints include the limits
251
+ on the size of messages which the SNMP entity supporting command
252
+ responder applications can generate, and the SNMP entity supporting
253
+ command generator applications can receive.
254
+
255
+ However, it is possible that such maximum sized messages may be
256
+ larger than the Path MTU of the path across the network traversed by
257
+ the messages. In this situation, such messages are subject to
258
+ fragmentation. Fragmentation is generally considered to be harmful
259
+ [FRAG], since among other problems, it leads to a decrease in the
260
+ reliability of the transfer of the messages. Thus, an SNMP entity
261
+ which sends a GetBulkRequest-PDU must take care to set its parameters
262
+ accordingly, so as to reduce the risk of fragmentation. In
263
+ particular, under conditions of network stress, only small values
264
+ should be used for max-repetitions.
265
+
266
+ 2.4. Transport Mappings
267
+
268
+ It is important to note that the exchange of SNMP messages requires
269
+ only an unreliable datagram service, with every message being
270
+ entirely and independently contained in a single transport datagram.
271
+ Specific transport mappings and encoding rules are specified
272
+ elsewhere [RFC3417]. However, the preferred mapping is the use of
273
+ the User Datagram Protocol [RFC768].
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+ Presuhn, et al. Standards Track [Page 5]
283
+
284
+ RFC 3416 Protocol Operations for SNMP December 2002
285
+
286
+
287
+ 2.5. SMIv2 Data Type Mappings
288
+
289
+ The SMIv2 [RFC2578] defines 11 base types (INTEGER, OCTET STRING,
290
+ OBJECT IDENTIFIER, Integer32, IpAddress, Counter32, Gauge32,
291
+ Unsigned32, TimeTicks, Opaque, Counter64) and the BITS construct.
292
+ The SMIv2 base types are mapped to the corresponding selection type
293
+ in the SimpleSyntax and ApplicationSyntax choices of the ASN.1 SNMP
294
+ protocol definition. Note that the INTEGER and Integer32 SMIv2 base
295
+ types are mapped to the integer-value selection type of the
296
+ SimpleSyntax choice. Similarly, the Gauge32 and Unsigned32 SMIv2
297
+ base types are mapped to the unsigned-integer-value selection type of
298
+ the ApplicationSyntax choice.
299
+
300
+ The SMIv2 BITS construct is mapped to the string-value selection type
301
+ of the SimpleSyntax choice. A BITS value is encoded as an OCTET
302
+ STRING, in which all the named bits in (the definition of) the
303
+ bitstring, commencing with the first bit and proceeding to the last
304
+ bit, are placed in bits 8 (high order bit) to 1 (low order bit) of
305
+ the first octet, followed by bits 8 to 1 of each subsequent octet in
306
+ turn, followed by as many bits as are needed of the final subsequent
307
+ octet, commencing with bit 8. Remaining bits, if any, of the final
308
+ octet are set to zero on generation and ignored on receipt.
309
+
310
+ 3. Definitions
311
+
312
+ The PDU syntax is defined using ASN.1 notation [ASN1].
313
+
314
+ SNMPv2-PDU DEFINITIONS ::= BEGIN
315
+
316
+ ObjectName ::= OBJECT IDENTIFIER
317
+
318
+ ObjectSyntax ::= CHOICE {
319
+ simple SimpleSyntax,
320
+ application-wide ApplicationSyntax }
321
+
322
+ SimpleSyntax ::= CHOICE {
323
+ integer-value INTEGER (-2147483648..2147483647),
324
+ string-value OCTET STRING (SIZE (0..65535)),
325
+ objectID-value OBJECT IDENTIFIER }
326
+
327
+ ApplicationSyntax ::= CHOICE {
328
+ ipAddress-value IpAddress,
329
+ counter-value Counter32,
330
+ timeticks-value TimeTicks,
331
+ arbitrary-value Opaque,
332
+ big-counter-value Counter64,
333
+ unsigned-integer-value Unsigned32 }
334
+
335
+
336
+
337
+
338
+ Presuhn, et al. Standards Track [Page 6]
339
+
340
+ RFC 3416 Protocol Operations for SNMP December 2002
341
+
342
+
343
+ IpAddress ::= [APPLICATION 0] IMPLICIT OCTET STRING (SIZE (4))
344
+
345
+ Counter32 ::= [APPLICATION 1] IMPLICIT INTEGER (0..4294967295)
346
+
347
+ Unsigned32 ::= [APPLICATION 2] IMPLICIT INTEGER (0..4294967295)
348
+
349
+ Gauge32 ::= Unsigned32
350
+
351
+ TimeTicks ::= [APPLICATION 3] IMPLICIT INTEGER (0..4294967295)
352
+
353
+ Opaque ::= [APPLICATION 4] IMPLICIT OCTET STRING
354
+
355
+ Counter64 ::= [APPLICATION 6]
356
+ IMPLICIT INTEGER (0..18446744073709551615)
357
+
358
+ -- protocol data units
359
+
360
+ PDUs ::= CHOICE {
361
+ get-request GetRequest-PDU,
362
+ get-next-request GetNextRequest-PDU,
363
+ get-bulk-request GetBulkRequest-PDU,
364
+ response Response-PDU,
365
+ set-request SetRequest-PDU,
366
+ inform-request InformRequest-PDU,
367
+ snmpV2-trap SNMPv2-Trap-PDU,
368
+ report Report-PDU }
369
+
370
+ -- PDUs
371
+
372
+ GetRequest-PDU ::= [0] IMPLICIT PDU
373
+
374
+ GetNextRequest-PDU ::= [1] IMPLICIT PDU
375
+
376
+ Response-PDU ::= [2] IMPLICIT PDU
377
+
378
+ SetRequest-PDU ::= [3] IMPLICIT PDU
379
+
380
+ -- [4] is obsolete
381
+
382
+ GetBulkRequest-PDU ::= [5] IMPLICIT BulkPDU
383
+
384
+ InformRequest-PDU ::= [6] IMPLICIT PDU
385
+
386
+ SNMPv2-Trap-PDU ::= [7] IMPLICIT PDU
387
+
388
+ -- Usage and precise semantics of Report-PDU are not defined
389
+ -- in this document. Any SNMP administrative framework making
390
+ -- use of this PDU must define its usage and semantics.
391
+
392
+
393
+
394
+ Presuhn, et al. Standards Track [Page 7]
395
+
396
+ RFC 3416 Protocol Operations for SNMP December 2002
397
+
398
+
399
+ Report-PDU ::= [8] IMPLICIT PDU
400
+
401
+ max-bindings INTEGER ::= 2147483647
402
+
403
+ PDU ::= SEQUENCE {
404
+ request-id INTEGER (-214783648..214783647),
405
+
406
+ error-status -- sometimes ignored
407
+ INTEGER {
408
+ noError(0),
409
+ tooBig(1),
410
+ noSuchName(2), -- for proxy compatibility
411
+ badValue(3), -- for proxy compatibility
412
+ readOnly(4), -- for proxy compatibility
413
+ genErr(5),
414
+ noAccess(6),
415
+ wrongType(7),
416
+ wrongLength(8),
417
+ wrongEncoding(9),
418
+ wrongValue(10),
419
+ noCreation(11),
420
+ inconsistentValue(12),
421
+ resourceUnavailable(13),
422
+ commitFailed(14),
423
+ undoFailed(15),
424
+ authorizationError(16),
425
+ notWritable(17),
426
+ inconsistentName(18)
427
+ },
428
+
429
+ error-index -- sometimes ignored
430
+ INTEGER (0..max-bindings),
431
+
432
+ variable-bindings -- values are sometimes ignored
433
+ VarBindList
434
+ }
435
+
436
+ BulkPDU ::= -- must be identical in
437
+ SEQUENCE { -- structure to PDU
438
+ request-id INTEGER (-214783648..214783647),
439
+ non-repeaters INTEGER (0..max-bindings),
440
+ max-repetitions INTEGER (0..max-bindings),
441
+
442
+ variable-bindings -- values are ignored
443
+ VarBindList
444
+ }
445
+
446
+ -- variable binding
447
+
448
+
449
+
450
+ Presuhn, et al. Standards Track [Page 8]
451
+
452
+ RFC 3416 Protocol Operations for SNMP December 2002
453
+
454
+
455
+ VarBind ::= SEQUENCE {
456
+ name ObjectName,
457
+
458
+ CHOICE {
459
+ value ObjectSyntax,
460
+ unSpecified NULL, -- in retrieval requests
461
+
462
+ -- exceptions in responses
463
+ noSuchObject [0] IMPLICIT NULL,
464
+ noSuchInstance [1] IMPLICIT NULL,
465
+ endOfMibView [2] IMPLICIT NULL
466
+ }
467
+ }
468
+
469
+ -- variable-binding list
470
+
471
+ VarBindList ::= SEQUENCE (SIZE (0..max-bindings)) OF VarBind
472
+
473
+ END
474
+
475
+ 4. Protocol Specification
476
+
477
+ 4.1. Common Constructs
478
+
479
+ The value of the request-id field in a Response-PDU takes the value
480
+ of the request-id field in the request PDU to which it is a response.
481
+ By use of the request-id value, an application can distinguish the
482
+ (potentially multiple) outstanding requests, and thereby correlate
483
+ incoming responses with outstanding requests. In cases where an
484
+ unreliable datagram service is used, the request-id also provides a
485
+ simple means of identifying messages duplicated by the network. Use
486
+ of the same request-id on a retransmission of a request allows the
487
+ response to either the original transmission or the retransmission to
488
+ satisfy the request. However, in order to calculate the round trip
489
+ time for transmission and processing of a request-response
490
+ transaction, the application needs to use a different request-id
491
+ value on a retransmitted request. The latter strategy is recommended
492
+ for use in the majority of situations.
493
+
494
+ A non-zero value of the error-status field in a Response-PDU is used
495
+ to indicate that an error occurred to prevent the processing of the
496
+ request. In these cases, a non-zero value of the Response-PDU's
497
+ error-index field provides additional information by identifying
498
+ which variable binding in the list caused the error. A variable
499
+ binding is identified by its index value. The first variable binding
500
+ in a variable-binding list is index one, the second is index two,
501
+ etc.
502
+
503
+
504
+
505
+
506
+ Presuhn, et al. Standards Track [Page 9]
507
+
508
+ RFC 3416 Protocol Operations for SNMP December 2002
509
+
510
+
511
+ SNMP limits OBJECT IDENTIFIER values to a maximum of 128 sub-
512
+ identifiers, where each sub-identifier has a maximum value of
513
+ 2**32-1.
514
+
515
+ 4.2. PDU Processing
516
+
517
+ In the elements of procedure below, any field of a PDU which is not
518
+ referenced by the relevant procedure is ignored by the receiving SNMP
519
+ entity. However, all components of a PDU, including those whose
520
+ values are ignored by the receiving SNMP entity, must have valid
521
+ ASN.1 syntax and encoding. For example, some PDUs (e.g., the
522
+ GetRequest-PDU) are concerned only with the name of a variable and
523
+ not its value. In this case, the value portion of the variable
524
+ binding is ignored by the receiving SNMP entity. The unSpecified
525
+ value is defined for use as the value portion of such bindings.
526
+
527
+ On generating a management communication, the message "wrapper" to
528
+ encapsulate the PDU is generated according to the "Elements of
529
+ Procedure" of the administrative framework in use. The definition of
530
+ "max-bindings" imposes an upper bound on the number of variable
531
+ bindings. In practice, the size of a message is also limited by
532
+ constraints on the maximum message size. A compliant implementation
533
+ must support as many variable bindings in a PDU or BulkPDU as fit
534
+ into the overall maximum message size limit of the SNMP engine, but
535
+ no more than 2147483647 variable bindings.
536
+
537
+ On receiving a management communication, the "Elements of Procedure"
538
+ of the administrative framework in use is followed, and if those
539
+ procedures indicate that the operation contained within the message
540
+ is to be performed locally, then those procedures also indicate the
541
+ MIB view which is visible to the operation.
542
+
543
+ 4.2.1. The GetRequest-PDU
544
+
545
+ A GetRequest-PDU is generated and transmitted at the request of an
546
+ application.
547
+
548
+ Upon receipt of a GetRequest-PDU, the receiving SNMP entity processes
549
+ each variable binding in the variable-binding list to produce a
550
+ Response-PDU. All fields of the Response-PDU have the same values as
551
+ the corresponding fields of the received request except as indicated
552
+ below. Each variable binding is processed as follows:
553
+
554
+ (1) If the variable binding's name exactly matches the name of a
555
+ variable accessible by this request, then the variable
556
+ binding's value field is set to the value of the named
557
+ variable.
558
+
559
+
560
+
561
+
562
+ Presuhn, et al. Standards Track [Page 10]
563
+
564
+ RFC 3416 Protocol Operations for SNMP December 2002
565
+
566
+
567
+ (2) Otherwise, if the variable binding's name does not have an
568
+ OBJECT IDENTIFIER prefix which exactly matches the OBJECT
569
+ IDENTIFIER prefix of any (potential) variable accessible by
570
+ this request, then its value field is set to "noSuchObject".
571
+
572
+ (3) Otherwise, the variable binding's value field is set to
573
+ "noSuchInstance".
574
+
575
+ If the processing of any variable binding fails for a reason other
576
+ than listed above, then the Response-PDU is re-formatted with the
577
+ same values in its request-id and variable-bindings fields as the
578
+ received GetRequest-PDU, with the value of its error-status field set
579
+ to "genErr", and the value of its error-index field is set to the
580
+ index of the failed variable binding.
581
+
582
+ Otherwise, the value of the Response-PDU's error-status field is set
583
+ to "noError", and the value of its error-index field is zero.
584
+
585
+ The generated Response-PDU is then encapsulated into a message. If
586
+ the size of the resultant message is less than or equal to both a
587
+ local constraint and the maximum message size of the originator, it
588
+ is transmitted to the originator of the GetRequest-PDU.
589
+
590
+ Otherwise, an alternate Response-PDU is generated. This alternate
591
+ Response-PDU is formatted with the same value in its request-id field
592
+ as the received GetRequest-PDU, with the value of its error-status
593
+ field set to "tooBig", the value of its error-index field set to
594
+ zero, and an empty variable-bindings field. This alternate
595
+ Response-PDU is then encapsulated into a message. If the size of the
596
+ resultant message is less than or equal to both a local constraint
597
+ and the maximum message size of the originator, it is transmitted to
598
+ the originator of the GetRequest-PDU. Otherwise, the snmpSilentDrops
599
+ [RFC3418] counter is incremented and the resultant message is
600
+ discarded.
601
+
602
+ 4.2.2. The GetNextRequest-PDU
603
+
604
+ A GetNextRequest-PDU is generated and transmitted at the request of
605
+ an application.
606
+
607
+ Upon receipt of a GetNextRequest-PDU, the receiving SNMP entity
608
+ processes each variable binding in the variable-binding list to
609
+ produce a Response-PDU. All fields of the Response-PDU have the same
610
+ values as the corresponding fields of the received request except as
611
+ indicated below. Each variable binding is processed as follows:
612
+
613
+ (1) The variable is located which is in the lexicographically
614
+ ordered list of the names of all variables which are
615
+
616
+
617
+
618
+ Presuhn, et al. Standards Track [Page 11]
619
+
620
+ RFC 3416 Protocol Operations for SNMP December 2002
621
+
622
+
623
+ accessible by this request and whose name is the first
624
+ lexicographic successor of the variable binding's name in
625
+ the incoming GetNextRequest-PDU. The corresponding variable
626
+ binding's name and value fields in the Response-PDU are set
627
+ to the name and value of the located variable.
628
+
629
+ (2) If the requested variable binding's name does not
630
+ lexicographically precede the name of any variable
631
+ accessible by this request, i.e., there is no lexicographic
632
+ successor, then the corresponding variable binding produced
633
+ in the Response-PDU has its value field set to
634
+ "endOfMibView", and its name field set to the variable
635
+ binding's name in the request.
636
+
637
+ If the processing of any variable binding fails for a reason other
638
+ than listed above, then the Response-PDU is re-formatted with the
639
+ same values in its request-id and variable-bindings fields as the
640
+ received GetNextRequest-PDU, with the value of its error-status field
641
+ set to "genErr", and the value of its error-index field is set to the
642
+ index of the failed variable binding.
643
+
644
+ Otherwise, the value of the Response-PDU's error-status field is set
645
+ to "noError", and the value of its error-index field is zero.
646
+
647
+ The generated Response-PDU is then encapsulated into a message. If
648
+ the size of the resultant message is less than or equal to both a
649
+ local constraint and the maximum message size of the originator, it
650
+ is transmitted to the originator of the GetNextRequest-PDU.
651
+
652
+ Otherwise, an alternate Response-PDU is generated. This alternate
653
+ Response-PDU is formatted with the same values in its request-id
654
+ field as the received GetNextRequest-PDU, with the value of its
655
+ error-status field set to "tooBig", the value of its error-index
656
+ field set to zero, and an empty variable-bindings field. This
657
+ alternate Response-PDU is then encapsulated into a message. If the
658
+ size of the resultant message is less than or equal to both a local
659
+ constraint and the maximum message size of the originator, it is
660
+ transmitted to the originator of the GetNextRequest-PDU. Otherwise,
661
+ the snmpSilentDrops [RFC3418] counter is incremented and the
662
+ resultant message is discarded.
663
+
664
+ 4.2.2.1. Example of Table Traversal
665
+
666
+ An important use of the GetNextRequest-PDU is the traversal of
667
+ conceptual tables of information within a MIB. The semantics of this
668
+ type of request, together with the method of identifying individual
669
+ instances of objects in the MIB, provides access to related objects
670
+ in the MIB as if they enjoyed a tabular organization.
671
+
672
+
673
+
674
+ Presuhn, et al. Standards Track [Page 12]
675
+
676
+ RFC 3416 Protocol Operations for SNMP December 2002
677
+
678
+
679
+ In the protocol exchange sketched below, an application retrieves the
680
+ media-dependent physical address and the address-mapping type for
681
+ each entry in the IP net-to-media Address Translation Table [RFC1213]
682
+ of a particular network element. It also retrieves the value of
683
+ sysUpTime [RFC3418], at which the mappings existed. Suppose that the
684
+ command responder's IP net-to-media table has three entries:
685
+
686
+ Interface-Number Network-Address Physical-Address Type
687
+
688
+ 1 10.0.0.51 00:00:10:01:23:45 static
689
+ 1 9.2.3.4 00:00:10:54:32:10 dynamic
690
+ 2 10.0.0.15 00:00:10:98:76:54 dynamic
691
+
692
+ The SNMP entity supporting a command generator application begins by
693
+ sending a GetNextRequest-PDU containing the indicated OBJECT
694
+ IDENTIFIER values as the requested variable names:
695
+
696
+ GetNextRequest ( sysUpTime,
697
+ ipNetToMediaPhysAddress,
698
+ ipNetToMediaType )
699
+
700
+ The SNMP entity supporting a command responder application responds
701
+ with a Response-PDU:
702
+
703
+ Response (( sysUpTime.0 = "123456" ),
704
+ ( ipNetToMediaPhysAddress.1.9.2.3.4 = "000010543210" ),
705
+ ( ipNetToMediaType.1.9.2.3.4 = "dynamic" ))
706
+
707
+ The SNMP entity supporting the command generator application
708
+ continues with:
709
+
710
+ GetNextRequest ( sysUpTime,
711
+ ipNetToMediaPhysAddress.1.9.2.3.4,
712
+ ipNetToMediaType.1.9.2.3.4 )
713
+
714
+ The SNMP entity supporting the command responder application responds
715
+ with:
716
+
717
+ Response (( sysUpTime.0 = "123461" ),
718
+ ( ipNetToMediaPhysAddress.1.10.0.0.51 = "000010012345" ),
719
+ ( ipNetToMediaType.1.10.0.0.51 = "static" ))
720
+
721
+ The SNMP entity supporting the command generator application
722
+ continues with:
723
+
724
+ GetNextRequest ( sysUpTime,
725
+ ipNetToMediaPhysAddress.1.10.0.0.51,
726
+ ipNetToMediaType.1.10.0.0.51 )
727
+
728
+
729
+
730
+ Presuhn, et al. Standards Track [Page 13]
731
+
732
+ RFC 3416 Protocol Operations for SNMP December 2002
733
+
734
+
735
+ The SNMP entity supporting the command responder application responds
736
+ with:
737
+
738
+ Response (( sysUpTime.0 = "123466" ),
739
+ ( ipNetToMediaPhysAddress.2.10.0.0.15 = "000010987654" ),
740
+ ( ipNetToMediaType.2.10.0.0.15 = "dynamic" ))
741
+
742
+ The SNMP entity supporting the command generator application
743
+ continues with:
744
+
745
+ GetNextRequest ( sysUpTime,
746
+ ipNetToMediaPhysAddress.2.10.0.0.15,
747
+ ipNetToMediaType.2.10.0.0.15 )
748
+
749
+ As there are no further entries in the table, the SNMP entity
750
+ supporting the command responder application responds with the
751
+ variables that are next in the lexicographical ordering of the
752
+ accessible object names, for example:
753
+
754
+ Response (( sysUpTime.0 = "123471" ),
755
+ ( ipNetToMediaNetAddress.1.9.2.3.4 = "9.2.3.4" ),
756
+ ( ipRoutingDiscards.0 = "2" ))
757
+
758
+ Note how, having reached the end of the column for
759
+ ipNetToMediaPhysAddress, the second variable binding from the command
760
+ responder application has now "wrapped" to the first row in the next
761
+ column. Furthermore, note how, having reached the end of the
762
+ ipNetToMediaTable for the third variable binding, the command
763
+ responder application has responded with the next available object,
764
+ which is outside that table. This response signals the end of the
765
+ table to the command generator application.
766
+
767
+ 4.2.3. The GetBulkRequest-PDU
768
+
769
+ A GetBulkRequest-PDU is generated and transmitted at the request of
770
+ an application. The purpose of the GetBulkRequest-PDU is to request
771
+ the transfer of a potentially large amount of data, including, but
772
+ not limited to, the efficient and rapid retrieval of large tables.
773
+
774
+ Upon receipt of a GetBulkRequest-PDU, the receiving SNMP entity
775
+ processes each variable binding in the variable-binding list to
776
+ produce a Response-PDU with its request-id field having the same
777
+ value as in the request.
778
+
779
+ For the GetBulkRequest-PDU type, the successful processing of each
780
+ variable binding in the request generates zero or more variable
781
+ bindings in the Response-PDU. That is, the one-to-one mapping
782
+ between the variable bindings of the GetRequest-PDU, GetNextRequest-
783
+
784
+
785
+
786
+ Presuhn, et al. Standards Track [Page 14]
787
+
788
+ RFC 3416 Protocol Operations for SNMP December 2002
789
+
790
+
791
+ PDU, and SetRequest-PDU types and the resultant Response-PDUs does
792
+ not apply for the mapping between the variable bindings of a
793
+ GetBulkRequest-PDU and the resultant Response-PDU.
794
+
795
+ The values of the non-repeaters and max-repetitions fields in the
796
+ request specify the processing requested. One variable binding in
797
+ the Response-PDU is requested for the first N variable bindings in
798
+ the request and M variable bindings are requested for each of the R
799
+ remaining variable bindings in the request. Consequently, the total
800
+ number of requested variable bindings communicated by the request is
801
+ given by N + (M * R), where N is the minimum of: a) the value of the
802
+ non-repeaters field in the request, and b) the number of variable
803
+ bindings in the request; M is the value of the max-repetitions field
804
+ in the request; and R is the maximum of: a) number of variable
805
+ bindings in the request - N, and b) zero.
806
+
807
+ The receiving SNMP entity produces a Response-PDU with up to the
808
+ total number of requested variable bindings communicated by the
809
+ request. The request-id shall have the same value as the received
810
+ GetBulkRequest-PDU.
811
+
812
+ If N is greater than zero, the first through the (N)-th variable
813
+ bindings of the Response-PDU are each produced as follows:
814
+
815
+ (1) The variable is located which is in the lexicographically
816
+ ordered list of the names of all variables which are accessible
817
+ by this request and whose name is the first lexicographic
818
+ successor of the variable binding's name in the incoming
819
+ GetBulkRequest-PDU. The corresponding variable binding's name
820
+ and value fields in the Response-PDU are set to the name and
821
+ value of the located variable.
822
+
823
+ (2) If the requested variable binding's name does not
824
+ lexicographically precede the name of any variable accessible
825
+ by this request, i.e., there is no lexicographic successor,
826
+ then the corresponding variable binding produced in the
827
+ Response-PDU has its value field set to "endOfMibView", and its
828
+ name field set to the variable binding's name in the request.
829
+
830
+ If M and R are non-zero, the (N + 1)-th and subsequent variable
831
+ bindings of the Response-PDU are each produced in a similar manner.
832
+ For each iteration i, such that i is greater than zero and less than
833
+ or equal to M, and for each repeated variable, r, such that r is
834
+ greater than zero and less than or equal to R, the (N + ( (i-1) * R )
835
+ + r)-th variable binding of the Response-PDU is produced as follows:
836
+
837
+
838
+
839
+
840
+
841
+
842
+ Presuhn, et al. Standards Track [Page 15]
843
+
844
+ RFC 3416 Protocol Operations for SNMP December 2002
845
+
846
+
847
+ (1) The variable which is in the lexicographically ordered list of
848
+ the names of all variables which are accessible by this request
849
+ and whose name is the (i)-th lexicographic successor of the (N
850
+ + r)-th variable binding's name in the incoming
851
+ GetBulkRequest-PDU is located and the variable binding's name
852
+ and value fields are set to the name and value of the located
853
+ variable.
854
+
855
+ (2) If there is no (i)-th lexicographic successor, then the
856
+ corresponding variable binding produced in the Response-PDU has
857
+ its value field set to "endOfMibView", and its name field set
858
+ to either the last lexicographic successor, or if there are no
859
+ lexicographic successors, to the (N + r)-th variable binding's
860
+ name in the request.
861
+
862
+ While the maximum number of variable bindings in the Response-PDU is
863
+ bounded by N + (M * R), the response may be generated with a lesser
864
+ number of variable bindings (possibly zero) for either of three
865
+ reasons.
866
+
867
+ (1) If the size of the message encapsulating the Response-PDU
868
+ containing the requested number of variable bindings would be
869
+ greater than either a local constraint or the maximum message
870
+ size of the originator, then the response is generated with a
871
+ lesser number of variable bindings. This lesser number is the
872
+ ordered set of variable bindings with some of the variable
873
+ bindings at the end of the set removed, such that the size of
874
+ the message encapsulating the Response-PDU is approximately
875
+ equal to but no greater than either a local constraint or the
876
+ maximum message size of the originator. Note that the number
877
+ of variable bindings removed has no relationship to the values
878
+ of N, M, or R.
879
+
880
+ (2) The response may also be generated with a lesser number of
881
+ variable bindings if for some value of iteration i, such that i
882
+ is greater than zero and less than or equal to M, that all of
883
+ the generated variable bindings have the value field set to
884
+ "endOfMibView". In this case, the variable bindings may be
885
+ truncated after the (N + (i * R))-th variable binding.
886
+
887
+ (3) In the event that the processing of a request with many
888
+ repetitions requires a significantly greater amount of
889
+ processing time than a normal request, then a command responder
890
+ application may terminate the request with less than the full
891
+ number of repetitions, providing at least one repetition is
892
+ completed.
893
+
894
+
895
+
896
+
897
+
898
+ Presuhn, et al. Standards Track [Page 16]
899
+
900
+ RFC 3416 Protocol Operations for SNMP December 2002
901
+
902
+
903
+ If the processing of any variable binding fails for a reason other
904
+ than listed above, then the Response-PDU is re-formatted with the
905
+ same values in its request-id and variable-bindings fields as the
906
+ received GetBulkRequest-PDU, with the value of its error-status field
907
+ set to "genErr", and the value of its error-index field is set to the
908
+ index of the variable binding in the original request which
909
+ corresponds to the failed variable binding.
910
+
911
+ Otherwise, the value of the Response-PDU's error-status field is set
912
+ to "noError", and the value of its error-index field to zero.
913
+
914
+ The generated Response-PDU (possibly with an empty variable-bindings
915
+ field) is then encapsulated into a message. If the size of the
916
+ resultant message is less than or equal to both a local constraint
917
+ and the maximum message size of the originator, it is transmitted to
918
+ the originator of the GetBulkRequest-PDU. Otherwise, the
919
+ snmpSilentDrops [RFC3418] counter is incremented and the resultant
920
+ message is discarded.
921
+
922
+ 4.2.3.1. Another Example of Table Traversal
923
+
924
+ This example demonstrates how the GetBulkRequest-PDU can be used as
925
+ an alternative to the GetNextRequest-PDU. The same traversal of the
926
+ IP net-to-media table as shown in Section 4.2.2.1 is achieved with
927
+ fewer exchanges.
928
+
929
+ The SNMP entity supporting the command generator application begins
930
+ by sending a GetBulkRequest-PDU with the modest max-repetitions value
931
+ of 2, and containing the indicated OBJECT IDENTIFIER values as the
932
+ requested variable names:
933
+
934
+ GetBulkRequest [ non-repeaters = 1, max-repetitions = 2 ]
935
+ ( sysUpTime,
936
+ ipNetToMediaPhysAddress,
937
+ ipNetToMediaType )
938
+
939
+ The SNMP entity supporting the command responder application responds
940
+ with a Response-PDU:
941
+
942
+ Response (( sysUpTime.0 = "123456" ),
943
+ ( ipNetToMediaPhysAddress.1.9.2.3.4 = "000010543210" ),
944
+ ( ipNetToMediaType.1.9.2.3.4 = "dynamic" ),
945
+ ( ipNetToMediaPhysAddress.1.10.0.0.51 = "000010012345" ),
946
+ ( ipNetToMediaType.1.10.0.0.51 = "static" ))
947
+
948
+
949
+
950
+
951
+
952
+
953
+
954
+ Presuhn, et al. Standards Track [Page 17]
955
+
956
+ RFC 3416 Protocol Operations for SNMP December 2002
957
+
958
+
959
+ The SNMP entity supporting the command generator application
960
+ continues with:
961
+
962
+ GetBulkRequest [ non-repeaters = 1, max-repetitions = 2 ]
963
+ ( sysUpTime,
964
+ ipNetToMediaPhysAddress.1.10.0.0.51,
965
+ ipNetToMediaType.1.10.0.0.51 )
966
+
967
+ The SNMP entity supporting the command responder application responds
968
+ with:
969
+
970
+ Response (( sysUpTime.0 = "123466" ),
971
+ ( ipNetToMediaPhysAddress.2.10.0.0.15 = "000010987654" ),
972
+ ( ipNetToMediaType.2.10.0.0.15 = "dynamic" ),
973
+ ( ipNetToMediaNetAddress.1.9.2.3.4 = "9.2.3.4" ),
974
+ ( ipRoutingDiscards.0 = "2" ))
975
+
976
+ Note how, as in the first example, the variable bindings in the
977
+ response indicate that the end of the table has been reached. The
978
+ fourth variable binding does so by returning information from the
979
+ next available column; the fifth variable binding does so by
980
+ returning information from the first available object
981
+ lexicographically following the table. This response signals the end
982
+ of the table to the command generator application.
983
+
984
+ 4.2.4. The Response-PDU
985
+
986
+ The Response-PDU is generated by an SNMP entity only upon receipt of
987
+ a GetRequest-PDU, GetNextRequest-PDU, GetBulkRequest-PDU,
988
+ SetRequest-PDU, or InformRequest-PDU, as described elsewhere in this
989
+ document.
990
+
991
+ If the error-status field of the Response-PDU is non-zero, the value
992
+ fields of the variable bindings in the variable binding list are
993
+ ignored.
994
+
995
+ If both the error-status field and the error-index field of the
996
+ Response-PDU are non-zero, then the value of the error-index field is
997
+ the index of the variable binding (in the variable-binding list of
998
+ the corresponding request) for which the request failed. The first
999
+ variable binding in a request's variable-binding list is index one,
1000
+ the second is index two, etc.
1001
+
1002
+ A compliant SNMP entity supporting a command generator application
1003
+ must be able to properly receive and handle a Response-PDU with an
1004
+ error-status field equal to "noSuchName", "badValue", or "readOnly".
1005
+ (See sections 1.3 and 4.3 of [RFC2576].)
1006
+
1007
+
1008
+
1009
+
1010
+ Presuhn, et al. Standards Track [Page 18]
1011
+
1012
+ RFC 3416 Protocol Operations for SNMP December 2002
1013
+
1014
+
1015
+ Upon receipt of a Response-PDU, the receiving SNMP entity presents
1016
+ its contents to the application which generated the request with the
1017
+ same request-id value. For more details, see [RFC3412].
1018
+
1019
+ 4.2.5. The SetRequest-PDU
1020
+
1021
+ A SetRequest-PDU is generated and transmitted at the request of an
1022
+ application.
1023
+
1024
+ Upon receipt of a SetRequest-PDU, the receiving SNMP entity
1025
+ determines the size of a message encapsulating a Response-PDU having
1026
+ the same values in its request-id and variable-bindings fields as the
1027
+ received SetRequest-PDU, and the largest possible sizes of the
1028
+ error-status and error-index fields. If the determined message size
1029
+ is greater than either a local constraint or the maximum message size
1030
+ of the originator, then an alternate Response-PDU is generated,
1031
+ transmitted to the originator of the SetRequest-PDU, and processing
1032
+ of the SetRequest-PDU terminates immediately thereafter. This
1033
+ alternate Response-PDU is formatted with the same values in its
1034
+ request-id field as the received SetRequest-PDU, with the value of
1035
+ its error-status field set to "tooBig", the value of its error-index
1036
+ field set to zero, and an empty variable-bindings field. This
1037
+ alternate Response-PDU is then encapsulated into a message. If the
1038
+ size of the resultant message is less than or equal to both a local
1039
+ constraint and the maximum message size of the originator, it is
1040
+ transmitted to the originator of the SetRequest-PDU. Otherwise, the
1041
+ snmpSilentDrops [RFC3418] counter is incremented and the resultant
1042
+ message is discarded. Regardless, processing of the SetRequest-PDU
1043
+ terminates.
1044
+
1045
+ Otherwise, the receiving SNMP entity processes each variable binding
1046
+ in the variable-binding list to produce a Response-PDU. All fields
1047
+ of the Response-PDU have the same values as the corresponding fields
1048
+ of the received request except as indicated below.
1049
+
1050
+ The variable bindings are conceptually processed as a two phase
1051
+ operation. In the first phase, each variable binding is validated;
1052
+ if all validations are successful, then each variable is altered in
1053
+ the second phase. Of course, implementors are at liberty to
1054
+ implement either the first, or second, or both, of these conceptual
1055
+ phases as multiple implementation phases. Indeed, such multiple
1056
+ implementation phases may be necessary in some cases to ensure
1057
+ consistency.
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+ Presuhn, et al. Standards Track [Page 19]
1067
+
1068
+ RFC 3416 Protocol Operations for SNMP December 2002
1069
+
1070
+
1071
+ The following validations are performed in the first phase on each
1072
+ variable binding until they are all successful, or until one fails:
1073
+
1074
+ (1) If the variable binding's name specifies an existing or non-
1075
+ existent variable to which this request is/would be denied
1076
+ access because it is/would not be in the appropriate MIB view,
1077
+ then the value of the Response-PDU's error-status field is set
1078
+ to "noAccess", and the value of its error-index field is set to
1079
+ the index of the failed variable binding.
1080
+
1081
+ (2) Otherwise, if there are no variables which share the same
1082
+ OBJECT IDENTIFIER prefix as the variable binding's name, and
1083
+ which are able to be created or modified no matter what new
1084
+ value is specified, then the value of the Response-PDU's
1085
+ error-status field is set to "notWritable", and the value of
1086
+ its error-index field is set to the index of the failed
1087
+ variable binding.
1088
+
1089
+ (3) Otherwise, if the variable binding's value field specifies,
1090
+ according to the ASN.1 language, a type which is inconsistent
1091
+ with that required for all variables which share the same
1092
+ OBJECT IDENTIFIER prefix as the variable binding's name, then
1093
+ the value of the Response-PDU's error-status field is set to
1094
+ "wrongType", and the value of its error-index field is set to
1095
+ the index of the failed variable binding.
1096
+
1097
+ (4) Otherwise, if the variable binding's value field specifies,
1098
+ according to the ASN.1 language, a length which is inconsistent
1099
+ with that required for all variables which share the same
1100
+ OBJECT IDENTIFIER prefix as the variable binding's name, then
1101
+ the value of the Response-PDU's error-status field is set to
1102
+ "wrongLength", and the value of its error-index field is set to
1103
+ the index of the failed variable binding.
1104
+
1105
+ (5) Otherwise, if the variable binding's value field contains an
1106
+ ASN.1 encoding which is inconsistent with that field's ASN.1
1107
+ tag, then the value of the Response-PDU's error-status field is
1108
+ set to "wrongEncoding", and the value of its error-index field
1109
+ is set to the index of the failed variable binding. (Note that
1110
+ not all implementation strategies will generate this error.)
1111
+
1112
+ (6) Otherwise, if the variable binding's value field specifies a
1113
+ value which could under no circumstances be assigned to the
1114
+ variable, then the value of the Response-PDU's error-status
1115
+ field is set to "wrongValue", and the value of its error-index
1116
+ field is set to the index of the failed variable binding.
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+ Presuhn, et al. Standards Track [Page 20]
1123
+
1124
+ RFC 3416 Protocol Operations for SNMP December 2002
1125
+
1126
+
1127
+ (7) Otherwise, if the variable binding's name specifies a variable
1128
+ which does not exist and could not ever be created (even though
1129
+ some variables sharing the same OBJECT IDENTIFIER prefix might
1130
+ under some circumstances be able to be created), then the value
1131
+ of the Response-PDU's error-status field is set to
1132
+ "noCreation", and the value of its error-index field is set to
1133
+ the index of the failed variable binding.
1134
+
1135
+ (8) Otherwise, if the variable binding's name specifies a variable
1136
+ which does not exist but can not be created under the present
1137
+ circumstances (even though it could be created under other
1138
+ circumstances), then the value of the Response-PDU's error-
1139
+ status field is set to "inconsistentName", and the value of its
1140
+ error-index field is set to the index of the failed variable
1141
+ binding.
1142
+
1143
+ (9) Otherwise, if the variable binding's name specifies a variable
1144
+ which exists but can not be modified no matter what new value
1145
+ is specified, then the value of the Response-PDU's error-status
1146
+ field is set to "notWritable", and the value of its error-index
1147
+ field is set to the index of the failed variable binding.
1148
+
1149
+ (10) Otherwise, if the variable binding's value field specifies a
1150
+ value that could under other circumstances be held by the
1151
+ variable, but is presently inconsistent or otherwise unable to
1152
+ be assigned to the variable, then the value of the Response-
1153
+ PDU's error-status field is set to "inconsistentValue", and the
1154
+ value of its error-index field is set to the index of the
1155
+ failed variable binding.
1156
+
1157
+ (11) When, during the above steps, the assignment of the value
1158
+ specified by the variable binding's value field to the
1159
+ specified variable requires the allocation of a resource which
1160
+ is presently unavailable, then the value of the Response-PDU's
1161
+ error-status field is set to "resourceUnavailable", and the
1162
+ value of its error-index field is set to the index of the
1163
+ failed variable binding.
1164
+
1165
+ (12) If the processing of the variable binding fails for a reason
1166
+ other than listed above, then the value of the Response-PDU's
1167
+ error-status field is set to "genErr", and the value of its
1168
+ error-index field is set to the index of the failed variable
1169
+ binding.
1170
+
1171
+ (13) Otherwise, the validation of the variable binding succeeds.
1172
+
1173
+
1174
+
1175
+
1176
+
1177
+
1178
+ Presuhn, et al. Standards Track [Page 21]
1179
+
1180
+ RFC 3416 Protocol Operations for SNMP December 2002
1181
+
1182
+
1183
+ At the end of the first phase, if the validation of all variable
1184
+ bindings succeeded, then the value of the Response-PDU's error-status
1185
+ field is set to "noError" and the value of its error-index field is
1186
+ zero, and processing continues as follows.
1187
+
1188
+ For each variable binding in the request, the named variable is
1189
+ created if necessary, and the specified value is assigned to it.
1190
+ Each of these variable assignments occurs as if simultaneously with
1191
+ respect to all other assignments specified in the same request.
1192
+ However, if the same variable is named more than once in a single
1193
+ request, with different associated values, then the actual assignment
1194
+ made to that variable is implementation-specific.
1195
+
1196
+ If any of these assignments fail (even after all the previous
1197
+ validations), then all other assignments are undone, and the
1198
+ Response-PDU is modified to have the value of its error-status field
1199
+ set to "commitFailed", and the value of its error-index field set to
1200
+ the index of the failed variable binding.
1201
+
1202
+ If and only if it is not possible to undo all the assignments, then
1203
+ the Response-PDU is modified to have the value of its error-status
1204
+ field set to "undoFailed", and the value of its error-index field is
1205
+ set to zero. Note that implementations are strongly encouraged to
1206
+ take all possible measures to avoid use of either "commitFailed" or
1207
+ "undoFailed" - these two error-status codes are not to be taken as
1208
+ license to take the easy way out in an implementation.
1209
+
1210
+ Finally, the generated Response-PDU is encapsulated into a message,
1211
+ and transmitted to the originator of the SetRequest-PDU.
1212
+
1213
+ 4.2.6. The SNMPv2-Trap-PDU
1214
+
1215
+ An SNMPv2-Trap-PDU is generated and transmitted by an SNMP entity on
1216
+ behalf of a notification originator application. The SNMPv2-Trap-PDU
1217
+ is often used to notify a notification receiver application at a
1218
+ logically remote SNMP entity that an event has occurred or that a
1219
+ condition is present. There is no confirmation associated with this
1220
+ notification delivery mechanism.
1221
+
1222
+ The destination(s) to which an SNMPv2-Trap-PDU is sent is determined
1223
+ in an implementation-dependent fashion by the SNMP entity. The first
1224
+ two variable bindings in the variable binding list of an SNMPv2-
1225
+ Trap-PDU are sysUpTime.0 [RFC3418] and snmpTrapOID.0 [RFC3418]
1226
+ respectively. If the OBJECTS clause is present in the invocation of
1227
+ the corresponding NOTIFICATION-TYPE macro, then each corresponding
1228
+ variable, as instantiated by this notification, is copied, in order,
1229
+
1230
+
1231
+
1232
+
1233
+
1234
+ Presuhn, et al. Standards Track [Page 22]
1235
+
1236
+ RFC 3416 Protocol Operations for SNMP December 2002
1237
+
1238
+
1239
+ to the variable-bindings field. If any additional variables are
1240
+ being included (at the option of the generating SNMP entity), then
1241
+ each is copied to the variable-bindings field.
1242
+
1243
+ 4.2.7. The InformRequest-PDU
1244
+
1245
+ An InformRequest-PDU is generated and transmitted by an SNMP entity
1246
+ on behalf of a notification originator application. The
1247
+ InformRequest-PDU is often used to notify a notification receiver
1248
+ application that an event has occurred or that a condition is
1249
+ present. This is a confirmed notification delivery mechanism,
1250
+ although there is, of course, no guarantee of delivery.
1251
+
1252
+ The destination(s) to which an InformRequest-PDU is sent is specified
1253
+ by the notification originator application. The first two variable
1254
+ bindings in the variable binding list of an InformRequest-PDU are
1255
+ sysUpTime.0 [RFC3418] and snmpTrapOID.0 [RFC3418] respectively. If
1256
+ the OBJECTS clause is present in the invocation of the corresponding
1257
+ NOTIFICATION-TYPE macro, then each corresponding variable, as
1258
+ instantiated by this notification, is copied, in order, to the
1259
+ variable-bindings field. If any additional variables are being
1260
+ included (at the option of the generating SNMP entity), then each is
1261
+ copied to the variable-bindings field.
1262
+
1263
+ Upon receipt of an InformRequest-PDU, the receiving SNMP entity
1264
+ determines the size of a message encapsulating a Response-PDU with
1265
+ the same values in its request-id, error-status, error-index and
1266
+ variable-bindings fields as the received InformRequest-PDU. If the
1267
+ determined message size is greater than either a local constraint or
1268
+ the maximum message size of the originator, then an alternate
1269
+ Response-PDU is generated, transmitted to the originator of the
1270
+ InformRequest-PDU, and processing of the InformRequest-PDU terminates
1271
+ immediately thereafter. This alternate Response-PDU is formatted
1272
+ with the same values in its request-id field as the received
1273
+ InformRequest-PDU, with the value of its error-status field set to
1274
+ "tooBig", the value of its error-index field set to zero, and an
1275
+ empty variable-bindings field. This alternate Response-PDU is then
1276
+ encapsulated into a message. If the size of the resultant message is
1277
+ less than or equal to both a local constraint and the maximum message
1278
+ size of the originator, it is transmitted to the originator of the
1279
+ InformRequest-PDU. Otherwise, the snmpSilentDrops [RFC3418] counter
1280
+ is incremented and the resultant message is discarded. Regardless,
1281
+ processing of the InformRequest-PDU terminates.
1282
+
1283
+ Otherwise, the receiving SNMP entity:
1284
+
1285
+ (1) presents its contents to the appropriate application;
1286
+
1287
+
1288
+
1289
+
1290
+ Presuhn, et al. Standards Track [Page 23]
1291
+
1292
+ RFC 3416 Protocol Operations for SNMP December 2002
1293
+
1294
+
1295
+ (2) generates a Response-PDU with the same values in its request-id
1296
+ and variable-bindings fields as the received InformRequest-PDU,
1297
+ with the value of its error-status field set to "noError" and
1298
+ the value of its error-index field set to zero; and
1299
+
1300
+ (3) transmits the generated Response-PDU to the originator of the
1301
+ InformRequest-PDU.
1302
+
1303
+ 5. Notice on Intellectual Property
1304
+
1305
+ The IETF takes no position regarding the validity or scope of any
1306
+ intellectual property or other rights that might be claimed to
1307
+ pertain to the implementation or use of the technology described in
1308
+ this document or the extent to which any license under such rights
1309
+ might or might not be available; neither does it represent that it
1310
+ has made any effort to identify any such rights. Information on the
1311
+ IETF's procedures with respect to rights in standards-track and
1312
+ standards-related documentation can be found in BCP-11. Copies of
1313
+ claims of rights made available for publication and any assurances of
1314
+ licenses to be made available, or the result of an attempt made to
1315
+ obtain a general license or permission for the use of such
1316
+ proprietary rights by implementors or users of this specification can
1317
+ be obtained from the IETF Secretariat.
1318
+
1319
+ The IETF invites any interested party to bring to its attention any
1320
+ copyrights, patents or patent applications, or other proprietary
1321
+ rights which may cover technology that may be required to practice
1322
+ this standard. Please address the information to the IETF Executive
1323
+ Director.
1324
+
1325
+ 6. Acknowledgments
1326
+
1327
+ This document is the product of the SNMPv3 Working Group. Some
1328
+ special thanks are in order to the following Working Group members:
1329
+
1330
+ Randy Bush
1331
+ Jeffrey D. Case
1332
+ Mike Daniele
1333
+ Rob Frye
1334
+ Lauren Heintz
1335
+ Keith McCloghrie
1336
+ Russ Mundy
1337
+ David T. Perkins
1338
+ Randy Presuhn
1339
+ Aleksey Romanov
1340
+ Juergen Schoenwaelder
1341
+ Bert Wijnen
1342
+
1343
+
1344
+
1345
+
1346
+ Presuhn, et al. Standards Track [Page 24]
1347
+
1348
+ RFC 3416 Protocol Operations for SNMP December 2002
1349
+
1350
+
1351
+ This version of the document, edited by Randy Presuhn, was initially
1352
+ based on the work of a design team whose members were:
1353
+
1354
+ Jeffrey D. Case
1355
+ Keith McCloghrie
1356
+ David T. Perkins
1357
+ Randy Presuhn
1358
+ Juergen Schoenwaelder
1359
+
1360
+ The previous versions of this document, edited by Keith McCloghrie,
1361
+ was the result of significant work by four major contributors:
1362
+
1363
+ Jeffrey D. Case
1364
+ Keith McCloghrie
1365
+ Marshall T. Rose
1366
+ Steven Waldbusser
1367
+
1368
+ Additionally, the contributions of the SNMPv2 Working Group to the
1369
+ previous versions are also acknowledged. In particular, a special
1370
+ thanks is extended for the contributions of:
1371
+
1372
+ Alexander I. Alten
1373
+ Dave Arneson
1374
+ Uri Blumenthal
1375
+ Doug Book
1376
+ Kim Curran
1377
+ Jim Galvin
1378
+ Maria Greene
1379
+ Iain Hanson
1380
+ Dave Harrington
1381
+ Nguyen Hien
1382
+ Jeff Johnson
1383
+ Michael Kornegay
1384
+ Deirdre Kostick
1385
+ David Levi
1386
+ Daniel Mahoney
1387
+ Bob Natale
1388
+ Brian O'Keefe
1389
+ Andrew Pearson
1390
+ Dave Perkins
1391
+ Randy Presuhn
1392
+ Aleksey Romanov
1393
+ Shawn Routhier
1394
+ Jon Saperia
1395
+ Juergen Schoenwaelder
1396
+ Bob Stewart
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+ Presuhn, et al. Standards Track [Page 25]
1403
+
1404
+ RFC 3416 Protocol Operations for SNMP December 2002
1405
+
1406
+
1407
+ Kaj Tesink
1408
+ Glenn Waters
1409
+ Bert Wijnen
1410
+
1411
+ 7. Security Considerations
1412
+
1413
+ The protocol defined in this document by itself does not provide a
1414
+ secure environment. Even if the network itself is secure (for
1415
+ example by using IPSec), there is no control as to who on the secure
1416
+ network is allowed access to management information.
1417
+
1418
+ It is recommended that the implementors consider the security
1419
+ features as provided by the SNMPv3 framework. Specifically, the use
1420
+ of the User-based Security Model STD 62, RFC 3414 [RFC3414] and the
1421
+ View-based Access Control Model STD 62, RFC 3415 [RFC3415] is
1422
+ recommended.
1423
+
1424
+ It is then a customer/user responsibility to ensure that the SNMP
1425
+ entity is properly configured so that:
1426
+
1427
+ - only those principals (users) having legitimate rights can
1428
+ access or modify the values of any MIB objects supported by
1429
+ that entity;
1430
+
1431
+ - the occurrence of particular events on the entity will be
1432
+ communicated appropriately;
1433
+
1434
+ - the entity responds appropriately and with due credence to
1435
+ events and information that have been communicated to it.
1436
+
1437
+ 8. References
1438
+
1439
+ 8.1. Normative References
1440
+
1441
+ [RFC768] Postel, J., "User Datagram Protocol", STD 6, RFC 768,
1442
+ August 1980.
1443
+
1444
+ [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
1445
+ Rose, M. and S. Waldbusser, "Structure of Management
1446
+ Information Version 2 (SMIv2)", STD 58, RFC 2578, April
1447
+ 1999.
1448
+
1449
+ [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
1450
+ Rose, M. and S. Waldbusser, "Textual Conventions for
1451
+ SMIv2", STD 58, RFC 2579, April 1999.
1452
+
1453
+
1454
+
1455
+
1456
+
1457
+
1458
+ Presuhn, et al. Standards Track [Page 26]
1459
+
1460
+ RFC 3416 Protocol Operations for SNMP December 2002
1461
+
1462
+
1463
+ [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
1464
+ Rose, M. and S. Waldbusser, "Conformance Statements for
1465
+ SMIv2", STD 58, RFC 2580, April 1999.
1466
+
1467
+ [RFC3411] Harrington, D., Presuhn, R. and B. Wijnen, "An
1468
+ Architecture for Describing Simple Network Management
1469
+ Protocol (SNMP) Management Frameworks", STD 62, RFC 3411,
1470
+ December 2002.
1471
+
1472
+ [RFC3412] Case, J., Harrington, D., Presuhn, R. and B. Wijnen,
1473
+ "Message Processing and Dispatching for the Simple
1474
+ Network Management Protocol (SNMP)", STD 62, RFC 3412,
1475
+ December 2002.
1476
+
1477
+ [RFC3413] Levi, D., Meyer, P. and B. Stewart, "Simple Network
1478
+ Management Protocol (SNMP) Applications", STD 62, RFC
1479
+ 3413, December 2002.
1480
+
1481
+ [RFC3414] Blumenthal, U. and B. Wijnen, "The User-Based Security
1482
+ Model (USM) for Version 3 of the Simple Network
1483
+ Management Protocol (SNMPv3)", STD 62, RFC 3414, December
1484
+ 2002.
1485
+
1486
+ [RFC3415] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based
1487
+ Access Control Model (VACM) for the Simple Network
1488
+ Management Protocol (SNMP)", STD 62, RFC 3415, December
1489
+ 2002.
1490
+
1491
+ [RFC3417] Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S.
1492
+ Waldbusser, "Transport Mappings for the Simple Network
1493
+ Management Protocol", STD 62, RFC 3417, December 2002.
1494
+
1495
+ [RFC3418] Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S.
1496
+ Waldbusser, "Management Information Base (MIB) for the
1497
+ Simple Network Management Protocol (SNMP)", STD 62, RFC
1498
+ 3418, December 2002.
1499
+
1500
+ [ASN1] Information processing systems - Open Systems
1501
+ Interconnection - Specification of Abstract Syntax
1502
+ Notation One (ASN.1), International Organization for
1503
+ Standardization. International Standard 8824, December
1504
+ 1987.
1505
+
1506
+ 8.2. Informative References
1507
+
1508
+ [FRAG] Kent, C. and J. Mogul, "Fragmentation Considered
1509
+ Harmful," Proceedings, ACM SIGCOMM '87, Stowe, VT, August
1510
+ 1987.
1511
+
1512
+
1513
+
1514
+ Presuhn, et al. Standards Track [Page 27]
1515
+
1516
+ RFC 3416 Protocol Operations for SNMP December 2002
1517
+
1518
+
1519
+ [RFC1155] Rose, M. and K. McCloghrie, "Structure and Identification
1520
+ of Management Information for TCP/IP-based Internets",
1521
+ STD 16, RFC 1155, May 1990.
1522
+
1523
+ [RFC1157] Case, J., Fedor, M., Schoffstall, M. and J. Davin,
1524
+ "Simple Network Management Protocol", STD 15, RFC 1157,
1525
+ May 1990.
1526
+
1527
+ [RFC1212] Rose, M. and K. McCloghrie, "Concise MIB Definitions",
1528
+ STD 16, RFC 1212, March 1991.
1529
+
1530
+ [RFC1213] McCloghrie, K. and M. Rose, Editors, "Management
1531
+ Information Base for Network Management of TCP/IP-based
1532
+ internets: MIB-II", STD 17, RFC 1213, March 1991.
1533
+
1534
+ [RFC1215] Rose, M., "A Convention for Defining Traps for use with
1535
+ the SNMP", RFC 1215, March 1991.
1536
+
1537
+ [RFC1901] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
1538
+ "Introduction to Community-based SNMPv2", RFC 1901,
1539
+ January 1996.
1540
+
1541
+ [RFC2576] Frye, R., Levi, D., Routhier, S. and B. Wijnen,
1542
+ "Coexistence between Version 1, Version 2, and Version 3
1543
+ of the Internet-Standard Network Management Framework",
1544
+ RFC 2576, March 2000.
1545
+
1546
+ [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group
1547
+ MIB", RFC 2863, June 2000.
1548
+
1549
+ [RFC2914] Floyd, S., "Congestion Control Principles", BCP 41, RFC
1550
+ 2914, September 2000.
1551
+
1552
+ [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart,
1553
+ "Introduction and Applicability Statements for Internet-
1554
+ Standard Management Framework", RFC 3410, December 2002.
1555
+
1556
+ 9. Changes from RFC 1905
1557
+
1558
+ These are the changes from RFC 1905:
1559
+
1560
+ - Corrected spelling error in copyright statement;
1561
+
1562
+ - Updated copyright date;
1563
+
1564
+ - Updated with new editor's name and contact information;
1565
+
1566
+ - Added notice on intellectual property;
1567
+
1568
+
1569
+
1570
+ Presuhn, et al. Standards Track [Page 28]
1571
+
1572
+ RFC 3416 Protocol Operations for SNMP December 2002
1573
+
1574
+
1575
+ - Cosmetic fixes to layout and typography;
1576
+
1577
+ - Added table of contents;
1578
+
1579
+ - Title changed;
1580
+
1581
+ - Updated document headers and footers;
1582
+
1583
+ - Deleted the old clause 2.3, entitled "Access to Management
1584
+ Information";
1585
+
1586
+ - Changed the way in which request-id was defined, though with
1587
+ the same ultimate syntax and semantics, to avoid coupling with
1588
+ SMI. This does not affect the protocol in any way;
1589
+
1590
+ - Replaced the word "exception" with the word "error" in the old
1591
+ clause 4.1. This does not affect the protocol in any way;
1592
+
1593
+ - Deleted the first two paragraphs of the old clause 4.2;
1594
+
1595
+ - Clarified the maximum number of variable bindings that an
1596
+ implementation must support in a PDU. This does not affect the
1597
+ protocol in any way;
1598
+
1599
+ - Replaced occurrences of "SNMPv2 application" with
1600
+ "application";
1601
+
1602
+ - Deleted three sentences in old clause 4.2.3 describing the
1603
+ handling of an impossible situation. This does not affect the
1604
+ protocol in any way;
1605
+
1606
+ - Clarified the use of the SNMPv2-Trap-Pdu in the old clause
1607
+ 4.2.6. This does not affect the protocol in any way;
1608
+
1609
+ - Aligned description of the use of the InformRequest-Pdu in old
1610
+ clause 4.2.7 with the architecture. This does not affect the
1611
+ protocol in any way;
1612
+
1613
+ - Updated references;
1614
+
1615
+ - Re-wrote introduction clause;
1616
+
1617
+ - Replaced manager/agent/SNMPv2 entity terminology with
1618
+ terminology from RFC 2571. This does not affect the protocol
1619
+ in any way;
1620
+
1621
+ - Eliminated IMPORTS from the SMI, replaced with equivalent in-
1622
+ line ASN.1. This does not affect the protocol in any way;
1623
+
1624
+
1625
+
1626
+ Presuhn, et al. Standards Track [Page 29]
1627
+
1628
+ RFC 3416 Protocol Operations for SNMP December 2002
1629
+
1630
+
1631
+ - Added notes calling attention to two different manifestations
1632
+ of reaching the end of a table in the table walk examples;
1633
+
1634
+ - Added content to security considerations clause;
1635
+
1636
+ - Updated ASN.1 comment on use of Report-PDU. This does not
1637
+ affect the protocol in any way;
1638
+
1639
+ - Updated acknowledgments section;
1640
+
1641
+ - Included information on handling of BITS;
1642
+
1643
+ - Deleted spurious comma in ASN.1 definition of PDUs;
1644
+
1645
+ - Added abstract;
1646
+
1647
+ - Made handling of additional variable bindings in informs
1648
+ consistent with that for traps. This was a correction of an
1649
+ editorial oversight, and reflects implementation practice;
1650
+
1651
+ - Added reference to RFC 2914.
1652
+
1653
+ 10. Editor's Address
1654
+
1655
+ Randy Presuhn
1656
+ BMC Software, Inc.
1657
+ 2141 North First Street
1658
+ San Jose, CA 95131
1659
+ USA
1660
+
1661
+ Phone: +1 408 546 1006
1662
+ EMail: randy_presuhn@bmc.com
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+
1672
+
1673
+
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+ Presuhn, et al. Standards Track [Page 30]
1683
+
1684
+ RFC 3416 Protocol Operations for SNMP December 2002
1685
+
1686
+
1687
+ 11. Full Copyright Statement
1688
+
1689
+ Copyright (C) The Internet Society (2002). All Rights Reserved.
1690
+
1691
+ This document and translations of it may be copied and furnished to
1692
+ others, and derivative works that comment on or otherwise explain it
1693
+ or assist in its implementation may be prepared, copied, published
1694
+ and distributed, in whole or in part, without restriction of any
1695
+ kind, provided that the above copyright notice and this paragraph are
1696
+ included on all such copies and derivative works. However, this
1697
+ document itself may not be modified in any way, such as by removing
1698
+ the copyright notice or references to the Internet Society or other
1699
+ Internet organizations, except as needed for the purpose of
1700
+ developing Internet standards in which case the procedures for
1701
+ copyrights defined in the Internet Standards process must be
1702
+ followed, or as required to translate it into languages other than
1703
+ English.
1704
+
1705
+ The limited permissions granted above are perpetual and will not be
1706
+ revoked by the Internet Society or its successors or assigns.
1707
+
1708
+ This document and the information contained herein is provided on an
1709
+ "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
1710
+ TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
1711
+ BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
1712
+ HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
1713
+ MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
1714
+
1715
+ Acknowledgement
1716
+
1717
+ Funding for the RFC Editor function is currently provided by the
1718
+ Internet Society.
1719
+
1720
+
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+
1730
+
1731
+
1732
+
1733
+
1734
+
1735
+
1736
+
1737
+
1738
+ Presuhn, et al. Standards Track [Page 31]
1739
+