1-- Module Name: HMS112R10.MIB (SCTE 85-1)
2-- SCTE Status: Adopted
3
4SCTE-HMS-HE-OPTICAL-TRANSMITTER-MIB DEFINITIONS ::= BEGIN
5
6IMPORTS
7    Integer32, Unsigned32, MODULE-IDENTITY, OBJECT-TYPE
8        FROM SNMPv2-SMI
9    MODULE-COMPLIANCE, OBJECT-GROUP
10        FROM SNMPv2-CONF
11    entPhysicalIndex
12         FROM ENTITY-MIB
13    HeTenthCentigrade, HeTenthVolt, HeTenthdBm, HeHundredthNanoMeter,
14    HeTenthdB, HeOnOffStatus, HeOnOffControl, HeLaserType
15        FROM SCTE-HMS-HEADENDIDENT-MIB  -- see SCTE 38-11 (formerly HMS114)
16    heOpticalTransmitterGroup
17        FROM SCTE-HMS-HE-OPTICS-MIB;  -- see SCTE 83-1 (formerly HMS108)
18
19heOpticalTransmitterMIB MODULE-IDENTITY
20    LAST-UPDATED "200302170000Z" -- February 17, 2003
21    ORGANIZATION "SCTE HMS Working Group"
22    CONTACT-INFO
23           "  SCTE HMS Subcommittee, Chairman
24               mailto:standards@scte.org
25           "
26    DESCRIPTION
27            "The MIB module is for representing optical transmitters
28             present in the headend (or indoor) and are supported by a
29            SNMP agent."
30
31        ::= { heOpticalTransmitterGroup 1 }
32
33heOpTxMIBObjects  OBJECT IDENTIFIER ::= { heOpticalTransmitterMIB 1 }
34
35--          The Optical Transmitter Unit Table
36heOpTxUnitTable OBJECT-TYPE
37    SYNTAX      SEQUENCE OF HeOpTxUnitEntry
38    MAX-ACCESS  not-accessible
39    STATUS      current
40    DESCRIPTION
41            "A table containing information about headend (or indoor)
42            fiber optic transmitters. These transmitters could be plug-in
43            modules for a chassis, stand-alone pizza-box units etc."
44        ::= { heOpTxMIBObjects 1 }
45
46heOpTxUnitEntry OBJECT-TYPE
47    SYNTAX      HeOpTxUnitEntry
48    MAX-ACCESS  not-accessible
49    STATUS      current
50    DESCRIPTION
51            "Information about each Fiber Optic Transmitter in
52            the subsystem."
53    INDEX       { entPhysicalIndex }
54    ::= { heOpTxUnitTable 1 }
55
56HeOpTxUnitEntry ::= SEQUENCE
57{
58    heOpTxUnitOutputStatus      HeOnOffStatus,
59    heOpTxUnitOnOffControl      HeOnOffControl
60}
61
62heOpTxUnitOutputStatus OBJECT-TYPE
63    SYNTAX      HeOnOffStatus
64    MAX-ACCESS  read-only
65    STATUS      current
66    DESCRIPTION
67            "The output status of the transmitter.
68
69            If all the outputs of the transmitter are off then
70            the variable value shall be off(1), else the value
71            shall be on(2)."
72    ::= { heOpTxUnitEntry 1 }
73
74heOpTxUnitOnOffControl OBJECT-TYPE
75    SYNTAX      HeOnOffControl
76    MAX-ACCESS  read-write
77    STATUS      current
78    DESCRIPTION
79            "This variable controls the output status of the transmitter.
80
81            Setting this variable to off(1) will cause all the
82            transmitters outputs to be shut off.
83
84            Setting this variable to on(2) will cause all the
85            transmitters outputs to be turned on.
86
87            Setting this variable to meaningless(3) will have no effect.
88
89            A GET request on this variable will always return the value
90            meaningless(3).
91
92            A management application should query heOpTxUnitOutputStatus
93            to get the output status of the transmitter."
94    ::= { heOpTxUnitEntry 2 }
95
96--          The Optical Transmitter Input Table
97heOpTxInputTable OBJECT-TYPE
98    SYNTAX       SEQUENCE OF HeOpTxInputEntry
99    MAX-ACCESS   not-accessible
100    STATUS       current
101    DESCRIPTION
102            "A table containing information related to RF Parameters
103            in headend (or indoor) fiber optic transmitters. These
104            transmitters could be plug-in modules for a chassis,
105            stand-alone pizza-box units etc."
106    ::= { heOpTxMIBObjects 2 }
107
108heOpTxInputEntry OBJECT-TYPE
109    SYNTAX      HeOpTxInputEntry
110    MAX-ACCESS  not-accessible
111    STATUS      current
112    DESCRIPTION
113            "Information about each Fiber Optic Transmitter in
114            the subsystem."
115    INDEX       { entPhysicalIndex, heOpTxInputIndex }
116    ::= { heOpTxInputTable 1 }
117
118HeOpTxInputEntry ::= SEQUENCE {
119    heOpTxInputIndex            Unsigned32,
120    heOpTxInputRFPower          HeTenthdBm,
121    heOpTxInputModulatorBias    HeTenthVolt,
122    heOpTxInputAGCMode          HeOnOffStatus,
123    heOpTxInputModulationMode   INTEGER,
124    heOpTxInputRFPadLevel       HeTenthdB
125}
126
127heOpTxInputIndex OBJECT-TYPE
128    SYNTAX      Unsigned32
129    MAX-ACCESS  not-accessible
130    STATUS      current
131    DESCRIPTION
132            "Index number corresponding to the RF Input
133            for the transmitter unit."
134    ::= { heOpTxInputEntry 1 }
135
136heOpTxInputRFPower OBJECT-TYPE
137    SYNTAX      HeTenthdBm
138    UNITS       "0.1 dBm"
139    MAX-ACCESS  read-only
140    STATUS      current
141    DESCRIPTION
142            "RF composite input power in 0.1 dBm."
143    ::= { heOpTxInputEntry 2 }
144
145heOpTxInputModulatorBias OBJECT-TYPE
146    SYNTAX      HeTenthVolt
147    UNITS       "0.1 Volt"
148    MAX-ACCESS  read-only
149    STATUS      current
150    DESCRIPTION
151            "Modulation Bias."
152    ::= { heOpTxInputEntry 3 }
153
154heOpTxInputAGCMode OBJECT-TYPE
155    SYNTAX      HeOnOffStatus
156    MAX-ACCESS  read-write
157    STATUS      current
158    DESCRIPTION
159            "Switches the transmitter Automatic Gain Control mode
160            of operation either off(1) or on(2)."
161    ::= { heOpTxInputEntry 4 }
162
163heOpTxInputModulationMode OBJECT-TYPE
164    SYNTAX      INTEGER {
165        cw(1),
166        modulated(2)
167    }
168    MAX-ACCESS        read-write
169    STATUS          current
170    DESCRIPTION
171            "Transmitter modulation mode:
172            cw(1) for Continuous Wave, or
173            modulated(2) for Modulated."
174    ::= { heOpTxInputEntry 5 }
175
176heOpTxInputRFPadLevel OBJECT-TYPE
177    SYNTAX      HeTenthdB
178    UNITS       "0.1 dB"
179    MAX-ACCESS  read-write
180    STATUS      current
181    DESCRIPTION
182            "RF Pad Attenuation Level."
183    ::= { heOpTxInputEntry 6 }
184
185--          The Optical Transmitter Laser Table
186heOpTxLaserTable OBJECT-TYPE
187    SYNTAX SEQUENCE OF HeOpTxLaserEntry
188    MAX-ACCESS not-accessible
189    STATUS current
190    DESCRIPTION
191            "A table containing information about transmitter
192            laser(s)."
193    ::= { heOpTxMIBObjects 3 }
194
195heOpTxLaserEntry OBJECT-TYPE
196    SYNTAX      HeOpTxLaserEntry
197    MAX-ACCESS  not-accessible
198    STATUS      current
199    DESCRIPTION
200            "A list of information about each laser in
201            the particular transmitter."
202    INDEX       { entPhysicalIndex, heOpTxLaserIndex }
203    ::= { heOpTxLaserTable 1 }
204
205HeOpTxLaserEntry ::= SEQUENCE {
206    heOpTxLaserIndex            Unsigned32,
207    heOpTxLaserTemp             HeTenthCentigrade,
208    heOpTxLaserBiasCurrent      Integer32,
209    heOpTxLaserOutputPower      HeTenthdBm,
210    heOpTxLaserTECCurrent       Integer32,
211    heOpTxLaserType             HeLaserType,
212    heOpTxLaserWavelength       HeHundredthNanoMeter,
213    heOpTxLaserOutputStatus     HeOnOffStatus,
214    heOpTxLaserOnOffControl     HeOnOffControl
215}
216
217heOpTxLaserIndex OBJECT-TYPE
218    SYNTAX      Unsigned32
219    MAX-ACCESS  not-accessible
220    STATUS      current
221    DESCRIPTION
222            "An arbitrary value which uniquely identifies the laser."
223    ::= { heOpTxLaserEntry 1 }
224
225heOpTxLaserTemp OBJECT-TYPE
226    SYNTAX      HeTenthCentigrade (-250..1000)
227    UNITS       "0.1 degrees Celsius"
228    MAX-ACCESS  read-only
229    STATUS      current
230    DESCRIPTION
231            "Temperature of the Transmitter Laser.
232
233            This object must provide for the alarm management capabilities
234            with a corresponding entry in the propertyTable of
235            SCTE-HMS-PROPERTY-MIB (HMS026).
236
237            An alarm shall be recorded as an entry in the currentAlarmTable
238            of SCTE-HMS-PROPERTY-MIB (HMS026).
239
240            A log record shall be added as an entry in the heCommonLogTable.
241
242            An heCommonAlarmEvent notification shall be sent."
243    ::= { heOpTxLaserEntry 2 }
244
245heOpTxLaserBiasCurrent OBJECT-TYPE
246    SYNTAX      Integer32 (0..65535)
247    UNITS       "milli Amperes"
248    MAX-ACCESS  read-only
249    STATUS      current
250    DESCRIPTION
251            "Transmitter laser bias current.
252
253            This object must provide for the alarm management capabilities
254            with a corresponding entry in the propertyTable of
255            SCTE-HMS-PROPERTY-MIB (HMS026).
256
257            An alarm shall be recorded as an entry in the currentAlarmTable
258            of SCTE-HMS-PROPERTY-MIB (HMS026).
259
260            A log record shall be added as an entry in the heCommonLogTable.
261
262            An heCommonAlarmEvent notification shall be sent."
263    ::= { heOpTxLaserEntry 3 }
264
265heOpTxLaserOutputPower OBJECT-TYPE
266    SYNTAX      HeTenthdBm
267    UNITS       "0.1 dBm"
268    MAX-ACCESS  read-only
269    STATUS      current
270    DESCRIPTION
271            "The laser output power.
272
273            This object must provide for the alarm management capabilities
274            with a corresponding entry in the propertyTable of
275            SCTE-HMS-PROPERTY-MIB (HMS026).
276
277            An alarm shall be recorded as an entry in the currentAlarmTable
278            of SCTE-HMS-PROPERTY-MIB (HMS026).
279
280            A log record shall be added as an entry in the heCommonLogTable.
281
282            An heCommonAlarmEvent notification shall be sent."
283    ::= { heOpTxLaserEntry 4 }
284
285heOpTxLaserTECCurrent OBJECT-TYPE
286    SYNTAX      Integer32
287    UNITS       "milli Amperes"
288    MAX-ACCESS  read-only
289    STATUS      current
290    DESCRIPTION
291            "Laser Thermo Electric Cooler current."
292    ::= { heOpTxLaserEntry 5 }
293
294heOpTxLaserType OBJECT-TYPE
295    SYNTAX      HeLaserType
296    MAX-ACCESS  read-only
297    STATUS      current
298    DESCRIPTION
299            "Laser type."
300    ::= { heOpTxLaserEntry 6 }
301
302heOpTxLaserWavelength OBJECT-TYPE
303    SYNTAX      HeHundredthNanoMeter
304    UNITS       "0.01 nanometer"
305    MAX-ACCESS  read-only
306    STATUS      current
307    DESCRIPTION
308            "The laser wavelength.
309            Typical value might be 155056 (1550.56 nm)."
310    ::= { heOpTxLaserEntry 7 }
311
312heOpTxLaserOutputStatus OBJECT-TYPE
313    SYNTAX      HeOnOffStatus
314    MAX-ACCESS  read-only
315    STATUS      current
316    DESCRIPTION
317            "The laser output status.
318
319            The value is on(2), if the Laser output is operating
320            in normal condition
321
322            The value is off(1), if the laser is either forced to turn off
323            or shut due to an internal error.
324
325            This object must provide for the alarm management capabilities
326            with a corresponding entry in the discretePropertyTable of
327            SCTE-HMS-PROPERTY-MIB (HMS026).
328
329            An alarm shall be recorded as an entry in the currentAlarmTable
330            of SCTE-HMS-PROPERTY-MIB (HMS026).
331
332            A log record shall be added as an entry in the heCommonLogTable.
333
334            An heCommonAlarmEvent notification shall be sent."
335    ::= { heOpTxLaserEntry 8 }
336
337heOpTxLaserOnOffControl    OBJECT-TYPE
338    SYNTAX      HeOnOffControl
339    MAX-ACCESS  read-write
340    STATUS      current
341    DESCRIPTION
342            "This variable controls the output status of the laser.
343
344            Setting this variable to off(1) will cause the
345            laser output to be shut off.
346
347            Setting this variable to on(2) will cause the
348            laser output to be turned on.
349
350            Setting this variable to meaningless(3) will have no effect.
351
352            A Get Request on this variable will always return the value
353            meaningless(3).
354
355            A management application should query heOpTxLaserOutputStatus
356            to get the output status of the laser."
357    ::= { heOpTxLaserEntry 9 }
358
359-- Conformance information
360heOpTxMIBConformance
361        OBJECT IDENTIFIER ::= { heOpticalTransmitterMIB 2 }
362
363heOpTxMIBCompliances
364        OBJECT IDENTIFIER ::= { heOpTxMIBConformance 1 }
365
366heOpTxMIBGroups
367        OBJECT IDENTIFIER ::= { heOpTxMIBConformance 2 }
368
369-- Compliance statements
370heOpTxCompliance MODULE-COMPLIANCE
371    STATUS  current
372    DESCRIPTION
373            "The minimum compliance statement for indoor optical transmitters."
374    MODULE
375        MANDATORY-GROUPS { heOpTxUnitMandatoryGroup,
376                           heOpTxLaserMandatoryGroup
377                         }
378    ::= { heOpTxMIBCompliances 1 }
379
380heOpTxUnitMandatoryGroup OBJECT-GROUP
381    OBJECTS {
382              heOpTxUnitOutputStatus
383            }
384    STATUS  current
385    DESCRIPTION
386            "The main group defines objects which are common to all
387            indoor optical transmitter modules."
388    ::= { heOpTxMIBGroups 1 }
389
390heOpTxLaserMandatoryGroup OBJECT-GROUP
391    OBJECTS {
392              heOpTxLaserType,
393              heOpTxLaserWavelength,
394              heOpTxLaserOutputStatus
395            }
396    STATUS  current
397    DESCRIPTION
398            "The laser group defines laser objects which are common to all
399            indoor optical transmitter modules."
400    ::= { heOpTxMIBGroups 2 }
401
402heOpTxUnitTableGroup OBJECT-GROUP
403    OBJECTS {
404              heOpTxUnitOutputStatus,
405              heOpTxUnitOnOffControl
406            }
407    STATUS  current
408    DESCRIPTION
409            "The unit group defines objects which are defined
410            in the SCTE-HMS-HE-OPTICAL-TRANSMITTER-MIB MIB module."
411    ::= { heOpTxMIBGroups 3 }
412
413heOpTxInputTableGroup OBJECT-GROUP
414    OBJECTS {
415              heOpTxInputRFPower,
416              heOpTxInputModulatorBias,
417              heOpTxInputAGCMode,
418              heOpTxInputModulationMode,
419              heOpTxInputRFPadLevel
420            }
421    STATUS  current
422    DESCRIPTION
423            "The input group defines RF objects which are defined
424            in the SCTE-HMS-HE-OPTICAL-TRANSMITTER-MIB MIB module."
425    ::= { heOpTxMIBGroups 4 }
426
427heOpTxLaserTableGroup OBJECT-GROUP
428    OBJECTS {
429              heOpTxLaserTemp,
430              heOpTxLaserBiasCurrent,
431              heOpTxLaserOutputPower,
432              heOpTxLaserTECCurrent,
433              heOpTxLaserType,
434              heOpTxLaserWavelength,
435              heOpTxLaserOutputStatus,
436              heOpTxLaserOnOffControl
437            }
438    STATUS  current
439    DESCRIPTION
440            "The laser group defines laser objects which are defined
441            in the SCTE-HMS-HE-OPTICAL-TRANSMITTER-MIB MIB module."
442    ::= { heOpTxMIBGroups 5 }
443
444END
445