draft-ietf-snmpv2-smi-02.txt   rfc1442.txt 
Draft Structure of Management Information for SNMPv2 Oct 92 Network Working Group J. Case
Request for Comments: 1442 SNMP Research, Inc.
K. McCloghrie
Hughes LAN Systems
M. Rose
Dover Beach Consulting, Inc.
S. Waldbusser
Carnegie Mellon University
April 1993
Structure of Management Information Structure of Management Information
for version 2 of the for version 2 of the
Simple Network Management Protocol (SNMPv2) Simple Network Management Protocol (SNMPv2)
Thu Nov 12 08:51:15 1992 | Status of this Memo
Jeffrey D. Case
SNMP Research, Inc.
University of Tennessee, Knoxville
case@cs.utk.edu
Keith McCloghrie
Hughes LAN Systems
kzm@hls.com
Marshall T. Rose This RFC specifes an IAB standards track protocol for the
Dover Beach Consulting, Inc. Internet community, and requests discussion and suggestions
mrose@dbc.mtview.ca.us for improvements. Please refer to the current edition of the
"IAB Official Protocol Standards" for the standardization
state and status of this protocol. Distribution of this memo
is unlimited.
Steven L. Waldbusser Table of Contents
Carnegie Mellon University
waldbusser@andrew.cmu.edu
1. Status of this Memo 1 Introduction .......................................... 2
1.1 A Note on Terminology ............................... 3
2 Definitions ........................................... 4
3.1 The MODULE-IDENTITY macro ........................... 5
3.2 Object Names and Syntaxes ........................... 7
3.3 The OBJECT-TYPE macro ............................... 10
3.5 The NOTIFICATION-TYPE macro ......................... 12
3 Information Modules ................................... 13
3.1 Macro Invocation .................................... 13
3.1.1 Textual Clauses ................................... 14
3.2 IMPORTing Symbols ................................... 14
4 Naming Hierarchy ...................................... 16
5 Mapping of the MODULE-IDENTITY macro .................. 17
5.1 Mapping of the LAST-UPDATED clause .................. 17
5.2 Mapping of the ORGANIZATION clause .................. 17
5.3 Mapping of the CONTACT-INFO clause .................. 17
5.4 Mapping of the DESCRIPTION clause ................... 17
5.5 Mapping of the REVISION clause ...................... 17
5.6 Mapping of the DESCRIPTION clause ................... 18
5.7 Mapping of the MODULE-IDENTITY value ................ 18
5.8 Usage Example ....................................... 19
This document is an Internet Draft. Internet Drafts are Case, McCloghrie, Rose & Waldbusser [Page i]
working documents of the Internet Engineering Task Force RFC 1442 SMI for SNMPv2 April 1993
(IETF), its Areas, and its Working Groups. Note that other
groups may also distribute working documents as Internet
Drafts.
Internet Drafts are valid for a maximum of six months and may 6 Mapping of the OBJECT-IDENTITY macro .................. 20
be updated, replaced, or obsoleted by other documents at any 6.1 Mapping of the STATUS clause ........................ 20
time. It is inappropriate to use Internet Drafts as reference 6.2 Mapping of the DESCRIPTION clause ................... 20
material or to cite them other than as a "work in progress". 6.3 Mapping of the REFERENCE clause ..................... 20
6.4 Mapping of the OBJECT-IDENTITY value ................ 20
6.5 Usage Example ....................................... 21
7 Mapping of the OBJECT-TYPE macro ...................... 22
7.1 Mapping of the SYNTAX clause ........................ 22
7.1.1 Integer32 and INTEGER ............................. 22
7.1.2 OCTET STRING ...................................... 23
7.1.3 OBJECT IDENTIFIER ................................. 23
7.1.4 BIT STRING ........................................ 23
7.1.5 IpAddress ......................................... 23
7.1.6 Counter32 ......................................... 24
7.1.7 Gauge32 ........................................... 24
7.1.8 TimeTicks ......................................... 24
7.1.9 Opaque ............................................ 25
7.1.10 NsapAddress ...................................... 25
7.1.11 Counter64 ........................................ 26
7.1.12 UInteger32 ....................................... 26
7.2 Mapping of the UNITS clause ......................... 26
7.3 Mapping of the MAX-ACCESS clause .................... 27
7.4 Mapping of the STATUS clause ........................ 27
7.5 Mapping of the DESCRIPTION clause ................... 27
7.6 Mapping of the REFERENCE clause ..................... 28
7.7 Mapping of the INDEX clause ......................... 28
7.7.1 Creation and Deletion of Conceptual Rows .......... 30
7.8 Mapping of the AUGMENTS clause ...................... 31
7.8.1 Relation between INDEX and AUGMENTS clauses ....... 31
7.9 Mapping of the DEFVAL clause ........................ 32
7.10 Mapping of the OBJECT-TYPE value ................... 33
7.11 Usage Example ...................................... 35
8 Mapping of the NOTIFICATION-TYPE macro ................ 37
8.1 Mapping of the OBJECTS clause ....................... 37
8.2 Mapping of the STATUS clause ........................ 37
8.3 Mapping of the DESCRIPTION clause ................... 37
8.4 Mapping of the REFERENCE clause ..................... 37
8.5 Mapping of the NOTIFICATION-TYPE value .............. 38
8.6 Usage Example ....................................... 39
9 Refined Syntax ........................................ 40
10 Extending an Information Module ...................... 41
10.1 Object Assignments ................................. 41
10.2 Object Definitions ................................. 41
10.3 Notification Definitions ........................... 42
RFC 1442 SMI for SNMPv2 April 1993
Draft Structure of Management Information for SNMPv2 Oct 92 11 Appendix: de-OSIfying a MIB module ................... 43
11.1 Managed Object Mapping ............................. 43
11.1.1 Mapping to the SYNTAX clause ..................... 44
11.1.2 Mapping to the UNITS clause ...................... 45
11.1.3 Mapping to the MAX-ACCESS clause ................. 45
11.1.4 Mapping to the STATUS clause ..................... 45
11.1.5 Mapping to the DESCRIPTION clause ................ 45
11.1.6 Mapping to the REFERENCE clause .................. 45
11.1.7 Mapping to the INDEX clause ...................... 45
11.1.8 Mapping to the DEFVAL clause ..................... 45
11.2 Action Mapping ..................................... 46
11.2.1 Mapping to the SYNTAX clause ..................... 46
11.2.2 Mapping to the MAX-ACCESS clause ................. 46
11.2.3 Mapping to the STATUS clause ..................... 46
11.2.4 Mapping to the DESCRIPTION clause ................ 46
11.2.5 Mapping to the REFERENCE clause .................. 46
11.3 Event Mapping ...................................... 46
11.3.1 Mapping to the STATUS clause ..................... 47
11.3.2 Mapping to the DESCRIPTION clause ................ 47
11.3.3 Mapping to the REFERENCE clause .................. 47
12 Acknowledgements ..................................... 48
13 References ........................................... 52
14 Security Considerations .............................. 54
15 Authors' Addresses ................................... 54
RFC 1442 SMI for SNMPv2 April 1993
2. Introduction 1. Introduction
A network management system contains: several (potentially A network management system contains: several (potentially
many) nodes, each with a processing entity, termed an agent, many) nodes, each with a processing entity, termed an agent,
which has access to management instrumentation; at least one which has access to management instrumentation; at least one
management station; and, a management protocol, used to convey management station; and, a management protocol, used to convey
management information between the agents and management management information between the agents and management
stations. Operations of the management protocol are carried stations. Operations of the protocol are carried out under an
out under an administrative framework which defines both administrative framework which defines both authentication and
authentication and authorization policies. authorization policies.
Network management stations execute management applications Network management stations execute management applications
which monitor and control network elements. Network elements which monitor and control network elements. Network elements
are devices such as hosts, routers, terminal servers, etc., are devices such as hosts, routers, terminal servers, etc.,
which are monitored and controlled through access to their which are monitored and controlled through access to their
management information. management information.
Management information is viewed as a collection of managed Management information is viewed as a collection of managed
objects, residing in a virtual information store, termed the objects, residing in a virtual information store, termed the
Management Information Base (MIB). Collections of related Management Information Base (MIB). Collections of related
objects are defined in MIB modules. These modules are written objects are defined in MIB modules. These modules are written
using a subset of OSI's Abstract Syntax Notation One (ASN.1) using a subset of OSI's Abstract Syntax Notation One (ASN.1)
[1]. It is the purpose of this document, the Structure of [1]. It is the purpose of this document, the Structure of
Management Information (SMI), to define that subset. Management Information (SMI), to define that subset.
The SMI is divided into four parts: object definitions, trap The SMI is divided into three parts: module definitions,
definitions, compliance definitions, and capabilities object definitions, and, trap definitions.
definitions.
(1) Object definitions are used when describing managed (1) Module definitions are used when describing information
modules. An ASN.1 macro, MODULE-IDENTITY, is used to
concisely convey the semantics of an information module.
(2) Object definitions are used when describing managed
objects. An ASN.1 macro, OBJECT-TYPE, is used to objects. An ASN.1 macro, OBJECT-TYPE, is used to
concisely convey the syntax and semantics of a managed concisely convey the syntax and semantics of a managed
object. Collections of related objects are grouped object.
together to form a unit of conformance. An ASN.1 macro,
OBJECT-GROUP, is used to concisely convey the syntax and
semantics of such a group.
(2) Notification definitions are used when describing an |
unsolicited transmission of management information. |
An ASN.1 macro, NOTIFICATION-TYPE, is used to concisely |
convey the syntax and semantics of a notification. |
(3) Compliance definitions are used when describing
requirements for agents with respect to object
definitions. An ASN.1 macro, MODULE-COMPLIANCE, is used
Draft Structure of Management Information for SNMPv2 Oct 92 (3) Notification definitions are used when describing
unsolicited transmissions of management information. An
ASN.1 macro, NOTIFICATION-TYPE, is used to concisely
convey the syntax and semantics of a notification.
to concisely convey such requirements. RFC 1442 SMI for SNMPv2 April 1993
(4) Capability definitions are used when describing the 1.1. A Note on Terminology
capabilities of agents with respect to object
definitions. An ASN.1 macro, AGENT-CAPABILITIES, is used
to concisely convey such capabilities.
2.1. A Note on Terminology For the purpose of exposition, the original Internet-standard
Network Management Framework, as described in RFCs 1155, 1157,
and 1212, is termed the SNMP version 1 framework (SNMPv1).
The current framework is termed the SNMP version 2 framework
(SNMPv2).
For the purpose of exposition, the original Internet-standard + RFC 1442 SMI for SNMPv2 April 1993
Network Management Framework, as described in RFCs 1155, 1157, +
and 1212, is termed the SNMP version 1 framework (SNMPv1). +
The current framework is termed the SNMP version 2 framework +
(SNMPv2). +
Draft Structure of Management Information for SNMPv2 Oct 92
3. Definitions 2. Definitions
SNMPv2-SMI DEFINITIONS ::= BEGIN SNMPv2-SMI DEFINITIONS ::= BEGIN
-- the path to the root -- the path to the root
internet OBJECT IDENTIFIER ::= { iso org(3) dod(6) 1 } internet OBJECT IDENTIFIER ::= { iso 3 6 1 }
directory OBJECT IDENTIFIER ::= { internet 1 } directory OBJECT IDENTIFIER ::= { internet 1 }
mgmt OBJECT IDENTIFIER ::= { internet 2 } mgmt OBJECT IDENTIFIER ::= { internet 2 }
experimental OBJECT IDENTIFIER ::= { internet 3 } experimental OBJECT IDENTIFIER ::= { internet 3 }
private OBJECT IDENTIFIER ::= { internet 4 } private OBJECT IDENTIFIER ::= { internet 4 }
enterprises OBJECT IDENTIFIER ::= { private 1 } enterprises OBJECT IDENTIFIER ::= { private 1 }
snmpV2 OBJECT IDENTIFIER ::= security OBJECT IDENTIFIER ::= { internet 5 }
{ joint-iso-ccitt mhs(6) group(6) mtr(200) 4 }
snmpMappings OBJECT IDENTIFIER ::= { snmpV2 1 }
-- { snmpV2 2 } is obsolete
-- these two values will go away snmpV2 OBJECT IDENTIFIER ::= { internet 6 }
-- when the SNMP Security working group reconvenes
smpProtocols OBJECT IDENTIFIER ::= { snmpV2 3 }
smpMD5AuthProtocol OBJECT IDENTIFIER ::= { smpProtocols 1 }
snmpModules OBJECT IDENTIFIER ::= { snmpV2 4 } -- transport domains
Draft Structure of Management Information for SNMPv2 Oct 92 snmpDomains OBJECT IDENTIFIER ::= { snmpV2 1 }
-- information about a module -- transport proxies
snmpProxys OBJECT IDENTIFIER ::= { snmpV2 2 }
-- module identities
snmpModules OBJECT IDENTIFIER ::= { snmpV2 3 }
RFC 1442 SMI for SNMPv2 April 1993
-- definitions for information modules
MODULE-IDENTITY MACRO ::= MODULE-IDENTITY MACRO ::=
BEGIN BEGIN
TYPE NOTATION ::= TYPE NOTATION ::=
"LAST-UPDATED" value(update UTCTime) "LAST-UPDATED" value(Update UTCTime)
"ORGANIZATION" value(organization Text) "ORGANIZATION" Text
"CONTACT-INFO" value(contact Text) "CONTACT-INFO" Text
"DESCRIPTION" value(description Text) "DESCRIPTION" Text
RevisionPart RevisionPart
VALUE NOTATION ::= VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER) value(VALUE OBJECT IDENTIFIER)
RevisionPart ::= RevisionPart ::=
Revisions Revisions
| empty | empty
Revisions ::= Revisions ::=
Revision Revision
| Revisions Revision | Revisions Revision
Revision ::= Revision ::=
"REVISION" value(update UTCTime) "REVISION" value(Update UTCTime)
"DESCRIPTION" value(description Text) "DESCRIPTION" Text
-- uses the NVT ASCII character set -- uses the NVT ASCII character set
Text ::= OCTET STRING Text ::= """" string """"
END END
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
-- definition for objects
OBJECT-TYPE MACRO ::= OBJECT-IDENTITY MACRO ::=
BEGIN BEGIN
TYPE NOTATION ::= TYPE NOTATION ::=
"SYNTAX" type(ObjectSyntax)
UnitsPart
"MAX-ACCESS" Access
"STATUS" Status "STATUS" Status
"DESCRIPTION" value(description Text) "DESCRIPTION" Text
ReferPart ReferPart
IndexPart
DefValPart
VALUE NOTATION ::= VALUE NOTATION ::=
value(VALUE ObjectName) value(VALUE OBJECT IDENTIFIER)
UnitsPart ::=
"UNITS" value(units Text)
| empty
Access ::=
"not-accessible"
| "read-only"
| "read-write"
| "read-create"
Status ::= Status ::=
"current" "current"
| "deprecated"
| "obsolete" | "obsolete"
ReferPart ::= ReferPart ::=
"REFERENCE" value(reference Text) "REFERENCE" Text
| empty | empty
IndexPart ::=
"INDEX" "{" IndexTypes "}"
| "AUGMENTS" "{" Entry "}"
| empty
IndexTypes ::=
IndexType
| IndexTypes "," IndexType
Draft Structure of Management Information for SNMPv2 Oct 92
IndexType ::=
"IMPLIED" Index
| Index
Index ::=
-- use the SYNTAX value of the
-- correspondent OBJECT-TYPE invocation
value(indexobject ObjectName)
Entry ::=
-- use the INDEX value of the
-- correspondent OBJECT-TYPE invocation
value(entryobject ObjectName)
DefValPart ::=
"DEFVAL" "{" value(defval ObjectSyntax) "}"
| empty
-- uses the NVT ASCII character set Text ::= """" string """"
Text ::= OCTET STRING
END END
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
-- names of objects -- names of objects
ObjectName ::= ObjectName ::=
OBJECT IDENTIFIER OBJECT IDENTIFIER
-- syntax of objects -- syntax of objects
ObjectSyntax ::= ObjectSyntax ::=
CHOICE { CHOICE {
skipping to change at page 9, line 5 skipping to change at page 8, line 5
OCTET STRING, OCTET STRING,
objectID-value objectID-value
OBJECT IDENTIFIER, OBJECT IDENTIFIER,
-- only the enumerated form is allowed -- only the enumerated form is allowed
bit-value bit-value
BIT STRING BIT STRING
} }
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
-- indistinguishable from INTEGER, but never needs more than -- indistinguishable from INTEGER, but never needs more than
-- 32-bits for a two's complement representation -- 32-bits for a two's complement representation
Integer32 ::= Integer32 ::=
[UNIVERSAL 2] [UNIVERSAL 2]
IMPLICIT INTEGER (-2147483648..2147483647) IMPLICIT INTEGER (-2147483648..2147483647)
-- application-wide types -- application-wide types
ApplicationSyntax ::= ApplicationSyntax ::=
skipping to change at page 9, line 36 skipping to change at page 8, line 36
timeticks-value timeticks-value
TimeTicks, TimeTicks,
arbitrary-value arbitrary-value
Opaque, Opaque,
nsapAddress-value nsapAddress-value
NsapAddress, NsapAddress,
big-counter-value big-counter-value
Counter64 Counter64,
unsigned-integer-value
UInteger32
} }
-- in network-byte order -- in network-byte order
-- (this is a tagged type for historical reasons)
IpAddress ::= IpAddress ::=
[APPLICATION 0] [APPLICATION 0]
IMPLICIT OCTET STRING (SIZE (4)) IMPLICIT OCTET STRING (SIZE (4))
RFC 1442 SMI for SNMPv2 April 1993
-- this wraps -- this wraps
Counter32 ::= Counter32 ::=
[APPLICATION 1] [APPLICATION 1]
IMPLICIT INTEGER (0..4294967295) IMPLICIT INTEGER (0..4294967295)
Draft Structure of Management Information for SNMPv2 Oct 92
-- this doesn't wrap -- this doesn't wrap
Gauge32 ::= Gauge32 ::=
[APPLICATION 2] [APPLICATION 2]
IMPLICIT INTEGER (0..4294967295) IMPLICIT INTEGER (0..4294967295)
-- hundredths of seconds since an epoch -- hundredths of seconds since an epoch
TimeTicks ::= TimeTicks ::=
[APPLICATION 3] [APPLICATION 3]
IMPLICIT INTEGER (0..4294967295) IMPLICIT INTEGER (0..4294967295)
-- for backward-compatibility only -- for backward-compatibility only
Opaque ::= Opaque ::=
[APPLICATION 4] [APPLICATION 4]
IMPLICIT OCTET STRING IMPLICIT OCTET STRING
-- for OSI NSAP addresses -- for OSI NSAP addresses
-- (this is a tagged type for historical reasons)
NsapAddress ::= NsapAddress ::=
[APPLICATION 5] [APPLICATION 5]
IMPLICIT OCTET STRING (SIZE (1 | 4..21)) IMPLICIT OCTET STRING (SIZE (1 | 4..21))
-- for counters that wrap in less than one hour with only 32 bits -- for counters that wrap in less than one hour with only 32 bits
Counter64 ::= Counter64 ::=
[APPLICATION 6] [APPLICATION 6]
IMPLICIT INTEGER (0..18446744073709551615) IMPLICIT INTEGER (0..18446744073709551615)
Draft Structure of Management Information for SNMPv2 Oct 92 -- an unsigned 32-bit quantity
UInteger32 ::=
-- definitions for object groups (a unit of conformance) [APPLICATION 7]
IMPLICIT INTEGER (0..4294967295)
OBJECT-GROUP MACRO ::=
BEGIN
TYPE NOTATION ::=
ObjectsPart
"STATUS" Status
"DESCRIPTION" value(description Text)
ReferPart
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER)
ObjectsPart ::=
"OBJECTS" "{" Objects "}"
Objects ::=
Object
| Objects "," Object
Object ::=
value(object ObjectName)
Status ::=
"current"
| "deprecated"
| "obsolete"
ReferPart ::=
"REFERENCE" value(reference Text)
| empty
-- uses the NVT ASCII character set RFC 1442 SMI for SNMPv2 April 1993
Text ::= OCTET STRING
END
Draft Structure of Management Information for SNMPv2 Oct 92
-- definitions for notifications | -- definition for objects
NOTIFICATION-TYPE MACRO ::= | OBJECT-TYPE MACRO ::=
BEGIN BEGIN
TYPE NOTATION ::= TYPE NOTATION ::=
ObjectsPart "SYNTAX" type(Syntax)
UnitsPart
"MAX-ACCESS" Access
"STATUS" Status "STATUS" Status
"DESCRIPTION" value(description Text) "DESCRIPTION" Text
ReferPart ReferPart
IndexPart
DefValPart
VALUE NOTATION ::= VALUE NOTATION ::=
value (VALUE OBJECT IDENTIFIER) value(VALUE ObjectName)
ObjectPart ::= UnitsPart ::=
"OBJECTS" "{" Objects "}" "UNITS" Text
| empty | empty
Objects ::=
Object
| Objects "," Object
Object ::=
value(object ObjectName)
Status ::=
"current"
| "deprecated"
| "obsolete"
ReferPart ::=
"REFERENCE" value (reference Text)
| empty
-- uses the NVT ASCII character set
Text ::= OCTET STRING
END
Draft Structure of Management Information for SNMPv2 Oct 92
-- definitions for compliance
MODULE-COMPLIANCE MACRO ::=
BEGIN
TYPE NOTATION ::=
"STATUS" Status
"DESCRIPTION" value(description Text)
ReferPart
ModulePart
VALUE NOTATION ::= Access ::=
value(VALUE OBJECT IDENTIFIER) "not-accessible"
| "read-only"
| "read-write"
| "read-create"
Status ::= Status ::=
"current" "current"
| "deprecated" | "deprecated"
| "obsolete" | "obsolete"
ReferPart ::= ReferPart ::=
"REFERENCE" value (reference Text) "REFERENCE" Text
| empty
ModulePart ::=
Modules
| empty
Modules ::=
Module
| Modules Module
Module ::=
-- name of module --
"MODULE" ModuleName
MandatoryPart
CompliancePart
ModuleName ::=
identifier ModuleIdentifier
-- must not be empty unless contained
-- in MIB Module
| empty
ModuleIdentifier ::=
value (moduleID OBJECT IDENTIFIER)
| empty
MandatoryPart ::=
"MANDATORY-GROUPS" "{" Groups "}"
Draft Structure of Management Information for SNMPv2 Oct 92
| empty | empty
Groups ::= IndexPart ::=
Group "INDEX" "{" IndexTypes "}"
| Groups "," Group | "AUGMENTS" "{" Entry "}"
Group ::=
value(group OBJECT IDENTIFIER)
CompliancePart ::=
Compliances
| empty | empty
Compliances ::= IndexTypes ::=
Compliance IndexType
| Compliances Compliance | IndexTypes "," IndexType
Compliance ::=
Group
| Object
Group ::=
"GROUP" value(object OBJECT IDENTIFIER)
"DESCRIPTION" value(description Text)
Object ::=
"OBJECT" value(object ObjectName)
SyntaxPart
WriteSyntaxPart
AccessPart
"DESCRIPTION" value(description Text)
-- must be a refinement for object's SYNTAX clause RFC 1442 SMI for SNMPv2 April 1993
SyntaxPart ::=
"SYNTAX" type(SYNTAX)
| empty
-- must be a refinement for object's SYNTAX clause IndexType ::=
WriteSyntaxPart ::= "IMPLIED" Index
"WRITE-SYNTAX" type(WriteSYNTAX) | Index
| empty Index ::=
-- use the SYNTAX value of the
-- correspondent OBJECT-TYPE invocation
value(Indexobject ObjectName)
Entry ::=
-- use the INDEX value of the
-- correspondent OBJECT-TYPE invocation
value(Entryobject ObjectName)
AccessPart ::= DefValPart ::=
"MIN-ACCESS" Access "DEFVAL" "{" value(Defval Syntax) "}"
| empty | empty
Access ::=
"not-accessible"
| "read-only"
Draft Structure of Management Information for SNMPv2 Oct 92
| "read-write"
| "read-create"
-- uses the NVT ASCII character set -- uses the NVT ASCII character set
Text ::= OCTET STRING Text ::= """" string """"
END END
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
-- definitions for agent capabilities -- definitions for notifications
AGENT-CAPABILITIES MACRO ::= NOTIFICATION-TYPE MACRO ::=
BEGIN BEGIN
TYPE NOTATION ::= TYPE NOTATION ::=
"PRODUCT-RELEASE" value(release Text) ObjectsPart
"STATUS" Status "STATUS" Status
"DESCRIPTION" value(description Text) "DESCRIPTION" Text
ReferPart ReferPart
ModulePart
VALUE NOTATION ::= VALUE NOTATION ::=
-- agent's sysObjectID [2] or snmpORID [3]
value(VALUE OBJECT IDENTIFIER) value(VALUE OBJECT IDENTIFIER)
ObjectsPart ::=
"OBJECTS" "{" Objects "}"
| empty
Objects ::=
Object
| Objects "," Object
Object ::=
value(Name ObjectName)
Status ::= Status ::=
"current" "current"
| "deprecated" | "deprecated"
| "obsolete" | "obsolete"
ReferPart ::= ReferPart ::=
"REFERENCE" value (reference Text) "REFERENCE" Text
| empty | empty
ModulePart ::=
Modules
| empty
Modules ::=
Module
| Modules Module
Module ::=
-- name of module --
"SUPPORTS" ModuleName
"INCLUDES" "{" Groups "}"
VariationPart
ModuleName ::=
identifier ModuleIdentifier
ModuleIdentifier ::=
value (moduleID OBJECT IDENTIFIER)
| empty
Groups ::=
Group
| Groups "," Group
Draft Structure of Management Information for SNMPv2 Oct 92
Group ::=
value(group OBJECT IDENTIFIER)
VariationPart ::=
Variations
| empty
Variations ::=
Variation
| Variations Variation
Variation ::=
"VARIATION" value(object ObjectName)
SyntaxPart
WriteSyntaxPart
AccessPart
CreationPart
DefValPart
"DESCRIPTION" value(description Text)
-- must be a refinement for object's SYNTAX clause
SyntaxPart ::=
"SYNTAX" type(SYNTAX)
| empty
-- must be a refinement for object's SYNTAX clause
WriteSyntaxPart ::=
"WRITE-SYNTAX" type(WriteSYNTAX)
| empty
AccessPart ::=
"ACCESS" Access
| empty
Access ::=
"not-implemented"
| "read-only"
| "read-write"
| "read-create"
-- following is for backward-compatibility only
| "write-only"
CreationPart ::=
"CREATION-REQUIRES" "{" Cells "}"
| empty
Draft Structure of Management Information for SNMPv2 Oct 92
Cells ::=
Cell
| Cells "," Cell
Cell ::=
value(cell ObjectName)
DefValPart ::=
"DEFVAL" "{" value (defval ObjectSyntax) "}"
| empty
-- uses the NVT ASCII character set -- uses the NVT ASCII character set
Text ::= OCTET STRING Text ::= """" string """"
END END
END END
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
4. Information Modules 3. Information Modules
An "information module" is an ASN.1 module defining An "information module" is an ASN.1 module defining
information relating to network management. information relating to network management.
The SMI describes how to use a subset of ASN.1 to define an The SMI describes how to use a subset of ASN.1 to define an
information module. Further, additional restrictions are information module. Further, additional restrictions are
placed on "standard" information modules. It is strongly placed on "standard" information modules. It is strongly
recommended that "enterprise-specific" information modules recommended that "enterprise-specific" information modules
also adhere to these restrictions. also adhere to these restrictions.
Typically, there are three kinds of information modules: Typically, there are three kinds of information modules:
(1) MIB modules, which contain definitions of inter-related (1) MIB modules, which contain definitions of inter-related
managed objects, make use of the OBJECT-TYPE and OBJECT- managed objects, make use of the OBJECT-TYPE and
GROUP macros (if notification definitions are included, | NOTIFICATION-TYPE macros;
then the NOTIFICATION-TYPE macro is also used); |
(2) compliance statements for MIB modules, which make use of (2) compliance statements for MIB modules, which make use of
the MODULE-COMPLIANCE macros; and, the MODULE-COMPLIANCE and OBJECT-GROUP macros [2]; and,
(3) capability statements for agent implementations which (3) capability statements for agent implementations which
make use of the AGENT-CAPABILITIES macros. make use of the AGENT-CAPABILITIES macros [2].
This classification scheme does not imply a rigid taxonomy. This classification scheme does not imply a rigid taxonomy.
For example, a "standard" information module might include For example, a "standard" information module might include
definitions of managed objects and a compliance statement. definitions of managed objects and a compliance statement.
Similarly, an "enterprise-specific" information module might Similarly, an "enterprise-specific" information module might
include definitions of managed objects and a capability include definitions of managed objects and a capability
statement. Of course, a "standard" information module may not statement. Of course, a "standard" information module may not
contain capability statements. contain capability statements.
All information modules start with exactly one invocation of All information modules start with exactly one invocation of
the MODULE-IDENTITY macro, which provides contact and revision the MODULE-IDENTITY macro, which provides contact and revision
history. This invocation must appear immediately after any history. This invocation must appear immediately after any
IMPORTs or EXPORTs statements. IMPORTs or EXPORTs statements.
4.1. Macro Invocation 3.1. Macro Invocation
Within an information module, each macro invocation appears Within an information module, each macro invocation appears
as: as:
<descriptor> <macro> <clauses> ::= <value> <descriptor> <macro> <clauses> ::= <value>
Draft Structure of Management Information for SNMPv2 Oct 92
where <descriptor> corresponds to an ASN.1 identifier, <macro> where <descriptor> corresponds to an ASN.1 identifier, <macro>
RFC 1442 SMI for SNMPv2 April 1993
names the macro being invoked, and <clauses> and <value> names the macro being invoked, and <clauses> and <value>
depend on the definition of the macro. depend on the definition of the macro.
An ASN.1 identifier consists of one or more letters, digits, An ASN.1 identifier consists of one or more letters, digits,
or hyphens. The initial character must be a lower-case or hyphens. The initial character must be a lower-case
letter, and the final character may not be a hyphen. Further, letter, and the final character may not be a hyphen. Further,
a hyphen may not be immediatedly followed by another hyphen. a hyphen may not be immediatedly followed by another hyphen.
For all descriptors appearing in an information module, the For all descriptors appearing in an information module, the
descriptor shall be unique and mnemonic, and shall not exceed descriptor shall be unique and mnemonic, and shall not exceed
64 characters in length. This promotes a common language for 64 characters in length. This promotes a common language for
humans to use when discussing the information module and also humans to use when discussing the information module and also
facilitates simple table mappings for user-interfaces. facilitates simple table mappings for user-interfaces.
The set of descriptors defined in all "standard" information The set of descriptors defined in all "standard" information
modules shall be unique. Further, within each "standard" modules shall be unique. Further, within any information
information module, the hyphen is not allowed as a character module, the hyphen is not allowed as a character in any
in any descriptor. descriptor.
Finally, by convention, if the descriptor refers to an object Finally, by convention, if the descriptor refers to an object
with a SYNTAX clause value of either Counter32 or Counter64, with a SYNTAX clause value of either Counter32 or Counter64,
then the descriptor used for the object should denote then the descriptor used for the object should denote
plurality. plurality.
4.1.1. Textual Clauses 3.1.1. Textual Clauses
Some clauses in a macro invocation may take a textual value Some clauses in a macro invocation may take a textual value
(e.g., the DESCRIPTION clause). (e.g., the DESCRIPTION clause). Note that, in order to
conform to the ASN.1 syntax, the entire value of these clauses
must be enclosed in double quotation marks, and therefore
cannot itself contain double quotation marks, although the
value may be multi-line.
4.2. IMPORTing Symbols 3.2. IMPORTing Symbols
When symbols from "enterprise-specific" information modules To reference an external object, the IMPORTS statement must be
are referenced (e.g., a descriptor), there is the possibility used to identify both the descriptor and the module defining
of collision. the descriptor.
To reference an external object, the IMPORTS statement must be | Note that when symbols from "enterprise-specific" information
used to identify both the descriptor and the module defining | modules are referenced (e.g., a descriptor), there is the
the descriptor. If two different information modules define | possibility of collision. As such, if different objects with
the same descriptor for different objects, then this ambiguity | the same descriptor are IMPORTed, then this ambiguity is
is resolved by prefixing the descriptor with the name of the | RFC 1442 SMI for SNMPv2 April 1993
information module and a dot |
("."), i.e.,
Draft Structure of Management Information for SNMPv2 Oct 92
"module.descriptor" | resolved by prefixing the descriptor with the name of the
information module and a dot ("."), i.e.,
Draft Structure of Management Information for SNMPv2 Oct 92 "module.descriptor"
(All descriptors must be unique within any information
module.)
Of course, this notation can be used even when there is no
collision when IMPORTing symbols.
Finally, the IMPORTS statement may not be used to import an
ASN.1 named type which corresponds to either the SEQUENCE or
SEQUENCE OF type.
RFC 1442 SMI for SNMPv2 April 1993
4. Naming Hierarchy
The root of the subtree administered by the Internet Assigned
Numbers Authority (IANA) for the Internet is:
internet OBJECT IDENTIFIER ::= { iso 3 6 1 }
That is, the Internet subtree of OBJECT IDENTIFIERs starts
with the prefix:
1.3.6.1.
Several branches underneath this subtree are used for network
management:
mgmt OBJECT IDENTIFIER ::= { internet 2 }
experimental OBJECT IDENTIFIER ::= { internet 3 }
private OBJECT IDENTIFIER ::= { internet 4 }
enterprises OBJECT IDENTIFIER ::= { private 1 }
However, the SMI does not prohibit the definition of objects
in other portions of the object tree.
The mgmt(2) subtree is used to identify "standard" objects.
The experimental(3) subtree is used to identify objects being
designed by working groups of the IETF. If an information
module produced by a working group becomes a "standard"
information module, then at the very beginning of its entry
onto the Internet standards track, the objects are moved under
the mgmt(2) subtree.
The private(4) subtree is used to identify objects defined
unilaterally. The enterprises(1) subtree beneath private is
used, among other things, to permit providers of networking
subsystems to register models of their products.
RFC 1442 SMI for SNMPv2 April 1993
5. Mapping of the MODULE-IDENTITY macro 5. Mapping of the MODULE-IDENTITY macro
The MODULE-IDENTITY macro is used to provide contact and The MODULE-IDENTITY macro is used to provide contact and
revision history for each information module. It must appear revision history for each information module. It must appear
exactly once in every information module. It should be noted exactly once in every information module. It should be noted
that the expansion of the MODULE-IDENTITY macro is something that the expansion of the MODULE-IDENTITY macro is something
which conceptually happens during implementation and not which conceptually happens during implementation and not
during run-time. during run-time.
skipping to change at page 23, line 5 skipping to change at page 18, line 5
high-level textual description of the contents of this high-level textual description of the contents of this
information module. information module.
5.5. Mapping of the REVISION clause 5.5. Mapping of the REVISION clause
The REVISION clause, which need not be present, is repeatedly The REVISION clause, which need not be present, is repeatedly
used to describe the revisions made to this information used to describe the revisions made to this information
module, in reverse chronological order. Each instance of this module, in reverse chronological order. Each instance of this
clause contains the date and time of the revision. clause contains the date and time of the revision.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
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.
5.6. Mapping of the DESCRIPTION clause 5.6. Mapping of the DESCRIPTION clause
The DESCRIPTION clause, which must be present for each The DESCRIPTION clause, which must be present for each
REVISION clause, contains a high-level textual description of REVISION clause, contains a high-level textual description of
the revision identified in that REVISION clause. the revision identified in that REVISION clause.
5.7. Mapping of the MODULE-IDENTITY value 5.7. Mapping of the MODULE-IDENTITY value
The value of an invocation of the MODULE-IDENTITY macro is an The value of an invocation of the MODULE-IDENTITY macro is an
OBJECT IDENTIFIER. As such, this value may be authoritatively OBJECT IDENTIFIER. As such, this value may be authoritatively
used when referring to the information module containing the used when referring to the information module containing the
invocation. invocation.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
5.8. Usage Example 5.8. Usage Example
Consider how a skeletal MIB module might be constructed: e.g., Consider how a skeletal MIB module might be constructed: e.g.,
RFCxxxx-MIB DEFINITIONS ::= BEGIN FIZBIN-MIB DEFINITIONS ::= BEGIN
IMPORTS IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, OBJECT-GROUP, experimental MODULE-IDENTITY, OBJECT-TYPE, experimental
FROM SNMPv2-SMI; FROM SNMPv2-SMI;
xxxx MODULE-IDENTITY fizbin MODULE-IDENTITY
LAST-UPDATED "9210070433Z" LAST-UPDATED "9210070433Z"
ORGANIZATION "IETF SNMPv2 Working Group" ORGANIZATION "IETF SNMPv2 Working Group"
CONTACT-INFO CONTACT-INFO
" Marshall T. Rose " Marshall T. Rose
Postal: Dover Beach Consulting, Inc. Postal: Dover Beach Consulting, Inc.
420 Whisman Court 420 Whisman Court
Mountain View, CA 94043-2186 Mountain View, CA 94043-2186
US US
Tel: +1 415 968 1052 Tel: +1 415 968 1052
Fax: +1 415 968 2510 Fax: +1 415 968 2510
E-mail: mrose@dbc.mtview.ca.us" E-mail: mrose@dbc.mtview.ca.us"
DESCRIPTION DESCRIPTION
"The MIB module for entities implementing the "The MIB module for entities implementing the xxxx
xxxx protocol." protocol."
REVISION "9210070433Z" REVISION "9210070433Z"
DESCRIPTION DESCRIPTION
"Initial version of this MIB module." "Initial version of this MIB module."
-- contact IANA for actual number -- contact IANA for actual number
::= { experimental xx } ::= { experimental xx }
END END
RFC 1442 SMI for SNMPv2 April 1993
Draft Structure of Management Information for SNMPv2 Oct 92 6. Mapping of the OBJECT-IDENTITY macro
6. Mapping of the OBJECT-TYPE macro The OBJECT-IDENTITY macro is used to define information about
an OBJECT IDENTIFIER assignment. It should be noted that the
expansion of the OBJECT-IDENTITY macro is something which
conceptually happens during implementation and not during
run-time.
6.1. Mapping of the STATUS clause
The STATUS clause, which must be present, indicates whether
this definition is current or historic.
The values "current", and "obsolete" are self-explanatory.
6.2. Mapping of the DESCRIPTION clause
The DESCRIPTION clause, which must be present, contains a
textual description of the object assignment.
6.3. Mapping of the REFERENCE clause
The REFERENCE clause, which need not be present, contains a
textual cross-reference to an object assignment defined in
some other information module.
6.4. Mapping of the OBJECT-IDENTITY value
The value of an invocation of the OBJECT-IDENTITY macro is an
OBJECT IDENTIFIER.
RFC 1442 SMI for SNMPv2 April 1993
6.5. Usage Example
Consider how an OBJECT IDENTIFIER assignment might be made:
e.g.,
fizbin69 OBJECT-IDENTITY
STATUS current
DESCRIPTION
"The authoritative identity of the Fizbin 69
chipset."
::= { fizbinChipSets 1 }
RFC 1442 SMI for SNMPv2 April 1993
7. Mapping of the OBJECT-TYPE macro
The OBJECT-TYPE macro is used to define a managed object. It The OBJECT-TYPE macro is used to define a managed object. It
should be noted that the expansion of the OBJECT-TYPE macro is should be noted that the expansion of the OBJECT-TYPE macro is
something which conceptually happens during implementation and something which conceptually happens during implementation and
not during run-time. not during run-time.
6.1. Mapping of the SYNTAX clause 7.1. Mapping of the SYNTAX clause
The SYNTAX clause, which must be present, defines the abstract The SYNTAX clause, which must be present, defines the abstract
data structure corresponding to that object. The data data structure corresponding to that object. The data
structure must be one of the alternatives defined in the structure must be one of the alternatives defined in the
ObjectSyntax CHOICE. Any restriction on size, range, ObjectSyntax CHOICE.
enumerations or repertoire specified in this clause represents
the maximal level of support which makes "protocol sense". Full ASN.1 sub-typing is allowed, as appropriate to the
underingly ASN.1 type, primarily as an aid to implementors in
understanding the meaning of the object. Any such restriction
on size, range, enumerations or repertoire specified in this
clause represents the maximal level of support which makes
"protocol sense". Of course, sub-typing is not allowed for
the Counter32 or Counter64 types, but is allowed for the
Gauge32 type.
The semantics of ObjectSyntax are now described. The semantics of ObjectSyntax are now described.
6.1.1. Integer32 and INTEGER 7.1.1. Integer32 and INTEGER
The Integer32 type represents integer-valued information The Integer32 type represents integer-valued information
between -2^31 and 2^31-1 inclusive (-2147483648 to 2147483647 between -2^31 and 2^31-1 inclusive (-2147483648 to 2147483647
decimal). This type is indistinguishable from the INTEGER decimal). This type is indistinguishable from the INTEGER
type. type.
The INTEGER type may also be used to represent integer-valued The INTEGER type may also be used to represent integer-valued
information, if it contains named-number enumerations, or if information, if it contains named-number enumerations, or if
it is subtyped to be more constrained than the Integer32 type. it is sub-typed to be more constrained than the Integer32
In the former case, only those named-numbers so enumerated may type. In the former case, only those named-numbers so
be present as a value. Further, the enumerated values must enumerated may be present as a value. Note that although it
all be positive. is recommended that enumerated values start at 1 and be
numbered contiguously, any valid value for Integer32 is
allowed for an enumerated value and, further, enumerated
values needn't be contiguously assigned.
A requirement on "standard" information modules is that the RFC 1442 SMI for SNMPv2 April 1993
hyphen character is not allowed as a part of the label name
for any named-number enumeration.
6.1.2. OCTET STRING Finally, the hyphen character is not allowed as a part of the
label name for any named-number enumeration.
7.1.2. OCTET STRING
The OCTET STRING type represents arbitrary binary or textual The OCTET STRING type represents arbitrary binary or textual
data. Although there is no SMI-specified size limitation for data. Although there is no SMI-specified size limitation for
this type, MIB designers should realize that there may be this type, MIB designers should realize that there may be
implementation and interoperability limitations for sizes in implementation and interoperability limitations for sizes in
Draft Structure of Management Information for SNMPv2 Oct 92
excess of 255 octets. excess of 255 octets.
6.1.3. OBJECT IDENTIFIER 7.1.3. OBJECT IDENTIFIER
The OBJECT IDENTIFIER type represents administratively The OBJECT IDENTIFIER type represents administratively
assigned names. Any instance of this type may have at most assigned names. Any instance of this type may have at most
128 sub-identifiers. Further, each sub-identifier must not 128 sub-identifiers. Further, each sub-identifier must not
exceed the value 2^32-1 (4294967295 decimal). exceed the value 2^32-1 (4294967295 decimal).
6.1.4. BIT STRING 7.1.4. BIT STRING
The BIT STRING type represents an enumeration of named bits. The BIT STRING type represents an enumeration of named bits.
This collection is assigned non-negative, contiguous values, This collection is assigned non-negative, contiguous values,
starting at zero. Only those named-bits so enumerated may be starting at zero. Only those named-bits so enumerated may be
present in a value. present in a value.
A requirement on "standard" MIB modules is that the hyphen A requirement on "standard" MIB modules is that the hyphen
character is not allowed as a part of the label name for any character is not allowed as a part of the label name for any
named-bit enumeration. named-bit enumeration.
6.1.5. IpAddress 7.1.5. IpAddress
The IpAddress type represents a 32-bit internet address. It The IpAddress type represents a 32-bit internet address. It
is represented as an OCTET STRING of length 4, in network is represented as an OCTET STRING of length 4, in network
byte-order. byte-order.
6.1.6. Counter32 Note that the IpAddress type is a tagged type for historical
reasons. Network addresses should be represented using an
invocation of the TEXTUAL-CONVENTION macro [3].
RFC 1442 SMI for SNMPv2 April 1993
7.1.6. Counter32
The Counter32 type represents a non-negative integer which The Counter32 type represents a non-negative integer which
monotonically increases until it reaches a maximum value of monotonically increases until it reaches a maximum value of
2^32-1 (4294967295 decimal), when it wraps around and starts 2^32-1 (4294967295 decimal), when it wraps around and starts
increasing again from zero. increasing again from zero.
Counters have no defined "initial" value, and thus, a single Counters have no defined "initial" value, and thus, a single
value of a Counter has (in general) no information content. value of a Counter has (in general) no information content.
Discontinuities in the monotonically increasing value normally Discontinuities in the monotonically increasing value normally
occur at re-initialization of the management system, and at occur at re-initialization of the management system, and at
other times as specified in the description of an object-type other times as specified in the description of an object-type
using this ASN.1 type. If such other times can occur, for using this ASN.1 type. If such other times can occur, for
example, the creation of an object instance at times other example, the creation of an object instance at times other
than re-initialization, then a corresponding object should be than re-initialization, then a corresponding object should be
Draft Structure of Management Information for SNMPv2 Oct 92 defined with a SYNTAX clause value of TimeStamp (a textual
convention defined in [3]) indicating the time of the last
defined with a SYNTAX clause value of TimeStamp (a textual | discontinuity.
convention defined in [4]) |
indicating the time of the last discontinuity.
The value of the MAX-ACCESS clause for objects with a SYNTAX The value of the MAX-ACCESS clause for objects with a SYNTAX
clause value of Counter32 is always "read-only". clause value of Counter32 is always "read-only".
6.1.7. Gauge32 A DEFVAL clause is not allowed for objects with a SYNTAX
clause value of Counter32.
7.1.7. Gauge32
The Gauge32 type represents a non-negative integer, which may The Gauge32 type represents a non-negative integer, which may
increase or decrease, but shall never exceed a maximum value. increase or decrease, but shall never exceed a maximum value.
The maximum value can not be greater than 2^32-1 (4294967295 The maximum value can not be greater than 2^32-1 (4294967295
decimal). The value of a Gauge has its maximum value whenever decimal). The value of a Gauge has its maximum value whenever
the information being modeled is greater or equal to that the information being modeled is greater or equal to that
maximum value; if the information being modeled subsequently maximum value; if the information being modeled subsequently
decreases below the maximum value, the Gauge also decreases. decreases below the maximum value, the Gauge also decreases.
6.1.8. TimeTicks 7.1.8. TimeTicks
The TimeTicks type represents a non-negative integer which The TimeTicks type represents a non-negative integer which
represents the time, modulo 2^32 (4294967296 decimal), in represents the time, modulo 2^32 (4294967296 decimal), in
hundredths of a second between two epochs. When objects are hundredths of a second between two epochs. When objects are
defined which use this ASN.1 type, the description of the defined which use this ASN.1 type, the description of the
object identifies both of the reference epochs. object identifies both of the reference epochs.
6.1.9. Opaque RFC 1442 SMI for SNMPv2 April 1993
For example, [3] defines the TimeStamp textual convention
which is based on the TimeTicks type. With a TimeStamp, the
first reference epoch is defined as when MIB-II's sysUpTime
[7] was zero, and the second reference epoch is defined as the
current value of sysUpTime.
7.1.9. Opaque
The Opaque type is provided solely for backward-compatibility, The Opaque type is provided solely for backward-compatibility,
and shall not be used for newly-defined object types. and shall not be used for newly-defined object types.
The Opaque type supports the capability to pass arbitrary The Opaque type supports the capability to pass arbitrary
ASN.1 syntax. A value is encoded using the ASN.1 Basic | ASN.1 syntax. A value is encoded using the ASN.1 Basic
Encoding Rules [5] into a string | Encoding Rules [4] into a string of octets. This, in turn, is
of octets. This, in turn, is encoded as an OCTET STRING, in encoded as an OCTET STRING, in effect "double-wrapping" the
effect "double-wrapping" the original ASN.1 value. original ASN.1 value.
Note that a conforming implementation need only be able to Note that a conforming implementation need only be able to
accept and recognize opaquely-encoded data. It need not be accept and recognize opaquely-encoded data. It need not be
able to unwrap the data and then interpret its contents. able to unwrap the data and then interpret its contents.
Further note that by use of the ASN.1 EXTERNAL type, non-ASN.1
types may be used in opaquely-encoded data.
Draft Structure of Management Information for SNMPv2 Oct 92
A requirement on "standard" MIB modules is that no object may A requirement on "standard" MIB modules is that no object may
have a SYNTAX clause value of Opaque. have a SYNTAX clause value of Opaque.
6.1.10. Counter64 7.1.10. NsapAddress
The NsapAddress type represents an OSI address as a variable-
length OCTET STRING. The first octet of the string contains a
binary value in the range of 0..20, and indicates the length
in octets of the NSAP. Following the first octet, is the
NSAP, expressed in concrete binary notation, starting with the
most significant octet. A zero-length NSAP is used as a
"special" address meaning "the default NSAP" (analogous to the
IP address of 0.0.0.0). Such an NSAP is encoded as a single
octet, containing the value 0. All other NSAPs are encoded in
at least 4 octets.
Note that the NsapAddress type is a tagged type for historical
reasons. Network addresses should be represented using an
invocation of the TEXTUAL-CONVENTION macro [3].
RFC 1442 SMI for SNMPv2 April 1993
7.1.11. Counter64
The Counter64 type represents a non-negative integer which The Counter64 type represents a non-negative integer which
monotonically increases until it reaches a maximum value of monotonically increases until it reaches a maximum value of
2^64-1 (18446744073709551615 decimal), when it wraps around 2^64-1 (18446744073709551615 decimal), when it wraps around
and starts increasing again from zero. and starts increasing again from zero.
Counters have no defined "initial" value, and thus, a single Counters have no defined "initial" value, and thus, a single
value of a Counter has (in general) no information content. value of a Counter has (in general) no information content.
Discontinuities in the monotonically increasing value normally Discontinuities in the monotonically increasing value normally
occur at re-initialization of the management system, and at occur at re-initialization of the management system, and at
other times as specified in the description of an object-type other times as specified in the description of an object-type
using this ASN.1 type. If such other times can occur, for using this ASN.1 type. If such other times can occur, for
example, the creation of an object instance at times other example, the creation of an object instance at times other
than re-initialization, then a corresponding object should be than re-initialization, then a corresponding object should be
defined with a SYNTAX clause value of TimeStamp (a textual | defined with a SYNTAX clause value of TimeStamp (a textual
convention defined in [4]) | convention defined in [3]) indicating the time of the last
indicating the time of the last discontinuity. discontinuity.
The value of the MAX-ACCESS clause for objects with a SYNTAX The value of the MAX-ACCESS clause for objects with a SYNTAX
clause value of Counter64 is always "read-only". clause value of Counter64 is always "read-only".
A requirement on "standard" MIB modules is that the Counter64 A requirement on "standard" MIB modules is that the Counter64
type may be used only if the information being modeled would type may be used only if the information being modeled would
wrap in less than one hour if the Counter32 type was used wrap in less than one hour if the Counter32 type was used
instead. instead.
6.1.11. NsapAddress A DEFVAL clause is not allowed for objects with a SYNTAX
clause value of Counter64.
The NsapAddress type represents an OSI address as a variable- 7.1.12. UInteger32
length OCTET STRING. The first octet of the string contains a
binary value in the range of 0..20, and indicates the length
in octets of the NSAP. Following the first octet, is the
NSAP, expressed in concrete binary notation, starting with the
most significant octet. A zero-length NSAP is used as a
"special" address meaning "the default NSAP" (analogous to the
IP address of 0.0.0.0). Such an NSAP is encoded as a single
octet, containing the value 0. All other NSAPs are encoded in
at least 4 octets.
Draft Structure of Management Information for SNMPv2 Oct 92 The UInteger32 type represents integer-valued information
between 0 and 2^32-1 inclusive (0 to 4294967295 decimal).
6.2. Mapping of the UNITS clause 7.2. Mapping of the UNITS clause
This UNITS clause, which need not be present, contains a This UNITS clause, which need not be present, contains a
textual definition of the units associated with that object. textual definition of the units associated with that object.
6.3. Mapping of the MAX-ACCESS clause RFC 1442 SMI for SNMPv2 April 1993
7.3. Mapping of the MAX-ACCESS clause
The MAX-ACCESS clause, which must be present, defines whether The MAX-ACCESS clause, which must be present, defines whether
it makes "protocol sense" to read, write and/or create an it makes "protocol sense" to read, write and/or create an
instance of the object. This is the maximal level of access instance of the object. This is the maximal level of access
for the object. (This maximal level of access is independent for the object. (This maximal level of access is independent
of any administrative authorization policy.) of any administrative authorization policy.)
The value "read-write" indicates that read and write access The value "read-write" indicates that read and write access
make "protocol sense", but create does not. The value "read- make "protocol sense", but create does not. The value "read-
create" indicates that read, write and create access make create" indicates that read, write and create access make
"protocol sense". "protocol sense". The value "not-accessible" indicates either
an auxiliary object (see Section 7.7) or an object which is
accessible only via a notificationn (e.g., snmpTrapOID [5]).
These values are ordered, from least to greatest: "not- These values are ordered, from least to greatest: "not-
accessible", "read-only", "read-write", "read-create". accessible", "read-only", "read-write", "read-create".
If any columnar object in a conceptual row has "read-create" If any columnar object in a conceptual row has "read-create"
as its maximal level of access, then no other columnar object as its maximal level of access, then no other columnar object
of the same conceptual row may have a maximal access of of the same conceptual row may have a maximal access of
"read-write". (Note that "read-create" is a superset of "read-write". (Note that "read-create" is a superset of
"read-write".) "read-write".)
6.4. Mapping of the STATUS clause 7.4. Mapping of the STATUS clause
The STATUS clause, which must be present, indicates whether The STATUS clause, which must be present, indicates whether
this definition is current or historic. this definition is current or historic.
The values "current", and "obsolete" are self-explanatory. The values "current", and "obsolete" are self-explanatory.
The "deprecated" value indicates that that object is obsolete, The "deprecated" value indicates that the object is obsolete,
but that an implementor may wish to support that object to but that an implementor may wish to support that object to
foster interoperability with older implementations. foster interoperability with older implementations.
6.5. Mapping of the DESCRIPTION clause 7.5. Mapping of the DESCRIPTION clause
The DESCRIPTION clause, which must be present, contains a The DESCRIPTION clause, which must be present, contains a
textual definition of that object which provides all semantic textual definition of that object which provides all semantic
definitions necessary for implementation, and should embody definitions necessary for implementation, and should embody
Draft Structure of Management Information for SNMPv2 Oct 92
any information which would otherwise be communicated in any any information which would otherwise be communicated in any
ASN.1 commentary annotations associated with the object. ASN.1 commentary annotations associated with the object.
6.6. Mapping of the REFERENCE clause RFC 1442 SMI for SNMPv2 April 1993
7.6. Mapping of the REFERENCE clause
The REFERENCE clause, which need not be present, contains a The REFERENCE clause, which need not be present, contains a
textual cross-reference to an object defined in some other textual cross-reference to an object defined in some other
information module. This is useful when de-osifying a MIB information module. This is useful when de-osifying a MIB
module produced by some other organization. module produced by some other organization.
6.7. Mapping of the INDEX clause 7.7. Mapping of the INDEX clause
The INDEX clause, which must be present if that object The INDEX clause, which must be present if that object
corresponds to a conceptual row (unless an AUGMENTS clause is corresponds to a conceptual row (unless an AUGMENTS clause is
present instead), and must be absent otherwise, defines present instead), and must be absent otherwise, defines
instance identification information for the columnar objects instance identification information for the columnar objects
subordinate to that object. subordinate to that object.
Management operations apply exclusively to scalar objects. Management operations apply exclusively to scalar objects.
However, it is convenient for developers of management However, it is convenient for developers of management
applications to impose imaginary, tabular structures on the applications to impose imaginary, tabular structures on the
ordered collection of objects that constitute the MIB. Each ordered collection of objects that constitute the MIB. Each
such conceptual table contains zero or more rows, and each row such conceptual table contains zero or more rows, and each row
may contain one or more scalar objects, termed columnar may contain one or more scalar objects, termed columnar
objects. This conceptualization is formalized by using the objects. This conceptualization is formalized by using the
OBJECT-TYPE macro to define both an object which corresponds OBJECT-TYPE macro to define both an object which corresponds
to a table and an object which corresponds to a row in that to a table and an object which corresponds to a row in that
table. A conceptual table has SYNTAX of the form: table. A conceptual table has SYNTAX of the form:
SEQUENCE OF <EntryType> | SEQUENCE OF <EntryType>
where <EntryType> refers to the SEQUENCE type of its | where <EntryType> refers to the SEQUENCE type of its
subordinate conceptual row. | subordinate conceptual row. A conceptual row has SYNTAX of
A conceptual row has SYNTAX of the form: the form:
<EntryType> | <EntryType>
where <EntryType> is a SEQUENCE type defined as follows: + where <EntryType> is a SEQUENCE type defined as follows:
<EntryType> ::= SEQUENCE { <type1>, ... , <typeN> } + <EntryType> ::= SEQUENCE { <type1>, ... , <typeN> }
where there is one <type> for each subordinate object, and where there is one <type> for each subordinate object, and
each <type> is of the form: each <type> is of the form:
Draft Structure of Management Information for SNMPv2 Oct 92
<descriptor> <syntax> <descriptor> <syntax>
where <descriptor> is the descriptor naming a subordinate where <descriptor> is the descriptor naming a subordinate
RFC 1442 SMI for SNMPv2 April 1993
object, and <syntax> has the value of that subordinate object, and <syntax> has the value of that subordinate
object's SYNTAX clause, optionally omitting the sub-typing object's SYNTAX clause, optionally omitting the sub-typing
information. Further, these ASN.1 types are always present information. Further, these ASN.1 types are always present
(the DEFAULT and OPTIONAL clauses are disallowed in the (the DEFAULT and OPTIONAL clauses are disallowed in the
SEQUENCE definition). The MAX-ACCESS clause for conceptual SEQUENCE definition). The MAX-ACCESS clause for conceptual
tables and rows is "not-accessible". tables and rows is "not-accessible".
For leaf objects which are not columnar objects, instances of For leaf objects which are not columnar objects, instances of
the object are identified by appending a sub-identifier of the object are identified by appending a sub-identifier of
zero to the name of that object. Otherwise, the INDEX clause zero to the name of that object. Otherwise, the INDEX clause
skipping to change at page 32, line 5 skipping to change at page 29, line 47
encoded in a separate sub-identifier); encoded in a separate sub-identifier);
(4) object identifier-valued: `n+1' sub-identifiers, where (4) object identifier-valued: `n+1' sub-identifiers, where
`n' is the number of sub-identifiers in the value (the `n' is the number of sub-identifiers in the value (the
first sub-identifier is `n' itself, following this, each first sub-identifier is `n' itself, following this, each
sub-identifier in the value is copied); sub-identifier in the value is copied);
(5) IpAddress-valued: 4 sub-identifiers, in the familiar (5) IpAddress-valued: 4 sub-identifiers, in the familiar
a.b.c.d notation. a.b.c.d notation.
Draft Structure of Management Information for SNMPv2 Oct 92
(6) NsapAddress-valued: `n' sub-identifiers, where `n' is the (6) NsapAddress-valued: `n' sub-identifiers, where `n' is the
length of the value (each octet of the value is encoded length of the value (each octet of the value is encoded
in a separate sub-identifier); in a separate sub-identifier);
Note that the IMPLIED keyword can only be present for string- RFC 1442 SMI for SNMPv2 April 1993
valued objects, excluding IpAddress- and NsapAddress-valued
objects. Note that the IMPLIED keyword can only be present for objects
having a variable-length syntax (e.g., variable-length strings
or object identifier-valued objects). Further, the IMPLIED
keyword may appear at most once within the INDEX clause, and
if so, is associated with the right-most object having a
variable-length syntax. Finally, the IMPLIED keyword may not
be used on a variable-length string object if that string
might have a value of zero-length.
Instances identified by use of integer-valued objects should Instances identified by use of integer-valued objects should
be numbered starting from one (i.e., not from zero). The use be numbered starting from one (i.e., not from zero). The use
of zero as a value for an integer-valued index object should of zero as a value for an integer-valued index object should
be avoided, except in special cases. be avoided, except in special cases.
Objects which are both specified in the INDEX clause of a Objects which are both specified in the INDEX clause of a
conceptual row and also columnar objects of the same conceptual row and also columnar objects of the same
conceptual row are termed auxiliary objects. The MAX-ACCESS conceptual row are termed auxiliary objects. The MAX-ACCESS
clause for newly-defined auxiliary objects is "not- clause for newly-defined auxiliary objects is "not-
skipping to change at page 32, line 37 skipping to change at page 30, line 38
either "read-only" or "read-create"). either "read-only" or "read-create").
Note that objects specified in a conceptual row's INDEX clause Note that objects specified in a conceptual row's INDEX clause
need not be columnar objects of that conceptual row. In this need not be columnar objects of that conceptual row. In this
situation, the DESCRIPTION clause of the conceptual row must situation, the DESCRIPTION clause of the conceptual row must
include a textual explanation of how the objects which are include a textual explanation of how the objects which are
included in the INDEX clause but not columnar objects of that included in the INDEX clause but not columnar objects of that
conceptual row, are used in uniquely identifying instances of conceptual row, are used in uniquely identifying instances of
the conceptual row's columnar objects. the conceptual row's columnar objects.
6.7.1. Creation and Deletion of Conceptual Rows 7.7.1. Creation and Deletion of Conceptual Rows
For newly-defined conceptual rows which allow the creation of For newly-defined conceptual rows which allow the creation of
new object instances and the deletion of existing object new object instances and the deletion of existing object
instances, there should be one columnar object with a SYNTAX instances, there should be one columnar object with a SYNTAX
clause value of RowStatus (a textual convention defined in | clause value of RowStatus (a textual convention defined in
[4]) | [3]) and a MAX-ACCESS clause value of read-create. By
and a MAX-ACCESS clause value of read-create. By convention, convention, this is termed the status column for the
this is termed the status column for the conceptual row. conceptual row.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
6.8. Mapping of the AUGMENTS clause 7.8. Mapping of the AUGMENTS clause
The AUGMENTS clause, which must not be present unless the The AUGMENTS clause, which must not be present unless the
object corresponds to a conceptual row, is an alternative to object corresponds to a conceptual row, is an alternative to
the INDEX clause. Every object corresponding to a conceptual the INDEX clause. Every object corresponding to a conceptual
row has either an INDEX clause or an AUGMENTS clause. row has either an INDEX clause or an AUGMENTS clause.
If an object corresponding to a conceptual row has an INDEX If an object corresponding to a conceptual row has an INDEX
clause, that row is termed a base conceptual row; clause, that row is termed a base conceptual row;
alternatively, if the object has an AUGMENTS clause, the row alternatively, if the object has an AUGMENTS clause, the row
is said to be a conceptual row augmentation, where the is said to be a conceptual row augmentation, where the
AUGMENTS clause names the object corresponding to the base AUGMENTS clause names the object corresponding to the base
conceptual row which is augmented by this conceptual row conceptual row which is augmented by this conceptual row
extension. Instances of subordinate columnar objects of a extension. Instances of subordinate columnar objects of a
conceptual row extension are identified according to the INDEX conceptual row extension are identified according to the INDEX
clause of the base conceptual row corresponding to the object clause of the base conceptual row corresponding to the object
named in the AUGMENTS clause. Further, instances of named in the AUGMENTS clause. Further, instances of
subordinate columnar objects of a conceptual row extension subordinate columnar objects of a conceptual row extension
exist according to the same semantics as instances of exist according to the same semantics as instances of
subordinate columnar objects of the base conceptual row being subordinate columnar objects of the base conceptual row being
augmented. augmented. As such, note that creation of a base conceptual
row implies the correspondent creation of any conceptual row
augmentations.
For example, a MIB designer might wish to define additional For example, a MIB designer might wish to define additional
columns in an "enterprise-specific" MIB which logically extend columns in an "enterprise-specific" MIB which logically extend
a conceptual row in a "standard" MIB. The "standard" MIB a conceptual row in a "standard" MIB. The "standard" MIB
definition of the conceptual row would include the INDEX definition of the conceptual row would include the INDEX
clause and the "enterprise-specific" MIB would contain the clause and the "enterprise-specific" MIB would contain the
definition of a conceptual row using the AUGMENTS clause. definition of a conceptual row using the AUGMENTS clause.
Note that a base conceptual row may be augmented by multiple Note that a base conceptual row may be augmented by multiple
conceptual row extensions. conceptual row extensions.
6.9. Mapping of the DEFVAL clause 7.8.1. Relation between INDEX and AUGMENTS clauses
When defining instance identification information for a
conceptual table:
(1) If there is a one-to-one correspondence between the
conceptual rows of this table and an existing table, then
the AUGMENTS clause should be used.
RFC 1442 SMI for SNMPv2 April 1993
(2) Otherwise, if there is a sparse relationship between the
conceptuals rows of this table and an existing table,
then an INDEX clause should be used which is identical to
that in the existing table.
(3) Otherwise, auxiliary objects should be defined within the
conceptual row for the new table, and those objects
should be used within the INDEX clause for the conceptual
row.
7.9. Mapping of the DEFVAL clause
The DEFVAL clause, which need not be present, defines an The DEFVAL clause, which need not be present, defines an
acceptable default value which may be used at the discretion acceptable default value which may be used at the discretion
of an SNMPv2 entity acting in an agent role when an object of a SNMPv2 entity acting in an agent role when an object
instance is created. instance is created.
During conceptual row creation, if an instance of a columnar During conceptual row creation, if an instance of a columnar
object is not present as one of the operands in the object is not present as one of the operands in the
correspondent management protocol set operation, then the correspondent management protocol set operation, then the
value of the DEFVAL clause, if present, indicates an value of the DEFVAL clause, if present, indicates an
acceptable default value that a SNMPv2 entity acting in an acceptable default value that a SNMPv2 entity acting in an
Draft Structure of Management Information for SNMPv2 Oct 92
agent role might use. agent role might use.
The value of the DEFVAL clause must, of course, correspond to The value of the DEFVAL clause must, of course, correspond to
the SYNTAX clause for the object. If the value is an OBJECT the SYNTAX clause for the object. If the value is an OBJECT
IDENTIFIER, then it must be expressed as a single ASN.1 IDENTIFIER, then it must be expressed as a single ASN.1
identifier, and not as a collection of sub-identifiers. identifier, and not as a collection of sub-identifiers.
Note that if an operand to the management protocol set Note that if an operand to the management protocol set
operation is an instance of a read-only object, then the error operation is an instance of a read-only object, then the error
`notWritable' [6] will be returned. As such, the DEFVAL `notWritable' [6] will be returned. As such, the DEFVAL
clause can be used to provide an acceptable default value that clause can be used to provide an acceptable default value that
a SNMPv2 entity acting in an agent role might use. a SNMPv2 entity acting in an agent role might use.
By way of example, consider the following possible DEFVAL By way of example, consider the following possible DEFVAL
clauses: clauses:
ObjectSyntax DEFVAL clause RFC 1442 SMI for SNMPv2 April 1993
----------------- ------------
Integer32 1 ObjectSyntax DEFVAL clause
-- same for Gauge32, TimeTicks ----------------- ------------
INTEGER valid -- enumerated value Integer32 1
OCTET STRING 'ffffffffffff'h -- same for Gauge32, TimeTicks, UInteger32
OBJECT IDENTIFIER sysDescr INTEGER valid -- enumerated value
BIT STRING { primary, secondary } -- enumerated values OCTET STRING 'ffffffffffff'H
IpAddress 'c0210415'h -- 192.33.4.21 OBJECT IDENTIFIER sysDescr
BIT STRING { primary, secondary } -- enumerated values
IpAddress 'c0210415'H -- 192.33.4.21
Object types with SYNTAX of Counter32 and Counter64 may not Object types with SYNTAX of Counter32 and Counter64 may not
have DEFVAL clauses, since they do not have defined initial have DEFVAL clauses, since they do not have defined initial
values. However, it is recommended that they be initialized values. However, it is recommended that they be initialized
to zero. to zero.
6.10. Mapping of the OBJECT-TYPE value 7.10. Mapping of the OBJECT-TYPE value
The value of an invocation of the OBJECT-TYPE macro is the The value of an invocation of the OBJECT-TYPE macro is the
name of the object, which is an OBJECT IDENTIFIER, an name of the object, which is an OBJECT IDENTIFIER, an
administratively assigned name. administratively assigned name.
When an OBJECT IDENTIFIER is assigned to an object: When an OBJECT IDENTIFIER is assigned to an object:
(1) If the object corresponds to a conceptual table, then (1) If the object corresponds to a conceptual table, then
only a single assignment, that for a conceptual row, is only a single assignment, that for a conceptual row, is
present immediately beneath that object. The present immediately beneath that object. The
administratively assigned name for the conceptual row administratively assigned name for the conceptual row
object is derived by appending a sub-identifier of "1" to object is derived by appending a sub-identifier of "1" to
Draft Structure of Management Information for SNMPv2 Oct 92
the administratively assigned name for the conceptual the administratively assigned name for the conceptual
table. table.
(2) If the object corresponds to a conceptual row, then at (2) If the object corresponds to a conceptual row, then at
least one assignment, one for each column in the least one assignment, one for each column in the
conceptual row, is present beneath that object. The conceptual row, is present beneath that object. The
administratively assigned name for each column is derived administratively assigned name for each column is derived
by appending a unique, positive sub-identifier to the by appending a unique, positive sub-identifier to the
administratively assigned name for the conceptual row. administratively assigned name for the conceptual row.
(3) Otherwise, no other OBJECT IDENTIFIERs which are (3) Otherwise, no other OBJECT IDENTIFIERs which are
subordinate to the object may be assigned. subordinate to the object may be assigned.
Note that the final sub-identifier of any administratively Note that the final sub-identifier of any administratively
assigned name for an object shall be positive. A zero-valued assigned name for an object shall be positive. A zero-valued
final sub-identifier is reserved for future use. final sub-identifier is reserved for future use.
RFC 1442 SMI for SNMPv2 April 1993
Further note that although conceptual tables and rows are Further note that although conceptual tables and rows are
given administratively assigned names, these conceptual given administratively assigned names, these conceptual
objects may not be manipulated in aggregate form by the objects may not be manipulated in aggregate form by the
management protocol. management protocol.
6.10.1. Naming Hierarchy RFC 1442 SMI for SNMPv2 April 1993
The root of the subtree administered by the Internet Assigned
Numbers Authority (IANA) for the Internet is:
internet OBJECT IDENTIFIER ::= { iso org(3) dod(6) 1 }
That is, the Internet subtree of OBJECT IDENTIFIERs starts
with the prefix:
1.3.6.1.
Several branches underneath this subtree are used for network
management:
mgmt OBJECT IDENTIFIER ::= { internet 2 }
experimental OBJECT IDENTIFIER ::= { internet 3 }
private OBJECT IDENTIFIER ::= { internet 4 }
enterprises OBJECT IDENTIFIER ::= { private 1 }
However, the SMI does not prohibit the definition of objects
in other portions of the object tree.
Draft Structure of Management Information for SNMPv2 Oct 92
The mgmt(2) subtree is used to identify "standard" objects.
The experimental(3) subtree is used to identify objects used
in Internet experiments. As a part of the assignment process,
the IANA may make requirements as to how that subtree is used.
The private(4) subtree is used to identify objects defined
unilaterally. The enterprises(1) subtree beneath private is
used, among other things, to permit providers of networking
subsystems to register models of their products.
Draft Structure of Management Information for SNMPv2 Oct 92
6.11. Usage Example 7.11. Usage Example
Consider how one might define a conceptual table and its Consider how one might define a conceptual table and its
subordinates. subordinates.
evalSlot OBJECT-TYPE evalSlot OBJECT-TYPE
SYNTAX INTEGER SYNTAX INTEGER
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The index number of the first unassigned entry in "The index number of the first unassigned entry in
skipping to change at page 38, line 5 skipping to change at page 36, line 5
evalEntry OBJECT-TYPE evalEntry OBJECT-TYPE
SYNTAX EvalEntry SYNTAX EvalEntry
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"An entry (conceptual row) in the evaluation "An entry (conceptual row) in the evaluation
table." table."
INDEX { evalIndex } INDEX { evalIndex }
::= { evalTable 1 } ::= { evalTable 1 }
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
EvalEntry ::= EvalEntry ::=
SEQUENCE { SEQUENCE {
evalIndex Integer32, evalIndex Integer32,
evalString OCTET STRING, evalString DisplayString,
evalValue Integer32, evalValue Integer32,
evalStatus RowStatus evalStatus RowStatus
} }
evalIndex OBJECT-TYPE evalIndex OBJECT-TYPE
SYNTAX Integer32 SYNTAX Integer32
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The auxiliary variable used for identifying "The auxiliary variable used for identifying
instances of the columnar objects in the instances of the columnar objects in the
evaluation table." evaluation table."
::= { evalEntry 1 } ::= { evalEntry 1 }
evalString OBJECT-TYPE evalString OBJECT-TYPE
SYNTAX OCTET STRING SYNTAX DisplayString
MAX-ACCESS read-create MAX-ACCESS read-create
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The string to evaluate." "The string to evaluate."
::= { evalEntry 2 } ::= { evalEntry 2 }
evalValue OBJECT-TYPE evalValue OBJECT-TYPE
SYNTAX Integer32 SYNTAX Integer32
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
skipping to change at page 39, line 5 skipping to change at page 37, line 5
SYNTAX RowStatus SYNTAX RowStatus
MAX-ACCESS read-create MAX-ACCESS read-create
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The status column used for creating, modifying, "The status column used for creating, modifying,
and deleting instances of the columnar objects in and deleting instances of the columnar objects in
the evaluation table." the evaluation table."
DEFVAL { active } DEFVAL { active }
::= { evalEntry 4 } ::= { evalEntry 4 }
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
7. Mapping of the OBJECT-GROUP macro
When a MIB module is written, each collection of related
managed objects defined within the MIB module is combined into
a unit of conformance termed a MIB group. The OBJECT-GROUP
macro is used to define each such collection of related
objects. It should be noted that the expansion of the
OBJECT-GROUP macro is something which conceptually happens
during implementation and not during run-time.
To "implement" an object, a SNMPv2 entity acting in an agent
role must return an 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 [6]. 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 [6].
7.1. Mapping of the OBJECTS clause
The OBJECTS clause which must be present, is used to name each
object contained in the 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
"read-only", "read-write", or "read-create".
7.2. Mapping of the STATUS clause
The STATUS clause, which must be present, indicates whether
this definition is current or historic.
The values "current", and "obsolete" are self-explanatory.
The "deprecated" value indicates that that object is obsolete,
but that an implementor may wish to support that object to
foster interoperability with older implementations.
Draft Structure of Management Information for SNMPv2 Oct 92
7.3. Mapping of the DESCRIPTION clause
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.
7.4. Mapping of the REFERENCE clause
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.
7.5. Mapping of the OBJECT-GROUP value
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.
Draft Structure of Management Information for SNMPv2 Oct 92
7.6. Usage Example
Consider how the system group from MIB-II [2] might be
described:
system OBJECT-GROUP
OBJECTS { sysDescr, sysObjectID, sysUpTime,
sysContact, sysName, sysLocation,
sysServices }
STATUS current
DESCRIPTION
"The system group defines objects which are common
to all managed systems."
::= { mib-2 1 }
Draft Structure of Management Information for SNMPv2 Oct 92
8. Mapping of the NOTIFICATION-TYPE macro 8. Mapping of the NOTIFICATION-TYPE macro
The NOTIFICATION-TYPE macro is used to define the information | The NOTIFICATION-TYPE macro is used to define the information
contained within an unsolicited transmission of management | contained within an unsolicited transmission of management
information (i.e., within either an SNMPv2-Trap-PDU or | information (i.e., within either a SNMPv2-Trap-PDU or
InformRequest-PDU). It should be noted that the expansion of | InformRequest-PDU). It should be noted that the expansion of
the NOTIFICATION-TYPE macro is | the NOTIFICATION-TYPE macro is something which conceptually
something which conceptually happens during implementation and happens during implementation and not during run-time.
not during run-time. -
8.1. Mapping of the OBJECTS clause 8.1. Mapping of the OBJECTS clause
The OBJECTS clause, which need not be present, defines the The OBJECTS clause, which need not be present, defines the
ordered sequence of MIB objects which are contained within ordered sequence of MIB objects which are contained within
every instance of the notification. | every instance of the notification.
8.2. Mapping of the STATUS clause 8.2. Mapping of the STATUS clause
The STATUS clause, which must be present, indicates whether The STATUS clause, which must be present, indicates whether
this definition is current or historic. this definition is current or historic.
The values "current", and "obsolete" are self-explanatory. The values "current", and "obsolete" are self-explanatory.
The "deprecated" value indicates that that object is obsolete, The "deprecated" value indicates that the notification is
but that an implementor may wish to support that object to obsolete, but that an implementor may wish to support that
foster interoperability with older implementations. object to foster interoperability with older implementations.
8.3. Mapping of the DESCRIPTION clause 8.3. Mapping of the DESCRIPTION clause
The DESCRIPTION clause, which must be present, contains a | The DESCRIPTION clause, which must be present, contains a
textual definition of the notification | textual definition of the notification which provides all
which provides all semantic definitions necessary for semantic definitions necessary for implementation, and should
implementation, and should embody any information which would embody any information which would otherwise be communicated
otherwise be communicated in any ASN.1 commentary annotations in any ASN.1 commentary annotations associated with the
associated with the object. In particular, the DESCRIPTION object. In particular, the DESCRIPTION clause should document
clause should document which instances of the objects | which instances of the objects mentioned in the OBJECTS clause
mentioned in the OBJECTS clause should be contained within | should be contained within notifications of this type.
notifications of this type. |
Draft Structure of Management Information for SNMPv2 Oct 92
8.4. Mapping of the REFERENCE clause 8.4. Mapping of the REFERENCE clause
The REFERENCE clause, which need not be present, contains a | The REFERENCE clause, which need not be present, contains a
textual cross-reference to a notification defined in some | textual cross-reference to a notification defined in some
other | other information module. This is useful when de-osifying a
information module. This is useful when de-osifying a MIB RFC 1442 SMI for SNMPv2 April 1993
module produced by some other organization.
MIB module produced by some other organization.
8.5. Mapping of the NOTIFICATION-TYPE value 8.5. Mapping of the NOTIFICATION-TYPE value
The value of an invocation of the NOTIFICATION-TYPE macro is | The value of an invocation of the NOTIFICATION-TYPE macro is
the name of the notification, | the name of the notification, which is an OBJECT IDENTIFIER,
which is an OBJECT IDENTIFIER, an administratively assigned an administratively assigned name.
name. -
Draft Structure of Management Information for SNMPv2 Oct 92 Sections 4.2.6 and 4.2.7 of [6] describe how the
NOTIFICATION-TYPE macro is used to generate a SNMPv2-Trap-PDU
or InformRequest-PDU, respectively.
RFC 1442 SMI for SNMPv2 April 1993
8.6. Usage Example 8.6. Usage Example
Consider how a linkUp trap might be described: Consider how a linkUp trap might be described:
linkUp NOTIFICATION-TYPE | linkUp NOTIFICATION-TYPE
OBJECTS { ifIndex } OBJECTS { ifIndex }
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"A linkUp trap signifies that the SNMPv2 entity, "A linkUp trap signifies that the SNMPv2 entity,
acting in an agent role, recognizes that one of acting in an agent role, recognizes that one of
the communication links represented in its the communication links represented in its
configuration has come up." configuration has come up."
::= { snmpTraps 4 } ::= { snmpTraps 4 }
According to this invocation, the trap authoritatively According to this invocation, the trap authoritatively
identified as identified as
{ snmpTraps 4 } { snmpTraps 4 }
is used to report a link coming up. | is used to report a link coming up.
The instance of ifIndex corresponding to this link will be
present as the third variable in the variable-bindings field.
Note that a SNMPv2 entity acting in an agent role can be Note that a SNMPv2 entity acting in an agent role can be
configured to send this trap to zero or more SNMPv2 entities configured to send this trap to zero or more SNMPv2 entities
acting in a manager role, depending on the contents of the acting in a manager role, depending on the contents of the
aclTable and viewTable [9] tables. For example, by judicious aclTable and viewTable [8] tables. For example, by judicious
use of the viewTable, a SNMPv2 entity acting in an agent role use of the viewTable, a SNMPv2 entity acting in an agent role
might be configured to send all linkUp traps to one particular might be configured to send all linkUp traps to one particular
SNMPv2 entity, and linkUp traps for only certain interfaces to SNMPv2 entity, and linkUp traps for only certain interfaces to
other SNMPv2 entities. other SNMPv2 entities.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
9. Mapping of the MODULE-COMPLIANCE macro
The MODULE-COMPLIANCE macro is used to convey a minimum set of
requirements with respect to implementation of one or more MIB
modules. It should be noted that the expansion of the
MODULE-COMPLIANCE macro is something which conceptually
happens during implementation and not during run-time.
A requirement on all "standard" MIB modules is that a
corresponding MODULE-COMPLIANCE specification is also defined,
either in the same information module or in a companion
information module.
9.1. Mapping of the STATUS clause
The STATUS clause, which must be present, indicates whether
this definition is current or historic.
The values "current", and "obsolete" are self-explanatory.
The "deprecated" value indicates that that object is obsolete,
but that an implementor may wish to support that object to
foster interoperability with older implementations.
9.2. Mapping of the DESCRIPTION clause
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.
9.3. Mapping of the REFERENCE clause
The REFERENCE clause, which need not be present, contains a
textual cross-reference to a compliance statement defined in
some other information module.
9.4. Mapping of the MODULE clause
The MODULE clause, which must be present, is repeatedly used
to name each MIB module for which compliance requirements are
Draft Structure of Management Information for SNMPv2 Oct 92
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.
9.4.1. Mapping of the MANDATORY-GROUPS clause
The MANDATORY-GROUPS clause, which need not be present, names
the one or more 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
within each group listed. That is, if a SNMPv2 entity returns
a noSuchObject exception in response to a management protocol
get operation [6] for any object within any mandatory group
for every MIB view, then that SNMPv2 entity is not a
conformant implementation of the MIB module.
9.4.2. Mapping of the GROUP clause
The GROUP clause which need not be present, is repeatedly used
to name each MIB group which is conditionally mandatory or
unconditionally optional for compliance to the MIB module. A
MIB group named in a GROUP clause must be absent from the
correspondent MANDATORY-GROUPS clause.
Conditionally mandatory groups include those which are
mandatory only if a particular protocol is implemented, or
only if another group is implemented. A GROUP clause's
DESCRIPTION specifies the conditions under which the group is
conditionally mandatory.
A MIB group which is named in neither a MANDATORY-GROUPS
clause nor a GROUP clause, is unconditionally optional for
compliance to the MIB module.
9.4.3. Mapping of the OBJECT clause
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.
Draft Structure of Management Information for SNMPv2 Oct 92
The MIB object must be present in one of the groups named in
the correspondent MANDATORY-GROUPS clause or GROUP clauses.
9.4.3.1. Mapping of the SYNTAX clause
The SYNTAX clause, which need not be present, is used to
provide a refined SYNTAX for the object named in the
correspondent OBJECT clause. Note that if this clause and a
WRITE-SYNTAX clause are both present, then this clause only
applies when instances of the object named in the
correspondent OBJECT clause are read.
Consult Section 11 for more information on refined syntax.
9.4.3.2. Mapping of the WRITE-SYNTAX clause
The WRITE-SYNTAX clause, which need not be present, is used to
provide a refined SYNTAX for the object named in the
correspondent OBJECT clause when instances of that object are
written.
Consult Section 11 for more information on refined syntax.
9.4.3.3. Mapping of the MIN-ACCESS clause
The MIN-ACCESS clause, which need not be present, is used to
define the minimal level of access for the object named in the
correspondent OBJECT clause. If this clause is absent, the
minimal level of access is the same as the maximal level
specified in the correspondent invocation of the OBJECT-TYPE
macro. If present, this clause must not specify a greater
level of access than is specified in the correspondent
invocation of the OBJECT-TYPE macro.
The level of access for certain types of objects is fixed
according to their syntax definition. These types are:
conceptual tables and rows, auxiliary objects, and objects
with the syntax of Counter32, Counter64, or certain types of |
textual conventions (e.g., RowStatus [4]). |
A MIN-ACCESS clause should not be present for such objects.
Draft Structure of Management Information for SNMPv2 Oct 92
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.
9.4.3.4. Mapping of the DESCRIPTION clause
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.
9.5. Mapping of the MODULE-COMPLIANCE value
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
requirements embodied by that invocation of the macro.
Draft Structure of Management Information for SNMPv2 Oct 92
9.6. Usage Example
Consider how a compliance statement might be included at the
end of the MIB-II document [2], assuming that objects groups
were defined therein:
rfc1213Compliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for SNMPv2 entities
residing on systems which implement the Internet
suite of protocols."
MODULE -- compliance to the containing MIB module
MANDATORY-GROUPS { system, snmp }
GROUP interfaces
DESCRIPTION
"The interfaces group is mandatory for systems
with network interfaces."
GROUP ip
DESCRIPTION
"The ip group is mandatory for systems which
implement IP."
GROUP icmp
DESCRIPTION
"The icmp group is mandatory for systems which
implement ICMP."
GROUP tcp
DESCRIPTION
"The tcp group is mandatory for systems which
implement TCP."
OBJECT tcpConnState
MIN-ACCESS read-only
DESCRIPTION
"A compliant system need not allow
write-access to this object."
GROUP udp
DESCRIPTION
"The udp group is mandatory for systems which
implement UDP."
Draft Structure of Management Information for SNMPv2 Oct 92
GROUP egp
DESCRIPTION
"The egp group is mandatory for systems which
implement EGP."
::= { mib2Compliance 1 }
According to this invocation, to claim compliance with the
specification named
{ mib2Compliance 1 }
a system must implement RFC1213's system and snmp groups. If
the system implements any network interfaces, then RFC1213's
interfaces group must be implemented. Further, if the system
implements any of the IP, ICMP, TCP, UDP, or EGP protocols,
then the correspondent group in RFC1213 must be implemented,
if compliance is to be claimed. Finally, although RFC1213
specifies that it makes "protocol sense" for the tcpConnState
object to be writable, this specification allows the system to
permit only read-only access and still claim compliance.
Draft Structure of Management Information for SNMPv2 Oct 92
10. Mapping of the AGENT-CAPABILITIES macro
The AGENT-CAPABILITIES macro is used to convey the
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.
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 the
definition to the discretion of an implementor.
Practical experience has demonstrated a need for concisely
describing the capabilities of an agent with regards to the
MIB groups that it implements. 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 sysObjectID [2]
associated with the agent, or to the value of an instance of
the snmpORID object in the snmpORTable [3]. In particular,
some objects may have restricted or augmented syntax or
access-levels.
If the AGENT-CAPABILITIES invocation is given to a
management-station implementor, then that implementor can
build management applications which optimize themselves when
communicating with a particular agent. For example, the
management-station can maintain a database of these
invocations. When a management-station interacts with an
agent, it retrieves the agent's sysObjectID [2]. Based on
this, it consults the database. If an entry is found, then
the management application can optimize its behavior
accordingly.
Note that this binding to sysObjectID may not always suffice
to define all MIB objects to which an agent can provide
access. In particular, this situation occurs where the agent
dynamically learns of the objects it supports. In these
cases, the snmpORID column of snmpORTable [3] contains
Draft Structure of Management Information for SNMPv2 Oct 92
information which should be used in addition to sysObjectID.
Note that the AGENT-CAPABILITIES macro specifies refinements
or variations with respect to OBJECT-TYPE macros in MIB
modules, NOT with respect to MODULE-COMPLIANCE macros in
compliance statements.
10.1. Mapping of the PRODUCT-RELEASE clause
The PRODUCT-RELEASE clause, which must be present, contains a
textual description of the product release which includes this
agent.
10.2. Mapping of the STATUS clause
The STATUS clause, which must be present, indicates whether
this definition is current or historic.
The values "current", and "obsolete" are self-explanatory.
The "deprecated" value indicates that that object is obsolete,
but that an implementor may wish to support that object to
foster interoperability with older implementations.
10.3. Mapping of the DESCRIPTION clause
The DESCRIPTION clause, which must be present, contains a
textual description of this agent.
10.4. Mapping of the REFERENCE clause
The REFERENCE clause, which need not be present, contains a
textual cross-reference to a capability statement defined in
some other information module.
10.5. Mapping of the SUPPORTS clause
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
Draft Structure of Management Information for SNMPv2 Oct 92
IDENTIFIER as well.
10.5.1. Mapping of the INCLUDES clause
The INCLUDES clause, which must be present for each use of the
SUPPORTS clause, is used to name each MIB group associated
with the SUPPORT clause, which the agent claims to implement.
10.5.2. Mapping of the VARIATION clause
The VARIATION clause, which need not be present, is repeatedly
used to name each MIB object which the agent implements in
some variant or refined fashion with respect to the
correspondent invocation of the OBJECT-TYPE macro.
Note that the variation concept is meant for generic
implementation restrictions, e.g., if the variation for an
object depends on the values of other objects, then this
should be noted in the appropriate DESCRIPTION clause.
10.5.2.1. Mapping of the SYNTAX clause
The SYNTAX clause, which need not be present, is used to
provide a refined SYNTAX for the object named in the
correspondent VARIATION clause. Note that if this clause and
a WRITE-SYNTAX clause are both present, then this clause only
applies when instances of the object named in the
correspondent VARIATION clause are read.
Consult Section 11 for more information on refined syntax.
10.5.2.2. Mapping of the WRITE-SYNTAX clause
The WRITE-SYNTAX clause, which need not be present, is used to
provide a refined SYNTAX for the object named in the
correspondent VARIATION clause when instances of that object
are written.
Consult Section 11 for more information on refined syntax.
Draft Structure of Management Information for SNMPv2 Oct 92
10.5.2.3. Mapping of the ACCESS clause
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 named in the correspondent VARIATION
clause.
The value "not-implemented" indicates the agent does not
implement the object, and in the ordering of possible values
is equivalent to "not-accessible".
The value "write-only" is provided solely for backward
compatibility, and shall not be used for newly-defined object
types. In the ordering of possible values, "write-only" is
less than "not-accessible".
10.5.2.4. Mapping of the CREATION-REQUIRES clause
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(4)'. (Consult |
the definition of RowStatus [4].) |
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 [7,8]), then the CREATION-REQUIRES
clause, which need not be present, is used to name the
columnar objects of a conceptual row to which values must be
explicitly assigned, by a management protocol set operation,
before the agent will create new instances of objects in that
row.
This clause must not present unless the object named in the
correspondent VARIATION clause is a conceptual row, i.e., has
a syntax which resolves to a SEQUENCE containing columnar
objects. The objects named in the value of this clause
usually will refer to columnar objects in that row. However,
objects unrelated to the conceptual row may also be specified.
All objects which are named in the CREATION-REQUIRES clause
for a conceptual row, and which are columnar objects of that
row, must have an access level of "read-create".
Draft Structure of Management Information for SNMPv2 Oct 92
10.5.2.5. Mapping of the DEFVAL clause
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.
10.5.2.6. Mapping of the DESCRIPTION clause
The DESCRIPTION clause, which must be present for each use of
the VARIATION clause, contains a textual description of the
variant or refined implementation.
10.6. Mapping of the AGENT-CAPABILITIES value
The value of an invocation of the AGENT-CAPABILITIES macro is
an OBJECT IDENTIFIER, which names the value of sysObjectID [2]
or snmpORID [3] for which this capabilities statement is
valid.
Draft Structure of Management Information for SNMPv2 Oct 92
10.7. Usage Example
Consider how a capabilities statement for an agent might be
described:
exampleAgent AGENT-CAPABILITIES
PRODUCT-RELEASE "ACME Agent release 1.1 for 4BSD"
STATUS current
DESCRIPTION "ACME agent for 4BSD"
SUPPORTS RFC1213-MIB
INCLUDES { system, interfaces, at, ip, icmp,
tcp, udp, snmp }
VARIATION ifAdminStatus
SYNTAX INTEGER { up(1), down(2) }
DESCRIPTION "Unable to set test mode on 4BSD"
VARIATION ifOperStatus
SYNTAX INTEGER { up(1), down(2) }
DESCRIPTION "Information limited on 4BSD"
VARIATION atEntry
CREATION-REQUIRES { atPhysAddress }
DESCRIPTION "Address mappings on 4BSD require
both protocol and media addresses"
VARIATION ipDefaultTTL
SYNTAX INTEGER (255..255)
DESCRIPTION "Hard-wired on 4BSD"
VARIATION ipInAddrErrors
ACCESS not-implemented
DESCRIPTION "Information not available on 4BSD"
VARIATION ipRouteType
SYNTAX INTEGER { direct(3), indirect(4) }
WRITE-SYNTAX INTEGER { invalid(2), direct(3),
indirect(4) }
DESCRIPTION "Information limited on 4BSD"
VARIATION tcpConnState
ACCESS read-only
DESCRIPTION "Unable to set this on 4BSD"
Draft Structure of Management Information for SNMPv2 Oct 92
SUPPORTS EVAL-MIB
INCLUDES { functions, expressions }
VARIATION exprEntry
CREATION-REQUIRES { evalString }
DESCRIPTION "Conceptual row creation supported"
::= { acmeAgents 1 }
According to this invocation, an agent with a sysObjectID (or
snmpORID) value of
{ acmeAgents 1 }
supports two MIB modules.
From MIB-II, all groups except the egp group are supported.
However, the object ipInAddrErrors is not implemented, whilst
the objects
ifAdminStatus
ifOperStatus
ipDefaultTTL
ipRouteType
have a restricted syntax, and the object
tcpConnState
is available only for reading. Note that in the case of the
object ipRouteType the set of values which may be read is
different than the set of values which may be written.
Finally, when creating a new instance in the atTable, the
set-request must create an instance of atPhysAddress.
From the EVAL-MIB, all the objects contained in the functions
and expressions groups are supported, without variation. In
addition, creation of new instances in the expr table is
supported.
Draft Structure of Management Information for SNMPv2 Oct 92
11. Refined Syntax 9. Refined Syntax
The SYNTAX and WRITE-SYNTAX clauses in the MODULE-COMPLIANCE Some macros allow an object's syntax to be refined (e.g., the
and AGENT-CAPABILITIES macros allow an object's syntax to be SYNTAX clause in the MODULE-COMPLIANCE macro [2]). However,
refined. However, not all refinements of syntax are not all refinements of syntax are appropriate. In particular,
appropriate. In particular, the object's primitive or the object's primitive or application type must not be
application type must not be changed. changed.
Further, the following restrictions apply: Further, the following restrictions apply:
Restrictions to Refinement on Restrictions to Refinement on
object syntax range enumeration size repertoire object syntax range enumeration size repertoire
----------------- ----- ----------- ---- ---------- ----------------- ----- ----------- ---- ----------
INTEGER (1) (2) - - INTEGER (1) (2) - -
OCTET STRING - - (3) (4) OCTET STRING - - (3) (4)
OBJECT IDENTIFIER - - - - OBJECT IDENTIFIER - - - -
BIT STRING - (2) - - BIT STRING - (2) - -
IpAddress - - - - IpAddress - - - -
Counter32 - - - - Counter32 - - - -
Gauge32 (1) - - - Gauge32 (1) - - -
TimeTicks - - - - TimeTicks - - - -
Counter64 - - - - NsapAddress - - - -
NsapAddress - - - - Counter64 - - - -
where: where:
(1) the range of permitted values may be refined by raising (1) the range of permitted values may be refined by raising
the lower-bounds, by reducing the upper-bounds, and/or by the lower-bounds, by reducing the upper-bounds, and/or by
reducing the alternative value/range choices; reducing the alternative value/range choices;
(2) the enumeration of named-values may be refined by (2) the enumeration of named-values may be refined by
removing one or more named-values; removing one or more named-values;
(3) the size in characters of the value may be refined by (3) the size in characters of the value may be refined by
raising the lower-bounds, by reducing the upper-bounds, raising the lower-bounds, by reducing the upper-bounds,
and/or by reducing the alternative size choices; or, and/or by reducing the alternative size choices; or,
(4) the repertoire of characters in the value may be reduced (4) the repertoire of characters in the value may be reduced
by further sub-typing. by further sub-typing.
Otherwise no refinements are possible. Otherwise no refinements are possible.
Note that when refining an object with a SYNTAX clause value Note that when refining an object with a SYNTAX clause value
of Integer32, then the refined SYNTAX is expressed as an of Integer32 or UInteger32, the refined SYNTAX is expressed as
INTEGER and the restrictions of the table above are used. an INTEGER and the restrictions of the table above are used.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
12. Extending an Information Module 10. Extending an Information Module
As experience is gained with a published information module, As experience is gained with a published information module,
it may be desirable to revise that information module. it may be desirable to revise that information module.
12.1. Object Definitions To begin, the invocation of the MODULE-IDENTITY macro should
be updated to include information about the revision.
Usually, this consists of updating the LAST-UPDATED clause and
adding a pair of REVISION and DESCRIPTION clauses. However,
other existing clauses in the invocation may be updated.
Note that the module's label (e.g., "FIZBIN-MIB" from the
example in Section 5.8), is not changed when the information
module is revised.
10.1. Object Assignments
If any non-editorial change is made to any clause of a object
assignment, then the OBJECT IDENTIFIER value associated with
that object assignment must also be changed, along with its
associated descriptor.
10.2. Object Definitions
An object definition may be revised in any of the following An object definition may be revised in any of the following
ways: ways:
(1) Existing objects with a status of "current" may be (1) A SYNTAX clause containing an enumerated INTEGER may have
revised as "deprecated" or "obsolete". Similarly, new enumerations added or existing labels changed.
objects with a status of "deprecated" may be revised as
"obsolete".
(2) A DEFVAL clause may be added or updated. (2) A STATUS clause value of "current" may be revised as
"deprecated" or "obsolete". Similarly, a STATUS clause
value of "deprecated" may be revised as "obsolete".
(3) A REFERENCE clause may be added or updated. (3) A DEFVAL clause may be added or updated.
(4) A UNITS clause may be added. (4) A REFERENCE clause may be added or updated.
(5) A conceptual row may be augmented by adding new columnar (5) A UNITS clause may be added.
(6) A conceptual row may be augmented by adding new columnar
objects at the end of the row. objects at the end of the row.
(6) Entirely new objects may be defined, named with RFC 1442 SMI for SNMPv2 April 1993
(7) Entirely new objects may be defined, named with
previously unassigned OBJECT IDENTIFIER values. previously unassigned OBJECT IDENTIFIER values.
However, if the semantics of any previously defined object are Otherwise, if the semantics of any previously defined object
changed (i.e., if a non-editorial change is made to any clause are changed (i.e., if a non-editorial change is made to any
other those specifically allowed above), then the OBJECT clause other those specifically allowed above), then the
IDENTIFIER value associated with that object must also be OBJECT IDENTIFIER value associated with that object must also
changed. be changed.
Finally, note that changing the descriptor associated with an Note that changing the descriptor associated with an existing
existing object, is not considered a semantic change, as these object is considered a semantic change, as these strings may
strings are used solely for local use, and are not passed via be used in an IMPORTS statement.
the management protocol.
12.2. Trap Definitions Finally, note that if an object has the value of its STATUS
clause changed, then the value of its DESCRIPTION clause
should be updated accordingly.
A trap definition may be revised in any of the following ways: 10.3. Notification Definitions
Draft Structure of Management Information for SNMPv2 Oct 92 A notification definition may be revised in any of the
following ways:
(1) A REFERENCE clause may be added or updated. (1) A REFERENCE clause may be added or updated.
However, if the semantics of any previously defined trap are Otherwise, if the semantics of any previously defined
changed (i.e., if a non-editorial change is made to any clause notification are changed (i.e., if a non-editorial change is
other those specifically allowed above), then the OBJECT made to any clause other those specifically allowed above),
IDENTIFIER value associated with that trap must also be then the OBJECT IDENTIFIER value associated with that
changed. notification must also be changed.
Finally, note that changing the descriptor associated with an
existing trap, is not considered a semantic change, as these
strings are used solely for local use, and are not passed via
the management protocol.
12.3. Compliance Definitions
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.
12.4. Capabilities Definitions Note that changing the descriptor associated with an existing
notification is considered a semantic change, as these strings
may be used in an IMPORTS statement.
If any non-editorial change is made to any clause of a Finally, note that if an object has the value of its STATUS
capabilities definition, then the OBJECT IDENTIFIER value clause changed, then the value of its DESCRIPTION clause
associated with that capabilities definition must also be should be updated accordingly.
changed, along with its associated descriptor.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
13. Appendix: de-OSIfying a MIB module 11. Appendix: de-OSIfying a MIB module
There has been an increasing amount of work recently on taking There has been an increasing amount of work recently on taking
MIBs defined by other organizations (e.g., the IEEE) and de- MIBs defined by other organizations (e.g., the IEEE) and de-
osifying them for use with the Internet-standard network osifying them for use with the Internet-standard network
management framework. The steps to achieve this are management framework. The steps to achieve this are
straight-forward, though tedious. Of course, it is helpful to straight-forward, though tedious. Of course, it is helpful to
already be experienced in writing MIB modules for use with the already be experienced in writing MIB modules for use with the
Internet-standard network management framework. Internet-standard network management framework.
The first step is to construct a skeletal MIB module, as shown The first step is to construct a skeletal MIB module, as shown
earlier in Section 5.8. The next step is to categorize the earlier in Section 5.8. The next step is to categorize the
objects into groups. Optional objects are not permitted. objects into groups. Optional objects are not permitted.
Thus, when a MIB module is created, optional objects must be Thus, when a MIB module is created, optional objects must be
placed in a optional group, which, if implemented, all objects placed in a additional groups, which, if implemented, all
in the group must be implemented. For the first pass, it is objects in the group must be implemented. For the first pass,
wisest to simply ignore any optional objects in the original it is wisest to simply ignore any optional objects in the
MIB: experience shows it is better to define a core MIB module original MIB: experience shows it is better to define a core
first, containing only essential objects; later, if experience MIB module first, containing only essential objects; later, if
demands, other objects can be added. experience demands, other objects can be added.
13.1. Managed Object Mapping 11.1. Managed Object Mapping
Next for each managed object class, determine whether there Next for each managed object class, determine whether there
can exist multiple instances of that managed object class. If can exist multiple instances of that managed object class. If
not, then for each of its attributes, use the OBJECT-TYPE not, then for each of its attributes, use the OBJECT-TYPE
macro to make an equivalent definition. macro to make an equivalent definition.
Otherwise, if multiple instances of the managed object class Otherwise, if multiple instances of the managed object class
can exist, then define a conceptual table having conceptual can exist, then define a conceptual table having conceptual
rows each containing a columnar object for each of the managed rows each containing a columnar object for each of the managed
object class's attributes. If the managed object class is object class's attributes. If the managed object class is
skipping to change at page 62, line 4 skipping to change at page 44, line 4
required for each of the "distinguished attributes" of the required for each of the "distinguished attributes" of the
containing managed object class. If they do not already exist containing managed object class. If they do not already exist
within the MIB module, then they can be added via the within the MIB module, then they can be added via the
definition of additional columnar objects in the conceptual definition of additional columnar objects in the conceptual
row corresponding to the contained managed object class. row corresponding to the contained managed object class.
In defining a conceptual row, it is useful to consider the In defining a conceptual row, it is useful to consider the
optimization of network management operations which will act optimization of network management operations which will act
upon its columnar objects. In particular, it is wisest to upon its columnar objects. In particular, it is wisest to
avoid defining more columnar objects within a conceptual row, avoid defining more columnar objects within a conceptual row,
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
than can fit in a single PDU. As a rule of thumb, a than can fit in a single PDU. As a rule of thumb, a
conceptual row should contain no more than approximately 20 conceptual row should contain no more than approximately 20
objects. Similarly, or as a way to abide by the "20 object objects. Similarly, or as a way to abide by the "20 object
guideline", columnar objects should be grouped into tables guideline", columnar objects should be grouped into tables
according to the expected grouping of network management according to the expected grouping of network management
operations upon them. As such, the content of conceptual rows operations upon them. As such, the content of conceptual rows
should reflect typical access scenarios, e.g., they should be should reflect typical access scenarios, e.g., they should be
organized along functional lines such as one row for organized along functional lines such as one row for
statistics and another row for parameters, or along usage statistics and another row for parameters, or along usage
skipping to change at page 62, line 26 skipping to change at page 44, line 26
objects. objects.
On the other hand, the definition of conceptual rows where the On the other hand, the definition of conceptual rows where the
number of columnar objects used as indexes outnumbers the number of columnar objects used as indexes outnumbers the
number used to hold information, should also be avoided. In number used to hold information, should also be avoided. In
particular, the splitting of a managed object class's particular, the splitting of a managed object class's
attributes into many conceptual tables should not be used as a attributes into many conceptual tables should not be used as a
way to obtain the same degree of flexibility/complexity as is way to obtain the same degree of flexibility/complexity as is
often found in MIBs with a myriad of optionals. often found in MIBs with a myriad of optionals.
13.1.1. Mapping to the SYNTAX clause 11.1.1. Mapping to the SYNTAX clause
When mapping to the SYNTAX clause of the OBJECT-type macro: When mapping to the SYNTAX clause of the OBJECT-type macro:
(1) An object with BOOLEAN syntax becomes a TruthValue [4]. | (1) An object with BOOLEAN syntax becomes a TruthValue [3].
(2) An object with INTEGER syntax becomes an Integer32. (2) An object with INTEGER syntax becomes an Integer32.
(3) An object with ENUMERATED syntax becomes an INTEGER with (3) An object with ENUMERATED syntax becomes an INTEGER with
enumerations, taking any of the values given which can be enumerations, taking any of the values given which can be
represented with an Integer32. represented with an Integer32.
(4) An object with BIT STRING syntax but no enumerations (4) An object with BIT STRING syntax but no enumerations
becomes an OCTET STRING. becomes an OCTET STRING.
(5) An object with a character string syntax becomes either (5) An object with a character string syntax becomes either
an OCTET STRING, or a DisplayString [4], | an OCTET STRING, or a DisplayString [3], depending on the
depending on the repertoire of the character string. repertoire of the character string.
(6) A non-tabular object with a complex syntax, such as REAL (6) A non-tabular object with a complex syntax, such as REAL
or EXTERNAL, must be decomposed, usually into an OCTET or EXTERNAL, must be decomposed, usually into an OCTET
STRING (if sensible). As a rule, any object with a STRING (if sensible). As a rule, any object with a
complicated syntax should be avoided. complicated syntax should be avoided.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
(7) Tabular objects must be decomposed into rows of columnar (7) Tabular objects must be decomposed into rows of columnar
objects. objects.
13.1.2. Mapping to the UNITS clause 11.1.2. Mapping to the UNITS clause
If the description of this managed object defines a unit- If the description of this managed object defines a unit-
basis, then mapping to this clause is straight-forward. basis, then mapping to this clause is straight-forward.
13.1.3. Mapping to the MAX-ACCESS clause 11.1.3. Mapping to the MAX-ACCESS clause
This is straight-forward. This is straight-forward.
13.1.4. Mapping to the STATUS clause 11.1.4. Mapping to the STATUS clause
This is straight-forward. This is straight-forward.
13.1.5. Mapping to the DESCRIPTION clause 11.1.5. Mapping to the DESCRIPTION clause
This is straight-forward: simply copy the text, making sure This is straight-forward: simply copy the text, making sure
that any embedded double quotation marks are sanitized (i.e., that any embedded double quotation marks are sanitized (i.e.,
replaced with single-quotes or removed). replaced with single-quotes or removed).
13.1.6. Mapping to the REFERENCE clause 11.1.6. Mapping to the REFERENCE clause
This is straight-forward: simply include a textual reference This is straight-forward: simply include a textual reference
to the object being mapped, the document which defines the to the object being mapped, the document which defines the
object, and perhaps a page number in the document. object, and perhaps a page number in the document.
13.1.7. Mapping to the INDEX clause 11.1.7. Mapping to the INDEX clause
If necessary, decide how instance-identifiers for columnar If necessary, decide how instance-identifiers for columnar
objects are to be formed and define this clause accordingly. objects are to be formed and define this clause accordingly.
13.1.8. Mapping to the DEFVAL clause 11.1.8. Mapping to the DEFVAL clause
Decide if a meaningful default value can be assigned to the Decide if a meaningful default value can be assigned to the
object being mapped, and if so, define the DEFVAL clause object being mapped, and if so, define the DEFVAL clause
accordingly. accordingly.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
13.2. Action Mapping 11.2. Action Mapping
Actions are modeled as read-write objects, in which writing a Actions are modeled as read-write objects, in which writing a
particular value results in a state change. (Usually, as a particular value results in a state change. (Usually, as a
part of this state change, some action might take place.) part of this state change, some action might take place.)
13.2.1. Mapping to the SYNTAX clause 11.2.1. Mapping to the SYNTAX clause
Usually the Integer32 syntax is used with a distinguished Usually the Integer32 syntax is used with a distinguished
value provided for each action that the object provides access value provided for each action that the object provides access
to. In addition, there is usually one other distinguished to. In addition, there is usually one other distinguished
value, which is the one returned when the object is read. value, which is the one returned when the object is read.
13.2.2. Mapping to the MAX-ACCESS clause 11.2.2. Mapping to the MAX-ACCESS clause
Always use read-write or read-create. Always use read-write or read-create.
13.2.3. Mapping to the STATUS clause 11.2.3. Mapping to the STATUS clause
This is straight-forward. This is straight-forward.
13.2.4. Mapping to the DESCRIPTION clause 11.2.4. Mapping to the DESCRIPTION clause
This is straight-forward: simply copy the text, making sure This is straight-forward: simply copy the text, making sure
that any embedded double quotation marks are sanitized (i.e., that any embedded double quotation marks are sanitized (i.e.,
replaced with single-quotes or removed). replaced with single-quotes or removed).
13.2.5. Mapping to the REFERENCE clause 11.2.5. Mapping to the REFERENCE clause
This is straight-forward: simply include a textual reference This is straight-forward: simply include a textual reference
to the action being mapped, the document which defines the to the action being mapped, the document which defines the
action, and perhaps a page number in the document. action, and perhaps a page number in the document.
13.3. Event Mapping 11.3. Event Mapping
Events are modeled as SNMPv2 traps using NOTIFICATION-TYPE | Events are modeled as SNMPv2 notifications using
macro. | NOTIFICATION-TYPE macro. However, recall that SNMPv2
However, recall that SNMPv2 emphasizes trap-directed polling. emphasizes trap-directed polling. As such, few, and usually
As such, few, and usually no, traps, need be defined for any no, notifications, need be defined for any MIB module.
Draft Structure of Management Information for SNMPv2 Oct 92
MIB module. RFC 1442 SMI for SNMPv2 April 1993
13.3.1. Mapping to the STATUS clause 11.3.1. Mapping to the STATUS clause
This is straight-forward. This is straight-forward.
13.3.2. Mapping to the DESCRIPTION clause 11.3.2. Mapping to the DESCRIPTION clause
This is straight-forward: simply copy the text, making sure This is straight-forward: simply copy the text, making sure
that any embedded double quotation marks are sanitized (i.e., that any embedded double quotation marks are sanitized (i.e.,
replaced with single-quotes or removed). replaced with single-quotes or removed).
13.3.3. Mapping to the REFERENCE clause 11.3.3. Mapping to the REFERENCE clause
This is straight-forward: simply include a textual reference | This is straight-forward: simply include a textual reference
to the notification being mapped, the document which defines | to the notification being mapped, the document which defines
the notification, | the notification, and perhaps a page number in the document.
and perhaps a page number in the document.
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
14. Acknowledgements 12. Acknowledgements
The section on object definitions (and MIB de-osification) is The section on object definitions (and MIB de-osification) is
based, in part, on RFCs 1155 and 1212. The IMPLIED keyword is based, in part, on RFCs 1155 and 1212. The IMPLIED keyword is
based on a conversation with David T. Perkins in December, based on a conversation with David T. Perkins in December,
1991. 1991.
The section on trap definitions is based, in part, on RFC The section on trap definitions is based, in part, on RFC
1215. 1215.
The section on compliance definitions is based, in part, on a Finally, the comments of the SNMP version 2 working group are
conversation with James R. Davin in December, 1990.
The section on capabilities definitions is based, in part, on
RFC 1303.
Finally, the comments of the SNMP Version 2 working group are
gratefully acknowledged: gratefully acknowledged:
Steve Alexander, Interactive Systems Beth Adams, Network Management Forum
Uri Blumenthal, International Business Machines Steve Alexander, INTERACTIVE Systems Corporation
Jeffrey D. Case, SNMP Research, Inc. David Arneson, Cabletron Systems
Toshiya Asaba
Fred Baker, ACC
Jim Barnes, Xylogics, Inc.
Brian Bataille
Andy Bierman, SynOptics Communications, Inc.
Uri Blumenthal, IBM Corporation
Fred Bohle, Interlink
Jack Brown
Theodore Brunner, Bellcore
Stephen F. Bush, GE Information Services
Jeffrey D. Case, University of Tennessee, Knoxville
John Chang, IBM Corporation
Szusin Chen, Sun Microsystems
Robert Ching
Chris Chiotasso, Ungermann-Bass
Bobby A. Clay, NASA/Boeing
John Cooke, Chipcom
Tracy Cox, Bellcore Tracy Cox, Bellcore
Juan Cruz, Datability, Inc.
David Cullerot, Cabletron Systems
Cathy Cunningham, Microcom
James R. (Chuck) Davin, Bellcore James R. (Chuck) Davin, Bellcore
Michael Davis, Clearpoint
Mike Davison, FiberCom Mike Davison, FiberCom
Cynthia DellaTorre, MITRE
Taso N. Devetzis, Bellcore Taso N. Devetzis, Bellcore
Manual Diaz, DAVID Systems, Inc.
Jon Dreyer, Sun Microsystems
David Engel, Optical Data Systems
RFC 1442 SMI for SNMPv2 April 1993
Mike Erlinger, Lexcel
Roger Fajman, NIH
Daniel Fauvarque, Sun Microsystems
Karen Frisa, CMU
Shari Galitzer, MITRE
Shawn Gallagher, Digital Equipment Corporation
Richard Graveman, Bellcore
Maria Greene, Xyplex, Inc.
Michel Guittet, Apple
Robert Gutierrez, NASA
Bill Hagerty, Cabletron Systems
Gary W. Haney, Martin Marietta Energy Systems Gary W. Haney, Martin Marietta Energy Systems
Patrick Hanil, Nokia Telecommunications
Matt Hecht, SNMP Research, Inc. Matt Hecht, SNMP Research, Inc.
Edward A. Heiner, Jr., Synernetics Inc.
Susan E. Hicks, Martin Marietta Energy Systems Susan E. Hicks, Martin Marietta Energy Systems
Satish Joshi, SynOptics Geral Holzhauer, Apple
John Hopprich, DAVID Systems, Inc.
Jeff Hughes, Hewlett-Packard
Robin Iddon, Axon Networks, Inc.
David Itusak
Kevin M. Jackson, Concord Communications, Inc.
Ole J. Jacobsen, Interop Company
Ronald Jacoby, Silicon Graphics, Inc.
Satish Joshi, SynOptics Communications, Inc.
Frank Kastenholz, FTP Software
Mark Kepke, Hewlett-Packard Mark Kepke, Hewlett-Packard
Ken Key, SNMP Research, Inc. Ken Key, SNMP Research, Inc.
Michael Kornegay, Visisoft Zbiginew Kielczewski, Eicon
Deidre C. Kostick, Bellcore Jongyeoi Kim
Andrew Knutsen, The Santa Cruz Operation
Michael L. Kornegay, VisiSoft
Deirdre C. Kostik, Bellcore
Cheryl Krupczak, Georgia Tech Cheryl Krupczak, Georgia Tech
Robert C. Lushbaugh, Martin Marietta Energy Systems Mark S. Lewis, Telebit
David Lin
David Lindemulder, AT&T/NCR
Ben Lisowski, Sprint
David Liu, Bell-Northern Research
John Lunny, The Wollongong Group
Robert C. Lushbaugh Martin, Marietta Energy Systems
Michael Luufer, BBN
Carl Madison, Star-Tek, Inc.
Keith McCloghrie, Hughes LAN Systems Keith McCloghrie, Hughes LAN Systems
Evan McGinnis, 3Com Corporation
RFC 1442 SMI for SNMPv2 April 1993
Bill McKenzie, IBM Corporation
Donna McMaster, SynOptics Communications, Inc.
John Medicke, IBM Corporation
Doug Miller, Telebit
Dave Minnich, FiberCom Dave Minnich, FiberCom
Dave Perkins, SynOptics Mohammad Mirhakkak, MITRE
Rohit Mital, Protools
George Mouradian, AT&T Bell Labs
Patrick Mullaney, Cabletron Systems
Dan Myers, 3Com Corporation
Rina Nathaniel, Rad Network Devices Ltd.
Hien V. Nguyen, Sprint
Mo Nikain
Tom Nisbet
William B. Norton, MERIT
Steve Onishi, Wellfleet Communications, Inc.
David T. Perkins, SynOptics Communications, Inc.
Carl Powell, BBN
Ilan Raab, SynOptics Communications, Inc.
Richard Ramons, AT&T
Venkat D. Rangan, Metric Network Systems, Inc.
Louise Reingold, Sprint
Sam Roberts, Farallon Computing, Inc.
Kary Robertson, Concord Communications, Inc.
Dan Romascanu, Lannet Data Communications Ltd.
Marshall T. Rose, Dover Beach Consulting, Inc. Marshall T. Rose, Dover Beach Consulting, Inc.
Shawn A. Routhier, Epilogue Technology Shawn A. Routhier, Epilogue Technology Corporation
Chris Rozman
Asaf Rubissa, Fibronics
Jon Saperia, Digital Equipment Corporation Jon Saperia, Digital Equipment Corporation
Bob Stewart, Xyplex (chair) Michael Sapich
Robert Synder, Cisco Systems Mike Scanlon, Interlan
Maurice Turcotte, Racal Datacom Sam Schaen, MITRE
John Seligson, Ultra Network Technologies
Paul A. Serice, Corporation for Open Systems
Chris Shaw, Banyan Systems
Timon Sloane
Robert Snyder, Cisco Systems
Joo Young Song
Roy Spitier, Sprint
Einar Stefferud, Network Management Associates
John Stephens, Cayman Systems, Inc.
Robert L. Stewart, Xyplex, Inc. (chair)
Kaj Tesink, Bellcore
Dean Throop, Data General
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
Steven L. Waldbusser, Carnegie Mellon University Ahmet Tuncay, France Telecom-CNET
Bert Wijnen, International Business Machines Maurice Turcotte, Racal Datacom
Peter Wilson, 3Com Warren Vik, INTERACTIVE Systems Corporation
Yannis Viniotis
Steven L. Waldbusser, Carnegie Mellon Universitty
Timothy M. Walden, ACC
Alice Wang, Sun Microsystems
James Watt, Newbridge
Luanne Waul, Timeplex
Donald E. Westlake III, Digital Equipment Corporation
Gerry White
Bert Wijnen, IBM Corporation
Peter Wilson, 3Com Corporation
Steven Wong, Digital Equipment Corporation Steven Wong, Digital Equipment Corporation
Randy Worzella, IBM Corporation
Daniel Woycke, MITRE
Honda Wu
Jeff Yarnell, Protools
Chris Young, Cabletron Chris Young, Cabletron
Kiho Yum, 3Com Kiho Yum, 3Com Corporation
Draft Structure of Management Information for SNMPv2 Oct 92 RFC 1442 SMI for SNMPv2 April 1993
15. References 13. References
[1] Information processing systems - Open Systems [1] Information processing systems - Open Systems
Interconnection - Specification of Abstract Syntax Interconnection - Specification of Abstract Syntax
Notation One (ASN.1), International Organization for Notation One (ASN.1), International Organization for
Standardization. International Standard 8824, (December, Standardization. International Standard 8824, (December,
1987). 1987).
[2] K. McCloghrie and M.T. Rose, Management Information Base [2] Case, J., McCloghrie, K., Rose, M., and Waldbusser, S.,
for Network Management of TCP/IP-based internets: MIB-II. "Conformance Statements for version 2 of the the Simple
Request for Comments 1213, (March, 1991). Network Management Protocol (SNMPv2)", RFC 1444, SNMP
Research, Inc., Hughes LAN Systems, Dover Beach
Consulting, Inc., Carnegie Mellon University, April 1993.
[3] J.D. Case, K. McCloghrie, M.T. Rose, S.L. Waldbusser, [3] Case, J., McCloghrie, K., Rose, M., and Waldbusser, S.,
Management Information Base for version 2 of the Simple "Textual Conventions for version 2 of the the Simple
Network Management Protocol, Internet-Draft, (October 7, Network Management Protocol (SNMPv2)", RFC 1443, SNMP
1992). Research, Inc., Hughes LAN Systems, Dover Beach
Consulting, Inc., Carnegie Mellon University, April 1993.
[4] - [4] Information processing systems - Open Systems
J.D. Case, K. McCloghrie, M.T. Rose, S.L. Waldbusser, Interconnection - Specification of Basic Encoding Rules
Textual Conventions for version 2 of the the Simple for Abstract Syntax Notation One (ASN.1), International
Network Management Protocol (SNMPv2), Internet-Draft, Organization for Standardization. International Standard
(October 7, 1992). 8825, (December, 1987).
[5] Information processing systems - Open Systems + [5] Case, J., McCloghrie, K., Rose, M., and Waldbusser, S.,
Interconnection - Specification of Basic Encoding Rules + "Management Information Base for version 2 of the Simple
for Abstract Syntax Notation One (ASN.1), International + Network Management Protocol (SNMPv2)", RFC 1450, SNMP
Organization for Standardization. International Standard + Research, Inc., Hughes LAN Systems, Dover Beach
8825, (December, 1987). + Consulting, Inc., Carnegie Mellon University, April 1993.
[6] J.D. Case, K. McCloghrie, M.T. Rose, S.L. Waldbusser, [6] Case, J., McCloghrie, K., Rose, M., and Waldbusser, S.,
Protocol Operations for version 2 of the Simple Network "Protocol Operations for version 2 of the Simple Network
Management Protocol (SNMPv2), Internet-Draft, (October 7, Management Protocol (SNMPv2)", RFC 1448, SNMP Research,
1992). Inc., Hughes LAN Systems, Dover Beach Consulting, Inc.,
Carnegie Mellon University, April 1993.
[7] M.T. Rose and K. McCloghrie, Structure and Identification [7] McCloghrie, K., and Rose, M., "Management Information
of Management Information for TCP/IP-based internets. Base for Network Management of TCP/IP-based internets:
Request for Comments 1155, (May, 1990). MIB-II", STD 17, RFC 1213, March 1991.
[8] M.T. Rose and K. McCloghrie, Concise MIB Definitions. [8] McCloghrie, K., and Galvin, J., "Party MIB for version 2
Request for Comments 1212, (March, 1991). of the Simple Network Management Protocol (SNMPv2)", RFC
1447, Hughes LAN Systems, Trusted Information Systems,
[9] K. McCloghrie, J.R. Davin, J.M. Galvin, Definitions of RFC 1442 SMI for SNMPv2 April 1993
Managed Objects for Administration of SNMP Parties.
Request for Comments 1353, (July, 1992).
Draft Structure of Management Information for SNMPv2 Oct 92 April 1993.
Table of Contents RFC 1442 SMI for SNMPv2 April 1993
1 Status of this Memo ................................... 1 14. Security Considerations
2 Introduction .......................................... 2
2.1 A Note on Terminology ............................... 3
3 Definitions ........................................... 4
3.1 The MODULE-IDENTITY macro ........................... 5
3.2 The OBJECT-TYPE macro ............................... 6
3.3 Object Names and Syntaxes ........................... 8
3.4 The OBJECT-GROUP macro .............................. 11
3.5 The NOTIFICATION-TYPE macro ......................... 12
3.6 The MODULE-COMPLIANCE macro ......................... 13
3.7 The AGENT-CAPABILITIES macro ........................ 16
4 Information Modules ................................... 19
4.1 Macro Invocation .................................... 19
4.1.1 Textual Clauses ................................... 20
4.2 IMPORTing Symbols ................................... 20
5 Mapping of the MODULE-IDENTITY macro .................. 22
5.1 Mapping of the LAST-UPDATED clause .................. 22
5.2 Mapping of the ORGANIZATION clause .................. 22
5.3 Mapping of the CONTACT-INFO clause .................. 22
5.4 Mapping of the DESCRIPTION clause ................... 22
5.5 Mapping of the REVISION clause ...................... 22
5.6 Mapping of the DESCRIPTION clause ................... 23
5.7 Mapping of the MODULE-IDENTITY value ................ 23
5.8 Usage Example ....................................... 24
6 Mapping of the OBJECT-TYPE macro ...................... 25
6.1 Mapping of the SYNTAX clause ........................ 25
6.1.1 Integer32 and INTEGER ............................. 25
6.1.2 OCTET STRING ...................................... 25
6.1.3 OBJECT IDENTIFIER ................................. 26
6.1.4 BIT STRING ........................................ 26
6.1.5 IpAddress ......................................... 26
6.1.6 Counter32 ......................................... 26
6.1.7 Gauge32 ........................................... 27
6.1.8 TimeTicks ......................................... 27
6.1.9 Opaque ............................................ 27
6.1.10 Counter64 ........................................ 28
6.1.11 NsapAddress ...................................... 28
6.2 Mapping of the UNITS clause ......................... 29
6.3 Mapping of the MAX-ACCESS clause .................... 29
6.4 Mapping of the STATUS clause ........................ 29
6.5 Mapping of the DESCRIPTION clause ................... 29
6.6 Mapping of the REFERENCE clause ..................... 30
Draft Structure of Management Information for SNMPv2 Oct 92
6.7 Mapping of the INDEX clause ......................... 30 Security issues are not discussed in this memo.
6.7.1 Creation and Deletion of Conceptual Rows .......... 32
6.8 Mapping of the AUGMENTS clause ...................... 33
6.9 Mapping of the DEFVAL clause ........................ 33
6.10 Mapping of the OBJECT-TYPE value ................... 34
6.10.1 Naming Hierarchy ................................. 35
6.11 Usage Example ...................................... 37
7 Mapping of the OBJECT-GROUP macro ..................... 39
7.1 Mapping of the OBJECTS clause ....................... 39
7.2 Mapping of the STATUS clause ........................ 39
7.3 Mapping of the DESCRIPTION clause ................... 40
7.4 Mapping of the REFERENCE clause ..................... 40
7.5 Mapping of the OBJECT-GROUP value ................... 40
7.6 Usage Example ....................................... 41
8 Mapping of the NOTIFICATION-TYPE macro ................ 42
8.1 Mapping of the OBJECTS clause ....................... 42
8.2 Mapping of the STATUS clause ........................ 42
8.3 Mapping of the DESCRIPTION clause ................... 42
8.4 Mapping of the REFERENCE clause ..................... 43
8.5 Mapping of the NOTIFICATION-TYPE value .............. 43
8.6 Usage Example ....................................... 44
9 Mapping of the MODULE-COMPLIANCE macro ................ 45
9.1 Mapping of the STATUS clause ........................ 45
9.2 Mapping of the DESCRIPTION clause ................... 45
9.3 Mapping of the REFERENCE clause ..................... 45
9.4 Mapping of the MODULE clause ........................ 45
9.4.1 Mapping of the MANDATORY-GROUPS clause ............ 46
9.4.2 Mapping of the GROUP clause ....................... 46
9.4.3 Mapping of the OBJECT clause ...................... 46
9.4.3.1 Mapping of the SYNTAX clause .................... 47
9.4.3.2 Mapping of the WRITE-SYNTAX clause .............. 47
9.4.3.3 Mapping of the MIN-ACCESS clause ................ 47
9.4.3.4 Mapping of the DESCRIPTION clause ............... 48
9.5 Mapping of the MODULE-COMPLIANCE value .............. 48
9.6 Usage Example ....................................... 49
10 Mapping of the AGENT-CAPABILITIES macro .............. 51
10.1 Mapping of the PRODUCT-RELEASE clause .............. 52
10.2 Mapping of the STATUS clause ....................... 52
10.3 Mapping of the DESCRIPTION clause .................. 52
10.4 Mapping of the REFERENCE clause .................... 52
10.5 Mapping of the SUPPORTS clause ..................... 52
10.5.1 Mapping of the INCLUDES clause ................... 53
10.5.2 Mapping of the VARIATION clause .................. 53
10.5.2.1 Mapping of the SYNTAX clause ................... 53
10.5.2.2 Mapping of the WRITE-SYNTAX clause ............. 53
Draft Structure of Management Information for SNMPv2 Oct 92
10.5.2.3 Mapping of the ACCESS clause ................... 54 15. Authors' Addresses
10.5.2.4 Mapping of the CREATION-REQUIRES clause ........ 54
10.5.2.5 Mapping of the DEFVAL clause ................... 55 Jeffrey D. Case
10.5.2.6 Mapping of the DESCRIPTION clause .............. 55 SNMP Research, Inc.
10.6 Mapping of the AGENT-CAPABILITIES value ............ 55 3001 Kimberlin Heights Rd.
10.7 Usage Example ...................................... 56 Knoxville, TN 37920-9716
11 Refined Syntax ....................................... 58 US
12 Extending an Information Module ...................... 59
12.1 Object Definitions ................................. 59 Phone: +1 615 573 1434
12.2 Trap Definitions ................................... 59 Email: case@snmp.com
12.3 Compliance Definitions ............................. 60
12.4 Capabilities Definitions ........................... 60 Keith McCloghrie
13 Appendix: de-OSIfying a MIB module ................... 61 Hughes LAN Systems
13.1 Managed Object Mapping ............................. 61 1225 Charleston Road
13.1.1 Mapping to the SYNTAX clause ..................... 62 Mountain View, CA 94043
13.1.2 Mapping to the UNITS clause ...................... 63 US
13.1.3 Mapping to the MAX-ACCESS clause ................. 63
13.1.4 Mapping to the STATUS clause ..................... 63 Phone: +1 415 966 7934
13.1.5 Mapping to the DESCRIPTION clause ................ 63 Email: kzm@hls.com
13.1.6 Mapping to the REFERENCE clause .................. 63
13.1.7 Mapping to the INDEX clause ...................... 63 Marshall T. Rose
13.1.8 Mapping to the DEFVAL clause ..................... 63 Dover Beach Consulting, Inc.
13.2 Action Mapping ..................................... 64 420 Whisman Court
13.2.1 Mapping to the SYNTAX clause ..................... 64 Mountain View, CA 94043-2186
13.2.2 Mapping to the MAX-ACCESS clause ................. 64 US
13.2.3 Mapping to the STATUS clause ..................... 64
13.2.4 Mapping to the DESCRIPTION clause ................ 64 Phone: +1 415 968 1052
13.2.5 Mapping to the REFERENCE clause .................. 64 Email: mrose@dbc.mtview.ca.us
13.3 Event Mapping ...................................... 64
13.3.1 Mapping to the STATUS clause ..................... 65 Steven Waldbusser
13.3.2 Mapping to the DESCRIPTION clause ................ 65 Carnegie Mellon University
13.3.3 Mapping to the REFERENCE clause .................. 65 4910 Forbes Ave
14 Acknowledgements ..................................... 66 Pittsburgh, PA 15213
15 References ........................................... 68 US
Phone: +1 412 268 6628
Email: waldbusser@cmu.edu
 End of changes. 259 change blocks. 
1481 lines changed or deleted 892 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/