1 DISMAN-SCHEDULE-MIB DEFINITIONS ::= BEGIN
4 MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
5 Integer32, Unsigned32, Counter32, mib-2, zeroDotZero
9 DateAndTime, RowStatus, StorageType, VariablePointer
12 MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
16 FROM SNMP-FRAMEWORK-MIB;
18 schedMIB MODULE-IDENTITY
19 LAST-UPDATED "200201070000Z"
20 ORGANIZATION "IETF Distributed Management Working Group"
22 "WG EMail: disman@dorothy.bmc.com
23 Subscribe: disman-request@dorothy.bmc.com
28 2141 North First Street
29 San Jose, California 95131
31 EMail: rpresuhn@bmc.com
32 Phone: +1 408 546-1006
36 Postal: 4401 Great America Parkway
37 Santa Clara, CA 95052-8185
39 EMail: dlevi@nortelnetworks.com
40 Phone: +1 865 686 0432
44 Editor: Juergen Schoenwaelder
46 Postal: Bueltenweg 74/75
49 EMail: schoenw@ibr.cs.tu-bs.de
50 Phone: +49 531 391-3283"
52 "This MIB module defines a MIB which provides mechanisms to
53 schedule SNMP set operations periodically or at specific
55 REVISION "200201070000Z"
57 "Revised version, published as RFC 3231.
59 This revision introduces a new object type called
60 schedTriggers. Created new conformance and compliance
61 statements that take care of the new schedTriggers object.
63 Several clarifications have been added to remove ambiguities
64 that were discovered and reported by implementors."
65 REVISION "199811171800Z"
67 "Initial version, published as RFC 2591."
71 -- The various groups defined within this MIB definition:
74 schedObjects OBJECT IDENTIFIER ::= { schedMIB 1 }
75 schedNotifications OBJECT IDENTIFIER ::= { schedMIB 2 }
76 schedConformance OBJECT IDENTIFIER ::= { schedMIB 3 }
79 -- Textual Conventions:
82 SnmpPduErrorStatus ::= TEXTUAL-CONVENTION
85 "This TC enumerates the SNMPv1 and SNMPv2 PDU error status
86 codes as defined in RFC 1157 and RFC 1905. It also adds a
87 pseudo error status code `noResponse' which indicates a
105 inconsistentValue(12),
106 resourceUnavailable(13),
109 authorizationError(16),
115 -- Some scalars which provide information about the local time zone.
118 schedLocalTime OBJECT-TYPE
119 SYNTAX DateAndTime (SIZE (11))
123 "The local time used by the scheduler. Schedules which
124 refer to calendar time will use the local time indicated
125 by this object. An implementation MUST return all 11 bytes
126 of the DateAndTime textual-convention so that a manager
127 may retrieve the offset from GMT time."
128 ::= { schedObjects 1 }
131 -- The schedule table which controls the scheduler.
134 schedTable OBJECT-TYPE
135 SYNTAX SEQUENCE OF SchedEntry
136 MAX-ACCESS not-accessible
139 "This table defines scheduled actions triggered by
140 SNMP set operations."
141 ::= { schedObjects 2 }
144 schedEntry OBJECT-TYPE
146 MAX-ACCESS not-accessible
149 "An entry describing a particular scheduled action.
151 Unless noted otherwise, writable objects of this row
152 can be modified independent of the current value of
153 schedRowStatus, schedAdminStatus and schedOperStatus.
154 In particular, it is legal to modify schedInterval
155 and the objects in the schedCalendarGroup when
156 schedRowStatus is active and schedAdminStatus and
157 schedOperStatus are both enabled."
158 INDEX { schedOwner, schedName }
161 SchedEntry ::= SEQUENCE {
162 schedOwner SnmpAdminString,
163 schedName SnmpAdminString,
164 schedDescr SnmpAdminString,
165 schedInterval Unsigned32,
171 schedContextName SnmpAdminString,
172 schedVariable VariablePointer,
173 schedValue Integer32,
175 schedAdminStatus INTEGER,
176 schedOperStatus INTEGER,
177 schedFailures Counter32,
178 schedLastFailure SnmpPduErrorStatus,
179 schedLastFailed DateAndTime,
180 schedStorageType StorageType,
181 schedRowStatus RowStatus,
182 schedTriggers Counter32
185 schedOwner OBJECT-TYPE
186 SYNTAX SnmpAdminString (SIZE(0..32))
187 MAX-ACCESS not-accessible
190 "The owner of this scheduling entry. The exact semantics of
191 this string are subject to the security policy defined by
194 the security administrator."
197 schedName OBJECT-TYPE
198 SYNTAX SnmpAdminString (SIZE(1..32))
199 MAX-ACCESS not-accessible
202 "The locally-unique, administratively assigned name for this
203 scheduling entry. This object allows a schedOwner to have
204 multiple entries in the schedTable."
207 schedDescr OBJECT-TYPE
208 SYNTAX SnmpAdminString
209 MAX-ACCESS read-create
212 "The human readable description of the purpose of this
217 schedInterval OBJECT-TYPE
220 MAX-ACCESS read-create
223 "The number of seconds between two action invocations of
224 a periodic scheduler. Implementations must guarantee
225 that action invocations will not occur before at least
226 schedInterval seconds have passed.
228 The scheduler must ignore all periodic schedules that
229 have a schedInterval value of 0. A periodic schedule
230 with a scheduling interval of 0 seconds will therefore
231 never invoke an action.
233 Implementations may be forced to delay invocations in the
234 face of local constraints. A scheduled management function
235 should therefore not rely on the accuracy provided by the
236 scheduler implementation.
238 Note that implementations which maintain a list of pending
239 activations must re-calculate them when this object is
246 schedWeekDay OBJECT-TYPE
256 MAX-ACCESS read-create
259 "The set of weekdays on which the scheduled action should
260 take place. Setting multiple bits will include several
261 weekdays in the set of possible weekdays for this schedule.
262 Setting all bits will cause the scheduler to ignore the
265 Note that implementations which maintain a list of pending
266 activations must re-calculate them when this object is
271 schedMonth OBJECT-TYPE
286 MAX-ACCESS read-create
289 "The set of months during which the scheduled action should
290 take place. Setting multiple bits will include several
291 months in the set of possible months for this schedule.
294 Setting all bits will cause the scheduler to ignore the
297 Note that implementations which maintain a list of pending
298 activations must re-calculate them when this object is
305 d1(0), d2(1), d3(2), d4(3), d5(4),
306 d6(5), d7(6), d8(7), d9(8), d10(9),
307 d11(10), d12(11), d13(12), d14(13), d15(14),
308 d16(15), d17(16), d18(17), d19(18), d20(19),
309 d21(20), d22(21), d23(22), d24(23), d25(24),
310 d26(25), d27(26), d28(27), d29(28), d30(29),
312 r1(31), r2(32), r3(33), r4(34), r5(35),
313 r6(36), r7(37), r8(38), r9(39), r10(40),
314 r11(41), r12(42), r13(43), r14(44), r15(45),
315 r16(46), r17(47), r18(48), r19(49), r20(50),
316 r21(51), r22(52), r23(53), r24(54), r25(55),
317 r26(56), r27(57), r28(58), r29(59), r30(60),
320 MAX-ACCESS read-create
323 "The set of days in a month on which a scheduled action
324 should take place. There are two sets of bits one can
325 use to define the day within a month:
327 Enumerations starting with the letter 'd' indicate a
328 day in a month relative to the first day of a month.
329 The first day of the month can therefore be specified
330 by setting the bit d1(0) and d31(30) means the last
331 day of a month with 31 days.
333 Enumerations starting with the letter 'r' indicate a
334 day in a month in reverse order, relative to the last
335 day of a month. The last day in the month can therefore
336 be specified by setting the bit r1(31) and r31(61) means
337 the first day of a month with 31 days.
339 Setting multiple bits will include several days in the set
340 of possible days for this schedule. Setting all bits will
341 cause the scheduler to ignore the day within a month.
344 Setting all bits starting with the letter 'd' or the
345 letter 'r' will also cause the scheduler to ignore the
348 Note that implementations which maintain a list of pending
349 activations must re-calculate them when this object is
354 schedHour OBJECT-TYPE
356 h0(0), h1(1), h2(2), h3(3), h4(4),
357 h5(5), h6(6), h7(7), h8(8), h9(9),
358 h10(10), h11(11), h12(12), h13(13), h14(14),
359 h15(15), h16(16), h17(17), h18(18), h19(19),
360 h20(20), h21(21), h22(22), h23(23)
362 MAX-ACCESS read-create
365 "The set of hours within a day during which the scheduled
366 action should take place.
368 Note that implementations which maintain a list of pending
369 activations must re-calculate them when this object is
374 schedMinute OBJECT-TYPE
376 m0(0), m1(1), m2(2), m3(3), m4(4),
377 m5(5), m6(6), m7(7), m8(8), m9(9),
378 m10(10), m11(11), m12(12), m13(13), m14(14),
379 m15(15), m16(16), m17(17), m18(18), m19(19),
380 m20(20), m21(21), m22(22), m23(23), m24(24),
381 m25(25), m26(26), m27(27), m28(28), m29(29),
382 m30(30), m31(31), m32(32), m33(33), m34(34),
383 m35(35), m36(36), m37(37), m38(38), m39(39),
384 m40(40), m41(41), m42(42), m43(43), m44(44),
385 m45(45), m46(46), m47(47), m48(48), m49(49),
386 m50(50), m51(51), m52(52), m53(53), m54(54),
387 m55(55), m56(56), m57(57), m58(58), m59(59)
389 MAX-ACCESS read-create
394 "The set of minutes within an hour when the scheduled action
397 Note that implementations which maintain a list of pending
398 activations must re-calculate them when this object is
403 schedContextName OBJECT-TYPE
404 SYNTAX SnmpAdminString (SIZE(0..32))
405 MAX-ACCESS read-create
408 "The context which contains the local MIB variable pointed
409 to by schedVariable."
411 ::= { schedEntry 10 }
413 schedVariable OBJECT-TYPE
414 SYNTAX VariablePointer
415 MAX-ACCESS read-create
418 "An object identifier pointing to a local MIB variable
419 which resolves to an ASN.1 primitive type of INTEGER."
420 DEFVAL { zeroDotZero }
421 ::= { schedEntry 11 }
423 schedValue OBJECT-TYPE
425 MAX-ACCESS read-create
428 "The value which is written to the MIB object pointed to by
429 schedVariable when the scheduler invokes an action. The
430 implementation shall enforce the use of access control
431 rules when performing the set operation on schedVariable.
432 This is accomplished by calling the isAccessAllowed abstract
433 service interface as defined in RFC 2571.
435 Note that an implementation may choose to issue an SNMP Set
436 message to the SNMP engine and leave the access control
437 decision to the normal message processing procedure."
439 ::= { schedEntry 12 }
441 schedType OBJECT-TYPE
449 MAX-ACCESS read-create
452 "The type of this schedule. The value periodic(1) indicates
453 that this entry specifies a periodic schedule. A periodic
454 schedule is defined by the value of schedInterval. The
455 values of schedWeekDay, schedMonth, schedDay, schedHour
456 and schedMinute are ignored.
458 The value calendar(2) indicates that this entry describes a
459 calendar schedule. A calendar schedule is defined by the
460 values of schedWeekDay, schedMonth, schedDay, schedHour and
461 schedMinute. The value of schedInterval is ignored. A
462 calendar schedule will trigger on all local times that
463 satisfy the bits set in schedWeekDay, schedMonth, schedDay,
464 schedHour and schedMinute.
466 The value oneshot(3) indicates that this entry describes a
467 one-shot schedule. A one-shot schedule is similar to a
468 calendar schedule with the additional feature that it
469 disables itself by changing in the `finished'
470 schedOperStatus once the schedule triggers an action.
472 Note that implementations which maintain a list of pending
473 activations must re-calculate them when this object is
476 ::= { schedEntry 13 }
478 schedAdminStatus OBJECT-TYPE
483 MAX-ACCESS read-create
486 "The desired state of the schedule."
488 ::= { schedEntry 14 }
490 schedOperStatus OBJECT-TYPE
501 "The current operational state of this schedule. The state
502 enabled(1) indicates this entry is active and that the
503 scheduler will invoke actions at appropriate times. The
504 disabled(2) state indicates that this entry is currently
505 inactive and ignored by the scheduler. The finished(3)
506 state indicates that the schedule has ended. Schedules
507 in the finished(3) state are ignored by the scheduler.
508 A one-shot schedule enters the finished(3) state when it
511 Note that the operational state must not be enabled(1)
512 when the schedRowStatus is not active."
513 ::= { schedEntry 15 }
515 schedFailures OBJECT-TYPE
520 "This variable counts the number of failures while invoking
521 the scheduled action. This counter at most increments once
522 for a triggered action."
523 ::= { schedEntry 16 }
525 schedLastFailure OBJECT-TYPE
526 SYNTAX SnmpPduErrorStatus
530 "The most recent error that occurred during the invocation of
531 a scheduled action. The value noError(0) is returned
532 if no errors have occurred yet."
534 ::= { schedEntry 17 }
536 schedLastFailed OBJECT-TYPE
541 "The date and time when the most recent failure occurred.
544 The value '0000000000000000'H is returned if no failure
545 occurred since the last re-initialization of the scheduler."
546 DEFVAL { '0000000000000000'H }
547 ::= { schedEntry 18 }
549 schedStorageType OBJECT-TYPE
551 MAX-ACCESS read-create
554 "This object defines whether this scheduled action is kept
555 in volatile storage and lost upon reboot or if this row is
556 backed up by non-volatile or permanent storage.
558 Conceptual rows having the value `permanent' must allow
559 write access to the columnar objects schedDescr,
560 schedInterval, schedContextName, schedVariable, schedValue,
561 and schedAdminStatus. If an implementation supports the
562 schedCalendarGroup, write access must be also allowed to
563 the columnar objects schedWeekDay, schedMonth, schedDay,
564 schedHour, schedMinute."
566 ::= { schedEntry 19 }
568 schedRowStatus OBJECT-TYPE
570 MAX-ACCESS read-create
573 "The status of this scheduled action. A control that allows
574 entries to be added and removed from this table.
576 Note that the operational state must change to enabled
577 when the administrative state is enabled and the row
578 status changes to active(1).
580 Attempts to destroy(6) a row or to set a row
581 notInService(2) while the operational state is enabled
582 result in inconsistentValue errors.
584 The value of this object has no effect on whether other
585 objects in this conceptual row can be modified."
586 ::= { schedEntry 20 }
588 schedTriggers OBJECT-TYPE
595 "This variable counts the number of attempts (either
596 successful or failed) to invoke the scheduled action."
597 ::= { schedEntry 21 }
600 -- Notifications that are emitted to indicate failures. The
601 -- definition of schedTraps makes notification registrations
602 -- reversible (see STD 58, RFC 2578).
605 schedTraps OBJECT IDENTIFIER ::= { schedNotifications 0 }
607 schedActionFailure NOTIFICATION-TYPE
608 OBJECTS { schedLastFailure, schedLastFailed }
611 "This notification is generated whenever the invocation of a
612 scheduled action fails."
615 -- conformance information
617 schedCompliances OBJECT IDENTIFIER ::= { schedConformance 1 }
618 schedGroups OBJECT IDENTIFIER ::= { schedConformance 2 }
620 -- compliance statements
622 schedCompliance2 MODULE-COMPLIANCE
625 "The compliance statement for SNMP entities which implement
627 MODULE -- this module
629 schedGroup2, schedNotificationsGroup
631 GROUP schedCalendarGroup
633 "The schedCalendarGroup is mandatory only for those
634 implementations that support calendar based schedules."
637 "The values calendar(2) or oneshot(3) are not valid for
638 implementations that do not implement the
639 schedCalendarGroup. Such an implementation must return
640 inconsistentValue error responses for attempts to set
641 schedAdminStatus to calendar(2) or oneshot(3)."
644 ::= { schedCompliances 2 }
646 schedGroup2 OBJECT-GROUP
648 schedDescr, schedInterval, schedContextName,
649 schedVariable, schedValue, schedType,
650 schedAdminStatus, schedOperStatus, schedFailures,
651 schedLastFailure, schedLastFailed, schedStorageType,
652 schedRowStatus, schedTriggers
656 "A collection of objects providing scheduling capabilities."
657 ::= { schedGroups 4 }
659 schedCalendarGroup OBJECT-GROUP
661 schedLocalTime, schedWeekDay, schedMonth,
662 schedDay, schedHour, schedMinute
666 "A collection of objects providing calendar based schedules."
667 ::= { schedGroups 2 }
669 schedNotificationsGroup NOTIFICATION-GROUP
675 "The notifications emitted by the scheduler."
676 ::= { schedGroups 3 }
679 -- Deprecated compliance and conformance group definitions
683 schedCompliance MODULE-COMPLIANCE
686 "The compliance statement for SNMP entities which implement
688 MODULE -- this module
690 schedGroup, schedNotificationsGroup
694 GROUP schedCalendarGroup
696 "The schedCalendarGroup is mandatory only for those
697 implementations that support calendar based schedules."
700 "The values calendar(2) or oneshot(3) are not valid for
701 implementations that do not implement the
702 schedCalendarGroup. Such an implementation must return
703 inconsistentValue error responses for attempts to set
704 schedAdminStatus to calendar(2) or oneshot(3)."
705 ::= { schedCompliances 1 }
707 schedGroup OBJECT-GROUP
709 schedDescr, schedInterval, schedContextName,
710 schedVariable, schedValue, schedType,
711 schedAdminStatus, schedOperStatus, schedFailures,
712 schedLastFailure, schedLastFailed, schedStorageType,
717 "A collection of objects providing scheduling capabilities."
718 ::= { schedGroups 1 }