mibs/ietf/POWER-ETHERNET-MIB

   1 POWER-ETHERNET-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4            MODULE-IDENTITY, mib-2, OBJECT-TYPE, Integer32,
   5            Gauge32, Counter32, NOTIFICATION-TYPE
   6                    FROM SNMPv2-SMI
   7            TruthValue
   8                    FROM SNMPv2-TC
   9            MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
  10                    FROM SNMPv2-CONF
  11
  12             SnmpAdminString
  13                     FROM SNMP-FRAMEWORK-MIB;
  14
  15     powerEthernetMIB MODULE-IDENTITY
  16
  17          LAST-UPDATED    "200311240000Z"  -- November 24, 2003
  18          ORGANIZATION "IETF Ethernet Interfaces and Hub MIB
  19                        Working Group"
  20
  21
  22
  23
  24
  25
  26          CONTACT-INFO
  27          "
  28           WG Charter:
  29           http://www.ietf.org/html.charters/hubmib-charter.html
  30
  31          Mailing lists:
  32           General Discussion: hubmib@ietf.org
  33           To Subscribe: hubmib-requests@ietf.org
  34           In Body: subscribe your_email_address
  35
  36          Chair: Dan Romascanu
  37           Avaya
  38           Tel:  +972-3-645-8414
  39           Email: dromasca@avaya.com
  40
  41          Editor: Avi Berger
  42           PowerDsine Inc.
  43           Tel:    972-9-7755100 Ext 307
  44           Fax:    972-9-7755120
  45           E-mail: avib@PowerDsine.com
  46          "
  47
  48         DESCRIPTION
  49               "The MIB module for managing Power Source Equipment
  50                (PSE) working according to the IEEE 802.af Powered
  51                Ethernet (DTE Power via MDI) standard.
  52
  53                 The following terms are used throughout this
  54                 MIB module.  For complete formal definitions,
  55                 the IEEE 802.3 standards should be consulted
  56                 wherever possible:
  57
  58                 Group - A recommended, but optional, entity
  59                 defined by the IEEE 802.3 management standard,
  60                 in order to support a modular numbering scheme.
  61                 The classical example allows an implementor to
  62                 represent field-replaceable units as groups of
  63                 ports, with the port numbering matching the
  64                 modular hardware implementation.
  65
  66               Port - This entity identifies the port within the group
  67               for which this entry contains information.  The numbering
  68               scheme for ports is implementation specific.
  69
  70              Copyright (c) The Internet Society (2003).  This version
  71              of this MIB module is part of RFC 3621; See the RFC
  72              itself for full legal notices."
  73
  74
  75
  76
  77        REVISION    "200311240000Z"  -- November 24, 2003
  78        DESCRIPTION "Initial version, published as RFC 3621."
  79        ::= { mib-2 105 }
  80
  81 pethNotifications OBJECT IDENTIFIER ::= { powerEthernetMIB 0 }
  82 pethObjects       OBJECT IDENTIFIER ::= { powerEthernetMIB 1 }
  83 pethConformance   OBJECT IDENTIFIER ::= { powerEthernetMIB 2 }
  84
  85 -- PSE Objects
  86
  87   pethPsePortTable OBJECT-TYPE
  88        SYNTAX      SEQUENCE OF PethPsePortEntry
  89        MAX-ACCESS  not-accessible
  90        STATUS      current
  91        DESCRIPTION
  92            "A table of objects that display and control the power
  93             characteristics of power Ethernet ports on a Power Source
  94             Entity (PSE) device.  This group will be implemented in
  95             managed power Ethernet switches and mid-span devices.
  96             Values of all read-write objects in this table are
  97             persistent at restart/reboot."
  98        ::= { pethObjects 1 }
  99
 100    pethPsePortEntry OBJECT-TYPE
 101        SYNTAX      PethPsePortEntry
 102        MAX-ACCESS  not-accessible
 103        STATUS      current
 104        DESCRIPTION
 105                "A set of objects that display and control the power
 106                characteristics of a power Ethernet PSE port."
 107        INDEX    { pethPsePortGroupIndex , pethPsePortIndex  }
 108        ::= { pethPsePortTable 1 }
 109
 110    PethPsePortEntry ::= SEQUENCE {
 111        pethPsePortGroupIndex
 112           Integer32,
 113        pethPsePortIndex
 114           Integer32,
 115        pethPsePortAdminEnable
 116           TruthValue,
 117        pethPsePortPowerPairsControlAbility
 118           TruthValue,
 119        pethPsePortPowerPairs
 120           INTEGER,
 121        pethPsePortDetectionStatus
 122           INTEGER,
 123        pethPsePortPowerPriority
 124           INTEGER,
 125
 126
 127
 128        pethPsePortMPSAbsentCounter
 129           Counter32,
 130        pethPsePortType
 131           SnmpAdminString,
 132        pethPsePortPowerClassifications
 133           INTEGER,
 134        pethPsePortInvalidSignatureCounter
 135           Counter32,
 136        pethPsePortPowerDeniedCounter
 137           Counter32,
 138        pethPsePortOverLoadCounter
 139           Counter32,
 140        pethPsePortShortCounter
 141           Counter32
 142   }
 143
 144      pethPsePortGroupIndex OBJECT-TYPE
 145        SYNTAX      Integer32 (1..2147483647)
 146        MAX-ACCESS  not-accessible
 147        STATUS      current
 148        DESCRIPTION
 149            "This variable uniquely identifies the group
 150             containing the port to which a power Ethernet PSE is
 151             connected.  Group means box in the stack, module in a
 152             rack and the value 1 MUST be used for non-modular devices.
 153             Furthermore, the same value MUST be used in this variable,
 154             pethMainPseGroupIndex, and pethNotificationControlGroupIndex
 155             to refer to a given box in a stack or module in the rack."
 156        ::= { pethPsePortEntry 1 }
 157
 158      pethPsePortIndex OBJECT-TYPE
 159        SYNTAX      Integer32 (1..2147483647)
 160        MAX-ACCESS  not-accessible
 161        STATUS      current
 162        DESCRIPTION
 163            "This variable uniquely identifies the power Ethernet PSE
 164             port within group pethPsePortGroupIndex to which the
 165             power Ethernet PSE entry is connected."
 166        ::= { pethPsePortEntry 2 }
 167
 168      pethPsePortAdminEnable OBJECT-TYPE
 169     SYNTAX TruthValue
 170     MAX-ACCESS read-write
 171     STATUS current
 172     DESCRIPTION
 173         "true (1) An interface which can provide the PSE functions.
 174          false(2) The interface will act as it would if it had no PSE
 175          function."
 176
 177
 178
 179     REFERENCE
 180       "IEEE Std 802.3af Section 30.9.1.1.2 aPSEAdminState"
 181     ::= { pethPsePortEntry 3 }
 182
 183      pethPsePortPowerPairsControlAbility OBJECT-TYPE
 184     SYNTAX TruthValue
 185     MAX-ACCESS read-only
 186     STATUS current
 187     DESCRIPTION
 188         "Describes the capability of controlling the power pairs
 189          functionality to switch pins for sourcing power.
 190          The value true indicate that the device has the capability
 191          to control the power pairs.  When false the PSE Pinout
 192          Alternative used cannot be controlled through the
 193          PethPsePortAdminEnable attribute."
 194     REFERENCE
 195       "IEEE Std 802.3af Section 30.9.1.1.3
 196        aPSEPowerPairsControlAbility"
 197     ::= { pethPsePortEntry 4 }
 198
 199     pethPsePortPowerPairs OBJECT-TYPE
 200     SYNTAX INTEGER   {
 201                signal(1),
 202                spare(2)
 203      }
 204     MAX-ACCESS read-write
 205     STATUS current
 206     DESCRIPTION
 207         "Describes or controls the pairs in use.  If the value of
 208          pethPsePortPowerPairsControl is true, this object is
 209          writable.
 210          A value of signal(1) means that the signal pairs
 211          only are in use.
 212          A value of spare(2) means that the spare pairs
 213          only are in use."
 214     REFERENCE
 215       "IEEE Std 802.3af Section 30.9.1.1.4 aPSEPowerPairs"
 216     ::= { pethPsePortEntry 5 }
 217
 218      pethPsePortDetectionStatus OBJECT-TYPE
 219     SYNTAX INTEGER   {
 220              disabled(1),
 221              searching(2),
 222                deliveringPower(3),
 223                fault(4),
 224                test(5),
 225                otherFault(6)
 226      }
 227
 228
 229
 230     MAX-ACCESS read-only
 231     STATUS current
 232     DESCRIPTION
 233         "Describes the operational status of the port PD detection.
 234          A value of disabled(1)- indicates that the PSE State diagram
 235          is in the state DISABLED.
 236          A value of deliveringPower(3) - indicates that the PSE State
 237          diagram is in the state POWER_ON for a duration greater than
 238          tlim max (see IEEE Std 802.3af Table 33-5 tlim).
 239          A value of fault(4) - indicates that the PSE State diagram is
 240          in the state TEST_ERROR.
 241          A value of test(5) - indicates that the PSE State diagram is
 242          in the state TEST_MODE.
 243          A value of otherFault(6) - indicates that the PSE State
 244          diagram is in the state IDLE due to the variable
 245          error_conditions.
 246          A value of searching(2)- indicates the PSE State diagram is
 247          in a state other than those listed above."
 248     REFERENCE
 249       "IEEE Std 802.3af Section 30.9.1.1.5
 250        aPSEPowerDetectionStatus"
 251     ::= { pethPsePortEntry 6 }
 252
 253      pethPsePortPowerPriority OBJECT-TYPE
 254     SYNTAX INTEGER   {
 255                critical(1),
 256                high(2),
 257                low(3)
 258      }
 259     MAX-ACCESS read-write
 260     STATUS current
 261     DESCRIPTION
 262         "This object controls the priority of the port from the point
 263          of view of a power management algorithm.  The priority that
 264          is set by this variable could be used by a control mechanism
 265          that prevents over current situations by disconnecting first
 266          ports with lower power priority.  Ports that connect devices
 267          critical to the operation of the network - like the E911
 268          telephones ports - should be set to higher priority."
 269     ::= { pethPsePortEntry 7 }
 270
 271    pethPsePortMPSAbsentCounter OBJECT-TYPE
 272     SYNTAX Counter32
 273     MAX-ACCESS read-only
 274     STATUS current
 275     DESCRIPTION
 276           "This counter is incremented when the PSE state diagram
 277              transitions directly from the state POWER_ON to the
 278
 279
 280
 281              state IDLE due to tmpdo_timer_done being asserted."
 282     REFERENCE
 283       "IEEE Std 802.3af Section 30.9.1.1.11
 284        aPSEMPSAbsentCounter"
 285     ::= { pethPsePortEntry 8 }
 286
 287    pethPsePortType OBJECT-TYPE
 288     SYNTAX SnmpAdminString
 289     MAX-ACCESS read-write
 290     STATUS current
 291     DESCRIPTION
 292         "A manager will set the value of this variable to indicate
 293          the type of powered device that is connected to the port.
 294          The default value supplied by the agent if no value has
 295          ever been set should be a zero-length octet string."
 296     ::= { pethPsePortEntry 9 }
 297
 298     pethPsePortPowerClassifications OBJECT-TYPE
 299      SYNTAX INTEGER   {
 300                class0(1),
 301                class1(2),
 302                class2(3),
 303                class3(4),
 304                class4(5)
 305      }
 306     MAX-ACCESS read-only
 307     STATUS current
 308     DESCRIPTION
 309         "Classification is a way to tag different terminals on the
 310         Power over LAN network according to their power consumption.
 311         Devices such as IP telephones, WLAN access points and others,
 312         will be classified according to their power requirements.
 313
 314         The meaning of the classification labels is defined in the
 315         IEEE specification.
 316
 317        This variable is valid only while a PD is being powered,
 318         that is, while the attribute pethPsePortDetectionStatus
 319         is reporting the enumeration deliveringPower."
 320     REFERENCE
 321       "IEEE Std 802.3af Section 30.9.1.1.6
 322        aPSEPowerClassification"
 323    ::= { pethPsePortEntry 10 }
 324
 325    pethPsePortInvalidSignatureCounter OBJECT-TYPE
 326     SYNTAX Counter32
 327     MAX-ACCESS read-only
 328     STATUS current
 329
 330
 331
 332     DESCRIPTION
 333        "This counter is incremented when the PSE state diagram
 334          enters the state SIGNATURE_INVALID."
 335     REFERENCE
 336           "IEEE Std 802.3af Section 30.9.1.1.7
 337            aPSEInvalidSignatureCounter"
 338     ::= { pethPsePortEntry 11 }
 339
 340    pethPsePortPowerDeniedCounter OBJECT-TYPE
 341     SYNTAX Counter32
 342     MAX-ACCESS read-only
 343     STATUS current
 344     DESCRIPTION
 345           "This counter is incremented when the PSE state diagram
 346              enters the state POWER_DENIED."
 347     REFERENCE
 348       "IEEE Std 802.3af Section 30.9.1.1.8
 349        aPSEPowerDeniedCounter"
 350     ::= { pethPsePortEntry 12 }
 351
 352    pethPsePortOverLoadCounter OBJECT-TYPE
 353     SYNTAX Counter32
 354     MAX-ACCESS read-only
 355     STATUS current
 356     DESCRIPTION
 357           "This counter is incremented when the PSE state diagram
 358              enters the state ERROR_DELAY_OVER."
 359     REFERENCE
 360       "IEEE Std 802.3af Section 30.9.1.1.9
 361        aPSEOverLoadCounter"
 362     ::= { pethPsePortEntry 13 }
 363
 364    pethPsePortShortCounter OBJECT-TYPE
 365     SYNTAX Counter32
 366     MAX-ACCESS read-only
 367     STATUS current
 368     DESCRIPTION
 369           "This counter is incremented when the PSE state diagram
 370              enters the state ERROR_DELAY_SHORT."
 371     REFERENCE
 372       "IEEE Std 802.3af Section 30.9.1.1.10
 373        aPSEShortCounter"
 374     ::= { pethPsePortEntry 14 }
 375
 376 -- Main PSE Objects
 377
 378 pethMainPseObjects       OBJECT IDENTIFIER ::= { pethObjects 3 }
 379
 380
 381
 382
 383 pethMainPseTable OBJECT-TYPE
 384        SYNTAX      SEQUENCE OF PethMainPseEntry
 385        MAX-ACCESS  not-accessible
 386        STATUS      current
 387        DESCRIPTION
 388            "A table of objects that display and control attributes
 389             of the main power source in a PSE  device.  Ethernet
 390             switches are one example of boxes that would support
 391             these objects.
 392             Values of all read-write objects in this table are
 393             persistent at restart/reboot."
 394        ::= { pethMainPseObjects 1 }
 395
 396    pethMainPseEntry OBJECT-TYPE
 397        SYNTAX      PethMainPseEntry
 398        MAX-ACCESS  not-accessible
 399        STATUS      current
 400        DESCRIPTION
 401             "A set of objects that display and control the Main
 402              power of a PSE. "
 403        INDEX    { pethMainPseGroupIndex }
 404        ::= { pethMainPseTable 1 }
 405
 406    PethMainPseEntry ::= SEQUENCE {
 407        pethMainPseGroupIndex
 408            Integer32,
 409        pethMainPsePower
 410            Gauge32 ,
 411        pethMainPseOperStatus
 412            INTEGER,
 413        pethMainPseConsumptionPower
 414            Gauge32,
 415        pethMainPseUsageThreshold
 416            Integer32
 417    }
 418      pethMainPseGroupIndex OBJECT-TYPE
 419        SYNTAX       Integer32 (1..2147483647)
 420        MAX-ACCESS  not-accessible
 421        STATUS      current
 422        DESCRIPTION
 423            "This variable uniquely identifies the group to which
 424            power Ethernet PSE is connected.  Group means (box in
 425            the stack, module in a rack) and the value 1 MUST be
 426            used for non-modular devices.  Furthermore, the same
 427            value MUST be used in this variable, pethPsePortGroupIndex,
 428            and pethNotificationControlGroupIndex to refer to a
 429            given box in a stack or module in a rack."
 430        ::= { pethMainPseEntry 1 }
 431
 432
 433
 434      pethMainPsePower OBJECT-TYPE
 435        SYNTAX      Gauge32  (1..65535)
 436        UNITS      "Watts"
 437        MAX-ACCESS  read-only
 438        STATUS      current
 439        DESCRIPTION
 440                "The nominal power of the PSE expressed in Watts."
 441        ::= { pethMainPseEntry 2 }
 442
 443      pethMainPseOperStatus OBJECT-TYPE
 444        SYNTAX INTEGER   {
 445                on(1),
 446                off(2),
 447                faulty(3)
 448           }
 449        MAX-ACCESS  read-only
 450        STATUS      current
 451        DESCRIPTION
 452                "The operational status of the main PSE."
 453        ::= { pethMainPseEntry 3 }
 454
 455      pethMainPseConsumptionPower OBJECT-TYPE
 456        SYNTAX      Gauge32
 457        UNITS      "Watts"
 458        MAX-ACCESS  read-only
 459        STATUS      current
 460        DESCRIPTION
 461                "Measured usage power expressed in Watts."
 462        ::= { pethMainPseEntry 4 }
 463
 464      pethMainPseUsageThreshold OBJECT-TYPE
 465        SYNTAX      Integer32  (1..99)
 466        UNITS      "%"
 467        MAX-ACCESS  read-write
 468        STATUS      current
 469        DESCRIPTION
 470                "The usage threshold expressed in percents for
 471                 comparing the measured power and initiating
 472                 an alarm if the threshold is exceeded."
 473        ::= { pethMainPseEntry 5 }
 474
 475 -- Notification  Control  Objects
 476
 477 pethNotificationControl        OBJECT IDENTIFIER ::= { pethObjects 4 }
 478
 479 pethNotificationControlTable OBJECT-TYPE
 480        SYNTAX      SEQUENCE OF PethNotificationControlEntry
 481        MAX-ACCESS  not-accessible
 482
 483
 484
 485        STATUS      current
 486        DESCRIPTION
 487            "A table of objects that display and control the
 488             Notification on a PSE  device.
 489             Values of all read-write objects in this table are
 490             persistent at restart/reboot."
 491        ::= { pethNotificationControl 1 }
 492
 493    pethNotificationControlEntry OBJECT-TYPE
 494        SYNTAX      PethNotificationControlEntry
 495        MAX-ACCESS  not-accessible
 496        STATUS      current
 497        DESCRIPTION
 498             "A set of objects that control the Notification events."
 499        INDEX    { pethNotificationControlGroupIndex }
 500        ::= { pethNotificationControlTable 1 }
 501
 502    PethNotificationControlEntry ::= SEQUENCE {
 503        pethNotificationControlGroupIndex
 504            Integer32,
 505        pethNotificationControlEnable
 506            TruthValue
 507    }
 508      pethNotificationControlGroupIndex OBJECT-TYPE
 509        SYNTAX      Integer32 (1..2147483647)
 510        MAX-ACCESS  not-accessible
 511        STATUS      current
 512        DESCRIPTION
 513            "This variable uniquely identifies the group.  Group
 514             means box in the stack, module in a rack and the value
 515             1 MUST be used for non-modular devices.  Furthermore,
 516             the same value MUST be used in this variable,
 517             pethPsePortGroupIndex, and
 518             pethMainPseGroupIndex to refer to a given box in a
 519             stack or module in a rack. "
 520        ::= { pethNotificationControlEntry 1 }
 521
 522       pethNotificationControlEnable  OBJECT-TYPE
 523        SYNTAX             TruthValue
 524        MAX-ACCESS         read-write
 525        STATUS             current
 526        DESCRIPTION
 527           "This object controls, on a per-group basis, whether
 528              or not notifications from the agent are enabled.  The
 529              value true(1) means that notifications are enabled; the
 530              value false(2) means that they are not."
 531        ::= { pethNotificationControlEntry 2 }
 532
 533
 534
 535
 536 --
 537 -- Notifications Section
 538 --
 539 --
 540
 541      pethPsePortOnOffNotification NOTIFICATION-TYPE
 542          OBJECTS     { pethPsePortDetectionStatus }
 543          STATUS      current
 544          DESCRIPTION
 545              " This Notification indicates if Pse Port is delivering or
 546                not power to the PD.  This Notification SHOULD be sent on
 547                every status change except in the searching mode.
 548                At least 500 msec must elapse between notifications
 549                being emitted by the same object instance."
 550           ::= { pethNotifications 1 }
 551
 552      pethMainPowerUsageOnNotification NOTIFICATION-TYPE
 553          OBJECTS     { pethMainPseConsumptionPower  }
 554          STATUS      current
 555          DESCRIPTION
 556            " This Notification indicate PSE Threshold usage
 557                indication is on, the usage power is above the
 558                threshold.  At least 500 msec must elapse between
 559                notifications being emitted by the same object
 560                instance."
 561          ::= { pethNotifications 2 }
 562
 563       pethMainPowerUsageOffNotification NOTIFICATION-TYPE
 564          OBJECTS     { pethMainPseConsumptionPower }
 565          STATUS      current
 566          DESCRIPTION
 567            " This Notification indicates PSE Threshold usage indication
 568                off, the usage power is below the threshold.
 569                At least 500 msec must elapse between notifications being
 570                emitted by the same object instance."
 571          ::= { pethNotifications 3 }
 572
 573 --
 574 -- Conformance Section
 575 --
 576 pethCompliances OBJECT IDENTIFIER ::= { pethConformance 1 }
 577 pethGroups      OBJECT IDENTIFIER ::= { pethConformance 2 }
 578
 579 pethCompliance MODULE-COMPLIANCE
 580        STATUS  current
 581        DESCRIPTION
 582                "Describes the requirements for conformance to the
 583                Power Ethernet MIB."
 584
 585
 586
 587        MODULE  -- this module
 588            MANDATORY-GROUPS { pethPsePortGroup,
 589                               pethPsePortNotificationGroup,
 590                               pethNotificationControlGroup
 591                             }
 592            GROUP   pethMainPseGroup
 593            DESCRIPTION
 594                "The pethMainPseGroup is mandatory for PSE systems
 595                 that implement a main power supply."
 596            GROUP   pethMainPowerNotificationGroup
 597            DESCRIPTION
 598                "The pethMainPowerNotificationGroup is mandatory for
 599                PSE systems that implement a main power supply."
 600        ::= { pethCompliances 1 }
 601
 602 pethPsePortGroup OBJECT-GROUP
 603     OBJECTS {
 604        pethPsePortAdminEnable,
 605        pethPsePortPowerPairsControlAbility,
 606        pethPsePortPowerPairs,
 607        pethPsePortDetectionStatus,
 608        pethPsePortPowerPriority,
 609        pethPsePortMPSAbsentCounter,
 610        pethPsePortInvalidSignatureCounter,
 611        pethPsePortPowerDeniedCounter,
 612        pethPsePortOverLoadCounter,
 613        pethPsePortShortCounter,
 614        pethPsePortType,
 615        pethPsePortPowerClassifications
 616     }
 617     STATUS  current
 618     DESCRIPTION
 619           "PSE Port objects."
 620     ::= { pethGroups 1 }
 621
 622 pethMainPseGroup OBJECT-GROUP
 623     OBJECTS {
 624        pethMainPsePower,
 625        pethMainPseOperStatus,
 626        pethMainPseConsumptionPower,
 627        pethMainPseUsageThreshold
 628     }
 629     STATUS  current
 630     DESCRIPTION
 631             "Main PSE Objects. "
 632     ::= { pethGroups 2 }
 633
 634 pethNotificationControlGroup OBJECT-GROUP
 635
 636
 637
 638     OBJECTS {
 639        pethNotificationControlEnable
 640     }
 641     STATUS  current
 642     DESCRIPTION
 643             "Notification Control  Objects. "
 644     ::= { pethGroups 3 }
 645
 646 pethPsePortNotificationGroup NOTIFICATION-GROUP
 647     NOTIFICATIONS { pethPsePortOnOffNotification}
 648     STATUS           current
 649     DESCRIPTION  "Pse Port Notifications."
 650     ::= { pethGroups 4 }
 651
 652   pethMainPowerNotificationGroup NOTIFICATION-GROUP
 653      NOTIFICATIONS { pethMainPowerUsageOnNotification,
 654                       pethMainPowerUsageOffNotification}
 655     STATUS           current
 656     DESCRIPTION  "Main PSE Notifications."
 657       ::= { pethGroups 5 }
 658
 659 END