1-- ***************************************************************** 2-- CISCO-VOICE-IF-MIB.my: Voice Interface MIB file 3-- 4-- September 1996 Hongchi Shih 5-- 6-- Copyright (c) 1996-1998, 1999, 2001, 2002 by cisco Systems, Inc. 7-- All rights reserved. 8-- ***************************************************************** 9 10CISCO-VOICE-IF-MIB DEFINITIONS ::= BEGIN 11 12IMPORTS 13 MODULE-IDENTITY, 14 OBJECT-TYPE, 15 Integer32 16 FROM SNMPv2-SMI 17 TruthValue, 18 DisplayString 19 FROM SNMPv2-TC 20 MODULE-COMPLIANCE, 21 OBJECT-GROUP 22 FROM SNMPv2-CONF 23 ifIndex 24 FROM IF-MIB 25 CountryCode 26 FROM CISCO-TC 27 ciscoMgmt 28 FROM CISCO-SMI; 29 30 31ciscoVoiceInterfaceMIB MODULE-IDENTITY 32 LAST-UPDATED "200307180000Z" 33 ORGANIZATION "Cisco Systems, Inc." 34 CONTACT-INFO 35 " Cisco Systems 36 Customer Service 37 38 Postal: 170 W. Tasman Drive 39 San Jose, CA 95134 40 USA 41 42 Tel: +1 800 553-NETS 43 44 E-mail: cs-voice@cisco.com" 45 DESCRIPTION 46 "Common Voice Interface MIB module. 47 The MIB module manages the common voice related 48 parameters for both voice analog and ISDN interfaces. 49 " 50 REVISION "200307180000Z" 51 DESCRIPTION 52 "Add new value (tieline (4)) for the object 53 cvIfCfgConnectionMode 54 " 55 REVISION "200103080000Z" 56 DESCRIPTION 57 "Add new object and values for handling the following features: 58 [1] New echo canceller coverage values. 59 [2] Echo canceller worst-case Echo Return Loss in cvIfCfgEntry. 60 [3] Echo canceller identity in cvIfCfgEntry. 61 " 62 ::= { ciscoMgmt 64 } 63 64 65 66 67-- Common Voice Interface MIB objects definitions 68 69cvIfObjects OBJECT IDENTIFIER ::= { ciscoVoiceInterfaceMIB 1 } 70cvIfCfgObjects OBJECT IDENTIFIER ::= { cvIfObjects 1 } 71 72 73-- 74-- Voice interface Layering model and ifStack usage 75-- 76-- Refer to section 2.2.1 of RFC2128 for Layering model and ifStack 77-- usage 78-- 79 80-- 81-- Voice interface Common Configuration Group 82-- 83-- This group contains the common voice related configuration variables 84-- that are used by both analog and digital telephony interfaces 85-- 86 87-- 88-- Voice Common Configuration Table 89-- 90cvIfCfgTable OBJECT-TYPE 91 SYNTAX SEQUENCE OF CvIfCfgEntry 92 MAX-ACCESS not-accessible 93 STATUS current 94 DESCRIPTION 95 "The Voice Common Configuration Table. It contains 96 information about the voice related configuration 97 parameters for both analog and digital telephony 98 interfaces. 99 " 100 ::= { cvIfCfgObjects 1 } 101 102cvIfCfgEntry OBJECT-TYPE 103 SYNTAX CvIfCfgEntry 104 MAX-ACCESS not-accessible 105 STATUS current 106 DESCRIPTION 107 "An entry in the configuration table for each voice analog 108 interface or voice feature associated ISDN D channel. 109 The entry is automatically created when a voice analog 110 interface hardware is found or ISDN D channel is 111 configured and the ISDN associated voice support hardware 112 is detected by the managed system. 113 For the ISDN D channel associated entry, the entry 114 is deleted after ISDN D channel is removed. 115 " 116 INDEX { ifIndex } 117 ::= { cvIfCfgTable 1 } 118 119CvIfCfgEntry ::= 120 SEQUENCE { 121 cvIfCfgNoiseRegEnable TruthValue, 122 cvIfCfgNonLinearProcEnable TruthValue, 123 cvIfCfgMusicOnHoldThreshold Integer32, 124 cvIfCfgInGain Integer32, 125 cvIfCfgOutAttn Integer32, 126 cvIfCfgEchoCancelEnable TruthValue, 127 cvIfCfgEchoCancelCoverage INTEGER, 128 cvIfCfgConnectionMode INTEGER, 129 cvIfCfgConnectionNumber DisplayString, 130 cvIfCfgInitialDigitTimeOut Integer32, 131 cvIfCfgInterDigitTimeOut Integer32, 132 cvIfCfgRegionalTone CountryCode, 133 cvIfCfgEchoCancelWorstERL INTEGER, 134 cvIfCfgEchoCanceller INTEGER 135 } 136 137cvIfCfgNoiseRegEnable OBJECT-TYPE 138 SYNTAX TruthValue 139 MAX-ACCESS read-write 140 STATUS current 141 DESCRIPTION 142 "The object indicates whether or not the background noise 143 should be played to fill silence gaps if VAD is 144 activated. 145 The default value of this object is enabled. 146 " 147 ::= { cvIfCfgEntry 1 } 148 149 150cvIfCfgNonLinearProcEnable OBJECT-TYPE 151 SYNTAX TruthValue 152 MAX-ACCESS read-write 153 STATUS current 154 DESCRIPTION 155 "The object indicates whether or not the Nonlinear 156 Processing is enabled for the interface. 157 The default value of this object is enabled. 158 " 159 ::= { cvIfCfgEntry 2 } 160 161cvIfCfgMusicOnHoldThreshold OBJECT-TYPE 162 SYNTAX Integer32 (-70..-30) 163 UNITS "dBm" 164 MAX-ACCESS read-write 165 STATUS current 166 DESCRIPTION 167 "The object specifies the Music On Hold Threshold for 168 the interface. 169 The default value of this object is -38 dBm. 170 " 171 ::= { cvIfCfgEntry 3 } 172 173 174cvIfCfgInGain OBJECT-TYPE 175 SYNTAX Integer32 (-6..14) 176 UNITS "dB" 177 MAX-ACCESS read-write 178 STATUS current 179 DESCRIPTION 180 "This object contains the amount of gain inserted at the 181 receiver side of the interface. The input gain settings 182 only define a gain/loss relative to the 0 dB setting. 183 The absolute loss at the 0 dB setting could be 184 implementation dependent based on the desired network 185 loss plan. 186 The default value of this object is 0 dB (decibel). 187 " 188 ::= { cvIfCfgEntry 4 } 189 190cvIfCfgOutAttn OBJECT-TYPE 191 SYNTAX Integer32 (0..14) 192 UNITS "dB" 193 MAX-ACCESS read-write 194 STATUS current 195 DESCRIPTION 196 "This object contains the amount of attenuation inserted 197 at the transmit side of the interface. 198 The output attenuation settings only define a loss 199 relative to the 0 dB setting. 200 The absolute loss at the 0 dB setting could be 201 implementation dependent based on the desired network 202 loss plan. 203 The default value of this object is 0 dB (decibel). 204 " 205 ::= { cvIfCfgEntry 5 } 206 207cvIfCfgEchoCancelEnable OBJECT-TYPE 208 SYNTAX TruthValue 209 MAX-ACCESS read-write 210 STATUS current 211 DESCRIPTION 212 "The object specifies whether or not the Echo Cancellation 213 is enabled for the interface. 214 The default value of this object is enabled. 215 " 216 ::= { cvIfCfgEntry 6 } 217 218cvIfCfgEchoCancelCoverage OBJECT-TYPE 219 SYNTAX INTEGER { 220 echoCanceller16ms (1), 221 echoCanceller24ms (2), 222 echoCanceller32ms (3), 223 echoCanceller8ms (4), 224 echoCanceller48ms (5), 225 echoCanceller64ms (6), 226 echoCanceller80ms (7), 227 echoCanceller96ms (8), 228 echoCanceller112ms (9), 229 echoCanceller128ms (10) 230 } 231 MAX-ACCESS read-write 232 STATUS current 233 DESCRIPTION 234 "The object specifies the Echo Canceller coverage for 235 the interface. This object is valid if the 236 cvIfCfgEchoCancelEnable object is 'true'. 237 echoCanceller8ms - 8 millisecs echo canceller coverage. 238 echoCanceller16ms - 16 millisecs echo canceller coverage. 239 echoCanceller24ms - 24 millisecs echo canceller coverage. 240 echoCanceller32ms - 32 millisecs echo canceller coverage. 241 echoCanceller48ms - 48 millisecs echo canceller coverage. 242 echoCanceller64ms - 64 millisecs echo canceller coverage. 243 echoCanceller80ms - 80 millisecs echo canceller coverage. 244 echoCanceller96ms - 96 millisecs echo canceller coverage. 245 echoCanceller112ms - 112 millisecs echo canceller coverage. 246 echoCanceller128ms - 128 millisecs echo canceller coverage. 247 The default value of this object is echoCanceller8ms or 248 echoCanceller64ms, depending on the particular echo 249 canceller. 250 " 251 ::= { cvIfCfgEntry 7 } 252 253cvIfCfgConnectionMode OBJECT-TYPE 254 SYNTAX INTEGER { 255 normal (1), 256 trunk (2), 257 plar (3), 258 tieline (4) 259 } 260 MAX-ACCESS read-write 261 STATUS current 262 DESCRIPTION 263 "The object indicates the connection mode of the interface. 264 normal - the interface acts normally to handle incoming 265 and outgoing call. 266 trunk - the interface acts in trunking mode. trunking mode 267 causes two interfaces (on either the same or 268 different routers) to be always conferenced 269 together, and for telephony signaling to be passed 270 transparently through the VoIP system rather than 271 trapped and interpreted by the session application 272 on the router(s). 273 plar - the interface acts in PLAR (private line automatic 274 ringdown) mode. PLAR is handled by associating a 275 peer directly with an interface such that when the 276 interface goes off-hook, that peer is used to 277 setup the second call leg and conference them 278 together without the caller having to dial any 279 digits. 280 tieline- the interface acts in tie-line mode. This 281 specifies a connection that emulates a temporary 282 tie-line trunk to a PBX. A tie-line connection is 283 automatically set up for each call and torn down 284 when the call ends. 285 " 286 ::= { cvIfCfgEntry 8 } 287 288cvIfCfgConnectionNumber OBJECT-TYPE 289 SYNTAX DisplayString (SIZE (0..32)) 290 MAX-ACCESS read-write 291 STATUS current 292 DESCRIPTION 293 "This is the E.164 phone number that is used to 294 establish connection with trunking mode or PLAR mode. 295 If the cvIfCfgConnectionMode is 'normal', then this 296 object will be a zero length string. 297 " 298 ::= { cvIfCfgEntry 9 } 299 300cvIfCfgInitialDigitTimeOut OBJECT-TYPE 301 SYNTAX Integer32 (0..120) 302 UNITS "seconds" 303 MAX-ACCESS read-write 304 STATUS current 305 DESCRIPTION 306 "This is the initial digit timeout that indicates the amount 307 of time the managed system waits for an initial input digit 308 from the caller. The timer is activated when the call is 309 accepted and is deactivated upon digit input. If the timer 310 expires, the caller is signaled through the appropriate 311 tone and the call is abandoned. The value of zero disables 312 the timer. 313 The default value of this object is 10 seconds. 314 " 315 ::= { cvIfCfgEntry 10 } 316 317cvIfCfgInterDigitTimeOut OBJECT-TYPE 318 SYNTAX Integer32 (0..120) 319 UNITS "seconds" 320 MAX-ACCESS read-write 321 STATUS current 322 DESCRIPTION 323 "This is the inter-digit timeout that indicates the amount 324 of time the managed system waits for a subsequent input 325 digit from the caller. The timer is started upon receipt 326 of an input digit and restarted as each digit is received 327 until the destination address is identified. If the timer 328 expires and no destination address is identified, the 329 caller is signaled through the appropriate tone and the 330 call is abandoned. The value of zero disables the timer. 331 The default value of this object is 10 seconds. 332 " 333 ::= { cvIfCfgEntry 11 } 334 335cvIfCfgRegionalTone OBJECT-TYPE 336 SYNTAX CountryCode 337 MAX-ACCESS read-write 338 STATUS current 339 DESCRIPTION 340 "This object contains the country specific setting 341 for the tone, ring, cadence parameters to be used by 342 this interface. 343 " 344 ::= { cvIfCfgEntry 12 } 345 346cvIfCfgEchoCancelWorstERL OBJECT-TYPE 347 SYNTAX INTEGER { 348 echoCancellerWorstERLUnknown (1), 349 echoCancellerWorstERL6dB (2), 350 echoCancellerWorstERL3dB (3), 351 echoCancellerWorstERL0dB (4) 352 } 353 MAX-ACCESS read-write 354 STATUS current 355 DESCRIPTION 356 "The object specifies the worst case Echo Return Loss for 357 which the echo canceller must operate. To some echo 358 cancellers this object may not apply. This object is 359 valid if the cvIfCfgEchoCancelEnable object is 'true'. 360 echoCancellerWorstERL6dB - 6 decibels worst case ERL. 361 echoCancellerWorstERL3dB - 3 decibels worst case ERL. 362 echoCancellerWorstERL0dB - 0 decibels worst case ERL. 363 echoCancellerWorstERLUnknown - the object does not apply 364 to this echo canceller. 365 The default value of this object is 366 echoCancellerWorstERL6dB unless 367 echoCancellerWorstERLUnknown is appropriate because 368 the echo canceller is not configurable by this object. 369 " 370 ::= { cvIfCfgEntry 13 } 371 372cvIfCfgEchoCanceller OBJECT-TYPE 373 SYNTAX INTEGER { 374 echoCancellerStandard (1), 375 echoCancellerExtended (2) 376 } 377 MAX-ACCESS read-only 378 STATUS current 379 DESCRIPTION 380 "The object specifies which echo canceller is present 381 on the interface. 382 echoCancellerStandard - for this echo canceller valid 383 values of cvIfCfgEchoCancelCoverage are echoCanceller8ms 384 through echoCanceller32ms; cvIfCfgEchoCancelWorstERL is 385 not valid. 386 echoCancellerExtended - for this echo canceller valid 387 values of cvIfCfgEchoCancelCoverage are echoCanceller24ms 388 through echoCanceller128ms; cvIfCfgEchoCancelWorstERL is 389 valid. 390 " 391 ::= { cvIfCfgEntry 14 } 392 393cvIfConformance OBJECT IDENTIFIER ::= 394 { ciscoVoiceInterfaceMIB 2 } 395cvIfCompliances OBJECT IDENTIFIER ::= 396 { cvIfConformance 1 } 397cvIfGroups OBJECT IDENTIFIER ::= 398 { cvIfConformance 2 } 399 400-- compliance statements 401 402cvIfCompliance MODULE-COMPLIANCE 403 STATUS current 404 DESCRIPTION 405 "The compliance statement for entities which 406 implement the Cisco Voice Interface MIB" 407 MODULE -- this module 408 MANDATORY-GROUPS 409 { cvIfGroup } 410 411 GROUP cvIfConnectionGroup 412 DESCRIPTION 413 "The cvIfConnectionGroup is mandatory only for 414 voice analog interfaces. 415 " 416 OBJECT cvIfCfgNoiseRegEnable 417 MIN-ACCESS read-only 418 DESCRIPTION 419 "Write access is not required." 420 421 OBJECT cvIfCfgNonLinearProcEnable 422 MIN-ACCESS read-only 423 DESCRIPTION 424 "Write access is not required." 425 426 OBJECT cvIfCfgMusicOnHoldThreshold 427 MIN-ACCESS read-only 428 DESCRIPTION 429 "Write access is not required." 430 431 OBJECT cvIfCfgInGain 432 MIN-ACCESS read-only 433 DESCRIPTION 434 "Write access is not required." 435 436 OBJECT cvIfCfgOutAttn 437 MIN-ACCESS read-only 438 DESCRIPTION 439 "Write access is not required." 440 441 OBJECT cvIfCfgEchoCancelEnable 442 MIN-ACCESS read-only 443 DESCRIPTION 444 "Write access is not required." 445 446 OBJECT cvIfCfgEchoCancelCoverage 447 MIN-ACCESS read-only 448 DESCRIPTION 449 "Write access is not required." 450 451 OBJECT cvIfCfgConnectionMode 452 MIN-ACCESS read-only 453 DESCRIPTION 454 "Write access is not required." 455 456 OBJECT cvIfCfgConnectionNumber 457 MIN-ACCESS read-only 458 DESCRIPTION 459 "Write access is not required." 460 461 OBJECT cvIfCfgInitialDigitTimeOut 462 MIN-ACCESS read-only 463 DESCRIPTION 464 "Write access is not required." 465 466 OBJECT cvIfCfgInterDigitTimeOut 467 MIN-ACCESS read-only 468 DESCRIPTION 469 "Write access is not required." 470 471 OBJECT cvIfCfgRegionalTone 472 MIN-ACCESS read-only 473 DESCRIPTION 474 "Write access is not required." 475 476 OBJECT cvIfCfgEchoCancelWorstERL 477 MIN-ACCESS read-only 478 DESCRIPTION 479 "Write access is not required." 480 481 ::= { cvIfCompliances 1 } 482 483-- units of conformance 484 485 486cvIfGroup OBJECT-GROUP 487 OBJECTS { 488 cvIfCfgNoiseRegEnable, 489 cvIfCfgNonLinearProcEnable , 490 cvIfCfgMusicOnHoldThreshold, 491 cvIfCfgInGain, 492 cvIfCfgOutAttn, 493 cvIfCfgEchoCancelEnable, 494 cvIfCfgEchoCancelCoverage, 495 cvIfCfgInitialDigitTimeOut, 496 cvIfCfgInterDigitTimeOut, 497 cvIfCfgRegionalTone, 498 cvIfCfgEchoCancelWorstERL, 499 cvIfCfgEchoCanceller 500 } 501 STATUS current 502 DESCRIPTION 503 "A collection of objects providing the Common Voice 504 parameter related configuration for both analog and 505 digital voice interfaces." 506 ::= { cvIfGroups 1 } 507 508cvIfConnectionGroup OBJECT-GROUP 509 OBJECTS { 510 cvIfCfgConnectionMode, 511 cvIfCfgConnectionNumber 512 } 513 STATUS current 514 DESCRIPTION 515 "A collection of objects providing trunking or PLAR 516 (private line automatic ringdown) related configuration 517 for voice analog interfaces. 518 " 519 ::= { cvIfGroups 2 } 520 521END 522