Node-Red configuration
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

rfc3416.txt 68KB

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