MLM-MIB
File:
MLM-MIB.mib (29076 bytes)
Imported modules
Imported symbols
Defined Types
MlmCompileEntry |
|
SEQUENCE |
|
|
|
|
mlmCompileIndex |
INTEGER |
|
|
mlmScriptNumber |
INTEGER |
|
|
mlmScriptName |
DisplayString |
|
|
mlmCompileResult |
INTEGER |
|
|
mlmExecutionArgs |
OCTET STRING |
|
|
mlmExecutionPeriod |
INTEGER |
|
|
mlmRowStatus |
RowStatus |
|
|
mlmPermanence |
INTEGER |
|
MlmScriptEntry |
|
SEQUENCE |
|
|
|
|
mlmScriptIndex |
INTEGER |
|
|
mlmScriptLineIndex |
INTEGER |
|
|
mlmScriptCode |
OCTET STRING |
|
|
mlmCompileErrors |
OCTET STRING |
|
MlmResultEntry |
|
SEQUENCE |
|
|
|
|
mlmCompileIndex |
INTEGER |
|
|
mlmResultIndex |
INTEGER |
|
|
mlmResultOID |
OBJECT IDENTIFIER |
|
|
mlmResultType |
INTEGER |
|
|
mlmIntegerValue |
INTEGER |
|
|
mlmCounter32Value |
Counter32 |
|
|
mlmGauge32Value |
Gauge32 |
|
|
mlmTimeTicksValue |
TimeTicks |
|
|
mlmIpAddressValue |
IpAddress |
|
|
mlmOctetStringValue |
OCTET STRING |
|
|
mlmObjectIDValue |
OBJECT IDENTIFIER |
|
|
mlmCounter64Value |
Counter64 |
|
|
mlmRuntimeError |
OCTET STRING |
|
Defined Values
mlmMIB |
1.3.6.1.4.1.99.42 |
The MIB module for the SNMP Mid-Level-Manager MIB |
MODULE-IDENTITY |
|
|
|
mlmLock |
1.3.6.1.4.1.99.42.1.1 |
This variable is used for creating new rows in the
mlmCompileTable. When creating a new row, this
variable must be set as well as the mlmRowStatus. If
the value it is set to does not equal its current
value, the set completely fails. A manager should
only perform set requests on rows in the
mlmCompileTable which it has created using mlmLock.
The value of mlmLock is equal to the first unused row
in the mlmCompileTable. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
TestAndIncr |
|
|
mlmScriptWrite |
1.3.6.1.4.1.99.42.1.2 |
This variable is used to instruct the MLM to write
a script stored in the mlmScriptTable to non-volatile
storage. This is done by performing a set on the
variable. The value to which it is set should be
the index of a row in the mlmCompileTable, which
should contain a non-zero value for mlmScriptNumber,
and a non-empty value for mlmScriptName. If these
two values are not set, the set will fail with a
BAD_VALUE_ERROR. Otherwise, the script in the
mlmScriptTable referenced by the value of
mlmScriptNumber is written to non-volatile memory
using the name in mlmScriptName, and the value of
mlmScriptNumber is set to 0. In addition, any other
entries in the mlmCompileTable whose values for
mlmScriptNumber and mlmScriptName match those for
the row being written will also have their values
for mlmScriptNumber set to 0. Finally, if there
are no more references to the script stored in the
mlmScriptTable, the script will be removed.
The value returned for this variable on a get request
should be the last value it was successfully set to,
or zero (0) if it has never been set. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
INTEGER |
0..2147483647 |
|
mlmExecutionSpeed |
1.3.6.1.4.1.99.42.1.3 |
This variable controls the performance of scripts.
The Mid-Level-Manager is event driven, and uses
timeout events to advance execution of all currently
running (active) scripts. This variable controls this
timeout interval. Setting it to a low value will
cause scripts to run faster, but the MLM will not
respond to SNMP requests as quickly. Setting it to a
higher value will reduce the speed of scripts, but
will allow the MLM to respond to SNMP requests more
quickly. This value is measured in 100ths of
seconds. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
INTEGER |
1..2147483647 |
|
mlmTimeSlice |
1.3.6.1.4.1.99.42.1.4 |
This variable controls the time-slice size for
executing scripts. It works in conjunction with the
mlmExecutionSpeed variable. After each timeout, each
script is advanced by the number of instructions
specified by this variable (or until blocked on a
network request). If the value of this variable is
negative, then all scripts will be advanced to
completion, or until blocked on a network request. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
Integer32 |
|
|
mlmNextScript |
1.3.6.1.4.1.99.42.1.8 |
This variable is used for creating scripts in
the mlmScriptTable. It should be used for creating
scripts from scratch, or for reading scripts from
non-volatile storage into the mlmScriptTable (by setting
mlmScriptNumber as described later). The current value
of mlmNextScript should first be retrieved, and this
value should then be included in the set request for
creating the first row of a new script, or in the
set request for changing mlmScriptNumber to read
a script from non-volatile storage. If the value
it is set to does not equal its current value, the
set completely fails. A manager should only perform
set requests on rows in the mlmScriptTable which
it has created using mlmNextScript. The value of
mlmNextScript is equal to the first unused set of rows
in the mlmScriptTable. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
TestAndIncr |
|
|
mlmCompileTable |
1.3.6.1.4.1.99.42.1.5 |
Contains list of runnable scripts, including indices
into the mlmScriptTable, script arguments, and script
execution period |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
MlmCompileEntry |
|
mlmCompileEntry |
1.3.6.1.4.1.99.42.1.5.1 |
An entry in the mlm compile table. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
MlmCompileEntry |
|
|
mlmCompileIndex |
1.3.6.1.4.1.99.42.1.5.1.1 |
Unique identifier for a mlmCompileEntry. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
1..2147483647 |
|
mlmScriptNumber |
1.3.6.1.4.1.99.42.1.5.1.2 |
Pointer into the mlmScriptTable. If this is not
provided when the row is created, it defaults to a
non-existent script. If the value for this
variable references a non-empty script, this script
will be used instead of any script referenced by
the mlmScriptName variable. If mlmScriptNumber is
set to a non-zero value from a zero value, and
the value to which it is set references an unused
set of entries in the mlmScriptTable, and
the value of mlmScriptName is not empty, the script
referenced by mlmScriptName will be read from
non-volatile memory into the appropriate entries of
the mlmScriptTable. The mlmNextScript variable can
be retrieved to find the next unused set of entries
in the mlmScriptTable. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
INTEGER |
0..2147483647 |
|
mlmScriptName |
1.3.6.1.4.1.99.42.1.5.1.3 |
This variable is used to reference a script stored
in non-volatile memory, instead of entries in the
mlmScriptTable. The mlmScriptName variable can also
be used for downloading scripts from a management
station to non-volatile storage on the agent, or
for examining the contents of a script stored in
non-volatile memory on the agent. If this variable
is not empty, and mlmScriptNumber is equal to zero,
the script referenced by mlmScriptName will be run
when mlmRowStatus is set to the appropriate value.
When launching a script from within a script, the
string : can be used as the script
filename. This will cause the script stored in the
mlmScriptTable with index to be
executed. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
DisplayString |
|
|
mlmCompileResult |
1.3.6.1.4.1.99.42.1.5.1.4 |
Indicates whether the script has been compiled(0),
the number of errors found during compilation, or that
the script has not been compiled(-1). |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Integer32 |
|
|
mlmExecutionArgs |
1.3.6.1.4.1.99.42.1.5.1.5 |
Space separated list of arguments to be passed to the
script when it is executed. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
OCTET STRING |
Size(0..2048) |
|
mlmExecutionPeriod |
1.3.6.1.4.1.99.42.1.5.1.6 |
Specifies the time period which the agent will wait
when the script finished executing. After this
period, the script will be executed again. The value
is measured in 100ths of a second. A value of 0 means
periodic polling is disabled for this table entry. A
script may still be explicitly halted/restarted when
periodic polling is enabled. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
INTEGER |
0..2147483647 |
|
mlmRowStatus |
1.3.6.1.4.1.99.42.1.5.1.7 |
To create new row, a manager sets this object to
createAndWait. Until this object is set to active or
notInService, its value is returned as notReady. If
its value is notReady, and is set to notInService, the
script is compiled. If its value is notReady and is
set to active, the script is compiled and executed.
If its value is notInService and is set to active, the
script is executed. When the script is finished
executing, the agent sets this object to notInService.
To halt execution of a script, the manager sets this
object to notInService. To force a script to be re-
compiled, the manager sets this object to notReady,
and then to notInService. To delete a row, the
manager sets this object to destroy. When all rows
with a particular mlmScriptNumber have been destroyed,
all rows with corresponding mlmScriptIndex values in the
mlmScriptTable are destroyed. The value of
mlmRowStatus may be set to notInService or to active
by the agent if the mlmExecutionPeriod variable is set
to a value greater than zero. If the manager sets
mlmRowStatus to active or notInService when the values
of mlmScriptNumber and mlmScriptName to not reference
a script, the agent will return a BAD_VALUE_ERROR. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
RowStatus |
|
|
mlmPermanence |
1.3.6.1.4.1.99.42.1.5.1.8 |
This column indicates how the MLM should treat the
current row in the mlmScriptCompileTable. If the value
is 'temporary', no record of the row is kept when the
MLM is restarted (e.g. the machine is rebooted).
If the value is 'startup', the row is recorded in
non-volatile memory, is restored when the MLM is
restarted, and the row is immediately activated
(i.e. the script is run) when the MLM is restarted.
If the value is 'permanent', the row is stored in
non-volatile memory and is restored when the MLM is
restarted. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
INTEGER |
temporary(1), startup(2), permanent(3) |
|
mlmScriptEntry |
1.3.6.1.4.1.99.42.1.6.1 |
A mlmScriptTable entry. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
MlmScriptEntry |
|
|
mlmScriptIndex |
1.3.6.1.4.1.99.42.1.6.1.1 |
Index into the mlmScriptTable. This is the major
index, and indicates which script the row belongs to.
This object matches the mlmScriptNumber variable in
the mlmCompileTable. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
1..2147483647 |
|
mlmScriptLineIndex |
1.3.6.1.4.1.99.42.1.6.1.2 |
Index into the mlmScriptTable. This is the minor
index, and indicates the line number of this row
within the script indicated by mlmScriptIndex. Empty
rows are not allowed in the mlmScriptTable, so the
rows with a particular mlmScriptIndex value must have
ascending values starting at 1. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
1..2147483647 |
|
mlmScriptCode |
1.3.6.1.4.1.99.42.1.6.1.3 |
This variable contains the actual code of the
script. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
OCTET STRING |
Size(0..132) |
|
mlmCompileErrors |
1.3.6.1.4.1.99.42.1.6.1.4 |
This contains compile time errors. The error appears
in the row in which the error was found. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
OCTET STRING |
Size(0..132) |
|
mlmResultTable |
1.3.6.1.4.1.99.42.1.7 |
Table containing results of script execution. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
MlmResultEntry |
|
mlmResultEntry |
1.3.6.1.4.1.99.42.1.7.1 |
Note that rows in this table are only visible after a
script has been run. If a script is currently
running, the rows will reflect the values of the
previous run (or will be absent if this is the first
time the script is run). It is unfortunate that
SNMP/SNMPv2 does not provide a better way to return a
discriminated union. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
MlmResultEntry |
|
|
mlmResultIndex |
1.3.6.1.4.1.99.42.1.7.1.1 |
Index into the list of VarBinds returned by a
script. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
1..2147483647 |
|
mlmResultOID |
1.3.6.1.4.1.99.42.1.7.1.2 |
Contains the OIDs of the VarBinds returned from a
script. These may not necessarily have any meaning,
depending on the particular script. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
OBJECT IDENTIFIER |
|
|
mlmResultType |
1.3.6.1.4.1.99.42.1.7.1.3 |
Contains a code representing the type of the varbind
returned by the script, or a 1 if an error occurred
during execution. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
error(1), nothing(2), null(3), integer(4), counter32(5), gauge32(6), timeticks(7), ipaddress(8), octetstring(9), objectid(10), counter64(13) |
|
mlmIntegerValue |
1.3.6.1.4.1.99.42.1.7.1.4 |
Signed 32-bit integer value |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Integer32 |
|
|
mlmGauge32Value |
1.3.6.1.4.1.99.42.1.7.1.6 |
32-bit gauge value |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Gauge32 |
|
|
mlmOctetStringValue |
1.3.6.1.4.1.99.42.1.7.1.9 |
Octet string value |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
OCTET STRING |
Size(0..2048) |
|
mlmObjectIDValue |
1.3.6.1.4.1.99.42.1.7.1.10 |
object id value |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
OBJECT IDENTIFIER |
|
|
mlmRuntimeError |
1.3.6.1.4.1.99.42.1.7.1.15 |
Contains a description of any runtime errors which
occurred during script execution. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
OCTET STRING |
Size(0..132) |
|
mlmCompliance |
1.3.6.1.4.1.99.42.2.1.1 |
The compliance statement for SNMPv2 entities which
implement the SNMP MLM Script MIB. |
Status: current |
Access: read-only |
MODULE-COMPLIANCE |
|
|
|
mlmMIBGroup |
1.3.6.1.4.1.99.42.2.2.1 |
A collection of objects providing an interface for
configuring and controlling an SNMP MLM. |
Status: current |
Access: read-only |
OBJECT-GROUP |
|
|
|