Internet-Draft Schedule MIB July 1998
Definitions of Managed Objects for
Scheduling Management Operations
July 17, 1998
<draft-ietf-disman-schedule-mib-04.txt>
David B. Levi
SNMP Research, Inc.
levi@snmp.com
Juergen Schoenwaelder
TU Braunschweig
schoenw@ibr.cs.tu-bs.de
Status of this Memo
This document is an Internet-Draft. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas,
and its working groups. Note that other groups may also distribute
working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as ``work in progress.''
To view the entire list of current Internet-Drafts, please check the
"1id-abstracts.txt" listing contained in the Internet-Drafts Shadow
Directories on ftp.is.co.za (Africa), ftp.nordu.net (Northern
Europe), ftp.nis.garr.it (Southern Europe), munnari.oz.au (Pacific
Rim), ftp.ietf.org (US East Coast), or ftp.isi.edu (US West Coast).
Distribution of this document is unlimited. Please send comments to
the Distributed Management Working Group, <disman@nexen.com>.
Copyright Notice
Copyright (C) The Internet Society (1998). All Rights Reserved.
Expires December 1998 [Page 1]
Internet-Draft Schedule MIB July 1998
1. Abstract
This memo defines an experimental portion of the Management
Information Base (MIB) for use with network management protocols in
the Internet community. In particular, it describes a set of managed
objects that are used to schedule management operations periodically
or at specified dates and times.
This memo does not specify a standard for the Internet community.
2. The SNMP Management Framework
The SNMP Management Framework presently consists of five major
components:
o An overall architecture, described in RFC 2271 [1].
o Mechanisms for describing and naming objects and events for the
purpose of management. The first version of this Structure of
Management Information (SMI) is called SMIv1 and described in
RFC 1155 [2], RFC 1212 [3] and RFC 1215 [4]. The second version,
called SMIv2, is described in RFC 1902 [5], RFC 1903 [6] and RFC
1904 [7].
o Message protocols for transferring management information. The
first version of the SNMP message protocol is called SNMPv1 and
described in RFC 1157 [8]. A second version of the SNMP message
protocol, which is not an Internet standards track protocol, is
called SNMPv2c and described in RFC 1901 [9] and RFC 1906 [10].
The third version of the message protocol is called SNMPv3 and
described in RFC 1906 [10], RFC 2272 [11] and RFC 2274 [12].
o Protocol operations for accessing management information. The
first set of protocol operations and associated PDU formats is
described in RFC 1157 [8]. A second set of protocol operations
and associated PDU formats is described in RFC 1905 [13].
o A set of fundamental applications described in RFC 2273 [14] and
the view-based access control mechanism described in RFC 2275
[15].
Managed objects are accessed via a virtual information store, termed
the Management Information Base or MIB. Objects in the MIB are
defined using the mechanisms defined in the SMI.
This memo specifies a MIB module that is compliant to the SMIv2. A
Expires December 1998 [Page 2]
Internet-Draft Schedule MIB July 1998
MIB conforming to the SMIv1 can be produced through the appropriate
translations. The resulting translated MIB must be semantically
equivalent, except where objects or events are omitted because no
translation is possible (use of Counter64). Some machine readable
information in SMIv2 will be converted into textual descriptions in
SMIv1 during the translation process. However, this loss of machine
readable information is not considered to change the semantics of the
MIB.
3. Overview
The MIB defined in this memo provides scheduling of actions
periodically or at specified dates and times. The actions can be used
to realize on-duty / off-duty schedules or to trigger management
functions in a DISMAN application.
Schedules can be enabled or disabled by modifying a control object.
This allows pre-configured schedules which are activated or de-
activated by some other management functions.
3.1. Periodic Schedules
Periodic schedules are based on fixed time periods between the
initiation of scheduled actions. Periodic schedules are defined by
specifying the number of seconds between two initiations. The time
needed to complete the action is usually not known by the scheduler
and does therefore not influence the next scheduling point.
Implementations must guarantee that action invocations will not occur
before their next scheduled time. However, implementations may be
forced to delay invocations in the face of local constraints (e.g., a
heavy load on higher-priority tasks). An accumulation of such delays
would result in a drift of the scheduling interval with respect to
time, and should be avoided.
Scheduled actions collecting statistical data should retrieve time
stamps from the data source and not rely on the accuracy of the
periodic scheduler in order to obtain accurate statistics.
3.2. Calendar Schedules
Calendar schedules trigger scheduled actions at specified dates and
times. Calendar schedules are therefore aware of the notion of
Expires December 1998 [Page 3]
Internet-Draft Schedule MIB July 1998
months, days, weekdays, hours and minutes.
It is possible to specify multiple values for each calendar item.
This provides a mechanism for defining complex schedules. For
example, a schedule could be defined which triggers an action every
15 minutes on a given weekday.
3.3. Actions
Scheduled actions are modeled by SNMP set operations on local MIB
variables. Scheduled actions described in this MIB are further
restricted to objects of type INTEGER. This restriction does not
limit the usefulness of the MIB. Simple schedules such as on-duty /
off-duty schedules for resources that have a status MIB object (e.g.
ifAdminStatus) are possible.
More complex actions can be realized by triggering a management
script which is responsible for performing complex state transitions.
A management script can also be used to perform SNMP set operations
on remote SNMP engines.
Expires December 1998 [Page 4]
Internet-Draft Schedule MIB July 1998
4. Definitions
DISMAN-SCHEDULE-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
Integer32, Unsigned32, Counter32, experimental
FROM SNMPv2-SMI
TEXTUAL-CONVENTION,
DateAndTime, RowStatus, StorageType, VariablePointer
FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
FROM SNMPv2-CONF
SnmpAdminString
FROM SNMP-FRAMEWORK-MIB;
schedMIB MODULE-IDENTITY
LAST-UPDATED "9807170000Z"
ORGANIZATION "IETF DISMAN Working Group"
CONTACT-INFO
"David B. Levi
SNMP Research, Inc.
3001 Kimberlin Heights Road
Knoxville, TN 37920-9716
U.S.A.
Tel: +1 423 573 1434
E-mail: levi@snmp.com
Juergen Schoenwaelder
TU Braunschweig
Bueltenweg 74/75
38106 Braunschweig
Germany
Tel: +49-531-391-3283
E-mail: schoenw@ibr.cs.tu-bs.de"
DESCRIPTION
"This MIB module defines a MIB which provides mechanisms to
schedule SNMP set operations periodically or at specific
points in time."
-- Get real registration number from IANA.
-- ::= { mib-2 XXXX }
::= { experimental 6789 }
--
Expires December 1998 [Page 5]
Internet-Draft Schedule MIB July 1998
-- The various groups defined within this MIB definition:
--
schedObjects OBJECT IDENTIFIER ::= { schedMIB 1 }
schedNotifications OBJECT IDENTIFIER ::= { schedMIB 2 }
schedConformance OBJECT IDENTIFIER ::= { schedMIB 3 }
--
-- Textual Conventions:
--
SnmpPduErrorStatus ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This TC enumerates the SNMPv1 and SNMPv2 PDU error status
codes as defined in RFC 1157 and RFC 1905. It also adds a
pseudo error status code `noResponse' which indicates a
timeout condition."
SYNTAX INTEGER {
noResponse(-1),
noError(0),
tooBig(1),
noSuchName(2),
badValue(3),
readOnly(4),
genErr(5),
noAccess(6),
wrongType(7),
wrongLength(8),
wrongEncoding(9),
wrongValue(10),
noCreation(11),
inconsistentValue(12),
resourceUnavailable(13),
commitFailed(14),
undoFailed(15),
authorizationError(16),
notWritable(17),
inconsistentName(18)
}
--
-- The schedule table which controls the scheduler.
--
schedTable OBJECT-TYPE
SYNTAX SEQUENCE OF SchedEntry
Expires December 1998 [Page 6]
Internet-Draft Schedule MIB July 1998
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table defines scheduled actions triggered by
SNMP set operations."
::= { schedObjects 1 }
schedEntry OBJECT-TYPE
SYNTAX SchedEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry describing a particular scheduled action."
INDEX { schedOwner, schedName }
::= { schedTable 1 }
SchedEntry ::= SEQUENCE {
schedOwner SnmpAdminString,
schedName SnmpAdminString,
schedDescr SnmpAdminString,
schedInterval Unsigned32,
schedWeekDay BITS,
schedMonth BITS,
schedDay BITS,
schedHour BITS,
schedMinute BITS,
schedContextName SnmpAdminString,
schedVariable VariablePointer,
schedValue Integer32,
schedAdminStatus INTEGER,
schedOperStatus INTEGER,
schedFailures Counter32,
schedLastFailure SnmpPduErrorStatus,
schedLastFailed DateAndTime,
schedStorageType StorageType,
schedRowStatus RowStatus
}
schedOwner OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE(0..32))
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The owner of this scheduling entry. The exact semantics of
this string are subject to the security policy defined by
the security administrator."
::= { schedEntry 1 }
Expires December 1998 [Page 7]
Internet-Draft Schedule MIB July 1998
schedName OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE(1..32))
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The locally-unique, administratively assigned name for this
scheduling entry. This object allows a schedOwner to have
multiple entries in the schedTable."
::= { schedEntry 2 }
schedDescr OBJECT-TYPE
SYNTAX SnmpAdminString
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The human readable description of the purpose of this
scheduling entry."
DEFVAL { ''H }
::= { schedEntry 3 }
schedInterval OBJECT-TYPE
SYNTAX Unsigned32
UNITS "seconds"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The number of seconds between two action invocations of a
periodic scheduler. Implementations must guarantee that
action invocations will not occur before at least
schedInterval seconds have passed.
Implementations may be forced to delay invocations in the
face of local constraints. A scheduled management function
should therefore not rely on the accuracy provided by the
scheduler implementation."
::= { schedEntry 4 }
schedWeekDay OBJECT-TYPE
SYNTAX BITS {
sunday(0),
monday(1),
tuesday(2),
wednesday(3),
thursday(4),
friday(5),
saturday(6)
}
Expires December 1998 [Page 8]
Internet-Draft Schedule MIB July 1998
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The set of weekdays on which the scheduled action should
take place."
DEFVAL { {} }
::= { schedEntry 5 }
schedMonth OBJECT-TYPE
SYNTAX BITS {
january(0),
february(1),
march(2),
april(3),
may(4),
june(5),
july(6),
august(7),
september(8),
october(9),
november(10),
december(11)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The set of months during which the scheduled action should
take place."
DEFVAL { {} }
::= { schedEntry 6 }
schedDay OBJECT-TYPE
SYNTAX BITS {
d0(0), d1(1), d2(2), d3(3), d4(4),
d5(5), d6(6), d7(7), d8(8), d9(9),
d10(10), d11(11), d12(12), d13(13), d14(14),
d15(15), d16(16), d17(17), d18(18), d19(19),
d20(20), d21(21), d22(22), d23(23), d24(24),
d25(25), d26(26), d27(27), d28(28), d29(29),
d30(30), d31(31)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The set of days in a month on which a scheduled action
should take place. The first day of the month has the
number d0(0)."
Expires December 1998 [Page 9]
Internet-Draft Schedule MIB July 1998
DEFVAL { {} }
::= { schedEntry 7 }
schedHour OBJECT-TYPE
SYNTAX BITS {
h0(0), h1(1), h2(2), h3(3), h4(4),
h5(5), h6(6), h7(7), h8(8), h9(9),
h10(10), h11(11), h12(12), h13(13), h14(14),
h15(15), h16(16), h17(17), h18(18), h19(19),
h20(20), h21(21), h22(22), h23(23)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The set of hours within a day during which the scheduled
action should take place."
DEFVAL { {} }
::= { schedEntry 8 }
schedMinute OBJECT-TYPE
SYNTAX BITS {
m0(0), m1(1), m2(2), m3(3), m4(4),
m5(5), m6(6), m7(7), m8(8), m9(9),
m10(10), m11(11), m12(12), m13(13), m14(14),
m15(15), m16(16), m17(17), m18(18), m19(19),
m20(20), m21(21), m22(22), m23(23), m24(24),
m25(25), m26(26), m27(27), m28(28), m29(29),
m30(30), m31(31), m32(32), m33(33), m34(34),
m35(35), m36(36), m37(37), m38(38), m39(39),
m40(40), m41(41), m42(42), m43(43), m44(44),
m45(45), m46(46), m47(47), m48(48), m49(49),
m50(50), m51(51), m52(52), m53(53), m54(54),
m55(55), m56(56), m57(57), m58(58), m59(59)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The set of minutes within an hour when the scheduled action
should take place."
DEFVAL { {} }
::= { schedEntry 9 }
schedContextName OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE(0..32))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
Expires December 1998 [Page 10]
Internet-Draft Schedule MIB July 1998
"The context which contains the local MIB variable pointed
to by schedVariable."
::= { schedEntry 10 }
schedVariable OBJECT-TYPE
SYNTAX VariablePointer
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"An object identifier pointing to a local MIB variable
which resolves to an ASN.1 primitive type of INTEGER."
::= { schedEntry 11 }
schedValue OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The value which is written to the MIB object pointed to by
schedVariable when the scheduler invokes an action. The
implementation shall enforce the use of access control
rules when performing the set operation on schedVariable.
This is accomplished by calling the isAccessAllowed abstract
service interface as defined in RFC 2271."
::= { schedEntry 12 }
schedAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
periodic(1),
calendar(2),
disabled(3)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The desired state of the schedule. The periodic(1) state
indicates this entry specifies a periodic schedule. The
calendar(2) state indicates that this entry describes a
calendar schedule. The disabled(2) state indicates that
this entry is currently inactive."
DEFVAL { disabled }
::= { schedEntry 13 }
schedOperStatus OBJECT-TYPE
SYNTAX INTEGER {
periodic(1),
calendar(2),
Expires December 1998 [Page 11]
Internet-Draft Schedule MIB July 1998
disabled(3)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current operational state of this schedule. The
periodic(1) state indicates that the periodic schedule
is active and the calendar(2) state indicates that the
calendar schedule is active. The disabled(3) state indicates
that the schedule is currently not active."
::= { schedEntry 14 }
schedFailures OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This variable counts the number of failures while invoking
the scheduled action."
::= { schedEntry 15 }
schedLastFailure OBJECT-TYPE
SYNTAX SnmpPduErrorStatus
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The most recent error that occured during the invocation of
a scheduled action. The value noError(0) is returned
if no errors have occurred yet."
DEFVAL { noError }
::= { schedEntry 16 }
schedLastFailed OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time when the most recent failure occured. The
value '0000000000000000'H is returned if no failure occured
since the last re-initialization of the scheduler."
DEFVAL { '0000000000000000'H }
::= { schedEntry 17 }
schedStorageType OBJECT-TYPE
SYNTAX StorageType
MAX-ACCESS read-create
STATUS current
Expires December 1998 [Page 12]
Internet-Draft Schedule MIB July 1998
DESCRIPTION
"This object defines whether this scheduled action is kept in
volatile storage and lost upon reboot or if this row is
backed up by non-volatile or permanent storage.
Conceptual rows having the value `permanent' must allow
write access to the columnar objects schedDescr,
schedInterval, schedContextName, schedVariable, schedValue,
and schedAdminStatus. If an implementation supports the
schedCalendarGroup, write access must be also allowed to
the columnar objects schedWeekDay, schedMonth, schedDay,
schedHour, schedMinute."
DEFVAL { volatile }
::= { schedEntry 18 }
schedRowStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The status of this scheduled action. A control that allows
entries to be added and removed from this table.
The miminum number of objects that need to be set during
row creation before a row can be set to `active' are
schedContextName, schedVariable and schedValue."
::= { schedEntry 19 }
--
-- Notifications that are emitted to indicate failures. The definition
-- of schedMIBTraps makes notification registrations reversible.
--
schedTraps OBJECT IDENTIFIER ::= { schedNotifications 0 }
schedActionFailure NOTIFICATION-TYPE
OBJECTS { schedLastFailure }
STATUS current
DESCRIPTION
"This notification is generated whenever the invocation of a
scheduled action fails."
::= { schedTraps 1 }
-- conformance information
schedCompliances OBJECT IDENTIFIER ::= { schedConformance 1 }
schedGroups OBJECT IDENTIFIER ::= { schedConformance 2 }
Expires December 1998 [Page 13]
Internet-Draft Schedule MIB July 1998
-- compliance statements
schedCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for SNMP entities which implement
the scheduling MIB."
MODULE -- this module
MANDATORY-GROUPS {
schedGroup, schedNotificationsGroup
}
GROUP schedCalendarGroup
DESCRIPTION
"The schedCalendarGroup is mandatory only for those
implementations that support calendar based schedules."
OBJECT schedAdminStatus
DESCRIPTION
"The value calendar(2) is not valid for implementations
that do no implement the schedCalendarGroup. Such an
implementation must return inconsistentValue error
responses for attempts to set schedAdminStatus to
calendar(2)."
::= { schedCompliances 1 }
schedGroup OBJECT-GROUP
OBJECTS {
schedDescr,
schedInterval,
schedContextName,
schedVariable,
schedValue,
schedAdminStatus,
schedOperStatus,
schedFailures,
schedLastFailure,
schedLastFailed,
schedStorageType,
schedRowStatus
}
STATUS current
DESCRIPTION
"A collection of objects providing scheduling capabilities."
::= { schedGroups 1 }
schedCalendarGroup OBJECT-GROUP
OBJECTS {
schedWeekDay,
Expires December 1998 [Page 14]
Internet-Draft Schedule MIB July 1998
schedMonth,
schedDay,
schedHour,
schedMinute
}
STATUS current
DESCRIPTION
"A collection of objects providing calendar based schedules."
::= { schedGroups 2 }
schedNotificationsGroup NOTIFICATION-GROUP
NOTIFICATIONS {
schedActionFailure
}
STATUS current
DESCRIPTION
"The notifications emitted by the scheduler."
::= { schedGroups 3 }
END
Expires December 1998 [Page 15]
Internet-Draft Schedule MIB July 1998
5. Usage Examples
This section presents some examples how the scheduling MIB can be
used to schedule scripts with the Script MIB [17] or to realize on-
duty/off-duty schedules by modifying status objects of other MIB
modules.
5.1. Starting a script to ping devices every 20 minutes
It is assumed that the schedule entry is owned by schedOwner = "joe"
and its name is schedName = "ping". The instance identifier for the
scheduling entry is therefore 3.106.111.101.4.112.105.110.103.
It is further assumed that the launch button entry is owned by
smLaunchOwner = "joe" and its name is smLaunchName = "ping-devs".
The complete object identifier for the launch button is therefore
smLaunchStart.3.106.111.101.9.112.105.110.103.45.100.101.118.115. The
script lives in the context identified by the string "engine1".
The configuration of the scheduler entry which presses the launch
button every 20 minutes would look as follows:
schedInterval.3.106.111.101.4.112.105.110.103 = 1200
schedValue.3.106.111.101.4.112.105.110.103 = 0
schedContextName.3.106.111.101.4.112.105.110.103 = "engine1"
schedVariable.3.106.111.101.4.112.105.110.103 =
smLaunchStart.3.106.111.101.9.112.105.110.103.45.100.101.118.115
schedAdminStatus.3.106.111.101.4.112.105.110.103 = periodic(1)
schedStorageType.3.106.111.101.4.112.105.110.103 = nonVolatile(3)
schedRowStatus.3.106.111.101.4.112.105.110.103 = active(1)
All the remaining columns in the schedTable represent status
information and are not shown here.
5.2. Starting a script at midnight every Friday the 13th
It is assumed that the schedule entry is owned by schedOwner = "joe"
and its name is schedName = "13th". The instance identifier for the
scheduling entry is therefore 3.106.111.101.4.49.51.116.104.
It is further assumed that the launch button entry is owned by
smLaunchOwner = "joe" and its name is smLaunchName = "ghost". The
complete object identifier for the launch button is therefore
Expires December 1998 [Page 16]
Internet-Draft Schedule MIB July 1998
smLaunchStart.3.106.111.101.5.103.104.111.115.116. The script lives
in the context identified by the string "engine1".
The configuration of the scheduler entry which presses the launch
button on every Friday 13th at midnight would look as follows:
schedWeekDay.3.106.111.101.4.49.51.116.104 = { friday }
schedMonth.3.106.111.101.4.49.51.116.104 = {
january, february, march, april, may, june,
july, august, september, october, november, december
}
schedDay.3.106.111.101.4.49.51.116.104 = { d13 }
schedHour.3.106.111.101.4.49.51.116.104 = { h0 }
schedMinute.3.106.111.101.4.49.51.116.104 = { m0 }
schedValue.3.106.111.101.4.49.51.116.104 = 0
schedContextName.3.106.111.101.4.49.51.116.104 = "engine1"
schedVariable.3.106.111.101.4.49.51.116.104 =
smLaunchStart.3.106.111.101.5.103.104.111.115.116
schedAdminStatus.3.106.111.101.4.49.51.116.104 = calendar(2)
schedStorageType.3.106.111.101.4.49.51.116.104 = nonVolatile(3)
schedRowStatus.3.106.111.101.4.49.51.116.104 = active(1)
All the remaining columns in the schedTable represent status
information and are not shown here.
5.3. Turning an interface off during weekends
This example assumes that a network interface should be taken down
during weekends. The interface table (ifTable) of the IF-MIB [18] is
assumed to exist in the context identified by an empty string and the
index of the interface is ifIndex = 6.
The scheduling entry which brings the interface down on every Friday
evening at 20:30 (8:30 pm) is owned by schedOwner = "bob" and its
name is schedName = "if-off". The instance identifier for the
scheduling entry is therefore 3.98.111.98.6.105.102.45.111.102.102.
schedWeekDay.3.98.111.98.6.105.102.45.111.102.102 = { monday }
schedMonth.3.98.111.98.6.105.102.45.111.102.102 = {
january, february, march, april, may, june,
july, august, september, october, november, december
}
schedDay.3.98.111.98.6.105.102.45.111.102.102 = {
d0, d1, d2, d3, d4, d5, d6, d7, d8, d9,
Expires December 1998 [Page 17]
Internet-Draft Schedule MIB July 1998
d10, d11, d12, d13, d14, d15, d16, d17, d18, d19,
d20, d21, d22, d23, d24, d25, d26, d27, d28, d29,
d30, d31
}
schedHour.3.98.111.98.6.105.102.45.111.102.102 = { h20 }
schedMinute.3.98.111.98.6.105.102.45.111.102.102 = { m30 }
schedValue.3.98.111.98.6.105.102.45.111.102.102 = down(2)
schedContextName.3.98.111.98.6.105.102.45.111.102.102 = ""
schedVariable.3.98.111.98.6.105.102.45.111.102.102 =
ifAdminStatus.6
schedAdminStatus.3.98.111.98.6.105.102.45.111.102.102 = calendar(2)
schedStorageType.3.98.111.98.6.105.102.45.111.102.102 =
nonVolatile(3)
schedRowStatus.3.98.111.98.6.105.102.45.111.102.102 = active(1)
The scheduling entry which brings the interface up on every Monday
morning at 5:30 is owned by schedOwner = "bob" and its name is
schedName = "if-on". The instance identifier for the scheduling entry
is therefore 3.98.111.98.5.105.102.45.111.110.
The entry in the schedTable which brings the interface up again on
every Monday morning at 5:30 looks as follows:
schedWeekDay.3.98.111.98.5.105.102.45.111.110 = { friday }
schedMonth.3.98.111.98.5.105.102.45.111.110 = {
january, february, march, april, may, june,
july, august, september, october, november, december
}
schedDay.3.98.111.98.5.105.102.45.111.110 = {
d0, d1, d2, d3, d4, d5, d6, d7, d8, d9,
d10, d11, d12, d13, d14, d15, d16, d17, d18, d19,
d20, d21, d22, d23, d24, d25, d26, d27, d28, d29,
d30, d31
}
schedHour.3.98.111.98.5.105.102.45.111.110 = { h5 }
schedMinute.3.98.111.98.5.105.102.45.111.110 = { m30 }
schedValue.3.98.111.98.5.105.102.45.111.110 = up(1)
schedContextName.3.98.111.98.5.105.102.45.111.110 = ""
schedVariable.3.98.111.98.5.105.102.45.111.110 = ifAdminStatus.6
schedAdminStatus.3.98.111.98.5.105.102.45.111.110 = calendar(2)
schedStorageType.3.98.111.98.5.105.102.45.111.110 = nonVolatile(3)
schedRowStatus.3.98.111.98.5.105.102.45.111.110 = active(1)
Expires December 1998 [Page 18]
Internet-Draft Schedule MIB July 1998
A similar configuration could be used to control other schedules. For
example, one could change the "if-on" and "if-off" schedules to
enable and disable the periodic scheduler defined in the first
example.
6. Security Considerations
Scheduled SNMP set operations must use the security credentials that
were present when the corresponding row in the scheduling entry was
created. An implementation must therefore record and maintain the
credentials for every scheduling entry.
An implementation must ensure that access control rules are applied
when doing the set operation. This is accomplished by calling the
isAccessAllowed abstract service interface defined in RFC 2271 [1]:
statusInformation = -- success or errorIndication
isAccessAllowed(
IN securityModel -- Security Model in use
IN securityName -- principal who wants to access
IN securityLevel -- Level of Security
IN viewType -- read, write, or notify view
IN contextName -- context containing variableName
IN variableName -- OID for the managed object
)
The securityModel, securityName and securityLevel parameters are set
to the values that were recorded when the scheduling entry was
created. The viewType parameter must select the write view and the
contextName and variableName parameters are taken from the
schedContextName and schedVariableName values of the scheduling
entry.
This MIB limits scheduled actions to objects in the local MIB. This
avoids security problems with the delegation of access rights.
However, it might be possible for a user of this MIB to own some
schedules that might trigger far in the future. This can cause
security risks if the security administrator did not properly update
the access control lists when a user is withdrawn from an SNMP
engine. Therefore, it is suggested that entries in the schedTable be
cleaned up whenever a user is removed from an SNMP engine.
To facilitate the provisioning of access control by a security
administrator using the View-Based Access Control Model (VACM)
defined in RFC 2275 [15] for tables in which multiple users may need
to independently create or modify entries, the initial index is used
Expires December 1998 [Page 19]
Internet-Draft Schedule MIB July 1998
as an "owner index". Such an initial index has a syntax of
SnmpAdminString, and can thus be trivially mapped to a securityName
or groupName as defined in VACM, in accordance with a security
policy.
All entries in related tables belonging to a particular user will
have the same value for this initial index. For a given user's
entries in a particular table, the object identifiers for the
information in these entries will have the same subidentifiers
(except for the "column" subidentifier) up to the end of the encoded
owner index. To configure VACM to permit access to this portion of
the table, one would create vacmViewTreeFamilyTable entries with the
value of vacmViewTreeFamilySubtree including the owner index portion,
and vacmViewTreeFamilyMask "wildcarding" the column subidentifier.
More elaborate configurations are possible.
7. Intellectual Property
The IETF takes no position regarding the validity or scope of any
intellectual property or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; neither does it represent that it
has made any effort to identify any such rights. Information on the
IETF's procedures with respect to rights in standards-track and
standards-related documentation can be found in BCP-11. Copies of
claims of rights made available for publication and any assurances of
licenses to be made available, or the result of an attempt made to
obtain a general license or permission for the use of such
proprietary rights by implementors or users of this specification can
be obtained from the IETF Secretariat.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights which may cover technology that may be required to practice
this standard. Please address the information to the IETF Executive
Director.
8. Acknowledgments
This document was produced by the IETF Distributed Management
(DISMAN) working group.
Expires December 1998 [Page 20]
Internet-Draft Schedule MIB July 1998
9. References
[1] Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture for
Describing SNMP Management Frameworks", RFC 2271, Cabletron
Systems, Inc., BMC Software, Inc., IBM T. J. Watson Research,
January 1998
[2] Rose, M., and K. McCloghrie, "Structure and Identification of
Management Information for TCP/IP-based Internets", RFC 1155,
Performance Systems International, Hughes LAN Systems, May 1990
[3] Rose, M., and K. McCloghrie, "Concise MIB Definitions", RFC 1212,
Performance Systems International, Hughes LAN Systems, March 1991
[4] M. Rose, "A Convention for Defining Traps for use with the SNMP",
RFC 1215, Performance Systems International, March 1991
[5] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Structure
of Management Information for Version 2 of the Simple Network
Management Protocol (SNMPv2)", RFC 1902, SNMP Research,Inc., Cisco
Systems, Inc., Dover Beach Consulting, Inc., International Network
Services, January 1996.
[6] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Textual
Conventions for Version 2 of the Simple Network Management Protocol
(SNMPv2)", RFC 1903, SNMP Research, Inc., Cisco Systems, Inc.,
Dover Beach Consulting, Inc., International Network Services,
January 1996.
[7] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Conformance
Statements for Version 2 of the Simple Network Management Protocol
(SNMPv2)", RFC 1904, SNMP Research, Inc., Cisco Systems, Inc.,
Dover Beach Consulting, Inc., International Network Services,
January 1996.
[8] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple Network
Management Protocol", RFC 1157, SNMP Research, Performance Systems
International, Performance Systems International, MIT Laboratory
for Computer Science, May 1990.
[9] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser,
"Introduction to Community-based SNMPv2", RFC 1901, SNMP Research,
Inc., Cisco Systems, Inc., Dover Beach Consulting, Inc.,
International Network Services, January 1996.
[10] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Transport
Mappings for Version 2 of the Simple Network Management Protocol
Expires December 1998 [Page 21]
Internet-Draft Schedule MIB July 1998
(SNMPv2)", RFC 1906, SNMP Research, Inc., Cisco Systems, Inc.,
Dover Beach Consulting, Inc., International Network Services,
January 1996.
[11] Case, J., Harrington D., Presuhn R., and B. Wijnen, "Message
Processing and Dispatching for the Simple Network Management
Protocol (SNMP)", RFC 2272, SNMP Research, Inc., Cabletron Systems,
Inc., BMC Software, Inc., IBM T. J. Watson Research, January 1998.
[12] Blumenthal, U., and B. Wijnen, "User-based Security Model (USM) for
version 3 of the Simple Network Management Protocol (SNMPv3)", RFC
2274, IBM T. J. Watson Research, January 1998.
[13] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Protocol
Operations for Version 2 of the Simple Network Management Protocol
(SNMPv2)", RFC 1905, SNMP Research, Inc., Cisco Systems, Inc.,
Dover Beach Consulting, Inc., International Network Services,
January 1996.
[14] Levi, D., Meyer, P., and B. Stewart, "SNMPv3 Applications", RFC
2273, SNMP Research, Inc., Secure Computing Corporation, Cisco
Systems, January 1998
[15] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based Access
Control Model (VACM) for the Simple Network Management Protocol
(SNMP)", RFC 2275, IBM T. J. Watson Research, BMC Software, Inc.,
Cisco Systems, Inc., January 1998
[16] Hovey, R., and S. Bradner, "The Organizations Involved in the IETF
Standards Process", BCP 11, RFC 2028, October 1996.
[17] Levi, D., and J. Schoenwaelder, "Definitions of Managed Objects for
the Delegation of Management Scripts", Internet-Draft <draft-ietf-
disman-script-mib-04.txt>, SNMP Research, Inc., TU Braunschweig,
May 1998.
[18] McCloghrie, K., and F. Kastenholz, "The Interfaces Group MIB using
SMIv2", RFC 2233, Cisco Systems, FTP Software, November 1997.
Expires December 1998 [Page 22]
Internet-Draft Schedule MIB July 1998
10. Editors' Addresses
David B. Levi Email: levi@snmp.com
SNMP Research, Inc. Tel: +1 423 573 1434
3001 Kimberlin Heights Road
Knoxville, TN 37920-9716
U.S.A.
Juergen Schoenwaelder Email: schoenw@ibr.cs.tu-bs.de
TU Braunschweig Tel: +49 531 391-3283
Bueltenweg 74/75
38106 Braunschweig
Germany
11. Full Copyright Statement
Copyright (C) The Internet Society (1998). All Rights Reserved.
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than
English.
The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Expires December 1998 [Page 23]
Internet-Draft Schedule MIB July 1998
12. Revision History
This section should be removed once this document gets published as an
RFC.
12.1. Changes from <draft-ietf-disman-schedule-mib-00>
o Clarifications about drifts between initiations of action in a
periodic scheduler.
o Made the registration of the notification reversible.
o Changed the syntax of schedInterval from TimeInterval to
Unsigned32. The maximum resolution is now seconds instead of
hundreds of a second.
o The conformance statement makes objects for the calendar-based
scheduler optional.
o Minor changes to make the MIB compile with smicng.
12.2. Changes from <draft-ietf-disman-schedule-mib-01>
o Updated the section about the SNMP management framework and
added references to SNMPv3.
o Replaced Utf8String with SnmpAdminString.
o Added Intellectual Property section.
o Changed some wordings to make the text more readable.
12.3. Changes from <draft-ietf-disman-schedule-mib-02>
o Fixes some typos.
o Changed the semantics of "no bits set" and added DEFVALs which
default to nothing scheduled.
Expires December 1998 [Page 24]
Internet-Draft Schedule MIB July 1998
o Added reference to BCP-11.
o Added the schedContextName object to indicate the context of the
variable being set by the scheduler.
o Added three examples to demonstrate the usage of the scheduling
MIB.
o Created a new TC SnmpPduErrorStatus which contains SNMP PDU
error status codes plus `noResponse'.
o Added the new boilerplate and the references that go along with
it.
o Removed the transitional states `enabling' and `disabling' from
the schedOperStatus object.
o Defined the set of objects that must be writable if the storage
type of a row is permanent.
o List the objects that have to get values assigned during row
creation in order to set a row to `active'.
o Added text which describes how the isAccessAllowed abstract
service interface is called for access control.
o Added Randy's text which explains the indexing structure without
refering to a DISMAN framework.
o Replaced schedIndex with schedName. This allows semantic
meaningful references to scheduling entries.
12.4. Changes from <draft-ietf-disman-schedule-mib-03>
o Changed the MIB module name to DISMAN-SCHEDULE-MIB.
o Fixed the example to make the indexing consistent with the new
version of the Script MIB.
o Removed the IMPLIED keyword and updated the examples.
o Moved the change logs to the end of the document.
Expires December 1998 [Page 25]
Internet-Draft Schedule MIB July 1998
Table of Contents
1 Abstract ..................................................... 2
2 The SNMP Management Framework ................................ 2
3 Overview ..................................................... 3
3.1 Periodic Schedules ......................................... 3
3.2 Calendar Schedules ......................................... 3
3.3 Actions .................................................... 4
4 Definitions .................................................. 5
5 Usage Examples ............................................... 16
5.1 Starting a script to ping devices every 20 minutes ......... 16
5.2 Starting a script at midnight every Friday the 13th ........ 16
5.3 Turning an interface off during weekends ................... 17
6 Security Considerations ...................................... 19
7 Intellectual Property ........................................ 20
8 Acknowledgments .............................................. 20
9 References ................................................... 21
10 Editors' Addresses .......................................... 23
11 Full Copyright Statement .................................... 23
12 Revision History ............................................ 24
12.1 Changes from <draft-ietf-disman-schedule-mib-00> .......... 24
12.2 Changes from <draft-ietf-disman-schedule-mib-01> .......... 24
12.3 Changes from <draft-ietf-disman-schedule-mib-02> .......... 24
12.4 Changes from <draft-ietf-disman-schedule-mib-03> .......... 25
Expires December 1998 [Page 26]
