Blame test/smidiff/DISMAN-SCRIPT-MIB.old

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