1SNMP-TARGET-MIB(7) MIB SNMP-TARGET-MIB(7)
2 SNMP-TARGET-MIB DEFINITIONS ::= BEGIN
6 IMPORTS
8 MODULE-IDENTITY,
9 OBJECT-TYPE,
10 snmpModules,
11 Counter32,
12 Integer32
13 FROM SNMPv2-SMI
14 TEXTUAL-CONVENTION,
16 TDomain,
17 TAddress,
18 TimeInterval,
19 RowStatus,
20 StorageType,
21 TestAndIncr
22 FROM SNMPv2-TC
23 SnmpSecurityModel,
25 SnmpMessageProcessingModel,
26 SnmpSecurityLevel,
27 SnmpAdminString
28 FROM SNMP-FRAMEWORK-MIB
29 MODULE-COMPLIANCE,
31 OBJECT-GROUP
32 FROM SNMPv2-CONF;
33 snmpTargetMIB MODULE-IDENTITY
35 LAST-UPDATED "9808040000Z"
36 ORGANIZATION "IETF SNMPv3 Working Group"
37 CONTACT-INFO
38 "WG-email: snmpv3@tis.com
39 Subscribe: majordomo@tis.com
40 In message body: subscribe snmpv3
41 Chair: Russ Mundy
43 Trusted Information Systems
44 Postal: 3060 Washington Rd
45 Glenwood MD 21738
46 USA
47 EMail: mundy@tis.com
48 Phone: +1-301-854-6889
49 Co-editor: David B. Levi
51 SNMP Research, Inc.
52 Postal: 3001 Kimberlin Heights Road
53 Knoxville, TN 37920-9716
54 EMail: levi@snmp.com
55 Phone: +1 423 573 1434
56 Co-editor: Paul Meyer
58 Secure Computing Corporation
59 Postal: 2675 Long Lake Road
60 Roseville, MN 55113
61 EMail: paul_meyer@securecomputing.com
62 Phone: +1 651 628 1592
63 Co-editor: Bob Stewart
65 Cisco Systems, Inc.
66 Postal: 170 West Tasman Drive
67 San Jose, CA 95134-1706
68 EMail: bstewart@cisco.com
69 Phone: +1 603 654 2686"
70 DESCRIPTION
71 "This MIB module defines MIB objects which provide
72 mechanisms to remotely configure the parameters used
73 by an SNMP entity for the generation of SNMP messages."
74 REVISION "9808040000Z"
75 DESCRIPTION "Clarifications, published as
76 draft-ietf-snmpv3-appl-v2-01.txt."
77 REVISION "9707140000Z"
78 DESCRIPTION "The initial revision, published as RFC2273."
79 ::= { snmpModules 12 }
80 snmpTargetObjects OBJECT IDENTIFIER ::= { snmpTargetMIB 1 }
82 snmpTargetConformance OBJECT IDENTIFIER ::= { snmpTargetMIB 3 }
83 SnmpTagValue ::= TEXTUAL-CONVENTION
85 DISPLAY-HINT "255a"
86 STATUS current
87 DESCRIPTION
88 "An octet string containing a tag value.
89 Tag values are preferably in human-readable form.
90 To facilitate internationalization, this information
92 is represented using the ISO/IEC IS 10646-1 character
93 set, encoded as an octet string using the UTF-8
94 character encoding scheme described in RFC 2279.
95 Since additional code points are added by amendments
97 to the 10646 standard from time to time,
98 implementations must be prepared to encounter any code
99 point from 0x00000000 to 0x7fffffff.
100 The use of control codes should be avoided, and certain
102 control codes are not allowed as described below.
103 For code points not directly supported by user
105 interface hardware or software, an alternative means
106 of entry and display, such as hexadecimal, may be
107 provided.
108 For information encoded in 7-bit US-ASCII, the UTF-8
110 representation is identical to the US-ASCII encoding.
111 Note that when this TC is used for an object that
113 is used or envisioned to be used as an index, then a
114 SIZE restriction must be specified so that the number
115 of sub-identifiers for any object instance does not
116 exceed the limit of 128, as defined by [RFC1905].
117 An object of this type contains a single tag value
119 which is used to select a set of entries in a table.
120 A tag value is an arbitrary string of octets, but
122 may not contain a delimiter character. Delimiter
123 characters are defined to be one of the following:
124 - An ASCII space character (0x20).
126 - An ASCII TAB character (0x09).
128 - An ASCII carriage return (CR) character (0x0D).
130 - An ASCII line feed (LF) character (0x0B).
132 Delimiter characters are used to separate tag values
134 in a tag list. An object of this type may only
135 contain a single tag value, and so delimiter
136 characters are not allowed in a value of this type.
137 Some examples of valid tag values are:
139 - 'acme'
141 - 'router'
143 - 'host'
145 The use of a tag value to select table entries is
147 application and MIB specific."
148 SYNTAX OCTET STRING (SIZE (0..255))
149 SnmpTagList ::= TEXTUAL-CONVENTION
151 DISPLAY-HINT "255a"
152 STATUS current
153 DESCRIPTION
154 "An octet string containing a list of tag values.
155 Tag values are preferably in human-readable form.
156 To facilitate internationalization, this information
158 is represented using the ISO/IEC IS 10646-1 character
159 set, encoded as an octet string using the UTF-8
160 character encoding scheme described in RFC 2279.
161 Since additional code points are added by amendments
163 to the 10646 standard from time to time,
164 implementations must be prepared to encounter any code
165 point from 0x00000000 to 0x7fffffff.
166 The use of control codes should be avoided, except as
168 described below.
169 For code points not directly supported by user
171 interface hardware or software, an alternative means
172 of entry and display, such as hexadecimal, may be
173 provided.
174 For information encoded in 7-bit US-ASCII, the UTF-8
176 representation is identical to the US-ASCII encoding.
177 An object of this type contains a list of tag values
179 which are used to select a set of entries in a table.
180 A tag value is an arbitrary string of octets, but
182 may not contain a delimiter character. Delimiter
183 characters are defined to be one of the following:
184 - An ASCII space character (0x20).
186 - An ASCII TAB character (0x09).
188 - An ASCII carriage return (CR) character (0x0D).
190 - An ASCII line feed (LF) character (0x0B).
192 Delimiter characters are used to separate tag values
194 in a tag list. Only a single delimiter character may
195 occur between two tag values. A tag value may not
196 have a zero length. These constraints imply certain
197 restrictions on the contents of this object:
198 - There cannot be a leading or trailing delimiter
200 character.
201 - There cannot be multiple adjacent delimiter
203 characters.
204 Some examples of valid tag lists are:
206 - An empty string
208 - 'acme router'
210 - 'host managerStation'
212 Note that although a tag value may not have a length of
214 zero, an empty string is still valid. This indicates
215 an empty list (i.e. there are no tag values in the list).
216 The use of the tag list to select table entries is
218 application and MIB specific. Typically, an application
219 will provide one or more tag values, and any entry
220 which contains some combination of these tag values
221 will be selected."
222 SYNTAX OCTET STRING (SIZE (0..255))
223 --
225 --
226 -- The snmpTargetObjects group
227 --
228 --
229 snmpTargetSpinLock OBJECT-TYPE
231 SYNTAX TestAndIncr
232 MAX-ACCESS read-write
233 STATUS current
234 DESCRIPTION
235 "This object is used to facilitate modification of table
236 entries in the SNMP-TARGET-MIB module by multiple
237 managers. In particular, it is useful when modifying
238 the value of the snmpTargetAddrTagList object.
239 The procedure for modifying the snmpTargetAddrTagList
241 object is as follows:
242 1. Retrieve the value of snmpTargetSpinLock and
244 of snmpTargetAddrTagList.
245 2. Generate a new value for snmpTargetAddrTagList.
247 3. Set the value of snmpTargetSpinLock to the
249 retrieved value, and the value of
250 snmpTargetAddrTagList to the new value. If
251 the set fails for the snmpTargetSpinLock
252 object, go back to step 1."
253 ::= { snmpTargetObjects 1 }
254 snmpTargetAddrTable OBJECT-TYPE
256 SYNTAX SEQUENCE OF SnmpTargetAddrEntry
257 MAX-ACCESS not-accessible
258 STATUS current
259 DESCRIPTION
260 "A table of transport addresses to be used in the generation
261 of SNMP messages."
262 ::= { snmpTargetObjects 2 }
263 snmpTargetAddrEntry OBJECT-TYPE
265 SYNTAX SnmpTargetAddrEntry
266 MAX-ACCESS not-accessible
267 STATUS current
268 DESCRIPTION
269 "A transport address to be used in the generation
270 of SNMP operations.
271 Entries in the snmpTargetAddrTable are created and
273 deleted using the snmpTargetAddrRowStatus object."
274 INDEX { IMPLIED snmpTargetAddrName }
275 ::= { snmpTargetAddrTable 1 }
276 SnmpTargetAddrEntry ::= SEQUENCE {
278 snmpTargetAddrName SnmpAdminString,
279 snmpTargetAddrTDomain TDomain,
280 snmpTargetAddrTAddress TAddress,
281 snmpTargetAddrTimeout TimeInterval,
282 snmpTargetAddrRetryCount Integer32,
283 snmpTargetAddrTagList SnmpTagList,
284 snmpTargetAddrParams SnmpAdminString,
285 snmpTargetAddrStorageType StorageType,
286 snmpTargetAddrRowStatus RowStatus
287 }
288 snmpTargetAddrName OBJECT-TYPE
290 SYNTAX SnmpAdminString (SIZE(1..32))
291 MAX-ACCESS not-accessible
292 STATUS current
293 DESCRIPTION
294 "The locally arbitrary, but unique identifier associated
295 with this snmpTargetAddrEntry."
296 ::= { snmpTargetAddrEntry 1 }
297 snmpTargetAddrTDomain OBJECT-TYPE
299 SYNTAX TDomain
300 MAX-ACCESS read-create
301 STATUS current
302 DESCRIPTION
303 "This object indicates the transport type of the address
304 contained in the snmpTargetAddrTAddress object."
305 ::= { snmpTargetAddrEntry 2 }
306 snmpTargetAddrTAddress OBJECT-TYPE
308 SYNTAX TAddress
309 MAX-ACCESS read-create
310 STATUS current
311 DESCRIPTION
312 "This object contains a transport address. The format of
313 this address depends on the value of the
314 snmpTargetAddrTDomain object."
315 ::= { snmpTargetAddrEntry 3 }
316 snmpTargetAddrTimeout OBJECT-TYPE
318 SYNTAX TimeInterval
319 MAX-ACCESS read-create
320 STATUS current
321 DESCRIPTION
322 "This object should reflect the expected maximum round
323 trip time for communicating with the transport address
324 defined by this row. When a message is sent to this
325 address, and a response (if one is expected) is not
326 received within this time period, an implementation
327 may assume that the response will not be delivered.
328 Note that the time interval that an application waits
330 for a response may actually be derived from the value
331 of this object. The method for deriving the actual time
332 interval is implementation dependent. One such method
333 is to derive the expected round trip time based on a
334 particular retransmission algorithm and on the number
335 of timeouts which have occurred. The type of message may
336 also be considered when deriving expected round trip
337 times for retransmissions. For example, if a message is
338 being sent with a securityLevel that indicates both
339 authentication and privacy, the derived value may be
340 increased to compensate for extra processing time spent
341 during authentication and encryption processing."
342 DEFVAL { 1500 }
343 ::= { snmpTargetAddrEntry 4 }
344 snmpTargetAddrRetryCount OBJECT-TYPE
346 SYNTAX Integer32 (0..255)
347 MAX-ACCESS read-create
348 STATUS current
349 DESCRIPTION
350 "This object specifies a default number of retries to be
351 attempted when a response is not received for a generated
352 message. An application may provide its own retry count,
353 in which case the value of this object is ignored."
354 DEFVAL { 3 }
355 ::= { snmpTargetAddrEntry 5 }
356 snmpTargetAddrTagList OBJECT-TYPE
358 SYNTAX SnmpTagList
359 MAX-ACCESS read-create
360 STATUS current
361 DESCRIPTION
362 "This object contains a list of tag values which are
363 used to select target addresses for a particular
364 operation."
365 DEFVAL { "" }
366 ::= { snmpTargetAddrEntry 6 }
367 snmpTargetAddrParams OBJECT-TYPE
369 SYNTAX SnmpAdminString (SIZE(1..32))
370 MAX-ACCESS read-create
371 STATUS current
372 DESCRIPTION
373 "The value of this object identifies an entry in the
374 snmpTargetParamsTable. The identified entry
375 contains SNMP parameters to be used when generating
376 messages to be sent to this transport address."
377 ::= { snmpTargetAddrEntry 7 }
378 snmpTargetAddrStorageType OBJECT-TYPE
380 SYNTAX StorageType
381 MAX-ACCESS read-create
382 STATUS current
383 DESCRIPTION
384 "The storage type for this conceptual row."
385 DEFVAL { nonVolatile }
386 ::= { snmpTargetAddrEntry 8 }
387 snmpTargetAddrRowStatus OBJECT-TYPE
389 SYNTAX RowStatus
390 MAX-ACCESS read-create
391 STATUS current
392 DESCRIPTION
393 "The status of this conceptual row.
394 To create a row in this table, a manager must
396 set this object to either createAndGo(4) or
397 createAndWait(5).
398 Until instances of all corresponding columns are
400 appropriately configured, the value of the
401 corresponding instance of the snmpTargetAddrRowStatus
402 column is 'notReady'.
403 In particular, a newly created row cannot be made
405 active until the corresponding instances of
406 snmpTargetAddrTDomain, snmpTargetAddrTAddress, and
407 snmpTargetAddrParams have all been set.
408 The following objects may not be modified while the
410 value of this object is active(1):
411 - snmpTargetAddrTDomain
412 - snmpTargetAddrTAddress
413 An attempt to set these objects while the value of
414 snmpTargetAddrRowStatus is active(1) will result in
415 an inconsistentValue error."
416 ::= { snmpTargetAddrEntry 9 }
417 snmpTargetParamsTable OBJECT-TYPE
419 SYNTAX SEQUENCE OF SnmpTargetParamsEntry
420 MAX-ACCESS not-accessible
421 STATUS current
422 DESCRIPTION
423 "A table of SNMP target information to be used
424 in the generation of SNMP messages."
425 ::= { snmpTargetObjects 3 }
426 snmpTargetParamsEntry OBJECT-TYPE
428 SYNTAX SnmpTargetParamsEntry
429 MAX-ACCESS not-accessible
430 STATUS current
431 DESCRIPTION
432 "A set of SNMP target information.
433 Entries in the snmpTargetParamsTable are created and
435 deleted using the snmpTargetParamsRowStatus object."
436 INDEX { IMPLIED snmpTargetParamsName }
437 ::= { snmpTargetParamsTable 1 }
438 SnmpTargetParamsEntry ::= SEQUENCE {
440 snmpTargetParamsName SnmpAdminString,
441 snmpTargetParamsMPModel SnmpMessageProcessingModel,
442 snmpTargetParamsSecurityModel SnmpSecurityModel,
443 snmpTargetParamsSecurityName SnmpAdminString,
444 snmpTargetParamsSecurityLevel SnmpSecurityLevel,
445 snmpTargetParamsStorageType StorageType,
446 snmpTargetParamsRowStatus RowStatus
447 }
448 snmpTargetParamsName OBJECT-TYPE
450 SYNTAX SnmpAdminString (SIZE(1..32))
451 MAX-ACCESS not-accessible
452 STATUS current
453 DESCRIPTION
454 "The locally arbitrary, but unique identifier associated
455 with this snmpTargetParamsEntry."
456 ::= { snmpTargetParamsEntry 1 }
457 snmpTargetParamsMPModel OBJECT-TYPE
459 SYNTAX SnmpMessageProcessingModel
460 MAX-ACCESS read-create
461 STATUS current
462 DESCRIPTION
463 "The Message Processing Model to be used when generating
464 SNMP messages using this entry."
465 ::= { snmpTargetParamsEntry 2 }
466 snmpTargetParamsSecurityModel OBJECT-TYPE
468 SYNTAX SnmpSecurityModel (1..2147483647)
469 MAX-ACCESS read-create
470 STATUS current
471 DESCRIPTION
472 "The Security Model to be used when generating SNMP
473 messages using this entry. An implementation may
474 choose to return an inconsistentValue error if an
475 attempt is made to set this variable to a value
476 for a security model which the implementation does
477 not support."
478 ::= { snmpTargetParamsEntry 3 }
479 snmpTargetParamsSecurityName OBJECT-TYPE
481 SYNTAX SnmpAdminString
482 MAX-ACCESS read-create
483 STATUS current
484 DESCRIPTION
485 "The securityName which identifies the Principal on
486 whose behalf SNMP messages will be generated using
487 this entry."
488 ::= { snmpTargetParamsEntry 4 }
489 snmpTargetParamsSecurityLevel OBJECT-TYPE
491 SYNTAX SnmpSecurityLevel
492 MAX-ACCESS read-create
493 STATUS current
494 DESCRIPTION
495 "The Level of Security to be used when generating
496 SNMP messages using this entry."
497 ::= { snmpTargetParamsEntry 5 }
498 snmpTargetParamsStorageType OBJECT-TYPE
500 SYNTAX StorageType
501 MAX-ACCESS read-create
502 STATUS current
503 DESCRIPTION
504 "The storage type for this conceptual row."
505 DEFVAL { nonVolatile }
506 ::= { snmpTargetParamsEntry 6 }
507 snmpTargetParamsRowStatus OBJECT-TYPE
509 SYNTAX RowStatus
510 MAX-ACCESS read-create
511 STATUS current
512 DESCRIPTION
513 "The status of this conceptual row.
514 To create a row in this table, a manager must
516 set this object to either createAndGo(4) or
517 createAndWait(5).
518 Until instances of all corresponding columns are
520 appropriately configured, the value of the
521 corresponding instance of the snmpTargetParamsRowStatus
522 column is 'notReady'.
523 In particular, a newly created row cannot be made
525 active until the corresponding
526 snmpTargetParamsMPModel,
527 snmpTargetParamsSecurityModel,
528 snmpTargetParamsSecurityName,
529 and snmpTargetParamsSecurityLevel have all been set.
530 The following objects may not be modified while the
532 value of this object is active(1):
533 - snmpTargetParamsMPModel
534 - snmpTargetParamsSecurityModel
535 - snmpTargetParamsSecurityName
536 - snmpTargetParamsSecurityLevel
537 An attempt to set these objects while the value of
538 snmpTargetParamsRowStatus is active(1) will result in
539 an inconsistentValue error."
540 ::= { snmpTargetParamsEntry 7 }
541 snmpUnavailableContexts OBJECT-TYPE
543 SYNTAX Counter32
544 MAX-ACCESS read-only
545 STATUS current
546 DESCRIPTION
547 "The total number of packets received by the SNMP
548 engine which were dropped because the context
549 contained in the message was unavailable."
550 ::= { snmpTargetObjects 4 }
551 snmpUnknownContexts OBJECT-TYPE
553 SYNTAX Counter32
554 MAX-ACCESS read-only
555 STATUS current
556 DESCRIPTION
557 "The total number of packets received by the SNMP
558 engine which were dropped because the context
559 contained in the message was unknown."
560 ::= { snmpTargetObjects 5 }
561 --
563 --
564 -- Conformance information
565 --
566 --
567 snmpTargetCompliances OBJECT IDENTIFIER ::=
569 { snmpTargetConformance 1 }
570 snmpTargetGroups OBJECT IDENTIFIER ::=
571 { snmpTargetConformance 2 }
572 --
574 --
575 -- Compliance statements
576 --
577 --
578 snmpTargetCommandResponderCompliance MODULE-COMPLIANCE
579 STATUS current
580 DESCRIPTION
581 "The compliance statement for SNMP entities which include
582 a command responder application."
583 MODULE -- This Module
584 MANDATORY-GROUPS { snmpTargetCommandResponderGroup }
585 ::= { snmpTargetCompliances 1 }
586 snmpTargetBasicGroup OBJECT-GROUP
588 OBJECTS {
589 snmpTargetSpinLock,
590 snmpTargetAddrTDomain,
591 snmpTargetAddrTAddress,
592 snmpTargetAddrTagList,
593 snmpTargetAddrParams,
594 snmpTargetAddrStorageType,
595 snmpTargetAddrRowStatus,
596 snmpTargetParamsMPModel,
597 snmpTargetParamsSecurityModel,
598 snmpTargetParamsSecurityName,
599 snmpTargetParamsSecurityLevel,
600 snmpTargetParamsStorageType,
601 snmpTargetParamsRowStatus
602 }
603 STATUS current
604 DESCRIPTION
605 "A collection of objects providing basic remote
606 configuration of management targets."
607 ::= { snmpTargetGroups 1 }
608 snmpTargetResponseGroup OBJECT-GROUP
610 OBJECTS {
611 snmpTargetAddrTimeout,
612 snmpTargetAddrRetryCount
613 }
614 STATUS current
615 DESCRIPTION
616 "A collection of objects providing remote configuration
617 of management targets for applications which generate
618 SNMP messages for which a response message would be
619 expected."
620 ::= { snmpTargetGroups 2 }
621 snmpTargetCommandResponderGroup OBJECT-GROUP
623 OBJECTS {
624 snmpUnavailableContexts,
625 snmpUnknownContexts
626 }
627 STATUS current
628 DESCRIPTION
629 "A collection of objects required for command responder
630 applications, used for counting error conditions."
631 ::= { snmpTargetGroups 3 }
632 END
634Erlang/OTP SNMP SNMP-TARGET-MIB(7)