1SCTE-HMS-HE-OPTICAL-AMPLIFIER-MIB DEFINITIONS ::= BEGIN 2 3IMPORTS 4 MODULE-IDENTITY, OBJECT-TYPE, Unsigned32 5 FROM SNMPv2-SMI 6 MODULE-COMPLIANCE, OBJECT-GROUP 7 FROM SNMPv2-CONF 8 entPhysicalIndex 9 FROM ENTITY-MIB 10 HeOnOffStatus, HeOnOffControl, HeLaserType, 11 HeTenthCentigrade, HeTenthdB, HeTenthdBm, HeMilliAmp 12 FROM SCTE-HMS-HEADENDIDENT-MIB 13 heOpticalAmplifierGroup 14 FROM SCTE-HMS-HE-OPTICS-MIB; 15 16heOpticalAmplifierMIB MODULE-IDENTITY 17 LAST-UPDATED "200312100000Z" -- December 10, 2003 18 ORGANIZATION "SCTE HMS Working Group" 19 CONTACT-INFO 20 "SCTE HMS Subcommittee, Chairman 21 mailto: standards@scte.org" 22 23 DESCRIPTION 24 "The MIB module is for representing optical amplifiers 25 present in the headend (or indoor) and are supported by a 26 SNMP agent." 27 28 ::= { heOpticalAmplifierGroup 1 } 29 30heOpAmpMIBObjects OBJECT IDENTIFIER ::= { heOpticalAmplifierMIB 1 } 31 32-- The Optical Amplifier Unit Table 33heOpAmpUnitTable OBJECT-TYPE 34 SYNTAX SEQUENCE OF HeOpAmpUnitEntry 35 MAX-ACCESS not-accessible 36 STATUS current 37 DESCRIPTION 38 "A table containing information about headend (or indoor) 39 fiber optic amplifiers. These amplifiers could be plug-in 40 modules for a chassis, stand-alone pizza-box units etc." 41 ::= { heOpAmpMIBObjects 1 } 42 43heOpAmpUnitEntry OBJECT-TYPE 44 SYNTAX HeOpAmpUnitEntry 45 MAX-ACCESS not-accessible 46 STATUS current 47 DESCRIPTION 48 "Information about each Fiber Optic amplifier in 49 the subsystem." 50 INDEX { entPhysicalIndex } 51 ::= { heOpAmpUnitTable 1 } 52 53HeOpAmpUnitEntry ::= SEQUENCE 54{ 55 heOpAmpUnitOutputStatus HeOnOffStatus, 56 heOpAmpUnitOnOffControl HeOnOffControl 57} 58 59heOpAmpUnitOutputStatus OBJECT-TYPE 60 SYNTAX HeOnOffStatus 61 MAX-ACCESS read-only 62 STATUS current 63 DESCRIPTION 64 "The output status of the amplifier. 65 66 If all the outputs of the amplifier are off then 67 the variable value shall be off(1), else the value 68 shall be on(2). 69 70 This object must provide for the alarm management capabilities 71 with a corresponding entry in the discretePropertyTable of 72 SCTE-HMS-PROPERTY-MIB (HMS026). 73 74 An alarm shall be recorded as an entry in the currentAlarmTable 75 of SCTE-HMS-PROPERTY-MIB (HMS026). 76 77 A log record shall be added as an entry in the heCommonLogTable. 78 79 An heCommonAlarmEvent notification shall be sent." 80 ::= { heOpAmpUnitEntry 1 } 81 82heOpAmpUnitOnOffControl OBJECT-TYPE 83 SYNTAX HeOnOffControl 84 MAX-ACCESS read-write 85 STATUS current 86 DESCRIPTION 87 "This variable controls the output status of the amplifer. 88 89 Setting this variable to off(1) will cause all the 90 amplifier outputs to be shut off. 91 92 Setting this variable to on(2) will cause all the 93 amplifier outputs to be turned on. 94 95 A value meaningless(3) will be implemented by the 96 variables that represent a switch with write-only access. 97 A GET request for the value of the write-only variable 98 shall return a value meaningless(3). 99 100 A SET request with a value meaningless(3) for the variable 101 with write access shall have no effect and no exception is 102 generated. 103 104 A value may be used by the variables with both read-write 105 and write-only access. 106 107 The variables with read-only access shall be defined with 108 the textual convention HeOnOffStatus." 109 110 ::= { heOpAmpUnitEntry 2 } 111 112-- The Optical Amplifier Input Table 113heOpAmpInputTable OBJECT-TYPE 114 SYNTAX SEQUENCE OF HeOpAmpInputEntry 115 MAX-ACCESS not-accessible 116 STATUS current 117 DESCRIPTION 118 "A table containing information related to input Parameters 119 in headend (or indoor) fiber optic amplifiers. These 120 amplifiers could be plug-in modules for a chassis, 121 stand-alone pizza-box units etc." 122 ::= { heOpAmpMIBObjects 2 } 123 124heOpAmpInputEntry OBJECT-TYPE 125 SYNTAX HeOpAmpInputEntry 126 MAX-ACCESS not-accessible 127 STATUS current 128 DESCRIPTION 129 "Information about each Fiber Optic amplifier input in 130 the subsystem." 131 INDEX { entPhysicalIndex, heOpAmpInputIndex} 132 ::= { heOpAmpInputTable 1 } 133 134HeOpAmpInputEntry ::= SEQUENCE 135{ 136 heOpAmpInputIndex Unsigned32, 137 heOpAmpInputPower HeTenthdBm 138} 139 140heOpAmpInputIndex OBJECT-TYPE 141 SYNTAX Unsigned32 142 MAX-ACCESS not-accessible 143 STATUS current 144 DESCRIPTION 145 "An arbitrary value which uniquely identifies 146 the amplifier input." 147 ::= { heOpAmpInputEntry 1 } 148 149heOpAmpInputPower OBJECT-TYPE 150 SYNTAX HeTenthdBm 151 UNITS "0.1 dBm" 152 MAX-ACCESS read-only 153 STATUS current 154 DESCRIPTION 155 "Optical input power. 156 This object must provide for the alarm management capabilities 157 with a corresponding entry in the propertyTable of 158 SCTE-HMS-PROPERTY-MIB (HMS026). 159 160 An alarm shall be recorded as an entry in the currentAlarmTable 161 of SCTE-HMS-PROPERTY-MIB (HMS026). 162 163 A log record shall be added as an entry in the heCommonLogTable. 164 165 An heCommonAlarmEvent notification shall be sent." 166 ::= { heOpAmpInputEntry 2 } 167 168-- The Optical Amplifier Laser Table 169heOpAmpLaserTable OBJECT-TYPE 170 SYNTAX SEQUENCE OF HeOpAmpLaserEntry 171 MAX-ACCESS not-accessible 172 STATUS current 173 DESCRIPTION 174 "A table containing information about amplifier laser(s)." 175 ::= { heOpAmpMIBObjects 3 } 176 177heOpAmpLaserEntry OBJECT-TYPE 178 SYNTAX HeOpAmpLaserEntry 179 MAX-ACCESS not-accessible 180 STATUS current 181 DESCRIPTION 182 "A list of information about each laser in 183 the particular amplifier." 184 INDEX { entPhysicalIndex, heOpAmpLaserIndex } 185 ::= { heOpAmpLaserTable 1 } 186 187HeOpAmpLaserEntry ::= SEQUENCE 188{ 189 heOpAmpLaserIndex Unsigned32, 190 heOpAmpLaserTemp HeTenthCentigrade, 191 heOpAmpLaserBiasCurrent HeMilliAmp, 192 heOpAmpLaserOutputPower HeTenthdBm, 193 heOpAmpLaserTECCurrent HeMilliAmp, 194 heOpAmpLaserType HeLaserType 195} 196 197heOpAmpLaserIndex OBJECT-TYPE 198 SYNTAX Unsigned32 199 MAX-ACCESS not-accessible 200 STATUS current 201 DESCRIPTION 202 "An arbitrary value which uniquely identifies the laser." 203 ::= { heOpAmpLaserEntry 1 } 204 205heOpAmpLaserTemp OBJECT-TYPE 206 SYNTAX HeTenthCentigrade 207 UNITS "0.1 degrees Celsius" 208 MAX-ACCESS read-only 209 STATUS current 210 DESCRIPTION 211 "Temperature of the amplifier laser. 212 213 This object must provide for the alarm management capabilities 214 with a corresponding entry in the propertyTable of 215 SCTE-HMS-PROPERTY-MIB (HMS026). 216 217 An alarm shall be recorded as an entry in the currentAlarmTable 218 of SCTE-HMS-PROPERTY-MIB (HMS026). 219 220 A log record shall be added as an entry in the heCommonLogTable. 221 222 An heCommonAlarmEvent notification shall be sent." 223 224 ::= { heOpAmpLaserEntry 2 } 225 226heOpAmpLaserBiasCurrent OBJECT-TYPE 227 SYNTAX HeMilliAmp 228 UNITS "1.0 mA" 229 MAX-ACCESS read-only 230 STATUS current 231 DESCRIPTION 232 "Amplifier laser bias current in mA. 233 234 This object must provide for the alarm management capabilities 235 with a corresponding entry in the propertyTable of 236 SCTE-HMS-PROPERTY-MIB (HMS026). 237 238 An alarm shall be recorded as an entry in the currentAlarmTable 239 of SCTE-HMS-PROPERTY-MIB (HMS026). 240 241 A log record shall be added as an entry in the heCommonLogTable. 242 243 An heCommonAlarmEvent notification shall be sent." 244 245 ::= { heOpAmpLaserEntry 3 } 246 247heOpAmpLaserOutputPower OBJECT-TYPE 248 SYNTAX HeTenthdBm 249 UNITS "0.1 dBm" 250 MAX-ACCESS read-only 251 STATUS current 252 DESCRIPTION 253 "The laser output power. 254 255 This object must provide for the alarm management capabilities 256 with a corresponding entry in the propertyTable of 257 SCTE-HMS-PROPERTY-MIB (HMS026). 258 259 An alarm shall be recorded as an entry in the currentAlarmTable 260 of SCTE-HMS-PROPERTY-MIB (HMS026). 261 262 A log record shall be added as an entry in the heCommonLogTable. 263 264 An heCommonAlarmEvent notification shall be sent." 265 266 ::= { heOpAmpLaserEntry 4 } 267 268heOpAmpLaserTECCurrent OBJECT-TYPE 269 SYNTAX HeMilliAmp 270 UNITS "1.0 mA" 271 MAX-ACCESS read-only 272 STATUS current 273 DESCRIPTION 274 "Laser Thermo Electric Cooler current. 275 This object must provide for the alarm management capabilities 276 with a corresponding entry in the propertyTable of 277 SCTE-HMS-PROPERTY-MIB (HMS026). 278 279 An alarm shall be recorded as an entry in the currentAlarmTable 280 of SCTE-HMS-PROPERTY-MIB (HMS026). 281 282 A log record shall be added as an entry in the heCommonLogTable. 283 284 An heCommonAlarmEvent notification shall be sent." 285 ::= { heOpAmpLaserEntry 5 } 286 287heOpAmpLaserType OBJECT-TYPE 288 SYNTAX HeLaserType 289 MAX-ACCESS read-only 290 STATUS current 291 DESCRIPTION 292 "Laser type." 293 ::= { heOpAmpLaserEntry 6 } 294 295 296-- The Optical Amplifier Output Table 297heOpAmpOutputTable OBJECT-TYPE 298 SYNTAX SEQUENCE OF HeOpAmpOutputEntry 299 MAX-ACCESS not-accessible 300 STATUS current 301 DESCRIPTION 302 "A table containing information about amplifier's outputs." 303 ::= { heOpAmpMIBObjects 4 } 304 305heOpAmpOutputEntry OBJECT-TYPE 306 SYNTAX HeOpAmpOutputEntry 307 MAX-ACCESS not-accessible 308 STATUS current 309 DESCRIPTION 310 "A list of information about each output in 311 the particular amplifier." 312 INDEX { entPhysicalIndex, heOpAmpOutputIndex } 313 ::= { heOpAmpOutputTable 1 } 314 315HeOpAmpOutputEntry ::= SEQUENCE 316{ 317 heOpAmpOutputIndex Unsigned32, 318 heOpAmpSetOpticalOutputPower HeTenthdBm, 319 heOpAmpGainPerWavelength HeTenthdB, 320 heOpAmpOutputPower HeTenthdBm, 321 heOpAmpOutputGainType INTEGER 322} 323 324heOpAmpOutputIndex OBJECT-TYPE 325 SYNTAX Unsigned32 326 MAX-ACCESS not-accessible 327 STATUS current 328 DESCRIPTION 329 "An arbitrary value which uniquely identifies the output." 330 ::= { heOpAmpOutputEntry 1 } 331 332heOpAmpSetOpticalOutputPower OBJECT-TYPE 333 SYNTAX HeTenthdBm 334 UNITS "0.1 dBm" 335 MAX-ACCESS read-write 336 STATUS current 337 DESCRIPTION 338 "Set Amplifier Optical Output Power. The setting of this 339 value has no effect unless the heOpAmpOutputGainType is 340 set to constantPower(1)" 341 ::= {heOpAmpOutputEntry 2 } 342 343heOpAmpGainPerWavelength OBJECT-TYPE 344 SYNTAX HeTenthdB 345 UNITS "0.1 dBm" 346 MAX-ACCESS read-write 347 STATUS current 348 DESCRIPTION 349 "Controls constant gain per wavelength. The setting of this 350 value has no effect unless the heOpAmpOutputGainType is 351 set to constantGain(2)" 352 ::= {heOpAmpOutputEntry 3 } 353 354heOpAmpOutputPower OBJECT-TYPE 355 SYNTAX HeTenthdBm 356 UNITS "0.1 dBm" 357 MAX-ACCESS read-only 358 STATUS current 359 DESCRIPTION 360 "The output power. This could be the power from a single output 361 or the output power from each of multiple outputs. 362 363 This object must provide for the alarm management capabilities 364 with a corresponding entry in the PropertyTable of 365 SCTE-HMS-PROPERTY-MIB (HMS026). 366 367 An alarm shall be recorded as an entry in the currentAlarmTable 368 of SCTE-HMS-PROPERTY-MIB (HMS026). 369 370 A log record shall be added as an entry in the heCommonLogTable. 371 372 An heCommonAlarmEvent notification shall be sent." 373 374 ::= { heOpAmpOutputEntry 4 } 375 376heOpAmpOutputGainType OBJECT-TYPE 377 SYNTAX INTEGER { 378 constantPower(1), 379 constantGain(2) 380 } 381 MAX-ACCESS read-write 382 STATUS current 383 DESCRIPTION 384 "Controls the output gain type, which is either constant 385 power or constant gain. When constantGain is selected, 386 the value of heOpAmpGainPerWavelength is used to control 387 the output of the amplifier and heOpAmpSetOpticalOutputPower 388 will have no effect. When constantPower is selected, 389 heOpAmpSetOpticalOutputPower is used to control the output 390 of the amplifier and heOpAmpGainPerWavelength will have no 391 effect " 392 ::= { heOpAmpOutputEntry 5 } 393 394-- conformance information 395heOpAmpMIBConformance 396 OBJECT IDENTIFIER ::= { heOpticalAmplifierMIB 2 } 397 398heOpAmpMIBCompliances 399 OBJECT IDENTIFIER ::= { heOpAmpMIBConformance 1 } 400 401heOpAmpMIBGroups 402 OBJECT IDENTIFIER ::= { heOpAmpMIBConformance 2 } 403 404-- compliance statements 405heOpAmpCompliance MODULE-COMPLIANCE 406 STATUS current 407 DESCRIPTION 408 "The minimum compliance statement for indoor optical amplifiers." 409 MODULE -- this module 410 MANDATORY-GROUPS { heOpAmpUnitMandatoryGroup, 411 heOpAmpInputMandatoryGroup, 412 heOpAmpOutputMandatoryGroup 413 } 414 GROUP heOpAmpUnitTableGroup 415 DESCRIPTION 416 "this is an unconditionally optional group" 417 GROUP heOpAmpInputTableGroup 418 DESCRIPTION 419 "this is an unconditionally optional group" 420 GROUP heOpAmpLaserTableGroup 421 DESCRIPTION 422 "this is an unconditionally optional group" 423 GROUP heOpAmpOutputTableGroup 424 DESCRIPTION 425 "this is an unconditionally optional group" 426 ::= { heOpAmpMIBCompliances 1 } 427 428heOpAmpUnitMandatoryGroup OBJECT-GROUP 429 OBJECTS { 430 heOpAmpUnitOutputStatus 431 } 432 STATUS current 433 DESCRIPTION 434 "The main group defines objects which are common to all 435 indoor optical amplifier modules." 436 ::= { heOpAmpMIBGroups 1 } 437 438heOpAmpInputMandatoryGroup OBJECT-GROUP 439 OBJECTS { 440 heOpAmpInputPower 441 } 442 STATUS current 443 DESCRIPTION 444 "The input group defines objects which are common to all 445 indoor optical amplifier modules." 446 ::= { heOpAmpMIBGroups 2 } 447 448heOpAmpOutputMandatoryGroup OBJECT-GROUP 449 OBJECTS { 450 heOpAmpOutputPower 451 } 452 STATUS current 453 DESCRIPTION 454 "The output group defines objects which are common to all 455 indoor optical amplifier modules." 456 ::= { heOpAmpMIBGroups 3 } 457 458heOpAmpUnitTableGroup OBJECT-GROUP 459 OBJECTS { 460 heOpAmpUnitOutputStatus, 461 heOpAmpUnitOnOffControl 462 } 463 STATUS current 464 DESCRIPTION 465 "The unit group defines objects which are defined 466 in the SCTE-HMS-HE-OPTICAL-amplifier-MIB MIB module." 467 ::= { heOpAmpMIBGroups 4 } 468 469heOpAmpInputTableGroup OBJECT-GROUP 470 OBJECTS { 471 heOpAmpInputPower 472 } 473 STATUS current 474 DESCRIPTION 475 "The input group defines optical objects which are defined 476 in the SCTE-HMS-HE-OPTICAL-amplifier-MIB MIB module." 477 ::= { heOpAmpMIBGroups 5 } 478 479heOpAmpLaserTableGroup OBJECT-GROUP 480 OBJECTS { 481 heOpAmpLaserTemp, 482 heOpAmpLaserBiasCurrent, 483 heOpAmpLaserOutputPower, 484 heOpAmpLaserTECCurrent, 485 heOpAmpLaserType 486 } 487 STATUS current 488 DESCRIPTION 489 "The laser group defines laser objects which are defined 490 in the SCTE-HMS-HE-OPTICAL-amplifier-MIB MIB module." 491 ::= { heOpAmpMIBGroups 6 } 492 493heOpAmpOutputTableGroup OBJECT-GROUP 494 OBJECTS { 495 heOpAmpSetOpticalOutputPower, 496 heOpAmpGainPerWavelength, 497 heOpAmpOutputPower, 498 heOpAmpOutputGainType 499 } 500 STATUS current 501 DESCRIPTION 502 "The output group defines amplifier output objects which are defined 503 in the SCTE-HMS-HE-OPTICAL-amplifier-MIB MIB module." 504 ::= { heOpAmpMIBGroups 7 } 505END 506