idnits 2.17.1 draft-ietf-megaco-mib-05.txt: -(69): Line appears to be too long, but this could be caused by non-ascii characters in UTF-8 encoding -(1482): Line appears to be too long, but this could be caused by non-ascii characters in UTF-8 encoding Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == There are 4 instances of lines with non-ascii characters in the document. == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** The document seems to lack an Authors' Addresses Section. ** There are 322 instances of too long lines in the document, the longest one being 13 characters in excess of 72. ** The abstract seems to contain references ([MIBGUIDE]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 1557 has weird spacing: '...here is no co...' == Line 1562 has weird spacing: '...ly, the use o...' == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (April 2003) is 7682 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'RFC2026' is mentioned on line 17, but not defined -- Looks like a reference, but probably isn't: '18' on line 1563 -- Looks like a reference, but probably isn't: '17' on line 1564 == Unused Reference: 'RFC2571' is defined on line 1499, but no explicit reference was found in the text == Unused Reference: 'RFC1155' is defined on line 1502, but no explicit reference was found in the text == Unused Reference: 'RFC1212' is defined on line 1506, but no explicit reference was found in the text == Unused Reference: 'RFC1215' is defined on line 1509, but no explicit reference was found in the text == Unused Reference: 'RFC1157' is defined on line 1512, but no explicit reference was found in the text == Unused Reference: 'RFC1901' is defined on line 1515, but no explicit reference was found in the text == Unused Reference: 'RFC1905' is defined on line 1518, but no explicit reference was found in the text == Unused Reference: 'RFC2570' is defined on line 1522, but no explicit reference was found in the text == Unused Reference: 'RFC2573' is defined on line 1526, but no explicit reference was found in the text == Unused Reference: 'RFC2575' is defined on line 1529, but no explicit reference was found in the text == Unused Reference: 'RFC2574' is defined on line 1533, but no explicit reference was found in the text == Outdated reference: A later version (-04) exists of draft-ietf-ops-mib-review-guidelines-01 -- Obsolete informational reference (is this intentional?): RFC 3015 (Obsoleted by RFC 3525) -- Obsolete informational reference (is this intentional?): RFC 2571 (Obsoleted by RFC 3411) -- Obsolete informational reference (is this intentional?): RFC 1905 (Obsoleted by RFC 3416) -- Obsolete informational reference (is this intentional?): RFC 2570 (Obsoleted by RFC 3410) -- Obsolete informational reference (is this intentional?): RFC 2573 (Obsoleted by RFC 3413) -- Obsolete informational reference (is this intentional?): RFC 2575 (Obsoleted by RFC 3415) -- Obsolete informational reference (is this intentional?): RFC 2574 (Obsoleted by RFC 3414) Summary: 5 errors (**), 0 flaws (~~), 19 warnings (==), 11 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Media Gateway Control (Megaco) Bala Pitchandi (Editor) 3 UTStarcom Inc 4 Ilya Akramovich 5 Lucent Technologies 6 C. Michael Brown 7 Internet Draft Nortel Networks 8 Document: draft-ietf-megaco-mib-05.txt Matt Holdrege 9 Expires: October 2003 April 2003 11 Megaco MIB 13 Status of this Memo 15 This document is an Internet-Draft and is in full conformance with all 16 provisions of Section 10 of RFC2026 [RFC2026]. 18 Internet-Drafts are working documents of the Internet Engineering Task Force 19 (IETF), its areas, and its working groups. Note that other groups may also 20 distribute working documents as Internet-Drafts. 22 Internet-Drafts are draft documents valid for a maximum of six months and may 23 be updated, replaced, or obsoleted by other documents at any time. It is 24 inappropriate to use Internet-Drafts as reference material or to cite them 25 other than as "work in progress." 27 The list of current Internet-Drafts can be accessed at 28 http://www.ietf.org/ietf/1id-abstracts.txt 29 The list of Internet-Draft Shadow Directories can be accessed at 30 http://www.ietf.org/shadow.html. 32 Copyright Notice 34 Copyright (C) The Internet Society (2003). All Rights Reserved. 36 Abstract 38 This memo defines a portion of the Management Information Base (MIB) for use 39 with network management protocols in the Internet community. In particular, it 40 defines objects for use by the MEGACO/H.248 protocol operating on Media 41 Gateways and Media Gateway Controllers. These objects can be used to manage the 42 network containing Media Gateways and Media Gateway Controllers. 44 Changes from the previous version of the draft include: 46 1. Added medGwyGatewayControllerId as an additional index to the 47 medGwyGatewayControllerTable. 49 2. Modified the usage of TimeTicks to TimeStamp which is now being widely used 50 and is more useful. 51 3. Converted the Integer32�s to Unsigned32 wherever appropriate. 52 4. Added few more Textual Conventions that could be imported to vendor specific 53 MIBs. 54 5. Corrected few MIB syntax errors. 55 6. Reformatted the entire document to be compliant with the new IETF MIB 56 guidelines from [MIBGUIDE] 58 Table of Contents 60 1. The Internet-Standard Management Framework....................2 61 2. Overview......................................................2 62 2.1 Terms.....................................................3 63 3. Megaco MIB Definition.........................................3 64 4. Intellectual Property........................................31 65 5. Normative References.........................................32 66 6. Informative References.......................................32 67 7. Security Considerations......................................33 68 8. Acknowledgments..............................................34 69 9. Authors� Addresses...........................................34 70 10. Full Copyright Statement....................................34 72 1. The Internet-Standard Management Framework 74 For a detailed overview of the documents that describe the current Internet- 75 Standard Management Framework, please refer to section 7 of RFC 3410 [RFC3410]. 77 Managed objects are accessed via a virtual information store, termed the 78 Management Information Base or MIB. MIB objects are generally accessed through 79 the Simple Network Management Protocol (SNMP). Objects in the MIB are defined 80 using the mechanisms defined in the Structure of Management Information (SMI). 81 This memo specifies a MIB module that is compliant to the SMIv2, which is 82 described in STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, 83 RFC 2580 [RFC2580]. 85 2. Overview 87 The MEGACO/H.248 protocol [RFC3015] [ITUH248] defines communication between the 88 elements of a physically decomposed multimedia gateway. Those elements are the 89 Media Gateway Controller (MGC) and the Media Gateway (MG). This MIB defines 90 objects on these elements that are to be used to configure these elements such 91 as through control of variable settings, to gather and report management 92 statistics, and to report the occurrence of system management events (i.e., 93 traps) to the network management system. 95 This memo specifies a MIB module that is compliant to the SMIv2. A MIB 96 conforming to the SMIv1 can be produced through the appropriate translations. 97 The resulting translated MIB must be semantically equivalent, except where 98 objects or events are omitted because no translation is possible (use of 99 Counter64). Some machine readable information in SMIv2 will be converted into 100 textual descriptions in SMIv1 during the translation process. However, this 101 loss of machine readable information is not considered to change the semantics 102 of the MIB. 104 2.1 Terms 106 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", 107 "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be 108 interpreted as described in BCP 14, RFC 2119 [RFC2119]. 110 3. Megaco MIB Definition 112 --********************************************************************* 113 -- MEGACO-MIB 114 -- Media Gateway Control MIB 115 -- 116 --********************************************************************* 118 MEGACO-MIB DEFINITIONS ::= BEGIN 120 IMPORTS 121 MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, 122 Integer32, IpAddress, Unsigned32 123 FROM SNMPv2-SMI 125 TEXTUAL-CONVENTION, 126 RowStatus, TestAndIncr, AutonomousType, TimeStamp 127 FROM SNMPv2-TC 129 MODULE-COMPLIANCE, OBJECT-GROUP, 130 NOTIFICATION-GROUP 131 FROM SNMPv2-CONF 133 SnmpAdminString 134 FROM SNMP-FRAMEWORK-MIB 136 InterfaceIndex 137 FROM IF-MIB; 139 megacoMib MODULE-IDENTITY 140 LAST-UPDATED "200209301200Z" 141 ORGANIZATION "IETF" 142 CONTACT-INFO 143 " 144 Postal: 145 Bala Pitchandi 146 UTStarcom Inc 147 33 Wood Avenue South 148 Iselin, NJ 08830 150 Phone: 151 +1 (732)452-4457 153 Email: 154 bs@utstar.com 155 " 156 DESCRIPTION 157 "Media Gateway Control (Megaco) Management 158 Information Base (MIB) 159 " 161 -- Revision History 163 REVISION "200304181200Z" -- 18.Apr, 2003 164 DESCRIPTION 165 "Corrected syntactical errors and some MIB errors" 167 REVISION "200209301200Z" -- 30.Sep, 2002 168 DESCRIPTION 169 "Reworked the entire MIB to add the missing objects and 170 eliminate the ambiguities" 172 REVISION "0003201200Z" -- May, 2001 173 DESCRIPTION 174 "Initial Version by Holdridge et al" 176 ::= { mib-2 xx } _ final assignment by IANA at publication time 178 -- ***************************************************************** 179 -- 180 -- OID For the MIB 181 -- 182 -- ***************************************************************** 184 mediaGatewayMIBObjects OBJECT IDENTIFIER::= { megacoMib 1 } 186 -- ***************************************************************** 187 -- 188 -- MEGACO-MIB 189 -- 190 -- The Media Gateway MIB contains 4 (object) groups 191 -- medGwyConfiguration 192 -- This group consists of all the configuration related information 193 -- pertained with the Media Gateways and Media Gateway Controllers 194 -- in the network being managed. This group contains the following 195 -- three tables: 196 -- medGwyLinkIdTable - Table used to provide the linkId to create 197 -- new entries in the gateway table 198 -- medGwyGatewayConfigTable - Table provides the list of gateways 199 -- in the network and their configuration 200 -- medGwyGatewayControllerTable - Table provides the list of media 201 -- gateway controllers in the network 202 -- and their configuration 203 -- medGwyStatistics 204 -- This group consists of all the statistics related information 205 -- pertained with the gateways. This group contains the following table: 206 -- medGwyGatewayStatsTable - Table provides the gateway statistics 207 -- and related information 208 -- 209 -- medGwyConnections 210 -- This group consists of the connections, terminations and their 211 -- properties related information for the gateways being managed 212 -- This group contains the following three tables: 213 -- medGwyTermIdTable - Table used to provide the manager the next 214 -- available termination Id. 215 -- medGwyTerminationsTable - Table provides the list of terminations 216 -- and their configuration & status 217 -- medGwyPropertyProfileTable - Table provides the list of profiles 218 -- that are being supported by the 219 -- gateway 220 -- 221 -- medGwyProperties 222 -- For Future Extension 223 -- 224 -- 225 -- ***************************************************************** 227 -- ***************************************************************** 228 -- 229 -- Group Objects 230 -- 231 -- ***************************************************************** 233 medGwyConfiguration 234 OBJECT IDENTIFIER::= { mediaGatewayMIBObjects 1 } 235 medGwyStatistics 236 OBJECT IDENTIFIER::= { mediaGatewayMIBObjects 2 } 237 medGwyConnections 238 OBJECT IDENTIFIER::= { mediaGatewayMIBObjects 3 } 239 medGwyProperties 240 OBJECT IDENTIFIER::= { mediaGatewayMIBObjects 4 } 242 -- ***************************************************************** 243 -- 244 -- Textual conventions for the Media Gateway MIB 245 -- 246 -- ***************************************************************** 248 MediaGatewayId ::= TEXTUAL-CONVENTION 249 STATUS current 250 DESCRIPTION 251 "Possible Media Gateway Id that can be used to identify 252 any media gateway uniquely" 253 SYNTAX INTEGER (1..2147483647) 255 MediaGatewayLinkId ::= TEXTUAL-CONVENTION 256 STATUS current 257 DESCRIPTION 258 "Possible Media Gateway Link Id that can be used to identify 259 any media gateway link uniquely" 260 SYNTAX Unsigned32 (1..2147483647) 262 MediaGatewayTermId ::= TEXTUAL-CONVENTION 263 STATUS current 264 DESCRIPTION 265 "Possible Termination Id that can be used to identify 266 any media gateway termination uniquely" 267 SYNTAX Unsigned32 (1..2147483647) 269 -- ***************************************************************** 270 -- 271 -- medGwyLinkIdTable 272 -- Media Gateway LinkId Table... 273 -- 274 -- Provides the manager with the nextId for use in creating a 275 -- LinkId. There is one entry in this table for each MediaGateway. 276 -- 277 -- Link represents the signalling link between the media gateway 278 -- and the media gateway controller. The following rules guide 279 -- the creation of the LinkId 280 -- 281 -- (1) There could be more than one media gateways (medGwyGatewayId) 282 -- sharing the same signalling link (medGwyLinkId). 283 -- 284 -- (2) A gateway may have many links (interfaces) towards the Media 285 -- Gateway Controller but only the active link that is currently 286 -- being used to communicate with the controller would be accounted 287 -- in this table 288 -- 289 -- If this table isn't implemented, the manager would be 290 -- responsible for providing the (unique) nextId (via retaining 291 -- used id's, hashing, etc) 292 -- 293 -- ***************************************************************** 295 medGwyLinkIdTable OBJECT-TYPE 296 SYNTAX SEQUENCE OF MedGwyLinkIdEntry 297 MAX-ACCESS not-accessible 298 STATUS current 299 DESCRIPTION 300 "This table contains a nextLinkId for each Gateway. 301 It provides the manager with the nextLinkId for use 302 in creating new Gateway Table Entries." 303 ::= { medGwyConfiguration 1} 305 medGwyLinkIdEntry OBJECT-TYPE 306 SYNTAX MedGwyLinkIdEntry 307 MAX-ACCESS not-accessible 308 STATUS current 309 DESCRIPTION 310 "This table contains the NextLinkId for this Gateway 311 and is indexed by mediaGatewayId." 312 INDEX { medGwyGatewayId } 313 ::= { medGwyLinkIdTable 1 } 315 MedGwyLinkIdEntry ::= SEQUENCE 316 { 317 medGwyNextLinkId TestAndIncr -- rw 318 } 320 medGwyNextLinkId OBJECT-TYPE 321 SYNTAX TestAndIncr 322 MAX-ACCESS read-write 323 STATUS current 324 DESCRIPTION 325 "The Next Value for a MediaGateway LinkId. Assists the 326 manager in selecting a value for medGwyGatewayLinkId. 327 Using the TestAndIncr syntax, A Manager will 'lock' this 328 variable, ensuring single access." 329 ::= { medGwyLinkIdEntry 1 } 331 -- ***************************************************************** 332 -- 333 -- medGwyGatewayConfigTable 334 -- 335 -- The Media Gateway Configuration Table... 336 -- 337 -- There would be one entry in this table and is indexed by 338 -- (medGwyGatewayId, medGwyGatewayLinkId). The table is guided by 339 -- the following rules: 340 -- 341 -- (1) There is one entry in this table for each MediaGateway 342 -- SignallingLink. 343 -- 344 -- (2) Even though gateways could share the signalling link, they 345 -- could have different IP Address and/or Port Number. In order 346 -- to accomodate that, the table is indexed by both medGwyGatewayId 347 -- and medGwyGatewayLinkId. 348 -- 349 -- (3) Virtual MGs must be represented as a separate entry 350 -- in this table 351 -- 352 -- (4) Statistics can be reset to zero by managers when necessary using 353 -- medGwyGatewayResetStatistics. 354 -- 355 -- ***************************************************************** 357 medGwyGatewayConfigTable OBJECT-TYPE 358 SYNTAX SEQUENCE OF MedGwyGatewayConfigEntry 359 MAX-ACCESS not-accessible 360 STATUS current 361 DESCRIPTION "A list of medGwyGatewayConfigEntry objects." 362 ::= { medGwyConfiguration 2 } 364 medGwyGatewayConfigEntry OBJECT-TYPE 365 SYNTAX MedGwyGatewayConfigEntry 366 MAX-ACCESS not-accessible 367 STATUS current 368 DESCRIPTION "Entry holding configuration information about a 369 group of Media Gateway Controllers sharing the same 370 signaling link." 371 INDEX { medGwyGatewayId, medGwyGatewayLinkId } 372 ::= { medGwyGatewayConfigTable 1 } 374 MedGwyGatewayConfigEntry ::= SEQUENCE 375 { 376 medGwyGatewayId MediaGatewayId, -- na 377 medGwyGatewayLinkId MediaGatewayLinkId, -- na 378 medGwyGatewayLinkName OCTET STRING, -- rc 379 medGwyGatewayIPAddress IpAddress, -- rc 380 medGwyGatewayPort Integer32, -- rc 381 medGwyGatewayEncodingScheme INTEGER, -- rc 382 medGwyGatewayProtocol INTEGER, -- rc 383 medGwyGatewaySignalingTptProtocol INTEGER, -- rc 384 medGwyGatewayAdminStatus INTEGER, -- rc 385 medGwyGatewayOperStatus INTEGER, -- ro 386 medGwyGatewayLastStatusChange TimeStamp, -- ro 387 medGwyGatewayResetStatistics INTEGER, -- rc 388 medGwyGatewayRowStatus RowStatus -- rc 389 } 391 medGwyGatewayId OBJECT-TYPE 392 SYNTAX MediaGatewayId 393 MAX-ACCESS not-accessible 394 STATUS current 395 DESCRIPTION "The unique Media Gateway Id which identifies this 396 media gateway" 397 ::= { medGwyGatewayConfigEntry 1 } 399 medGwyGatewayLinkId OBJECT-TYPE 400 SYNTAX MediaGatewayLinkId 401 MAX-ACCESS not-accessible 402 STATUS current 403 DESCRIPTION "The unique link id which identifies the signalling 404 link that this gateway uses to communicate with the 405 Gateway Controller(s)." 406 ::= { medGwyGatewayConfigEntry 2 } 408 medGwyGatewayLinkName OBJECT-TYPE 409 SYNTAX OCTET STRING ( SIZE (0..255) ) 410 MAX-ACCESS read-create 411 STATUS current 412 DESCRIPTION "A descriptive name of this signalling link / media 413 gateway combination" 414 ::= { medGwyGatewayConfigEntry 3 } 416 medGwyGatewayIPAddress OBJECT-TYPE 417 SYNTAX IpAddress 418 MAX-ACCESS read-create 419 STATUS current 420 DESCRIPTION "The IP address that the Media Gateway Controller 421 will use to communicate with the Media Gateway. 422 The value 0.0.0.0 is returned if the entry is 423 invalid." 424 ::= { medGwyGatewayConfigEntry 4 } 426 medGwyGatewayPort OBJECT-TYPE 427 SYNTAX Integer32 (0..65535) 428 MAX-ACCESS read-create 429 STATUS current 430 DESCRIPTION "TCP/UDP port number that the Media Gateway Controller will 431 use to communiacte with the Media Gateway. The value 432 0 is returned if the entry is invalid." 433 DEFVAL { 2944 } 434 ::= { medGwyGatewayConfigEntry 5 } 436 medGwyGatewayEncodingScheme OBJECT-TYPE 437 SYNTAX INTEGER 438 { 439 text (1), 440 binary (2) 441 } 442 MAX-ACCESS read-create 443 STATUS current 444 DESCRIPTION "The encoding scheme that would be used to encode the Megaco 445 messages that are sent/received to/from the gateway 446 controller" 447 DEFVAL { text } 448 ::= { medGwyGatewayConfigEntry 6 } 450 medGwyGatewayProtocol OBJECT-TYPE 451 SYNTAX INTEGER 452 { 453 notApplicable(1), -- 454 other (2), -- Other (none from the list below) 455 dss1-ip (3), -- Q931+ 456 ipdc (4), -- IPDC 457 megacov1 (5) -- MEGACO/H.248 Version 1 458 megacov2 (6) -- MEGACO/H.248 Version 2 459 mgcp (7) -- MGCP 460 } 461 MAX-ACCESS read-create 462 STATUS current 463 DESCRIPTION "Type of the control protocol in use." 464 ::= { medGwyGatewayConfigEntry 7 } 466 medGwyGatewaySignalingTptProtocol OBJECT-TYPE 467 SYNTAX INTEGER 468 { 469 TCP (1), 470 UDP (2), 471 SCTP (3), 472 other (4) 473 } 474 MAX-ACCESS read-create 475 STATUS current 476 DESCRIPTION "Type of the transport protocol that is being used to 477 transport the megaco signalling traffic" 478 ::= { medGwyGatewayConfigEntry 8 } 480 medGwyGatewayAdminStatus OBJECT-TYPE 481 SYNTAX INTEGER 482 { 483 up (1), 484 down (2), 485 testing (3) 486 } 487 MAX-ACCESS read-create 488 STATUS current 489 DESCRIPTION "The desired state of the gateway. The testing(3) state 490 indicates that no signalling packets can be passed. When 491 a managed system initializes, all gateways start with 492 medGwyGatewayAdminStatus in the down(2) state. As a result 493 of either explicit management action or per configuration 494 information retained by the managed system, 495 medGwyGatewayAdminStatus is then changed to either the 496 up(1) or testing(3) states (or remains in the down(2) 497 state)." 498 ::= { medGwyGatewayConfigEntry 9 } 500 medGwyGatewayOperStatus OBJECT-TYPE 501 SYNTAX INTEGER 502 { 503 up (1), -- ready to communicate with MGC 504 down (2), 505 testing(3), -- in some test mode 506 unknown(4), -- status can not be determined 507 -- for some reason. 508 } 509 MAX-ACCESS read-only 510 STATUS current 511 DESCRIPTION "The current operational state of the gateway. The 512 testing(3) state indicates that no signalling packets can 513 be passed. If medGwyGatewayAdminStatus is down(2) then 514 medGwyGatewayOperStatus should be down(2). If 515 medGwyGatewayAdminStatus is changed to up(1) then 516 medGwyGatewayOperStatus should change to up(1) if the 517 gateway is ready to transmit and receive signalling 518 traffic; it should remain in the down(2) state if and 519 only if there is a fault that prevents it from going to 520 the up(1) state" 522 ::= { medGwyGatewayConfigEntry 10 } 524 medGwyGatewayLastStatusChange OBJECT-TYPE 525 SYNTAX TimeStamp 526 MAX-ACCESS read-only 527 STATUS current 528 DESCRIPTION "The value of sysUpTime at the time the associated 529 link entered its current operational status. If 530 the current status was entered prior to the last 531 re-initialization of the local network management 532 subsystem, then this object contains a zero value." 533 ::= { medGwyGatewayConfigEntry 11 } 535 medGwyGatewayResetStatistics OBJECT-TYPE 536 SYNTAX INTEGER 537 { 538 notApplicable (1), -- Invalid/unknown. 539 other (2), -- None from the list below. 541 reset (3) -- Reset all statistics now. 542 } 543 MAX-ACCESS read-create 544 STATUS current 545 DESCRIPTION "This object can be used to reset all statistics 546 collected for this media gateway link so far. 547 Statistics will be reset when the object is SET 548 to 'reset'. Upon reset, the agent changes the value 549 of this object to 'notApplicable'." 550 ::= { medGwyGatewayConfigEntry 12 } 552 medGwyGatewayRowStatus OBJECT-TYPE 553 SYNTAX RowStatus 554 MAX-ACCESS read-create 555 STATUS current 556 DESCRIPTION "This is used to create new rows in this table, 557 Modify existing rows, and to delete existing rows." 558 ::= { medGwyGatewayConfigEntry 13 } 560 -- ***************************************************************** 561 -- 562 -- medGwyGatewayControllerTable 563 -- 564 -- The Media Gateway Controller Table... 565 -- 566 -- This table would provide information about the media gateway 567 -- controllers in the network and their configuration. The rules 568 -- that guide this table are: 569 -- 570 -- (1) This table consists a 'List' of Media Gateway Controllers 571 -- (on a media gateway), and Configuration Information for these 572 -- Controllers. 573 -- 574 -- (2) An Entry in this Table is automatically created when a manager 575 -- creates an entry in the medGwyGatewayConfigTable because even 576 -- though the same MGC could manage many gateways, they could have 577 -- different logical IP address/Port number towards each of the 578 -- gateway 579 -- 580 -- (3) There can be many logical gateways inside a physical gateway 581 -- (MediaGatewayId) and there can me multiple media gateway 582 -- controllers (medGwyGatewayControllerId) and there can be many 583 -- links between "m" number of gateways and "n" number of controllers 584 -- (medGwyGatewayLinkId). 585 -- 586 -- The relationship can be, for example, as follows: 587 -- 588 -- MediaGatewayId medGwyGatewayControllerId 589 -- +----------+ medGwyGatewayLinkId +----------+ 590 -- | mg1 |----------->------------>| mgc1 | 591 -- | +----------+ | | +----------+ 592 -- | | mg2 | +------------->| mgc2 | 593 -- | | +----------+ | | +----------+ 594 -- +-| | mg3 |----------->---------->| | mgc3 | 595 -- | | | | | | | 596 -- +-| | +----------->| | 597 -- | | | | 598 -- +----------+ +----------+ 599 -- 600 -- ***************************************************************** 602 medGwyGatewayControllerTable OBJECT-TYPE 603 SYNTAX SEQUENCE OF MedGwyGatewayControllerEntry 604 MAX-ACCESS not-accessible 605 STATUS current 606 DESCRIPTION "List of the Media Gateway Controllers that are managed 607 in the network" 608 ::= { medGwyConfiguration 3 } 610 medGwyGatewayControllerEntry OBJECT-TYPE 611 SYNTAX MedGwyGatewayControllerEntry 612 MAX-ACCESS not-accessible 613 STATUS current 614 DESCRIPTION "Entry holding information about an individual 615 Media Gateway Controller." 616 INDEX { medGwyGatewayId, medGwyGatewayLinkId, medGwyGatewayControllerId 617 } 618 ::= { medGwyGatewayControllerTable 1 } 620 MedGwyGatewayControllerEntry ::= SEQUENCE 621 { 622 medGwyGatewayControllerId Unsigned32, -- ro 623 medGwyGatewayControllerIPAddress IpAddress, -- rw 624 medGwyGatewayControllerPort Integer32, -- rw 625 medGwyGatewayControllerAdminStatus INTEGER -- rw 626 medGwyGatewayControllerOperStatus INTEGER, -- ro 627 } 629 medGwyGatewayControllerId OBJECT-TYPE 630 SYNTAX Unsigned32 (1..2147483647) 631 MAX-ACCESS not-accessible 632 STATUS current 633 DESCRIPTION "An unique identification number that is assigned to 634 the gateway controller by the manager" 635 ::= { medGwyGatewayControllerEntry 1 } 637 medGwyGatewayControllerIPAddress OBJECT-TYPE 638 SYNTAX IpAddress 639 MAX-ACCESS read-write 640 STATUS current 641 DESCRIPTION "The IP address of the Media Gateway Controller. The 642 value 0.0.0.0 is returned if the entry is invalid." 643 ::= { medGwyGatewayControllerEntry 2 } 645 medGwyGatewayControllerPort OBJECT-TYPE 646 SYNTAX Integer32 (0..65535) 647 MAX-ACCESS read-write 648 STATUS current 649 DESCRIPTION "TCP port of the Media Gateway Controller. The value 650 0 is returned if the entry is invalid." 651 ::= { medGwyGatewayControllerEntry 3 } 653 medGwyGatewayControllerAdminStatus OBJECT-TYPE 654 SYNTAX INTEGER 655 { 656 up (1), 657 down (2), 658 testing (3) 659 } 660 MAX-ACCESS read-create 661 STATUS current 662 DESCRIPTION "The desired state of the gateway. The testing(3) state 663 indicates that no signalling packets can be passed. When 664 a managed system initializes, all gateways start with 665 medGwyGatewayControllerAdminStatus in the down(2) state. 666 As a result of either explicit management action or per 667 configuration information retained by the managed system, 668 medGwyGatewayControllerAdminStatus is then changed to 669 either the up(1) or testing(3) states (or remains in the 670 down(2) state)." 671 ::= { medGwyGatewayControllerEntry 4 } 673 medGwyGatewayControllerOperStatus OBJECT-TYPE 674 SYNTAX INTEGER 675 { 676 up (1), -- Up/active. 677 down (2), -- Down. 678 standby (3) -- Standby mode. 679 } 680 MAX-ACCESS read-only 681 STATUS current 682 DESCRIPTION "The current operational state of the gateway controller. 683 The standby(3) state indicates that it is in the standby 684 mode and no signalling packets can be passed. If 685 medGwyGatewayControllerAdminStatus is down(2) then 686 medGwyGatewayControllerOperStatus should be down(2). If 687 medGwyGatewayControllerAdminStatus is changed to up(1) then 688 medGwyGatewayControllerOperStatus should change to up(1) 689 if the gateway contoller is ready to transmit and receive 690 signalling traffic; it should remain in the down(2) state if 691 and only if there is a fault that prevents it from going to 692 the up(1) state" 693 ::= { medGwyGatewayControllerEntry 5 } 695 -- ***************************************************************** 696 -- 697 -- medGwyGatewayStatsTable 698 -- 699 -- The Media Gateway Stats Table... 700 -- 701 -- This table provides the control protocol related statistics for 702 -- the gateways that are being managed in the network. The rules 703 -- that guide this table are: 704 -- 705 -- (1) There is one entry in this table for each 706 -- MediaGateway/SignallingLink. 707 -- (2) The Agent creates this table, when a GatewayConfigTable 708 -- Entry is created. 709 -- 710 -- ***************************************************************** 712 medGwyGatewayStatsTable OBJECT-TYPE 713 SYNTAX SEQUENCE OF MedGwyGatewayStatsEntry 714 MAX-ACCESS not-accessible 715 STATUS current 716 DESCRIPTION "A list of mediaGatewayTableEntry objects." 717 ::= { medGwyStatistics 1 } 719 medGwyGatewayStatsEntry OBJECT-TYPE 720 SYNTAX MedGwyGatewayStatsEntry 721 MAX-ACCESS not-accessible 722 STATUS current 723 DESCRIPTION "Entry holding statistics about a group of 724 media Gateway/signalling link pair 725 " 726 INDEX { medGwyGatewayId, medGwyGatewayLinkId } 727 ::= { medGwyGatewayStatsTable 1 } 729 MedGwyGatewayStatsEntry ::= SEQUENCE 730 { 731 medGwyGatewayNumInMessages Unsigned32, -- ro 732 medGwyGatewayNumInOctets Unsigned32, -- ro 733 medGwyGatewayNumOutMessages Unsigned32, -- ro 734 medGwyGatewayNumOutOctets Unsigned32, -- ro 735 medGwyGatewayNumErrors Unsigned32, -- ro 736 medGwyGatewayNumTimerRecovery Unsigned32, -- ro 737 medGwyGatewayTransportNumLosses Unsigned32, -- ro 738 medGwyGatewayTransportNumSwitchover Unsigned32, -- ro 739 medGwyGatewayTransportTotalNumAlarms Unsigned32, -- ro 740 medGwyGatewayTransportLastEvent INTEGER, -- ro 741 medGwyGatewayTransportLastEventTime TimeStamp, -- ro 742 medGwyGatewayLastStatisticsReset TimeStamp -- ro 743 } 745 medGwyGatewayNumInMessages OBJECT-TYPE 746 SYNTAX Unsigned32 747 MAX-ACCESS read-only 748 STATUS current 749 DESCRIPTION "Total number of messages received on the link." 750 ::= { medGwyGatewayStatsEntry 1 } 752 medGwyGatewayNumInOctets OBJECT-TYPE 753 SYNTAX Unsigned32 754 MAX-ACCESS read-only 755 STATUS current 756 DESCRIPTION "Total number of octets received on the link." 757 ::= { medGwyGatewayStatsEntry 2 } 759 medGwyGatewayNumOutMessages OBJECT-TYPE 760 SYNTAX Unsigned32 761 MAX-ACCESS read-only 762 STATUS current 763 DESCRIPTION "Total number of messages sent on the link." 764 ::= { medGwyGatewayStatsEntry 3 } 766 medGwyGatewayNumOutOctets OBJECT-TYPE 767 SYNTAX Unsigned32 768 MAX-ACCESS read-only 769 STATUS current 770 DESCRIPTION "Total number of octets sent on the link." 771 ::= { medGwyGatewayStatsEntry 4 } 773 medGwyGatewayNumErrors OBJECT-TYPE 774 SYNTAX Unsigned32 775 MAX-ACCESS read-only 776 STATUS current 777 DESCRIPTION "Total number of signaling-level errors encountered. 778 Includes, but is not limited to, number of bad 779 messages received, number of failures to sent a 780 message and number of other errors." 781 ::= { medGwyGatewayStatsEntry 5 } 783 medGwyGatewayNumTimerRecovery OBJECT-TYPE 784 SYNTAX Unsigned32 785 MAX-ACCESS read-only 786 STATUS current 787 DESCRIPTION "Total Number of timer recovery events since the 788 statistics was last reset. This reflects all protocol 789 timers that are supported (For Megaco, T - start timer, 790 S - short timer, L - long timer, and Z - long duration 791 timer etc)" 792 ::= { medGwyGatewayStatsEntry 6 } 793 medGwyGatewayTransportNumLosses OBJECT-TYPE 794 SYNTAX Unsigned32 795 MAX-ACCESS read-only 796 STATUS current 797 DESCRIPTION "Number of times a transport link was lost 798 (excluding switch-over cases). A link loss is defined 799 as loss of communication with the entity (MGC) due to 800 hardware/transient problems in the interface or other 801 related hardware/software" 802 ::= { medGwyGatewayStatsEntry 7 } 804 medGwyGatewayTransportNumSwitchover OBJECT-TYPE 805 SYNTAX Unsigned32 806 MAX-ACCESS read-only 807 STATUS current 808 DESCRIPTION "Number of times when the signaling was switched 809 over to an alternative link. This includes 810 switchover due to the Handoffs initiated by the 811 gateway controllers" 812 ::= { medGwyGatewayStatsEntry 8 } 814 medGwyGatewayTransportTotalNumAlarms OBJECT-TYPE 815 SYNTAX Unsigned32 816 MAX-ACCESS read-only 817 STATUS current 818 DESCRIPTION "Total number of all alarms issued for the transport 819 layer." 820 ::= { medGwyGatewayStatsEntry 9 } 822 medGwyGatewayTransportLastEvent OBJECT-TYPE 823 SYNTAX INTEGER 824 { 825 notApplicable (1), -- Invalid/unknown. 826 other (2), -- None from the list below. 827 linkUp (3), -- Transport link is up. 828 linkLoss (4), -- Transport link loss. 829 persistentError (5), -- No link - persistent error. 830 linkShutdown (6), -- Link is shut down. 831 switchOver (7) -- Fail-over. 832 } 833 MAX-ACCESS read-only 834 STATUS current 835 DESCRIPTION "Last event reported by the transport layer." 836 ::= { medGwyGatewayStatsEntry 10 } 838 medGwyGatewayTransportLastEventTime OBJECT-TYPE 839 SYNTAX TimeStamp 840 MAX-ACCESS read-write 841 STATUS current 842 DESCRIPTION "The value of sysUpTime at the time when the event 843 specified by mediaGatewayTransportLastEvent occured. 844 If the last event occured prior to the last 845 re-initialization of the local network management 846 subsystem, then this object contains a zero value." 847 ::= { medGwyGatewayStatsEntry 11 } 849 medGwyGatewayLastStatisticsReset OBJECT-TYPE 850 SYNTAX TimeStamp 851 MAX-ACCESS read-only 852 STATUS current 853 DESCRIPTION "The value of sysUpTime at the time when the 854 statistics were reset. If the reset occured prior to 855 the last re-initialization of the local network 856 management subsystem, this object contains a zero 857 value." 858 ::= { medGwyGatewayStatsEntry 12 } 860 -- ***************************************************************** 861 -- 862 -- medGwyTermIdTable 863 -- 864 -- TerminationId Table... 865 -- 866 -- This table provides unique TerminationId for the creation of 867 -- an entry into the TerminationsTable. The following rules guide 868 -- this table: 869 -- 870 -- (1) This table provides the manager with the nextId for use in 871 -- creating a Termination. There is one entry in this table for each 872 -- MediaGateway. 873 -- (2) If this table isn't implemented, the manager would be 874 -- responsible for providing the (unique) nextId (via retaining 875 -- used id's, hashing, etc) 876 -- 877 -- ***************************************************************** 879 medGwyTermIdTable OBJECT-TYPE 880 SYNTAX SEQUENCE OF MedGwyTermIdEntry 881 MAX-ACCESS not-accessible 882 STATUS current 883 DESCRIPTION 884 "This table contains a nextTerminationId for each 885 Gateway. It provides the manager with the 886 nextTerminationId for use in creating a new 887 TerminationsTable Entry." 888 ::= { medGwyConnections 1} 890 medGwyTermIdEntry OBJECT-TYPE 891 SYNTAX MedGwyTermIdEntry 892 MAX-ACCESS not-accessible 893 STATUS current 894 DESCRIPTION 895 "This table contains a nextTerminationId for each 896 Gateway, and is indexed by mediaGatewayId." 897 INDEX { medGwyGatewayId } 898 ::= { medGwyTermIdTable 1 } 900 MedGwyTermIdEntry ::= SEQUENCE 901 { 902 medGwyNextTerminationId TestAndIncr -- rw 903 } 905 medGwyNextTerminationId OBJECT-TYPE 906 SYNTAX TestAndIncr 907 MAX-ACCESS read-write 908 STATUS current 909 DESCRIPTION "The Next Value for a MediaGateway TerminationId. Assists 910 the manager in selecting a value for medGwyTerminationId. 911 Using the TestAndIncr syntax, A Manager will 'lock' this 912 variable, ensuring single access." 913 ::= { medGwyTermIdEntry 1 } 915 -- ***************************************************************** 916 -- 917 -- medGwyTerminationsTable 918 -- 919 -- The Terminations Table... 920 -- 921 -- This table provides the list of terminations available in the gateway 922 -- and their corresponding profile information and related configuration 923 -- information. The following rules guide this table: 924 -- 925 -- (1) There is one entry in this table for each Termination in a 926 -- MediaGateway. 927 -- (2) The list of terminations include terminations that are present 928 -- for all the contexts that are present in the gateway (excluding 929 -- the NULL context) (Subject to Discussion) 930 -- 931 -- ***************************************************************** 933 medGwyTerminationsTable OBJECT-TYPE 934 SYNTAX SEQUENCE OF MedGwyTerminationsEntry 935 MAX-ACCESS not-accessible 936 STATUS current 937 DESCRIPTION 938 "This table contains information about terminations 939 in a media gateway. It is a list of terminations. 940 The number of entries equals to the total number of 941 terminations for all contexts in a gateway." 942 ::= { medGwyConnections 2} 943 medGwyTerminationsEntry OBJECT-TYPE 944 SYNTAX MedGwyTerminationsEntry 945 MAX-ACCESS not-accessible 946 STATUS current 947 DESCRIPTION " 948 It contains objects that describe a termination. 949 " 950 INDEX { medGwyGatewayId, medGwyTerminationId } 951 ::= { medGwyTerminationsTable 1 } 953 MedGwyTerminationsEntry ::= SEQUENCE 954 { 955 medGwyTerminationId MediaGatewayTermId, -- na 956 medGwyTerminationName SnmpAdminString, -- rc 957 medGwyTerminationAdminStatus INTEGER, -- rw 958 medGwyTerminationOperStatus INTEGER, -- rc 959 medGwyTerminationInterfaceIdentifier InterfaceIndex, -- rc 960 medGwyTerminationPropertyProfileId Unsigned32, -- rc 961 medGwyTerminationRowStatus RowStatus -- rc 962 } 963 medGwyTerminationId OBJECT-TYPE 964 SYNTAX MediaGatewayTermId 965 MAX-ACCESS not-accessible 966 STATUS current 967 DESCRIPTION "An unique identification number that is assigned to 968 the termination by a media gateway. This is the 969 TerminationId that would be used in the protocol 970 messages that are sent from the gateway" 971 ::= { medGwyTerminationsEntry 1 } 973 medGwyTerminationName OBJECT-TYPE 974 SYNTAX SnmpAdminString ( SIZE (0..64) ) 975 MAX-ACCESS read-create 976 STATUS current 977 DESCRIPTION "A descriptive name that would describe this termination 978 and its use. For example, 'emergency-ds0-1' indicating 979 that this termination is reserved as an emergencey DS0 980 channel" 981 ::= { medGwyTerminationsEntry 2 } 983 medGwyTerminationAdminStatus OBJECT-TYPE 984 SYNTAX INTEGER 985 { 986 in-Service (1), 987 out-Of-Service(2), 988 testing (3) 989 } 990 MAX-ACCESS read-write 991 STATUS current 992 DESCRIPTION "The desired state of the termination. The testing(3) state 993 indicates that no connections can be created for this 994 termination. When a managed system initializes, all 995 terminations start with medGwyTerminationAdminStatus in the 996 out-of-service(2) state. As a result of either 997 explicit management action or per configuration information 998 retained by the managed system, 999 medGwyTerminationAdminStatus is then changed to either the 1000 in-Service(1) or testing(3) states (or remains in the 1001 out-Of-Service(2) state)." 1002 ::= { medGwyTerminationsEntry 3 } 1004 medGwyTerminationOperStatus OBJECT-TYPE 1005 SYNTAX INTEGER 1006 { 1007 up (1), 1008 down (2), 1009 testing (3) 1010 } 1011 MAX-ACCESS read-create 1012 STATUS current 1013 DESCRIPTION "The current operational state of the termination. 1014 The testing(3) state indicates that it is in the testing 1015 mode and no connections can be created on it. If 1016 medGwyTerminationAdminStatus is out-of-service(2) then 1017 medGwyTerminationOperStatus should be down(2). If 1018 medGwyTerminationAdminStatus is changed to up(1) then 1019 medGwyTerminationOperStatus should change to up(1) if the 1020 termination is ready to accept connections; it should remain 1021 in the down(2) state if and only if there is a fault that 1022 prevents it from going to the up(1) state" 1023 ::= { medGwyTerminationsEntry 4 } 1025 medGwyTerminationInterfaceIdentifier OBJECT-TYPE 1026 SYNTAX InterfaceIndex 1027 MAX-ACCESS read-create 1028 STATUS current 1029 DESCRIPTION "A number that uniquely identifies the interface in 1030 the physical gateway. This is the ifIndex in the ifTable, 1031 that this termination would be using to communicate to 1032 other gateways" 1033 ::= { medGwyTerminationsEntry 5 } 1035 medGwyTerminationPropertyProfileId OBJECT-TYPE 1036 SYNTAX Unsigned32 (1..2147483647) 1037 MAX-ACCESS read-create 1038 STATUS current 1039 DESCRIPTION "This determines the profile of the termination which 1040 determines what kind of capabilities this termination has. 1041 This is an index into the medGwyPropertyProfileTable 1042 which identifies all the profile that are available" 1043 ::= { medGwyTerminationsEntry 6 } 1045 medGwyTerminationRowStatus OBJECT-TYPE 1046 SYNTAX RowStatus 1047 MAX-ACCESS read-create 1048 STATUS current 1049 DESCRIPTION "This is used to create new rows in this table, 1050 Modify existing rows, and to delete existing rows." 1051 ::= { medGwyTerminationsEntry 7 } 1053 -- ***************************************************************** 1054 -- 1055 -- medGwyPropertyProfileTable 1056 -- 1057 -- The Media Gateway Property Profile Table... 1058 -- 1059 -- This table describes different profiles and the properties supported 1060 -- by each profile. The rules that guide this table are: 1061 -- 1062 -- (1) There are 'N' entries for each Gateway-PropertyProfile 1063 -- (2) Each entry is a supported property, thus this table gives a list 1064 -- of supported properties for each specified Profile. 1065 -- (3) Each Property is defined as an Object Identifer in the various 1066 -- Package Mibs (like MEGACO-TONES-MIB etc). 1067 -- (4) That OID is used to identify the particular Package, and if the 1068 -- Termination supports the property, this Package OID is included 1069 -- in its list. 1070 -- (5) Terminations (in the TerminationsTable) will have a 1071 -- PropertyProfileId that indicates which PropertyProfile this 1072 -- Termination supports. 1073 -- (6) A Manager builds a Profile of properties, then ties each 1074 -- termination to a defined profile, via the PropertyProfileId 1075 -- (7) Vendors are encouraged to come up with different profiles 1076 -- for different scenarios in order to ensure inter-operability 1077 -- among different implementations 1078 -- 1079 -- ***************************************************************** 1081 medGwyPropertyProfileTable OBJECT-TYPE 1082 SYNTAX SEQUENCE OF MedGwyPropertyProfileEntry 1083 MAX-ACCESS not-accessible 1084 STATUS current 1085 DESCRIPTION 1086 "This table contains a list of the properties 1087 supported in a Profile. A Manager builds a Profile 1088 of properties, then ties each termination to a 1089 defined profile" 1090 ::= { medGwyConnections 3} 1091 medGwyPropertyProfileEntry OBJECT-TYPE 1092 SYNTAX MedGwyPropertyProfileEntry 1093 MAX-ACCESS not-accessible 1094 STATUS current 1095 DESCRIPTION " 1096 Each row represents a default property of the 1097 Property Profile N-entries per 1098 mediaGatewayId/PropertyId, one entry per property." 1099 INDEX { medGwyGatewayId, medGwyPropertyProfileId, 1100 medGwyPropertyProfileIndex } 1101 ::= { medGwyPropertyProfileTable 1 } 1103 MedGwyPropertyProfileEntry ::= SEQUENCE 1104 { 1105 medGwyPropertyProfileId Unsigned32, -- na 1106 medGwyPropertyProfileIndex Unsigned32, -- na 1107 medGwyPropertyProfileProperty AutonomousType, -- rc 1108 medGwyTermPropertyProfileStatus RowStatus -- rc 1109 } 1111 medGwyPropertyProfileId OBJECT-TYPE 1112 SYNTAX Unsigned32 (1..2147483647) 1113 MAX-ACCESS not-accessible 1114 STATUS current 1115 DESCRIPTION "This PropertyProfile Identifier uniquelyidentifies this 1116 set of properties. This is the value each termination 1117 would refer, when they would like to support all the 1118 properties in this profile" 1119 ::= { medGwyPropertyProfileEntry 1 } 1121 medGwyPropertyProfileIndex OBJECT-TYPE 1122 SYNTAX Unsigned32 (1..2147483647) 1123 MAX-ACCESS not-accessible 1124 STATUS current 1125 DESCRIPTION "This is the index to the PropertyProfile This is just 1126 a 'counter' through the medGwyPropertyProfile Table. 1127 ie, property=1 property=2 etc." 1128 ::= { medGwyPropertyProfileEntry 2 } 1130 medGwyPropertyProfileProperty OBJECT-TYPE 1131 SYNTAX AutonomousType 1132 MAX-ACCESS read-create 1133 STATUS current 1134 DESCRIPTION "The Property supported by this Profile. 1135 This is an Object ID (OID) defined in a package MIB 1136 to identify a Particular property (such as AnalogLines, 1137 Tones etc)." 1138 ::= { medGwyPropertyProfileEntry 3 } 1140 medGwyTermPropertyProfileStatus OBJECT-TYPE 1141 SYNTAX RowStatus 1142 MAX-ACCESS read-create 1143 STATUS current 1144 DESCRIPTION 1145 "used to create new rows in this table, modify 1146 existing rows, and to delete existing rows." 1147 ::= { medGwyPropertyProfileEntry 4 } 1149 -- ***************************************************************** 1150 -- 1151 -- MEGACO-MIB Notification Definitions 1152 -- 1153 -- There are seven traps currently supported by the MEGACO-MIB. They are 1154 -- 1155 -- o medGwyLinkStatusChange 1156 -- This trap is sent whenever there is a change in the link status 1157 -- that the media gateway is communicating 1158 -- 1159 -- o medGwyInvalidControllerAddress 1160 -- This trap is sent whenever a gateway receives a protocol message 1161 -- from a controller that was not present in the configured list 1162 -- of media gateway controllers 1163 -- 1164 -- o meGwyInvalidTerminationId 1165 -- This trap is sent whenever a gateway receives a protocol message 1166 -- for a termination that is not recognized by the gateway 1167 -- 1168 -- o medGwyInvalidPackageElement 1169 -- This trap is sent whenever a gateway receives an invalid 1170 -- event/signal or any other descriptor for the package specified 1171 -- along with it. 1172 -- 1173 -- o medGwyTerminationStatusChange 1174 -- This trap is sent whenever the status of the termination 1175 -- changes from in-Service to out-of-Service or to testing. 1176 -- 1177 -- o medGwyGatewayHandoff 1178 -- This trap is sent whenever there is a handoff (due to a failure of 1179 -- the MGC or enforced by the MGC) in a gateway 1180 -- 1181 -- o medGwyProtocolError 1182 -- This trap is sent whenever there is a protocol error detected 1183 -- in the messages that the gateway receives from the gateway 1184 -- controllers that are configured 1185 -- 1186 -- ***************************************************************** 1187 mediaGatewayMIBNotifications 1188 OBJECT IDENTIFIER ::= { megacoMib 2 } 1190 medGwyNotifPrefix 1191 OBJECT IDENTIFIER ::= { mediaGatewayMIBNotifications 0 } 1192 medGwyNotifObjects 1193 OBJECT IDENTIFIER ::= { mediaGatewayMIBNotifications 1 } 1195 -- 1196 -- Objects necessary for these Notifications 1197 -- 1198 medGwyReceivedElement OBJECT-TYPE 1199 SYNTAX OCTET STRING ( SIZE (0..255) ) 1200 MAX-ACCESS accessible-for-notify 1201 STATUS current 1202 DESCRIPTION "The element name received in a megaco message. For 1203 example, 'eventDescriptor' is one such element that 1204 could be sent with the notifications" 1205 ::= { medGwyNotifObjects 1 } 1207 medGwyLinkStatusChange NOTIFICATION-TYPE 1208 OBJECTS { 1209 medGwyGatewayLinkName, 1210 medGwyGatewayOperStatus 1211 } 1212 STATUS current 1213 DESCRIPTION "This notification indicates that operational status 1214 of a media gateway control link has changed." 1215 ::= { medGwyNotifPrefix 1} 1217 medGwyInvalidControllerAddress NOTIFICATION-TYPE 1218 OBJECTS { 1219 medGwyGatewayControllerIPAddress 1220 } 1221 STATUS current 1222 DESCRIPTION "This notification indicates that a message was received 1223 from a controller that did not match any of the valid 1224 controller IPAddress-es configured in 1225 medGwyGatewayControllerTable" 1226 ::= { medGwyNotifPrefix 2 } 1228 medGwyInvalidTerminationId NOTIFICATION-TYPE 1229 OBJECTS { 1230 medGwyTerminationId 1231 } 1232 STATUS current 1233 DESCRIPTION "This notification indicates that a message was received 1234 from a controller that contained a TerminationId that did 1235 not match any TerminationId in the TerminationsTable. 1237 TerminationId is found in the OID of the 1238 medGwyTerminationName Object." 1239 ::= { medGwyNotifPrefix 3 } 1241 medGwyInvalidPackageElement NOTIFICATION-TYPE 1242 OBJECTS { 1243 medGwyReceivedElement 1244 } 1245 STATUS current 1246 DESCRIPTION "This notification indicates that a message was received 1247 from a controller that contained an event, signal, 1248 or descriptor that was not recognized for the 1249 package." 1250 ::= { medGwyNotifPrefix 4 } 1252 medGwyTerminationStatusChange NOTIFICATION-TYPE 1253 OBJECTS { 1254 medGwyTerminationStatus, 1255 medGwyTerminationTestStatus 1256 } 1257 STATUS current 1258 DESCRIPTION "This notification is sent when a termination changes 1259 status." 1260 ::= { medGwyNotifPrefix 5 } 1262 medGwyGatewayHandoff NOTIFICATION-TYPE 1263 OBJECTS { 1264 medGwyGatewayId, 1265 medGwyGatewayControllerId 1266 } 1267 STATUS current 1268 DESCRIPTION "This notification is sent when a gateway is handed off 1269 to a different gateway controller either due to a apparent 1270 MGC failure or due to a MGC-enforced condition" 1271 ::= { medGwyNotifPrefix 6 } 1273 medGwyProtocolError NOTIFICATION-TYPE 1274 OBJECTS { 1275 medGwyTerminationId 1276 } 1277 STATUS current 1278 DESCRIPTION "This notification is sent when a protocol error is detected 1279 in the messages received from the 'configured' gateway 1280 controllers" 1281 ::= { medGwyNotifPrefix 7 } 1283 -- ***************************************************************** 1284 -- 1285 -- Conformance for the MEGACO-MIB 1286 -- 1287 -- This object group provides list of groups to be conformed when 1288 -- managing different types of gateways, gateway controllers individually 1289 -- and both simultaneously from one single management entity. 1290 -- 1291 -- ***************************************************************** 1293 mediaGatewayConformance OBJECT IDENTIFIER ::= { megacoMib 3 } 1295 -- ***************************************************************** 1296 -- 1297 -- Conformance Object Groups 1298 -- 1299 -- There are two object groups 1300 -- 1301 -- medGwyCompliances 1302 -- This group includes all the compliance statements (both mandatory 1303 -- and optional statements. 1304 -- 1305 -- medGwyConfGroups 1306 -- This group includes all the different groups that form the compliance 1307 -- statements 1308 -- 1309 -- ***************************************************************** 1311 medGwyCompliances 1312 OBJECT IDENTIFIER ::= { mediaGatewayConformance 1 } 1313 medGwyConfGroups 1314 OBJECT IDENTIFIER ::= { mediaGatewayConformance 2 } 1316 -- Compliance 1318 medGwyCompliance MODULE-COMPLIANCE 1319 STATUS current 1320 DESCRIPTION 1321 "Compliance statement for entities which implement 1322 the MEGACO-MIB. 1323 " 1324 MODULE -- this module 1325 MANDATORY-GROUPS 1326 { 1327 medGwyConfigGroup, 1328 medGwyStatsGroup, 1329 } 1331 GROUP medGwyGWControllerGroup 1332 DESCRIPTION 1333 "This group is mandatory for all Systems that are gateway 1334 controllers and are being managed over a distributed 1335 environment" 1337 GROUP medGwyNextIdGroup 1338 DESCRIPTION 1339 "This group is not mandatory for all the agent implementations. 1340 But if this group is not implemented, then the manager is 1341 responsible for uniquely determining the nextId to be used 1342 in various listed objects." 1344 GROUP medGwyNotificationsGroup 1345 DESCRIPTION 1346 "This group is mandatory for all the implementations, which . 1347 are fault tolerant. This group contains all the notifications" 1349 ::= { medGwyCompliances 1 } 1351 -- Units of Conformance 1353 medGwyConfigGroup OBJECT-GROUP 1354 OBJECTS 1355 { 1356 medGwyGatewayLinkName, 1357 medGwyGatewayIPAddress, 1358 medGwyGatewayPort, 1359 medGwyGatewayEncodingScheme, 1360 medGwyGatewayProtocol, 1361 medGwyGatewaySignalingTptProtocol, 1362 medGwyGatewayAdminStatus, 1363 medGwyGatewayOperStatus, 1364 medGwyGatewayLastStatusChange, 1365 medGwyGatewayResetStatistics 1366 } 1367 STATUS current 1368 DESCRIPTION 1369 "This group contains of all the configuration Information for a 1370 Media Gateway. This group is mandatory for any implementation 1371 managing a media gateway or a group of media gateways" 1372 ::= { medGwyConfGroups 1 } 1374 medGwyStatsGroup OBJECT-GROUP 1375 OBJECTS 1376 { 1377 medGwyGatewayNumInMessages, 1378 medGwyGatewayNumInOctets, 1379 medGwyGatewayNumOutMessages, 1380 medGwyGatewayNumOutOctets, 1381 medGwyGatewayNumErrors, 1382 medGwyGatewayNumTimerRecovery, 1383 medGwyGatewayTransportNumLosses, 1384 medGwyGatewayTransportNumSwitchover, 1385 medGwyGatewayTransportTotalNumAlarms, 1386 medGwyGatewayTransportLastEvent, 1387 medGwyGatewayTransportLastEventTime, 1388 medGwyGatewayLastStatisticsReset 1389 } 1390 STATUS current 1391 DESCRIPTION 1392 "This group contains of all the statistics Information for a 1393 Media Gateway. This group is mandatory for any implementation 1394 managing a media gateway or a group of media gateways" 1395 ::= { medGwyConfGroups 2 } 1397 medGwyGWControllerGroup OBJECT-GROUP 1398 OBJECTS 1399 { 1400 medGwyGatewayControllerIPAddress, 1401 medGwyGatewayControllerPort, 1402 medGwyGatewayControllerAdminStatus, 1403 medGwyGatewayControllerOperStatus 1404 } 1405 STATUS current 1406 DESCRIPTION 1407 "This group contains of all the configuration Information for a 1408 Media Gateway Controller. This group is mandatory for any 1409 implementation managing a media gateway controller or a group of 1410 media gateway controllers. It is also mandatory for implementations 1411 managing media gateway(s)" 1412 ::= { medGwyConfGroups 3 } 1414 medGwyNextIdGroup OBJECT-GROUP 1415 OBJECTS 1416 { 1417 medGwyNextTerminationId, 1418 medGwyNextLinkId 1419 } 1420 STATUS current 1421 DESCRIPTION 1422 "Agent provides NextId's to the Manager to assist in selecting 1423 and creating new table entries. This group is optional for 1424 all the implementations. But when it is not implemented, it is 1425 the manager's responsibility to uniquely determine these ids" 1426 ::= { medGwyConfGroups 4 } 1428 medGwyNotificationsGroup NOTIFICATION-GROUP 1429 NOTIFICATIONS 1430 { 1431 medGwyLinkStatusChange, 1432 medGwyInvalidControllerAddress, 1433 medGwyInvalidTerminationId, 1434 medGwyInvalidPackageElement, 1435 medGwyTerminationStatusChange, 1436 medGwyGatewayHandoff, 1437 medGwyProtocolError 1438 } 1439 STATUS current 1440 DESCRIPTION 1441 "This group contains notifications that an entity implementing 1442 the Media Gateway(s) will send. This group is mandatory for 1443 all implementations that are managing a media gateway or a group 1444 of media gateways" 1445 ::= { medGwyConfGroups 5 } 1447 END 1448 4. Intellectual Property 1450 The IETF takes no position regarding the validity or scope of any intellectual 1451 property or other rights that might be claimed to pertain to the implementation 1452 or use of the technology described in this document or the extent to which any 1453 license under such rights might or might not be available; neither does it 1454 represent that it has made any effort to identify any such rights. Information 1455 on the IETF's procedures with respect to rights in standards-track and 1456 standards-related documentation can be found in BCP-11. Copies of claims of 1457 rights made available for publication and any assurances of licenses to be made 1458 available, or the result of an attempt made to obtain a general license or 1459 permission for the use of such proprietary rights by implementors or users of 1460 this specification can be obtained from the IETF Secretariat. 1462 The IETF invites any interested party to bring to its attention any copyrights, 1463 patents or patent applications, or other proprietary rights which may cover 1464 technology that may be required to practice this standard. Please address the 1465 information to the IETF Executive Director. 1467 5. Normative References 1469 [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1470 Rose, M. and S. Waldbusser, "Structure of Management 1471 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1472 1999. 1474 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1475 Rose, M. and S. Waldbusser, "Textual Conventions for 1476 SMIv2", STD 58, RFC 2579, April 1999. 1478 [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1479 Rose, M. and S. Waldbusser, "Conformance Statements for 1480 SMIv2", STD 58, RFC 2580, April 1999. 1482 [MIBGUIDE] Heard, C.M., �Guidelines for MIB Authors and Reviewers�, Internet 1483 Draft, draft-ietf-ops-mib-review-guidelines-01.txt, February 2003 1485 6. Informative References 1487 [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, 1488 "Introduction and Applicability Statements for Internet- 1489 Standard Management Framework", RFC 3410, December 2002. 1491 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement 1492 Levels", BCP 14, RFC 2119, March 1997 1494 [RFC3015] Cuervo, F., Greene, N., Rayhan, A., Rosen, B., Segers, J., "Megaco 1495 Protocol Version 1.0", RFC 3015, November 2000 1497 [ITUH248] ITU-T Recommendation H.248 (06/2000), "Gateway Control Protocol". 1499 [RFC2571] Harrington, D., Presuhn, R. and B. Wijnen, "An Architecture for 1500 Describing SNMP Management Frameworks", RFC 2571, April 1999. 1502 [RFC1155] Rose, M. and K. McCloghrie, "Structure and Identification of 1503 Management Information for TCP/IP-based Internets", STD 16, RFC 1155, 1504 May 1990. 1506 [RFC1212] Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16, RFC 1507 1212, March 1991. 1509 [RFC1215] Rose, M., "A Convention for Defining Traps for use with the SNMP", 1510 RFC 1215, March 1991. 1512 [RFC1157] Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple Network 1513 Management Protocol", STD 15, RFC 1157, May 1990. 1515 [RFC1901] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Introduction 1516 to Community-based SNMPv2", RFC 1901, 1518 [RFC1905] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Protocol 1519 Operations for Version 2 of the Simple Network Management Protocol 1520 (SNMPv2)", RFC 1905, January 1996. 1522 [RFC2570] Case, J., Mundy, R., Partain, D. and B. Stewart, "Introduction to 1523 Version 3 of the Internet-standard Network Management Framework", RFC 1524 2570, April 1999. 1526 [RFC2573] Levi, D., Meyer, P. and B. Stewart, "SNMPv3 Applications", RFC 2573, 1527 April 1999. 1529 [RFC2575] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access Control 1530 Model (VACM) for the Simple Network Management Protocol (SNMP)", RFC 1531 2575, April 1999. 1533 [RFC2574] Blumenthal, U., and B. Wijnen, "User-based Security Model (USM) for 1534 version 3 of the Simple Network Management Protocol (SNMPv3)", RFC 1535 2574, April 1999. 1537 7. Security Considerations 1539 In order to implement this MIB, a probe must capture all packets on the 1540 locally-attached network, including packets between third parties. These 1541 packets are analyzed to collect network addresses, protocol usage information, 1542 and conversation statistics. Data of this nature may be considered sensitive in 1543 some environments. In such environments the administrator may wish to restrict 1544 SNMP access to the probe. 1546 This MIB also includes functions for returning the contents of captured 1547 packets, potentially including sensitive user data or passwords. It is 1548 recommended that SNMP access to these functions be restricted. 1550 There are a number of management objects defined in this MIB that have a MAX- 1551 ACCESS clause of read-write and/or read-create. Such objects may be considered 1552 sensitive or vulnerable in some network environments. The support for SET 1553 operations in a non-secure environment without proper protection can have a 1554 negative effect on network operations. 1556 SNMPv1 by itself is not a secure environment. Even if the network itself is 1557 secure (for example by using IPSec), even then, there is no control as to who 1558 on the secure network is allowed to access and GET/SET 1559 (read/change/create/delete) the objects in this MIB. 1561 It is recommended that the implementors consider the security features as 1562 provided by the SNMPv3 framework. Specifically, the use of the User-based 1563 Security Model RFC 2574 [18] and the View- based Access Control Model RFC 2575 1564 [17] is recommended. 1566 It is then a customer/user responsibility to ensure that the SNMP entity giving 1567 access to an instance of this MIB, is properly configured to give access to the 1568 objects only to those principals (users) that have legitimate rights to indeed 1569 GET or SET change/create/delete) them. 1571 8. Acknowledgments 1573 The authors would like to acknowledge the significant contributions to this 1574 draft by Pratima Shah (AGCS), Irina Suconick (Videoserver), Brian Rosen 1575 (Marconi), Rod Miller (Nortel Networks), and Thomas Stone (Jetstream). The 1576 authors also would like to thank all those in the Megaco Community who reviewed 1577 the MIB and provided valuable comments that include Raphael Tryster (Tdsoft) 1578 and Margaret Hsieh (Cisco). 1580 9. Authors� Addresses 1582 Bala Pitchandi 1583 UTStarcom Inc 1584 33 Wood Avenue South 1585 Iselin, NJ USA 08830 1586 Phone: (732) 452 4457 1587 Email: bs@utstar.com 1589 Ilya Akramovich 1590 Lucent Technologies 1591 1701 Harbor Bay Parkway 1592 Alameda, CA USA 94502 1593 Phone: (510) 769-6001 1594 Email: ilya@ascend.com 1596 C. Michael Brown 1597 Email: cmbrown@mindspring.com 1599 Matt Holdrege 1600 Email: matt.holdrege@verizon.net 1602 10. Full Copyright Statement 1604 Copyright (C) The Internet Society (2003). All Rights Reserved. 1606 This document and translations of it may be copied and furnished to others, and 1607 derivative works that comment on or otherwise explain it or assist in its 1608 implementation may be prepared, copied, published and distributed, in whole or 1609 in part, without restriction of any kind, provided that the above copyright 1610 notice and this paragraph are included on all such copies and derivative works. 1611 However, this document itself may not be modified in any way, such as by 1612 removing the copyright notice or references to the Internet Society or other 1613 Internet organizations, except as needed for the purpose of developing Internet 1614 standards in which case the procedures for copyrights defined in the Internet 1615 Standards process must be followed, or as required to translate it into 1616 languages other than English. 1618 The limited permissions granted above are perpetual and will not be revoked by 1619 the Internet Society or its successors or assigns. 1621 This document and the information contained herein is provided on an "AS IS" 1622 basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE 1623 DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY 1624 WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR 1625 ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 1627 Acknowledgement 1629 Funding for the RFC Editor function is currently provided by the Internet 1630 Society.