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.

rfc1098.txt 68KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907
  1. Network Working Group J. Case
  2. Request for Comments: 1098 University of Tennessee at Knoxville
  3. Obsoletes: RFC 1067 M. Fedor
  4. NYSERNet, Inc.
  5. M. Schoffstall
  6. Rensselaer Polytechnic Institute
  7. C. Davin
  8. MIT Laboratory for Computer Science
  9. April 1989
  10. A Simple Network Management Protocol (SNMP)
  11. Table of Contents
  12. 1. Status of this Memo ................................... 2
  13. 2. Introduction .......................................... 2
  14. 3. The SNMP Architecture ................................. 4
  15. 3.1 Goals of the Architecture ............................ 4
  16. 3.2 Elements of the Architecture ......................... 4
  17. 3.2.1 Scope of Management Information .................... 5
  18. 3.2.2 Representation of Management Information ........... 5
  19. 3.2.3 Operations Supported on Management Information ..... 6
  20. 3.2.4 Form and Meaning of Protocol Exchanges ............. 7
  21. 3.2.5 Definition of Administrative Relationships ......... 7
  22. 3.2.6 Form and Meaning of References to Managed Objects .. 11
  23. 3.2.6.1 Resolution of Ambiguous MIB References ........... 11
  24. 3.2.6.2 Resolution of References across MIB Versions...... 11
  25. 3.2.6.3 Identification of Object Instances ............... 11
  26. 3.2.6.3.1 ifTable Object Type Names ...................... 12
  27. 3.2.6.3.2 atTable Object Type Names ...................... 12
  28. 3.2.6.3.3 ipAddrTable Object Type Names .................. 13
  29. 3.2.6.3.4 ipRoutingTable Object Type Names ............... 13
  30. 3.2.6.3.5 tcpConnTable Object Type Names ................. 13
  31. 3.2.6.3.6 egpNeighTable Object Type Names ................ 14
  32. 4. Protocol Specification ................................ 15
  33. 4.1 Elements of Procedure ................................ 16
  34. 4.1.1 Common Constructs .................................. 18
  35. 4.1.2 The GetRequest-PDU ................................. 19
  36. 4.1.3 The GetNextRequest-PDU ............................. 20
  37. 4.1.3.1 Example of Table Traversal ....................... 22
  38. 4.1.4 The GetResponse-PDU ................................ 23
  39. 4.1.5 The SetRequest-PDU ................................. 24
  40. 4.1.6 The Trap-PDU ....................................... 26
  41. 4.1.6.1 The coldStart Trap ............................... 27
  42. 4.1.6.2 The warmStart Trap ............................... 27
  43. 4.1.6.3 The linkDown Trap ................................ 27
  44. 4.1.6.4 The linkUp Trap .................................. 27
  45. Case, Fedor, Schoffstall, & Davin [Page 1]
  46. RFC 1098 SNMP April 1989
  47. 4.1.6.5 The authenticationFailure Trap ................... 27
  48. 4.1.6.6 The egpNeighborLoss Trap ......................... 27
  49. 4.1.6.7 The enterpriseSpecific Trap ...................... 28
  50. 5. Definitions ........................................... 29
  51. 6. Acknowledgements ...................................... 32
  52. 7. References ............................................ 33
  53. 1. Status of this Memo
  54. This RFC is a re-release of RFC 1067, with a changed "Status of this
  55. Memo" section. This memo defines a simple protocol by which
  56. management information for a network element may be inspected or
  57. altered by logically remote users. In particular, together with its
  58. companion memos which describe the structure of management
  59. information along with the initial management information base, these
  60. documents provide a simple, workable architecture and system for
  61. managing TCP/IP-based internets and in particular the Internet.
  62. The Internet Activities Board (IAB) has designated two different
  63. network management protocols with the same status of "Draft Standard"
  64. and "Recommended".
  65. The two protocols are the Common Management Information Services and
  66. Protocol over TCP/IP (CMOT) [9], and the Simple Network Management
  67. Protocol (SNMP) (this memo).
  68. The IAB intends each of these two protocols to receive the attention
  69. of implementers and experimenters. The IAB seeks reports of
  70. experience with these two protocols from system builders and users.
  71. By this action, the IAB recommends that all IP and TCP
  72. implementations be network manageable (e.g., implement the Internet
  73. MIB [3]) and that the implementations that are network manageable are
  74. expected to adopt and implement at least one of these two Internet
  75. Draft Standards.
  76. Distribution of this memo is unlimited.
  77. 2. Introduction
  78. As reported in RFC 1052, IAB Recommendations for the Development of
  79. Internet Network Management Standards [1], the Internet Activities
  80. Board has directed the Internet Engineering Task Force (IETF) to
  81. create two new working groups in the area of network management. One
  82. group is charged with the further specification and definition of
  83. elements to be included in the Management Information Base (MIB).
  84. The other is charged with defining the modifications to the Simple
  85. Network Management Protocol (SNMP) to accommodate the short-term
  86. Case, Fedor, Schoffstall, & Davin [Page 2]
  87. RFC 1098 SNMP April 1989
  88. needs of the network vendor and operations communities, and to align
  89. with the output of the MIB working group.
  90. The MIB working group has produced two memos, one which defines a
  91. Structure for Management Information (SMI) [2] for use by the managed
  92. objects contained in the MIB. A second memo [3] defines the list of
  93. managed objects.
  94. The output of the SNMP Extensions working group is this memo, which
  95. incorporates changes to the initial SNMP definition [4] required to
  96. attain alignment with the output of the MIB working group. The
  97. changes should be minimal in order to be consistent with the IAB's
  98. directive that the working groups be "extremely sensitive to the need
  99. to keep the SNMP simple." Although considerable care and debate has
  100. gone into the changes to the SNMP which are reflected in this memo,
  101. the resulting protocol is not backwardly-compatible with its
  102. predecessor, the Simple Gateway Monitoring Protocol (SGMP) [5].
  103. Although the syntax of the protocol has been altered, the original
  104. philosophy, design decisions, and architecture remain intact. In
  105. order to avoid confusion, new UDP ports have been allocated for use
  106. by the protocol described in this memo.
  107. Case, Fedor, Schoffstall, & Davin [Page 3]
  108. RFC 1098 SNMP April 1989
  109. 3. The SNMP Architecture
  110. Implicit in the SNMP architectural model is a collection of network
  111. management stations and network elements. Network management
  112. stations execute management applications which monitor and control
  113. network elements. Network elements are devices such as hosts,
  114. gateways, terminal servers, and the like, which have management
  115. agents responsible for performing the network management functions
  116. requested by the network management stations. The Simple Network
  117. Management Protocol (SNMP) is used to communicate management
  118. information between the network management stations and the agents in
  119. the network elements.
  120. 3.1. Goals of the Architecture
  121. The SNMP explicitly minimizes the number and complexity of management
  122. functions realized by the management agent itself. This goal is
  123. attractive in at least four respects:
  124. (1) The development cost for management agent software
  125. necessary to support the protocol is accordingly reduced.
  126. (2) The degree of management function that is remotely
  127. supported is accordingly increased, thereby admitting
  128. fullest use of internet resources in the management task.
  129. (3) The degree of management function that is remotely
  130. supported is accordingly increased, thereby imposing the
  131. fewest possible restrictions on the form and
  132. sophistication of management tools.
  133. (4) Simplified sets of management functions are easily
  134. understood and used by developers of network management
  135. tools.
  136. A second goal of the protocol is that the functional paradigm for
  137. monitoring and control be sufficiently extensible to accommodate
  138. additional, possibly unanticipated aspects of network operation and
  139. management.
  140. A third goal is that the architecture be, as much as possible,
  141. independent of the architecture and mechanisms of particular hosts or
  142. particular gateways.
  143. 3.2. Elements of the Architecture
  144. The SNMP architecture articulates a solution to the network
  145. management problem in terms of:
  146. Case, Fedor, Schoffstall, & Davin [Page 4]
  147. RFC 1098 SNMP April 1989
  148. (1) the scope of the management information communicated by
  149. the protocol,
  150. (2) the representation of the management information
  151. communicated by the protocol,
  152. (3) operations on management information supported by the
  153. protocol,
  154. (4) the form and meaning of exchanges among management
  155. entities,
  156. (5) the definition of administrative relationships among
  157. management entities, and
  158. (6) the form and meaning of references to management
  159. information.
  160. 3.2.1. Scope of Management Information
  161. The scope of the management information communicated by operation of
  162. the SNMP is exactly that represented by instances of all non-
  163. aggregate object types either defined in Internet-standard MIB or
  164. defined elsewhere according to the conventions set forth in
  165. Internet-standard SMI [2].
  166. Support for aggregate object types in the MIB is neither required for
  167. conformance with the SMI nor realized by the SNMP.
  168. 3.2.2. Representation of Management Information
  169. Management information communicated by operation of the SNMP is
  170. represented according to the subset of the ASN.1 language [6] that is
  171. specified for the definition of non-aggregate types in the SMI.
  172. The SGMP adopted the convention of using a well-defined subset of the
  173. ASN.1 language [6]. The SNMP continues and extends this tradition by
  174. utilizing a moderately more complex subset of ASN.1 for describing
  175. managed objects and for describing the protocol data units used for
  176. managing those objects. In addition, the desire to ease eventual
  177. transition to OSI-based network management protocols led to the
  178. definition in the ASN.1 language of an Internet-standard Structure of
  179. Management Information (SMI) [2] and Management Information Base
  180. (MIB) [3]. The use of the ASN.1 language, was, in part, encouraged
  181. by the successful use of ASN.1 in earlier efforts, in particular, the
  182. SGMP. The restrictions on the use of ASN.1 that are part of the SMI
  183. contribute to the simplicity espoused and validated by experience
  184. with the SGMP.
  185. Case, Fedor, Schoffstall, & Davin [Page 5]
  186. RFC 1098 SNMP April 1989
  187. Also for the sake of simplicity, the SNMP uses only a subset of the
  188. basic encoding rules of ASN.1 [7]. Namely, all encodings use the
  189. definite-length form. Further, whenever permissible, non-constructor
  190. encodings are used rather than constructor encodings. This
  191. restriction applies to all aspects of ASN.1 encoding, both for the
  192. top-level protocol data units and the data objects they contain.
  193. 3.2.3. Operations Supported on Management Information
  194. The SNMP models all management agent functions as alterations or
  195. inspections of variables. Thus, a protocol entity on a logically
  196. remote host (possibly the network element itself) interacts with the
  197. management agent resident on the network element in order to retrieve
  198. (get) or alter (set) variables. This strategy has at least two
  199. positive consequences:
  200. (1) It has the effect of limiting the number of essential
  201. management functions realized by the management agent to
  202. two: one operation to assign a value to a specified
  203. configuration or other parameter and another to retrieve
  204. such a value.
  205. (2) A second effect of this decision is to avoid introducing
  206. into the protocol definition support for imperative
  207. management commands: the number of such commands is in
  208. practice ever-increasing, and the semantics of such
  209. commands are in general arbitrarily complex.
  210. The strategy implicit in the SNMP is that the monitoring of network
  211. state at any significant level of detail is accomplished primarily by
  212. polling for appropriate information on the part of the monitoring
  213. center(s). A limited number of unsolicited messages (traps) guide
  214. the timing and focus of the polling. Limiting the number of
  215. unsolicited messages is consistent with the goal of simplicity and
  216. minimizing the amount of traffic generated by the network management
  217. function.
  218. The exclusion of imperative commands from the set of explicitly
  219. supported management functions is unlikely to preclude any desirable
  220. management agent operation. Currently, most commands are requests
  221. either to set the value of some parameter or to retrieve such a
  222. value, and the function of the few imperative commands currently
  223. supported is easily accommodated in an asynchronous mode by this
  224. management model. In this scheme, an imperative command might be
  225. realized as the setting of a parameter value that subsequently
  226. triggers the desired action. For example, rather than implementing a
  227. "reboot command," this action might be invoked by simply setting a
  228. parameter indicating the number of seconds until system reboot.
  229. Case, Fedor, Schoffstall, & Davin [Page 6]
  230. RFC 1098 SNMP April 1989
  231. 3.2.4. Form and Meaning of Protocol Exchanges
  232. The communication of management information among management entities
  233. is realized in the SNMP through the exchange of protocol messages.
  234. The form and meaning of those messages is defined below in Section 4.
  235. Consistent with the goal of minimizing complexity of the management
  236. agent, the exchange of SNMP messages requires only an unreliable
  237. datagram service, and every message is entirely and independently
  238. represented by a single transport datagram. While this document
  239. specifies the exchange of messages via the UDP protocol [8], the
  240. mechanisms of the SNMP are generally suitable for use with a wide
  241. variety of transport services.
  242. 3.2.5. Definition of Administrative Relationships
  243. The SNMP architecture admits a variety of administrative
  244. relationships among entities that participate in the protocol. The
  245. entities residing at management stations and network elements which
  246. communicate with one another using the SNMP are termed SNMP
  247. application entities. The peer processes which implement the SNMP,
  248. and thus support the SNMP application entities, are termed protocol
  249. entities.
  250. A pairing of an SNMP agent with some arbitrary set of SNMP
  251. application entities is called an SNMP community. Each SNMP
  252. community is named by a string of octets, that is called the
  253. community name for said community.
  254. An SNMP message originated by an SNMP application entity that in fact
  255. belongs to the SNMP community named by the community component of
  256. said message is called an authentic SNMP message. The set of rules
  257. by which an SNMP message is identified as an authentic SNMP message
  258. for a particular SNMP community is called an authentication scheme.
  259. An implementation of a function that identifies authentic SNMP
  260. messages according to one or more authentication schemes is called an
  261. authentication service.
  262. Clearly, effective management of administrative relationships among
  263. SNMP application entities requires authentication services that (by
  264. the use of encryption or other techniques) are able to identify
  265. authentic SNMP messages with a high degree of certainty. Some SNMP
  266. implementations may wish to support only a trivial authentication
  267. service that identifies all SNMP messages as authentic SNMP messages.
  268. For any network element, a subset of objects in the MIB that pertain
  269. to that element is called a SNMP MIB view. Note that the names of
  270. the object types represented in a SNMP MIB view need not belong to a
  271. Case, Fedor, Schoffstall, & Davin [Page 7]
  272. RFC 1098 SNMP April 1989
  273. single sub-tree of the object type name space.
  274. An element of the set { READ-ONLY, READ-WRITE } is called an SNMP
  275. access mode.
  276. A pairing of a SNMP access mode with a SNMP MIB view is called an
  277. SNMP community profile. A SNMP community profile represents
  278. specified access privileges to variables in a specified MIB view. For
  279. every variable in the MIB view in a given SNMP community profile,
  280. access to that variable is represented by the profile according to
  281. the following conventions:
  282. (1) if said variable is defined in the MIB with "Access:" of
  283. "none," it is unavailable as an operand for any operator;
  284. (2) if said variable is defined in the MIB with "Access:" of
  285. "read-write" or "write-only" and the access mode of the
  286. given profile is READ-WRITE, that variable is available
  287. as an operand for the get, set, and trap operations;
  288. (3) otherwise, the variable is available as an operand for
  289. the get and trap operations.
  290. (4) In those cases where a "write-only" variable is an
  291. operand used for the get or trap operations, the value
  292. given for the variable is implementation-specific.
  293. A pairing of a SNMP community with a SNMP community profile is called
  294. a SNMP access policy. An access policy represents a specified
  295. community profile afforded by the SNMP agent of a specified SNMP
  296. community to other members of that community. All administrative
  297. relationships among SNMP application entities are architecturally
  298. defined in terms of SNMP access policies.
  299. For every SNMP access policy, if the network element on which the
  300. SNMP agent for the specified SNMP community resides is not that to
  301. which the MIB view for the specified profile pertains, then that
  302. policy is called a SNMP proxy access policy. The SNMP agent
  303. associated with a proxy access policy is called a SNMP proxy agent.
  304. While careless definition of proxy access policies can result in
  305. management loops, prudent definition of proxy policies is useful in
  306. at least two ways:
  307. (1) It permits the monitoring and control of network elements
  308. which are otherwise not addressable using the management
  309. protocol and the transport protocol. That is, a proxy
  310. agent may provide a protocol conversion function allowing
  311. a management station to apply a consistent management
  312. Case, Fedor, Schoffstall, & Davin [Page 8]
  313. RFC 1098 SNMP April 1989
  314. framework to all network elements, including devices such
  315. as modems, multiplexors, and other devices which support
  316. different management frameworks.
  317. (2) It potentially shields network elements from elaborate
  318. access control policies. For example, a proxy agent may
  319. implement sophisticated access control whereby diverse
  320. subsets of variables within the MIB are made accessible
  321. to different management stations without increasing the
  322. complexity of the network element.
  323. By way of example, Figure 1 illustrates the relationship between
  324. management stations, proxy agents, and management agents. In this
  325. example, the proxy agent is envisioned to be a normal Internet
  326. Network Operations Center (INOC) of some administrative domain which
  327. has a standard managerial relationship with a set of management
  328. agents.
  329. Case, Fedor, Schoffstall, & Davin [Page 9]
  330. RFC 1098 SNMP April 1989
  331. +------------------+ +----------------+ +----------------+
  332. | Region #1 INOC | |Region #2 INOC | |PC in Region #3 |
  333. | | | | | |
  334. |Domain=Region #1 | |Domain=Region #2| |Domain=Region #3|
  335. |CPU=super-mini-1 | |CPU=super-mini-1| |CPU=Clone-1 |
  336. |PCommunity=pub | |PCommunity=pub | |PCommunity=slate|
  337. | | | | | |
  338. +------------------+ +----------------+ +----------------+
  339. /|\ /|\ /|\
  340. | | |
  341. | | |
  342. | \|/ |
  343. | +-----------------+ |
  344. +-------------->| Region #3 INOC |<-------------+
  345. | |
  346. |Domain=Region #3 |
  347. |CPU=super-mini-2 |
  348. |PCommunity=pub, |
  349. | slate |
  350. |DCommunity=secret|
  351. +-------------->| |<-------------+
  352. | +-----------------+ |
  353. | /|\ |
  354. | | |
  355. | | |
  356. \|/ \|/ \|/
  357. +-----------------+ +-----------------+ +-----------------+
  358. |Domain=Region#3 | |Domain=Region#3 | |Domain=Region#3 |
  359. |CPU=router-1 | |CPU=mainframe-1 | |CPU=modem-1 |
  360. |DCommunity=secret| |DCommunity=secret| |DCommunity=secret|
  361. +-----------------+ +-----------------+ +-----------------+
  362. Domain: the administrative domain of the element
  363. PCommunity: the name of a community utilizing a proxy agent
  364. DCommunity: the name of a direct community
  365. Figure 1
  366. Example Network Management Configuration
  367. Case, Fedor, Schoffstall, & Davin [Page 10]
  368. RFC 1098 SNMP April 1989
  369. 3.2.6. Form and Meaning of References to Managed Objects
  370. The SMI requires that the definition of a conformant management
  371. protocol address:
  372. (1) the resolution of ambiguous MIB references,
  373. (2) the resolution of MIB references in the presence multiple
  374. MIB versions, and
  375. (3) the identification of particular instances of object
  376. types defined in the MIB.
  377. 3.2.6.1. Resolution of Ambiguous MIB References
  378. Because the scope of any SNMP operation is conceptually confined to
  379. objects relevant to a single network element, and because all SNMP
  380. references to MIB objects are (implicitly or explicitly) by unique
  381. variable names, there is no possibility that any SNMP reference to
  382. any object type defined in the MIB could resolve to multiple
  383. instances of that type.
  384. 3.2.6.2. Resolution of References across MIB Versions
  385. The object instance referred to by any SNMP operation is exactly that
  386. specified as part of the operation request or (in the case of a get-
  387. next operation) its immediate successor in the MIB as a whole. In
  388. particular, a reference to an object as part of some version of the
  389. Internet-standard MIB does not resolve to any object that is not part
  390. of said version of the Internet-standard MIB, except in the case that
  391. the requested operation is get-next and the specified object name is
  392. lexicographically last among the names of all objects presented as
  393. part of said version of the Internet-Standard MIB.
  394. 3.2.6.3. Identification of Object Instances
  395. The names for all object types in the MIB are defined explicitly
  396. either in the Internet-standard MIB or in other documents which
  397. conform to the naming conventions of the SMI. The SMI requires that
  398. conformant management protocols define mechanisms for identifying
  399. individual instances of those object types for a particular network
  400. element.
  401. Each instance of any object type defined in the MIB is identified in
  402. SNMP operations by a unique name called its "variable name." In
  403. general, the name of an SNMP variable is an OBJECT IDENTIFIER of the
  404. form x.y, where x is the name of a non-aggregate object type defined
  405. in the MIB and y is an OBJECT IDENTIFIER fragment that, in a way
  406. Case, Fedor, Schoffstall, & Davin [Page 11]
  407. RFC 1098 SNMP April 1989
  408. specific to the named object type, identifies the desired instance.
  409. This naming strategy admits the fullest exploitation of the semantics
  410. of the GetNextRequest-PDU (see Section 4), because it assigns names
  411. for related variables so as to be contiguous in the lexicographical
  412. ordering of all variable names known in the MIB.
  413. The type-specific naming of object instances is defined below for a
  414. number of classes of object types. Instances of an object type to
  415. which none of the following naming conventions are applicable are
  416. named by OBJECT IDENTIFIERs of the form x.0, where x is the name of
  417. said object type in the MIB definition.
  418. For example, suppose one wanted to identify an instance of the
  419. variable sysDescr The object class for sysDescr is:
  420. iso org dod internet mgmt mib system sysDescr
  421. 1 3 6 1 2 1 1 1
  422. Hence, the object type, x, would be 1.3.6.1.2.1.1.1 to which is
  423. appended an instance sub-identifier of 0. That is, 1.3.6.1.2.1.1.1.0
  424. identifies the one and only instance of sysDescr.
  425. 3.2.6.3.1. ifTable Object Type Names
  426. The name of a subnet interface, s, is the OBJECT IDENTIFIER value of
  427. the form i, where i has the value of that instance of the ifIndex
  428. object type associated with s.
  429. For each object type, t, for which the defined name, n, has a prefix
  430. of ifEntry, an instance, i, of t is named by an OBJECT IDENTIFIER of
  431. the form n.s, where s is the name of the subnet interface about which
  432. i represents information.
  433. For example, suppose one wanted to identify the instance of the
  434. variable ifType associated with interface 2. Accordingly, ifType.2
  435. would identify the desired instance.
  436. 3.2.6.3.2. atTable Object Type Names
  437. The name of an AT-cached network address, x, is an OBJECT IDENTIFIER
  438. of the form 1.a.b.c.d, where a.b.c.d is the value (in the familiar
  439. "dot" notation) of the atNetAddress object type associated with x.
  440. The name of an address translation equivalence e is an OBJECT
  441. IDENTIFIER value of the form s.w, such that s is the value of that
  442. instance of the atIndex object type associated with e and such that w
  443. is the name of the AT-cached network address associated with e.
  444. Case, Fedor, Schoffstall, & Davin [Page 12]
  445. RFC 1098 SNMP April 1989
  446. For each object type, t, for which the defined name, n, has a prefix
  447. of atEntry, an instance, i, of t is named by an OBJECT IDENTIFIER of
  448. the form n.y, where y is the name of the address translation
  449. equivalence about which i represents information.
  450. For example, suppose one wanted to find the physical address of an
  451. entry in the address translation table (ARP cache) associated with an
  452. IP address of 89.1.1.42 and interface 3. Accordingly,
  453. atPhysAddress.3.1.89.1.1.42 would identify the desired instance.
  454. 3.2.6.3.3. ipAddrTable Object Type Names
  455. The name of an IP-addressable network element, x, is the OBJECT
  456. IDENTIFIER of the form a.b.c.d such that a.b.c.d is the value (in the
  457. familiar "dot" notation) of that instance of the ipAdEntAddr object
  458. type associated with x.
  459. For each object type, t, for which the defined name, n, has a prefix
  460. of ipAddrEntry, an instance, i, of t is named by an OBJECT IDENTIFIER
  461. of the form n.y, where y is the name of the IP-addressable network
  462. element about which i represents information.
  463. For example, suppose one wanted to find the network mask of an entry
  464. in the IP interface table associated with an IP address of 89.1.1.42.
  465. Accordingly, ipAdEntNetMask.89.1.1.42 would identify the desired
  466. instance.
  467. 3.2.6.3.4. ipRoutingTable Object Type Names
  468. The name of an IP route, x, is the OBJECT IDENTIFIER of the form
  469. a.b.c.d such that a.b.c.d is the value (in the familiar "dot"
  470. notation) of that instance of the ipRouteDest object type associated
  471. with x.
  472. For each object type, t, for which the defined name, n, has a prefix
  473. of ipRoutingEntry, an instance, i, of t is named by an OBJECT
  474. IDENTIFIER of the form n.y, where y is the name of the IP route about
  475. which i represents information.
  476. For example, suppose one wanted to find the next hop of an entry in
  477. the IP routing table associated with the destination of 89.1.1.42.
  478. Accordingly, ipRouteNextHop.89.1.1.42 would identify the desired
  479. instance.
  480. 3.2.6.3.5. tcpConnTable Object Type Names
  481. The name of a TCP connection, x, is the OBJECT IDENTIFIER of the form
  482. a.b.c.d.e.f.g.h.i.j such that a.b.c.d is the value (in the familiar
  483. Case, Fedor, Schoffstall, & Davin [Page 13]
  484. RFC 1098 SNMP April 1989
  485. "dot" notation) of that instance of the tcpConnLocalAddress object
  486. type associated with x and such that f.g.h.i is the value (in the
  487. familiar "dot" notation) of that instance of the tcpConnRemoteAddress
  488. object type associated with x and such that e is the value of that
  489. instance of the tcpConnLocalPort object type associated with x and
  490. such that j is the value of that instance of the tcpConnRemotePort
  491. object type associated with x.
  492. For each object type, t, for which the defined name, n, has a prefix
  493. of tcpConnEntry, an instance, i, of t is named by an OBJECT
  494. IDENTIFIER of the form n.y, where y is the name of the TCP connection
  495. about which i represents information.
  496. For example, suppose one wanted to find the state of a TCP connection
  497. between the local address of 89.1.1.42 on TCP port 21 and the remote
  498. address of 10.0.0.51 on TCP port 2059. Accordingly,
  499. tcpConnState.89.1.1.42.21.10.0.0.51.2059 would identify the desired
  500. instance.
  501. 3.2.6.3.6. egpNeighTable Object Type Names
  502. The name of an EGP neighbor, x, is the OBJECT IDENTIFIER of the form
  503. a.b.c.d such that a.b.c.d is the value (in the familiar "dot"
  504. notation) of that instance of the egpNeighAddr object type associated
  505. with x.
  506. For each object type, t, for which the defined name, n, has a prefix
  507. of egpNeighEntry, an instance, i, of t is named by an OBJECT
  508. IDENTIFIER of the form n.y, where y is the name of the EGP neighbor
  509. about which i represents information.
  510. For example, suppose one wanted to find the neighbor state for the IP
  511. address of 89.1.1.42. Accordingly, egpNeighState.89.1.1.42 would
  512. identify the desired instance.
  513. Case, Fedor, Schoffstall, & Davin [Page 14]
  514. RFC 1098 SNMP April 1989
  515. 4. Protocol Specification
  516. The network management protocol is an application protocol by which
  517. the variables of an agent's MIB may be inspected or altered.
  518. Communication among protocol entities is accomplished by the exchange
  519. of messages, each of which is entirely and independently represented
  520. within a single UDP datagram using the basic encoding rules of ASN.1
  521. (as discussed in Section 3.2.2). A message consists of a version
  522. identifier, an SNMP community name, and a protocol data unit (PDU).
  523. A protocol entity receives messages at UDP port 161 on the host with
  524. which it is associated for all messages except for those which report
  525. traps (i.e., all messages except those which contain the Trap-PDU).
  526. Messages which report traps should be received on UDP port 162 for
  527. further processing. An implementation of this protocol need not
  528. accept messages whose length exceeds 484 octets. However, it is
  529. recommended that implementations support larger datagrams whenever
  530. feasible.
  531. It is mandatory that all implementations of the SNMP support the five
  532. PDUs: GetRequest-PDU, GetNextRequest-PDU, GetResponse-PDU,
  533. SetRequest-PDU, and Trap-PDU.
  534. RFC1098-SNMP DEFINITIONS ::= BEGIN
  535. IMPORTS
  536. ObjectName, ObjectSyntax, NetworkAddress, IpAddress, TimeTicks
  537. FROM RFC1065-SMI;
  538. -- top-level message
  539. Message ::=
  540. SEQUENCE {
  541. version -- version-1 for this RFC
  542. INTEGER {
  543. version-1(0)
  544. },
  545. community -- community name
  546. OCTET STRING,
  547. data -- e.g., PDUs if trivial
  548. ANY -- authentication is being used
  549. }
  550. Case, Fedor, Schoffstall, & Davin [Page 15]
  551. RFC 1098 SNMP April 1989
  552. -- protocol data units
  553. PDUs ::=
  554. CHOICE {
  555. get-request
  556. GetRequest-PDU,
  557. get-next-request
  558. GetNextRequest-PDU,
  559. get-response
  560. GetResponse-PDU,
  561. set-request
  562. SetRequest-PDU,
  563. trap
  564. Trap-PDU
  565. }
  566. -- the individual PDUs and commonly used
  567. -- data types will be defined later
  568. END
  569. 4.1. Elements of Procedure
  570. This section describes the actions of a protocol entity implementing
  571. the SNMP. Note, however, that it is not intended to constrain the
  572. internal architecture of any conformant implementation.
  573. In the text that follows, the term transport address is used. In the
  574. case of the UDP, a transport address consists of an IP address along
  575. with a UDP port. Other transport services may be used to support the
  576. SNMP. In these cases, the definition of a transport address should
  577. be made accordingly.
  578. The top-level actions of a protocol entity which generates a message
  579. are as follows:
  580. (1) It first constructs the appropriate PDU, e.g., the
  581. GetRequest-PDU, as an ASN.1 object.
  582. (2) It then passes this ASN.1 object along with a community
  583. name its source transport address and the destination
  584. transport address, to the service which implements the
  585. desired authentication scheme. This authentication
  586. Case, Fedor, Schoffstall, & Davin [Page 16]
  587. RFC 1098 SNMP April 1989
  588. service returns another ASN.1 object.
  589. (3) The protocol entity then constructs an ASN.1 Message
  590. object, using the community name and the resulting ASN.1
  591. object.
  592. (4) This new ASN.1 object is then serialized, using the basic
  593. encoding rules of ASN.1, and then sent using a transport
  594. service to the peer protocol entity.
  595. Similarly, the top-level actions of a protocol entity which receives
  596. a message are as follows:
  597. (1) It performs a rudimentary parse of the incoming datagram
  598. to build an ASN.1 object corresponding to an ASN.1
  599. Message object. If the parse fails, it discards the
  600. datagram and performs no further actions.
  601. (2) It then verifies the version number of the SNMP message.
  602. If there is a mismatch, it discards the datagram and
  603. performs no further actions.
  604. (3) The protocol entity then passes the community name and
  605. user data found in the ASN.1 Message object, along with
  606. the datagram's source and destination transport addresses
  607. to the service which implements the desired
  608. authentication scheme. This entity returns another ASN.1
  609. object, or signals an authentication failure. In the
  610. latter case, the protocol entity notes this failure,
  611. (possibly) generates a trap, and discards the datagram
  612. and performs no further actions.
  613. (4) The protocol entity then performs a rudimentary parse on
  614. the ASN.1 object returned from the authentication service
  615. to build an ASN.1 object corresponding to an ASN.1 PDUs
  616. object. If the parse fails, it discards the datagram and
  617. performs no further actions. Otherwise, using the named
  618. SNMP community, the appropriate profile is selected, and
  619. the PDU is processed accordingly. If, as a result of
  620. this processing, a message is returned then the source
  621. transport address that the response message is sent from
  622. shall be identical to the destination transport address
  623. that the original request message was sent to.
  624. Case, Fedor, Schoffstall, & Davin [Page 17]
  625. RFC 1098 SNMP April 1989
  626. 4.1.1. Common Constructs
  627. Before introducing the six PDU types of the protocol, it is
  628. appropriate to consider some of the ASN.1 constructs used frequently:
  629. -- request/response information
  630. RequestID ::=
  631. INTEGER
  632. ErrorStatus ::=
  633. INTEGER {
  634. noError(0),
  635. tooBig(1),
  636. noSuchName(2),
  637. badValue(3),
  638. readOnly(4)
  639. genErr(5)
  640. }
  641. ErrorIndex ::=
  642. INTEGER
  643. -- variable bindings
  644. VarBind ::=
  645. SEQUENCE {
  646. name
  647. ObjectName,
  648. value
  649. ObjectSyntax
  650. }
  651. VarBindList ::=
  652. SEQUENCE OF
  653. VarBind
  654. RequestIDs are used to distinguish among outstanding requests. By
  655. use of the RequestID, an SNMP application entity can correlate
  656. incoming responses with outstanding requests. In cases where an
  657. unreliable datagram service is being used, the RequestID also
  658. provides a simple means of identifying messages duplicated by the
  659. network.
  660. A non-zero instance of ErrorStatus is used to indicate that an
  661. Case, Fedor, Schoffstall, & Davin [Page 18]
  662. RFC 1098 SNMP April 1989
  663. exception occurred while processing a request. In these cases,
  664. ErrorIndex may provide additional information by indicating which
  665. variable in a list caused the exception.
  666. The term variable refers to an instance of a managed object. A
  667. variable binding, or VarBind, refers to the pairing of the name of a
  668. variable to the variable's value. A VarBindList is a simple list of
  669. variable names and corresponding values. Some PDUs are concerned
  670. only with the name of a variable and not its value (e.g., the
  671. GetRequest-PDU). In this case, the value portion of the binding is
  672. ignored by the protocol entity. However, the value portion must
  673. still have valid ASN.1 syntax and encoding. It is recommended that
  674. the ASN.1 value NULL be used for the value portion of such bindings.
  675. 4.1.2. The GetRequest-PDU
  676. The form of the GetRequest-PDU is:
  677. GetRequest-PDU ::=
  678. [0]
  679. IMPLICIT SEQUENCE {
  680. request-id
  681. RequestID,
  682. error-status -- always 0
  683. ErrorStatus,
  684. error-index -- always 0
  685. ErrorIndex,
  686. variable-bindings
  687. VarBindList
  688. }
  689. The GetRequest-PDU is generated by a protocol entity only at the
  690. request of its SNMP application entity.
  691. Upon receipt of the GetRequest-PDU, the receiving protocol entity
  692. responds according to any applicable rule in the list below:
  693. (1) If, for any object named in the variable-bindings field,
  694. the object's name does not exactly match the name of some
  695. object available for get operations in the relevant MIB
  696. view, then the receiving entity sends to the originator
  697. of the received message the GetResponse-PDU of identical
  698. form, except that the value of the error-status field is
  699. noSuchName, and the value of the error-index field is the
  700. index of said object name component in the received
  701. Case, Fedor, Schoffstall, & Davin [Page 19]
  702. RFC 1098 SNMP April 1989
  703. message.
  704. (2) If, for any object named in the variable-bindings field,
  705. the object is an aggregate type (as defined in the SMI),
  706. then the receiving entity sends to the originator of the
  707. received message the GetResponse-PDU of identical form,
  708. except that the value of the error-status field is
  709. noSuchName, and the value of the error-index field is the
  710. index of said object name component in the received
  711. message.
  712. (3) If the size of the GetResponse-PDU generated as described
  713. below would exceed a local limitation, then the receiving
  714. entity sends to the originator of the received message
  715. the GetResponse-PDU of identical form, except that the
  716. value of the error-status field is tooBig, and the value
  717. of the error-index field is zero.
  718. (4) If, for any object named in the variable-bindings field,
  719. the value of the object cannot be retrieved for reasons
  720. not covered by any of the foregoing rules, then the
  721. receiving entity sends to the originator of the received
  722. message the GetResponse-PDU of identical form, except
  723. that the value of the error-status field is genErr and
  724. the value of the error-index field is the index of said
  725. object name component in the received message.
  726. If none of the foregoing rules apply, then the receiving protocol
  727. entity sends to the originator of the received message the
  728. GetResponse-PDU such that, for each object named in the variable-
  729. bindings field of the received message, the corresponding component
  730. of the GetResponse-PDU represents the name and value of that
  731. variable. The value of the error- status field of the GetResponse-
  732. PDU is noError and the value of the error-index field is zero. The
  733. value of the request-id field of the GetResponse-PDU is that of the
  734. received message.
  735. 4.1.3. The GetNextRequest-PDU
  736. The form of the GetNextRequest-PDU is identical to that of the
  737. GetRequest-PDU except for the indication of the PDU type. In the
  738. ASN.1 language:
  739. GetNextRequest-PDU ::=
  740. [1]
  741. IMPLICIT SEQUENCE {
  742. request-id
  743. RequestID,
  744. Case, Fedor, Schoffstall, & Davin [Page 20]
  745. RFC 1098 SNMP April 1989
  746. error-status -- always 0
  747. ErrorStatus,
  748. error-index -- always 0
  749. ErrorIndex,
  750. variable-bindings
  751. VarBindList
  752. }
  753. The GetNextRequest-PDU is generated by a protocol entity only at the
  754. request of its SNMP application entity.
  755. Upon receipt of the GetNextRequest-PDU, the receiving protocol entity
  756. responds according to any applicable rule in the list below:
  757. (1) If, for any object name in the variable-bindings field,
  758. that name does not lexicographically precede the name of
  759. some object available for get operations in the relevant
  760. MIB view, then the receiving entity sends to the
  761. originator of the received message the GetResponse-PDU of
  762. identical form, except that the value of the error-status
  763. field is noSuchName, and the value of the error-index
  764. field is the index of said object name component in the
  765. received message.
  766. (2) If the size of the GetResponse-PDU generated as described
  767. below would exceed a local limitation, then the receiving
  768. entity sends to the originator of the received message
  769. the GetResponse-PDU of identical form, except that the
  770. value of the error-status field is tooBig, and the value
  771. of the error-index field is zero.
  772. (3) If, for any object named in the variable-bindings field,
  773. the value of the lexicographical successor to the named
  774. object cannot be retrieved for reasons not covered by any
  775. of the foregoing rules, then the receiving entity sends
  776. to the originator of the received message the
  777. GetResponse-PDU of identical form, except that the value
  778. of the error-status field is genErr and the value of the
  779. error-index field is the index of said object name
  780. component in the received message.
  781. If none of the foregoing rules apply, then the receiving protocol
  782. entity sends to the originator of the received message the
  783. GetResponse-PDU such that, for each name in the variable-bindings
  784. field of the received message, the corresponding component of the
  785. Case, Fedor, Schoffstall, & Davin [Page 21]
  786. RFC 1098 SNMP April 1989
  787. GetResponse-PDU represents the name and value of that object whose
  788. name is, in the lexicographical ordering of the names of all objects
  789. available for get operations in the relevant MIB view, together with
  790. the value of the name field of the given component, the immediate
  791. successor to that value. The value of the error-status field of the
  792. GetResponse-PDU is noError and the value of the errorindex field is
  793. zero. The value of the request-id field of the GetResponse-PDU is
  794. that of the received message.
  795. 4.1.3.1. Example of Table Traversal
  796. One important use of the GetNextRequest-PDU is the traversal of
  797. conceptual tables of information within the MIB. The semantics of
  798. this type of SNMP message, together with the protocol-specific
  799. mechanisms for identifying individual instances of object types in
  800. the MIB, affords access to related objects in the MIB as if they
  801. enjoyed a tabular organization.
  802. By the SNMP exchange sketched below, an SNMP application entity might
  803. extract the destination address and next hop gateway for each entry
  804. in the routing table of a particular network element. Suppose that
  805. this routing table has three entries:
  806. Destination NextHop Metric
  807. 10.0.0.99 89.1.1.42 5
  808. 9.1.2.3 99.0.0.3 3
  809. 10.0.0.51 89.1.1.42 5
  810. The management station sends to the SNMP agent a GetNextRequest-PDU
  811. containing the indicated OBJECT IDENTIFIER values as the requested
  812. variable names:
  813. GetNextRequest ( ipRouteDest, ipRouteNextHop, ipRouteMetric1 )
  814. The SNMP agent responds with a GetResponse-PDU:
  815. GetResponse (( ipRouteDest.9.1.2.3 = "9.1.2.3" ),
  816. ( ipRouteNextHop.9.1.2.3 = "99.0.0.3" ),
  817. ( ipRouteMetric1.9.1.2.3 = 3 ))
  818. The management station continues with:
  819. GetNextRequest ( ipRouteDest.9.1.2.3,
  820. ipRouteNextHop.9.1.2.3,
  821. Case, Fedor, Schoffstall, & Davin [Page 22]
  822. RFC 1098 SNMP April 1989
  823. ipRouteMetric1.9.1.2.3 )
  824. The SNMP agent responds:
  825. GetResponse (( ipRouteDest.10.0.0.51 = "10.0.0.51" ),
  826. ( ipRouteNextHop.10.0.0.51 = "89.1.1.42" ),
  827. ( ipRouteMetric1.10.0.0.51 = 5 ))
  828. The management station continues with:
  829. GetNextRequest ( ipRouteDest.10.0.0.51,
  830. ipRouteNextHop.10.0.0.51,
  831. ipRouteMetric1.10.0.0.51 )
  832. The SNMP agent responds:
  833. GetResponse (( ipRouteDest.10.0.0.99 = "10.0.0.99" ),
  834. ( ipRouteNextHop.10.0.0.99 = "89.1.1.42" ),
  835. ( ipRouteMetric1.10.0.0.99 = 5 ))
  836. The management station continues with:
  837. GetNextRequest ( ipRouteDest.10.0.0.99,
  838. ipRouteNextHop.10.0.0.99,
  839. ipRouteMetric1.10.0.0.99 )
  840. As there are no further entries in the table, the SNMP agent returns
  841. those objects that are next in the lexicographical ordering of the
  842. known object names. This response signals the end of the routing
  843. table to the management station.
  844. 4.1.4. The GetResponse-PDU
  845. The form of the GetResponse-PDU is identical to that of the
  846. GetRequest-PDU except for the indication of the PDU type. In the
  847. ASN.1 language:
  848. GetResponse-PDU ::=
  849. [2]
  850. IMPLICIT SEQUENCE {
  851. request-id
  852. RequestID,
  853. Case, Fedor, Schoffstall, & Davin [Page 23]
  854. RFC 1098 SNMP April 1989
  855. error-status
  856. ErrorStatus,
  857. error-index
  858. ErrorIndex,
  859. variable-bindings
  860. VarBindList
  861. }
  862. The GetResponse-PDU is generated by a protocol entity only upon
  863. receipt of the GetRequest-PDU, GetNextRequest-PDU, or SetRequest-PDU,
  864. as described elsewhere in this document.
  865. Upon receipt of the GetResponse-PDU, the receiving protocol entity
  866. presents its contents to its SNMP application entity.
  867. 4.1.5. The SetRequest-PDU
  868. The form of the SetRequest-PDU is identical to that of the
  869. GetRequest-PDU except for the indication of the PDU type. In the
  870. ASN.1 language:
  871. SetRequest-PDU ::=
  872. [3]
  873. IMPLICIT SEQUENCE {
  874. request-id
  875. RequestID,
  876. error-status -- always 0
  877. ErrorStatus,
  878. error-index -- always 0
  879. ErrorIndex,
  880. variable-bindings
  881. VarBindList
  882. }
  883. The SetRequest-PDU is generated by a protocol entity only at the
  884. request of its SNMP application entity.
  885. Upon receipt of the SetRequest-PDU, the receiving entity responds
  886. according to any applicable rule in the list below:
  887. (1) If, for any object named in the variable-bindings field,
  888. Case, Fedor, Schoffstall, & Davin [Page 24]
  889. RFC 1098 SNMP April 1989
  890. the object is not available for set operations in the
  891. relevant MIB view, then the receiving entity sends to the
  892. originator of the received message the GetResponse-PDU of
  893. identical form, except that the value of the error-status
  894. field is noSuchName, and the value of the error-index
  895. field is the index of said object name component in the
  896. received message.
  897. (2) If, for any object named in the variable-bindings field,
  898. the contents of the value field does not, according to
  899. the ASN.1 language, manifest a type, length, and value
  900. that is consistent with that required for the variable,
  901. then the receiving entity sends to the originator of the
  902. received message the GetResponse-PDU of identical form,
  903. except that the value of the error-status field is
  904. badValue, and the value of the error-index field is the
  905. index of said object name in the received message.
  906. (3) If the size of the Get Response type message generated as
  907. described below would exceed a local limitation, then the
  908. receiving entity sends to the originator of the received
  909. message the GetResponse-PDU of identical form, except
  910. that the value of the error-status field is tooBig, and
  911. the value of the error-index field is zero.
  912. (4) If, for any object named in the variable-bindings field,
  913. the value of the named object cannot be altered for
  914. reasons not covered by any of the foregoing rules, then
  915. the receiving entity sends to the originator of the
  916. received message the GetResponse-PDU of identical form,
  917. except that the value of the error-status field is genErr
  918. and the value of the error-index field is the index of
  919. said object name component in the received message.
  920. If none of the foregoing rules apply, then for each object named in
  921. the variable-bindings field of the received message, the
  922. corresponding value is assigned to the variable. Each variable
  923. assignment specified by the SetRequest-PDU should be effected as if
  924. simultaneously set with respect to all other assignments specified in
  925. the same message.
  926. The receiving entity then sends to the originator of the received
  927. message the GetResponse-PDU of identical form except that the value
  928. of the error-status field of the generated message is noError and the
  929. value of the error-index field is zero.
  930. Case, Fedor, Schoffstall, & Davin [Page 25]
  931. RFC 1098 SNMP April 1989
  932. 4.1.6. The Trap-PDU
  933. The form of the Trap-PDU is:
  934. Trap-PDU ::=
  935. [4]
  936. IMPLICIT SEQUENCE {
  937. enterprise -- type of object generating
  938. -- trap, see sysObjectID in [2]
  939. OBJECT IDENTIFIER,
  940. agent-addr -- address of object generating
  941. NetworkAddress, -- trap
  942. generic-trap -- generic trap type
  943. INTEGER {
  944. coldStart(0),
  945. warmStart(1),
  946. linkDown(2),
  947. linkUp(3),
  948. authenticationFailure(4),
  949. egpNeighborLoss(5),
  950. enterpriseSpecific(6)
  951. },
  952. specific-trap -- specific code, present even
  953. INTEGER, -- if generic-trap is not
  954. -- enterpriseSpecific
  955. time-stamp -- time elapsed between the last
  956. TimeTicks, -- (re)initialization of the network
  957. -- entity and the generation of the
  958. trap
  959. variable-bindings -- "interesting" information
  960. VarBindList
  961. }
  962. The Trap-PDU is generated by a protocol entity only at the request of
  963. the SNMP application entity. The means by which an SNMP application
  964. entity selects the destination addresses of the SNMP application
  965. entities is implementation-specific.
  966. Upon receipt of the Trap-PDU, the receiving protocol entity presents
  967. its contents to its SNMP application entity.
  968. Case, Fedor, Schoffstall, & Davin [Page 26]
  969. RFC 1098 SNMP April 1989
  970. The significance of the variable-bindings component of the Trap-PDU
  971. is implementation-specific.
  972. Interpretations of the value of the generic-trap field are:
  973. 4.1.6.1. The coldStart Trap
  974. A coldStart(0) trap signifies that the sending protocol entity is
  975. reinitializing itself such that the agent's configuration or the
  976. protocol entity implementation may be altered.
  977. 4.1.6.2. The warmStart Trap
  978. A warmStart(1) trap signifies that the sending protocol entity is
  979. reinitializing itself such that neither the agent configuration nor
  980. the protocol entity implementation is altered.
  981. 4.1.6.3. The linkDown Trap
  982. A linkDown(2) trap signifies that the sending protocol entity
  983. recognizes a failure in one of the communication links represented in
  984. the agent's configuration.
  985. The Trap-PDU of type linkDown contains as the first element of its
  986. variable-bindings, the name and value of the ifIndex instance for the
  987. affected interface.
  988. 4.1.6.4. The linkUp Trap
  989. A linkUp(3) trap signifies that the sending protocol entity
  990. recognizes that one of the communication links represented in the
  991. agent's configuration has come up.
  992. The Trap-PDU of type linkUp contains as the first element of its
  993. variable-bindings, the name and value of the ifIndex instance for the
  994. affected interface.
  995. 4.1.6.5. The authenticationFailure Trap
  996. An authenticationFailure(4) trap signifies that the sending protocol
  997. entity is the addressee of a protocol message that is not properly
  998. authenticated. While implementations of the SNMP must be capable of
  999. generating this trap, they must also be capable of suppressing the
  1000. emission of such traps via an implementation-specific mechanism.
  1001. 4.1.6.6. The egpNeighborLoss Trap
  1002. An egpNeighborLoss(5) trap signifies that an EGP neighbor for whom
  1003. Case, Fedor, Schoffstall, & Davin [Page 27]
  1004. RFC 1098 SNMP April 1989
  1005. the sending protocol entity was an EGP peer has been marked down and
  1006. the peer relationship no longer obtains.
  1007. The Trap-PDU of type egpNeighborLoss contains as the first element of
  1008. its variable-bindings, the name and value of the egpNeighAddr
  1009. instance for the affected neighbor.
  1010. 4.1.6.7. The enterpriseSpecific Trap
  1011. A enterpriseSpecific(6) trap signifies that the sending protocol
  1012. entity recognizes that some enterprise-specific event has occurred.
  1013. The specific-trap field identifies the particular trap which
  1014. occurred.
  1015. Case, Fedor, Schoffstall, & Davin [Page 28]
  1016. RFC 1098 SNMP April 1989
  1017. 5. Definitions
  1018. RFC1098-SNMP DEFINITIONS ::= BEGIN
  1019. IMPORTS
  1020. ObjectName, ObjectSyntax, NetworkAddress, IpAddress, TimeTicks
  1021. FROM RFC1065-SMI;
  1022. -- top-level message
  1023. Message ::=
  1024. SEQUENCE {
  1025. version -- version-1 for this RFC
  1026. INTEGER {
  1027. version-1(0)
  1028. },
  1029. community -- community name
  1030. OCTET STRING,
  1031. data -- e.g., PDUs if trivial
  1032. ANY -- authentication is being used
  1033. }
  1034. -- protocol data units
  1035. PDUs ::=
  1036. CHOICE {
  1037. get-request
  1038. GetRequest-PDU,
  1039. get-next-request
  1040. GetNextRequest-PDU,
  1041. get-response
  1042. GetResponse-PDU,
  1043. set-request
  1044. SetRequest-PDU,
  1045. trap
  1046. Trap-PDU
  1047. }
  1048. Case, Fedor, Schoffstall, & Davin [Page 29]
  1049. RFC 1098 SNMP April 1989
  1050. -- PDUs
  1051. GetRequest-PDU ::=
  1052. [0]
  1053. IMPLICIT PDU
  1054. GetNextRequest-PDU ::=
  1055. [1]
  1056. IMPLICIT PDU
  1057. GetResponse-PDU ::=
  1058. [2]
  1059. IMPLICIT PDU
  1060. SetRequest-PDU ::=
  1061. [3]
  1062. IMPLICIT PDU
  1063. PDU ::=
  1064. SEQUENCE {
  1065. request-id
  1066. INTEGER,
  1067. error-status -- sometimes ignored
  1068. INTEGER {
  1069. noError(0),
  1070. tooBig(1),
  1071. noSuchName(2),
  1072. badValue(3),
  1073. readOnly(4),
  1074. genErr(5)
  1075. },
  1076. error-index -- sometimes ignored
  1077. INTEGER,
  1078. variable-bindings -- values are sometimes ignored
  1079. VarBindList
  1080. }
  1081. Trap-PDU ::=
  1082. [4]
  1083. IMPLICIT SEQUENCE {
  1084. enterprise -- type of object generating
  1085. -- trap, see sysObjectID in [2]
  1086. OBJECT IDENTIFIER,
  1087. Case, Fedor, Schoffstall, & Davin [Page 30]
  1088. RFC 1098 SNMP April 1989
  1089. agent-addr -- address of object generating
  1090. NetworkAddress, -- trap
  1091. generic-trap -- generic trap type
  1092. INTEGER {
  1093. coldStart(0),
  1094. warmStart(1),
  1095. linkDown(2),
  1096. linkUp(3),
  1097. authenticationFailure(4),
  1098. egpNeighborLoss(5),
  1099. enterpriseSpecific(6)
  1100. },
  1101. specific-trap -- specific code, present even
  1102. INTEGER, -- if generic-trap is not
  1103. -- enterpriseSpecific
  1104. time-stamp -- time elapsed between the last
  1105. TimeTicks, -- (re)initialization of the
  1106. network
  1107. -- entity and the generation of the
  1108. trap
  1109. variable-bindings -- "interesting" information
  1110. VarBindList
  1111. }
  1112. -- variable bindings
  1113. VarBind ::=
  1114. SEQUENCE {
  1115. name
  1116. ObjectName,
  1117. value
  1118. ObjectSyntax
  1119. }
  1120. VarBindList ::=
  1121. SEQUENCE OF
  1122. VarBind
  1123. END
  1124. Case, Fedor, Schoffstall, & Davin [Page 31]
  1125. RFC 1098 SNMP April 1989
  1126. 6. Acknowledgements
  1127. This memo was influenced by the IETF SNMP Extensions working
  1128. group:
  1129. Karl Auerbach, Epilogue Technology
  1130. K. Ramesh Babu, Excelan
  1131. Amatzia Ben-Artzi, 3Com/Bridge
  1132. Lawrence Besaw, Hewlett-Packard
  1133. Jeffrey D. Case, University of Tennessee at Knoxville
  1134. Anthony Chung, Sytek
  1135. James Davidson, The Wollongong Group
  1136. James R. Davin, MIT Laboratory for Computer Science
  1137. Mark S. Fedor, NYSERNet
  1138. Phill Gross, The MITRE Corporation
  1139. Satish Joshi, ACC
  1140. Dan Lynch, Advanced Computing Environments
  1141. Keith McCloghrie, The Wollongong Group
  1142. Marshall T. Rose, The Wollongong Group (chair)
  1143. Greg Satz, cisco
  1144. Martin Lee Schoffstall, Rensselaer Polytechnic Institute
  1145. Wengyik Yeong, NYSERNet
  1146. Case, Fedor, Schoffstall, & Davin [Page 32]
  1147. RFC 1098 SNMP April 1989
  1148. 7. References
  1149. [1] Cerf, V., "IAB Recommendations for the Development of
  1150. Internet Network Management Standards", RFC 1052, IAB,
  1151. April 1988.
  1152. [2] Rose, M., and K. McCloghrie, "Structure and Identification
  1153. of Management Information for TCP/IP-based internets",
  1154. RFC 1065, TWG, August 1988.
  1155. [3] McCloghrie, K., and M. Rose, "Management Information Base
  1156. for Network Management of TCP/IP-based internets",
  1157. RFC 1066, TWG, August 1988.
  1158. [4] Case, J., M. Fedor, M. Schoffstall, and J. Davin,
  1159. "A Simple Network Management Protocol", Internet
  1160. Engineering Task Force working note, Network Information
  1161. Center, SRI International, Menlo Park, California,
  1162. March 1988.
  1163. [5] Davin, J., J. Case, M. Fedor, and M. Schoffstall,
  1164. "A Simple Gateway Monitoring Protocol", RFC 1028,
  1165. Proteon, University of Tennessee at Knoxville,
  1166. Cornell University, and Rensselaer Polytechnic
  1167. Institute, November 1987.
  1168. [6] Information processing systems - Open Systems
  1169. Interconnection, "Specification of Abstract Syntax
  1170. Notation One (ASN.1)", International Organization for
  1171. Standardization, International Standard 8824,
  1172. December 1987.
  1173. [7] Information processing systems - Open Systems
  1174. Interconnection, "Specification of Basic Encoding Rules
  1175. for Abstract Notation One (ASN.1)", International
  1176. Organization for Standardization, International Standard
  1177. 8825, December 1987.
  1178. [8] Postel, J., "User Datagram Protocol", RFC 768,
  1179. USC/Information Sciences Institute, November 1980.
  1180. [9] Warrier, U., and L. Besaw, "The Common Management Information
  1181. Services and Protocol over TCP/IP", RFC 1095, Unisys Corporation
  1182. and Hewlett-Packard, April 1989.
  1183. Case, Fedor, Schoffstall, & Davin [Page 33]
  1184. RFC 1098 SNMP April 1989
  1185. Authors' Addresses
  1186. Jeffrey D. Case
  1187. University of Tennessee Computing Center
  1188. Associate Driector
  1189. 200 Stokely Management Center
  1190. Knoxville, TN 37996-0520
  1191. Phone: (615) 974-6721
  1192. Email: case@UTKUX1.UTK.EDU
  1193. Mark Fedor
  1194. Nysernet, Inc.
  1195. Rensselaer Technology Park
  1196. 125 Jordan Road
  1197. Troy, NY 12180
  1198. Phone: (518) 283-8860
  1199. Email: fedor@patton.NYSER.NET
  1200. Martin Lee Schoffstall
  1201. NYSERNET Inc.
  1202. Rensselaer Technology Park
  1203. 165 Jordan Road
  1204. Troy, NY 12180
  1205. Phone: (518) 283-8860
  1206. Email: schoff@NISC.NYSER.NET
  1207. Chuck Davin
  1208. MIT Laboratory for Computer Science, NE43-507
  1209. 545 Technology Square
  1210. Cambridge, MA 02139
  1211. Phone: (617) 253-6020
  1212. EMail: jrd@ptt.lcs.mit.edu
  1213. Case, Fedor, Schoffstall, & Davin [Page 34]