smilint output for ./SEE-MIB
| Message Severities |
|---|
| Severity | Count |
|---|
| error | 3 |
| change recommended | 1 |
| warning | 1 |
| Message Types |
|---|
| Type | Count |
|---|
| basetype-not-imported (error) | 2 |
| compliance-group-status (change recommended) | 1 |
| object-identifier-not-prefix (error) | 1 |
| type-without-format (warning) | 1 |
Messages:
SEE-MIB
1: -- extracted from draft-bierman-disman-see-00.txt
2: -- at Fri Feb 16 06:04:08 2001
3:
4: SEE-MIB DEFINITIONS ::= BEGIN
5:
6: IMPORTS
7: MODULE-IDENTITY, OBJECT-TYPE, Integer32,
8: Unsigned32, Counter32, NOTIFICATION-TYPE,
9: experimental
10: FROM SNMPv2-SMI
11: MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
12: FROM SNMPv2-CONF
13: RowStatus, TimeStamp, TEXTUAL-CONVENTION,
14: TruthValue, StorageType, DateAndTime
15: FROM SNMPv2-TC
16: SnmpAdminString
17: FROM SNMP-FRAMEWORK-MIB
18: SnmpEngineIdOrNone
19: FROM ENTITY-MIB
20: smScriptOwner, smScriptName, smLanguageGroup,
21: smScriptGroup, smCodeGroup
22: FROM DISMAN-SCRIPT-MIB;
23:
24: seeMIB MODULE-IDENTITY
25: LAST-UPDATED "200012240000Z"
26: ORGANIZATION "Cisco Systems, Inc."
27: CONTACT-INFO
28: " Andy Bierman
29: Cisco Systems, Inc.
30: Postal: 170 West Tasman Drive
31: San Jose, CA USA 95134
32: Tel: +1 408 527-3711
33: E-mail: abierman@cisco.com
34:
35: Send comments to <abierman@cisco.com>"
36: DESCRIPTION
37: "This module defines MIB variables related to the operation
38: of the Script Execution Environment."
39: REVISION "200012240000Z"
40: DESCRIPTION
41: "Initial version of the Script Execution Environment MIB
42: module."
43: ::= { experimental xxx }
43: error -
Object identifier element `xxx' name only allowed as first element
44:
45:
46: seeMibObjects OBJECT IDENTIFIER ::= { seeMIB 1 }
47: seeNotifications OBJECT IDENTIFIER ::= { seeMIB 2 }
48: seeConformance OBJECT IDENTIFIER ::= { seeMIB 3 }
49:
50: seeCapsObjects OBJECT IDENTIFIER ::= { seeMibObjects 1 }
51: seeEnvObjects OBJECT IDENTIFIER ::= { seeMibObjects 2 }
52: seeExecObjects OBJECT IDENTIFIER ::= { seeMibObjects 3 }
53: seeRegistrations OBJECT IDENTIFIER ::= { seeMibObjects 4 }
54:
55:
56: --
57: -- SEE Textual Conventions
58: --
59:
60: SeeAppProfile ::= TEXTUAL-CONVENTION
61: STATUS current
62: DESCRIPTION
63: "This TC describes an enumerated integer that identifies an
64: individual application profile.
65:
66: The value 'appWatchedVar' indicates the Watched Variable
67: application profile, which allows a script to be executed if
68: instances of a polled MIB object changes value.
69:
70: The value 'appPeriodic' indicates the Periodic application
71: profile, which allows a script to be executed repeatedly,
72: once per specified polling interval.
73:
74: The value 'appCalendar' indicates the Calendar application
75: profile, which allows a script to be executed on an ad-hoc
76: basis, with the Scheduling MIB.
77:
78: The value 'appNotifyFilter' indicates the Notification
79: Filter application profile, which allows a script to be
80: executed just before particular notifications are generated
81: by the SNMP Entity hosting the script execution environment.
82: The value 'appNotifyReceiver' indicates the Notification
83: Receiver application profile, which allows a script to be
84: executed when particular notifications are received by the
85: SNMP Entity hosting the script execution environment.
86:
87: The value 'appVirtualGet' indicates the Virtual Get
88: application profile, which allows a read-only script to be
89: executed if an associated MIB object is retrieved by a
90: command generator application.
91:
92: The value 'appManual' indicates this the Manual application
93: profile, which allows a script to be executed by management
94: application action only."
95: SYNTAX INTEGER {
96: appWatchedVar(1),
97: appPeriodic(2),
98: appCalendar(3),
99: appNotifyFilter(4),
100: appNotifyReceiver(5),
101: appVirtualGet(6),
102: appManual(7)
103: }
104:
105:
106: SeeExecPermissions ::= TEXTUAL-CONVENTION
107: STATUS current
108: DESCRIPTION
109: "This TC describes a BITS object that identifies the
110: specific runtime permissions on the host SNMP engine for a
111: particular management task execution environment.
112:
113: If the 'agentEnvVars' BIT is set, then this task may create
114: and destroy environment variables with agent scope.
115:
116: If the 'groupEnvVars' BIT is set, then this task may create
117: and destroy environment variables with group scope, and only
118: for the group identified by the associated
119: seeTaskControlGroupId object.
120:
121: If the 'taskEnvVars' BIT is set, then this task may create
122: and destroy environment variables with group scope, and only
123: for this task, identified by the associated
124: seeTaskControlTaskIndex object.
125:
126: If the 'notificationPDUs' BIT is set, and the application
127: profile for this entry permits notification generation, then
128: this task may emit notifications via the 'SnmpMsgLib' system
129: library functions.
130:
131: If the 'getPDUs' BIT is set, then this task may conduct SNMP
132: data retrieval transactions via the 'SnmpMsgLib' system
133: library functions.
134:
135: If the 'setPDUs' BIT is set, then this task may conduct SNMP
136: Set transactions via the system library functions.
137:
138: If the 'writeConfig' BIT is set, and write access is
139: permitted by the application profile for this entry, then
140: this task may call system library functions which
141: (potentially) change configuration parameters in the host
142: SNMP engine.
143:
144: If the 'diagnostics' BIT is set, and write access is
145: permitted by the application profile for this entry, then
146: this task may call system library functions which invoke
147: (potentially intrusive) diagnostics tests on the host SNMP
148: engine.
149:
150: If the 'oidAlias' BIT is set, and write access is permitted
151: by the application profile for this entry, then this task
152: may call system library functions which create, delete, or
153: mmodify the set of OID Alias identifier tokens available to
154: all tasks (i.e. agent scope)."
155: SYNTAX BITS {
156: agentEnvVars(0),
157: groupEnvVars(1),
158: taskEnvVars(2),
159: notificationPDUs(3),
160: getPDUs(4),
161: setPDUs(5),
162: writeConfig(6),
163: diagnostics(7),
164: oidAliases(8)
165: }
166:
167:
168: SeeLogOutput ::= TEXTUAL-CONVENTION
169: STATUS current
170: DESCRIPTION
171: "This TC describes a log fragment.
172: Because debug log messages may become too large too download
173: in a single SNMP PDU, log files may need to be fragmented in
174: a configurable manner.
175:
176: An agent may limit the size of actual MIB instances of this
177: type, based on the resource or transport layer limitations
178: of the operating environment."
179: SYNTAX OCTET STRING (SIZE(0..65535))
180:
181:
182: SeeGroupIdentifier ::= TEXTUAL-CONVENTION
182: warning -
warning: type `SeeGroupIdentifier' has no format specification
183: STATUS current
184: DESCRIPTION
185: "This TC describes an integer that represents an
186: administratively assigned 'task group' identifier. All
187: management tasks in the same group share access to
188: environment variables defined with 'group scope'."
189: SYNTAX Integer32 (1..2147483647)
190:
191:
192: SeeTypeIdentifier ::= TEXTUAL-CONVENTION
193: STATUS current
194: DESCRIPTION
195: "This TC describes a string that represents a globally
196: unique data type identifier string. The agent uses this
197: string for type conversion and data validation purposes
198: within the execution environment.
199:
200: This is a case-sensitive string that is not null-terminated.
201: It must contain the name of a base data type from the
202: SMIv2-SMI, or a base data type from the SEE language.
203:
204: The intrinsic Type Identifier 'Null' is used to
205: differentiate between an empty string and an unset string.
206: There are three 'read-only' variants of the 'Null' Type
207: Identifier, which may be present in Response PDU varbind
208: lists to clarify the semantics of a zero length value
209: string:
210:
211: 'NoSuchName'
212: 'NoSuchInstance'
213: 'EndOfMibView'
214:
215: The following list contains the list of valid Base Type
216: Identifiers, derived from the SMIv2 [RFC2578], and the SEE
217: language definition.
218:
219: 'BITS'
220: 'char'
221: 'Counter32'
222: 'Counter64'
223: 'EndOfMibView'
224: 'float'
225: 'Gauge32'
226: 'int'
227: 'INTEGER'
228: 'Integer32'
229: 'IpAddress' (deprecated)
230: 'long'
231: 'NoSuchInstance'
232: 'NoSuchName'
233: 'Null'
234: 'OBJECT IDENTIFIER'
235: 'OCTET STRING'
236: 'OID'
237: 'Opaque' (deprecated)
238: 'STRING'
239: 'TimeTicks'
240: 'uint'
241: 'ulong'
242: 'Unsigned32' "
243: SYNTAX OCTET STRING (SIZE (1..32))
244:
245:
246: SeeIdentifierString ::= TEXTUAL-CONVENTION
247: STATUS current
248: DESCRIPTION
249: "This TC describes a string that conforms to the syntax
250: requirements for an <identifier> token in the SEE language
251: specification. Identifiers in the SEE MIB are restricted to
252: the underscore character (_), numeric characters ([0..9]),
253: and the letters of the alphabet ([a..z] | [A..Z])."
254: SYNTAX OCTET STRING (SIZE (1..48))
255:
256:
257: SeeStringLiteral ::= TEXTUAL-CONVENTION
258: STATUS current
259: DESCRIPTION
260: "This TC describes an arbitrary string value that conforms
261: to the syntax requirements for a <string-literal> token in
262: the SEE language specification, except that the double
263: quotes that start and end the string and not saved in
264: objects of this type, in order to remain consistent with
265: 'SNMP strings'."
266: SYNTAX OCTET STRING (SIZE (0..65535))
267:
268:
269: SeeResultCode ::= TEXTUAL-CONVENTION
270: STATUS current
271: DESCRIPTION
272: "This TC describes a script or function result code. This
273: enumerated list is derived from smRunExitCode object in the
274: Script MIB, It is used here as a TC, to allow these
275: semantics to be shared by multiple objects. The enumeration
276: 'noError' has been changed from the value '1' to the value
277: '0' to be consistent with the C programming language. The
278: value '1' as been changed to 'notSet'. An additional
279: enumeration (triggerOverflowError) has also been added.
280:
281: An object of this type may have one of the following values:
282:
283: - `noError', which indicates that the script or function
284: completed successfully without errors;
285:
286: - `notSet', which does not indicate any error condition;
287:
288: - `halted', which indicates that the script or function
289: was halted by a request from an authorized manager;
290:
291: - `lifeTimeExceeded', which indicates that the script or
292: function exited because a time limit was exceeded;
293:
294: - `noResourcesLeft', which indicates that the script or
295: function exited because it ran out of resources,
296: (e.g. memory);
297:
298: - `languageError', which indicates that the script or
299: function exited because of a language error (e.g. a
300: syntax error in an interpreted language);
301:
302: - `runtimeError', which indicates that the script or
303: function exited due to a runtime error (e.g. a
304: division by zero);
305:
306: - `invalidArgument', which indicates that the script or
307: function could not be run because of invalid arguments;
308:
309: - `securityViolation', which indicates that the script or
310: function exited due to a security violation;
311:
312: - `genericError', which indicates that the script or
313: function exited for an unspecified reason.
314:
315: - `triggerOverflowError', which indicates that the
316: management task or function did not execute because an
317: invocation of that task was already in progress, and
318: the trigger event was dropped instead of queued.
319:
320: If the script has not yet begun running, or is currently
321: running, the value will be `notSet'."
322: SYNTAX INTEGER {
323: noError(0),
324: notSet(1),
325: halted(2),
326: lifeTimeExceeded(3),
327: noResourcesLeft(4),
328: languageError(5),
329: runtimeError(6),
330: invalidArgument(7),
331: securityViolation(8),
332: genericError(9),
333: triggerOverflowError(10)
334: }
335:
336:
337:
338: --
339: -- SEE Agent System Resource Capabilities
340: --
341:
342: seeCapsTodClock OBJECT-TYPE
343: SYNTAX INTEGER {
344: noTodClock(1),
345: todClock(2),
346: todClockAndTz(3)
347: }
348: MAX-ACCESS read-only
349: STATUS current
350: DESCRIPTION
351: "An indication of the Time of Day clock capabilities of this
352: agent.
353:
354: If this object is equal to 'noTodClock(1)', then this agent
355: does not have a Time of Day clock, and therefore does not
356: support the 'TimeLib' system library, the schedLocalTime MIB
357: object, or the _TRIGGER_TIME_OF_DAY environment variable.
358:
359: If this object is equal to 'todClock(2)', then this agent
360: has a Time of Day clock, but does not know the local
361: timezone, (i.e. supports the 8 octet variant of the
362: TimeAndDate textual convention). The agent therefore
363: supports the TimeLib system library and _TRIGGER_TIME_OF_DAY
364: environment variable, but does not support the
365: schedLocalTime MIB object.
366:
367: If this object is equal to 'todClockAndTz(3)', then this
368: agent has a Time of Day clock, and also knows the local
369: timezone, (i.e. supports the 11 octet variant of the
370: TimeAndDate textual convention). The agent therefore
371: supports the TimeLib system library, schedLocalTime MIB
372: object, and the _TRIGGER_TIME_OF_DAY environment variable.
373:
374: The agent must set this object during system initialization
375: and not change the value without reinitializing the agent."
376: ::= { seeCapsObjects 1 }
377:
378: seeCapsFloatDataType OBJECT-TYPE
379: SYNTAX TruthValue
380: MAX-ACCESS read-only
381: STATUS current
382: DESCRIPTION
383: "An indication of the floating point arithmetic capabilities
384: of this agent.
385:
386: If this object is equal to 'false', then the agent does not
387: support the 'float' data type defined in the scripting
388: language.
389:
390: If this object is equal to 'true', then the agent does
391: support the 'float' data type defined in the scripting
392: language.
393:
394: The agent must set this object during system initialization
395: and not change the value without reinitializing the agent."
396: ::= { seeCapsObjects 2 }
397:
398: seeCapsMinPollInterval OBJECT-TYPE
399: SYNTAX Integer32 (1..2147483647)
400: UNITS "seconds"
401: MAX-ACCESS read-only
402: STATUS current
403: DESCRIPTION
404: "The minimum polling interval that this SEE agent will
405: support. Implementations are permitted to set their own
406: minimum polling interval, based on the capabilities of the
407: system. The agent should set this object as closely as
408: possible to the value '1'.
409:
410: The agent must set this object during system initialization
411: and not change it without reinitializing the agent."
412: ::= { seeCapsObjects 3 }
413:
414: seeCapsMaxEnvStringLen OBJECT-TYPE
415: SYNTAX Integer32 (64..2147483647)
416: MAX-ACCESS read-only
417: STATUS current
418: DESCRIPTION
419: "The maximum length of an individual environment variable
420: string that this SEE agent will support.
421:
422: The agent must set this object during system initialization
423: and not change it without reinitializing the agent."
424: ::= { seeCapsObjects 4 }
425:
426: seeCapsAllowedTargets OBJECT-TYPE
427: SYNTAX INTEGER {
428: localTarget(1),
429: remoteTargets(2),
430: localAndRemoteTargets(3)
431: }
432: MAX-ACCESS read-only
433: STATUS current
434: DESCRIPTION
435: "An indication of the target platform types that this agent
436: can support.
437:
438: If this object is equal to 'localTarget(1)', then this agent
439: only supports application profiles which run on behalf of
440: the local SNMP engine. The agent will only allow the
441: seeTaskControlEngineId object to contain an empty string
442: (indicating that the target SNMP engine is the host SNMP
443: engine).
444:
445: If this object is equal to 'remoteTargets(2)', then this
446: agent only supports application profiles which run on behalf
447: of remote SNMP engines (e.g. the agent is a mid-level
448: manager containing only the MIB objects required to
449: configure itself). The agent will only allow the
450: seeTaskControlEngineId object to contain a non-zero length
451: string, not equal to the snmpEngineId for the local agent.
452:
453: If this object is equal to 'localAndRemoteTargets(3)', then
454: this agent supports application profiles which run on behalf
455: of local or remote SNMP engines. The agent will allow the
456: seeTaskControlEngineId object to contain any valid value.
457:
458: The agent must set this object during system initialization
459: and not change it without reinitializing the agent."
460: ::= { seeCapsObjects 5 }
461:
462: --
463: -- SEE Environment Configuration Scalars
464: --
465:
466: seeTaskAbortNotifyEnabled OBJECT-TYPE
467: SYNTAX TruthValue
468: MAX-ACCESS read-write
469: STATUS current
470: DESCRIPTION
471: "If this object contains the value 'true', then the agent
472: will allow generation of seeTaskAbort notifications to
473: occur.
474:
475: Otherwise, the agent will not generate any seeTaskAbort
476: notifications."
477: ::= { seeEnvObjects 1 }
478:
479: seeTaskAlarmNotifyEnabled OBJECT-TYPE
480: SYNTAX TruthValue
481: MAX-ACCESS read-write
482: STATUS current
483: DESCRIPTION
484: "If this object contains the value 'true', then the agent
485: will allow generation of seeTaskAlarm notifications to
486: occur.
487: Otherwise, the agent will not generate any seeTaskAlarm
488: notifications."
489: ::= { seeEnvObjects 2 }
490:
491: --
492: -- SEE Environment Variable Strings
493: --
494:
495: seeEnvVarTable OBJECT-TYPE
496: SYNTAX SEQUENCE OF SeeEnvVarEntry
497: MAX-ACCESS not-accessible
498: STATUS current
499: DESCRIPTION
500: "Contains the environment variable definitions used on this
501: SEE agent. An environment variable is represented as an
502: array of 'STRING' data elements. The number of strings is
503: identified by the seeEnvVarArraySize object (in this table)
504: and the maximum size of each string is identified by the
505: seeCapsMaxEnvStringLen scalar object.
506:
507: The SEE agent will recognize the SeeIdentifierString
508: specified in each entry as an environment variable array
509: identifier token with the same value.
510:
511: The indexing of this table allows three different scopes in
512: which a given environment variable may be visible - agent,
513: group, and task.
514:
515: Scope seeEnvVarGroupId seeEnvVarTaskId
516: Name INDEX INDEX
517: --------------------------------------------
518: agent zero zero
519: group non-zero zero
520: task zero non-zero
521: INVALID non-zero non-zero
522:
523: Agent Scope: 1 instance of the env var per agent
524: Group Scope: 1 instance of the env var per group
525: Task Scope: 1 instance of the env var per task
526:
527: When a task requests access to an environment variable (via
528: the 'EnvVarLib' System Library), the agent will determine
529: the proper identifier scope by searching this table for the
530: correct task, group, or agent scoped entry.
531: The binding between management task and the proper set of
532: environment variables is done (conceptually) just before
533: each invocation of the associated script.
534:
535: Applications should not delete entries which are currently
536: in use by one or more seeTaskControlEntries."
537: ::= { seeEnvObjects 3 }
538:
539: seeEnvVarEntry OBJECT-TYPE
540: SYNTAX SeeEnvVarEntry
541: MAX-ACCESS not-accessible
542: STATUS current
543: DESCRIPTION
544: "A conceptual row in the seeEnvVarTable.
545:
546: Entries are created in this table by agent or management
547: station action. Entries may also be created by scripts via
548: the 'env_create' function from the 'EnvVarLib' system
549: library. Note that the size of this table may be restricted
550: either statically or dynamically, due to limited agent
551: resources.
552:
553: An agent should include all environment variables available
554: in the execution environment in this table."
555: INDEX { seeEnvVarGroup, seeEnvVarTask, seeEnvVarName }
556: ::= { seeEnvVarTable 1 }
557:
558: SeeEnvVarEntry ::= SEQUENCE {
559: seeEnvVarGroup Integer32,
560: seeEnvVarTask Integer32,
561: seeEnvVarName SeeIdentifierString,
562: seeEnvVarArraySize Integer32,
563: seeEnvVarPermissions INTEGER,
564: seeEnvVarWriteGroup Integer32,
565: seeEnvVarWriteTask Integer32,
566: seeEnvVarInitType INTEGER,
567: seeEnvVarInitValue SeeStringLiteral,
568: seeEnvVarStorageType StorageType,
569: seeEnvVarStatus RowStatus
570: }
571:
572: seeEnvVarGroup OBJECT-TYPE
573: SYNTAX Integer32 (0..2147483647)
574: MAX-ACCESS not-accessible
575: STATUS current
576: DESCRIPTION
577: "The group scope identifier for this environment variable.
578:
579: If the associated seeEnvVarTask object is greater than zero,
580: this this object must equal zero.
581:
582: If this object is equal to zero, and the associated
583: seeEnvVarTask object is equal to zero, then the indicated
584: environment variable is visible to all groups for read
585: access.
586:
587: If this object is greater than zero, and the associated
588: seeEnvVarTask object is equal to zero, then the indicated
589: environment variable is visible in to management tasks with
590: the same seeTaskControlGroupId value."
591: ::= { seeEnvVarEntry 1 }
592:
593: seeEnvVarTask OBJECT-TYPE
594: SYNTAX Integer32 (0..2147483647)
595: MAX-ACCESS not-accessible
596: STATUS current
597: DESCRIPTION
598: "The task scope identifier for this environment variable.
599:
600: If this object is equal to zero, then the associated
601: seeEnvVarGroup identifies the scope of this entry (i.e
602: either group or agent scope).
603:
604: If this object is greater than zero, then the indicated
605: environment variable is visible only to the management task
606: with the same seeTaskControlIndex value as this object."
607: ::= { seeEnvVarEntry 2 }
608:
609: seeEnvVarName OBJECT-TYPE
610: SYNTAX SeeIdentifierString
611: MAX-ACCESS not-accessible
612: STATUS current
613: DESCRIPTION
614: "The environment variable identifier token value associated
615: with this entry."
616: ::= { seeEnvVarEntry 3 }
617:
618: seeEnvVarArraySize OBJECT-TYPE
619: SYNTAX Integer32 (1..2147483647)
620: MAX-ACCESS read-create
621: STATUS current
622: DESCRIPTION
623: "The number of strings contained in the environment variable
624: represented by this entry. Each array element is identified
625: by an dense index value, starting from zero and ending with
626: 'seeEnvVarArraySize - 1'.
627:
628: Individual elements can be referenced with the array
629: operator following the Identifier token (e.g. 'foo[3]'). In
630: order to maintain syntax consistency within scripts, the
631: Identifier token may be used alone to indicate the first
632: array element (i.e. 'foo' and 'foo[0]' reference the same
633: string).
634:
635: The value of this object may be retrieved by a script with
636: the 'env_string_count' function from the 'EnvVarLib' system
637: library.
638:
639: Note that the agent must reserve storage for all the array
640: elements indicated by this object. Applications should keep
641: array sizes to the minimum required for the particular
642: management task, in order to conserve agent resources.
643:
644: This object may not be modified if the associated
645: seeEnvVarStatus object is equal to active."
646: ::= { seeEnvVarEntry 4 }
647:
648: seeEnvVarPermissions OBJECT-TYPE
649: SYNTAX INTEGER {
650: readOnly(1),
651: readWrite(2)
652: }
653: MAX-ACCESS read-create
654: STATUS current
655: DESCRIPTION
656: "The type of access permissions allowed for the environment
657: variable associated with this entry, within the environment
658: variable scope defined for this entry.
659:
660: The value 'readOnly(1)' identifies a environment variable
661: which may only be read by scripts. Any script within the
662: scope of this environment variable which attempts to modify
663: the contents of an environment variable of this type will
664: terminate with an 'securityViolation' error status. The
665: associated seeEnvVarWriteGroup and seeEnvVarWriteTask
666: objects are not used in this case.
667:
668: The value 'readWrite(2)' identifies a environment variable
669: which may be read or modified by one or more scripts,
670: depending on the scope of the environment variable
671: (determined by the seeEnvVarGroup and seeEnvVarTask index
672: values) and the associated seeEnvVarWriteGroup and
673: seeEnvVarWriteTask objects.
674:
675: This object may not be modified if the associated
676: seeEnvVarStatus object is equal to active."
677: ::= { seeEnvVarEntry 5 }
678:
679: seeEnvVarWriteGroup OBJECT-TYPE
680: SYNTAX Integer32 (0..2147483647)
681: MAX-ACCESS read-create
682: STATUS current
683: DESCRIPTION
684: "This object can be used to limit write access of a
685: particular environment variable to a specific task group.
686: It is only relevant if the associated seeEnvVarPermissions
687: object is equal to 'readWrite'. Otherwise this object is
688: not used.
689:
690: If this object is equal to zero, then write access of this
691: entry is not limited to a single task group. Otherwise, the
692: associated seeEnvVarWriteTask object must be equal to zero,
693: and this object identifies the seeTaskControlGroupId value
694: of the tasks that are allowed to write to this environment
695: variable.
696:
697: This object may not be modified if the associated
698: seeEnvVarStatus object is equal to active."
699: ::= { seeEnvVarEntry 6 }
700:
701: seeEnvVarWriteTask OBJECT-TYPE
702: SYNTAX Integer32 (0..2147483647)
703: MAX-ACCESS read-create
704: STATUS current
705: DESCRIPTION
706: "This object can be used to limit write access of a
707: particular environment variable to a specific management
708: task. It is only relevant if the associated
709: seeEnvVarPermissions object is equal to 'readWrite'.
710: If this object is equal to zero, then write access to this
711: entry is not restricted to a single task. Otherwise, the
712: associated seeEnvVarWriteGroup object must be equal to zero,
713: and this object identifies the seeTaskControlIndex value of
714: the one task that is allowed to write to this environment
715: variable.
716:
717: This object may not be modified if the associated
718: seeEnvVarStatus object is equal to active."
719: ::= { seeEnvVarEntry 7 }
720:
721: seeEnvVarInitType OBJECT-TYPE
722: SYNTAX INTEGER {
723: initAlgorithmic(1),
724: initStatic(2)
725: }
726: MAX-ACCESS read-only
727: STATUS current
728: DESCRIPTION
729: "The manner in which the agent will initialize this
730: environment variable.
731:
732: The value 'initAlgorithmic' identifies a system environment
733: variable which is set by the agent in some algorithmic
734: manner. In this case, the envVarInitValue object is not
735: used.
736:
737: The value 'initStatic' identifies an environment variable
738: array which is initialized by the agent with the associated
739: seeEnvVarInitValue, at the time this entry is activated."
740: ::= { seeEnvVarEntry 8 }
741:
742: seeEnvVarInitValue OBJECT-TYPE
743: SYNTAX SeeStringLiteral
744: MAX-ACCESS read-create
745: STATUS current
746: DESCRIPTION
747: "The initial value used for the environment variable
748: associated with this entry.
749:
750: If the associated seeEnvVarInitType object equals
751: 'initStatic', then the agent will initialize each element of
752: the the indicated environment variable with this value.
753:
754: This object may not be modified if the associated
755: seeEnvVarStatus object is equal to active."
756: ::= { seeEnvVarEntry 9 }
757:
758: seeEnvVarStorageType OBJECT-TYPE
759: SYNTAX StorageType
760: MAX-ACCESS read-create
761: STATUS current
762: DESCRIPTION
763: "The type on non-volatile storage behavior associated with
764: this entry."
765: ::= { seeEnvVarEntry 10 }
766:
767: seeEnvVarStatus OBJECT-TYPE
768: SYNTAX RowStatus
769: MAX-ACCESS read-create
770: STATUS current
771: DESCRIPTION
772: "The status of this entry. This object must be equal to
773: active for the associated environment variable to be
774: recognized within the script execution environment.
775:
776: Upon activation, the agent will make the environment
777: variable visible in the indicated scope with the specified
778: initial value.
779:
780: Note that if this row is activated and later deactivated,
781: scripts which attempt to access the environment variable
782: identified by this entry will terminate with a
783: 'runtimeError' error status."
784: ::= { seeEnvVarEntry 11 }
785:
786: --
787: -- SEE OID Alias Table
788: --
789:
790: seeOidAliasTable OBJECT-TYPE
791: SYNTAX SEQUENCE OF SeeOidAliasEntry
792: MAX-ACCESS not-accessible
793: STATUS current
794: DESCRIPTION
795: "Contains the OBJECT IDENTIFIER Alias definitions used on
796: this SEE agent. An OID Alias variable is represented as a
797: single read-only 'STRING' data element.
798:
799: The SEE agent will recognize the SeeIdentifierString
800: specified in each entry as an OID Alias identifier token (in
801: agent scope) with the same value. OID Alias identifier
802: tokens can be used with any 'read-only' operator that is
803: valid for a local variable of type 'OID'."
804: ::= { seeEnvObjects 4 }
805:
806: seeOidAliasEntry OBJECT-TYPE
807: SYNTAX SeeOidAliasEntry
808: MAX-ACCESS not-accessible
809: STATUS current
810: DESCRIPTION
811: "A conceptual row in the seeOidAliasTable.
812:
813: Entries are created in this table by agent or management
814: station action. Entries may also be created by scripts via
815: the 'oid_alias_set' function from the 'SysLib' system
816: library. Note that the size of this table may be restricted
817: either statically or dynamically, due to limited agent
818: resources.
819:
820: An agent should include all OID aliases available in the
821: execution environment in this table."
822: INDEX { seeOidAliasString }
823: ::= { seeOidAliasTable 1 }
824:
825: SeeOidAliasEntry ::= SEQUENCE {
826: seeOidAliasString SeeIdentifierString,
827: seeOidAliasOID OBJECT IDENTIFIER,
828: seeOidAliasStorageType StorageType,
829: seeOidAliasStatus RowStatus
830: }
831:
832: seeOidAliasString OBJECT-TYPE
833: SYNTAX SeeIdentifierString
834: MAX-ACCESS not-accessible
835: STATUS current
836: DESCRIPTION
837: "The unique identifier token string that is the target of
838: this entry. When the agent encounters an identifier token in
839: a script that exactly matches this string, that identifier
840: token will be replaced with the contents of the associated
841: seeOidAliasOID object. This token replacement will be done
842: for processing purposes only, as the script itself will not
843: be modified."
844: ::= { seeOidAliasEntry 1 }
845:
846: seeOidAliasOID OBJECT-TYPE
847: SYNTAX OBJECT IDENTIFIER
848: MAX-ACCESS read-create
849: STATUS current
850: DESCRIPTION
851: "The OBJECT IDENTIFIER to use as a replacement token when
852: the identifier token identified by this entry is encountered
853: in a script.
854:
855: This object may not be modified if the associated
856: seeOidAliasStatus object is equal to active."
857: ::= { seeOidAliasEntry 2 }
858:
859: seeOidAliasStorageType OBJECT-TYPE
860: SYNTAX StorageType
861: MAX-ACCESS read-create
862: STATUS current
863: DESCRIPTION
864: "The type on non-volatile storage behavior associated with
865: this entry."
866: ::= { seeOidAliasEntry 3 }
867:
868: seeOidAliasStatus OBJECT-TYPE
869: SYNTAX RowStatus
870: MAX-ACCESS read-create
871: STATUS current
872: DESCRIPTION
873: "The status of this entry. All values must be set
874: appropriately before this row may be activated."
875: ::= { seeOidAliasEntry 4 }
876:
877: --
878: -- SEE Task Control Table
879: --
880:
881: seeTaskControlTable OBJECT-TYPE
882: SYNTAX SEQUENCE OF SeeTaskControlEntry
883: MAX-ACCESS not-accessible
884: STATUS current
885: DESCRIPTION
886: "Controls the operation of each task within the execution
887: environment. Entries in this table operate independently of
888: one another. Administrators must configure this table
889: carefully, since it is possible for management tasks to
890: interact with each other, since the underlying system
891: parameters and status are shared by all tasks.
892:
893: The multi-threading mechanisms required to support multiple
894: active entries in this table are beyond the scope of this
895: document. Read-only scripts should be written to operate in
896: a multi-threaded environment. Read-write scripts may be
897: configured to 'run to completion' or run in a multi-threaded
898: mode."
899: ::= { seeExecObjects 1 }
900:
901: seeTaskControlEntry OBJECT-TYPE
902: SYNTAX SeeTaskControlEntry
903: MAX-ACCESS not-accessible
904: STATUS current
905: DESCRIPTION
906: "A conceptual row in the seeTaskControlTable.
907:
908: Entries are created in this table by agent or management
909: station action. Entries are retained by the agent, as
910: indicated by the seeTaskControlStorageType object.
911:
912: The smScriptOwner and smScript objects (from the Script MIB)
913: identify the particular script associated with each
914: management task entry."
915: INDEX { smScriptOwner, smScriptName, seeTaskControlIndex }
916: ::= { seeTaskControlTable 1 }
917:
918: SeeTaskControlEntry ::= SEQUENCE {
919: seeTaskControlIndex Integer32,
920: seeTaskControlDescr SnmpAdminString,
921: seeTaskControlAppProfile SeeAppProfile,
922: seeTaskControlExecPermissions SeeExecPermissions,
923: seeTaskControlGroupId SeeGroupIdentifier,
924: seeTaskControlRunMode INTEGER,
925: seeTaskControlRunButton INTEGER,
926: seeTaskControlStartFn SeeIdentifierString,
927: seeTaskControlLifetime Integer32,
928: seeTaskControlEngineId SnmpEngineIdOrNone,
929: seeTaskControlContextName SnmpAdminString,
930: seeTaskControlTriggerOid OBJECT IDENTIFIER,
931: seeTaskControlTriggerInt Integer32,
932: seeTaskControlTriggerOvflAct INTEGER,
933: seeTaskControlScratchpadSize Integer32,
934: seeTaskControlResultType SeeTypeIdentifier,
935: seeTaskControlLogWriteMode INTEGER,
936: seeTaskControlMaxLogSize Integer32,
937: seeTaskControlMaxLogChunkSize Integer32,
938: seeTaskControlLogClearButton INTEGER,
939: seeTaskControlNumExecOks Counter32,
940: seeTaskControlNumExecFails Counter32,
941: seeTaskControlLastResCode SeeResultCode,
942: seeTaskControlLastResult OCTET STRING,
943: seeTaskControlLastSEIndex Unsigned32,
944: seeTaskControlLastSEOffset Integer32,
945: seeTaskControlTaskRunning TruthValue,
946: seeTaskControlLastTrigTime TimeStamp,
947: seeTaskControlCurLogSize Gauge32,
947: error -
SMIv2 base type `Gauge32' must be imported from SNMPv2-SMI
948: seeTaskControlLostLogOctets Counter32,
949: seeTaskControlLastLogWriteTime TimeStamp,
950: seeTaskControlStorageType StorageType,
951: seeTaskControlStatus RowStatus
952: }
953:
954: seeTaskControlIndex OBJECT-TYPE
955: SYNTAX Integer32 (1..2147483647)
956: MAX-ACCESS not-accessible
957: STATUS current
958: DESCRIPTION
959: "An arbitrary index for this management task entry, which is
960: unique for all values of smScriptOwner and smScriptName.
961: This index allows multiple management tasks to be be
962: configured which use the same script, as well as providing a
963: unique integer identifier for each management task. These
964: index values may be reused by management applications or the
965: agent. There is no requirement to retain the semantics of an
966: active seeTaskControlEntry once the seeTaskControlRowStatus
967: is set to 'destroy'."
968: ::= { seeTaskControlEntry 1 }
969:
970: seeTaskControlDescr OBJECT-TYPE
971: SYNTAX SnmpAdminString
972: MAX-ACCESS read-create
973: STATUS current
974: DESCRIPTION
975: "An administratively assigned textual description of this
976: management task."
977: ::= { seeTaskControlEntry 2 }
978:
979: seeTaskControlAppProfile OBJECT-TYPE
980: SYNTAX SeeAppProfile
981: MAX-ACCESS read-create
982: STATUS current
983: DESCRIPTION
984: "The application profile for this management task. The
985: associated script will be invoked, and runtime constraints
986: enforced, according to the rules for the application profile
987: indicated by this object.
988:
989: This object may not be modified if the associated
990: seeTaskControlStatus object is equal to active."
991: ::= { seeTaskControlEntry 3 }
992:
993: seeTaskControlExecPermissions OBJECT-TYPE
994: SYNTAX SeeExecPermissions
995: MAX-ACCESS read-create
996: STATUS current
997: DESCRIPTION
998: "The execution permissions set for this management task.
999: The associated script will be invoked, and runtime
1000: constraints enforced, according to the particular
1001: permissions enabled in this bit string. Note that this
1002: object does not override any characteristics indicated by
1003: the associated seeTaskControlAppProfile object. Instead, it
1004: allows further constraint of the specific execution
1005: environment and system library features available to script
1006: (on behalf of this entry).
1007:
1008: This object may not be modified if the associated
1009: seeTaskControlStatus object is equal to active."
1010: ::= { seeTaskControlEntry 4 }
1011:
1012: seeTaskControlGroupId OBJECT-TYPE
1013: SYNTAX SeeGroupIdentifier
1014: MAX-ACCESS read-create
1015: STATUS current
1016: DESCRIPTION
1017: "The task group identifier for this entry.
1018:
1019: This object may not be modified if the associated
1020: seeTaskControlStatus object is equal to active."
1021: ::= { seeTaskControlEntry 5 }
1022:
1023: seeTaskControlRunMode OBJECT-TYPE
1024: SYNTAX INTEGER {
1025: normalRunMode(1),
1026: traceRunMode(2),
1027: debugRunMode(3),
1028: validateMode(4)
1029: }
1030: MAX-ACCESS read-create
1031: STATUS current
1032: DESCRIPTION
1033: "Controls the manner in which the script associated with
1034: this task is executed. There are four run modes defined,
1035: which allow some level of control over log messages, script
1036: debugging, and system access.
1037:
1038: The value 'normalRunMode' identifies a management task
1039: running in the 'normal' operational mode, in which system
1040: library function logging is disabled. Note that a script
1041: may emit logging messages via library functions, regardless
1042: of the value of this object. This mode only disables trace
1043: logging of system activity.
1044:
1045: The value 'traceRunMode' identifies a management task
1046: running in the 'trace' operational mode, in which system
1047: activity, such as calls to library functions, are logged in
1048: the seeLogControlTable.
1049:
1050: The value 'debugRunMode' identifies a management task
1051: running in the 'debug' operational mode, in which trace
1052: logging is active, except no read-write library functions
1053: are actually invoked. This allows an administrator some
1054: ability to determine the impact of a new script on the
1055: existing environment, without risking system disruption.
1056: Note that scripts which modify and then inspect system
1057: behavior may behave unexpectedly in this 'no-op' run mode.
1058:
1059: The value 'validateMode' identifies a management task that
1060: is installed in validation mode. Instead of executing the
1061: associated script, the agent will examine the entire script
1062: for correctness. Problems such as syntax errors and
1063: unresolved function names should be detected in this mode.
1064: Note that an implementation cannot completely validate OID
1065: Alias and environment variable identifier usage, since these
1066: identifier tokens can be installed dynamically, by scripts
1067: or management applications.
1068:
1069: After the validation check is done, the
1070: seeTaskControlLastResCode, seeTaskControlLastSEIndex, and
1071: seeTaskControlLastSEOffset objects will be set to non-zero
1072: values if any problems are found. The agent will also
1073: output error messages to the seeLogTable for the script.
1074:
1075: This object may not be modified if the associated
1076: seeTaskControlStatus object is equal to active."
1077: DEFVAL { normalRunMode }
1078: ::= { seeTaskControlEntry 6 }
1079:
1080: seeTaskControlRunButton OBJECT-TYPE
1081: SYNTAX INTEGER {
1082: runTask(1),
1083: notPressed(2)
1084: }
1085: MAX-ACCESS read-create
1086: STATUS current
1087: DESCRIPTION
1088: "This object allows the associated script to be executed
1089: manually by a management application.
1090:
1091: This object is only used if the associated
1092: seeTaskControlAppProfile object is equal to 'appManual', or
1093: if the associated seeTaskControlRunMode is equal to
1094: 'validateMode'. It is ignored by the agent in other
1095: situations.
1096:
1097: Setting this object to the value 'runTask(1)' will cause the
1098: script for this entry to be executed once, unless it is
1099: currently running. In that case, the agent will return an
1100: 'inconsistentValue' error instead of starting the script on
1101: behalf of this entry. As soon as the script is restarted,
1102: the agent will set this object to the value 'notPressed(2)'.
1103: An application may examine the associated
1104: seeTaskControlTaskRunning object to determine if the task is
1105: currently running.
1106:
1107: Setting this object to the value 'notPressed(2)' has no
1108: effect whatsoever."
1109: ::= { seeTaskControlEntry 7 }
1110:
1111: seeTaskControlStartFn OBJECT-TYPE
1112: SYNTAX SeeIdentifierString
1113: MAX-ACCESS read-create
1114: STATUS current
1115: DESCRIPTION
1116: "The unique identifier token string that identifies the
1117: script entry point for this management task entry.
1118:
1119: Upon script invocation, the agent will attempt to execute
1120: the script function with this name. If the function does not
1121: exist, or if its inputs or return type does not match the
1122: application profile indicated by the associated
1123: seeTaskControlAppProfile object, then the agent will
1124: terminate the script invocation with a 'languageError'
1125: return status.
1126:
1127: Only two function prototype forms are supported at this
1128: time. The specific prototype to use depends on the
1129: application profile.
1130:
1131: Without return value:
1132: 'void <seeTaskControlStartFn> (void);'
1133: With return value:
1134: '<type-specifier> <seeTaskControlStartFn> (void);'
1135:
1136: Note that this object is ignored by the agent if the
1137: associated seeTaskControlRunMode is equal to
1138: 'validateMode(4)', since the agent will validate the entire
1139: script, not just this function and all possible code-paths.
1140:
1141: This object may not be modified if the associated
1142: seeTaskControlStatus object is equal to active."
1143: ::= { seeTaskControlEntry 8 }
1144:
1145: seeTaskControlLifetime OBJECT-TYPE
1146: SYNTAX Integer32 (0..2147483647)
1147: MAX-ACCESS read-create
1148: STATUS current
1149: DESCRIPTION
1150: "This object indicates the maximum number of seconds that
1151: may elapse before the script associated with this entry is
1152: aborted by the agent with a 'lifeTimeExceeded' error status.
1153: This timeout mechanism applies to each invocation of a
1154: script on behalf of a specific seeTaskControlEntry.
1155:
1156: If this object is equal to zero, then the timeout mechanism
1157: is not used, and no maximum script invocation lifetime will
1158: be enforced by the agent.
1159:
1160: If this object is greater than zero, then the agent will
1161: wait until at least this number of seconds elapses before
1162: terminating the current invocation of the script with a
1163: 'lifeTimeExceeded' error status.
1164:
1165: This object may not be modified if the associated
1166: seeTaskControlStatus object is equal to active."
1167: ::= { seeTaskControlEntry 9 }
1168:
1169: seeTaskControlEngineId OBJECT-TYPE
1170: SYNTAX SnmpEngineIdOrNone
1171: MAX-ACCESS read-create
1172: STATUS current
1173: DESCRIPTION
1174: "This object identifies the 'primary target' SNMP engine for
1175: this management task entry. This object, together with the
1176: associated seeTaskControlContextName object, defines the
1177: context associated with the seeTaskControlTriggerOid object.
1178:
1179: If this object contains a zero length string, then the local
1180: agent will be used as the target of management operations
1181: executed by the associated script. The agent will limit the
1182: value of this object to a zero-length string if the
1183: seeCapsAllowedTargets object is equal to 'localTarget'.
1184:
1185: Otherwise, this object identifies the SNMP entity of the
1186: 'primary target' for script logic embodied in the associated
1187: task. Note that a task is not limited to communication with
1188: this target. The agent will create the _TARGET_ENGINE_ID
1189: environment variable in task scope, upon activation of this
1190: entry, set to the value of this object.
1191:
1192: This object may not be modified if the associated
1193: seeTaskControlStatus object is equal to active."
1194: ::= { seeTaskControlEntry 10 }
1195:
1196: seeTaskControlContextName OBJECT-TYPE
1197: SYNTAX SnmpAdminString
1198: MAX-ACCESS read-create
1199: STATUS current
1200: DESCRIPTION
1201: "This object identifies the 'primary target' context for
1202: this management task entry. This object, together with the
1203: associated seeTaskControlEngineId object, defines the
1204: context associated with the seeTaskControlTriggerOid object.
1205: The agent will create the _TARGET_CONTEXT_NAME environment
1206: variable (array size of one) in task scope, upon activation
1207: of this entry, with the value of this object.
1208:
1209: If the associated seeTaskControlAppProfile object is equal
1210: to 'appNotifyFilter' or 'appNotifyReceiver', and this object
1211: contains a non-zero length string, then this object selects
1212: only notifications with the same contextName (or community),
1213:
1214: This object may not be modified if the associated
1215: seeTaskControlStatus object is equal to active."
1216: ::= { seeTaskControlEntry 11 }
1217:
1218: seeTaskControlTriggerOid OBJECT-TYPE
1219: SYNTAX OBJECT IDENTIFIER
1220: MAX-ACCESS read-create
1221: STATUS current
1222: DESCRIPTION
1223: "An OBJECT IDENTIFIER indicating a particular OBJECT
1224: IDENTIFIER base fragment associated with the trigger event
1225: for this management task entry. This object represents
1226: different OBJECT IDENTIFIER parameters in different modes.
1227:
1228: The _TRIGGER_OID_BASE environment variable will be set to
1229: the canonical string representation for this object at the
1230: start of each trigger frame executed on behalf of this
1231: entry.
1232:
1233: Each application profile may define restrictions on the
1234: values which may be assigned to this object, such as whether
1235: complete or incomplete base fragments are permitted.
1236:
1237: The agent might not be able to validate the contents of this
1238: object at the time the object is set, since the
1239: seeTaskControlAppProfile may not be known at the time this
1240: object is set. The agent must verify the contents of this
1241: object before the associated seeTaskControlStatus is set to
1242: 'active'.
1243:
1244: This object may not be modified if the associated
1245: seeTaskControlStatus object is equal to active."
1246: ::= { seeTaskControlEntry 12 }
1247:
1248: seeTaskControlTriggerInt OBJECT-TYPE
1249: SYNTAX Integer32 (0..2147483647)
1250: UNITS "seconds"
1251: MAX-ACCESS read-create
1252: STATUS current
1253: DESCRIPTION
1254: "An interval of time that should pass between successive
1255: periodic evaluations of the trigger condition.
1256:
1257: If the associated seeTaskControlAppProfile object is equal
1258: to 'appWatchedVar' or 'appPeriodic', then this object
1259: identifies the minimum number of seconds that should elapse
1260: between trigger events executed on behalf of this control
1261: entry, and the value zero is not allowed.
1262:
1263: For other values of seeTaskControlAppProfile, this object is
1264: ignored by the agent, and should contain the value zero.
1265:
1266: This object may not be modified if the associated
1267: seeTaskControlStatus object is equal to active."
1268: ::= { seeTaskControlEntry 13 }
1269:
1270: seeTaskControlTriggerOvflAct OBJECT-TYPE
1271: SYNTAX INTEGER {
1272: dropTrigger(1),
1273: dropNotifyTrigger(2),
1274: queueTrigger(3)
1275: }
1276: MAX-ACCESS read-create
1277: STATUS current
1278: DESCRIPTION
1279: "Controls how the agent handles a trigger overflow condition
1280: on behalf of this management task, i.e. a new trigger event
1281: occurs which should be dispatched to this management task,
1282: but cannot because the execution on behalf of the previous
1283: trigger event has not finished.
1284:
1285: The value 'dropTrigger' indicates that a new trigger event
1286: will be dropped if a trigger overflow occurs, and a
1287: 'triggerOverflow' log message will be generated if logging
1288: is active for this entry.
1289:
1290: The value 'dropNotifyTrigger' indicates that a new trigger
1291: event will be dropped if a trigger overflow occurs. A
1292: 'triggerOverflow' log message will be generated if logging
1293: is active for this entry, and a 'seeTaskAlarm' notification
1294: will also be generated.
1295: The value 'queueTrigger' indicates that the agent will
1296: attempt to save a new trigger event if a trigger overflow
1297: occurs. If the agent cannot queue the trigger event, then a
1298: trigger overflow is handled as defined by the
1299: 'dropNotifyTrigger' enumeration. If the agent can queue the
1300: trigger event, then the event order must be preserved, and
1301: the associated script should be invoked with any queued
1302: events as soon as possible.
1303:
1304: This object may not be modified if the associated
1305: seeTaskControlStatus object is equal to active."
1306: ::= { seeTaskControlEntry 14 }
1307:
1308: seeTaskControlScratchpadSize OBJECT-TYPE
1309: SYNTAX Integer32 (0..65535)
1310: MAX-ACCESS read-create
1311: STATUS current
1312: DESCRIPTION
1313: "This object identifies the number of array elements that
1314: the _SCRATCHPAD environment variable for this task will
1315: contain.
1316:
1317: The agent will create this number of strings in the
1318: _SCRATCHPAD environment variable. The maximum length of each
1319: string is defined by the seeCapsMaxEnvStringLen object. An
1320: agent is not required to allocate (or reserve) the requested
1321: data storage until this entry is activated.
1322:
1323: This object may not be modified if the associated
1324: seeTaskControlStatus object is equal to active."
1325: DEFVAL { 1 }
1326: ::= { seeTaskControlEntry 15 }
1327:
1328: seeTaskControlResultType OBJECT-TYPE
1329: SYNTAX SeeTypeIdentifier
1330: MAX-ACCESS read-create
1331: STATUS current
1332: DESCRIPTION
1333: "This object identifies the base type of the script result
1334: stored in the associated seeTaskControlLastResult object.
1335: This allows the script result string to be formatted in
1336: specific ways, so it can be converted to a type other than
1337: 'STRING' in a standard way. Refer to the SeeTypeIdentifier
1338: TC for more details.
1339: Note that the agent is not required to enforce the
1340: formatting syntax requirements specified for each Type
1341: Identifier value. This object is provided as a 'formatting
1342: hint' to applications only.
1343:
1344: This object may not be modified if the associated
1345: seeTaskControlStatus object is equal to active."
1346: ::= { seeTaskControlEntry 16 }
1347:
1348: seeTaskControlLogWriteMode OBJECT-TYPE
1349: SYNTAX INTEGER {
1350: wrapWhenFull(1),
1351: stopWhenFull(2)
1352: }
1353: MAX-ACCESS read-create
1354: STATUS current
1355: DESCRIPTION
1356: "The type of behavior the agent will take on behalf of this
1357: entry, when the total number of octets of log output in the
1358: associated seeLogTable equals or exceeds the associated
1359: seeTaskControlMaxLogSize value for this entry.
1360:
1361: If this object contains the value 'wrapWhenFull' and the the
1362: maximum log size is exceeded, then the agent will delete
1363: enough of the oldest seeLogEntries (with all the same
1364: seeTaskControlIndex major index value) to make room for the
1365: new entry.
1366:
1367: If this object contains the value 'stopWhenFull(2)', and the
1368: the maximum log size is exceeded, then the agent will stop
1369: adding seeLogEntries. Instead, the associated
1370: seeTaskControlLostLogOctets object will be incremented by
1371: the size of the seeLogChunk object that would have been
1372: created.
1373:
1374: This object may not be modified if the associated
1375: seeTaskControlStatus object is equal to active."
1376: ::= { seeTaskControlEntry 17 }
1377:
1378: seeTaskControlMaxLogSize OBJECT-TYPE
1379: SYNTAX Integer32 (-1..2147483647)
1380: MAX-ACCESS read-create
1381: STATUS current
1382: DESCRIPTION
1383: "The maximum number of octets that may be written to
1384: seeLogEntries on behalf of this entry.
1385:
1386: If this object contains the value '-1', then no maximum size
1387: will be enforced for the associated seeLogTable. The size
1388: of the log table is subject to only to agent resources.
1389:
1390: If this object contains the value '0', then logging will be
1391: disabled for this entry.
1392:
1393: Otherwise, this object identifies the maximum allowed size
1394: of the combined lengths of the associated seeLogChunk OCTET
1395: STRING objects, created in the seeLogTable on behalf of this
1396: entry. Refer to the seeTaskControlLogWriteMode for a
1397: description of agent behavior when the log size is equal or
1398: larger in size to the value specified by this object.
1399:
1400: This object may not be modified if the associated
1401: seeTaskControlStatus object is equal to active."
1402: ::= { seeTaskControlEntry 18 }
1403:
1404: seeTaskControlMaxLogChunkSize OBJECT-TYPE
1405: SYNTAX Integer32 (255..65535)
1406: MAX-ACCESS read-create
1407: STATUS current
1408: DESCRIPTION
1409: "The maximum number of octets that may be written to any
1410: seeLogChunk object created on behalf of this entry. An
1411: application should limit the value of this object in order
1412: to prevent a 'tooBig' SNMP PDU error to be generated for get
1413: requests of the seeLogChunk object.
1414:
1415: The agent must not create entries larger than this number of
1416: octets in the seeLogTable on behalf of this entry. Note
1417: that an agent may choose to fragment log entries at values
1418: lower than indicated by this object.
1419:
1420: This object may not be modified if the associated
1421: seeTaskControlStatus object is equal to active."
1422: ::= { seeTaskControlEntry 19 }
1423:
1424: seeTaskControlLogClearButton OBJECT-TYPE
1425: SYNTAX INTEGER {
1426: clearLog(1),
1427: notPressed(2)
1428: }
1429:
1430: MAX-ACCESS read-create
1431: STATUS current
1432: DESCRIPTION
1433: "This object allows the contents of the seeLogTable created
1434: on behalf of this entry to be deleted.
1435:
1436: If this object is set to the value 'clearLog' the agent will
1437: delete all related entries in the seeLogTable, and then set
1438: the value of this object to the value 'notPressed'.
1439:
1440: Setting this object to the value 'notPressed(2)' has no
1441: effect whatsoever."
1442: ::= { seeTaskControlEntry 20 }
1443:
1444: seeTaskControlNumExecOks OBJECT-TYPE
1445: SYNTAX Counter32
1446: UNITS "script invocation events"
1447: MAX-ACCESS read-only
1448: STATUS current
1449: DESCRIPTION
1450: "This counter is incremented by one, each time the script
1451: associated with this control entry is executed, and
1452: completed with a return status of 'noError'."
1453: ::= { seeTaskControlEntry 21 }
1454:
1455: seeTaskControlNumExecFails OBJECT-TYPE
1456: SYNTAX Counter32
1457: UNITS "script invocation events"
1458: MAX-ACCESS read-only
1459: STATUS current
1460: DESCRIPTION
1461: "This counter is incremented by one, each time the script
1462: associated with this control entry is executed, and
1463: completed with a return status other than 'noError'."
1464: ::= { seeTaskControlEntry 22 }
1465:
1466: seeTaskControlLastResCode OBJECT-TYPE
1467: SYNTAX SeeResultCode
1468: MAX-ACCESS read-only
1469: STATUS current
1470: DESCRIPTION
1471: "The system result status value obtained the last time the
1472: associated script was executed."
1473: ::= { seeTaskControlEntry 23 }
1474:
1475: seeTaskControlLastResult OBJECT-TYPE
1476: SYNTAX OCTET STRING
1477: MAX-ACCESS read-only
1478: STATUS current
1479: DESCRIPTION
1480: "The string result value obtained the last time the
1481: associated script was executed. This object may contain a
1482: value in a different data type, string-encoded according to
1483: the encoding rules for the Type Identifier indicated by the
1484: associated seeTaskControlResultType object.
1485:
1486: If the seeTaskControlAppProfile object for this entry is
1487: equal to 'appVirtualGet', and the seeTaskControlStatus is
1488: equal to 'active', then the associated script will be be
1489: invoked each time this object is retrieved.
1490:
1491: The empty string is returned if no return value is available
1492: on behalf of this entry."
1493: ::= { seeTaskControlEntry 24 }
1494:
1495: seeTaskControlLastSEIndex OBJECT-TYPE
1496: SYNTAX Unsigned32 (1..4294967295)
1497: MAX-ACCESS read-only
1498: STATUS current
1499: DESCRIPTION
1500: "The smCodeIndex value of the SEE script chunk, in which the
1501: first script syntax error was found during the execution of
1502: the associated script.
1503:
1504: If no syntax error has been detected, or if a particular
1505: script has not yet been executed by the agent, then this
1506: object will contain the value zero."
1507: ::= { seeTaskControlEntry 25 }
1508:
1509: seeTaskControlLastSEOffset OBJECT-TYPE
1510: SYNTAX Integer32 (-1..1023)
1511: MAX-ACCESS read-only
1512: STATUS current
1513: DESCRIPTION
1514: "The offset position within the associated smCodeText OCTET
1515: STRING in which the first script syntax error was found
1516: during the execution of the associated script.
1517:
1518: If no syntax error has been detected, or if a particular
1519: script has not yet been executed by the agent, then this
1520: object will contain the value '-1'.
1521:
1522: Otherwise, this object identifies the number of octets into
1523: the script code string identified by the associated
1524: seeTaskControlLastSEIndex object.
1525:
1526: Note that position of the first octet in the string is
1527: identified by the value '0', not the value '1'."
1528: ::= { seeTaskControlEntry 26 }
1529:
1530: seeTaskControlTaskRunning OBJECT-TYPE
1531: SYNTAX TruthValue
1532: MAX-ACCESS read-only
1533: STATUS current
1534: DESCRIPTION
1535: "Indicates whether the agent is currently running the
1536: associated script on behalf of this management task entry.
1537:
1538: The value 'true' indicates this task is currently running."
1539: ::= { seeTaskControlEntry 27 }
1540:
1541: seeTaskControlLastTrigTime OBJECT-TYPE
1542: SYNTAX TimeStamp
1543: MAX-ACCESS read-only
1544: STATUS current
1545: DESCRIPTION
1546: "The value of sysUpTime the last time a trigger event for
1547: this entry occurred, or zero if no such event has occurred."
1548: ::= { seeTaskControlEntry 28 }
1549:
1550: seeTaskControlCurLogSize OBJECT-TYPE
1551: SYNTAX Gauge32
1552: MAX-ACCESS read-only
1552: error -
SMIv2 base type `Gauge32' must be imported from SNMPv2-SMI
1553: STATUS current
1554: DESCRIPTION
1555: "The current number of octets contained in all seeLogChunk
1556: instances, existing in the seeLogTable on behalf of this
1557: entry."
1558: ::= { seeTaskControlEntry 29 }
1559:
1560: seeTaskControlLostLogOctets OBJECT-TYPE
1561: SYNTAX Counter32
1562: MAX-ACCESS read-only
1563: STATUS current
1564: DESCRIPTION
1565: "An indication that log entries on behalf of this task are
1566: not being captured in the seeLogTable.
1567:
1568: This counter is incremented by the number of octets which
1569: would have been written to the associated seeLogTable on
1570: behalf of this entry, but were not written, for whatever
1571: reason."
1572: ::= { seeTaskControlEntry 30 }
1573:
1574: seeTaskControlLastLogWriteTime OBJECT-TYPE
1575: SYNTAX TimeStamp
1576: MAX-ACCESS read-only
1577: STATUS current
1578: DESCRIPTION
1579: "The value of sysUpTime the last time an entry was added to
1580: the seeLogTable on behalf of this task.
1581:
1582: A management application can use this object to determine
1583: when new log output has been written for this task. This
1584: timestamp will be updated when a seeLogEntry is successfully
1585: added to the seeLogTable on behalf of this entry.
1586:
1587: Initially, this object will contain the value zero."
1588: ::= { seeTaskControlEntry 31 }
1589:
1590: seeTaskControlStorageType OBJECT-TYPE
1591: SYNTAX StorageType
1592: MAX-ACCESS read-create
1593: STATUS current
1594: DESCRIPTION
1595: "The type on non-volatile storage behavior associated with
1596: this entry."
1597: ::= { seeTaskControlEntry 32 }
1598:
1599: seeTaskControlStatus OBJECT-TYPE
1600: SYNTAX RowStatus
1601: MAX-ACCESS read-create
1602: STATUS current
1603: DESCRIPTION
1604: "The status of this entry. All values must be set
1605: appropriately before this row may be activated. All valid
1606: row creation states should be supported, including
1607: 'createAndWait' and 'notInService'."
1608: ::= { seeTaskControlEntry 33 }
1609:
1610: --
1611: -- SEE Log Table
1612: --
1613: -- contains a controlled number of limited length
1614: -- log chunks for each entry configured in the
1615: -- seeTaskControlTable
1616: --
1617:
1618: seeLogTable OBJECT-TYPE
1619: SYNTAX SEQUENCE OF SeeLogEntry
1620: MAX-ACCESS not-accessible
1621: STATUS current
1622: DESCRIPTION
1623: "Contains the individual output chunks which comprise the
1624: log output for the associated seeTaskControlEntry."
1625: ::= { seeExecObjects 2 }
1626:
1627: seeLogEntry OBJECT-TYPE
1628: SYNTAX SeeLogEntry
1629: MAX-ACCESS not-accessible
1630: STATUS current
1631: DESCRIPTION
1632: "A conceptual row in the seeLogTable.
1633:
1634: Entries are created in this table by agent or script action.
1635:
1636: The management task associated with the log output contained
1637: in this table is identified by the seeTaskControlIndex value
1638: in the INDEX clause."
1639: INDEX { seeTaskControlIndex,
1640: seeLogIndex }
1641: ::= { seeLogTable 1 }
1642:
1643: SeeLogEntry ::= SEQUENCE {
1644: seeLogIndex Integer32,
1645: seeLogCreateTOD DateAndTime,
1646: seeLogCreateTime TimeStamp,
1647: seeLogChunk SeeLogOutput
1648: }
1649:
1650: seeLogIndex OBJECT-TYPE
1651: SYNTAX Integer32 (1..2147483647)
1652: MAX-ACCESS not-accessible
1653: STATUS current
1654: DESCRIPTION
1655: "The minor index for this log entry. The agent should use
1656: consecutive index values until the maximum value is reached,
1657: before reusing index values. However, this object should be
1658: 'reset' to the value '1' if the associated
1659: seeTaskControlLogClearButton object is set to 'clearLog'."
1660: ::= { seeLogEntry 1 }
1661:
1662: seeLogCreateTOD OBJECT-TYPE
1663: SYNTAX DateAndTime
1664: MAX-ACCESS read-only
1665: STATUS current
1666: DESCRIPTION
1667: "The current time of day (e.g. value of schedLocalTime) at
1668: the time this log entry was added to this table. If the
1669: seeCapsTodClock object is equal to 'noTodClock', then this
1670: object will contain the empty string."
1671: ::= { seeLogEntry 2 }
1672:
1673: seeLogCreateTime OBJECT-TYPE
1674: SYNTAX TimeStamp
1675: MAX-ACCESS read-only
1676: STATUS current
1677: DESCRIPTION
1678: "The value of sysUpTime at the time this log entry was added
1679: to this table."
1680: ::= { seeLogEntry 3 }
1681:
1682: seeLogChunk OBJECT-TYPE
1683: SYNTAX SeeLogOutput
1684: MAX-ACCESS read-only
1685: STATUS current
1686: DESCRIPTION
1687: "A log fragment created on behalf of the associated
1688: seeTaskControlEntry. This object will not be greater in
1689: length than the associated seeTaskControlMaxLogChunkSize
1690: object."
1691: ::= { seeLogEntry 4 }
1692:
1693: --
1694: -- Registrations
1695: --
1696:
1697: seeLanguage OBJECT IDENTIFIER ::= { seeRegistrations 1 }
1698:
1699: seeLibraries OBJECT IDENTIFIER ::= { seeRegistrations 2 }
1700: --
1701: -- Notifications Section
1702: --
1703:
1704: seeTraps OBJECT IDENTIFIER ::= { seeNotifications 0 }
1705:
1706:
1707: -- this replaces the smScriptAbort notification
1708:
1709: seeTaskAbort NOTIFICATION-TYPE
1710: OBJECTS { seeTaskControlAppProfile,
1711: seeTaskControlLastResCode }
1712: STATUS current
1713: DESCRIPTION
1714: "This notification is generated whenever a management task
1715: terminates with a result status other than 'noError', if the
1716: seeTaskAbortNotifyEnabled object is equal to 'true'.
1717:
1718: The seeTaskControlAppProfile identifies the type of
1719: application that terminated with an error status, and the
1720: seeTaskControlLastResCode identifies the specific error that
1721: occurred.
1722:
1723: An implementation may restrict the frequency that these
1724: notifications are actually emitted by the agent."
1725: ::= { seeTraps 1 }
1726:
1727: -- this replaces the smScriptResult notification
1728:
1729: seeTaskAlarm NOTIFICATION-TYPE
1730: OBJECTS { seeTaskControlAppProfile }
1731: STATUS current
1732: DESCRIPTION
1733: "This notification is generated by script action (on behalf
1734: of a particular management task) via the 'SnmpMsgLib' system
1735: library, if the seeTaskAlarmNotifyEnabled object is equal to
1736: 'true'.
1737:
1738: The seeTaskControlAppProfile object is always encoded first,
1739: as a means of identifying the type of application and the
1740: seeTaskControlEntry. Individual tasks will likely add other
1741: varbinds as well.
1742:
1743: An implementation may restrict the frequency that these
1744: notifications are actually emitted by the agent."
1745: ::= { seeTraps 2 }
1746:
1747: --
1748: -- Conformance Section
1749: --
1750:
1751: seeCompliances OBJECT IDENTIFIER ::= { seeConformance 1 }
1752: seeGroups OBJECT IDENTIFIER ::= { seeConformance 2 }
1753:
1754: seeCompliance MODULE-COMPLIANCE
1754: change recommended -
warning: current compliance statement `seeCompliance' includes deprecated group `smScriptGroup'
1755: STATUS current
1756: DESCRIPTION
1757: "Describes the requirements for conformance to the Script
1758: Execution Environment MIB."
1759: MODULE -- this module
1760: MANDATORY-GROUPS { seeCapsGroup,
1761: seeEnvGroup,
1762: seeExecGroup,
1763: seeNotificationsGroup,
1764: smLanguageGroup,
1765: smScriptGroup,
1766: smCodeGroup
1767: }
1768: ::= { seeCompliances 1 }
1769:
1770: seeCapsGroup OBJECT-GROUP
1771: OBJECTS {
1772: seeCapsTodClock,
1773: seeCapsFloatDataType,
1774: seeCapsMinPollInterval,
1775: seeCapsMaxEnvStringLen,
1776: seeCapsAllowedTargets
1777: }
1778: STATUS current
1779: DESCRIPTION
1780: "A collection of objects used to identify some SEE runtime
1781: capabilities provided by this agent."
1782: ::= { seeGroups 1 }
1783:
1784: seeEnvGroup OBJECT-GROUP
1785: OBJECTS {
1786: seeTaskAbortNotifyEnabled,
1787: seeTaskAlarmNotifyEnabled,
1788: seeEnvVarArraySize,
1789: seeEnvVarPermissions,
1790: seeEnvVarWriteGroup,
1791: seeEnvVarWriteTask,
1792: seeEnvVarInitType,
1793: seeEnvVarInitValue,
1794: seeEnvVarStorageType,
1795: seeEnvVarStatus,
1796: seeOidAliasOID,
1797: seeOidAliasStorageType,
1798: seeOidAliasStatus
1799: }
1800: STATUS current
1801: DESCRIPTION
1802: "A collection of objects used to control the configuration
1803: of the execution environment."
1804: ::= { seeGroups 2 }
1805:
1806: seeExecGroup OBJECT-GROUP
1807: OBJECTS {
1808: seeTaskControlDescr,
1809: seeTaskControlAppProfile,
1810: seeTaskControlExecPermissions,
1811: seeTaskControlGroupId,
1812: seeTaskControlRunMode,
1813: seeTaskControlRunButton,
1814: seeTaskControlStartFn,
1815: seeTaskControlLifetime,
1816: seeTaskControlEngineId,
1817: seeTaskControlContextName,
1818: seeTaskControlTriggerOid,
1819: seeTaskControlTriggerInt,
1820: seeTaskControlTriggerOvflAct,
1821: seeTaskControlScratchpadSize,
1822: seeTaskControlResultType,
1823: seeTaskControlLogWriteMode,
1824: seeTaskControlMaxLogSize,
1825: seeTaskControlMaxLogChunkSize,
1826: seeTaskControlLogClearButton,
1827: seeTaskControlNumExecOks,
1828: seeTaskControlNumExecFails,
1829: seeTaskControlLastResCode,
1830: seeTaskControlLastResult,
1831: seeTaskControlLastSEIndex,
1832: seeTaskControlLastSEOffset,
1833: seeTaskControlTaskRunning,
1834: seeTaskControlLastTrigTime,
1835: seeTaskControlCurLogSize,
1836: seeTaskControlLostLogOctets,
1837: seeTaskControlLastLogWriteTime,
1838: seeTaskControlStorageType,
1839: seeTaskControlStatus,
1840: seeLogCreateTOD,
1841: seeLogCreateTime,
1842: seeLogChunk
1843: }
1844: STATUS current
1845: DESCRIPTION
1846: "A collection of objects used to control the execution of
1847: management tasks."
1848: ::= { seeGroups 3 }
1849:
1850: seeNotificationsGroup NOTIFICATION-GROUP
1851: NOTIFICATIONS {
1852: seeTaskAbort,
1853: seeTaskAlarm
1854: }
1855: STATUS current
1856: DESCRIPTION
1857: "The notifications emitted by the SEE MIB."
1858: ::= { seeGroups 4 }
1859:
1860: END
1861:
1862: --
1863: -- Copyright (C) The Internet Society (2001). All Rights Reserved.
1864: --
1865: -- This document and translations of it may be copied and furnished to
1866: -- others, and derivative works that comment on or otherwise explain it or
1867: -- assist in its implementation may be prepared, copied, published and
1868: -- distributed, in whole or in part, without restriction of any kind,
1869: -- provided that the above copyright notice and this paragraph are included
1870: -- on all such copies and derivative works. However, this document itself
1871: -- may not be modified in any way, such as by removing the copyright notice
1872: -- or references to the Internet Society or other Internet organizations,
1873: -- except as needed for the purpose of developing Internet standards in
1874: -- which case the procedures for copyrights defined in the Internet
1875: -- Standards process must be followed, or as required to translate it into
1876: -- languages other than English.
1877: --
1878: -- The limited permissions granted above are perpetual and will not be
1879: -- revoked by the Internet Society or its successors or assigns.
1880: --
1881: -- This document and the information contained herein is provided on an "AS
1882: -- IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
1883: -- FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT
1884: -- LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT
1885: -- INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
1886: -- FITNESS FOR A PARTICULAR PURPOSE.
1887: