| 1 |
<pre>Network Working Group Editors of this version: |
| 2 |
Request for Comments: 2578 K. McCloghrie |
| 3 |
STD: 58 Cisco Systems |
| 4 |
Obsoletes: <a href="./rfc1902">1902</a> D. Perkins |
| 5 |
Category: Standards Track SNMPinfo |
| 6 |
J. Schoenwaelder |
| 7 |
TU Braunschweig |
| 8 |
Authors of previous version: |
| 9 |
J. Case |
| 10 |
SNMP Research |
| 11 |
K. McCloghrie |
| 12 |
Cisco Systems |
| 13 |
M. Rose |
| 14 |
First Virtual Holdings |
| 15 |
S. Waldbusser |
| 16 |
International Network Services |
| 17 |
April 1999 |
| 18 |
|
| 19 |
|
| 20 |
<span class="h1">Structure of Management Information Version 2 (SMIv2)</span> |
| 21 |
|
| 22 |
|
| 23 |
Status of this Memo |
| 24 |
|
| 25 |
This document specifies an Internet standards track protocol for the |
| 26 |
Internet community, and requests discussion and suggestions for |
| 27 |
improvements. Please refer to the current edition of the "Internet |
| 28 |
Official Protocol Standards" (STD 1) for the standardization state |
| 29 |
and status of this protocol. Distribution of this memo is unlimited. |
| 30 |
|
| 31 |
Copyright Notice |
| 32 |
|
| 33 |
Copyright (C) The Internet Society (1999). All Rights Reserved. |
| 34 |
|
| 35 |
|
| 36 |
Table of Contents |
| 37 |
|
| 38 |
<a href="#section-1">1</a> Introduction .................................................<a href="#page-3">3</a> |
| 39 |
<a href="#section-1.1">1.1</a> A Note on Terminology ......................................<a href="#page-4">4</a> |
| 40 |
<a href="#section-2">2</a> Definitions ..................................................<a href="#page-4">4</a> |
| 41 |
<a href="#section-2.1">2.1</a> The MODULE-IDENTITY macro ..................................<a href="#page-5">5</a> |
| 42 |
<a href="#section-2.2">2.2</a> Object Names and Syntaxes ..................................<a href="#page-5">5</a> |
| 43 |
<a href="#section-2.3">2.3</a> The OBJECT-TYPE macro ......................................<a href="#page-8">8</a> |
| 44 |
<a href="#section-2.5">2.5</a> The NOTIFICATION-TYPE macro ...............................<a href="#page-10">10</a> |
| 45 |
<a href="#section-2.6">2.6</a> Administrative Identifiers ................................<a href="#page-11">11</a> |
| 46 |
<a href="#section-3">3</a> Information Modules .........................................<a href="#page-11">11</a> |
| 47 |
<a href="#section-3.1">3.1</a> Macro Invocation ..........................................<a href="#page-12">12</a> |
| 48 |
<a href="#section-3.1.1">3.1.1</a> Textual Values and Strings ..............................<a href="#page-13">13</a> |
| 49 |
|
| 50 |
|
| 51 |
<span class="grey">McCloghrie, et al. Standards Track [Page 1]</span></pre> |
| 52 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 53 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 54 |
|
| 55 |
|
| 56 |
<a href="#section-3.2">3.2</a> IMPORTing Symbols .........................................<a href="#page-14">14</a> |
| 57 |
<a href="#section-3.3">3.3</a> Exporting Symbols .........................................<a href="#page-14">14</a> |
| 58 |
<a href="#section-3.4">3.4</a> ASN.1 Comments ............................................<a href="#page-14">14</a> |
| 59 |
<a href="#section-3.5">3.5</a> OBJECT IDENTIFIER values ..................................<a href="#page-15">15</a> |
| 60 |
<a href="#section-3.6">3.6</a> OBJECT IDENTIFIER usage ...................................<a href="#page-15">15</a> |
| 61 |
<a href="#section-3.7">3.7</a> Reserved Keywords .........................................<a href="#page-16">16</a> |
| 62 |
<a href="#section-4">4</a> Naming Hierarchy ............................................<a href="#page-16">16</a> |
| 63 |
<a href="#section-5">5</a> Mapping of the MODULE-IDENTITY macro ........................<a href="#page-17">17</a> |
| 64 |
<a href="#section-5.1">5.1</a> Mapping of the LAST-UPDATED clause ........................<a href="#page-17">17</a> |
| 65 |
<a href="#section-5.2">5.2</a> Mapping of the ORGANIZATION clause ........................<a href="#page-17">17</a> |
| 66 |
<a href="#section-5.3">5.3</a> Mapping of the CONTACT-INFO clause ........................<a href="#page-18">18</a> |
| 67 |
<a href="#section-5.4">5.4</a> Mapping of the DESCRIPTION clause .........................<a href="#page-18">18</a> |
| 68 |
<a href="#section-5.5">5.5</a> Mapping of the REVISION clause ............................<a href="#page-18">18</a> |
| 69 |
<a href="#section-5.5.1">5.5.1</a> Mapping of the DESCRIPTION sub-clause ...................<a href="#page-18">18</a> |
| 70 |
<a href="#section-5.6">5.6</a> Mapping of the MODULE-IDENTITY value ......................<a href="#page-18">18</a> |
| 71 |
<a href="#section-5.7">5.7</a> Usage Example .............................................<a href="#page-18">18</a> |
| 72 |
<a href="#section-6">6</a> Mapping of the OBJECT-IDENTITY macro ........................<a href="#page-19">19</a> |
| 73 |
<a href="#section-6.1">6.1</a> Mapping of the STATUS clause ..............................<a href="#page-19">19</a> |
| 74 |
<a href="#section-6.2">6.2</a> Mapping of the DESCRIPTION clause .........................<a href="#page-20">20</a> |
| 75 |
<a href="#section-6.3">6.3</a> Mapping of the REFERENCE clause ...........................<a href="#page-20">20</a> |
| 76 |
<a href="#section-6.4">6.4</a> Mapping of the OBJECT-IDENTITY value ......................<a href="#page-20">20</a> |
| 77 |
<a href="#section-6.5">6.5</a> Usage Example .............................................<a href="#page-20">20</a> |
| 78 |
<a href="#section-7">7</a> Mapping of the OBJECT-TYPE macro ............................<a href="#page-20">20</a> |
| 79 |
<a href="#section-7.1">7.1</a> Mapping of the SYNTAX clause ..............................<a href="#page-21">21</a> |
| 80 |
<a href="#section-7.1.1">7.1.1</a> Integer32 and INTEGER ...................................<a href="#page-21">21</a> |
| 81 |
<a href="#section-7.1.2">7.1.2</a> OCTET STRING ............................................<a href="#page-21">21</a> |
| 82 |
<a href="#section-7.1.3">7.1.3</a> OBJECT IDENTIFIER .......................................<a href="#page-22">22</a> |
| 83 |
<a href="#section-7.1.4">7.1.4</a> The BITS construct ......................................<a href="#page-22">22</a> |
| 84 |
<a href="#section-7.1.5">7.1.5</a> IpAddress ...............................................<a href="#page-22">22</a> |
| 85 |
<a href="#section-7.1.6">7.1.6</a> Counter32 ...............................................<a href="#page-23">23</a> |
| 86 |
<a href="#section-7.1.7">7.1.7</a> Gauge32 .................................................<a href="#page-23">23</a> |
| 87 |
<a href="#section-7.1.8">7.1.8</a> TimeTicks ...............................................<a href="#page-24">24</a> |
| 88 |
<a href="#section-7.1.9">7.1.9</a> Opaque ..................................................<a href="#page-24">24</a> |
| 89 |
<a href="#section-7.1.10">7.1.10</a> Counter64 ..............................................<a href="#page-24">24</a> |
| 90 |
<a href="#section-7.1.11">7.1.11</a> Unsigned32 .............................................<a href="#page-25">25</a> |
| 91 |
<a href="#section-7.1.12">7.1.12</a> Conceptual Tables ......................................<a href="#page-25">25</a> |
| 92 |
<a href="#section-7.1.12.1">7.1.12.1</a> Creation and Deletion of Conceptual Rows .............<a href="#page-26">26</a> |
| 93 |
<a href="#section-7.2">7.2</a> Mapping of the UNITS clause ...............................<a href="#page-26">26</a> |
| 94 |
<a href="#section-7.3">7.3</a> Mapping of the MAX-ACCESS clause ..........................<a href="#page-26">26</a> |
| 95 |
<a href="#section-7.4">7.4</a> Mapping of the STATUS clause ..............................<a href="#page-27">27</a> |
| 96 |
<a href="#section-7.5">7.5</a> Mapping of the DESCRIPTION clause .........................<a href="#page-27">27</a> |
| 97 |
<a href="#section-7.6">7.6</a> Mapping of the REFERENCE clause ...........................<a href="#page-27">27</a> |
| 98 |
<a href="#section-7.7">7.7</a> Mapping of the INDEX clause ...............................<a href="#page-27">27</a> |
| 99 |
<a href="#section-7.8">7.8</a> Mapping of the AUGMENTS clause ............................<a href="#page-29">29</a> |
| 100 |
<a href="#section-7.8.1">7.8.1</a> Relation between INDEX and AUGMENTS clauses .............<a href="#page-30">30</a> |
| 101 |
<a href="#section-7.9">7.9</a> Mapping of the DEFVAL clause ..............................<a href="#page-30">30</a> |
| 102 |
<a href="#section-7.10">7.10</a> Mapping of the OBJECT-TYPE value .........................<a href="#page-31">31</a> |
| 103 |
<a href="#section-7.11">7.11</a> Usage Example ............................................<a href="#page-32">32</a> |
| 104 |
|
| 105 |
|
| 106 |
<span class="grey">McCloghrie, et al. Standards Track [Page 2]</span></pre> |
| 107 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 108 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 109 |
|
| 110 |
|
| 111 |
<a href="#section-8">8</a> Mapping of the NOTIFICATION-TYPE macro ......................<a href="#page-34">34</a> |
| 112 |
<a href="#section-8.1">8.1</a> Mapping of the OBJECTS clause .............................<a href="#page-34">34</a> |
| 113 |
<a href="#section-8.2">8.2</a> Mapping of the STATUS clause ..............................<a href="#page-34">34</a> |
| 114 |
<a href="#section-8.3">8.3</a> Mapping of the DESCRIPTION clause .........................<a href="#page-35">35</a> |
| 115 |
<a href="#section-8.4">8.4</a> Mapping of the REFERENCE clause ...........................<a href="#page-35">35</a> |
| 116 |
<a href="#section-8.5">8.5</a> Mapping of the NOTIFICATION-TYPE value ....................<a href="#page-35">35</a> |
| 117 |
<a href="#section-8.6">8.6</a> Usage Example .............................................<a href="#page-35">35</a> |
| 118 |
<a href="#section-9">9</a> Refined Syntax ..............................................<a href="#page-36">36</a> |
| 119 |
<a href="#section-10">10</a> Extending an Information Module ............................<a href="#page-37">37</a> |
| 120 |
<a href="#section-10.1">10.1</a> Object Assignments .......................................<a href="#page-37">37</a> |
| 121 |
<a href="#section-10.2">10.2</a> Object Definitions .......................................<a href="#page-38">38</a> |
| 122 |
<a href="#section-10.3">10.3</a> Notification Definitions .................................<a href="#page-39">39</a> |
| 123 |
<a href="#section-11">11</a> <a href="#appendix-A">Appendix A</a>: Detailed Sub-typing Rules ......................<a href="#page-40">40</a> |
| 124 |
<a href="#section-11.1">11.1</a> Syntax Rules .............................................<a href="#page-40">40</a> |
| 125 |
<a href="#section-11.2">11.2</a> Examples .................................................<a href="#page-41">41</a> |
| 126 |
<a href="#section-12">12</a> Security Considerations ....................................<a href="#page-41">41</a> |
| 127 |
<a href="#section-13">13</a> Editors' Addresses .........................................<a href="#page-41">41</a> |
| 128 |
<a href="#section-14">14</a> References .................................................<a href="#page-42">42</a> |
| 129 |
<a href="#section-15">15</a> Full Copyright Statement ...................................<a href="#page-43">43</a> |
| 130 |
|
| 131 |
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span> |
| 132 |
|
| 133 |
Management information is viewed as a collection of managed objects, |
| 134 |
residing in a virtual information store, termed the Management |
| 135 |
Information Base (MIB). Collections of related objects are defined |
| 136 |
in MIB modules. These modules are written using an adapted subset of |
| 137 |
OSI's Abstract Syntax Notation One, ASN.1 (1988) [<a href="#ref-1" title="(December">1</a>]. It is the |
| 138 |
purpose of this document, the Structure of Management Information |
| 139 |
(SMI), to define that adapted subset, and to assign a set of |
| 140 |
associated administrative values. |
| 141 |
|
| 142 |
The SMI is divided into three parts: module definitions, object |
| 143 |
definitions, and, notification definitions. |
| 144 |
|
| 145 |
(1) Module definitions are used when describing information modules. |
| 146 |
An ASN.1 macro, MODULE-IDENTITY, is used to concisely convey the |
| 147 |
semantics of an information module. |
| 148 |
|
| 149 |
(2) Object definitions are used when describing managed objects. An |
| 150 |
ASN.1 macro, OBJECT-TYPE, is used to concisely convey the syntax |
| 151 |
and semantics of a managed object. |
| 152 |
|
| 153 |
(3) Notification definitions are used when describing unsolicited |
| 154 |
transmissions of management information. An ASN.1 macro, |
| 155 |
NOTIFICATION-TYPE, is used to concisely convey the syntax and |
| 156 |
semantics of a notification. |
| 157 |
|
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
<span class="grey">McCloghrie, et al. Standards Track [Page 3]</span></pre> |
| 162 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 163 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 164 |
|
| 165 |
|
| 166 |
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. A Note on Terminology</span> |
| 167 |
|
| 168 |
For the purpose of exposition, the original Structure of Management |
| 169 |
Information, as described in RFCs 1155 (STD 16), 1212 (STD 16), and |
| 170 |
<a href="./rfc1215">RFC 1215</a>, is termed the SMI version 1 (SMIv1). The current version |
| 171 |
of the Structure of Management Information is termed SMI version 2 |
| 172 |
(SMIv2). |
| 173 |
|
| 174 |
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Definitions</span> |
| 175 |
|
| 176 |
SNMPv2-SMI DEFINITIONS ::= BEGIN |
| 177 |
|
| 178 |
|
| 179 |
-- the path to the root |
| 180 |
|
| 181 |
org OBJECT IDENTIFIER ::= { iso 3 } -- "iso" = 1 |
| 182 |
dod OBJECT IDENTIFIER ::= { org 6 } |
| 183 |
internet OBJECT IDENTIFIER ::= { dod 1 } |
| 184 |
|
| 185 |
directory OBJECT IDENTIFIER ::= { internet 1 } |
| 186 |
|
| 187 |
mgmt OBJECT IDENTIFIER ::= { internet 2 } |
| 188 |
mib-2 OBJECT IDENTIFIER ::= { mgmt 1 } |
| 189 |
transmission OBJECT IDENTIFIER ::= { mib-2 10 } |
| 190 |
|
| 191 |
experimental OBJECT IDENTIFIER ::= { internet 3 } |
| 192 |
|
| 193 |
private OBJECT IDENTIFIER ::= { internet 4 } |
| 194 |
enterprises OBJECT IDENTIFIER ::= { private 1 } |
| 195 |
|
| 196 |
security OBJECT IDENTIFIER ::= { internet 5 } |
| 197 |
|
| 198 |
snmpV2 OBJECT IDENTIFIER ::= { internet 6 } |
| 199 |
|
| 200 |
-- transport domains |
| 201 |
snmpDomains OBJECT IDENTIFIER ::= { snmpV2 1 } |
| 202 |
|
| 203 |
-- transport proxies |
| 204 |
snmpProxys OBJECT IDENTIFIER ::= { snmpV2 2 } |
| 205 |
|
| 206 |
-- module identities |
| 207 |
snmpModules OBJECT IDENTIFIER ::= { snmpV2 3 } |
| 208 |
|
| 209 |
-- Extended UTCTime, to allow dates with four-digit years |
| 210 |
-- (Note that this definition of ExtUTCTime is not to be IMPORTed |
| 211 |
-- by MIB modules.) |
| 212 |
ExtUTCTime ::= OCTET STRING(SIZE(11 | 13)) |
| 213 |
-- format is YYMMDDHHMMZ or YYYYMMDDHHMMZ |
| 214 |
|
| 215 |
|
| 216 |
<span class="grey">McCloghrie, et al. Standards Track [Page 4]</span></pre> |
| 217 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 218 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 219 |
|
| 220 |
|
| 221 |
-- where: YY - last two digits of year (only years |
| 222 |
-- between 1900-1999) |
| 223 |
-- YYYY - last four digits of the year (any year) |
| 224 |
-- MM - month (01 through 12) |
| 225 |
-- DD - day of month (01 through 31) |
| 226 |
-- HH - hours (00 through 23) |
| 227 |
-- MM - minutes (00 through 59) |
| 228 |
-- Z - denotes GMT (the ASCII character Z) |
| 229 |
-- |
| 230 |
-- For example, "9502192015Z" and "199502192015Z" represent |
| 231 |
-- 8:15pm GMT on 19 February 1995. Years after 1999 must use |
| 232 |
-- the four digit year format. Years 1900-1999 may use the |
| 233 |
-- two or four digit format. |
| 234 |
|
| 235 |
-- definitions for information modules |
| 236 |
|
| 237 |
MODULE-IDENTITY MACRO ::= |
| 238 |
BEGIN |
| 239 |
TYPE NOTATION ::= |
| 240 |
"LAST-UPDATED" value(Update ExtUTCTime) |
| 241 |
"ORGANIZATION" Text |
| 242 |
"CONTACT-INFO" Text |
| 243 |
"DESCRIPTION" Text |
| 244 |
RevisionPart |
| 245 |
|
| 246 |
VALUE NOTATION ::= |
| 247 |
value(VALUE OBJECT IDENTIFIER) |
| 248 |
|
| 249 |
RevisionPart ::= |
| 250 |
Revisions |
| 251 |
| empty |
| 252 |
Revisions ::= |
| 253 |
Revision |
| 254 |
| Revisions Revision |
| 255 |
Revision ::= |
| 256 |
"REVISION" value(Update ExtUTCTime) |
| 257 |
"DESCRIPTION" Text |
| 258 |
|
| 259 |
-- a character string as defined in <a href="#section-3.1.1">section 3.1.1</a> |
| 260 |
Text ::= value(IA5String) |
| 261 |
END |
| 262 |
|
| 263 |
|
| 264 |
OBJECT-IDENTITY MACRO ::= |
| 265 |
BEGIN |
| 266 |
TYPE NOTATION ::= |
| 267 |
"STATUS" Status |
| 268 |
"DESCRIPTION" Text |
| 269 |
|
| 270 |
|
| 271 |
<span class="grey">McCloghrie, et al. Standards Track [Page 5]</span></pre> |
| 272 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span> |
| 273 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 274 |
|
| 275 |
|
| 276 |
ReferPart |
| 277 |
|
| 278 |
VALUE NOTATION ::= |
| 279 |
value(VALUE OBJECT IDENTIFIER) |
| 280 |
|
| 281 |
Status ::= |
| 282 |
"current" |
| 283 |
| "deprecated" |
| 284 |
| "obsolete" |
| 285 |
|
| 286 |
ReferPart ::= |
| 287 |
"REFERENCE" Text |
| 288 |
| empty |
| 289 |
|
| 290 |
-- a character string as defined in <a href="#section-3.1.1">section 3.1.1</a> |
| 291 |
Text ::= value(IA5String) |
| 292 |
END |
| 293 |
|
| 294 |
|
| 295 |
-- names of objects |
| 296 |
-- (Note that these definitions of ObjectName and NotificationName |
| 297 |
-- are not to be IMPORTed by MIB modules.) |
| 298 |
|
| 299 |
ObjectName ::= |
| 300 |
OBJECT IDENTIFIER |
| 301 |
|
| 302 |
NotificationName ::= |
| 303 |
OBJECT IDENTIFIER |
| 304 |
|
| 305 |
-- syntax of objects |
| 306 |
|
| 307 |
-- the "base types" defined here are: |
| 308 |
-- 3 built-in ASN.1 types: INTEGER, OCTET STRING, OBJECT IDENTIFIER |
| 309 |
-- 8 application-defined types: Integer32, IpAddress, Counter32, |
| 310 |
-- Gauge32, Unsigned32, TimeTicks, Opaque, and Counter64 |
| 311 |
|
| 312 |
ObjectSyntax ::= |
| 313 |
CHOICE { |
| 314 |
simple |
| 315 |
SimpleSyntax, |
| 316 |
|
| 317 |
-- note that SEQUENCEs for conceptual tables and |
| 318 |
-- rows are not mentioned here... |
| 319 |
|
| 320 |
application-wide |
| 321 |
ApplicationSyntax |
| 322 |
} |
| 323 |
|
| 324 |
|
| 325 |
|
| 326 |
<span class="grey">McCloghrie, et al. Standards Track [Page 6]</span></pre> |
| 327 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span> |
| 328 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 329 |
|
| 330 |
|
| 331 |
-- built-in ASN.1 types |
| 332 |
|
| 333 |
SimpleSyntax ::= |
| 334 |
CHOICE { |
| 335 |
-- INTEGERs with a more restrictive range |
| 336 |
-- may also be used |
| 337 |
integer-value -- includes Integer32 |
| 338 |
INTEGER (-2147483648..2147483647), |
| 339 |
|
| 340 |
-- OCTET STRINGs with a more restrictive size |
| 341 |
-- may also be used |
| 342 |
string-value |
| 343 |
OCTET STRING (SIZE (0..65535)), |
| 344 |
|
| 345 |
objectID-value |
| 346 |
OBJECT IDENTIFIER |
| 347 |
} |
| 348 |
|
| 349 |
-- indistinguishable from INTEGER, but never needs more than |
| 350 |
-- 32-bits for a two's complement representation |
| 351 |
Integer32 ::= |
| 352 |
INTEGER (-2147483648..2147483647) |
| 353 |
|
| 354 |
|
| 355 |
-- application-wide types |
| 356 |
|
| 357 |
ApplicationSyntax ::= |
| 358 |
CHOICE { |
| 359 |
ipAddress-value |
| 360 |
IpAddress, |
| 361 |
|
| 362 |
counter-value |
| 363 |
Counter32, |
| 364 |
|
| 365 |
timeticks-value |
| 366 |
TimeTicks, |
| 367 |
|
| 368 |
arbitrary-value |
| 369 |
Opaque, |
| 370 |
|
| 371 |
big-counter-value |
| 372 |
Counter64, |
| 373 |
|
| 374 |
unsigned-integer-value -- includes Gauge32 |
| 375 |
Unsigned32 |
| 376 |
} |
| 377 |
|
| 378 |
-- in network-byte order |
| 379 |
|
| 380 |
|
| 381 |
<span class="grey">McCloghrie, et al. Standards Track [Page 7]</span></pre> |
| 382 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span> |
| 383 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 384 |
|
| 385 |
|
| 386 |
-- (this is a tagged type for historical reasons) |
| 387 |
IpAddress ::= |
| 388 |
[APPLICATION 0] |
| 389 |
IMPLICIT OCTET STRING (SIZE (4)) |
| 390 |
|
| 391 |
-- this wraps |
| 392 |
Counter32 ::= |
| 393 |
[APPLICATION 1] |
| 394 |
IMPLICIT INTEGER (0..4294967295) |
| 395 |
|
| 396 |
-- this doesn't wrap |
| 397 |
Gauge32 ::= |
| 398 |
[APPLICATION 2] |
| 399 |
IMPLICIT INTEGER (0..4294967295) |
| 400 |
|
| 401 |
-- an unsigned 32-bit quantity |
| 402 |
-- indistinguishable from Gauge32 |
| 403 |
Unsigned32 ::= |
| 404 |
[APPLICATION 2] |
| 405 |
IMPLICIT INTEGER (0..4294967295) |
| 406 |
|
| 407 |
-- hundredths of seconds since an epoch |
| 408 |
TimeTicks ::= |
| 409 |
[APPLICATION 3] |
| 410 |
IMPLICIT INTEGER (0..4294967295) |
| 411 |
|
| 412 |
-- for backward-compatibility only |
| 413 |
Opaque ::= |
| 414 |
[APPLICATION 4] |
| 415 |
IMPLICIT OCTET STRING |
| 416 |
|
| 417 |
-- for counters that wrap in less than one hour with only 32 bits |
| 418 |
Counter64 ::= |
| 419 |
[APPLICATION 6] |
| 420 |
IMPLICIT INTEGER (0..18446744073709551615) |
| 421 |
|
| 422 |
|
| 423 |
-- definition for objects |
| 424 |
|
| 425 |
OBJECT-TYPE MACRO ::= |
| 426 |
BEGIN |
| 427 |
TYPE NOTATION ::= |
| 428 |
"SYNTAX" Syntax |
| 429 |
UnitsPart |
| 430 |
"MAX-ACCESS" Access |
| 431 |
"STATUS" Status |
| 432 |
"DESCRIPTION" Text |
| 433 |
ReferPart |
| 434 |
|
| 435 |
|
| 436 |
<span class="grey">McCloghrie, et al. Standards Track [Page 8]</span></pre> |
| 437 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span> |
| 438 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 439 |
|
| 440 |
|
| 441 |
IndexPart |
| 442 |
DefValPart |
| 443 |
|
| 444 |
VALUE NOTATION ::= |
| 445 |
value(VALUE ObjectName) |
| 446 |
|
| 447 |
Syntax ::= -- Must be one of the following: |
| 448 |
-- a base type (or its refinement), |
| 449 |
-- a textual convention (or its refinement), or |
| 450 |
-- a BITS pseudo-type |
| 451 |
type |
| 452 |
| "BITS" "{" NamedBits "}" |
| 453 |
|
| 454 |
NamedBits ::= NamedBit |
| 455 |
| NamedBits "," NamedBit |
| 456 |
|
| 457 |
NamedBit ::= identifier "(" number ")" -- number is nonnegative |
| 458 |
|
| 459 |
UnitsPart ::= |
| 460 |
"UNITS" Text |
| 461 |
| empty |
| 462 |
|
| 463 |
Access ::= |
| 464 |
"not-accessible" |
| 465 |
| "accessible-for-notify" |
| 466 |
| "read-only" |
| 467 |
| "read-write" |
| 468 |
| "read-create" |
| 469 |
|
| 470 |
Status ::= |
| 471 |
"current" |
| 472 |
| "deprecated" |
| 473 |
| "obsolete" |
| 474 |
|
| 475 |
ReferPart ::= |
| 476 |
"REFERENCE" Text |
| 477 |
| empty |
| 478 |
|
| 479 |
IndexPart ::= |
| 480 |
"INDEX" "{" IndexTypes "}" |
| 481 |
| "AUGMENTS" "{" Entry "}" |
| 482 |
| empty |
| 483 |
IndexTypes ::= |
| 484 |
IndexType |
| 485 |
| IndexTypes "," IndexType |
| 486 |
IndexType ::= |
| 487 |
"IMPLIED" Index |
| 488 |
| Index |
| 489 |
|
| 490 |
|
| 491 |
<span class="grey">McCloghrie, et al. Standards Track [Page 9]</span></pre> |
| 492 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span> |
| 493 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 494 |
|
| 495 |
|
| 496 |
Index ::= |
| 497 |
-- use the SYNTAX value of the |
| 498 |
-- correspondent OBJECT-TYPE invocation |
| 499 |
value(ObjectName) |
| 500 |
Entry ::= |
| 501 |
-- use the INDEX value of the |
| 502 |
-- correspondent OBJECT-TYPE invocation |
| 503 |
value(ObjectName) |
| 504 |
|
| 505 |
DefValPart ::= "DEFVAL" "{" Defvalue "}" |
| 506 |
| empty |
| 507 |
|
| 508 |
Defvalue ::= -- must be valid for the type specified in |
| 509 |
-- SYNTAX clause of same OBJECT-TYPE macro |
| 510 |
value(ObjectSyntax) |
| 511 |
| "{" BitsValue "}" |
| 512 |
|
| 513 |
BitsValue ::= BitNames |
| 514 |
| empty |
| 515 |
|
| 516 |
BitNames ::= BitName |
| 517 |
| BitNames "," BitName |
| 518 |
|
| 519 |
BitName ::= identifier |
| 520 |
|
| 521 |
-- a character string as defined in <a href="#section-3.1.1">section 3.1.1</a> |
| 522 |
Text ::= value(IA5String) |
| 523 |
END |
| 524 |
|
| 525 |
|
| 526 |
-- definitions for notifications |
| 527 |
|
| 528 |
NOTIFICATION-TYPE MACRO ::= |
| 529 |
BEGIN |
| 530 |
TYPE NOTATION ::= |
| 531 |
ObjectsPart |
| 532 |
"STATUS" Status |
| 533 |
"DESCRIPTION" Text |
| 534 |
ReferPart |
| 535 |
|
| 536 |
VALUE NOTATION ::= |
| 537 |
value(VALUE NotificationName) |
| 538 |
|
| 539 |
ObjectsPart ::= |
| 540 |
"OBJECTS" "{" Objects "}" |
| 541 |
| empty |
| 542 |
Objects ::= |
| 543 |
Object |
| 544 |
|
| 545 |
|
| 546 |
<span class="grey">McCloghrie, et al. Standards Track [Page 10]</span></pre> |
| 547 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span> |
| 548 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 549 |
|
| 550 |
|
| 551 |
| Objects "," Object |
| 552 |
Object ::= |
| 553 |
value(ObjectName) |
| 554 |
|
| 555 |
Status ::= |
| 556 |
"current" |
| 557 |
| "deprecated" |
| 558 |
| "obsolete" |
| 559 |
|
| 560 |
ReferPart ::= |
| 561 |
"REFERENCE" Text |
| 562 |
| empty |
| 563 |
|
| 564 |
-- a character string as defined in <a href="#section-3.1.1">section 3.1.1</a> |
| 565 |
Text ::= value(IA5String) |
| 566 |
END |
| 567 |
|
| 568 |
-- definitions of administrative identifiers |
| 569 |
|
| 570 |
zeroDotZero OBJECT-IDENTITY |
| 571 |
STATUS current |
| 572 |
DESCRIPTION |
| 573 |
"A value used for null identifiers." |
| 574 |
::= { 0 0 } |
| 575 |
|
| 576 |
END |
| 577 |
|
| 578 |
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Information Modules</span> |
| 579 |
|
| 580 |
An "information module" is an ASN.1 module defining information |
| 581 |
relating to network management. |
| 582 |
|
| 583 |
The SMI describes how to use an adapted subset of ASN.1 (1988) to |
| 584 |
define an information module. Further, additional restrictions are |
| 585 |
placed on "standard" information modules. It is strongly recommended |
| 586 |
that "enterprise-specific" information modules also adhere to these |
| 587 |
restrictions. |
| 588 |
|
| 589 |
Typically, there are three kinds of information modules: |
| 590 |
|
| 591 |
(1) MIB modules, which contain definitions of inter-related managed |
| 592 |
objects, make use of the OBJECT-TYPE and NOTIFICATION-TYPE macros; |
| 593 |
|
| 594 |
(2) compliance statements for MIB modules, which make use of the |
| 595 |
MODULE-COMPLIANCE and OBJECT-GROUP macros [<a href="#ref-2" title=""Conformance Statements for SMIv2"">2</a>]; and, |
| 596 |
|
| 597 |
(3) capability statements for agent implementations which make use of |
| 598 |
the AGENT-CAPABILITIES macros [<a href="#ref-2" title=""Conformance Statements for SMIv2"">2</a>]. |
| 599 |
|
| 600 |
|
| 601 |
<span class="grey">McCloghrie, et al. Standards Track [Page 11]</span></pre> |
| 602 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span> |
| 603 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 604 |
|
| 605 |
|
| 606 |
This classification scheme does not imply a rigid taxonomy. For |
| 607 |
example, a "standard" information module will normally include |
| 608 |
definitions of managed objects and a compliance statement. |
| 609 |
Similarly, an "enterprise-specific" information module might include |
| 610 |
definitions of managed objects and a capability statement. Of |
| 611 |
course, a "standard" information module may not contain capability |
| 612 |
statements. |
| 613 |
|
| 614 |
The constructs of ASN.1 allowed in SMIv2 information modules include: |
| 615 |
the IMPORTS clause, value definitions for OBJECT IDENTIFIERs, type |
| 616 |
definitions for SEQUENCEs (with restrictions), ASN.1 type assignments |
| 617 |
of the restricted ASN.1 types allowed in SMIv2, and instances of |
| 618 |
ASN.1 macros defined in this document and its companion documents [2, |
| 619 |
3]. Additional ASN.1 macros must not be defined in SMIv2 information |
| 620 |
modules. SMIv1 macros must not be used in SMIv2 information modules. |
| 621 |
|
| 622 |
The names of all standard information modules must be unique (but |
| 623 |
different versions of the same information module should have the |
| 624 |
same name). Developers of enterprise information modules are |
| 625 |
encouraged to choose names for their information modules that will |
| 626 |
have a low probability of colliding with standard or other enterprise |
| 627 |
information modules. An information module may not use the ASN.1 |
| 628 |
construct of placing an object identifier value between the module |
| 629 |
name and the "DEFINITIONS" keyword. For the purposes of this |
| 630 |
specification, an ASN.1 module name begins with an upper-case letter |
| 631 |
and continues with zero or more letters, digits, or hyphens, except |
| 632 |
that a hyphen can not be the last character, nor can there be two |
| 633 |
consecutive hyphens. |
| 634 |
|
| 635 |
All information modules start with exactly one invocation of the |
| 636 |
MODULE-IDENTITY macro, which provides contact information as well as |
| 637 |
revision history to distinguish between versions of the same |
| 638 |
information module. This invocation must appear immediately after |
| 639 |
any IMPORTs statements. |
| 640 |
|
| 641 |
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Macro Invocation</span> |
| 642 |
|
| 643 |
Within an information module, each macro invocation appears as: |
| 644 |
|
| 645 |
<descriptor> <macro> <clauses> ::= <value> |
| 646 |
|
| 647 |
where <descriptor> corresponds to an ASN.1 identifier, <macro> names |
| 648 |
the macro being invoked, and <clauses> and <value> depend on the |
| 649 |
definition of the macro. (Note that this definition of a descriptor |
| 650 |
applies to all macros defined in this memo and in [<a href="#ref-2" title=""Conformance Statements for SMIv2"">2</a>].) |
| 651 |
|
| 652 |
|
| 653 |
|
| 654 |
|
| 655 |
|
| 656 |
<span class="grey">McCloghrie, et al. Standards Track [Page 12]</span></pre> |
| 657 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span> |
| 658 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 659 |
|
| 660 |
|
| 661 |
For the purposes of this specification, an ASN.1 identifier consists |
| 662 |
of one or more letters or digits, and its initial character must be a |
| 663 |
lower-case letter. Note that hyphens are not allowed by this |
| 664 |
specification (except for use by information modules converted from |
| 665 |
SMIv1 which did allow hyphens). |
| 666 |
|
| 667 |
For all descriptors appearing in an information module, the |
| 668 |
descriptor shall be unique and mnemonic, and shall not exceed 64 |
| 669 |
characters in length. (However, descriptors longer than 32 |
| 670 |
characters are not recommended.) This promotes a common language for |
| 671 |
humans to use when discussing the information module and also |
| 672 |
facilitates simple table mappings for user-interfaces. |
| 673 |
|
| 674 |
The set of descriptors defined in all "standard" information modules |
| 675 |
shall be unique. |
| 676 |
|
| 677 |
Finally, by convention, if the descriptor refers to an object with a |
| 678 |
SYNTAX clause value of either Counter32 or Counter64, then the |
| 679 |
descriptor used for the object should denote plurality. |
| 680 |
|
| 681 |
<span class="h4"><a class="selflink" id="section-3.1.1" href="#section-3.1.1">3.1.1</a>. Textual Values and Strings</span> |
| 682 |
|
| 683 |
Some clauses in a macro invocation may take a character string as a |
| 684 |
textual value (e.g., the DESCRIPTION clause). Other clauses take |
| 685 |
binary or hexadecimal strings (in any position where a non-negative |
| 686 |
number is allowed). |
| 687 |
|
| 688 |
A character string is preceded and followed by the quote character |
| 689 |
("), and consists of an arbitrary number (possibly zero) of: |
| 690 |
|
| 691 |
- any 7-bit displayable ASCII characters except quote ("), |
| 692 |
- tab characters, |
| 693 |
- spaces, and |
| 694 |
- line terminator characters (\n or \r\n). |
| 695 |
|
| 696 |
The value of a character string is interpreted as ASCII. |
| 697 |
|
| 698 |
A binary string consists of a number (possibly zero) of zeros and |
| 699 |
ones preceded by a single (') and followed by either the pair ('B) or |
| 700 |
('b), where the number is a multiple of eight. |
| 701 |
|
| 702 |
A hexadecimal string consists of an even number (possibly zero) of |
| 703 |
hexadecimal digits, preceded by a single (') and followed by either |
| 704 |
the pair ('H) or ('h). Digits specified via letters can be in upper |
| 705 |
or lower case. |
| 706 |
|
| 707 |
Note that ASN.1 comments can not be enclosed inside any of these |
| 708 |
types of strings. |
| 709 |
|
| 710 |
|
| 711 |
<span class="grey">McCloghrie, et al. Standards Track [Page 13]</span></pre> |
| 712 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span> |
| 713 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 714 |
|
| 715 |
|
| 716 |
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. IMPORTing Symbols</span> |
| 717 |
|
| 718 |
To reference an external object, the IMPORTS statement must be used |
| 719 |
to identify both the descriptor and the module in which the |
| 720 |
descriptor is defined, where the module is identified by its ASN.1 |
| 721 |
module name. |
| 722 |
|
| 723 |
Note that when symbols from "enterprise-specific" information modules |
| 724 |
are referenced (e.g., a descriptor), there is the possibility of |
| 725 |
collision. As such, if different objects with the same descriptor |
| 726 |
are IMPORTed, then this ambiguity is resolved by prefixing the |
| 727 |
descriptor with the name of the information module and a dot ("."), |
| 728 |
i.e., |
| 729 |
|
| 730 |
"module.descriptor" |
| 731 |
|
| 732 |
(All descriptors must be unique within any information module.) |
| 733 |
|
| 734 |
Of course, this notation can be used to refer to objects even when |
| 735 |
there is no collision when IMPORTing symbols. |
| 736 |
|
| 737 |
Finally, if any of the ASN.1 named types and macros defined in this |
| 738 |
document, specifically: |
| 739 |
|
| 740 |
Counter32, Counter64, Gauge32, Integer32, IpAddress, MODULE- |
| 741 |
IDENTITY, NOTIFICATION-TYPE, Opaque, OBJECT-TYPE, OBJECT- |
| 742 |
IDENTITY, TimeTicks, Unsigned32, |
| 743 |
|
| 744 |
or any of those defined in [<a href="#ref-2" title=""Conformance Statements for SMIv2"">2</a>] or [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>], are used in an information |
| 745 |
module, then they must be imported using the IMPORTS statement. |
| 746 |
However, the following must not be included in an IMPORTS statement: |
| 747 |
|
| 748 |
- named types defined by ASN.1 itself, specifically: INTEGER, |
| 749 |
OCTET STRING, OBJECT IDENTIFIER, SEQUENCE, SEQUENCE OF type, |
| 750 |
- the BITS construct. |
| 751 |
|
| 752 |
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Exporting Symbols</span> |
| 753 |
|
| 754 |
The ASN.1 EXPORTS statement is not allowed in SMIv2 information |
| 755 |
modules. All items defined in an information module are |
| 756 |
automatically exported. |
| 757 |
|
| 758 |
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. ASN.1 Comments</span> |
| 759 |
|
| 760 |
ASN.1 comments can be included in an information module. However, it |
| 761 |
is recommended that all substantive descriptions be placed within an |
| 762 |
appropriate DESCRIPTION clause. |
| 763 |
|
| 764 |
|
| 765 |
|
| 766 |
<span class="grey">McCloghrie, et al. Standards Track [Page 14]</span></pre> |
| 767 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span> |
| 768 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 769 |
|
| 770 |
|
| 771 |
ASN.1 comments commence with a pair of adjacent hyphens and end with |
| 772 |
the next pair of adjacent hyphens or at the end of the line, |
| 773 |
whichever occurs first. Comments ended by a pair of hyphens have the |
| 774 |
effect of a single space character. |
| 775 |
|
| 776 |
<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. OBJECT IDENTIFIER values</span> |
| 777 |
|
| 778 |
An OBJECT IDENTIFIER value is an ordered list of non-negative |
| 779 |
numbers. For the SMIv2, each number in the list is referred to as a |
| 780 |
sub-identifier, there are at most 128 sub-identifiers in a value, and |
| 781 |
each sub-identifier has a maximum value of 2^32-1 (4294967295 |
| 782 |
decimal). |
| 783 |
|
| 784 |
All OBJECT IDENTIFIER values have at least two sub-identifiers, where |
| 785 |
the value of the first sub-identifier is one of the following well- |
| 786 |
known names: |
| 787 |
|
| 788 |
Value Name |
| 789 |
0 ccitt |
| 790 |
1 iso |
| 791 |
2 joint-iso-ccitt |
| 792 |
|
| 793 |
(Note that this SMI does not recognize "new" well-known names, e.g., |
| 794 |
as defined when the CCITT became the ITU.) |
| 795 |
|
| 796 |
<span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a>. OBJECT IDENTIFIER usage</span> |
| 797 |
|
| 798 |
OBJECT IDENTIFIERs are used in information modules in two ways: |
| 799 |
|
| 800 |
(1) registration: the definition of a particular item is registered as |
| 801 |
a particular OBJECT IDENTIFIER value, and associated with a |
| 802 |
particular descriptor. After such a registration, the semantics |
| 803 |
thereby associated with the value are not allowed to change, the |
| 804 |
OBJECT IDENTIFIER can not be used for any other registration, and |
| 805 |
the descriptor can not be changed nor associated with any other |
| 806 |
registration. The following macros result in a registration: |
| 807 |
|
| 808 |
OBJECT-TYPE, MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-GROUP, |
| 809 |
OBJECT-IDENTITY, NOTIFICATION-GROUP, MODULE-COMPLIANCE, |
| 810 |
AGENT-CAPABILITIES. |
| 811 |
|
| 812 |
(2) assignment: a descriptor can be assigned to a particular OBJECT |
| 813 |
IDENTIFIER value. For this usage, the semantics associated with |
| 814 |
the OBJECT IDENTIFIER value is not allowed to change, and a |
| 815 |
descriptor assigned to a particular OBJECT IDENTIFIER value cannot |
| 816 |
subsequently be assigned to another. However, multiple descriptors |
| 817 |
can be assigned to the same OBJECT IDENTIFIER value. Such |
| 818 |
assignments are specified in the following manner: |
| 819 |
|
| 820 |
|
| 821 |
<span class="grey">McCloghrie, et al. Standards Track [Page 15]</span></pre> |
| 822 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span> |
| 823 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 824 |
|
| 825 |
|
| 826 |
mib OBJECT IDENTIFIER ::= { mgmt 1 } -- from <a href="./rfc1156">RFC1156</a> |
| 827 |
mib-2 OBJECT IDENTIFIER ::= { mgmt 1 } -- from <a href="./rfc1213">RFC1213</a> |
| 828 |
fredRouter OBJECT IDENTIFIER ::= { flintStones 1 1 } |
| 829 |
barneySwitch OBJECT IDENTIFIER ::= { flintStones bedrock(2) 1 } |
| 830 |
|
| 831 |
Note while the above examples are legal, the following is not: |
| 832 |
|
| 833 |
dinoHost OBJECT IDENTIFIER ::= { flintStones bedrock 2 } |
| 834 |
|
| 835 |
A descriptor is allowed to be associated with both a registration and |
| 836 |
an assignment, providing both are associated with the same OBJECT |
| 837 |
IDENTIFIER value and semantics. |
| 838 |
|
| 839 |
<span class="h3"><a class="selflink" id="section-3.7" href="#section-3.7">3.7</a>. Reserved Keywords</span> |
| 840 |
|
| 841 |
The following are reserved keywords which must not be used as |
| 842 |
descriptors or module names: |
| 843 |
|
| 844 |
ABSENT ACCESS AGENT-CAPABILITIES ANY APPLICATION AUGMENTS BEGIN |
| 845 |
BIT BITS BOOLEAN BY CHOICE COMPONENT COMPONENTS CONTACT-INFO |
| 846 |
CREATION-REQUIRES Counter32 Counter64 DEFAULT DEFINED |
| 847 |
DEFINITIONS DEFVAL DESCRIPTION DISPLAY-HINT END ENUMERATED |
| 848 |
ENTERPRISE EXPLICIT EXPORTS EXTERNAL FALSE FROM GROUP Gauge32 |
| 849 |
IDENTIFIER IMPLICIT IMPLIED IMPORTS INCLUDES INDEX INTEGER |
| 850 |
Integer32 IpAddress LAST-UPDATED MANDATORY-GROUPS MAX MAX-ACCESS |
| 851 |
MIN MIN-ACCESS MINUS-INFINITY MODULE MODULE-COMPLIANCE MODULE- |
| 852 |
IDENTITY NOTIFICATION-GROUP NOTIFICATION-TYPE NOTIFICATIONS NULL |
| 853 |
OBJECT OBJECT-GROUP OBJECT-IDENTITY OBJECT-TYPE OBJECTS OCTET OF |
| 854 |
OPTIONAL ORGANIZATION Opaque PLUS-INFINITY PRESENT PRIVATE |
| 855 |
PRODUCT-RELEASE REAL REFERENCE REVISION SEQUENCE SET SIZE STATUS |
| 856 |
STRING SUPPORTS SYNTAX TAGS TEXTUAL-CONVENTION TRAP-TYPE TRUE |
| 857 |
TimeTicks UNITS UNIVERSAL Unsigned32 VARIABLES VARIATION WITH |
| 858 |
WRITE-SYNTAX |
| 859 |
|
| 860 |
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Naming Hierarchy</span> |
| 861 |
|
| 862 |
The root of the subtree administered by the Internet Assigned Numbers |
| 863 |
Authority (IANA) for the Internet is: |
| 864 |
|
| 865 |
internet OBJECT IDENTIFIER ::= { iso 3 6 1 } |
| 866 |
|
| 867 |
That is, the Internet subtree of OBJECT IDENTIFIERs starts with the |
| 868 |
prefix: |
| 869 |
|
| 870 |
1.3.6.1. |
| 871 |
|
| 872 |
Several branches underneath this subtree are used for network |
| 873 |
management: |
| 874 |
|
| 875 |
|
| 876 |
<span class="grey">McCloghrie, et al. Standards Track [Page 16]</span></pre> |
| 877 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span> |
| 878 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 879 |
|
| 880 |
|
| 881 |
mgmt OBJECT IDENTIFIER ::= { internet 2 } |
| 882 |
experimental OBJECT IDENTIFIER ::= { internet 3 } |
| 883 |
private OBJECT IDENTIFIER ::= { internet 4 } |
| 884 |
enterprises OBJECT IDENTIFIER ::= { private 1 } |
| 885 |
|
| 886 |
However, the SMI does not prohibit the definition of objects in other |
| 887 |
portions of the object tree. |
| 888 |
|
| 889 |
The mgmt(2) subtree is used to identify "standard" objects. |
| 890 |
|
| 891 |
The experimental(3) subtree is used to identify objects being |
| 892 |
designed by working groups of the IETF. If an information module |
| 893 |
produced by a working group becomes a "standard" information module, |
| 894 |
then at the very beginning of its entry onto the Internet standards |
| 895 |
track, the objects are moved under the mgmt(2) subtree. |
| 896 |
|
| 897 |
The private(4) subtree is used to identify objects defined |
| 898 |
unilaterally. The enterprises(1) subtree beneath private is used, |
| 899 |
among other things, to permit providers of networking subsystems to |
| 900 |
register models of their products. |
| 901 |
|
| 902 |
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Mapping of the MODULE-IDENTITY macro</span> |
| 903 |
|
| 904 |
The MODULE-IDENTITY macro is used to provide contact and revision |
| 905 |
history for each information module. It must appear exactly once in |
| 906 |
every information module. It should be noted that the expansion of |
| 907 |
the MODULE-IDENTITY macro is something which conceptually happens |
| 908 |
during implementation and not during run-time. |
| 909 |
|
| 910 |
Note that reference in an IMPORTS clause or in clauses of SMIv2 |
| 911 |
macros to an information module is NOT through the use of the |
| 912 |
'descriptor' of a MODULE-IDENTITY macro; rather, an information |
| 913 |
module is referenced through specifying its module name. |
| 914 |
|
| 915 |
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Mapping of the LAST-UPDATED clause</span> |
| 916 |
|
| 917 |
The LAST-UPDATED clause, which must be present, contains the date and |
| 918 |
time that this information module was last edited. |
| 919 |
|
| 920 |
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Mapping of the ORGANIZATION clause</span> |
| 921 |
|
| 922 |
The ORGANIZATION clause, which must be present, contains a textual |
| 923 |
description of the organization under whose auspices this information |
| 924 |
module was developed. |
| 925 |
|
| 926 |
|
| 927 |
|
| 928 |
|
| 929 |
|
| 930 |
|
| 931 |
<span class="grey">McCloghrie, et al. Standards Track [Page 17]</span></pre> |
| 932 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span> |
| 933 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 934 |
|
| 935 |
|
| 936 |
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Mapping of the CONTACT-INFO clause</span> |
| 937 |
|
| 938 |
The CONTACT-INFO clause, which must be present, contains the name, |
| 939 |
postal address, telephone number, and electronic mail address of the |
| 940 |
person to whom technical queries concerning this information module |
| 941 |
should be sent. |
| 942 |
|
| 943 |
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. Mapping of the DESCRIPTION clause</span> |
| 944 |
|
| 945 |
The DESCRIPTION clause, which must be present, contains a high-level |
| 946 |
textual description of the contents of this information module. |
| 947 |
|
| 948 |
<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>. Mapping of the REVISION clause</span> |
| 949 |
|
| 950 |
The REVISION clause, which need not be present, is repeatedly used to |
| 951 |
describe the revisions (including the initial version) made to this |
| 952 |
information module, in reverse chronological order (i.e., most recent |
| 953 |
first). Each instance of this clause contains the date and time of |
| 954 |
the revision. |
| 955 |
|
| 956 |
<span class="h4"><a class="selflink" id="section-5.5.1" href="#section-5.5.1">5.5.1</a>. Mapping of the DESCRIPTION sub-clause</span> |
| 957 |
|
| 958 |
The DESCRIPTION sub-clause, which must be present for each REVISION |
| 959 |
clause, contains a high-level textual description of the revision |
| 960 |
identified in that REVISION clause. |
| 961 |
|
| 962 |
<span class="h3"><a class="selflink" id="section-5.6" href="#section-5.6">5.6</a>. Mapping of the MODULE-IDENTITY value</span> |
| 963 |
|
| 964 |
The value of an invocation of the MODULE-IDENTITY macro is an OBJECT |
| 965 |
IDENTIFIER. As such, this value may be authoritatively used when |
| 966 |
specifying an OBJECT IDENTIFIER value to refer to the information |
| 967 |
module containing the invocation. |
| 968 |
|
| 969 |
Note that it is a common practice to use the value of the MODULE- |
| 970 |
IDENTITY macro as a subtree under which other OBJECT IDENTIFIER |
| 971 |
values assigned within the module are defined. However, it is legal |
| 972 |
(and occasionally necessary) for the other OBJECT IDENTIFIER values |
| 973 |
assigned within the module to be unrelated to the OBJECT IDENTIFIER |
| 974 |
value of the MODULE-IDENTITY macro. |
| 975 |
|
| 976 |
<span class="h3"><a class="selflink" id="section-5.7" href="#section-5.7">5.7</a>. Usage Example</span> |
| 977 |
|
| 978 |
Consider how a skeletal MIB module might be constructed: e.g., |
| 979 |
|
| 980 |
FIZBIN-MIB DEFINITIONS ::= BEGIN |
| 981 |
|
| 982 |
IMPORTS |
| 983 |
MODULE-IDENTITY, OBJECT-TYPE, experimental |
| 984 |
|
| 985 |
|
| 986 |
<span class="grey">McCloghrie, et al. Standards Track [Page 18]</span></pre> |
| 987 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span> |
| 988 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 989 |
|
| 990 |
|
| 991 |
FROM SNMPv2-SMI; |
| 992 |
|
| 993 |
|
| 994 |
fizbin MODULE-IDENTITY |
| 995 |
LAST-UPDATED "199505241811Z" |
| 996 |
ORGANIZATION "IETF SNMPv2 Working Group" |
| 997 |
CONTACT-INFO |
| 998 |
" Marshall T. Rose |
| 999 |
|
| 1000 |
Postal: Dover Beach Consulting, Inc. |
| 1001 |
420 Whisman Court |
| 1002 |
Mountain View, CA 94043-2186 |
| 1003 |
US |
| 1004 |
|
| 1005 |
Tel: +1 415 968 1052 |
| 1006 |
Fax: +1 415 968 2510 |
| 1007 |
|
| 1008 |
E-mail: [email protected]" |
| 1009 |
|
| 1010 |
DESCRIPTION |
| 1011 |
"The MIB module for entities implementing the xxxx |
| 1012 |
protocol." |
| 1013 |
REVISION "9505241811Z" |
| 1014 |
DESCRIPTION |
| 1015 |
"The latest version of this MIB module." |
| 1016 |
REVISION "9210070433Z" |
| 1017 |
DESCRIPTION |
| 1018 |
"The initial version of this MIB module, published in |
| 1019 |
RFC yyyy." |
| 1020 |
-- contact IANA for actual number |
| 1021 |
::= { experimental xx } |
| 1022 |
|
| 1023 |
END |
| 1024 |
|
| 1025 |
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Mapping of the OBJECT-IDENTITY macro</span> |
| 1026 |
|
| 1027 |
The OBJECT-IDENTITY macro is used to define information about an |
| 1028 |
OBJECT IDENTIFIER assignment. All administrative OBJECT IDENTIFIER |
| 1029 |
assignments which define a type identification value (see |
| 1030 |
AutonomousType, a textual convention defined in [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>]) should be |
| 1031 |
defined via the OBJECT-IDENTITY macro. It should be noted that the |
| 1032 |
expansion of the OBJECT-IDENTITY macro is something which |
| 1033 |
conceptually happens during implementation and not during run-time. |
| 1034 |
|
| 1035 |
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Mapping of the STATUS clause</span> |
| 1036 |
|
| 1037 |
The STATUS clause, which must be present, indicates whether this |
| 1038 |
definition is current or historic. |
| 1039 |
|
| 1040 |
|
| 1041 |
<span class="grey">McCloghrie, et al. Standards Track [Page 19]</span></pre> |
| 1042 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span> |
| 1043 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1044 |
|
| 1045 |
|
| 1046 |
The value "current" means that the definition is current and valid. |
| 1047 |
The value "obsolete" means the definition is obsolete and should not |
| 1048 |
be implemented and/or can be removed if previously implemented. |
| 1049 |
While the value "deprecated" also indicates an obsolete definition, |
| 1050 |
it permits new/continued implementation in order to foster |
| 1051 |
interoperability with older/existing implementations. |
| 1052 |
|
| 1053 |
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Mapping of the DESCRIPTION clause</span> |
| 1054 |
|
| 1055 |
The DESCRIPTION clause, which must be present, contains a textual |
| 1056 |
description of the object assignment. |
| 1057 |
|
| 1058 |
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Mapping of the REFERENCE clause</span> |
| 1059 |
|
| 1060 |
The REFERENCE clause, which need not be present, contains a textual |
| 1061 |
cross-reference to some other document, either another information |
| 1062 |
module which defines a related assignment, or some other document |
| 1063 |
which provides additional information relevant to this definition. |
| 1064 |
|
| 1065 |
<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>. Mapping of the OBJECT-IDENTITY value</span> |
| 1066 |
|
| 1067 |
The value of an invocation of the OBJECT-IDENTITY macro is an OBJECT |
| 1068 |
IDENTIFIER. |
| 1069 |
|
| 1070 |
<span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>. Usage Example</span> |
| 1071 |
|
| 1072 |
Consider how an OBJECT IDENTIFIER assignment might be made: e.g., |
| 1073 |
|
| 1074 |
fizbin69 OBJECT-IDENTITY |
| 1075 |
STATUS current |
| 1076 |
DESCRIPTION |
| 1077 |
"The authoritative identity of the Fizbin 69 chipset." |
| 1078 |
::= { fizbinChipSets 1 } |
| 1079 |
|
| 1080 |
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Mapping of the OBJECT-TYPE macro</span> |
| 1081 |
|
| 1082 |
The OBJECT-TYPE macro is used to define a type of managed object. It |
| 1083 |
should be noted that the expansion of the OBJECT-TYPE macro is |
| 1084 |
something which conceptually happens during implementation and not |
| 1085 |
during run-time. |
| 1086 |
|
| 1087 |
For leaf objects which are not columnar objects (i.e., not contained |
| 1088 |
within a conceptual table), instances of the object are identified by |
| 1089 |
appending a sub-identifier of zero to the name of that object. |
| 1090 |
Otherwise, the INDEX clause of the conceptual row object superior to |
| 1091 |
a columnar object defines instance identification information. |
| 1092 |
|
| 1093 |
|
| 1094 |
|
| 1095 |
|
| 1096 |
<span class="grey">McCloghrie, et al. Standards Track [Page 20]</span></pre> |
| 1097 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span> |
| 1098 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1099 |
|
| 1100 |
|
| 1101 |
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Mapping of the SYNTAX clause</span> |
| 1102 |
|
| 1103 |
The SYNTAX clause, which must be present, defines the abstract data |
| 1104 |
structure corresponding to that object. The data structure must be |
| 1105 |
one of the following: a base type, the BITS construct, or a textual |
| 1106 |
convention. (SEQUENCE OF and SEQUENCE are also possible for |
| 1107 |
conceptual tables, see <a href="#section-7.1.12">section 7.1.12</a>). The base types are those |
| 1108 |
defined in the ObjectSyntax CHOICE. A textual convention is a |
| 1109 |
newly-defined type defined as a sub-type of a base type [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>]. |
| 1110 |
|
| 1111 |
An extended subset of the full capabilities of ASN.1 (1988) sub- |
| 1112 |
typing is allowed, as appropriate to the underlying ASN.1 type. Any |
| 1113 |
such restriction on size, range or enumerations specified in this |
| 1114 |
clause represents the maximal level of support which makes "protocol |
| 1115 |
sense". Restrictions on sub-typing are specified in detail in |
| 1116 |
<a href="#section-9">Section 9</a> and <a href="#appendix-A">Appendix A</a> of this memo. |
| 1117 |
|
| 1118 |
The semantics of ObjectSyntax are now described. |
| 1119 |
|
| 1120 |
<span class="h4"><a class="selflink" id="section-7.1.1" href="#section-7.1.1">7.1.1</a>. Integer32 and INTEGER</span> |
| 1121 |
|
| 1122 |
The Integer32 type represents integer-valued information between |
| 1123 |
-2^31 and 2^31-1 inclusive (-2147483648 to 2147483647 decimal). This |
| 1124 |
type is indistinguishable from the INTEGER type. Both the INTEGER |
| 1125 |
and Integer32 types may be sub-typed to be more constrained than the |
| 1126 |
Integer32 type. |
| 1127 |
|
| 1128 |
The INTEGER type (but not the Integer32 type) may also be used to |
| 1129 |
represent integer-valued information as named-number enumerations. |
| 1130 |
In this case, only those named-numbers so enumerated may be present |
| 1131 |
as a value. Note that although it is recommended that enumerated |
| 1132 |
values start at 1 and be numbered contiguously, any valid value for |
| 1133 |
Integer32 is allowed for an enumerated value and, further, enumerated |
| 1134 |
values needn't be contiguously assigned. |
| 1135 |
|
| 1136 |
Finally, a label for a named-number enumeration must consist of one |
| 1137 |
or more letters or digits, up to a maximum of 64 characters, and the |
| 1138 |
initial character must be a lower-case letter. (However, labels |
| 1139 |
longer than 32 characters are not recommended.) Note that hyphens |
| 1140 |
are not allowed by this specification (except for use by information |
| 1141 |
modules converted from SMIv1 which did allow hyphens). |
| 1142 |
|
| 1143 |
<span class="h4"><a class="selflink" id="section-7.1.2" href="#section-7.1.2">7.1.2</a>. OCTET STRING</span> |
| 1144 |
|
| 1145 |
The OCTET STRING type represents arbitrary binary or textual data. |
| 1146 |
Although the SMI-specified size limitation for this type is 65535 |
| 1147 |
octets, MIB designers should realize that there may be implementation |
| 1148 |
and interoperability limitations for sizes in excess of 255 octets. |
| 1149 |
|
| 1150 |
|
| 1151 |
<span class="grey">McCloghrie, et al. Standards Track [Page 21]</span></pre> |
| 1152 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span> |
| 1153 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1154 |
|
| 1155 |
|
| 1156 |
<span class="h4"><a class="selflink" id="section-7.1.3" href="#section-7.1.3">7.1.3</a>. OBJECT IDENTIFIER</span> |
| 1157 |
|
| 1158 |
The OBJECT IDENTIFIER type represents administratively assigned |
| 1159 |
names. Any instance of this type may have at most 128 sub- |
| 1160 |
identifiers. Further, each sub-identifier must not exceed the value |
| 1161 |
2^32-1 (4294967295 decimal). |
| 1162 |
|
| 1163 |
<span class="h4"><a class="selflink" id="section-7.1.4" href="#section-7.1.4">7.1.4</a>. The BITS construct</span> |
| 1164 |
|
| 1165 |
The BITS construct represents an enumeration of named bits. This |
| 1166 |
collection is assigned non-negative, contiguous (but see below) |
| 1167 |
values, starting at zero. Only those named-bits so enumerated may be |
| 1168 |
present in a value. (Thus, enumerations must be assigned to |
| 1169 |
consecutive bits; however, see <a href="#section-9">Section 9</a> for refinements of an object |
| 1170 |
with this syntax.) |
| 1171 |
|
| 1172 |
As part of updating an information module, for an object defined |
| 1173 |
using the BITS construct, new enumerations can be added or existing |
| 1174 |
enumerations can have new labels assigned to them. After an |
| 1175 |
enumeration is added, it might not be possible to distinguish between |
| 1176 |
an implementation of the updated object for which the new enumeration |
| 1177 |
is not asserted, and an implementation of the object prior to the |
| 1178 |
addition. Depending on the circumstances, such an ambiguity could |
| 1179 |
either be desirable or could be undesirable. The means to avoid such |
| 1180 |
an ambiguity is dependent on the encoding of values on the wire; |
| 1181 |
however, one possibility is to define new enumerations starting at |
| 1182 |
the next multiple of eight bits. (Of course, this can also result in |
| 1183 |
the enumerations no longer being contiguous.) |
| 1184 |
|
| 1185 |
Although there is no SMI-specified limitation on the number of |
| 1186 |
enumerations (and therefore on the length of a value), except as may |
| 1187 |
be imposed by the limit on the length of an OCTET STRING, MIB |
| 1188 |
designers should realize that there may be implementation and |
| 1189 |
interoperability limitations for sizes in excess of 128 bits. |
| 1190 |
|
| 1191 |
Finally, a label for a named-number enumeration must consist of one |
| 1192 |
or more letters or digits, up to a maximum of 64 characters, and the |
| 1193 |
initial character must be a lower-case letter. (However, labels |
| 1194 |
longer than 32 characters are not recommended.) Note that hyphens |
| 1195 |
are not allowed by this specification. |
| 1196 |
|
| 1197 |
<span class="h4"><a class="selflink" id="section-7.1.5" href="#section-7.1.5">7.1.5</a>. IpAddress</span> |
| 1198 |
|
| 1199 |
The IpAddress type represents a 32-bit internet address. It is |
| 1200 |
represented as an OCTET STRING of length 4, in network byte-order. |
| 1201 |
|
| 1202 |
|
| 1203 |
|
| 1204 |
|
| 1205 |
|
| 1206 |
<span class="grey">McCloghrie, et al. Standards Track [Page 22]</span></pre> |
| 1207 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span> |
| 1208 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1209 |
|
| 1210 |
|
| 1211 |
Note that the IpAddress type is a tagged type for historical reasons. |
| 1212 |
Network addresses should be represented using an invocation of the |
| 1213 |
TEXTUAL-CONVENTION macro [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>]. |
| 1214 |
|
| 1215 |
<span class="h4"><a class="selflink" id="section-7.1.6" href="#section-7.1.6">7.1.6</a>. Counter32</span> |
| 1216 |
|
| 1217 |
The Counter32 type represents a non-negative integer which |
| 1218 |
monotonically increases until it reaches a maximum value of 2^32-1 |
| 1219 |
(4294967295 decimal), when it wraps around and starts increasing |
| 1220 |
again from zero. |
| 1221 |
|
| 1222 |
Counters have no defined "initial" value, and thus, a single value of |
| 1223 |
a Counter has (in general) no information content. Discontinuities |
| 1224 |
in the monotonically increasing value normally occur at re- |
| 1225 |
initialization of the management system, and at other times as |
| 1226 |
specified in the description of an object-type using this ASN.1 type. |
| 1227 |
If such other times can occur, for example, the creation of an object |
| 1228 |
instance at times other than re-initialization, then a corresponding |
| 1229 |
object should be defined, with an appropriate SYNTAX clause, to |
| 1230 |
indicate the last discontinuity. Examples of appropriate SYNTAX |
| 1231 |
clause include: TimeStamp (a textual convention defined in [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>]), |
| 1232 |
DateAndTime (another textual convention from [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>]) or TimeTicks. |
| 1233 |
|
| 1234 |
The value of the MAX-ACCESS clause for objects with a SYNTAX clause |
| 1235 |
value of Counter32 is either "read-only" or "accessible-for-notify". |
| 1236 |
|
| 1237 |
A DEFVAL clause is not allowed for objects with a SYNTAX clause value |
| 1238 |
of Counter32. |
| 1239 |
|
| 1240 |
<span class="h4"><a class="selflink" id="section-7.1.7" href="#section-7.1.7">7.1.7</a>. Gauge32</span> |
| 1241 |
|
| 1242 |
The Gauge32 type represents a non-negative integer, which may |
| 1243 |
increase or decrease, but shall never exceed a maximum value, nor |
| 1244 |
fall below a minimum value. The maximum value can not be greater |
| 1245 |
than 2^32-1 (4294967295 decimal), and the minimum value can not be |
| 1246 |
smaller than 0. The value of a Gauge32 has its maximum value |
| 1247 |
whenever the information being modeled is greater than or equal to |
| 1248 |
its maximum value, and has its minimum value whenever the information |
| 1249 |
being modeled is smaller than or equal to its minimum value. If the |
| 1250 |
information being modeled subsequently decreases below (increases |
| 1251 |
above) the maximum (minimum) value, the Gauge32 also decreases |
| 1252 |
(increases). (Note that despite of the use of the term "latched" in |
| 1253 |
the original definition of this type, it does not become "stuck" at |
| 1254 |
its maximum or minimum value.) |
| 1255 |
|
| 1256 |
|
| 1257 |
|
| 1258 |
|
| 1259 |
|
| 1260 |
|
| 1261 |
<span class="grey">McCloghrie, et al. Standards Track [Page 23]</span></pre> |
| 1262 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span> |
| 1263 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1264 |
|
| 1265 |
|
| 1266 |
<span class="h4"><a class="selflink" id="section-7.1.8" href="#section-7.1.8">7.1.8</a>. TimeTicks</span> |
| 1267 |
|
| 1268 |
The TimeTicks type represents a non-negative integer which represents |
| 1269 |
the time, modulo 2^32 (4294967296 decimal), in hundredths of a second |
| 1270 |
between two epochs. When objects are defined which use this ASN.1 |
| 1271 |
type, the description of the object identifies both of the reference |
| 1272 |
epochs. |
| 1273 |
|
| 1274 |
For example, [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>] defines the TimeStamp textual convention which is |
| 1275 |
based on the TimeTicks type. With a TimeStamp, the first reference |
| 1276 |
epoch is defined as the time when sysUpTime [<a href="#ref-5" title=""Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)"">5</a>] was zero, and the |
| 1277 |
second reference epoch is defined as the current value of sysUpTime. |
| 1278 |
|
| 1279 |
The TimeTicks type may not be sub-typed. |
| 1280 |
|
| 1281 |
<span class="h4"><a class="selflink" id="section-7.1.9" href="#section-7.1.9">7.1.9</a>. Opaque</span> |
| 1282 |
|
| 1283 |
The Opaque type is provided solely for backward-compatibility, and |
| 1284 |
shall not be used for newly-defined object types. |
| 1285 |
|
| 1286 |
The Opaque type supports the capability to pass arbitrary ASN.1 |
| 1287 |
syntax. A value is encoded using the ASN.1 Basic Encoding Rules [<a href="#ref-4" title="(December">4</a>] |
| 1288 |
into a string of octets. This, in turn, is encoded as an OCTET |
| 1289 |
STRING, in effect "double-wrapping" the original ASN.1 value. |
| 1290 |
|
| 1291 |
Note that a conforming implementation need only be able to accept and |
| 1292 |
recognize opaquely-encoded data. It need not be able to unwrap the |
| 1293 |
data and then interpret its contents. |
| 1294 |
|
| 1295 |
A requirement on "standard" MIB modules is that no object may have a |
| 1296 |
SYNTAX clause value of Opaque. |
| 1297 |
|
| 1298 |
<span class="h4"><a class="selflink" id="section-7.1.10" href="#section-7.1.10">7.1.10</a>. Counter64</span> |
| 1299 |
|
| 1300 |
The Counter64 type represents a non-negative integer which |
| 1301 |
monotonically increases until it reaches a maximum value of 2^64-1 |
| 1302 |
(18446744073709551615 decimal), when it wraps around and starts |
| 1303 |
increasing again from zero. |
| 1304 |
|
| 1305 |
Counters have no defined "initial" value, and thus, a single value of |
| 1306 |
a Counter has (in general) no information content. Discontinuities |
| 1307 |
in the monotonically increasing value normally occur at re- |
| 1308 |
initialization of the management system, and at other times as |
| 1309 |
specified in the description of an object-type using this ASN.1 type. |
| 1310 |
If such other times can occur, for example, the creation of an object |
| 1311 |
instance at times other than re-initialization, then a corresponding |
| 1312 |
object should be defined, with an appropriate SYNTAX clause, to |
| 1313 |
indicate the last discontinuity. Examples of appropriate SYNTAX |
| 1314 |
|
| 1315 |
|
| 1316 |
<span class="grey">McCloghrie, et al. Standards Track [Page 24]</span></pre> |
| 1317 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span> |
| 1318 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1319 |
|
| 1320 |
|
| 1321 |
clause are: TimeStamp (a textual convention defined in [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>]), |
| 1322 |
DateAndTime (another textual convention from [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>]) or TimeTicks. |
| 1323 |
|
| 1324 |
The value of the MAX-ACCESS clause for objects with a SYNTAX clause |
| 1325 |
value of Counter64 is either "read-only" or "accessible-for-notify". |
| 1326 |
|
| 1327 |
A requirement on "standard" MIB modules is that the Counter64 type |
| 1328 |
may be used only if the information being modeled would wrap in less |
| 1329 |
than one hour if the Counter32 type was used instead. |
| 1330 |
|
| 1331 |
A DEFVAL clause is not allowed for objects with a SYNTAX clause value |
| 1332 |
of Counter64. |
| 1333 |
|
| 1334 |
<span class="h4"><a class="selflink" id="section-7.1.11" href="#section-7.1.11">7.1.11</a>. Unsigned32</span> |
| 1335 |
|
| 1336 |
The Unsigned32 type represents integer-valued information between 0 |
| 1337 |
and 2^32-1 inclusive (0 to 4294967295 decimal). |
| 1338 |
|
| 1339 |
<span class="h4"><a class="selflink" id="section-7.1.12" href="#section-7.1.12">7.1.12</a>. Conceptual Tables</span> |
| 1340 |
|
| 1341 |
Management operations apply exclusively to scalar objects. However, |
| 1342 |
it is sometimes convenient for developers of management applications |
| 1343 |
to impose an imaginary, tabular structure on an ordered collection of |
| 1344 |
objects within the MIB. Each such conceptual table contains zero or |
| 1345 |
more rows, and each row may contain one or more scalar objects, |
| 1346 |
termed columnar objects. This conceptualization is formalized by |
| 1347 |
using the OBJECT-TYPE macro to define both an object which |
| 1348 |
corresponds to a table and an object which corresponds to a row in |
| 1349 |
that table. A conceptual table has SYNTAX of the form: |
| 1350 |
|
| 1351 |
SEQUENCE OF <EntryType> |
| 1352 |
|
| 1353 |
where <EntryType> refers to the SEQUENCE type of its subordinate |
| 1354 |
conceptual row. A conceptual row has SYNTAX of the form: |
| 1355 |
|
| 1356 |
<EntryType> |
| 1357 |
|
| 1358 |
where <EntryType> is a SEQUENCE type defined as follows: |
| 1359 |
|
| 1360 |
<EntryType> ::= SEQUENCE { <type1>, ... , <typeN> } |
| 1361 |
|
| 1362 |
where there is one <type> for each subordinate object, and each |
| 1363 |
<type> is of the form: |
| 1364 |
|
| 1365 |
<descriptor> <syntax> |
| 1366 |
|
| 1367 |
where <descriptor> is the descriptor naming a subordinate object, and |
| 1368 |
<syntax> has the value of that subordinate object's SYNTAX clause, |
| 1369 |
|
| 1370 |
|
| 1371 |
<span class="grey">McCloghrie, et al. Standards Track [Page 25]</span></pre> |
| 1372 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span> |
| 1373 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1374 |
|
| 1375 |
|
| 1376 |
except that both sub-typing information and the named values for |
| 1377 |
enumerated integers or the named bits for the BITS construct, are |
| 1378 |
omitted from <syntax>. |
| 1379 |
|
| 1380 |
Further, a <type> is always present for every subordinate object. |
| 1381 |
(The ASN.1 DEFAULT and OPTIONAL clauses are disallowed in the |
| 1382 |
SEQUENCE definition.) The MAX-ACCESS clause for conceptual tables |
| 1383 |
and rows is "not-accessible". |
| 1384 |
|
| 1385 |
<span class="h5"><a class="selflink" id="section-7.1.12.1" href="#section-7.1.12.1">7.1.12.1</a>. Creation and Deletion of Conceptual Rows</span> |
| 1386 |
|
| 1387 |
For newly-defined conceptual rows which allow the creation of new |
| 1388 |
object instances and/or the deletion of existing object instances, |
| 1389 |
there should be one columnar object with a SYNTAX clause value of |
| 1390 |
RowStatus (a textual convention defined in [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>]) and a MAX-ACCESS |
| 1391 |
clause value of read-create. By convention, this is termed the |
| 1392 |
status column for the conceptual row. |
| 1393 |
|
| 1394 |
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Mapping of the UNITS clause</span> |
| 1395 |
|
| 1396 |
This UNITS clause, which need not be present, contains a textual |
| 1397 |
definition of the units associated with that object. |
| 1398 |
|
| 1399 |
<span class="h3"><a class="selflink" id="section-7.3" href="#section-7.3">7.3</a>. Mapping of the MAX-ACCESS clause</span> |
| 1400 |
|
| 1401 |
The MAX-ACCESS clause, which must be present, defines whether it |
| 1402 |
makes "protocol sense" to read, write and/or create an instance of |
| 1403 |
the object, or to include its value in a notification. This is the |
| 1404 |
maximal level of access for the object. (This maximal level of |
| 1405 |
access is independent of any administrative authorization policy.) |
| 1406 |
|
| 1407 |
The value "read-write" indicates that read and write access make |
| 1408 |
"protocol sense", but create does not. The value "read-create" |
| 1409 |
indicates that read, write and create access make "protocol sense". |
| 1410 |
The value "not-accessible" indicates an auxiliary object (see <a href="#section-7.7">Section</a> |
| 1411 |
<a href="#section-7.7">7.7</a>). The value "accessible-for-notify" indicates an object which is |
| 1412 |
accessible only via a notification (e.g., snmpTrapOID [<a href="#ref-5" title=""Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)"">5</a>]). |
| 1413 |
|
| 1414 |
These values are ordered, from least to greatest: "not-accessible", |
| 1415 |
"accessible-for-notify", "read-only", "read-write", "read-create". |
| 1416 |
|
| 1417 |
If any columnar object in a conceptual row has "read-create" as its |
| 1418 |
maximal level of access, then no other columnar object of the same |
| 1419 |
conceptual row may have a maximal access of "read-write". (Note that |
| 1420 |
"read-create" is a superset of "read-write".) |
| 1421 |
|
| 1422 |
|
| 1423 |
|
| 1424 |
|
| 1425 |
|
| 1426 |
<span class="grey">McCloghrie, et al. Standards Track [Page 26]</span></pre> |
| 1427 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span> |
| 1428 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1429 |
|
| 1430 |
|
| 1431 |
<span class="h3"><a class="selflink" id="section-7.4" href="#section-7.4">7.4</a>. Mapping of the STATUS clause</span> |
| 1432 |
|
| 1433 |
The STATUS clause, which must be present, indicates whether this |
| 1434 |
definition is current or historic. |
| 1435 |
|
| 1436 |
The value "current" means that the definition is current and valid. |
| 1437 |
The value "obsolete" means the definition is obsolete and should not |
| 1438 |
be implemented and/or can be removed if previously implemented. |
| 1439 |
While the value "deprecated" also indicates an obsolete definition, |
| 1440 |
it permits new/continued implementation in order to foster |
| 1441 |
interoperability with older/existing implementations. |
| 1442 |
|
| 1443 |
<span class="h3"><a class="selflink" id="section-7.5" href="#section-7.5">7.5</a>. Mapping of the DESCRIPTION clause</span> |
| 1444 |
|
| 1445 |
The DESCRIPTION clause, which must be present, contains a textual |
| 1446 |
definition of that object which provides all semantic definitions |
| 1447 |
necessary for implementation, and should embody any information which |
| 1448 |
would otherwise be communicated in any ASN.1 commentary annotations |
| 1449 |
associated with the object. |
| 1450 |
|
| 1451 |
<span class="h3"><a class="selflink" id="section-7.6" href="#section-7.6">7.6</a>. Mapping of the REFERENCE clause</span> |
| 1452 |
|
| 1453 |
The REFERENCE clause, which need not be present, contains a textual |
| 1454 |
cross-reference to some other document, either another information |
| 1455 |
module which defines a related assignment, or some other document |
| 1456 |
which provides additional information relevant to this definition. |
| 1457 |
|
| 1458 |
<span class="h3"><a class="selflink" id="section-7.7" href="#section-7.7">7.7</a>. Mapping of the INDEX clause</span> |
| 1459 |
|
| 1460 |
The INDEX clause, which must be present if that object corresponds to |
| 1461 |
a conceptual row (unless an AUGMENTS clause is present instead), and |
| 1462 |
must be absent otherwise, defines instance identification information |
| 1463 |
for the columnar objects subordinate to that object. |
| 1464 |
|
| 1465 |
The instance identification information in an INDEX clause must |
| 1466 |
specify object(s) such that value(s) of those object(s) will |
| 1467 |
unambiguously distinguish a conceptual row. The objects can be |
| 1468 |
columnar objects from the same and/or another conceptual table, but |
| 1469 |
must not be scalar objects. Multiple occurrences of the same object |
| 1470 |
in a single INDEX clause is strongly discouraged. |
| 1471 |
|
| 1472 |
The syntax of the objects in the INDEX clause indicate how to form |
| 1473 |
the instance-identifier: |
| 1474 |
|
| 1475 |
(1) integer-valued (i.e., having INTEGER as its underlying primitive |
| 1476 |
type): a single sub-identifier taking the integer value (this |
| 1477 |
works only for non-negative integers); |
| 1478 |
|
| 1479 |
|
| 1480 |
|
| 1481 |
<span class="grey">McCloghrie, et al. Standards Track [Page 27]</span></pre> |
| 1482 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span> |
| 1483 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1484 |
|
| 1485 |
|
| 1486 |
(2) string-valued, fixed-length strings (or variable-length preceded by |
| 1487 |
the IMPLIED keyword): `n' sub-identifiers, where `n' is the length |
| 1488 |
of the string (each octet of the string is encoded in a separate |
| 1489 |
sub-identifier); |
| 1490 |
|
| 1491 |
(3) string-valued, variable-length strings (not preceded by the IMPLIED |
| 1492 |
keyword): `n+1' sub-identifiers, where `n' is the length of the |
| 1493 |
string (the first sub-identifier is `n' itself, following this, |
| 1494 |
each octet of the string is encoded in a separate sub-identifier); |
| 1495 |
|
| 1496 |
(4) object identifier-valued (when preceded by the IMPLIED keyword): |
| 1497 |
`n' sub-identifiers, where `n' is the number of sub-identifiers in |
| 1498 |
the value (each sub-identifier of the value is copied into a |
| 1499 |
separate sub-identifier); |
| 1500 |
|
| 1501 |
(5) object identifier-valued (when not preceded by the IMPLIED |
| 1502 |
keyword): `n+1' sub-identifiers, where `n' is the number of sub- |
| 1503 |
identifiers in the value (the first sub-identifier is `n' itself, |
| 1504 |
following this, each sub-identifier in the value is copied); |
| 1505 |
|
| 1506 |
(6) IpAddress-valued: 4 sub-identifiers, in the familiar a.b.c.d |
| 1507 |
notation. |
| 1508 |
|
| 1509 |
Note that the IMPLIED keyword can only be present for an object |
| 1510 |
having a variable-length syntax (e.g., variable-length strings or |
| 1511 |
object identifier-valued objects), Further, the IMPLIED keyword can |
| 1512 |
only be associated with the last object in the INDEX clause. |
| 1513 |
Finally, the IMPLIED keyword may not be used on a variable-length |
| 1514 |
string object if that string might have a value of zero-length. |
| 1515 |
|
| 1516 |
Since a single value of a Counter has (in general) no information |
| 1517 |
content (see <a href="#section-7.1.6">section 7.1.6</a> and 7.1.10), objects defined using the |
| 1518 |
syntax, Counter32 or Counter64, must not be specified in an INDEX |
| 1519 |
|
| 1520 |
clause. If an object defined using the BITS construct is used in an |
| 1521 |
INDEX clause, it is considered a variable-length string. |
| 1522 |
|
| 1523 |
Instances identified by use of integer-valued objects should be |
| 1524 |
numbered starting from one (i.e., not from zero). The use of zero as |
| 1525 |
a value for an integer-valued index object should be avoided, except |
| 1526 |
in special cases. |
| 1527 |
|
| 1528 |
Objects which are both specified in the INDEX clause of a conceptual |
| 1529 |
row and also columnar objects of the same conceptual row are termed |
| 1530 |
auxiliary objects. The MAX-ACCESS clause for auxiliary objects is |
| 1531 |
"not-accessible", except in the following circumstances: |
| 1532 |
|
| 1533 |
|
| 1534 |
|
| 1535 |
|
| 1536 |
<span class="grey">McCloghrie, et al. Standards Track [Page 28]</span></pre> |
| 1537 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span> |
| 1538 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1539 |
|
| 1540 |
|
| 1541 |
(1) within a MIB module originally written to conform to SMIv1, and |
| 1542 |
later converted to conform to SMIv2; or |
| 1543 |
|
| 1544 |
(2) a conceptual row must contain at least one columnar object which is |
| 1545 |
not an auxiliary object. In the event that all of a conceptual |
| 1546 |
row's columnar objects are also specified in its INDEX clause, then |
| 1547 |
one of them must be accessible, i.e., have a MAX-ACCESS clause of |
| 1548 |
"read-only". (Note that this situation does not arise for a |
| 1549 |
conceptual row allowing create access, since such a row will have a |
| 1550 |
status column which will not be an auxiliary object.) |
| 1551 |
|
| 1552 |
Note that objects specified in a conceptual row's INDEX clause need |
| 1553 |
not be columnar objects of that conceptual row. In this situation, |
| 1554 |
the DESCRIPTION clause of the conceptual row must include a textual |
| 1555 |
explanation of how the objects which are included in the INDEX clause |
| 1556 |
but not columnar objects of that conceptual row, are used in uniquely |
| 1557 |
identifying instances of the conceptual row's columnar objects. |
| 1558 |
|
| 1559 |
<span class="h3"><a class="selflink" id="section-7.8" href="#section-7.8">7.8</a>. Mapping of the AUGMENTS clause</span> |
| 1560 |
|
| 1561 |
The AUGMENTS clause, which must not be present unless the object |
| 1562 |
corresponds to a conceptual row, is an alternative to the INDEX |
| 1563 |
clause. Every object corresponding to a conceptual row has either an |
| 1564 |
INDEX clause or an AUGMENTS clause. |
| 1565 |
|
| 1566 |
If an object corresponding to a conceptual row has an INDEX clause, |
| 1567 |
that row is termed a base conceptual row; alternatively, if the |
| 1568 |
object has an AUGMENTS clause, the row is said to be a conceptual row |
| 1569 |
augmentation, where the AUGMENTS clause names the object |
| 1570 |
corresponding to the base conceptual row which is augmented by this |
| 1571 |
conceptual row augmentation. (Thus, a conceptual row augmentation |
| 1572 |
cannot itself be augmented.) Instances of subordinate columnar |
| 1573 |
objects of a conceptual row augmentation are identified according to |
| 1574 |
the INDEX clause of the base conceptual row corresponding to the |
| 1575 |
object named in the AUGMENTS clause. Further, instances of |
| 1576 |
subordinate columnar objects of a conceptual row augmentation exist |
| 1577 |
according to the same semantics as instances of subordinate columnar |
| 1578 |
objects of the base conceptual row being augmented. As such, note |
| 1579 |
that creation of a base conceptual row implies the correspondent |
| 1580 |
creation of any conceptual row augmentations. |
| 1581 |
|
| 1582 |
For example, a MIB designer might wish to define additional columns |
| 1583 |
in an "enterprise-specific" MIB which logically extend a conceptual |
| 1584 |
row in a "standard" MIB. The "standard" MIB definition of the |
| 1585 |
conceptual row would include the INDEX clause and the "enterprise- |
| 1586 |
specific" MIB would contain the definition of a conceptual row using |
| 1587 |
the AUGMENTS clause. On the other hand, it would be incorrect to use |
| 1588 |
the AUGMENTS clause for the relationship between <a href="./rfc2233">RFC 2233</a>'s ifTable |
| 1589 |
|
| 1590 |
|
| 1591 |
<span class="grey">McCloghrie, et al. Standards Track [Page 29]</span></pre> |
| 1592 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span> |
| 1593 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1594 |
|
| 1595 |
|
| 1596 |
and the many media-specific MIBs which extend it for specific media |
| 1597 |
(e.g., the dot3Table in <a href="./rfc2358">RFC 2358</a>), since not all interfaces are of |
| 1598 |
the same media. |
| 1599 |
|
| 1600 |
Note that a base conceptual row may be augmented by multiple |
| 1601 |
conceptual row augmentations. |
| 1602 |
|
| 1603 |
<span class="h4"><a class="selflink" id="section-7.8.1" href="#section-7.8.1">7.8.1</a>. Relation between INDEX and AUGMENTS clauses</span> |
| 1604 |
|
| 1605 |
When defining instance identification information for a conceptual |
| 1606 |
table: |
| 1607 |
|
| 1608 |
(1) If there is a one-to-one correspondence between the conceptual rows |
| 1609 |
of this table and an existing table, then the AUGMENTS clause |
| 1610 |
should be used. |
| 1611 |
|
| 1612 |
(2) Otherwise, if there is a sparse relationship between the conceptual |
| 1613 |
rows of this table and an existing table, then an INDEX clause |
| 1614 |
should be used which is identical to that in the existing table. |
| 1615 |
For example, the relationship between <a href="./rfc2233">RFC 2233</a>'s ifTable and a |
| 1616 |
media-specific MIB which extends the ifTable for a specific media |
| 1617 |
(e.g., the dot3Table in <a href="./rfc2358">RFC 2358</a>), is a sparse relationship. |
| 1618 |
|
| 1619 |
(3) Otherwise, if no existing objects have the required syntax and |
| 1620 |
semantics, then auxiliary objects should be defined within the |
| 1621 |
conceptual row for the new table, and those objects should be used |
| 1622 |
within the INDEX clause for the conceptual row. |
| 1623 |
|
| 1624 |
<span class="h3"><a class="selflink" id="section-7.9" href="#section-7.9">7.9</a>. Mapping of the DEFVAL clause</span> |
| 1625 |
|
| 1626 |
The DEFVAL clause, which need not be present, defines an acceptable |
| 1627 |
default value which may be used at the discretion of an agent when an |
| 1628 |
object instance is created. That is, the value is a "hint" to |
| 1629 |
implementors. |
| 1630 |
|
| 1631 |
During conceptual row creation, if an instance of a columnar object |
| 1632 |
is not present as one of the operands in the correspondent management |
| 1633 |
protocol set operation, then the value of the DEFVAL clause, if |
| 1634 |
present, indicates an acceptable default value that an agent might |
| 1635 |
use (especially for a read-only object). |
| 1636 |
|
| 1637 |
Note that with this definition of the DEFVAL clause, it is |
| 1638 |
appropriate to use it for any columnar object of a read-create table. |
| 1639 |
It is also permitted to use it for scalar objects dynamically created |
| 1640 |
by an agent, or for columnar objects of a read-write table |
| 1641 |
dynamically created by an agent. |
| 1642 |
|
| 1643 |
|
| 1644 |
|
| 1645 |
|
| 1646 |
<span class="grey">McCloghrie, et al. Standards Track [Page 30]</span></pre> |
| 1647 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span> |
| 1648 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1649 |
|
| 1650 |
|
| 1651 |
The value of the DEFVAL clause must, of course, correspond to the |
| 1652 |
SYNTAX clause for the object. If the value is an OBJECT IDENTIFIER, |
| 1653 |
then it must be expressed as a single ASN.1 identifier, and not as a |
| 1654 |
collection of sub-identifiers. |
| 1655 |
|
| 1656 |
Note that if an operand to the management protocol set operation is |
| 1657 |
an instance of a read-only object, then the error `notWritable' [<a href="#ref-6" title=""Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)"">6</a>] |
| 1658 |
will be returned. As such, the DEFVAL clause can be used to provide |
| 1659 |
an acceptable default value that an agent might use. |
| 1660 |
|
| 1661 |
By way of example, consider the following possible DEFVAL clauses: |
| 1662 |
|
| 1663 |
ObjectSyntax DEFVAL clause |
| 1664 |
---------------- ------------ |
| 1665 |
Integer32 DEFVAL { 1 } |
| 1666 |
-- same for Gauge32, TimeTicks, Unsigned32 |
| 1667 |
INTEGER DEFVAL { valid } -- enumerated value |
| 1668 |
OCTET STRING DEFVAL { 'ffffffffffff'H } |
| 1669 |
DisplayString DEFVAL { "SNMP agent" } |
| 1670 |
IpAddress DEFVAL { 'c0210415'H } -- 192.33.4.21 |
| 1671 |
OBJECT IDENTIFIER DEFVAL { sysDescr } |
| 1672 |
BITS DEFVAL { { primary, secondary } } |
| 1673 |
-- enumerated values that are set |
| 1674 |
BITS DEFVAL { { } } |
| 1675 |
-- no enumerated values are set |
| 1676 |
|
| 1677 |
A binary string used in a DEFVAL clause for an OCTET STRING must be |
| 1678 |
either an integral multiple of eight or zero bits in length; |
| 1679 |
similarly, a hexadecimal string must be an even number of hexadecimal |
| 1680 |
digits. The value of a character string used in a DEFVAL clause must |
| 1681 |
not contain tab characters or line terminator characters. |
| 1682 |
|
| 1683 |
Object types with SYNTAX of Counter32 and Counter64 may not have |
| 1684 |
DEFVAL clauses, since they do not have defined initial values. |
| 1685 |
However, it is recommended that they be initialized to zero. |
| 1686 |
|
| 1687 |
<span class="h3"><a class="selflink" id="section-7.10" href="#section-7.10">7.10</a>. Mapping of the OBJECT-TYPE value</span> |
| 1688 |
|
| 1689 |
The value of an invocation of the OBJECT-TYPE macro is the name of |
| 1690 |
the object, which is an OBJECT IDENTIFIER, an administratively |
| 1691 |
assigned name. |
| 1692 |
|
| 1693 |
When an OBJECT IDENTIFIER is assigned to an object: |
| 1694 |
|
| 1695 |
(1) If the object corresponds to a conceptual table, then only a single |
| 1696 |
assignment, that for a conceptual row, is present immediately |
| 1697 |
beneath that object. The administratively assigned name for the |
| 1698 |
conceptual row object is derived by appending a sub-identifier of |
| 1699 |
|
| 1700 |
|
| 1701 |
<span class="grey">McCloghrie, et al. Standards Track [Page 31]</span></pre> |
| 1702 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span> |
| 1703 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1704 |
|
| 1705 |
|
| 1706 |
"1" to the administratively assigned name for the conceptual table. |
| 1707 |
|
| 1708 |
(2) If the object corresponds to a conceptual row, then at least one |
| 1709 |
assignment, one for each column in the conceptual row, is present |
| 1710 |
beneath that object. The administratively assigned name for each |
| 1711 |
column is derived by appending a unique, positive sub-identifier to |
| 1712 |
the administratively assigned name for the conceptual row. |
| 1713 |
|
| 1714 |
(3) Otherwise, no other OBJECT IDENTIFIERs which are subordinate to the |
| 1715 |
object may be assigned. |
| 1716 |
|
| 1717 |
Note that the final sub-identifier of any administratively assigned |
| 1718 |
name for an object shall be positive. A zero-valued final sub- |
| 1719 |
identifier is reserved for future use. |
| 1720 |
|
| 1721 |
<span class="h3"><a class="selflink" id="section-7.11" href="#section-7.11">7.11</a>. Usage Example</span> |
| 1722 |
|
| 1723 |
Consider how one might define a conceptual table and its |
| 1724 |
subordinates. (This example uses the RowStatus textual convention |
| 1725 |
defined in [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>].) |
| 1726 |
|
| 1727 |
evalSlot OBJECT-TYPE |
| 1728 |
SYNTAX Integer32 (0..2147483647) |
| 1729 |
MAX-ACCESS read-only |
| 1730 |
STATUS current |
| 1731 |
DESCRIPTION |
| 1732 |
"The index number of the first unassigned entry in the |
| 1733 |
evaluation table, or the value of zero indicating that |
| 1734 |
all entries are assigned. |
| 1735 |
|
| 1736 |
A management station should create new entries in the |
| 1737 |
evaluation table using this algorithm: first, issue a |
| 1738 |
management protocol retrieval operation to determine the |
| 1739 |
value of evalSlot; and, second, issue a management |
| 1740 |
protocol set operation to create an instance of the |
| 1741 |
evalStatus object setting its value to createAndGo(4) or |
| 1742 |
createAndWait(5). If this latter operation succeeds, |
| 1743 |
then the management station may continue modifying the |
| 1744 |
instances corresponding to the newly created conceptual |
| 1745 |
row, without fear of collision with other management |
| 1746 |
stations." |
| 1747 |
::= { eval 1 } |
| 1748 |
|
| 1749 |
evalTable OBJECT-TYPE |
| 1750 |
SYNTAX SEQUENCE OF EvalEntry |
| 1751 |
MAX-ACCESS not-accessible |
| 1752 |
STATUS current |
| 1753 |
DESCRIPTION |
| 1754 |
|
| 1755 |
|
| 1756 |
<span class="grey">McCloghrie, et al. Standards Track [Page 32]</span></pre> |
| 1757 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span> |
| 1758 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1759 |
|
| 1760 |
|
| 1761 |
"The (conceptual) evaluation table." |
| 1762 |
::= { eval 2 } |
| 1763 |
|
| 1764 |
evalEntry OBJECT-TYPE |
| 1765 |
SYNTAX EvalEntry |
| 1766 |
MAX-ACCESS not-accessible |
| 1767 |
STATUS current |
| 1768 |
DESCRIPTION |
| 1769 |
"An entry (conceptual row) in the evaluation table." |
| 1770 |
INDEX { evalIndex } |
| 1771 |
::= { evalTable 1 } |
| 1772 |
|
| 1773 |
EvalEntry ::= |
| 1774 |
SEQUENCE { |
| 1775 |
evalIndex Integer32, |
| 1776 |
evalString DisplayString, |
| 1777 |
evalValue Integer32, |
| 1778 |
evalStatus RowStatus |
| 1779 |
} |
| 1780 |
|
| 1781 |
evalIndex OBJECT-TYPE |
| 1782 |
SYNTAX Integer32 (1..2147483647) |
| 1783 |
MAX-ACCESS not-accessible |
| 1784 |
STATUS current |
| 1785 |
DESCRIPTION |
| 1786 |
"The auxiliary variable used for identifying instances of |
| 1787 |
the columnar objects in the evaluation table." |
| 1788 |
::= { evalEntry 1 } |
| 1789 |
|
| 1790 |
evalString OBJECT-TYPE |
| 1791 |
SYNTAX DisplayString |
| 1792 |
MAX-ACCESS read-create |
| 1793 |
STATUS current |
| 1794 |
DESCRIPTION |
| 1795 |
"The string to evaluate." |
| 1796 |
::= { evalEntry 2 } |
| 1797 |
|
| 1798 |
evalValue OBJECT-TYPE |
| 1799 |
SYNTAX Integer32 |
| 1800 |
MAX-ACCESS read-only |
| 1801 |
STATUS current |
| 1802 |
DESCRIPTION |
| 1803 |
"The value when evalString was last evaluated, or zero if |
| 1804 |
no such value is available." |
| 1805 |
DEFVAL { 0 } |
| 1806 |
::= { evalEntry 3 } |
| 1807 |
|
| 1808 |
evalStatus OBJECT-TYPE |
| 1809 |
|
| 1810 |
|
| 1811 |
<span class="grey">McCloghrie, et al. Standards Track [Page 33]</span></pre> |
| 1812 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span> |
| 1813 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1814 |
|
| 1815 |
|
| 1816 |
SYNTAX RowStatus |
| 1817 |
MAX-ACCESS read-create |
| 1818 |
STATUS current |
| 1819 |
DESCRIPTION |
| 1820 |
"The status column used for creating, modifying, and |
| 1821 |
deleting instances of the columnar objects in the |
| 1822 |
evaluation table." |
| 1823 |
DEFVAL { active } |
| 1824 |
::= { evalEntry 4 } |
| 1825 |
|
| 1826 |
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Mapping of the NOTIFICATION-TYPE macro</span> |
| 1827 |
|
| 1828 |
The NOTIFICATION-TYPE macro is used to define the information |
| 1829 |
contained within an unsolicited transmission of management |
| 1830 |
information (i.e., within either a SNMPv2-Trap-PDU or InformRequest- |
| 1831 |
PDU). It should be noted that the expansion of the NOTIFICATION-TYPE |
| 1832 |
macro is something which conceptually happens during implementation |
| 1833 |
and not during run-time. |
| 1834 |
|
| 1835 |
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Mapping of the OBJECTS clause</span> |
| 1836 |
|
| 1837 |
The OBJECTS clause, which need not be present, defines an ordered |
| 1838 |
sequence of MIB object types. One and only one object instance for |
| 1839 |
each occurrence of each object type must be present, and in the |
| 1840 |
specified order, in every instance of the notification. If the same |
| 1841 |
object type occurs multiple times in a notification's ordered |
| 1842 |
sequence, then an object instance is present for each of them. An |
| 1843 |
object type specified in this clause must not have an MAX-ACCESS |
| 1844 |
clause of "not-accessible". The notification's DESCRIPTION clause |
| 1845 |
must specify the information/meaning conveyed by each occurrence of |
| 1846 |
each object type in the sequence. The DESCRIPTION clause must also |
| 1847 |
specify which object instance is present for each object type in the |
| 1848 |
notification. |
| 1849 |
|
| 1850 |
Note that an agent is allowed, at its own discretion, to append as |
| 1851 |
many additional objects as it considers useful to the end of the |
| 1852 |
notification (i.e., after the objects defined by the OBJECTS clause). |
| 1853 |
|
| 1854 |
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Mapping of the STATUS clause</span> |
| 1855 |
|
| 1856 |
The STATUS clause, which must be present, indicates whether this |
| 1857 |
definition is current or historic. |
| 1858 |
|
| 1859 |
The value "current" means that the definition is current and valid. |
| 1860 |
The value "obsolete" means the definition is obsolete and should not |
| 1861 |
be implemented and/or can be removed if previously implemented. |
| 1862 |
While the value "deprecated" also indicates an obsolete definition, |
| 1863 |
it permits new/continued implementation in order to foster |
| 1864 |
|
| 1865 |
|
| 1866 |
<span class="grey">McCloghrie, et al. Standards Track [Page 34]</span></pre> |
| 1867 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span> |
| 1868 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1869 |
|
| 1870 |
|
| 1871 |
interoperability with older/existing implementations. |
| 1872 |
|
| 1873 |
<span class="h3"><a class="selflink" id="section-8.3" href="#section-8.3">8.3</a>. Mapping of the DESCRIPTION clause</span> |
| 1874 |
|
| 1875 |
The DESCRIPTION clause, which must be present, contains a textual |
| 1876 |
definition of the notification which provides all semantic |
| 1877 |
definitions necessary for implementation, and should embody any |
| 1878 |
information which would otherwise be communicated in any ASN.1 |
| 1879 |
commentary annotations associated with the notification. In |
| 1880 |
particular, the DESCRIPTION clause should document which instances of |
| 1881 |
the objects mentioned in the OBJECTS clause should be contained |
| 1882 |
within notifications of this type. |
| 1883 |
|
| 1884 |
<span class="h3"><a class="selflink" id="section-8.4" href="#section-8.4">8.4</a>. Mapping of the REFERENCE clause</span> |
| 1885 |
|
| 1886 |
The REFERENCE clause, which need not be present, contains a textual |
| 1887 |
cross-reference to some other document, either another information |
| 1888 |
module which defines a related assignment, or some other document |
| 1889 |
which provides additional information relevant to this definition. |
| 1890 |
|
| 1891 |
<span class="h3"><a class="selflink" id="section-8.5" href="#section-8.5">8.5</a>. Mapping of the NOTIFICATION-TYPE value</span> |
| 1892 |
|
| 1893 |
The value of an invocation of the NOTIFICATION-TYPE macro is the name |
| 1894 |
of the notification, which is an OBJECT IDENTIFIER, an |
| 1895 |
administratively assigned name. In order to achieve compatibility |
| 1896 |
with SNMPv1 traps, both when converting SMIv1 information modules |
| 1897 |
to/from this SMI, and in the procedures employed by multi-lingual |
| 1898 |
systems and proxy forwarding applications, the next to last sub- |
| 1899 |
identifier in the name of any newly-defined notification must have |
| 1900 |
the value zero. |
| 1901 |
|
| 1902 |
Sections <a href="#section-4.2.6">4.2.6</a> and <a href="#section-4.2.7">4.2.7</a> of [<a href="#ref-6" title=""Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)"">6</a>] describe how the NOTIFICATION-TYPE |
| 1903 |
macro is used to generate a SNMPv2-Trap-PDU or InformRequest-PDU, |
| 1904 |
respectively. |
| 1905 |
|
| 1906 |
<span class="h3"><a class="selflink" id="section-8.6" href="#section-8.6">8.6</a>. Usage Example</span> |
| 1907 |
|
| 1908 |
Consider how a configuration change notification might be described: |
| 1909 |
|
| 1910 |
entityMIBTraps OBJECT IDENTIFIER ::= { entityMIB 2 } |
| 1911 |
entityMIBTrapPrefix OBJECT IDENTIFIER ::= { entityMIBTraps 0 } |
| 1912 |
|
| 1913 |
entConfigChange NOTIFICATION-TYPE |
| 1914 |
STATUS current |
| 1915 |
DESCRIPTION |
| 1916 |
"An entConfigChange trap is sent when the value of |
| 1917 |
entLastChangeTime changes. It can be utilized by an NMS to |
| 1918 |
trigger logical/physical entity table maintenance polls. |
| 1919 |
|
| 1920 |
|
| 1921 |
<span class="grey">McCloghrie, et al. Standards Track [Page 35]</span></pre> |
| 1922 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span> |
| 1923 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1924 |
|
| 1925 |
|
| 1926 |
|
| 1927 |
An agent must not generate more than one entConfigChange |
| 1928 |
'trap-event' in a five second period, where a 'trap-event' |
| 1929 |
is the transmission of a single trap PDU to a list of |
| 1930 |
trap destinations. If additional configuration changes |
| 1931 |
occur within the five second 'throttling' period, then |
| 1932 |
these trap-events should be suppressed by the agent. An |
| 1933 |
NMS should periodically check the value of |
| 1934 |
entLastChangeTime to detect any missed entConfigChange |
| 1935 |
trap-events, e.g. due to throttling or transmission loss." |
| 1936 |
::= { entityMIBTrapPrefix 1 } |
| 1937 |
|
| 1938 |
According to this invocation, the notification authoritatively |
| 1939 |
identified as |
| 1940 |
|
| 1941 |
{ entityMIBTrapPrefix 1 } |
| 1942 |
|
| 1943 |
is used to report a particular type of configuration change. |
| 1944 |
|
| 1945 |
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Refined Syntax</span> |
| 1946 |
|
| 1947 |
Some macros have clauses which allows syntax to be refined, |
| 1948 |
specifically: the SYNTAX clause of the OBJECT-TYPE macro, and the |
| 1949 |
SYNTAX/WRITE-SYNTAX clauses of the MODULE-COMPLIANCE and AGENT- |
| 1950 |
CAPABILITIES macros [<a href="#ref-2" title=""Conformance Statements for SMIv2"">2</a>]. However, not all refinements of syntax are |
| 1951 |
appropriate. In particular, the object's primitive or application |
| 1952 |
type must not be changed. |
| 1953 |
|
| 1954 |
Further, the following restrictions apply: |
| 1955 |
|
| 1956 |
Restrictions to Refinement of |
| 1957 |
object syntax range enumeration size |
| 1958 |
----------------- ----- ----------- ---- |
| 1959 |
INTEGER (1) (2) - |
| 1960 |
Integer32 (1) - - |
| 1961 |
Unsigned32 (1) - - |
| 1962 |
OCTET STRING - - (3) |
| 1963 |
OBJECT IDENTIFIER - - - |
| 1964 |
BITS - (2) - |
| 1965 |
IpAddress - - - |
| 1966 |
Counter32 - - - |
| 1967 |
Counter64 - - - |
| 1968 |
Gauge32 (1) - - |
| 1969 |
TimeTicks - - - |
| 1970 |
|
| 1971 |
where: |
| 1972 |
|
| 1973 |
|
| 1974 |
|
| 1975 |
|
| 1976 |
<span class="grey">McCloghrie, et al. Standards Track [Page 36]</span></pre> |
| 1977 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span> |
| 1978 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 1979 |
|
| 1980 |
|
| 1981 |
(1) the range of permitted values may be refined by raising the lower- |
| 1982 |
bounds, by reducing the upper-bounds, and/or by reducing the |
| 1983 |
alternative value/range choices; |
| 1984 |
|
| 1985 |
(2) the enumeration of named-values may be refined by removing one or |
| 1986 |
more named-values (note that for BITS, a refinement may cause the |
| 1987 |
enumerations to no longer be contiguous); or, |
| 1988 |
|
| 1989 |
(3) the size in octets of the value may be refined by raising the |
| 1990 |
lower-bounds, by reducing the upper-bounds, and/or by reducing the |
| 1991 |
alternative size choices. |
| 1992 |
|
| 1993 |
No other types of refinements can be specified in the SYNTAX clause. |
| 1994 |
However, the DESCRIPTION clause is available to specify additional |
| 1995 |
restrictions which can not be expressed in the SYNTAX clause. |
| 1996 |
Further details on (and examples of) sub-typing are provided in |
| 1997 |
<a href="#appendix-A">Appendix A</a>. |
| 1998 |
|
| 1999 |
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Extending an Information Module</span> |
| 2000 |
|
| 2001 |
As experience is gained with an information module, it may be |
| 2002 |
desirable to revise that information module. However, changes are |
| 2003 |
not allowed if they have any potential to cause interoperability |
| 2004 |
problems "over the wire" between an implementation using an original |
| 2005 |
specification and an implementation using an updated |
| 2006 |
specification(s). |
| 2007 |
|
| 2008 |
For any change, the invocation of the MODULE-IDENTITY macro must be |
| 2009 |
updated to include information about the revision: specifically, |
| 2010 |
updating the LAST-UPDATED clause, adding a pair of REVISION and |
| 2011 |
DESCRIPTION clauses (see <a href="#section-5.5">section 5.5</a>), and making any necessary |
| 2012 |
changes to existing clauses, including the ORGANIZATION and CONTACT- |
| 2013 |
INFO clauses. |
| 2014 |
|
| 2015 |
Note that any definition contained in an information module is |
| 2016 |
available to be IMPORT-ed by any other information module, and is |
| 2017 |
referenced in an IMPORTS clause via the module name. Thus, a module |
| 2018 |
name should not be changed. Specifically, the module name (e.g., |
| 2019 |
"FIZBIN-MIB" in the example of <a href="#section-5.7">Section 5.7</a>) should not be changed |
| 2020 |
when revising an information module (except to correct typographical |
| 2021 |
errors), and definitions should not be moved from one information |
| 2022 |
module to another. |
| 2023 |
|
| 2024 |
Also note that obsolete definitions must not be removed from MIB |
| 2025 |
modules since their descriptors may still be referenced by other |
| 2026 |
information modules, and the OBJECT IDENTIFIERs used to name them |
| 2027 |
must never be re-assigned. |
| 2028 |
|
| 2029 |
|
| 2030 |
|
| 2031 |
<span class="grey">McCloghrie, et al. Standards Track [Page 37]</span></pre> |
| 2032 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span> |
| 2033 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 2034 |
|
| 2035 |
|
| 2036 |
<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. Object Assignments</span> |
| 2037 |
|
| 2038 |
If any non-editorial change is made to any clause of a object |
| 2039 |
assignment, then the OBJECT IDENTIFIER value associated with that |
| 2040 |
object assignment must also be changed, along with its associated |
| 2041 |
descriptor. |
| 2042 |
|
| 2043 |
<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. Object Definitions</span> |
| 2044 |
|
| 2045 |
An object definition may be revised in any of the following ways: |
| 2046 |
|
| 2047 |
(1) A SYNTAX clause containing an enumerated INTEGER may have new |
| 2048 |
enumerations added or existing labels changed. Similarly, named |
| 2049 |
bits may be added or existing labels changed for the BITS |
| 2050 |
construct. |
| 2051 |
|
| 2052 |
(2) The value of a SYNTAX clause may be replaced by a textual |
| 2053 |
convention, providing the textual convention is defined to use the |
| 2054 |
same primitive ASN.1 type, has the same set of values, and has |
| 2055 |
identical semantics. |
| 2056 |
|
| 2057 |
(3) A STATUS clause value of "current" may be revised as "deprecated" |
| 2058 |
or "obsolete". Similarly, a STATUS clause value of "deprecated" |
| 2059 |
may be revised as "obsolete". When making such a change, the |
| 2060 |
DESCRIPTION clause should be updated to explain the rationale. |
| 2061 |
|
| 2062 |
(4) A DEFVAL clause may be added or updated. |
| 2063 |
|
| 2064 |
(5) A REFERENCE clause may be added or updated. |
| 2065 |
|
| 2066 |
(6) A UNITS clause may be added. |
| 2067 |
|
| 2068 |
(7) A conceptual row may be augmented by adding new columnar objects at |
| 2069 |
the end of the row, and making the corresponding update to the |
| 2070 |
SEQUENCE definition. |
| 2071 |
|
| 2072 |
(8) Clarifications and additional information may be included in the |
| 2073 |
DESCRIPTION clause. |
| 2074 |
|
| 2075 |
(9) Entirely new objects may be defined, named with previously |
| 2076 |
unassigned OBJECT IDENTIFIER values. |
| 2077 |
|
| 2078 |
Otherwise, if the semantics of any previously defined object are |
| 2079 |
changed (i.e., if a non-editorial change is made to any clause other |
| 2080 |
than those specifically allowed above), then the OBJECT IDENTIFIER |
| 2081 |
value associated with that object must also be changed. |
| 2082 |
|
| 2083 |
|
| 2084 |
|
| 2085 |
|
| 2086 |
<span class="grey">McCloghrie, et al. Standards Track [Page 38]</span></pre> |
| 2087 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span> |
| 2088 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 2089 |
|
| 2090 |
|
| 2091 |
Note that changing the descriptor associated with an existing object |
| 2092 |
is considered a semantic change, as these strings may be used in an |
| 2093 |
IMPORTS statement. |
| 2094 |
|
| 2095 |
<span class="h3"><a class="selflink" id="section-10.3" href="#section-10.3">10.3</a>. Notification Definitions</span> |
| 2096 |
|
| 2097 |
A notification definition may be revised in any of the following |
| 2098 |
ways: |
| 2099 |
|
| 2100 |
(1) A REFERENCE clause may be added or updated. |
| 2101 |
|
| 2102 |
(2) A STATUS clause value of "current" may be revised as "deprecated" |
| 2103 |
or "obsolete". Similarly, a STATUS clause value of "deprecated" |
| 2104 |
may be revised as "obsolete". When making such a change, the |
| 2105 |
DESCRIPTION clause should be updated to explain the rationale. |
| 2106 |
|
| 2107 |
(3) A DESCRIPTION clause may be clarified. |
| 2108 |
|
| 2109 |
Otherwise, if the semantics of any previously defined notification |
| 2110 |
are changed (i.e., if a non-editorial change is made to any clause |
| 2111 |
other those specifically allowed above), then the OBJECT IDENTIFIER |
| 2112 |
value associated with that notification must also be changed. |
| 2113 |
|
| 2114 |
Note that changing the descriptor associated with an existing |
| 2115 |
notification is considered a semantic change, as these strings may be |
| 2116 |
used in an IMPORTS statement. |
| 2117 |
|
| 2118 |
|
| 2119 |
|
| 2120 |
|
| 2121 |
|
| 2122 |
|
| 2123 |
|
| 2124 |
|
| 2125 |
|
| 2126 |
|
| 2127 |
|
| 2128 |
|
| 2129 |
|
| 2130 |
|
| 2131 |
|
| 2132 |
|
| 2133 |
|
| 2134 |
|
| 2135 |
|
| 2136 |
|
| 2137 |
|
| 2138 |
|
| 2139 |
|
| 2140 |
|
| 2141 |
<span class="grey">McCloghrie, et al. Standards Track [Page 39]</span></pre> |
| 2142 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span> |
| 2143 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 2144 |
|
| 2145 |
|
| 2146 |
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. <a href="#appendix-A">Appendix A</a>: Detailed Sub-typing Rules</span> |
| 2147 |
|
| 2148 |
|
| 2149 |
<span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.1</a>. Syntax Rules</span> |
| 2150 |
|
| 2151 |
The syntax rules for sub-typing are given below. Note that while |
| 2152 |
this syntax is based on ASN.1, it includes some extensions beyond |
| 2153 |
what is allowed in ASN.1, and a number of ASN.1 constructs are not |
| 2154 |
allowed by this syntax. |
| 2155 |
|
| 2156 |
<integerSubType> |
| 2157 |
::= <empty> |
| 2158 |
| "(" <range> ["|" <range>]... ")" |
| 2159 |
|
| 2160 |
<octetStringSubType> |
| 2161 |
::= <empty> |
| 2162 |
| "(" "SIZE" "(" <range> ["|" <range>]... ")" ")" |
| 2163 |
|
| 2164 |
<range> |
| 2165 |
::= <value> |
| 2166 |
| <value> ".." <value> |
| 2167 |
|
| 2168 |
<value> |
| 2169 |
::= "-" <number> |
| 2170 |
| <number> |
| 2171 |
| <hexString> |
| 2172 |
| <binString> |
| 2173 |
|
| 2174 |
where: |
| 2175 |
<empty> is the empty string |
| 2176 |
<number> is a non-negative integer |
| 2177 |
<hexString> is a hexadecimal string (e.g., '0F0F'H) |
| 2178 |
<binString> is a binary string (e.g, '1010'B) |
| 2179 |
|
| 2180 |
<range> is further restricted as follows: |
| 2181 |
- any <value> used in a SIZE clause must be non-negative. |
| 2182 |
- when a pair of values is specified, the first value |
| 2183 |
must be less than the second value. |
| 2184 |
- when multiple ranges are specified, the ranges may |
| 2185 |
not overlap but may touch. For example, (1..4 | 4..9) |
| 2186 |
is invalid, and (1..4 | 5..9) is valid. |
| 2187 |
- the ranges must be a subset of the maximum range of the |
| 2188 |
base type. |
| 2189 |
|
| 2190 |
|
| 2191 |
|
| 2192 |
|
| 2193 |
|
| 2194 |
|
| 2195 |
|
| 2196 |
<span class="grey">McCloghrie, et al. Standards Track [Page 40]</span></pre> |
| 2197 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span> |
| 2198 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 2199 |
|
| 2200 |
|
| 2201 |
<span class="h3"><a class="selflink" id="section-11.2" href="#section-11.2">11.2</a>. Examples</span> |
| 2202 |
|
| 2203 |
Some examples of legal sub-typing: |
| 2204 |
|
| 2205 |
Integer32 (-20..100) |
| 2206 |
Integer32 (0..100 | 300..500) |
| 2207 |
Integer32 (300..500 | 0..100) |
| 2208 |
Integer32 (0 | 2 | 4 | 6 | 8 | 10) |
| 2209 |
OCTET STRING (SIZE(0..100)) |
| 2210 |
OCTET STRING (SIZE(0..100 | 300..500)) |
| 2211 |
OCTET STRING (SIZE(0 | 2 | 4 | 6 | 8 | 10)) |
| 2212 |
SYNTAX TimeInterval (0..100) |
| 2213 |
SYNTAX DisplayString (SIZE(0..32)) |
| 2214 |
|
| 2215 |
(Note the last two examples above are not valid in a TEXTUAL |
| 2216 |
CONVENTION, see [<a href="#ref-3" title=""Textual Conventions for SMIv2"">3</a>].) |
| 2217 |
|
| 2218 |
Some examples of illegal sub-typing: |
| 2219 |
|
| 2220 |
Integer32 (150..100) -- first greater than second |
| 2221 |
Integer32 (0..100 | 50..500) -- ranges overlap |
| 2222 |
Integer32 (0 | 2 | 0 ) -- value duplicated |
| 2223 |
Integer32 (MIN..-1 | 1..MAX) -- MIN and MAX not allowed |
| 2224 |
Integer32 (SIZE (0..34)) -- must not use SIZE |
| 2225 |
OCTET STRING (0..100) -- must use SIZE |
| 2226 |
OCTET STRING (SIZE(-10..100)) -- negative SIZE |
| 2227 |
|
| 2228 |
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. Security Considerations</span> |
| 2229 |
|
| 2230 |
This document defines a language with which to write and read |
| 2231 |
descriptions of management information. The language itself has no |
| 2232 |
security impact on the Internet. |
| 2233 |
|
| 2234 |
|
| 2235 |
|
| 2236 |
<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. Editors' Addresses</span> |
| 2237 |
|
| 2238 |
Keith McCloghrie |
| 2239 |
Cisco Systems, Inc. |
| 2240 |
170 West Tasman Drive |
| 2241 |
San Jose, CA 95134-1706 |
| 2242 |
USA |
| 2243 |
Phone: +1 408 526 5260 |
| 2244 |
EMail: [email protected] |
| 2245 |
|
| 2246 |
|
| 2247 |
|
| 2248 |
|
| 2249 |
|
| 2250 |
|
| 2251 |
<span class="grey">McCloghrie, et al. Standards Track [Page 41]</span></pre> |
| 2252 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span> |
| 2253 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 2254 |
|
| 2255 |
|
| 2256 |
David Perkins |
| 2257 |
SNMPinfo |
| 2258 |
3763 Benton Street |
| 2259 |
Santa Clara, CA 95051 |
| 2260 |
USA |
| 2261 |
Phone: +1 408 221-8702 |
| 2262 |
EMail: [email protected] |
| 2263 |
|
| 2264 |
Juergen Schoenwaelder |
| 2265 |
TU Braunschweig |
| 2266 |
Bueltenweg 74/75 |
| 2267 |
38106 Braunschweig |
| 2268 |
Germany |
| 2269 |
Phone: +49 531 391-3283 |
| 2270 |
EMail: [email protected] |
| 2271 |
|
| 2272 |
|
| 2273 |
<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. References</span> |
| 2274 |
|
| 2275 |
[<a id="ref-1">1</a>] Information processing systems - Open Systems Interconnection - |
| 2276 |
Specification of Abstract Syntax Notation One (ASN.1), |
| 2277 |
International Organization for Standardization. International |
| 2278 |
Standard 8824, (December, 1987). |
| 2279 |
|
| 2280 |
[<a id="ref-2">2</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. |
| 2281 |
and S. Waldbusser, "Conformance Statements for SMIv2", STD 58, |
| 2282 |
<a href="./rfc2580">RFC 2580</a>, April 1999. |
| 2283 |
|
| 2284 |
[<a id="ref-3">3</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. |
| 2285 |
and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, |
| 2286 |
<a href="./rfc2579">RFC 2579</a>, April 1999. |
| 2287 |
|
| 2288 |
[<a id="ref-4">4</a>] Information processing systems - Open Systems Interconnection - |
| 2289 |
Specification of Basic Encoding Rules for Abstract Syntax Notation |
| 2290 |
One (ASN.1), International Organization for Standardization. |
| 2291 |
International Standard 8825, (December, 1987). |
| 2292 |
|
| 2293 |
[<a id="ref-5">5</a>] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M. and |
| 2294 |
S. Waldbusser, "Management Information Base for Version 2 of the |
| 2295 |
Simple Network Management Protocol (SNMPv2)", <a href="./rfc1907">RFC 1907</a>, January |
| 2296 |
1996. |
| 2297 |
|
| 2298 |
[<a id="ref-6">6</a>] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M. and |
| 2299 |
S. Waldbusser, "Protocol Operations for Version 2 of the Simple |
| 2300 |
Network Management Protocol (SNMPv2)", <a href="./rfc1905">RFC 1905</a>, January 1996. |
| 2301 |
|
| 2302 |
|
| 2303 |
|
| 2304 |
|
| 2305 |
|
| 2306 |
<span class="grey">McCloghrie, et al. Standards Track [Page 42]</span></pre> |
| 2307 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span> |
| 2308 |
<span class="grey"><a href="./rfc2578">RFC 2578</a> SMIv2 April 1999</span> |
| 2309 |
|
| 2310 |
|
| 2311 |
<span class="h2"><a class="selflink" id="section-15" href="#section-15">15</a>. Full Copyright Statement</span> |
| 2312 |
|
| 2313 |
Copyright (C) The Internet Society (1999). All Rights Reserved. |
| 2314 |
|
| 2315 |
This document and translations of it may be copied and furnished to |
| 2316 |
others, and derivative works that comment on or otherwise explain it |
| 2317 |
or assist in its implementation may be prepared, copied, published |
| 2318 |
and distributed, in whole or in part, without restriction of any |
| 2319 |
kind, provided that the above copyright notice and this paragraph are |
| 2320 |
included on all such copies and derivative works. However, this |
| 2321 |
document itself may not be modified in any way, such as by removing |
| 2322 |
the copyright notice or references to the Internet Society or other |
| 2323 |
Internet organizations, except as needed for the purpose of |
| 2324 |
developing Internet standards in which case the procedures for |
| 2325 |
copyrights defined in the Internet Standards process must be |
| 2326 |
followed, or as required to translate it into languages other than |
| 2327 |
English. |
| 2328 |
|
| 2329 |
The limited permissions granted above are perpetual and will not be |
| 2330 |
revoked by the Internet Society or its successors or assigns. |
| 2331 |
|
| 2332 |
This document and the information contained herein is provided on an |
| 2333 |
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING |
| 2334 |
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING |
| 2335 |
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION |
| 2336 |
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF |
| 2337 |
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE." |
| 2338 |
|
| 2339 |
|
| 2340 |
|
| 2341 |
|
| 2342 |
|
| 2343 |
|
| 2344 |
|
| 2345 |
|
| 2346 |
|
| 2347 |
|
| 2348 |
|
| 2349 |
|
| 2350 |
|
| 2351 |
|
| 2352 |
|
| 2353 |
|
| 2354 |
|
| 2355 |
|
| 2356 |
|
| 2357 |
|
| 2358 |
|
| 2359 |
|
| 2360 |
|
| 2361 |
McCloghrie, et al. Standards Track [Page 43] |
| 2362 |
</pre> |