SEE-MIB

File: SEE-MIB.mib (77811 bytes)

Imported modules

SNMPv2-SMI SNMPv2-CONF SNMPv2-TC
SNMP-FRAMEWORK-MIB ENTITY-MIB DISMAN-SCRIPT-MIB

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Integer32
Gauge32 Unsigned32 Counter32
NOTIFICATION-TYPE experimental MODULE-COMPLIANCE
OBJECT-GROUP NOTIFICATION-GROUP RowStatus
TimeStamp TEXTUAL-CONVENTION TruthValue
StorageType DateAndTime SnmpAdminString
SnmpEngineIdOrNone smScriptOwner smScriptName
smLanguageGroup smScriptGroup smCodeGroup

Defined Types

SeeAppProfile  
This TC describes an enumerated integer that identifies an individual application profile. The value 'appWatchedVar' indicates the Watched Variable application profile, which allows a script to be executed if instances of a polled MIB object changes value. The value 'appPeriodic' indicates the Periodic application profile, which allows a script to be executed repeatedly, once per specified polling interval. The value 'appCalendar' indicates the Calendar application profile, which allows a script to be executed on an ad-hoc basis, with the Scheduling MIB. The value 'appNotifyFilter' indicates the Notification Filter application profile, which allows a script to be executed just before particular notifications are generated by the SNMP Entity hosting the script execution environment. The value 'appNotifyReceiver' indicates the Notification Receiver application profile, which allows a script to be executed when particular notifications are received by the SNMP Entity hosting the script execution environment. The value 'appVirtualGet' indicates the Virtual Get application profile, which allows a read-only script to be executed if an associated MIB object is retrieved by a command generator application. The value 'appManual' indicates this the Manual application profile, which allows a script to be executed by management application action only.
TEXTUAL-CONVENTION    
  INTEGER appWatchedVar(1), appPeriodic(2), appCalendar(3), appNotifyFilter(4), appNotifyReceiver(5), appVirtualGet(6), appManual(7)  

SeeExecPermissions  
This TC describes a BITS object that identifies the specific runtime permissions on the host SNMP engine for a particular management task execution environment. If the 'agentEnvVars' BIT is set, then this task may create and destroy environment variables with agent scope. If the 'groupEnvVars' BIT is set, then this task may create and destroy environment variables with group scope, and only for the group identified by the associated seeTaskControlGroupId object. If the 'taskEnvVars' BIT is set, then this task may create and destroy environment variables with group scope, and only for this task, identified by the associated seeTaskControlTaskIndex object. If the 'notificationPDUs' BIT is set, and the application profile for this entry permits notification generation, then this task may emit notifications via the 'SnmpMsgLib' system library functions. If the 'getPDUs' BIT is set, then this task may conduct SNMP data retrieval transactions via the 'SnmpMsgLib' system library functions. If the 'setPDUs' BIT is set, then this task may conduct SNMP Set transactions via the system library functions. If the 'writeConfig' BIT is set, and write access is permitted by the application profile for this entry, then this task may call system library functions which (potentially) change configuration parameters in the host SNMP engine. If the 'diagnostics' BIT is set, and write access is permitted by the application profile for this entry, then this task may call system library functions which invoke (potentially intrusive) diagnostics tests on the host SNMP engine. If the 'oidAlias' BIT is set, and write access is permitted by the application profile for this entry, then this task may call system library functions which create, delete, or mmodify the set of OID Alias identifier tokens available to all tasks (i.e. agent scope).
TEXTUAL-CONVENTION    
  BITS agentEnvVars(0), groupEnvVars(1), taskEnvVars(2), notificationPDUs(3), getPDUs(4), setPDUs(5), writeConfig(6), diagnostics(7), oidAliases(8)  

SeeLogOutput  
This TC describes a log fragment. Because debug log messages may become too large too download in a single SNMP PDU, log files may need to be fragmented in a configurable manner. An agent may limit the size of actual MIB instances of this type, based on the resource or transport layer limitations of the operating environment.
TEXTUAL-CONVENTION    
  OCTET STRING Size(0..65535)  

SeeGroupIdentifier  
This TC describes an integer that represents an administratively assigned 'task group' identifier. All management tasks in the same group share access to environment variables defined with 'group scope'.
TEXTUAL-CONVENTION    
  Integer32 1..2147483647  

SeeTypeIdentifier  
This TC describes a string that represents a globally unique data type identifier string. The agent uses this string for type conversion and data validation purposes within the execution environment. This is a case-sensitive string that is not null-terminated. It must contain the name of a base data type from the SMIv2-SMI, or a base data type from the SEE language. The intrinsic Type Identifier 'Null' is used to differentiate between an empty string and an unset string. There are three 'read-only' variants of the 'Null' Type Identifier, which may be present in Response PDU varbind lists to clarify the semantics of a zero length value string: 'NoSuchName' 'NoSuchInstance' 'EndOfMibView' The following list contains the list of valid Base Type Identifiers, derived from the SMIv2 [RFC2578], and the SEE language definition. 'BITS' 'char' 'Counter32' 'Counter64' 'EndOfMibView' 'float' 'Gauge32' 'int' 'INTEGER' 'Integer32' 'IpAddress' (deprecated) 'long' 'NoSuchInstance' 'NoSuchName' 'Null' 'OBJECT IDENTIFIER' 'OCTET STRING' 'OID' 'Opaque' (deprecated) 'STRING' 'TimeTicks' 'uint' 'ulong' 'Unsigned32'
TEXTUAL-CONVENTION    
  OCTET STRING Size(1..32)  

SeeIdentifierString  
This TC describes a string that conforms to the syntax requirements for an token in the SEE language specification. Identifiers in the SEE MIB are restricted to the underscore character (_), numeric characters ([0..9]), and the letters of the alphabet ([a..z] | [A..Z]).
TEXTUAL-CONVENTION    
  OCTET STRING Size(1..48)  

SeeStringLiteral  
This TC describes an arbitrary string value that conforms to the syntax requirements for a token in the SEE language specification, except that the double quotes that start and end the string and not saved in objects of this type, in order to remain consistent with 'SNMP strings'.
TEXTUAL-CONVENTION    
  OCTET STRING Size(0..65535)  

SeeResultCode  
This TC describes a script or function result code. This enumerated list is derived from smRunExitCode object in the Script MIB, It is used here as a TC, to allow these semantics to be shared by multiple objects. The enumeration 'noError' has been changed from the value '1' to the value '0' to be consistent with the C programming language. The value '1' as been changed to 'notSet'. An additional enumeration (triggerOverflowError) has also been added. An object of this type may have one of the following values: - `noError', which indicates that the script or function completed successfully without errors; - `notSet', which does not indicate any error condition; - `halted', which indicates that the script or function was halted by a request from an authorized manager; - `lifeTimeExceeded', which indicates that the script or function exited because a time limit was exceeded; - `noResourcesLeft', which indicates that the script or function exited because it ran out of resources, (e.g. memory); - `languageError', which indicates that the script or function exited because of a language error (e.g. a syntax error in an interpreted language); - `runtimeError', which indicates that the script or function exited due to a runtime error (e.g. a division by zero); - `invalidArgument', which indicates that the script or function could not be run because of invalid arguments; - `securityViolation', which indicates that the script or function exited due to a security violation; - `genericError', which indicates that the script or function exited for an unspecified reason. - `triggerOverflowError', which indicates that the management task or function did not execute because an invocation of that task was already in progress, and the trigger event was dropped instead of queued. If the script has not yet begun running, or is currently running, the value will be `notSet'.
TEXTUAL-CONVENTION    
  INTEGER noError(0), notSet(1), halted(2), lifeTimeExceeded(3), noResourcesLeft(4), languageError(5), runtimeError(6), invalidArgument(7), securityViolation(8), genericError(9), triggerOverflowError(10)  

SeeEnvVarEntry  
SEQUENCE    
  seeEnvVarGroup Integer32
  seeEnvVarTask Integer32
  seeEnvVarName SeeIdentifierString
  seeEnvVarArraySize Integer32
  seeEnvVarPermissions INTEGER
  seeEnvVarWriteGroup Integer32
  seeEnvVarWriteTask Integer32
  seeEnvVarInitType INTEGER
  seeEnvVarInitValue SeeStringLiteral
  seeEnvVarStorageType StorageType
  seeEnvVarStatus RowStatus

SeeOidAliasEntry  
SEQUENCE    
  seeOidAliasString SeeIdentifierString
  seeOidAliasOID OBJECT IDENTIFIER
  seeOidAliasStorageType StorageType
  seeOidAliasStatus RowStatus

SeeTaskControlEntry  
SEQUENCE    
  seeTaskControlIndex Integer32
  seeTaskControlDescr SnmpAdminString
  seeTaskControlAppProfile SeeAppProfile
  seeTaskControlExecPermissions SeeExecPermissions
  seeTaskControlGroupId SeeGroupIdentifier
  seeTaskControlRunMode INTEGER
  seeTaskControlRunButton INTEGER
  seeTaskControlStartFn SeeIdentifierString
  seeTaskControlLifetime Integer32
  seeTaskControlEngineId SnmpEngineIdOrNone
  seeTaskControlContextName SnmpAdminString
  seeTaskControlTriggerOid OBJECT IDENTIFIER
  seeTaskControlTriggerInt Integer32
  seeTaskControlTriggerOvflAct INTEGER
  seeTaskControlScratchpadSize Integer32
  seeTaskControlResultType SeeTypeIdentifier
  seeTaskControlLogWriteMode INTEGER
  seeTaskControlMaxLogSize Integer32
  seeTaskControlMaxLogChunkSize Integer32
  seeTaskControlLogClearButton INTEGER
  seeTaskControlNumExecOks Counter32
  seeTaskControlNumExecFails Counter32
  seeTaskControlLastResCode SeeResultCode
  seeTaskControlLastResult OCTET STRING
  seeTaskControlLastSEIndex Unsigned32
  seeTaskControlLastSEOffset Integer32
  seeTaskControlTaskRunning TruthValue
  seeTaskControlLastTrigTime TimeStamp
  seeTaskControlCurLogSize Gauge32
  seeTaskControlLostLogOctets Counter32
  seeTaskControlLastLogWriteTime TimeStamp
  seeTaskControlStorageType StorageType
  seeTaskControlStatus RowStatus

SeeLogEntry  
SEQUENCE    
  seeLogIndex Integer32
  seeLogCreateTOD DateAndTime
  seeLogCreateTime TimeStamp
  seeLogChunk SeeLogOutput

Defined Values

seeMIB 1.3.6.1.3.1
This module defines MIB variables related to the operation of the Script Execution Environment.
MODULE-IDENTITY    

seeMibObjects 1.3.6.1.3.1.1
OBJECT IDENTIFIER    

seeNotifications 1.3.6.1.3.1.2
OBJECT IDENTIFIER    

seeConformance 1.3.6.1.3.1.3
OBJECT IDENTIFIER    

seeCapsObjects 1.3.6.1.3.1.1.1
OBJECT IDENTIFIER    

seeEnvObjects 1.3.6.1.3.1.1.2
OBJECT IDENTIFIER    

seeExecObjects 1.3.6.1.3.1.1.3
OBJECT IDENTIFIER    

seeRegistrations 1.3.6.1.3.1.1.4
OBJECT IDENTIFIER    

seeCapsTodClock 1.3.6.1.3.1.1.1.1
An indication of the Time of Day clock capabilities of this agent. If this object is equal to 'noTodClock(1)', then this agent does not have a Time of Day clock, and therefore does not support the 'TimeLib' system library, the schedLocalTime MIB object, or the _TRIGGER_TIME_OF_DAY environment variable. If this object is equal to 'todClock(2)', then this agent has a Time of Day clock, but does not know the local timezone, (i.e. supports the 8 octet variant of the TimeAndDate textual convention). The agent therefore supports the TimeLib system library and _TRIGGER_TIME_OF_DAY environment variable, but does not support the schedLocalTime MIB object. If this object is equal to 'todClockAndTz(3)', then this agent has a Time of Day clock, and also knows the local timezone, (i.e. supports the 11 octet variant of the TimeAndDate textual convention). The agent therefore supports the TimeLib system library, schedLocalTime MIB object, and the _TRIGGER_TIME_OF_DAY environment variable. The agent must set this object during system initialization and not change the value without reinitializing the agent.
Status: current Access: read-only
OBJECT-TYPE    
  INTEGER noTodClock(1), todClock(2), todClockAndTz(3)  

seeCapsFloatDataType 1.3.6.1.3.1.1.1.2
An indication of the floating point arithmetic capabilities of this agent. If this object is equal to 'false', then the agent does not support the 'float' data type defined in the scripting language. If this object is equal to 'true', then the agent does support the 'float' data type defined in the scripting language. The agent must set this object during system initialization and not change the value without reinitializing the agent.
Status: current Access: read-only
OBJECT-TYPE    
  TruthValue  

seeCapsMinPollInterval 1.3.6.1.3.1.1.1.3
The minimum polling interval that this SEE agent will support. Implementations are permitted to set their own minimum polling interval, based on the capabilities of the system. The agent should set this object as closely as possible to the value '1'. The agent must set this object during system initialization and not change it without reinitializing the agent.
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 1..2147483647  

seeCapsMaxEnvStringLen 1.3.6.1.3.1.1.1.4
The maximum length of an individual environment variable string that this SEE agent will support. The agent must set this object during system initialization and not change it without reinitializing the agent.
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 64..2147483647  

seeCapsAllowedTargets 1.3.6.1.3.1.1.1.5
An indication of the target platform types that this agent can support. If this object is equal to 'localTarget(1)', then this agent only supports application profiles which run on behalf of the local SNMP engine. The agent will only allow the seeTaskControlEngineId object to contain an empty string (indicating that the target SNMP engine is the host SNMP engine). If this object is equal to 'remoteTargets(2)', then this agent only supports application profiles which run on behalf of remote SNMP engines (e.g. the agent is a mid-level manager containing only the MIB objects required to configure itself). The agent will only allow the seeTaskControlEngineId object to contain a non-zero length string, not equal to the snmpEngineId for the local agent. If this object is equal to 'localAndRemoteTargets(3)', then this agent supports application profiles which run on behalf of local or remote SNMP engines. The agent will allow the seeTaskControlEngineId object to contain any valid value. The agent must set this object during system initialization and not change it without reinitializing the agent.
Status: current Access: read-only
OBJECT-TYPE    
  INTEGER localTarget(1), remoteTargets(2), localAndRemoteTargets(3)  

seeTaskAbortNotifyEnabled 1.3.6.1.3.1.1.2.1
If this object contains the value 'true', then the agent will allow generation of seeTaskAbort notifications to occur. Otherwise, the agent will not generate any seeTaskAbort notifications.
Status: current Access: read-write
OBJECT-TYPE    
  TruthValue  

seeTaskAlarmNotifyEnabled 1.3.6.1.3.1.1.2.2
If this object contains the value 'true', then the agent will allow generation of seeTaskAlarm notifications to occur. Otherwise, the agent will not generate any seeTaskAlarm notifications.
Status: current Access: read-write
OBJECT-TYPE    
  TruthValue  

seeEnvVarTable 1.3.6.1.3.1.1.2.3
Contains the environment variable definitions used on this SEE agent. An environment variable is represented as an array of 'STRING' data elements. The number of strings is identified by the seeEnvVarArraySize object (in this table) and the maximum size of each string is identified by the seeCapsMaxEnvStringLen scalar object. The SEE agent will recognize the SeeIdentifierString specified in each entry as an environment variable array identifier token with the same value. The indexing of this table allows three different scopes in which a given environment variable may be visible - agent, group, and task. Scope seeEnvVarGroupId seeEnvVarTaskId Name INDEX INDEX -------------------------------------------- agent zero zero group non-zero zero task zero non-zero INVALID non-zero non-zero Agent Scope: 1 instance of the env var per agent Group Scope: 1 instance of the env var per group Task Scope: 1 instance of the env var per task When a task requests access to an environment variable (via the 'EnvVarLib' System Library), the agent will determine the proper identifier scope by searching this table for the correct task, group, or agent scoped entry. The binding between management task and the proper set of environment variables is done (conceptually) just before each invocation of the associated script. Applications should not delete entries which are currently in use by one or more seeTaskControlEntries.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    SeeEnvVarEntry

seeEnvVarEntry 1.3.6.1.3.1.1.2.3.1
A conceptual row in the seeEnvVarTable. Entries are created in this table by agent or management station action. Entries may also be created by scripts via the 'env_create' function from the 'EnvVarLib' system library. Note that the size of this table may be restricted either statically or dynamically, due to limited agent resources. An agent should include all environment variables available in the execution environment in this table.
Status: current Access: not-accessible
OBJECT-TYPE    
  SeeEnvVarEntry  

seeEnvVarGroup 1.3.6.1.3.1.1.2.3.1.1
The group scope identifier for this environment variable. If the associated seeEnvVarTask object is greater than zero, this this object must equal zero. If this object is equal to zero, and the associated seeEnvVarTask object is equal to zero, then the indicated environment variable is visible to all groups for read access. If this object is greater than zero, and the associated seeEnvVarTask object is equal to zero, then the indicated environment variable is visible in to management tasks with the same seeTaskControlGroupId value.
Status: current Access: not-accessible
OBJECT-TYPE    
  Integer32 0..2147483647  

seeEnvVarTask 1.3.6.1.3.1.1.2.3.1.2
The task scope identifier for this environment variable. If this object is equal to zero, then the associated seeEnvVarGroup identifies the scope of this entry (i.e either group or agent scope). If this object is greater than zero, then the indicated environment variable is visible only to the management task with the same seeTaskControlIndex value as this object.
Status: current Access: not-accessible
OBJECT-TYPE    
  Integer32 0..2147483647  

seeEnvVarName 1.3.6.1.3.1.1.2.3.1.3
The environment variable identifier token value associated with this entry.
Status: current Access: not-accessible
OBJECT-TYPE    
  SeeIdentifierString  

seeEnvVarArraySize 1.3.6.1.3.1.1.2.3.1.4
The number of strings contained in the environment variable represented by this entry. Each array element is identified by an dense index value, starting from zero and ending with 'seeEnvVarArraySize - 1'. Individual elements can be referenced with the array operator following the Identifier token (e.g. 'foo[3]'). In order to maintain syntax consistency within scripts, the Identifier token may be used alone to indicate the first array element (i.e. 'foo' and 'foo[0]' reference the same string). The value of this object may be retrieved by a script with the 'env_string_count' function from the 'EnvVarLib' system library. Note that the agent must reserve storage for all the array elements indicated by this object. Applications should keep array sizes to the minimum required for the particular management task, in order to conserve agent resources. This object may not be modified if the associated seeEnvVarStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  Integer32 1..2147483647  

seeEnvVarPermissions 1.3.6.1.3.1.1.2.3.1.5
The type of access permissions allowed for the environment variable associated with this entry, within the environment variable scope defined for this entry. The value 'readOnly(1)' identifies a environment variable which may only be read by scripts. Any script within the scope of this environment variable which attempts to modify the contents of an environment variable of this type will terminate with an 'securityViolation' error status. The associated seeEnvVarWriteGroup and seeEnvVarWriteTask objects are not used in this case. The value 'readWrite(2)' identifies a environment variable which may be read or modified by one or more scripts, depending on the scope of the environment variable (determined by the seeEnvVarGroup and seeEnvVarTask index values) and the associated seeEnvVarWriteGroup and seeEnvVarWriteTask objects. This object may not be modified if the associated seeEnvVarStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  INTEGER readOnly(1), readWrite(2)  

seeEnvVarWriteGroup 1.3.6.1.3.1.1.2.3.1.6
This object can be used to limit write access of a particular environment variable to a specific task group. It is only relevant if the associated seeEnvVarPermissions object is equal to 'readWrite'. Otherwise this object is not used. If this object is equal to zero, then write access of this entry is not limited to a single task group. Otherwise, the associated seeEnvVarWriteTask object must be equal to zero, and this object identifies the seeTaskControlGroupId value of the tasks that are allowed to write to this environment variable. This object may not be modified if the associated seeEnvVarStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  Integer32 0..2147483647  

seeEnvVarWriteTask 1.3.6.1.3.1.1.2.3.1.7
This object can be used to limit write access of a particular environment variable to a specific management task. It is only relevant if the associated seeEnvVarPermissions object is equal to 'readWrite'. If this object is equal to zero, then write access to this entry is not restricted to a single task. Otherwise, the associated seeEnvVarWriteGroup object must be equal to zero, and this object identifies the seeTaskControlIndex value of the one task that is allowed to write to this environment variable. This object may not be modified if the associated seeEnvVarStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  Integer32 0..2147483647  

seeEnvVarInitType 1.3.6.1.3.1.1.2.3.1.8
The manner in which the agent will initialize this environment variable. The value 'initAlgorithmic' identifies a system environment variable which is set by the agent in some algorithmic manner. In this case, the envVarInitValue object is not used. The value 'initStatic' identifies an environment variable array which is initialized by the agent with the associated seeEnvVarInitValue, at the time this entry is activated.
Status: current Access: read-only
OBJECT-TYPE    
  INTEGER initAlgorithmic(1), initStatic(2)  

seeEnvVarInitValue 1.3.6.1.3.1.1.2.3.1.9
The initial value used for the environment variable associated with this entry. If the associated seeEnvVarInitType object equals 'initStatic', then the agent will initialize each element of the the indicated environment variable with this value. This object may not be modified if the associated seeEnvVarStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  SeeStringLiteral  

seeEnvVarStorageType 1.3.6.1.3.1.1.2.3.1.10
The type on non-volatile storage behavior associated with this entry.
Status: current Access: read-create
OBJECT-TYPE    
  StorageType  

seeEnvVarStatus 1.3.6.1.3.1.1.2.3.1.11
The status of this entry. This object must be equal to active for the associated environment variable to be recognized within the script execution environment. Upon activation, the agent will make the environment variable visible in the indicated scope with the specified initial value. Note that if this row is activated and later deactivated, scripts which attempt to access the environment variable identified by this entry will terminate with a 'runtimeError' error status.
Status: current Access: read-create
OBJECT-TYPE    
  RowStatus  

seeOidAliasTable 1.3.6.1.3.1.1.2.4
Contains the OBJECT IDENTIFIER Alias definitions used on this SEE agent. An OID Alias variable is represented as a single read-only 'STRING' data element. The SEE agent will recognize the SeeIdentifierString specified in each entry as an OID Alias identifier token (in agent scope) with the same value. OID Alias identifier tokens can be used with any 'read-only' operator that is valid for a local variable of type 'OID'.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    SeeOidAliasEntry

seeOidAliasEntry 1.3.6.1.3.1.1.2.4.1
A conceptual row in the seeOidAliasTable. Entries are created in this table by agent or management station action. Entries may also be created by scripts via the 'oid_alias_set' function from the 'SysLib' system library. Note that the size of this table may be restricted either statically or dynamically, due to limited agent resources. An agent should include all OID aliases available in the execution environment in this table.
Status: current Access: not-accessible
OBJECT-TYPE    
  SeeOidAliasEntry  

seeOidAliasString 1.3.6.1.3.1.1.2.4.1.1
The unique identifier token string that is the target of this entry. When the agent encounters an identifier token in a script that exactly matches this string, that identifier token will be replaced with the contents of the associated seeOidAliasOID object. This token replacement will be done for processing purposes only, as the script itself will not be modified.
Status: current Access: not-accessible
OBJECT-TYPE    
  SeeIdentifierString  

seeOidAliasOID 1.3.6.1.3.1.1.2.4.1.2
The OBJECT IDENTIFIER to use as a replacement token when the identifier token identified by this entry is encountered in a script. This object may not be modified if the associated seeOidAliasStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  OBJECT IDENTIFIER  

seeOidAliasStorageType 1.3.6.1.3.1.1.2.4.1.3
The type on non-volatile storage behavior associated with this entry.
Status: current Access: read-create
OBJECT-TYPE    
  StorageType  

seeOidAliasStatus 1.3.6.1.3.1.1.2.4.1.4
The status of this entry. All values must be set appropriately before this row may be activated.
Status: current Access: read-create
OBJECT-TYPE    
  RowStatus  

seeTaskControlTable 1.3.6.1.3.1.1.3.1
Controls the operation of each task within the execution environment. Entries in this table operate independently of one another. Administrators must configure this table carefully, since it is possible for management tasks to interact with each other, since the underlying system parameters and status are shared by all tasks. The multi-threading mechanisms required to support multiple active entries in this table are beyond the scope of this document. Read-only scripts should be written to operate in a multi-threaded environment. Read-write scripts may be configured to 'run to completion' or run in a multi-threaded mode.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    SeeTaskControlEntry

seeTaskControlEntry 1.3.6.1.3.1.1.3.1.1
A conceptual row in the seeTaskControlTable. Entries are created in this table by agent or management station action. Entries are retained by the agent, as indicated by the seeTaskControlStorageType object. The smScriptOwner and smScript objects (from the Script MIB) identify the particular script associated with each management task entry.
Status: current Access: not-accessible
OBJECT-TYPE    
  SeeTaskControlEntry  

seeTaskControlIndex 1.3.6.1.3.1.1.3.1.1.1
An arbitrary index for this management task entry, which is unique for all values of smScriptOwner and smScriptName. This index allows multiple management tasks to be be configured which use the same script, as well as providing a unique integer identifier for each management task. These index values may be reused by management applications or the agent. There is no requirement to retain the semantics of an active seeTaskControlEntry once the seeTaskControlRowStatus is set to 'destroy'.
Status: current Access: not-accessible
OBJECT-TYPE    
  Integer32 1..2147483647  

seeTaskControlDescr 1.3.6.1.3.1.1.3.1.1.2
An administratively assigned textual description of this management task.
Status: current Access: read-create
OBJECT-TYPE    
  SnmpAdminString  

seeTaskControlAppProfile 1.3.6.1.3.1.1.3.1.1.3
The application profile for this management task. The associated script will be invoked, and runtime constraints enforced, according to the rules for the application profile indicated by this object. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  SeeAppProfile  

seeTaskControlExecPermissions 1.3.6.1.3.1.1.3.1.1.4
The execution permissions set for this management task. The associated script will be invoked, and runtime constraints enforced, according to the particular permissions enabled in this bit string. Note that this object does not override any characteristics indicated by the associated seeTaskControlAppProfile object. Instead, it allows further constraint of the specific execution environment and system library features available to script (on behalf of this entry). This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  SeeExecPermissions  

seeTaskControlGroupId 1.3.6.1.3.1.1.3.1.1.5
The task group identifier for this entry. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  SeeGroupIdentifier  

seeTaskControlRunMode 1.3.6.1.3.1.1.3.1.1.6
Controls the manner in which the script associated with this task is executed. There are four run modes defined, which allow some level of control over log messages, script debugging, and system access. The value 'normalRunMode' identifies a management task running in the 'normal' operational mode, in which system library function logging is disabled. Note that a script may emit logging messages via library functions, regardless of the value of this object. This mode only disables trace logging of system activity. The value 'traceRunMode' identifies a management task running in the 'trace' operational mode, in which system activity, such as calls to library functions, are logged in the seeLogControlTable. The value 'debugRunMode' identifies a management task running in the 'debug' operational mode, in which trace logging is active, except no read-write library functions are actually invoked. This allows an administrator some ability to determine the impact of a new script on the existing environment, without risking system disruption. Note that scripts which modify and then inspect system behavior may behave unexpectedly in this 'no-op' run mode. The value 'validateMode' identifies a management task that is installed in validation mode. Instead of executing the associated script, the agent will examine the entire script for correctness. Problems such as syntax errors and unresolved function names should be detected in this mode. Note that an implementation cannot completely validate OID Alias and environment variable identifier usage, since these identifier tokens can be installed dynamically, by scripts or management applications. After the validation check is done, the seeTaskControlLastResCode, seeTaskControlLastSEIndex, and seeTaskControlLastSEOffset objects will be set to non-zero values if any problems are found. The agent will also output error messages to the seeLogTable for the script. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  INTEGER normalRunMode(1), traceRunMode(2), debugRunMode(3), validateMode(4)  

seeTaskControlRunButton 1.3.6.1.3.1.1.3.1.1.7
This object allows the associated script to be executed manually by a management application. This object is only used if the associated seeTaskControlAppProfile object is equal to 'appManual', or if the associated seeTaskControlRunMode is equal to 'validateMode'. It is ignored by the agent in other situations. Setting this object to the value 'runTask(1)' will cause the script for this entry to be executed once, unless it is currently running. In that case, the agent will return an 'inconsistentValue' error instead of starting the script on behalf of this entry. As soon as the script is restarted, the agent will set this object to the value 'notPressed(2)'. An application may examine the associated seeTaskControlTaskRunning object to determine if the task is currently running. Setting this object to the value 'notPressed(2)' has no effect whatsoever.
Status: current Access: read-create
OBJECT-TYPE    
  INTEGER runTask(1), notPressed(2)  

seeTaskControlStartFn 1.3.6.1.3.1.1.3.1.1.8
The unique identifier token string that identifies the script entry point for this management task entry. Upon script invocation, the agent will attempt to execute the script function with this name. If the function does not exist, or if its inputs or return type does not match the application profile indicated by the associated seeTaskControlAppProfile object, then the agent will terminate the script invocation with a 'languageError' return status. Only two function prototype forms are supported at this time. The specific prototype to use depends on the application profile. Without return value: 'void (void);' With return value: ' (void);' Note that this object is ignored by the agent if the associated seeTaskControlRunMode is equal to 'validateMode(4)', since the agent will validate the entire script, not just this function and all possible code-paths. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  SeeIdentifierString  

seeTaskControlLifetime 1.3.6.1.3.1.1.3.1.1.9
This object indicates the maximum number of seconds that may elapse before the script associated with this entry is aborted by the agent with a 'lifeTimeExceeded' error status. This timeout mechanism applies to each invocation of a script on behalf of a specific seeTaskControlEntry. If this object is equal to zero, then the timeout mechanism is not used, and no maximum script invocation lifetime will be enforced by the agent. If this object is greater than zero, then the agent will wait until at least this number of seconds elapses before terminating the current invocation of the script with a 'lifeTimeExceeded' error status. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  Integer32 0..2147483647  

seeTaskControlEngineId 1.3.6.1.3.1.1.3.1.1.10
This object identifies the 'primary target' SNMP engine for this management task entry. This object, together with the associated seeTaskControlContextName object, defines the context associated with the seeTaskControlTriggerOid object. If this object contains a zero length string, then the local agent will be used as the target of management operations executed by the associated script. The agent will limit the value of this object to a zero-length string if the seeCapsAllowedTargets object is equal to 'localTarget'. Otherwise, this object identifies the SNMP entity of the 'primary target' for script logic embodied in the associated task. Note that a task is not limited to communication with this target. The agent will create the _TARGET_ENGINE_ID environment variable in task scope, upon activation of this entry, set to the value of this object. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  SnmpEngineIdOrNone  

seeTaskControlContextName 1.3.6.1.3.1.1.3.1.1.11
This object identifies the 'primary target' context for this management task entry. This object, together with the associated seeTaskControlEngineId object, defines the context associated with the seeTaskControlTriggerOid object. The agent will create the _TARGET_CONTEXT_NAME environment variable (array size of one) in task scope, upon activation of this entry, with the value of this object. If the associated seeTaskControlAppProfile object is equal to 'appNotifyFilter' or 'appNotifyReceiver', and this object contains a non-zero length string, then this object selects only notifications with the same contextName (or community), This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  SnmpAdminString  

seeTaskControlTriggerOid 1.3.6.1.3.1.1.3.1.1.12
An OBJECT IDENTIFIER indicating a particular OBJECT IDENTIFIER base fragment associated with the trigger event for this management task entry. This object represents different OBJECT IDENTIFIER parameters in different modes. The _TRIGGER_OID_BASE environment variable will be set to the canonical string representation for this object at the start of each trigger frame executed on behalf of this entry. Each application profile may define restrictions on the values which may be assigned to this object, such as whether complete or incomplete base fragments are permitted. The agent might not be able to validate the contents of this object at the time the object is set, since the seeTaskControlAppProfile may not be known at the time this object is set. The agent must verify the contents of this object before the associated seeTaskControlStatus is set to 'active'. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  OBJECT IDENTIFIER  

seeTaskControlTriggerInt 1.3.6.1.3.1.1.3.1.1.13
An interval of time that should pass between successive periodic evaluations of the trigger condition. If the associated seeTaskControlAppProfile object is equal to 'appWatchedVar' or 'appPeriodic', then this object identifies the minimum number of seconds that should elapse between trigger events executed on behalf of this control entry, and the value zero is not allowed. For other values of seeTaskControlAppProfile, this object is ignored by the agent, and should contain the value zero. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  Integer32 0..2147483647  

seeTaskControlTriggerOvflAct 1.3.6.1.3.1.1.3.1.1.14
Controls how the agent handles a trigger overflow condition on behalf of this management task, i.e. a new trigger event occurs which should be dispatched to this management task, but cannot because the execution on behalf of the previous trigger event has not finished. The value 'dropTrigger' indicates that a new trigger event will be dropped if a trigger overflow occurs, and a 'triggerOverflow' log message will be generated if logging is active for this entry. The value 'dropNotifyTrigger' indicates that a new trigger event will be dropped if a trigger overflow occurs. A 'triggerOverflow' log message will be generated if logging is active for this entry, and a 'seeTaskAlarm' notification will also be generated. The value 'queueTrigger' indicates that the agent will attempt to save a new trigger event if a trigger overflow occurs. If the agent cannot queue the trigger event, then a trigger overflow is handled as defined by the 'dropNotifyTrigger' enumeration. If the agent can queue the trigger event, then the event order must be preserved, and the associated script should be invoked with any queued events as soon as possible. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  INTEGER dropTrigger(1), dropNotifyTrigger(2), queueTrigger(3)  

seeTaskControlScratchpadSize 1.3.6.1.3.1.1.3.1.1.15
This object identifies the number of array elements that the _SCRATCHPAD environment variable for this task will contain. The agent will create this number of strings in the _SCRATCHPAD environment variable. The maximum length of each string is defined by the seeCapsMaxEnvStringLen object. An agent is not required to allocate (or reserve) the requested data storage until this entry is activated. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  Integer32 0..65535  

seeTaskControlResultType 1.3.6.1.3.1.1.3.1.1.16
This object identifies the base type of the script result stored in the associated seeTaskControlLastResult object. This allows the script result string to be formatted in specific ways, so it can be converted to a type other than 'STRING' in a standard way. Refer to the SeeTypeIdentifier TC for more details. Note that the agent is not required to enforce the formatting syntax requirements specified for each Type Identifier value. This object is provided as a 'formatting hint' to applications only. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  SeeTypeIdentifier  

seeTaskControlLogWriteMode 1.3.6.1.3.1.1.3.1.1.17
The type of behavior the agent will take on behalf of this entry, when the total number of octets of log output in the associated seeLogTable equals or exceeds the associated seeTaskControlMaxLogSize value for this entry. If this object contains the value 'wrapWhenFull' and the the maximum log size is exceeded, then the agent will delete enough of the oldest seeLogEntries (with all the same seeTaskControlIndex major index value) to make room for the new entry. If this object contains the value 'stopWhenFull(2)', and the the maximum log size is exceeded, then the agent will stop adding seeLogEntries. Instead, the associated seeTaskControlLostLogOctets object will be incremented by the size of the seeLogChunk object that would have been created. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  INTEGER wrapWhenFull(1), stopWhenFull(2)  

seeTaskControlMaxLogSize 1.3.6.1.3.1.1.3.1.1.18
The maximum number of octets that may be written to seeLogEntries on behalf of this entry. If this object contains the value '-1', then no maximum size will be enforced for the associated seeLogTable. The size of the log table is subject to only to agent resources. If this object contains the value '0', then logging will be disabled for this entry. Otherwise, this object identifies the maximum allowed size of the combined lengths of the associated seeLogChunk OCTET STRING objects, created in the seeLogTable on behalf of this entry. Refer to the seeTaskControlLogWriteMode for a description of agent behavior when the log size is equal or larger in size to the value specified by this object. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  Integer32 -1..2147483647  

seeTaskControlMaxLogChunkSize 1.3.6.1.3.1.1.3.1.1.19
The maximum number of octets that may be written to any seeLogChunk object created on behalf of this entry. An application should limit the value of this object in order to prevent a 'tooBig' SNMP PDU error to be generated for get requests of the seeLogChunk object. The agent must not create entries larger than this number of octets in the seeLogTable on behalf of this entry. Note that an agent may choose to fragment log entries at values lower than indicated by this object. This object may not be modified if the associated seeTaskControlStatus object is equal to active.
Status: current Access: read-create
OBJECT-TYPE    
  Integer32 255..65535  

seeTaskControlLogClearButton 1.3.6.1.3.1.1.3.1.1.20
This object allows the contents of the seeLogTable created on behalf of this entry to be deleted. If this object is set to the value 'clearLog' the agent will delete all related entries in the seeLogTable, and then set the value of this object to the value 'notPressed'. Setting this object to the value 'notPressed(2)' has no effect whatsoever.
Status: current Access: read-create
OBJECT-TYPE    
  INTEGER clearLog(1), notPressed(2)  

seeTaskControlNumExecOks 1.3.6.1.3.1.1.3.1.1.21
This counter is incremented by one, each time the script associated with this control entry is executed, and completed with a return status of 'noError'.
Status: current Access: read-only
OBJECT-TYPE    
  Counter32  

seeTaskControlNumExecFails 1.3.6.1.3.1.1.3.1.1.22
This counter is incremented by one, each time the script associated with this control entry is executed, and completed with a return status other than 'noError'.
Status: current Access: read-only
OBJECT-TYPE    
  Counter32  

seeTaskControlLastResCode 1.3.6.1.3.1.1.3.1.1.23
The system result status value obtained the last time the associated script was executed.
Status: current Access: read-only
OBJECT-TYPE    
  SeeResultCode  

seeTaskControlLastResult 1.3.6.1.3.1.1.3.1.1.24
The string result value obtained the last time the associated script was executed. This object may contain a value in a different data type, string-encoded according to the encoding rules for the Type Identifier indicated by the associated seeTaskControlResultType object. If the seeTaskControlAppProfile object for this entry is equal to 'appVirtualGet', and the seeTaskControlStatus is equal to 'active', then the associated script will be be invoked each time this object is retrieved. The empty string is returned if no return value is available on behalf of this entry.
Status: current Access: read-only
OBJECT-TYPE    
  OCTET STRING  

seeTaskControlLastSEIndex 1.3.6.1.3.1.1.3.1.1.25
The smCodeIndex value of the SEE script chunk, in which the first script syntax error was found during the execution of the associated script. If no syntax error has been detected, or if a particular script has not yet been executed by the agent, then this object will contain the value zero.
Status: current Access: read-only
OBJECT-TYPE    
  Unsigned32 1..4294967295  

seeTaskControlLastSEOffset 1.3.6.1.3.1.1.3.1.1.26
The offset position within the associated smCodeText OCTET STRING in which the first script syntax error was found during the execution of the associated script. If no syntax error has been detected, or if a particular script has not yet been executed by the agent, then this object will contain the value '-1'. Otherwise, this object identifies the number of octets into the script code string identified by the associated seeTaskControlLastSEIndex object. Note that position of the first octet in the string is identified by the value '0', not the value '1'.
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 -1..1023  

seeTaskControlTaskRunning 1.3.6.1.3.1.1.3.1.1.27
Indicates whether the agent is currently running the associated script on behalf of this management task entry. The value 'true' indicates this task is currently running.
Status: current Access: read-only
OBJECT-TYPE    
  TruthValue  

seeTaskControlLastTrigTime 1.3.6.1.3.1.1.3.1.1.28
The value of sysUpTime the last time a trigger event for this entry occurred, or zero if no such event has occurred.
Status: current Access: read-only
OBJECT-TYPE    
  TimeStamp  

seeTaskControlCurLogSize 1.3.6.1.3.1.1.3.1.1.29
The current number of octets contained in all seeLogChunk instances, existing in the seeLogTable on behalf of this entry.
Status: current Access: read-only
OBJECT-TYPE    
  Gauge32  

seeTaskControlLostLogOctets 1.3.6.1.3.1.1.3.1.1.30
An indication that log entries on behalf of this task are not being captured in the seeLogTable. This counter is incremented by the number of octets which would have been written to the associated seeLogTable on behalf of this entry, but were not written, for whatever reason.
Status: current Access: read-only
OBJECT-TYPE    
  Counter32  

seeTaskControlLastLogWriteTime 1.3.6.1.3.1.1.3.1.1.31
The value of sysUpTime the last time an entry was added to the seeLogTable on behalf of this task. A management application can use this object to determine when new log output has been written for this task. This timestamp will be updated when a seeLogEntry is successfully added to the seeLogTable on behalf of this entry. Initially, this object will contain the value zero.
Status: current Access: read-only
OBJECT-TYPE    
  TimeStamp  

seeTaskControlStorageType 1.3.6.1.3.1.1.3.1.1.32
The type on non-volatile storage behavior associated with this entry.
Status: current Access: read-create
OBJECT-TYPE    
  StorageType  

seeTaskControlStatus 1.3.6.1.3.1.1.3.1.1.33
The status of this entry. All values must be set appropriately before this row may be activated. All valid row creation states should be supported, including 'createAndWait' and 'notInService'.
Status: current Access: read-create
OBJECT-TYPE    
  RowStatus  

seeLogTable 1.3.6.1.3.1.1.3.2
Contains the individual output chunks which comprise the log output for the associated seeTaskControlEntry.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    SeeLogEntry

seeLogEntry 1.3.6.1.3.1.1.3.2.1
A conceptual row in the seeLogTable. Entries are created in this table by agent or script action. The management task associated with the log output contained in this table is identified by the seeTaskControlIndex value in the INDEX clause.
Status: current Access: not-accessible
OBJECT-TYPE    
  SeeLogEntry  

seeLogIndex 1.3.6.1.3.1.1.3.2.1.1
The minor index for this log entry. The agent should use consecutive index values until the maximum value is reached, before reusing index values. However, this object should be 'reset' to the value '1' if the associated seeTaskControlLogClearButton object is set to 'clearLog'.
Status: current Access: not-accessible
OBJECT-TYPE    
  Integer32 1..2147483647  

seeLogCreateTOD 1.3.6.1.3.1.1.3.2.1.2
The current time of day (e.g. value of schedLocalTime) at the time this log entry was added to this table. If the seeCapsTodClock object is equal to 'noTodClock', then this object will contain the empty string.
Status: current Access: read-only
OBJECT-TYPE    
  DateAndTime  

seeLogCreateTime 1.3.6.1.3.1.1.3.2.1.3
The value of sysUpTime at the time this log entry was added to this table.
Status: current Access: read-only
OBJECT-TYPE    
  TimeStamp  

seeLogChunk 1.3.6.1.3.1.1.3.2.1.4
A log fragment created on behalf of the associated seeTaskControlEntry. This object will not be greater in length than the associated seeTaskControlMaxLogChunkSize object.
Status: current Access: read-only
OBJECT-TYPE    
  SeeLogOutput  

seeLanguage 1.3.6.1.3.1.1.4.1
OBJECT IDENTIFIER    

seeLibraries 1.3.6.1.3.1.1.4.2
OBJECT IDENTIFIER    

seeTraps 1.3.6.1.3.1.2.0
OBJECT IDENTIFIER    

seeTaskAbort 1.3.6.1.3.1.2.0.1
This notification is generated whenever a management task terminates with a result status other than 'noError', if the seeTaskAbortNotifyEnabled object is equal to 'true'. The seeTaskControlAppProfile identifies the type of application that terminated with an error status, and the seeTaskControlLastResCode identifies the specific error that occurred. An implementation may restrict the frequency that these notifications are actually emitted by the agent.
Status: current Access: read-only
NOTIFICATION-TYPE    

seeTaskAlarm 1.3.6.1.3.1.2.0.2
This notification is generated by script action (on behalf of a particular management task) via the 'SnmpMsgLib' system library, if the seeTaskAlarmNotifyEnabled object is equal to 'true'. The seeTaskControlAppProfile object is always encoded first, as a means of identifying the type of application and the seeTaskControlEntry. Individual tasks will likely add other varbinds as well. An implementation may restrict the frequency that these notifications are actually emitted by the agent.
Status: current Access: read-only
NOTIFICATION-TYPE    

seeCompliances 1.3.6.1.3.1.3.1
OBJECT IDENTIFIER    

seeGroups 1.3.6.1.3.1.3.2
OBJECT IDENTIFIER    

seeCompliance 1.3.6.1.3.1.3.1.1
Describes the requirements for conformance to the Script Execution Environment MIB.
Status: current Access: read-only
MODULE-COMPLIANCE    

seeCapsGroup 1.3.6.1.3.1.3.2.1
A collection of objects used to identify some SEE runtime capabilities provided by this agent.
Status: current Access: read-only
OBJECT-GROUP    

seeEnvGroup 1.3.6.1.3.1.3.2.2
A collection of objects used to control the configuration of the execution environment.
Status: current Access: read-only
OBJECT-GROUP    

seeExecGroup 1.3.6.1.3.1.3.2.3
A collection of objects used to control the execution of management tasks.
Status: current Access: read-only
OBJECT-GROUP    

seeNotificationsGroup 1.3.6.1.3.1.3.2.4
The notifications emitted by the SEE MIB.
Status: current Access: read-only
NOTIFICATION-GROUP