mibs/ietf/IF-CAP-STACK-MIB

   1 IF-CAP-STACK-MIB DEFINITIONS ::= BEGIN
   2
   3   IMPORTS
   4     MODULE-IDENTITY, OBJECT-TYPE, mib-2
   5       FROM SNMPv2-SMI         -- [RFC2578]
   6     TruthValue
   7       FROM SNMPv2-TC          -- [RFC2579]
   8     MODULE-COMPLIANCE, OBJECT-GROUP
   9       FROM SNMPv2-CONF        -- [RFC2580]
  10     ifStackGroup2, ifStackHigherLayer, ifStackLowerLayer
  11       FROM IF-MIB             -- [RFC2863]
  12     ifInvStackGroup
  13       FROM IF-INVERTED-STACK-MIB -- [RFC2864]
  14     ;
  15
  16   ifCapStackMIB MODULE-IDENTITY
  17     LAST-UPDATED "200711070000Z"  -- November 07, 2007
  18     ORGANIZATION "IETF Ethernet Interfaces and Hub MIB Working Group"
  19     CONTACT-INFO
  20       "WG charter:
  21         http://www.ietf.org/html.charters/OLD/hubmib-charter.html
  22
  23       Mailing Lists:
  24         General Discussion: hubmib@ietf.org
  25
  26
  27
  28         To Subscribe: hubmib-request@ietf.org
  29         In Body: subscribe your_email_address
  30
  31       Chair:  Bert Wijnen
  32       Postal: Alcatel-Lucent
  33               Schagen 33
  34               3461 GL Linschoten
  35               Netherlands
  36        Phone: +31-348-407-775
  37        EMail: bwijnen@alcatel-lucent.com
  38
  39       Editor: Edward Beili
  40       Postal: Actelis Networks Inc.
  41               25 Bazel St., P.O.B. 10173
  42               Petach-Tikva 10173
  43               Israel
  44        Phone: +972-3-924-3491
  45        EMail: edward.beili@actelis.com"
  46
  47     DESCRIPTION
  48       "The objects in this MIB module are used to describe
  49       cross-connect capabilities of stacked (layered) interfaces,
  50       complementing ifStackTable and ifInvStackTable defined in
  51       IF-MIB and IF-INVERTED-STACK-MIB, respectively.
  52
  53       Copyright (C) The IETF Trust (2007).  This version
  54       of this MIB module is part of RFC 5066;  see the RFC
  55       itself for full legal notices."
  56
  57     REVISION    "200711070000Z"  -- November 07, 2007
  58     DESCRIPTION "Initial version, published as RFC 5066."
  59
  60     ::= { mib-2 166 }
  61
  62    -- Sections of the module
  63    -- Structured as recommended by [RFC4181], see
  64    -- Appendix D: Suggested OID Layout
  65
  66    ifCapStackObjects     OBJECT IDENTIFIER ::= { ifCapStackMIB 1 }
  67
  68    ifCapStackConformance OBJECT IDENTIFIER ::= { ifCapStackMIB 2 }
  69
  70    -- Groups in the module
  71
  72    --
  73    -- ifCapStackTable group
  74    --
  75
  76
  77
  78
  79    ifCapStackTable  OBJECT-TYPE
  80      SYNTAX      SEQUENCE OF IfCapStackEntry
  81      MAX-ACCESS  not-accessible
  82      STATUS      current
  83      DESCRIPTION
  84        "This table, modeled after ifStackTable from IF-MIB,
  85        contains information on the possible 'on-top-of'
  86        relationships between the multiple sub-layers of network
  87        interfaces (as opposed to actual relationships described in
  88        ifStackTable).  In particular, it contains information on
  89        which sub-layers MAY possibly run 'on top of' which other
  90        sub-layers, as determined by cross-connect capability of the
  91        device, where each sub-layer corresponds to a conceptual row
  92        in the ifTable.  For example, when the sub-layer with ifIndex
  93        value x can be connected to run on top of the sub-layer with
  94        ifIndex value y, then this table contains:
  95
  96          ifCapStackStatus.x.y=true
  97
  98        The ifCapStackStatus.x.y row does not exist if it is
  99        impossible to connect between the sub-layers x and y.
 100
 101        Note that for most stacked interfaces (e.g., 2BASE-TL)
 102        there's always at least one higher-level interface (e.g., PCS
 103        port) for each lower-level interface (e.g., PME) and at
 104        least one lower-level interface for each higher-level
 105        interface, that is, there is at least a single row with a
 106        'true' status for any such existing value of x or y.
 107
 108        This table is read-only as it describes device capabilities."
 109      REFERENCE
 110        "IF-MIB, ifStackTable"
 111      ::= { ifCapStackObjects 1 }
 112
 113    ifCapStackEntry  OBJECT-TYPE
 114      SYNTAX      IfCapStackEntry
 115      MAX-ACCESS  not-accessible
 116      STATUS      current
 117      DESCRIPTION
 118        "Information on a particular relationship between two
 119        sub-layers, specifying that one sub-layer MAY possibly run
 120        on 'top' of the other sub-layer.  Each sub-layer corresponds
 121        to a conceptual row in the ifTable (interface index for
 122        lower and higher layer, respectively)."
 123      INDEX {
 124        ifStackHigherLayer,
 125        ifStackLowerLayer
 126      }
 127
 128
 129
 130      ::= { ifCapStackTable 1 }
 131
 132    IfCapStackEntry ::= SEQUENCE {
 133         ifCapStackStatus       TruthValue
 134       }
 135
 136    ifCapStackStatus  OBJECT-TYPE
 137      SYNTAX      TruthValue
 138      MAX-ACCESS  read-only
 139      STATUS      current
 140      DESCRIPTION
 141        "The status of the 'cross-connect capability' relationship
 142        between two sub-layers.  The following values can be returned:
 143          true(1)         - indicates that the sub-layer interface,
 144                            identified by the ifStackLowerLayer MAY
 145                            be connected to run 'below' the sub-layer
 146                            interface, identified by the
 147                            ifStackHigherLayer index.
 148          false(2)        - the sub-layer interfaces cannot be
 149                            connected temporarily due to
 150                            unavailability of the interface(s), e.g.,
 151                            one of the interfaces is located on an
 152                            absent pluggable module.
 153
 154        Note that lower-layer interface availability per higher-layer,
 155        indicated by the value of 'true', can be constrained by
 156        other parameters, for example, by the aggregation capacity of
 157        a higher-layer interface or by the lower-layer interface in
 158        question being already connected to another higher-layer
 159        interface.  In order to ensure that a particular sub-layer can
 160        be connected to another sub-layer, all respective objects
 161        (e.g., ifCapStackTable, ifStackTable, and efmCuPAFCapacity for
 162        EFMCu interfaces) SHALL be inspected.
 163
 164        This object is read-only, unlike ifStackStatus, as it
 165        describes a cross-connect capability."
 166      ::= { ifCapStackEntry 1 }
 167
 168    ifInvCapStackTable  OBJECT-TYPE
 169      SYNTAX        SEQUENCE OF IfInvCapStackEntry
 170      MAX-ACCESS    not-accessible
 171      STATUS        current
 172      DESCRIPTION
 173        "A table containing information on the possible relationships
 174        between the multiple sub-layers of network interfaces.  This
 175        table, modeled after ifInvStackTable from
 176        IF-INVERTED-STACK-MIB, is an inverse of the ifCapStackTable
 177        defined in this MIB module.
 178
 179
 180
 181        In particular, this table contains information on which
 182        sub-layers MAY run 'underneath' which other sub-layers, where
 183        each sub-layer corresponds to a conceptual row in the ifTable.
 184        For example, when the sub-layer with ifIndex value x MAY be
 185        connected to run underneath the sub-layer with ifIndex value
 186        y, then this table contains:
 187
 188           ifInvCapStackStatus.x.y=true
 189
 190        This table contains exactly the same number of rows as the
 191        ifCapStackTable, but the rows appear in a different order.
 192
 193        This table is read-only as it describes a cross-connect
 194        capability."
 195      REFERENCE
 196         "IF-INVERTED-STACK-MIB, ifInvStackTable"
 197      ::= { ifCapStackObjects 2 }
 198
 199    ifInvCapStackEntry  OBJECT-TYPE
 200      SYNTAX        IfInvCapStackEntry
 201      MAX-ACCESS    not-accessible
 202      STATUS        current
 203      DESCRIPTION
 204         "Information on a particular relationship between two sub-
 205         layers, specifying that one sub-layer MAY run underneath the
 206         other sub-layer.  Each sub-layer corresponds to a conceptual
 207         row in the ifTable."
 208      INDEX { ifStackLowerLayer, ifStackHigherLayer }
 209      ::= { ifInvCapStackTable 1 }
 210
 211     IfInvCapStackEntry ::= SEQUENCE {
 212       ifInvCapStackStatus       TruthValue
 213     }
 214
 215    ifInvCapStackStatus  OBJECT-TYPE
 216      SYNTAX         TruthValue
 217      MAX-ACCESS     read-only
 218      STATUS         current
 219      DESCRIPTION
 220         "The status of the possible 'cross-connect capability'
 221         relationship between two sub-layers.
 222
 223         An instance of this object exists for each instance of the
 224         ifCapStackStatus object, and vice versa.  For example, if the
 225         variable ifCapStackStatus.H.L exists, then the variable
 226         ifInvCapStackStatus.L.H must also exist, and vice versa.  In
 227         addition, the two variables always have the same value.
 228
 229
 230
 231
 232         The ifInvCapStackStatus object is read-only, as it describes
 233         a cross-connect capability."
 234      REFERENCE
 235         "ifCapStackStatus"
 236      ::= { ifInvCapStackEntry 1 }
 237
 238   --
 239   -- Conformance Statements
 240   --
 241
 242    ifCapStackGroups      OBJECT IDENTIFIER ::=
 243         { ifCapStackConformance 1 }
 244
 245    ifCapStackCompliances OBJECT IDENTIFIER ::=
 246         { ifCapStackConformance 2 }
 247
 248    -- Units of Conformance
 249
 250    ifCapStackGroup OBJECT-GROUP
 251      OBJECTS {
 252        ifCapStackStatus,
 253        ifInvCapStackStatus
 254      }
 255      STATUS  current
 256      DESCRIPTION
 257        "A collection of objects providing information on the
 258        cross-connect capability of multi-layer (stacked) network
 259        interfaces."
 260      ::= { ifCapStackGroups 1 }
 261
 262
 263   -- Compliance Statements
 264
 265    ifCapStackCompliance MODULE-COMPLIANCE
 266      STATUS      current
 267      DESCRIPTION
 268        "The compliance statement for SNMP entities, which provide
 269        information on the cross-connect capability of multi-layer
 270        (stacked) network interfaces, with flexible cross-connect
 271        between the sub-layers."
 272
 273
 274      MODULE  -- this module
 275        MANDATORY-GROUPS {
 276          ifCapStackGroup
 277        }
 278
 279        OBJECT       ifCapStackStatus
 280
 281
 282
 283        SYNTAX       TruthValue { true(1) }
 284        DESCRIPTION
 285          "Support for the false(2) value is OPTIONAL for
 286          implementations supporting pluggable interfaces."
 287
 288        OBJECT       ifInvCapStackStatus
 289        SYNTAX       TruthValue { true(1) }
 290        DESCRIPTION
 291          "Support for the false(2) value is OPTIONAL for
 292          implementations supporting pluggable interfaces."
 293
 294      MODULE  IF-MIB
 295        MANDATORY-GROUPS {
 296          ifStackGroup2
 297        }
 298
 299      MODULE  IF-INVERTED-STACK-MIB
 300        MANDATORY-GROUPS {
 301          ifInvStackGroup
 302        }
 303
 304      ::= { ifCapStackCompliances 1 }
 305 END