Blame mibs/DISMAN-SCRIPT-MIB.txt

Packit fcad23
DISMAN-SCRIPT-MIB DEFINITIONS ::= BEGIN
Packit fcad23
Packit fcad23
IMPORTS
Packit fcad23
    MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
Packit fcad23
    Integer32, Unsigned32, mib-2
Packit fcad23
        FROM SNMPv2-SMI
Packit fcad23
Packit fcad23
    RowStatus, TimeInterval, DateAndTime, StorageType, DisplayString
Packit fcad23
        FROM SNMPv2-TC
Packit fcad23
Packit fcad23
    MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
Packit fcad23
        FROM SNMPv2-CONF
Packit fcad23
Packit fcad23
    SnmpAdminString
Packit fcad23
        FROM SNMP-FRAMEWORK-MIB;
Packit fcad23
Packit fcad23
scriptMIB MODULE-IDENTITY
Packit fcad23
    LAST-UPDATED "200108210000Z"
Packit fcad23
    ORGANIZATION "IETF Distributed Management Working Group"
Packit fcad23
    CONTACT-INFO
Packit fcad23
        "WG EMail:  disman@dorothy.bmc.com
Packit fcad23
         Subscribe: disman-request@dorothy.bmc.com
Packit fcad23
Packit fcad23
         Chair:     Randy Presuhn
Packit fcad23
                    BMC Software, Inc.
Packit fcad23
Packit fcad23
         Postal:    Office 1-3141
Packit fcad23
                    2141 North First Street
Packit fcad23
                    San Jose,  California 95131
Packit fcad23
                    USA
Packit fcad23
         EMail:     rpresuhn@bmc.com
Packit fcad23
         Phone:     +1 408 546-1006
Packit fcad23
Packit fcad23
         Editor:    David B. Levi
Packit fcad23
                    Nortel Networks
Packit fcad23
         Postal:    4401 Great America Parkway
Packit fcad23
                    Santa Clara, CA 95052-8185
Packit fcad23
                    USA
Packit fcad23
         EMail:     dlevi@nortelnetworks.com
Packit fcad23
         Phone:     +1 423 686 0432
Packit fcad23
Packit fcad23
         Editor:    Juergen Schoenwaelder
Packit fcad23
                    TU Braunschweig
Packit fcad23
         Postal:    Bueltenweg 74/75
Packit fcad23
                    38106 Braunschweig
Packit fcad23
                    Germany
Packit fcad23
         EMail:     schoenw@ibr.cs.tu-bs.de
Packit fcad23
         Phone:     +49 531 391-3283"
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This MIB module defines a set of objects that allow to
Packit fcad23
         delegate management scripts to distributed managers."
Packit fcad23
    REVISION    "200108210000Z"
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Revised version, published as RFC 3165.
Packit fcad23
Packit fcad23
         This revision introduces several new objects: smScriptError,
Packit fcad23
         smScriptLastChange, smLaunchError, smLaunchLastChange,
Packit fcad23
         smLaunchRowExpireTime, smRunResultTime, and smRunErrorTime.
Packit fcad23
Packit fcad23
         The following existing objects were updated: the maximum
Packit fcad23
         value of smRunLifeTime now disables the timer, an
Packit fcad23
         autostart value was added to the smLaunchAdminStatus
Packit fcad23
         object, and a new expired state was added to the
Packit fcad23
         smLaunchOperStatus object.
Packit fcad23
Packit fcad23
         A new smScriptException notification has been added to
Packit fcad23
         support runtime error notifications.
Packit fcad23
Packit fcad23
         Created new conformance and compliance statements that
Packit fcad23
         take care of the new objects and notifications.
Packit fcad23
Packit fcad23
         Clarifications have been added in several places to remove
Packit fcad23
         ambiguities or contradictions that were discovered and
Packit fcad23
         reported by implementors."
Packit fcad23
Packit fcad23
    REVISION    "199902221800Z"
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Initial version, published as RFC 2592."
Packit fcad23
    ::= { mib-2 64 }
Packit fcad23
Packit fcad23
--
Packit fcad23
-- The groups defined within this MIB module:
Packit fcad23
--
Packit fcad23
Packit fcad23
smObjects       OBJECT IDENTIFIER ::= { scriptMIB 1 }
Packit fcad23
smNotifications OBJECT IDENTIFIER ::= { scriptMIB 2 }
Packit fcad23
smConformance   OBJECT IDENTIFIER ::= { scriptMIB 3 }
Packit fcad23
Packit fcad23
--
Packit fcad23
-- Script language and language extensions.
Packit fcad23
--
Packit fcad23
-- This group defines tables which list the languages and the
Packit fcad23
-- language extensions supported by a Script MIB implementation.
Packit fcad23
-- Languages are uniquely identified by object identifier values.
Packit fcad23
--
Packit fcad23
Packit fcad23
smLangTable OBJECT-TYPE
Packit fcad23
    SYNTAX      SEQUENCE OF SmLangEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This table lists supported script languages."
Packit fcad23
    ::= { smObjects 1 }
Packit fcad23
Packit fcad23
smLangEntry OBJECT-TYPE
Packit fcad23
    SYNTAX      SmLangEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "An entry describing a particular language."
Packit fcad23
    INDEX { smLangIndex }
Packit fcad23
    ::= { smLangTable 1 }
Packit fcad23
Packit fcad23
SmLangEntry ::= SEQUENCE {
Packit fcad23
    smLangIndex         Integer32,
Packit fcad23
    smLangLanguage      OBJECT IDENTIFIER,
Packit fcad23
    smLangVersion       SnmpAdminString,
Packit fcad23
    smLangVendor        OBJECT IDENTIFIER,
Packit fcad23
    smLangRevision      SnmpAdminString,
Packit fcad23
    smLangDescr         SnmpAdminString
Packit fcad23
}
Packit fcad23
Packit fcad23
smLangIndex OBJECT-TYPE
Packit fcad23
    SYNTAX      Integer32 (1..2147483647)
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The locally arbitrary, but unique identifier associated
Packit fcad23
         with this language entry.
Packit fcad23
Packit fcad23
         The value is expected to remain constant at least from one
Packit fcad23
         re-initialization of the entity's network management system
Packit fcad23
         to the next re-initialization.
Packit fcad23
Packit fcad23
         Note that the data type and the range of this object must
Packit fcad23
         be consistent with the definition of smScriptLanguage."
Packit fcad23
    ::= { smLangEntry 1 }
Packit fcad23
Packit fcad23
smLangLanguage OBJECT-TYPE
Packit fcad23
    SYNTAX      OBJECT IDENTIFIER
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The globally unique identification of the language."
Packit fcad23
    ::= { smLangEntry 2 }
Packit fcad23
Packit fcad23
smLangVersion OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (0..32))
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The version number of the language. The zero-length string
Packit fcad23
         shall be used if the language does not have a version
Packit fcad23
         number.
Packit fcad23
Packit fcad23
         It is suggested that the version number consist of one or
Packit fcad23
         more decimal numbers separated by dots, where the first
Packit fcad23
         number is called the major version number."
Packit fcad23
    ::= { smLangEntry 3 }
Packit fcad23
Packit fcad23
smLangVendor OBJECT-TYPE
Packit fcad23
    SYNTAX      OBJECT IDENTIFIER
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "An object identifier which identifies the vendor who
Packit fcad23
         provides the implementation of the language. This object
Packit fcad23
         identifier SHALL point to the object identifier directly
Packit fcad23
         below the enterprise object identifier {1 3 6 1 4 1}
Packit fcad23
         allocated for the vendor. The value must be the object
Packit fcad23
         identifier {0 0} if the vendor is not known."
Packit fcad23
    ::= { smLangEntry 4 }
Packit fcad23
Packit fcad23
smLangRevision OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (0..32))
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The version number of the language implementation.
Packit fcad23
         The value of this object must be an empty string if
Packit fcad23
         version number of the implementation is unknown.
Packit fcad23
Packit fcad23
         It is suggested that the value consist of one or more
Packit fcad23
         decimal numbers separated by dots, where the first
Packit fcad23
         number is called the major version number."
Packit fcad23
    ::= { smLangEntry 5 }
Packit fcad23
Packit fcad23
smLangDescr OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A textual description of the language."
Packit fcad23
    ::= { smLangEntry 6 }
Packit fcad23
Packit fcad23
smExtsnTable OBJECT-TYPE
Packit fcad23
    SYNTAX      SEQUENCE OF SmExtsnEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This table lists supported language extensions."
Packit fcad23
    ::= { smObjects 2 }
Packit fcad23
Packit fcad23
smExtsnEntry OBJECT-TYPE
Packit fcad23
    SYNTAX      SmExtsnEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "An entry describing a particular language extension."
Packit fcad23
    INDEX { smLangIndex, smExtsnIndex }
Packit fcad23
    ::= { smExtsnTable 1 }
Packit fcad23
Packit fcad23
SmExtsnEntry ::= SEQUENCE {
Packit fcad23
    smExtsnIndex        Integer32,
Packit fcad23
    smExtsnExtension    OBJECT IDENTIFIER,
Packit fcad23
    smExtsnVersion      SnmpAdminString,
Packit fcad23
    smExtsnVendor       OBJECT IDENTIFIER,
Packit fcad23
    smExtsnRevision     SnmpAdminString,
Packit fcad23
    smExtsnDescr        SnmpAdminString
Packit fcad23
}
Packit fcad23
Packit fcad23
smExtsnIndex OBJECT-TYPE
Packit fcad23
    SYNTAX      Integer32 (1..2147483647)
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The locally arbitrary, but unique identifier associated
Packit fcad23
         with this language extension entry.
Packit fcad23
Packit fcad23
         The value is expected to remain constant at least from one
Packit fcad23
         re-initialization of the entity's network management system
Packit fcad23
         to the next re-initialization."
Packit fcad23
    ::= { smExtsnEntry 1}
Packit fcad23
Packit fcad23
smExtsnExtension OBJECT-TYPE
Packit fcad23
    SYNTAX      OBJECT IDENTIFIER
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The globally unique identification of the language
Packit fcad23
         extension."
Packit fcad23
    ::= { smExtsnEntry 2 }
Packit fcad23
Packit fcad23
smExtsnVersion OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (0..32))
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The version number of the language extension.
Packit fcad23
         It is suggested that the version number consist of one or
Packit fcad23
         more decimal numbers separated by dots, where the first
Packit fcad23
         number is called the major version number."
Packit fcad23
    ::= { smExtsnEntry 3 }
Packit fcad23
Packit fcad23
smExtsnVendor OBJECT-TYPE
Packit fcad23
    SYNTAX      OBJECT IDENTIFIER
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "An object identifier which identifies the vendor who
Packit fcad23
         provides the implementation of the extension. The
Packit fcad23
         object identifier value should point to the OID node
Packit fcad23
         directly below the enterprise OID {1 3 6 1 4 1}
Packit fcad23
         allocated for the vendor. The value must by the object
Packit fcad23
         identifier {0 0} if the vendor is not known."
Packit fcad23
    ::= { smExtsnEntry 4 }
Packit fcad23
Packit fcad23
smExtsnRevision OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (0..32))
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The version number of the extension implementation.
Packit fcad23
         The value of this object must be an empty string if
Packit fcad23
         version number of the implementation is unknown.
Packit fcad23
Packit fcad23
         It is suggested that the value consist of one or more
Packit fcad23
         decimal numbers separated by dots, where the first
Packit fcad23
         number is called the major version number."
Packit fcad23
    ::= { smExtsnEntry 5 }
Packit fcad23
Packit fcad23
smExtsnDescr OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A textual description of the language extension."
Packit fcad23
    ::= { smExtsnEntry 6 }
Packit fcad23
Packit fcad23
--
Packit fcad23
-- Scripts known by the Script MIB implementation.
Packit fcad23
--
Packit fcad23
-- This group defines a table which lists all known scripts.
Packit fcad23
-- Scripts can be added and removed through manipulation of the
Packit fcad23
-- smScriptTable.
Packit fcad23
--
Packit fcad23
Packit fcad23
smScriptObjects OBJECT IDENTIFIER ::= { smObjects 3 }
Packit fcad23
Packit fcad23
smScriptTable OBJECT-TYPE
Packit fcad23
    SYNTAX      SEQUENCE OF SmScriptEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This table lists and describes locally known scripts."
Packit fcad23
    ::= { smScriptObjects 1 }
Packit fcad23
Packit fcad23
smScriptEntry OBJECT-TYPE
Packit fcad23
    SYNTAX      SmScriptEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "An entry describing a particular script. Every script that
Packit fcad23
         is stored in non-volatile memory is required to appear in
Packit fcad23
         this script table."
Packit fcad23
    INDEX { smScriptOwner, smScriptName }
Packit fcad23
    ::= { smScriptTable 1 }
Packit fcad23
Packit fcad23
SmScriptEntry ::= SEQUENCE {
Packit fcad23
    smScriptOwner       SnmpAdminString,
Packit fcad23
    smScriptName        SnmpAdminString,
Packit fcad23
    smScriptDescr       SnmpAdminString,
Packit fcad23
    smScriptLanguage    Integer32,
Packit fcad23
    smScriptSource      DisplayString,
Packit fcad23
    smScriptAdminStatus INTEGER,
Packit fcad23
    smScriptOperStatus  INTEGER,
Packit fcad23
    smScriptStorageType StorageType,
Packit fcad23
    smScriptRowStatus   RowStatus,
Packit fcad23
    smScriptError       SnmpAdminString,
Packit fcad23
    smScriptLastChange  DateAndTime
Packit fcad23
}
Packit fcad23
Packit fcad23
smScriptOwner OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (0..32))
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The manager who owns this row in the smScriptTable."
Packit fcad23
    ::= { smScriptEntry 1 }
Packit fcad23
Packit fcad23
smScriptName OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (1..32))
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The locally-unique, administratively assigned name for this
Packit fcad23
         script. This object allows an smScriptOwner to have multiple
Packit fcad23
         entries in the smScriptTable.
Packit fcad23
Packit fcad23
         This value of this object may be used to derive the name
Packit fcad23
         (e.g. a file name) which is used by the Script MIB
Packit fcad23
         implementation to access the script in non-volatile
Packit fcad23
         storage. The details of this mapping are implementation
Packit fcad23
         specific. However, the mapping needs to ensure that scripts
Packit fcad23
         created by different owners with the same script name do not
Packit fcad23
         map to the same name in non-volatile storage."
Packit fcad23
    ::= { smScriptEntry 2 }
Packit fcad23
Packit fcad23
smScriptDescr OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A description of the purpose of the script."
Packit fcad23
    ::= { smScriptEntry 3 }
Packit fcad23
Packit fcad23
smScriptLanguage OBJECT-TYPE
Packit fcad23
    SYNTAX      Integer32 (0..2147483647)
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object type identifies an entry in the
Packit fcad23
         smLangTable which is used to execute this script.
Packit fcad23
         The special value 0 may be used by hard-wired scripts
Packit fcad23
         that can not be modified and that are executed by
Packit fcad23
         internal functions.
Packit fcad23
Packit fcad23
         Set requests to change this object are invalid if the
Packit fcad23
         value of smScriptOperStatus is `enabled' or `compiling'
Packit fcad23
         and will result in an inconsistentValue error.
Packit fcad23
Packit fcad23
         Note that the data type and the range of this object must
Packit fcad23
         be consistent with the definition of smLangIndex."
Packit fcad23
    ::= { smScriptEntry 4 }
Packit fcad23
Packit fcad23
smScriptSource OBJECT-TYPE
Packit fcad23
    SYNTAX      DisplayString
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object either contains a reference to the script
Packit fcad23
         source or an empty string. A reference must be given
Packit fcad23
         in the form of a Uniform Resource Locator (URL) as
Packit fcad23
         defined in RFC 2396. The allowed character sets and the
Packit fcad23
         encoding rules defined in RFC 2396 section 2 apply.
Packit fcad23
Packit fcad23
         When the smScriptAdminStatus object is set to `enabled',
Packit fcad23
         the Script MIB implementation will `pull' the script
Packit fcad23
         source from the URL contained in this object if the URL
Packit fcad23
         is not empty.
Packit fcad23
Packit fcad23
         An empty URL indicates that the script source is loaded
Packit fcad23
         from local storage. The script is read from the smCodeTable
Packit fcad23
         if the value of smScriptStorageType is volatile. Otherwise,
Packit fcad23
         the script is read from non-volatile storage.
Packit fcad23
Packit fcad23
         Note: This document does not mandate implementation of any
Packit fcad23
         specific URL scheme. An attempt to load a script from a
Packit fcad23
         nonsupported URL scheme will cause the smScriptOperStatus
Packit fcad23
         to report an `unknownProtocol' error.
Packit fcad23
Packit fcad23
         Set requests to change this object are invalid if the
Packit fcad23
         value of smScriptOperStatus is `enabled', `editing',
Packit fcad23
         `retrieving' or `compiling' and will result in an
Packit fcad23
         inconsistentValue error."
Packit fcad23
    DEFVAL { ''H }
Packit fcad23
    ::= { smScriptEntry 5 }
Packit fcad23
Packit fcad23
smScriptAdminStatus OBJECT-TYPE
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    enabled(1),
Packit fcad23
                    disabled(2),
Packit fcad23
                    editing(3)
Packit fcad23
                }
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object indicates the desired status of
Packit fcad23
         the script. See the definition of smScriptOperStatus for
Packit fcad23
         a description of the values.
Packit fcad23
Packit fcad23
         When the smScriptAdminStatus object is set to `enabled' and
Packit fcad23
         the smScriptOperStatus is `disabled' or one of the error
Packit fcad23
         states, the Script MIB implementation will `pull' the script
Packit fcad23
         source from the URL contained in the smScriptSource object
Packit fcad23
         if the URL is not empty."
Packit fcad23
    DEFVAL { disabled }
Packit fcad23
    ::= { smScriptEntry 6 }
Packit fcad23
Packit fcad23
smScriptOperStatus OBJECT-TYPE
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    enabled(1),
Packit fcad23
                    disabled(2),
Packit fcad23
                    editing(3),
Packit fcad23
                    retrieving(4),
Packit fcad23
                    compiling(5),
Packit fcad23
                    noSuchScript(6),
Packit fcad23
                    accessDenied(7),
Packit fcad23
                    wrongLanguage(8),
Packit fcad23
                    wrongVersion(9),
Packit fcad23
                    compilationFailed(10),
Packit fcad23
                    noResourcesLeft(11),
Packit fcad23
                    unknownProtocol(12),
Packit fcad23
                    protocolFailure(13),
Packit fcad23
                    genericError(14)
Packit fcad23
                }
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The actual status of the script in the runtime system. The
Packit fcad23
         value of this object is only meaningful when the value of
Packit fcad23
         the smScriptRowStatus object is `active'.
Packit fcad23
Packit fcad23
         The smScriptOperStatus object may have the following values:
Packit fcad23
Packit fcad23
         - `enabled' indicates that the script is available and can
Packit fcad23
            be started by a launch table entry.
Packit fcad23
Packit fcad23
         - `disabled' indicates that the script can not be used.
Packit fcad23
Packit fcad23
         - `editing' indicates that the script can be modified in the
Packit fcad23
           smCodeTable.
Packit fcad23
Packit fcad23
         - `retrieving' indicates that the script is currently being
Packit fcad23
           loaded from non-volatile storage or a remote system.
Packit fcad23
Packit fcad23
         - `compiling' indicates that the script is currently being
Packit fcad23
           compiled by the runtime system.
Packit fcad23
Packit fcad23
         - `noSuchScript' indicates that the script does not exist
Packit fcad23
           at the smScriptSource.
Packit fcad23
Packit fcad23
         - `accessDenied' indicates that the script can not be loaded
Packit fcad23
           from the smScriptSource due to a lack of permissions.
Packit fcad23
Packit fcad23
         - `wrongLanguage' indicates that the script can not be
Packit fcad23
            loaded from the smScriptSource because of a language
Packit fcad23
            mismatch.
Packit fcad23
Packit fcad23
         - `wrongVersion' indicates that the script can not be loaded
Packit fcad23
           from the smScriptSource because of a language version
Packit fcad23
           mismatch.
Packit fcad23
Packit fcad23
         - `compilationFailed' indicates that the compilation failed.
Packit fcad23
Packit fcad23
         - `noResourcesLeft' indicates that the runtime system does
Packit fcad23
           not have enough resources to load the script.
Packit fcad23
Packit fcad23
         - `unknownProtocol' indicates that the script could not be
Packit fcad23
           loaded from the smScriptSource because the requested
Packit fcad23
           protocol is not supported.
Packit fcad23
Packit fcad23
         - `protocolFailure' indicates that the script could not be
Packit fcad23
           loaded from the smScriptSource because of a protocol
Packit fcad23
           failure.
Packit fcad23
Packit fcad23
         - `genericError' indicates that the script could not be
Packit fcad23
Packit fcad23
           loaded due to an error condition not listed above.
Packit fcad23
Packit fcad23
         The `retrieving' and `compiling' states are transient states
Packit fcad23
         which will either lead to one of the error states or the
Packit fcad23
         `enabled' state. The `disabled' and `editing' states are
Packit fcad23
         administrative states which are only reached by explicit
Packit fcad23
         management operations.
Packit fcad23
Packit fcad23
         All launch table entries that refer to this script table
Packit fcad23
         entry shall have an smLaunchOperStatus value of `disabled'
Packit fcad23
         when the value of this object is not `enabled'."
Packit fcad23
    DEFVAL { disabled }
Packit fcad23
    ::= { smScriptEntry 7 }
Packit fcad23
Packit fcad23
smScriptStorageType OBJECT-TYPE
Packit fcad23
    SYNTAX      StorageType
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object defines whether this row and the script
Packit fcad23
         controlled by this row are kept in volatile storage and
Packit fcad23
         lost upon reboot or if this row is backed up by
Packit fcad23
         non-volatile or permanent storage.
Packit fcad23
Packit fcad23
         The storage type of this row always complies with the value
Packit fcad23
         of this entry if the value of the corresponding RowStatus
Packit fcad23
         object is `active'.
Packit fcad23
Packit fcad23
         However, the storage type of the script controlled by this
Packit fcad23
         row may be different, if the value of this entry is
Packit fcad23
         `non-volatile'. The script controlled by this row is written
Packit fcad23
         into local non-volatile storage if the following condition
Packit fcad23
         becomes true:
Packit fcad23
Packit fcad23
         (a) the URL contained in the smScriptSource object is empty
Packit fcad23
             and
Packit fcad23
         (b) the smScriptStorageType is `nonVolatile'
Packit fcad23
             and
Packit fcad23
         (c) the smScriptOperStatus is `enabled'
Packit fcad23
Packit fcad23
         Setting this object to `volatile' removes a script from
Packit fcad23
         non-volatile storage if the script controlled by this row
Packit fcad23
         has been in non-volatile storage before. Attempts to set
Packit fcad23
         this object to permanent will always fail with an
Packit fcad23
         inconsistentValue error.
Packit fcad23
Packit fcad23
         The value of smScriptStorageType is only meaningful if the
Packit fcad23
         value of the corresponding RowStatus object is `active'.
Packit fcad23
Packit fcad23
         If smScriptStorageType has the value permanent(4), then all
Packit fcad23
         objects whose MAX-ACCESS value is read-create must be
Packit fcad23
         writable, with the exception of the smScriptStorageType and
Packit fcad23
         smScriptRowStatus objects, which shall be read-only."
Packit fcad23
    DEFVAL { volatile }
Packit fcad23
    ::= { smScriptEntry 8 }
Packit fcad23
Packit fcad23
smScriptRowStatus OBJECT-TYPE
Packit fcad23
    SYNTAX      RowStatus
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A control that allows entries to be added and removed from
Packit fcad23
         this table.
Packit fcad23
Packit fcad23
         Changing the smScriptRowStatus from `active' to
Packit fcad23
         `notInService' will remove the associated script from the
Packit fcad23
         runtime system.
Packit fcad23
Packit fcad23
         Deleting conceptual rows from this table may affect the
Packit fcad23
         deletion of other resources associated with this row. For
Packit fcad23
         example, a script stored in non-volatile storage may be
Packit fcad23
         removed from non-volatile storage.
Packit fcad23
Packit fcad23
         An entry may not exist in the `active' state unless all
Packit fcad23
         required objects in the entry have appropriate values. Rows
Packit fcad23
         that are not complete or not in service are not known by the
Packit fcad23
         script runtime system.
Packit fcad23
Packit fcad23
         Attempts to `destroy' a row or to set a row `notInService'
Packit fcad23
         while the smScriptOperStatus is `enabled' will result in an
Packit fcad23
         inconsistentValue error.
Packit fcad23
Packit fcad23
         Attempts to `destroy' a row or to set a row `notInService'
Packit fcad23
         where the value of the smScriptStorageType object is
Packit fcad23
         `permanent' or `readOnly' will result in an
Packit fcad23
         inconsistentValue error.
Packit fcad23
Packit fcad23
         The value of this object has no effect on whether other
Packit fcad23
         objects in this conceptual row can be modified."
Packit fcad23
    ::= { smScriptEntry 9 }
Packit fcad23
Packit fcad23
smScriptError OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object contains a descriptive error message if the
Packit fcad23
Packit fcad23
         transition into the operational status `enabled' failed.
Packit fcad23
         Implementations must reset the error message to a
Packit fcad23
         zero-length string when a new attempt to change the
Packit fcad23
         script status to `enabled' is started."
Packit fcad23
    DEFVAL { ''H }
Packit fcad23
    ::= { smScriptEntry 10 }
Packit fcad23
Packit fcad23
smScriptLastChange OBJECT-TYPE
Packit fcad23
    SYNTAX      DateAndTime
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The date and time when this script table entry was last
Packit fcad23
         modified. The value '0000000000000000'H is returned if
Packit fcad23
         the script table entry has not yet been modified.
Packit fcad23
Packit fcad23
         Note that the resetting of smScriptError is not considered
Packit fcad23
         a change of the script table entry."
Packit fcad23
    DEFVAL { '0000000000000000'H }
Packit fcad23
    ::= { smScriptEntry 11 }
Packit fcad23
Packit fcad23
--
Packit fcad23
-- Access to script code via SNMP
Packit fcad23
--
Packit fcad23
-- The smCodeTable allows script code to be read and modified
Packit fcad23
-- via SNMP.
Packit fcad23
--
Packit fcad23
Packit fcad23
smCodeTable OBJECT-TYPE
Packit fcad23
    SYNTAX      SEQUENCE OF SmCodeEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This table contains the script code for scripts that are
Packit fcad23
         written via SNMP write operations."
Packit fcad23
    ::= { smScriptObjects 2 }
Packit fcad23
Packit fcad23
smCodeEntry OBJECT-TYPE
Packit fcad23
    SYNTAX      SmCodeEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "An entry describing a particular fragment of a script."
Packit fcad23
    INDEX { smScriptOwner, smScriptName, smCodeIndex }
Packit fcad23
    ::= { smCodeTable 1 }
Packit fcad23
Packit fcad23
SmCodeEntry ::= SEQUENCE {
Packit fcad23
    smCodeIndex         Unsigned32,
Packit fcad23
    smCodeText          OCTET STRING,
Packit fcad23
    smCodeRowStatus     RowStatus
Packit fcad23
}
Packit fcad23
Packit fcad23
smCodeIndex OBJECT-TYPE
Packit fcad23
    SYNTAX      Unsigned32 (1..4294967295)
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The index value identifying this code fragment."
Packit fcad23
    ::= { smCodeEntry 1 }
Packit fcad23
Packit fcad23
smCodeText OBJECT-TYPE
Packit fcad23
    SYNTAX      OCTET STRING (SIZE (1..1024))
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The code that makes up a fragment of a script. The format
Packit fcad23
         of this code fragment depends on the script language which
Packit fcad23
         is identified by the associated smScriptLanguage object."
Packit fcad23
    ::= { smCodeEntry 2 }
Packit fcad23
Packit fcad23
smCodeRowStatus OBJECT-TYPE
Packit fcad23
    SYNTAX      RowStatus
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A control that allows entries to be added and removed from
Packit fcad23
         this table.
Packit fcad23
Packit fcad23
         The value of this object has no effect on whether other
Packit fcad23
         objects in this conceptual row can be modified."
Packit fcad23
    ::= { smCodeEntry 3 }
Packit fcad23
Packit fcad23
--
Packit fcad23
-- Script execution.
Packit fcad23
--
Packit fcad23
-- This group defines tables which allow script execution to be
Packit fcad23
-- initiated, suspended, resumed, and terminated.  It also provides
Packit fcad23
-- a mechanism for keeping a history of recent script executions
Packit fcad23
-- and their results.
Packit fcad23
--
Packit fcad23
Packit fcad23
smRunObjects OBJECT IDENTIFIER ::= { smObjects 4 }
Packit fcad23
Packit fcad23
smLaunchTable OBJECT-TYPE
Packit fcad23
    SYNTAX      SEQUENCE OF SmLaunchEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This table lists and describes scripts that are ready
Packit fcad23
         to be executed together with their parameters."
Packit fcad23
    ::= { smRunObjects 1 }
Packit fcad23
Packit fcad23
smLaunchEntry OBJECT-TYPE
Packit fcad23
    SYNTAX      SmLaunchEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "An entry describing a particular executable script."
Packit fcad23
    INDEX { smLaunchOwner, smLaunchName }
Packit fcad23
    ::= { smLaunchTable 1 }
Packit fcad23
Packit fcad23
SmLaunchEntry ::= SEQUENCE {
Packit fcad23
    smLaunchOwner               SnmpAdminString,
Packit fcad23
    smLaunchName                SnmpAdminString,
Packit fcad23
    smLaunchScriptOwner         SnmpAdminString,
Packit fcad23
    smLaunchScriptName          SnmpAdminString,
Packit fcad23
    smLaunchArgument            OCTET STRING,
Packit fcad23
    smLaunchMaxRunning          Unsigned32,
Packit fcad23
    smLaunchMaxCompleted        Unsigned32,
Packit fcad23
    smLaunchLifeTime            TimeInterval,
Packit fcad23
    smLaunchExpireTime          TimeInterval,
Packit fcad23
    smLaunchStart               Integer32,
Packit fcad23
    smLaunchControl             INTEGER,
Packit fcad23
    smLaunchAdminStatus         INTEGER,
Packit fcad23
    smLaunchOperStatus          INTEGER,
Packit fcad23
    smLaunchRunIndexNext        Integer32,
Packit fcad23
    smLaunchStorageType         StorageType,
Packit fcad23
    smLaunchRowStatus           RowStatus,
Packit fcad23
    smLaunchError               SnmpAdminString,
Packit fcad23
    smLaunchLastChange          DateAndTime,
Packit fcad23
    smLaunchRowExpireTime       TimeInterval
Packit fcad23
}
Packit fcad23
Packit fcad23
smLaunchOwner OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (0..32))
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The manager who owns this row in the smLaunchTable. Every
Packit fcad23
         instance of a running script started from a particular entry
Packit fcad23
         in the smLaunchTable (i.e. entries in the smRunTable) will
Packit fcad23
         be owned by the same smLaunchOwner used to index the entry
Packit fcad23
         in the smLaunchTable. This owner is not necessarily the same
Packit fcad23
         as the owner of the script itself (smLaunchScriptOwner)."
Packit fcad23
    ::= { smLaunchEntry 1 }
Packit fcad23
Packit fcad23
smLaunchName OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (1..32))
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The locally-unique, administratively assigned name for this
Packit fcad23
         launch table entry. This object allows an smLaunchOwner to
Packit fcad23
         have multiple entries in the smLaunchTable. The smLaunchName
Packit fcad23
         is an arbitrary name that must be different from any other
Packit fcad23
         smLaunchTable entries with the same smLaunchOwner but can be
Packit fcad23
         the same as other entries in the smLaunchTable with
Packit fcad23
         different smLaunchOwner values. Note that the value of
Packit fcad23
         smLaunchName is not related in any way to the name of the
Packit fcad23
         script being launched."
Packit fcad23
    ::= { smLaunchEntry 2 }
Packit fcad23
Packit fcad23
smLaunchScriptOwner OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (0..32))
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object in combination with the value of
Packit fcad23
         smLaunchScriptName identifies the script that can be
Packit fcad23
         launched from this smLaunchTable entry. Attempts to write
Packit fcad23
         this object will fail with an inconsistentValue error if
Packit fcad23
         the value of smLaunchOperStatus is `enabled'."
Packit fcad23
    ::= { smLaunchEntry 3 }
Packit fcad23
Packit fcad23
smLaunchScriptName OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString (SIZE (0..32))
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object in combination with the value of
Packit fcad23
         the smLaunchScriptOwner identifies the script that can be
Packit fcad23
         launched from this smLaunchTable entry. The zero-length
Packit fcad23
         string may be used to point to a non-existing script.
Packit fcad23
Packit fcad23
         Attempts to write this object will fail with an
Packit fcad23
         inconsistentValue error if the value of smLaunchOperStatus
Packit fcad23
         is `enabled'."
Packit fcad23
    DEFVAL { ''H }
Packit fcad23
    ::= { smLaunchEntry 4 }
Packit fcad23
Packit fcad23
smLaunchArgument OBJECT-TYPE
Packit fcad23
    SYNTAX      OCTET STRING
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The argument supplied to the script. When a script is
Packit fcad23
         invoked, the value of this object is used to initialize
Packit fcad23
         the smRunArgument object."
Packit fcad23
    DEFVAL { ''H }
Packit fcad23
    ::= { smLaunchEntry 5 }
Packit fcad23
Packit fcad23
smLaunchMaxRunning OBJECT-TYPE
Packit fcad23
    SYNTAX      Unsigned32 (1..4294967295)
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The maximum number of concurrently running scripts that may
Packit fcad23
         be invoked from this entry in the smLaunchTable. Lowering
Packit fcad23
         the current value of this object does not affect any scripts
Packit fcad23
         that are already executing."
Packit fcad23
    DEFVAL { 1 }
Packit fcad23
    ::= { smLaunchEntry 6 }
Packit fcad23
Packit fcad23
smLaunchMaxCompleted OBJECT-TYPE
Packit fcad23
    SYNTAX      Unsigned32 (1..4294967295)
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The maximum number of finished scripts invoked from this
Packit fcad23
         entry in the smLaunchTable allowed to be retained in the
Packit fcad23
         smRunTable. Whenever the value of this object is changed
Packit fcad23
         and whenever a script terminates, entries in the smRunTable
Packit fcad23
         are deleted if necessary until the number of completed
Packit fcad23
         scripts is smaller than the value of this object. Scripts
Packit fcad23
         whose smRunEndTime value indicates the oldest completion
Packit fcad23
         time are deleted first."
Packit fcad23
    DEFVAL { 1 }
Packit fcad23
    ::= { smLaunchEntry 7 }
Packit fcad23
Packit fcad23
smLaunchLifeTime OBJECT-TYPE
Packit fcad23
    SYNTAX      TimeInterval
Packit fcad23
    UNITS       "centi-seconds"
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The default maximum amount of time a script launched
Packit fcad23
         from this entry may run. The value of this object is used
Packit fcad23
         to initialize the smRunLifeTime object when a script is
Packit fcad23
         launched. Changing the value of an smLaunchLifeTime
Packit fcad23
         instance does not affect scripts previously launched from
Packit fcad23
Packit fcad23
         this entry."
Packit fcad23
    DEFVAL { 360000 }
Packit fcad23
    ::= { smLaunchEntry 8 }
Packit fcad23
Packit fcad23
smLaunchExpireTime OBJECT-TYPE
Packit fcad23
    SYNTAX      TimeInterval
Packit fcad23
    UNITS       "centi-seconds"
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The default maximum amount of time information about a
Packit fcad23
         script launched from this entry is kept in the smRunTable
Packit fcad23
         after the script has completed execution.  The value of
Packit fcad23
         this object is used to initialize the smRunExpireTime
Packit fcad23
         object when a script is launched. Changing the value of an
Packit fcad23
         smLaunchExpireTime instance does not affect scripts
Packit fcad23
         previously launched from this entry."
Packit fcad23
    DEFVAL { 360000 }
Packit fcad23
    ::= { smLaunchEntry 9 }
Packit fcad23
Packit fcad23
smLaunchStart OBJECT-TYPE
Packit fcad23
    SYNTAX      Integer32 (0..2147483647)
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object is used to start the execution of scripts.
Packit fcad23
         When retrieved, the value will be the value of smRunIndex
Packit fcad23
         for the last script that started execution by manipulating
Packit fcad23
         this object. The value will be zero if no script started
Packit fcad23
         execution yet.
Packit fcad23
Packit fcad23
         A script is started by setting this object to an unused
Packit fcad23
         smRunIndex value. A new row in the smRunTable will be
Packit fcad23
         created which is indexed by the value supplied by the
Packit fcad23
         set-request in addition to the value of smLaunchOwner and
Packit fcad23
         smLaunchName. An unused value can be obtained by reading
Packit fcad23
         the smLaunchRunIndexNext object.
Packit fcad23
Packit fcad23
         Setting this object to the special value 0 will start
Packit fcad23
         the script with a self-generated smRunIndex value. The
Packit fcad23
         consequence is that the script invoker has no reliable
Packit fcad23
         way to determine the smRunIndex value for this script
Packit fcad23
         invocation and that the invoker has therefore no way
Packit fcad23
         to obtain the results from this script invocation. The
Packit fcad23
         special value 0 is however useful for scheduled script
Packit fcad23
         invocations.
Packit fcad23
Packit fcad23
         If this object is set, the following checks must be
Packit fcad23
Packit fcad23
         performed:
Packit fcad23
Packit fcad23
         1) The value of the smLaunchOperStatus object in this
Packit fcad23
            entry of the smLaunchTable must be `enabled'.
Packit fcad23
         2) The values of smLaunchScriptOwner and
Packit fcad23
            smLaunchScriptName of this row must identify an
Packit fcad23
            existing entry in the smScriptTable.
Packit fcad23
         3) The value of smScriptOperStatus of this entry must
Packit fcad23
            be `enabled'.
Packit fcad23
         4) The principal performing the set operation must have
Packit fcad23
            read access to the script. This must be checked by
Packit fcad23
            calling the isAccessAllowed abstract service interface
Packit fcad23
            defined in RFC 2271 on the row in the smScriptTable
Packit fcad23
            identified by smLaunchScriptOwner and smLaunchScriptName.
Packit fcad23
            The isAccessAllowed abstract service interface must be
Packit fcad23
            called on all columnar objects in the smScriptTable with
Packit fcad23
            a MAX-ACCESS value different than `not-accessible'. The
Packit fcad23
            test fails as soon as a call indicates that access is
Packit fcad23
            not allowed.
Packit fcad23
         5) If the value provided by the set operation is not 0,
Packit fcad23
            a check must be made that the value is currently not
Packit fcad23
            in use. Otherwise, if the value provided by the set
Packit fcad23
            operation is 0, a suitable unused value must be
Packit fcad23
            generated.
Packit fcad23
         6) The number of currently executing scripts invoked
Packit fcad23
            from this smLaunchTable entry must be less than
Packit fcad23
            smLaunchMaxRunning.
Packit fcad23
Packit fcad23
         Attempts to start a script will fail with an
Packit fcad23
         inconsistentValue error if one of the checks described
Packit fcad23
         above fails.
Packit fcad23
Packit fcad23
         Otherwise, if all checks have been passed, a new entry
Packit fcad23
         in the smRunTable will be created indexed by smLaunchOwner,
Packit fcad23
         smLaunchName and the new value for smRunIndex. The value
Packit fcad23
         of smLaunchArgument will be copied into smRunArgument,
Packit fcad23
         the value of smLaunchLifeTime will be copied to
Packit fcad23
         smRunLifeTime, and the value of smLaunchExpireTime
Packit fcad23
         will be copied to smRunExpireTime.
Packit fcad23
Packit fcad23
         The smRunStartTime will be set to the current time and
Packit fcad23
         the smRunState will be set to `initializing' before the
Packit fcad23
         script execution is initiated in the appropriate runtime
Packit fcad23
         system.
Packit fcad23
Packit fcad23
         Note that the data type and the range of this object must
Packit fcad23
         be consistent with the smRunIndex object. Since this
Packit fcad23
         object might be written from the scheduling MIB, the
Packit fcad23
Packit fcad23
         data type Integer32 rather than Unsigned32 is used."
Packit fcad23
    DEFVAL { 0 }
Packit fcad23
    ::= { smLaunchEntry 10 }
Packit fcad23
Packit fcad23
smLaunchControl OBJECT-TYPE
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    abort(1),
Packit fcad23
                    suspend(2),
Packit fcad23
                    resume(3),
Packit fcad23
                    nop(4)
Packit fcad23
                }
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object is used to request a state change for all
Packit fcad23
         running scripts in the smRunTable that were started from
Packit fcad23
         this row in the smLaunchTable.
Packit fcad23
Packit fcad23
         Setting this object to abort(1), suspend(2) or resume(3)
Packit fcad23
         will set the smRunControl object of all applicable rows
Packit fcad23
         in the smRunTable to abort(1), suspend(2) or resume(3)
Packit fcad23
         respectively. The phrase `applicable rows' means the set of
Packit fcad23
         rows which were created from this entry in the smLaunchTable
Packit fcad23
         and whose value of smRunState allows the corresponding
Packit fcad23
         state change as described in the definition of the
Packit fcad23
         smRunControl object. Setting this object to nop(4) has no
Packit fcad23
         effect.
Packit fcad23
Packit fcad23
         Attempts to set this object lead to an inconsistentValue
Packit fcad23
         error only if all implicated sets on all the applicable
Packit fcad23
         rows lead to inconsistentValue errors. It is not allowed
Packit fcad23
         to return an inconsistentValue error if at least one state
Packit fcad23
         change on one of the applicable rows was successful."
Packit fcad23
    DEFVAL { nop }
Packit fcad23
    ::= { smLaunchEntry 11 }
Packit fcad23
Packit fcad23
smLaunchAdminStatus OBJECT-TYPE
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    enabled(1),
Packit fcad23
                    disabled(2),
Packit fcad23
                    autostart(3)
Packit fcad23
                }
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object indicates the desired status of
Packit fcad23
         this launch table entry. The values enabled(1) and
Packit fcad23
         autostart(3) both indicate that the launch table entry
Packit fcad23
Packit fcad23
         should transition into the operational enabled(1) state as
Packit fcad23
         soon as the associated script table entry is enabled(1).
Packit fcad23
Packit fcad23
         The value autostart(3) further indicates that the script
Packit fcad23
         is started automatically by conceptually writing the
Packit fcad23
         value 0 into the associated smLaunchStart object during
Packit fcad23
         the transition from the `disabled' into the `enabled'
Packit fcad23
         operational state. This is useful for scripts that are
Packit fcad23
         to be launched on system start-up."
Packit fcad23
    DEFVAL { disabled }
Packit fcad23
    ::= { smLaunchEntry 12 }
Packit fcad23
Packit fcad23
smLaunchOperStatus OBJECT-TYPE
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    enabled(1),
Packit fcad23
                    disabled(2),
Packit fcad23
                    expired(3)
Packit fcad23
                }
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object indicates the actual status of
Packit fcad23
         this launch table entry.  The smLaunchOperStatus object
Packit fcad23
         may have the following values:
Packit fcad23
Packit fcad23
         - `enabled' indicates that the launch table entry is
Packit fcad23
           available and can be used to start scripts.
Packit fcad23
Packit fcad23
         - `disabled' indicates that the launch table entry can
Packit fcad23
           not be used to start scripts.
Packit fcad23
Packit fcad23
         - `expired' indicates that the launch table entry can
Packit fcad23
           not be used to start scripts and will disappear as
Packit fcad23
           soon as all smRunTable entries associated with this
Packit fcad23
           launch table entry have disappeared.
Packit fcad23
Packit fcad23
         The value `enabled' requires that the smLaunchRowStatus
Packit fcad23
         object is active. The value `disabled' requires that there
Packit fcad23
         are no entries in the smRunTable associated with this
Packit fcad23
         smLaunchTable entry."
Packit fcad23
    DEFVAL { disabled }
Packit fcad23
    ::= { smLaunchEntry 13 }
Packit fcad23
Packit fcad23
smLaunchRunIndexNext OBJECT-TYPE
Packit fcad23
    SYNTAX      Integer32 (1..2147483647)
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This variable is used for creating rows in the smRunTable.
Packit fcad23
         The value of this variable is a currently unused value
Packit fcad23
         for smRunIndex, which can be written into the smLaunchStart
Packit fcad23
         object associated with this row to launch a script.
Packit fcad23
Packit fcad23
         The value returned when reading this variable must be unique
Packit fcad23
         for the smLaunchOwner and smLaunchName associated with this
Packit fcad23
         row. Subsequent attempts to read this variable must return
Packit fcad23
         different values.
Packit fcad23
Packit fcad23
         This variable will return the special value 0 if no new rows
Packit fcad23
         can be created.
Packit fcad23
Packit fcad23
         Note that the data type and the range of this object must be
Packit fcad23
         consistent with the definition of smRunIndex."
Packit fcad23
    ::= { smLaunchEntry 14 }
Packit fcad23
Packit fcad23
smLaunchStorageType OBJECT-TYPE
Packit fcad23
    SYNTAX      StorageType
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object defines if this row is kept in volatile storage
Packit fcad23
         and lost upon reboot or if this row is backed up by stable
Packit fcad23
         storage.
Packit fcad23
Packit fcad23
         The value of smLaunchStorageType is only meaningful if the
Packit fcad23
         value of the corresponding RowStatus object is active.
Packit fcad23
Packit fcad23
         If smLaunchStorageType has the value permanent(4), then all
Packit fcad23
         objects whose MAX-ACCESS value is read-create must be
Packit fcad23
         writable, with the exception of the smLaunchStorageType and
Packit fcad23
         smLaunchRowStatus objects, which shall be read-only."
Packit fcad23
    DEFVAL { volatile }
Packit fcad23
    ::= { smLaunchEntry 15 }
Packit fcad23
Packit fcad23
smLaunchRowStatus OBJECT-TYPE
Packit fcad23
    SYNTAX      RowStatus
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A control that allows entries to be added and removed from
Packit fcad23
         this table.
Packit fcad23
Packit fcad23
         Attempts to `destroy' a row or to set a row `notInService'
Packit fcad23
         while the smLaunchOperStatus is `enabled' will result in
Packit fcad23
         an inconsistentValue error.
Packit fcad23
Packit fcad23
         Attempts to `destroy' a row or to set a row `notInService'
Packit fcad23
         where the value of the smLaunchStorageType object is
Packit fcad23
         `permanent' or `readOnly' will result in an
Packit fcad23
         inconsistentValue error.
Packit fcad23
Packit fcad23
         The value of this object has no effect on whether other
Packit fcad23
         objects in this conceptual row can be modified."
Packit fcad23
    ::= { smLaunchEntry 16 }
Packit fcad23
Packit fcad23
smLaunchError OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object contains a descriptive error message if an
Packit fcad23
         attempt to launch a script fails. Implementations must reset
Packit fcad23
         the error message to a zero-length string when a new attempt
Packit fcad23
         to launch a script is started."
Packit fcad23
    DEFVAL { ''H }
Packit fcad23
    ::= { smLaunchEntry 17 }
Packit fcad23
Packit fcad23
smLaunchLastChange OBJECT-TYPE
Packit fcad23
    SYNTAX      DateAndTime
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The date and time when this launch table entry was last
Packit fcad23
         modified. The value '0000000000000000'H is returned if
Packit fcad23
         the launch table entry has not yet been modified.
Packit fcad23
Packit fcad23
         Note that a change of smLaunchStart, smLaunchControl,
Packit fcad23
         smLaunchRunIndexNext, smLaunchRowExpireTime, or the
Packit fcad23
         resetting of smLaunchError is not considered a change
Packit fcad23
         of this launch table entry."
Packit fcad23
    DEFVAL { '0000000000000000'H }
Packit fcad23
    ::= { smLaunchEntry 18 }
Packit fcad23
Packit fcad23
smLaunchRowExpireTime OBJECT-TYPE
Packit fcad23
    SYNTAX      TimeInterval
Packit fcad23
    UNITS       "centi-seconds"
Packit fcad23
    MAX-ACCESS  read-create
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object specifies how long this row remains
Packit fcad23
         in the `enabled' or `disabled' operational state. The value
Packit fcad23
         reported by this object ticks backwards. When the value
Packit fcad23
         reaches 0, it stops ticking backward and the row is
Packit fcad23
         deleted if there are no smRunTable entries associated with
Packit fcad23
Packit fcad23
         this smLaunchTable entry. Otherwise, the smLaunchOperStatus
Packit fcad23
         changes to `expired' and the row deletion is deferred
Packit fcad23
         until there are no smRunTable entries associated with this
Packit fcad23
         smLaunchTable entry.
Packit fcad23
Packit fcad23
         The smLaunchRowExpireTime will not tick backwards if it is
Packit fcad23
         set to its maximum value (2147483647). In other words,
Packit fcad23
         setting this object to its maximum value turns the timer
Packit fcad23
         off.
Packit fcad23
Packit fcad23
         The value of this object may be set in order to increase
Packit fcad23
         or reduce the remaining time that the launch table entry
Packit fcad23
         may be used. Setting the value to 0 will cause an immediate
Packit fcad23
         row deletion or transition into the `expired' operational
Packit fcad23
         state.
Packit fcad23
Packit fcad23
         It is not possible to set this object while the operational
Packit fcad23
         status is `expired'. Attempts to modify this object while
Packit fcad23
         the operational status is `expired' leads to an
Packit fcad23
         inconsistentValue error.
Packit fcad23
Packit fcad23
         Note that the timer ticks backwards independent of the
Packit fcad23
         operational state of the launch table entry."
Packit fcad23
    DEFVAL { 2147483647 }
Packit fcad23
    ::= { smLaunchEntry 19 }
Packit fcad23
Packit fcad23
smRunTable OBJECT-TYPE
Packit fcad23
    SYNTAX      SEQUENCE OF SmRunEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This table lists and describes scripts that are currently
Packit fcad23
         running or have been running in the past."
Packit fcad23
    ::= { smRunObjects 2 }
Packit fcad23
Packit fcad23
smRunEntry OBJECT-TYPE
Packit fcad23
    SYNTAX      SmRunEntry
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "An entry describing a particular running or finished
Packit fcad23
         script."
Packit fcad23
    INDEX { smLaunchOwner, smLaunchName, smRunIndex }
Packit fcad23
    ::= { smRunTable 1 }
Packit fcad23
Packit fcad23
SmRunEntry ::= SEQUENCE {
Packit fcad23
    smRunIndex          Integer32,
Packit fcad23
    smRunArgument       OCTET STRING,
Packit fcad23
    smRunStartTime      DateAndTime,
Packit fcad23
    smRunEndTime        DateAndTime,
Packit fcad23
    smRunLifeTime       TimeInterval,
Packit fcad23
    smRunExpireTime     TimeInterval,
Packit fcad23
    smRunExitCode       INTEGER,
Packit fcad23
    smRunResult         OCTET STRING,
Packit fcad23
    smRunControl        INTEGER,
Packit fcad23
    smRunState          INTEGER,
Packit fcad23
    smRunError          SnmpAdminString,
Packit fcad23
    smRunResultTime     DateAndTime,
Packit fcad23
    smRunErrorTime      DateAndTime
Packit fcad23
}
Packit fcad23
Packit fcad23
smRunIndex OBJECT-TYPE
Packit fcad23
    SYNTAX      Integer32 (1..2147483647)
Packit fcad23
    MAX-ACCESS  not-accessible
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The locally arbitrary, but unique identifier associated
Packit fcad23
         with this running or finished script. This value must be
Packit fcad23
         unique for all rows in the smRunTable with the same
Packit fcad23
         smLaunchOwner and smLaunchName.
Packit fcad23
Packit fcad23
         Note that the data type and the range of this object must
Packit fcad23
         be consistent with the definition of smLaunchRunIndexNext
Packit fcad23
         and smLaunchStart."
Packit fcad23
    ::= { smRunEntry 1 }
Packit fcad23
Packit fcad23
smRunArgument OBJECT-TYPE
Packit fcad23
    SYNTAX      OCTET STRING
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The argument supplied to the script when it started."
Packit fcad23
    DEFVAL { ''H }
Packit fcad23
    ::= { smRunEntry 2 }
Packit fcad23
Packit fcad23
smRunStartTime OBJECT-TYPE
Packit fcad23
    SYNTAX      DateAndTime
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The date and time when the execution started. The value
Packit fcad23
         '0000000000000000'H is returned if the script has not
Packit fcad23
         started yet."
Packit fcad23
    DEFVAL { '0000000000000000'H }
Packit fcad23
    ::= { smRunEntry 3 }
Packit fcad23
Packit fcad23
smRunEndTime OBJECT-TYPE
Packit fcad23
    SYNTAX      DateAndTime
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The date and time when the execution terminated. The value
Packit fcad23
         '0000000000000000'H is returned if the script has not
Packit fcad23
         terminated yet."
Packit fcad23
    DEFVAL { '0000000000000000'H }
Packit fcad23
    ::= { smRunEntry 4 }
Packit fcad23
Packit fcad23
smRunLifeTime OBJECT-TYPE
Packit fcad23
    SYNTAX      TimeInterval
Packit fcad23
    UNITS       "centi-seconds"
Packit fcad23
    MAX-ACCESS  read-write
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object specifies how long the script can execute.
Packit fcad23
         This object returns the remaining time that the script
Packit fcad23
         may run. The object is initialized with the value of the
Packit fcad23
         associated smLaunchLifeTime object and ticks backwards.
Packit fcad23
         The script is aborted immediately when the value reaches 0.
Packit fcad23
Packit fcad23
         The value of this object may be set in order to increase or
Packit fcad23
         reduce the remaining time that the script may run. Setting
Packit fcad23
         this value to 0 will abort script execution immediately,
Packit fcad23
         and, if the value of smRunExpireTime is also 0, will remove
Packit fcad23
         this entry from the smRunTable once it has terminated.
Packit fcad23
Packit fcad23
         If smRunLifeTime is set to its maximum value (2147483647),
Packit fcad23
         either by a set operation or by its initialization from the
Packit fcad23
         smLaunchLifeTime object, then it will not tick backwards.
Packit fcad23
         A running script with a maximum smRunLifeTime value will
Packit fcad23
         thus never be terminated with a `lifeTimeExceeded' exit
Packit fcad23
         code.
Packit fcad23
Packit fcad23
         The value of smRunLifeTime reflects the real-time execution
Packit fcad23
         time as seen by the outside world. The value of this object
Packit fcad23
         will always be 0 for a script that finished execution, that
Packit fcad23
         is smRunState has the value `terminated'.
Packit fcad23
Packit fcad23
         The value of smRunLifeTime does not change while a script
Packit fcad23
         is suspended, that is smRunState has the value `suspended'.
Packit fcad23
         Note that this does not affect set operations. It is legal
Packit fcad23
         to modify smRunLifeTime via set operations while a script
Packit fcad23
         is suspended."
Packit fcad23
    ::= { smRunEntry 5 }
Packit fcad23
Packit fcad23
smRunExpireTime OBJECT-TYPE
Packit fcad23
    SYNTAX      TimeInterval
Packit fcad23
    UNITS       "centi-seconds"
Packit fcad23
    MAX-ACCESS  read-write
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object specifies how long this row can
Packit fcad23
         exist in the smRunTable after the script has terminated.
Packit fcad23
         This object returns the remaining time that the row may
Packit fcad23
         exist before it is aged out. The object is initialized with
Packit fcad23
         the value of the associated smLaunchExpireTime object and
Packit fcad23
         ticks backwards. The entry in the smRunTable is destroyed
Packit fcad23
         when the value reaches 0 and the smRunState has the value
Packit fcad23
         `terminated'.
Packit fcad23
Packit fcad23
         The value of this object may be set in order to increase or
Packit fcad23
         reduce the remaining time that the row may exist.  Setting
Packit fcad23
         the value to 0 will destroy this entry as soon as the
Packit fcad23
         smRunState has the value `terminated'."
Packit fcad23
    ::= { smRunEntry 6 }
Packit fcad23
Packit fcad23
smRunExitCode OBJECT-TYPE
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    noError(1),
Packit fcad23
                    halted(2),
Packit fcad23
                    lifeTimeExceeded(3),
Packit fcad23
                    noResourcesLeft(4),
Packit fcad23
                    languageError(5),
Packit fcad23
                    runtimeError(6),
Packit fcad23
                    invalidArgument(7),
Packit fcad23
                    securityViolation(8),
Packit fcad23
                    genericError(9)
Packit fcad23
                }
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object indicates the reason why a
Packit fcad23
         script finished execution. The smRunExitCode code may have
Packit fcad23
         one of the following values:
Packit fcad23
Packit fcad23
         - `noError', which indicates that the script completed
Packit fcad23
            successfully without errors;
Packit fcad23
Packit fcad23
         - `halted', which indicates that the script was halted
Packit fcad23
            by a request from an authorized manager;
Packit fcad23
Packit fcad23
         - `lifeTimeExceeded', which indicates that the script
Packit fcad23
            exited because a time limit was exceeded;
Packit fcad23
Packit fcad23
         - `noResourcesLeft', which indicates that the script
Packit fcad23
            exited because it ran out of resources (e.g. memory);
Packit fcad23
Packit fcad23
         - `languageError', which indicates that the script exited
Packit fcad23
            because of a language error (e.g. a syntax error in an
Packit fcad23
            interpreted language);
Packit fcad23
Packit fcad23
         - `runtimeError', which indicates that the script exited
Packit fcad23
            due to a runtime error (e.g. a division by zero);
Packit fcad23
Packit fcad23
         - `invalidArgument', which indicates that the script could
Packit fcad23
            not be run because of invalid script arguments;
Packit fcad23
Packit fcad23
         - `securityViolation', which indicates that the script
Packit fcad23
            exited due to a security violation;
Packit fcad23
Packit fcad23
         - `genericError', which indicates that the script exited
Packit fcad23
            for an unspecified reason.
Packit fcad23
Packit fcad23
         If the script has not yet begun running, or is currently
Packit fcad23
         running, the value will be `noError'."
Packit fcad23
    DEFVAL { noError }
Packit fcad23
    ::= { smRunEntry 7 }
Packit fcad23
Packit fcad23
smRunResult OBJECT-TYPE
Packit fcad23
    SYNTAX      OCTET STRING
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The result value produced by the running script. Note that
Packit fcad23
         the result may change while the script is executing."
Packit fcad23
    DEFVAL { ''H }
Packit fcad23
    ::= { smRunEntry 8 }
Packit fcad23
Packit fcad23
smRunControl OBJECT-TYPE
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    abort(1),
Packit fcad23
                    suspend(2),
Packit fcad23
                    resume(3),
Packit fcad23
                    nop(4)
Packit fcad23
                }
Packit fcad23
    MAX-ACCESS  read-write
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object indicates the desired status of the
Packit fcad23
         script execution defined by this row.
Packit fcad23
Packit fcad23
         Setting this object to `abort' will abort execution if the
Packit fcad23
Packit fcad23
         value of smRunState is `initializing', `executing',
Packit fcad23
         `suspending', `suspended' or `resuming'. Setting this object
Packit fcad23
         to `abort' when the value of smRunState is `aborting' or
Packit fcad23
         `terminated', or if the implementation can determine that
Packit fcad23
         the attempt to abort the execution would fail, will result
Packit fcad23
         in an inconsistentValue error.
Packit fcad23
Packit fcad23
         Setting this object to `suspend' will suspend execution
Packit fcad23
         if the value of smRunState is `executing'. Setting this
Packit fcad23
         object to `suspend' will cause an inconsistentValue error
Packit fcad23
         if the value of smRunState is not `executing' or if the
Packit fcad23
         implementation can determine that the attempt to suspend
Packit fcad23
         the execution would fail.
Packit fcad23
Packit fcad23
         Setting this object to `resume' will resume execution
Packit fcad23
         if the value of smRunState is `suspending' or
Packit fcad23
         `suspended'. Setting this object to `resume' will cause an
Packit fcad23
         inconsistentValue error if the value of smRunState is
Packit fcad23
         not `suspended' or if the implementation can determine
Packit fcad23
         that the attempt to resume the execution would fail.
Packit fcad23
Packit fcad23
         Setting this object to nop(4) has no effect."
Packit fcad23
    DEFVAL { nop }
Packit fcad23
    ::= { smRunEntry 9 }
Packit fcad23
Packit fcad23
smRunState OBJECT-TYPE
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    initializing(1),
Packit fcad23
                    executing(2),
Packit fcad23
                    suspending(3),
Packit fcad23
                    suspended(4),
Packit fcad23
                    resuming(5),
Packit fcad23
                    aborting(6),
Packit fcad23
                    terminated(7)
Packit fcad23
                }
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The value of this object indicates the script's execution
Packit fcad23
         state. If the script has been invoked but has not yet
Packit fcad23
         begun execution, the value will be `initializing'. If the
Packit fcad23
         script is running, the value will be `executing'.
Packit fcad23
Packit fcad23
         A running script which received a request to suspend
Packit fcad23
         execution first transitions into a temporary `suspending'
Packit fcad23
         state.  The temporary `suspending' state changes to
Packit fcad23
         `suspended' when the script has actually been suspended. The
Packit fcad23
         temporary `suspending' state changes back to `executing' if
Packit fcad23
Packit fcad23
         the attempt to suspend the running script fails.
Packit fcad23
Packit fcad23
         A suspended script which received a request to resume
Packit fcad23
         execution first transitions into a temporary `resuming'
Packit fcad23
         state. The temporary `resuming' state changes to `running'
Packit fcad23
         when the script has actually been resumed. The temporary
Packit fcad23
         `resuming' state changes back to `suspended' if the attempt
Packit fcad23
         to resume the suspended script fails.
Packit fcad23
Packit fcad23
         A script which received a request to abort execution but
Packit fcad23
         which is still running first transitions into a temporary
Packit fcad23
         `aborting' state.
Packit fcad23
Packit fcad23
         A script which has finished its execution is `terminated'."
Packit fcad23
    ::= { smRunEntry 10 }
Packit fcad23
Packit fcad23
smRunError OBJECT-TYPE
Packit fcad23
    SYNTAX      SnmpAdminString
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This object contains a descriptive error message if the
Packit fcad23
         script startup or execution raised an abnormal condition.
Packit fcad23
         An implementation must store a descriptive error message
Packit fcad23
         in this object if the script exits with the smRunExitCode
Packit fcad23
         `genericError'."
Packit fcad23
    DEFVAL { ''H }
Packit fcad23
    ::= { smRunEntry 11 }
Packit fcad23
Packit fcad23
smRunResultTime OBJECT-TYPE
Packit fcad23
    SYNTAX      DateAndTime
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The date and time when the smRunResult was last updated.
Packit fcad23
         The value '0000000000000000'H is returned if smRunResult
Packit fcad23
         has not yet been updated after the creation of this
Packit fcad23
         smRunTable entry."
Packit fcad23
    DEFVAL { '0000000000000000'H }
Packit fcad23
    ::= { smRunEntry 12 }
Packit fcad23
Packit fcad23
smRunErrorTime OBJECT-TYPE
Packit fcad23
    SYNTAX      DateAndTime
Packit fcad23
    MAX-ACCESS  read-only
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The date and time when the smRunError was last updated.
Packit fcad23
         The value '0000000000000000'H is returned if smRunError
Packit fcad23
Packit fcad23
         has not yet been updated after the creation of this
Packit fcad23
         smRunTable entry."
Packit fcad23
    DEFVAL { '0000000000000000'H }
Packit fcad23
    ::= { smRunEntry 13 }
Packit fcad23
Packit fcad23
--
Packit fcad23
-- Notifications. The definition of smTraps makes notification
Packit fcad23
-- registrations reversible (see STD 58, RFC 2578).
Packit fcad23
--
Packit fcad23
Packit fcad23
smTraps OBJECT IDENTIFIER ::= { smNotifications 0 }
Packit fcad23
Packit fcad23
smScriptAbort NOTIFICATION-TYPE
Packit fcad23
    OBJECTS     { smRunExitCode, smRunEndTime, smRunError }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This notification is generated whenever a running script
Packit fcad23
         terminates with an smRunExitCode unequal to `noError'."
Packit fcad23
    ::= { smTraps 1 }
Packit fcad23
Packit fcad23
smScriptResult NOTIFICATION-TYPE
Packit fcad23
    OBJECTS     { smRunResult }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This notification can be used by scripts to notify other
Packit fcad23
         management applications about results produced by the
Packit fcad23
         script.
Packit fcad23
Packit fcad23
         This notification is not automatically generated by the
Packit fcad23
         Script MIB implementation. It is the responsibility of
Packit fcad23
         the executing script to emit this notification where it
Packit fcad23
         is appropriate to do so."
Packit fcad23
    ::= { smTraps 2 }
Packit fcad23
Packit fcad23
smScriptException NOTIFICATION-TYPE
Packit fcad23
    OBJECTS     { smRunError }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This notification can be used by scripts to notify other
Packit fcad23
         management applications about script errors.
Packit fcad23
Packit fcad23
         This notification is not automatically generated by the
Packit fcad23
         Script MIB implementation. It is the responsibility of
Packit fcad23
         the executing script or the runtime system to emit this
Packit fcad23
         notification where it is appropriate to do so."
Packit fcad23
    ::= { smTraps 3 }
Packit fcad23
Packit fcad23
-- conformance information
Packit fcad23
Packit fcad23
smCompliances OBJECT IDENTIFIER ::= { smConformance 1 }
Packit fcad23
smGroups      OBJECT IDENTIFIER ::= { smConformance 2 }
Packit fcad23
Packit fcad23
-- compliance statements
Packit fcad23
Packit fcad23
smCompliance2 MODULE-COMPLIANCE
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The compliance statement for SNMP entities which implement
Packit fcad23
         the Script MIB."
Packit fcad23
    MODULE      -- this module
Packit fcad23
    MANDATORY-GROUPS {
Packit fcad23
            smLanguageGroup, smScriptGroup2, smLaunchGroup2,
Packit fcad23
            smRunGroup2, smNotificationsGroup2
Packit fcad23
    }
Packit fcad23
    GROUP   smCodeGroup
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The smCodeGroup is mandatory only for those implementations
Packit fcad23
         that support the downloading of scripts via SNMP."
Packit fcad23
    OBJECT  smScriptSource
Packit fcad23
    MIN-ACCESS  read-only
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The smScriptSource object is read-only for implementations
Packit fcad23
         that are not able to download script code from a URL."
Packit fcad23
    OBJECT smCodeText
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation need only support write access to
Packit fcad23
         the smCodeText object only during row creation."
Packit fcad23
    OBJECT smLaunchArgument
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation has to support a minimum size
Packit fcad23
         for smLaunchArgument of 255 octets."
Packit fcad23
    OBJECT smRunArgument
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation has to support a minimum size
Packit fcad23
         for smRunArgument of 255 octets."
Packit fcad23
    OBJECT smRunResult
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation has to support a minimum size
Packit fcad23
         for smRunResult of 255 octets."
Packit fcad23
    OBJECT smRunState
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation does not have to support script
Packit fcad23
         suspension and the smRunState `suspended'. Such an
Packit fcad23
         implementation will change into the `suspending' state
Packit fcad23
         when the smRunControl is set to `suspend' and remain in this
Packit fcad23
         state until smRunControl is set to `resume' or the script
Packit fcad23
         terminates."
Packit fcad23
    ::= { smCompliances 2 }
Packit fcad23
Packit fcad23
smLanguageGroup OBJECT-GROUP
Packit fcad23
    OBJECTS {
Packit fcad23
        smLangLanguage, smLangVersion,
Packit fcad23
        smLangVendor, smLangRevision,
Packit fcad23
        smLangDescr, smExtsnExtension,
Packit fcad23
        smExtsnVersion, smExtsnVendor,
Packit fcad23
        smExtsnRevision, smExtsnDescr
Packit fcad23
    }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A collection of objects providing information about the
Packit fcad23
         capabilities of the scripting engine."
Packit fcad23
    ::= { smGroups 1 }
Packit fcad23
Packit fcad23
smScriptGroup2 OBJECT-GROUP
Packit fcad23
    OBJECTS {
Packit fcad23
        smScriptDescr, smScriptLanguage,
Packit fcad23
        smScriptSource, smScriptAdminStatus,
Packit fcad23
        smScriptOperStatus, smScriptStorageType,
Packit fcad23
        smScriptRowStatus, smScriptError,
Packit fcad23
        smScriptLastChange
Packit fcad23
    }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A collection of objects providing information about
Packit fcad23
         installed scripts."
Packit fcad23
    ::= { smGroups 7 }
Packit fcad23
Packit fcad23
smCodeGroup OBJECT-GROUP
Packit fcad23
    OBJECTS {
Packit fcad23
        smCodeText, smCodeRowStatus
Packit fcad23
    }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A collection of objects used to download or modify scripts
Packit fcad23
         by using SNMP set requests."
Packit fcad23
    ::= { smGroups 3 }
Packit fcad23
Packit fcad23
smLaunchGroup2 OBJECT-GROUP
Packit fcad23
    OBJECTS {
Packit fcad23
        smLaunchScriptOwner, smLaunchScriptName,
Packit fcad23
        smLaunchArgument, smLaunchMaxRunning,
Packit fcad23
        smLaunchMaxCompleted, smLaunchLifeTime,
Packit fcad23
        smLaunchExpireTime, smLaunchStart,
Packit fcad23
        smLaunchControl, smLaunchAdminStatus,
Packit fcad23
        smLaunchOperStatus, smLaunchRunIndexNext,
Packit fcad23
        smLaunchStorageType, smLaunchRowStatus,
Packit fcad23
        smLaunchError, smLaunchLastChange,
Packit fcad23
        smLaunchRowExpireTime
Packit fcad23
    }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A collection of objects providing information about scripts
Packit fcad23
         that can be launched."
Packit fcad23
    ::= { smGroups 8 }
Packit fcad23
Packit fcad23
smRunGroup2 OBJECT-GROUP
Packit fcad23
    OBJECTS {
Packit fcad23
        smRunArgument, smRunStartTime,
Packit fcad23
        smRunEndTime, smRunLifeTime,
Packit fcad23
        smRunExpireTime, smRunExitCode,
Packit fcad23
        smRunResult, smRunState,
Packit fcad23
        smRunControl, smRunError,
Packit fcad23
        smRunResultTime, smRunErrorTime
Packit fcad23
    }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A collection of objects providing information about running
Packit fcad23
         scripts."
Packit fcad23
    ::= { smGroups 9 }
Packit fcad23
Packit fcad23
smNotificationsGroup2 NOTIFICATION-GROUP
Packit fcad23
    NOTIFICATIONS {
Packit fcad23
        smScriptAbort,
Packit fcad23
        smScriptResult,
Packit fcad23
        smScriptException
Packit fcad23
    }
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The notifications emitted by the Script MIB."
Packit fcad23
    ::= { smGroups 10 }
Packit fcad23
Packit fcad23
--
Packit fcad23
-- Deprecated compliance and conformance group definitions
Packit fcad23
-- from RFC 2592.
Packit fcad23
--
Packit fcad23
Packit fcad23
smCompliance MODULE-COMPLIANCE
Packit fcad23
    STATUS      deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The compliance statement for SNMP entities which implement
Packit fcad23
         the Script MIB."
Packit fcad23
    MODULE      -- this module
Packit fcad23
    MANDATORY-GROUPS {
Packit fcad23
Packit fcad23
            smLanguageGroup, smScriptGroup, smLaunchGroup, smRunGroup
Packit fcad23
    }
Packit fcad23
    GROUP   smCodeGroup
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The smCodeGroup is mandatory only for those implementations
Packit fcad23
         that support the downloading of scripts via SNMP."
Packit fcad23
    OBJECT  smScriptSource
Packit fcad23
    MIN-ACCESS  read-only
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The smScriptSource object is read-only for implementations
Packit fcad23
         that are not able to download script code from a URL."
Packit fcad23
    OBJECT smCodeText
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation need only support write access
Packit fcad23
         to the smCodeText object during row creation."
Packit fcad23
    OBJECT smLaunchArgument
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation has to support a minimum size
Packit fcad23
         for smLaunchArgument of 255 octets."
Packit fcad23
    OBJECT smRunArgument
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation has to support a minimum size
Packit fcad23
         for smRunArgument of 255 octets."
Packit fcad23
    OBJECT smRunResult
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation has to support a minimum size
Packit fcad23
         for smRunResult of 255 octets."
Packit fcad23
    OBJECT smRunState
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A compliant implementation does not have to support script
Packit fcad23
         suspension and the smRunState `suspended'. Such an
Packit fcad23
         implementation will change into the `suspending' state
Packit fcad23
         when the smRunControl is set to `suspend' and remain in this
Packit fcad23
         state until smRunControl is set to `resume' or the script
Packit fcad23
         terminates."
Packit fcad23
    ::= { smCompliances 1 }
Packit fcad23
Packit fcad23
smScriptGroup OBJECT-GROUP
Packit fcad23
    OBJECTS {
Packit fcad23
        smScriptDescr, smScriptLanguage,
Packit fcad23
        smScriptSource, smScriptAdminStatus,
Packit fcad23
        smScriptOperStatus, smScriptStorageType,
Packit fcad23
        smScriptRowStatus
Packit fcad23
    }
Packit fcad23
    STATUS      deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A collection of objects providing information about
Packit fcad23
         installed scripts."
Packit fcad23
    ::= { smGroups 2 }
Packit fcad23
Packit fcad23
smLaunchGroup OBJECT-GROUP
Packit fcad23
    OBJECTS {
Packit fcad23
        smLaunchScriptOwner, smLaunchScriptName,
Packit fcad23
        smLaunchArgument, smLaunchMaxRunning,
Packit fcad23
        smLaunchMaxCompleted, smLaunchLifeTime,
Packit fcad23
        smLaunchExpireTime, smLaunchStart,
Packit fcad23
        smLaunchControl, smLaunchAdminStatus,
Packit fcad23
        smLaunchOperStatus, smLaunchRunIndexNext,
Packit fcad23
        smLaunchStorageType, smLaunchRowStatus
Packit fcad23
    }
Packit fcad23
    STATUS      deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A collection of objects providing information about scripts
Packit fcad23
         that can be launched."
Packit fcad23
    ::= { smGroups 4 }
Packit fcad23
Packit fcad23
smRunGroup OBJECT-GROUP
Packit fcad23
    OBJECTS {
Packit fcad23
        smRunArgument, smRunStartTime,
Packit fcad23
        smRunEndTime, smRunLifeTime,
Packit fcad23
        smRunExpireTime, smRunExitCode,
Packit fcad23
        smRunResult, smRunState,
Packit fcad23
        smRunControl, smRunError
Packit fcad23
    }
Packit fcad23
    STATUS      deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A collection of objects providing information about running
Packit fcad23
         scripts."
Packit fcad23
    ::= { smGroups 5 }
Packit fcad23
Packit fcad23
smNotificationsGroup NOTIFICATION-GROUP
Packit fcad23
    NOTIFICATIONS {
Packit fcad23
        smScriptAbort,
Packit fcad23
        smScriptResult
Packit fcad23
    }
Packit fcad23
    STATUS      deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The notifications emitted by the Script MIB."
Packit fcad23
    ::= { smGroups 6 }
Packit fcad23
Packit fcad23
END