1 SNMP-TARGET-MIB DEFINITIONS ::= BEGIN
24 SnmpMessageProcessingModel,
27 FROM SNMP-FRAMEWORK-MIB
33 snmpTargetMIB MODULE-IDENTITY
34 LAST-UPDATED "200210140000Z"
35 ORGANIZATION "IETF SNMPv3 Working Group"
37 "WG-email: snmpv3@lists.tislabs.com
38 Subscribe: majordomo@lists.tislabs.com
39 In message body: subscribe snmpv3
42 Network Associates Laboratories
43 Postal: 15204 Omega Drive, Suite 300
44 Rockville, MD 20850-4601
46 EMail: mundy@tislabs.com
47 Phone: +1 301-947-7107
49 Co-Chair: David Harrington
51 Postal: 35 Industrial Way
53 Rochester, New Hampshire 03866-5005
55 EMail: dbh@enterasys.com
56 Phone: +1 603-337-2614
58 Co-editor: David B. Levi
60 Postal: 3505 Kesterwood Drive
61 Knoxville, Tennessee 37918
62 EMail: dlevi@nortelnetworks.com
63 Phone: +1 865 686 0432
66 Secure Computing Corporation
67 Postal: 2675 Long Lake Road
71 Roseville, Minnesota 55113
72 EMail: paul_meyer@securecomputing.com
73 Phone: +1 651 628 1592
75 Co-editor: Bob Stewart
78 "This MIB module defines MIB objects which provide
79 mechanisms to remotely configure the parameters used
80 by an SNMP entity for the generation of SNMP messages.
82 Copyright (C) The Internet Society (2002). This
83 version of this MIB module is part of RFC 3413;
84 see the RFC itself for full legal notices.
86 REVISION "200210140000Z" -- 14 October 2002
87 DESCRIPTION "Fixed DISPLAY-HINTS for UTF-8 strings, fixed hex
88 value of LF characters, clarified meaning of zero
89 length tag values, improved tag list examples.
90 Published as RFC 3413."
91 REVISION "199808040000Z" -- 4 August 1998
92 DESCRIPTION "Clarifications, published as
94 REVISION "199707140000Z" -- 14 July 1997
95 DESCRIPTION "The initial revision, published as RFC2273."
96 ::= { snmpModules 12 }
98 snmpTargetObjects OBJECT IDENTIFIER ::= { snmpTargetMIB 1 }
99 snmpTargetConformance OBJECT IDENTIFIER ::= { snmpTargetMIB 3 }
101 SnmpTagValue ::= TEXTUAL-CONVENTION
105 "An octet string containing a tag value.
106 Tag values are preferably in human-readable form.
108 To facilitate internationalization, this information
109 is represented using the ISO/IEC IS 10646-1 character
110 set, encoded as an octet string using the UTF-8
111 character encoding scheme described in RFC 2279.
113 Since additional code points are added by amendments
114 to the 10646 standard from time to time,
115 implementations must be prepared to encounter any code
116 point from 0x00000000 to 0x7fffffff.
118 The use of control codes should be avoided, and certain
122 control codes are not allowed as described below.
124 For code points not directly supported by user
125 interface hardware or software, an alternative means
126 of entry and display, such as hexadecimal, may be
129 For information encoded in 7-bit US-ASCII, the UTF-8
130 representation is identical to the US-ASCII encoding.
132 Note that when this TC is used for an object that
133 is used or envisioned to be used as an index, then a
134 SIZE restriction must be specified so that the number
135 of sub-identifiers for any object instance does not
136 exceed the limit of 128, as defined by [RFC1905].
138 An object of this type contains a single tag value
139 which is used to select a set of entries in a table.
141 A tag value is an arbitrary string of octets, but
142 may not contain a delimiter character. Delimiter
143 characters are defined to be one of the following:
145 - An ASCII space character (0x20).
147 - An ASCII TAB character (0x09).
149 - An ASCII carriage return (CR) character (0x0D).
151 - An ASCII line feed (LF) character (0x0A).
153 Delimiter characters are used to separate tag values
154 in a tag list. An object of this type may only
155 contain a single tag value, and so delimiter
156 characters are not allowed in a value of this type.
158 Note that a tag value of 0 length means that no tag is
159 defined. In other words, a tag value of 0 length would
160 never match anything in a tag list, and would never
161 select any table entries.
163 Some examples of valid tag values are:
173 The use of a tag value to select table entries is
174 application and MIB specific."
175 SYNTAX OCTET STRING (SIZE (0..255))
177 SnmpTagList ::= TEXTUAL-CONVENTION
181 "An octet string containing a list of tag values.
182 Tag values are preferably in human-readable form.
184 To facilitate internationalization, this information
185 is represented using the ISO/IEC IS 10646-1 character
186 set, encoded as an octet string using the UTF-8
187 character encoding scheme described in RFC 2279.
189 Since additional code points are added by amendments
190 to the 10646 standard from time to time,
191 implementations must be prepared to encounter any code
192 point from 0x00000000 to 0x7fffffff.
194 The use of control codes should be avoided, except as
197 For code points not directly supported by user
198 interface hardware or software, an alternative means
199 of entry and display, such as hexadecimal, may be
202 For information encoded in 7-bit US-ASCII, the UTF-8
203 representation is identical to the US-ASCII encoding.
205 An object of this type contains a list of tag values
206 which are used to select a set of entries in a table.
208 A tag value is an arbitrary string of octets, but
209 may not contain a delimiter character. Delimiter
210 characters are defined to be one of the following:
212 - An ASCII space character (0x20).
214 - An ASCII TAB character (0x09).
216 - An ASCII carriage return (CR) character (0x0D).
218 - An ASCII line feed (LF) character (0x0A).
220 Delimiter characters are used to separate tag values
224 in a tag list. Only a single delimiter character may
225 occur between two tag values. A tag value may not
226 have a zero length. These constraints imply certain
227 restrictions on the contents of this object:
229 - There cannot be a leading or trailing delimiter
232 - There cannot be multiple adjacent delimiter
235 Some examples of valid tag lists are:
237 - '' -- an empty list
239 - 'acme' -- list of one tag
241 - 'host router bridge' -- list of several tags
243 Note that although a tag value may not have a length of
244 zero, an empty string is still valid. This indicates
245 an empty list (i.e. there are no tag values in the list).
247 The use of the tag list to select table entries is
248 application and MIB specific. Typically, an application
249 will provide one or more tag values, and any entry
250 which contains some combination of these tag values
252 SYNTAX OCTET STRING (SIZE (0..255))
256 -- The snmpTargetObjects group
260 snmpTargetSpinLock OBJECT-TYPE
262 MAX-ACCESS read-write
265 "This object is used to facilitate modification of table
266 entries in the SNMP-TARGET-MIB module by multiple
267 managers. In particular, it is useful when modifying
268 the value of the snmpTargetAddrTagList object.
270 The procedure for modifying the snmpTargetAddrTagList
271 object is as follows:
275 1. Retrieve the value of snmpTargetSpinLock and
276 of snmpTargetAddrTagList.
278 2. Generate a new value for snmpTargetAddrTagList.
280 3. Set the value of snmpTargetSpinLock to the
281 retrieved value, and the value of
282 snmpTargetAddrTagList to the new value. If
283 the set fails for the snmpTargetSpinLock
284 object, go back to step 1."
285 ::= { snmpTargetObjects 1 }
287 snmpTargetAddrTable OBJECT-TYPE
288 SYNTAX SEQUENCE OF SnmpTargetAddrEntry
289 MAX-ACCESS not-accessible
292 "A table of transport addresses to be used in the generation
294 ::= { snmpTargetObjects 2 }
296 snmpTargetAddrEntry OBJECT-TYPE
297 SYNTAX SnmpTargetAddrEntry
298 MAX-ACCESS not-accessible
301 "A transport address to be used in the generation
304 Entries in the snmpTargetAddrTable are created and
305 deleted using the snmpTargetAddrRowStatus object."
306 INDEX { IMPLIED snmpTargetAddrName }
307 ::= { snmpTargetAddrTable 1 }
309 SnmpTargetAddrEntry ::= SEQUENCE {
310 snmpTargetAddrName SnmpAdminString,
311 snmpTargetAddrTDomain TDomain,
312 snmpTargetAddrTAddress TAddress,
313 snmpTargetAddrTimeout TimeInterval,
314 snmpTargetAddrRetryCount Integer32,
315 snmpTargetAddrTagList SnmpTagList,
316 snmpTargetAddrParams SnmpAdminString,
317 snmpTargetAddrStorageType StorageType,
318 snmpTargetAddrRowStatus RowStatus
321 snmpTargetAddrName OBJECT-TYPE
322 SYNTAX SnmpAdminString (SIZE(1..32))
326 MAX-ACCESS not-accessible
329 "The locally arbitrary, but unique identifier associated
330 with this snmpTargetAddrEntry."
331 ::= { snmpTargetAddrEntry 1 }
333 snmpTargetAddrTDomain OBJECT-TYPE
335 MAX-ACCESS read-create
338 "This object indicates the transport type of the address
339 contained in the snmpTargetAddrTAddress object."
340 ::= { snmpTargetAddrEntry 2 }
342 snmpTargetAddrTAddress OBJECT-TYPE
344 MAX-ACCESS read-create
347 "This object contains a transport address. The format of
348 this address depends on the value of the
349 snmpTargetAddrTDomain object."
350 ::= { snmpTargetAddrEntry 3 }
352 snmpTargetAddrTimeout OBJECT-TYPE
354 MAX-ACCESS read-create
357 "This object should reflect the expected maximum round
358 trip time for communicating with the transport address
359 defined by this row. When a message is sent to this
360 address, and a response (if one is expected) is not
361 received within this time period, an implementation
362 may assume that the response will not be delivered.
364 Note that the time interval that an application waits
365 for a response may actually be derived from the value
366 of this object. The method for deriving the actual time
367 interval is implementation dependent. One such method
368 is to derive the expected round trip time based on a
369 particular retransmission algorithm and on the number
370 of timeouts which have occurred. The type of message may
371 also be considered when deriving expected round trip
372 times for retransmissions. For example, if a message is
373 being sent with a securityLevel that indicates both
377 authentication and privacy, the derived value may be
378 increased to compensate for extra processing time spent
379 during authentication and encryption processing."
381 ::= { snmpTargetAddrEntry 4 }
383 snmpTargetAddrRetryCount OBJECT-TYPE
384 SYNTAX Integer32 (0..255)
385 MAX-ACCESS read-create
388 "This object specifies a default number of retries to be
389 attempted when a response is not received for a generated
390 message. An application may provide its own retry count,
391 in which case the value of this object is ignored."
393 ::= { snmpTargetAddrEntry 5 }
395 snmpTargetAddrTagList OBJECT-TYPE
397 MAX-ACCESS read-create
400 "This object contains a list of tag values which are
401 used to select target addresses for a particular
404 ::= { snmpTargetAddrEntry 6 }
406 snmpTargetAddrParams OBJECT-TYPE
407 SYNTAX SnmpAdminString (SIZE(1..32))
408 MAX-ACCESS read-create
411 "The value of this object identifies an entry in the
412 snmpTargetParamsTable. The identified entry
413 contains SNMP parameters to be used when generating
414 messages to be sent to this transport address."
415 ::= { snmpTargetAddrEntry 7 }
417 snmpTargetAddrStorageType OBJECT-TYPE
419 MAX-ACCESS read-create
422 "The storage type for this conceptual row.
423 Conceptual rows having the value 'permanent' need not
424 allow write-access to any columnar objects in the row."
428 DEFVAL { nonVolatile }
429 ::= { snmpTargetAddrEntry 8 }
431 snmpTargetAddrRowStatus OBJECT-TYPE
433 MAX-ACCESS read-create
436 "The status of this conceptual row.
438 To create a row in this table, a manager must
439 set this object to either createAndGo(4) or
442 Until instances of all corresponding columns are
443 appropriately configured, the value of the
444 corresponding instance of the snmpTargetAddrRowStatus
445 column is 'notReady'.
447 In particular, a newly created row cannot be made
448 active until the corresponding instances of
449 snmpTargetAddrTDomain, snmpTargetAddrTAddress, and
450 snmpTargetAddrParams have all been set.
452 The following objects may not be modified while the
453 value of this object is active(1):
454 - snmpTargetAddrTDomain
455 - snmpTargetAddrTAddress
456 An attempt to set these objects while the value of
457 snmpTargetAddrRowStatus is active(1) will result in
458 an inconsistentValue error."
459 ::= { snmpTargetAddrEntry 9 }
461 snmpTargetParamsTable OBJECT-TYPE
462 SYNTAX SEQUENCE OF SnmpTargetParamsEntry
463 MAX-ACCESS not-accessible
466 "A table of SNMP target information to be used
467 in the generation of SNMP messages."
468 ::= { snmpTargetObjects 3 }
470 snmpTargetParamsEntry OBJECT-TYPE
471 SYNTAX SnmpTargetParamsEntry
472 MAX-ACCESS not-accessible
475 "A set of SNMP target information.
479 Entries in the snmpTargetParamsTable are created and
480 deleted using the snmpTargetParamsRowStatus object."
481 INDEX { IMPLIED snmpTargetParamsName }
482 ::= { snmpTargetParamsTable 1 }
484 SnmpTargetParamsEntry ::= SEQUENCE {
485 snmpTargetParamsName SnmpAdminString,
486 snmpTargetParamsMPModel SnmpMessageProcessingModel,
487 snmpTargetParamsSecurityModel SnmpSecurityModel,
488 snmpTargetParamsSecurityName SnmpAdminString,
489 snmpTargetParamsSecurityLevel SnmpSecurityLevel,
490 snmpTargetParamsStorageType StorageType,
491 snmpTargetParamsRowStatus RowStatus
494 snmpTargetParamsName OBJECT-TYPE
495 SYNTAX SnmpAdminString (SIZE(1..32))
496 MAX-ACCESS not-accessible
499 "The locally arbitrary, but unique identifier associated
500 with this snmpTargetParamsEntry."
501 ::= { snmpTargetParamsEntry 1 }
503 snmpTargetParamsMPModel OBJECT-TYPE
504 SYNTAX SnmpMessageProcessingModel
505 MAX-ACCESS read-create
508 "The Message Processing Model to be used when generating
509 SNMP messages using this entry."
510 ::= { snmpTargetParamsEntry 2 }
512 snmpTargetParamsSecurityModel OBJECT-TYPE
513 SYNTAX SnmpSecurityModel (1..2147483647)
514 MAX-ACCESS read-create
517 "The Security Model to be used when generating SNMP
518 messages using this entry. An implementation may
519 choose to return an inconsistentValue error if an
520 attempt is made to set this variable to a value
521 for a security model which the implementation does
523 ::= { snmpTargetParamsEntry 3 }
525 snmpTargetParamsSecurityName OBJECT-TYPE
526 SYNTAX SnmpAdminString
530 MAX-ACCESS read-create
533 "The securityName which identifies the Principal on
534 whose behalf SNMP messages will be generated using
536 ::= { snmpTargetParamsEntry 4 }
538 snmpTargetParamsSecurityLevel OBJECT-TYPE
539 SYNTAX SnmpSecurityLevel
540 MAX-ACCESS read-create
543 "The Level of Security to be used when generating
544 SNMP messages using this entry."
545 ::= { snmpTargetParamsEntry 5 }
547 snmpTargetParamsStorageType OBJECT-TYPE
549 MAX-ACCESS read-create
552 "The storage type for this conceptual row.
553 Conceptual rows having the value 'permanent' need not
554 allow write-access to any columnar objects in the row."
555 DEFVAL { nonVolatile }
556 ::= { snmpTargetParamsEntry 6 }
558 snmpTargetParamsRowStatus OBJECT-TYPE
560 MAX-ACCESS read-create
563 "The status of this conceptual row.
565 To create a row in this table, a manager must
566 set this object to either createAndGo(4) or
569 Until instances of all corresponding columns are
570 appropriately configured, the value of the
571 corresponding instance of the snmpTargetParamsRowStatus
572 column is 'notReady'.
574 In particular, a newly created row cannot be made
575 active until the corresponding
576 snmpTargetParamsMPModel,
577 snmpTargetParamsSecurityModel,
581 snmpTargetParamsSecurityName,
582 and snmpTargetParamsSecurityLevel have all been set.
584 The following objects may not be modified while the
585 value of this object is active(1):
586 - snmpTargetParamsMPModel
587 - snmpTargetParamsSecurityModel
588 - snmpTargetParamsSecurityName
589 - snmpTargetParamsSecurityLevel
590 An attempt to set these objects while the value of
591 snmpTargetParamsRowStatus is active(1) will result in
592 an inconsistentValue error."
593 ::= { snmpTargetParamsEntry 7 }
595 snmpUnavailableContexts OBJECT-TYPE
600 "The total number of packets received by the SNMP
601 engine which were dropped because the context
602 contained in the message was unavailable."
603 ::= { snmpTargetObjects 4 }
605 snmpUnknownContexts OBJECT-TYPE
610 "The total number of packets received by the SNMP
611 engine which were dropped because the context
612 contained in the message was unknown."
613 ::= { snmpTargetObjects 5 }
617 -- Conformance information
621 snmpTargetCompliances OBJECT IDENTIFIER ::=
622 { snmpTargetConformance 1 }
623 snmpTargetGroups OBJECT IDENTIFIER ::=
624 { snmpTargetConformance 2 }
628 -- Compliance statements
635 snmpTargetCommandResponderCompliance MODULE-COMPLIANCE
638 "The compliance statement for SNMP entities which include
639 a command responder application."
640 MODULE -- This Module
641 MANDATORY-GROUPS { snmpTargetCommandResponderGroup }
642 ::= { snmpTargetCompliances 1 }
644 snmpTargetBasicGroup OBJECT-GROUP
647 snmpTargetAddrTDomain,
648 snmpTargetAddrTAddress,
649 snmpTargetAddrTagList,
650 snmpTargetAddrParams,
651 snmpTargetAddrStorageType,
652 snmpTargetAddrRowStatus,
653 snmpTargetParamsMPModel,
654 snmpTargetParamsSecurityModel,
655 snmpTargetParamsSecurityName,
656 snmpTargetParamsSecurityLevel,
657 snmpTargetParamsStorageType,
658 snmpTargetParamsRowStatus
662 "A collection of objects providing basic remote
663 configuration of management targets."
664 ::= { snmpTargetGroups 1 }
666 snmpTargetResponseGroup OBJECT-GROUP
668 snmpTargetAddrTimeout,
669 snmpTargetAddrRetryCount
673 "A collection of objects providing remote configuration
674 of management targets for applications which generate
675 SNMP messages for which a response message would be
677 ::= { snmpTargetGroups 2 }
679 snmpTargetCommandResponderGroup OBJECT-GROUP
684 snmpUnavailableContexts,
689 "A collection of objects required for command responder
690 applications, used for counting error conditions."
691 ::= { snmpTargetGroups 3 }