summaryrefslogtreecommitdiff
path: root/MIBS/mrv/NBS-OSA-MIB
blob: 0c6b85310eeb30a610153ba67eb64edab69a7026 (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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
NBS-OSA-MIB DEFINITIONS ::= BEGIN

IMPORTS
    Unsigned32, TimeTicks, OBJECT-TYPE,
    MODULE-IDENTITY, OBJECT-IDENTITY, NOTIFICATION-TYPE
        FROM SNMPv2-SMI
    InterfaceIndex, ifAlias
        FROM IF-MIB
    NbsCmmcChannelBand
        FROM NBS-CMMCENUM-MIB
    nbs, NbsTcMHz
        FROM NBS-MIB;

nbsOsaMib  MODULE-IDENTITY
    LAST-UPDATED "201503190000Z"
    ORGANIZATION  "NBS"
    CONTACT-INFO
      "For technical support, please contact your service channel"

    DESCRIPTION
      "MIB for controlling and monitoring optical spectrum analyzers"

    ::= { nbs 207 }

-- *******************************************************************
-- NBS-OSA-MIB local defines
-- *******************************************************************

nbsOsaPortGrp  OBJECT-IDENTITY
    STATUS    current
    DESCRIPTION
      "OSA Card information"
    ::= { nbsOsaMib 1 }

nbsOsaSpectrumGrp  OBJECT-IDENTITY
    STATUS    current
    DESCRIPTION
      "Info and settings for channels"
    ::= { nbsOsaMib 2 }

nbsOsaChannelGrp  OBJECT-IDENTITY
    STATUS    current
    DESCRIPTION
      "Info and settings for channels"
    ::= { nbsOsaMib 3 }

nbsOsaTraps  OBJECT-IDENTITY
    STATUS      current
    DESCRIPTION "SNMP Traps or Notifications"
    ::= { nbsOsaMib 4 }

-- *******************************************************************
--
-- the nbsOsaPortTable
--
-- *******************************************************************

nbsOsaPortTableSize OBJECT-TYPE
        SYNTAX      Unsigned32
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The number of entries in nbsOsaPortTable."

        ::= { nbsOsaPortGrp 1 }

nbsOsaPortTable OBJECT-TYPE
        SYNTAX      SEQUENCE OF NbsOsaPortEntry
        MAX-ACCESS  not-accessible
        STATUS      current
        DESCRIPTION
          ""
        ::= { nbsOsaPortGrp 2 }

NbsOsaPortEntry ::= SEQUENCE {
        nbsOsaPortIfIndex      InterfaceIndex,
        nbsOsaPortAttenuation  INTEGER,
        nbsOsaPortChannels     INTEGER
}

nbsOsaPortEntry      OBJECT-TYPE
        SYNTAX      NbsOsaPortEntry
        MAX-ACCESS  not-accessible
        STATUS      current
        DESCRIPTION
          ""
        INDEX { nbsOsaPortIfIndex }
        ::= { nbsOsaPortTable 1 }

nbsOsaPortIfIndex   OBJECT-TYPE
        SYNTAX      InterfaceIndex
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The Mib2 ifIndex of the optical spectrum analyzer port"
        ::= { nbsOsaPortEntry 2 }

nbsOsaPortAttenuation OBJECT-TYPE
        SYNTAX      INTEGER (-100000..100000)
        MAX-ACCESS  read-write
        STATUS      current
        DESCRIPTION
          "Attenuation subtracted from RxPower readings, in millidecibels (mdB).

           When SET, agent immediately clears nbsOsaChannelTable and
           nbsOsaSpectrumTable entries for this ifIndex."
        DEFVAL { 0 }
        ::= { nbsOsaPortEntry 3 }

nbsOsaPortChannels OBJECT-TYPE
        SYNTAX      INTEGER
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The number of nbsOsaChannelTable entries for this port."
        DEFVAL { 0 }
        ::= { nbsOsaPortEntry 4 }

-- *******************************************************************
--
-- the nbsOsaSpectrumTable
--
-- *******************************************************************

nbsOsaSpectrumTableSize OBJECT-TYPE
        SYNTAX      Unsigned32
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The number of entries in nbsOsaSpectrumTable."

        ::= { nbsOsaSpectrumGrp 1 }

nbsOsaSpectrumTable OBJECT-TYPE
        SYNTAX      SEQUENCE OF NbsOsaSpectrumEntry
        MAX-ACCESS  not-accessible
        STATUS      current
        DESCRIPTION
          "Table of supported channels, their signal strength, and
           user-configured thresholds."

        ::= { nbsOsaSpectrumGrp 2 }

NbsOsaSpectrumEntry ::= SEQUENCE {
        nbsOsaSpectrumIfIndex      InterfaceIndex,
        nbsOsaSpectrumWavelength   INTEGER,
        nbsOsaSpectrumTimestamp    TimeTicks,
        nbsOsaSpectrumRxPowerOper  INTEGER
}

nbsOsaSpectrumEntry      OBJECT-TYPE
        SYNTAX      NbsOsaSpectrumEntry
        MAX-ACCESS  not-accessible
        STATUS      current
        DESCRIPTION
          "Reports status of monitored frequencies."
        INDEX { nbsOsaSpectrumIfIndex, nbsOsaSpectrumWavelength }
        ::= { nbsOsaSpectrumTable 1 }

nbsOsaSpectrumIfIndex   OBJECT-TYPE
        SYNTAX      InterfaceIndex
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The Mib2 ifIndex of the optical spectrum analyzer port"
        ::= { nbsOsaSpectrumEntry 2 }

nbsOsaSpectrumWavelength OBJECT-TYPE
        SYNTAX      INTEGER
        MAX-ACCESS  not-accessible
        STATUS      current
        DESCRIPTION
          "The measured wavelength, in picometers (pm)."
        ::= { nbsOsaSpectrumEntry 3 }

nbsOsaSpectrumTimestamp OBJECT-TYPE
        SYNTAX      TimeTicks
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "Value of sysUptime when this table row was last updated."
        ::= { nbsOsaSpectrumEntry 4 }

nbsOsaSpectrumRxPowerOper OBJECT-TYPE
        SYNTAX      INTEGER
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The last known signal strength, in millidecibels (mdBm), of this
           channel."
        ::= { nbsOsaSpectrumEntry 5 }

-- *******************************************************************
--
-- the nbsOsaChannelTable
--
-- *******************************************************************

nbsOsaChannelTableSize OBJECT-TYPE
        SYNTAX      Unsigned32
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The number of entries in nbsOsaChannelTable."

        ::= { nbsOsaChannelGrp 1 }

nbsOsaChannelTable OBJECT-TYPE
        SYNTAX      SEQUENCE OF NbsOsaChannelEntry
        MAX-ACCESS  not-accessible
        STATUS      current
        DESCRIPTION
          "Table of supported channels, their signal strength, and
           user-configured thresholds."

        ::= { nbsOsaChannelGrp 2 }

NbsOsaChannelEntry ::= SEQUENCE {
        nbsOsaChannelIfIndex           InterfaceIndex,
        nbsOsaChannelFrequencyNominal  NbsTcMHz,
        nbsOsaChannelBand              NbsCmmcChannelBand,
        nbsOsaChannelNumber            INTEGER,

        nbsOsaChannelStatus            INTEGER,
        nbsOsaChannelTimestamp         TimeTicks,
        nbsOsaChannelFrequencyOper     NbsTcMHz,

        nbsOsaChannelRxPowerOper       INTEGER,
        nbsOsaChannelRxPowerMin        INTEGER,
        nbsOsaChannelRxPowerMax        INTEGER,

        nbsOsaChannelOSNROper          INTEGER,
        nbsOsaChannelOSNRMin           INTEGER,
        nbsOsaChannelOSNRMax           INTEGER
}

nbsOsaChannelEntry      OBJECT-TYPE
        SYNTAX      NbsOsaChannelEntry
        MAX-ACCESS  not-accessible
        STATUS      current
        DESCRIPTION
          "Reports status of monitored frequencies."
        INDEX { nbsOsaChannelIfIndex, nbsOsaChannelFrequencyNominal }
        ::= { nbsOsaChannelTable 1 }

nbsOsaChannelIfIndex   OBJECT-TYPE
        SYNTAX      InterfaceIndex
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The Mib2 ifIndex of the optical spectrum analyzer port"
        ::= { nbsOsaChannelEntry 1 }

nbsOsaChannelFrequencyNominal OBJECT-TYPE
        SYNTAX      NbsTcMHz
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The nominal frequency, in MHz, of this channel."
        ::= { nbsOsaChannelEntry 2 }

nbsOsaChannelBand OBJECT-TYPE
        SYNTAX      NbsCmmcChannelBand
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The ITU grid labels DWDM channels with a letter 'band' and a
           numeric channel.  Within this mib, the band is indicated by
           this object, and the channel number is shown in the object
           nbsOsaChannelNumber.

           Frequencies of at least 180100 GHz but less than 190100 GHz
           are considered the L spectrum, and frequencies of at least
           190100 but less than 200100 GHz are considered the C spectrum.

           Frequencies evenly divisible by 100 GHz are designated with
           a 'C' or 'L' prepended to the channel number.  Frequencies
           that are offset by 50 GHz are designated 'H' within the C
           spectrum, and 'Q' within the L spectrum."
        ::= { nbsOsaChannelEntry 3 }

nbsOsaChannelNumber OBJECT-TYPE
        SYNTAX      INTEGER
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The channel number can be derived by extracting the two middle
           digits from the six digit frequency in GHz."
        ::= { nbsOsaChannelEntry 4 }

nbsOsaChannelStatus OBJECT-TYPE
        SYNTAX      INTEGER {
                absent   (1),
                present  (2)
        }
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "If the OSA thinks the channel is there or not."
        ::= { nbsOsaChannelEntry 5 }

nbsOsaChannelTimestamp OBJECT-TYPE
        SYNTAX      TimeTicks
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "Value of sysUptime when this table row was last updated."
        ::= { nbsOsaChannelEntry 6 }

nbsOsaChannelFrequencyOper OBJECT-TYPE
        SYNTAX      NbsTcMHz
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The measured frequency, in MHz, of this channel."
        ::= { nbsOsaChannelEntry 7 }

nbsOsaChannelRxPowerOper OBJECT-TYPE
        SYNTAX      INTEGER
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The last known signal strength, in millidecibels (mdBm), of this
           channel.

           Not supported value: -100001"
        DEFVAL { -100000 }
        ::= { nbsOsaChannelEntry 8 }

nbsOsaChannelRxPowerMin OBJECT-TYPE
        SYNTAX      INTEGER (-100000..100000)
        MAX-ACCESS  read-write
        STATUS      current
        DESCRIPTION
          "The user-specified minimum signal strength, in millidecibels
           (mdBm), of this channel.

           Not supported value: -100001"
        DEFVAL { 0 }
        ::= { nbsOsaChannelEntry 9 }

nbsOsaChannelRxPowerMax OBJECT-TYPE
        SYNTAX      INTEGER (-100000..100000)
        MAX-ACCESS  read-write
        STATUS      current
        DESCRIPTION
          "The user-specified maximum signal strength, in millidecibels
           (mdBm), of this channel.

           Not supported value: -100001"
        DEFVAL { 0 }
        ::= { nbsOsaChannelEntry 10 }

nbsOsaChannelOSNROper OBJECT-TYPE
        SYNTAX      INTEGER
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
          "The last known OSNR, in permil, of this channel."
        ::= { nbsOsaChannelEntry 11 }

nbsOsaChannelOSNRMin OBJECT-TYPE
        SYNTAX      INTEGER
        MAX-ACCESS  read-write
        STATUS      current
        DESCRIPTION
          "The user-specified minimum OSNR of this channel"
        DEFVAL { 1000 }
        ::= { nbsOsaChannelEntry 12 }

nbsOsaChannelOSNRMax OBJECT-TYPE
        SYNTAX      INTEGER
        MAX-ACCESS  read-write
        STATUS      current
        DESCRIPTION
          "The user-specified maximum OSNR of this channel"
        DEFVAL { 1000 }
        ::= { nbsOsaChannelEntry 13 }

-- *******************************************************************

--
-- nbsOsaChannelTraps (Notifications)
--

nbsOsaTrapPortChannelAdded  NOTIFICATION-TYPE
        OBJECTS   { nbsOsaChannelIfIndex,
                    ifAlias,
                    nbsOsaChannelBand,
                    nbsOsaChannelNumber,
                    nbsOsaChannelFrequencyNominal }
        STATUS      current
        DESCRIPTION
                "Sent when optical spectrum analyser first detects a channel.

                 This Notification should be of Severity ERROR."
        ::= { nbsOsaTraps 1 }

nbsOsaTrapPortChannelDropped  NOTIFICATION-TYPE
        OBJECTS   { nbsOsaChannelIfIndex,
                    ifAlias,
                    nbsOsaChannelBand,
                    nbsOsaChannelNumber,
                    nbsOsaChannelFrequencyNominal }
        STATUS      current
        DESCRIPTION
                "Sent when optical spectrum analyser stops detecting a channel.

                 This Notification should be of Severity ERROR."
        ::= { nbsOsaTraps 2 }

nbsOsaTrapPortRxPowerTooLow  NOTIFICATION-TYPE
        OBJECTS   { nbsOsaChannelIfIndex,
                    ifAlias,
                    nbsOsaChannelBand,
                    nbsOsaChannelNumber,
                    nbsOsaChannelRxPowerMin,
                    nbsOsaChannelRxPowerOper }
        STATUS      current
        DESCRIPTION
                "Sent when RxPower is lower than nbsOsaChannelRxPowerMin.

                 This Notification should be of Severity ERROR.

                 Note: mdBm"
        ::= { nbsOsaTraps 3 }

nbsOsaTrapPortRxPowerOK  NOTIFICATION-TYPE
        OBJECTS   { nbsOsaChannelIfIndex,
                    ifAlias,
                    nbsOsaChannelBand,
                    nbsOsaChannelNumber,
                    nbsOsaChannelRxPowerOper }
        STATUS      current
        DESCRIPTION
                "Sent when RxPower returns to a level between
                 nbsOsaChannelRxPowerMin and nbsOsaChannelRxPowerMax.

                 This Notification should be of Severity ERROR.

                 Note: mdBm"
        ::= { nbsOsaTraps 4 }

nbsOsaTrapPortRxPowerTooHigh  NOTIFICATION-TYPE
        OBJECTS   { nbsOsaChannelIfIndex,
                    ifAlias,
                    nbsOsaChannelBand,
                    nbsOsaChannelNumber,
                    nbsOsaChannelRxPowerMax,
                    nbsOsaChannelRxPowerOper }
        STATUS      current
        DESCRIPTION
                "Sent when RxPower is higher than nbsOsaChannelRxPowerMax.

                 This Notification should be of Severity ERROR.

                 Note: mdBm"
        ::= { nbsOsaTraps 5 }

nbsOsaTrapPortOSNRTooLow  NOTIFICATION-TYPE
        OBJECTS   { nbsOsaChannelIfIndex,
                    ifAlias,
                    nbsOsaChannelBand,
                    nbsOsaChannelNumber,
                    nbsOsaChannelOSNRMin,
                    nbsOsaChannelOSNROper }
        STATUS      current
        DESCRIPTION
                "Sent when OSNR is lower then the configured threshold.

                 This Notification should be of Severity ERROR."
        ::= { nbsOsaTraps 6 }

nbsOsaTrapPortOSNROk  NOTIFICATION-TYPE
        OBJECTS   { nbsOsaChannelIfIndex,
                    ifAlias,
                    nbsOsaChannelBand,
                    nbsOsaChannelNumber,
                    nbsOsaChannelOSNROper }
        STATUS      current
        DESCRIPTION
                "Sent when OSNR is ok.

                 This Notification should be of Severity ERROR."
        ::= { nbsOsaTraps 7 }

nbsOsaTrapPortOSNRTooHigh  NOTIFICATION-TYPE
        OBJECTS   { nbsOsaChannelIfIndex,
                    ifAlias,
                    nbsOsaChannelBand,
                    nbsOsaChannelNumber,
                    nbsOsaChannelOSNRMax,
                    nbsOsaChannelOSNROper }
        STATUS      current
        DESCRIPTION
                "Sent when OSNR is higher then the configured threshold.

                 This Notification should be of Severity ERROR."
        ::= { nbsOsaTraps 8 }
END