contrib/ngatm/snmp_atm/BEGEMOT-ATM.txt

   1 --
   2 -- Copyright (c) 2001-2002
   3 --      Fraunhofer Institute for Open Communication Systems (FhG Fokus).
   4 --      All rights reserved.
   5 -- Copyright (c) 2004
   6 --      Hartmut Brandt.
   7 --      All rights reserved.
   8 --
   9 -- Author: Hartmut Brandt <harti@freebsd.org>
  10 --
  11 -- Redistribution and use in source and binary forms, with or without
  12 -- modification, are permitted provided that the following conditions
  13 -- are met:
  14 -- 1. Redistributions of source code must retain the above copyright
  15 --    notice, this list of conditions and the following disclaimer.
  16 -- 2. Redistributions in binary form must reproduce the above copyright
  17 --    notice, this list of conditions and the following disclaimer in the
  18 --    documentation and/or other materials provided with the distribution.
  19 --
  20 -- THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21 -- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 -- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 -- ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  24 -- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 -- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 -- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 -- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 -- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 -- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 -- SUCH DAMAGE.
  31 --
  32 -- $Begemot: libunimsg/snmp_atm/BEGEMOT-ATM.txt,v 1.2 2004/08/06 14:50:26 brandt Exp $
  33 --
  34 -- Private Begemot MIB for ATM interfaces.
  35 --
  36 BEGEMOT-ATM-MIB DEFINITIONS ::= BEGIN
  37
  38 IMPORTS
  39     MODULE-IDENTITY, OBJECT-TYPE, Unsigned32, TimeTicks
  40         FROM SNMPv2-SMI
  41     TEXTUAL-CONVENTION, DisplayString
  42         FROM SNMPv2-TC
  43     ifIndex
  44         FROM IF-MIB
  45     begemot
  46         FROM BEGEMOT-MIB;
  47
  48 begemotAtm MODULE-IDENTITY
  49     LAST-UPDATED "200407190000Z"
  50     ORGANIZATION "German Aerospace Centre"
  51     CONTACT-INFO
  52             "           Hartmut Brandt
  53
  54              Postal:    German Aerospace Centre (DLR)
  55                         Institute of Communications and Navigation
  56                         82234 Wessling
  57                         Germany
  58
  59              Fax:       +49 8153 28 2844
  60
  61              E-mail:    harti@freebsd.org"
  62     DESCRIPTION
  63             "The Begemot MIB for ATM interfaces."
  64
  65     ::= { begemot 101 }
  66
  67 begemotAtmObjects       OBJECT IDENTIFIER ::= { begemotAtm 1 }
  68
  69 -- --------------------------------------------------------------------------
  70
  71 AtmESI ::= TEXTUAL-CONVENTION
  72     DISPLAY-HINT "1x:"
  73     STATUS      current
  74     DESCRIPTION
  75             "An ATM End System Identifier. This is basically the same as
  76             an Ethernet Address and is assigned using the same rules."
  77     SYNTAX      OCTET STRING (SIZE(6))
  78
  79 -- --------------------------------------------------------------------------
  80
  81 --
  82 -- Interfaces table
  83 --
  84 begemotAtmIfTable OBJECT-TYPE
  85     SYNTAX      SEQUENCE OF BegemotAtmIfEntry
  86     MAX-ACCESS  not-accessible
  87     STATUS      current
  88     DESCRIPTION
  89             "This table contains an entry for each hardware ATM
  90             interface. The table is indexed by the interface index."
  91     ::= { begemotAtmObjects 1 }
  92
  93 begemotAtmIfEntry OBJECT-TYPE
  94     SYNTAX      BegemotAtmIfEntry
  95     MAX-ACCESS  not-accessible
  96     STATUS      current
  97     DESCRIPTION
  98             "This is a table entry describing one ATM hardware interface."
  99     INDEX       { ifIndex }
 100     ::= { begemotAtmIfTable 1 }
 101
 102 BegemotAtmIfEntry ::= SEQUENCE {
 103     begemotAtmIfName            DisplayString,
 104     begemotAtmIfPcr             Unsigned32,
 105     begemotAtmIfMedia           INTEGER,
 106     begemotAtmIfVpiBits         Unsigned32,
 107     begemotAtmIfVciBits         Unsigned32,
 108     begemotAtmIfMaxVpcs         Unsigned32,
 109     begemotAtmIfMaxVccs         Unsigned32,
 110     begemotAtmIfEsi             AtmESI,
 111     begemotAtmIfCarrierStatus   INTEGER,
 112     begemotAtmIfMode            INTEGER
 113 }
 114
 115 begemotAtmIfName OBJECT-TYPE
 116     SYNTAX      DisplayString (SIZE(1..15))
 117     MAX-ACCESS  read-only
 118     STATUS      current
 119     DESCRIPTION
 120             "Name of the ATM interface."
 121     ::= { begemotAtmIfEntry 1 }
 122
 123 begemotAtmIfPcr OBJECT-TYPE
 124     SYNTAX      Unsigned32
 125     MAX-ACCESS  read-only
 126     STATUS      current
 127     DESCRIPTION
 128             "The line cell rate of the interface."
 129     ::= { begemotAtmIfEntry 2 }
 130
 131 begemotAtmIfMedia OBJECT-TYPE
 132     SYNTAX      INTEGER {
 133                         other(1),
 134                         unknown(3),
 135                         utp25(4),
 136                         taxi100(5),
 137                         taxi140(6),
 138                         mm155(7),
 139                         sm155(8),
 140                         utp155(9),
 141                         mm622(10),
 142                         sm622(11),
 143                         virtual(12)
 144                 }
 145     MAX-ACCESS  read-only
 146     STATUS      current
 147     DESCRIPTION
 148             "The physical medium."
 149     ::= { begemotAtmIfEntry 3 }
 150
 151 begemotAtmIfVpiBits OBJECT-TYPE
 152     SYNTAX      Unsigned32 (0..12)
 153     MAX-ACCESS  read-only
 154     STATUS      current
 155     DESCRIPTION
 156             "Number of VPI bits that are used by the device."
 157     ::= { begemotAtmIfEntry 4 }
 158
 159 begemotAtmIfVciBits OBJECT-TYPE
 160     SYNTAX      Unsigned32 (0..16)
 161     MAX-ACCESS  read-only
 162     STATUS      current
 163     DESCRIPTION
 164             "Number of VCI bits that are used by the device."
 165     ::= { begemotAtmIfEntry 5 }
 166
 167 begemotAtmIfMaxVpcs OBJECT-TYPE
 168     SYNTAX      Unsigned32 (0..256)
 169     MAX-ACCESS  read-only
 170     STATUS      current
 171     DESCRIPTION
 172             "The maximum number of VPC supported on this device. This may not
 173             be larger than 2^begemotAtmIfVpiBits."
 174     ::= { begemotAtmIfEntry 6 }
 175
 176 begemotAtmIfMaxVccs OBJECT-TYPE
 177     SYNTAX      Unsigned32 (0..16777216)
 178     MAX-ACCESS  read-only
 179     STATUS      current
 180     DESCRIPTION
 181             "The maximum number of VCC supported on this device. This may not
 182             be larger than 2^(begemotAtmIfVpiBits + begemotAtmVciBits)."
 183     ::= { begemotAtmIfEntry 7 }
 184
 185 begemotAtmIfEsi OBJECT-TYPE
 186     SYNTAX      AtmESI
 187     MAX-ACCESS  read-only
 188     STATUS      current
 189     DESCRIPTION
 190             "The default End System Identifier as reported by the hardware.
 191             If the hardware has no ESI all six bytes are reported as 0."
 192     ::= { begemotAtmIfEntry 8 }
 193
 194 begemotAtmIfCarrierStatus OBJECT-TYPE
 195     SYNTAX      INTEGER { carrierOn(1), carrierOff(2), unknown(3), none(4) }
 196     MAX-ACCESS  read-only
 197     STATUS      current
 198     DESCRIPTION
 199             "The state of the carrier. For interfaces which don't have the
 200             notion of a carriere none is reported."
 201     ::= { begemotAtmIfEntry 9 }
 202
 203 begemotAtmIfMode OBJECT-TYPE
 204     SYNTAX      INTEGER { sonet(1), sdh(2), unknown(3) }
 205     MAX-ACCESS  read-write
 206     STATUS      current
 207     DESCRIPTION
 208             "The mode of the SUNI interface. For interfaces without SUNI
 209             unknown is reported in which case the variable is read-only.
 210             Some types of interfaces may not be able to change this value."
 211     ::= { begemotAtmIfEntry 10 }
 212
 213 begemotAtmIfTableLastChange OBJECT-TYPE
 214     SYNTAX      TimeTicks
 215     MAX-ACCESS  read-only
 216     STATUS      current
 217     DESCRIPTION
 218             "The value of sysUpTime the last time that an entry in
 219             begemotIfTable was created or destroyed. If the table is
 220             unchanged since the last coldStart this value is zero."
 221     ::= { begemotAtmObjects 2 }
 222
 223 --
 224 -- Interface hardware table
 225 --
 226 begemotAtmHWTable OBJECT-TYPE
 227     SYNTAX      SEQUENCE OF BegemotAtmHWEntry
 228     MAX-ACCESS  not-accessible
 229     STATUS      current
 230     DESCRIPTION
 231             "This table augments the begemotAtmIfTable and contains an entry
 232             for each hardware ATM interface. The entries describe the
 233             ATM hardware interface."
 234     ::= { begemotAtmObjects 3 }
 235
 236 begemotAtmHWEntry OBJECT-TYPE
 237     SYNTAX      BegemotAtmHWEntry
 238     MAX-ACCESS  not-accessible
 239     STATUS      current
 240     DESCRIPTION
 241             "This is a table entry describing one ATM hardware interface."
 242     AUGMENTS    { begemotAtmIfEntry }
 243     ::= { begemotAtmHWTable 1 }
 244
 245 BegemotAtmHWEntry ::= SEQUENCE {
 246     begemotAtmHWVendor          DisplayString,
 247     begemotAtmHWDevice          DisplayString,
 248     begemotAtmHWSerial          Unsigned32,
 249     begemotAtmHWVersion         Unsigned32,
 250     begemotAtmHWSoftVersion     Unsigned32
 251 }
 252
 253 begemotAtmHWVendor OBJECT-TYPE
 254     SYNTAX      DisplayString
 255     MAX-ACCESS  read-only
 256     STATUS      current
 257     DESCRIPTION
 258             "A short string naming the vendor of the interface card."
 259     ::= { begemotAtmHWEntry 1 }
 260
 261 begemotAtmHWDevice OBJECT-TYPE
 262     SYNTAX      DisplayString
 263     MAX-ACCESS  read-only
 264     STATUS      current
 265     DESCRIPTION
 266             "A short string naming the brand of the interface card."
 267     ::= { begemotAtmHWEntry 2 }
 268
 269 begemotAtmHWSerial OBJECT-TYPE
 270     SYNTAX      Unsigned32
 271     MAX-ACCESS  read-only
 272     STATUS      current
 273     DESCRIPTION
 274             "The serial number of the interface card or 0 if it doesn't
 275             report a serial number."
 276     ::= { begemotAtmHWEntry 3 }
 277
 278 begemotAtmHWVersion OBJECT-TYPE
 279     SYNTAX      Unsigned32
 280     MAX-ACCESS  read-only
 281     STATUS      current
 282     DESCRIPTION
 283             "The hardware version of the interface card or 0 if it doesn't
 284             report a hardware version number."
 285     ::= { begemotAtmHWEntry 4 }
 286
 287 begemotAtmHWSoftVersion OBJECT-TYPE
 288     SYNTAX      Unsigned32
 289     MAX-ACCESS  read-only
 290     STATUS      current
 291     DESCRIPTION
 292             "The firmware version of the interface card or 0 if it doesn't
 293             report a firmware version number."
 294     ::= { begemotAtmHWEntry 5 }
 295
 296 -- --------------------------------------------------------------------
 297
 298 -- System specific parts
 299 begemotAtmSysGroup      OBJECT IDENTIFIER ::= { begemotAtmObjects 4 }
 300
 301 END