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) |
|
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) |
|
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 |
|
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) |
|
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 |
|
|
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 |
|
|
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 |
|
|
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) |
|
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 |
|
|
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 |
|
|