draft-ietf-snmpv2-tc-ds-06.txt   rfc1903.txt 
Internet Draft Textual Conventions for SNMPv2 September 1995 Network Working Group SNMPv2 Working Group
Request for Comments: 1903 J. Case
Obsoletes: 1443 SNMP Research, Inc.
Category: Standards Track K. McCloghrie
Cisco Systems, Inc.
M. Rose
Dover Beach Consulting, Inc.
S. Waldbusser
International Network Services
January 1996
Textual Conventions Textual Conventions
for Version 2 of the for Version 2 of the
Simple Network Management Protocol (SNMPv2) Simple Network Management Protocol (SNMPv2)
28 September 1995 | Status of this Memo
draft-ietf-snmpv2-tc-ds-06.txt |
Keith McCloghrie
Editor +
Cisco Systems, Inc.
kzm@cisco.com
Status of this Memo -
This document is an Internet-Draft. Internet-Drafts are working This document specifies an Internet standards track protocol for the
documents of the Internet Engineering Task Force (IETF), its areas, and Internet community, and requests discussion and suggestions for
its working groups. Note that other groups may also distribute working improvements. Please refer to the current edition of the "Internet
documents as Internet-Drafts. Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Internet-Drafts are draft documents valid for a maximum of six months Table of Contents
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet- Drafts as reference material
or to cite them other than as ``work in progress.''
To learn the current status of any Internet-Draft, please check the 1. Introduction ................................................ 1
``1id-abstracts.txt'' listing contained in the Internet- Drafts Shadow 1.1 A Note on Terminology ...................................... 2
Directories on ds.internic.net (US East Coast), nic.nordu.net (Europe), 2. Definitions ................................................. 3
ftp.isi.edu (US West Coast), or munnari.oz.au (Pacific Rim). 3. Mapping of the TEXTUAL-CONVENTION macro ..................... 19
3.1 Mapping of the DISPLAY-HINT clause ......................... 19
3.2 Mapping of the STATUS clause ............................... 21
3.3 Mapping of the DESCRIPTION clause .......................... 21
3.4 Mapping of the REFERENCE clause ............................ 21
3.5 Mapping of the SYNTAX clause ............................... 22
4. Security Considerations ..................................... 22
5. Editor's Address ............................................ 22
6. Acknowledgements ............................................ 22
7. References .................................................. 23
1. Introduction 1. Introduction
A management system contains: several (potentially many) nodes, each A management system contains: several (potentially many) nodes, each
with a processing entity, termed an agent, which has access to with a processing entity, termed an agent, which has access to
management instrumentation; at least one management station; and, a management instrumentation; at least one management station; and, a
management protocol, used to convey management information between the management protocol, used to convey management information between
agents and management stations. Operations of the protocol are carried the agents and management stations. Operations of the protocol are
out under an administrative framework which defines authentication, carried out under an administrative framework which defines
authorization, access control, and privacy policies. authentication, authorization, access control, and privacy policies.
Management stations execute management applications which monitor and Management stations execute management applications which monitor and
control managed elements. Managed elements are devices such as hosts, control managed elements. Managed elements are devices such as
routers, terminal servers, etc., which are monitored and controlled via hosts, routers, terminal servers, etc., which are monitored and
access to their management information. controlled via access to their management information.
Management information is viewed as a collection of managed objects, Management information is viewed as a collection of managed objects,
residing in a virtual information store, termed the Management residing in a virtual information store, termed the Management
Information Base (MIB). Collections of related objects are defined in Information Base (MIB). Collections of related objects are defined
MIB modules. These modules are written using a subset of OSI's Abstract in MIB modules. These modules are written using a subset of OSI's
Syntax Notation One (ASN.1) [1], termed the Structure of Management Abstract Syntax Notation One (ASN.1) [1], termed the Structure of
Information (SMI) [2]. Management Information (SMI) [2].
When designing a MIB module, it is often useful to define new types When designing a MIB module, it is often useful to define new types
similar to those defined in the SMI. In comparison to a type defined in similar to those defined in the SMI. In comparison to a type defined
the SMI, each of these new types has a different name, a similar syntax, in the SMI, each of these new types has a different name, a similar
but a more precise semantics. These newly defined types are termed syntax, but a more precise semantics. These newly defined types are
textual conventions, and are used for the convenience of humans reading termed textual conventions, and are used for the convenience of
the MIB module. It is the purpose of this document to define the humans reading the MIB module. It is the purpose of this document to
initial set of textual conventions available to all MIB modules. define the initial set of textual conventions available to all MIB
modules.
Objects defined using a textual convention are always encoded by means Objects defined using a textual convention are always encoded by
of the rules that define their primitive type. However, textual means of the rules that define their primitive type. However,
conventions often have special semantics associated with them. As such, textual conventions often have special semantics associated with
an ASN.1 macro, TEXTUAL-CONVENTION, is used to concisely convey the them. As such, an ASN.1 macro, TEXTUAL-CONVENTION, is used to
syntax and semantics of a textual convention. concisely convey the syntax and semantics of a textual convention.
For all textual conventions defined in an information module, the name For all textual conventions defined in an information module, the
shall be unique and mnemonic, and shall not exceed 64 characters in name shall be unique and mnemonic, and shall not exceed 64 characters
length. (However, names longer than 32 characters are not recommended.) in length. (However, names longer than 32 characters are not
All names used for the textual conventions defined in all "standard" recommended.) All names used for the textual conventions defined in
information modules shall be unique. all "standard" information modules shall be unique.
1.1. A Note on Terminology 1.1. A Note on Terminology
For the purpose of exposition, the original Internet-standard Network For the purpose of exposition, the original Internet-standard Network
Management Framework, as described in RFCs 1155, 1157, and 1212, is Management Framework, as described in RFCs 1155 (STD 16), 1157 (STD
termed the SNMP version 1 framework (SNMPv1). The current framework is | 15), and 1212 (STD 16), is termed the SNMP version 1 framework
termed the SNMP version 2 framework (SNMPv2), as described in [3]. | (SNMPv1). The current framework is termed the SNMP version 2
framework (SNMPv2).
2. Definitions 2. Definitions
SNMPv2-TC DEFINITIONS ::= BEGIN SNMPv2-TC DEFINITIONS ::= BEGIN
IMPORTS IMPORTS
ObjectSyntax, TimeTicks ObjectSyntax, TimeTicks
FROM SNMPv2-SMI; FROM SNMPv2-SMI;
-- definition of textual conventions -- definition of textual conventions
skipping to change at page 10, line 45 skipping to change at page 7, line 40
conceptual row (but not make it available for use by conceptual row (but not make it available for use by
the managed device); and, the managed device); and,
- `destroy', which is supplied by a management station - `destroy', which is supplied by a management station
wishing to delete all of the instances associated with wishing to delete all of the instances associated with
an existing conceptual row. an existing conceptual row.
Whereas five of the six values (all except `notReady') may Whereas five of the six values (all except `notReady') may
be specified in a management protocol set operation, only be specified in a management protocol set operation, only
three values will be returned in response to a management three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row `active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by the has only three states: it is either available for use by
managed device (the status column has value `active'); it is the managed device (the status column has value `active');
not available for use by the managed device, though the it is not available for use by the managed device, though
agent has sufficient information to make it so (the status the agent has sufficient information to make it so (the
column has value `notInService'); or, it is not available status column has value `notInService'); or, it is not
for use by the managed device, and an attempt to make it so available for use by the managed device, and an attempt to
would fail because the agent has insufficient information make it so would fail because the agent has insufficient
(the state column has value `notReady'). information (the state column has value `notReady').
NOTE WELL NOTE WELL
This textual convention may be used for a MIB table, This textual convention may be used for a MIB table,
irrespective of whether the values of that table's irrespective of whether the values of that table's
conceptual rows are able to be modified while it is conceptual rows are able to be modified while it is
active, or whether its conceptual rows must be taken active, or whether its conceptual rows must be taken
out of service in order to be modified. That is, it is out of service in order to be modified. That is, it is
the responsibility of the DESCRIPTION clause of the the responsibility of the DESCRIPTION clause of the
status column to specify whether the status column must status column to specify whether the status column must
skipping to change at page 13, line 17 skipping to change at page 10, line 16
provide values for all columns which are missing but provide values for all columns which are missing but
required, then return noError and goto D. required, then return noError and goto D.
(3) if other variable bindings included in the same PDU, (3) if other variable bindings included in the same PDU,
provide values for all columns which are missing but provide values for all columns which are missing but
required, then return noError and goto C. required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be (4) at the discretion of the agent, the return value may be
either: either:
inconsistentName: because the agent does not choose to inconsistentName: because the agent does not choose to
create such an instance when the corresponding create such an instance when the corresponding
RowStatus instance does not exist, or RowStatus instance does not exist, or
inconsistentValue: if the supplied value is inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's inconsistent with the state of some other MIB object's
value, or value, or
noError: because the agent chooses to create the noError: because the agent chooses to create the
instance. instance.
If noError is returned, then the instance of the status If noError is returned, then the instance of the status
column must also be created, and the new state is B or C, column must also be created, and the new state is B or C,
depending on the information available to the agent. If depending on the information available to the agent. If
inconsistentName or inconsistentValue is returned, the row inconsistentName or inconsistentValue is returned, the row
skipping to change at page 14, line 8 skipping to change at page 10, line 43
(5) depending on the MIB definition for the column/table, (5) depending on the MIB definition for the column/table,
either noError or inconsistentValue may be returned. either noError or inconsistentValue may be returned.
NOTE: Other processing of the set request may result in a NOTE: Other processing of the set request may result in a
response other than noError being returned, e.g., response other than noError being returned, e.g.,
wrongValue, noCreation, etc. wrongValue, noCreation, etc.
Conceptual Row Creation Conceptual Row Creation
There are four potential interactions when creating a There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any not in use; creating the conceptual row; initializing any
objects for which the agent does not supply a default; and, objects for which the agent does not supply a default; and,
making the conceptual row available for use by the managed making the conceptual row available for use by the managed
device. device.
Interaction 1: Selecting an Instance-Identifier Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies The algorithm used to select an instance-identifier varies
for each conceptual row. In some cases, the instance- for each conceptual row. In some cases, the instance-
identifier is semantically significant, e.g., the identifier is semantically significant, e.g., the
skipping to change at page 16, line 22 skipping to change at page 13, line 8
instance of this column. instance of this column.
Once the column requirements have been determined, a Once the column requirements have been determined, a
management protocol set operation is accordingly issued. management protocol set operation is accordingly issued.
This operation also sets the new instance of the status This operation also sets the new instance of the status
column to `createAndGo'. column to `createAndGo'.
When the agent processes the set operation, it verifies that When the agent processes the set operation, it verifies that
it has sufficient information to make the conceptual row it has sufficient information to make the conceptual row
available for use by the managed device. The information available for use by the managed device. The information
available to the agent is provided by two sources: the available to the agent is provided by two sources: the
management protocol set operation which creates the management protocol set operation which creates the
conceptual row, and, implementation-specific defaults conceptual row, and, implementation-specific defaults
supplied by the agent (note that an agent must provide supplied by the agent (note that an agent must provide
implementation-specific defaults for at least those objects implementation-specific defaults for at least those objects
which it implements as read-only). If there is sufficient which it implements as read-only). If there is sufficient
information available, then the conceptual row is created, a information available, then the conceptual row is created, a
`noError' response is returned, the status column is set to `noError' response is returned, the status column is set to
`active', and no further interactions are necessary (i.e., `active', and no further interactions are necessary (i.e.,
interactions 3 and 4 are skipped). If there is insufficient interactions 3 and 4 are skipped). If there is insufficient
information, then the conceptual row is not created, and the information, then the conceptual row is not created, and the
skipping to change at page 17, line 32 skipping to change at page 14, line 9
Interaction 2b: Negotiating the Creation of the Conceptual Interaction 2b: Negotiating the Creation of the Conceptual
Row Row
The management station issues a management protocol set The management station issues a management protocol set
operation which sets the desired instance of the status operation which sets the desired instance of the status
column to `createAndWait'. If the agent is unwilling to column to `createAndWait'. If the agent is unwilling to
process a request of this sort, the set operation fails with process a request of this sort, the set operation fails with
an error of `wrongValue'. (As a consequence, such an agent an error of `wrongValue'. (As a consequence, such an agent
must be prepared to accept a single management protocol set must be prepared to accept a single management protocol set
operation, i.e., interaction 2a above, containing all of the operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise, columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is the conceptual row is created, a `noError' response is
returned, and the status column is immediately set to either returned, and the status column is immediately set to either
`notInService' or `notReady', depending on whether it has `notInService' or `notReady', depending on whether it has
sufficient information to make the conceptual row available sufficient information to make the conceptual row available
for use by the managed device. If there is sufficient for use by the managed device. If there is sufficient
information available, then the status column is set to information available, then the status column is set to
`notInService'; otherwise, if there is insufficient `notInService'; otherwise, if there is insufficient
information, then the status column is set to `notReady'. information, then the status column is set to `notReady'.
Regardless, we proceed to interaction 3. Regardless, we proceed to interaction 3.
skipping to change at page 19, line 38 skipping to change at page 16, line 4
protocol set operation is issued to set the status protocol set operation is issued to set the status
column to `active', the values held in the agent column to `active', the values held in the agent
supersede those used by the managed device. supersede those used by the managed device.
If the management station is prevented from setting the If the management station is prevented from setting the
status column to `active' (e.g., due to management station status column to `active' (e.g., due to management station
or network failure) the conceptual row will be left in the or network failure) the conceptual row will be left in the
`notInService' or `notReady' state, consuming resources `notInService' or `notReady' state, consuming resources
indefinitely. The agent must detect conceptual rows that indefinitely. The agent must detect conceptual rows that
have been in either state for an abnormally long period of have been in either state for an abnormally long period of
time and remove them. It is the responsibility of the + time and remove them. It is the responsibility of the
DESCRIPTION clause of the status column to indicate what an + DESCRIPTION clause of the status column to indicate what an
abnormally long period of time would be. + abnormally long period of time would be. This period of
This period of time should be long enough to allow for human time should be long enough to allow for human response time
response time (including `think time') between the creation (including `think time') between the creation of the
of the conceptual row and the setting of the status to conceptual row and the setting of the status to `active'.
`active'. In the absense of such information in the | In the absense of such information in the DESCRIPTION
DESCRIPTION clause, it is suggested that this period be | clause, it is suggested that this period be approximately 5
approximately 5 minutes in length. | minutes in length. This removal action applies not only to
This removal action applies not only to newly-created rows, newly-created rows, but also to previously active rows which
but also to previously active rows which are set to, and are set to, and left in, the notInService state for a
left in, the notInService state for a prolonged period | prolonged period exceeding that which is considered normal
exceeding that which is considered normal for such a | for such a conceptual row.
conceptual row. |
Conceptual Row Suspension Conceptual Row Suspension
When a conceptual row is `active', the management station When a conceptual row is `active', the management station
may issue a management protocol set operation which sets the may issue a management protocol set operation which sets the
instance of the status column to `notInService'. If the instance of the status column to `notInService'. If the
agent is unwilling to do so, the set operation fails with an agent is unwilling to do so, the set operation fails with an
error of `wrongValue'. Otherwise, the conceptual row is error of `wrongValue'. Otherwise, the conceptual row is
taken out of service, and a `noError' response is returned. taken out of service, and a `noError' response is returned.
It is the responsibility of the DESCRIPTION clause of the It is the responsibility of the DESCRIPTION clause of the
skipping to change at page 20, line 29 skipping to change at page 16, line 39
for the value of some other column of the same conceptual for the value of some other column of the same conceptual
row to be modified). row to be modified).
Conceptual Row Deletion Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set For deletion of conceptual rows, a management protocol set
operation is issued which sets the instance of the status operation is issued which sets the instance of the status
column to `destroy'. This request may be made regardless of column to `destroy'. This request may be made regardless of
the current value of the status column (e.g., it is possible the current value of the status column (e.g., it is possible
to delete conceptual rows which are either `notReady', to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds, then `notInService' or `active'.) If the operation succeeds,
all instances associated with the conceptual row are then all instances associated with the conceptual row are
immediately removed." immediately removed."
SYNTAX INTEGER { SYNTAX INTEGER {
-- the following two values are states: -- the following two values are states:
-- these values may be read or written -- these values may be read or written
active(1), active(1),
notInService(2), notInService(2),
-- the following value is a state: -- the following value is a state:
-- this value may be read, but not written -- this value may be read, but not written
notReady(3), notReady(3),
-- the following three values are -- the following three values are
-- actions: these values may be written, -- actions: these values may be written,
-- but are never read -- but are never read
createAndGo(4), createAndGo(4),
createAndWait(5), createAndWait(5),
destroy(6) destroy(6)
skipping to change at page 24, line 32 skipping to change at page 18, line 43
specify the columnar objects which a permanent(4) row must specify the columnar objects which a permanent(4) row must
at a minimum allow to be writable." at a minimum allow to be writable."
SYNTAX INTEGER { SYNTAX INTEGER {
other(1), -- eh? other(1), -- eh?
volatile(2), -- e.g., in RAM volatile(2), -- e.g., in RAM
nonVolatile(3), -- e.g., in NVRAM nonVolatile(3), -- e.g., in NVRAM
permanent(4), -- e.g., partially in ROM permanent(4), -- e.g., partially in ROM
readOnly(5) -- e.g., completely in ROM readOnly(5) -- e.g., completely in ROM
} }
TDomain ::= TEXTUAL-CONVENTION + TDomain ::= TEXTUAL-CONVENTION
STATUS current + STATUS current
DESCRIPTION + DESCRIPTION
"Denotes a kind of transport service. + "Denotes a kind of transport service.
Some possible values, such as snmpUDPDomain, are defined in + Some possible values, such as snmpUDPDomain, are defined in
'Transport Mappings for Version 2 of the Simple Network + 'Transport Mappings for Version 2 of the Simple Network
Management Protocol (SNMPv2)'." + Management Protocol (SNMPv2)'."
SYNTAX OBJECT IDENTIFIER +
TAddress ::= TEXTUAL-CONVENTION + SYNTAX OBJECT IDENTIFIER
STATUS current +
DESCRIPTION +
"Denotes a transport service address. +
For snmpUDPDomain, a TAddress is 6 octets long, the initial 4 + TAddress ::= TEXTUAL-CONVENTION
octets containing the IP-address in network-byte order and the + STATUS current
last 2 containing the UDP port in network-byte order. Consult + DESCRIPTION
'Transport Mappings for Version 2 of the Simple Network + "Denotes a transport service address.
Management Protocol (SNMPv2)' for further information on +
snmpUDPDomain." + For snmpUDPDomain, a TAddress is 6 octets long, the initial 4
SYNTAX OCTET STRING (SIZE (1..255)) + octets containing the IP-address in network-byte order and the
last 2 containing the UDP port in network-byte order. Consult
'Transport Mappings for Version 2 of the Simple Network
Management Protocol (SNMPv2)' for further information on
snmpUDPDomain."
SYNTAX OCTET STRING (SIZE (1..255))
END END
3. Mapping of the TEXTUAL-CONVENTION macro 3. 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
associated with a textual convention. It should be noted that the semantics associated with a textual convention. It should be noted
expansion of the TEXTUAL-CONVENTION macro is something which that the 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.
For all descriptors appearing in an information module, the descriptor For all descriptors appearing in an information module, the
shall be unique and mnemonic, and shall not exceed 64 characters in descriptor shall be unique and mnemonic, and shall not exceed 64
length. (However, descriptors longer than 32 characters are not characters in length. (However, descriptors longer than 32
recommended.) Further, the hyphen is not allowed as a character in the characters are not recommended.) Further, the hyphen is not allowed
name of any textual convention. as a character in the name of any textual convention.
3.1. Mapping of the DISPLAY-HINT clause 3.1. Mapping of the DISPLAY-HINT clause
The DISPLAY-HINT clause, which need not be present, gives a hint as to The DISPLAY-HINT clause, which need not be present, gives a hint as
how the value of an instance of an object with the syntax defined using to how the value of an instance of an object with the syntax defined
this textual convention might be displayed. The DISPLAY-HINT clause may using this textual convention might be displayed. The DISPLAY-HINT
be present if and only if the syntax has an underlying primitive type of clause may be present if and only if the syntax has an underlying
INTEGER or OCTET STRING. (Note, however, that the semantics defined for primitive type of INTEGER or OCTET STRING. (Note, however, that the
a particular syntax can cause the use of DISPLAY-HINT for that syntax to semantics defined for a particular syntax can cause the use of
make no sense, e.g., for Counter32 [2].) DISPLAY-HINT for that syntax to make no sense, e.g., for Counter32
[2].)
When the syntax has an underlying primitive type of INTEGER, the hint When the syntax has an underlying primitive type of INTEGER, the hint
consists of an integer-format specification, containing two parts. The consists of an integer-format specification, containing two parts.
first part is a single character suggesting a display format, either: The first part is a single character suggesting a display format,
'x' for hexadecimal, or 'd' for decimal, or 'o' for octal, or 'b' for either: 'x' for hexadecimal, or 'd' for decimal, or 'o' for octal, or
binary. The second part is always omitted for 'x', 'o' and 'b', and 'b' for binary. The second part is always omitted for 'x', 'o' and
need not be present for 'd'. If present, the second part starts with a 'b', and need not be present for 'd'. If present, the second part
hyphen and is followed by a decimal number, which defines the implied starts with a hyphen and is followed by a decimal number, which
decimal point when rendering the value. For example: defines the implied decimal point when rendering the value. For
example:
Hundredths ::= TEXTUAL-CONVENTION Hundredths ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d-2" DISPLAY-HINT "d-2"
... ...
SYNTAX INTEGER (0..10000) SYNTAX INTEGER (0..10000)
suggests that a Hundredths value of 1234 be rendered as "12.34" suggests that a Hundredths value of 1234 be rendered as "12.34"
When the syntax has an underlying primitive type of OCTET STRING, the When the syntax has an underlying primitive type of OCTET STRING, the
hint consists of one or more octet-format specifications. Each hint consists of one or more octet-format specifications. Each
specification consists of five parts, with each part using and removing specification consists of five parts, with each part using and
zero or more of the next octets from the value and producing the next removing zero or more of the next octets from the value and producing
zero or more characters to be displayed. The octets within the value the next zero or more characters to be displayed. The octets within
are processed in order of significance, most significant first. the value are processed in order of significance, most significant
first.
The five parts of a octet-format specification are: The five parts of a octet-format specification are:
(1) the (optional) repeat indicator; if present, this part is a `*', (1) the (optional) repeat indicator; if present, this part is a `*',
and indicates that the current octet of the value is to be used as and indicates that the current octet of the value is to be used as
the repeat count. The repeat count is an unsigned integer (which the repeat count. The repeat count is an unsigned integer (which
may be zero) which specifies how many times the remainder of this may be zero) which specifies how many times the remainder of this
octet-format specification should be successively applied. If the octet-format specification should be successively applied. If the
repeat indicator is not present, the repeat count is one. repeat indicator is not present, the repeat count is one.
(2) the octet length: one or more decimal digits specifying the number (2) the octet length: one or more decimal digits specifying the number
of octets of the value to be used and formatted by this octet- of octets of the value to be used and formatted by this octet-
specification. Note that the octet length can be zero. If less specification. Note that the octet length can be zero. If less
than this number of octets remain in the value, then the lesser than this number of octets remain in the value, then the lesser
number of octets are used. number of octets are used.
(3) the display format, either: `x' for hexadecimal, `d' for decimal, (3) the display format, either: `x' for hexadecimal, `d' for decimal,
`o' for octal, or `a' for ascii. If the octet length part is `o' for octal, or `a' for ascii. If the octet length part is
greater than one, and the display format part refers to a numeric greater than one, and the display format part refers to a numeric
format, then network-byte ordering (big-endian encoding) is used format, then network-byte ordering (big-endian encoding) is used
interpreting the octets in the value. interpreting the octets in the value.
(4) the (optional) display separator character; if present, this part (4) the (optional) display separator character; if present, this part
is a single character which is produced for display after each is a single character which is produced for display after each
application of this octet-specification; however, this character is application of this octet-specification; however, this character is
not produced for display if it would be immediately followed by the not produced for display if it would be immediately followed by the
display of the repeat terminator character for this octet- display of the repeat terminator character for this octet-
skipping to change at page 27, line 44 skipping to change at page 21, line 13
decimal digit and a `*'. decimal digit and a `*'.
(5) the (optional) repeat terminator character, which can be present (5) the (optional) repeat terminator character, which can be present
only if the display separator character is present and this octet- only if the display separator character is present and this octet-
specification begins with a repeat indicator; if present, this part specification begins with a repeat indicator; if present, this part
is a single character which is produced after all the zero or more is a single character which is produced after all the zero or more
repeated applications (as given by the repeat count) of this repeated applications (as given by the repeat count) of this
octet-specification. This character can be any character other octet-specification. This character can be any character other
than a decimal digit and a `*'. than a decimal digit and a `*'.
Output of a display separator character or a repeat terminator character Output of a display separator character or a repeat terminator
is suppressed if it would occur as the last character of the display. character is suppressed if it would occur as the last character of
the display.
If the octets of the value are exhausted before all the octet-format If the octets of the value are exhausted before all the octet-format
specification have been used, then the excess specifications are specification have been used, then the excess specifications are
ignored. If additional octets remain in the value after interpreting ignored. If additional octets remain in the value after interpreting
all the octet-format specifications, then the last octet-format all the octet-format specifications, then the last octet-format
specification is re-interpreted to process the additional octets, until specification is re-interpreted to process the additional octets,
no octets remain in the value. until no octets remain in the value.
3.2. Mapping of the STATUS clause 3.2. Mapping of the STATUS clause
The STATUS clause, which must be present, indicates whether this The STATUS clause, which must be present, indicates whether this
definition is current or historic. definition is current or historic.
The values "current", and "obsolete" are self-explanatory. The The values "current", and "obsolete" are self-explanatory. The
"deprecated" value indicates that the definition is obsolete, but that "deprecated" value indicates that the definition is obsolete, but
an implementor may wish to support the use of this textual convention to that an implementor may wish to support the use of this textual
foster interoperability with older implementations. convention to foster interoperability with older implementations.
3.3. Mapping of the DESCRIPTION clause 3.3. Mapping of the DESCRIPTION clause
The DESCRIPTION clause, which must be present, contains a textual The DESCRIPTION clause, which must be present, contains a textual
definition of the textual convention, which provides all semantic definition of the textual convention, which provides all semantic
definitions necessary for implementation, and should embody any definitions necessary for implementation, and should embody any
information which would otherwise be communicated in any ASN.1 information which would otherwise be communicated in any ASN.1
commentary annotations associated with the object. commentary annotations associated with the object.
Note that, in order to conform to the ASN.1 syntax, the entire value of Note that, in order to conform to the ASN.1 syntax, the entire value
this clause must be enclosed in double quotation marks, and therefore of this clause must be enclosed in double quotation marks, and
cannot itself contain double quotation marks, although the value may be therefore cannot itself contain double quotation marks, although the
multi-line. value may be multi-line.
3.4. Mapping of the REFERENCE clause 3.4. Mapping of the REFERENCE clause
The REFERENCE clause, which need not be present, contains a textual The REFERENCE clause, which need not be present, contains a textual
cross-reference to a related item defined in some other published work. cross-reference to a related item defined in some other published
work.
3.5. Mapping of the SYNTAX clause 3.5. 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
must be one of the alternatives defined in the ObjectSyntax CHOICE or structure must be one of the alternatives defined in the ObjectSyntax
the BITS construct (see section 7.1 in [2]). CHOICE or the BITS construct (see section 7.1 in [2]).
4. Acknowledgements 4. Security Considerations
This document is the result of significant work by the four major Security issues are not discussed in this memo.
contributors:
Jeffrey Case (SNMP Research, case@snmp.com) 5. Editor's Address
Keith McCloghrie (Cisco Systems, kzm@cisco.com)
Marshall Rose (Dover Beach Consulting, mrose@dbc.mtview.ca.us)
Steven Waldbusser (International Network Services, stevew@uni.ins.com)
In addition, the contributions of the SNMPv2 Working Group are Keith McCloghrie
acknowledged. In particular, a special thanks is extended for the Cisco Systems, Inc.
contributions of: 170 West Tasman Drive
San Jose, CA 95134-1706
US
Phone: +1 408 526 5260
EMail: kzm@cisco.com
6. Acknowledgements
This document is the result of significant work by the four major
contributors:
Jeffrey D. Case (SNMP Research, case@snmp.com)
Keith McCloghrie (Cisco Systems, kzm@cisco.com)
Marshall T. Rose (Dover Beach Consulting, mrose@dbc.mtview.ca.us)
Steven Waldbusser (International Network Services, stevew@uni.ins.com)
In addition, the contributions of the SNMPv2 Working Group are
acknowledged. In particular, a special thanks is extended for the
contributions of:
Alexander I. Alten (Novell) Alexander I. Alten (Novell)
Dave Arneson (Cabletron) Dave Arneson (Cabletron)
Uri Blumenthal (IBM) Uri Blumenthal (IBM)
Doug Book (Chipcom) Doug Book (Chipcom)
Kim Curran (Bell-Northern Research) Kim Curran (Bell-Northern Research)
Jim Galvin (Trusted Information Systems) Jim Galvin (Trusted Information Systems)
Maria Greene (Ascom Timeplex) Maria Greene (Ascom Timeplex)
Iain Hanson (Digital) Iain Hanson (Digital)
Dave Harrington (Cabletron) Dave Harrington (Cabletron)
skipping to change at page 30, line 5 skipping to change at page 23, line 20
Dave Perkins (Peer Networks) Dave Perkins (Peer Networks)
Randy Presuhn (Peer Networks) Randy Presuhn (Peer Networks)
Aleksey Romanov (Quality Quorum) Aleksey Romanov (Quality Quorum)
Shawn Routhier (Epilogue) Shawn Routhier (Epilogue)
Jon Saperia (BGS Systems) Jon Saperia (BGS Systems)
Bob Stewart (Cisco Systems, bstewart@cisco.com), chair Bob Stewart (Cisco Systems, bstewart@cisco.com), chair
Kaj Tesink (Bellcore) Kaj Tesink (Bellcore)
Glenn Waters (Bell-Northern Research) Glenn Waters (Bell-Northern Research)
Bert Wijnen (IBM) Bert Wijnen (IBM)
5. References 7. References
[1] Information processing systems - Open Systems Interconnection - [1] 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).
[2] McCloghrie, K., Editor, | [2] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
"Structure of Management Information for Version 2 of the Simple S. Waldbusser, "Structure of Management Information for Version 2
Network Management Protocol (SNMPv2)", Internet Draft, Cisco | of the Simple Network Management Protocol (SNMPv2)", RFC 1902,
Systems, September 1995. | January 1996.
[3] McCloghrie, K., Editor, "Introduction to Version 2 of the |
Internet-standard Network Management Framework", Internet Draft, |
Cisco Systems, September 1995. |
[4] McCloghrie, K., Editor, "Transport Mappings for Version 2 of the |
Simple Network Management Protocol (SNMPv2)", Internet Draft, Cisco |
Systems, September 1995. |
6. Security Considerations
Security issues are not discussed in this memo.
7. Editor's Address
Keith McCloghrie -
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
US
Phone: +1 408 526 5260
Email: kzm@cisco.com
Table of Contents -
1 Introduction .................................................... 2
1.1 A Note on Terminology ......................................... 3
2 Definitions ..................................................... 4
3 Mapping of the TEXTUAL-CONVENTION macro ......................... 26
3.1 Mapping of the DISPLAY-HINT clause ............................ 26
3.2 Mapping of the STATUS clause .................................. 28
3.3 Mapping of the DESCRIPTION clause ............................. 28
3.4 Mapping of the REFERENCE clause ............................... 28
3.5 Mapping of the SYNTAX clause .................................. 28
4 Acknowledgements ................................................ 29
5 References ...................................................... 30
6 Security Considerations ......................................... 31
7 Editor's Address ................................................ 31
 End of changes. 49 change blocks. 
184 lines changed or deleted 214 lines changed or added

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