Blame mibs/irtf/IRTF-NMRG-SMING-TYPES

Packit 022b05
module IRTF-NMRG-SMING-TYPES {
Packit 022b05
Packit 022b05
//
Packit 022b05
// $RCSfile: IRTF-NMRG-SMING-TYPES,v $
Packit 022b05
// $Revision: 7606 $
Packit 022b05
// $Author: schoenw $
Packit 022b05
// $Date: 2008-01-22 13:38:03 +0100 (Tue, 22 Jan 2008) $
Packit 022b05
//
Packit 022b05
Packit 022b05
    organization    "IRTF Network Management Research Group (NMRG),
Packit 022b05
                     Network Management Group, TU Braunschweig";
Packit 022b05
Packit 022b05
    contact         "        Frank Strauss
Packit 022b05
Packit 022b05
                     Postal: TU Braunschweig
Packit 022b05
                             Bueltenweg 74/75
Packit 022b05
                             38106 Braunschweig
Packit 022b05
                             Germany
Packit 022b05
Packit 022b05
                      Phone: +49 531 391-3266
Packit 022b05
                      EMail: strauss@ibr.cs.tu-bs.de";
Packit 022b05
Packit 022b05
    description     "Core type definitions for SMIng.";
Packit 022b05
Packit 022b05
    revision {
Packit 022b05
        date        "2000-10-19";
Packit 022b05
        description "Special semantics and default value of 8 or 11
Packit 022b05
		     zero bytes for the DateAndTime type.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    revision {
Packit 022b05
        date        "2000-02-13";
Packit 022b05
        description "SMIng grammar dropped module identity objects.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    revision {
Packit 022b05
        date        "1999-05-07";
Packit 022b05
        description "Initial Revision.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef Gauge32 {
Packit 022b05
        type        Unsigned32;
Packit 022b05
        description
Packit 022b05
           "The Gauge32 type represents a non-negative integer,
Packit 022b05
            which may increase or decrease, but shall never
Packit 022b05
            exceed a maximum value, nor fall below a minimum
Packit 022b05
            value.  The maximum value can not be greater than
Packit 022b05
            2^32-1 (4294967295 decimal), and the minimum value
Packit 022b05
            can not be smaller than 0.  The value of a Gauge32
Packit 022b05
            has its maximum value whenever the information
Packit 022b05
            being modeled is greater than or equal to its
Packit 022b05
            maximum value, and has its minimum value whenever
Packit 022b05
            the information being modeled is smaller than or
Packit 022b05
            equal to its minimum value.  If the information
Packit 022b05
            being modeled subsequently decreases below
Packit 022b05
            (increases above) the maximum (minimum) value, the
Packit 022b05
            Gauge32 also decreases (increases).  (Note that
Packit 022b05
            despite of the use of the term `latched' in the
Packit 022b05
            original definition of this type, it does not
Packit 022b05
            become `stuck' at its maximum or minimum value.)";
Packit 022b05
        reference
Packit 022b05
           "RFC 2578, Sections 2. and 7.1.7.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef Counter32 {
Packit 022b05
        type        Unsigned32;
Packit 022b05
        description
Packit 022b05
           "The Counter32 type represents a non-negative integer
Packit 022b05
            which monotonically increases until it reaches a
Packit 022b05
            maximum value of 2^32-1 (4294967295 decimal), when it
Packit 022b05
            wraps around and starts increasing again from zero.
Packit 022b05
               
Packit 022b05
            Counters have no defined `initial' value, and thus, a
Packit 022b05
            single value of a Counter has (in general) no
Packit 022b05
            information content.  Discontinuities in the
Packit 022b05
            monotonically increasing value normally occur at
Packit 022b05
            re-initialization of the management system, and at
Packit 022b05
            other times as specified in the description of an
Packit 022b05
            object using this type.  If such other times can
Packit 022b05
            occur, for example, the creation of an object
Packit 022b05
            instance at times other than re-initialization, then
Packit 022b05
            a corresponding object should be defined, with an
Packit 022b05
            appropriate type, to indicate the last discontinuity.
Packit 022b05
            Examples of appropriate types include: TimeStamp,
Packit 022b05
            DateAndTime or TimeTicks (other types defined in this
Packit 022b05
            module).
Packit 022b05
               
Packit 022b05
            The value of the access statement for objects with a
Packit 022b05
            type value of Counter32 should be either `readonly'
Packit 022b05
            or `notifyonly'.
Packit 022b05
               
Packit 022b05
            A default statement should not be used for objects
Packit 022b05
            with a type value of Counter32.";
Packit 022b05
        reference
Packit 022b05
           "RFC 2578, Sections 2. and 7.1.6.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef Gauge64 {
Packit 022b05
        type        Unsigned64;
Packit 022b05
        description
Packit 022b05
           "The Gauge64 type represents a non-negative integer,
Packit 022b05
            which may increase or decrease, but shall never
Packit 022b05
            exceed a maximum value, nor fall below a minimum
Packit 022b05
            value.  The maximum value can not be greater than
Packit 022b05
            2^64-1 (18446744073709551615), and the minimum value
Packit 022b05
            can not be smaller than 0.  The value of a Gauge64
Packit 022b05
            has its maximum value whenever the information
Packit 022b05
            being modeled is greater than or equal to its
Packit 022b05
            maximum value, and has its minimum value whenever
Packit 022b05
            the information being modeled is smaller than or
Packit 022b05
            equal to its minimum value.  If the information
Packit 022b05
            being modeled subsequently decreases below
Packit 022b05
            (increases above) the maximum (minimum) value, the
Packit 022b05
            Gauge64 also decreases (increases).  (Note that
Packit 022b05
            despite of the use of the term `latched' in the
Packit 022b05
            original definition of this type, it does not
Packit 022b05
            become `stuck' at its maximum or minimum value.)";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef Counter64 {
Packit 022b05
        type        Unsigned64;
Packit 022b05
        description
Packit 022b05
           "The Counter64 type represents a non-negative integer
Packit 022b05
            which monotonically increases until it reaches a
Packit 022b05
            maximum value of 2^64-1 (18446744073709551615), when
Packit 022b05
            it wraps around and starts increasing again from zero.
Packit 022b05
               
Packit 022b05
            Counters have no defined `initial' value, and thus, a
Packit 022b05
            single value of a Counter has (in general) no
Packit 022b05
            information content.  Discontinuities in the
Packit 022b05
            monotonically increasing value normally occur at
Packit 022b05
            re-initialization of the management system, and at
Packit 022b05
            other times as specified in the description of an
Packit 022b05
            object using this type.  If such other times can
Packit 022b05
            occur, for example, the creation of an object
Packit 022b05
            instance at times other than re-initialization, then
Packit 022b05
            a corresponding object should be defined, with an
Packit 022b05
            appropriate type, to indicate the last discontinuity.
Packit 022b05
            Examples of appropriate types include: TimeStamp,
Packit 022b05
            DateAndTime or TimeTicks (other types defined in this
Packit 022b05
            module).
Packit 022b05
               
Packit 022b05
            The value of the access statement for objects with a
Packit 022b05
            type value of Counter64 should be either `readonly'
Packit 022b05
            or `notifyonly'.
Packit 022b05
               
Packit 022b05
            A default statement should not be used for objects
Packit 022b05
            with a type value of Counter64.";
Packit 022b05
        reference
Packit 022b05
           "RFC 2578, Sections 2. and 7.1.10.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef Opaque {
Packit 022b05
        type        OctetString;
Packit 022b05
        description
Packit 022b05
           "The Opaque type is provided solely for
Packit 022b05
            backward-compatibility, and shall not be used for
Packit 022b05
            newly-defined object types.
Packit 022b05
                 
Packit 022b05
            The Opaque type supports the capability to pass
Packit 022b05
            arbitrary ASN.1 syntax.  A value is encoded using
Packit 022b05
            the ASN.1 Basic Encoding Rules into a string of
Packit 022b05
            octets.  This, in turn, is encoded as an
Packit 022b05
            OctetString, in effect `double-wrapping' the
Packit 022b05
            original ASN.1 value.
Packit 022b05
                 
Packit 022b05
            Note that a conforming implementation need only be
Packit 022b05
            able to accept and recognize opaquely-encoded data.
Packit 022b05
            It need not be able to unwrap the data and then
Packit 022b05
            interpret its contents.
Packit 022b05
                 
Packit 022b05
            A requirement on `standard' MIB modules is that no
Packit 022b05
            object may have a type value of Opaque.";
Packit 022b05
        reference
Packit 022b05
           "RFC 2578, Sections 2. and 7.1.9.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef IpAddress {
Packit 022b05
        type        OctetString (4);
Packit 022b05
        status      deprecated;
Packit 022b05
        description
Packit 022b05
           "******* THIS TYPE DEFINITION IS DEPRECATED *******
Packit 022b05
Packit 022b05
            The IpAddress type represents a 32-bit internet
Packit 022b05
            IPv4 address.  It is represented as an OctetString
Packit 022b05
            of length 4, in network byte-order.
Packit 022b05
                
Packit 022b05
            Note that the IpAddress type is present for
Packit 022b05
            historical reasons. IPv4 and IPv6 addresses should
Packit 022b05
            be represented using the IpAddr type. Generic
Packit 022b05
            Network addresses should be represented using a
Packit 022b05
            pair of TDomain and TAddress types (all defined in
Packit 022b05
            this module).";
Packit 022b05
        reference
Packit 022b05
           "RFC 2578, Sections 2. and 7.1.5.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef TimeTicks {
Packit 022b05
        type        Unsigned32;
Packit 022b05
        description
Packit 022b05
           "The TimeTicks type represents a non-negative
Packit 022b05
            integer which represents the time, modulo 2^32
Packit 022b05
            (4294967296 decimal), in hundredths of a second
Packit 022b05
            between two epochs.  When objects are defined which
Packit 022b05
            use this type, the description of the object
Packit 022b05
            identifies both of the reference epochs.
Packit 022b05
                 
Packit 022b05
            For example, the TimeStamp type (defined in this
Packit 022b05
            module) is based on the TimeTicks type.
Packit 022b05
Packit 022b05
            With a TimeStamp, the first reference epoch is
Packit 022b05
            defined as the time when SNMPv2-MIB::sysUpTime was
Packit 022b05
            zero, and the second reference epoch is defined as
Packit 022b05
            the current value of sysUpTime.
Packit 022b05
                 
Packit 022b05
            The TimeTicks type should not be sub-typed.";
Packit 022b05
        reference
Packit 022b05
           "RFC 2578, Sections 2. and 7.1.8.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    //
Packit 022b05
    //  The following type definitions are
Packit 022b05
    //  conversions of the textual conventions from
Packit 022b05
    //  the SNMPv2-TC module (RFC 2579), except for
Packit 022b05
    //  TAddressOrZero, which is not present in
Packit 022b05
    //  SNMPv2-TC.
Packit 022b05
    //
Packit 022b05
Packit 022b05
    typedef DisplayString {
Packit 022b05
        type        OctetString (0..255);
Packit 022b05
        format      "255a";
Packit 022b05
        description 
Packit 022b05
        "Represents textual information taken from the NVT ASCII
Packit 022b05
         character set, as defined in pages 4, 10-11 of RFC 854.
Packit 022b05
         
Packit 022b05
         To summarize RFC 854, the NVT ASCII repertoire specifies:
Packit 022b05
         
Packit 022b05
          - the use of character codes 0-127 (decimal)
Packit 022b05
         
Packit 022b05
          - the graphics characters (32-126) are interpreted as
Packit 022b05
            US ASCII
Packit 022b05
         
Packit 022b05
          - NUL, LF, CR, BEL, BS, HT, VT and FF have the special
Packit 022b05
            meanings specified in RFC 854
Packit 022b05
         
Packit 022b05
          - the other 25 codes have no standard interpretation
Packit 022b05
         
Packit 022b05
          - the sequence 'CR LF' means newline
Packit 022b05
         
Packit 022b05
          - the sequence 'CR NUL' means carriage-return
Packit 022b05
         
Packit 022b05
          - an 'LF' not preceded by a 'CR' means moving to the
Packit 022b05
            same column on the next line.
Packit 022b05
         
Packit 022b05
          - the sequence 'CR x' for any x other than LF or NUL is
Packit 022b05
            illegal.  (Note that this also means that a string may
Packit 022b05
            end with either 'CR LF' or 'CR NUL', but not with CR.)
Packit 022b05
         
Packit 022b05
         Any object defined using this syntax may not exceed 255
Packit 022b05
         characters in length.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef PhysAddress {
Packit 022b05
        type        OctetString;
Packit 022b05
        format      "1x:";
Packit 022b05
        description 
Packit 022b05
        "Represents media- or physical-level addresses.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef MacAddress {
Packit 022b05
        type        OctetString (6);
Packit 022b05
        format      "1x:";
Packit 022b05
        description 
Packit 022b05
        "Represents an 802 MAC address represented in the
Packit 022b05
         `canonical' order defined by IEEE 802.1a, i.e., as if it
Packit 022b05
         were transmitted least significant bit first, even though
Packit 022b05
         802.5 (in contrast to other 802.x protocols) requires MAC
Packit 022b05
         addresses to be transmitted most significant bit first.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef TruthValue {
Packit 022b05
        type        Enumeration (true(1), false(2));
Packit 022b05
        description 
Packit 022b05
        "Represents a boolean value.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef TestAndIncr {
Packit 022b05
        type        Integer32 (0..2147483647);
Packit 022b05
        description 
Packit 022b05
        "Represents integer-valued information used for atomic
Packit 022b05
         operations.  When the management protocol is used to specify
Packit 022b05
         that an object instance having this syntax is to be
Packit 022b05
         modified, the new value supplied via the management protocol
Packit 022b05
         must precisely match the value presently held by the
Packit 022b05
         instance.  If not, the management protocol set operation
Packit 022b05
         fails with an error of `inconsistentValue'.  Otherwise, if
Packit 022b05
         the current value is the maximum value of 2^31-1 (2147483647
Packit 022b05
         decimal), then the value held by the instance is wrapped to
Packit 022b05
         zero; otherwise, the value held by the instance is
Packit 022b05
         incremented by one.  (Note that regardless of whether the
Packit 022b05
         management protocol set operation succeeds, the variable-
Packit 022b05
         binding in the request and response PDUs are identical.)
Packit 022b05
         
Packit 022b05
         The value of the ACCESS clause for objects having this
Packit 022b05
         syntax is either `read-write' or `read-create'.  When an
Packit 022b05
         instance of a columnar object having this syntax is created,
Packit 022b05
         any value may be supplied via the management protocol.
Packit 022b05
         
Packit 022b05
         When the network management portion of the system is re-
Packit 022b05
         initialized, the value of every object instance having this
Packit 022b05
         syntax must either be incremented from its value prior to
Packit 022b05
         the re-initialization, or (if the value prior to the re-
Packit 022b05
         initialization is unknown) be set to a pseudo-randomly
Packit 022b05
         generated value.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef AutonomousType {
Packit 022b05
        type        ObjectIdentifier;
Packit 022b05
        description 
Packit 022b05
        "Represents an independently extensible type identification
Packit 022b05
         value.  It may, for example, indicate a particular sub-tree
Packit 022b05
         with further MIB definitions, or define a particular type of
Packit 022b05
         protocol or hardware.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef InstancePointer {
Packit 022b05
        type        ObjectIdentifier;
Packit 022b05
        status      obsolete;
Packit 022b05
        description 
Packit 022b05
        "A pointer to either a specific instance of a MIB object or
Packit 022b05
         a conceptual row of a MIB table in the managed device.  In
Packit 022b05
         the latter case, by convention, it is the name of the
Packit 022b05
         particular instance of the first accessible columnar object
Packit 022b05
         in the conceptual row.
Packit 022b05
         
Packit 022b05
         The two uses of this textual convention are replaced by
Packit 022b05
         VariablePointer and RowPointer, respectively.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef VariablePointer {
Packit 022b05
        type        ObjectIdentifier;
Packit 022b05
        description 
Packit 022b05
        "A pointer to a specific object instance.  For example,
Packit 022b05
         sysContact.0 or ifInOctets.3.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef RowPointer {
Packit 022b05
        type        ObjectIdentifier;
Packit 022b05
        description 
Packit 022b05
        "Represents a pointer to a conceptual row.  The value is the
Packit 022b05
         name of the instance of the first accessible columnar object
Packit 022b05
         in the conceptual row.
Packit 022b05
         
Packit 022b05
         For example, ifIndex.3 would point to the 3rd row in the
Packit 022b05
         ifTable (note that if ifIndex were not-accessible, then
Packit 022b05
         ifDescr.3 would be used instead).";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef RowStatus {
Packit 022b05
        type        Enumeration (active(1), notInService(2), 
Packit 022b05
                        notReady(3), createAndGo(4), 
Packit 022b05
                        createAndWait(5), destroy(6));
Packit 022b05
        description 
Packit 022b05
        "The RowStatus textual convention is used to manage the
Packit 022b05
         creation and deletion of conceptual rows, and is used as the
Packit 022b05
         value of the SYNTAX clause for the status column of a
Packit 022b05
         conceptual row (as described in Section 7.7.1 of [2].)
Packit 022b05
         
Packit 022b05
         The status column has six defined values:
Packit 022b05
         
Packit 022b05
             - `active', which indicates that the conceptual row is
Packit 022b05
             available for use by the managed device;
Packit 022b05
         
Packit 022b05
             - `notInService', which indicates that the conceptual
Packit 022b05
             row exists in the agent, but is unavailable for use by
Packit 022b05
             the managed device (see NOTE below);
Packit 022b05
         
Packit 022b05
             - `notReady', which indicates that the conceptual row
Packit 022b05
             exists in the agent, but is missing information
Packit 022b05
             necessary in order to be available for use by the
Packit 022b05
             managed device;
Packit 022b05
         
Packit 022b05
             - `createAndGo', which is supplied by a management
Packit 022b05
             station wishing to create a new instance of a
Packit 022b05
             conceptual row and to have its status automatically set
Packit 022b05
             to active, making it available for use by the managed
Packit 022b05
             device;
Packit 022b05
         
Packit 022b05
             - `createAndWait', which is supplied by a management
Packit 022b05
             station wishing to create a new instance of a
Packit 022b05
             conceptual row (but not make it available for use by
Packit 022b05
             the managed device); and,
Packit 022b05
         
Packit 022b05
             - `destroy', which is supplied by a management station
Packit 022b05
             wishing to delete all of the instances associated with
Packit 022b05
             an existing conceptual row.
Packit 022b05
         
Packit 022b05
         Whereas five of the six values (all except `notReady') may
Packit 022b05
         be specified in a management protocol set operation, only
Packit 022b05
         three values will be returned in response to a management
Packit 022b05
         protocol retrieval operation: `notReady', `notInService' or
Packit 022b05
         `active'.  That is, when queried, an existing conceptual row
Packit 022b05
         has only three states: it is either available for use by the
Packit 022b05
         managed device (the status column has value `active'); it is
Packit 022b05
         not available for use by the managed device, though the
Packit 022b05
         
Packit 022b05
         
Packit 022b05
         agent has sufficient information to make it so (the status
Packit 022b05
         column has value `notInService'); or, it is not available
Packit 022b05
         for use by the managed device, and an attempt to make it so
Packit 022b05
         would fail because the agent has insufficient information
Packit 022b05
         (the state column has value `notReady').
Packit 022b05
         
Packit 022b05
                                 NOTE WELL
Packit 022b05
         
Packit 022b05
             This textual convention may be used for a MIB table,
Packit 022b05
             irrespective of whether the values of that table's
Packit 022b05
             conceptual rows are able to be modified while it is
Packit 022b05
             active, or whether its conceptual rows must be taken
Packit 022b05
             out of service in order to be modified.  That is, it is
Packit 022b05
             the responsibility of the DESCRIPTION clause of the
Packit 022b05
             status column to specify whether the status column must
Packit 022b05
             not be `active' in order for the value of some other
Packit 022b05
             column of the same conceptual row to be modified.  If
Packit 022b05
             such a specification is made, affected columns may be
Packit 022b05
             changed by an SNMP set PDU if the RowStatus would not
Packit 022b05
             be equal to `active' either immediately before or after
Packit 022b05
             processing the PDU.  In other words, if the PDU also
Packit 022b05
             contained a varbind that would change the RowStatus
Packit 022b05
             value, the column in question may be changed if the
Packit 022b05
             RowStatus was not equal to `active' as the PDU was
Packit 022b05
             received, or if the varbind sets the status to a value
Packit 022b05
             other than 'active'.
Packit 022b05
         
Packit 022b05
         Also note that whenever any elements of a row exist, the
Packit 022b05
         RowStatus column must also exist.
Packit 022b05
         
Packit 022b05
         
Packit 022b05
         To summarize the effect of having a conceptual row with a
Packit 022b05
         status column having a SYNTAX clause value of RowStatus,
Packit 022b05
         consider the following state diagram:
Packit 022b05
         
Packit 022b05
                                         STATE
Packit 022b05
              +--------------+-----------+-------------+-------------
Packit 022b05
              |      A       |     B     |      C      |      D
Packit 022b05
              |              |status col.|status column|
Packit 022b05
              |status column |    is     |      is     |status column
Packit 022b05
    ACTION    |does not exist|  notReady | notInService|  is active
Packit 022b05
--------------+--------------+-----------+-------------+-------------
Packit 022b05
set status    |noError    ->D|inconsist- |inconsistent-|inconsistent-
Packit 022b05
column to     |       or     |   entValue|        Value|        Value
Packit 022b05
createAndGo   |inconsistent- |           |             |
Packit 022b05
              |         Value|           |             |
Packit 022b05
--------------+--------------+-----------+-------------+-------------
Packit 022b05
set status    |noError  see 1|inconsist- |inconsistent-|inconsistent-
Packit 022b05
column to     |       or     |   entValue|        Value|        Value
Packit 022b05
createAndWait |wrongValue    |           |             |
Packit 022b05
--------------+--------------+-----------+-------------+-------------
Packit 022b05
set status    |inconsistent- |inconsist- |noError      |noError
Packit 022b05
column to     |         Value|   entValue|             |
Packit 022b05
active        |              |           |             |
Packit 022b05
              |              |     or    |             |
Packit 022b05
              |              |           |             |
Packit 022b05
              |              |see 2   ->D|see 8     ->D|          ->D
Packit 022b05
--------------+--------------+-----------+-------------+-------------
Packit 022b05
set status    |inconsistent- |inconsist- |noError      |noError   ->C
Packit 022b05
column to     |         Value|   entValue|             |
Packit 022b05
notInService  |              |           |             |
Packit 022b05
              |              |     or    |             |      or
Packit 022b05
              |              |           |             |
Packit 022b05
              |              |see 3   ->C|          ->C|see 6
Packit 022b05
--------------+--------------+-----------+-------------+-------------
Packit 022b05
set status    |noError       |noError    |noError      |noError   ->A
Packit 022b05
column to     |              |           |             |      or
Packit 022b05
destroy       |           ->A|        ->A|          ->A|see 7
Packit 022b05
--------------+--------------+-----------+-------------+-------------
Packit 022b05
set any other |see 4         |noError    |noError      |see 5
Packit 022b05
column to some|              |           |             |
Packit 022b05
value         |              |      see 1|          ->C|          ->D
Packit 022b05
--------------+--------------+-----------+-------------+-------------
Packit 022b05
         
Packit 022b05
         (1) goto B or C, depending on information available to the
Packit 022b05
         
Packit 022b05
         
Packit 022b05
         agent.
Packit 022b05
         
Packit 022b05
         (2) if other variable bindings included in the same PDU,
Packit 022b05
         provide values for all columns which are missing but
Packit 022b05
         required, then return noError and goto D.
Packit 022b05
         
Packit 022b05
         (3) if other variable bindings included in the same PDU,
Packit 022b05
         provide values for all columns which are missing but
Packit 022b05
         required, then return noError and goto C.
Packit 022b05
         
Packit 022b05
         (4) at the discretion of the agent, the return value may be
Packit 022b05
         either:
Packit 022b05
         
Packit 022b05
             inconsistentName: because the agent does not choose to
Packit 022b05
             create such an instance when the corresponding
Packit 022b05
             RowStatus instance does not exist, or
Packit 022b05
         
Packit 022b05
             inconsistentValue: if the supplied value is
Packit 022b05
             inconsistent with the state of some other MIB object's
Packit 022b05
             value, or
Packit 022b05
         
Packit 022b05
             noError: because the agent chooses to create the
Packit 022b05
             instance.
Packit 022b05
         
Packit 022b05
         If noError is returned, then the instance of the status
Packit 022b05
         column must also be created, and the new state is B or C,
Packit 022b05
         depending on the information available to the agent.  If
Packit 022b05
         inconsistentName or inconsistentValue is returned, the row
Packit 022b05
         remains in state A.
Packit 022b05
         
Packit 022b05
         (5) depending on the MIB definition for the column/table,
Packit 022b05
         either noError or inconsistentValue may be returned.
Packit 022b05
         
Packit 022b05
         (6) the return value can indicate one of the following
Packit 022b05
         errors:
Packit 022b05
         
Packit 022b05
             wrongValue: because the agent does not support
Packit 022b05
             createAndWait, or
Packit 022b05
         
Packit 022b05
             inconsistentValue: because the agent is unable to take
Packit 022b05
             the row out of service at this time, perhaps because it
Packit 022b05
             is in use and cannot be de-activated.
Packit 022b05
         
Packit 022b05
         (7) the return value can indicate the following error:
Packit 022b05
         
Packit 022b05
         
Packit 022b05
             inconsistentValue: because the agent is unable to
Packit 022b05
             remove the row at this time, perhaps because it is in
Packit 022b05
             use and cannot be de-activated.
Packit 022b05
         
Packit 022b05
         NOTE: Other processing of the set request may result in a
Packit 022b05
         response other than noError being returned, e.g.,
Packit 022b05
         wrongValue, noCreation, etc.
Packit 022b05
         
Packit 022b05
                          Conceptual Row Creation
Packit 022b05
         
Packit 022b05
         There are four potential interactions when creating a
Packit 022b05
         conceptual row: selecting an instance-identifier which is
Packit 022b05
         not in use; creating the conceptual row; initializing any
Packit 022b05
         objects for which the agent does not supply a default; and,
Packit 022b05
         making the conceptual row available for use by the managed
Packit 022b05
         device.
Packit 022b05
         
Packit 022b05
         Interaction 1: Selecting an Instance-Identifier
Packit 022b05
         
Packit 022b05
         The algorithm used to select an instance-identifier varies
Packit 022b05
         for each conceptual row.  In some cases, the instance-
Packit 022b05
         identifier is semantically significant, e.g., the
Packit 022b05
         destination address of a route, and a management station
Packit 022b05
         selects the instance-identifier according to the semantics.
Packit 022b05
         
Packit 022b05
         In other cases, the instance-identifier is used solely to
Packit 022b05
         distinguish conceptual rows, and a management station
Packit 022b05
         without specific knowledge of the conceptual row might
Packit 022b05
         examine the instances present in order to determine an
Packit 022b05
         unused instance-identifier.  (This approach may be used, but
Packit 022b05
         it is often highly sub-optimal; however, it is also a
Packit 022b05
         questionable practice for a naive management station to
Packit 022b05
         attempt conceptual row creation.)
Packit 022b05
         
Packit 022b05
         Alternately, the MIB module which defines the conceptual row
Packit 022b05
         might provide one or more objects which provide assistance
Packit 022b05
         in determining an unused instance-identifier.  For example,
Packit 022b05
         if the conceptual row is indexed by an integer-value, then
Packit 022b05
         an object having an integer-valued SYNTAX clause might be
Packit 022b05
         defined for such a purpose, allowing a management station to
Packit 022b05
         issue a management protocol retrieval operation.  In order
Packit 022b05
         to avoid unnecessary collisions between competing management
Packit 022b05
         stations, `adjacent' retrievals of this object should be
Packit 022b05
         different.
Packit 022b05
         
Packit 022b05
         
Packit 022b05
         Finally, the management station could select a pseudo-random
Packit 022b05
         number to use as the index.  In the event that this index
Packit 022b05
         was already in use and an inconsistentValue was returned in
Packit 022b05
         response to the management protocol set operation, the
Packit 022b05
         management station should simply select a new pseudo-random
Packit 022b05
         number and retry the operation.
Packit 022b05
         
Packit 022b05
         A MIB designer should choose between the two latter
Packit 022b05
         algorithms based on the size of the table (and therefore the
Packit 022b05
         efficiency of each algorithm).  For tables in which a large
Packit 022b05
         number of entries are expected, it is recommended that a MIB
Packit 022b05
         object be defined that returns an acceptable index for
Packit 022b05
         creation.  For tables with small numbers of entries, it is
Packit 022b05
         recommended that the latter pseudo-random index mechanism be
Packit 022b05
         used.
Packit 022b05
         
Packit 022b05
         Interaction 2: Creating the Conceptual Row
Packit 022b05
         
Packit 022b05
         Once an unused instance-identifier has been selected, the
Packit 022b05
         management station determines if it wishes to create and
Packit 022b05
         activate the conceptual row in one transaction or in a
Packit 022b05
         negotiated set of interactions.
Packit 022b05
         
Packit 022b05
         Interaction 2a: Creating and Activating the Conceptual Row
Packit 022b05
         
Packit 022b05
         The management station must first determine the column
Packit 022b05
         requirements, i.e., it must determine those columns for
Packit 022b05
         which it must or must not provide values.  Depending on the
Packit 022b05
         complexity of the table and the management station's
Packit 022b05
         knowledge of the agent's capabilities, this determination
Packit 022b05
         can be made locally by the management station.  Alternately,
Packit 022b05
         the management station issues a management protocol get
Packit 022b05
         operation to examine all columns in the conceptual row that
Packit 022b05
         it wishes to create.  In response, for each column, there
Packit 022b05
         are three possible outcomes:
Packit 022b05
         
Packit 022b05
             - a value is returned, indicating that some other
Packit 022b05
             management station has already created this conceptual
Packit 022b05
             row.  We return to interaction 1.
Packit 022b05
         
Packit 022b05
         
Packit 022b05
             - the exception `noSuchInstance' is returned,
Packit 022b05
             indicating that the agent implements the object-type
Packit 022b05
             associated with this column, and that this column in at
Packit 022b05
             least one conceptual row would be accessible in the MIB
Packit 022b05
             view used by the retrieval were it to exist. For those
Packit 022b05
             columns to which the agent provides read-create access,
Packit 022b05
             the `noSuchInstance' exception tells the management
Packit 022b05
             station that it should supply a value for this column
Packit 022b05
             when the conceptual row is to be created.
Packit 022b05
         
Packit 022b05
             - the exception `noSuchObject' is returned, indicating
Packit 022b05
             that the agent does not implement the object-type
Packit 022b05
             associated with this column or that there is no
Packit 022b05
             conceptual row for which this column would be
Packit 022b05
             accessible in the MIB view used by the retrieval.  As
Packit 022b05
             such, the management station can not issue any
Packit 022b05
             management protocol set operations to create an
Packit 022b05
             instance of this column.
Packit 022b05
         
Packit 022b05
         Once the column requirements have been determined, a
Packit 022b05
         management protocol set operation is accordingly issued.
Packit 022b05
         This operation also sets the new instance of the status
Packit 022b05
         column to `createAndGo'.
Packit 022b05
         
Packit 022b05
         When the agent processes the set operation, it verifies that
Packit 022b05
         it has sufficient information to make the conceptual row
Packit 022b05
         available for use by the managed device.  The information
Packit 022b05
         available to the agent is provided by two sources: the
Packit 022b05
         management protocol set operation which creates the
Packit 022b05
         conceptual row, and, implementation-specific defaults
Packit 022b05
         supplied by the agent (note that an agent must provide
Packit 022b05
         implementation-specific defaults for at least those objects
Packit 022b05
         which it implements as read-only).  If there is sufficient
Packit 022b05
         information available, then the conceptual row is created, a
Packit 022b05
         `noError' response is returned, the status column is set to
Packit 022b05
         `active', and no further interactions are necessary (i.e.,
Packit 022b05
         interactions 3 and 4 are skipped).  If there is insufficient
Packit 022b05
         information, then the conceptual row is not created, and the
Packit 022b05
         set operation fails with an error of `inconsistentValue'.
Packit 022b05
         On this error, the management station can issue a management
Packit 022b05
         protocol retrieval operation to determine if this was
Packit 022b05
         because it failed to specify a value for a required column,
Packit 022b05
         or, because the selected instance of the status column
Packit 022b05
         already existed.  In the latter case, we return to
Packit 022b05
         interaction 1.  In the former case, the management station
Packit 022b05
         
Packit 022b05
         
Packit 022b05
         can re-issue the set operation with the additional
Packit 022b05
         information, or begin interaction 2 again using
Packit 022b05
         `createAndWait' in order to negotiate creation of the
Packit 022b05
         conceptual row.
Packit 022b05
         
Packit 022b05
                                 NOTE WELL
Packit 022b05
         
Packit 022b05
             Regardless of the method used to determine the column
Packit 022b05
             requirements, it is possible that the management
Packit 022b05
             station might deem a column necessary when, in fact,
Packit 022b05
             the agent will not allow that particular columnar
Packit 022b05
             instance to be created or written.  In this case, the
Packit 022b05
             management protocol set operation will fail with an
Packit 022b05
             error such as `noCreation' or `notWritable'.  In this
Packit 022b05
             case, the management station decides whether it needs
Packit 022b05
             to be able to set a value for that particular columnar
Packit 022b05
             instance.  If not, the management station re-issues the
Packit 022b05
             management protocol set operation, but without setting
Packit 022b05
             a value for that particular columnar instance;
Packit 022b05
             otherwise, the management station aborts the row
Packit 022b05
             creation algorithm.
Packit 022b05
         
Packit 022b05
         
Packit 022b05
         Interaction 2b: Negotiating the Creation of the Conceptual
Packit 022b05
         Row
Packit 022b05
         
Packit 022b05
         The management station issues a management protocol set
Packit 022b05
         operation which sets the desired instance of the status
Packit 022b05
         column to `createAndWait'.  If the agent is unwilling to
Packit 022b05
         process a request of this sort, the set operation fails with
Packit 022b05
         an error of `wrongValue'.  (As a consequence, such an agent
Packit 022b05
         must be prepared to accept a single management protocol set
Packit 022b05
         operation, i.e., interaction 2a above, containing all of the
Packit 022b05
         columns indicated by its column requirements.) Otherwise,
Packit 022b05
         the conceptual row is created, a `noError' response is
Packit 022b05
         returned, and the status column is immediately set to either
Packit 022b05
         `notInService' or `notReady', depending on whether it has
Packit 022b05
         sufficient information to make the conceptual row available
Packit 022b05
         for use by the managed device.  If there is sufficient
Packit 022b05
         information available, then the status column is set to
Packit 022b05
         `notInService'; otherwise, if there is insufficient
Packit 022b05
         information, then the status column is set to `notReady'.
Packit 022b05
         Regardless, we proceed to interaction 3.
Packit 022b05
         
Packit 022b05
         Interaction 3: Initializing non-defaulted Objects
Packit 022b05
         
Packit 022b05
         The management station must now determine the column
Packit 022b05
         requirements.  It issues a management protocol get operation
Packit 022b05
         to examine all columns in the created conceptual row.  In
Packit 022b05
         the response, for each column, there are three possible
Packit 022b05
         outcomes:
Packit 022b05
         
Packit 022b05
             - a value is returned, indicating that the agent
Packit 022b05
             implements the object-type associated with this column
Packit 022b05
             and had sufficient information to provide a value.  For
Packit 022b05
             those columns to which the agent provides read-create
Packit 022b05
             access (and for which the agent allows their values to
Packit 022b05
             be changed after their creation), a value return tells
Packit 022b05
             the management station that it may issue additional
Packit 022b05
             management protocol set operations, if it desires, in
Packit 022b05
             order to change the value associated with this column.
Packit 022b05
         
Packit 022b05
         
Packit 022b05
             - the exception `noSuchInstance' is returned,
Packit 022b05
             indicating that the agent implements the object-type
Packit 022b05
             associated with this column, and that this column in at
Packit 022b05
             least one conceptual row would be accessible in the MIB
Packit 022b05
             view used by the retrieval were it to exist. However,
Packit 022b05
             the agent does not have sufficient information to
Packit 022b05
             provide a value, and until a value is provided, the
Packit 022b05
             conceptual row may not be made available for use by the
Packit 022b05
             managed device.  For those columns to which the agent
Packit 022b05
             provides read-create access, the `noSuchInstance'
Packit 022b05
             exception tells the management station that it must
Packit 022b05
             issue additional management protocol set operations, in
Packit 022b05
             order to provide a value associated with this column.
Packit 022b05
         
Packit 022b05
             - the exception `noSuchObject' is returned, indicating
Packit 022b05
             that the agent does not implement the object-type
Packit 022b05
             associated with this column or that there is no
Packit 022b05
             conceptual row for which this column would be
Packit 022b05
             accessible in the MIB view used by the retrieval.  As
Packit 022b05
             such, the management station can not issue any
Packit 022b05
             management protocol set operations to create an
Packit 022b05
             instance of this column.
Packit 022b05
         
Packit 022b05
         If the value associated with the status column is
Packit 022b05
         `notReady', then the management station must first deal with
Packit 022b05
         all `noSuchInstance' columns, if any.  Having done so, the
Packit 022b05
         value of the status column becomes `notInService', and we
Packit 022b05
         proceed to interaction 4.
Packit 022b05
         
Packit 022b05
         Interaction 4: Making the Conceptual Row Available
Packit 022b05
         
Packit 022b05
         Once the management station is satisfied with the values
Packit 022b05
         associated with the columns of the conceptual row, it issues
Packit 022b05
         a management protocol set operation to set the status column
Packit 022b05
         to `active'.  If the agent has sufficient information to
Packit 022b05
         make the conceptual row available for use by the managed
Packit 022b05
         device, the management protocol set operation succeeds (a
Packit 022b05
         `noError' response is returned).  Otherwise, the management
Packit 022b05
         protocol set operation fails with an error of
Packit 022b05
         `inconsistentValue'.
Packit 022b05
         
Packit 022b05
         
Packit 022b05
                                 NOTE WELL
Packit 022b05
         
Packit 022b05
             A conceptual row having a status column with value
Packit 022b05
             `notInService' or `notReady' is unavailable to the
Packit 022b05
             managed device.  As such, it is possible for the
Packit 022b05
             managed device to create its own instances during the
Packit 022b05
             time between the management protocol set operation
Packit 022b05
             which sets the status column to `createAndWait' and the
Packit 022b05
             management protocol set operation which sets the status
Packit 022b05
             column to `active'.  In this case, when the management
Packit 022b05
             protocol set operation is issued to set the status
Packit 022b05
             column to `active', the values held in the agent
Packit 022b05
             supersede those used by the managed device.
Packit 022b05
         
Packit 022b05
         If the management station is prevented from setting the
Packit 022b05
         status column to `active' (e.g., due to management station
Packit 022b05
         or network failure) the conceptual row will be left in the
Packit 022b05
         `notInService' or `notReady' state, consuming resources
Packit 022b05
         indefinitely.  The agent must detect conceptual rows that
Packit 022b05
         have been in either state for an abnormally long period of
Packit 022b05
         time and remove them.  It is the responsibility of the
Packit 022b05
         DESCRIPTION clause of the status column to indicate what an
Packit 022b05
         abnormally long period of time would be.  This period of
Packit 022b05
         time should be long enough to allow for human response time
Packit 022b05
         (including `think time') between the creation of the
Packit 022b05
         conceptual row and the setting of the status to `active'.
Packit 022b05
         In the absence of such information in the DESCRIPTION
Packit 022b05
         clause,
Packit 022b05
         it is suggested that this period be approximately 5 minutes
Packit 022b05
         in length.  This removal action applies not only to newly-
Packit 022b05
         created rows, but also to previously active rows which are
Packit 022b05
         set to, and left in, the notInService state for a prolonged
Packit 022b05
         period exceeding that which is considered normal for such a
Packit 022b05
         conceptual row.
Packit 022b05
         
Packit 022b05
         
Packit 022b05
                         Conceptual Row Suspension
Packit 022b05
         
Packit 022b05
         When a conceptual row is `active', the management station
Packit 022b05
         may issue a management protocol set operation which sets the
Packit 022b05
         instance of the status column to `notInService'.  If the
Packit 022b05
         agent is unwilling to do so, the set operation fails with an
Packit 022b05
         error of `wrongValue' or `inconsistentValue'.
Packit 022b05
         Otherwise, the conceptual row is taken out of service, and a
Packit 022b05
         `noError' response is returned.  It is the responsibility of
Packit 022b05
         the DESCRIPTION clause of the status column to indicate
Packit 022b05
         under what circumstances the status column should be taken
Packit 022b05
         out of service (e.g., in order for the value of some other
Packit 022b05
         column of the same conceptual row to be modified).
Packit 022b05
         
Packit 022b05
                          Conceptual Row Deletion
Packit 022b05
         
Packit 022b05
         For deletion of conceptual rows, a management protocol set
Packit 022b05
         operation is issued which sets the instance of the status
Packit 022b05
         column to `destroy'.  This request may be made regardless of
Packit 022b05
         the current value of the status column (e.g., it is possible
Packit 022b05
         to delete conceptual rows which are either `notReady',
Packit 022b05
         `notInService' or `active'.) If the operation succeeds, then
Packit 022b05
         all instances associated with the conceptual row are
Packit 022b05
         immediately removed.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef TimeStamp {
Packit 022b05
        type        TimeTicks;
Packit 022b05
        description 
Packit 022b05
        "The value of the sysUpTime object at which a specific
Packit 022b05
         occurrence happened.  The specific occurrence must be
Packit 022b05
         defined in the description of any object defined using this
Packit 022b05
         type.  When the specific occurrence occurred prior to the
Packit 022b05
         last time sysUpTime was zero, then the TimeStamp value is
Packit 022b05
         zero.  Note that this requires all TimeStamp values to be
Packit 022b05
         reset to zero when the value of sysUpTime reaches 497+ days
Packit 022b05
         and wraps around to zero.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef TimeInterval {
Packit 022b05
        type        Integer32 (0..2147483647);
Packit 022b05
        description 
Packit 022b05
        "A period of time, measured in units of 0.01 seconds.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef DateAndTime {
Packit 022b05
        type        OctetString (8 | 11);
Packit 022b05
	default     0x0000000000000000000000;
Packit 022b05
        format      "2d-1d-1d,1d:1d:1d.1d,1a1d:1d";
Packit 022b05
        description 
Packit 022b05
        "A date-time specification.
Packit 022b05
         
Packit 022b05
         field  octets  contents                  range
Packit 022b05
         -----  ------  --------                  -----
Packit 022b05
          1      1-2   year*                     0..65536
Packit 022b05
          2       3    month                     1..12
Packit 022b05
          3       4    day                       1..31
Packit 022b05
          4       5    hour                      0..23
Packit 022b05
          5       6    minutes                   0..59
Packit 022b05
          6       7    seconds                   0..60
Packit 022b05
                       (use 60 for leap-second)
Packit 022b05
          7       8    deci-seconds              0..9
Packit 022b05
          8       9    direction from UTC        '+' / '-'
Packit 022b05
          9      10    hours from UTC*           0..13
Packit 022b05
         10      11    minutes from UTC          0..59
Packit 022b05
         
Packit 022b05
         * Notes:
Packit 022b05
         - the value of year is in big-endian encoding
Packit 022b05
         - daylight saving time in New Zealand is +13
Packit 022b05
         
Packit 022b05
         For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be
Packit 022b05
         displayed as:
Packit 022b05
         
Packit 022b05
                         1992-5-26,13:30:15.0,-4:0
Packit 022b05
         
Packit 022b05
         Note that if only local time is known, then timezone
Packit 022b05
         information (fields 8-10) is not present.
Packit 022b05
Packit 022b05
	 The two special values of 8 or 11 zero bytes denote an
Packit 022b05
	 unknown date-time specification.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef StorageType {
Packit 022b05
        type        Enumeration (other(1), volatile(2), 
Packit 022b05
                        nonVolatile(3), permanent(4), 
Packit 022b05
                        readOnly(5));
Packit 022b05
        description 
Packit 022b05
        "Describes the memory realization of a conceptual row.  A
Packit 022b05
         row which is volatile(2) is lost upon reboot.  A row which
Packit 022b05
         is either nonVolatile(3), permanent(4) or readOnly(5), is
Packit 022b05
         backed up by stable storage.  A row which is permanent(4)
Packit 022b05
         can be changed but not deleted.  A row which is readOnly(5)
Packit 022b05
         cannot be changed nor deleted.
Packit 022b05
         
Packit 022b05
         If the value of an object with this syntax is either
Packit 022b05
         permanent(4) or readOnly(5), it cannot be modified.
Packit 022b05
         Conversely, if the value is either other(1), volatile(2) or
Packit 022b05
         nonVolatile(3), it cannot be modified to be permanent(4) or
Packit 022b05
         readOnly(5).  (All illegal modifications result in a
Packit 022b05
         'wrongValue' error.)
Packit 022b05
         
Packit 022b05
         Every usage of this textual convention is required to
Packit 022b05
         specify the columnar objects which a permanent(4) row must
Packit 022b05
         at a minimum allow to be writable.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef TDomain {
Packit 022b05
        type        ObjectIdentifier;
Packit 022b05
        description
Packit 022b05
        "Denotes a kind of transport service.
Packit 022b05
Packit 022b05
         Some possible values, such as snmpUDPDomain, are defined
Packit 022b05
         in the SNMPv2-TM MIB module.  Other possible values are
Packit 022b05
         defined in other MIB modules.";
Packit 022b05
        reference
Packit 022b05
        "The SNMPv2-TM MIB module is defined in RFC 1906.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef TAddressOrZero {
Packit 022b05
        type        OctetString (0..255);
Packit 022b05
        description
Packit 022b05
        "Denotes a transport service address.
Packit 022b05
Packit 022b05
         A TAddress value is always interpreted within the context
Packit 022b05
         of a TDomain value.  Thus, each definition of a TDomain
Packit 022b05
         value must be accompanied by a definition of a textual
Packit 022b05
         convention for use with that TDomain.  Some possible
Packit 022b05
         textual conventions, such as SnmpUDPAddress for
Packit 022b05
         snmpUDPDomain, are defined in the SNMPv2-TM MIB module.
Packit 022b05
         Other possible textual conventions are defined in
Packit 022b05
         other MIB modules.
Packit 022b05
Packit 022b05
         A zero-length TAddress value denotes an unknown transport
Packit 022b05
         service address.";
Packit 022b05
        reference
Packit 022b05
        "The SNMPv2-TM MIB module is defined in RFC 1906.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
    typedef TAddress {
Packit 022b05
        type        TAddressOrZero (1..255);
Packit 022b05
        description
Packit 022b05
        "Denotes a transport service address.
Packit 022b05
Packit 022b05
         This type does not allow a zero-length TAddress value.";
Packit 022b05
    };
Packit 022b05
Packit 022b05
};