Blame mibs/SNMPv2-TC.txt

Packit fcad23
SNMPv2-TC DEFINITIONS ::= BEGIN
Packit fcad23
Packit fcad23
IMPORTS
Packit fcad23
    TimeTicks         FROM SNMPv2-SMI;
Packit fcad23
Packit fcad23
-- definition of textual conventions
Packit fcad23
Packit fcad23
TEXTUAL-CONVENTION MACRO ::=
Packit fcad23
Packit fcad23
BEGIN
Packit fcad23
    TYPE NOTATION ::=
Packit fcad23
                  DisplayPart
Packit fcad23
                  "STATUS" Status
Packit fcad23
                  "DESCRIPTION" Text
Packit fcad23
                  ReferPart
Packit fcad23
                  "SYNTAX" Syntax
Packit fcad23
Packit fcad23
    VALUE NOTATION ::=
Packit fcad23
                   value(VALUE Syntax)      -- adapted ASN.1
Packit fcad23
Packit fcad23
    DisplayPart ::=
Packit fcad23
                  "DISPLAY-HINT" Text
Packit fcad23
                | empty
Packit fcad23
Packit fcad23
    Status ::=
Packit fcad23
                  "current"
Packit fcad23
                | "deprecated"
Packit fcad23
                | "obsolete"
Packit fcad23
Packit fcad23
    ReferPart ::=
Packit fcad23
                  "REFERENCE" Text
Packit fcad23
                | empty
Packit fcad23
Packit fcad23
    -- a character string as defined in [2]
Packit fcad23
    Text ::= value(IA5String)
Packit fcad23
Packit fcad23
    Syntax ::=   -- Must be one of the following:
Packit fcad23
                       -- a base type (or its refinement), or
Packit fcad23
                       -- a BITS pseudo-type
Packit fcad23
                  type
Packit fcad23
                | "BITS" "{" NamedBits "}"
Packit fcad23
Packit fcad23
    NamedBits ::= NamedBit
Packit fcad23
                | NamedBits "," NamedBit
Packit fcad23
Packit fcad23
    NamedBit ::=  identifier "(" number ")" -- number is nonnegative
Packit fcad23
Packit fcad23
END
Packit fcad23
Packit fcad23
DisplayString ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "255a"
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Represents textual information taken from the NVT ASCII
Packit fcad23
Packit fcad23
            character set, as defined in pages 4, 10-11 of RFC 854.
Packit fcad23
Packit fcad23
            To summarize RFC 854, the NVT ASCII repertoire specifies:
Packit fcad23
Packit fcad23
              - the use of character codes 0-127 (decimal)
Packit fcad23
Packit fcad23
              - the graphics characters (32-126) are interpreted as
Packit fcad23
                US ASCII
Packit fcad23
Packit fcad23
              - NUL, LF, CR, BEL, BS, HT, VT and FF have the special
Packit fcad23
                meanings specified in RFC 854
Packit fcad23
Packit fcad23
              - the other 25 codes have no standard interpretation
Packit fcad23
Packit fcad23
              - the sequence 'CR LF' means newline
Packit fcad23
Packit fcad23
              - the sequence 'CR NUL' means carriage-return
Packit fcad23
Packit fcad23
              - an 'LF' not preceded by a 'CR' means moving to the
Packit fcad23
                same column on the next line.
Packit fcad23
Packit fcad23
              - the sequence 'CR x' for any x other than LF or NUL is
Packit fcad23
                illegal.  (Note that this also means that a string may
Packit fcad23
                end with either 'CR LF' or 'CR NUL', but not with CR.)
Packit fcad23
Packit fcad23
            Any object defined using this syntax may not exceed 255
Packit fcad23
            characters in length."
Packit fcad23
    SYNTAX       OCTET STRING (SIZE (0..255))
Packit fcad23
Packit fcad23
PhysAddress ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "1x:"
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Represents media- or physical-level addresses."
Packit fcad23
    SYNTAX       OCTET STRING
Packit fcad23
Packit fcad23
MacAddress ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "1x:"
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Represents an 802 MAC address represented in the
Packit fcad23
            `canonical' order defined by IEEE 802.1a, i.e., as if it
Packit fcad23
            were transmitted least significant bit first, even though
Packit fcad23
            802.5 (in contrast to other 802.x protocols) requires MAC
Packit fcad23
            addresses to be transmitted most significant bit first."
Packit fcad23
    SYNTAX       OCTET STRING (SIZE (6))
Packit fcad23
Packit fcad23
TruthValue ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Represents a boolean value."
Packit fcad23
    SYNTAX       INTEGER { true(1), false(2) }
Packit fcad23
Packit fcad23
TestAndIncr ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Represents integer-valued information used for atomic
Packit fcad23
            operations.  When the management protocol is used to specify
Packit fcad23
            that an object instance having this syntax is to be
Packit fcad23
            modified, the new value supplied via the management protocol
Packit fcad23
            must precisely match the value presently held by the
Packit fcad23
            instance.  If not, the management protocol set operation
Packit fcad23
            fails with an error of `inconsistentValue'.  Otherwise, if
Packit fcad23
            the current value is the maximum value of 2^31-1 (2147483647
Packit fcad23
            decimal), then the value held by the instance is wrapped to
Packit fcad23
            zero; otherwise, the value held by the instance is
Packit fcad23
            incremented by one.  (Note that regardless of whether the
Packit fcad23
            management protocol set operation succeeds, the variable-
Packit fcad23
            binding in the request and response PDUs are identical.)
Packit fcad23
Packit fcad23
            The value of the ACCESS clause for objects having this
Packit fcad23
            syntax is either `read-write' or `read-create'.  When an
Packit fcad23
            instance of a columnar object having this syntax is created,
Packit fcad23
            any value may be supplied via the management protocol.
Packit fcad23
Packit fcad23
            When the network management portion of the system is re-
Packit fcad23
            initialized, the value of every object instance having this
Packit fcad23
            syntax must either be incremented from its value prior to
Packit fcad23
            the re-initialization, or (if the value prior to the re-
Packit fcad23
            initialization is unknown) be set to a pseudo-randomly
Packit fcad23
            generated value."
Packit fcad23
    SYNTAX       INTEGER (0..2147483647)
Packit fcad23
Packit fcad23
AutonomousType ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Represents an independently extensible type identification
Packit fcad23
            value.  It may, for example, indicate a particular sub-tree
Packit fcad23
            with further MIB definitions, or define a particular type of
Packit fcad23
            protocol or hardware."
Packit fcad23
    SYNTAX       OBJECT IDENTIFIER
Packit fcad23
Packit fcad23
InstancePointer ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       obsolete
Packit fcad23
    DESCRIPTION
Packit fcad23
            "A pointer to either a specific instance of a MIB object or
Packit fcad23
            a conceptual row of a MIB table in the managed device.  In
Packit fcad23
            the latter case, by convention, it is the name of the
Packit fcad23
            particular instance of the first accessible columnar object
Packit fcad23
            in the conceptual row.
Packit fcad23
Packit fcad23
            The two uses of this textual convention are replaced by
Packit fcad23
            VariablePointer and RowPointer, respectively."
Packit fcad23
    SYNTAX       OBJECT IDENTIFIER
Packit fcad23
Packit fcad23
VariablePointer ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "A pointer to a specific object instance.  For example,
Packit fcad23
            sysContact.0 or ifInOctets.3."
Packit fcad23
    SYNTAX       OBJECT IDENTIFIER
Packit fcad23
Packit fcad23
RowPointer ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Represents a pointer to a conceptual row.  The value is the
Packit fcad23
            name of the instance of the first accessible columnar object
Packit fcad23
            in the conceptual row.
Packit fcad23
Packit fcad23
            For example, ifIndex.3 would point to the 3rd row in the
Packit fcad23
            ifTable (note that if ifIndex were not-accessible, then
Packit fcad23
            ifDescr.3 would be used instead)."
Packit fcad23
    SYNTAX       OBJECT IDENTIFIER
Packit fcad23
Packit fcad23
RowStatus ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The RowStatus textual convention is used to manage the
Packit fcad23
            creation and deletion of conceptual rows, and is used as the
Packit fcad23
            value of the SYNTAX clause for the status column of a
Packit fcad23
            conceptual row (as described in Section 7.7.1 of [2].)
Packit fcad23
Packit fcad23
            The status column has six defined values:
Packit fcad23
Packit fcad23
                 - `active', which indicates that the conceptual row is
Packit fcad23
                 available for use by the managed device;
Packit fcad23
Packit fcad23
                 - `notInService', which indicates that the conceptual
Packit fcad23
                 row exists in the agent, but is unavailable for use by
Packit fcad23
                 the managed device (see NOTE below); 'notInService' has
Packit fcad23
                 no implication regarding the internal consistency of
Packit fcad23
                 the row, availability of resources, or consistency with
Packit fcad23
                 the current state of the managed device;
Packit fcad23
Packit fcad23
                 - `notReady', which indicates that the conceptual row
Packit fcad23
                 exists in the agent, but is missing information
Packit fcad23
                 necessary in order to be available for use by the
Packit fcad23
                 managed device (i.e., one or more required columns in
Packit fcad23
                 the conceptual row have not been instanciated);
Packit fcad23
Packit fcad23
                 - `createAndGo', which is supplied by a management
Packit fcad23
                 station wishing to create a new instance of a
Packit fcad23
                 conceptual row and to have its status automatically set
Packit fcad23
                 to active, making it available for use by the managed
Packit fcad23
                 device;
Packit fcad23
Packit fcad23
                 - `createAndWait', which is supplied by a management
Packit fcad23
                 station wishing to create a new instance of a
Packit fcad23
                 conceptual row (but not make it available for use by
Packit fcad23
                 the managed device); and,
Packit fcad23
                 - `destroy', which is supplied by a management station
Packit fcad23
                 wishing to delete all of the instances associated with
Packit fcad23
                 an existing conceptual row.
Packit fcad23
Packit fcad23
            Whereas five of the six values (all except `notReady') may
Packit fcad23
            be specified in a management protocol set operation, only
Packit fcad23
            three values will be returned in response to a management
Packit fcad23
            protocol retrieval operation:  `notReady', `notInService' or
Packit fcad23
            `active'.  That is, when queried, an existing conceptual row
Packit fcad23
            has only three states:  it is either available for use by
Packit fcad23
            the managed device (the status column has value `active');
Packit fcad23
            it is not available for use by the managed device, though
Packit fcad23
            the agent has sufficient information to attempt to make it
Packit fcad23
            so (the status column has value `notInService'); or, it is
Packit fcad23
            not available for use by the managed device, and an attempt
Packit fcad23
            to make it so would fail because the agent has insufficient
Packit fcad23
            information (the state column has value `notReady').
Packit fcad23
Packit fcad23
                                     NOTE WELL
Packit fcad23
Packit fcad23
                 This textual convention may be used for a MIB table,
Packit fcad23
                 irrespective of whether the values of that table's
Packit fcad23
                 conceptual rows are able to be modified while it is
Packit fcad23
                 active, or whether its conceptual rows must be taken
Packit fcad23
                 out of service in order to be modified.  That is, it is
Packit fcad23
                 the responsibility of the DESCRIPTION clause of the
Packit fcad23
                 status column to specify whether the status column must
Packit fcad23
                 not be `active' in order for the value of some other
Packit fcad23
                 column of the same conceptual row to be modified.  If
Packit fcad23
                 such a specification is made, affected columns may be
Packit fcad23
                 changed by an SNMP set PDU if the RowStatus would not
Packit fcad23
                 be equal to `active' either immediately before or after
Packit fcad23
                 processing the PDU.  In other words, if the PDU also
Packit fcad23
                 contained a varbind that would change the RowStatus
Packit fcad23
                 value, the column in question may be changed if the
Packit fcad23
                 RowStatus was not equal to `active' as the PDU was
Packit fcad23
                 received, or if the varbind sets the status to a value
Packit fcad23
                 other than 'active'.
Packit fcad23
Packit fcad23
            Also note that whenever any elements of a row exist, the
Packit fcad23
            RowStatus column must also exist.
Packit fcad23
Packit fcad23
            To summarize the effect of having a conceptual row with a
Packit fcad23
            status column having a SYNTAX clause value of RowStatus,
Packit fcad23
            consider the following state diagram:
Packit fcad23
Packit fcad23
                                         STATE
Packit fcad23
              +--------------+-----------+-------------+-------------
Packit fcad23
              |      A       |     B     |      C      |      D
Packit fcad23
              |              |status col.|status column|
Packit fcad23
              |status column |    is     |      is     |status column
Packit fcad23
    ACTION    |does not exist|  notReady | notInService|  is active
Packit fcad23
--------------+--------------+-----------+-------------+-------------
Packit fcad23
set status    |noError    ->D|inconsist- |inconsistent-|inconsistent-
Packit fcad23
column to     |       or     |   entValue|        Value|        Value
Packit fcad23
createAndGo   |inconsistent- |           |             |
Packit fcad23
              |         Value|           |             |
Packit fcad23
--------------+--------------+-----------+-------------+-------------
Packit fcad23
set status    |noError  see 1|inconsist- |inconsistent-|inconsistent-
Packit fcad23
column to     |       or     |   entValue|        Value|        Value
Packit fcad23
createAndWait |wrongValue    |           |             |
Packit fcad23
--------------+--------------+-----------+-------------+-------------
Packit fcad23
set status    |inconsistent- |inconsist- |noError      |noError
Packit fcad23
column to     |         Value|   entValue|             |
Packit fcad23
active        |              |           |             |
Packit fcad23
              |              |     or    |             |
Packit fcad23
              |              |           |             |
Packit fcad23
              |              |see 2   ->D|see 8     ->D|          ->D
Packit fcad23
--------------+--------------+-----------+-------------+-------------
Packit fcad23
set status    |inconsistent- |inconsist- |noError      |noError   ->C
Packit fcad23
column to     |         Value|   entValue|             |
Packit fcad23
notInService  |              |           |             |
Packit fcad23
              |              |     or    |             |      or
Packit fcad23
              |              |           |             |
Packit fcad23
              |              |see 3   ->C|          ->C|see 6
Packit fcad23
--------------+--------------+-----------+-------------+-------------
Packit fcad23
set status    |noError       |noError    |noError      |noError   ->A
Packit fcad23
column to     |              |           |             |      or
Packit fcad23
destroy       |           ->A|        ->A|          ->A|see 7
Packit fcad23
--------------+--------------+-----------+-------------+-------------
Packit fcad23
set any other |see 4         |noError    |noError      |see 5
Packit fcad23
column to some|              |           |             |
Packit fcad23
value         |              |      see 1|          ->C|          ->D
Packit fcad23
--------------+--------------+-----------+-------------+-------------
Packit fcad23
Packit fcad23
            (1) goto B or C, depending on information available to the
Packit fcad23
            agent.
Packit fcad23
Packit fcad23
            (2) if other variable bindings included in the same PDU,
Packit fcad23
            provide values for all columns which are missing but
Packit fcad23
            required, and all columns have acceptable values, then
Packit fcad23
            return noError and goto D.
Packit fcad23
Packit fcad23
            (3) if other variable bindings included in the same PDU,
Packit fcad23
            provide legal values for all columns which are missing but
Packit fcad23
            required, then return noError and goto C.
Packit fcad23
Packit fcad23
            (4) at the discretion of the agent, the return value may be
Packit fcad23
            either:
Packit fcad23
Packit fcad23
                 inconsistentName:  because the agent does not choose to
Packit fcad23
                 create such an instance when the corresponding
Packit fcad23
                 RowStatus instance does not exist, or
Packit fcad23
Packit fcad23
                 inconsistentValue:  if the supplied value is
Packit fcad23
                 inconsistent with the state of some other MIB object's
Packit fcad23
                 value, or
Packit fcad23
Packit fcad23
                 noError: because the agent chooses to create the
Packit fcad23
                 instance.
Packit fcad23
Packit fcad23
            If noError is returned, then the instance of the status
Packit fcad23
            column must also be created, and the new state is B or C,
Packit fcad23
            depending on the information available to the agent.  If
Packit fcad23
            inconsistentName or inconsistentValue is returned, the row
Packit fcad23
            remains in state A.
Packit fcad23
Packit fcad23
            (5) depending on the MIB definition for the column/table,
Packit fcad23
            either noError or inconsistentValue may be returned.
Packit fcad23
Packit fcad23
            (6) the return value can indicate one of the following
Packit fcad23
            errors:
Packit fcad23
Packit fcad23
                 wrongValue: because the agent does not support
Packit fcad23
                 notInService (e.g., an agent which does not support
Packit fcad23
                 createAndWait), or
Packit fcad23
Packit fcad23
                 inconsistentValue: because the agent is unable to take
Packit fcad23
                 the row out of service at this time, perhaps because it
Packit fcad23
                 is in use and cannot be de-activated.
Packit fcad23
Packit fcad23
            (7) the return value can indicate the following error:
Packit fcad23
Packit fcad23
                 inconsistentValue: because the agent is unable to
Packit fcad23
                 remove the row at this time, perhaps because it is in
Packit fcad23
                 use and cannot be de-activated.
Packit fcad23
Packit fcad23
            (8) the transition to D can fail, e.g., if the values of the
Packit fcad23
            conceptual row are inconsistent, then the error code would
Packit fcad23
            be inconsistentValue.
Packit fcad23
Packit fcad23
            NOTE: Other processing of (this and other varbinds of) the
Packit fcad23
            set request may result in a response other than noError
Packit fcad23
            being returned, e.g., wrongValue, noCreation, etc.
Packit fcad23
Packit fcad23
                              Conceptual Row Creation
Packit fcad23
Packit fcad23
            There are four potential interactions when creating a
Packit fcad23
            conceptual row:  selecting an instance-identifier which is
Packit fcad23
            not in use; creating the conceptual row; initializing any
Packit fcad23
            objects for which the agent does not supply a default; and,
Packit fcad23
            making the conceptual row available for use by the managed
Packit fcad23
            device.
Packit fcad23
Packit fcad23
            Interaction 1: Selecting an Instance-Identifier
Packit fcad23
Packit fcad23
            The algorithm used to select an instance-identifier varies
Packit fcad23
            for each conceptual row.  In some cases, the instance-
Packit fcad23
            identifier is semantically significant, e.g., the
Packit fcad23
            destination address of a route, and a management station
Packit fcad23
            selects the instance-identifier according to the semantics.
Packit fcad23
Packit fcad23
            In other cases, the instance-identifier is used solely to
Packit fcad23
            distinguish conceptual rows, and a management station
Packit fcad23
            without specific knowledge of the conceptual row might
Packit fcad23
            examine the instances present in order to determine an
Packit fcad23
            unused instance-identifier.  (This approach may be used, but
Packit fcad23
            it is often highly sub-optimal; however, it is also a
Packit fcad23
            questionable practice for a naive management station to
Packit fcad23
            attempt conceptual row creation.)
Packit fcad23
Packit fcad23
            Alternately, the MIB module which defines the conceptual row
Packit fcad23
            might provide one or more objects which provide assistance
Packit fcad23
            in determining an unused instance-identifier.  For example,
Packit fcad23
            if the conceptual row is indexed by an integer-value, then
Packit fcad23
            an object having an integer-valued SYNTAX clause might be
Packit fcad23
            defined for such a purpose, allowing a management station to
Packit fcad23
            issue a management protocol retrieval operation.  In order
Packit fcad23
            to avoid unnecessary collisions between competing management
Packit fcad23
            stations, `adjacent' retrievals of this object should be
Packit fcad23
            different.
Packit fcad23
Packit fcad23
            Finally, the management station could select a pseudo-random
Packit fcad23
            number to use as the index.  In the event that this index
Packit fcad23
Packit fcad23
            was already in use and an inconsistentValue was returned in
Packit fcad23
            response to the management protocol set operation, the
Packit fcad23
            management station should simply select a new pseudo-random
Packit fcad23
            number and retry the operation.
Packit fcad23
Packit fcad23
            A MIB designer should choose between the two latter
Packit fcad23
            algorithms based on the size of the table (and therefore the
Packit fcad23
            efficiency of each algorithm).  For tables in which a large
Packit fcad23
            number of entries are expected, it is recommended that a MIB
Packit fcad23
            object be defined that returns an acceptable index for
Packit fcad23
            creation.  For tables with small numbers of entries, it is
Packit fcad23
            recommended that the latter pseudo-random index mechanism be
Packit fcad23
            used.
Packit fcad23
Packit fcad23
            Interaction 2: Creating the Conceptual Row
Packit fcad23
Packit fcad23
            Once an unused instance-identifier has been selected, the
Packit fcad23
            management station determines if it wishes to create and
Packit fcad23
            activate the conceptual row in one transaction or in a
Packit fcad23
            negotiated set of interactions.
Packit fcad23
Packit fcad23
            Interaction 2a: Creating and Activating the Conceptual Row
Packit fcad23
Packit fcad23
            The management station must first determine the column
Packit fcad23
            requirements, i.e., it must determine those columns for
Packit fcad23
            which it must or must not provide values.  Depending on the
Packit fcad23
            complexity of the table and the management station's
Packit fcad23
            knowledge of the agent's capabilities, this determination
Packit fcad23
            can be made locally by the management station.  Alternately,
Packit fcad23
            the management station issues a management protocol get
Packit fcad23
            operation to examine all columns in the conceptual row that
Packit fcad23
            it wishes to create.  In response, for each column, there
Packit fcad23
            are three possible outcomes:
Packit fcad23
Packit fcad23
                 - a value is returned, indicating that some other
Packit fcad23
                 management station has already created this conceptual
Packit fcad23
                 row.  We return to interaction 1.
Packit fcad23
Packit fcad23
                 - the exception `noSuchInstance' is returned,
Packit fcad23
                 indicating that the agent implements the object-type
Packit fcad23
                 associated with this column, and that this column in at
Packit fcad23
                 least one conceptual row would be accessible in the MIB
Packit fcad23
                 view used by the retrieval were it to exist. For those
Packit fcad23
                 columns to which the agent provides read-create access,
Packit fcad23
                 the `noSuchInstance' exception tells the management
Packit fcad23
                 station that it should supply a value for this column
Packit fcad23
                 when the conceptual row is to be created.
Packit fcad23
Packit fcad23
                 - the exception `noSuchObject' is returned, indicating
Packit fcad23
                 that the agent does not implement the object-type
Packit fcad23
                 associated with this column or that there is no
Packit fcad23
                 conceptual row for which this column would be
Packit fcad23
                 accessible in the MIB view used by the retrieval.  As
Packit fcad23
                 such, the management station can not issue any
Packit fcad23
                 management protocol set operations to create an
Packit fcad23
                 instance of this column.
Packit fcad23
Packit fcad23
            Once the column requirements have been determined, a
Packit fcad23
            management protocol set operation is accordingly issued.
Packit fcad23
            This operation also sets the new instance of the status
Packit fcad23
            column to `createAndGo'.
Packit fcad23
Packit fcad23
            When the agent processes the set operation, it verifies that
Packit fcad23
            it has sufficient information to make the conceptual row
Packit fcad23
            available for use by the managed device.  The information
Packit fcad23
            available to the agent is provided by two sources:  the
Packit fcad23
            management protocol set operation which creates the
Packit fcad23
            conceptual row, and, implementation-specific defaults
Packit fcad23
            supplied by the agent (note that an agent must provide
Packit fcad23
            implementation-specific defaults for at least those objects
Packit fcad23
            which it implements as read-only).  If there is sufficient
Packit fcad23
            information available, then the conceptual row is created, a
Packit fcad23
            `noError' response is returned, the status column is set to
Packit fcad23
            `active', and no further interactions are necessary (i.e.,
Packit fcad23
            interactions 3 and 4 are skipped).  If there is insufficient
Packit fcad23
            information, then the conceptual row is not created, and the
Packit fcad23
            set operation fails with an error of `inconsistentValue'.
Packit fcad23
            On this error, the management station can issue a management
Packit fcad23
            protocol retrieval operation to determine if this was
Packit fcad23
            because it failed to specify a value for a required column,
Packit fcad23
            or, because the selected instance of the status column
Packit fcad23
            already existed.  In the latter case, we return to
Packit fcad23
            interaction 1.  In the former case, the management station
Packit fcad23
            can re-issue the set operation with the additional
Packit fcad23
            information, or begin interaction 2 again using
Packit fcad23
            `createAndWait' in order to negotiate creation of the
Packit fcad23
            conceptual row.
Packit fcad23
Packit fcad23
                                     NOTE WELL
Packit fcad23
Packit fcad23
                 Regardless of the method used to determine the column
Packit fcad23
                 requirements, it is possible that the management
Packit fcad23
                 station might deem a column necessary when, in fact,
Packit fcad23
                 the agent will not allow that particular columnar
Packit fcad23
                 instance to be created or written.  In this case, the
Packit fcad23
                 management protocol set operation will fail with an
Packit fcad23
                 error such as `noCreation' or `notWritable'.  In this
Packit fcad23
                 case, the management station decides whether it needs
Packit fcad23
                 to be able to set a value for that particular columnar
Packit fcad23
                 instance.  If not, the management station re-issues the
Packit fcad23
                 management protocol set operation, but without setting
Packit fcad23
                 a value for that particular columnar instance;
Packit fcad23
                 otherwise, the management station aborts the row
Packit fcad23
                 creation algorithm.
Packit fcad23
Packit fcad23
            Interaction 2b: Negotiating the Creation of the Conceptual
Packit fcad23
            Row
Packit fcad23
Packit fcad23
            The management station issues a management protocol set
Packit fcad23
            operation which sets the desired instance of the status
Packit fcad23
            column to `createAndWait'.  If the agent is unwilling to
Packit fcad23
            process a request of this sort, the set operation fails with
Packit fcad23
            an error of `wrongValue'.  (As a consequence, such an agent
Packit fcad23
            must be prepared to accept a single management protocol set
Packit fcad23
            operation, i.e., interaction 2a above, containing all of the
Packit fcad23
            columns indicated by its column requirements.)  Otherwise,
Packit fcad23
            the conceptual row is created, a `noError' response is
Packit fcad23
            returned, and the status column is immediately set to either
Packit fcad23
            `notInService' or `notReady', depending on whether it has
Packit fcad23
            sufficient information to (attempt to) make the conceptual
Packit fcad23
            row available for use by the managed device.  If there is
Packit fcad23
            sufficient information available, then the status column is
Packit fcad23
            set to `notInService'; otherwise, if there is insufficient
Packit fcad23
            information, then the status column is set to `notReady'.
Packit fcad23
            Regardless, we proceed to interaction 3.
Packit fcad23
Packit fcad23
            Interaction 3: Initializing non-defaulted Objects
Packit fcad23
Packit fcad23
            The management station must now determine the column
Packit fcad23
            requirements.  It issues a management protocol get operation
Packit fcad23
            to examine all columns in the created conceptual row.  In
Packit fcad23
            the response, for each column, there are three possible
Packit fcad23
            outcomes:
Packit fcad23
Packit fcad23
                 - a value is returned, indicating that the agent
Packit fcad23
                 implements the object-type associated with this column
Packit fcad23
                 and had sufficient information to provide a value.  For
Packit fcad23
                 those columns to which the agent provides read-create
Packit fcad23
                 access (and for which the agent allows their values to
Packit fcad23
                 be changed after their creation), a value return tells
Packit fcad23
                 the management station that it may issue additional
Packit fcad23
                 management protocol set operations, if it desires, in
Packit fcad23
                 order to change the value associated with this column.
Packit fcad23
Packit fcad23
                 - the exception `noSuchInstance' is returned,
Packit fcad23
                 indicating that the agent implements the object-type
Packit fcad23
                 associated with this column, and that this column in at
Packit fcad23
                 least one conceptual row would be accessible in the MIB
Packit fcad23
                 view used by the retrieval were it to exist. However,
Packit fcad23
                 the agent does not have sufficient information to
Packit fcad23
                 provide a value, and until a value is provided, the
Packit fcad23
                 conceptual row may not be made available for use by the
Packit fcad23
                 managed device.  For those columns to which the agent
Packit fcad23
                 provides read-create access, the `noSuchInstance'
Packit fcad23
                 exception tells the management station that it must
Packit fcad23
                 issue additional management protocol set operations, in
Packit fcad23
                 order to provide a value associated with this column.
Packit fcad23
Packit fcad23
                 - the exception `noSuchObject' is returned, indicating
Packit fcad23
                 that the agent does not implement the object-type
Packit fcad23
                 associated with this column or that there is no
Packit fcad23
                 conceptual row for which this column would be
Packit fcad23
                 accessible in the MIB view used by the retrieval.  As
Packit fcad23
                 such, the management station can not issue any
Packit fcad23
                 management protocol set operations to create an
Packit fcad23
                 instance of this column.
Packit fcad23
Packit fcad23
            If the value associated with the status column is
Packit fcad23
            `notReady', then the management station must first deal with
Packit fcad23
            all `noSuchInstance' columns, if any.  Having done so, the
Packit fcad23
            value of the status column becomes `notInService', and we
Packit fcad23
            proceed to interaction 4.
Packit fcad23
Packit fcad23
            Interaction 4: Making the Conceptual Row Available
Packit fcad23
Packit fcad23
            Once the management station is satisfied with the values
Packit fcad23
            associated with the columns of the conceptual row, it issues
Packit fcad23
            a management protocol set operation to set the status column
Packit fcad23
            to `active'.  If the agent has sufficient information to
Packit fcad23
            make the conceptual row available for use by the managed
Packit fcad23
            device, the management protocol set operation succeeds (a
Packit fcad23
            `noError' response is returned).  Otherwise, the management
Packit fcad23
            protocol set operation fails with an error of
Packit fcad23
            `inconsistentValue'.
Packit fcad23
Packit fcad23
                                     NOTE WELL
Packit fcad23
Packit fcad23
                 A conceptual row having a status column with value
Packit fcad23
                 `notInService' or `notReady' is unavailable to the
Packit fcad23
                 managed device.  As such, it is possible for the
Packit fcad23
                 managed device to create its own instances during the
Packit fcad23
                 time between the management protocol set operation
Packit fcad23
                 which sets the status column to `createAndWait' and the
Packit fcad23
                 management protocol set operation which sets the status
Packit fcad23
                 column to `active'.  In this case, when the management
Packit fcad23
                 protocol set operation is issued to set the status
Packit fcad23
                 column to `active', the values held in the agent
Packit fcad23
                 supersede those used by the managed device.
Packit fcad23
Packit fcad23
            If the management station is prevented from setting the
Packit fcad23
            status column to `active' (e.g., due to management station
Packit fcad23
            or network failure) the conceptual row will be left in the
Packit fcad23
            `notInService' or `notReady' state, consuming resources
Packit fcad23
            indefinitely.  The agent must detect conceptual rows that
Packit fcad23
            have been in either state for an abnormally long period of
Packit fcad23
            time and remove them.  It is the responsibility of the
Packit fcad23
            DESCRIPTION clause of the status column to indicate what an
Packit fcad23
            abnormally long period of time would be.  This period of
Packit fcad23
            time should be long enough to allow for human response time
Packit fcad23
            (including `think time') between the creation of the
Packit fcad23
            conceptual row and the setting of the status to `active'.
Packit fcad23
            In the absence of such information in the DESCRIPTION
Packit fcad23
            clause, it is suggested that this period be approximately 5
Packit fcad23
            minutes in length.  This removal action applies not only to
Packit fcad23
            newly-created rows, but also to previously active rows which
Packit fcad23
            are set to, and left in, the notInService state for a
Packit fcad23
            prolonged period exceeding that which is considered normal
Packit fcad23
            for such a conceptual row.
Packit fcad23
Packit fcad23
                             Conceptual Row Suspension
Packit fcad23
Packit fcad23
            When a conceptual row is `active', the management station
Packit fcad23
            may issue a management protocol set operation which sets the
Packit fcad23
            instance of the status column to `notInService'.  If the
Packit fcad23
            agent is unwilling to do so, the set operation fails with an
Packit fcad23
            error of `wrongValue' or `inconsistentValue'.  Otherwise,
Packit fcad23
            the conceptual row is taken out of service, and a `noError'
Packit fcad23
            response is returned.  It is the responsibility of the
Packit fcad23
            DESCRIPTION clause of the status column to indicate under
Packit fcad23
            what circumstances the status column should be taken out of
Packit fcad23
            service (e.g., in order for the value of some other column
Packit fcad23
            of the same conceptual row to be modified).
Packit fcad23
Packit fcad23
                              Conceptual Row Deletion
Packit fcad23
Packit fcad23
            For deletion of conceptual rows, a management protocol set
Packit fcad23
            operation is issued which sets the instance of the status
Packit fcad23
            column to `destroy'.  This request may be made regardless of
Packit fcad23
            the current value of the status column (e.g., it is possible
Packit fcad23
            to delete conceptual rows which are either `notReady',
Packit fcad23
            `notInService' or `active'.)  If the operation succeeds,
Packit fcad23
            then all instances associated with the conceptual row are
Packit fcad23
            immediately removed."
Packit fcad23
    SYNTAX       INTEGER {
Packit fcad23
                     -- the following two values are states:
Packit fcad23
                     -- these values may be read or written
Packit fcad23
                     active(1),
Packit fcad23
                     notInService(2),
Packit fcad23
                     -- the following value is a state:
Packit fcad23
                     -- this value may be read, but not written
Packit fcad23
                     notReady(3),
Packit fcad23
                     -- the following three values are
Packit fcad23
                     -- actions: these values may be written,
Packit fcad23
                     --   but are never read
Packit fcad23
                     createAndGo(4),
Packit fcad23
                     createAndWait(5),
Packit fcad23
                     destroy(6)
Packit fcad23
                 }
Packit fcad23
Packit fcad23
TimeStamp ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The value of the sysUpTime object at which a specific
Packit fcad23
            occurrence happened.  The specific occurrence must be
Packit fcad23
Packit fcad23
            defined in the description of any object defined using this
Packit fcad23
            type.
Packit fcad23
Packit fcad23
            If sysUpTime is reset to zero as a result of a re-
Packit fcad23
            initialization of the network management (sub)system, then
Packit fcad23
            the values of all TimeStamp objects are also reset.
Packit fcad23
            However, after approximately 497 days without a re-
Packit fcad23
            initialization, the sysUpTime object will reach 2^^32-1 and
Packit fcad23
            then increment around to zero; in this case, existing values
Packit fcad23
            of TimeStamp objects do not change.  This can lead to
Packit fcad23
            ambiguities in the value of TimeStamp objects."
Packit fcad23
    SYNTAX       TimeTicks
Packit fcad23
Packit fcad23
TimeInterval ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "A period of time, measured in units of 0.01 seconds."
Packit fcad23
    SYNTAX       INTEGER (0..2147483647)
Packit fcad23
Packit fcad23
DateAndTime ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "2d-1d-1d,1d:1d:1d.1d,1a1d:1d"
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "A date-time specification.
Packit fcad23
Packit fcad23
            field  octets  contents                  range
Packit fcad23
            -----  ------  --------                  -----
Packit fcad23
              1      1-2   year*                     0..65536
Packit fcad23
              2       3    month                     1..12
Packit fcad23
              3       4    day                       1..31
Packit fcad23
              4       5    hour                      0..23
Packit fcad23
              5       6    minutes                   0..59
Packit fcad23
              6       7    seconds                   0..60
Packit fcad23
                           (use 60 for leap-second)
Packit fcad23
              7       8    deci-seconds              0..9
Packit fcad23
              8       9    direction from UTC        '+' / '-'
Packit fcad23
              9      10    hours from UTC*           0..13
Packit fcad23
             10      11    minutes from UTC          0..59
Packit fcad23
Packit fcad23
            * Notes:
Packit fcad23
            - the value of year is in network-byte order
Packit fcad23
            - daylight saving time in New Zealand is +13
Packit fcad23
Packit fcad23
            For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be
Packit fcad23
            displayed as:
Packit fcad23
Packit fcad23
                             1992-5-26,13:30:15.0,-4:0
Packit fcad23
Packit fcad23
            Note that if only local time is known, then timezone
Packit fcad23
            information (fields 8-10) is not present."
Packit fcad23
    SYNTAX       OCTET STRING (SIZE (8 | 11))
Packit fcad23
Packit fcad23
StorageType ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Describes the memory realization of a conceptual row.  A
Packit fcad23
            row which is volatile(2) is lost upon reboot.  A row which
Packit fcad23
            is either nonVolatile(3), permanent(4) or readOnly(5), is
Packit fcad23
            backed up by stable storage.  A row which is permanent(4)
Packit fcad23
            can be changed but not deleted.  A row which is readOnly(5)
Packit fcad23
            cannot be changed nor deleted.
Packit fcad23
Packit fcad23
            If the value of an object with this syntax is either
Packit fcad23
            permanent(4) or readOnly(5), it cannot be written.
Packit fcad23
            Conversely, if the value is either other(1), volatile(2) or
Packit fcad23
            nonVolatile(3), it cannot be modified to be permanent(4) or
Packit fcad23
            readOnly(5).  (All illegal modifications result in a
Packit fcad23
            'wrongValue' error.)
Packit fcad23
Packit fcad23
            Every usage of this textual convention is required to
Packit fcad23
            specify the columnar objects which a permanent(4) row must
Packit fcad23
            at a minimum allow to be writable."
Packit fcad23
    SYNTAX       INTEGER {
Packit fcad23
                     other(1),       -- eh?
Packit fcad23
                     volatile(2),    -- e.g., in RAM
Packit fcad23
                     nonVolatile(3), -- e.g., in NVRAM
Packit fcad23
                     permanent(4),   -- e.g., partially in ROM
Packit fcad23
                     readOnly(5)     -- e.g., completely in ROM
Packit fcad23
                 }
Packit fcad23
Packit fcad23
TDomain ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
          "Denotes a kind of transport service.
Packit fcad23
Packit fcad23
          Some possible values, such as snmpUDPDomain, are defined in
Packit fcad23
          the SNMPv2-TM MIB module.  Other possible values are defined
Packit fcad23
          in other MIB modules."
Packit fcad23
    REFERENCE    "The SNMPv2-TM MIB module is defined in RFC 1906."
Packit fcad23
    SYNTAX       OBJECT IDENTIFIER
Packit fcad23
Packit fcad23
TAddress ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS       current
Packit fcad23
    DESCRIPTION
Packit fcad23
          "Denotes a transport service address.
Packit fcad23
Packit fcad23
          A TAddress value is always interpreted within the context of a
Packit fcad23
          TDomain value.  Thus, each definition of a TDomain value must
Packit fcad23
          be accompanied by a definition of a textual convention for use
Packit fcad23
          with that TDomain.  Some possible textual conventions, such as
Packit fcad23
          SnmpUDPAddress for snmpUDPDomain, are defined in the SNMPv2-TM
Packit fcad23
          MIB module.  Other possible textual conventions are defined in
Packit fcad23
          other MIB modules."
Packit fcad23
    REFERENCE    "The SNMPv2-TM MIB module is defined in RFC 1906."
Packit fcad23
    SYNTAX       OCTET STRING (SIZE (1..255))
Packit fcad23
Packit fcad23
END