837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterCORE-MIB DEFINITIONS ::= BEGIN
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from SMI --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- the path to the root
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster internet OBJECT IDENTIFIER ::= { iso(1) org(3) dod(6) 1 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster directory OBJECT IDENTIFIER ::= { internet 1 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster mgmt OBJECT IDENTIFIER ::= { internet 2 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster experimental OBJECT IDENTIFIER ::= { internet 3 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster private OBJECT IDENTIFIER ::= { internet 4 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster enterprises OBJECT IDENTIFIER ::= { private 1 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster security OBJECT IDENTIFIER ::= { internet 5 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpV2 OBJECT IDENTIFIER ::= { internet 6 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- transport domains
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpDomains OBJECT IDENTIFIER ::= { snmpV2 1 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- transport proxies
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpProxys OBJECT IDENTIFIER ::= { snmpV2 2 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- module identities
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpModules OBJECT IDENTIFIER ::= { snmpV2 3 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-----------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from MIB-II --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-----------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster mib-2 OBJECT IDENTIFIER ::= { mgmt 1 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from RFC 1271 --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster EntryStatus ::= INTEGER
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster createRequest(2),
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster underCreation(3),
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- The status of a table entry.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- Setting this object to the value invalid(4) has the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- effect of invalidating the corresponding entry.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- That is, it effectively disassociates the mapping
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- identified with said entry.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- It is an implementation-specific matter as to whether
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- the agent removes an invalidated entry from the table.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- Accordingly, management stations must be prepared to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- receive tabular information from agents that corresponds
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- to entries currently not in use. Proper
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- interpretation of such entries requires examination
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- of the relevant EntryStatus object.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- An existing instance of this object cannot be set to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- createRequest(2). This object may only be set to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- createRequest(2) when this instance is created. When
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- this object is created, the agent may wish to create
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- supplemental object instances to complete a conceptual
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- row in this table. Immediately after completing the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- create operation, the agent must set this object to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- underCreation(3).
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- Entries shall exist in the underCreation(3) state until
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- the management station is finished configuring the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- entry and sets this object to valid(1) or aborts,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- setting this object to invalid(4). If the agent
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- determines that an entry has been in the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- underCreation(3) state for an abnormally long time,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- it may decide that the management station has
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- crashed. If the agent makes this decision,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- it may set this object to invalid(4) to reclaim the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- entry. A prudent agent will understand that the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- management station may need to wait for human input
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- and will allow for that possibility in its
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- determination of this abnormally long period.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from RFC 1316 --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from RFC 1443 --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster------------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from RFC 1065/1442 --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster------------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Gauge32 ::= Gauge
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Counter32 ::= Counter
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Integer32 ::= INTEGER
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- application-wide types
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster NetworkAddress ::=
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IpAddress ::=
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster [APPLICATION 0] -- in network-byte order
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IMPLICIT OCTET STRING (SIZE (4))
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster [APPLICATION 1]
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IMPLICIT INTEGER (0..4294967295)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Counter64 ::=
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster [APPLICATION 1]
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IMPLICIT INTEGER (0..18446744073709551615)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster [APPLICATION 2]
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IMPLICIT INTEGER (0..4294967295)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Unsigned32 ::=
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster [APPLICATION 2]
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IMPLICIT INTEGER (0..4294967295)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster TimeTicks ::=
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster [APPLICATION 3]
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IMPLICIT INTEGER (0..4294967295)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster [APPLICATION 4] -- arbitrary ASN.1 value,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IMPLICIT OCTET STRING -- "double-wrapped"
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster---------------------------------------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from RFC 1903: Textual Conventions for SNMPv2 --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster---------------------------------------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterDisplayString ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DISPLAY-HINT "255a"
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Represents textual information taken from the NVT ASCII
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster character set, as defined in pages 4, 10-11 of RFC 854.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster To summarize RFC 854, the NVT ASCII repertoire specifies:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the use of character codes 0-127 (decimal)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the graphics characters (32-126) are interpreted as
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - NUL, LF, CR, BEL, BS, HT, VT and FF have the special
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster meanings specified in RFC 854
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the other 25 codes have no standard interpretation
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the sequence 'CR LF' means newline
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the sequence 'CR NUL' means carriage-return
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - an 'LF' not preceded by a 'CR' means moving to the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster same column on the next line.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the sequence 'CR x' for any x other than LF or NUL is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster illegal. (Note that this also means that a string may
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster end with either 'CR LF' or 'CR NUL', but not with CR.)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Any object defined using this syntax may not exceed 255
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster characters in length."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OCTET STRING (SIZE (0..255))
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterPhysAddress ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DISPLAY-HINT "1x:"
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Represents media- or physical-level addresses."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OCTET STRING
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterMacAddress ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DISPLAY-HINT "1x:"
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Represents an 802 MAC address represented in the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `canonical' order defined by IEEE 802.1a, i.e., as if it
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster were transmitted least significant bit first, even though
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 802.5 (in contrast to other 802.x protocols) requires MAC
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster addresses to be transmitted most significant bit first."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OCTET STRING (SIZE (6))
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterTruthValue ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Represents a boolean value."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX INTEGER { true(1), false(2) }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterTestAndIncr ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Represents integer-valued information used for atomic
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster operations. When the management protocol is used to specify
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster that an object instance having this syntax is to be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster modified, the new value supplied via the management protocol
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster must precisely match the value presently held by the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster instance. If not, the management protocol set operation
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster fails with an error of `inconsistentValue'. Otherwise, if
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the current value is the maximum value of 2^31-1 (2147483647
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster decimal), then the value held by the instance is wrapped to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster zero; otherwise, the value held by the instance is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster incremented by one. (Note that regardless of whether the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operation succeeds, the variable-
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster binding in the request and response PDUs are identical.)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The value of the ACCESS clause for objects having this
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster syntax is either `read-write' or `read-create'. When an
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster instance of a columnar object having this syntax is created,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster any value may be supplied via the management protocol.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster When the network management portion of the system is re-
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster initialized, the value of every object instance having this
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster syntax must either be incremented from its value prior to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the re-initialization, or (if the value prior to the re-
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster initialization is unknown) be set to a pseudo-randomly
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster generated value."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX INTEGER (0..2147483647)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterAutonomousType ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Represents an independently extensible type identification
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster value. It may, for example, indicate a particular sub-tree
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster with further MIB definitions, or define a particular type of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster protocol or hardware."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OBJECT IDENTIFIER
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterInstancePointer ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS obsolete
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "A pointer to either a specific instance of a MIB object or
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster a conceptual row of a MIB table in the managed device. In
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the latter case, by convention, it is the name of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster particular instance of the first accessible columnar object
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster in the conceptual row.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The two uses of this textual convention are replaced by
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster VariablePointer and RowPointer, respectively."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OBJECT IDENTIFIER
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterVariablePointer ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "A pointer to a specific object instance. For example,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster sysContact.0 or ifInOctets.3."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OBJECT IDENTIFIER
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterRowPointer ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Represents a pointer to a conceptual row. The value is the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster name of the instance of the first accessible columnar object
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster in the conceptual row.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, ifIndex.3 would point to the 3rd row in the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster ifTable (note that if ifIndex were not-accessible, then
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster ifDescr.3 would be used instead)."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OBJECT IDENTIFIER
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterRowStatus ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "The RowStatus textual convention is used to manage the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster creation and deletion of conceptual rows, and is used as the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster value of the SYNTAX clause for the status column of a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row (as described in Section 7.7.1 of [2].)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The status column has six defined values:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - `active', which indicates that the conceptual row is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster available for use by the managed device;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - `notInService', which indicates that the conceptual
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster row exists in the agent, but is unavailable for use by
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the managed device (see NOTE below);
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - `notReady', which indicates that the conceptual row
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster exists in the agent, but is missing information
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster necessary in order to be available for use by the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster managed device;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - `createAndGo', which is supplied by a management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster station wishing to create a new instance of a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row and to have its status automatically set
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to active, making it available for use by the managed
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - `createAndWait', which is supplied by a management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster station wishing to create a new instance of a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row (but not make it available for use by
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the managed device); and,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - `destroy', which is supplied by a management station
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster wishing to delete all of the instances associated with
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster an existing conceptual row.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Whereas five of the six values (all except `notReady') may
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster be specified in a management protocol set operation, only
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster three values will be returned in response to a management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster protocol retrieval operation: `notReady', `notInService' or
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `active'. That is, when queried, an existing conceptual row
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster has only three states: it is either available for use by
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the managed device (the status column has value `active');
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster it is not available for use by the managed device, though
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the agent has sufficient information to make it so (the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster status column has value `notInService'); or, it is not
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster available for use by the managed device, and an attempt to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster make it so would fail because the agent has insufficient
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information (the state column has value `notReady').
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster This textual convention may be used for a MIB table,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster irrespective of whether the values of that table's
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual rows are able to be modified while it is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster active, or whether its conceptual rows must be taken
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster out of service in order to be modified. That is, it is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the responsibility of the DESCRIPTION clause of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster status column to specify whether the status column must
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster not be `active' in order for the value of some other
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster column of the same conceptual row to be modified. If
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster such a specification is made, affected columns may be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster changed by an SNMP set PDU if the RowStatus would not
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster be equal to `active' either immediately before or after
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster processing the PDU. In other words, if the PDU also
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster contained a varbind that would change the RowStatus
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster value, the column in question may be changed if the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster RowStatus was not equal to `active' as the PDU was
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster received, or if the varbind sets the status to a value
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster other than 'active'.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Also note that whenever any elements of a row exist, the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster RowStatus column must also exist.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster To summarize the effect of having a conceptual row with a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster status column having a SYNTAX clause value of RowStatus,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster consider the following state diagram:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster +--------------+-----------+-------------+-------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster | A | B | C | D
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster | |status col.|status column|
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster |status column | is | is |status column
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster ACTION |does not exist| notReady | notInService| is active
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------+--------------+-----------+-------------+-------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fosterset status |noError ->D|inconsist- |inconsistent-|inconsistent-
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fostercolumn to | or | entValue| Value| Value
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FostercreateAndGo |inconsistent- | | |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster | Value| | |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------+--------------+-----------+-------------+-------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fosterset status |noError see 1|inconsist- |inconsistent-|inconsistent-
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fostercolumn to | or | entValue| Value| Value
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FostercreateAndWait |wrongValue | | |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------+--------------+-----------+-------------+-------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fosterset status |inconsistent- |inconsist- |noError |noError
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fostercolumn to | Value| entValue| |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fosteractive | | | |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster | |see 2 ->D| ->D| ->D
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------+--------------+-----------+-------------+-------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fosterset status |inconsistent- |inconsist- |noError |noError ->C
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fostercolumn to | Value| entValue| |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosternotInService | | | |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster | | or | | or
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster | |see 3 ->C| ->C|wrongValue
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------+--------------+-----------+-------------+-------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fosterset status |noError |noError |noError |noError
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fostercolumn to | | | |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fosterdestroy | ->A| ->A| ->A| ->A
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------+--------------+-----------+-------------+-------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fosterset any other |see 4 |noError |noError |see 5
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fostercolumn to some| | | |
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Fostervalue | | see 1| ->C| ->D
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster--------------+--------------+-----------+-------------+-------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (1) goto B or C, depending on information available to the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterSNMPv2 Working Group Standards Track [Page 9]
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterRFC 1903 Textual Conventions for SNMPv2 January 1996
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (2) if other variable bindings included in the same PDU,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster provide values for all columns which are missing but
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster required, then return noError and goto D.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (3) if other variable bindings included in the same PDU,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster provide values for all columns which are missing but
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster required, then return noError and goto C.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (4) at the discretion of the agent, the return value may be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster inconsistentName: because the agent does not choose to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster create such an instance when the corresponding
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster RowStatus instance does not exist, or
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster inconsistentValue: if the supplied value is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster inconsistent with the state of some other MIB object's
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster noError: because the agent chooses to create the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster If noError is returned, then the instance of the status
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster column must also be created, and the new state is B or C,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster depending on the information available to the agent. If
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster inconsistentName or inconsistentValue is returned, the row
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster remains in state A.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (5) depending on the MIB definition for the column/table,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster either noError or inconsistentValue may be returned.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster NOTE: Other processing of the set request may result in a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster response other than noError being returned, e.g.,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster wrongValue, noCreation, etc.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Conceptual Row Creation
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster There are four potential interactions when creating a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row: selecting an instance-identifier which is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster not in use; creating the conceptual row; initializing any
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster objects for which the agent does not supply a default; and,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster making the conceptual row available for use by the managed
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Interaction 1: Selecting an Instance-Identifier
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The algorithm used to select an instance-identifier varies
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster for each conceptual row. In some cases, the instance-
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster identifier is semantically significant, e.g., the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster destination address of a route, and a management station
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster selects the instance-identifier according to the semantics.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster In other cases, the instance-identifier is used solely to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster distinguish conceptual rows, and a management station
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster without specific knowledge of the conceptual row might
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster examine the instances present in order to determine an
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster unused instance-identifier. (This approach may be used, but
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster it is often highly sub-optimal; however, it is also a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster questionable practice for a naive management station to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster attempt conceptual row creation.)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Alternately, the MIB module which defines the conceptual row
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster might provide one or more objects which provide assistance
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster in determining an unused instance-identifier. For example,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster if the conceptual row is indexed by an integer-value, then
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster an object having an integer-valued SYNTAX clause might be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster defined for such a purpose, allowing a management station to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster issue a management protocol retrieval operation. In order
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to avoid unnecessary collisions between competing management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster stations, `adjacent' retrievals of this object should be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Finally, the management station could select a pseudo-random
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster number to use as the index. In the event that this index
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster was already in use and an inconsistentValue was returned in
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster response to the management protocol set operation, the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management station should simply select a new pseudo-random
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster number and retry the operation.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster A MIB designer should choose between the two latter
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster algorithms based on the size of the table (and therefore the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster efficiency of each algorithm). For tables in which a large
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster number of entries are expected, it is recommended that a MIB
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster object be defined that returns an acceptable index for
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster creation. For tables with small numbers of entries, it is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster recommended that the latter pseudo-random index mechanism be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Interaction 2: Creating the Conceptual Row
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Once an unused instance-identifier has been selected, the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management station determines if it wishes to create and
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster activate the conceptual row in one transaction or in a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster negotiated set of interactions.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Interaction 2a: Creating and Activating the Conceptual Row
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The management station must first determine the column
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster requirements, i.e., it must determine those columns for
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster which it must or must not provide values. Depending on the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster complexity of the table and the management station's
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster knowledge of the agent's capabilities, this determination
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster can be made locally by the management station. Alternately,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the management station issues a management protocol get
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster operation to examine all columns in the conceptual row that
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster it wishes to create. In response, for each column, there
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster are three possible outcomes:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - a value is returned, indicating that some other
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management station has already created this conceptual
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster row. We return to interaction 1.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the exception `noSuchInstance' is returned,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster indicating that the agent implements the object-type
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster associated with this column, and that this column in at
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster least one conceptual row would be accessible in the MIB
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster view used by the retrieval were it to exist. For those
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster columns to which the agent provides read-create access,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the `noSuchInstance' exception tells the management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster station that it should supply a value for this column
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster when the conceptual row is to be created.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the exception `noSuchObject' is returned, indicating
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster that the agent does not implement the object-type
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster associated with this column or that there is no
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row for which this column would be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster accessible in the MIB view used by the retrieval. As
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster such, the management station can not issue any
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operations to create an
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster instance of this column.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Once the column requirements have been determined, a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operation is accordingly issued.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster This operation also sets the new instance of the status
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster column to `createAndGo'.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster When the agent processes the set operation, it verifies that
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster it has sufficient information to make the conceptual row
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster available for use by the managed device. The information
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster available to the agent is provided by two sources: the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operation which creates the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row, and, implementation-specific defaults
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster supplied by the agent (note that an agent must provide
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster implementation-specific defaults for at least those objects
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster which it implements as read-only). If there is sufficient
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information available, then the conceptual row is created, a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `noError' response is returned, the status column is set to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `active', and no further interactions are necessary (i.e.,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster interactions 3 and 4 are skipped). If there is insufficient
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information, then the conceptual row is not created, and the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster set operation fails with an error of `inconsistentValue'.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster On this error, the management station can issue a management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster protocol retrieval operation to determine if this was
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster because it failed to specify a value for a required column,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster or, because the selected instance of the status column
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster already existed. In the latter case, we return to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster interaction 1. In the former case, the management station
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster can re-issue the set operation with the additional
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information, or begin interaction 2 again using
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `createAndWait' in order to negotiate creation of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Regardless of the method used to determine the column
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster requirements, it is possible that the management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster station might deem a column necessary when, in fact,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the agent will not allow that particular columnar
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster instance to be created or written. In this case, the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operation will fail with an
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster error such as `noCreation' or `notWritable'. In this
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster case, the management station decides whether it needs
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to be able to set a value for that particular columnar
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster instance. If not, the management station re-issues the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operation, but without setting
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster a value for that particular columnar instance;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster otherwise, the management station aborts the row
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster creation algorithm.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Interaction 2b: Negotiating the Creation of the Conceptual
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The management station issues a management protocol set
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster operation which sets the desired instance of the status
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster column to `createAndWait'. If the agent is unwilling to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster process a request of this sort, the set operation fails with
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster an error of `wrongValue'. (As a consequence, such an agent
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster must be prepared to accept a single management protocol set
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster operation, i.e., interaction 2a above, containing all of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster columns indicated by its column requirements.) Otherwise,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the conceptual row is created, a `noError' response is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster returned, and the status column is immediately set to either
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `notInService' or `notReady', depending on whether it has
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster sufficient information to make the conceptual row available
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster for use by the managed device. If there is sufficient
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information available, then the status column is set to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `notInService'; otherwise, if there is insufficient
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information, then the status column is set to `notReady'.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Regardless, we proceed to interaction 3.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Interaction 3: Initializing non-defaulted Objects
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The management station must now determine the column
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster requirements. It issues a management protocol get operation
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to examine all columns in the created conceptual row. In
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the response, for each column, there are three possible
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - a value is returned, indicating that the agent
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster implements the object-type associated with this column
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster and had sufficient information to provide a value. For
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster those columns to which the agent provides read-create
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster access (and for which the agent allows their values to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster be changed after their creation), a value return tells
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the management station that it may issue additional
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operations, if it desires, in
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster order to change the value associated with this column.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the exception `noSuchInstance' is returned,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster indicating that the agent implements the object-type
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster associated with this column, and that this column in at
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster least one conceptual row would be accessible in the MIB
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster view used by the retrieval were it to exist. However,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the agent does not have sufficient information to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster provide a value, and until a value is provided, the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row may not be made available for use by the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster managed device. For those columns to which the agent
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster provides read-create access, the `noSuchInstance'
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster exception tells the management station that it must
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster issue additional management protocol set operations, in
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster order to provide a value associated with this column.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the exception `noSuchObject' is returned, indicating
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster that the agent does not implement the object-type
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster associated with this column or that there is no
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row for which this column would be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster accessible in the MIB view used by the retrieval. As
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster such, the management station can not issue any
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operations to create an
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster instance of this column.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster If the value associated with the status column is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `notReady', then the management station must first deal with
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster all `noSuchInstance' columns, if any. Having done so, the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster value of the status column becomes `notInService', and we
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster proceed to interaction 4.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Interaction 4: Making the Conceptual Row Available
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Once the management station is satisfied with the values
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster associated with the columns of the conceptual row, it issues
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster a management protocol set operation to set the status column
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to `active'. If the agent has sufficient information to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster make the conceptual row available for use by the managed
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster device, the management protocol set operation succeeds (a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `noError' response is returned). Otherwise, the management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster protocol set operation fails with an error of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `inconsistentValue'.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster A conceptual row having a status column with value
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `notInService' or `notReady' is unavailable to the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster managed device. As such, it is possible for the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster managed device to create its own instances during the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster time between the management protocol set operation
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster which sets the status column to `createAndWait' and the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster management protocol set operation which sets the status
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster column to `active'. In this case, when the management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster protocol set operation is issued to set the status
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster column to `active', the values held in the agent
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster supersede those used by the managed device.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster If the management station is prevented from setting the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster status column to `active' (e.g., due to management station
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster or network failure) the conceptual row will be left in the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `notInService' or `notReady' state, consuming resources
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster indefinitely. The agent must detect conceptual rows that
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster have been in either state for an abnormally long period of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster time and remove them. It is the responsibility of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DESCRIPTION clause of the status column to indicate what an
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster abnormally long period of time would be. This period of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster time should be long enough to allow for human response time
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (including `think time') between the creation of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster conceptual row and the setting of the status to `active'.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster In the absense of such information in the DESCRIPTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster clause, it is suggested that this period be approximately 5
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster minutes in length. This removal action applies not only to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster newly-created rows, but also to previously active rows which
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster are set to, and left in, the notInService state for a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster prolonged period exceeding that which is considered normal
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster for such a conceptual row.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Conceptual Row Suspension
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster When a conceptual row is `active', the management station
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster may issue a management protocol set operation which sets the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster instance of the status column to `notInService'. If the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster agent is unwilling to do so, the set operation fails with an
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster error of `wrongValue'. Otherwise, the conceptual row is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster taken out of service, and a `noError' response is returned.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster It is the responsibility of the DESCRIPTION clause of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster status column to indicate under what circumstances the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster status column should be taken out of service (e.g., in order
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster for the value of some other column of the same conceptual
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster row to be modified).
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Conceptual Row Deletion
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For deletion of conceptual rows, a management protocol set
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster operation is issued which sets the instance of the status
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster column to `destroy'. This request may be made regardless of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the current value of the status column (e.g., it is possible
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to delete conceptual rows which are either `notReady',
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster `notInService' or `active'.) If the operation succeeds,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster then all instances associated with the conceptual row are
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster immediately removed."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX INTEGER {
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- the following two values are states:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- these values may be read or written
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster notInService(2),
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- the following value is a state:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- this value may be read, but not written
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster notReady(3),
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- the following three values are
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- actions: these values may be written,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster -- but are never read
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster createAndGo(4),
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster createAndWait(5),
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterTimeStamp ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "The value of the sysUpTime object at which a specific
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster occurrence happened. The specific occurrence must be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster defined in the description of any object defined using this
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX TimeTicks
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterTimeInterval ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "A period of time, measured in units of 0.01 seconds."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX INTEGER (0..2147483647)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterDateAndTime ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DISPLAY-HINT "2d-1d-1d,1d:1d:1d.1d,1a1d:1d"
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "A date-time specification.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster field octets contents range
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster ----- ------ -------- -----
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 1 1-2 year 0..65536
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 2 3 month 1..12
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 3 4 day 1..31
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 4 5 hour 0..23
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 5 6 minutes 0..59
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 6 7 seconds 0..60
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (use 60 for leap-second)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 7 8 deci-seconds 0..9
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 8 9 direction from UTC '+' / '-'
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 9 10 hours from UTC 0..11
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 10 11 minutes from UTC 0..59
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster displayed as:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 1992-5-26,13:30:15.0,-4:0
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Note that if only local time is known, then timezone
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information (fields 8-10) is not present."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OCTET STRING (SIZE (8 | 11))
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterStorageType ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Describes the memory realization of a conceptual row. A
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster row which is volatile(2) is lost upon reboot. A row which
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster is either nonVolatile(3), permanent(4) or readOnly(5), is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster backed up by stable storage. A row which is permanent(4)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster can be changed but not deleted. A row which is readOnly(5)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster cannot be changed nor deleted.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster If the value of an object with this syntax is either
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster permanent(4) or readOnly(5), it cannot be modified.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Conversely, if the value is either other(1), volatile(2) or
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster nonVolatile(3), it cannot be modified to be permanent(4) or
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster readOnly(5).
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Every usage of this textual convention is required to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster specify the columnar objects which a permanent(4) row must
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster at a minimum allow to be writable."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX INTEGER {
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster other(1), -- eh?
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster volatile(2), -- e.g., in RAM
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster nonVolatile(3), -- e.g., in NVRAM
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster permanent(4), -- e.g., partially in ROM
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster readOnly(5) -- e.g., completely in ROM
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterTDomain ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Denotes a kind of transport service.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Some possible values, such as snmpUDPDomain, are defined in
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 'Transport Mappings for Version 2 of the Simple Network
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Management Protocol (SNMPv2)'."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OBJECT IDENTIFIER
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterTAddress ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Denotes a transport service address.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For snmpUDPDomain, a TAddress is 6 octets long, the initial 4
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster octets containing the IP-address in network-byte order and the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster last 2 containing the UDP port in network-byte order. Consult
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 'Transport Mappings for Version 2 of the Simple Network
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Management Protocol (SNMPv2)' for further information on
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpUDPDomain."
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OCTET STRING (SIZE (1..255))
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster---------------------------------------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from RFC 2571: Textual Conventions for SNMPv3 --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster---------------------------------------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SnmpEngineID ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DESCRIPTION "An SNMP engine's administratively-unique identifier.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Objects of this type are for identification, not for
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster addressing, even though it is possible that an
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster address may have been used in the generation of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster a specific value.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The value for this object may not be all zeros or
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster all 'ff'H or the empty (zero length) string.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The initial value for this object may be configured
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster via an operator console entry or via an algorithmic
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster function. In the latter case, the following
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster example algorithm is recommended.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster In cases where there are multiple engines on the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster same system, the use of this algorithm is NOT
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster appropriate, as it would result in all of those
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster engines ending up with the same ID value.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 1) The very first bit is used to indicate how the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster rest of the data is composed.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 0 - as defined by enterprise using former methods
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster that existed before SNMPv3. See item 2 below.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 1 - as defined by this architecture, see item 3
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Note that this allows existing uses of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster engineID (also known as AgentID [RFC1910]) to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster co-exist with any new uses.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 2) The snmpEngineID has a length of 12 octets.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The first four octets are set to the binary
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster equivalent of the agent's SNMP management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster private enterprise number as assigned by the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Internet Assigned Numbers Authority (IANA).
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, if Acme Networks has been assigned
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster { enterprises 696 }, the first four octets would
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster be assigned '000002b8'H.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The remaining eight octets are determined via
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster one or more enterprise-specific methods. Such
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster methods must be designed so as to maximize the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster possibility that the value of this object will
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster be unique in the agent's administrative domain.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, it may be the IP address of the SNMP
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster entity, or the MAC address of one of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster interfaces, with each address suitably padded
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster with random octets. If multiple methods are
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster defined, then it is recommended that the first
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster octet indicate the method being used and the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster remaining octets be a function of the method.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 3) The length of the octet strings varies.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The first four octets are set to the binary
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster equivalent of the agent's SNMP management
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster private enterprise number as assigned by the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Internet Assigned Numbers Authority (IANA).
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, if Acme Networks has been assigned
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster { enterprises 696 }, the first four octets would
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster be assigned '000002b8'H.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The very first bit is set to 1. For example, the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster above value for Acme Networks now changes to be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster '800002b8'H.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The fifth octet indicates how the rest (6th and
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster following octets) are formatted. The values for
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the fifth octet are:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 0 - reserved, unused.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 1 - IPv4 address (4 octets)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster lowest non-special IP address
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 2 - IPv6 address (16 octets)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster lowest non-special IP address
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 3 - MAC address (6 octets)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster lowest IEEE MAC address, canonical
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 4 - Text, administratively assigned
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Maximum remaining length 27
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 5 - Octets, administratively assigned
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Maximum remaining length 27
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 6-127 - reserved, unused
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 127-255 - as defined by the enterprise
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Maximum remaining length 27
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OCTET STRING (SIZE(5..32))
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SnmpSecurityModel ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DESCRIPTION "An identifier that uniquely identifies a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster securityModel of the Security Subsystem within the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SNMP Management Architecture.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The values for securityModel are allocated as
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - The zero value is reserved.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - Values between 1 and 255, inclusive, are reserved
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster for standards-track Security Models and are
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster managed by the Internet Assigned Numbers Authority
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - Values greater than 255 are allocated to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster enterprise-specific Security Models. An
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster enterprise-specific securityModel value is defined
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster enterpriseID * 256 + security model within
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, the fourth Security Model defined by
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the enterprise whose enterpriseID is 1 would be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster This scheme for allocation of securityModel
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster values allows for a maximum of 255 standards-
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster based Security Models, and for a maximum of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 255 Security Models per enterprise.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster It is believed that the assignment of new
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster securityModel values will be rare in practice
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster because the larger the number of simultaneously
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster utilized Security Models, the larger the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster chance that interoperability will suffer.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Consequently, it is believed that such a range
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster will be sufficient. In the unlikely event that
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the standards committee finds this number to be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster insufficient over time, an enterprise number
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster can be allocated to obtain an additional 255
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster possible values.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Note that the most significant bit must be zero;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster hence, there are 23 bits allocated for various
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster organizations to design and define non-standard
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster securityModels. This limits the ability to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster define new proprietary implementations of Security
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Models to the first 8,388,608 enterprises.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster It is worthwhile to note that, in its encoded
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster form, the securityModel value will normally
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster require only a single byte since, in practice,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the leftmost bits will be zero for most messages
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster and sign extension is suppressed by the encoding
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster As of this writing, there are several values
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster of securityModel defined for use with SNMP or
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster reserved for use with supporting MIB objects.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster They are as follows:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 0 reserved for 'any'
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 1 reserved for SNMPv1
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 2 reserved for SNMPv2c
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 3 User-Based Security Model (USM)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX INTEGER(0 .. 2147483647)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SnmpMessageProcessingModel ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DESCRIPTION "An identifier that uniquely identifies a Message
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Processing Model of the Message Processing
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Subsystem within a SNMP Management Architecture.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The values for messageProcessingModel are
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster allocated as follows:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - Values between 0 and 255, inclusive, are
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster reserved for standards-track Message Processing
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Models and are managed by the Internet Assigned
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Numbers Authority (IANA).
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - Values greater than 255 are allocated to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster enterprise-specific Message Processing Models.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster An enterprise messageProcessingModel value is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster defined to be:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster enterpriseID * 256 +
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster messageProcessingModel within enterprise
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, the fourth Message Processing Model
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster defined by the enterprise whose enterpriseID
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster is 1 would be 260.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster This scheme for allocating messageProcessingModel
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster values allows for a maximum of 255 standards-
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster based Message Processing Models, and for a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster maximum of 255 Message Processing Models per
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster It is believed that the assignment of new
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster messageProcessingModel values will be rare
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster in practice because the larger the number of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster simultaneously utilized Message Processing Models,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the larger the chance that interoperability
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster will suffer. It is believed that such a range
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster will be sufficient. In the unlikely event that
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the standards committee finds this number to be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster insufficient over time, an enterprise number
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster can be allocated to obtain an additional 256
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster possible values.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Note that the most significant bit must be zero;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster hence, there are 23 bits allocated for various
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster organizations to design and define non-standard
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster messageProcessingModels. This limits the ability
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to define new proprietary implementations of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Message Processing Models to the first 8,388,608
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster enterprises.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster It is worthwhile to note that, in its encoded
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster form, the messageProcessingModel value will
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster normally require only a single byte since, in
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster practice, the leftmost bits will be zero for
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster most messages and sign extension is suppressed
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster by the encoding rules.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster As of this writing, there are several values of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster messageProcessingModel defined for use with SNMP.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster They are as follows:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 0 reserved for SNMPv1
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 1 reserved for SNMPv2c
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 2 reserved for SNMPv2u and SNMPv2*
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 3 reserved for SNMPv3
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX INTEGER(0 .. 2147483647)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SnmpSecurityLevel ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DESCRIPTION "A Level of Security at which SNMP messages can be
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster sent or with which operations are being processed;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster in particular, one of:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster noAuthNoPriv - without authentication and
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster without privacy,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster authNoPriv - with authentication but
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster without privacy,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster authPriv - with authentication and
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster with privacy.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster These three values are ordered such that
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster noAuthNoPriv is less than authNoPriv and
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster authNoPriv is less than authPriv.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX INTEGER { noAuthNoPriv(1),
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster authNoPriv(2),
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SnmpAdminString ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DISPLAY-HINT "255a"
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster DESCRIPTION "An octet string containing administrative
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information, preferably in human-readable form.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster To facilitate internationalization, this
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster information is represented using the ISO/IEC
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster IS 10646-1 character set, encoded as an octet
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster string using the UTF-8 transformation format
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster described in [RFC2279].
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Since additional code points are added by
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster amendments to the 10646 standard from time
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to time, implementations must be prepared to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster encounter any code point from 0x00000000 to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 0x7fffffff. Byte sequences that do not
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster correspond to the valid UTF-8 encoding of a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster code point or are outside this range are
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The use of control codes should be avoided.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster When it is necessary to represent a newline,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the control code sequence CR LF should be used.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The use of leading or trailing white space should
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For code points not directly supported by user
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster interface hardware or software, an alternative
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster means of entry and display, such as hexadecimal,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster may be provided.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For information encoded in 7-bit US-ASCII,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the UTF-8 encoding is identical to the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster US-ASCII encoding.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster UTF-8 may require multiple bytes to represent a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster single character / code point; thus the length
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster of this object in octets may be different from
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the number of characters encoded. Similarly,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster size constraints refer to the number of encoded
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster octets, not the number of characters represented
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster by an encoding.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Note that when this TC is used for an object that
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster is used or envisioned to be used as an index, then
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster a SIZE restriction MUST be specified so that the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster number of sub-identifiers for any object instance
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster does not exceed the limit of 128, as defined by
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Note that the size of an SnmpAdminString object is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster measured in octets, not characters.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX DisplayString (SIZE (0..255))
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster---------------------------------------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- from RFC 2574: Textual Conventions for SNMPv3 --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster---------------------------------------------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan FosterKeyChange ::= TEXTUAL-CONVENTION
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster STATUS current
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster "Every definition of an object with this syntax must identify
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster a protocol P, a secret key K, and a hash algorithm H
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster that produces output of L octets.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The object's value is a manager-generated, partially-random
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster value which, when modified, causes the value of the secret
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster key K, to be modified via a one-way function.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The value of an instance of this object is the concatenation
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster of two components: first a 'random' component and then a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 'delta' component.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The lengths of the random and delta components
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster are given by the corresponding value of the protocol P;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster if P requires K to be a fixed length, the length of both the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster random and delta components is that fixed length; if P
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster allows the length of K to be variable up to a particular
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster maximum length, the length of the random component is that
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster maximum length and the length of the delta component is any
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster length less than or equal to that maximum length.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, usmHMACMD5AuthProtocol requires K to be a fixed
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster length of 16 octets and L - of 16 octets.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster usmHMACSHAAuthProtocol requires K to be a fixed length of
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster 20 octets and L - of 20 octets. Other protocols may define
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster other sizes, as deemed appropriate.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster When a requester wants to change the old key K to a new
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster key keyNew on a remote entity, the 'random' component is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster obtained from either a true random generator, or from a
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster pseudorandom generator, and the 'delta' component is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster computed as follows:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - a temporary variable is initialized to the existing value
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - if the length of the keyNew is greater than L octets,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the random component is appended to the value of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temporary variable, and the result is input to the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the hash algorithm H to produce a digest value, and
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the temporary variable is set to this digest value;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the value of the temporary variable is XOR-ed with
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the first (next) L-octets (16 octets in case of MD5)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster of the keyNew to produce the first (next) L-octets
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (16 octets in case of MD5) of the 'delta' component.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the above two steps are repeated until the unused
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster portion of the keyNew component is L octets or less,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the random component is appended to the value of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temporary variable, and the result is input to the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster hash algorithm H to produce a digest value;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - this digest value, truncated if necessary to be the same
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster length as the unused portion of the keyNew, is XOR-ed
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster with the unused portion of the keyNew to produce the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster (final portion of the) 'delta' component.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, using MD5 as the hash algorithm H:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster iterations = (lenOfDelta - 1)/16; /* integer division */
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp = keyOld;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster for (i = 0; i < iterations; i++) {
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp = MD5 (temp || random);
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster delta[i*16 .. (i*16)+15] =
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp XOR keyNew[i*16 .. (i*16)+15];
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp = MD5 (temp || random);
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster delta[i*16 .. lenOfDelta-1] =
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp XOR keyNew[i*16 .. lenOfDelta-1];
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The 'random' and 'delta' components are then concatenated as
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster described above, and the resulting octet string is sent to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the recipient as the new value of an instance of this object.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster At the receiver side, when an instance of this object is set
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster to a new value, then a new value of K is computed as follows:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - a temporary variable is initialized to the existing value
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - if the length of the delta component is greater than L
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster octets, then:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the random component is appended to the value of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temporary variable, and the result is input to the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster hash algorithm H to produce a digest value, and the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temporary variable is set to this digest value;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the value of the temporary variable is XOR-ed with
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster the first (next) L-octets (16 octets in case of MD5)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster of the delta component to produce the first (next)
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster L-octets (16 octets in case of MD5) of the new value
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the above two steps are repeated until the unused
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster portion of the delta component is L octets or less,
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - the random component is appended to the value of the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temporary variable, and the result is input to the
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster hash algorithm H to produce a digest value;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster - this digest value, truncated if necessary to be the same
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster length as the unused portion of the delta component, is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster XOR-ed with the unused portion of the delta component to
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster produce the (final portion of the) new value of K.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster For example, using MD5 as the hash algorithm H:
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster iterations = (lenOfDelta - 1)/16; /* integer division */
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp = keyOld;
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster for (i = 0; i < iterations; i++) {
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp = MD5 (temp || random);
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster keyNew[i*16 .. (i*16)+15] =
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp XOR delta[i*16 .. (i*16)+15];
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp = MD5 (temp || random);
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster keyNew[i*16 .. lenOfDelta-1] =
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster temp XOR delta[i*16 .. lenOfDelta-1];
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster The value of an object with this syntax, whenever it is
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster retrieved by the management protocol, is always the zero
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster length string.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Note that the keyOld and keyNew are the localized keys.
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster Note that it is probably wise that when an SNMP entity sends
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster a SetRequest to change a key, that it keeps a copy of the old
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster key until it has confirmed that the key change actually
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster SYNTAX OCTET STRING
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-----------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-- entreprises --
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster-----------------
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster sun OBJECT IDENTIFIER ::= { enterprises 42 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster messaging OBJECT IDENTIFIER ::= { sun products(2) 8 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster agents OBJECT IDENTIFIER ::= { messaging 1 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster private-mibs OBJECT IDENTIFIER ::= { messaging 2 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpx400d OBJECT IDENTIFIER ::= { agents 1 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpxapiad OBJECT IDENTIFIER ::= { agents 2 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpx500d OBJECT IDENTIFIER ::= { agents 3 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpimd OBJECT IDENTIFIER ::= { agents 4 }
837871e12425577ebe5d6f129d18ea78dd0e640eAllan Foster snmpslapd OBJECT IDENTIFIER ::= { agents 5 }