draft-ietf-rap-sppi-05.txt   draft-ietf-rap-sppi-06.txt 
skipping to change at page 1, line 17 skipping to change at page 1, line 17
K. Chan K. Chan
Nortel Networks Nortel Networks
S. Hahn S. Hahn
R. Sahita R. Sahita
Intel Intel
A. Smith A. Smith
Allegro Networks Allegro Networks
F. Reichmeyer F. Reichmeyer
PFN PFN
20 February 2001 11 April 2001
Structure of Policy Provisioning Information (SPPI) Structure of Policy Provisioning Information (SPPI)
draft-ietf-rap-sppi-05.txt draft-ietf-rap-sppi-06.txt
Status of this Memo Status of this Memo
This document is an Internet-Draft and is in full conformance with all This document is an Internet-Draft and is in full conformance with all
provisions of Section 10 of RFC2026. Internet-Drafts are working provisions of Section 10 of RFC2026. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas, and documents of the Internet Engineering Task Force (IETF), its areas, and
its working groups. Note that other groups may also distribute working its working groups. Note that other groups may also distribute working
documents as Internet-Drafts. documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
skipping to change at page 2, line 5 skipping to change at page 2, line 5
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt. http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
Copyright Notice Copyright Notice
Copyright (C) The Internet Society (2000). All Rights Reserved. Copyright (C) The Internet Society (2000). All Rights Reserved.
Draft SPPI February 2001 SPPI April 2001
1. Introduction Abstract
RFC 2748 [COPS] defines the COPS protocol, and RFC 2749 [COPS-RSVP] RFC 2748 [COPS] defines the COPS protocol, and RFC 2749 [COPS-RSVP]
describes how the COPS protocol is used to provide for the outsourcing describes how the COPS protocol is used to provide for the outsourcing
of policy decisions for RSVP. Another usage of the COPS protocol, for of policy decisions for RSVP. Another usage of the COPS protocol, for
the provisioning of policy, is introduced in [COPS-PR]. In this the provisioning of policy, is introduced in RFC 3084 [COPS-PR]. In
provisioning model, the policy information is viewed as a collection of this provisioning model, the policy information is viewed as a
Provisioning Classes (PRCs) and Provisioning Instances (PRIs) residing collection of Provisioning Classes (PRCs) and Provisioning Instances
in a virtual information store, termed the Policy Information Base (PRIs) residing in a virtual information store, termed the Policy
(PIB). Collections of related Provisioning Classes are defined in a PIB Information Base (PIB). Collections of related Provisioning Classes are
module. PIB modules are written using an adapted subset of SNMP's defined in a PIB module. PIB modules are written using an adapted
Structure of Management Information (SMI) [SMI, TC, CONF]. It is the subset of SNMP's Structure of Management Information (SMI) [SMI, TC,
purpose of this document, the Structure of Policy Provisioning CONF]. It is the purpose of this document, the Structure of Policy
Information (SPPI), to define that adapted subset. Provisioning Information (SPPI), to define that adapted subset.
1.1. Change Log
This log to be removed as and when this draft is published as an RFC.
1.1.1. Changes made in version published on 13 July 2000
- included definition of the TEXTUAL-CONVENTION macro in the SPPI's
ASN.1 module so that TC's in PIBs can use data types not present in the
SMI.
- renamed the CLIENT-TYPES clause to be the SUBJECT-CATEGORIES clause in
order to be more generic.
- renamed the POLICY-ACCESS clause to be the PIB-ACCESS clause for
consistency. Added an extra parameter on the PIB-ACCESS clause for use
as the sub-identifier for a RowStatus column when converting to a MIB.
- added new clauses: EXTENDS, PIB-INDEX, PIB-REFERENCES, PIB-TAG, and
PIB-MODULES.
- renamed the MIN-ACCESS clause to be the PIB-MIN-ACCESS clause.
- created a new PIB module to contain the TC's defined in the SPPI.
- defined new TC's: Prid, PolicyTagId, PolicyTagReference.
- added Appendix with example usage of PIB-REFERENCES and PIB-TAG.
- added detail on carrying an INSTALL-ERROR in COPS-PR messages.
Draft SPPI February 2001
1.1.2. Changes made in version published on 20 September 2000
- copied (unmodified) the definitions of the OBJECT-IDENTITY and OBJECT-
GROUP macros into this document.
- changed syntax of PolicyTagId and PolicyTagReference to Unsigned32.
- changed the PolicyXxx TC names to remove "Policy" and be more
consistent, i.e., PolicyTagId, PolicyReferenceId and PolicyTagReference
to TagId, ReferenceId and TagReferenceId.
- made the UNIQUENESS clause optional, but recommended wherever it
provides useful information.
- changed usage of the PIB-INDEX and INDEX clauses to be more
consistent: a PIB-INDEX clause is now always required, and always has
the same meaning. The INDEX clause is now optional, and is only used
for the algorithmic conversion to a MIB.
- changed default OID value for an added RowStatus column to be 127.
- removed the PIB-MODULES clause.
- changed the meaning of PRC to be Provisioning Class, and of PRI to be
Provisioning Instance.
- required the algorithmic conversion to a MIB to have a configurable
option with respect to how Integer64 and Unsigned64 are mapped to the
SMI.
- specified that a PIB module's SUBJECT-CATEGORIES clause is not
exclusive. That is, some other specification might (e.g., at a future
date) specify additional COPS Client Types to which the PIB module is
relevant.
- updated the Reserved Keywords.
- copied the definitions of IpAddress, Unsigned32, TimeTicks from the
SMI into COPS-PR-SPPI, and clarified that PIB modules must import each
base data type that it uses from COPS-PR-SPPI, and may import, from the
SMI, (subtree) OIDs for the purpose of defining new OIDs.
- various typos.
Draft SPPI February 2001
1.1.3. Changes made in version published on 13 November 2000
- clarified definition of PIB-REFERENCES.
- added "report-only" as a value of PIB-ACCESS.
1.1.4. Changes made in version published 22 January 2001
- Converted PIB-REFERENCE to PIB-REFERENCES
- Changed [APPLICATION 7] and [APPLICATION 8] references to [APPLICATION
10] and [APPLICATION 11].
1.1.5. Changes made in version published 20 February 2001 Conventions used in this document
- Deprecated IpAddress and added reference to INET-ADDRESS-MIB. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC-2119].
2. Use of the SMI 1. Use of the SMI
The SPPI and PIB modules are based on SNMP's SMI and MIB modules, which The SPPI and PIB modules are based on SNMP's SMI and MIB modules, which
use an adapted subset of the ASN.1 data definition language [ASN1]. The use an adapted subset of the ASN.1 data definition language [ASN1]. The
decision to base the definition of PIB modules on this format allows for decision to base the definition of PIB modules on this format allows for
the leveraging of the community's knowledge, experience and tools of the the leveraging of the community's knowledge, experience and tools of the
SMI and MIB modules. SMI and MIB modules.
2.1. Terminology Translation 1.1. Terminology Translation
The SMI uses the term "managed objects" to refer to object types, both The SMI uses the term "managed objects" to refer to object types, both
tabular types with descriptors such as xxxTable and xxxEntry, as well as tabular types with descriptors such as xxxTable and xxxEntry, as well as
scalar and columnar object types. The SPPI does not use the term scalar and columnar object types. The SPPI does not use the term
"object" so as to avoid confusion with COPS protocol objects. Instead, "object" so as to avoid confusion with COPS protocol objects. Instead,
the SPPI uses the term Provisioning Class (PRC) for the table and row the SPPI uses the term Provisioning Class (PRC) for the table and row
definitions (the xxxTable and xxxEntry objects, respectively), and definitions (the xxxTable and xxxEntry objects, respectively), and
Provisioning Instance (PRI) for an instantiation of a row definition. Provisioning Instance (PRI) for an instantiation of a row definition.
For a columnar object of a table definition, the SPPI uses the term For a columnar object of a table definition, the SPPI uses the term
"attribute" of a Provisioning Class. (The SPPI does not support the "attribute" of a Provisioning Class. (The SPPI does not support the
equivalent of the SMI's scalar objects.) equivalent of the SMI's scalar objects.)
SPPI April 2001
2.2. Overview 1.2. Overview
SNMP's SMI is divided into five parts: module definitions, object SNMP's SMI is divided into five parts: module definitions, object
definitions, notification definitions [SMI], textual convention definitions, notification definitions [SMI], textual convention
definitions [TC] and conformance definitions [CONF]. definitions [TC] and conformance definitions [CONF].
Draft SPPI February 2001
- The SMI's MODULE-IDENTITY macro is used to convey the semantics of - The SMI's MODULE-IDENTITY macro is used to convey the semantics of
a MIB module. The SPPI uses this macro to convey the semantics of a MIB module. The SPPI uses this macro to convey the semantics of
a PIB module. a PIB module.
- The SMI's OBJECT-TYPE macro is used to convey the syntax and - The SMI's OBJECT-TYPE macro is used to convey the syntax and
semantics of managed objects. The SPPI uses this macro to convey semantics of managed objects. The SPPI uses this macro to convey
the syntax and semantics of PRCs and their attributes. the syntax and semantics of PRCs and their attributes.
- The SMI's notification definitions are not used (at this time) by - The SMI's notification definitions are not used (at this time) by
the SPPI. (Note that the use of the keyword 'notify' in the SPPI the SPPI. (Note that the use of the keyword 'notify' in the SPPI
skipping to change at page 5, line 34 skipping to change at page 3, line 39
- The SMI's conformance definitions define several macros: the - The SMI's conformance definitions define several macros: the
OBJECT-GROUP macro, the NOTIFICATION-GROUP macro, the MODULE- OBJECT-GROUP macro, the NOTIFICATION-GROUP macro, the MODULE-
COMPLIANCE macro and the AGENT-CAPABILITIES macro. The SPPI uses COMPLIANCE macro and the AGENT-CAPABILITIES macro. The SPPI uses
the OBJECT-GROUP and MODULE-COMPLIANCE macros to specify acceptable the OBJECT-GROUP and MODULE-COMPLIANCE macros to specify acceptable
lower-bounds of implementation of the attributes of PRCs, and lower-bounds of implementation of the attributes of PRCs, and
thereby indirectly, acceptable lower-bounds of implementation of thereby indirectly, acceptable lower-bounds of implementation of
the PRCs themselves. The NOTIFICATION-GROUP macro is not used (at the PRCs themselves. The NOTIFICATION-GROUP macro is not used (at
this time) by the SPPI. Potential usage by the SPPI of the AGENT- this time) by the SPPI. Potential usage by the SPPI of the AGENT-
CAPABILITIES macro is for further study. CAPABILITIES macro is for further study.
3. Structure of this Specification 2. Structure of this Specification
The SMI is specified in terms of an ASN.1 definition together with The SMI is specified in terms of an ASN.1 definition together with
descriptive text for each element introduced in that ASN.1 definition. descriptive text for each element introduced in that ASN.1 definition.
This document specifies the SPPI also via a ASN.1 definition, which is a This document specifies the SPPI also via a ASN.1 definition, which is a
modified version of the SMI's definition, together with descriptive text modified version of the SMI's definition, together with descriptive text
for only those elements in the SPPI's ASN.1 definition which have for only those elements in the SPPI's ASN.1 definition which have
differences from the SMI's. For elements in the ASN.1 definition which differences from the SMI's. For elements in the ASN.1 definition which
have no descriptive text in this specification, the reader is referred have no descriptive text in this specification, the reader is referred
to the SMI's descriptive text for that element. to the SMI's descriptive text for that element.
Draft SPPI February 2001 SPPI April 2001
4. Definitions 3. Definitions
COPS-PR-SPPI DEFINITIONS ::= BEGIN COPS-PR-SPPI DEFINITIONS ::= BEGIN
IMPORTS ObjectName, SimpleSyntax, ExtUTCTime IMPORTS ObjectName, SimpleSyntax, ExtUTCTime, mgmt
FROM SNMPv2-SMI; FROM SNMPv2-SMI;
-- the root for PIB definitions
pib OBJECT IDENTIFIER ::= { mgmt 2 }
-- definitions for PIB modules -- definitions for PIB modules
MODULE-IDENTITY MACRO ::= MODULE-IDENTITY MACRO ::=
BEGIN BEGIN
TYPE NOTATION ::= TYPE NOTATION ::=
SubjectPart -- new SubjectPart -- new
"LAST-UPDATED" value(Update ExtUTCTime) "LAST-UPDATED" value(Update ExtUTCTime)
"ORGANIZATION" Text "ORGANIZATION" Text
"CONTACT-INFO" Text "CONTACT-INFO" Text
"DESCRIPTION" Text "DESCRIPTION" Text
skipping to change at page 6, line 48 skipping to change at page 5, line 4
identifier "(" number ")" -- number is positive identifier "(" number ")" -- number is positive
RevisionPart ::= RevisionPart ::=
Revisions Revisions
| empty | empty
Revisions ::= Revisions ::=
Revision Revision
| Revisions Revision | Revisions Revision
Revision ::= Revision ::=
"REVISION" value(Update ExtUTCTime) "REVISION" value(Update ExtUTCTime)
"DESCRIPTION" Text SPPI April 2001
Draft SPPI February 2001 "DESCRIPTION" Text
-- a character string as defined in [SMI] -- a character string as defined in [SMI]
Text ::= value(IA5String) Text ::= value(IA5String)
END END
-- --
OBJECT-IDENTITY MACRO ::= OBJECT-IDENTITY MACRO ::=
BEGIN BEGIN
TYPE NOTATION ::= TYPE NOTATION ::=
skipping to change at page 7, line 40 skipping to change at page 5, line 41
| empty | empty
-- a character string as defined in [SMI] -- a character string as defined in [SMI]
Text ::= value(IA5String) Text ::= value(IA5String)
END END
-- syntax of attributes -- syntax of attributes
-- the "base types" defined here are: -- the "base types" defined here are:
-- 3 built-in ASN.1 types: INTEGER, OCTET STRING, OBJECT IDENTIFIER -- 3 built-in ASN.1 types: INTEGER, OCTET STRING, OBJECT IDENTIFIER
-- 7 application-defined types: Integer32, IpAddress, Unsigned32,
-- TimeTicks, Opaque, Integer64 and Unsigned64
ObjectSyntax ::= ObjectSyntax ::=
CHOICE { CHOICE {
simple simple
SimpleSyntax, SimpleSyntax,
-- note that SEQUENCEs for table and row definitions -- note that SEQUENCEs for table and row definitions
-- are not mentioned here... SPPI April 2001
Draft SPPI February 2001 -- are not mentioned here...
application-wide application-wide
ApplicationSyntax ApplicationSyntax
} }
-- application-wide types -- application-wide types
ApplicationSyntax ::= ApplicationSyntax ::=
CHOICE { CHOICE {
ipAddress-value ipAddress-value
IpAddress, IpAddress,
timeticks-value timeticks-value
TimeTicks, TimeTicks,
arbitrary-value
Opaque,
unsigned-integer-value unsigned-integer-value
Unsigned32, Unsigned32,
large-integer-value -- new large-integer-value -- new
Integer64, Integer64,
large-unsigned-integer-value -- new large-unsigned-integer-value -- new
Unsigned64 Unsigned64
} }
-- the following 5 types are copied from the SMI
-- 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 ::=
INTEGER (-2147483648..2147483647) INTEGER (-2147483648..2147483647)
-- (this is a tagged type for historical reasons) -- (this is a tagged type for historical reasons)
IpAddress ::= IpAddress ::=
[APPLICATION 0] [APPLICATION 0]
IMPLICIT OCTET STRING (SIZE (4)) IMPLICIT OCTET STRING (SIZE (4))
-- ******* THIS TYPE DEFINITION IS DEPRECATED ******* -- ******* THIS TYPE DEFINITION IS DEPRECATED *******
-- The IpAddress type represents a 32-bit internet -- The IpAddress type represents a 32-bit internet
-- IPv4 address. It is represented as an OctetString -- IPv4 address. It is represented as an OctetString
-- of length 4, in network byte-order. -- of length 4, in network byte-order.
SPPI April 2001
-- Note that the IpAddress type is present for -- Note that the IpAddress type is present for
-- historical reasons. IPv4 and IPv6 addresses should -- historical reasons. IPv4 and IPv6 addresses should
-- be represented using the INET-ADDRESS-MIB -- be represented using the INET-ADDRESS-MIB
-- defined in [INETADDR]. -- defined in [INETADDR].
Draft SPPI February 2001
-- an unsigned 32-bit quantity -- an unsigned 32-bit quantity
Unsigned32 ::= Unsigned32 ::=
[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
Opaque ::=
[APPLICATION 4]
IMPLICIT OCTET STRING
-- the following 2 types are not present in the SMI -- the following 2 types are not present in the SMI
Integer64 ::= Integer64 ::=
[APPLICATION 10] [APPLICATION 10]
IMPLICIT INTEGER (-9223372036854775808..9223372036854775807) IMPLICIT INTEGER (-9223372036854775808..9223372036854775807)
Unsigned64 Unsigned64
[APPLICATION 11] [APPLICATION 11]
IMPLICIT INTEGER (0..18446744073709551615) IMPLICIT INTEGER (0..18446744073709551615)
-- definition for Provisioning Classes and their attributes -- definition for Provisioning Classes and their attributes
-- (differences from the SMI are noted in the ASN.1 comments) -- (differences from the SMI are noted in the ASN.1 comments)
OBJECT-TYPE MACRO ::= OBJECT-TYPE MACRO ::=
BEGIN BEGIN
TYPE NOTATION ::= TYPE NOTATION ::=
"SYNTAX" Syntax "SYNTAX" Syntax
UnitsPart UnitsPart
"PIB-ACCESS" AccessPart -- modified "PIB-ACCESS" Access -- modified
PibReferencesPart -- new PibReferencesPart -- new
PibTagPart -- new PibTagPart -- new
"STATUS" Status "STATUS" Status
"DESCRIPTION" Text "DESCRIPTION" Text
ErrorsPart -- new ErrorsPart -- new
SPPI April 2001
ReferPart ReferPart
IndexPart -- modified IndexPart -- modified
MibIndexPart -- modified MibIndexPart -- modified
UniquePart -- new UniquePart -- new
DefValPart DefValPart
VALUE NOTATION ::= VALUE NOTATION ::=
value(VALUE ObjectName) value(VALUE ObjectName)
Syntax ::= -- Must be one of the following: Syntax ::= -- Must be one of the following:
Draft SPPI February 2001
-- a base type (or its refinement), -- a base type (or its refinement),
-- a textual convention (or its refinement), or -- a textual convention (or its refinement), or
-- a BITS pseudo-type -- a BITS pseudo-type
type type
| "BITS" "{" NamedBits "}" | "BITS" "{" NamedBits "}"
NamedBits ::= NamedBit NamedBits ::= NamedBit
| NamedBits "," NamedBit | NamedBits "," NamedBit
NamedBit ::= identifier "(" number ")" -- number is nonnegative NamedBit ::= identifier "(" number ")" -- number is nonnegative
UnitsPart ::= UnitsPart ::=
"UNITS" Text "UNITS" Text
| empty | empty
AccessPart ::= -- new
Access
| Access "," number -- number is positive
Access ::= -- modified Access ::= -- modified
"install" "install"
| "notify" | "notify"
| "install-notify" | "install-notify"
| "report-only" | "report-only"
Status ::= Status ::=
"current" "current"
| "deprecated" | "deprecated"
| "obsolete" | "obsolete"
ErrorsPart ::= -- new ErrorsPart ::= -- new
"INSTALL-ERRORS" "{" Errors "}" "INSTALL-ERRORS" "{" Errors "}"
| empty | empty
Errors ::= -- new Errors ::= -- new
Error Error
| Errors "," Error | Errors "," Error
Error ::= -- new Error ::= -- new
identifier "(" number ")" -- number is positive identifier "(" number ")" -- number is positive
SPPI April 2001
ReferPart ::= ReferPart ::=
"REFERENCE" Text "REFERENCE" Text
| empty | empty
IndexPart ::= IndexPart ::=
Draft SPPI February 2001
"PIB-INDEX" "{" Index "}" -- new "PIB-INDEX" "{" Index "}" -- new
| "AUGMENTS" "{" Entry "}" | "AUGMENTS" "{" Entry "}"
| "EXTENDS" "{" Entry "}" -- new | "EXTENDS" "{" Entry "}" -- new
| empty | empty
Index ::= Index ::=
-- the correspondent OBJECT-TYPE invocation -- the correspondent OBJECT-TYPE invocation
value(ObjectName) value(ObjectName)
Entry ::= Entry ::=
-- use the INDEX value of the -- use the INDEX value of the
-- correspondent OBJECT-TYPE invocation -- correspondent OBJECT-TYPE invocation
skipping to change at page 11, line 46 skipping to change at page 10, line 4
PibTagPart ::= PibTagPart ::=
-- for use with TagReferenceId TC -- for use with TagReferenceId TC
"PIB-TAG" "{" Attr "}" "PIB-TAG" "{" Attr "}"
| empty | empty
Attr ::= -- specifies an attribute Attr ::= -- specifies an attribute
value(ObjectName) value(ObjectName)
UniquePart ::= -- new UniquePart ::= -- new
"UNIQUENESS" "{" UniqueTypes "}" "UNIQUENESS" "{" UniqueTypes "}"
SPPI April 2001
| "UNIQUENESS" "{" "}" | "UNIQUENESS" "{" "}"
| empty | empty
UniqueTypes ::= UniqueTypes ::=
UniqueType UniqueType
| UniqueTypes "," UniqueType | UniqueTypes "," UniqueType
Draft SPPI February 2001
UniqueType ::= UniqueType ::=
-- the correspondent OBJECT-TYPE invocation -- the correspondent OBJECT-TYPE invocation
value(ObjectName) value(ObjectName)
DefValPart ::= "DEFVAL" "{" Defvalue "}" DefValPart ::= "DEFVAL" "{" Defvalue "}"
| empty | empty
Defvalue ::= -- must be valid for the type specified in Defvalue ::= -- must be valid for the type specified in
-- SYNTAX clause of same OBJECT-TYPE macro -- SYNTAX clause of same OBJECT-TYPE macro
value(ObjectSyntax) value(ObjectSyntax)
skipping to change at page 12, line 46 skipping to change at page 11, line 4
ObjectsPart ObjectsPart
"STATUS" Status "STATUS" Status
"DESCRIPTION" Text "DESCRIPTION" Text
ReferPart ReferPart
VALUE NOTATION ::= VALUE NOTATION ::=
value(VALUE OBJECT IDENTIFIER) value(VALUE OBJECT IDENTIFIER)
ObjectsPart ::= ObjectsPart ::=
"OBJECTS" "{" Objects "}" "OBJECTS" "{" Objects "}"
SPPI April 2001
Objects ::= Objects ::=
Object Object
| Objects "," Object | Objects "," Object
Object ::= Object ::=
value(ObjectName) value(ObjectName)
Draft SPPI February 2001
Status ::= Status ::=
"current" "current"
| "deprecated" | "deprecated"
| "obsolete" | "obsolete"
ReferPart ::= ReferPart ::=
"REFERENCE" Text "REFERENCE" Text
| empty | empty
-- a character string as defined in [SMI] -- a character string as defined in [SMI]
skipping to change at page 13, line 45 skipping to change at page 12, line 4
| "deprecated" | "deprecated"
| "obsolete" | "obsolete"
ReferPart ::= ReferPart ::=
"REFERENCE" Text "REFERENCE" Text
| empty | empty
ModulePart ::= ModulePart ::=
Modules Modules
Modules ::= Modules ::=
SPPI April 2001
Module Module
| Modules Module | Modules Module
Module ::= Module ::=
-- name of module -- -- name of module --
"MODULE" ModuleName "MODULE" ModuleName
MandatoryPart MandatoryPart
Draft SPPI February 2001
CompliancePart CompliancePart
ModuleName ::= ModuleName ::=
-- identifier must start with uppercase letter -- identifier must start with uppercase letter
identifier ModuleIdentifier identifier ModuleIdentifier
-- must not be empty unless contained -- must not be empty unless contained
-- in MIB Module -- in MIB Module
| empty | empty
ModuleIdentifier ::= ModuleIdentifier ::=
value(OBJECT IDENTIFIER) value(OBJECT IDENTIFIER)
skipping to change at page 14, line 46 skipping to change at page 13, line 4
Compliance ::= Compliance ::=
ComplianceGroup ComplianceGroup
| Object | Object
ComplianceGroup ::= ComplianceGroup ::=
"GROUP" value(OBJECT IDENTIFIER) "GROUP" value(OBJECT IDENTIFIER)
"DESCRIPTION" Text "DESCRIPTION" Text
Object ::= Object ::=
"OBJECT" value(ObjectName) "OBJECT" value(ObjectName)
SPPI April 2001
InstallSyntaxPart -- modified InstallSyntaxPart -- modified
AccessPart AccessPart
"DESCRIPTION" Text "DESCRIPTION" Text
-- must be a refinement for object's SYNTAX clause -- must be a refinement for object's SYNTAX clause
InstallSyntaxPart ::= "SYNTAX" Syntax InstallSyntaxPart ::= "SYNTAX" Syntax
Draft SPPI February 2001
| empty | empty
Syntax ::= -- Must be one of the following: Syntax ::= -- Must be one of the following:
-- a base type (or its refinement), -- a base type (or its refinement),
-- a textual convention (or its refinement), or -- a textual convention (or its refinement), or
-- a BITS pseudo-type -- a BITS pseudo-type
type type
| "BITS" "{" NamedBits "}" | "BITS" "{" NamedBits "}"
NamedBits ::= NamedBit NamedBits ::= NamedBit
skipping to change at page 15, line 46 skipping to change at page 14, line 4
TEXTUAL-CONVENTION MACRO ::= TEXTUAL-CONVENTION MACRO ::=
BEGIN BEGIN
TYPE NOTATION ::= TYPE NOTATION ::=
DisplayPart DisplayPart
"STATUS" Status "STATUS" Status
"DESCRIPTION" Text "DESCRIPTION" Text
ReferPart ReferPart
"SYNTAX" Syntax "SYNTAX" Syntax
VALUE NOTATION ::= VALUE NOTATION ::=
SPPI April 2001
value(VALUE Syntax) -- adapted ASN.1 value(VALUE Syntax) -- adapted ASN.1
DisplayPart ::= DisplayPart ::=
"DISPLAY-HINT" Text "DISPLAY-HINT" Text
| empty | empty
Draft SPPI February 2001
Status ::= Status ::=
"current" "current"
| "deprecated" | "deprecated"
| "obsolete" | "obsolete"
ReferPart ::= ReferPart ::=
"REFERENCE" Text "REFERENCE" Text
| empty | empty
-- a character string as defined in [SMI] -- a character string as defined in [SMI]
skipping to change at page 17, line 4 skipping to change at page 15, line 4
| "BITS" "{" NamedBits "}" | "BITS" "{" NamedBits "}"
NamedBits ::= NamedBit NamedBits ::= NamedBit
| NamedBits "," NamedBit | NamedBits "," NamedBit
NamedBit ::= identifier "(" number ")" -- number is nonnegative NamedBit ::= identifier "(" number ")" -- number is nonnegative
END END
END END
SPPI April 2001
Draft SPPI February 2001
COPS-PR-SPPI-TC PIB-DEFINITIONS ::= BEGIN COPS-PR-SPPI-TC PIB-DEFINITIONS ::= BEGIN
IMPORTS Unsigned32, MODULE-IDENTITY, TEXTUAL-CONVENTION IMPORTS Unsigned32, MODULE-IDENTITY, TEXTUAL-CONVENTION, pib
FROM COPS-PR-SPPI; FROM COPS-PR-SPPI;
copsPrSppiTc MODULE-IDENTITY copsPrSppiTc MODULE-IDENTITY
SUBJECT-CATEGORIES { all } SUBJECT-CATEGORIES { all }
LAST-UPDATED "200009201800Z" LAST-UPDATED "200009201800Z"
ORGANIZATION "IETF RAP WG" ORGANIZATION "IETF RAP WG"
CONTACT-INFO "Keith McCloghrie CONTACT-INFO "Keith McCloghrie
Cisco Systems, Inc. Cisco Systems, Inc.
170 West Tasman Drive, 170 West Tasman Drive,
San Jose, CA 95134-1706 USA San Jose, CA 95134-1706 USA
skipping to change at page 17, line 35 skipping to change at page 15, line 34
2111 NE 25th Avenue 2111 NE 25th Avenue
Hillsboro, OR 97124 USA Hillsboro, OR 97124 USA
Phone: +1 503 712 1554 Phone: +1 503 712 1554
Email: ravi.sahita@intel.com " Email: ravi.sahita@intel.com "
DESCRIPTION DESCRIPTION
"The PIB module containing a set of Textual Conventions "The PIB module containing a set of Textual Conventions
which have general applicability to all PIB modules." which have general applicability to all PIB modules."
REVISION "200009201800Z" REVISION "200009201800Z"
DESCRIPTION DESCRIPTION
"Initial version, published in RFC xxxx." "Initial version, published in RFC xxxx."
::= { tbd } ::= { pib xxx } -- to be assigned by IANA
InstanceId ::= TEXTUAL-CONVENTION InstanceId ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The textual convention for use by an attribute which is used "The textual convention for use by an attribute which is used
as the instance-identifying index of a PRC, i.e., an attribute as the instance-identifying index of a PRC, i.e., an attribute
named in a PIB-INDEX clause. The value of an attribute with this named in a PIB-INDEX clause. The value of an attribute with this
syntax is always greater than zero. PRIs of the same PRC need syntax is always greater than zero. PRIs of the same PRC need
not have contiguous values for their instance-identifying not have contiguous values for their instance-identifying
attribute." attribute."
SYNTAX Unsigned32 (1..4294967295) SYNTAX Unsigned32 (1..4294967295)
ReferenceId ::= TEXTUAL-CONVENTION ReferenceId ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"A textual convention for use by an attribute which is used as "A textual convention for use by an attribute which is used as
SPPI April 2001
Draft SPPI February 2001
a pointer in order to reference an instance of a particular a pointer in order to reference an instance of a particular
PRC. An attribute with this syntax must not be used in a PRC. An attribute with this syntax must not be used in a
PIB-INDEX clause , and its description must specify the PIB-INDEX clause , and its description must specify the
particular PRC to which the referenced PRI will belong. particular PRC to which the referenced PRI will belong.
For an attribute of this type, the referenced PRI must exist. For an attribute of this type, the referenced PRI must exist.
Furthermore, it is an error to try to delete a PRI that is Furthermore, it is an error to try to delete a PRI that is
referenced by another instance without first deleting/modifying referenced by another instance without first deleting/modifying
the referencing instance. The definition of an attribute with the referencing instance. The definition of an attribute with
this syntax can permit the attribute to have a value of zero to this syntax can permit the attribute to have a value of zero to
skipping to change at page 19, line 4 skipping to change at page 17, line 4
DESCRIPTION DESCRIPTION
"Represents a reference to a tag list of instances of a "Represents a reference to a tag list of instances of a
particular PRC. The particular PRC must have an attribute particular PRC. The particular PRC must have an attribute
with the syntax of TagId. The tag list consists of with the syntax of TagId. The tag list consists of
all instances which have the same value of the TagId all instances which have the same value of the TagId
attribute. Reference to the tag list is via the attribute attribute. Reference to the tag list is via the attribute
with the syntax of TagReferenceId containing the tag with the syntax of TagReferenceId containing the tag
value which identifies the tag list." value which identifies the tag list."
SYNTAX Unsigned32 SYNTAX Unsigned32
END END
SPPI April 2001
Draft SPPI February 2001 4. PIB Modules
5. PIB Modules
The names of all standard PIB modules must be unique (but different The names of all standard PIB modules must be unique (but different
versions of the same module should have the same name). Developers of versions of the same module should have the same name). Developers of
enterprise PIB modules are encouraged to choose names for their modules enterprise PIB modules are encouraged to choose names for their modules
that will have a low probability of colliding with standard or other that will have a low probability of colliding with standard or other
enterprise modules. enterprise modules.
The first line of a PIB module is: The first line of a PIB module is:
PIB-MODULE-NAME PIB-DEFINITIONS ::= BEGIN PIB-MODULE-NAME PIB-DEFINITIONS ::= BEGIN
where PIB-MODULE-NAME is the module name. where PIB-MODULE-NAME is the module name.
Like the SMI, additional ASN.1 macros must not be defined in PIB Like the SMI, additional ASN.1 macros must not be defined in PIB
modules. modules.
5.1. Importing Definitions 4.1. Importing Definitions
Like the SMI, a PIB module which needs to reference an external Like the SMI, a PIB module which needs to reference an external
definition, must use the IMPORTS statement to identify both the definition, must use the IMPORTS statement to identify both the
descriptor and the module in which the descriptor is defined, where a descriptor and the module in which the descriptor is defined, where a
module is identified by its ASN.1 module name. module is identified by its ASN.1 module name.
In particular, a PIB module imports each of the base data types that it In particular, a PIB module imports each of the base data types that it
uses from COPS-PR-SPPI (defined in this document), and may import as uses from COPS-PR-SPPI (defined in this document), and may import as
required from other PIB modules. A PIB module may import, from the SMI, required from other PIB modules. A PIB module may import, from the SMI,
(subtree) OIDs for the purpose of defining new OIDs. A PIB module may (subtree) OIDs for the purpose of defining new OIDs. A PIB module may
skipping to change at page 19, line 47 skipping to change at page 17, line 46
supported by the SPPI. However, the following must not be included in supported by the SPPI. However, the following must not be included in
an IMPORTS statement: an IMPORTS statement:
- named types defined by ASN.1 itself, specifically: INTEGER, OCTET - named types defined by ASN.1 itself, specifically: INTEGER, OCTET
STRING, OBJECT IDENTIFIER, SEQUENCE, SEQUENCE OF type, STRING, OBJECT IDENTIFIER, SEQUENCE, SEQUENCE OF type,
- the BITS construct. - the BITS construct.
For each ASN.1 macro that a PIB uses, it must import that macro's For each ASN.1 macro that a PIB uses, it must import that macro's
definition from the COPS-PR-SPPI. definition from the COPS-PR-SPPI.
5.2. Reserved Keywords 4.2. Reserved Keywords
In addition to the reserved keywords listed in the SMI, the following In addition to the reserved keywords listed in the SMI, the following
must not be used as descriptors or module names: must not be used as descriptors or module names:
Draft SPPI February 2001 SPPI April 2001
EXTENDS INSTALL-ERRORS Integer64 PIB-MIN-ACCESS PIB-ACCESS EXTENDS INSTALL-ERRORS Integer64 PIB-MIN-ACCESS PIB-ACCESS
PIB-INDEX PIB-REFERENCES PIB-TAG SUBJECT-CATEGORIES UNIQUENESS PIB-INDEX PIB-REFERENCES PIB-TAG SUBJECT-CATEGORIES UNIQUENESS
Unsigned64 Unsigned64
6. Naming Hierarchy 5. Naming Hierarchy
The SPPI uses the same OBJECT IDENTIFIER naming hierarchy as the SMI. The SPPI uses the same OBJECT IDENTIFIER naming hierarchy as the SMI.
That is, OIDs are typically assigned to PIB modules from the subtree That is, OIDs are typically assigned to PIB modules from the subtree
administered by the Internet Assigned Numbers Authority (IANA). administered by the Internet Assigned Numbers Authority (IANA).
However, like the SMI, the SPPI does not prohibit the definition of PRCs However, like the SMI, the SPPI does not prohibit the definition of PRCs
in other portions of the OID tree. in other portions of the OID tree.
7. Mapping of the MODULE-IDENTITY macro 6. Mapping of the MODULE-IDENTITY macro
7.1. Mapping of the SUBJECT-CATEGORIES clause 6.1. Mapping of the SUBJECT-CATEGORIES clause
The SUBJECT-CATEGORIES clause, which must be present, identifies one or The SUBJECT-CATEGORIES clause, which must be present, identifies one or
more categories of provisioning data for which this PIB module defines more categories of provisioning data for which this PIB module defines
provisioning information. For use with the COPS-PR protocol, the provisioning information. For use with the COPS-PR protocol, the
individual subject categories are mapped to COPS Client Types [COPS-PR]. individual subject categories are mapped to COPS Client Types [COPS-PR].
The subject categories are identified either: IANA Considerations for SPPI SUBJECT-CATEGORIES follow the same
requirements as specified in [COPS] IANA Considerations for COPS Client
Types. The subject categories are identified either:
- via the keyword "all", indicating the PIB module defines - via the keyword "all", indicating the PIB module defines
provisioning information relevant for all subject categories (and provisioning information relevant for all subject categories (and
thus, all COPS Client Types), or thus, all COPS Client Types), or
- a list of named-number enumerations, where each number which must - a list of named-number enumerations, where each number which must
be greater than zero, identifies a subject category, and is mapped be greater than zero, identifies a subject category, and is mapped
to the Client Type which is identified by that same number in the to the Client Type which is identified by that same number in the
COPS protocol. The namespace for these named numbers is global and COPS protocol. The namespace for these named numbers is global and
therefore the labels should be assigned consistently across PIB therefore the labels should be assigned consistently across PIB
modules. At present time, no more than one named-number modules. At present time, no more than one named-number
enumeration should be specified. enumeration should be specified.
Note that the list of categories specified in a PIB module's SUBJECT- Note that the list of categories specified in a PIB module's SUBJECT-
CATEGORIES clause is not exclusive. That is, some other specification CATEGORIES clause is not exclusive. That is, some other specification
might (e.g., at a future date) specify additional COPS Client Types to might (e.g., at a future date) specify additional COPS Client Types to
which the module is relevant. which the module is relevant.
When a PIB module applies to multiple subject categories, that PIB When a PIB module applies to multiple subject categories, that PIB
module exists in multiple virtual information stores, one for each module exists in multiple virtual information stores, one for each
Client-Type. SPPI April 2001
Draft SPPI February 2001 Client-Type. A PIB module with SUBJECT-CATEGORIES "all" uses the named-
number specified in the SUBJECT-CATEGORIES of the PIB it is associated
with, as the COPS Client-Type when it is sent over COPS.
8. Mapping of the OBJECT-TYPE macro 7. Mapping of the OBJECT-TYPE macro
The SPPI requires that all attribute definitions be contained within a The SPPI requires that all attribute definitions be contained within a
PRC, i.e., within a table definition. PRC, i.e., within a table definition.
8.1. Mapping of the SYNTAX clause 7.1. Mapping of the SYNTAX clause
The SYNTAX clause, which must be present within the definition of an The SYNTAX clause, which must be present within the definition of an
attribute, defines the abstract data structure of that attribute. The attribute, defines the abstract data structure of that attribute. The
data structure must be one of the following: a base type, the BITS data structure must be one of the following: a base type, the BITS
construct, or a textual convention. construct, or a textual convention.
The SYNTAX clause must also be present for the table and row definitions The SYNTAX clause must also be present for the table and row definitions
of a PRC, and in this case must be a SEQUENCE OF or SEQUENCE (see of a PRC, and in this case must be a SEQUENCE OF or SEQUENCE (see
section 8.1.7 below). section 8.1.7 below).
The base types are an extended subset of the SMI's base types: The base types are an extended subset of the SMI's base types:
- built-in ASN.1 types: INTEGER, OCTET STRING, OBJECT IDENTIFIER, - built-in ASN.1 types: INTEGER, OCTET STRING, OBJECT IDENTIFIER,
- application-defined types: Integer32, IpAddress, Unsigned32, - application-defined types: Integer32, Unsigned32, TimeTicks,
TimeTicks, Integer64 and Unsigned64. Integer64 and Unsigned64.
A textual convention is a newly-defined type defined as a sub-type of a A textual convention is a newly-defined type defined as a sub-type of a
base type [TC]. The value of an attribute whose syntax is defined using base type [TC]. The value of an attribute whose syntax is defined using
a textual convention is encoded "on-the-wire" according to the textual a textual convention is encoded "on-the-wire" according to the textual
convention's underlying base type. convention's underlying base type.
Note that the set of base types has been chosen so as to provide Note that the set of base types has been chosen so as to provide
sufficient variety of on-the-wire encodings for attribute values; base sufficient variety of on-the-wire encodings for attribute values; base
types should contain a minimum of semantics. Semantics should, to the types should contain a minimum of semantics. Semantics should, to the
extent possible, be incorporated into a data type through the use of a extent possible, be incorporated into a data type through the use of a
textual convention. Thus, the IpAddress and TimeTicks data types should textual convention.
really be defined as textual conventions because they contain semantics.
However, they are defined here as base types so as to avoid confusion
with the SMI which defines them as base types.
The differences from the SMI in the semantics of ObjectSyntax are now The differences from the SMI in the semantics of ObjectSyntax are now
described. described.
8.1.1. Counter32 7.1.1. Counter32
The Counter32 type is not supported by the SPPI. The Counter32 type is not supported by the SPPI.
Draft SPPI February 2001 SPPI April 2001
8.1.2. Gauge32 7.1.2. Gauge32
The Gauge32 type is not supported by the SPPI. The Gauge32 type is not supported by the SPPI.
8.1.3. Opaque 7.1.3. Opaque
The Opaque type is not supported by the SPPI. The Opaque type is provided solely for backward-compatibility, and shall
not be used for newly-defined object types. The Opaque type supports the
capability to pass arbitrary ASN.1 syntax. A value is encoded using the
ASN.1 Basic Encoding Rules [ASN1] into a string of octets. This, in
turn, is encoded as an OCTET STRING, in effect "double-wrapping" the
original ASN.1 value. Note that a conforming implementation need only be
able to accept and recognize opaquely-encoded data. It need not be able
to unwrap the data and then interpret its contents. A requirement on
"standard" PIB modules is that no object may have a SYNTAX clause value
of Opaque.
8.1.4. Counter64 7.1.4. IpAddress
The IpAddress type is provided solely for backward-compatibility, and
shall not be used for newly-defined object types. Instead, It is
recommended to use the InetAddressType/InetAddress pair TCs as defined
in RFC2851 [INETADDR].
7.1.5. Counter64
The Counter64 type is not supported by the SPPI. The Counter64 type is not supported by the SPPI.
8.1.5. Integer64 7.1.6. Integer64
The Integer64 type represents integer-valued information between -2^63 The Integer64 type represents integer-valued information between -2^63
and 2^63-1 inclusive (-9223372036854775808 to 9223372036854775807 and 2^63-1 inclusive (-9223372036854775808 to 9223372036854775807
decimal). While Integer64 may be sub-typed to be more constrained, if decimal). While Integer64 may be sub-typed to be more constrained, if
the constraint results in all possible values being contained in the the constraint results in all possible values being contained in the
range (-2147483648..2147483647), then the Integer32 type must be used range (-2147483648..2147483647), then the Integer32 type must be used
instead of Integer64. instead of Integer64.
8.1.6. Unsigned64 7.1.7. Unsigned64
The Unsigned64 type represents integer-valued information between 0 and The Unsigned64 type represents integer-valued information between 0 and
2^64-1 inclusive (0 to 18446744073709551615 decimal). While Unsigned64 2^64-1 inclusive (0 to 18446744073709551615 decimal). While Unsigned64
may be sub-typed to be more constrained, if the constraint results in may be sub-typed to be more constrained, if the constraint results in
all possible values being contained in the range (0..4294967295), then all possible values being contained in the range (0..4294967295), then
the Unsigned32 type must be used instead of Unsigned64. the Unsigned32 type must be used instead of Unsigned64.
8.1.7. Provisioning Classes SPPI April 2001
7.1.8. Provisioning Classes
The operations (on PIBs) supported by the SPPI apply exclusively to The operations (on PIBs) supported by the SPPI apply exclusively to
PRCs. Each PRC is modelled as a tabular structure, i.e., a table. Each PRCs. Each PRC is modelled as a tabular structure, i.e., a table. Each
instance of a particular PRC has the same set of attributes. The set of instance of a particular PRC has the same set of attributes. The set of
attributes which belong to every instance of a particular PRC is attributes which belong to every instance of a particular PRC is
modelled as a row in the table. This model is formalized by using the modelled as a row in the table. Note that a PRC must have no more than
OBJECT-TYPE macro to define both: 127 attributes. The usage of subids (for PRC attributes) beyond 127
(that is 128 and above) is reserved for Mapping PIBs to MIBs (see
Appendix A). PRCs that require more than 127 attributes must use the
AUGMENTS clause to augment the PRC containing the initial 127 attributes
to add additional attributes. Definition of Provisioning Classes is
formalized by using the OBJECT-TYPE macro to define both:
- the PRC as a whole, called the table definition, and - the PRC as a whole, called the table definition, and
- the characteristics of every instance of a particular PRC, called - the characteristics of every instance of a particular PRC, called
the row definition. the row definition.
In the table definition, the SYNTAX clause has the form: In the table definition, the SYNTAX clause has the form:
Draft SPPI February 2001
SEQUENCE OF <EntryType> SEQUENCE OF <EntryType>
where <EntryType> refers to the SEQUENCE type of its attribute where <EntryType> refers to the SEQUENCE type of its attribute
definitions. In the row definition, the SYNTAX clause has the form: definitions. In the row definition, the SYNTAX clause has 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> }
skipping to change at page 23, line 28 skipping to change at page 22, line 5
where there is one <type> for each attribute, and each <type> is of the where there is one <type> for each attribute, and each <type> is of the
form: form:
<descriptor> <syntax> <descriptor> <syntax>
where <descriptor> is the descriptor naming an attribute, and <syntax> where <descriptor> is the descriptor naming an attribute, and <syntax>
has the value of that attribute's SYNTAX clause, except that both sub- has the value of that attribute's SYNTAX clause, except that both sub-
typing information and the named values for enumerated integers or the typing information and the named values for enumerated integers or the
named bits for the BITS construct, are omitted from <syntax>. named bits for the BITS construct, are omitted from <syntax>.
8.2. Mapping of the MAX-ACCESS clause SPPI April 2001
7.2. Mapping of the MAX-ACCESS clause
The MAX-ACCESS clause is not supported by the SPPI. The MAX-ACCESS clause is not supported by the SPPI.
8.3. Mapping of the PIB-ACCESS clause 7.3. Mapping of the PIB-ACCESS clause
The PIB-ACCESS clause must be present for a PRC's table definition, and The PIB-ACCESS clause must be present for a PRC's table definition, and
must not be present for any other OBJECT-TYPE definition. The PIB- must not be present for any other OBJECT-TYPE definition. The PIB-
ACCESS clause defines what kind of access is appropriate for the PRC. ACCESS clause defines what kind of access is appropriate for the PRC.
The PIB-ACCESS clause also optionally (default value is 127) provides a
number which is used in the algorithmic conversion of a PIB to a MIB
(see Appendix A).
- the value "install" is used to indicate a PRC which a PDP can - the value "install" is used to indicate a PRC which a PDP can
install in the PEP as provisioning information. install in the PEP as provisioning information.
- the value "notify" is used to indicate a PRC for which the PEP must - the value "notify" is used to indicate a PRC for which the PEP must
notify the PDP of all its instances and attribute values of that notify the PDP of all its instances and attribute values of that
PRC. PRC.
- the value "install-notify" is used to indicate the uncommon type of - the value "install-notify" is used to indicate the uncommon type of
PRC which has both characteristics: "install" and "notify". PRC which has both characteristics: "install" and "notify".
Draft SPPI February 2001
the value "report-only" is used to indicate a PRC which has neither the the value "report-only" is used to indicate a PRC which has neither the
"install" characteristic nor the "notify" characteristic. However, "install" characteristic nor the "notify" characteristic. However,
instances of such a PRC may be included in synchronous/asynchronous instances of such a PRC may be included in synchronous/asynchronous
reports generated by the PEP. (Note: PRCs having the "install" and/or reports generated by the PEP. (Note: PRCs having the "install" and/or
"notify" characteristics may also be included in reports generated by "notify" characteristics may also be included in reports generated by
the PEP.) the PEP.)
8.4. Mapping of the INSTALL-ERRORS clause 7.4. Mapping of the INSTALL-ERRORS clause
The INSTALL-ERRORS clause, which may optionally be present for a PRC's The INSTALL-ERRORS clause, which may optionally be present for a PRC's
table definition, and must be absent otherwise, lists one or more table definition, and must be absent otherwise, lists one or more
potential reasons for rejecting an install or a removal of an instance potential reasons for rejecting an install or a removal of an instance
of the PRC. Each reason consists of a named-number enumeration, where of the PRC. Each reason consists of a named-number enumeration, where
the number represents a PRC-specific error-code to be used in a COPS the number represents a PRC-specific error-code to be used in a COPS
protocol message, as the Sub-Error Code, with the Error-Code set to protocol message, as the Error Sub-code, with the Error-Code set to
priSpecificError (see [COPS-PR]). The semantics of each named-number priSpecificError (see [COPS-PR]). The semantics of each named-number
enumeration should be described in the PRC's DESCRIPTION clause. enumeration should be described in the PRC's DESCRIPTION clause.
The numbers listed in an INSTALL-ERRORS must be greater than zero and The numbers listed in an INSTALL-ERRORS must be greater than zero and
less than 65536. If this clause is not present, an install/remove can less than 65536. If this clause is not present, an install/remove can
still fail, but no PRC-specific error is available to be reported. still fail, but no PRC-specific error is available to be reported.
8.5. Mapping of the PIB-INDEX clause SPPI April 2001
7.5. Mapping of the PIB-INDEX clause
The PIB-INDEX clause, which must be present for a row definition (unless The PIB-INDEX clause, which must be present for a row definition (unless
an AUGMENTS or an EXTENDS clause is present instead), and must be absent an AUGMENTS or an EXTENDS clause is present instead), and must be absent
otherwise, defines identification information for instances of the PRC. otherwise, defines identification information for instances of the PRC.
The PIB-INDEX clause includes exactly one descriptor. This descriptor The PIB-INDEX clause includes exactly one descriptor. This descriptor
specifies an attribute (typically, but not necessarily of the same PRC) specifies an attribute (typically, but not necessarily of the same PRC)
which is used to identify an instance of that PRC. The syntax of this which is used to identify an instance of that PRC. The syntax of this
attribute is required to be InstanceId (a textual convention with an attribute is REQUIRED to be InstanceId (a textual convention with an
underlying syntax of Unsigned32), and it has no semantics other than its underlying syntax of Unsigned32), and it has no semantics other than its
use in identifying the PRC instance. The OBJECT IDENTIFIER which use in identifying the PRC instance. The OBJECT IDENTIFIER which
identifies an instance of a PRC is formed by appending one sub- identifies an instance of a PRC is formed by appending one sub-
identifier to the OID which identifies that PRC's row definition. The identifier to the OID which identifies that PRC's row definition. The
value of the additional sub-identifier is that instance's value of the value of the additional sub-identifier is that instance's value of the
attribute specified in the INDEX clause. attribute specified in the INDEX clause.
Note that SPPI does not permit use of the IMPLIED keyword in a PIB-INDEX Note that SPPI does not permit use of the IMPLIED keyword in a PIB-INDEX
clause. clause.
Draft SPPI February 2001 7.6. Mapping of the INDEX clause
8.6. Mapping of the INDEX clause
The INDEX clause is optionally present if a PIB-INDEX clause is present, The INDEX clause is optionally present if a PIB-INDEX clause is present,
and must be absent otherwise. If present, the INDEX clause can contain and must be absent otherwise. If present, the INDEX clause can contain
any number of attributes, and is used only by the algorithmic conversion any number of attributes, and is used only by the algorithmic conversion
of a PIB to a MIB (see Appendix A). of a PIB to a MIB (see Appendix A).
An IMPLIED keyword can be present in an INDEX clause if so desired. An IMPLIED keyword can be present in an INDEX clause if so desired.
8.7. Mapping of the AUGMENTS clause 7.7. Mapping of the AUGMENTS clause
The AUGMENTS clause, which must not be present except in row The AUGMENTS clause, which must not be present except in row
definitions, is an alternative to the PIB-INDEX clause and the EXTENDS definitions, is an alternative to the PIB-INDEX clause and the EXTENDS
clause. Every row definition has exactly one of: a PIB-INDEX clause, an clause. Every row definition has exactly one of: a PIB-INDEX clause, an
AUGMENTS clause, or an EXTENDS clause. AUGMENTS clause, or an EXTENDS clause.
A row definition which has a PIB-INDEX clause is called a base row A row definition which has a PIB-INDEX clause is called a base row
definition. A row definition which has an AUGMENTS clause is called a definition. A row definition which has an AUGMENTS clause is called a
row augmentation, where the AUGMENTS clause names the base row row augmentation, where the AUGMENTS clause names the base row
definition which is augmented by this row augmentation. (Thus, a row definition which is augmented by this row augmentation. (Thus, a row
augmentation cannot itself be augmented.) augmentation cannot itself be augmented.)
A PRC whose row definition is a row augmentation is called an augmenting A PRC whose row definition is a row augmentation is called an augmenting
PRC. Instances of an augmenting PRC are identified according to the PRC. Instances of an augmenting PRC are identified according to the
PIB-INDEX clause of the base row definition named in the AUGMENTS PIB-INDEX clause of the base row definition named in the AUGMENTS
SPPI April 2001
clause. Further, instances of an augmenting PRC exist according to the clause. Further, instances of an augmenting PRC exist according to the
same semantics as instances of the PRC which it augments. As such, when same semantics as instances of the PRC which it augments. As such, when
an instance of a PRC is installed or removed, an instance of every PRC an instance of a PRC is installed or removed, an instance of every PRC
which augments it is also installed or removed (for more details, see which augments it is also installed or removed. (for more details, see
[COPS-PR]). [COPS-PR]).
8.8. Mapping of the EXTENDS clause 7.8. Mapping of the EXTENDS clause
The EXTENDS clause, which must not be present except in row definitions, The EXTENDS clause, which must not be present except in row definitions,
is an alternative to the PIB-INDEX clause and the AUGMENTS clause. is an alternative to the PIB-INDEX clause and the AUGMENTS clause.
Every row definition has exactly one of: a PIB-INDEX clause, an AUGMENTS Every row definition has exactly one of: a PIB-INDEX clause, an AUGMENTS
clause, or an EXTENDS clause. clause, or an EXTENDS clause.
A row definition which has an EXTENDS clause is called a sparse row A row definition which has an EXTENDS clause is called a sparse row
augmentation, where the EXTENDS clause names the row definition which is augmentation, where the EXTENDS clause names the row definition which is
sparsely-augmented by this sparse row augmentation. The sparsely- sparsely-augmented by this sparse row augmentation. The sparsely-
augmented row can be a base row definition, or another sparse row augmented row can be a base row definition, or another sparse row
augmentation. augmentation.
Draft SPPI February 2001
A PRC whose row definition is a sparse row augmentation is called a A PRC whose row definition is a sparse row augmentation is called a
sparsely augmenting PRC. Instances of a sparsely augmenting PRC are sparsely augmenting PRC. Instances of a sparsely augmenting PRC are
identified according to the PIB-INDEX clause of the row definition named identified according to the PIB-INDEX clause of the row definition named
in the sparsely augmenting PRC's EXTENDS clause. in the sparsely augmenting PRC's EXTENDS clause.
An instance of a sparsely augmenting PRC can not exist unless a An instance of a sparsely augmenting PRC can not exist unless a
corresponding instance of the PRC which it sparsely augments exists. As corresponding instance of the PRC which it sparsely augments exists. As
such, when an instance of a PRC is removed, an instance of any PRC which such, when an instance of a PRC is removed, an instance of any PRC which
sparsely augments it is also removed. However, an instance of a sparsely augments it is also removed. However, an instance of a
sparsely augmenting PRC need not exist when the corresponding instance sparsely augmenting PRC need not exist when the corresponding instance
of the PRC that it sparsely augments exists. Thus, an instance of a of the PRC that it sparsely augments exists. Thus, an instance of a
sparsely augmenting PRC can be installed at the same time as or sparsely augmenting PRC can be installed at the same time as or
subsequent to the installation of, and can be removed prior to the subsequent to the installation of, and can be removed prior to the
removal of, the corresponding instance of the PRC that it sparsely removal of, the corresponding instance of the PRC that it sparsely
augments. So, instances of a sparsely augmenting PRC must be installed augments. So, instances of a sparsely augmenting PRC must be installed
explicitly, but are removed either implicitly (via removal of the explicitly, but are removed either implicitly (via removal of the
augmented PRI) or explicitly. augmented PRI) or explicitly. When a sparsely augmented PRC is
installed, both instances, the instance of the sparsely augmented PRC
and the instance of the sparsely augmenting PRC must be sent in one COPS
message.x
8.8.1. Relation between PIB-INDEX, AUGMENTS and EXTENDS clauses 7.8.1. Relation between PIB-INDEX, AUGMENTS and EXTENDS clauses
When defining instance identification information for a PRC: When defining instance identification information for a PRC:
SPPI April 2001
- If there is a one-to-one correspondence between instances of this - If there is a one-to-one correspondence between instances of this
PRC and instances of an existing PRC, then the AUGMENTS clause PRC and instances of an existing PRC, then the AUGMENTS clause
should be used. should be used.
- Otherwise, if there is a sparse relationship between instances of - Otherwise, if there is a sparse relationship between instances of
this PRC and instances of an existing PRC, then an EXTENDS clause this PRC and instances of an existing PRC (that is, there is a one
should be used. to zero or one correspondence between instances of a sparsely
augmented PRC and the instances of the PRC that sparsely augments
it.), then an EXTENDS clause should be used.
- Otherwise, a PIB-INDEX clause should be used which names its own - Otherwise, a PIB-INDEX clause should be used which names its own
InstanceId attribute. InstanceId attribute.
8.9. Mapping of the UNIQUENESS clause 7.9. Mapping of the UNIQUENESS clause
The UNIQUENESS clause, which is optionally present for any row The UNIQUENESS clause, which is optionally present for any row
definition which has a PIB-INDEX clause, and must be absent otherwise, definition, lists a set of zero or more of the PRC's attributes, for
lists a set of zero or more of the PRC's attributes, for which no two which no two instances of the PRC can have the same set of values. The
instances of the PRC can have the same set of values. The specified set specified set of attributes provide a necessary and sufficient set of
of attributes provide a necessary and sufficient set of values by which values by which to identify an instance of this PRC. The attribute
to identify an instance of this PRC. The attribute contained in the contained in the PIB-INDEX clause may not be present in the UNIQUENESS
PIB-INDEX clause may not be present in the UNIQUENESS clause. By clause. By definition, an attribute may not appear more than once in a
definition, an attribute may not appear more than once in a UNIQUENESS UNIQUENESS clause. A UNIQUENESS clause containing zero attributes
clause. A UNIQUENESS clause containing zero attributes indicates that indicates that it's possible for two instances of the PRC to have
identical values for all attributes except, of course, for the one named
Draft SPPI February 2001 in the PIB-INDEX clause.
it's possible for two instances of the PRC to have identical values for If a PRC and its sparsely augmenting PRC both have UNIQUENESS clauses,
all attributes except, of course, for the one named in the PIB-INDEX then the UNIQUENESS constraint for instances of each PRC MUST be applied
clause. according to the UNIQUENESS clause in the corresponding PRC definition.
Note that a sparsely augmenting PRC thus can override the UNIQUENESS
clause of the PRC it sparsely augments.
Even though the UNIQUENESS clause is optional, its inclusion is Even though the UNIQUENESS clause is optional, its inclusion is
recommended wherever it provides useful information. recommended wherever it provides useful information.
8.10. Mapping of the PIB-REFERENCES clause 7.10. Mapping of the PIB-REFERENCES clause
The PIB-REFERENCES clause, which must be present for any attribute which The PIB-REFERENCES clause, which must be present for any attribute which
has the SYNTAX of ReferenceId, and must be absent otherwise, names the has the SYNTAX of ReferenceId, and must be absent otherwise, names the
PRC, an instance of which is referenced by the ReferenceId attribute. PRC, an instance of which is referenced by the ReferenceId attribute.
For example usages of the PIB-REFERENCES clause, see Appendix B. For example usages of the PIB-REFERENCES clause, see Appendix B.
8.11. Mapping of the PIB-TAG clause SPPI April 2001
7.11. Mapping of the PIB-TAG clause
The PIB-TAG clause, which must be present for an attribute which has the The PIB-TAG clause, which must be present for an attribute which has the
SYNTAX TagReferenceId, and must be absent otherwise, is used to indicate SYNTAX TagReferenceId, and must be absent otherwise, is used to indicate
that this attribute references a "tag list" of instances of another PRC. that this attribute references a "tag list" of instances of another PRC.
Such a tag list (similar in concept to the usage of the same term in Such a tag list (similar in concept to the usage of the same term in
[APPL]) is formed by all instances of the other PRC which have the same [APPL]) is formed by all instances of the other PRC which have the same
(tag) value of a particular attribute of that other PRC. The particular (tag) value of a particular attribute of that other PRC. The particular
attribute of the other PRC, which must have the SYNTAX TagId, is named attribute of the other PRC, which must have the SYNTAX TagId, is named
in the PIB-TAG clause. For an example usage of the PIB-TAG clause, see in the PIB-TAG clause. For an example usage of the PIB-TAG clause, see
Appendix B. Appendix B.
9. Mapping of the OBJECT-IDENTITY macro 8. Mapping of the OBJECT-IDENTITY macro
The OBJECT-IDENTITY macro is used in PIB modules to define information The OBJECT-IDENTITY macro is used in PIB modules to define information
about an OBJECT IDENTIFIER assignment. about an OBJECT IDENTIFIER assignment.
Draft SPPI February 2001 9. Mapping of the OBJECT-GROUP macro
10. Mapping of the OBJECT-GROUP macro
For conformance purposes, it is useful to define a conformance group as For conformance purposes, it is useful to define a conformance group as
a collection of related PRCs and their attributes. The OBJECT-GROUP a collection of related PRCs and their attributes. The OBJECT-GROUP
macro (directly) defines the collection of attributes which belong to a macro (directly) defines the collection of attributes which belong to a
conformance group. Since each attribute included in the collection conformance group. Since each attribute included in the collection
belongs to a PRC, the collection of related PRCs which belong to a belongs to a PRC, the collection of related PRCs which belong to a
conformance group is also specified (indirectly) as the set of PRCs to conformance group is also specified (indirectly) as the set of PRCs to
which the included attributes belong. which the included attributes belong.
10.1. Mapping of the OBJECTS clause 9.1. Mapping of the OBJECTS clause
The OBJECTS clause, which must be present, is used to specify each The OBJECTS clause, which must be present, is used to specify each
attribute contained in the conformance group. Each of the specified attribute contained in the conformance group. Each of the specified
attributes must be defined in the same PIB module as the OBJECT-GROUP attributes must be defined in the same PIB module as the OBJECT-GROUP
macro appears. macro appears.
It is required that every attribute defined in a PIB module be contained It is required that every attribute defined in a PIB module be contained
in at least one conformance group. This avoids the common error of in at least one conformance group. This avoids the common error of
adding a new attribute to a module and forgetting to add the new adding a new attribute to a module and forgetting to add the new
attribute to a group. attribute to a group.
11. Mapping of the MODULE-COMPLIANCE macro SPPI April 2001
10. Mapping of the MODULE-COMPLIANCE macro
The MODULE-COMPLIANCE macro is used to convey a minimum set of The MODULE-COMPLIANCE macro is used to convey a minimum set of
requirements with respect to implementation of one or more PIB modules. requirements with respect to implementation of one or more PIB modules.
A requirement on all "standard" PIB modules is that a corresponding A requirement on all "standard" PIB modules is that a corresponding
MODULE-COMPLIANCE specification is also defined, either in the same MODULE-COMPLIANCE specification is also defined, either in the same
module or in a companion module. module or in a companion module.
11.1. Mapping of the MODULE clause 10.1. Mapping of the MODULE clause
The MODULE clause, which must be present, is repeatedly used to name The MODULE clause, which must be present, is repeatedly used to name
each PIB module for which compliance requirements are being specified. each PIB module for which compliance requirements are being specified.
Each PIB module is named by its module name, and optionally, by its Each PIB module is named by its module name, and optionally, by its
associated OBJECT IDENTIFIER as well. The module name can be omitted associated OBJECT IDENTIFIER as well. The module name can be omitted
when the MODULE-COMPLIANCE invocation occurs inside a PIB module, to when the MODULE-COMPLIANCE invocation occurs inside a PIB module, to
refer to the encompassing PIB module. refer to the encompassing PIB module.
11.1.1. Mapping of the MANDATORY-GROUPS clause 10.1.1. Mapping of the MANDATORY-GROUPS clause
The MANDATORY-GROUPS clause, which need not be present, names the one or The MANDATORY-GROUPS clause, which need not be present, names the one or
more conformance groups within the correspondent PIB module which are more conformance groups within the correspondent PIB module which are
Draft SPPI February 2001
unconditionally mandatory for implementation. If an agent claims unconditionally mandatory for implementation. If an agent claims
compliance to the PIB module, then it must implement each and every compliance to the PIB module, then it must implement each and every
attribute (and therefore the PRCs to which they belong) within each attribute (and therefore the PRCs to which they belong) within each
conformance group listed. conformance group listed.
11.1.2. Mapping of the GROUP clause 10.1.2. Mapping of the GROUP clause
The GROUP clause, which need not be present, is repeatedly used to name The GROUP clause, which need not be present, is repeatedly used to name
each conformance group which is conditionally mandatory for compliance each conformance group which is conditionally mandatory for compliance
to the PIB module. The GROUP clause can also be used to name to the PIB module. The GROUP clause can also be used to name
unconditionally optional groups. A group named in a GROUP clause must unconditionally optional groups. A group named in a GROUP clause must
be absent from the correspondent MANDATORY-GROUPS clause. be absent from the correspondent MANDATORY-GROUPS clause.
Conditionally mandatory groups include those which are mandatory only if Conditionally mandatory groups include those which are mandatory only if
a particular protocol is implemented, or only if another group is a particular protocol is implemented, or only if another group is
implemented. A GROUP clause's DESCRIPTION specifies the conditions implemented. A GROUP clause's DESCRIPTION specifies the conditions
under which the group is conditionally mandatory. under which the group is conditionally mandatory.
A group which is named in neither a MANDATORY-GROUPS clause nor a GROUP A group which is named in neither a MANDATORY-GROUPS clause nor a GROUP
clause, is unconditionally optional for compliance to the PIB module. clause, is unconditionally optional for compliance to the PIB module.
11.1.3. Mapping of the OBJECT clause SPPI April 2001
10.1.3. Mapping of the OBJECT clause
The OBJECT clause, which need not be present, is repeatedly used to The OBJECT clause, which need not be present, is repeatedly used to
specify each attribute for which compliance has a refined requirement specify each attribute for which compliance has a refined requirement
with respect to the PIB module definition. The attribute must be with respect to the PIB module definition. The attribute must be
present in one of the conformance groups named in the correspondent present in one of the conformance groups named in the correspondent
MANDATORY-GROUPS clause or GROUP clauses. MANDATORY-GROUPS clause or GROUP clauses.
By definition, each attribute specified in an OBJECT clause follows a By definition, each attribute specified in an OBJECT clause follows a
MODULE clause which names the PIB module in which that attribute is MODULE clause which names the PIB module in which that attribute is
defined. Therefore, the use of an IMPORTS statement, to specify from defined. Therefore, the use of an IMPORTS statement, to specify from
where such attributes are imported, is redundant and is not required in where such attributes are imported, is redundant and is not required in
a PIB module. a PIB module.
11.1.3.1. Mapping of the SYNTAX clause 10.1.3.1. Mapping of the SYNTAX clause
The SYNTAX clause, which need not be present, is used to provide a The SYNTAX clause, which need not be present, is used to provide a
refined SYNTAX for the attribute named in the correspondent OBJECT refined SYNTAX for the attribute named in the correspondent OBJECT
clause. The refined syntax is the minimum level of support needed for clause. The refined syntax is the minimum level of support needed for
this attribute in order to be compliant. this attribute in order to be compliant.
Draft SPPI February 2001 10.1.3.2. Mapping of the WRITE-SYNTAX clause
11.1.3.2. Mapping of the WRITE-SYNTAX clause
The WRITE-SYNTAX clause is not supported by the SPPI. The WRITE-SYNTAX clause is not supported by the SPPI.
11.1.3.3. Mapping of the PIB-MIN-ACCESS clause 10.1.3.3. Mapping of the PIB-MIN-ACCESS clause
The PIB-MIN-ACCESS clause, which need not be present, is used to define The PIB-MIN-ACCESS clause, which need not be present, is used to define
the minimal level of access for the attribute named in the correspondent the minimal level of access for the attribute named in the correspondent
OBJECT clause. If this clause is absent, the minimal level of access is OBJECT clause. If this clause is absent, the minimal level of access is
the same as the maximal level specified in the PIB-ACCESS clause of the the same as the maximal level specified in the PIB-ACCESS clause of the
correspondent invocation of the OBJECT-TYPE macro. If present, this correspondent invocation of the OBJECT-TYPE macro. If present, this
clause must specify a subset of the access specified in the clause must specify a subset of the access specified in the
correspondent PIB-ACCESS clause, where: "install" is a subset of correspondent PIB-ACCESS clause, where: "install" is a subset of
"install-notify", "notify" is a subset of "install-notify", and "not- "install-notify", "notify" is a subset of "install-notify", and "not-
accessible" is a subset of all other values. accessible" is a subset of all other values.
An implementation is compliant if the level of access it provides is the An implementation is compliant if the level of access it provides is the
same or a superset of the minimal level in the MODULE-COMPLIANCE macro same or a superset of the minimal level in the MODULE-COMPLIANCE macro
and the same or a subset of the maximal level in the PIB-ACCESS clause. and the same or a subset of the maximal level in the PIB-ACCESS clause.
12. Textual Conventions SPPI April 2001
11. Textual Conventions
When designing a PIB module, it is often useful to define new data types When designing a PIB module, it is often useful to define new data types
similar to those defined in the SPPI. In comparison to a type defined similar to those defined in the SPPI. In comparison to a type defined
in the SPPI, each of these new types has a different name, a similar in the SPPI, each of these new types has a different name, a similar
syntax, and specific semantics. These newly defined types are termed syntax, and specific semantics. These newly defined types are termed
textual conventions, and are used for the convenience of humans reading textual conventions, and are used for the convenience of humans reading
the PIB module. the PIB module.
Attributes defined using a textual convention are always encoded by Attributes defined using a textual convention are always encoded by
means of the rules that define their underlying type. means of the rules that define their underlying type.
12.1. Mapping of the TEXTUAL-CONVENTION macro 11.1. Mapping of the TEXTUAL-CONVENTION macro
The TEXTUAL-CONVENTION macro is used to convey the syntax and semantics The TEXTUAL-CONVENTION macro is used to convey the syntax and semantics
associated with a textual convention. It should be noted that the associated with a textual convention. It should be noted that the
expansion of the TEXTUAL-CONVENTION macro is something which expansion of the TEXTUAL-CONVENTION macro is something which
conceptually happens during implementation and not during run-time. conceptually happens during implementation and not during run-time.
The name of a textual convention must consist of one or more letters or The name of a textual convention must consist of one or more letters or
digits, with the initial character being an upper case letter. The name digits, with the initial character being an upper case letter. The name
must not conflict with any of the reserved words listed in section 5.2, must not conflict with any of the reserved words listed in section 5.2,
should not consist of all upper case letters, and shall not exceed 64 should not consist of all upper case letters, and shall not exceed 64
characters in length. (However, names longer than 32 characters are not characters in length. (However, names longer than 32 characters are not
Draft SPPI February 2001
recommended.) The hyphen is not allowed in the name of a textual recommended.) The hyphen is not allowed in the name of a textual
convention (except for use in information modules converted from SMIv1 convention (except for use in information modules converted from SMIv1
which allowed hyphens in ASN.1 type assignments). Further, all names which allowed hyphens in ASN.1 type assignments). Further, all names
used for the textual conventions defined in all "standard" PIB modules used for the textual conventions defined in all "standard" PIB modules
shall be unique. shall be unique.
12.1.1. Mapping of the SYNTAX clause 11.1.1. Mapping of the SYNTAX clause
The SYNTAX clause, which must be present, defines abstract data The SYNTAX clause, which must be present, defines abstract data
structure corresponding to the textual convention. The data structure structure corresponding to the textual convention. The data structure
must be one of the following: a base type (see the SYNTAX clause of an must be one of the following: a base type (see the SYNTAX clause of an
OBJECT-TYPE macro), or the BITS construct. Note that this means that OBJECT-TYPE macro), or the BITS construct. Note that this means that
the SYNTAX clause of a Textual Convention can not refer to a previously the SYNTAX clause of a Textual Convention can not refer to a previously
defined Textual Convention. defined Textual Convention.
12.1.1.1. Sub-typing of Textual Conventions 11.1.1.1. Sub-typing of Textual Conventions
The SYNTAX clause of a TEXTUAL CONVENTION macro may be sub-typed in the The SYNTAX clause of a TEXTUAL CONVENTION macro may be sub-typed in the
same way as the SYNTAX clause of an OBJECT-TYPE macro. same way as the SYNTAX clause of an OBJECT-TYPE macro.
13. Extending a PIB Module SPPI April 2001
The SMI's rules for extending an information module are augmented with 12. Extending a PIB Module
the following rules:
13.1. OBJECT-TYPE Definitions PIBs may be revised as implementation experience is gained. However,
changes with potential to cause disruption to interoperability between
the previous PIB and the revised PIB are not allowed.
An invocation of the OBJECT-TYPE macro may also be revised in any of the 12.1. PIB Modules
following ways:
For any change, the invocation of the MODULE-IDENTITY macro must be
updated to include information about the revision: specifically,
updating the LAST-UPDATED clause, adding a pair of REVISION and
DESCRIPTION clauses, and making any necessary changes to existing
clauses, including the ORGANIZATION and CONTACT-INFO clauses.
Note that any definition contained in an existing PIB is available to be
IMPORT-ed by any other PIB, and is referenced in an IMPORTS clause via
the PIB module name. Thus, a PIB module name should not be changed.
Definitions should not be moved from one PIB to another.
Also note that obsolete definitions must not be removed from PIB modules
since their descriptors may still be referenced by other PIB modules,
and the OBJECT IDENTIFIERs used to name them must never be re-assigned.
The EXTENDS/AUGMENTS clause should be used to extend previous
definitions depending on the information to be represented.
Changes to an existing PIB can be made in several ways:
- Additional PRCs can be added to a PIB or an existing one
deprecated.
- Attributes can be added to, or deprecated from, an existing PRC.
Note that an ASN.1 value of the correct type or an ASN.1 NULL value
must be sent even for deprecated attributes to mantain
interoperability. New attributes must be added in sequence after
the existing ones.
- An existing PRC can be extended or augmented with a new PRC defined
in another (perhaps enterprise specific) PIB.
Additional named-number enumerations may be added to a SUBJECT-
CATEGORIES clause.
SPPI April 2001
12.2. 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.
Note that the max subid for PRC attributes is 127 (See Section 7.1.8)
12.3. Object Definitions
An object definition may be revised in any of the following ways:
- A SYNTAX clause containing an enumerated INTEGER may have new
enumerations added or existing labels changed. Similarly, named
bits may be added or existing labels changed for the BITS
construct.
- The value of a SYNTAX clause may be replaced by a textual
convention, providing the textual convention is defined to use the
same primitive ASN.1 type, has the same set of values, and has
identical semantics.
- A UNITS clause may be added.
- 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, the
DESCRIPTION clause should be updated to explain the rationale.
- Clarifications and additional information may be included in the
DESCRIPTION clause.
- An INSTALL-ERRORS clause may be added or an existing INSTALL-ERRORS - An INSTALL-ERRORS clause may be added or an existing INSTALL-ERRORS
clause have additional errors defined. clause have additional errors defined.
- Additional named-number enumerations may be added to a SUBJECT- - A REFERENCE clause may be added or updated.
CATEGORIES clause.
Draft SPPI February 2001 - A DEFVAL clause may be added or updated.
14. Appendix A: Mapping a PIB to a MIB - A PRC may be augmented by adding new objects at the end of the row,
and making the corresponding update to the SEQUENCE definition.
Since the SPPI is modelled on the SMI, a PIB can be easily and - Entirely new objects may be defined, named with previously
unassigned OBJECT IDENTIFIER values.
SPPI April 2001
Otherwise, if the semantics of any previously defined object are changed
(i.e., if a non-editorial change is made to any clause other than those
specifically allowed above), then the OBJECT IDENTIFIER value associated
with that object must also be changed.
Note that changing the descriptor associated with an existing object is
considered a semantic change, as these strings may be used in an IMPORTS
statement.
SPPI April 2001
13. Appendix A: Mapping a PIB to a MIB
Since the SPPI is modelled on the SMI, a PIB can be potentially
algorithmically mapped into a MIB. This mapping is achieved by means of algorithmically mapped into a MIB. This mapping is achieved by means of
the following rules: the following rules:
- Modify the module's module name by appending "-MIB" to the name. - Modify the module's module name by appending "-MIB" to the name.
- Change the OID assigned to the MODULE-IDENTITY to be different - Change the OID assigned to the MODULE-IDENTITY to be different
value. value.
- Replace the keyword PIB-DEFINITIONS with the keyword DEFINITIONS. - Replace the keyword PIB-DEFINITIONS with the keyword DEFINITIONS.
skipping to change at page 32, line 44 skipping to change at page 33, line 44
- Add a MAX-ACCESS clause for each OBJECT-TYPE. For each table - Add a MAX-ACCESS clause for each OBJECT-TYPE. For each table
definition and row definition, the MAX-ACCESS is "not-accessible". definition and row definition, the MAX-ACCESS is "not-accessible".
For each attribute that is in the INDEX clause, the MAX-ACCESS is For each attribute that is in the INDEX clause, the MAX-ACCESS is
"not-accessible". For the remaining attributes, the MAX-ACCESS is "not-accessible". For the remaining attributes, the MAX-ACCESS is
"read-create". "read-create".
- Add a columnar attribute of type RowStatus with a descriptor and - Add a columnar attribute of type RowStatus with a descriptor and
appropriate DESCRIPTION. The descriptor can be formed by appending appropriate DESCRIPTION. The descriptor can be formed by appending
the nine characters "RowStatus" to the end of the PRC's descriptor the nine characters "RowStatus" to the end of the PRC's descriptor
(truncated if necessary to avoid the resulting descriptor being too (truncated if necessary to avoid the resulting descriptor being too
long). The optional number provided by the PIB-ACCESS clause is long). A Subid beyond 127 (i.e., 128 and above) can be used as the
used as the OID for this columnar attribute. If no number is OID for this columnar attribute.
provided by the PIB-ACCESS clause, then the default number 127 is
used.
- Modify any SYNTAX clause which has a base data type which is not - Modify any SYNTAX clause which has a base data type which is not
allowed in the SMI, either to be a valid SMI data type or to omit allowed in the SMI, either to be a valid SMI data type or to omit
the OBJECT-TYPE or TEXTUAL-CONVENTION definition and all references the OBJECT-TYPE or TEXTUAL-CONVENTION definition and all references
Draft SPPI February 2001
to it. Since it is not clear (at this time) which is the best SMI to it. Since it is not clear (at this time) which is the best SMI
data type to use, the conversion SHOULD provide a configurable data type to use, the conversion SHOULD provide a configurable
SPPI April 2001
option allowing a choice from at least the following: option allowing a choice from at least the following:
- convert to an OCTET STRING of the relevant size. - convert to an OCTET STRING of the relevant size.
Specifically, this option would map both Integer64 and Specifically, this option would map both Integer64 and
Unsigned64 to OCTET STRING (SIZE(8)), or Unsigned64 to OCTET STRING (SIZE(8)), or
- omit them from the conversion, or - omit them from the conversion, or
- map Integer64 and Unsigned64 to Counter64 (even though this - map Integer64 and Unsigned64 to Counter64 (even though this
has problems representing negative numbers, and unwanted has problems representing negative numbers, and unwanted
counter semantics.) counter semantics.)
SPPI April 2001
Draft SPPI February 2001 14. Appendix B: Example usage of PIB-REFERENCES and PIB-TAG clauses
15. Appendix B: Example usage of PIB-REFERENCES and PIB-TAG clauses
The following example demonstrates the use of the PIB-REFERENCES and The following example demonstrates the use of the PIB-REFERENCES and
PIB-TAG clauses. PIB-TAG clauses.
In this example, the PIB-REFERENCES clause is used by the In this example, the PIB-REFERENCES clause is used by the
qosIfDscpMapQueue attribute to indicate the PRC of which it references qosIfDscpMapQueue attribute to indicate the PRC of which it references
an instance, and similarly, by the qosIfDscpMapThresh attribute. an instance, and similarly, by the qosIfDscpMapThresh attribute.
The qosIfDscpMapTable PRC has an instance for each DSCP of a particular The qosIfDscpMapTable PRC has an instance for each DSCP of a particular
"map", but there is no PRC defined for a map itself; rather, a map "map", but there is no PRC defined for a map itself; rather, a map
skipping to change at page 34, line 49 skipping to change at page 35, line 48
QosIfDscpAssignEntry ::= SEQUENCE { QosIfDscpAssignEntry ::= SEQUENCE {
qosIfDscpAssignPrid InstanceId, qosIfDscpAssignPrid InstanceId,
qosIfDscpAssignName SnmpAdminString, qosIfDscpAssignName SnmpAdminString,
qosIfDscpAssignRoles RoleCombination, qosIfDscpAssignRoles RoleCombination,
qosIfDscpAssignDscpMap TagReferenceId qosIfDscpAssignDscpMap TagReferenceId
} }
qosIfDscpAssignDscpMap OBJECT-TYPE qosIfDscpAssignDscpMap OBJECT-TYPE
SYNTAX TagReferenceId SYNTAX TagReferenceId
PIB-TAG qosIfDscpMapMapId -- attribute defined below PIB-TAG { qosIfDscpMapMapId } -- attribute defined below
STATUS current STATUS current
DESCRIPTION DESCRIPTION
SPPI April 2001
Draft SPPI February 2001
"The DSCP map which is applied to interfaces of type "The DSCP map which is applied to interfaces of type
qosIfDscpAssignName which have a role combination of qosIfDscpAssignName which have a role combination of
qosIfDscpAssignRoles." qosIfDscpAssignRoles."
::= { qosIfDscpAssignEntry 3 } ::= { qosIfDscpAssignEntry 3 }
-- --
-- DSCP to Queue and Threshold Mapping Table -- DSCP to Queue and Threshold Mapping Table
-- --
skipping to change at page 36, line 4 skipping to change at page 37, line 4
qosIfDscpMapMapId OBJECT-TYPE qosIfDscpMapMapId OBJECT-TYPE
SYNTAX TagId SYNTAX TagId
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"An integer that identifies the DSCP map to which this PRI "An integer that identifies the DSCP map to which this PRI
belongs." belongs."
::= { qosIfDscpMapEntry 2 } ::= { qosIfDscpMapEntry 2 }
qosIfDscpMapQueue OBJECT-TYPE qosIfDscpMapQueue OBJECT-TYPE
SPPI April 2001
Draft SPPI February 2001
SYNTAX ReferenceId SYNTAX ReferenceId
PIB-REFERENCES qosIfQueueTable PIB-REFERENCES { qosIfQueueEntry }
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This attribute maps the DSCP specified by qosIfDscpMapDscp to "This attribute maps the DSCP specified by qosIfDscpMapDscp to
the queue identified by qosIfQueuePrid in qosIfQueueTable. the queue identified by qosIfQueuePrid in qosIfQueueTable.
For a given DSCP map, all the queues must belong to a single For a given DSCP map, all the queues must belong to a single
queue set." queue set."
::= { qosIfDscpMapEntry 4 } ::= { qosIfDscpMapEntry 4 }
qosIfDscpMapThresh OBJECT-TYPE qosIfDscpMapThresh OBJECT-TYPE
SYNTAX ReferenceId SYNTAX ReferenceId
PIB-REFERENCES qosIfThresholdTable PIB-REFERENCES { qosIfThresholdEntry }
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This attribute maps the DSCP specified by qosIfDscpMapDscp to "This attribute maps the DSCP specified by qosIfDscpMapDscp to
the threshold identified by qosIfThresholdId in the threshold identified by qosIfThresholdId in
qosIfThresholdTable. The threshold set to which this qosIfThresholdTable. The threshold set to which this
threshold belongs must be assigned to the queue specified by threshold belongs must be assigned to the queue specified by
qosIfDscpMapQueue." qosIfDscpMapQueue."
::= { qosIfDscpMapEntry 5 } ::= { qosIfDscpMapEntry 5 }
SPPI April 2001
Draft SPPI February 2001 15. Security Considerations
16. Security Considerations
This document defines a language with which to define provisioning This document defines a language with which to define provisioning
information. The language itself has no security impact on the information. The language itself has no security impact on the
Internet. Internet.
16. IANA Considerations
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 }
The mgmt(2) subtree is used to identify "standard" objects.
This document defines
pib OBJECT IDENTIFIER ::= { mgmt 2 }
as the root for PIBs defined to be carried over [COPS-PR]. This Object
Identifier is a high level assignment that needs to be registered with
[IANA]. Root Object Identifiers for future "standards track" PIBs will
also need to be registered and MUST use Object Identifiers below this
oid. A standards track PIB can only be assigned an OID by IANA if the
PIB is approved by the IESG as a "standards track" document.
Experimental and enterprise PIBs MUST be defined under the
"experimental" and "enterprises" Object Identifiers respectively.
The PIB module "copsPrSppiTc" is defined in this document as a standard
module and hence, needs a subid assignment under the "pib" oid from
IANA.
SPPI April 2001
SPPI SUBJECT-CATEGORIES are mapped to COPS Client Types. IANA
Considerations for SUBJECT-CATEGORIES follow the same requirements as
specified in [COPS] IANA Considerations for COPS Client Types. Thus, a
new PIB can define a new COPS Client Type in the "standards",
"experimental" or "enterprise" space, and when approved that would mean
that a new COPS Client Type gets assigned. IANA must update the registry
for COPS CLient Types (where applicable as described in [COPS] IANA
Considerations) as a result.
17. Authors' Addresses 17. Authors' Addresses
Keith McCloghrie Keith McCloghrie
Cisco Systems, Inc. Cisco Systems, Inc.
170 West Tasman Drive 170 West Tasman Drive
San Jose, CA 95134-1706 USA San Jose, CA 95134-1706 USA
Phone: +1 408 526 5260 Phone: +1 408 526 5260
Email: kzm@cisco.com Email: kzm@cisco.com
Michael Fine Michael Fine
skipping to change at page 38, line 4 skipping to change at page 40, line 4
Billerica, MA 01821 USA Billerica, MA 01821 USA
Phone: +1 978 288 8175 Phone: +1 978 288 8175
Email: khchan@nortelnetworks.com Email: khchan@nortelnetworks.com
Scott Hahn Scott Hahn
Intel Intel
2111 NE 25th Avenue 2111 NE 25th Avenue
Hillsboro, OR 97124 USA Hillsboro, OR 97124 USA
Phone: +1 503 264 8231 Phone: +1 503 264 8231
Email: scott.hahn@intel.com Email: scott.hahn@intel.com
SPPI April 2001
Draft SPPI February 2001
Ravi Sahita Ravi Sahita
Intel Intel
2111 NE 25th Avenue 2111 NE 25th Avenue
Hillsboro, OR 97124 USA Hillsboro, OR 97124 USA
Phone: +1 503 712 1554 Phone: +1 503 712 1554
Email: ravi.sahita@intel.com Email: ravi.sahita@intel.com
Andrew Smith Andrew Smith
Allegro Networks Allegro Networks
skipping to change at page 38, line 44 skipping to change at page 40, line 43
Sastry, "The COPS (Common Open Policy Service) Protocol" RFC 2748, Sastry, "The COPS (Common Open Policy Service) Protocol" RFC 2748,
January 2000. January 2000.
[COPS-RSVP] [COPS-RSVP]
Boyle, J., Cohen, R., Durham, D., Herzog, S., Rajan, R., and A. Boyle, J., Cohen, R., Durham, D., Herzog, S., Rajan, R., and A.
Sastry, " COPS usage for RSVP", RFC 2749, January 2000. Sastry, " COPS usage for RSVP", RFC 2749, January 2000.
[COPS-PR] [COPS-PR]
Reichmeyer, F., Herzog, S., Chan, K., Durham, D., Yavatkar, R. Reichmeyer, F., Herzog, S., Chan, K., Durham, D., Yavatkar, R.
Gai, S., McCloghrie, K. and A. Smith, "COPS Usage for Policy Gai, S., McCloghrie, K. and A. Smith, "COPS Usage for Policy
Provisioning" Internet Draft, draft-ietf-rap-cops-pr-04.txt, August Provisioning" RFC 3084, March 2001.
2000.
[SMI] [SMI]
McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M.,
and S. Waldbusser. "Structure of Management Information Version 2 and S. Waldbusser. "Structure of Management Information Version 2
(SMIv2)", RFC 2578, April 1999. (SMIv2)", RFC 2578, STD 58, April 1999.
Draft SPPI February 2001 SPPI April 2001
[TC] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., [TC] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M.,
and S. Waldbusser. "Textual Conventions for SMIv2", RFC 2579, and S. Waldbusser. "Textual Conventions for SMIv2", RFC 2579, STD
April 1999. 58, April 1999.
[CONF] [CONF]
McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M.,
and S. Waldbusser. "Conformance Statements for SMIv2", RFC 2580, and S. Waldbusser. "Conformance Statements for SMIv2", RFC 2580,
April 1999. STD 58, April 1999.
[APPL] [APPL]
Levi, D., Meyer, P., and B. Stewart, "SNMP Applications", RFC 2573, Levi, D., Meyer, P., and B. Stewart, "SNMP Applications", RFC 2573,
April 1999. April 1999.
[ASN1] [ASN1]
Information processing systems -- Open Systems Interconnection -- Information processing systems -- Open Systems Interconnection --
Specification of Abstract Syntax Notation One (ASN.1), Specification of Abstract Syntax Notation One (ASN.1),
International Organization for Standardization. International International Organization for Standardization. International
Standard 8824, December 1987. Standard 8824, December 1987.
[INETADDR] [INETADDR]
M. Daniele, B. Haberman, S. Routhier and J. Schoenwaelder "Textual M. Daniele, B. Haberman, S. Routhier and J. Schoenwaelder "Textual
Conventions for Internet Network Addresses", RFC 2851, June 2000. Conventions for Internet Network Addresses", RFC 2851, June 2000.
Draft SPPI February 2001 [IANA]
http://www.isi.edu/in-notes/iana/assignments/smi-numbers
[IANA-CONSIDERATIONS]
Alvestrand, H. and T. Narten, "Guidelines for Writing an IANA
Considerations Section in RFCs", BCP 26, RFC 2434, October 1998.
[RFC-2119]
Bradner, S., "Key words for use in RFCs to Indicate Requirement
Levels", BCP 14, RFC 2119, March 1997
SPPI April 2001
19. Full Copyright Statement 19. Full Copyright Statement
Copyright (C) The Internet Society (2000). All Rights Reserved. Copyright (C) The Internet Society (2000). All Rights Reserved.
This document and translations of it may be copied and furnished to This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it or others, and derivative works that comment on or otherwise explain it or
assist in its implementation may be prepared, copied, published and assist in its implementation may be prepared, copied, published and
distributed, in whole or in part, without restriction of any kind, distributed, in whole or in part, without restriction of any kind,
provided that the above copyright notice and this paragraph are included provided that the above copyright notice and this paragraph are included
skipping to change at page 41, line 4 skipping to change at page 43, line 4
The limited permissions granted above are perpetual and will not be The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns. revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an "AS This document and the information contained herein is provided on an "AS
IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT
INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE." FITNESS FOR A PARTICULAR PURPOSE."
SPPI April 2001
Draft SPPI February 2001
Table of Contents Table of Contents
1 Introduction .................................................... 2 1 Use of the SMI .................................................. 2
1.1 Change Log .................................................... 2 1.1 Terminology Translation ....................................... 2
1.1.1 Changes made in version published on 13 July 2000 ........... 2 1.2 Overview ...................................................... 3
1.1.2 Changes made in version published on 20 September 2000 ...... 3 2 Structure of this Specification ................................. 3
1.1.3 Changes made in version published on 13 November 2000 ....... 4 3 Definitions ..................................................... 4
1.1.4 Changes made in version published 22 January 2001 ........... 4 4 PIB Modules ..................................................... 17
1.1.5 Changes made in version published 20 February 2001 .......... 4 4.1 Importing Definitions ......................................... 17
2 Use of the SMI .................................................. 4 4.2 Reserved Keywords ............................................. 17
2.1 Terminology Translation ....................................... 4 5 Naming Hierarchy ................................................ 18
2.2 Overview ...................................................... 4 6 Mapping of the MODULE-IDENTITY macro ............................ 18
3 Structure of this Specification ................................. 5 6.1 Mapping of the SUBJECT-CATEGORIES clause ...................... 18
4 Definitions ..................................................... 6 7 Mapping of the OBJECT-TYPE macro ................................ 19
5 PIB Modules ..................................................... 19 7.1 Mapping of the SYNTAX clause .................................. 19
5.1 Importing Definitions ......................................... 19 7.1.1 Counter32 ................................................... 19
5.2 Reserved Keywords ............................................. 19 7.1.2 Gauge32 ..................................................... 20
6 Naming Hierarchy ................................................ 20 7.1.3 Opaque ...................................................... 20
7 Mapping of the MODULE-IDENTITY macro ............................ 20 7.1.4 IpAddress ................................................... 20
7.1 Mapping of the SUBJECT-CATEGORIES clause ...................... 20 7.1.5 Counter64 ................................................... 20
8 Mapping of the OBJECT-TYPE macro ................................ 21 7.1.6 Integer64 ................................................... 20
8.1 Mapping of the SYNTAX clause .................................. 21 7.1.7 Unsigned64 .................................................. 20
8.1.1 Counter32 ................................................... 21 7.1.8 Provisioning Classes ........................................ 21
8.1.2 Gauge32 ..................................................... 22 7.2 Mapping of the MAX-ACCESS clause .............................. 22
8.1.3 Opaque ...................................................... 22 7.3 Mapping of the PIB-ACCESS clause .............................. 22
8.1.4 Counter64 ................................................... 22 7.4 Mapping of the INSTALL-ERRORS clause .......................... 22
8.1.5 Integer64 ................................................... 22 7.5 Mapping of the PIB-INDEX clause ............................... 23
8.1.6 Unsigned64 .................................................. 22 7.6 Mapping of the INDEX clause ................................... 23
8.1.7 Provisioning Classes ........................................ 22 7.7 Mapping of the AUGMENTS clause ................................ 23
8.2 Mapping of the MAX-ACCESS clause .............................. 23 7.8 Mapping of the EXTENDS clause ................................. 24
8.3 Mapping of the PIB-ACCESS clause .............................. 23 7.8.1 Relation between PIB-INDEX, AUGMENTS and EXTENDS clauses
8.4 Mapping of the INSTALL-ERRORS clause .......................... 24 .............................................................. 24
8.5 Mapping of the PIB-INDEX clause ............................... 24 7.9 Mapping of the UNIQUENESS clause .............................. 25
8.6 Mapping of the INDEX clause ................................... 25 7.10 Mapping of the PIB-REFERENCES clause ......................... 25
8.7 Mapping of the AUGMENTS clause ................................ 25 7.11 Mapping of the PIB-TAG clause ................................ 26
8.8 Mapping of the EXTENDS clause ................................. 25 8 Mapping of the OBJECT-IDENTITY macro ............................ 26
8.8.1 Relation between PIB-INDEX, AUGMENTS and EXTENDS clauses 9 Mapping of the OBJECT-GROUP macro ............................... 26
.............................................................. 26 9.1 Mapping of the OBJECTS clause ................................. 26
8.9 Mapping of the UNIQUENESS clause .............................. 26 10 Mapping of the MODULE-COMPLIANCE macro ......................... 27
8.10 Mapping of the PIB-REFERENCES clause ......................... 27 10.1 Mapping of the MODULE clause ................................. 27
8.11 Mapping of the PIB-TAG clause ................................ 27 10.1.1 Mapping of the MANDATORY-GROUPS clause ..................... 27
9 Mapping of the OBJECT-IDENTITY macro ............................ 27 10.1.2 Mapping of the GROUP clause ................................ 27
10 Mapping of the OBJECT-GROUP macro .............................. 28 10.1.3 Mapping of the OBJECT clause ............................... 28
10.1 Mapping of the OBJECTS clause ................................ 28 10.1.3.1 Mapping of the SYNTAX clause ............................. 28
SPPI April 2001
Draft SPPI February 2001
11 Mapping of the MODULE-COMPLIANCE macro ......................... 28 10.1.3.2 Mapping of the WRITE-SYNTAX clause ....................... 28
11.1 Mapping of the MODULE clause ................................. 28 10.1.3.3 Mapping of the PIB-MIN-ACCESS clause ..................... 28
11.1.1 Mapping of the MANDATORY-GROUPS clause ..................... 28 11 Textual Conventions ............................................ 29
11.1.2 Mapping of the GROUP clause ................................ 29 11.1 Mapping of the TEXTUAL-CONVENTION macro ...................... 29
11.1.3 Mapping of the OBJECT clause ............................... 29 11.1.1 Mapping of the SYNTAX clause ............................... 29
11.1.3.1 Mapping of the SYNTAX clause ............................. 29 11.1.1.1 Sub-typing of Textual Conventions ........................ 29
11.1.3.2 Mapping of the WRITE-SYNTAX clause ....................... 30 12 Extending a PIB Module ......................................... 30
11.1.3.3 Mapping of the PIB-MIN-ACCESS clause ..................... 30 12.1 PIB Modules .................................................. 30
12 Textual Conventions ............................................ 30 12.2 Object Assignments ........................................... 31
12.1 Mapping of the TEXTUAL-CONVENTION macro ...................... 30 12.3 Object Definitions ........................................... 31
12.1.1 Mapping of the SYNTAX clause ............................... 31 13 Appendix A: Mapping a PIB to a MIB ............................. 33
12.1.1.1 Sub-typing of Textual Conventions ........................ 31 14 Appendix B: Example usage of PIB-REFERENCES and PIB-TAG
13 Extending a PIB Module ......................................... 31 clauses ...................................................... 35
13.1 OBJECT-TYPE Definitions ...................................... 31 15 Security Considerations ........................................ 38
14 Appendix A: Mapping a PIB to a MIB ............................. 32 16 IANA Considerations ............................................ 38
15 Appendix B: Example usage of PIB-REFERENCES and PIB-TAG 17 Authors' Addresses ............................................. 39
clauses ...................................................... 34 18 References ..................................................... 40
16 Security Considerations ........................................ 37 19 Full Copyright Statement ....................................... 42
17 Authors' Addresses ............................................. 37
18 References ..................................................... 38
19 Full Copyright Statement ....................................... 40
 End of changes. 

This html diff was produced by rfcdiff 1.23, available from http://www.levkowetz.com/ietf/tools/rfcdiff/