A Convention for Describing SNMP-based Agents
RFC 1303

Document Type RFC - Informational (February 1992; No errata)
Last updated 2013-03-02
Stream Legacy
Formats plain text pdf html bibtex
Stream Legacy state (None)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state RFC 1303 (Informational)
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                      K. McCloghrie
Request For Comments: 1303                            Hughes LAN Systems
                                                                 M. Rose
                                                  Dover Beach Consulting
                                                           February 1992

             A Convention for Describing SNMP-based Agents

Status of This Memo

   This memo provides information for the Internet community.  It does
   not specify an Internet standard.  Distribution of this memo is
   unlimited.

Abstract

   This memo suggests a straight-forward approach towards describing
   SNMP-based agents.

Table of Contents

   1. The Network Management Framework ............................    2
   2. Objects .....................................................    2
   3. Describing Agents ...........................................    3
   3.1 Definitions ................................................    4
   3.2 Mapping of the MODULE-CONFORMANCE macro ....................    5
   3.2.1 Mapping of the LAST-UPDATED clause .......................    6
   3.2.2 Mapping of the PRODUCT-RELEASE clause ....................    6
   3.2.3 Mapping of the DESCRIPTION clause ........................    6
   3.2.4 Mapping of the SUPPORTS clause ...........................    6
   3.2.4.1 Mapping of the INCLUDES clause .........................    6
   3.2.4.2 Mapping of the VARIATION clause ........................    6
   3.2.4.2.1 Mapping of the SYNTAX clause .........................    6
   3.2.4.2.2 Mapping of the WRITE-SYNTAX clause ...................    7
   3.2.4.2.3 Mapping of the ACCESS clause .........................    7
   3.2.4.2.4 Mapping of the CREATION-REQUIRES clause ..............    7
   3.2.4.2.5 Mapping of the DEFVAL clause .........................    7
   3.2.4.2.6 Mapping of the DESCRIPTION clause ....................    7
   3.3 Refined Syntax .............................................    7
   3.4 Usage Example ..............................................    8
   4. Acknowledgements ............................................   11
   5. References ..................................................   11
   6. Security Considerations......................................   12
   7. Authors' Addresses...........................................   12

McCloghrie & Rose                                               [Page 1]
RFC 1303         Convention for Describing SNMP Agents     February 1992

1.  The Network Management Framework

   The Internet-standard Network Management Framework consists of
   three components.  They are:

   RFC 1155 [1] which defines the SMI, the mechanisms used for
   describing and naming objects for the purpose of management.
   RFC 1212 [2] defines a more concise description mechanism,
   which is wholly consistent with the SMI.

   RFC 1213 [3] which defines MIB-II, the core set of managed
   objects for the Internet suite of protocols.

   RFC 1157 [4] which defines the SNMP, the protocol used for
   network access to managed objects.

   The Framework permits new objects to be defined for the
   purpose of experimentation and evaluation.

2.  Objects

   Managed objects are accessed via a virtual information store,
   termed the Management Information Base or MIB.  Within a given
   MIB module, objects are defined using RFC 1212's OBJECT-TYPE
   macro.  At a minimum, each object has a name, a syntax, an
   access-level, and an implementation-status.

   The name is an object identifier, an administratively assigned
   name, which specifies an object type.  The object type
   together with an object instance serves to uniquely identify a
   specific instantiation of the object.  For human convenience,
   we often use a textual string, termed the OBJECT DESCRIPTOR,
   to also refer to the object type.

   The syntax of an object type defines the abstract data
   structure corresponding to that object type.  The ASN.1[5]
   language is used for this purpose.  However, RFC 1155
   purposely restricts the ASN.1 constructs which may be used.
   These restrictions are explicitly made for simplicity.

   The access-level of an object type defines whether it makes
   "protocol sense" to read and/or write the value of an instance
   of the object type.  (This access-level is independent of any
   administrative authorization policy.)

   The implementation-status of an object type indicates whether
   the object is mandatory, optional, obsolete, or deprecated.

McCloghrie & Rose                                               [Page 2]
RFC 1303         Convention for Describing SNMP Agents     February 1992

3.  Describing Agents

   When a MIB module is written, it is divided into units of
   conformance termed groups.  If an agent claims conformance to
   a group, then it must implement each and every object within
   that group.  Of course, for whatever reason, an agent may
Show full document text