home *** CD-ROM | disk | FTP | other *** search
/ Handbook of Infosec Terms 2.0 / Handbook_of_Infosec_Terms_Version_2.0_ISSO.iso / text / rfcs / rfc1904.txt < prev    next >
Text File  |  1996-05-07  |  48KB  |  674 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Network Working Group                               SNMPv2 Working Group Request for Comments: 1904                                       J. Case Obsoletes: 1444                                      SNMP Research, Inc. Category: Standards Track                                  K. McCloghrie                                                      Cisco Systems, Inc.                                                                  M. Rose                                             Dover Beach Consulting, Inc.                                                            S. Waldbusser                                           International Network Services                                                             January 1996 
  8.  
  9.                Conformance Statements for Version 2 of the               Simple Network Management Protocol (SNMPv2) 
  10.  
  11. Status of this Memo 
  12.  
  13.    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. 
  14.  
  15. Table of Contents 
  16.  
  17.    1. Introduction ................................................    2    1.1 A Note on Terminology ......................................    3    2. Definitions .................................................    3    2.1 The OBJECT-GROUP macro .....................................    3    2.2 The NOTIFICATION-GROUP macro ...............................    4    2.3 The MODULE-COMPLIANCE macro ................................    5    2.4 The AGENT-CAPABILITIES macro ...............................    7    3. Mapping of the OBJECT-GROUP macro ...........................    9    3.1 Mapping of the OBJECTS clause ..............................   10    3.2 Mapping of the STATUS clause ...............................   10    3.3 Mapping of the DESCRIPTION clause ..........................   10    3.4 Mapping of the REFERENCE clause ............................   10    3.5 Mapping of the OBJECT-GROUP value ..........................   10    3.6 Usage Example ..............................................   11    4. Mapping of the NOTIFICATION-GROUP macro .....................   11    4.1 Mapping of the NOTIFICATIONS clause ........................   11    4.2 Mapping of the STATUS clause ...............................   11    4.3 Mapping of the DESCRIPTION clause ..........................   12    4.4 Mapping of the REFERENCE clause ............................   12    4.5 Mapping of the NOTIFICATION-GROUP value ....................   12    4.6 Usage Example ..............................................   12    5. Mapping of the MODULE-COMPLIANCE macro ......................   12    5.1 Mapping of the STATUS clause ...............................   13 
  18.  
  19.  
  20.  
  21. SNMPv2 Working Group        Standards Track                     [Page 1] 
  22.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  23.  
  24.     5.2 Mapping of the DESCRIPTION clause ..........................   13    5.3 Mapping of the REFERENCE clause ............................   13    5.4 Mapping of the MODULE clause ...............................   13    5.4.1 Mapping of the MANDATORY-GROUPS clause ...................   13    5.4.2 Mapping of the GROUP clause ..............................   14    5.4.3 Mapping of the OBJECT clause .............................   14    5.4.3.1 Mapping of the SYNTAX clause ...........................   14    5.4.3.2 Mapping of the WRITE-SYNTAX clause .....................   15    5.4.3.3 Mapping of the MIN-ACCESS clause .......................   15    5.4.4 Mapping of the DESCRIPTION clause ........................   15    5.5 Mapping of the MODULE-COMPLIANCE value .....................   15    5.6 Usage Example ..............................................   16    6. Mapping of the AGENT-CAPABILITIES macro .....................   16    6.1 Mapping of the PRODUCT-RELEASE clause ......................   17    6.2 Mapping of the STATUS clause ...............................   17    6.3 Mapping of the DESCRIPTION clause ..........................   17    6.4 Mapping of the REFERENCE clause ............................   17    6.5 Mapping of the SUPPORTS clause .............................   18    6.5.1 Mapping of the INCLUDES clause ...........................   18    6.5.2 Mapping of the VARIATION clause ..........................   18    6.5.2.1 Mapping of the SYNTAX clause ...........................   18    6.5.2.2 Mapping of the WRITE-SYNTAX clause .....................   18    6.5.2.3 Mapping of the ACCESS clause ...........................   19    6.5.2.4 Mapping of the CREATION-REQUIRES clause ................   19    6.5.2.5 Mapping of the DEFVAL clause ...........................   20    6.5.2.6 Mapping of the DESCRIPTION clause ......................   20    6.6 Mapping of the AGENT-CAPABILITIES value ....................   20    6.7 Usage Example ..............................................   20    7. Extending an Information Module .............................   22    7.1 Conformance Groups .........................................   22    7.2 Compliance Definitions .....................................   22    7.3 Capabilities Definitions ...................................   22    8. Security Considerations .....................................   23    9. Editor's Address ............................................   23    10. Acknowledgements ...........................................   23    11. References .................................................   24 
  25.  
  26. 1.  Introduction 
  27.  
  28.    A management system contains:  several (potentially many) nodes, each    with a processing entity, termed an agent, which has access to    management instrumentation; at least one management station; and, a    management protocol, used to convey management information between    the agents and management stations.  Operations of the protocol are    carried out under an administrative framework which defines    authentication, authorization, access control, and privacy policies. 
  29.  
  30.  
  31.  
  32.  
  33.  
  34. SNMPv2 Working Group        Standards Track                     [Page 2] 
  35.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  36.  
  37.     Management stations execute management applications which monitor and    control managed elements.  Managed elements are devices such as    hosts, routers, terminal servers, etc., which are monitored and    controlled via access to their management information. 
  38.  
  39.    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 a subset of OSI's    Abstract Syntax Notation One (ASN.1) [1], termed the Structure of    Management Information (SMI) [2]. 
  40.  
  41.    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. 
  42.  
  43. 1.1.  A Note on Terminology 
  44.  
  45.    For the purpose of exposition, the original Internet-standard Network    Management Framework, as described in RFCs 1155 (STD 16), 1157 (STD    15), and 1212 (STD 16), is termed the SNMP version 1 framework    (SNMPv1).  The current framework is termed the SNMP version 2    framework (SNMPv2). 
  46.  
  47. 2.  Definitions 
  48.  
  49. SNMPv2-CONF DEFINITIONS ::= BEGIN 
  50.  
  51. -- definitions for conformance groups 
  52.  
  53. OBJECT-GROUP MACRO ::= BEGIN     TYPE NOTATION ::=                   ObjectsPart                   "STATUS" Status                   "DESCRIPTION" Text                   ReferPart 
  54.  
  55.     VALUE NOTATION ::=                   value(VALUE OBJECT IDENTIFIER) 
  56.  
  57.     ObjectsPart ::=                   "OBJECTS" "{" Objects "}"     Objects ::=                   Object                 | Objects "," Object     Object ::= 
  58.  
  59.  
  60.  
  61. SNMPv2 Working Group        Standards Track                     [Page 3] 
  62.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  63.  
  64.                    value(Name ObjectName) 
  65.  
  66.     Status ::=                   "current"                 | "deprecated"                 | "obsolete" 
  67.  
  68.     ReferPart ::=                   "REFERENCE" Text                 | empty 
  69.  
  70.     -- uses the NVT ASCII character set     Text ::= """" string """" END 
  71.  
  72.  -- more definitions for conformance groups 
  73.  
  74. NOTIFICATION-GROUP MACRO ::= BEGIN     TYPE NOTATION ::=                   NotificationsPart                   "STATUS" Status                   "DESCRIPTION" Text                   ReferPart 
  75.  
  76.     VALUE NOTATION ::=                   value(VALUE OBJECT IDENTIFIER) 
  77.  
  78.     NotificationsPart ::=                   "NOTIFICATIONS" "{" Notifications "}"     Notifications ::=                   Notification                 | Notifications "," Notification     Notification ::=                   value(Name NotificationName) 
  79.  
  80.     Status ::=                   "current"                 | "deprecated"                 | "obsolete" 
  81.  
  82.     ReferPart ::=                   "REFERENCE" Text                 | empty 
  83.  
  84.     -- uses the NVT ASCII character set     Text ::= """" string """" 
  85.  
  86.  
  87.  
  88. SNMPv2 Working Group        Standards Track                     [Page 4] 
  89.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  90.  
  91.  END 
  92.  
  93.  -- definitions for compliance statements 
  94.  
  95. MODULE-COMPLIANCE MACRO ::= BEGIN     TYPE NOTATION ::=                   "STATUS" Status                   "DESCRIPTION" Text                   ReferPart                   ModulePart 
  96.  
  97.     VALUE NOTATION ::=                   value(VALUE OBJECT IDENTIFIER) 
  98.  
  99.     Status ::=                   "current"                 | "deprecated"                 | "obsolete" 
  100.  
  101.     ReferPart ::=                 "REFERENCE" Text               | empty 
  102.  
  103.     ModulePart ::=                   Modules                 | empty     Modules ::=                   Module                 | Modules Module     Module ::=                   -- name of module --                   "MODULE" ModuleName                   MandatoryPart                   CompliancePart 
  104.  
  105.     ModuleName ::=                   modulereference ModuleIdentifier                 -- must not be empty unless contained                 -- in MIB Module                 | empty     ModuleIdentifier ::=                   value(ModuleID OBJECT IDENTIFIER)                 | empty 
  106.  
  107.     MandatoryPart ::=                   "MANDATORY-GROUPS" "{" Groups "}" 
  108.  
  109.  
  110.  
  111. SNMPv2 Working Group        Standards Track                     [Page 5] 
  112.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  113.  
  114.                  | empty 
  115.  
  116.     Groups ::=                   Group                 | Groups "," Group     Group ::=                   value(Group OBJECT IDENTIFIER) 
  117.  
  118.     CompliancePart ::=                   Compliances                 | empty 
  119.  
  120.     Compliances ::=                   Compliance                 | Compliances Compliance     Compliance ::=                   ComplianceGroup                 | Object 
  121.  
  122.     ComplianceGroup ::=                   "GROUP" value(Name OBJECT IDENTIFIER)                   "DESCRIPTION" Text 
  123.  
  124.     Object ::=                   "OBJECT" value(Name ObjectName)                   SyntaxPart                   WriteSyntaxPart                   AccessPart                   "DESCRIPTION" Text 
  125.  
  126.     -- must be a refinement for object's SYNTAX clause     SyntaxPart ::=                   "SYNTAX" type(SYNTAX)                 | empty 
  127.  
  128.     -- must be a refinement for object's SYNTAX clause     WriteSyntaxPart ::=                   "WRITE-SYNTAX" type(WriteSYNTAX)                 | empty 
  129.  
  130.     AccessPart ::=                   "MIN-ACCESS" Access                 | empty     Access ::=                   "not-accessible"                 | "accessible-for-notify"                 | "read-only"                 | "read-write" 
  131.  
  132.  
  133.  
  134. SNMPv2 Working Group        Standards Track                     [Page 6] 
  135.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  136.  
  137.                  | "read-create" 
  138.  
  139.     -- uses the NVT ASCII character set     Text ::= """" string """" END 
  140.  
  141.  -- definitions for capabilities statements 
  142.  
  143. AGENT-CAPABILITIES MACRO ::= BEGIN     TYPE NOTATION ::=                   "PRODUCT-RELEASE" Text                   "STATUS" Status                   "DESCRIPTION" Text                   ReferPart                   ModulePart 
  144.  
  145.     VALUE NOTATION ::=                   value(VALUE OBJECT IDENTIFIER) 
  146.  
  147.     Status ::=                   "current"                 | "obsolete" 
  148.  
  149.     ReferPart ::=                 "REFERENCE" Text               | empty 
  150.  
  151.     ModulePart ::=                   Modules                 | empty     Modules ::=                   Module                 | Modules Module     Module ::=                   -- name of module --                   "SUPPORTS" ModuleName                   "INCLUDES" "{" Groups "}"                   VariationPart 
  152.  
  153.     ModuleName ::=                   identifier ModuleIdentifier     ModuleIdentifier ::=                   value(ModuleID OBJECT IDENTIFIER)                 | empty 
  154.  
  155.     Groups ::= 
  156.  
  157.  
  158.  
  159. SNMPv2 Working Group        Standards Track                     [Page 7] 
  160.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  161.  
  162.                    Group                 | Groups "," Group     Group ::=                   value(Name OBJECT IDENTIFIER) 
  163.  
  164.     VariationPart ::=                   Variations                 | empty     Variations ::=                   Variation                 | Variations Variation 
  165.  
  166.     Variation ::=                   ObjectVariation                 | NotificationVariation 
  167.  
  168.     NotificationVariation ::=                   "VARIATION" value(Name NotificationName)                   AccessPart                   "DESCRIPTION" Text 
  169.  
  170.     ObjectVariation ::=                   "VARIATION" value(Name ObjectName)                   SyntaxPart                   WriteSyntaxPart                   AccessPart                   CreationPart                   DefValPart                   "DESCRIPTION" Text 
  171.  
  172.     -- must be a refinement for object's SYNTAX clause     SyntaxPart ::=                   "SYNTAX" type(SYNTAX)                 | empty 
  173.  
  174.     -- must be a refinement for object's SYNTAX clause     WriteSyntaxPart ::=                   "WRITE-SYNTAX" type(WriteSYNTAX)                 | empty 
  175.  
  176.     AccessPart ::=                   "ACCESS" Access                 | empty 
  177.  
  178.     Access ::=                   "not-implemented"                 -- only "not-implemented" for notifications                 | "accessible-for-notify" 
  179.  
  180.  
  181.  
  182. SNMPv2 Working Group        Standards Track                     [Page 8] 
  183.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  184.  
  185.                  | "read-only"                 | "read-write"                 | "read-create"                 -- following is for backward-compatibility only                 | "write-only" 
  186.  
  187.     CreationPart ::=                   "CREATION-REQUIRES" "{" Cells "}"                 | empty 
  188.  
  189.     Cells ::=                   Cell                 | Cells "," Cell 
  190.  
  191.     Cell ::=                   value(Cell ObjectName) 
  192.  
  193.     DefValPart ::=                   "DEFVAL" "{" value(Defval ObjectSyntax) "}"                 | empty 
  194.  
  195.     -- uses the NVT ASCII character set     Text ::= """" string """" END 
  196.  
  197.  END 
  198.  
  199. 3.  Mapping of the OBJECT-GROUP macro 
  200.  
  201.    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. 
  202.  
  203.    To "implement" an object, a SNMPv2 entity acting in an agent role    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, a SNMPv2 entity must    accordingly be able to reasonably influence the underlying managed    entity.  If a SNMPv2 entity acting in an agent role can not implement    an object, the management protocol provides for the SNMPv2 entity to    return an exception or error, e.g, noSuchObject [4].  Under no    circumstances shall a SNMPv2 entity 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 [4]. 
  204.  
  205.  
  206.  
  207.  SNMPv2 Working Group        Standards Track                     [Page 9] 
  208.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  209.  
  210.  3.1.  Mapping of the OBJECTS clause 
  211.  
  212.    The OBJECTS clause, which must be present, is used to name each    object contained in the conformance group.  Each of the named 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". 
  213.  
  214.    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. 
  215.  
  216. 3.2.  Mapping of the STATUS clause 
  217.  
  218.    The STATUS clause, which must be present, indicates whether this    definition is current or historic. 
  219.  
  220.    The values "current", and "obsolete" are self-explanatory.  The    "deprecated" value indicates that the definition is obsolete, but    that an implementor may wish to support the group to foster    interoperability with older implementations. 
  221.  
  222. 3.3.  Mapping of the DESCRIPTION clause 
  223.  
  224.    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. 
  225.  
  226. 3.4.  Mapping of the REFERENCE clause 
  227.  
  228.    The REFERENCE clause, which need not be present, contains a textual    cross-reference to a group  defined in some other information module.    This is useful when de-osifying a MIB module produced by some other    organization. 
  229.  
  230. 3.5.  Mapping of the OBJECT-GROUP value 
  231.  
  232.    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. 
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240. SNMPv2 Working Group        Standards Track                    [Page 10] 
  241.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  242.  
  243.  3.6.  Usage Example 
  244.  
  245.    The SNMP Group [3] is described: 
  246.  
  247. 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 SNMPv2 entity."     ::= { snmpMIBGroups 8 } 
  248.  
  249.  According to this invocation, the conformance group named 
  250.  
  251.      { snmpMIBGroups 8 } 
  252.  
  253. contains 7 objects. 
  254.  
  255. 4.  Mapping of the NOTIFICATION-GROUP macro 
  256.  
  257.    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. 
  258.  
  259. 4.1.  Mapping of the NOTIFICATIONS clause 
  260.  
  261.    The NOTIFICATIONS clause, which must be present, is used to name each    notification contained in the conformance group.  Each of the named    notifications must be defined in the same information module as the    NOTIFICATION-GROUP macro appears. 
  262.  
  263. 4.2.  Mapping of the STATUS clause 
  264.  
  265.    The STATUS clause, which must be present, indicates whether this    definition is current or historic. 
  266.  
  267.    The values "current", and "obsolete" are self-explanatory.  The    "deprecated" value indicates that the definition is obsolete, but    that an implementor may wish to support the group to foster 
  268.  
  269.  
  270.  
  271. SNMPv2 Working Group        Standards Track                    [Page 11] 
  272.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  273.  
  274.     interoperability with older implementations. 
  275.  
  276. 4.3.  Mapping of the DESCRIPTION clause 
  277.  
  278.    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. 
  279.  
  280. 4.4.  Mapping of the REFERENCE clause 
  281.  
  282.    The REFERENCE clause, which need not be present, contains a textual    cross-reference to a group defined in some other information module.    This is useful when de-osifying a MIB module produced by some other    organization. 
  283.  
  284. 4.5.  Mapping of the NOTIFICATION-GROUP value 
  285.  
  286.    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. 
  287.  
  288. 4.6.  Usage Example 
  289.  
  290.    The SNMP Basic Notifications Group [3] is described: 
  291.  
  292. snmpBasicNotificationsGroup NOTIFICATION-GROUP     NOTIFICATIONS { coldStart, authenticationFailure }     STATUS        current     DESCRIPTION             "The two notifications which an SNMPv2 entity is required to             implement."     ::= { snmpMIBGroups 7 } 
  293.  
  294. According to this invocation, the conformance group named 
  295.  
  296.      { snmpMIBGroups 1 } 
  297.  
  298. contains 2 notifications. 
  299.  
  300. 5.  Mapping of the MODULE-COMPLIANCE macro 
  301.  
  302.    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. 
  303.  
  304.  
  305.  
  306. SNMPv2 Working Group        Standards Track                    [Page 12] 
  307.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  308.  
  309.     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. 
  310.  
  311. 5.1.  Mapping of the STATUS clause 
  312.  
  313.    The STATUS clause, which must be present, indicates whether this    definition is current or historic. 
  314.  
  315.    The values "current", and "obsolete" are self-explanatory.  The    "deprecated" value indicates that the specification is obsolete, but    that an implementor may wish to support that object to foster    interoperability with older implementations. 
  316.  
  317. 5.2.  Mapping of the DESCRIPTION clause 
  318.  
  319.    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. 
  320.  
  321. 5.3.  Mapping of the REFERENCE clause 
  322.  
  323.    The REFERENCE clause, which need not be present, contains a textual    cross-reference to a compliance statement defined in some other    information module. 
  324.  
  325. 5.4.  Mapping of the MODULE clause 
  326.  
  327.    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. 
  328.  
  329. 5.4.1.  Mapping of the MANDATORY-GROUPS clause 
  330.  
  331.    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 a    SNMPv2 entity acting in an agent role claims compliance to the MIB    module, then it must implement each and every object and notification    within each conformance group listed.  That is, if a SNMPv2 entity    returns a noSuchObject exception in response to a management protocol    get operation [4] for any object within any mandatory conformance    group for every MIB view, or if the SNMPv2 entity cannot generate    each notification listed in any conformance group under the 
  332.  
  333.  
  334.  
  335. SNMPv2 Working Group        Standards Track                    [Page 13] 
  336.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  337.  
  338.     appropriate circumstances, then that SNMPv2 entity is not a    conformant implementation of the MIB module. 
  339.  
  340. 5.4.2.  Mapping of the GROUP clause 
  341.  
  342.    The GROUP clause, which need not be present, is repeatedly used to    name each object and notification group which is conditionally    mandatory or unconditionally optional for compliance to the MIB    module.  A group named in a GROUP clause must be absent from the    correspondent MANDATORY-GROUPS clause. 
  343.  
  344.    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. 
  345.  
  346.    A group which is named in neither a MANDATORY-GROUPS clause nor a    GROUP clause, is unconditionally optional for compliance to the MIB    module. 
  347.  
  348. 5.4.3.  Mapping of the OBJECT clause 
  349.  
  350.    The OBJECT clause, which need not be present, is repeatedly used to    name 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. 
  351.  
  352.    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. 
  353.  
  354. 5.4.3.1.  Mapping of the SYNTAX clause 
  355.  
  356.    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. 
  357.  
  358.    Consult Section 9 of [2] for more information on refined syntax. 
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  SNMPv2 Working Group        Standards Track                    [Page 14] 
  367.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  368.  
  369.  5.4.3.2.  Mapping of the WRITE-SYNTAX clause 
  370.  
  371.    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. 
  372.  
  373.    Consult Section 9 of [2] for more information on refined syntax. 
  374.  
  375. 5.4.3.3.  Mapping of the MIN-ACCESS clause 
  376.  
  377.    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. 
  378.  
  379.    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    objects. 
  380.  
  381.    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. 
  382.  
  383. 5.4.4.  Mapping of the DESCRIPTION clause 
  384.  
  385.    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. 
  386.  
  387. 5.5.  Mapping of the MODULE-COMPLIANCE value 
  388.  
  389.    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. 
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397. SNMPv2 Working Group        Standards Track                    [Page 15] 
  398.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  399.  
  400.  5.6.  Usage Example 
  401.  
  402.    The compliance statement contained in the (hypothetical) XYZv2-MIB    might be: 
  403.  
  404. 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 } 
  405.  
  406.         GROUP   xyzV1Group         DESCRIPTION             "The xyzV1 group is mandatory only for those              XYZv2 entities which also implement XYZv1." ::= { xyzMIBCompliances 1 } 
  407.  
  408.    According to this invocation, to claim alignment with the compliance    statement named 
  409.  
  410.      { xyzMIBCompliances 1 } 
  411.  
  412.    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. 
  413.  
  414. 6.  Mapping of the AGENT-CAPABILITIES macro 
  415.  
  416.    The AGENT-CAPABILITIES macro is used to convey a set of capabilities    present in a SNMPv2 entity acting in an agent role.  It should be    noted that the expansion of the AGENT-CAPABILITIES macro is something    which conceptually happens during implementation and not during run-    time. 
  417.  
  418.    When a MIB module is written, it is divided into units of conformance    termed groups.  If a SNMPv2 entity acting in an agent role claims to    implement a group, then it must implement each and every object    within that group.  Of course, for whatever reason, a SNMPv2 entity    might implement only a subset of the groups within a MIB module.  In    addition, the definition of some MIB objects leave some aspects of 
  419.  
  420.  
  421.  
  422. SNMPv2 Working Group        Standards Track                    [Page 16] 
  423.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  424.  
  425.     the definition to the discretion of an implementor. 
  426.  
  427.    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 [3].  In particular, some objects may have restricted or    augmented syntax or access-levels. 
  428.  
  429.    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 [3].    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. 
  430.  
  431.    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. 
  432.  
  433. 6.1.  Mapping of the PRODUCT-RELEASE clause 
  434.  
  435.    The PRODUCT-RELEASE clause, which must be present, contains a textual    description of the product release which includes this set of    capabilities. 
  436.  
  437. 6.2.  Mapping of the STATUS clause 
  438.  
  439.    The STATUS clause, which must be present, indicates whether this    definition is current ("current") or historic ("obsolete"). 
  440.  
  441. 6.3.  Mapping of the DESCRIPTION clause 
  442.  
  443.    The DESCRIPTION clause, which must be present, contains a textual    description of this set of capabilities. 
  444.  
  445. 6.4.  Mapping of the REFERENCE clause 
  446.  
  447.    The REFERENCE clause, which need not be present, contains a textual    cross-reference to a capability statement defined in some other    information module. 
  448.  
  449.  
  450.  
  451.  
  452.  
  453. SNMPv2 Working Group        Standards Track                    [Page 17] 
  454.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  455.  
  456.  6.5.  Mapping of the SUPPORTS clause 
  457.  
  458.    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 well. 
  459.  
  460. 6.5.1.  Mapping of the INCLUDES clause 
  461.  
  462.    The INCLUDES clause, which must be present for each use of the    SUPPORTS clause, is used to name each MIB group associated with the    SUPPORTS clause, which the agent claims to implement. 
  463.  
  464. 6.5.2.  Mapping of the VARIATION clause 
  465.  
  466.    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. 
  467.  
  468.    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. 
  469.  
  470.    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    required in an information module. 
  471.  
  472. 6.5.2.1.  Mapping of the SYNTAX clause 
  473.  
  474.    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. 
  475.  
  476.    Consult Section 9 of [2] for more information on refined syntax. 
  477.  
  478. 6.5.2.2.  Mapping of the WRITE-SYNTAX clause 
  479.  
  480.    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. 
  481.  
  482.    Consult Section 9 of [2] for more information on refined syntax. 
  483.  
  484.  
  485.  
  486. SNMPv2 Working Group        Standards Track                    [Page 18] 
  487.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  488.  
  489.  6.5.2.3.  Mapping of the ACCESS clause 
  490.  
  491.    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. 
  492.  
  493.    The only value applicable to notifications is "not-implemented". 
  494.  
  495.    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". 
  496.  
  497.    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". 
  498.  
  499. 6.5.2.4.  Mapping of the CREATION-REQUIRES clause 
  500.  
  501.    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 [5].) 
  502.  
  503.    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 [6,7]), 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. 
  504.  
  505.    This clause must not 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. 
  506.  
  507.    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". 
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  SNMPv2 Working Group        Standards Track                    [Page 19] 
  516.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  517.  
  518.  6.5.2.5.  Mapping of the DEFVAL clause 
  519.  
  520.    The DEFVAL clause, which need not be present, is used to provide a    refined 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. 
  521.  
  522. 6.5.2.6.  Mapping of the DESCRIPTION clause 
  523.  
  524.    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. 
  525.  
  526. 6.6.  Mapping of the AGENT-CAPABILITIES value 
  527.  
  528.    The value of an invocation of the AGENT-CAPABILITIES macro is an    OBJECT IDENTIFIER, which names the value of sysORID [3] for which    this capabilities statement is valid. 
  529.  
  530. 6.7.  Usage Example 
  531.  
  532.    Consider how a capabilities statement for an agent might be    described: 
  533.  
  534. exampleAgent AGENT-CAPABILITIES     PRODUCT-RELEASE      "ACME Agent release 1.1 for 4BSD"     STATUS               current     DESCRIPTION          "ACME agent for 4BSD" 
  535.  
  536.     SUPPORTS             SNMPv2-MIB         INCLUDES         { systemGroup, snmpGroup, snmpSetGroup,                            snmpBasicNotificationsGroup } 
  537.  
  538.         VARIATION        coldStart             DESCRIPTION  "A coldStart trap is generated on all                          reboots." 
  539.  
  540.     SUPPORTS             IF-MIB         INCLUDES         { ifGeneralGroup, ifPacketGroup } 
  541.  
  542.         VARIATION        ifAdminStatus             SYNTAX       INTEGER { up(1), down(2) }             DESCRIPTION  "Unable to set test mode on 4BSD" 
  543.  
  544.         VARIATION        ifOperStatus             SYNTAX       INTEGER { up(1), down(2) }             DESCRIPTION  "Information limited on 4BSD" 
  545.  
  546.  
  547.  
  548.  SNMPv2 Working Group        Standards Track                    [Page 20] 
  549.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  550.  
  551.      SUPPORTS             IP-MIB         INCLUDES         { ipGroup, icmpGroup }          VARIATION        ipDefaultTTL             SYNTAX       INTEGER (255..255)             DESCRIPTION  "Hard-wired on 4BSD" 
  552.  
  553.         VARIATION        ipInAddrErrors             ACCESS       not-implemented             DESCRIPTION  "Information not available on 4BSD" 
  554.  
  555.         VARIATION        ipNetToMediaEntry             CREATION-REQUIRES { ipNetToMediaPhysAddress }             DESCRIPTION  "Address mappings on 4BSD require                          both protocol and media addresses" 
  556.  
  557.     SUPPORTS             TCP-MIB         INCLUDES         { tcpGroup }         VARIATION        tcpConnState             ACCESS       read-only             DESCRIPTION  "Unable to set this on 4BSD" 
  558.  
  559.     SUPPORTS             UDP-MIB         INCLUDES         { udpGroup } 
  560.  
  561.     SUPPORTS             EVAL-MIB         INCLUDES         { functionsGroup, expressionsGroup }         VARIATION        exprEntry             CREATION-REQUIRES { evalString }             DESCRIPTION "Conceptual row creation supported" 
  562.  
  563.     ::= { acmeAgents 1 } 
  564.  
  565.    According to this invocation, an agent with a sysORID value of 
  566.  
  567.      { acmeAgents 1 } 
  568.  
  569.    supports six MIB modules. 
  570.  
  571.    From SNMPv2-MIB, five conformance groups are supported. 
  572.  
  573.    From IF-MIB, the ifGeneralGroup and ifPacketGroup groups are    supported.  However, the objects ifAdminStatus and ifOperStatus have    a restricted syntax. 
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581. SNMPv2 Working Group        Standards Track                    [Page 21] 
  582.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  583.  
  584.     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 atPhysAddress. 
  585.  
  586.    From TCP-MIB, the tcpGroup is supported except that tcpConnState is    available only for reading. 
  587.  
  588.    From UDP-MIB, the udpGroup is fully supported. 
  589.  
  590.    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. 
  591.  
  592. 7.  Extending an Information Module 
  593.  
  594.    As experience is gained with a published information module, it may    be desirable to revise that information module. 
  595.  
  596.    Section 10 of [2] 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. 
  597.  
  598. 7.1.  Conformance Groups 
  599.  
  600.    If any non-editorial change is made to any clause of an object group    then the OBJECT IDENTIFIER value associated with that object group    must also be changed, along with its associated descriptor. 
  601.  
  602. 7.2.  Compliance Definitions 
  603.  
  604.    If any non-editorial change is made to any clause of a compliance    definition, then the OBJECT IDENTIFIER value associated with that    compliance definition must also be changed, along with its associated    descriptor. 
  605.  
  606. 7.3.  Capabilities Definitions 
  607.  
  608.    If any non-editorial change is made to any clause of a capabilities    definition, then the OBJECT IDENTIFIER value associated with that    capabilities definition must also be changed, along with its    associated descriptor. 
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616. SNMPv2 Working Group        Standards Track                    [Page 22] 
  617.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  618.  
  619.  8.  Security Considerations 
  620.  
  621.    Security issues are not discussed in this memo. 
  622.  
  623. 9.  Editor's Address 
  624.  
  625.    Keith McCloghrie    Cisco Systems, Inc.    170 West Tasman Drive    San Jose, CA  95134-1706    US 
  626.  
  627.    Phone: +1 408 526 5260    EMail: kzm@cisco.com 
  628.  
  629. 10.  Acknowledgements 
  630.  
  631.    This document is the result of significant work by the four major    contributors: 
  632.  
  633.    Jeffrey D. Case (SNMP Research, case@snmp.com)    Keith McCloghrie (Cisco Systems, kzm@cisco.com)    Marshall T. Rose (Dover Beach Consulting, mrose@dbc.mtview.ca.us)    Steven Waldbusser (International Network Services, stevew@uni.ins.com) 
  634.  
  635.    In addition, the contributions of the SNMPv2 Working Group are    acknowledged.  In particular, a special thanks is extended for the    contributions of: 
  636.  
  637.      Alexander I. Alten (Novell)      Dave Arneson (Cabletron)      Uri Blumenthal (IBM)      Doug Book (Chipcom)      Kim Curran (Bell-Northern Research)      Jim Galvin (Trusted Information Systems)      Maria Greene (Ascom Timeplex)      Iain Hanson (Digital)      Dave Harrington (Cabletron)      Nguyen Hien (IBM)      Jeff Johnson (Cisco Systems)      Michael Kornegay (Object Quest)      Deirdre Kostick (AT&T Bell Labs)      David Levi (SNMP Research)      Daniel Mahoney (Cabletron)      Bob Natale (ACE*COMM)      Brian O'Keefe (Hewlett Packard)      Andrew Pearson (SNMP Research)      Dave Perkins (Peer Networks) 
  638.  
  639.  
  640.  
  641. SNMPv2 Working Group        Standards Track                    [Page 23] 
  642.  RFC 1904           Conformance Statements for SNMPv2        January 1996 
  643.  
  644.       Randy Presuhn (Peer Networks)      Aleksey Romanov (Quality Quorum)      Shawn Routhier (Epilogue)      Jon Saperia (BGS Systems)      Bob Stewart (Cisco Systems, bstewart@cisco.com), chair      Kaj Tesink (Bellcore)      Glenn Waters (Bell-Northern Research)      Bert Wijnen (IBM) 
  645.  
  646. 11.  References 
  647.  
  648. [1]  Information processing systems - Open Systems Interconnection -      Specification of Abstract Syntax Notation One (ASN.1),      International Organization for Standardization.  International      Standard 8824, (December, 1987). 
  649.  
  650. [2]  SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and      S. Waldbusser, "Structure of Management Information for Version 2      of the Simple Network Management Protocol (SNMPv2)", RFC 1902,      January 1996. 
  651.  
  652. [3]  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)", RFC 1907,      January 1996. 
  653.  
  654. [4]  SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and      S. Waldbusser, "Protocol Operations for Version 2 of the Simple      Network Management Protocol (SNMPv2)", RFC 1905, January 1996. 
  655.  
  656. [5]  SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and      S. Waldbusser, "Textual Conventions for Version 2 of the Simple      Network Management Protocol (SNMPv2)", RFC 1903, January 1996. 
  657.  
  658. [6]  Rose, M., and K. McCloghrie, "Structure and Identification of      Management Information for TCP/IP-based internets", STD 16, RFC      1155, May 1990. 
  659.  
  660. [7]  Rose, M., and K. McCloghrie, "Concise MIB Definitions", STD 16,      RFC 1212, March 1991. 
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.  
  672. SNMPv2 Working Group        Standards Track                    [Page 24] 
  673.  
  674.