-- extracted from draft-ietf-malloc-malloc-mib-00.txt
-- at Mon Nov 15 17:10:50 1999

MALLOC-MIB DEFINITIONS ::= BEGIN

IMPORTS
    MODULE-IDENTITY, OBJECT-TYPE, UInteger32,
    Integer32, Gauge32, IpAddress    FROM SNMPv2-SMI
    RowStatus, DisplayString         FROM SNMPv2-TC
    MODULE-COMPLIANCE, OBJECT-GROUP  FROM SNMPv2-CONF;

mallocMIB MODULE-IDENTITY
    LAST-UPDATED "9901151200Z"
    ORGANIZATION "Microsoft Corporation"
    CONTACT-INFO
                        " Dave Thaler
                          Microsoft Corporation
                          One Microsoft Way
                          Redmond, WA  98052-6399
                          EMail: dthalerd@microsoft.com"
    DESCRIPTION
            "The MIB module for management of Multicast Address
            Allocation Servers."
    ::= { XXX }


mallocMIBObjects OBJECT IDENTIFIER ::= { mallocMIB 1 }

malloc      OBJECT IDENTIFIER ::= { mallocMIBObjects 1 }
--
-- scalars
--

mallocCapabilities OBJECT-TYPE
    SYNTAX     BITS {
                   startTime(0),
                   serverMobility(1),
                   retryAfter(2)
               }
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "This object describes the capabilities which a client or
            server supports.  The startTime bit indicates that
            allocations with a future start time are supported.  The
            serverMobility bit indicates that allocations can be renewed
            or released from a server other than the one granting the
            original allocation.  The retryAfter bit indicates support
            for a waiting state whether the client may check back at a
            later time to get the status of its request."
    ::= { malloc 1 }

--
-- the Scope Table
--
-- Entries in this table may be dynamically discovered via
-- some other protocol, such as MZAP, or may be statically
-- configured, such as in an isolated network environment.
--

mallocScopeTable OBJECT-TYPE
    SYNTAX     SEQUENCE OF MallocScopeEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "The (conceptual) table containing information on multicast
            scopes from which addresses may be allocated."
    ::= { malloc 2 }

mallocScopeEntry OBJECT-TYPE
    SYNTAX     MallocScopeEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "An entry (conceptual row) containing the information on a
            particular multicast scope."
    INDEX      { mallocScopeFirstAddress }
    ::= { mallocScopeTable 1 }

MallocScopeEntry ::= SEQUENCE {
    mallocScopeFirstAddress         IpAddress,
    mallocScopeLastAddress          IpAddress,
    mallocScopeTTL                  INTEGER,
    mallocScopeLifetime             UInteger32,
    mallocScopeNumAllocatedAddrs    Gauge32,
    mallocScopeNumOfferedAddrs      Gauge32,
    mallocScopeNumWaitingAddrs      Gauge32,
    mallocScopeStatus               RowStatus
}

mallocScopeFirstAddress OBJECT-TYPE
    SYNTAX     IpAddress
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "The first address in the multicast scope range."
    ::= { mallocScopeEntry 1 }

mallocScopeLastAddress OBJECT-TYPE
    SYNTAX     IpAddress
    MAX-ACCESS read-create
    STATUS     current
    DESCRIPTION
            "The last address in the multicast scope range."
    ::= { mallocScopeEntry 2 }

mallocScopeTTL OBJECT-TYPE
    SYNTAX     INTEGER (0..255)
    MAX-ACCESS read-create
    STATUS     current
    DESCRIPTION
            "The IPv4 TTL (or IPv6 hop limit) which applications should
            use for groups within the scope."
    DEFVAL     { 255 }
    ::= { mallocScopeEntry 3 }

mallocScopeLifetime OBJECT-TYPE
    SYNTAX     UInteger32
    UNITS      "seconds"
    MAX-ACCESS read-create
    STATUS     current
    DESCRIPTION
            "The number of seconds remaining in the lifetime of the
            scope.  A value of 0 indicates that the scope is not subject
            to aging."
    DEFVAL     { 0 }
    ::= { mallocScopeEntry 4 }

mallocScopeNumAllocatedAddrs OBJECT-TYPE
    SYNTAX     Gauge32
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The number of addresses in the range which have been
            allocated.  This value can be used to determine the current
            address space utilization within the scoped range. This
            should match the total number of addresses for this scope
            covered by entries in the mallocAddressTable."
    ::= { mallocScopeEntry 5 }

mallocScopeNumOfferedAddrs OBJECT-TYPE
    SYNTAX     Gauge32
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The number of addresses in the range which have been
            offered.  This number should match the sum of
            mallocRequestNumAddrs for all entries in the
            mallocRequestTable in the offered state.  Together with
            mallocScopeNumAllocatedAddrs, this can be used to determine
            the address space utilization within the scoped range in the
            immediate future."
    ::= { mallocScopeEntry 6 }

mallocScopeNumWaitingAddrs OBJECT-TYPE
    SYNTAX     Gauge32
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The number of addresses in the range which have been
            requested, but whose state is waiting, while the server
            attempts to acquire more address space."
    ::= { mallocScopeEntry 7 }

mallocScopeStatus OBJECT-TYPE
    SYNTAX     RowStatus
    MAX-ACCESS read-create
    STATUS     current
    DESCRIPTION
            "The status of this row, by which new entries may be
            created, or old entries deleted from this table."
    ::= { mallocScopeEntry 8 }

--
-- the Scope Name Table
--
-- Entries in this table may be dynamically discovered via
-- some other protocol, such as MZAP, or may be statically
-- configured, such as in an isolated network environment.
--

mallocScopeNameTable OBJECT-TYPE
    SYNTAX     SEQUENCE OF MallocScopeNameEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "The (conceptual) table containing information on multicast
            scope names."
    ::= { malloc 3 }

mallocScopeNameEntry OBJECT-TYPE
    SYNTAX     MallocScopeNameEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "An entry (conceptual row) containing the information on a
            particular multicast scope name."
    INDEX      { mallocScopeFirstAddress, IMPLIED mallocScopeNameLangName }
    ::= { mallocScopeNameTable 1 }

MallocScopeNameEntry ::= SEQUENCE {
    mallocScopeNameLangName         DisplayString,
    mallocScopeNameScopeName        DisplayString,
    mallocScopeNameDefault          INTEGER,
    mallocScopeNameStatus           RowStatus
}

mallocScopeNameLangName OBJECT-TYPE
    SYNTAX     DisplayString (SIZE(1..255))
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "The RFC 1766 language tag for the language of the scope
            name."
    ::= { mallocScopeNameEntry 1 }

mallocScopeNameScopeName OBJECT-TYPE
    SYNTAX     DisplayString (SIZE(1..255))
    MAX-ACCESS read-create
    STATUS     current
    DESCRIPTION
            "The UTF-8 encoding of the scope name."
    ::= { mallocScopeNameEntry 2 }

mallocScopeNameDefault OBJECT-TYPE
    SYNTAX     INTEGER {
                   true(1),
                   false(2)
               }
    MAX-ACCESS read-create
    STATUS     current
    DESCRIPTION
            "This object indicates whether this name should be used if
            no scope name exists in a client's preferred language."
    DEFVAL     { false }
    ::= { mallocScopeNameEntry 3 }

mallocScopeNameStatus OBJECT-TYPE
    SYNTAX     RowStatus
    MAX-ACCESS read-create
    STATUS     current
    DESCRIPTION
            "The status of this row, by which new entries may be
            created, or old entries deleted from this table."
    ::= { mallocScopeNameEntry 4 }

--
-- the Request Table
--
-- Entries in this table reflect requests dynamically received
-- by an address allocation protocol.
--

mallocRequestTable OBJECT-TYPE
    SYNTAX     SEQUENCE OF MallocRequestEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "The (conceptual) table containing information on allocation
            requests, whether allocated or in progress.  This table may
            also be used to determine which clients are responsible for
            high address space utilization within a given scope."
    ::= { malloc 4 }

mallocRequestEntry OBJECT-TYPE
    SYNTAX     MallocRequestEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "An entry (conceptual row) containing the information on a
            particular allocation request."
    INDEX      { mallocRequestGuid }
    ::= { mallocRequestTable 1 }

MallocRequestEntry ::= SEQUENCE {
    mallocRequestGuid                    OCTET STRING,
    mallocRequestScopeFirstAddress       IpAddress,
    mallocRequestStartTime               Integer32,
    mallocRequestEndTime                 Integer32,
    mallocRequestNumAddrs                Integer32,
    mallocRequestState                   INTEGER,
    mallocRequestClientAddress           IpAddress,
    mallocRequestServerAddress           IpAddress
}

mallocRequestGuid OBJECT-TYPE
    SYNTAX     OCTET STRING
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "The unique identifier of this request."
    ::= { mallocRequestEntry 1 }

mallocRequestScopeFirstAddress OBJECT-TYPE
    SYNTAX     IpAddress
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The first address of the scope to which the request
            applies.  This must match mallocScopeFirstAddress for some
            row in the mallocScopeTable."
    ::= { mallocRequestEntry 2 }

mallocRequestStartTime OBJECT-TYPE
    SYNTAX     Integer32
    UNITS      "seconds"
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The number of seconds remaining before the start time of
            the request.  A value of 0 means that the allocation is
            currently in effect."
    ::= { mallocRequestEntry 3 }

mallocRequestEndTime OBJECT-TYPE
    SYNTAX     Integer32
    UNITS      "seconds"
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The number of seconds remaining before the end time of the
            request."
    ::= { mallocRequestEntry 4 }

mallocRequestNumAddrs OBJECT-TYPE
    SYNTAX     Integer32
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The number of addresses requested.  If the addresses have
            been allocated, this number should match the total number of
            addresses for this request covered by entries in the
            mallocAddressTable."
    ::= { mallocRequestEntry 5 }

mallocRequestState OBJECT-TYPE
    SYNTAX     INTEGER {
                   allocated(1),
                   offered(2),   -- tentatively allocated
                   waiting(3)    -- waiting for more space
               }
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The state of the request. A value of allocated indicates
            that one or more entries for this request are present in the
            mallocAddressTable.  A value of offered indicates that
            addresses have been offered to the client (e.g. via a MADCAP
            OFFER message), but the allocation has not been committed.
            A value of waiting indicates that the allocation is blocked
            while the server attempts to acquire more space from which
            it can allocate addresses."
    ::= { mallocRequestEntry 6 }

mallocRequestClientAddress OBJECT-TYPE
    SYNTAX     IpAddress
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The address of the client to which this allocation was
            (last) granted."
    ::= { mallocRequestEntry 7 }

mallocRequestServerAddress OBJECT-TYPE
    SYNTAX     IpAddress
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The address of the server to which the request was (last)
            sent."
    ::= { mallocRequestEntry 8 }

--
-- the Address Table
--

mallocAddressTable OBJECT-TYPE
    SYNTAX     SEQUENCE OF MallocAddressEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "The (conceptual) table containing information on blocks of
            allocated addresses.  This table may be used to map a given
            multicast group address to the associated request."
    ::= { malloc 5 }

mallocAddressEntry OBJECT-TYPE
    SYNTAX     MallocAddressEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "An entry (conceptual row) containing the information on a
            particular block of allocated addresses."
    INDEX      { mallocAddressFirstAddress }
    ::= { mallocAddressTable 1 }

MallocAddressEntry ::= SEQUENCE {
    mallocAddressFirstAddress            IpAddress,
    mallocAddressNumAddrs                Integer32,
    mallocAddressRequestGuid             OCTET STRING
}

mallocAddressFirstAddress OBJECT-TYPE
    SYNTAX     IpAddress
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
            "The first address in the allocated block."
    ::= { mallocAddressEntry 1 }

mallocAddressNumAddrs OBJECT-TYPE
    SYNTAX     Integer32
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The number of addresses in the allocated block."
    ::= { mallocAddressEntry 2 }

mallocAddressRequestGuid OBJECT-TYPE
    SYNTAX     OCTET STRING
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
            "The unique identifier of the request which caused this
            block of addresses to be allocated."
    ::= { mallocAddressEntry 3 }

-- conformance information

mallocMIBConformance
                  OBJECT IDENTIFIER ::= { mallocMIB 2 }
mallocMIBCompliances
                  OBJECT IDENTIFIER ::= { mallocMIBConformance 1 }
mallocMIBGroups  OBJECT IDENTIFIER ::= { mallocMIBConformance 2 }


-- compliance statements

mallocMIBServerCompliance MODULE-COMPLIANCE
    STATUS  current
    DESCRIPTION
            "The compliance statement for multicast address allocation
            servers implementing the MALLOC MIB."
    MODULE  -- this module
    MANDATORY-GROUPS { mallocMIBBasicGroup,
                       mallocMIBServerGroup }

        OBJECT      mallocScopeLastAddress
        MIN-ACCESS  read-only
        DESCRIPTION
            "Write access is not required."

        OBJECT      mallocScopeTTL
        MIN-ACCESS  read-only
        DESCRIPTION
            "Write access is not required."

        OBJECT      mallocScopeLifetime
        MIN-ACCESS  read-only
        DESCRIPTION
            "Write access is not required."

        OBJECT      mallocScopeStatus
        MIN-ACCESS  read-only
        DESCRIPTION
            "Write access is not required."

        OBJECT      mallocScopeNameScopeName
        MIN-ACCESS  read-only
        DESCRIPTION
            "Write access is not required."

        OBJECT      mallocScopeNameDefault
        MIN-ACCESS  read-only
        DESCRIPTION
            "Write access is not required."

        OBJECT      mallocScopeNameStatus
        MIN-ACCESS  read-only
        DESCRIPTION
            "Write access is not required."
   ::= { mallocMIBCompliances 1 }

mallocMIBClientCompliance MODULE-COMPLIANCE
    STATUS  current
    DESCRIPTION
            "The compliance statement for hosts implementing the MALLOC
            MIB."
    MODULE  -- this module
    MANDATORY-GROUPS { mallocMIBBasicGroup,
                       mallocMIBClientGroup }
   ::= { mallocMIBCompliances 2 }

-- units of conformance

mallocMIBBasicGroup OBJECT-GROUP
        OBJECTS { mallocCapabilities,
                  mallocRequestScopeFirstAddress, mallocRequestStartTime,
                  mallocRequestEndTime, mallocRequestNumAddrs,
                  mallocRequestState,
                  mallocAddressNumAddrs, mallocAddressRequestGuid
                }
        STATUS  current
        DESCRIPTION
            "The basic collection of objects providing management of IP
            multicast address allocation."
   ::= { mallocMIBGroups 1 }

mallocMIBServerGroup OBJECT-GROUP
        OBJECTS { mallocScopeLastAddress, mallocScopeTTL,
                  mallocScopeLifetime, mallocScopeNumAllocatedAddrs,
                  mallocScopeNumOfferedAddrs, mallocScopeNumWaitingAddrs,
                  mallocScopeStatus,
                  mallocScopeNameScopeName, mallocScopeNameDefault,
                  mallocScopeNameStatus,
                  mallocRequestClientAddress
                }

        STATUS  current
        DESCRIPTION
            "A collection of objects providing management of multicast
            address allocation in servers."
   ::= { mallocMIBGroups 2 }

mallocMIBClientGroup OBJECT-GROUP
        OBJECTS { mallocRequestServerAddress }
        STATUS  current
        DESCRIPTION
            "The basic collection of objects providing management of IP
            multicast address allocation."
   ::= { mallocMIBGroups 3 }

END

-- 
-- Copyright (C) The Internet Society (1999).  All Rights Reserved.
-- 
-- This document and translations of it may be copied and furnished to
-- others, and derivative works that comment on or otherwise explain it or
-- assist in its implmentation may be prepared, copied, published and
-- distributed, in whole or in part, without restriction of any kind,
-- provided that the above copyright notice and this paragraph are included
-- on all such copies and derivative works.  However, this document itself
-- may not be modified in any way, such as by removing the copyright notice
-- or references to the Internet Society or other Internet organizations,
-- except as needed for the purpose of developing Internet standards in
-- which case the procedures for copyrights defined in the Internet
-- Standards process must be followed, or as required to translate it into
-- languages other than English.
-- 
-- The limited permissions granted above are perpetual and will not be
-- revoked by the Internet Society or its successors or assigns.
-- 
-- This document and the information contained herein is provided on an "AS
-- IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
-- FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT
-- LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT
-- INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
-- FITNESS FOR A PARTICULAR PURPOSE."
-- 
--