1-- ***************************************************************** 2-- CISCO-WAN-T38-FAXRELAY-MIB.my: CISCO WAN T38 FAXRELAY MIB file 3-- 4-- February 2004, George Ogagan 5-- 6-- Copyright (c) 1999, 2000, 2001, 2002, 2003, 2004 by 7-- Cisco Systems, Inc. 8-- All rights reserved. 9-- 10-- 11-- ***************************************************************** 12 13 14 15CISCO-WAN-T38-FAXRELAY-MIB DEFINITIONS ::= BEGIN 16 17IMPORTS 18 MODULE-IDENTITY, 19 OBJECT-TYPE, 20 Integer32 21 FROM SNMPv2-SMI 22 23 MODULE-COMPLIANCE, 24 OBJECT-GROUP 25 FROM SNMPv2-CONF 26 27 ciscoWan FROM CISCOWAN-SMI; 28 29ciscoWanT38FaxRelayMIB MODULE-IDENTITY 30 LAST-UPDATED "200402190000Z" 31 ORGANIZATION "Cisco Systems, Inc." 32 CONTACT-INFO 33 " Cisco Systems 34 Customer Service 35 36 Postal: 170 W Tasman Drive 37 San Jose, CA 95134 38 USA 39 40 Tel: +1 800 553-NETS 41 42 E-mail: cs-voice@cisco.com" 43 44 DESCRIPTION 45 "The MIB module for configuring T.38 fax relay 46 protocol parameters. This MIB will be used in 47 VoIP(Voice over IP) applications. 48 " 49 50 REVISION "200402190000Z" 51 DESCRIPTION 52 "Update descriptions in the MIB." 53 54 55 REVISION "200206010000Z" 56 DESCRIPTION 57 "Added new object t38T30ECM. 58 changed t38Redundancy status from current 59 to deprecated. 60 " 61 62 REVISION "200204121500Z" 63 DESCRIPTION 64 "Added new varbind t38Redundancy into 65 t38FaxRelayGrpTable, changed the default 66 value for t38HsDataPacketSize. 67 " 68 69 ::= { ciscoWan 19 } 70 71ciscoWanT38FaxRelayMIBObjects OBJECT IDENTIFIER ::= 72 { ciscoWanT38FaxRelayMIB 1 } 73 74t38FaxRelayGrp OBJECT IDENTIFIER ::= 75 { ciscoWanT38FaxRelayMIBObjects 1 } 76 77t38FaxRelayGrpTable OBJECT-TYPE 78 SYNTAX SEQUENCE OF T38FaxRelayGrpEntry 79 MAX-ACCESS not-accessible 80 STATUS current 81 DESCRIPTION 82 "This table contains configuration information 83 about various fax relay parameters used in 84 VoIP calls on voice interface. 85 " 86 ::= { t38FaxRelayGrp 1 } 87 88t38FaxRelayGrpEntry OBJECT-TYPE 89 SYNTAX T38FaxRelayGrpEntry 90 MAX-ACCESS not-accessible 91 STATUS current 92 DESCRIPTION 93 "An entry is created when a DS1 interface is 94 configured. An entry is deleted when a DS1 95 interface is removed. All configurations 96 information in an entry is applied to a VoIP 97 call when the VoIP call is placed on the DS1 98 interface. 99 " 100 INDEX { t38vismDs1Number } 101 ::= { t38FaxRelayGrpTable 1 } 102 103T38FaxRelayGrpEntry ::= 104 SEQUENCE { 105 t38vismDs1Number Integer32, 106 t38MaxFaxTxRate INTEGER, 107 t38FaxInfoFieldSize Integer32, 108 t38HsDataPacketSize INTEGER, 109 t38LsDataRedundancy Integer32, 110 t38HsDataRedundancy Integer32, 111 t38TCFmethod INTEGER, 112 t38ErrCorrection INTEGER, 113 t38NSFOverride INTEGER, 114 t38NSFCountryCode Integer32, 115 t38NSFVendorCode Integer32, 116 t38NseAckTimeOut Integer32, 117 t38FxLCO INTEGER, 118 t38Redundancy INTEGER, 119 t38T30ECM INTEGER 120 } 121 122t38vismDs1Number OBJECT-TYPE 123 SYNTAX Integer32 (1..2147483647) 124 MAX-ACCESS not-accessible 125 STATUS current 126 DESCRIPTION 127 "This object identifies the unique DS1 value for 128 a T1/E1 interface. 129 " 130 ::= { t38FaxRelayGrpEntry 1 } 131 132t38MaxFaxTxRate OBJECT-TYPE 133 SYNTAX INTEGER { 134 fx2400bps (1), 135 fx4800bps (2), 136 fx7200bps (3), 137 fx9600bps (4), 138 fx12000bps (5), 139 fx14400bps (6) 140 } 141 MAX-ACCESS read-write 142 STATUS current 143 DESCRIPTION 144 "This object is used for configuring the maximum fax 145 transmission rate. 146 147 'fx2400bps' - maximum transmission rate in 2400 bps. 148 'fx4800bps' - maximum transmission rate in 4800 bps. 149 'fx7200bps' - maximum transmission rate in 7200 bps. 150 'fx9600bps' - maximum transmission rate in 9600 bps. 151 'fx12000bps' - maximum transmission rate in 12000 bps. 152 'fx14400bps' - maximum transmission rate in 14400 bps. 153 " 154 DEFVAL { fx14400bps } 155 ::= {t38FaxRelayGrpEntry 2} 156 157t38FaxInfoFieldSize OBJECT-TYPE 158 SYNTAX Integer32 (0..2147483647) 159 MAX-ACCESS read-write 160 STATUS deprecated 161 DESCRIPTION 162 "This object is used to configure the fax information 163 field size in bytes. 164 " 165 DEFVAL { 48 } 166 ::= {t38FaxRelayGrpEntry 3} 167 168 169t38HsDataPacketSize OBJECT-TYPE 170 SYNTAX INTEGER { 171 tenms (10), 172 twentyms (20), 173 thirtyms (30), 174 fortyms (40) 175 } 176 MAX-ACCESS read-write 177 STATUS current 178 DESCRIPTION 179 "This object specifies the size of primary high speed(HS) 180 - the data packet transmitted after the first phase of a T.38 181 call. 182 183 'tenms' - size of the HS in 10 millisecond. 184 'twentyms' - size of the HS in 20 millisecond. 185 'thirtyms' - size of the HS in 30 millisecond. 186 'fortyms' - size of the HS in 40 millisecond. 187 " 188 DEFVAL { thirtyms } 189 ::= {t38FaxRelayGrpEntry 4} 190 191t38LsDataRedundancy OBJECT-TYPE 192 SYNTAX Integer32 (0..2147483647) 193 MAX-ACCESS read-write 194 STATUS current 195 DESCRIPTION 196 "This object determines the extent of the internet fax 197 protocol(IFP) packet transmission redundancy for the 198 low-speed control information exchanged during the 199 first phase of a T.38 fax relay connection. 200 201 Depending on whether forward error correction(FEC) 202 is enabled via the t38ErrorCorrection object, 203 t38LsDataRedundancy has different meaning. 204 205 If FEC is disabled, then t38LsDataRedundancy is the 206 maximum number of prior IFP packets within an unnumbered 207 datagram protocol transport layer (UDPTL) packet carrying 208 low speed information, not counting the primary or current 209 IFP packet. 210 211 If FEC is enabled, then t38LsDataRedundancy is the maximum 212 number of FEC messages within a UDPTL packet carrying low 213 speed information. 214 " 215 DEFVAL { 5 } 216 ::= {t38FaxRelayGrpEntry 5} 217 218t38HsDataRedundancy OBJECT-TYPE 219 SYNTAX Integer32 (0..2147483647) 220 MAX-ACCESS read-write 221 STATUS current 222 DESCRIPTION 223 "This object determines the extent of the IFP packet 224 transmission redundancy for the high-speed control 225 and image information exchanged following the initial 226 low-speed phase of a T.38 fax relay connection. 227 228 Depending on whether FEC is enabled via the 229 t38ErrorCorrection object, t38HsDataRedundancy 230 has different meanings. 231 232 If FEC is disabled, then t38HsDataRedundancy is the 233 maximum number of prior IFP packets within a UDPTL packet 234 carrying high speed information, not counting the primary 235 or current IFP packet. 236 237 If FEC is enabled, then t38HsDataRedundancy is the 238 maximum number of FEC messages within a UDPTL packet 239 carrying high speed information. 240 " 241 DEFVAL { 0 } 242 ::= {t38FaxRelayGrpEntry 6} 243 244t38TCFmethod OBJECT-TYPE 245 SYNTAX INTEGER { 246 localTCF (1), 247 networkTCF (2) 248 } 249 MAX-ACCESS read-write 250 STATUS current 251 DESCRIPTION 252 "This object determines the method used to verify 253 the TCF(Training Check Field). 254 255 For UDP-based fax transport, its value should be set 256 to networkTCF. For TCP-based fax transport, its value 257 should be set to localTCF. A value of localTCF may be 258 used in rare circumstances for UDP-based fax transport. 259 260 A value of networkTCF implies that date rate management 261 is done end-to-end between the group 3 fax terminals, 262 in a manner similar to the PSTN(Public Switched 263 Telephone Network). In this case, the TCF training 264 signal is passed transparently by the IP network. 265 266 A value of localTCF implies that media gateways are actively 267 involved in the training and data rate management procedure, 268 including the generation of the TCF training signal. 269 Data rate management is done by one of the media gateways on 270 the basis of local results and results forwarded over the IP 271 network by the other gateway. The other gateway generates 272 the TCF training signal towards its group 3 fax terminal. 273 " 274 DEFVAL { networkTCF } 275 ::= {t38FaxRelayGrpEntry 7} 276 277t38ErrCorrection OBJECT-TYPE 278 SYNTAX INTEGER { 279 enabled (1), 280 disabled (2) 281 } 282 MAX-ACCESS read-write 283 STATUS deprecated 284 DESCRIPTION 285 "This object is used to enable/disable the FEC 286 scheme for UDP-based fax transport. 287 " 288 DEFVAL { enabled } 289 ::= {t38FaxRelayGrpEntry 8} 290 291t38NSFOverride OBJECT-TYPE 292 SYNTAX INTEGER { 293 enabled (1), 294 disabled (2) 295 } 296 MAX-ACCESS read-write 297 STATUS current 298 DESCRIPTION 299 "This object is used to enable/disable the gateway to 300 override the NSF(Non-Standard Facilities) code in the 301 following T.30 signals: NSF, NSC (Non-Standard Facilities 302 Command) and NSS (Non-Standard Facilities Set-up). The 303 NSF code is overridden to prevent the group 3 fax 304 machines from synchronizing with each other on the basis 305 of a protocol other the ITU T-series recommendations. 306 If this proprietary synchronization is prevented, the 307 group 3 fax machines will synchronize to the standard 308 T-series protocol. This action is necessary if the fax 309 relay capability of the media gateway is limited 310 to the T-series recommendations. As defined in T.35, the NSF 311 code consists of a one-byte Country Code, a two-byte 312 Terminal Provider Code (also called the Vendor Code), and a 313 variable-length (up to 255 bytes) Terminal Provider-Oriented 314 Code. If t38NSFOverride is enabled, the Country Code and 315 Terminal Provider Code are overridden with the values of the 316 t38NSFCountryCode and t38NSFVendorCode respectively, while 317 the Terminal Provider-Oriented Code (which is a bit-map of 318 manufacturer-specific capabilities) is set to all-zeros. 319 " 320 DEFVAL { enabled } 321 ::= {t38FaxRelayGrpEntry 9} 322 323t38NSFCountryCode OBJECT-TYPE 324 SYNTAX Integer32 (0..65535) 325 MAX-ACCESS read-write 326 STATUS current 327 DESCRIPTION 328 "The Country Code in the NSF code is a 329 single-byte field identifying the country where 330 the group 3 fax equipment with non-standard 331 capabilities were manufactured. 332 333 There are un ratified proposals on the table to extend 334 this to a two-byte field. If the fax relay capability of the 335 gateway is limited to the ITU T-series protocol, the value 336 of the t38NSFCountryCode object is to be written into the 337 Country Code field to preclude non-standard synchronization 338 of the group 3 faxs terminals. 339 Since a value of 0x00 refers to Japan, and a value of 0xFF 340 is a Country Code extension mechanism, these cannot be used 341 to disable non-standard synchronization. 342 343 The t38NSFCountryCode value used to override NSF-based 344 synchronization is 0xAD (173). 345 If the Country Code is extended to two bytes in the future, 346 the second byte will be set to 0x00. In conjunction with 347 this Country Code, a t38NSFVendorCode value of 0x0051 348 is used for NSF suppression. It is not possible to use a 349 value of 0x0000 for this suppression since it refers to 350 Compression Labs. 351 To realize NSF suppression, all bytes in the Terminal 352 Provider-Oriented Code field, which describes the 353 manufacturer-specific capabilities, are set to zeros. 354 " 355 REFERENCE 356 "Per ITU T.35 section 3.1 357 " 358 359 DEFVAL { 173 } 360 ::= {t38FaxRelayGrpEntry 10} 361 362t38NSFVendorCode OBJECT-TYPE 363 SYNTAX Integer32 (0..65535) 364 MAX-ACCESS read-write 365 STATUS current 366 DESCRIPTION 367 "The Vendor Code (also called the Terminal 368 Provider Code) in the NSF code is a two-byte 369 field identifying the manufacturer of the group 370 3 fax equipment with non-standard capabilities. 371 372 If the fax relay capability of the gateway is limited to 373 the ITU T-series protocol, the value of the t38NSFVendorCode 374 object is to be written into the Vendor Code 375 (Terminal Provider Code) field to preclude non-standard 376 synchronization of the group 3 fax terminals. 377 378 Since a value of 0x0000 refers to Compression Labs, it 379 cannot be used to disable non-standard synchronization. 380 The t38NSFVendorCode value used to override NSF-based 381 synchronization is 0x0051 (81). 382 To realize NSF suppression, this is used in conjunction with 383 the appropriate Country Code referring to the United States, 384 and in conjunction with the setting of all bytes in the 385 Terminal Provider-Oriented Code field, which describes the 386 manufacturer-specific capabilities, to zeros. 387 " 388 REFERENCE 389 "Per ITU T.35 section 3.2 390 " 391 392 DEFVAL { 81 } 393 ::= {t38FaxRelayGrpEntry 11} 394 395t38NseAckTimeOut OBJECT-TYPE 396 SYNTAX Integer32 (250..10000) 397 UNITS "milliseconds" 398 MAX-ACCESS read-write 399 STATUS current 400 DESCRIPTION 401 "This object defines a timeout value in milliseconds for a 402 provision able timer. This timer is started after sending a 403 NSE(Named Signal Event) 200 while waiting for the NSE 201 404 acknowledgement or NSE 202 negative acknowledgement. 405 Expiration of the response timer will indicate that the 406 request to switch to T.38 has been rejected or discarded 407 by the far end. 408 409 The default value is 1 second (1000 ms) and this value 410 can only be set in the increments of 250 ms. 411 " 412 DEFVAL { 1000 } 413 ::= {t38FaxRelayGrpEntry 12} 414 415t38FxLCO OBJECT-TYPE 416 SYNTAX INTEGER { 417 gwAndPt (1), 418 gw (2), 419 ptAndGw (3), 420 pt (4), 421 off (5) 422 } 423 MAX-ACCESS read-write 424 STATUS current 425 DESCRIPTION 426 "This object is a configurable default value for the 427 fx(fax option) in LCO(Local Connection Option). In 428 the absence of the MGCP fx LCO, this default value 429 will be used. The MGCP fx LCO will always override 430 this object. 431 432 The meanings of these enumerated types are: 433 'gwAndPt': means gateway controlled fax relay is preferred 434 over fax pass through. 435 'gw': means gateway controlled fax relay (using NSEs). 436 'ptAndGw': means fax pass through is preferred over gateway 437 controlled fax relay. 438 'pt': means fax pass through. 439 'off': means Do not do gateway controlled T.38 fax relay. 440 441 This does not preclude upspeeding or alteration of silence 442 suppression or echo cancellation settings for the 443 connection. 444 " 445 DEFVAL { gwAndPt } 446 ::= {t38FaxRelayGrpEntry 13} 447 448t38Redundancy OBJECT-TYPE 449 SYNTAX INTEGER { 450 enabled (1), 451 disabled (2) 452 } 453 MAX-ACCESS read-write 454 STATUS deprecated 455 DESCRIPTION 456 "This object is used to enable/disable the Redundancy 457 scheme for UDP-based fax transport. 458 " 459 DEFVAL { enabled } 460 ::= {t38FaxRelayGrpEntry 14} 461 462t38T30ECM OBJECT-TYPE 463 SYNTAX INTEGER { 464 enabled (1), 465 disabled (2) 466 } 467 MAX-ACCESS read-write 468 STATUS current 469 DESCRIPTION 470 "This object is used to enable/disable T.30 471 Error Correcting Mode(ECM). ECM is a feature 472 implemented by many new fax devices which 473 improves image quality and page compression 474 capabilities through a reliable image data 475 transmission protocol -- ECM. If fax calls 476 are failing due to high packet loss then disabling 477 T.30 ECM may improve the success rate. 478 " 479 DEFVAL { enabled } 480 ::= {t38FaxRelayGrpEntry 15} 481 482-- ***************************************************************** 483-- t38 Fax Relay group notification 484-- ***************************************************************** 485 486t38NotificationPrefix OBJECT IDENTIFIER ::= 487 { ciscoWanT38FaxRelayMIB 2 } 488 489t38Notifications OBJECT IDENTIFIER ::= 490 { t38NotificationPrefix 0 } 491 492 493-- ********************************************************************** 494-- Conformance 495-- ********************************************************************** 496 497-- 498-- conformance information 499-- 500 501t38FaxRelayMIBConformance OBJECT IDENTIFIER ::= 502 { ciscoWanT38FaxRelayMIB 3 } 503 504 505t38FaxRelayMIBCompliances OBJECT IDENTIFIER ::= 506 { t38FaxRelayMIBConformance 1 } 507 508t38FaxRelayMIBGroups OBJECT IDENTIFIER ::= 509 { t38FaxRelayMIBConformance 2 } 510 511 512-- 513-- Conformance and compliance statements statements 514-- 515 516t38FaxRelayMIBCompliance MODULE-COMPLIANCE 517 STATUS deprecated -- replaced by t38FaxRelayMIBComplianceRev1 518 DESCRIPTION 519 "The compliance statement for t38 fax relay 520 group which implement t38FaxRelayGrp MIB. 521 " 522 MODULE -- this module 523 MANDATORY-GROUPS { t38FaxRelayGroup 524 } 525 ::= { t38FaxRelayMIBCompliances 1 } 526 527t38FaxRelayMIBComplianceRev1 MODULE-COMPLIANCE 528 STATUS current 529 DESCRIPTION 530 "The compliance statement for t38 fax relay 531 group which implement t38FaxRelayGrp MIB. 532 " 533 MODULE -- this module 534 MANDATORY-GROUPS { t38FaxRelayGroupRev1 535 } 536 ::= { t38FaxRelayMIBCompliances 2 } 537 538-- 539-- units of conformance 540-- 541-- MIB Groups 542-- 543 544t38FaxRelayGroup OBJECT-GROUP 545 OBJECTS { 546 t38MaxFaxTxRate, 547 t38FaxInfoFieldSize, 548 t38HsDataPacketSize, 549 t38LsDataRedundancy, 550 t38HsDataRedundancy, 551 t38TCFmethod, 552 t38ErrCorrection, 553 t38NSFOverride, 554 t38NSFCountryCode, 555 t38NSFVendorCode, 556 t38NseAckTimeOut, 557 t38FxLCO, 558 t38Redundancy, 559 t38T30ECM 560 } 561 STATUS deprecated 562 DESCRIPTION 563 "This group contains objects related to 564 configuration of T38 fax relay. 565 " 566 ::= { t38FaxRelayMIBGroups 1 } 567 568 569t38FaxRelayGroupRev1 OBJECT-GROUP 570 OBJECTS { 571 t38MaxFaxTxRate, 572 t38HsDataPacketSize, 573 t38LsDataRedundancy, 574 t38HsDataRedundancy, 575 t38TCFmethod, 576 t38NSFOverride, 577 t38NSFCountryCode, 578 t38NSFVendorCode, 579 t38NseAckTimeOut, 580 t38FxLCO, 581 t38T30ECM 582 } 583 STATUS current 584 DESCRIPTION 585 "The collection of objects that were 586 supported earlier but deprecated now. 587 " 588 ::= { t38FaxRelayMIBGroups 2 } 589 590 591END 592 593