SCALAR OBJECTS

Name	Type	Access	OID	Description

TABLE OBJECTS

Table smLangTable

Table Name	smLangTable
In MIB	DISMAN-SCRIPT-MIB
Registered at OID	.1.3.6.1.2.1.64.1.1
Table Description	This table lists supported script languages.
Row Description	An entry describing a particular language.

smLangTable Indexes:

Name	Type	Access	Description
1 smLangIndex	INTEGER32 Legal values: 1 .. 2147483647	NoAccess	The locally arbitrary, but unique identifier associated with this language entry. The value is expected to remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. Note that the data type and the range of this object must be consistent with the definition of smScriptLanguage.

Other smLangTable Columns:

Name	Type	Access	Description
2 smLangLanguage	OBJECTID	ReadOnly	The globally unique identification of the language.
3 smLangVersion	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The version number of the language. The zero-length string shall be used if the language does not have a version number. It is suggested that the version number consist of one or more decimal numbers separated by dots, where the first number is called the major version number.
4 smLangVendor	OBJECTID	ReadOnly	An object identifier which identifies the vendor who provides the implementation of the language. This object identifier SHALL point to the object identifier directly below the enterprise object identifier {1 3 6 1 4 1} allocated for the vendor. The value must be the object identifier {0 0} if the vendor is not known.
5 smLangRevision	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The version number of the language implementation. The value of this object must be an empty string if version number of the implementation is unknown. It is suggested that the value consist of one or more decimal numbers separated by dots, where the first number is called the major version number.
6 smLangDescr	OCTETSTR Legal Lengths: 0 .. 255 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. A textual description of the language.

Table smExtsnTable

Table Name	smExtsnTable
In MIB	DISMAN-SCRIPT-MIB
Registered at OID	.1.3.6.1.2.1.64.1.2
Table Description	This table lists supported language extensions.
Row Description	An entry describing a particular language extension.

smExtsnTable Indexes:

Name	Type	Access	Description
1 smLangIndex	INTEGER32 Legal values: 1 .. 2147483647	NoAccess	The locally arbitrary, but unique identifier associated with this language entry. The value is expected to remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. Note that the data type and the range of this object must be consistent with the definition of smScriptLanguage.
1 smExtsnIndex	INTEGER32 Legal values: 1 .. 2147483647	NoAccess	The locally arbitrary, but unique identifier associated with this language extension entry. The value is expected to remain constant at least from one re-initialization of the entity's network management system to the next re-initialization.

Other smExtsnTable Columns:

Name	Type	Access	Description
2 smExtsnExtension	OBJECTID	ReadOnly	The globally unique identification of the language extension.
3 smExtsnVersion	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The version number of the language extension. It is suggested that the version number consist of one or more decimal numbers separated by dots, where the first number is called the major version number.
4 smExtsnVendor	OBJECTID	ReadOnly	An object identifier which identifies the vendor who provides the implementation of the extension. The object identifier value should point to the OID node directly below the enterprise OID {1 3 6 1 4 1} allocated for the vendor. The value must by the object identifier {0 0} if the vendor is not known.
5 smExtsnRevision	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The version number of the extension implementation. The value of this object must be an empty string if version number of the implementation is unknown. It is suggested that the value consist of one or more decimal numbers separated by dots, where the first number is called the major version number.
6 smExtsnDescr	OCTETSTR Legal Lengths: 0 .. 255 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. A textual description of the language extension.

Table smScriptTable

Table Name	smScriptTable
In MIB	DISMAN-SCRIPT-MIB
Registered at OID	.1.3.6.1.2.1.64.1.3.1
Table Description	This table lists and describes locally known scripts.
Row Description	An entry describing a particular script. Every script that is stored in non-volatile memory is required to appear in this script table.

smScriptTable Indexes:

Name	Type	Access	Description
1 smScriptOwner	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	NoAccess	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The manager who owns this row in the smScriptTable.
2 smScriptName	OCTETSTR Legal Lengths: 1 .. 32 SnmpAdminString	NoAccess	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The locally-unique, administratively assigned name for this script. This object allows an smScriptOwner to have multiple entries in the smScriptTable. This value of this object may be used to derive the name (e.g. a file name) which is used by the Script MIB implementation to access the script in non-volatile storage. The details of this mapping are implementation specific. However, the mapping needs to ensure that scripts created by different owners with the same script name do not map to the same name in non-volatile storage.

Other smScriptTable Columns:

Name	Type	Access	Description
3 smScriptDescr	OCTETSTR Legal Lengths: 0 .. 255 SnmpAdminString	Create	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. A description of the purpose of the script.
4 smScriptLanguage	INTEGER32 Legal values: 0 .. 2147483647	Create	The value of this object type identifies an entry in the smLangTable which is used to execute this script. The special value 0 may be used by hard-wired scripts that can not be modified and that are executed by internal functions. Set requests to change this object are invalid if the value of smScriptOperStatus is `enabled' or `compiling' and will result in an inconsistentValue error. Note that the data type and the range of this object must be consistent with the definition of smLangIndex.
5 smScriptSource	OCTETSTR Legal Lengths: 0 .. 255 DisplayString	Create	Note: this object is based on the DisplayString TEXTUAL-CONVENTION. This object either contains a reference to the script source or an empty string. A reference must be given in the form of a Uniform Resource Locator (URL) as defined in RFC 2396. The allowed character sets and the encoding rules defined in RFC 2396 section 2 apply. When the smScriptAdminStatus object is set to `enabled', the Script MIB implementation will `pull' the script source from the URL contained in this object if the URL is not empty. An empty URL indicates that the script source is loaded from local storage. The script is read from the smCodeTable if the value of smScriptStorageType is volatile. Otherwise, the script is read from non-volatile storage. Note: This document does not mandate implementation of any specific URL scheme. An attempt to load a script from a nonsupported URL scheme will cause the smScriptOperStatus to report an `unknownProtocol' error. Set requests to change this object are invalid if the value of smScriptOperStatus is `enabled', `editing', `retrieving' or `compiling' and will result in an inconsistentValue error.
6 smScriptAdminStatus	INTEGER Value Label/Meaning 1 enabled 2 disabled 3 editing	Create	The value of this object indicates the desired status of the script. See the definition of smScriptOperStatus for a description of the values. When the smScriptAdminStatus object is set to `enabled' and the smScriptOperStatus is `disabled' or one of the error states, the Script MIB implementation will `pull' the script source from the URL contained in the smScriptSource object if the URL is not empty.
7 smScriptOperStatus	INTEGER Value Label/Meaning 1 enabled 2 disabled 3 editing 4 retrieving 5 compiling 6 noSuchScript 7 accessDenied 8 wrongLanguage 9 wrongVersion 10 compilationFailed 11 noResourcesLeft 12 unknownProtocol 13 protocolFailure 14 genericError	ReadOnly	The actual status of the script in the runtime system. The value of this object is only meaningful when the value of the smScriptRowStatus object is `active'. The smScriptOperStatus object may have the following values: - `enabled' indicates that the script is available and can be started by a launch table entry. - `disabled' indicates that the script can not be used. - `editing' indicates that the script can be modified in the smCodeTable. - `retrieving' indicates that the script is currently being loaded from non-volatile storage or a remote system. - `compiling' indicates that the script is currently being compiled by the runtime system. - `noSuchScript' indicates that the script does not exist at the smScriptSource. - `accessDenied' indicates that the script can not be loaded from the smScriptSource due to a lack of permissions. - `wrongLanguage' indicates that the script can not be loaded from the smScriptSource because of a language mismatch. - `wrongVersion' indicates that the script can not be loaded from the smScriptSource because of a language version mismatch. - `compilationFailed' indicates that the compilation failed. - `noResourcesLeft' indicates that the runtime system does not have enough resources to load the script. - `unknownProtocol' indicates that the script could not be loaded from the smScriptSource because the requested protocol is not supported. - `protocolFailure' indicates that the script could not be loaded from the smScriptSource because of a protocol failure. - `genericError' indicates that the script could not be loaded due to an error condition not listed above. The `retrieving' and `compiling' states are transient states which will either lead to one of the error states or the `enabled' state. The `disabled' and `editing' states are administrative states which are only reached by explicit management operations. All launch table entries that refer to this script table entry shall have an smLaunchOperStatus value of `disabled' when the value of this object is not `enabled'.
8 smScriptStorageType	INTEGER StorageType (ENUM list below)	Create	Note: this object is based on the StorageType TEXTUAL-CONVENTION. This object defines whether this row and the script controlled by this row are kept in volatile storage and lost upon reboot or if this row is backed up by non-volatile or permanent storage. The storage type of this row always complies with the value of this entry if the value of the corresponding RowStatus object is `active'. However, the storage type of the script controlled by this row may be different, if the value of this entry is `non-volatile'. The script controlled by this row is written into local non-volatile storage if the following condition becomes true: (a) the URL contained in the smScriptSource object is empty and (b) the smScriptStorageType is `nonVolatile' and (c) the smScriptOperStatus is `enabled' Setting this object to `volatile' removes a script from non-volatile storage if the script controlled by this row has been in non-volatile storage before. Attempts to set this object to permanent will always fail with an inconsistentValue error. The value of smScriptStorageType is only meaningful if the value of the corresponding RowStatus object is `active'. If smScriptStorageType has the value permanent(4), then all objects whose MAX-ACCESS value is read-create must be writable, with the exception of the smScriptStorageType and smScriptRowStatus objects, which shall be read-only.
9 smScriptRowStatus	INTEGER RowStatus (ENUM list below)	Create	Note: this object is based on the RowStatus TEXTUAL-CONVENTION. A control that allows entries to be added and removed from this table. Changing the smScriptRowStatus from `active' to `notInService' will remove the associated script from the runtime system. Deleting conceptual rows from this table may affect the deletion of other resources associated with this row. For example, a script stored in non-volatile storage may be removed from non-volatile storage. An entry may not exist in the `active' state unless all required objects in the entry have appropriate values. Rows that are not complete or not in service are not known by the script runtime system. Attempts to `destroy' a row or to set a row `notInService' while the smScriptOperStatus is `enabled' will result in an inconsistentValue error. Attempts to `destroy' a row or to set a row `notInService' where the value of the smScriptStorageType object is `permanent' or `readOnly' will result in an inconsistentValue error. The value of this object has no effect on whether other objects in this conceptual row can be modified.
10 smScriptError	OCTETSTR Legal Lengths: 0 .. 255 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. This object contains a descriptive error message if the transition into the operational status `enabled' failed. Implementations must reset the error message to a zero-length string when a new attempt to change the script status to `enabled' is started.
11 smScriptLastChange	OCTETSTR Legal Lengths: 8 , 11 DateAndTime	ReadOnly	Note: this object is based on the DateAndTime TEXTUAL-CONVENTION. The date and time when this script table entry was last modified. The value '0000000000000000'H is returned if the script table entry has not yet been modified. Note that the resetting of smScriptError is not considered a change of the script table entry.

Table smCodeTable

Table Name	smCodeTable
In MIB	DISMAN-SCRIPT-MIB
Registered at OID	.1.3.6.1.2.1.64.1.3.2
Table Description	This table contains the script code for scripts that are written via SNMP write operations.
Row Description	An entry describing a particular fragment of a script.

smCodeTable Indexes:

Name	Type	Access	Description
1 smScriptOwner	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	NoAccess	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The manager who owns this row in the smScriptTable.
2 smScriptName	OCTETSTR Legal Lengths: 1 .. 32 SnmpAdminString	NoAccess	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The locally-unique, administratively assigned name for this script. This object allows an smScriptOwner to have multiple entries in the smScriptTable. This value of this object may be used to derive the name (e.g. a file name) which is used by the Script MIB implementation to access the script in non-volatile storage. The details of this mapping are implementation specific. However, the mapping needs to ensure that scripts created by different owners with the same script name do not map to the same name in non-volatile storage.
1 smCodeIndex	UNSIGNED32 Legal values: 1 .. -1	NoAccess	The index value identifying this code fragment.

Other smCodeTable Columns:

Name	Type	Access	Description
2 smCodeText	OCTETSTR Legal Lengths: 1 .. 1024	Create	The code that makes up a fragment of a script. The format of this code fragment depends on the script language which is identified by the associated smScriptLanguage object.
3 smCodeRowStatus	INTEGER RowStatus (ENUM list below)	Create	Note: this object is based on the RowStatus TEXTUAL-CONVENTION. A control that allows entries to be added and removed from this table. The value of this object has no effect on whether other objects in this conceptual row can be modified.

Table smLaunchTable

Table Name	smLaunchTable
In MIB	DISMAN-SCRIPT-MIB
Registered at OID	.1.3.6.1.2.1.64.1.4.1
Table Description	This table lists and describes scripts that are ready to be executed together with their parameters.
Row Description	An entry describing a particular executable script.

smLaunchTable Indexes:

Name	Type	Access	Description
1 smLaunchOwner	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	NoAccess	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The manager who owns this row in the smLaunchTable. Every instance of a running script started from a particular entry in the smLaunchTable (i.e. entries in the smRunTable) will be owned by the same smLaunchOwner used to index the entry in the smLaunchTable. This owner is not necessarily the same as the owner of the script itself (smLaunchScriptOwner).
2 smLaunchName	OCTETSTR Legal Lengths: 1 .. 32 SnmpAdminString	NoAccess	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The locally-unique, administratively assigned name for this launch table entry. This object allows an smLaunchOwner to have multiple entries in the smLaunchTable. The smLaunchName is an arbitrary name that must be different from any other smLaunchTable entries with the same smLaunchOwner but can be the same as other entries in the smLaunchTable with different smLaunchOwner values. Note that the value of smLaunchName is not related in any way to the name of the script being launched.

Other smLaunchTable Columns:

Name	Type	Access	Description
3 smLaunchScriptOwner	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	Create	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The value of this object in combination with the value of smLaunchScriptName identifies the script that can be launched from this smLaunchTable entry. Attempts to write this object will fail with an inconsistentValue error if the value of smLaunchOperStatus is `enabled'.
4 smLaunchScriptName	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	Create	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The value of this object in combination with the value of the smLaunchScriptOwner identifies the script that can be launched from this smLaunchTable entry. The zero-length string may be used to point to a non-existing script. Attempts to write this object will fail with an inconsistentValue error if the value of smLaunchOperStatus is `enabled'.
5 smLaunchArgument	OCTETSTR	Create	The argument supplied to the script. When a script is invoked, the value of this object is used to initialize the smRunArgument object.
6 smLaunchMaxRunning	UNSIGNED32 Legal values: 1 .. -1	Create	The maximum number of concurrently running scripts that may be invoked from this entry in the smLaunchTable. Lowering the current value of this object does not affect any scripts that are already executing.
7 smLaunchMaxCompleted	UNSIGNED32 Legal values: 1 .. -1	Create	The maximum number of finished scripts invoked from this entry in the smLaunchTable allowed to be retained in the smRunTable. Whenever the value of this object is changed and whenever a script terminates, entries in the smRunTable are deleted if necessary until the number of completed scripts is smaller than the value of this object. Scripts whose smRunEndTime value indicates the oldest completion time are deleted first.
8 smLaunchLifeTime	INTEGER Legal values: 0 .. 2147483647 TimeInterval	Create	Note: this object is based on the TimeInterval TEXTUAL-CONVENTION. The default maximum amount of time a script launched from this entry may run. The value of this object is used to initialize the smRunLifeTime object when a script is launched. Changing the value of an smLaunchLifeTime instance does not affect scripts previously launched from this entry.
9 smLaunchExpireTime	INTEGER Legal values: 0 .. 2147483647 TimeInterval	Create	Note: this object is based on the TimeInterval TEXTUAL-CONVENTION. The default maximum amount of time information about a script launched from this entry is kept in the smRunTable after the script has completed execution. The value of this object is used to initialize the smRunExpireTime object when a script is launched. Changing the value of an smLaunchExpireTime instance does not affect scripts previously launched from this entry.
10 smLaunchStart	INTEGER32 Legal values: 0 .. 2147483647	Create	This object is used to start the execution of scripts. When retrieved, the value will be the value of smRunIndex for the last script that started execution by manipulating this object. The value will be zero if no script started execution yet. A script is started by setting this object to an unused smRunIndex value. A new row in the smRunTable will be created which is indexed by the value supplied by the set-request in addition to the value of smLaunchOwner and smLaunchName. An unused value can be obtained by reading the smLaunchRunIndexNext object. Setting this object to the special value 0 will start the script with a self-generated smRunIndex value. The consequence is that the script invoker has no reliable way to determine the smRunIndex value for this script invocation and that the invoker has therefore no way to obtain the results from this script invocation. The special value 0 is however useful for scheduled script invocations. If this object is set, the following checks must be performed: 1) The value of the smLaunchOperStatus object in this entry of the smLaunchTable must be `enabled'. 2) The values of smLaunchScriptOwner and smLaunchScriptName of this row must identify an existing entry in the smScriptTable. 3) The value of smScriptOperStatus of this entry must be `enabled'. 4) The principal performing the set operation must have read access to the script. This must be checked by calling the isAccessAllowed abstract service interface defined in RFC 2271 on the row in the smScriptTable identified by smLaunchScriptOwner and smLaunchScriptName. The isAccessAllowed abstract service interface must be called on all columnar objects in the smScriptTable with a MAX-ACCESS value different than `not-accessible'. The test fails as soon as a call indicates that access is not allowed. 5) If the value provided by the set operation is not 0, a check must be made that the value is currently not in use. Otherwise, if the value provided by the set operation is 0, a suitable unused value must be generated. 6) The number of currently executing scripts invoked from this smLaunchTable entry must be less than smLaunchMaxRunning. Attempts to start a script will fail with an inconsistentValue error if one of the checks described above fails. Otherwise, if all checks have been passed, a new entry in the smRunTable will be created indexed by smLaunchOwner, smLaunchName and the new value for smRunIndex. The value of smLaunchArgument will be copied into smRunArgument, the value of smLaunchLifeTime will be copied to smRunLifeTime, and the value of smLaunchExpireTime will be copied to smRunExpireTime. The smRunStartTime will be set to the current time and the smRunState will be set to `initializing' before the script execution is initiated in the appropriate runtime system. Note that the data type and the range of this object must be consistent with the smRunIndex object. Since this object might be written from the scheduling MIB, the data type Integer32 rather than Unsigned32 is used.
11 smLaunchControl	INTEGER Value Label/Meaning 1 abort 2 suspend 3 resume 4 nop	Create	This object is used to request a state change for all running scripts in the smRunTable that were started from this row in the smLaunchTable. Setting this object to abort(1), suspend(2) or resume(3) will set the smRunControl object of all applicable rows in the smRunTable to abort(1), suspend(2) or resume(3) respectively. The phrase `applicable rows' means the set of rows which were created from this entry in the smLaunchTable and whose value of smRunState allows the corresponding state change as described in the definition of the smRunControl object. Setting this object to nop(4) has no effect. Attempts to set this object lead to an inconsistentValue error only if all implicated sets on all the applicable rows lead to inconsistentValue errors. It is not allowed to return an inconsistentValue error if at least one state change on one of the applicable rows was successful.
12 smLaunchAdminStatus	INTEGER Value Label/Meaning 1 enabled 2 disabled 3 autostart	Create	The value of this object indicates the desired status of this launch table entry. The values enabled(1) and autostart(3) both indicate that the launch table entry should transition into the operational enabled(1) state as soon as the associated script table entry is enabled(1). The value autostart(3) further indicates that the script is started automatically by conceptually writing the value 0 into the associated smLaunchStart object during the transition from the `disabled' into the `enabled' operational state. This is useful for scripts that are to be launched on system start-up.
13 smLaunchOperStatus	INTEGER Value Label/Meaning 1 enabled 2 disabled 3 expired	ReadOnly	The value of this object indicates the actual status of this launch table entry. The smLaunchOperStatus object may have the following values: - `enabled' indicates that the launch table entry is available and can be used to start scripts. - `disabled' indicates that the launch table entry can not be used to start scripts. - `expired' indicates that the launch table entry can not be used to start scripts and will disappear as soon as all smRunTable entries associated with this launch table entry have disappeared. The value `enabled' requires that the smLaunchRowStatus object is active. The value `disabled' requires that there are no entries in the smRunTable associated with this smLaunchTable entry.
14 smLaunchRunIndexNext	INTEGER32 Legal values: 1 .. 2147483647	ReadOnly	This variable is used for creating rows in the smRunTable. The value of this variable is a currently unused value for smRunIndex, which can be written into the smLaunchStart object associated with this row to launch a script. The value returned when reading this variable must be unique for the smLaunchOwner and smLaunchName associated with this row. Subsequent attempts to read this variable must return different values. This variable will return the special value 0 if no new rows can be created. Note that the data type and the range of this object must be consistent with the definition of smRunIndex.
15 smLaunchStorageType	INTEGER StorageType (ENUM list below)	Create	Note: this object is based on the StorageType TEXTUAL-CONVENTION. This object defines if this row is kept in volatile storage and lost upon reboot or if this row is backed up by stable storage. The value of smLaunchStorageType is only meaningful if the value of the corresponding RowStatus object is active. If smLaunchStorageType has the value permanent(4), then all objects whose MAX-ACCESS value is read-create must be writable, with the exception of the smLaunchStorageType and smLaunchRowStatus objects, which shall be read-only.
16 smLaunchRowStatus	INTEGER RowStatus (ENUM list below)	Create	Note: this object is based on the RowStatus TEXTUAL-CONVENTION. A control that allows entries to be added and removed from this table. Attempts to `destroy' a row or to set a row `notInService' while the smLaunchOperStatus is `enabled' will result in an inconsistentValue error. Attempts to `destroy' a row or to set a row `notInService' where the value of the smLaunchStorageType object is `permanent' or `readOnly' will result in an inconsistentValue error. The value of this object has no effect on whether other objects in this conceptual row can be modified.
17 smLaunchError	OCTETSTR Legal Lengths: 0 .. 255 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. This object contains a descriptive error message if an attempt to launch a script fails. Implementations must reset the error message to a zero-length string when a new attempt to launch a script is started.
18 smLaunchLastChange	OCTETSTR Legal Lengths: 8 , 11 DateAndTime	ReadOnly	Note: this object is based on the DateAndTime TEXTUAL-CONVENTION. The date and time when this launch table entry was last modified. The value '0000000000000000'H is returned if the launch table entry has not yet been modified. Note that a change of smLaunchStart, smLaunchControl, smLaunchRunIndexNext, smLaunchRowExpireTime, or the resetting of smLaunchError is not considered a change of this launch table entry.
19 smLaunchRowExpireTime	INTEGER Legal values: 0 .. 2147483647 TimeInterval	Create	Note: this object is based on the TimeInterval TEXTUAL-CONVENTION. The value of this object specifies how long this row remains in the `enabled' or `disabled' operational state. The value reported by this object ticks backwards. When the value reaches 0, it stops ticking backward and the row is deleted if there are no smRunTable entries associated with this smLaunchTable entry. Otherwise, the smLaunchOperStatus changes to `expired' and the row deletion is deferred until there are no smRunTable entries associated with this smLaunchTable entry. The smLaunchRowExpireTime will not tick backwards if it is set to its maximum value (2147483647). In other words, setting this object to its maximum value turns the timer off. The value of this object may be set in order to increase or reduce the remaining time that the launch table entry may be used. Setting the value to 0 will cause an immediate row deletion or transition into the `expired' operational state. It is not possible to set this object while the operational status is `expired'. Attempts to modify this object while the operational status is `expired' leads to an inconsistentValue error. Note that the timer ticks backwards independent of the operational state of the launch table entry.

Table smRunTable

Table Name	smRunTable
In MIB	DISMAN-SCRIPT-MIB
Registered at OID	.1.3.6.1.2.1.64.1.4.2
Table Description	This table lists and describes scripts that are currently running or have been running in the past.
Row Description	An entry describing a particular running or finished script.

smRunTable Indexes:

Name	Type	Access	Description
1 smLaunchOwner	OCTETSTR Legal Lengths: 0 .. 32 SnmpAdminString	NoAccess	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The manager who owns this row in the smLaunchTable. Every instance of a running script started from a particular entry in the smLaunchTable (i.e. entries in the smRunTable) will be owned by the same smLaunchOwner used to index the entry in the smLaunchTable. This owner is not necessarily the same as the owner of the script itself (smLaunchScriptOwner).
2 smLaunchName	OCTETSTR Legal Lengths: 1 .. 32 SnmpAdminString	NoAccess	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The locally-unique, administratively assigned name for this launch table entry. This object allows an smLaunchOwner to have multiple entries in the smLaunchTable. The smLaunchName is an arbitrary name that must be different from any other smLaunchTable entries with the same smLaunchOwner but can be the same as other entries in the smLaunchTable with different smLaunchOwner values. Note that the value of smLaunchName is not related in any way to the name of the script being launched.
1 smRunIndex	INTEGER32 Legal values: 1 .. 2147483647	NoAccess	The locally arbitrary, but unique identifier associated with this running or finished script. This value must be unique for all rows in the smRunTable with the same smLaunchOwner and smLaunchName. Note that the data type and the range of this object must be consistent with the definition of smLaunchRunIndexNext and smLaunchStart.

Other smRunTable Columns:

Name	Type	Access	Description
2 smRunArgument	OCTETSTR	ReadOnly	The argument supplied to the script when it started.
3 smRunStartTime	OCTETSTR Legal Lengths: 8 , 11 DateAndTime	ReadOnly	Note: this object is based on the DateAndTime TEXTUAL-CONVENTION. The date and time when the execution started. The value '0000000000000000'H is returned if the script has not started yet.
4 smRunEndTime	OCTETSTR Legal Lengths: 8 , 11 DateAndTime	ReadOnly	Note: this object is based on the DateAndTime TEXTUAL-CONVENTION. The date and time when the execution terminated. The value '0000000000000000'H is returned if the script has not terminated yet.
5 smRunLifeTime	INTEGER Legal values: 0 .. 2147483647 TimeInterval	ReadWrite	Note: this object is based on the TimeInterval TEXTUAL-CONVENTION. This object specifies how long the script can execute. This object returns the remaining time that the script may run. The object is initialized with the value of the associated smLaunchLifeTime object and ticks backwards. The script is aborted immediately when the value reaches 0. The value of this object may be set in order to increase or reduce the remaining time that the script may run. Setting this value to 0 will abort script execution immediately, and, if the value of smRunExpireTime is also 0, will remove this entry from the smRunTable once it has terminated. If smRunLifeTime is set to its maximum value (2147483647), either by a set operation or by its initialization from the smLaunchLifeTime object, then it will not tick backwards. A running script with a maximum smRunLifeTime value will thus never be terminated with a `lifeTimeExceeded' exit code. The value of smRunLifeTime reflects the real-time execution time as seen by the outside world. The value of this object will always be 0 for a script that finished execution, that is smRunState has the value `terminated'. The value of smRunLifeTime does not change while a script is suspended, that is smRunState has the value `suspended'. Note that this does not affect set operations. It is legal to modify smRunLifeTime via set operations while a script is suspended.
6 smRunExpireTime	INTEGER Legal values: 0 .. 2147483647 TimeInterval	ReadWrite	Note: this object is based on the TimeInterval TEXTUAL-CONVENTION. The value of this object specifies how long this row can exist in the smRunTable after the script has terminated. This object returns the remaining time that the row may exist before it is aged out. The object is initialized with the value of the associated smLaunchExpireTime object and ticks backwards. The entry in the smRunTable is destroyed when the value reaches 0 and the smRunState has the value `terminated'. The value of this object may be set in order to increase or reduce the remaining time that the row may exist. Setting the value to 0 will destroy this entry as soon as the smRunState has the value `terminated'.
7 smRunExitCode	INTEGER Value Label/Meaning 1 noError 2 halted 3 lifeTimeExceeded 4 noResourcesLeft 5 languageError 6 runtimeError 7 invalidArgument 8 securityViolation 9 genericError	ReadOnly	The value of this object indicates the reason why a script finished execution. The smRunExitCode code may have one of the following values: - `noError', which indicates that the script completed successfully without errors; - `halted', which indicates that the script was halted by a request from an authorized manager; - `lifeTimeExceeded', which indicates that the script exited because a time limit was exceeded; - `noResourcesLeft', which indicates that the script exited because it ran out of resources (e.g. memory); - `languageError', which indicates that the script exited because of a language error (e.g. a syntax error in an interpreted language); - `runtimeError', which indicates that the script exited due to a runtime error (e.g. a division by zero); - `invalidArgument', which indicates that the script could not be run because of invalid script arguments; - `securityViolation', which indicates that the script exited due to a security violation; - `genericError', which indicates that the script exited for an unspecified reason. If the script has not yet begun running, or is currently running, the value will be `noError'.
8 smRunResult	OCTETSTR	ReadOnly	The result value produced by the running script. Note that the result may change while the script is executing.
9 smRunControl	INTEGER Value Label/Meaning 1 abort 2 suspend 3 resume 4 nop	ReadWrite	The value of this object indicates the desired status of the script execution defined by this row. Setting this object to `abort' will abort execution if the value of smRunState is `initializing', `executing', `suspending', `suspended' or `resuming'. Setting this object to `abort' when the value of smRunState is `aborting' or `terminated', or if the implementation can determine that the attempt to abort the execution would fail, will result in an inconsistentValue error. Setting this object to `suspend' will suspend execution if the value of smRunState is `executing'. Setting this object to `suspend' will cause an inconsistentValue error if the value of smRunState is not `executing' or if the implementation can determine that the attempt to suspend the execution would fail. Setting this object to `resume' will resume execution if the value of smRunState is `suspending' or `suspended'. Setting this object to `resume' will cause an inconsistentValue error if the value of smRunState is not `suspended' or if the implementation can determine that the attempt to resume the execution would fail. Setting this object to nop(4) has no effect.
10 smRunState	INTEGER Value Label/Meaning 1 initializing 2 executing 3 suspending 4 suspended 5 resuming 6 aborting 7 terminated	ReadOnly	The value of this object indicates the script's execution state. If the script has been invoked but has not yet begun execution, the value will be `initializing'. If the script is running, the value will be `executing'. A running script which received a request to suspend execution first transitions into a temporary `suspending' state. The temporary `suspending' state changes to `suspended' when the script has actually been suspended. The temporary `suspending' state changes back to `executing' if the attempt to suspend the running script fails. A suspended script which received a request to resume execution first transitions into a temporary `resuming' state. The temporary `resuming' state changes to `running' when the script has actually been resumed. The temporary `resuming' state changes back to `suspended' if the attempt to resume the suspended script fails. A script which received a request to abort execution but which is still running first transitions into a temporary `aborting' state. A script which has finished its execution is `terminated'.
11 smRunError	OCTETSTR Legal Lengths: 0 .. 255 SnmpAdminString	ReadOnly	Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. This object contains a descriptive error message if the script startup or execution raised an abnormal condition. An implementation must store a descriptive error message in this object if the script exits with the smRunExitCode `genericError'.
12 smRunResultTime	OCTETSTR Legal Lengths: 8 , 11 DateAndTime	ReadOnly	Note: this object is based on the DateAndTime TEXTUAL-CONVENTION. The date and time when the smRunResult was last updated. The value '0000000000000000'H is returned if smRunResult has not yet been updated after the creation of this smRunTable entry.
13 smRunErrorTime	OCTETSTR Legal Lengths: 8 , 11 DateAndTime	ReadOnly	Note: this object is based on the DateAndTime TEXTUAL-CONVENTION. The date and time when the smRunError was last updated. The value '0000000000000000'H is returned if smRunError has not yet been updated after the creation of this smRunTable entry.

DEPRECATED OR OBSOLETE OR HISTORIC OBJECTS

NOTIFICATIONS

TEXTUAL CONVENTIONS

These TEXTUAL-CONVENTIONS are used in other parts of the document above. They are SNMP's way of defining a datatype that is used repeatedly by other MIB objects. Any implementation implementing objects that use one of these definitions must follow its DESCRIPTION clause as well as the DESCRIPTION clause of the object itself.

Name	Type	Description
StorageType	INTEGER Value Label/Meaning 1 other 2 volatile 3 nonVolatile 4 permanent 5 readOnly	Describes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted. If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.) Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable.
DisplayString	OCTETSTR	Represents textual information taken from the NVT ASCII character set, as defined in pages 4, 10-11 of RFC 854. To summarize RFC 854, the NVT ASCII repertoire specifies: - the use of character codes 0-127 (decimal) - the graphics characters (32-126) are interpreted as US ASCII - NUL, LF, CR, BEL, BS, HT, VT and FF have the special meanings specified in RFC 854 - the other 25 codes have no standard interpretation - the sequence 'CR LF' means newline - the sequence 'CR NUL' means carriage-return - an 'LF' not preceded by a 'CR' means moving to the same column on the next line. - the sequence 'CR x' for any x other than LF or NUL is illegal. (Note that this also means that a string may end with either 'CR LF' or 'CR NUL', but not with CR.) Any object defined using this syntax may not exceed 255 characters in length.
DateAndTime	OCTETSTR	A date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present.
TimeInterval	INTEGER	A period of time, measured in units of 0.01 seconds.
RowStatus	INTEGER Value Label/Meaning 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy	The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status
SnmpAdminString	OCTETSTR	An octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters.

TREE VIEW

Tree view generated by running: snmptranslate -Tp DISMAN-SCRIPT-MIB::scriptMIB