summaryrefslogtreecommitdiff
path: root/MIBS/omnitron/OMNITRON-POE-MIB
blob: d34bce0f9ff845b121a4c497a19767a2ec3bfe75 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
OMNITRON-POE-MIB DEFINITIONS ::= BEGIN

IMPORTS
    MODULE-IDENTITY, OBJECT-TYPE, Unsigned32, IpAddress
        FROM SNMPv2-SMI           -- RFC-2578
    TruthValue
        FROM SNMPv2-TC            -- RFC-2579
    MODULE-COMPLIANCE, OBJECT-GROUP
        FROM SNMPv2-CONF          -- RFC-2580
    omnitron, OstPortSingleIndex, OstFloatValue
        FROM OMNITRON-TC-MIB;     -- Omnitron Enterprise Extension MIB

omnitronPoeMib MODULE-IDENTITY
    LAST-UPDATED "201501191200Z"     -- January 19, 2015
    ORGANIZATION "Omnitron Systems Technology, Inc."
    CONTACT-INFO "Omnitron Systems Technology, Inc.
                  38 Tesla
                  Irvine, CA 92618-4670
                  USA

             Tel: (949) 250 6510
             Fax: (949) 250 6514
          E-mail: info@omnitron-systems.com
   International: +1 949 250 6510

                  Technical Support and Customer Service
             Tel: (800) 675 8410
          E-mail: support@omnitron-systems.com
   International: +1 949 250 6510"

    DESCRIPTION
            "Omnitron PoE MIB for use with iConverter Management Modules v5.2
             and NetOutlook.

             Copyright 2015 Omnitron Systems Technology, Inc.
             All rights reserved.
            "

    REVISION    "201501191200Z"     -- January 19, 2015
    DESCRIPTION "Initial version of v5.2 MIB.
                "
    ::= { omnitron 15 }


--------------------------------------------------------------------------------
-- Power Over Ethernet (PoE) Global Configuration Table
--------------------------------------------------------------------------------

ostPoeGlobalCfgTable  OBJECT IDENTIFIER ::= { omnitronPoeMib 1 }

ostPoeGlobalCfgPwrLimitationEnable OBJECT-TYPE
    SYNTAX      TruthValue
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object specifies whether the PoE PSE power limiting function is enabled.

        The value 'true' indicates that PoE PSE limiting is enabled.

        The value 'false' indicates that PoE PSE limiting is disabled.
       "
    DEFVAL { false }
    ::= { ostPoeGlobalCfgTable 1 }

ostPoeGlobalCfgTotalPwr OBJECT-TYPE
    SYNTAX      OstFloatValue
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "This object indicates the total power sourced in Watts.
       "
    DEFVAL { "0.0" }
    ::= { ostPoeGlobalCfgTable 2 }


--------------------------------------------------------------------------------
-- Power Over Ethernet (PoE) Port Configuration Table
--------------------------------------------------------------------------------

ostPoePortCfgTable OBJECT-TYPE
    SYNTAX      SEQUENCE OF OstPoePortCfgEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "This table supports the port PoE configurations."
    ::= { omnitronPoeMib 2 }

ostPoePortCfgEntry OBJECT-TYPE
    SYNTAX      OstPoePortCfgEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "This is a PoE port configuration table entry."
    INDEX { ostPoePortCfgIndex }
    ::= { ostPoePortCfgTable 1 }

OstPoePortCfgEntry ::= SEQUENCE {
    ostPoePortCfgIndex                   OstPortSingleIndex,
    ostPoePortPseEnable                  INTEGER,
    ostPoePortPse60wMode                 INTEGER,
    ostPoePortPdMode                     INTEGER,
    ostPoePortPseVoltageSupplied         OstFloatValue,
    ostPoePortPseCurrentSupplied         OstFloatValue,
    ostPoePortPseStatus                  INTEGER,

    ostPoePortHeartbeatEnable            INTEGER,
    ostPoePortHeartbeatIpAddress         IpAddress,
    ostPoePortHeartbeatInterval          Unsigned32,
    ostPoePortHeartbeatErrorDetection    Unsigned32,
    ostPoePortHeartbeatErrorAction       INTEGER,
    ostPoePortHeartbeatNumberRestarts    Unsigned32,
    ostPoEPortHeartbeatStatus            INTEGER,
    ostPoEPortHeartbeatDeferTime         Unsigned32
    }

ostPoePortCfgIndex OBJECT-TYPE
    SYNTAX      OstPortSingleIndex
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "An index that is used to identify a specific PoE port number."
    ::= { ostPoePortCfgEntry 1 }


ostPoePortPseEnable OBJECT-TYPE
    SYNTAX      INTEGER {
        pseDisabled   (1),
        pseEnabled    (2)
    }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE PSE port enable.

        pseDisabled(1)           PSE power source is disabled
        pseEnabled(2)            PSE power source is enabled
       "
    DEFVAL { pseEnabled }
    ::= { ostPoePortCfgEntry 2 }

ostPoePortPse60wMode OBJECT-TYPE
    SYNTAX      INTEGER {
        pse60wNotAvail (0),
        pse60wAuto     (1),
        pse60wForce    (2)
    }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "The object is the PoE PSE 60W mode enable. This is the same control as
        the physical DIP switch.

        pse60wNotAvail           PSE 60W function not available
        pse60wAuto(1)            PSE 60W auto mode enabled
        pse60wForce(2)           PSE 60W force mode enabled
       "
    DEFVAL { pse60wAuto }
    ::= { ostPoePortCfgEntry 3 }

ostPoePortPdMode OBJECT-TYPE
    SYNTAX      INTEGER {
        pdModeNotDetected    (1),
        pdModeNotClassified  (2),
        pdModeFailure        (3),
        pdModeClass0         (4),
        pdModeClass1         (5),
        pdModeClass2         (6),
        pdModeClass3         (7),
        pdModeClass4         (8),
        pdMode60W            (9)
    }
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "This object is the PoE PD classification mode.

        pdModeNotDetected(1)     PD is not detected
        pdModeNotClassified(2)   PD is not classified
        pdModeFailure(3)         PD classification failure
        pdModeClass0(4)          PD is 802.3af Class 0 15W device
        pdModeClass1(5)          PD is 802.3af Class 1 4W device
        pdModeClass2(6)          PD is 802.3af Class 2 7W device
        pdModeClass3(7)          PD is 802.3af Class 3 15W device
        pdModeClass4(8)          PD is 802.3at Class 4 30W device
        pdMode60W(9)             PD is 60W device
       "
    DEFVAL { pdModeNotDetected }
    ::= { ostPoePortCfgEntry 4 }

ostPoePortPseVoltageSupplied OBJECT-TYPE
    SYNTAX      OstFloatValue
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "This object indicates the voltage output from the PSE port in volts.
       "
    DEFVAL { "0.0" }
    ::= { ostPoePortCfgEntry 5 }

ostPoePortPseCurrentSupplied OBJECT-TYPE
    SYNTAX      OstFloatValue
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "This object indicates the current output from the PSE port in mA
        (milliamps).
       "
    DEFVAL { "0.0" }
    ::= { ostPoePortCfgEntry 6 }

ostPoePortPseStatus OBJECT-TYPE
    SYNTAX      INTEGER {
        notApplicable        (1),
        pdNormal             (2),
        pdOverCurrent        (3),
        pdBrownOut           (4),
        pdInsufficientPower  (5)
    }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE PSE port status.

        notApplicable(1)        PD device not connected or port disabled
        pdNormal(2)             PD device is being powered fully
        pdOverCurrent(3)        PD device is consuming too much current
        pdBrownOut(4)           PD device is not fully powered
        pdInsufficientPower(5)  PD device not powered due to lack of power

        A write to this object restarts the PSE function and classification.
       "
    DEFVAL { notApplicable }
    ::= { ostPoePortCfgEntry 7 }

ostPoePortHeartbeatEnable OBJECT-TYPE
    SYNTAX      INTEGER {
        heartbeatDisabled   (1),
        heartbeatEnabled    (2)
    }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE PSE heartbeat enable.

        heartbeatDisabled(1)     PSE PD heartbeat is disabled
        heartbeatEnabled(2)      PSE PD heartbeat is enabled
       "
    DEFVAL { heartbeatDisabled }
    ::= { ostPoePortCfgEntry 8 }

ostPoePortHeartbeatIpAddress OBJECT-TYPE
    SYNTAX      IpAddress
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE PD heartbeat IP address to ping.
       "
    DEFVAL { '00000000'H }
    ::= { ostPoePortCfgEntry 9 }

ostPoePortHeartbeatInterval OBJECT-TYPE
    SYNTAX      Unsigned32 (1..300)
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE PSE PD heartbeat transmission interval in seconds.
       "
    DEFVAL { 1 }
    ::= { ostPoePortCfgEntry 10 }

ostPoePortHeartbeatErrorDetection OBJECT-TYPE
    SYNTAX      Unsigned32 (1..100)
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE PSE PD heartbeat number of consecutively lost
        heartbeat pings before an errored condition is declared. The number
        of consecutive error counts is cleared when a valid heartbeat
        response is received.
       "
    DEFVAL { 3 }
    ::= { ostPoePortCfgEntry 11 }

ostPoePortHeartbeatErrorAction OBJECT-TYPE
    SYNTAX      INTEGER {
        errorLostIgnored         (1),
        errorRestart             (2),
        errorShutdown            (3)
    }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE PSE heartbeat errored condition action.

        errorLostIgnored(1)      PD heartbeat errored condition is ignored
        errorRestart(2)          PD heartbeat errored condition results
                                   in a restart
        errorShutdown(3)         PD heartbeat errored condition results
                                   in a shutdown (power removed)
       "
    DEFVAL { errorLostIgnored }
    ::= { ostPoePortCfgEntry 12 }

ostPoePortHeartbeatNumberRestarts OBJECT-TYPE
    SYNTAX      Unsigned32 (0..16384)
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE PSE PD number of restarts when an errored
        hearbeat condition occurs. This object is only used when
        ostPoePortHeartbeatErrorAction is configured as 'errorRestart'

        A value of zero indicates restarts never stop.
       "
    DEFVAL { 0 }
    ::= { ostPoePortCfgEntry 13 }


ostPoEPortHeartbeatStatus OBJECT-TYPE
    SYNTAX      INTEGER {
        heartbeatDisabled   (1),
        heartbeatAvailable  (2),
        heartbeatErrored    (3),
        heartbeatRestart    (4),
        heartbeatShutdown   (5)
    }
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "This object is the PoE PSE PD heartbeat status.

        heartbeatDisabled(1)    PSE PD heartbeat is disabled
        heartbeatAvailable(2)   PSE PD heartbeats are being received
        heartbeatErrored(3)     PSE PD heartbeat is in an errored condition
        heartbeatRestart(4)     PSE PD heartbeat error has caused a PSE restart
        heartbeatShutdown(5)    PSE PD heartbeat error has caused a PSE shutdown
       "
    DEFVAL { heartbeatDisabled }
    ::= { ostPoePortCfgEntry 14 }

ostPoEPortHeartbeatDeferTime OBJECT-TYPE
    SYNTAX      Unsigned32 (1..300)
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "This object is the PoE heartbeat PSE PD heartbeat transmission delay
        interval in seconds after the port has been reenabled. The delay is
        the amount of time after power has been applied before the heartbeat
        function starts and hence the detection of heartbeat errors.
       "
    DEFVAL { 5 }
    ::= { ostPoePortCfgEntry 15 }


--------------------------------------------------------------------------------
-- Conformance Information
--------------------------------------------------------------------------------
ostPoeCompliances       OBJECT IDENTIFIER ::= { omnitronPoeMib 3 }
ostPoeGroups            OBJECT IDENTIFIER ::= { omnitronPoeMib 4 }


--------------------------------------------------------------------------------
-- Omnitron PoE MIB Units of conformance
--------------------------------------------------------------------------------
ostPoeGroup OBJECT-GROUP
    OBJECTS {
        ostPoeGlobalCfgPwrLimitationEnable,
        ostPoeGlobalCfgTotalPwr,

        ostPoePortPseEnable,
        ostPoePortPse60wMode,
        ostPoePortPdMode,
        ostPoePortPseVoltageSupplied,
        ostPoePortPseCurrentSupplied,
        ostPoePortPseStatus,

        ostPoePortHeartbeatEnable,
        ostPoePortHeartbeatIpAddress,
        ostPoePortHeartbeatInterval,
        ostPoePortHeartbeatErrorDetection,
        ostPoePortHeartbeatErrorAction,
        ostPoePortHeartbeatNumberRestarts,
        ostPoEPortHeartbeatStatus,
        ostPoEPortHeartbeatDeferTime
    }
    STATUS      current
    DESCRIPTION
       "Mandatory objects for the PoE functional group."
    ::= { ostPoeGroups 1 }


--------------------------------------------------------------------------------
-- Omnitron POE MIB Compliance statements
-------------------------------------------------------------------------------
ostPoeCompliance MODULE-COMPLIANCE
    STATUS       current
    DESCRIPTION "The compliance statement for the Omnitron PoE MIB."
    MODULE
        MANDATORY-GROUPS {
            ostPoeGroup
        }
    ::= { ostPoeCompliances 2 }


END