1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
|
<pre>Network Working Group Editors of this version:
Request for Comments: 2580 K. McCloghrie
STD: 58 Cisco Systems
Obsoletes: <a href="./rfc1904">1904</a> D. Perkins
Category: Standards Track SNMPinfo
J. Schoenwaelder
TU Braunschweig
Authors of previous version:
J. Case
SNMP Research
K. McCloghrie
Cisco Systems
M. Rose
First Virtual Holdings
S. Waldbusser
International Network Services
April 1999
<span class="h1">Conformance Statements for SMIv2</span>
Status of this Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (1999). All Rights Reserved.
Table of Contents
<a href="#section-1">1</a> Introduction .....................................................<a href="#page-3">3</a>
<a href="#section-1.1">1.1</a> A Note on Terminology ..........................................<a href="#page-3">3</a>
<a href="#section-2">2</a> Definitions ......................................................<a href="#page-3">3</a>
<a href="#section-2.1">2.1</a> The OBJECT-GROUP macro .........................................<a href="#page-3">3</a>
<a href="#section-2.2">2.2</a> The NOTIFICATION-GROUP macro ...................................<a href="#page-4">4</a>
<a href="#section-2.3">2.3</a> The MODULE-COMPLIANCE macro ....................................<a href="#page-5">5</a>
<a href="#section-2.4">2.4</a> The AGENT-CAPABILITIES macro ...................................<a href="#page-7">7</a>
<a href="#section-3">3</a> Mapping of the OBJECT-GROUP macro ...............................<a href="#page-10">10</a>
<a href="#section-3.1">3.1</a> Mapping of the OBJECTS clause .................................<a href="#page-10">10</a>
<a href="#section-3.2">3.2</a> Mapping of the STATUS clause ..................................<a href="#page-11">11</a>
<a href="#section-3.3">3.3</a> Mapping of the DESCRIPTION clause .............................<a href="#page-11">11</a>
<a href="#section-3.4">3.4</a> Mapping of the REFERENCE clause ...............................<a href="#page-11">11</a>
<span class="grey">McCloghrie, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<a href="#section-3.5">3.5</a> Mapping of the OBJECT-GROUP value .............................<a href="#page-11">11</a>
<a href="#section-3.6">3.6</a> Usage Example .................................................<a href="#page-12">12</a>
<a href="#section-4">4</a> Mapping of the NOTIFICATION-GROUP macro .........................<a href="#page-12">12</a>
<a href="#section-4.1">4.1</a> Mapping of the NOTIFICATIONS clause ...........................<a href="#page-12">12</a>
<a href="#section-4.2">4.2</a> Mapping of the STATUS clause ..................................<a href="#page-13">13</a>
<a href="#section-4.3">4.3</a> Mapping of the DESCRIPTION clause .............................<a href="#page-13">13</a>
<a href="#section-4.4">4.4</a> Mapping of the REFERENCE clause ...............................<a href="#page-13">13</a>
<a href="#section-4.5">4.5</a> Mapping of the NOTIFICATION-GROUP value .......................<a href="#page-13">13</a>
<a href="#section-4.6">4.6</a> Usage Example .................................................<a href="#page-13">13</a>
<a href="#section-5">5</a> Mapping of the MODULE-COMPLIANCE macro ..........................<a href="#page-14">14</a>
<a href="#section-5.1">5.1</a> Mapping of the STATUS clause ..................................<a href="#page-14">14</a>
<a href="#section-5.2">5.2</a> Mapping of the DESCRIPTION clause .............................<a href="#page-14">14</a>
<a href="#section-5.3">5.3</a> Mapping of the REFERENCE clause ...............................<a href="#page-15">15</a>
<a href="#section-5.4">5.4</a> Mapping of the MODULE clause ..................................<a href="#page-15">15</a>
<a href="#section-5.4.1">5.4.1</a> Mapping of the MANDATORY-GROUPS clause ......................<a href="#page-15">15</a>
<a href="#section-5.4.2">5.4.2</a> Mapping of the GROUP clause .................................<a href="#page-15">15</a>
<a href="#section-5.4.3">5.4.3</a> Mapping of the OBJECT clause ................................<a href="#page-16">16</a>
<a href="#section-5.4.3.1">5.4.3.1</a> Mapping of the SYNTAX clause ..............................<a href="#page-16">16</a>
<a href="#section-5.4.3.2">5.4.3.2</a> Mapping of the WRITE-SYNTAX clause ........................<a href="#page-16">16</a>
<a href="#section-5.4.3.3">5.4.3.3</a> Mapping of the MIN-ACCESS clause ..........................<a href="#page-16">16</a>
<a href="#section-5.4.4">5.4.4</a> Mapping of the DESCRIPTION clause ...........................<a href="#page-17">17</a>
<a href="#section-5.5">5.5</a> Mapping of the MODULE-COMPLIANCE value ........................<a href="#page-17">17</a>
<a href="#section-5.6">5.6</a> Usage Example .................................................<a href="#page-17">17</a>
<a href="#section-6">6</a> Mapping of the AGENT-CAPABILITIES macro .........................<a href="#page-19">19</a>
<a href="#section-6.1">6.1</a> Mapping of the PRODUCT-RELEASE clause .........................<a href="#page-19">19</a>
<a href="#section-6.2">6.2</a> Mapping of the STATUS clause ..................................<a href="#page-19">19</a>
<a href="#section-6.3">6.3</a> Mapping of the DESCRIPTION clause .............................<a href="#page-20">20</a>
<a href="#section-6.4">6.4</a> Mapping of the REFERENCE clause ...............................<a href="#page-20">20</a>
<a href="#section-6.5">6.5</a> Mapping of the SUPPORTS clause ................................<a href="#page-20">20</a>
<a href="#section-6.5.1">6.5.1</a> Mapping of the INCLUDES clause ..............................<a href="#page-20">20</a>
<a href="#section-6.5.2">6.5.2</a> Mapping of the VARIATION clause .............................<a href="#page-20">20</a>
<a href="#section-6.5.2.1">6.5.2.1</a> Mapping of the SYNTAX clause ..............................<a href="#page-21">21</a>
<a href="#section-6.5.2.2">6.5.2.2</a> Mapping of the WRITE-SYNTAX clause ........................<a href="#page-21">21</a>
<a href="#section-6.5.2.3">6.5.2.3</a> Mapping of the ACCESS clause ..............................<a href="#page-21">21</a>
<a href="#section-6.5.2.4">6.5.2.4</a> Mapping of the CREATION-REQUIRES clause ...................<a href="#page-22">22</a>
<a href="#section-6.5.2.5">6.5.2.5</a> Mapping of the DEFVAL clause ..............................<a href="#page-22">22</a>
<a href="#section-6.5.2.6">6.5.2.6</a> Mapping of the DESCRIPTION clause .........................<a href="#page-22">22</a>
<a href="#section-6.6">6.6</a> Mapping of the AGENT-CAPABILITIES value .......................<a href="#page-22">22</a>
<a href="#section-6.7">6.7</a> Usage Example .................................................<a href="#page-23">23</a>
<a href="#section-7">7</a> Extending an Information Module .................................<a href="#page-25">25</a>
<a href="#section-7.1">7.1</a> Conformance Groups ............................................<a href="#page-25">25</a>
<a href="#section-7.2">7.2</a> Compliance Definitions ........................................<a href="#page-26">26</a>
<a href="#section-7.3">7.3</a> Capabilities Definitions ......................................<a href="#page-26">26</a>
<a href="#section-8">8</a> Security Considerations .........................................<a href="#page-27">27</a>
<a href="#section-9">9</a> Editors' Addresses ..............................................<a href="#page-27">27</a>
<a href="#section-10">10</a> References .....................................................<a href="#page-28">28</a>
<a href="#section-11">11</a> Full Copyright Statement .......................................<a href="#page-29">29</a>
<span class="grey">McCloghrie, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
Management information is viewed as a collection of managed objects,
residing in a virtual information store, termed the Management
Information Base (MIB). Collections of related objects are defined
in MIB modules. These modules are written using an adapted subset of
OSI's Abstract Syntax Notation One, ASN.1 (1988) [<a href="#ref-1" title="(December">1</a>], termed the
Structure of Management Information (SMI) [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>].
It may be useful to define the acceptable lower-bounds of
implementation, along with the actual level of implementation
achieved. It is the purpose of this document to define the notation
used for these purposes.
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. A Note on Terminology</span>
For the purpose of exposition, the original Structure of Management
Information, as described in RFCs 1156 (STD 16), 1212 (STD 16), and
<a href="./rfc1215">RFC 1215</a>, is termed the SMI version 1 (SMIv1). The current version
of the Structure of Management Information is termed SMI version 2
(SMIv2).
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Definitions</span>
SNMPv2-CONF DEFINITIONS ::= BEGIN
IMPORTS ObjectName, NotificationName, ObjectSyntax
FROM SNMPv2-SMI;
-- definitions for conformance groups
OBJECT-GROUP MACRO ::=
BEGIN
TYPE NOTATION ::=
ObjectsPart
"STATUS" Status
"DESCRIPTION" Text
ReferPart
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER)
ObjectsPart ::=
"OBJECTS" "{" Objects "}"
Objects ::=
Object
| Objects "," Object
Object ::=
<span class="grey">McCloghrie, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
value(ObjectName)
Status ::=
"current"
| "deprecated"
| "obsolete"
ReferPart ::=
"REFERENCE" Text
| empty
-- a character string as defined in [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>]
Text ::= value(IA5String)
END
-- more definitions for conformance groups
NOTIFICATION-GROUP MACRO ::=
BEGIN
TYPE NOTATION ::=
NotificationsPart
"STATUS" Status
"DESCRIPTION" Text
ReferPart
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER)
NotificationsPart ::=
"NOTIFICATIONS" "{" Notifications "}"
Notifications ::=
Notification
| Notifications "," Notification
Notification ::=
value(NotificationName)
Status ::=
"current"
| "deprecated"
| "obsolete"
ReferPart ::=
"REFERENCE" Text
| empty
-- a character string as defined in [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>]
Text ::= value(IA5String)
END
<span class="grey">McCloghrie, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
-- definitions for compliance statements
MODULE-COMPLIANCE MACRO ::=
BEGIN
TYPE NOTATION ::=
"STATUS" Status
"DESCRIPTION" Text
ReferPart
ModulePart
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER)
Status ::=
"current"
| "deprecated"
| "obsolete"
ReferPart ::=
"REFERENCE" Text
| empty
ModulePart ::=
Modules
Modules ::=
Module
| Modules Module
Module ::=
-- name of module --
"MODULE" ModuleName
MandatoryPart
CompliancePart
ModuleName ::=
-- identifier must start with uppercase letter
identifier ModuleIdentifier
-- must not be empty unless contained
-- in MIB Module
| empty
ModuleIdentifier ::=
value(OBJECT IDENTIFIER)
| empty
MandatoryPart ::=
"MANDATORY-GROUPS" "{" Groups "}"
| empty
Groups ::=
<span class="grey">McCloghrie, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
Group
| Groups "," Group
Group ::=
value(OBJECT IDENTIFIER)
CompliancePart ::=
Compliances
| empty
Compliances ::=
Compliance
| Compliances Compliance
Compliance ::=
ComplianceGroup
| Object
ComplianceGroup ::=
"GROUP" value(OBJECT IDENTIFIER)
"DESCRIPTION" Text
Object ::=
"OBJECT" value(ObjectName)
SyntaxPart
WriteSyntaxPart
AccessPart
"DESCRIPTION" Text
-- must be a refinement for object's SYNTAX clause
SyntaxPart ::= "SYNTAX" Syntax
| empty
-- must be a refinement for object's SYNTAX clause
WriteSyntaxPart ::= "WRITE-SYNTAX" Syntax
| empty
Syntax ::= -- Must be one of the following:
-- a base type (or its refinement),
-- a textual convention (or its refinement), or
-- a BITS pseudo-type
type
| "BITS" "{" NamedBits "}"
NamedBits ::= NamedBit
| NamedBits "," NamedBit
NamedBit ::= identifier "(" number ")" -- number is nonnegative
AccessPart ::=
<span class="grey">McCloghrie, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
"MIN-ACCESS" Access
| empty
Access ::=
"not-accessible"
| "accessible-for-notify"
| "read-only"
| "read-write"
| "read-create"
-- a character string as defined in [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>]
Text ::= value(IA5String)
END
-- definitions for capabilities statements
AGENT-CAPABILITIES MACRO ::=
BEGIN
TYPE NOTATION ::=
"PRODUCT-RELEASE" Text
"STATUS" Status
"DESCRIPTION" Text
ReferPart
ModulePart
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER)
Status ::=
"current"
| "obsolete"
ReferPart ::=
"REFERENCE" Text
| empty
ModulePart ::=
Modules
| empty
Modules ::=
Module
| Modules Module
Module ::=
-- name of module --
"SUPPORTS" ModuleName
"INCLUDES" "{" Groups "}"
VariationPart
ModuleName ::=
<span class="grey">McCloghrie, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
-- identifier must start with uppercase letter
identifier ModuleIdentifier
ModuleIdentifier ::=
value(OBJECT IDENTIFIER)
| empty
Groups ::=
Group
| Groups "," Group
Group ::=
value(OBJECT IDENTIFIER)
VariationPart ::=
Variations
| empty
Variations ::=
Variation
| Variations Variation
Variation ::=
ObjectVariation
| NotificationVariation
NotificationVariation ::=
"VARIATION" value(NotificationName)
AccessPart
"DESCRIPTION" Text
ObjectVariation ::=
"VARIATION" value(ObjectName)
SyntaxPart
WriteSyntaxPart
AccessPart
CreationPart
DefValPart
"DESCRIPTION" Text
-- must be a refinement for object's SYNTAX clause
SyntaxPart ::= "SYNTAX" Syntax
| empty
WriteSyntaxPart ::= "WRITE-SYNTAX" Syntax
| empty
Syntax ::= -- Must be one of the following:
-- a base type (or its refinement),
-- a textual convention (or its refinement), or
-- a BITS pseudo-type
<span class="grey">McCloghrie, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
type
| "BITS" "{" NamedBits "}"
NamedBits ::= NamedBit
| NamedBits "," NamedBit
NamedBit ::= identifier "(" number ")" -- number is nonnegative
AccessPart ::=
"ACCESS" Access
| empty
Access ::=
"not-implemented"
-- only "not-implemented" for notifications
| "accessible-for-notify"
| "read-only"
| "read-write"
| "read-create"
-- following is for backward-compatibility only
| "write-only"
CreationPart ::=
"CREATION-REQUIRES" "{" Cells "}"
| empty
Cells ::=
Cell
| Cells "," Cell
Cell ::=
value(ObjectName)
DefValPart ::= "DEFVAL" "{" Defvalue "}"
| empty
Defvalue ::= -- must be valid for the object's syntax
-- in this macro's SYNTAX clause, if present,
-- or if not, in object's OBJECT-TYPE macro
value(ObjectSyntax)
| "{" BitsValue "}"
BitsValue ::= BitNames
| empty
BitNames ::= BitName
| BitNames "," BitName
BitName ::= identifier
<span class="grey">McCloghrie, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
-- a character string as defined in [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>]
Text ::= value(IA5String)
END
END
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Mapping of the OBJECT-GROUP macro</span>
For conformance purposes, it is useful to define a collection of
related managed objects. The OBJECT-GROUP macro is used to define
each such collection of related objects. It should be noted that the
expansion of the OBJECT-GROUP macro is something which conceptually
happens during implementation and not during run-time.
To "implement" an object, an agent must return a reasonably accurate
value for management protocol retrieval operations; similarly, if the
object is writable, then in response to a management protocol set
operation, an agent must accordingly be able to reasonably influence
the underlying managed entity. If an agent can not implement an
object, the management protocol provides for it to return an
exception or error, e.g, noSuchObject [<a href="#ref-4" title=""Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)"">4</a>]. Under no circumstances
shall an agent return a value for objects which it does not implement
-- it must always return the appropriate exception or error, as
described in the protocol specification [<a href="#ref-4" title=""Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)"">4</a>].
Note that the OBJECT-GROUP macro itself provides no conformance
information. Rather, conformance information is specified through
the inclusion of defined groups in a MODULE-COMPLIANCE macro.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Mapping of the OBJECTS clause</span>
The OBJECTS clause, which must be present, is used to specify each
object contained in the conformance group. Each of the specified
objects must be defined in the same information module as the
OBJECT-GROUP macro appears, and must have a MAX-ACCESS clause value
of "accessible-for-notify", "read-only", "read-write", or "read-
create".
It is required that every object defined in an information module
with a MAX-ACCESS clause other than "not-accessible" be contained in
at least one object group. This avoids the common error of adding a
new object to an information module and forgetting to add the new
object to a group.
<span class="grey">McCloghrie, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Mapping of the STATUS clause</span>
The STATUS clause, which must be present, indicates whether this
definition is current or historic.
The value "current" means that the definition is current and valid.
The value "obsolete" means the definition is obsolete and the group
should no longer be used for defining conformance. While the value
"deprecated" also indicates an obsolete definition, it permits
new/continued use of conformance definitions using this group.
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Mapping of the DESCRIPTION clause</span>
The DESCRIPTION clause, which must be present, contains a textual
definition of that group, along with a description of any relations
to other groups. Note that generic compliance requirements should
not be stated in this clause. However, implementation relationships
between this group and other groups may be defined in this clause.
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. Mapping of the REFERENCE clause</span>
The REFERENCE clause, which need not be present, contains a textual
cross-reference to some other document, either another information
module which defines a related assignment, or some other document
which provides additional information relevant to this definition.
<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. Mapping of the OBJECT-GROUP value</span>
The value of an invocation of the OBJECT-GROUP macro is the name of
the group, which is an OBJECT IDENTIFIER, an administratively
assigned name.
<span class="grey">McCloghrie, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a>. Usage Example</span>
The SNMP Group [<a href="#ref-3" title=""Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)"">3</a>] is described:
snmpGroup OBJECT-GROUP
OBJECTS { snmpInPkts,
snmpInBadVersions,
snmpInASNParseErrs,
snmpBadOperations,
snmpSilentDrops,
snmpProxyDrops,
snmpEnableAuthenTraps }
STATUS current
DESCRIPTION
"A collection of objects providing basic instrumentation
and control of an agent."
::= { snmpMIBGroups 8 }
According to this invocation, the conformance group named
{ snmpMIBGroups 8 }
contains 7 objects.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Mapping of the NOTIFICATION-GROUP macro</span>
For conformance purposes, it is useful to define a collection of
notifications. The NOTIFICATION-GROUP macro serves this purpose. It
should be noted that the expansion of the NOTIFICATION-GROUP macro is
something which conceptually happens during implementation and not
during run-time.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Mapping of the NOTIFICATIONS clause</span>
The NOTIFICATIONS clause, which must be present, is used to specify
each notification contained in the conformance group. Each of the
specified notifications must be defined in the same information
module as the NOTIFICATION-GROUP macro appears.
It is required that every notification defined in an information
module be contained in at least one notification group.
<span class="grey">McCloghrie, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Mapping of the STATUS clause</span>
The STATUS clause, which must be present, indicates whether this
definition is current or historic.
The value "current" means that the definition is current and valid.
The value "obsolete" means the definition is obsolete and this group
should no longer be used for defining conformance. While the value
"deprecated" also indicates an obsolete definition, it permits
new/continued use of conformance definitions using this group.
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. Mapping of the DESCRIPTION clause</span>
The DESCRIPTION clause, which must be present, contains a textual
definition of the group, along with a description of any relations to
other groups. Note that generic compliance requirements should not
be stated in this clause. However, implementation relationships
between this group and other groups may be defined in this clause.
<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. Mapping of the REFERENCE clause</span>
The REFERENCE clause, which need not be present, contains a textual
cross-reference to some other document, either another information
module which defines a related assignment, or some other document
which provides additional information relevant to this definition.
<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>. Mapping of the NOTIFICATION-GROUP value</span>
The value of an invocation of the NOTIFICATION-GROUP macro is the
name of the group, which is an OBJECT IDENTIFIER, an administratively
assigned name.
<span class="h3"><a class="selflink" id="section-4.6" href="#section-4.6">4.6</a>. Usage Example</span>
The SNMP Basic Notifications Group [<a href="#ref-3" title=""Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)"">3</a>] is described:
<span class="grey">McCloghrie, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
snmpBasicNotificationsGroup NOTIFICATION-GROUP
NOTIFICATIONS { coldStart, authenticationFailure }
STATUS current
DESCRIPTION
"The two notifications which an agent is required to
implement."
::= { snmpMIBGroups 7 }
According to this invocation, the conformance group named
{ snmpMIBGroups 7 }
contains 2 notifications.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Mapping of the MODULE-COMPLIANCE macro</span>
The MODULE-COMPLIANCE macro is used to convey a minimum set of
requirements with respect to implementation of one or more MIB
modules. It should be noted that the expansion of the MODULE-
COMPLIANCE macro is something which conceptually happens during
implementation and not during run-time.
A requirement on all "standard" MIB modules is that a corresponding
MODULE-COMPLIANCE specification is also defined, either in the same
information module or in a companion information module.
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Mapping of the STATUS clause</span>
The STATUS clause, which must be present, indicates whether this
definition is current or historic.
The value "current" means that the definition is current and valid.
The value "obsolete" means the definition is obsolete, and this
MODULE-COMPLIANCE specification no longer specifies a valid
definition of conformance. While the value "deprecated" also
indicates an obsolete definition, it permits new/continued use of the
MODULE-COMPLIANCE specification.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Mapping of the DESCRIPTION clause</span>
The DESCRIPTION clause, which must be present, contains a textual
definition of this compliance statement and should embody any
information which would otherwise be communicated in any ASN.1
commentary annotations associated with the statement.
<span class="grey">McCloghrie, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Mapping of the REFERENCE clause</span>
The REFERENCE clause, which need not be present, contains a textual
cross-reference to some other document, either another information
module which defines a related assignment, or some other document
which provides additional information relevant to this definition.
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. Mapping of the MODULE clause</span>
The MODULE clause, which must be present, is repeatedly used to name
each MIB module for which compliance requirements are being
specified. Each MIB module is named by its module name, and
optionally, by its associated OBJECT IDENTIFIER as well. The module
name can be omitted when the MODULE-COMPLIANCE invocation occurs
inside a MIB module, to refer to the encompassing MIB module.
<span class="h4"><a class="selflink" id="section-5.4.1" href="#section-5.4.1">5.4.1</a>. Mapping of the MANDATORY-GROUPS clause</span>
The MANDATORY-GROUPS clause, which need not be present, names the one
or more object or notification groups within the correspondent MIB
module which are unconditionally mandatory for implementation. If an
agent claims compliance to the MIB module, then it must implement
each and every object and notification within each conformance group
listed. That is, if an agent returns a noSuchObject exception in
response to a management protocol get operation [<a href="#ref-4" title=""Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)"">4</a>] for any object
within any mandatory conformance group for every possible MIB view,
or if the agent cannot generate each notification listed in any
conformance group under the appropriate circumstances, then that
agent is not a conformant implementation of the MIB module.
<span class="h4"><a class="selflink" id="section-5.4.2" href="#section-5.4.2">5.4.2</a>. Mapping of the GROUP clause</span>
The GROUP clause, which need not be present, is repeatedly used to
name each object and notification group which is conditionally
mandatory for compliance to the MIB module. The GROUP clause can
also be used to name unconditionally optional groups. A group named
in a GROUP clause must be absent from the correspondent MANDATORY-
GROUPS clause.
Conditionally mandatory groups include those which are mandatory only
if a particular protocol is implemented, or only if another group is
implemented. A GROUP clause's DESCRIPTION specifies the conditions
under which the group is conditionally mandatory.
A group which is named in neither a MANDATORY-GROUPS clause nor a
GROUP clause, is unconditionally optional for compliance to the MIB
module.
<span class="grey">McCloghrie, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h4"><a class="selflink" id="section-5.4.3" href="#section-5.4.3">5.4.3</a>. Mapping of the OBJECT clause</span>
The OBJECT clause, which need not be present, is repeatedly used to
specify each MIB object for which compliance has a refined
requirement with respect to the MIB module definition. The MIB
object must be present in one of the conformance groups named in the
correspondent MANDATORY-GROUPS clause or GROUP clauses.
By definition, each object specified in an OBJECT clause follows a
MODULE clause which names the information module in which that object
is defined. Therefore, the use of an IMPORTS statement, to specify
from where such objects are imported, is redundant and is not
required in an information module.
<span class="h5"><a class="selflink" id="section-5.4.3.1" href="#section-5.4.3.1">5.4.3.1</a>. Mapping of the SYNTAX clause</span>
The SYNTAX clause, which need not be present, is used to provide a
refined SYNTAX for the object named in the correspondent OBJECT
clause. Note that if this clause and a WRITE-SYNTAX clause are both
present, then this clause only applies when instances of the object
named in the correspondent OBJECT clause are read.
Consult Section 9 of [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>] for more information on refined syntax.
<span class="h5"><a class="selflink" id="section-5.4.3.2" href="#section-5.4.3.2">5.4.3.2</a>. Mapping of the WRITE-SYNTAX clause</span>
The WRITE-SYNTAX clause, which need not be present, is used to
provide a refined SYNTAX for the object named in the correspondent
OBJECT clause when instances of that object are written.
Consult Section 9 of [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>] for more information on refined syntax.
<span class="h5"><a class="selflink" id="section-5.4.3.3" href="#section-5.4.3.3">5.4.3.3</a>. Mapping of the MIN-ACCESS clause</span>
The MIN-ACCESS clause, which need not be present, is used to define
the minimal level of access for the object named in the correspondent
OBJECT clause. If this clause is absent, the minimal level of access
is the same as the maximal level specified in the correspondent
invocation of the OBJECT-TYPE macro. If present, this clause must
not specify a greater level of access than is specified in the
correspondent invocation of the OBJECT-TYPE macro.
The level of access for certain types of objects is fixed according
to their syntax definition. These types include: conceptual tables
and rows, auxiliary objects, and objects with the syntax of
Counter32, Counter64 (and possibly, certain types of textual
conventions). A MIN-ACCESS clause should not be present for such
<span class="grey">McCloghrie, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
objects.
An implementation is compliant if the level of access it provides is
greater or equal to the minimal level in the MODULE-COMPLIANCE macro
and less or equal to the maximal level in the OBJECT-TYPE macro.
<span class="h4"><a class="selflink" id="section-5.4.4" href="#section-5.4.4">5.4.4</a>. Mapping of the DESCRIPTION clause</span>
The DESCRIPTION clause must be present for each use of the GROUP or
OBJECT clause. For an OBJECT clause, it contains a textual
description of the refined compliance requirement. For a GROUP
clause, it contains a textual description of the conditions under
which the group is conditionally mandatory or unconditionally
optional.
<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>. Mapping of the MODULE-COMPLIANCE value</span>
The value of an invocation of the MODULE-COMPLIANCE macro is an
OBJECT IDENTIFIER. As such, this value may be authoritatively used
when referring to the compliance statement embodied by that
invocation of the macro.
<span class="h3"><a class="selflink" id="section-5.6" href="#section-5.6">5.6</a>. Usage Example</span>
The compliance statement contained in the (hypothetical) XYZv2-MIB
might be:
xyzMIBCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for XYZv2 entities which
implement the XYZv2 MIB."
MODULE -- compliance to the containing MIB module
MANDATORY-GROUPS { xyzSystemGroup,
xyzStatsGroup, xyzTrapGroup,
xyzSetGroup,
xyzBasicNotificationsGroup }
GROUP xyzV1Group
DESCRIPTION
"The xyzV1 group is mandatory only for those
XYZv2 entities which also implement XYZv1."
::= { xyzMIBCompliances 1 }
According to this invocation, to claim alignment with the compliance
statement named
{ xyzMIBCompliances 1 }
<span class="grey">McCloghrie, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
a system must implement the XYZv2-MIB's xyzSystemGroup,
xyzStatsGroup, xyzTrapGroup, and xyzSetGroup object conformance
groups, as well as the xyzBasicNotificationsGroup notifications
group. Furthermore, if the XYZv2 entity also implements XYZv1, then
it must also support the XYZv1Group group, if compliance is to be
claimed.
<span class="grey">McCloghrie, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Mapping of the AGENT-CAPABILITIES macro</span>
The AGENT-CAPABILITIES macro is used to convey a set of capabilities
present in an agent. It should be noted that the expansion of the
AGENT-CAPABILITIES macro is something which conceptually happens
during implementation and not during run-time.
When a MIB module is written, it is divided into units of conformance
termed groups. If an agent claims to implement a group, then it must
implement each and every object, or each and every notification,
within that group. Of course, for whatever reason, an agent might
implement only a subset of the groups within a MIB module. In
addition, the definition of some MIB objects/notifications leave some
aspects of the definition to the discretion of an implementor.
Practical experience has demonstrated a need for concisely describing
the capabilities of an agent with respect to one or more MIB modules.
The AGENT-CAPABILITIES macro allows an agent implementor to describe
the precise level of support which an agent claims in regards to a
MIB group, and to bind that description to the value of an instance
of sysORID [<a href="#ref-3" title=""Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)"">3</a>]. In particular, some objects may have restricted or
augmented syntax or access-levels.
If the AGENT-CAPABILITIES invocation is given to a management-station
implementor, then that implementor can build management applications
which optimize themselves when communicating with a particular agent.
For example, the management-station can maintain a database of these
invocations. When a management-station interacts with an agent, it
retrieves from the agent the values of all instances of sysORID [<a href="#ref-3" title=""Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)"">3</a>].
Based on this, it consults the database to locate each entry matching
one of the retrieved values of sysORID. Using the located entries,
the management application can now optimize its behavior accordingly.
Note that the AGENT-CAPABILITIES macro specifies refinements or
variations with respect to OBJECT-TYPE and NOTIFICATION-TYPE macros
in MIB modules, NOT with respect to MODULE-COMPLIANCE macros in
compliance statements.
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Mapping of the PRODUCT-RELEASE clause</span>
The PRODUCT-RELEASE clause, which must be present, contains a textual
description of the product release which includes this set of
capabilities.
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Mapping of the STATUS clause</span>
The STATUS clause, which must be present, indicates whether this
<span class="grey">McCloghrie, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
definition is current or historic.
The value "current" means that the definition is current and valid.
The value "obsolete" means the definition is obsolete and this
capabilities statement is no longer in use.
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Mapping of the DESCRIPTION clause</span>
The DESCRIPTION clause, which must be present, contains a textual
description of this set of capabilities.
<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>. Mapping of the REFERENCE clause</span>
The REFERENCE clause, which need not be present, contains a textual
cross-reference to some other document, either another information
module which defines a related assignment, or some other document
which provides additional information relevant to this definition.
<span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>. Mapping of the SUPPORTS clause</span>
The SUPPORTS clause, which need not be present, is repeatedly used to
name each MIB module for which the agent claims a complete or partial
implementation. Each MIB module is named by its module name, and
optionally, by its associated OBJECT IDENTIFIER (as registered by the
MODULE-IDENTITY macro, see [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>]) as well.
<span class="h4"><a class="selflink" id="section-6.5.1" href="#section-6.5.1">6.5.1</a>. Mapping of the INCLUDES clause</span>
The INCLUDES clause, which must follow each and every use of the
SUPPORTS clause, is used to name each MIB group associated with the
SUPPORTS clause, which the agent claims to implement.
<span class="h4"><a class="selflink" id="section-6.5.2" href="#section-6.5.2">6.5.2</a>. Mapping of the VARIATION clause</span>
The VARIATION clause, which need not be present, is repeatedly used
to name each object or notification which the agent implements in
some variant or refined fashion with respect to the correspondent
invocation of the OBJECT-TYPE or NOTIFICATION-TYPE macro.
Note that the variation concept is meant for generic implementation
restrictions, e.g., if the variation for an object depends on the
values of other objects, then this should be noted in the appropriate
DESCRIPTION clause.
By definition, each object specified in a VARIATION clause follows a
SUPPORTS clause which names the information module in which that
object is defined. Therefore, the use of an IMPORTS statement, to
specify from where such objects are imported, is redundant and is not
<span class="grey">McCloghrie, et al. Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
required in an information module.
<span class="h5"><a class="selflink" id="section-6.5.2.1" href="#section-6.5.2.1">6.5.2.1</a>. Mapping of the SYNTAX clause</span>
The SYNTAX clause, which need not be present, is used to provide a
refined SYNTAX for the object named in the correspondent VARIATION
clause. Note that if this clause and a WRITE-SYNTAX clause are both
present, then this clause only applies when instances of the object
named in the correspondent VARIATION clause are read.
Consult Section 9 of [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>] for more information on refined syntax.
Note that for enumerated INTEGERs and for the BITS construct, the
changes allowed when updating a MIB module include the addition of
enumerations and/or changing the labels of existing enumerations (see
Section 10.2 of [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>]). This type of change can cause problems for an
AGENT-CAPABILITIES macro written against the old revision of a MIB
module. One way to avoid such problems is to explicitly list all
objects having an enumerated syntax in a VARIATION clause, even when
all enumerations are currently supported.
<span class="h5"><a class="selflink" id="section-6.5.2.2" href="#section-6.5.2.2">6.5.2.2</a>. Mapping of the WRITE-SYNTAX clause</span>
The WRITE-SYNTAX clause, which need not be present, is used to
provide a refined SYNTAX for the object named in the correspondent
VARIATION clause when instances of that object are written.
Consult Section 9 of [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>] for more information on refined syntax.
<span class="h5"><a class="selflink" id="section-6.5.2.3" href="#section-6.5.2.3">6.5.2.3</a>. Mapping of the ACCESS clause</span>
The ACCESS clause, which need not be present, is used to indicate the
agent provides less than the maximal level of access to the object or
notification named in the correspondent VARIATION clause.
The only value applicable to notifications is "not-implemented".
The value "not-implemented" indicates the agent does not implement
the object or notification, and in the ordering of possible values is
equivalent to "not-accessible".
The value "write-only" is provided solely for backward compatibility,
and shall not be used for newly-defined object types. In the
ordering of possible values, "write-only" is less than "not-
accessible".
<span class="grey">McCloghrie, et al. Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h5"><a class="selflink" id="section-6.5.2.4" href="#section-6.5.2.4">6.5.2.4</a>. Mapping of the CREATION-REQUIRES clause</span>
The CREATION-REQUIRES clause, which need not be present, is used to
name the columnar objects of a conceptual row to which values must be
explicitly assigned, by a management protocol set operation, before
the agent will allow the instance of the status column of that row to
be set to `active'. (Consult the definition of RowStatus [<a href="#ref-5" title=""Textual Conventions for SMIv2"">5</a>].)
If the conceptual row does not have a status column (i.e., the
objects corresponding to the conceptual table were defined using the
mechanisms in [<a href="#ref-6" title=""Structure and Identification of Management Information for TCP/IP-based internets"">6</a>,<a href="#ref-7" title=""Concise MIB Definitions"">7</a>]), then the CREATION-REQUIRES clause, which need
not be present, is used to name the columnar objects of a conceptual
row to which values must be explicitly assigned, by a management
protocol set operation, before the agent will create new instances of
objects in that row.
This clause must not be present unless the object named in the
correspondent VARIATION clause is a conceptual row, i.e., has a
syntax which resolves to a SEQUENCE containing columnar objects. The
objects named in the value of this clause usually will refer to
columnar objects in that row. However, objects unrelated to the
conceptual row may also be specified.
All objects which are named in the CREATION-REQUIRES clause for a
conceptual row, and which are columnar objects of that row, must have
an access level of "read-create".
<span class="h5"><a class="selflink" id="section-6.5.2.5" href="#section-6.5.2.5">6.5.2.5</a>. Mapping of the DEFVAL clause</span>
The DEFVAL clause, which need not be present, is used to provide a
alternate DEFVAL value for the object named in the correspondent
VARIATION clause. The semantics of this value are identical to those
of the OBJECT-TYPE macro's DEFVAL clause.
<span class="h5"><a class="selflink" id="section-6.5.2.6" href="#section-6.5.2.6">6.5.2.6</a>. Mapping of the DESCRIPTION clause</span>
The DESCRIPTION clause, which must be present for each use of the
VARIATION clause, contains a textual description of the variant or
refined implementation of the object or notification.
<span class="h3"><a class="selflink" id="section-6.6" href="#section-6.6">6.6</a>. Mapping of the AGENT-CAPABILITIES value</span>
The value of an invocation of the AGENT-CAPABILITIES macro is an
OBJECT IDENTIFIER, which names the value of sysORID [<a href="#ref-3" title=""Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)"">3</a>] for which
this capabilities statement is valid.
<span class="grey">McCloghrie, et al. Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h3"><a class="selflink" id="section-6.7" href="#section-6.7">6.7</a>. Usage Example</span>
Consider how a capabilities statement for an agent might be
described:
exampleAgent AGENT-CAPABILITIES
PRODUCT-RELEASE "ACME Agent release 1.1 for 4BSD."
STATUS current
DESCRIPTION "ACME agent for 4BSD."
SUPPORTS SNMPv2-MIB
INCLUDES { systemGroup, snmpGroup, snmpSetGroup,
snmpBasicNotificationsGroup }
VARIATION coldStart
DESCRIPTION "A coldStart trap is generated on all
reboots."
SUPPORTS IF-MIB
INCLUDES { ifGeneralGroup, ifPacketGroup }
VARIATION ifAdminStatus
SYNTAX INTEGER { up(1), down(2) }
DESCRIPTION "Unable to set test mode on 4BSD."
VARIATION ifOperStatus
SYNTAX INTEGER { up(1), down(2) }
DESCRIPTION "Information limited on 4BSD."
SUPPORTS IP-MIB
INCLUDES { ipGroup, icmpGroup }
VARIATION ipDefaultTTL
SYNTAX INTEGER (255..255)
DESCRIPTION "Hard-wired on 4BSD."
VARIATION ipInAddrErrors
ACCESS not-implemented
DESCRIPTION "Information not available on 4BSD."
VARIATION ipNetToMediaEntry
CREATION-REQUIRES { ipNetToMediaPhysAddress }
DESCRIPTION "Address mappings on 4BSD require
both protocol and media addresses."
SUPPORTS TCP-MIB
INCLUDES { tcpGroup }
VARIATION tcpConnState
<span class="grey">McCloghrie, et al. Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
ACCESS read-only
DESCRIPTION "Unable to set this on 4BSD."
SUPPORTS UDP-MIB
INCLUDES { udpGroup }
SUPPORTS EVAL-MIB
INCLUDES { functionsGroup, expressionsGroup }
VARIATION exprEntry
CREATION-REQUIRES { evalString, evalStatus }
DESCRIPTION "Conceptual row creation is supported."
::= { acmeAgents 1 }
According to this invocation, an agent with a sysORID value of
{ acmeAgents 1 }
supports objects defined in six MIB modules.
From SNMPv2-MIB, five conformance groups are supported.
From IF-MIB, the ifGeneralGroup and ifPacketGroup groups are
supported. However, the objects ifAdminStatus and ifOperStatus have
a restricted syntax.
From IP-MIB, all objects in the ipGroup and icmpGroup are supported
except ipInAddrErrors, while ipDefaultTTL has a restricted range, and
when creating a new instance in the ipNetToMediaTable, the set-
request must create an instance of ipNetToMediaPhysAddress.
From TCP-MIB, the tcpGroup is supported except that tcpConnState is
available only for reading.
From UDP-MIB, the udpGroup is fully supported.
From the EVAL-MIB, all the objects contained in the functionsGroup
and expressionsGroup conformance groups are supported, without
variation. In addition, creation of new instances in the expr table
is supported, and requires both of the objects: evalString and
evalStatus, to be assigned a value.
<span class="grey">McCloghrie, et al. Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Extending an Information Module</span>
As experience is gained with a published information module, it may
be desirable to revise that information module.
Section 10 of [<a href="#ref-2" title=""Structure of Management Information Version 2 (SMIv2)"">2</a>] defines the rules for extending an information
module. The remainder of this section defines how conformance
groups, compliance statements, and capabilities statements may be
extended.
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Conformance Groups</span>
It may be desirable to revise the definition of a conformance group
(an OBJECT-GROUP or a NOTIFICATION-GROUP) after experience is gained
with it. However, conformance groups can be referenced by compliance
and/or capabilities definitions. Therefore, a change to a
conformance group is not allowed if it has the potential to cause a
reference to the group's original definition to be different from a
reference to the updated definition. Such changes can only be
accommodated by defining a new conformance group with a new
descriptor and a new OBJECT IDENTIFIER value.
The following revisions are allowed:
(1) A STATUS clause value of "current" may be revised as "deprecated"
or "obsolete". Similarly, a STATUS clause value of "deprecated"
may be revised as "obsolete". When making such a change, the
DESCRIPTION clause should be updated to explain the rationale.
(2) A REFERENCE clause may be added or updated.
(3) Clarifications and additional information may be included in the
DESCRIPTION clause.
(4) Any editorial change.
It is not necessary to change the STATUS value of a conformance group
when the status of a member of the group is changed.
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Compliance Definitions</span>
It may be desirable to revise the definition of a compliance
definition (MODULE-COMPLIANCE) after experience is gained with it.
However, changes are not allowed if they cause the requirements
specified by the original definition to be different from the
requirements of the updated definition. Such changes can only be
accommodated by defining a new compliance definition with a new
<span class="grey">McCloghrie, et al. Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
descriptor and a new OBJECT IDENTIFIER value.
The following revisions are allowed:
(1) A STATUS clause value of "current" may be revised as "deprecated"
or "obsolete". Similarly, a STATUS clause value of "deprecated"
may be revised as "obsolete". When making such a change, the
DESCRIPTION clause should be updated to explain the rationale.
(2) A REFERENCE clause may be added or updated.
(3) Clarifications and additional information may be included in the
DESCRIPTION clause(s).
(4) Any editorial change.
It is not necessary to change the STATUS value of a compliance
definition due to a change in the STATUS value of a definition it
references.
<span class="h3"><a class="selflink" id="section-7.3" href="#section-7.3">7.3</a>. Capabilities Definitions</span>
It may be desirable to revise the definition of a capabilities
definition (AGENT-CAPABILITIES) after experience is gained with it.
However, changes are not allowed if they cause the capabilities
specified by the original specification to be different from the
capabilities of the updated specification. Such changes can only be
accommodated by defining a new capabilities definition with a new
descriptor and a new OBJECT IDENTIFIER value.
The following revisions are allowed:
(1) A STATUS clause value of "current" may be revised as "obsolete".
When making such a change, the DESCRIPTION clause should be updated
to explain the rationale.
(2) A REFERENCE clause may be added or updated.
(3) Clarifications and additional information may be included in the
DESCRIPTION clause(s).
(4) Any editorial change.
It is not necessary to change the STATUS value of a capabilities
definition due to a change in the STATUS value of a definition it
references.
<span class="grey">McCloghrie, et al. Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Security Considerations</span>
This document defines the means to define conformance requirements
for implementing on documents describing management information.
This method of defining conformance requirements has no security
impact on the Internet.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Editors' Addresses</span>
Keith McCloghrie
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
Phone: +1 408 526 5260
EMail: kzm@cisco.com
David Perkins
SNMPinfo
3763 Benton Street
Santa Clara, CA 95051
USA
Phone: +1 408 221-8702
Email: dperkins@snmpinfo.com
Juergen Schoenwaelder
TU Braunschweig
Bueltenweg 74/75
38106 Braunschweig
Germany
Phone: +49 531 391-3283
EMail: schoenw@ibr.cs.tu-bs.de
<span class="grey">McCloghrie, et al. Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. References</span>
[<a id="ref-1">1</a>] Information processing systems - Open Systems Interconnection -
Specification of Abstract Syntax Notation One (ASN.1),
International Organization for Standardization. International
Standard 8824, (December, 1987).
[<a id="ref-2">2</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M.
and S. Waldbusser, "Structure of Management Information Version 2
(SMIv2)", STD 58, <a href="./rfc2578">RFC 2578</a>, April 1999.
[<a id="ref-3">3</a>] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M. and
S. Waldbusser, "Management Information Base for Version 2 of the
Simple Network Management Protocol (SNMPv2)", <a href="./rfc1907">RFC 1907</a>, January
1996.
[<a id="ref-4">4</a>] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M. and
S. Waldbusser, "Protocol Operations for Version 2 of the Simple
Network Management Protocol (SNMPv2)", <a href="./rfc1905">RFC 1905</a>, January 1996.
[<a id="ref-5">5</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M.
and S. Waldbusser, "Textual Conventions for SMIv2", STD 58,
<a href="./rfc2579">RFC 2579</a>, April 1999.
[<a id="ref-6">6</a>] Rose, M. and K. McCloghrie, "Structure and Identification of
Management Information for TCP/IP-based internets", STD 16, <a href="./rfc1155">RFC</a>
<a href="./rfc1155">1155</a>, May 1990.
[<a id="ref-7">7</a>] Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16, <a href="./rfc1212">RFC</a>
<a href="./rfc1212">1212</a>, March 1991.
<span class="grey">McCloghrie, et al. Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc2580">RFC 2580</a> Conformance Statements for SMIv2 April 1999</span>
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Full Copyright Statement</span>
Copyright (C) The Internet Society (1999). All Rights Reserved.
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than
English.
The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE."
McCloghrie, et al. Standards Track [Page 29]
</pre>
|