Definitions of Textual Conventions and OBJECT-IDENTITIES for IP Over InfiniBand (IPOVERIB) Management
draft-ietf-ipoib-ibmib-tc-mib-08

Versions: 00 01 02 03 04 05 06 07 08                                    
INTERNET-DRAFT                                              Sean Harnedy
                                                  Mangrove Systems, Inc.
Expires: August 2004                                       February 2004



                   Definitions of Textual Conventions
                     and OBJECT-IDENTITIES for
               IP Over InfiniBand (IPOVERIB) Management

                <draft-ietf-ipoib-ibmib-tc-mib-05.txt>


Status of this Memo

   This document is an Internet-Draft and is in full conformance with
   all provisions of Section 10 of RFC 2026.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF), its areas, and its working groups.  Note that
   other groups may also distribute working documents as Internet-
   Drafts.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   The list of current Internet-Drafts can be accessed at
              http://www.ietf.org/ietf/1id-abstracts.txt

   The list of Internet-Draft Shadow Directories can be accessed at
              http://www.ietf.org/shadow.html

   Distribution of this document is unlimited.  Please send comments to
   the IP Over IB (ipoib) Working Group, ipoverib@ietf.org.

Copyright Notice

   Copyright (C) The Internet Society (2004).  All Rights Reserved.

Abstract

   This memo defines a Management Information Base (MIB) module that
   contains Textual Conventions and OBJECT-IDENTITIES for use in
   definitions of management information for IP Over InfiniBand
   (IPOVERIB) networks.  The intent is that these TEXTUAL
   CONVENTIONs (TCs) will be imported and used in IPOVERIB related
   MIB modules.








Harnedy                    Expires August 2004                  [Page 1]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


Table of Contents

   1.  Introduction ...............................................    3
   2.  The Internet-Standard Management Framework .................    3
   3.  IPOVERIB Textual Conventions MIB Definitions ...............    4
   4.  Acknowledgments ............................................   10
   5.  Security Considerations ....................................   10
   6.  IANA Considerations ........................................   10
   7.  References .................................................   10
       7.1  Normative References ..................................   10
       7.2  Informative References ................................   11
   8.  Author's Address ...........................................   11
   9.  Intellectual Property Notice ...............................   11
   10.  Full Copyright Statement ..................................   12








































Harnedy                    Expires August 2004                  [Page 2]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


1. Introduction

   This memo defines a portion of the Management Information Base for
   use with network management protocols in the Internet community.
   In particular, it defines Textual Conventions used in IETF IPOVERIB
   and IPOVERIB-related MIBs.

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in RFC 2119 [RFC2119].

   For an introduction to the concepts of InfiniBand, see [INFINIV1].


2. The Internet-Standard Management Framework

   For a detailed overview of the documents that describe the current
   Internet-Standard Management Framework, please refer to section 7 of
   RFC 3410 [RFC3410].

   Managed objects are accessed via a virtual information store, termed
   the Management Information Base or MIB.  MIB objects are generally
   accessed through the Simple Network Management Protocol (SNMP).
   Objects in the MIB are defined using the mechanisms defined in the
   Structure of Management Information (SMI).  This memo specifies a MIB
   module that is compliant to the SMIv2, which is described in STD 58,
   RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580
   [RFC2580].


























Harnedy                    Expires August 2004                  [Page 3]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


3. IPOVERIB Textual Conventions MIB Definitions

IB-TC-MIB DEFINITIONS ::= BEGIN

IMPORTS
       experimental, MODULE-IDENTITY, Unsigned32
          FROM SNMPv2-SMI

       TEXTUAL-CONVENTION
          FROM SNMPv2-TC;

ibTcMIB MODULE-IDENTITY
    LAST-UPDATED "200402011200Z"  -- 1 February 2004 12:00:00 GMT
    ORGANIZATION
                 "IETF IP over IB (IPOIB) Working Group"
    CONTACT-INFO
                 "Sean Harnedy
          Postal: Mangrove Systems, Inc.
                  10 Fairfield Boulevard
                  Wallingford, CT 06492
                  United States
          Tel:    +1-203-679-7539
          Email:  sharnedy@mangrovesystems.com

          Email comments to the IPOIB WG Mailing List at
          ipoverib@ietf.org."
    DESCRIPTION
       "Copyright (C) The Internet Society (2004).  The initial
        version of this MIB module was published in RFC XXXX; for
        full legal notices see the RFC itself.  Supplementary
        information may be available on
        http://www.ietf.org/copyrights/ianamib.html.

        This MIB contains managed object definitions and textual
        conventions for managing InfiniBand devices that support
        the IP Over InfiniBand (IPOIB) protocols and procedures."

    REVISION
         "200402011200Z"  -- 1 February 2004 12:00:00 GMT
    DESCRIPTION
         "Initial version published as part of RFC XXXX."
    ::= { infinibandMIB 1 }

-- The IANA has currently defined the InfiniBand MIB on the
-- experimental branch.

infinibandMIB OBJECT IDENTIFIER ::= { experimental 117 }







Harnedy                    Expires August 2004                  [Page 4]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


-- This object identifier needs to be reassigned by IANA.
-- Since infiniband has been assigned an ifType of 199 a recommendation
-- is made that this OID be 199 as well, e.g.
--   ::= { transmission 199 }
--
-- The updated Object Identifier definition would be:
--
-- infinibandMIB OBJECT IDENTIFIER ::= { transmission 199 }
--


-- Textual Conventions.

IbDataPort ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "d"
    STATUS      current
    DESCRIPTION
       "Identifies a physical InfiniBand (IB) Port.  The InfiniBand
        Architecture (IBA) defines a maximum of 254 physical ports
        numbered Port 1 to Port 254.  A port is the location on a
        Channel Adapter, IB Router, or IB Switch to which a link is
        connected.  If a device has N ports, the ports are always
        numbered from 1 to N.  The relationship between an InfiniBand
        port and an ifIndex is one-to-one.  As such, the value of an
        ifIndex object instance can be directly used to identify
        corresponding instances of the objects defined herein as IB
        data ports.  Note: this definition does NOT include logical
        Port 0, which is reserved for IB management packets."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1]
         Section 18.2.4.1 (C18-10.a1) for switches, Section 17.2.1.3
         (C17-7.a1) for Channel Adapters, and Section 19.2.4.2 for
         routers."
    SYNTAX  Unsigned32 (1..254)

IbDataPortAndInvalid ::= TEXTUAL-CONVENTION
    STATUS      current
    DESCRIPTION
       "Identifies a physical IB port plus an invalid port number.
        The invalid port number has a value of 255.  Note: this
        definition does NOT include logical Port 0, which is reserved
        for IB management packets."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1]
         Section 18.2.4.1 (C18-10.a1) for switches, Section 17.2.1.3
         (C17-7.a1) for Channel Adapters, and Section 19.2.4.2 for
         routers."
    SYNTAX  Unsigned32 (1..255)






Harnedy                    Expires August 2004                  [Page 5]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


IbVirtualLane ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "d"
    STATUS      current
    DESCRIPTION
       "Identifies a Virtual Lane (VL) instance on a given interface
        (i.e., IB port).  VLs provide a mechanism for creating multiple
        virtual links within a physical link.  IBA defines VL 0 through
        VL 14 for data and VL 15 exclusively for Subnet Management.
        The actual data VLs that a port uses are configured by the
        Subnet Manager.  The default data VL is always VL 0."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1]
         Section 3.5.7."
    SYNTAX  Unsigned32 (0..15)

IbDataVirtualLane ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "d"
    STATUS      current
    DESCRIPTION
       "Identifies a Data Virtual Lane instance on a given interface
        (i.e., IB port).  This TC definition excludes the management
        Virtual Lane (VL 15).  The actual data VLs that a port uses
        are configured by the Subnet Manager.  The default data VL is
        always the first VL (VL 0)."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1]
         Section 3.5.7."
    SYNTAX  Unsigned32 (0..14)

IbDlid ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "d"
    STATUS      current
    DESCRIPTION
       "Identifies the Destination Local Identifier (DLID).  The IBA
        defines LID 0 as reserved and valid Local Identifier (LID)
        values from 1 to 65535.  LID 65535 is defined as a permissive
        DLID.

        This value is stored in IBA defined bit order, that is, the
        high-order bit of the Local Identifier byte 0 is positioned as
        the high-order bit of the first byte of the integer
        representation."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1]
         Section 4.1.3."
    SYNTAX  Unsigned32 (0..65535)








Harnedy                    Expires August 2004                  [Page 6]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


IbUnicastLid ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "d"
    STATUS      current
    DESCRIPTION
       "Identifies a Unicast LID.  Value is stored in IBA defined bit
        order, that is, the high-order bit of the Local Identifier
        byte 0 is positioned as the high-order bit of the first byte
        of the integer representation."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1]
         Section 4.1.3."
    SYNTAX  Unsigned32 (0..49151)

IbMulticastLid ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "d"
    STATUS      current
    DESCRIPTION
       "Identifies a Multicast LID.  Value is stored in IBA defined
        bit order, that is, the high-order bit of the Local
        Identifier byte 0 is positioned as the high-order bit of the
        first byte of the integer representation."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1]
         Section 4.1.3."
    SYNTAX  Unsigned32 (49152..65535)

IbGuid ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "1x:"
    STATUS      current
    DESCRIPTION
       "Globally Unique Identifier (GUID) is a number that uniquely
        identifies an IB device or component.  It is a compliant
        IEEE-defined 64-bit extended unique identifier (EUI-64)
        for Host Channel Adapters (HCA), Terminal Channel Adpaters
        (TCA), routers, and switches.  This 64-bit value is created
        by concatenating a 24-bit company ID value and a 40-bit
        extension.  The IEEE Registration Authority assigns the
        company ID. The extension ID is assigned by the particular
        company.  Therefore, each HCA, TCA, switch, and router shall
        be assigned an EUI-64 GUID by the manufacturer."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1]
         Section 4.1."
    SYNTAX  OCTET STRING (SIZE(8))










Harnedy                    Expires August 2004                  [Page 7]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


IbSmPortList ::= TEXTUAL-CONVENTION
    STATUS       current
    DESCRIPTION
       "Each bit mapping within this value specifies a port presence
        within the managed IB device.  This definition includes bit0
        as IB Port 0, the logical port used exclusively for management
        packets. Valid data port mappings are from bit1 to bit254.
        Bit255 is invalid and MUST always be zero."
    REFERENCE
        "InfiniBand Architecture Release 1.1 Vol. 1. [INFINIV1] Section
         18.2.4.1 (C18-10.a1) for switches, Section 17.2.1.3 (C17-7.a1)
         for Channel Adapters, and Section 19.2.4.2 for routers."
    SYNTAX  OCTET STRING (SIZE(32))

IbIpoibClientIdentifier ::= TEXTUAL-CONVENTION
    STATUS       current
    DESCRIPTION
       "The IPOIB Client Identifier uniquely identifies an IPOIB link
        layer address associated with the InfiniBand port.  It comprises
        three fields.
           1. Global Identifier (GID)
           2. Queue Pair Number field (QPN)
           3. reserved

       0                   1                   2                   3
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |1:GID(0-7)     |2:GID(8-15)    |3:GID(16-23)   |4:GID(24-31)   |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |5:GID(32-39)   |6:GID(40-47)   |7:GID(48-55)   |8:GID(56-63)   |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |9:GID(64-71)   |10:GID(72-79)  |11:GID(80-87)  |12:GID(88-95)  |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |13:GID(96-103) |14:GID(104-111)|15:GID(112-119)|16:GID(120-127)|
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |17:QPN(0-7)    |18:QPN(8-15)   |19:QPN(16-23)  |20:(reserved)  |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

        The Global Identifier field is a 16 octet field (octets 1
        through 16) that is formed by the combination of the IB subnet
        prefix and the port's GUID.  It is unique in the InfiniBand
        fabric.  NOTE: An IPOIB interface may have more than 1 GID
        associated with it.

        The Queue Pair Number field is a 3 octet field (octets 17, 18, &
        19) that identifies the destination queue pair.  Note: The
        reserved field and the QPN field are collectively referred to as
        the interface-id.  If an IPOIB interface has only 1 GID
        associated with it, the interface-id MAY contain all zeroes.

        The reserved field is octet 20.  It is reserved for future use.
        These bits SHOULD be set to zero."
    SYNTAX  OCTET STRING (SIZE(20))

Harnedy                    Expires August 2004                  [Page 8]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


IbSmSubnetPrefix ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "2x:"
    STATUS      current
    DESCRIPTION
       "The 64-bit value used to identify an InfiniBand subnet."
    SYNTAX  OCTET STRING (SIZE(8))

IbSmState ::= TEXTUAL-CONVENTION
    STATUS      current
    DESCRIPTION
       "Subnet Manager's state:
           notActive(0)    SM is not active
           discovering(1)  SM is discovering subnet
           standby(2)      SM is in standby role
           master(3)       SM is in master role."
    SYNTAX  INTEGER   {
               notActive(0),
               discovering(1),
               standby(2),
               master(3)
            }

IbNodeType ::= TEXTUAL-CONVENTION
    STATUS      current
    DESCRIPTION
       "Type of InfiniBand node."
    SYNTAX  INTEGER   {
               unknown(0),
               channelAdapter(1),
               switch(2),
               router(3)
            }

IbMtu ::= TEXTUAL-CONVENTION
    STATUS      current
    DESCRIPTION
       "The MTU size of this InfiniBand link."
    SYNTAX  INTEGER   {
               mtu256(1),
               mtu512(2),
               mtu1024(3),
               mtu2048(4),
               mtu4096(5)
            }

IbPartitionKey ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "x"
    STATUS      current
    DESCRIPTION
       "The 16-bit Partition Key."
    SYNTAX  Unsigned32 (0..65535)



Harnedy                    Expires August 2004                  [Page 9]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


IbTransportTime ::= TEXTUAL-CONVENTION
    STATUS      current
    DESCRIPTION
       "The time value used to calculate the InfiniBand network
        delay or response.  The duration of time is calculated
        by the following formula:
        delay/response = (4.096 microseconds * 2 ^ IbTransportTime)."
    SYNTAX  Unsigned32 (0..31)

END


4. Acknowledgments

   This MIB module was updated based on the original work done by Bill
   Anderson and Bill Strahm.


5. Security Considerations

   This memo defines textual conventions and object identities for use
   in IPOVERIB MIB modules. Security issues for these MIB modules are
   addressed in the memos defining those modules.  Because this memo
   does not define management objects, the memo has no impact on the
   security of the Internet.


6.  IANA Considerations

   IANA is requested to make a MIB OID assignment under the transmission
   branch, that is, assign the infinibandMIB under { transmission 199 }.
   This sub-id is requested because 199 is the ifType for
   infiniband(199) and is available under transmission.

   In the future, IPOIB related standards track MIB modules should be
   rooted under the infinibandMIB subtree.  The IANA is requested to
   manage that namespace.  New assignments can only be made via a
   Standards Action as specified in [RFC2434].

   This document also requests IANA to assign { infinibandMIB 1 } to the
   IB-TC-MIB specified in this document.


7. References


7.1. Normative References

   [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
             Requirement Levels", BCP 14, RFC 2119, March 1997.




Harnedy                    Expires August 2004                 [Page 10]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


   [RFC2434] Narten, T. and H. Alvestrand, "Guidelines for Writing an
             IANA Considerations Section in RFCs", BCP: 26, RFC 2434,
             October 1998.

   [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
             Rose, M. and S. Waldbusser, "Structure of Management
             Information Version 2 (SMIv2)", STD 58, RFC 2578, April
             1999.

   [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
             Rose, M. and S. Waldbusser, "Textual Conventions for
             SMIv2", STD 58, RFC 2579, April 1999.

   [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
             Rose, M. and S. Waldbusser, "Conformance Statements for
             SMIv2", STD 58, RFC 2580, April 1999.

   [INFINIV1] InfiniBand Architecture Specification Volume 1,
              Release 1.1, November 6, 2002.


7.2. Informative References

   [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart,
             "Introduction and Applicability Statements for Internet-
             Standard Management Framework", RFC 3410, December 2002.


8. Author's Address

   Sean Harnedy
   Mangrove Systems, Inc.
   10 Fairfield Boulevard
   Wallingford, CT 06492
   USA
   Phone: +1-203-679-7539
   Email: sharnedy@mangrovesystems.com


9.  Intellectual Property Notice

   The IETF takes no position regarding the validity or scope of any
   intellectual property or other rights that might be claimed to
   pertain to the implementation or use of the technology described in
   this document or the extent to which any license under such rights
   might or might not be available;  neither does it represent that it
   has made any effort to identify any such rights.  Information on the
   IETF's procedures with respect to rights in standards-track and
   standards-related documentation can be found in BCP-11.  Copies of
   claims of rights made available for publication and any assurances of
   licenses to be made available, or the result of an attempt made to
   obtain a general license or permission for the use of such
   proprietary rights by implementers or users of this specification can

Harnedy                    Expires August 2004                 [Page 11]


Internet-Draft           IPOVERIB TC MIB Module            February 2004


   be obtained from the IETF Secretariat.

   The IETF invites any interested party to bring to its attention any
   copyrights, patents or patent applications, or other proprietary
   rights which may cover technology that may be required to practice
   this standard.  Please address the information to the IETF Executive
   Director.


10. Full Copyright Statement

   Copyright (C) The Internet Society (2004).  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 implementation 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.
















Harnedy                  Expires August 2004                   [Page 12]