summaryrefslogtreecommitdiff
path: root/MIBS/mrv/NBS-OBA-MIB
blob: af3a2629321a15a4cacebc1f69dfd556cbf8816e (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
NBS-OBA-MIB DEFINITIONS ::= BEGIN

IMPORTS

    OBJECT-TYPE, MODULE-IDENTITY, OBJECT-IDENTITY
        FROM SNMPv2-SMI

    InterfaceIndex
        FROM IF-MIB

    nbs, NbsTcMHz
        FROM NBS-MIB

    DisplayString, RowStatus
        FROM SNMPv2-TC;

nbsObaMib  MODULE-IDENTITY
    LAST-UPDATED "201503270000Z"  -- March 27, 2015
    ORGANIZATION "NBS"
    CONTACT-INFO
       "For technical support, please contact your service channel"

    DESCRIPTION
       "Optical bandwidth allocation (OBA) information."
    ::= { nbs 240 }

-- *******************************************************************
-- NBS-OBA-MIB local defines
-- *******************************************************************

nbsObaInfoGrp OBJECT-IDENTITY
    STATUS    current
    DESCRIPTION
       "For users to know if OBA is accessible"
    ::= { nbsObaMib 1 }

nbsObaDefineGrp  OBJECT-IDENTITY
    STATUS    current
    DESCRIPTION
       "For users to configure OBAs"
    ::= { nbsObaMib 2 }

nbsObaAlsGrp OBJECT-IDENTITY
    STATUS    current
    DESCRIPTION
       "For users to configure the Automatic Laser Shut-down (ALS) feature"
    ::= { nbsObaMib 3 }


-- *******************************************************************
--
-- the nbsObaInfoGrp
--
-- *******************************************************************
nbsObaInfoTable OBJECT-TYPE
    SYNTAX      SEQUENCE OF NbsObaInfoEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "Optical bandwidth allocation (OBA) definition(s); table entries
       are expected to be configured and viewed from the port-level."
    ::= { nbsObaInfoGrp 1 }

NbsObaInfoEntry ::= SEQUENCE {
    nbsObaInfoLineIfIndex            InterfaceIndex,
    nbsObaInfoAvails                 DisplayString,
    nbsObaInfoUnitSize               NbsTcMHz,
    nbsObaInfoMaxUnits               INTEGER,
    nbsObaInfoMaxUnitsPerClientPort  INTEGER
}

nbsObaInfoEntry      OBJECT-TYPE
    SYNTAX      NbsObaInfoEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "Optical bandwidth allocation (OBA) definition."
    INDEX { nbsObaInfoLineIfIndex }
    ::= { nbsObaInfoTable 1 }

nbsObaInfoLineIfIndex    OBJECT-TYPE
    SYNTAX      InterfaceIndex
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "The trunk or line port ifindex."
    ::= { nbsObaInfoEntry 1 }

nbsObaInfoAvails    OBJECT-TYPE
    SYNTAX          DisplayString
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION
        "The comma separated list of bandwidth units available to the
        user"
    ::= { nbsObaInfoEntry 2 }

nbsObaInfoUnitSize    OBJECT-TYPE
    SYNTAX      NbsTcMHz
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "Shows the unit size in MHz"
    ::= { nbsObaInfoEntry 3 }


nbsObaInfoMaxUnits    OBJECT-TYPE
    SYNTAX      INTEGER
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "Shows the maximum number of OBA units allowed on this port"
    ::= { nbsObaInfoEntry 4 }

nbsObaInfoMaxUnitsPerClientPort    OBJECT-TYPE
    SYNTAX      INTEGER
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "Shows the maximum number of OBA units allowed on client ports"
    ::= { nbsObaInfoEntry 5 }


-- *******************************************************************
--
-- the nbsObaDefineGrp
--
-- *******************************************************************

nbsObaDefineTableSize OBJECT-TYPE
    SYNTAX      INTEGER
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "The number of entries for the nbsObaDefineTable in this port "
    ::= { nbsObaDefineGrp 1 }

nbsObaDefineTable OBJECT-TYPE
    SYNTAX      SEQUENCE OF NbsObaDefineEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "Optical bandwidth allocation (OBA) definition(s); table entries
       are expected to be configured and viewed from the port-level."
    ::= { nbsObaDefineGrp 2 }

NbsObaDefineEntry ::= SEQUENCE {
    nbsObaDefineLinePort              InterfaceIndex,
    nbsObaDefineOrdinalIndex          INTEGER,
    nbsObaDefineLabel                 DisplayString,
    nbsObaDefineOduType               INTEGER,
    nbsObaDefineOduList               DisplayString,
    nbsObaDefineOduCount              INTEGER,
    nbsObaDefineMapType               INTEGER,
    nbsObaDefineClientPort            InterfaceIndex,
    nbsObaDefineCoupledWith           DisplayString,
    nbsObaDefinePresentState          INTEGER,
    nbsObaDefineAllocationInfo        INTEGER,
    nbsObaDefineRowStatus             RowStatus
}

nbsObaDefineEntry      OBJECT-TYPE
    SYNTAX      NbsObaDefineEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "Optical bandwidth allocation (OBA) definition."
    INDEX { nbsObaDefineLinePort, nbsObaDefineOrdinalIndex }
    ::= { nbsObaDefineTable 1 }

nbsObaDefineLinePort    OBJECT-TYPE
    SYNTAX      InterfaceIndex
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "The line port (aka trunk port) associated with this entry."
    ::= { nbsObaDefineEntry 1 }

nbsObaDefineOrdinalIndex    OBJECT-TYPE
    SYNTAX      INTEGER
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "Ordinal index for this entry; arbitrarily picked, starting from
       1. It is hidden from the CLI."
    ::= { nbsObaDefineEntry 2 }

nbsObaDefineLabel  OBJECT-TYPE
    SYNTAX      DisplayString(SIZE(0..64))
    MAX-ACCESS  read-create
    STATUS      current
    DESCRIPTION
       "User defined label that uniquely identifies this OBA."
    ::= { nbsObaDefineEntry 10 }

nbsObaDefineOduType    OBJECT-TYPE
    SYNTAX       INTEGER {
        unconfigured (1),
        odu0         (2)
    }
    MAX-ACCESS   read-create
    STATUS       current
    DESCRIPTION
       "The information structure data unit (data rate):
         * ODU0 (1.24416 Gb/s)"
    DEFVAL { unconfigured }
    ::= { nbsObaDefineEntry 11 }

nbsObaDefineOduList   OBJECT-TYPE
    SYNTAX      DisplayString(SIZE(0..64))
    MAX-ACCESS  read-create
    STATUS      current
    DESCRIPTION
       "A comma separated list of data unit identifiers assigned to
       this OBA; an identifier may be assigned to one OBA only. ODU0
       identifiers are the letters a-h.

        The count of identifiers determines the maximum bandwidth
        available, based on nbsObaDefineOduType. Just enough should be
        assigned to convey the desired protocol; an overly generous
        assignment wastes a limited resource and reduces overall
        service capacity."
    ::= { nbsObaDefineEntry 12 }

nbsObaDefineOduCount  OBJECT-TYPE
    SYNTAX      INTEGER
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "The count of identifiers found in nbsObaDefineOduList."
    ::= { nbsObaDefineEntry 13 }

nbsObaDefineMapType    OBJECT-TYPE
    SYNTAX       INTEGER {
        unconfigured (1),
        express      (2), -- express could represent the OTN switching
        standAlone   (3), -- all by itself no redundant service
        primary      (4), -- to be used for redundant service to show the primary selection
        secondary    (5)  -- to be used for redundant service to show the standby selection
    }
    MAX-ACCESS   read-create
    STATUS       current
    DESCRIPTION
       "Specifies the OBA traffic mapping type:
         * an express OBA passes from one line port to the other;
         * a standAlone OBA has no redundant backup;
         * a primary OBA is the first choice for redundant service;
         * a secondary OBA provides service when the primary OBA fails."
    DEFVAL { unconfigured }
    ::= { nbsObaDefineEntry 20 }

nbsObaDefineClientPort    OBJECT-TYPE
    SYNTAX      InterfaceIndex
    MAX-ACCESS  read-create
    STATUS      current
    DESCRIPTION
       "The add/drop client port (aka user or access port) associated
       with this entry."
    ::= { nbsObaDefineEntry 21 }

nbsObaDefineCoupledWith    OBJECT-TYPE
    SYNTAX       DisplayString(SIZE(0..64))
    MAX-ACCESS   read-create
    STATUS       current
    DESCRIPTION
       "This object's content depends on the 'nbsObaDefineMapType'
       value:
         * express -- the associated OBA on the other line port;
         * standAlone -- N/A
         * primary -- label of the associated secondary OBA;
         * secondary -- label of the associated primary OBA.

        Using an OBA's label instead of its ordinal index avoids
        unexpected and unintential associations after create/delete
        activities."
    ::= { nbsObaDefineEntry 22 }

nbsObaDefinePresentState    OBJECT-TYPE
    SYNTAX       INTEGER {
        unknown  (1),
        down     (2),
        active   (3),
        standby  (4)
    }
    MAX-ACCESS   read-only
    STATUS       current
    DESCRIPTION
       "Current OBA status."
    DEFVAL { unknown }
    ::= { nbsObaDefineEntry 29 }

nbsObaDefineAllocationInfo    OBJECT-TYPE
    SYNTAX       INTEGER {
        unknown                          (1),
        unitsExceedProtocolSpec          (2),
        additionalUnitsNeededForProtocol (3),
        unitsMatchProtocolSpec           (4),
        unitsExceedExpress               (5),
        additionalUnitsNeededForExpress  (6),
        unitsMatchExpress                (7)
    }
    MAX-ACCESS   read-only
    STATUS       current
    DESCRIPTION
       "Indicates if the number of units (ODUs) exceed, are under, or
       match the port protocol specifications."
    DEFVAL { unknown }
    ::= { nbsObaDefineEntry 30 }

nbsObaDefineRowStatus OBJECT-TYPE
    SYNTAX      RowStatus
    MAX-ACCESS  read-create
    STATUS      current
    DESCRIPTION
       "Used to create and delete OBAs"
    DEFVAL { notInService }
    ::= { nbsObaDefineEntry 99 }


-- *******************************************************************
--
-- the nbsObaAlsGrp
--
-- *******************************************************************

nbsObaAlsTable OBJECT-TYPE
    SYNTAX      SEQUENCE OF NbsObaAlsEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "The Automatic Laser Shutdown (ALS) setting for each port."
    ::= { nbsObaAlsGrp 1 }

NbsObaAlsEntry ::= SEQUENCE {
    nbsObaAlsIfIndex                  InterfaceIndex,
    nbsObaAlsState                    INTEGER
}

nbsObaAlsEntry      OBJECT-TYPE
    SYNTAX      NbsObaAlsEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
       "Optical bandwidth allocation (OBA) port."
    INDEX { nbsObaAlsIfIndex }
    ::= { nbsObaAlsTable 1 }

nbsObaAlsIfIndex    OBJECT-TYPE
    SYNTAX      InterfaceIndex
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
       "The ifindex associated with this entry."
    ::= { nbsObaAlsEntry 1 }

nbsObaAlsState  OBJECT-TYPE
    SYNTAX      INTEGER {
        notSupported (1),
	enable       (2),
	disable      (3)
    }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
       "Defines whether the Automatic Laser Shut-down (ALS) feature is enabled or disabled."
    ::= { nbsObaAlsEntry 10 }


END