home *** CD-ROM | disk | FTP | other *** search
/ Hackers Toolkit 2.0 / Hackers_Toolkit_v2.0.iso / HTML / archive / Texts / Rfc / RFC1212.TXT < prev    next >
Encoding:
Text File  |  1999-11-04  |  41.5 KB  |  1,083 lines

  1. Network Working Group                                           M. Rose
  2. Request for Comments: 1212            Performance Systems International
  3.                                                           K. McCloghrie
  4.                                                      Hughes LAN Systems
  5.                                                                 Editors
  6.                                                              March 1991
  7.  
  8.  
  9.                         Concise MIB Definitions
  10. Status of this Memo
  11.  
  12.    This memo defines a format for producing MIB modules.  This RFC
  13.    specifies an IAB standards track document for the Internet community,
  14.    and requests discussion and suggestions for improvements.  Please
  15.    refer to the current edition of the "IAB Official Protocol Standards"
  16.    for the standardization state and status of this protocol.
  17.    Distribution of this memo is unlimited.
  18.  
  19. Table of Contents
  20.  
  21.    1. Abstract..............................................    2
  22.    2. Historical Perspective ...............................    2
  23.    3. Columnar Objects .....................................    3
  24.    3.1 Row Deletion ........................................    4
  25.    3.2 Row Addition ........................................    4
  26.    4. Defining Objects .....................................    5
  27.    4.1 Mapping of the OBJECT-TYPE macro ....................    7
  28.    4.1.1 Mapping of the SYNTAX clause ......................    7
  29.    4.1.2 Mapping of the ACCESS clause ......................    8
  30.    4.1.3 Mapping of the STATUS clause ......................    8
  31.    4.1.4 Mapping of the DESCRIPTION clause .................    8
  32.    4.1.5 Mapping of the REFERENCE clause ...................    8
  33.    4.1.6 Mapping of the INDEX clause .......................    8
  34.    4.1.7 Mapping of the DEFVAL clause ......................   10
  35.    4.1.8 Mapping of the OBJECT-TYPE value ..................   11
  36.    4.2 Usage Example .......................................   11
  37.    5. Appendix: DE-osifying MIBs ...........................   13
  38.    5.1 Managed Object Mapping ..............................   14
  39.    5.1.1 Mapping to the SYNTAX clause ......................   15
  40.    5.1.2 Mapping to the ACCESS clause ......................   15
  41.    5.1.3 Mapping to the STATUS clause ......................   15
  42.    5.1.4 Mapping to the DESCRIPTION clause .................   15
  43.    5.1.5 Mapping to the REFERENCE clause ...................   16
  44.    5.1.6 Mapping to the INDEX clause .......................   16
  45.    5.1.7 Mapping to the DEFVAL clause ......................   16
  46.    5.2 Action Mapping ......................................   16
  47.    5.2.1 Mapping to the SYNTAX clause ......................   16
  48.    5.2.2 Mapping to the ACCESS clause ......................   16
  49.  
  50.  
  51.  
  52. SNMP Working Group                                              [Page 1]
  53.  
  54.  
  55. RFC 1212                Concise MIB Definitions               March 1991
  56.  
  57.  
  58.    5.2.3 Mapping to the STATUS clause ......................   16
  59.    5.2.4 Mapping to the DESCRIPTION clause .................   16
  60.    5.2.5 Mapping to the REFERENCE clause ...................   16
  61.    6. Acknowledgements .....................................   17
  62.    7. References ...........................................   18
  63.    8. Security Considerations...............................   19
  64.    9. Authors' Addresses....................................   19
  65.  
  66. 1.  Abstract
  67.  
  68.    This memo describes a straight-forward approach toward producing
  69.    concise, yet descriptive, MIB modules.  It is intended that all
  70.    future MIB modules be written in this format.
  71.  
  72. 2.  Historical Perspective
  73.  
  74.    As reported in RFC 1052, IAB Recommendations for the Development of
  75.    Internet Network Management Standards [1], a two-prong strategy for
  76.    network management of TCP/IP-based internets was undertaken.  In the
  77.    short-term, the Simple Network Management Protocol (SNMP), defined in
  78.    RFC 1067, was to be used to manage nodes in the Internet community.
  79.    In the long-term, the use of the OSI network management framework was
  80.    to be examined.  Two documents were produced to define the management
  81.    information: RFC 1065, which defined the Structure of Management
  82.    Information (SMI), and RFC 1066, which defined the Management
  83.    Information Base (MIB).  Both of these documents were designed so as
  84.    to be compatible with both the SNMP and the OSI network management
  85.    framework.
  86.  
  87.    This strategy was quite successful in the short-term: Internet-based
  88.    network management technology was fielded, by both the research and
  89.    commercial communities, within a few months.  As a result of this,
  90.    portions of the Internet community became network manageable in a
  91.    timely fashion.
  92.  
  93.    As reported in RFC 1109, Report of the Second Ad Hoc Network
  94.    Management Review Group [2], the requirements of the SNMP and the OSI
  95.    network management frameworks were more different than anticipated.
  96.    As such, the requirement for compatibility between the SMI/MIB and
  97.    both frameworks was suspended.  This action permitted the operational
  98.    network management framework, based on the SNMP, to respond to new
  99.    operational needs in the Internet community by producing MIB-II.
  100.  
  101.    In May of 1990, the core documents were elevated to "Standard
  102.    Protocols" with "Recommended" status.  As such, the Internet-standard
  103.    network management framework consists of: Structure and
  104.    Identification of Management Information for TCP/IP-based internets,
  105.    RFC 1155 [3], which describes how managed objects contained in the
  106.  
  107.  
  108.  
  109. SNMP Working Group                                              [Page 2]
  110.  
  111.  
  112. RFC 1212                Concise MIB Definitions               March 1991
  113.  
  114.  
  115.    MIB are defined; Management Information Base for Network Management
  116.    of TCP/IP-based internets, which describes the managed objects
  117.    contained in the MIB, RFC 1156 [4]; and, the Simple Network
  118.    Management Protocol, RFC 1157 [5], which defines the protocol used to
  119.    manage these objects.  Consistent with the IAB directive to produce
  120.    simple, workable systems in the short-term, the list of managed
  121.    objects defined in the Internet-standard MIB was derived by taking
  122.    only those elements which are considered essential.  However, the SMI
  123.    defined three extensibility mechanisms: one, the addition of new
  124.    standard objects through the definitions of new versions of the MIB;
  125.    two, the addition of widely-available but non-standard objects
  126.    through the experimental subtree; and three, the addition of private
  127.    objects through the enterprises subtree.  Such additional objects can
  128.    not only be used for vendor-specific elements, but also for
  129.    experimentation as required to further the knowledge of which other
  130.    objects are essential.
  131.  
  132.    As more objects are defined using the second method, experience has
  133.    shown that the resulting MIB descriptions contain redundant
  134.    information.  In order to provide for MIB descriptions which are more
  135.    concise, and yet as informative, an enhancement is suggested.  This
  136.    enhancement allows the author of a MIB to remove the redundant
  137.    information, while retaining the important descriptive text.
  138.  
  139.    Before presenting the approach, a brief presentation of columnar
  140.    object handling by the SNMP is necessary.  This explains and further
  141.    motivates the value of the enhancement.
  142.  
  143. 3.  Columnar Objects
  144.  
  145.    The SNMP supports operations on MIB objects whose syntax is
  146.    ObjectSyntax as defined in the SMI.  Informally stated, SNMP
  147.    operations apply exclusively to scalar objects.  However, it is
  148.    convenient for developers of management applications to impose
  149.    imaginary, tabular structures on the ordered collection of objects
  150.    that constitute the MIB.  Each such conceptual table contains zero or
  151.    more rows, and each row may contain one or more scalar objects,
  152.    termed columnar objects.  Historically, this conceptualization has
  153.    been formalized by using the OBJECT-TYPE macro to define both an
  154.    object which corresponds to a table and an object which corresponds
  155.    to a row in that table.  (The ACCESS clause for such objects is
  156.    "not-accessible", of course.) However, it must be emphasized that, at
  157.    the protocol level, relationships among columnar objects in the same
  158.    row is a matter of convention, not of protocol.
  159.  
  160.    Note that there are good reasons why the tabular structure is not a
  161.    matter of protocol.  Consider the operation of the SNMP Get-Next-PDU
  162.    acting on the last columnar object of an instance of a conceptual
  163.  
  164.  
  165.  
  166. SNMP Working Group                                              [Page 3]
  167.  
  168.  
  169. RFC 1212                Concise MIB Definitions               March 1991
  170.  
  171.  
  172.    row; it returns the next column of the first conceptual row or the
  173.    first object instance occurring after the table.  In contrast, if the
  174.    rows were a matter of protocol, then it would instead return an
  175.    error.  By not returning an error, a single PDU exchange informs the
  176.    manager that not only has the end of the conceptual row/table been
  177.    reached, but also provides information on the next object instance,
  178.    thereby increasing the information density of the PDU exchange.
  179.  
  180. 3.1.  Row Deletion
  181.  
  182.    Nonetheless, it is highly useful to provide a means whereby a
  183.    conceptual row may be removed from a table. In MIB-II, this was
  184.    achieved by defining, for each conceptual row, an integer-valued
  185.    columnar object.  If a management station sets the value of this
  186.    object to some value, usually termed "invalid", then the effect is
  187.    one of invalidating the corresponding row in the table.  However, it
  188.    is an implementation-specific matter as to whether an agent removes
  189.    an invalidated entry from the table.  Accordingly, management
  190.    stations must be prepared to receive tabular information from agents
  191.    that corresponds to entries not currently in use.  Proper
  192.    interpretation of such entries requires examination of the columnar
  193.    object indicating the in-use status.
  194.  
  195. 3.2.  Row Addition
  196.  
  197.    It is also highly useful to have a clear understanding of how a
  198.    conceptual row may be added to a table.  In the SNMP, at the protocol
  199.    level, a management station issues an SNMP set operation containing
  200.    an arbitrary set of variable bindings.  In the case that an agent
  201.    detects that one or more of those variable bindings refers to an
  202.    object instance not currently available in that agent, it may,
  203.    according to the rules of the SNMP, behave according to any of the
  204.    following paradigms:
  205.  
  206.           (1)  It may reject the SNMP set operation as referring to
  207.                non-existent object instances by returning a response
  208.                with the error-status field set to "noSuchName" and the
  209.                error-index field set to refer to the first vacuous
  210.                reference.
  211.  
  212.           (2)  It may accept the SNMP set operation as requesting the
  213.                creation  of new object instances corresponding to each
  214.                of the object instances named in the variable bindings.
  215.                The value of each (potentially) newly created object
  216.                instance is specified by the "value" component of the
  217.                relevant variable binding.  In this case, if the request
  218.                specifies a value for a newly (or previously) created
  219.                object that it deems inappropriate by reason of value or
  220.  
  221.  
  222.  
  223. SNMP Working Group                                              [Page 4]
  224.  
  225.  
  226. RFC 1212                Concise MIB Definitions               March 1991
  227.  
  228.  
  229.                syntax, then it rejects the SNMP set operation by
  230.                responding with the error-status field set to badValue
  231.                and the error-index field set to refer to the first
  232.                offending variable binding.
  233.  
  234.           (3)  It may accept the SNMP set operation and create new
  235.                object instances as described in (2) above and, in
  236.                addition, at its discretion, create supplemental object
  237.                instances to complete a row in a conceptual table of
  238.                which the new object instances specified in the request
  239.                may be a part.
  240.  
  241.    It should be emphasized that all three of the above behaviors are
  242.    fully conformant to the SNMP specification and are fully acceptable,
  243.    subject to any restrictions which may be imposed by access control
  244.    and/or the definitions of the MIB objects themselves.
  245.  
  246. 4.  Defining Objects
  247.  
  248.    The Internet-standard SMI employs a two-level approach towards object
  249.    definition.  A MIB definition consists of two parts: a textual part,
  250.    in which objects are placed into groups, and a MIB module, in which
  251.    objects are described solely in terms of the ASN.1 macro OBJECT-TYPE,
  252.    which is defined by the SMI.
  253.  
  254.    An example of the former definition might be:
  255.  
  256.           OBJECT:
  257.           -------
  258.                sysLocation { system 6 }
  259.  
  260.           Syntax:
  261.                DisplayString (SIZE (0..255))
  262.  
  263.           Definition:
  264.                The physical location of this node (e.g., "telephone
  265.                closet, 3rd floor").
  266.  
  267.           Access:
  268.                read-only.
  269.  
  270.           Status:
  271.                mandatory.
  272.  
  273.           An example of the latter definition might be:
  274.  
  275.                sysLocation OBJECT-TYPE
  276.                    SYNTAX  DisplayString (SIZE (0..255))
  277.  
  278.  
  279.  
  280. SNMP Working Group                                              [Page 5]
  281.  
  282.  
  283. RFC 1212                Concise MIB Definitions               March 1991
  284.  
  285.  
  286.                    ACCESS  read-only
  287.                    STATUS  mandatory
  288.                    ::= { system 6 }
  289.  
  290.           In the interests of brevity and to reduce the chance of
  291.           editing errors, it would seem useful to combine the two
  292.           definitions.  This can be accomplished by defining an
  293.           extension to the OBJECT-TYPE macro:
  294.  
  295.           IMPORTS
  296.               ObjectName
  297.                   FROM RFC1155-SMI
  298.               DisplayString
  299.                   FROM RFC1158-MIB;
  300.  
  301.           OBJECT-TYPE MACRO ::=
  302.           BEGIN
  303.               TYPE NOTATION ::=
  304.                                           -- must conform to
  305.                                           -- RFC1155's ObjectSyntax
  306.                                 "SYNTAX" type(ObjectSyntax)
  307.                                 "ACCESS" Access
  308.                                 "STATUS" Status
  309.                                 DescrPart
  310.                                 ReferPart
  311.                                 IndexPart
  312.                                 DefValPart
  313.               VALUE NOTATION ::= value (VALUE ObjectName)
  314.  
  315.               Access ::= "read-only"
  316.                               | "read-write"
  317.                               | "write-only"
  318.                               | "not-accessible"
  319.               Status ::= "mandatory"
  320.                               | "optional"
  321.                               | "obsolete"
  322.                               | "deprecated"
  323.  
  324.               DescrPart ::=
  325.                          "DESCRIPTION" value (description DisplayString)
  326.                               | empty
  327.  
  328.               ReferPart ::=
  329.                          "REFERENCE" value (reference DisplayString)
  330.                               | empty
  331.  
  332.               IndexPart ::=
  333.                          "INDEX" "{" IndexTypes "}"
  334.  
  335.  
  336.  
  337. SNMP Working Group                                              [Page 6]
  338.  
  339.  
  340. RFC 1212                Concise MIB Definitions               March 1991
  341.  
  342.  
  343.                               | empty
  344.               IndexTypes ::=
  345.                          IndexType | IndexTypes "," IndexType
  346.               IndexType ::=
  347.                                   -- if indexobject, use the SYNTAX
  348.                                   -- value of the correspondent
  349.                                   -- OBJECT-TYPE invocation
  350.                          value (indexobject ObjectName)
  351.                                   -- otherwise use named SMI type
  352.                                   -- must conform to IndexSyntax below
  353.                               | type (indextype)
  354.  
  355.               DefValPart ::=
  356.                          "DEFVAL" "{" value (defvalue ObjectSyntax) "}"
  357.                               | empty
  358.  
  359.           END
  360.  
  361.           IndexSyntax ::=
  362.               CHOICE {
  363.                   number
  364.                       INTEGER (0..MAX),
  365.                   string
  366.                       OCTET STRING,
  367.                   object
  368.                       OBJECT IDENTIFIER,
  369.                   address
  370.                       NetworkAddress,
  371.                   ipAddress
  372.                       IpAddress
  373.               }
  374.  
  375.  
  376. 4.1.  Mapping of the OBJECT-TYPE macro
  377.  
  378.    It should be noted that the expansion of the OBJECT-TYPE macro is
  379.    something which conceptually happens during implementation and not
  380.    during run-time.
  381.  
  382. 4.1.1.  Mapping of the SYNTAX clause
  383.  
  384.    The SYNTAX clause, which must be present, defines the abstract data
  385.    structure corresponding to that object type.  The ASN.1 language [6]
  386.    is used for this purpose.  However, the SMI purposely restricts the
  387.    ASN.1 constructs which may be used.  These restrictions are made
  388.    expressly for simplicity.
  389.  
  390.  
  391.  
  392.  
  393.  
  394. SNMP Working Group                                              [Page 7]
  395.  
  396.  
  397. RFC 1212                Concise MIB Definitions               March 1991
  398.  
  399.  
  400. 4.1.2.  Mapping of the ACCESS clause
  401.  
  402.    The ACCESS clause, which must be present, defines the minimum level
  403.    of support required for that object type.  As a local matter,
  404.    implementations may support other access types (e.g., an
  405.    implementation may elect to permitting writing a variable marked as
  406.    read-only).  Further, protocol-specific "views" (e.g., those
  407.    indirectly implied by an SNMP community) may make further
  408.    restrictions on access to a variable.
  409.  
  410. 4.1.3.  Mapping of the STATUS clause
  411.  
  412.    The STATUS clause, which must be present, defines the implementation
  413.    support required for that object type.
  414.  
  415. 4.1.4.  Mapping of the DESCRIPTION clause
  416.  
  417.    The DESCRIPTION clause, which need not be present, contains a textual
  418.    definition of that object type which provides all semantic
  419.    definitions necessary for implementation, and should embody any
  420.    information which would otherwise be communicated in any ASN.1
  421.    commentary annotations associated with the object.  Note that, in
  422.    order to conform to the ASN.1 syntax, the entire value of this clause
  423.    must be enclosed in double quotation marks, although the value may be
  424.    multi-line.
  425.  
  426.    Further, note that if the MIB module does not contain a textual
  427.    description of the object type elsewhere then the DESCRIPTION clause
  428.    must be present.
  429.  
  430. 4.1.5.  Mapping of the REFERENCE clause
  431.  
  432.    The REFERENCE clause, which need not be present, contains a textual
  433.    cross-reference to an object defined in some other MIB module.  This
  434.    is useful when de-osifying a MIB produced by some other organization.
  435.  
  436. 4.1.6.  Mapping of the INDEX clause
  437.  
  438.    The INDEX clause, which may be present only if that object type
  439.    corresponds to a conceptual row, defines instance identification
  440.    information for that object type.  (Historically, each MIB definition
  441.    contained a section entitled "Identification of OBJECT instances for
  442.    use with the SNMP".  By using the INDEX clause, this section need no
  443.    longer occur as this clause concisely captures the precise semantics
  444.    needed for instance identification.)
  445.  
  446.    If the INDEX clause is not present, and the object type corresponds
  447.    to a non-columnar object, then instances of the object are identified
  448.  
  449.  
  450.  
  451. SNMP Working Group                                              [Page 8]
  452.  
  453.  
  454. RFC 1212                Concise MIB Definitions               March 1991
  455.  
  456.  
  457.    by appending a sub-identifier of zero to the name of that object.
  458.    Further, note that if the MIB module does not contain a textual
  459.    description of how instance identification information is derived for
  460.    columnar objects, then the INDEX clause must be present.
  461.  
  462.    To define the instance identification information, determine which
  463.    object value(s) will unambiguously distinguish a conceptual row.  The
  464.    syntax of those objects indicate how to form the instance-identifier:
  465.  
  466.           (1)  integer-valued: a single sub-identifier taking the
  467.                integer value (this works only for non-negative
  468.                integers);
  469.  
  470.           (2)  string-valued, fixed-length strings: `n' sub-identifiers,
  471.                where `n' is the length of the string (each octet of the
  472.                string is encoded in a separate sub-identifier);
  473.  
  474.           (3)  string-valued, variable-length strings: `n+1' sub-
  475.                identifiers, where `n' is the length of the string (the
  476.                first sub-identifier is `n' itself, following this, each
  477.                octet of the string is encoded in a separate sub-
  478.                identifier);
  479.  
  480.           (4)  object identifier-valued: `n+1' sub-identifiers, where
  481.                `n' is the number of sub-identifiers in the value (the
  482.                first sub-identifier is `n' itself, following this, each
  483.                sub-identifier in the value is copied);
  484.  
  485.           (5)  NetworkAddress-valued: `n+1' sub-identifiers, where `n'
  486.                depends on the kind of address being encoded (the first
  487.                sub-identifier indicates the kind of address, value 1
  488.                indicates an IpAddress); or,
  489.  
  490.           (6)  IpAddress-valued: 4 sub-identifiers, in the familiar
  491.                a.b.c.d notation.
  492.  
  493.    Note that if an "indextype" value is present (e.g., INTEGER rather
  494.    than ifIndex), then a DESCRIPTION clause must be present; the text
  495.    contained therein indicates the semantics of the "indextype" value.
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508. SNMP Working Group                                              [Page 9]
  509.  
  510.  
  511. RFC 1212                Concise MIB Definitions               March 1991
  512.  
  513.  
  514.    By way of example, in the context of MIB-II [7], the following INDEX
  515.    clauses might be present:
  516.  
  517.                  objects under         INDEX clause
  518.                -----------------       ------------
  519.                ifEntry                 { ifIndex }
  520.                atEntry                 { atNetIfIndex,
  521.                                          atNetAddress }
  522.                ipAddrEntry             { ipAdEntAddr }
  523.                ipRouteEntry            { ipRouteDest }
  524.                ipNetToMediaEntry       { ipNetToMediaIfIndex,
  525.                                          ipNetToMediaNetAddress }
  526.                tcpConnEntry            { tcpConnLocalAddress,
  527.                                          tcpConnLocalPort,
  528.                                          tcpConnRemoteAddress,
  529.                                          tcpConnRemotePort }
  530.                udpEntry                { udpLocalAddress,
  531.                                          udpLocalPort }
  532.                egpNeighEntry           { egpNeighAddr }
  533.  
  534.  
  535. 4.1.7.  Mapping of the DEFVAL clause
  536.  
  537.    The DEFVAL clause, which need not be present, defines an acceptable
  538.    default value which may be used when an object instance is created at
  539.    the discretion of the agent acting in conformance with the third
  540.    paradigm described in Section 4.2 above.
  541.  
  542.    During conceptual row creation, if an instance of a columnar object
  543.    is not present as one of the operands in the correspondent SNMP set
  544.    operation, then the value of the DEFVAL clause, if present, indicates
  545.    an acceptable default value that the agent might use.
  546.  
  547.    The value of the DEFVAL clause must, of course, correspond to the
  548.    SYNTAX clause for the object.  Note that if an operand to the SNMP
  549.    set operation is an instance of a read-only object, then the error
  550.    noSuchName will be returned.  As such, the DEFVAL clause can be used
  551.    to provide an acceptable default value that the agent might use.
  552.  
  553.    It is possible that no acceptable default value may exist for any of
  554.    the columnar objects in a conceptual row for which the creation of
  555.    new object instances is allowed.  In this case, the objects specified
  556.    in the INDEX clause must have a corresponding ACCESS clause value of
  557.    read-write.
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565. SNMP Working Group                                             [Page 10]
  566.  
  567.  
  568. RFC 1212                Concise MIB Definitions               March 1991
  569.  
  570.  
  571.    By way of example, consider the following possible DEFVAL clauses:
  572.  
  573.        ObjectSyntax            DEFVAL clause
  574.        -----------------       ------------
  575.        INTEGER                 1 -- same for Counter, Gauge, TimeTicks
  576.        OCTET STRING            'ffffffffffff'h
  577.        DisplayString           "any NVT ASCII string"
  578.        OBJECT IDENTIFIER       sysDescr
  579.        OBJECT IDENTIFIER       { system 2 }
  580.        NULL                    NULL
  581.        NetworkAddress          { internet 'c0210415'h }
  582.        IpAddress               'c0210415'h -- 192.33.4.21
  583.  
  584.  
  585. 4.1.8.  Mapping of the OBJECT-TYPE value
  586.  
  587.    The value of an invocation of the OBJECT-TYPE macro is the name of
  588.    the object, which is an object identifier.
  589.  
  590. 4.2.  Usage Example
  591.  
  592.    Consider how the ipNetToMediaTable from MIB-II might be fully
  593.    described:
  594.  
  595.           -- the IP Address Translation tables
  596.  
  597.           -- The Address Translation tables contain IpAddress to
  598.           -- "physical" address equivalences.  Some interfaces do not
  599.           -- use translation tables for determining address equivalences
  600.           -- (e.g., DDN-X.25 has an algorithmic method); if all
  601.           -- interfaces are of this type, then the Address Translation
  602.           -- table is empty, i.e., has zero entries.
  603.  
  604.           ipNetToMediaTable OBJECT-TYPE
  605.               SYNTAX  SEQUENCE OF IpNetToMediaEntry
  606.               ACCESS  not-accessible
  607.               STATUS  mandatory
  608.               DESCRIPTION
  609.                       "The IP Address Translation table used for mapping
  610.                       from IP addresses to physical addresses."
  611.               ::= { ip 22 }
  612.  
  613.           ipNetToMediaEntry OBJECT-TYPE
  614.               SYNTAX  IpNetToMediaEntry
  615.               ACCESS  not-accessible
  616.               STATUS  mandatory
  617.               DESCRIPTION
  618.                       "Each entry contains one IpAddress to 'physical'
  619.  
  620.  
  621.  
  622. SNMP Working Group                                             [Page 11]
  623.  
  624.  
  625. RFC 1212                Concise MIB Definitions               March 1991
  626.  
  627.  
  628.                       address equivalence."
  629.               INDEX   { ipNetToMediaIfIndex,
  630.                         ipNetToMediaNetAddress }
  631.               ::= { ipNetToMediaTable 1 }
  632.  
  633.           IpNetToMediaEntry ::=
  634.               SEQUENCE {
  635.                   ipNetToMediaIfIndex
  636.                       INTEGER,
  637.                   ipNetToMediaPhysAddress
  638.                       OCTET STRING,
  639.                   ipNetToMediaNetAddress
  640.                       IpAddress,
  641.                   ipNetoToMediaType
  642.                       INTEGER
  643.               }
  644.  
  645.           ipNetToMediaIfIndex OBJECT-TYPE
  646.               SYNTAX  INTEGER
  647.               ACCESS  read-write
  648.               STATUS  mandatory
  649.               DESCRIPTION
  650.                       "The interface on which this entry's equivalence
  651.                       is effective.  The interface identified by a
  652.                       particular value of this index is the same
  653.                       interface as identified by the same value of
  654.                       ifIndex."
  655.               ::= { ipNetToMediaEntry 1 }
  656.  
  657.           ipNetToMediaPhysAddress OBJECT-TYPE
  658.               SYNTAX  OCTET STRING
  659.               ACCESS  read-write
  660.               STATUS  mandatory
  661.               DESCRIPTION
  662.                       "The media-dependent 'physical' address."
  663.               ::= { ipNetToMediaEntry 2 }
  664.  
  665.           ipNetToMediaNetAddress OBJECT-TYPE
  666.               SYNTAX  IpAddress
  667.               ACCESS  read-write
  668.               STATUS  mandatory
  669.               DESCRIPTION
  670.                       "The IpAddress corresponding to the media-
  671.                       dependent 'physical' address."
  672.               ::= { ipNetToMediaEntry 3 }
  673.  
  674.           ipNetToMediaType OBJECT-TYPE
  675.               SYNTAX  INTEGER {
  676.  
  677.  
  678.  
  679. SNMP Working Group                                             [Page 12]
  680.  
  681.  
  682. RFC 1212                Concise MIB Definitions               March 1991
  683.  
  684.  
  685.                           other(1),   -- none of the following
  686.                           invalid(2), -- an invalidated mapping
  687.                           dynamic(3),
  688.                           static(4)
  689.                       }
  690.               ACCESS  read-write
  691.               STATUS  mandatory
  692.               DESCRIPTION
  693.                       "The type of mapping.
  694.  
  695.                       Setting this object to the value invalid(2) has
  696.                       the effect of invalidating the corresponding entry
  697.                       in the ipNetToMediaTable.  That is, it effectively
  698.                       disassociates the interface identified with said
  699.                       entry from the mapping identified with said entry.
  700.                       It is an implementation-specific matter as to
  701.                       whether the agent removes an invalidated entry
  702.                       from the table.  Accordingly, management stations
  703.                       must be prepared to receive tabular information
  704.                       from agents that corresponds to entries not
  705.                       currently in use.  Proper interpretation of such
  706.                       entries requires examination of the relevant
  707.                       ipNetToMediaType object."
  708.                   ::= { ipNetToMediaEntry 4 }
  709.  
  710.  
  711. 5.  Appendix: DE-osifying MIBs
  712.  
  713.    There has been an increasing amount of work recently on taking MIBs
  714.    defined by other organizations (e.g., the IEEE) and de-osifying them
  715.    for use with the Internet-standard network management framework.  The
  716.    steps to achieve this are straight-forward, though tedious.  Of
  717.    course, it is helpful to already be experienced in writing MIB
  718.    modules for use with the Internet-standard network management
  719.    framework.
  720.  
  721.    The first step is to construct a skeletal MIB module, e.g.,
  722.  
  723.                RFC1213-MIB DEFINITIONS ::= BEGIN
  724.  
  725.                IMPORTS
  726.                        experimental, OBJECT-TYPE, Counter
  727.                            FROM RFC1155-SMI;
  728.  
  729.                        -- contact IANA for actual number
  730.                root    OBJECT IDENTIFIER ::= { experimental xx }
  731.  
  732.                END
  733.  
  734.  
  735.  
  736. SNMP Working Group                                             [Page 13]
  737.  
  738.  
  739. RFC 1212                Concise MIB Definitions               March 1991
  740.  
  741.  
  742.    The next step is to categorize the objects into groups.  For
  743.    experimental MIBs, optional objects are permitted.  However, when a
  744.    MIB module is placed in the Internet-standard space, these optional
  745.    objects are either removed, or placed in a optional group, which, if
  746.    implemented, all objects in the group must be implemented.  For the
  747.    first pass, it is wisest to simply ignore any optional objects in the
  748.    original MIB: experience shows it is better to define a core MIB
  749.    module first, containing only essential objects; later, if experience
  750.    demands, other objects can be added.
  751.  
  752.    It must be emphasized that groups are "units of conformance" within a
  753.    MIB: everything in a group is "mandatory" and implementations do
  754.    either whole groups or none.
  755.  
  756. 5.1.  Managed Object Mapping
  757.  
  758.    Next for each managed object class, determine whether there can exist
  759.    multiple instances of that managed object class.  If not, then for
  760.    each of its attributes, use the OBJECT-TYPE macro to make an
  761.    equivalent definition.
  762.  
  763.    Otherwise, if multiple instances of the managed object class can
  764.    exist, then define a conceptual table having conceptual rows each
  765.    containing a columnar object for each of the managed object class's
  766.    attributes. If the managed object class is contained within the
  767.    containment tree of another managed object class, then the assignment
  768.    of an object type is normally required for each of the "distinguished
  769.    attributes" of the containing managed object class.  If they do not
  770.    already exist within the MIB module, then they can be added via the
  771.    definition of additional columnar objects in the conceptual row
  772.    corresponding to the contained managed object class.
  773.  
  774.    In defining a conceptual row, it is useful to consider the
  775.    optimization of network management operations which will act upon its
  776.    columnar objects.  In particular, it is wisest to avoid defining more
  777.    columnar objects within a conceptual row, than can fit in a single
  778.    PDU.  As a rule of thumb, a conceptual row should contain no more
  779.    than approximately 20 objects.  Similarly, or as a way to abide by
  780.    the "20 object guideline", columnar objects should be grouped into
  781.    tables according to the expected grouping of network management
  782.    operations upon them.  As such, the content of conceptual rows should
  783.    reflect typical access scenarios, e.g., they should be organized
  784.    along functional lines such as one row for statistics and another row
  785.    for parameters, or along usage lines such as commonly-needed objects
  786.    versus rarely-needed objects.
  787.  
  788.    On the other hand, the definition of conceptual rows where the number
  789.    of columnar objects used as indexes outnumbers the number used to
  790.  
  791.  
  792.  
  793. SNMP Working Group                                             [Page 14]
  794.  
  795.  
  796. RFC 1212                Concise MIB Definitions               March 1991
  797.  
  798.  
  799.    hold information, should also be avoided.  In particular, the
  800.    splitting of a managed object class's attributes into many conceptual
  801.    tables should not be used as a way to obtain the same degree of
  802.    flexibility/complexity as is often found in MIB's with a myriad of
  803.    optionals.
  804.  
  805. 5.1.1.  Mapping to the SYNTAX clause
  806.  
  807.    When mapping to the SYNTAX clause of the OBJECT-type macro:
  808.  
  809.           (1)  An object with BOOLEAN syntax becomes an INTEGER taking
  810.                either of values true(1) or false(2).
  811.  
  812.           (2)  An object with ENUMERATED syntax becomes an INTEGER,
  813.                taking any of the values given.
  814.  
  815.           (3)  An object with BIT STRING syntax containing no more than
  816.                32 bits becomes an INTEGER defined as a sum; otherwise if
  817.                more than 32 bits are present, the object becomes an
  818.                OCTET STRING, with the bits numbered from left-to-right,
  819.                in which the least significant bits of the last octet may
  820.                be "reserved for future use".
  821.  
  822.           (4)  An object with a character string syntax becomes either
  823.                an OCTET STRING or a DisplayString, depending on the
  824.                repertoire of the character string.
  825.  
  826.           (5)  An non-tabular object with a complex syntax, such as REAL
  827.                or EXTERNAL, must be decomposed, usually into an OCTET
  828.                STRING (if sensible).  As a rule, any object with a
  829.                complicated syntax should be avoided.
  830.  
  831.           (6)  Tabular objects must be decomposed into rows of columnar
  832.                objects.
  833.  
  834. 5.1.2.  Mapping to the ACCESS clause
  835.  
  836.    This is straight-forward.
  837.  
  838. 5.1.3.  Mapping to the STATUS clause
  839.  
  840.    This is usually straight-forward; however, some osified-MIBs use the
  841.    term "recommended".  In this case, a choice must be made between
  842.    "mandatory" and "optional".
  843.  
  844. 5.1.4.  Mapping to the DESCRIPTION clause
  845.  
  846.    This is straight-forward: simply copy the text, making sure that any
  847.  
  848.  
  849.  
  850. SNMP Working Group                                             [Page 15]
  851.  
  852.  
  853. RFC 1212                Concise MIB Definitions               March 1991
  854.  
  855.  
  856.    embedded double quotation marks are sanitized (i.e., replaced with
  857.    single-quotes or removed).
  858.  
  859. 5.1.5.  Mapping to the REFERENCE clause
  860.  
  861.    This is straight-forward: simply include a textual reference to the
  862.    object being mapped, the document which defines the object, and
  863.    perhaps a page number in the document.
  864.  
  865. 5.1.6.  Mapping to the INDEX clause
  866.  
  867.    Decide how instance-identifiers for columnar objects are to be formed
  868.    and define this clause accordingly.
  869.  
  870. 5.1.7.  Mapping to the DEFVAL clause
  871.  
  872.    Decide if a meaningful default value can be assigned to the object
  873.    being mapped, and if so, define the DEFVAL clause accordingly.
  874.  
  875. 5.2.  Action Mapping
  876.  
  877.    Actions are modeled as read-write objects, in which writing a
  878.    particular value results in the action taking place.
  879.  
  880. 5.2.1.  Mapping to the SYNTAX clause
  881.  
  882.    Usually an INTEGER syntax is used with a distinguished value provided
  883.    for each action that the object provides access to.  In addition,
  884.    there is usually one other distinguished value, which is the one
  885.    returned when the object is read.
  886.  
  887. 5.2.2.  Mapping to the ACCESS clause
  888.  
  889.    Always use read-write.
  890.  
  891. 5.2.3.  Mapping to the STATUS clause
  892.  
  893.    This is straight-forward.
  894.  
  895. 5.2.4.  Mapping to the DESCRIPTION clause
  896.  
  897.    This is straight-forward: simply copy the text, making sure that any
  898.    embedded double quotation marks are sanitized (i.e., replaced with
  899.    single-quotes or removed).
  900.  
  901. 5.2.5.  Mapping to the REFERENCE clause
  902.  
  903.    This is straight-forward: simply include a textual reference to the
  904.  
  905.  
  906.  
  907. SNMP Working Group                                             [Page 16]
  908.  
  909.  
  910. RFC 1212                Concise MIB Definitions               March 1991
  911.  
  912.  
  913.    action being mapped, the document which defines the action, and
  914.    perhaps a page number in the document.
  915.  
  916. 6.  Acknowledgements
  917.  
  918.    This document was produced by the SNMP Working Group:
  919.  
  920.                Anne Ambler, Spider
  921.                Karl Auerbach, Sun
  922.                Fred Baker, ACC
  923.                Ken Brinkerhoff
  924.                Ron Broersma, NOSC
  925.                Jack Brown, US Army
  926.                Theodore Brunner, Bellcore
  927.                Jeffrey Buffum, HP
  928.                John Burress, Wellfleet
  929.                Jeffrey D. Case, University of Tennessee at Knoxville
  930.                Chris Chiptasso, Spartacus
  931.                Paul Ciarfella, DEC
  932.                Bob Collet
  933.                John Cook, Chipcom
  934.                Tracy Cox, Bellcore
  935.                James R. Davin, MIT-LCS
  936.                Eric Decker, cisco
  937.                Kurt Dobbins, Cabletron
  938.                Nadya El-Afandi, Network Systems
  939.                Gary Ellis, HP
  940.                Fred Engle
  941.                Mike Erlinger
  942.                Mark S. Fedor, PSI
  943.                Richard Fox, Synoptics
  944.                Karen Frisa, CMU
  945.                Chris Gunner, DEC
  946.                Fred Harris, University of Tennessee at Knoxville
  947.                Ken Hibbard, Xylogics
  948.                Ole Jacobsen, Interop
  949.                Ken Jones
  950.                Satish Joshi, Synoptics
  951.                Frank Kastenholz, Racal-Interlan
  952.                Shimshon Kaufman, Spartacus
  953.                Ken Key, University of Tennessee at Knoxville
  954.                Jim Kinder, Fibercom
  955.                Alex Koifman, BBN
  956.                Christopher Kolb, PSI
  957.                Cheryl Krupczak, NCR
  958.                Paul Langille, DEC
  959.                Peter Lin, Vitalink
  960.                John Lunny, TWG
  961.  
  962.  
  963.  
  964. SNMP Working Group                                             [Page 17]
  965.  
  966.  
  967. RFC 1212                Concise MIB Definitions               March 1991
  968.  
  969.  
  970.                Carl Malamud
  971.                Randy Mayhew, University of Tennessee at Knoxville
  972.                Keith McCloghrie, Hughes LAN Systems
  973.                Donna McMaster, David Systems
  974.                Lynn Monsanto, Sun
  975.                Dave Perkins, 3COM
  976.                Jim Reinstedler, Ungerman Bass
  977.                Anil Rijsinghani, DEC
  978.                Kathy Rinehart, Arnold AFB
  979.                Kary Robertson
  980.                Marshall T. Rose, PSI (chair)
  981.                L. Michael Sabo, NCSC
  982.                Jon Saperia, DEC
  983.                Greg Satz, cisco
  984.                Martin Schoffstall, PSI
  985.                John Seligson
  986.                Steve Sherry, Xyplex
  987.                Fei Shu, NEC
  988.                Sam Sjogren, TGV
  989.                Mark Sleeper, Sparta
  990.                Lance Sprung
  991.                Mike St.Johns
  992.                Bob Stewart, Xyplex
  993.                Emil Sturniold
  994.                Kaj Tesink, Bellcore
  995.                Dean Throop, Data General
  996.                Bill Townsend, Xylogics
  997.                Maurice Turcotte, Racal-Milgo
  998.                Kannan Varadhou
  999.                Sudhanshu Verma, HP
  1000.                Bill Versteeg, Network Research Corporation
  1001.                Warren Vik, Interactive Systems
  1002.                David Waitzman, BBN
  1003.                Steve Waldbusser, CMU
  1004.                Dan Wintringhan
  1005.                David Wood
  1006.                Wengyik Yeong, PSI
  1007.                Jeff Young, Cray Research
  1008.  
  1009. 7.  References
  1010.  
  1011.    [1] Cerf, V., "IAB Recommendations for the Development of Internet
  1012.        Network Management Standards", RFC 1052, NRI, April 1988.
  1013.  
  1014.    [2] Cerf, V., "Report of the Second Ad Hoc Network Management Review
  1015.        Group", RFC 1109, NRI, August 1989.
  1016.  
  1017.    [3] Rose M., and K. McCloghrie, "Structure and Identification of
  1018.  
  1019.  
  1020.  
  1021. SNMP Working Group                                             [Page 18]
  1022.  
  1023.  
  1024. RFC 1212                Concise MIB Definitions               March 1991
  1025.  
  1026.  
  1027.        Management Information for TCP/IP-based internets", RFC 1155,
  1028.        Performance Systems International, Hughes LAN Systems, May 1990.
  1029.  
  1030.    [4] McCloghrie K., and M. Rose, "Management Information Base for
  1031.        Network Management of TCP/IP-based internets", RFC 1156, Hughes
  1032.        LAN Systems, Performance Systems International, May 1990.
  1033.  
  1034.    [5] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple
  1035.        Network Management Protocol", RFC 1157, SNMP Research,
  1036.        Performance Systems International, Performance Systems
  1037.        International, MIT Laboratory for Computer Science, May 1990.
  1038.  
  1039.    [6] Information processing systems - Open Systems Interconnection -
  1040.        Specification of Abstract Syntax Notation One (ASN.1),
  1041.        International Organization for Standardization International
  1042.        Standard 8824, December 1987.
  1043.  
  1044.    [7] Rose M., Editor, "Management Information Base for Network
  1045.        Management of TCP/IP-based internets: MIB-II", RFC 1213,
  1046.        Performance Systems International, March 1991.
  1047.  
  1048. 8.  Security Considerations
  1049.  
  1050.    Security issues are not discussed in this memo.
  1051.  
  1052. 9.  Authors' Addresses
  1053.  
  1054.    Marshall T. Rose
  1055.    Performance Systems International
  1056.    5201 Great America Parkway
  1057.    Suite 3106
  1058.    Santa Clara, CA  95054
  1059.  
  1060.    Phone: +1 408 562 6222
  1061.    EMail: mrose@psi.com
  1062.    X.500:  rose, psi, us
  1063.  
  1064.  
  1065.    Keith McCloghrie
  1066.    Hughes LAN Systems
  1067.    1225 Charleston Road
  1068.    Mountain View, CA 94043
  1069.    1225 Charleston Road
  1070.    Mountain View, CA 94043
  1071.  
  1072.    Phone: (415) 966-7934
  1073.    EMail: kzm@hls.com
  1074.  
  1075.  
  1076.  
  1077.  
  1078. SNMP Working Group                                             [Page 19]
  1079.  
  1080.  
  1081.  
  1082.  
  1083.