As per Relevance of the word conformance, we have this rfc below:
Network Working Group Editors of this version
Request for Comments: 2580 K.
STD: 58 Cisco
Obsoletes: 1904 D.
Category: Standards Track
J.
TU
Authors of previous version
J.
SNMP
K.
Cisco
M.
First Virtual
S.
International Network
April 1999
Conformance Statements for SMIv
Status of this
This document specifies an Internet standards track protocol for
Internet community, and requests discussion and suggestions
improvements. Please refer to the current edition of the "
Official Protocol Standards" (STD 1) for the standardization
and status of this protocol. Distribution of this memo is unlimited
Copyright
Copyright (C) The Internet Society (1999). All Rights Reserved
Table of
1 Introduction .....................................................3
1.1 A Note on Terminology ..........................................3
2 Definitions ......................................................3
2.1 The OBJECT-GROUP macro .........................................3
2.2 The NOTIFICATION-GROUP macro ...................................4
2.3 The MODULE-COMPLIANCE macro ....................................5
2.4 The AGENT-CAPABILITIES macro ...................................7
3 Mapping of the OBJECT-GROUP macro ...............................10
3.1 Mapping of the OBJECTS clause .................................10
3.2 Mapping of the STATUS clause ..................................11
3.3 Mapping of the DESCRIPTION clause .............................11
3.4 Mapping of the REFERENCE clause ...............................11
McCloghrie, et al. Standards Track [Page 1]
RFC 2580 Conformance Statements for SMIv2 April 1999
3.5 Mapping of the OBJECT-GROUP value .............................11
3.6 Usage Example .................................................12
4 Mapping of the NOTIFICATION-GROUP macro .........................12
4.1 Mapping of the NOTIFICATIONS clause ...........................12
4.2 Mapping of the STATUS clause ..................................13
4.3 Mapping of the DESCRIPTION clause .............................13
4.4 Mapping of the REFERENCE clause ...............................13
4.5 Mapping of the NOTIFICATION-GROUP value .......................13
4.6 Usage Example .................................................13
5 Mapping of the MODULE-COMPLIANCE macro ..........................14
5.1 Mapping of the STATUS clause ..................................14
5.2 Mapping of the DESCRIPTION clause .............................14
5.3 Mapping of the REFERENCE clause ...............................15
5.4 Mapping of the MODULE clause ..................................15
5.4.1 Mapping of the MANDATORY-GROUPS clause ......................15
5.4.2 Mapping of the GROUP clause .................................15
5.4.3 Mapping of the OBJECT clause ................................16
5.4.3.1 Mapping of the SYNTAX clause ..............................16
5.4.3.2 Mapping of the WRITE-SYNTAX clause ........................16
5.4.3.3 Mapping of the MIN-ACCESS clause ..........................16
5.4.4 Mapping of the DESCRIPTION clause ...........................17
5.5 Mapping of the MODULE-COMPLIANCE value ........................17
5.6 Usage Example .................................................17
6 Mapping of the AGENT-CAPABILITIES macro .........................19
6.1 Mapping of the PRODUCT-RELEASE clause .........................19
6.2 Mapping of the STATUS clause ..................................19
6.3 Mapping of the DESCRIPTION clause .............................20
6.4 Mapping of the REFERENCE clause ...............................20
6.5 Mapping of the SUPPORTS clause ................................20
6.5.1 Mapping of the INCLUDES clause ..............................20
6.5.2 Mapping of the VARIATION clause .............................20
6.5.2.1 Mapping of the SYNTAX clause ..............................21
6.5.2.2 Mapping of the WRITE-SYNTAX clause ........................21
6.5.2.3 Mapping of the ACCESS clause ..............................21
6.5.2.4 Mapping of the CREATION-REQUIRES clause ...................22
6.5.2.5 Mapping of the DEFVAL clause ..............................22
6.5.2.6 Mapping of the DESCRIPTION clause .........................22
6.6 Mapping of the AGENT-CAPABILITIES value .......................22
6.7 Usage Example .................................................23
7 Extending an Information Module .................................25
7.1 Conformance Groups ............................................25
7.2 Compliance Definitions ........................................26
7.3 Capabilities Definitions ......................................26
8 Security Considerations .........................................27
9 Editors' Addresses ..............................................27
10 References .....................................................28
11 Full Copyright Statement .......................................29
McCloghrie, et al. Standards Track [Page 2]
RFC 2580 Conformance Statements for SMIv2 April 1999
1.
Management information is viewed as a collection of managed objects
residing in a virtual information store, termed the
Information Base (MIB). Collections of related objects are
in MIB modules. These modules are written using an adapted subset
OSI's Abstract Syntax Notation One, ASN.1 (1988) [1], termed
Structure of Management Information (SMI) [2].
It may be useful to define the acceptable lower-bounds
implementation, along with the actual level of
achieved. It is the purpose of this document to define the
used for these purposes
1.1. A Note on
For the purpose of exposition, the original Structure of
Information, as described in RFCs 1156 (STD 16), 1212 (STD 16),
RFC 1215, is termed the SMI version 1 (SMIv1). The current
of the Structure of Management Information is termed SMI version 2
(SMIv2).
2.
SNMPv2-CONF DEFINITIONS ::=
IMPORTS ObjectName, NotificationName,
FROM SNMPv2-SMI
-- definitions for conformance
OBJECT-GROUP MACRO ::=
TYPE NOTATION ::=
"STATUS"
"DESCRIPTION"
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER
ObjectsPart ::=
"OBJECTS" "{" Objects "}"
Objects ::=
| Objects ","
Object ::=
McCloghrie, et al. Standards Track [Page 3]
RFC 2580 Conformance Statements for SMIv2 April 1999
value(ObjectName
Status ::=
"current
| "deprecated
| "obsolete
ReferPart ::=
"REFERENCE"
|
-- a character string as defined in [2]
Text ::= value(IA5String
-- more definitions for conformance
NOTIFICATION-GROUP MACRO ::=
TYPE NOTATION ::=
"STATUS"
"DESCRIPTION"
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER
NotificationsPart ::=
"NOTIFICATIONS" "{" Notifications "}"
Notifications ::=
| Notifications ","
Notification ::=
value(NotificationName
Status ::=
"current
| "deprecated
| "obsolete
ReferPart ::=
"REFERENCE"
|
-- a character string as defined in [2]
Text ::= value(IA5String
McCloghrie, et al. Standards Track [Page 4]
RFC 2580 Conformance Statements for SMIv2 April 1999
-- definitions for compliance
MODULE-COMPLIANCE MACRO ::=
TYPE NOTATION ::=
"STATUS"
"DESCRIPTION"
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER
Status ::=
"current
| "deprecated
| "obsolete
ReferPart ::=
"REFERENCE"
|
ModulePart ::=
Modules ::=
| Modules
Module ::=
-- name of module --
"MODULE"
ModuleName ::=
-- identifier must start with uppercase
identifier
-- must not be empty unless
-- in MIB
|
ModuleIdentifier ::=
value(OBJECT IDENTIFIER
|
MandatoryPart ::=
"MANDATORY-GROUPS" "{" Groups "}"
|
Groups ::=
McCloghrie, et al. Standards Track [Page 5]
RFC 2580 Conformance Statements for SMIv2 April 1999
| Groups ","
Group ::=
value(OBJECT IDENTIFIER
CompliancePart ::=
|
Compliances ::=
| Compliances
Compliance ::=
|
ComplianceGroup ::=
"GROUP" value(OBJECT IDENTIFIER
"DESCRIPTION"
Object ::=
"OBJECT" value(ObjectName
"DESCRIPTION"
-- must be a refinement for object's SYNTAX
SyntaxPart ::= "SYNTAX"
|
-- must be a refinement for object's SYNTAX
WriteSyntaxPart ::= "WRITE-SYNTAX"
|
Syntax ::= -- Must be one of the following
-- a base type (or its refinement),
-- a textual convention (or its refinement),
-- a BITS pseudo-
| "BITS" "{" NamedBits "}"
NamedBits ::=
| NamedBits ","
NamedBit ::= identifier "(" number ")" -- number is
AccessPart ::=
McCloghrie, et al. Standards Track [Page 6]
RFC 2580 Conformance Statements for SMIv2 April 1999
"MIN-ACCESS"
|
Access ::=
"not-accessible
| "accessible-for-notify
| "read-only
| "read-write
| "read-create
-- a character string as defined in [2]
Text ::= value(IA5String
-- definitions for capabilities
AGENT-CAPABILITIES MACRO ::=
TYPE NOTATION ::=
"PRODUCT-RELEASE"
"STATUS"
"DESCRIPTION"
VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER
Status ::=
"current
| "obsolete
ReferPart ::=
"REFERENCE"
|
ModulePart ::=
|
Modules ::=
| Modules
Module ::=
-- name of module --
"SUPPORTS"
"INCLUDES" "{" Groups "}"
ModuleName ::=
McCloghrie, et al. Standards Track [Page 7]
RFC 2580 Conformance Statements for SMIv2 April 1999
-- identifier must start with uppercase
identifier
ModuleIdentifier ::=
value(OBJECT IDENTIFIER
|
Groups ::=
| Groups ","
Group ::=
value(OBJECT IDENTIFIER
VariationPart ::=
|
Variations ::=
| Variations
Variation ::=
|
NotificationVariation ::=
"VARIATION" value(NotificationName
"DESCRIPTION"
ObjectVariation ::=
"VARIATION" value(ObjectName
"DESCRIPTION"
-- must be a refinement for object's SYNTAX
SyntaxPart ::= "SYNTAX"
|
WriteSyntaxPart ::= "WRITE-SYNTAX"
|
Syntax ::= -- Must be one of the following
-- a base type (or its refinement),
-- a textual convention (or its refinement),
-- a BITS pseudo-
McCloghrie, et al. Standards Track [Page 8]
RFC 2580 Conformance Statements for SMIv2 April 1999
| "BITS" "{" NamedBits "}"
NamedBits ::=
| NamedBits ","
NamedBit ::= identifier "(" number ")" -- number is
AccessPart ::=
"ACCESS"
|
Access ::=
"not-implemented
-- only "not-implemented" for
| "accessible-for-notify
| "read-only
| "read-write
| "read-create
-- following is for backward-compatibility
| "write-only
CreationPart ::=
"CREATION-REQUIRES" "{" Cells "}"
|
Cells ::=
| Cells ","
Cell ::=
value(ObjectName
DefValPart ::= "DEFVAL" "{" Defvalue "}"
|
Defvalue ::= -- must be valid for the object's
-- in this macro's SYNTAX clause, if present
-- or if not, in object's OBJECT-TYPE
value(ObjectSyntax
| "{" BitsValue "}"
BitsValue ::=
|
BitNames ::=
| BitNames ","
BitName ::=
McCloghrie, et al. Standards Track [Page 9]
RFC 2580 Conformance Statements for SMIv2 April 1999
-- a character string as defined in [2]
Text ::= value(IA5String
3. Mapping of the OBJECT-GROUP
For conformance purposes, it is useful to define a collection
related managed objects. The OBJECT-GROUP macro is used to
each such collection of related objects. It should be noted that
expansion of the OBJECT-GROUP macro is something which
happens during implementation and not during run-time
To "implement" an object, an agent must return a reasonably
value for management protocol retrieval operations; similarly, if
object is writable, then in response to a management protocol
operation, an agent must accordingly be able to reasonably
the underlying managed entity. If an agent can not implement
object, the management protocol provides for it to return
exception or error, e.g, noSuchObject [4]. Under no
shall an agent return a value for objects which it does not
-- it must always return the appropriate exception or error,
described in the protocol specification [4].
Note that the OBJECT-GROUP macro itself provides no
information. Rather, conformance information is specified
the inclusion of defined groups in a MODULE-COMPLIANCE macro
3.1. Mapping of the OBJECTS
The OBJECTS clause, which must be present, is used to specify
object contained in the conformance group. Each of the
objects must be defined in the same information module as
OBJECT-GROUP macro appears, and must have a MAX-ACCESS clause
of "accessible-for-notify", "read-only", "read-write", or "read
create".
It is required that every object defined in an information
with a MAX-ACCESS clause other than "not-accessible" be contained
at least one object group. This avoids the common error of adding
new object to an information module and forgetting to add the
object to a group
McCloghrie, et al. Standards Track [Page 10]
RFC 2580 Conformance Statements for SMIv2 April 1999
3.2. Mapping of the STATUS
The STATUS clause, which must be present, indicates whether
definition is current or historic
The value "current" means that the definition is current and valid
The value "obsolete" means the definition is obsolete and the
should no longer be used for defining conformance. While the
"deprecated" also indicates an obsolete definition, it
new/continued use of conformance definitions using this group
3.3. Mapping of the DESCRIPTION
The DESCRIPTION clause, which must be present, contains a
definition of that group, along with a description of any
to other groups. Note that generic compliance requirements
not be stated in this clause. However, implementation
between this group and other groups may be defined in this clause
3.4. Mapping of the REFERENCE
The REFERENCE clause, which need not be present, contains a
cross-reference to some other document, either another
module which defines a related assignment, or some other
which provides additional information relevant to this definition
3.5. Mapping of the OBJECT-GROUP
The value of an invocation of the OBJECT-GROUP macro is the name
the group, which is an OBJECT IDENTIFIER, an
assigned name
McCloghrie, et al. Standards Track [Page 11]
RFC 2580 Conformance Statements for SMIv2 April 1999
3.6. Usage
The SNMP Group [3] is described
snmpGroup OBJECT-
OBJECTS { snmpInPkts
snmpInBadVersions
snmpInASNParseErrs
snmpBadOperations
snmpSilentDrops
snmpProxyDrops
snmpEnableAuthenTraps }
STATUS
"A collection of objects providing basic
and control of an agent."
::= { snmpMIBGroups 8 }
According to this invocation, the conformance group
{ snmpMIBGroups 8 }
contains 7 objects
4. Mapping of the NOTIFICATION-GROUP
For conformance purposes, it is useful to define a collection
notifications. The NOTIFICATION-GROUP macro serves this purpose.
should be noted that the expansion of the NOTIFICATION-GROUP macro
something which conceptually happens during implementation and
during run-time
4.1. Mapping of the NOTIFICATIONS
The NOTIFICATIONS clause, which must be present, is used to
each notification contained in the conformance group. Each of
specified notifications must be defined in the same
module as the NOTIFICATION-GROUP macro appears
It is required that every notification defined in an
module be contained in at least one notification group
McCloghrie, et al. Standards Track [Page 12]
RFC 2580 Conformance Statements for SMIv2 April 1999
4.2. Mapping of the STATUS
The STATUS clause, which must be present, indicates whether
definition is current or historic
The value "current" means that the definition is current and valid
The value "obsolete" means the definition is obsolete and this
should no longer be used for defining conformance. While the
"deprecated" also indicates an obsolete definition, it
new/continued use of conformance definitions using this group
4.3. Mapping of the DESCRIPTION
The DESCRIPTION clause, which must be present, contains a
definition of the group, along with a description of any relations
other groups. Note that generic compliance requirements should
be stated in this clause. However, implementation
between this group and other groups may be defined in this clause
4.4. Mapping of the REFERENCE
The REFERENCE clause, which need not be present, contains a
cross-reference to some other document, either another
module which defines a related assignment, or some other
which provides additional information relevant to this definition
4.5. Mapping of the NOTIFICATION-GROUP
The value of an invocation of the NOTIFICATION-GROUP macro is
name of the group, which is an OBJECT IDENTIFIER, an
assigned name
4.6. Usage
The SNMP Basic Notifications Group [3] is described
McCloghrie, et al. Standards Track [Page 13]
RFC 2580 Conformance Statements for SMIv2 April 1999
snmpBasicNotificationsGroup NOTIFICATION-
NOTIFICATIONS { coldStart, authenticationFailure }
STATUS
"The two notifications which an agent is required
implement."
::= { snmpMIBGroups 7 }
According to this invocation, the conformance group
{ snmpMIBGroups 7 }
contains 2 notifications
5. Mapping of the MODULE-COMPLIANCE
The MODULE-COMPLIANCE macro is used to convey a minimum set
requirements with respect to implementation of one or more
modules. It should be noted that the expansion of the MODULE
COMPLIANCE macro is something which conceptually happens
implementation and not during run-time
A requirement on all "standard" MIB modules is that a
MODULE-COMPLIANCE specification is also defined, either in the
information module or in a companion information module
5.1. Mapping of the STATUS
The STATUS clause, which must be present, indicates whether
definition is current or historic
The value "current" means that the definition is current and valid
The value "obsolete" means the definition is obsolete, and
MODULE-COMPLIANCE specification no longer specifies a
definition of conformance. While the value "deprecated"
indicates an obsolete definition, it permits new/continued use of
MODULE-COMPLIANCE specification
5.2. Mapping of the DESCRIPTION
The DESCRIPTION clause, which must be present, contains a
definition of this compliance statement and should embody
information which would otherwise be communicated in any ASN.1
commentary annotations associated with the statement
McCloghrie, et al. Standards Track [Page 14]
RFC 2580 Conformance Statements for SMIv2 April 1999
5.3. Mapping of the REFERENCE
The REFERENCE clause, which need not be present, contains a
cross-reference to some other document, either another
module which defines a related assignment, or some other
which provides additional information relevant to this definition
5.4. Mapping of the MODULE
The MODULE clause, which must be present, is repeatedly used to
each MIB module for which compliance requirements are
specified. Each MIB module is named by its module name,
optionally, by its associated OBJECT IDENTIFIER as well. The
name can be omitted when the MODULE-COMPLIANCE invocation
inside a MIB module, to refer to the encompassing MIB module
5.4.1. Mapping of the MANDATORY-GROUPS
The MANDATORY-GROUPS clause, which need not be present, names the
or more object or notification groups within the correspondent
module which are unconditionally mandatory for implementation. If
agent claims compliance to the MIB module, then it must
each and every object and notification within each conformance
listed. That is, if an agent returns a noSuchObject exception
response to a management protocol get operation [4] for any
within any mandatory conformance group for every possible MIB view
or if the agent cannot generate each notification listed in
conformance group under the appropriate circumstances, then
agent is not a conformant implementation of the MIB module
5.4.2. Mapping of the GROUP
The GROUP clause, which need not be present, is repeatedly used
name each object and notification group which is
mandatory for compliance to the MIB module. The GROUP clause
also be used to name unconditionally optional groups. A group
in a GROUP clause must be absent from the correspondent MANDATORY
GROUPS clause
Conditionally mandatory groups include those which are mandatory
if a particular protocol is implemented, or only if another group
implemented. A GROUP clause's DESCRIPTION specifies the
under which the group is conditionally mandatory
A group which is named in neither a MANDATORY-GROUPS clause nor
GROUP clause, is unconditionally optional for compliance to the
module
McCloghrie, et al. Standards Track [Page 15]
RFC 2580 Conformance Statements for SMIv2 April 1999
5.4.3. Mapping of the OBJECT
The OBJECT clause, which need not be present, is repeatedly used
specify each MIB object for which compliance has a
requirement with respect to the MIB module definition. The
object must be present in one of the conformance groups named in
correspondent MANDATORY-GROUPS clause or GROUP clauses
By definition, each object specified in an OBJECT clause follows
MODULE clause which names the information module in which that
is defined. Therefore, the use of an IMPORTS statement, to
from where such objects are imported, is redundant and is
required in an information module
5.4.3.1. Mapping of the SYNTAX
The SYNTAX clause, which need not be present, is used to provide
refined SYNTAX for the object named in the correspondent
clause. Note that if this clause and a WRITE-SYNTAX clause are
present, then this clause only applies when instances of the
named in the correspondent OBJECT clause are read
Consult Section 9 of [2] for more information on refined syntax
5.4.3.2. Mapping of the WRITE-SYNTAX
The WRITE-SYNTAX clause, which need not be present, is used
provide a refined SYNTAX for the object named in the
OBJECT clause when instances of that object are written
Consult Section 9 of [2] for more information on refined syntax
5.4.3.3. Mapping of the MIN-ACCESS
The MIN-ACCESS clause, which need not be present, is used to
the minimal level of access for the object named in the
OBJECT clause. If this clause is absent, the minimal level of
is the same as the maximal level specified in the
invocation of the OBJECT-TYPE macro. If present, this clause
not specify a greater level of access than is specified in
correspondent invocation of the OBJECT-TYPE macro
The level of access for certain types of objects is fixed
to their syntax definition. These types include: conceptual
and rows, auxiliary objects, and objects with the syntax
Counter32, Counter64 (and possibly, certain types of
conventions). A MIN-ACCESS clause should not be present for
McCloghrie, et al. Standards Track [Page 16]
RFC 2580 Conformance Statements for SMIv2 April 1999
objects
An implementation is compliant if the level of access it provides
greater or equal to the minimal level in the MODULE-COMPLIANCE
and less or equal to the maximal level in the OBJECT-TYPE macro
5.4.4. Mapping of the DESCRIPTION
The DESCRIPTION clause must be present for each use of the GROUP
OBJECT clause. For an OBJECT clause, it contains a
description of the refined compliance requirement. For a
clause, it contains a textual description of the conditions
which the group is conditionally mandatory or
optional
5.5. Mapping of the MODULE-COMPLIANCE
The value of an invocation of the MODULE-COMPLIANCE macro is
OBJECT IDENTIFIER. As such, this value may be authoritatively
when referring to the compliance statement embodied by
invocation of the macro
5.6. Usage
The compliance statement contained in the (hypothetical) XYZv2-
might be
xyzMIBCompliance MODULE-
STATUS
"The compliance statement for XYZv2 entities
implement the XYZv2 MIB."
MODULE -- compliance to the containing MIB
MANDATORY-GROUPS { xyzSystemGroup
xyzStatsGroup, xyzTrapGroup
xyzSetGroup
xyzBasicNotificationsGroup }
GROUP xyzV1
"The xyzV1 group is mandatory only for
XYZv2 entities which also implement XYZv1."
::= { xyzMIBCompliances 1 }
According to this invocation, to claim alignment with the
statement
{ xyzMIBCompliances 1 }
McCloghrie, et al. Standards Track [Page 17]
RFC 2580 Conformance Statements for SMIv2 April 1999
a system must implement the XYZv2-MIB's xyzSystemGroup
xyzStatsGroup, xyzTrapGroup, and xyzSetGroup object
groups, as well as the xyzBasicNotificationsGroup
group. Furthermore, if the XYZv2 entity also implements XYZv1,
it must also support the XYZv1Group group, if compliance is to
claimed
McCloghrie, et al. Standards Track [Page 18]
RFC 2580 Conformance Statements for SMIv2 April 1999
6. Mapping of the AGENT-CAPABILITIES
The AGENT-CAPABILITIES macro is used to convey a set of
present in an agent. It should be noted that the expansion of
AGENT-CAPABILITIES macro is something which conceptually
during implementation and not during run-time
When a MIB module is written, it is divided into units of
termed groups. If an agent claims to implement a group, then it
implement each and every object, or each and every notification
within that group. Of course, for whatever reason, an agent
implement only a subset of the groups within a MIB module.
addition, the definition of some MIB objects/notifications leave
aspects of the definition to the discretion of an implementor
Practical experience has demonstrated a need for concisely
the capabilities of an agent with respect to one or more MIB modules
The AGENT-CAPABILITIES macro allows an agent implementor to
the precise level of support which an agent claims in regards to
MIB group, and to bind that description to the value of an
of sysORID [3]. In particular, some objects may have restricted
augmented syntax or access-levels
If the AGENT-CAPABILITIES invocation is given to a management-
implementor, then that implementor can build management
which optimize themselves when communicating with a particular agent
For example, the management-station can maintain a database of
invocations. When a management-station interacts with an agent,
retrieves from the agent the values of all instances of sysORID [3].
Based on this, it consults the database to locate each entry
one of the retrieved values of sysORID. Using the located entries
the management application can now optimize its behavior accordingly
Note that the AGENT-CAPABILITIES macro specifies refinements
variations with respect to OBJECT-TYPE and NOTIFICATION-TYPE
in MIB modules, NOT with respect to MODULE-COMPLIANCE macros
compliance statements
6.1. Mapping of the PRODUCT-RELEASE
The PRODUCT-RELEASE clause, which must be present, contains a
description of the product release which includes this set
capabilities
6.2. Mapping of the STATUS
The STATUS clause, which must be present, indicates whether
McCloghrie, et al. Standards Track [Page 19]
RFC 2580 Conformance Statements for SMIv2 April 1999
definition is current or historic
The value "current" means that the definition is current and valid
The value "obsolete" means the definition is obsolete and
capabilities statement is no longer in use
6.3. Mapping of the DESCRIPTION
The DESCRIPTION clause, which must be present, contains a
description of this set of capabilities
6.4. Mapping of the REFERENCE
The REFERENCE clause, which need not be present, contains a
cross-reference to some other document, either another
module which defines a related assignment, or some other
which provides additional information relevant to this definition
6.5. Mapping of the SUPPORTS
The SUPPORTS clause, which need not be present, is repeatedly used
name each MIB module for which the agent claims a complete or
implementation. Each MIB module is named by its module name,
optionally, by its associated OBJECT IDENTIFIER (as registered by
MODULE-IDENTITY macro, see [2]) as well
6.5.1. Mapping of the INCLUDES
The INCLUDES clause, which must follow each and every use of
SUPPORTS clause, is used to name each MIB group associated with
SUPPORTS clause, which the agent claims to implement
6.5.2. Mapping of the VARIATION
The VARIATION clause, which need not be present, is repeatedly
to name each object or notification which the agent implements
some variant or refined fashion with respect to the
invocation of the OBJECT-TYPE or NOTIFICATION-TYPE macro
Note that the variation concept is meant for generic
restrictions, e.g., if the variation for an object depends on
values of other objects, then this should be noted in the
DESCRIPTION clause
By definition, each object specified in a VARIATION clause follows
SUPPORTS clause which names the information module in which
object is defined. Therefore, the use of an IMPORTS statement,
specify from where such objects are imported, is redundant and is
McCloghrie, et al. Standards Track [Page 20]
RFC 2580 Conformance Statements for SMIv2 April 1999
required in an information module
6.5.2.1. Mapping of the SYNTAX
The SYNTAX clause, which need not be present, is used to provide
refined SYNTAX for the object named in the correspondent
clause. Note that if this clause and a WRITE-SYNTAX clause are
present, then this clause only applies when instances of the
named in the correspondent VARIATION clause are read
Consult Section 9 of [2] for more information on refined syntax
Note that for enumerated INTEGERs and for the BITS construct,
changes allowed when updating a MIB module include the addition
enumerations and/or changing the labels of existing enumerations (
Section 10.2 of [2]). This type of change can cause problems for
AGENT-CAPABILITIES macro written against the old revision of a
module. One way to avoid such problems is to explicitly list
objects having an enumerated syntax in a VARIATION clause, even
all enumerations are currently supported
6.5.2.2. Mapping of the WRITE-SYNTAX
The WRITE-SYNTAX clause, which need not be present, is used
provide a refined SYNTAX for the object named in the
VARIATION clause when instances of that object are written
Consult Section 9 of [2] for more information on refined syntax
6.5.2.3. Mapping of the ACCESS
The ACCESS clause, which need not be present, is used to indicate
agent provides less than the maximal level of access to the object
notification named in the correspondent VARIATION clause
The only value applicable to notifications is "not-implemented".
The value "not-implemented" indicates the agent does not
the object or notification, and in the ordering of possible values
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
ordering of possible values, "write-only" is less than "not
accessible".
McCloghrie, et al. Standards Track [Page 21]
RFC 2580 Conformance Statements for SMIv2 April 1999
6.5.2.4. Mapping of the CREATION-REQUIRES
The CREATION-REQUIRES clause, which need not be present, is used
name the columnar objects of a conceptual row to which values must
explicitly assigned, by a management protocol set operation,
the agent will allow the instance of the status column of that row
be set to `active'. (Consult the definition of RowStatus [5].)
If the conceptual row does not have a status column (i.e.,
objects corresponding to the conceptual table were defined using
mechanisms in [6,7]), then the CREATION-REQUIRES clause, which
not be present, is used to name the columnar objects of a
row to which values must be explicitly assigned, by a
protocol set operation, before the agent will create new instances
objects in that row
This clause must not be present unless the object named in
correspondent VARIATION clause is a conceptual row, i.e., has
syntax which resolves to a SEQUENCE containing columnar objects.
objects named in the value of this clause usually will refer
columnar objects in that row. However, objects unrelated to
conceptual row may also be specified
All objects which are named in the CREATION-REQUIRES clause for
conceptual row, and which are columnar objects of that row, must
an access level of "read-create".
6.5.2.5. Mapping of the DEFVAL
The DEFVAL clause, which need not be present, is used to provide
alternate DEFVAL value for the object named in the
VARIATION clause. The semantics of this value are identical to
of the OBJECT-TYPE macro's DEFVAL clause
6.5.2.6. Mapping of the DESCRIPTION
The DESCRIPTION clause, which must be present for each use of
VARIATION clause, contains a textual description of the variant
refined implementation of the object or notification
6.6. Mapping of the AGENT-CAPABILITIES
The value of an invocation of the AGENT-CAPABILITIES macro is
OBJECT IDENTIFIER, which names the value of sysORID [3] for
this capabilities statement is valid
McCloghrie, et al. Standards Track [Page 22]
RFC 2580 Conformance Statements for SMIv2 April 1999
6.7. Usage
Consider how a capabilities statement for an agent might
described
exampleAgent AGENT-
PRODUCT-RELEASE "ACME Agent release 1.1 for 4BSD."
STATUS
DESCRIPTION "ACME agent for 4BSD."
SUPPORTS SNMPv2-
INCLUDES { systemGroup, snmpGroup, snmpSetGroup
snmpBasicNotificationsGroup }
VARIATION
DESCRIPTION "A coldStart trap is generated on
reboots."
SUPPORTS IF-
INCLUDES { ifGeneralGroup, ifPacketGroup }
VARIATION
SYNTAX INTEGER { up(1), down(2) }
DESCRIPTION "Unable to set test mode on 4BSD."
VARIATION
SYNTAX INTEGER { up(1), down(2) }
DESCRIPTION "Information limited on 4BSD."
SUPPORTS IP-
INCLUDES { ipGroup, icmpGroup }
VARIATION
SYNTAX INTEGER (255..255)
DESCRIPTION "Hard-wired on 4BSD."
VARIATION
ACCESS not-
DESCRIPTION "Information not available on 4BSD."
VARIATION
CREATION-REQUIRES { ipNetToMediaPhysAddress }
DESCRIPTION "Address mappings on 4BSD
both protocol and media addresses."
SUPPORTS TCP-
INCLUDES { tcpGroup }
VARIATION
McCloghrie, et al. Standards Track [Page 23]
RFC 2580 Conformance Statements for SMIv2 April 1999
ACCESS read-
DESCRIPTION "Unable to set this on 4BSD."
SUPPORTS UDP-
INCLUDES { udpGroup }
SUPPORTS EVAL-
INCLUDES { functionsGroup, expressionsGroup }
VARIATION
CREATION-REQUIRES { evalString, evalStatus }
DESCRIPTION "Conceptual row creation is supported."
::= { acmeAgents 1 }
According to this invocation, an agent with a sysORID value
{ acmeAgents 1 }
supports objects defined in six MIB modules
From SNMPv2-MIB, five conformance groups are supported
From IF-MIB, the ifGeneralGroup and ifPacketGroup groups
supported. However, the objects ifAdminStatus and ifOperStatus
a restricted syntax
From IP-MIB, all objects in the ipGroup and icmpGroup are
except ipInAddrErrors, while ipDefaultTTL has a restricted range,
when creating a new instance in the ipNetToMediaTable, the set
request must create an instance of ipNetToMediaPhysAddress
From TCP-MIB, the tcpGroup is supported except that tcpConnState
available only for reading
From UDP-MIB, the udpGroup is fully supported
From the EVAL-MIB, all the objects contained in the
and expressionsGroup conformance groups are supported,
variation. In addition, creation of new instances in the expr
is supported, and requires both of the objects: evalString
evalStatus, to be assigned a value
McCloghrie, et al. Standards Track [Page 24]
RFC 2580 Conformance Statements for SMIv2 April 1999
7. Extending an Information
As experience is gained with a published information module, it
be desirable to revise that information module
Section 10 of [2] defines the rules for extending an
module. The remainder of this section defines how
groups, compliance statements, and capabilities statements may
extended
7.1. Conformance
It may be desirable to revise the definition of a conformance
(an OBJECT-GROUP or a NOTIFICATION-GROUP) after experience is
with it. However, conformance groups can be referenced by
and/or capabilities definitions. Therefore, a change to
conformance group is not allowed if it has the potential to cause
reference to the group's original definition to be different from
reference to the updated definition. Such changes can only
accommodated by defining a new conformance group with a
descriptor and a new OBJECT IDENTIFIER value
The following revisions are allowed
(1) A STATUS clause value of "current" may be revised as "deprecated
or "obsolete". Similarly, a STATUS clause value of "deprecated
may be revised as "obsolete". When making such a change,
DESCRIPTION clause should be updated to explain the rationale
(2) A REFERENCE clause may be added or updated
(3) Clarifications and additional information may be included in
DESCRIPTION clause
(4) Any editorial change
It is not necessary to change the STATUS value of a conformance
when the status of a member of the group is changed
7.2. Compliance
It may be desirable to revise the definition of a
definition (MODULE-COMPLIANCE) after experience is gained with it
However, changes are not allowed if they cause the
specified by the original definition to be different from
requirements of the updated definition. Such changes can only
accommodated by defining a new compliance definition with a
McCloghrie, et al. Standards Track [Page 25]
RFC 2580 Conformance Statements for SMIv2 April 1999
descriptor and a new OBJECT IDENTIFIER value
The following revisions are allowed
(1) A STATUS clause value of "current" may be revised as "deprecated
or "obsolete". Similarly, a STATUS clause value of "deprecated
may be revised as "obsolete". When making such a change,
DESCRIPTION clause should be updated to explain the rationale
(2) A REFERENCE clause may be added or updated
(3) Clarifications and additional information may be included in
DESCRIPTION clause(s).
(4) Any editorial change
It is not necessary to change the STATUS value of a
definition due to a change in the STATUS value of a definition
references
7.3. Capabilities
It may be desirable to revise the definition of a
definition (AGENT-CAPABILITIES) after experience is gained with it
However, changes are not allowed if they cause the
specified by the original specification to be different from
capabilities of the updated specification. Such changes can only
accommodated by defining a new capabilities definition with a
descriptor and a new OBJECT IDENTIFIER value
The following revisions are allowed
(1) A STATUS clause value of "current" may be revised as "obsolete".
When making such a change, the DESCRIPTION clause should be
to explain the rationale
(2) A REFERENCE clause may be added or updated
(3) Clarifications and additional information may be included in
DESCRIPTION clause(s).
(4) Any editorial change
It is not necessary to change the STATUS value of a
definition due to a change in the STATUS value of a definition
references
McCloghrie, et al. Standards Track [Page 26]
RFC 2580 Conformance Statements for SMIv2 April 1999
8. Security
This document defines the means to define conformance
for implementing on documents describing management information
This method of defining conformance requirements has no
impact on the Internet
9. Editors'
Keith
Cisco Systems, Inc
170 West Tasman
San Jose, CA 95134-1706
Phone: +1 408 526 5260
EMail: kzm@cisco.
David
3763 Benton
Santa Clara, CA 95051
Phone: +1 408 221-8702
Email: dperkins@snmpinfo.
Juergen
TU
Bueltenweg 74/75
38106
Phone: +49 531 391-3283
EMail: schoenw@ibr.cs.tu-bs.
McCloghrie, et al. Standards Track [Page 27]
RFC 2580 Conformance Statements for SMIv2 April 1999
10.
[1] Information processing systems - Open Systems Interconnection -
Specification of Abstract Syntax Notation One (ASN.1),
International Organization for Standardization.
Standard 8824, (December, 1987).
[2] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M
and S. Waldbusser, "Structure of Management Information Version 2
(SMIv2)", STD 58, RFC 2578, April 1999.
[3] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.
S. Waldbusser, "Management Information Base for Version 2 of
Simple Network Management Protocol (SNMPv2)", RFC 1907,
1996.
[4] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.
S. Waldbusser, "Protocol Operations for Version 2 of the
Network Management Protocol (SNMPv2)", RFC 1905, January 1996.
[5] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M
and S. Waldbusser, "Textual Conventions for SMIv2", STD 58,
RFC 2579, April 1999.
[6] Rose, M. and K. McCloghrie, "Structure and Identification
Management Information for TCP/IP-based internets", STD 16,
1155, May 1990.
[7] Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16,
1212, March 1991.
McCloghrie, et al. Standards Track [Page 28]
RFC 2580 Conformance Statements for SMIv2 April 1999
11. Full Copyright
Copyright (C) The Internet Society (1999). All Rights Reserved
This document and translations of it may be copied and furnished
others, and derivative works that comment on or otherwise explain
or assist in its implementation may be prepared, copied,
and distributed, in whole or in part, without restriction of
kind, provided that the above copyright notice and this paragraph
included on all such copies and derivative works. However,
document itself may not be modified in any way, such as by
the copyright notice or references to the Internet Society or
Internet organizations, except as needed for the purpose
developing Internet standards in which case the procedures
copyrights defined in the Internet Standards process must
followed, or as required to translate it into languages other
English
The limited permissions granted above are perpetual and will not
revoked by the Internet Society or its successors or assigns
This document and the information contained herein is provided on
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE."
McCloghrie, et al. Standards Track [Page 29]
if you see any problems within the linking, don't worry be happy,
this is version 0.1 of the Relevance System and you gotta expect some crappy subroutines sometimes,
just be content we did not write this in Java, which would have made this "bigger and better" HAHAHHA.
RFC documents can be found at I.E.T.F.
Relevance System Copyright © 2002 Spectrum WorldResearch
other technical nosh by ServerMasters Corporation
collaboration of BobX
