| 1 |
-- extracted from rfc2579.txt |
| 2 |
|
| 3 |
SNMPv2-TC DEFINITIONS ::= BEGIN |
| 4 |
|
| 5 |
IMPORTS |
| 6 |
TimeTicks FROM SNMPv2-SMI; |
| 7 |
|
| 8 |
|
| 9 |
-- definition of textual conventions |
| 10 |
|
| 11 |
TEXTUAL-CONVENTION MACRO ::= |
| 12 |
BEGIN |
| 13 |
TYPE NOTATION ::= |
| 14 |
DisplayPart |
| 15 |
"STATUS" Status |
| 16 |
"DESCRIPTION" Text |
| 17 |
ReferPart |
| 18 |
"SYNTAX" Syntax |
| 19 |
|
| 20 |
VALUE NOTATION ::= |
| 21 |
value(VALUE Syntax) -- adapted ASN.1 |
| 22 |
|
| 23 |
DisplayPart ::= |
| 24 |
"DISPLAY-HINT" Text |
| 25 |
| empty |
| 26 |
|
| 27 |
Status ::= |
| 28 |
"current" |
| 29 |
| "deprecated" |
| 30 |
| "obsolete" |
| 31 |
|
| 32 |
ReferPart ::= |
| 33 |
"REFERENCE" Text |
| 34 |
| empty |
| 35 |
|
| 36 |
-- a character string as defined in [2] |
| 37 |
Text ::= value(IA5String) |
| 38 |
|
| 39 |
Syntax ::= -- Must be one of the following: |
| 40 |
-- a base type (or its refinement), or |
| 41 |
-- a BITS pseudo-type |
| 42 |
type |
| 43 |
| "BITS" "{" NamedBits "}" |
| 44 |
|
| 45 |
NamedBits ::= NamedBit |
| 46 |
| NamedBits "," NamedBit |
| 47 |
|
| 48 |
NamedBit ::= identifier "(" number ")" -- number is nonnegative |
| 49 |
|
| 50 |
END |
| 51 |
|
| 52 |
|
| 53 |
|
| 54 |
|
| 55 |
DisplayString ::= TEXTUAL-CONVENTION |
| 56 |
DISPLAY-HINT "255a" |
| 57 |
STATUS current |
| 58 |
DESCRIPTION |
| 59 |
"Represents textual information taken from the NVT ASCII |
| 60 |
character set, as defined in pages 4, 10-11 of RFC 854. |
| 61 |
|
| 62 |
To summarize RFC 854, the NVT ASCII repertoire specifies: |
| 63 |
|
| 64 |
- the use of character codes 0-127 (decimal) |
| 65 |
|
| 66 |
- the graphics characters (32-126) are interpreted as |
| 67 |
US ASCII |
| 68 |
|
| 69 |
- NUL, LF, CR, BEL, BS, HT, VT and FF have the special |
| 70 |
meanings specified in RFC 854 |
| 71 |
|
| 72 |
- the other 25 codes have no standard interpretation |
| 73 |
|
| 74 |
- the sequence 'CR LF' means newline |
| 75 |
|
| 76 |
- the sequence 'CR NUL' means carriage-return |
| 77 |
|
| 78 |
- an 'LF' not preceded by a 'CR' means moving to the |
| 79 |
same column on the next line. |
| 80 |
|
| 81 |
- the sequence 'CR x' for any x other than LF or NUL is |
| 82 |
illegal. (Note that this also means that a string may |
| 83 |
end with either 'CR LF' or 'CR NUL', but not with CR.) |
| 84 |
|
| 85 |
Any object defined using this syntax may not exceed 255 |
| 86 |
characters in length." |
| 87 |
SYNTAX OCTET STRING (SIZE (0..255)) |
| 88 |
|
| 89 |
PhysAddress ::= TEXTUAL-CONVENTION |
| 90 |
DISPLAY-HINT "1x:" |
| 91 |
STATUS current |
| 92 |
DESCRIPTION |
| 93 |
"Represents media- or physical-level addresses." |
| 94 |
SYNTAX OCTET STRING |
| 95 |
|
| 96 |
|
| 97 |
MacAddress ::= TEXTUAL-CONVENTION |
| 98 |
DISPLAY-HINT "1x:" |
| 99 |
STATUS current |
| 100 |
DESCRIPTION |
| 101 |
"Represents an 802 MAC address represented in the |
| 102 |
`canonical' order defined by IEEE 802.1a, i.e., as if it |
| 103 |
were transmitted least significant bit first, even though |
| 104 |
802.5 (in contrast to other 802.x protocols) requires MAC |
| 105 |
addresses to be transmitted most significant bit first." |
| 106 |
SYNTAX OCTET STRING (SIZE (6)) |
| 107 |
|
| 108 |
TruthValue ::= TEXTUAL-CONVENTION |
| 109 |
STATUS current |
| 110 |
DESCRIPTION |
| 111 |
"Represents a boolean value." |
| 112 |
SYNTAX INTEGER { true(1), false(2) } |
| 113 |
|
| 114 |
TestAndIncr ::= TEXTUAL-CONVENTION |
| 115 |
STATUS current |
| 116 |
DESCRIPTION |
| 117 |
"Represents integer-valued information used for atomic |
| 118 |
operations. When the management protocol is used to specify |
| 119 |
that an object instance having this syntax is to be |
| 120 |
modified, the new value supplied via the management protocol |
| 121 |
must precisely match the value presently held by the |
| 122 |
instance. If not, the management protocol set operation |
| 123 |
fails with an error of `inconsistentValue'. Otherwise, if |
| 124 |
the current value is the maximum value of 2^31-1 (2147483647 |
| 125 |
decimal), then the value held by the instance is wrapped to |
| 126 |
zero; otherwise, the value held by the instance is |
| 127 |
incremented by one. (Note that regardless of whether the |
| 128 |
management protocol set operation succeeds, the variable- |
| 129 |
binding in the request and response PDUs are identical.) |
| 130 |
|
| 131 |
The value of the ACCESS clause for objects having this |
| 132 |
syntax is either `read-write' or `read-create'. When an |
| 133 |
instance of a columnar object having this syntax is created, |
| 134 |
any value may be supplied via the management protocol. |
| 135 |
|
| 136 |
When the network management portion of the system is re- |
| 137 |
initialized, the value of every object instance having this |
| 138 |
syntax must either be incremented from its value prior to |
| 139 |
the re-initialization, or (if the value prior to the re- |
| 140 |
initialization is unknown) be set to a pseudo-randomly |
| 141 |
generated value." |
| 142 |
SYNTAX INTEGER (0..2147483647) |
| 143 |
|
| 144 |
AutonomousType ::= TEXTUAL-CONVENTION |
| 145 |
STATUS current |
| 146 |
DESCRIPTION |
| 147 |
"Represents an independently extensible type identification |
| 148 |
value. It may, for example, indicate a particular sub-tree |
| 149 |
with further MIB definitions, or define a particular type of |
| 150 |
protocol or hardware." |
| 151 |
SYNTAX OBJECT IDENTIFIER |
| 152 |
|
| 153 |
|
| 154 |
InstancePointer ::= TEXTUAL-CONVENTION |
| 155 |
STATUS obsolete |
| 156 |
DESCRIPTION |
| 157 |
"A pointer to either a specific instance of a MIB object or |
| 158 |
a conceptual row of a MIB table in the managed device. In |
| 159 |
the latter case, by convention, it is the name of the |
| 160 |
particular instance of the first accessible columnar object |
| 161 |
in the conceptual row. |
| 162 |
|
| 163 |
The two uses of this textual convention are replaced by |
| 164 |
VariablePointer and RowPointer, respectively." |
| 165 |
SYNTAX OBJECT IDENTIFIER |
| 166 |
|
| 167 |
|
| 168 |
VariablePointer ::= TEXTUAL-CONVENTION |
| 169 |
STATUS current |
| 170 |
DESCRIPTION |
| 171 |
"A pointer to a specific object instance. For example, |
| 172 |
sysContact.0 or ifInOctets.3." |
| 173 |
SYNTAX OBJECT IDENTIFIER |
| 174 |
|
| 175 |
|
| 176 |
RowPointer ::= TEXTUAL-CONVENTION |
| 177 |
STATUS current |
| 178 |
DESCRIPTION |
| 179 |
"Represents a pointer to a conceptual row. The value is the |
| 180 |
name of the instance of the first accessible columnar object |
| 181 |
in the conceptual row. |
| 182 |
|
| 183 |
For example, ifIndex.3 would point to the 3rd row in the |
| 184 |
ifTable (note that if ifIndex were not-accessible, then |
| 185 |
ifDescr.3 would be used instead)." |
| 186 |
SYNTAX OBJECT IDENTIFIER |
| 187 |
|
| 188 |
RowStatus ::= TEXTUAL-CONVENTION |
| 189 |
STATUS current |
| 190 |
DESCRIPTION |
| 191 |
"The RowStatus textual convention is used to manage the |
| 192 |
creation and deletion of conceptual rows, and is used as the |
| 193 |
value of the SYNTAX clause for the status column of a |
| 194 |
conceptual row (as described in Section 7.7.1 of [2].) |
| 195 |
|
| 196 |
The status column has six defined values: |
| 197 |
|
| 198 |
- `active', which indicates that the conceptual row is |
| 199 |
available for use by the managed device; |
| 200 |
|
| 201 |
- `notInService', which indicates that the conceptual |
| 202 |
row exists in the agent, but is unavailable for use by |
| 203 |
the managed device (see NOTE below); 'notInService' has |
| 204 |
no implication regarding the internal consistency of |
| 205 |
the row, availability of resources, or consistency with |
| 206 |
the current state of the managed device; |
| 207 |
|
| 208 |
- `notReady', which indicates that the conceptual row |
| 209 |
exists in the agent, but is missing information |
| 210 |
necessary in order to be available for use by the |
| 211 |
managed device (i.e., one or more required columns in |
| 212 |
the conceptual row have not been instanciated); |
| 213 |
|
| 214 |
- `createAndGo', which is supplied by a management |
| 215 |
station wishing to create a new instance of a |
| 216 |
conceptual row and to have its status automatically set |
| 217 |
to active, making it available for use by the managed |
| 218 |
device; |
| 219 |
|
| 220 |
- `createAndWait', which is supplied by a management |
| 221 |
station wishing to create a new instance of a |
| 222 |
conceptual row (but not make it available for use by |
| 223 |
the managed device); and, |
| 224 |
|
| 225 |
- `destroy', which is supplied by a management station |
| 226 |
wishing to delete all of the instances associated with |
| 227 |
an existing conceptual row. |
| 228 |
|
| 229 |
Whereas five of the six values (all except `notReady') may |
| 230 |
be specified in a management protocol set operation, only |
| 231 |
three values will be returned in response to a management |
| 232 |
protocol retrieval operation: `notReady', `notInService' or |
| 233 |
`active'. That is, when queried, an existing conceptual row |
| 234 |
has only three states: it is either available for use by |
| 235 |
the managed device (the status column has value `active'); |
| 236 |
it is not available for use by the managed device, though |
| 237 |
the agent has sufficient information to attempt to make it |
| 238 |
so (the status column has value `notInService'); or, it is |
| 239 |
not available for use by the managed device, and an attempt |
| 240 |
to make it so would fail because the agent has insufficient |
| 241 |
information (the state column has value `notReady'). |
| 242 |
|
| 243 |
|
| 244 |
NOTE WELL |
| 245 |
|
| 246 |
This textual convention may be used for a MIB table, |
| 247 |
irrespective of whether the values of that table's |
| 248 |
conceptual rows are able to be modified while it is |
| 249 |
active, or whether its conceptual rows must be taken |
| 250 |
out of service in order to be modified. That is, it is |
| 251 |
the responsibility of the DESCRIPTION clause of the |
| 252 |
status column to specify whether the status column must |
| 253 |
not be `active' in order for the value of some other |
| 254 |
column of the same conceptual row to be modified. If |
| 255 |
such a specification is made, affected columns may be |
| 256 |
changed by an SNMP set PDU if the RowStatus would not |
| 257 |
be equal to `active' either immediately before or after |
| 258 |
processing the PDU. In other words, if the PDU also |
| 259 |
contained a varbind that would change the RowStatus |
| 260 |
value, the column in question may be changed if the |
| 261 |
RowStatus was not equal to `active' as the PDU was |
| 262 |
received, or if the varbind sets the status to a value |
| 263 |
other than 'active'. |
| 264 |
|
| 265 |
|
| 266 |
Also note that whenever any elements of a row exist, the |
| 267 |
RowStatus column must also exist. |
| 268 |
|
| 269 |
To summarize the effect of having a conceptual row with a |
| 270 |
status column having a SYNTAX clause value of RowStatus, |
| 271 |
consider the following state diagram: |
| 272 |
|
| 273 |
|
| 274 |
STATE |
| 275 |
+--------------+-----------+-------------+------------- |
| 276 |
| A | B | C | D |
| 277 |
| |status col.|status column| |
| 278 |
|status column | is | is |status column |
| 279 |
ACTION |does not exist| notReady | notInService| is active |
| 280 |
--------------+--------------+-----------+-------------+------------- |
| 281 |
set status |noError ->D|inconsist- |inconsistent-|inconsistent- |
| 282 |
column to | or | entValue| Value| Value |
| 283 |
createAndGo |inconsistent- | | | |
| 284 |
| Value| | | |
| 285 |
--------------+--------------+-----------+-------------+------------- |
| 286 |
set status |noError see 1|inconsist- |inconsistent-|inconsistent- |
| 287 |
column to | or | entValue| Value| Value |
| 288 |
createAndWait |wrongValue | | | |
| 289 |
--------------+--------------+-----------+-------------+------------- |
| 290 |
set status |inconsistent- |inconsist- |noError |noError |
| 291 |
column to | Value| entValue| | |
| 292 |
active | | | | |
| 293 |
| | or | | |
| 294 |
| | | | |
| 295 |
| |see 2 ->D|see 8 ->D| ->D |
| 296 |
--------------+--------------+-----------+-------------+------------- |
| 297 |
set status |inconsistent- |inconsist- |noError |noError ->C |
| 298 |
column to | Value| entValue| | |
| 299 |
notInService | | | | |
| 300 |
| | or | | or |
| 301 |
| | | | |
| 302 |
| |see 3 ->C| ->C|see 6 |
| 303 |
--------------+--------------+-----------+-------------+------------- |
| 304 |
set status |noError |noError |noError |noError ->A |
| 305 |
column to | | | | or |
| 306 |
destroy | ->A| ->A| ->A|see 7 |
| 307 |
--------------+--------------+-----------+-------------+------------- |
| 308 |
set any other |see 4 |noError |noError |see 5 |
| 309 |
column to some| | | | |
| 310 |
value | | see 1| ->C| ->D |
| 311 |
--------------+--------------+-----------+-------------+------------- |
| 312 |
|
| 313 |
(1) goto B or C, depending on information available to the |
| 314 |
agent. |
| 315 |
|
| 316 |
(2) if other variable bindings included in the same PDU, |
| 317 |
provide values for all columns which are missing but |
| 318 |
required, and all columns have acceptable values, then |
| 319 |
return noError and goto D. |
| 320 |
|
| 321 |
(3) if other variable bindings included in the same PDU, |
| 322 |
provide legal values for all columns which are missing but |
| 323 |
required, then return noError and goto C. |
| 324 |
|
| 325 |
(4) at the discretion of the agent, the return value may be |
| 326 |
either: |
| 327 |
|
| 328 |
inconsistentName: because the agent does not choose to |
| 329 |
create such an instance when the corresponding |
| 330 |
RowStatus instance does not exist, or |
| 331 |
|
| 332 |
inconsistentValue: if the supplied value is |
| 333 |
inconsistent with the state of some other MIB object's |
| 334 |
value, or |
| 335 |
|
| 336 |
noError: because the agent chooses to create the |
| 337 |
instance. |
| 338 |
|
| 339 |
If noError is returned, then the instance of the status |
| 340 |
column must also be created, and the new state is B or C, |
| 341 |
depending on the information available to the agent. If |
| 342 |
inconsistentName or inconsistentValue is returned, the row |
| 343 |
remains in state A. |
| 344 |
|
| 345 |
(5) depending on the MIB definition for the column/table, |
| 346 |
either noError or inconsistentValue may be returned. |
| 347 |
|
| 348 |
(6) the return value can indicate one of the following |
| 349 |
errors: |
| 350 |
|
| 351 |
wrongValue: because the agent does not support |
| 352 |
notInService (e.g., an agent which does not support |
| 353 |
createAndWait), or |
| 354 |
|
| 355 |
inconsistentValue: because the agent is unable to take |
| 356 |
the row out of service at this time, perhaps because it |
| 357 |
is in use and cannot be de-activated. |
| 358 |
|
| 359 |
(7) the return value can indicate the following error: |
| 360 |
|
| 361 |
inconsistentValue: because the agent is unable to |
| 362 |
remove the row at this time, perhaps because it is in |
| 363 |
use and cannot be de-activated. |
| 364 |
|
| 365 |
(8) the transition to D can fail, e.g., if the values of the |
| 366 |
conceptual row are inconsistent, then the error code would |
| 367 |
be inconsistentValue. |
| 368 |
|
| 369 |
NOTE: Other processing of (this and other varbinds of) the |
| 370 |
set request may result in a response other than noError |
| 371 |
being returned, e.g., wrongValue, noCreation, etc. |
| 372 |
|
| 373 |
|
| 374 |
Conceptual Row Creation |
| 375 |
|
| 376 |
There are four potential interactions when creating a |
| 377 |
conceptual row: selecting an instance-identifier which is |
| 378 |
not in use; creating the conceptual row; initializing any |
| 379 |
objects for which the agent does not supply a default; and, |
| 380 |
making the conceptual row available for use by the managed |
| 381 |
device. |
| 382 |
|
| 383 |
Interaction 1: Selecting an Instance-Identifier |
| 384 |
|
| 385 |
The algorithm used to select an instance-identifier varies |
| 386 |
for each conceptual row. In some cases, the instance- |
| 387 |
identifier is semantically significant, e.g., the |
| 388 |
destination address of a route, and a management station |
| 389 |
selects the instance-identifier according to the semantics. |
| 390 |
|
| 391 |
In other cases, the instance-identifier is used solely to |
| 392 |
distinguish conceptual rows, and a management station |
| 393 |
without specific knowledge of the conceptual row might |
| 394 |
examine the instances present in order to determine an |
| 395 |
unused instance-identifier. (This approach may be used, but |
| 396 |
it is often highly sub-optimal; however, it is also a |
| 397 |
questionable practice for a naive management station to |
| 398 |
attempt conceptual row creation.) |
| 399 |
|
| 400 |
Alternately, the MIB module which defines the conceptual row |
| 401 |
might provide one or more objects which provide assistance |
| 402 |
in determining an unused instance-identifier. For example, |
| 403 |
if the conceptual row is indexed by an integer-value, then |
| 404 |
an object having an integer-valued SYNTAX clause might be |
| 405 |
defined for such a purpose, allowing a management station to |
| 406 |
issue a management protocol retrieval operation. In order |
| 407 |
to avoid unnecessary collisions between competing management |
| 408 |
stations, `adjacent' retrievals of this object should be |
| 409 |
different. |
| 410 |
|
| 411 |
Finally, the management station could select a pseudo-random |
| 412 |
number to use as the index. In the event that this index |
| 413 |
was already in use and an inconsistentValue was returned in |
| 414 |
response to the management protocol set operation, the |
| 415 |
management station should simply select a new pseudo-random |
| 416 |
number and retry the operation. |
| 417 |
|
| 418 |
A MIB designer should choose between the two latter |
| 419 |
algorithms based on the size of the table (and therefore the |
| 420 |
efficiency of each algorithm). For tables in which a large |
| 421 |
number of entries are expected, it is recommended that a MIB |
| 422 |
object be defined that returns an acceptable index for |
| 423 |
creation. For tables with small numbers of entries, it is |
| 424 |
recommended that the latter pseudo-random index mechanism be |
| 425 |
used. |
| 426 |
|
| 427 |
Interaction 2: Creating the Conceptual Row |
| 428 |
|
| 429 |
Once an unused instance-identifier has been selected, the |
| 430 |
management station determines if it wishes to create and |
| 431 |
activate the conceptual row in one transaction or in a |
| 432 |
negotiated set of interactions. |
| 433 |
|
| 434 |
Interaction 2a: Creating and Activating the Conceptual Row |
| 435 |
|
| 436 |
The management station must first determine the column |
| 437 |
requirements, i.e., it must determine those columns for |
| 438 |
which it must or must not provide values. Depending on the |
| 439 |
complexity of the table and the management station's |
| 440 |
knowledge of the agent's capabilities, this determination |
| 441 |
can be made locally by the management station. Alternately, |
| 442 |
the management station issues a management protocol get |
| 443 |
operation to examine all columns in the conceptual row that |
| 444 |
it wishes to create. In response, for each column, there |
| 445 |
are three possible outcomes: |
| 446 |
|
| 447 |
- a value is returned, indicating that some other |
| 448 |
management station has already created this conceptual |
| 449 |
row. We return to interaction 1. |
| 450 |
|
| 451 |
- the exception `noSuchInstance' is returned, |
| 452 |
indicating that the agent implements the object-type |
| 453 |
associated with this column, and that this column in at |
| 454 |
least one conceptual row would be accessible in the MIB |
| 455 |
view used by the retrieval were it to exist. For those |
| 456 |
columns to which the agent provides read-create access, |
| 457 |
the `noSuchInstance' exception tells the management |
| 458 |
station that it should supply a value for this column |
| 459 |
when the conceptual row is to be created. |
| 460 |
|
| 461 |
- the exception `noSuchObject' is returned, indicating |
| 462 |
that the agent does not implement the object-type |
| 463 |
associated with this column or that there is no |
| 464 |
conceptual row for which this column would be |
| 465 |
accessible in the MIB view used by the retrieval. As |
| 466 |
such, the management station can not issue any |
| 467 |
management protocol set operations to create an |
| 468 |
instance of this column. |
| 469 |
|
| 470 |
Once the column requirements have been determined, a |
| 471 |
management protocol set operation is accordingly issued. |
| 472 |
This operation also sets the new instance of the status |
| 473 |
column to `createAndGo'. |
| 474 |
|
| 475 |
When the agent processes the set operation, it verifies that |
| 476 |
it has sufficient information to make the conceptual row |
| 477 |
available for use by the managed device. The information |
| 478 |
available to the agent is provided by two sources: the |
| 479 |
management protocol set operation which creates the |
| 480 |
conceptual row, and, implementation-specific defaults |
| 481 |
supplied by the agent (note that an agent must provide |
| 482 |
implementation-specific defaults for at least those objects |
| 483 |
which it implements as read-only). If there is sufficient |
| 484 |
information available, then the conceptual row is created, a |
| 485 |
`noError' response is returned, the status column is set to |
| 486 |
`active', and no further interactions are necessary (i.e., |
| 487 |
interactions 3 and 4 are skipped). If there is insufficient |
| 488 |
information, then the conceptual row is not created, and the |
| 489 |
set operation fails with an error of `inconsistentValue'. |
| 490 |
On this error, the management station can issue a management |
| 491 |
protocol retrieval operation to determine if this was |
| 492 |
because it failed to specify a value for a required column, |
| 493 |
or, because the selected instance of the status column |
| 494 |
already existed. In the latter case, we return to |
| 495 |
interaction 1. In the former case, the management station |
| 496 |
can re-issue the set operation with the additional |
| 497 |
information, or begin interaction 2 again using |
| 498 |
`createAndWait' in order to negotiate creation of the |
| 499 |
conceptual row. |
| 500 |
|
| 501 |
NOTE WELL |
| 502 |
|
| 503 |
Regardless of the method used to determine the column |
| 504 |
requirements, it is possible that the management |
| 505 |
station might deem a column necessary when, in fact, |
| 506 |
the agent will not allow that particular columnar |
| 507 |
instance to be created or written. In this case, the |
| 508 |
management protocol set operation will fail with an |
| 509 |
error such as `noCreation' or `notWritable'. In this |
| 510 |
case, the management station decides whether it needs |
| 511 |
to be able to set a value for that particular columnar |
| 512 |
instance. If not, the management station re-issues the |
| 513 |
management protocol set operation, but without setting |
| 514 |
a value for that particular columnar instance; |
| 515 |
otherwise, the management station aborts the row |
| 516 |
creation algorithm. |
| 517 |
|
| 518 |
Interaction 2b: Negotiating the Creation of the Conceptual |
| 519 |
Row |
| 520 |
|
| 521 |
The management station issues a management protocol set |
| 522 |
operation which sets the desired instance of the status |
| 523 |
column to `createAndWait'. If the agent is unwilling to |
| 524 |
process a request of this sort, the set operation fails with |
| 525 |
an error of `wrongValue'. (As a consequence, such an agent |
| 526 |
must be prepared to accept a single management protocol set |
| 527 |
operation, i.e., interaction 2a above, containing all of the |
| 528 |
columns indicated by its column requirements.) Otherwise, |
| 529 |
the conceptual row is created, a `noError' response is |
| 530 |
returned, and the status column is immediately set to either |
| 531 |
`notInService' or `notReady', depending on whether it has |
| 532 |
sufficient information to (attempt to) make the conceptual |
| 533 |
row available for use by the managed device. If there is |
| 534 |
sufficient information available, then the status column is |
| 535 |
set to `notInService'; otherwise, if there is insufficient |
| 536 |
information, then the status column is set to `notReady'. |
| 537 |
Regardless, we proceed to interaction 3. |
| 538 |
|
| 539 |
Interaction 3: Initializing non-defaulted Objects |
| 540 |
|
| 541 |
The management station must now determine the column |
| 542 |
requirements. It issues a management protocol get operation |
| 543 |
to examine all columns in the created conceptual row. In |
| 544 |
the response, for each column, there are three possible |
| 545 |
outcomes: |
| 546 |
|
| 547 |
- a value is returned, indicating that the agent |
| 548 |
implements the object-type associated with this column |
| 549 |
and had sufficient information to provide a value. For |
| 550 |
those columns to which the agent provides read-create |
| 551 |
access (and for which the agent allows their values to |
| 552 |
be changed after their creation), a value return tells |
| 553 |
the management station that it may issue additional |
| 554 |
management protocol set operations, if it desires, in |
| 555 |
order to change the value associated with this column. |
| 556 |
|
| 557 |
- the exception `noSuchInstance' is returned, |
| 558 |
indicating that the agent implements the object-type |
| 559 |
associated with this column, and that this column in at |
| 560 |
least one conceptual row would be accessible in the MIB |
| 561 |
view used by the retrieval were it to exist. However, |
| 562 |
the agent does not have sufficient information to |
| 563 |
provide a value, and until a value is provided, the |
| 564 |
conceptual row may not be made available for use by the |
| 565 |
managed device. For those columns to which the agent |
| 566 |
provides read-create access, the `noSuchInstance' |
| 567 |
exception tells the management station that it must |
| 568 |
issue additional management protocol set operations, in |
| 569 |
order to provide a value associated with this column. |
| 570 |
|
| 571 |
- the exception `noSuchObject' is returned, indicating |
| 572 |
that the agent does not implement the object-type |
| 573 |
associated with this column or that there is no |
| 574 |
conceptual row for which this column would be |
| 575 |
accessible in the MIB view used by the retrieval. As |
| 576 |
such, the management station can not issue any |
| 577 |
management protocol set operations to create an |
| 578 |
instance of this column. |
| 579 |
|
| 580 |
If the value associated with the status column is |
| 581 |
`notReady', then the management station must first deal with |
| 582 |
all `noSuchInstance' columns, if any. Having done so, the |
| 583 |
value of the status column becomes `notInService', and we |
| 584 |
proceed to interaction 4. |
| 585 |
|
| 586 |
|
| 587 |
Interaction 4: Making the Conceptual Row Available |
| 588 |
|
| 589 |
Once the management station is satisfied with the values |
| 590 |
associated with the columns of the conceptual row, it issues |
| 591 |
a management protocol set operation to set the status column |
| 592 |
to `active'. If the agent has sufficient information to |
| 593 |
make the conceptual row available for use by the managed |
| 594 |
device, the management protocol set operation succeeds (a |
| 595 |
`noError' response is returned). Otherwise, the management |
| 596 |
protocol set operation fails with an error of |
| 597 |
`inconsistentValue'. |
| 598 |
|
| 599 |
NOTE WELL |
| 600 |
|
| 601 |
A conceptual row having a status column with value |
| 602 |
`notInService' or `notReady' is unavailable to the |
| 603 |
managed device. As such, it is possible for the |
| 604 |
managed device to create its own instances during the |
| 605 |
time between the management protocol set operation |
| 606 |
which sets the status column to `createAndWait' and the |
| 607 |
management protocol set operation which sets the status |
| 608 |
column to `active'. In this case, when the management |
| 609 |
protocol set operation is issued to set the status |
| 610 |
column to `active', the values held in the agent |
| 611 |
supersede those used by the managed device. |
| 612 |
|
| 613 |
If the management station is prevented from setting the |
| 614 |
status column to `active' (e.g., due to management station |
| 615 |
or network failure) the conceptual row will be left in the |
| 616 |
`notInService' or `notReady' state, consuming resources |
| 617 |
indefinitely. The agent must detect conceptual rows that |
| 618 |
have been in either state for an abnormally long period of |
| 619 |
time and remove them. It is the responsibility of the |
| 620 |
DESCRIPTION clause of the status column to indicate what an |
| 621 |
abnormally long period of time would be. This period of |
| 622 |
time should be long enough to allow for human response time |
| 623 |
(including `think time') between the creation of the |
| 624 |
conceptual row and the setting of the status to `active'. |
| 625 |
In the absence of such information in the DESCRIPTION |
| 626 |
clause, it is suggested that this period be approximately 5 |
| 627 |
minutes in length. This removal action applies not only to |
| 628 |
newly-created rows, but also to previously active rows which |
| 629 |
are set to, and left in, the notInService state for a |
| 630 |
prolonged period exceeding that which is considered normal |
| 631 |
for such a conceptual row. |
| 632 |
|
| 633 |
|
| 634 |
|
| 635 |
Conceptual Row Suspension |
| 636 |
|
| 637 |
When a conceptual row is `active', the management station |
| 638 |
may issue a management protocol set operation which sets the |
| 639 |
instance of the status column to `notInService'. If the |
| 640 |
agent is unwilling to do so, the set operation fails with an |
| 641 |
error of `wrongValue' or `inconsistentValue'. Otherwise, |
| 642 |
the conceptual row is taken out of service, and a `noError' |
| 643 |
response is returned. It is the responsibility of the |
| 644 |
DESCRIPTION clause of the status column to indicate under |
| 645 |
what circumstances the status column should be taken out of |
| 646 |
service (e.g., in order for the value of some other column |
| 647 |
of the same conceptual row to be modified). |
| 648 |
|
| 649 |
|
| 650 |
Conceptual Row Deletion |
| 651 |
|
| 652 |
For deletion of conceptual rows, a management protocol set |
| 653 |
operation is issued which sets the instance of the status |
| 654 |
column to `destroy'. This request may be made regardless of |
| 655 |
the current value of the status column (e.g., it is possible |
| 656 |
to delete conceptual rows which are either `notReady', |
| 657 |
`notInService' or `active'.) If the operation succeeds, |
| 658 |
then all instances associated with the conceptual row are |
| 659 |
immediately removed." |
| 660 |
SYNTAX INTEGER { |
| 661 |
-- the following two values are states: |
| 662 |
-- these values may be read or written |
| 663 |
active(1), |
| 664 |
notInService(2), |
| 665 |
|
| 666 |
-- the following value is a state: |
| 667 |
-- this value may be read, but not written |
| 668 |
notReady(3), |
| 669 |
|
| 670 |
-- the following three values are |
| 671 |
-- actions: these values may be written, |
| 672 |
-- but are never read |
| 673 |
createAndGo(4), |
| 674 |
createAndWait(5), |
| 675 |
destroy(6) |
| 676 |
} |
| 677 |
|
| 678 |
TimeStamp ::= TEXTUAL-CONVENTION |
| 679 |
STATUS current |
| 680 |
DESCRIPTION |
| 681 |
"The value of the sysUpTime object at which a specific |
| 682 |
occurrence happened. The specific occurrence must be |
| 683 |
defined in the description of any object defined using this |
| 684 |
type. |
| 685 |
|
| 686 |
If sysUpTime is reset to zero as a result of a re- |
| 687 |
initialization of the network management (sub)system, then |
| 688 |
the values of all TimeStamp objects are also reset. |
| 689 |
However, after approximately 497 days without a re- |
| 690 |
initialization, the sysUpTime object will reach 2^^32-1 and |
| 691 |
then increment around to zero; in this case, existing values |
| 692 |
of TimeStamp objects do not change. This can lead to |
| 693 |
ambiguities in the value of TimeStamp objects." |
| 694 |
SYNTAX TimeTicks |
| 695 |
|
| 696 |
|
| 697 |
TimeInterval ::= TEXTUAL-CONVENTION |
| 698 |
STATUS current |
| 699 |
DESCRIPTION |
| 700 |
"A period of time, measured in units of 0.01 seconds." |
| 701 |
SYNTAX INTEGER (0..2147483647) |
| 702 |
|
| 703 |
DateAndTime ::= TEXTUAL-CONVENTION |
| 704 |
DISPLAY-HINT "2d-1d-1d,1d:1d:1d.1d,1a1d:1d" |
| 705 |
STATUS current |
| 706 |
DESCRIPTION |
| 707 |
"A date-time specification. |
| 708 |
|
| 709 |
field octets contents range |
| 710 |
----- ------ -------- ----- |
| 711 |
1 1-2 year* 0..65536 |
| 712 |
2 3 month 1..12 |
| 713 |
3 4 day 1..31 |
| 714 |
4 5 hour 0..23 |
| 715 |
5 6 minutes 0..59 |
| 716 |
6 7 seconds 0..60 |
| 717 |
(use 60 for leap-second) |
| 718 |
7 8 deci-seconds 0..9 |
| 719 |
8 9 direction from UTC '+' / '-' |
| 720 |
9 10 hours from UTC* 0..13 |
| 721 |
10 11 minutes from UTC 0..59 |
| 722 |
|
| 723 |
* Notes: |
| 724 |
- the value of year is in network-byte order |
| 725 |
- daylight saving time in New Zealand is +13 |
| 726 |
|
| 727 |
For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be |
| 728 |
displayed as: |
| 729 |
|
| 730 |
1992-5-26,13:30:15.0,-4:0 |
| 731 |
|
| 732 |
Note that if only local time is known, then timezone |
| 733 |
information (fields 8-10) is not present." |
| 734 |
SYNTAX OCTET STRING (SIZE (8 | 11)) |
| 735 |
|
| 736 |
|
| 737 |
StorageType ::= TEXTUAL-CONVENTION |
| 738 |
STATUS current |
| 739 |
DESCRIPTION |
| 740 |
"Describes the memory realization of a conceptual row. A |
| 741 |
row which is volatile(2) is lost upon reboot. A row which |
| 742 |
is either nonVolatile(3), permanent(4) or readOnly(5), is |
| 743 |
backed up by stable storage. A row which is permanent(4) |
| 744 |
can be changed but not deleted. A row which is readOnly(5) |
| 745 |
cannot be changed nor deleted. |
| 746 |
|
| 747 |
If the value of an object with this syntax is either |
| 748 |
permanent(4) or readOnly(5), it cannot be written. |
| 749 |
Conversely, if the value is either other(1), volatile(2) or |
| 750 |
nonVolatile(3), it cannot be modified to be permanent(4) or |
| 751 |
readOnly(5). (All illegal modifications result in a |
| 752 |
'wrongValue' error.) |
| 753 |
|
| 754 |
Every usage of this textual convention is required to |
| 755 |
specify the columnar objects which a permanent(4) row must |
| 756 |
at a minimum allow to be writable." |
| 757 |
SYNTAX INTEGER { |
| 758 |
other(1), -- eh? |
| 759 |
volatile(2), -- e.g., in RAM |
| 760 |
nonVolatile(3), -- e.g., in NVRAM |
| 761 |
permanent(4), -- e.g., partially in ROM |
| 762 |
readOnly(5) -- e.g., completely in ROM |
| 763 |
} |
| 764 |
|
| 765 |
TDomain ::= TEXTUAL-CONVENTION |
| 766 |
STATUS current |
| 767 |
DESCRIPTION |
| 768 |
"Denotes a kind of transport service. |
| 769 |
|
| 770 |
Some possible values, such as snmpUDPDomain, are defined in |
| 771 |
the SNMPv2-TM MIB module. Other possible values are defined |
| 772 |
in other MIB modules." |
| 773 |
REFERENCE "The SNMPv2-TM MIB module is defined in RFC 1906." |
| 774 |
SYNTAX OBJECT IDENTIFIER |
| 775 |
|
| 776 |
|
| 777 |
TAddress ::= TEXTUAL-CONVENTION |
| 778 |
STATUS current |
| 779 |
DESCRIPTION |
| 780 |
"Denotes a transport service address. |
| 781 |
|
| 782 |
A TAddress value is always interpreted within the context of a |
| 783 |
TDomain value. Thus, each definition of a TDomain value must |
| 784 |
be accompanied by a definition of a textual convention for use |
| 785 |
with that TDomain. Some possible textual conventions, such as |
| 786 |
SnmpUDPAddress for snmpUDPDomain, are defined in the SNMPv2-TM |
| 787 |
MIB module. Other possible textual conventions are defined in |
| 788 |
other MIB modules." |
| 789 |
REFERENCE "The SNMPv2-TM MIB module is defined in RFC 1906." |
| 790 |
SYNTAX OCTET STRING (SIZE (1..255)) |
| 791 |
|
| 792 |
|
| 793 |
END |