idnits 2.17.1 draft-ietf-sip-mib-12.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3978, Section 5.1 on line 18. -- Found old boilerplate from RFC 3978, Section 5.5 on line 4512. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 4523. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 4530. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 4536. ** This document has an original RFC 3978 Section 5.4 Copyright Line, instead of the newer IETF Trust Copyright according to RFC 4748. ** This document has an original RFC 3978 Section 5.5 Disclaimer, instead of the newer disclaimer which includes the IETF Trust according to RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. -- 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 (September 15, 2006) is 6425 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) No issues found here. Summary: 3 errors (**), 0 flaws (~~), 2 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 SIP Working Group K. Lingle 3 Internet-Draft Cisco Systems, Inc. 4 Intended status: Standards Track J-F. Mule 5 Expires: March 19, 2007 CableLabs 6 J. Maeng 7 D. Walker 8 September 15, 2006 10 Management Information Base for the Session Initiation Protocol (SIP) 11 draft-ietf-sip-mib-12.txt 13 Status of this Memo 15 By submitting this Internet-Draft, each author represents that any 16 applicable patent or other IPR claims of which he or she is aware 17 have been or will be disclosed, and any of which he or she becomes 18 aware will be disclosed, in accordance with Section 6 of BCP 79. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF), its areas, and its working groups. Note that 22 other groups may also distribute working documents as Internet- 23 Drafts. 25 Internet-Drafts are draft documents valid for a maximum of six months 26 and may be updated, replaced, or obsoleted by other documents at any 27 time. It is inappropriate to use Internet-Drafts as reference 28 material or to cite them other than as "work in progress." 30 The list of current Internet-Drafts can be accessed at 31 http://www.ietf.org/ietf/1id-abstracts.txt. 33 The list of Internet-Draft Shadow Directories can be accessed at 34 http://www.ietf.org/shadow.html. 36 This Internet-Draft will expire on March 19, 2007. 38 Copyright Notice 40 Copyright (C) The Internet Society (2006). 42 Abstract 44 This memo defines a portion of the Management Information Base (MIB) 45 for use with network management protocols in the Internet community. 46 In particular, it describes a set of managed objects that are used to 47 manage Session Initiation Protocol (SIP) entities, which include User 48 Agents, Proxy, Redirect and Registrar servers. 50 Table of Contents 52 1. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 3 53 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 54 3. The Internet-Standard Management Framework . . . . . . . . . . 3 55 4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 56 5. Structure of the SIP MIB . . . . . . . . . . . . . . . . . . . 4 57 5.1. Textual Conventions . . . . . . . . . . . . . . . . . . . 6 58 5.2. Relationship to the Network Services MIB . . . . . . . . . 6 59 5.3. IMPORTed MIB Modules and REFERENCE Clauses . . . . . . . . 10 60 6. Accommodating SIP Extension Methods . . . . . . . . . . . . . 10 61 7. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 11 62 7.1. SIP Textual Conventions . . . . . . . . . . . . . . . . . 11 63 7.2. SIP Common MIB Module . . . . . . . . . . . . . . . . . . 15 64 7.3. SIP User Agent MIB Module . . . . . . . . . . . . . . . . 54 65 7.4. SIP Server MIB Module (Proxy, Redirect and Registrar 66 Servers) . . . . . . . . . . . . . . . . . . . . . . . . . 58 67 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 77 68 9. Security Considerations . . . . . . . . . . . . . . . . . . . 77 69 10. Contributor Acknowledgments . . . . . . . . . . . . . . . . . 79 70 11. Changes from Previous Draft Revisions . . . . . . . . . . . . 79 71 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 93 72 12.1. Normative References . . . . . . . . . . . . . . . . . . . 93 73 12.2. Informative References . . . . . . . . . . . . . . . . . . 94 74 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 94 75 Intellectual Property and Copyright Statements . . . . . . . . . . 96 77 1. Conventions 79 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 80 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 81 document are to be interpreted as described in RFC 2119 [RFC2119]. 83 2. Introduction 85 This memo defines a portion of the Management Information Base (MIB) 86 for use with network management protocols in the Internet community. 87 In particular, it describes a set of managed objects that are used to 88 manage Session Initiation Protocol (SIP) entities, which include User 89 Agents, Proxy, Redirect and Registrar servers. The managed objects 90 defined in this document are intended to provide basic SIP protocol 91 management for SIP entities. The management of application-specific 92 or service-specific SIP configuration is out of scope. 94 3. The Internet-Standard Management Framework 96 For a detailed overview of the documents that describe the current 97 Internet-Standard Management Framework, please refer to section 7 of 98 RFC 3410 [RFC3410]. 100 Managed objects are accessed via a virtual information store, termed 101 the Management Information Base or MIB. MIB objects are generally 102 accessed through the Simple Network Management Protocol (SNMP). 103 Objects in the MIB are defined using the mechanisms defined in the 104 Structure of Management Information (SMI). This memo specifies a set 105 of MIB modules that are compliant to the SMIv2, which is described in 106 STD 58, comprised of RFC 2578 [RFC2578], RFC 2579 [RFC2579], and RFC 107 2580 [RFC2580]. 109 4. Overview 111 SIP [RFC3261] is an application-layer control (signaling) protocol 112 for creating, modifying, and terminating sessions with one or more 113 participants. These sessions include Internet telephone calls, 114 multimedia distribution, and multimedia conferences. 116 This MIB provides some managed objects for SIP entities defined in 117 RFC 3261 [RFC3261] - User Agents, and Proxy, Redirect and Registrar 118 servers: it is intended to provide management of the basic SIP 119 entities. It provides for monitoring of status and protocol 120 statistics, as well as for configuration of SIP entities. 122 5. Structure of the SIP MIB 124 Four MIB modules are specified: SIP-COMMON-MIB, SIP-SERVER-MIB, SIP- 125 UA-MIB and SIP-TC-MIB. SIP-COMMON-MIB contains common MIB objects 126 used in all the SIP entities. SIP-SERVER-MIB contains objects 127 specific to Proxy, Redirect and Registrar servers, and SIP-UA-MIB 128 includes objects specific to User Agents. SIP-TC-MIB defines the 129 textual conventions used throughout MIB modules. 131 The MIB modules contain following groups of objects: 133 SIP-COMMON-MIB: Management objects common to all the SIP entities 134 o sipCommonMIBObjects 135 * sipCommonCfgBase: This object group defines configuration 136 objects common to all SIP entities including the SIP protocol 137 version, the type of SIP entity (UA, proxy, redirect, registrar 138 server), the operational and administrative status, the SIP 139 organization name, the maximum number of SIP transactions an 140 entity can manage, etc. 141 * sipCommonCfgTimer: This object group defines timer 142 configuration objects applicable to SIP user agent and stateful 143 SIP proxy entities. 144 * sipCommonSummaryStats: This object group defines a table 145 containing the summary statistics objects applicable to all SIP 146 entities, including the total number of all SIP requests and 147 responses in/out, and the total number of transactions. 148 * sipCommonMethodStats: This object group defines a table 149 containing the SIP method statistics objects applicable to all 150 SIP entities, including the number outbound and inbound 151 requests on a per method basis. Retransmissions, where 152 appropriate, are also included in these statistics. 153 * sipCommonStatusCode: This object group defines a table 154 indicating the number of SIP responses (in and out) that the 155 SIP entity has been requested to monitor on a per method basis 156 (100, 200, 302, etc.). 157 * sipCommonStatsTrans: This object group defines a table 158 containing a gauge reflecting the number of transactions 159 currently awaiting definitive responses by the managed SIP 160 entity. 161 * sipCommonStatsRetry: This object group defines statistic 162 objects indicating the number of retransmissions sent on a per 163 method basis. 164 * sipCommonOtherStats: This object group defines additional 165 statistic objects including the number of SIP requests received 166 with unsupported URIs, the number of requests received with 167 unsupported SIP methods, and the number of discarded messages. 169 * sipCommonNotifObjects: This object group defines objects 170 accessible only via a notification (MAX ACCESS clause of 171 accessible-for-notify): they are related to the SNMP 172 notifications defined in this MIB module. 174 The SIP-COMMON-MIB also contains notifications, including: 175 o sipCommonStatusCodeNotif: indicates that a specific status code 176 has been sent or received by the system. 177 o sipCommonStatusCodeThreshExceededNotif: indicates that a specific 178 status code has been sent or received by the system enough to 179 exceed the configured threshold. 181 SIP-SERVER-MIB: Groups of objects for SIP Proxy, Redirect and 182 Registrar servers 183 o sipServerMIBObjects 184 * sipServerCfg: This object group defines common server 185 configuration objects including the SIP server host address. 186 * sipServerProxyCfg: This object group defines configuration 187 objects for SIP Proxy servers including the proxy mode of 188 operation (stateless, stateful, call stateful), the proxy 189 authentication method(s) and realm, etc. 190 * sipServerProxyStats: This object group defines a table 191 containing the statistics objects applicable to SIP proxy 192 servers. It includes the number of occurrences of unsupported 193 options being specified in received Proxy-Require headers. 194 * sipServerRegCfg: This object group defines common configuration 195 objects for SIP Registrar servers including the ability to 196 accept third-party registrations, the maximum registration 197 expiry that may be requested by user agents, the maximum number 198 of users the registrar can support, the number of currently 199 registered users, per contact registration information, etc. 200 * sipServerRegStats: This object group contains summary 201 statistics objects for SIP Registrar servers, precisely, the 202 number of REGISTER requests that have been accepted or 203 rejected. 205 SIP-UA-MIB: Group of objects for SIP User Agents. 206 o sipUAMIBObjects 207 * sipUACfgServer: This object group specifies SIP server 208 configuration objects applicable to SIP user agents including 209 the Internet address of the SIP Server to use to register, 210 proxy or redirect calls. 212 To conform with this specification, an SNMP agent MUST implement the 213 SIP-TC-MIB module, plus the SIP-COMMON-MIB module and one of the SIP 214 entity-type- specific MIB modules (SIP-SERVER-MIB or SIP-UA-MIB) as 215 applicable for each instance of a SIP entity being managed. If a 216 device has more than one SIP entity or multiple instances of the same 217 entity type, it MUST implement multiple SIP modules. Section 5.2 218 describes handling of multiple instances in detail. 220 5.1. Textual Conventions 222 The data types SipTCTransportProtocol, SipTCEntityRole, 223 SipTCOptionTagHeaders, and SipTCMethodName are defined in the SIP-TC- 224 MIB module and used as Textual Conventions in this document. 226 5.2. Relationship to the Network Services MIB 228 In the design of the SIP MIB, the authors considered the following 229 requirement: the SIP MIB must allow a single system with a single 230 SNMP agent to support multiple instances of various SIP MIB modules. 231 This requirement is met by using the framework provided by the 232 Network Services Monitoring MIB, NETWORK-SERVICES-MIB, RFC 2788 233 [RFC2788]. 235 A device implementing the SIP MIB MUST support the NETWORK-SERVICES- 236 MIB and, at a minimum, it MUST support the index and name objects 237 (applIndex and applName) in the application table (applTable). In 238 order to allow each instance of a SIP entity to be managed as a 239 separate network service application, a naming convention SHOULD be 240 used to make the application name unique. For example, if a system 241 is running 2 SIP UAs that need to be managed as 2 separate SIP 242 entities, by convention, the application names used in the Network 243 Services Monitoring MIB application table should be "sip_ua1" and 244 "sip_ua2". This convention allows each instance to have its own row 245 in the application table (applTable). 247 It is therefore RECOMMENDED to adopt the following application name 248 conventions: 249 o for a SIP Proxy entity, the applName value SHOULD be equal to a 250 character string starting with "sip_proxy" followed by a unique 251 application instance identifier, for example, "sip_proxy1", 252 "sip_proxy17" 253 o for a SIP Registrar entity, the applName value SHOULD be equal to 254 a character string starting with "sip_registrar" followed by a 255 unique application instance identifier, for example, 256 "sip_registrar1", "sip_registrar2" 257 o for a SIP User Agent entity, the applName value SHOULD be equal to 258 a character string starting with "sip_ua" followed by a unique 259 application instance identifier, for example, "sip_ua1", "sip_ua2" 260 o for any combination of Proxy, Registrar, or Redirect Server being 261 managed as a single aggregate entity, the applName value for the 262 combined server entity SHOULD reflect the appropriate combination 263 followed by a unique application instance identifier. In order to 264 facilitate consistent agent behavior and management application 265 expectations, the following order of names is RECOMMENDED: 266 * if Proxy exists, list first. 267 * if Proxy and Redirect exists, list Redirect second. 268 * if Registrar exists, always list last. 269 For example "sip_proxy1", "sip_proxy_registrar1", 270 "sip_proxy_redirect5", "sip_proxy_redirect_registrar2", or 271 "sip_registrar1". 272 o Note: the value of the network service application index 273 (applIndex) may be different from the instance identifier used in 274 the system (the applIndex is dynamically created and the value 275 assigned by the SNMP agent at the creation of the table entry 276 whereas the value of the instance identifier to be used in the 277 application name is provided as part of the application name 278 applName by the system administrator or configuration files of the 279 SIP entity). This note is illustrated in the first example 280 provided below. 282 Finally, the SNMP agent MAY support any combination of the other 283 attributes in applTable. If supported, the following objects SHOULD 284 have values populated as follows: 285 o applVersion: version of the SIP application, 286 o applUptime: the value of applUptime MUST be identical to the value 287 of sipCommonCfgServiceStartTime defined in the SIP-COMMON-MIB 288 module, 289 o applOperStatus: the value of applOperStatus SHOULD reflect the 290 operational status of sipCommonCfgServiceOperStatus, at least by 291 means of a mapping, 292 o applLastChange: the value of applLastChange MUST be identical to 293 the value of sipCommonCfgServiceLastChange defined in the SIP- 294 COMMON module. 296 A number of other objects are defined as part of the applTable. They 297 are not included for the sake of brevity and due to the fact that 298 they do not enhance the concept being presented. 300 Example 1: The tables below illustrate how a system acting as both 301 Proxy and Registrar server might be configured to maintain separate 302 SIP-COMMON-MIB instances. 304 The NETWORK-SERVICES-MIB applTable might be populated as follows: 306 +-----------+-------------------+----------------------+ 307 | applIndex | applName | applDescription | 308 +-----------+-------------------+----------------------+ 309 | 1 | "sip_proxy10" | "ACME SIP Proxy" | 310 | 2 | "sip_registrar17" | "ACME SIP Registrar" | 311 +-----------+-------------------+----------------------+ 313 The SIP-COMMON-MIB sipCommonCfgTable would have two rows: one for the 314 proxy (applIndex=1) and one for the registrar (applIndex=2). The 315 SIP-SERVER-MIB tables would, however, only be populated with one row 316 indexed by applIndex=1 and applIndex=2 respectively if the server 317 provides either proxy or registrar. 319 SIP-COMMON-MIB sipCommonCfgTable might be populated as: 321 +---------+------------------------+--------------------------+-----+ 322 | applInd | sipCommonCfgProtocolVe | sipCommonCfgServiceOperS | ... | 323 | e x | r sion | t atus | | 324 +---------+------------------------+--------------------------+-----+ 325 | 1 | "SIP/2.0" | up(1) | | 326 | 2 | "SIP/2.0" | restarting(4) | | 327 +---------+------------------------+--------------------------+-----+ 329 while sipServerProxyCfgTable in SIP-SERVER-MIB might be populated as: 331 +-----------+-------------------------------+-----+ 332 | applIndex | sipServerCfgProxyStatefulness | ... | 333 +-----------+-------------------------------+-----+ 334 | 1 | stateless(1) | | 335 +-----------+-------------------------------+-----+ 337 and sipServerRegUserTable in SIP-SERVER-MIB might be populated as: 339 +-----------+-----------------------+---------------------+-----+ 340 | applIndex | sipServerRegUserIndex | sipServerRegUserUri | ... | 341 +-----------+-----------------------+---------------------+-----+ 342 | 2 | 1 | bob@example.com | | 343 | 2 | 2 | alice@example.com | | 344 | 2 | 3 | jim@example.com | | 345 | 2 | 4 | john@example.com | | 346 +-----------+-----------------------+---------------------+-----+ 348 Example 2: 350 This example illustrates how to represent a system acting as both 351 Proxy and Registrar server, where the two entities share a single 352 instance of SIP-COMMON-MIB. 354 The NETWORK-SERVICES-MIB applTable might be populated as follows: 356 +-----------+------------------------+------------------------------+ 357 | applIndex | applName | applDescription | 358 +-----------+------------------------+------------------------------+ 359 | 1 | "sip_proxy_registrar1" | "ACME SIP Proxy and | 360 | | | Registrar" | 361 +-----------+------------------------+------------------------------+ 363 The SIP-COMMON-MIB sipCommonCfgTable would have only one row to cover 364 both the proxy and the registrar. 366 SIP-COMMON-MIB sipCommonCfgTable might be populated as: 368 +----------+--------------------------+-----------------------------+ 369 | applInde | sipCommonCfgProtocolVers | sipCommonCfgServiceOperStat | 370 | x | i on | u s | 371 +----------+--------------------------+-----------------------------+ 372 | 1 | "SIP/2.0" | up(1) | 373 +----------+--------------------------+-----------------------------+ 375 while sipServerRegUserTable in SIP-SERVER-MIB might be populated as: 377 +-----------+-----------------------+---------------------+-----+ 378 | applIndex | sipServerRegUserIndex | sipServerRegUserUri | ... | 379 +-----------+-----------------------+---------------------+-----+ 380 | 2 | 1 | bob@example.com | | 381 | 2 | 2 | alice@example.com | | 382 | 2 | 3 | kevin@example.com | | 383 | 2 | 4 | jf@example.com | | 384 +-----------+-----------------------+---------------------+-----+ 386 The NETWORK-SERVICES-MIB assocTable is not considered a requirement 387 for SIP systems. It is not a mandatory group for compliance with the 388 NETWORK-SERVICES-MIB module. 390 The relationship between the value of applOperStatus and 391 sipCommonCfgServiceOperStatus is as follows: 393 +-------------------------------+---------------+-------------------+ 394 | sipCommonCfgServiceOperStatus | -- | applOperStatus | 395 | | corresponds | | 396 | | to --> | | 397 +-------------------------------+---------------+-------------------+ 398 | up | --> | up | 399 | down | --> | down | 400 | congested | --> | congested | 401 | restarting | --> | restarting | 402 | quiescing | --> | quiescing | 403 | testing | --> | up | 404 | unknown | --> | --indeterminate-- | 405 +-------------------------------+---------------+-------------------+ 407 If the sipOperStatus is 'unknown' there is no corresponding value of 408 applOperStatus. Therefore, the last known value of applOperStatus 409 SHOULD be maintained until the sipOperStatus transitions to a value 410 that can be mapped appropriately. 412 5.3. IMPORTed MIB Modules and REFERENCE Clauses 414 The SIP MIB modules defined in this document IMPORT definitions 415 normatively from the following MIB modules, beyond [RFC2578], 416 [RFC2579] and [RFC2580]: INET-ADDRESS-MIB [RFC4001], NETWORK- 417 SERVICES-MIB [RFC2788], SNMP-FRAMEWORK-MIB [RFC3411]. 419 This MIB module also includes REFERENCE clauses that normatively 420 refer to SIP [RFC3261], and INET-ADDRESS-MIB [RFC4001]. 422 Finally, this MIB module makes informative references to several RFCs 423 in some of the examples described in the DESCRIPTION clauses, 424 including Reliability of Provisional Responses in SIP [RFC3262], and 425 SIP over SCTP [RFC4168]. 427 6. Accommodating SIP Extension Methods 429 The core set of SIP methods is defined in RFC 3261 [RFC3261]. Other 430 IETF RFCs define additional methods. In the future, additional 431 methods may be defined. In order to avoid having to update the SIP- 432 COMMON-MIB module to accommodate these extension methods, we use a 433 method identifier name (SipTCMethodName textual-convention) to 434 represent all SIP methods registered with IANA. See IANA 435 Consideration section. 437 For example, the sipCommonMethodSupportedTable is the main table for 438 listing all of the SIP methods supported by a system, including the 439 SIP methods defined in RFC 3261 [RFC3261] and other SIP methods 440 registered with IANA. The table is informational in nature and 441 populated by the system. Entries cannot be added or deleted by a 442 SNMP manager. 444 The SIP specification RFC 3261 [RFC3261] section 27.4 establishes the 445 sub-registries for SIP Methods and Response Codes under 446 http://www.iana.org/assignments/sip-parameters. This document uses 447 the existing sub-registry for the names of registered SIP method. 449 For example, in the sipCommonMethodSupportedTable of SIP-COMMON-MIB, 450 the sipCommonMethodSupportedName values can be represented as 451 follows: 453 +------------------------------+ 454 | sipCommonMethodSupportedName | 455 +------------------------------+ 456 | "ACK" | 457 | "BYE" | 458 | "CANCEL" | 459 | "INVITE" | 460 | "OPTIONS" | 461 +------------------------------+ 463 7. Definitions 465 7.1. SIP Textual Conventions 467 SIP-TC-MIB DEFINITIONS ::= BEGIN 469 IMPORTS 470 MODULE-IDENTITY, 471 mib-2 472 FROM SNMPv2-SMI -- RFC 2578 474 TEXTUAL-CONVENTION 475 FROM SNMPv2-TC; -- RFC 2579 477 sipTC MODULE-IDENTITY 478 LAST-UPDATED "200609121700Z" 479 ORGANIZATION "IETF Session Initiation Protocol Working Group" 480 CONTACT-INFO 481 "SIP WG email: sip@ietf.org 483 Co-editor Kevin Lingle 484 Cisco Systems, Inc. 485 postal: 7025 Kit Creek Road 486 P.O. Box 14987 487 Research Triangle Park, NC 27709 488 USA 489 email: klingle@cisco.com 490 phone: +1 919 392 2029 492 Co-editor Joon Maeng 493 email: jmaeng@austin.rr.com 494 Co-editor Jean-Francois Mule 495 CableLabs 496 postal: 858 Coal Creek Circle 497 Louisville, CO 80027 498 USA 499 email: jf.mule@cablelabs.com 500 phone: +1 303 661 9100 502 Co-editor Dave Walker 503 email: drwalker@rogers.com" 504 DESCRIPTION 505 "Session Initiation Protocol (SIP) MIB Textual Conventions 506 module used by other SIP-related MIB Modules. 508 Copyright (C) The Internet Society (2006). This version of 509 this MIB module is part of RFC XXXX; see the RFC itself for 510 full legal notices." 511 -- RFC Ed: replace XXXX with actual RFC number and remove this not 512 REVISION "200609121700Z" 513 DESCRIPTION 514 "Initial version of the IETF SIP-TC-MIB module. This version 515 published as part of RFC XXXX." 516 -- RFC Ed: replace XXXX with actual RFC number and remove this note 517 ::= { mib-2 XXX1 } 518 -- RFC Ed: replace XXX1 with actual IANA assigned number for this 519 -- sipTC mib module and remove this note 521 -- 522 -- Textual Conventions 523 -- 525 SipTCTransportProtocol ::= TEXTUAL-CONVENTION 526 STATUS current 527 DESCRIPTION 528 "This convention is a bit map. Each bit represents a transport 529 protocol. If a bit has value 1, then that selected transport 530 protocol is in some way dependent on the context of the object 531 using this convention. If a bit has value 0, then that 532 transport protocol is not selected. Combinations of bits can 533 be set when multiple transport protocols are selected. 535 bit 0: a protocol other than those defined here 536 bit 1: User Datagram Protocol bit 2 : Transmission Control 537 Protocol 538 bit 3: Stream Control Transmission Protocol 539 bit 4: Transport Layer Security Protocol over TCP 540 bit 5: Transport Layer Security Protocol over SCTP 541 " 543 REFERENCE "RFC 3261, Section 18 and RFC 4168" 544 SYNTAX BITS { 545 other(0), -- none of the following 546 udp(1), 547 tcp(2), 548 sctp(3), -- RFC4168 549 tlsTcp(4), 550 tlsSctp(5) -- RFC 4168 551 } 553 SipTCEntityRole ::= TEXTUAL-CONVENTION 554 STATUS current 555 DESCRIPTION 556 "This convention defines the role of a SIP entity. Examples of 557 SIP entities are proxies, user agents, redirect servers, 558 registrars or combinations of the above. 560 User Agent (UA): A logical entity that can act as both a user 561 agent client and user agent server. User Agent Client (UAC): 562 A logical entity that creates a new request, and then uses the 563 client transaction state machinery to send it. The role of UAC 564 lasts only for the duration of that transaction. In other 565 words, if a piece of software initiates a request, it acts as 566 a UAC for the duration of that transaction. If it receives a 567 request later, it assumes the role of a user agent server for 568 the processing of that transaction. User Agent Server (UAS): 569 a logical entity that generates a response to a SIP request. 570 The response accepts, rejects, or redirects the request. This 571 role lasts only for the duration of that transaction. In 572 other words, if a piece of software responds to a request, it 573 acts as a UAS for the duration of that transaction. If it 574 generates a request later, it assumes the role of a user agent 575 client for the processing of that transaction. 577 Proxy, Proxy Server: An intermediary entity that acts as both 578 a server and a client for the purpose of making requests on 579 behalf of other clients. A proxy server primarily plays the 580 role of routing, which means its job is to ensure that a 581 request is sent to another entity 'closer' to the targeted 582 user. Proxies are also useful for enforcing policy. A proxy 583 interprets, and, if necessary, rewrites specific parts of a 584 request message before forwarding it. 586 Redirect Server: A redirect server is a user agent server that 587 generates 3xx responses to requests it receives, directing the 588 client to contact an alternate set of URIs. 590 Registrar: A registrar is a server that accepts REGISTER 591 requests and places the information it receives in those 592 requests into the location service for the domain it handles." 593 REFERENCE 594 "RFC 3261, Section 6" 595 SYNTAX BITS { 596 other(0), 597 userAgent(1), 598 proxyServer(2), 599 redirectServer(3), 600 registrarServer(4) 601 } 603 SipTCOptionTagHeaders ::= TEXTUAL-CONVENTION 604 STATUS current 605 DESCRIPTION 606 "This convention defines the header fields that use the option 607 tags per section 19.2 of RFC 3261. These tags are used in 608 Require (Section 20.32), Proxy-Require (Section 20.29), 609 Supported (Section 20.37) and Unsupported (Section 20.40) 610 header fields." 611 REFERENCE 612 "RFC 3261, Sections 19.2, 20.32, 20.29, 20.37 and 20.40" 613 SYNTAX BITS { 614 require(0), -- Require header 615 proxyRequire(1), -- Proxy-Require header 616 supported(2), -- Supported header 617 unsupported(3) -- Unsupported header 618 } 620 SipTCMethodName ::= TEXTUAL-CONVENTION 621 STATUS current 622 DESCRIPTION 623 "This textual convention is a string that uniquely identifies a 624 SIP method. The scope of uniqueness is the context of all 625 defined SIP methods. 627 Experimental support of extension methods is acceptable and 628 expected. Extension methods are those defined in 629 Internet-Draft documents but not yet allocated an official 630 sanctioned by IANA. 632 To support experimental extension methods, any object using 633 this textual convention as syntax MAY return/accept a method 634 identifier value other than those sanctioned by IANA. That 635 system MUST ensure no collisions with officially assigned 636 method names." 637 REFERENCE 638 "RFC 3261, Section 27.4" 640 SYNTAX OCTET STRING (SIZE (1..100)) 642 END 644 7.2. SIP Common MIB Module 646 SIP-COMMON-MIB DEFINITIONS ::= BEGIN 648 IMPORTS 649 MODULE-IDENTITY, 650 OBJECT-TYPE, 651 NOTIFICATION-TYPE, 652 Counter32, 653 Gauge32, 654 TimeTicks, 655 Unsigned32, 656 mib-2 657 FROM SNMPv2-SMI -- RFC 2578 659 RowStatus, 660 TimeStamp, 661 TruthValue 662 FROM SNMPv2-TC -- RFC 2579 664 MODULE-COMPLIANCE, 665 OBJECT-GROUP, 666 NOTIFICATION-GROUP 667 FROM SNMPv2-CONF -- RFC 2580 669 SnmpAdminString 670 FROM SNMP-FRAMEWORK-MIB -- RFC 3411 672 SipTCTransportProtocol, 673 SipTCMethodName, 674 SipTCEntityRole, 675 SipTCOptionTagHeaders 676 FROM SIP-TC-MIB 678 applIndex 679 FROM NETWORK-SERVICES-MIB -- RFC 2788 681 InetPortNumber 682 FROM INET-ADDRESS-MIB; -- RFC 4001 684 sipCommonMIB MODULE-IDENTITY 685 LAST-UPDATED "200609121700Z" 686 ORGANIZATION "IETF Session Initiation Protocol Working Group" 687 CONTACT-INFO 688 "SIP WG email: sip@ietf.org 690 Co-editor Kevin Lingle 691 Cisco Systems, Inc. 692 postal: 7025 Kit Creek Road 693 P.O. Box 14987 694 Research Triangle Park, NC 27709 695 USA 696 email: klingle@cisco.com 697 phone: +1 919 392 2029 699 Co-editor Joon Maeng 700 email: jmaeng@austin.rr.com 702 Co-editor Jean-Francois Mule 703 CableLabs 704 postal: 858 Coal Creek Circle 705 Louisville, CO 80027 706 USA 707 email: jf.mule@cablelabs.com 708 phone: +1 303 661 9100 710 Co-editor Dave Walker 711 email: drwalker@rogers.com" 712 DESCRIPTION 713 "Session Initiation Protocol (SIP) Common MIB module. This 714 module defines objects which may be common to all SIP entities. 716 SIP is an application-layer signaling protocol for creating, 717 modifying and terminating multimedia sessions with one or more 718 participants. These sessions include Internet multimedia 719 conferences and Internet telephone calls. SIP is defined in 720 RFC 3261 (June 2002). 722 This MIB is defined for managing objects which are common to 723 SIP User Agents (UAs), Proxy, Redirect and Registrar servers. 724 Objects specific to each of these entities MAY be managed using 725 entity specific MIBs defined in other modules. 727 Copyright (C) The Internet Society (2006). This version of 728 this MIB module is part of RFC XXXX; see the RFC itself for 729 full legal notices." 730 -- RFC Ed: replace XXXX with actual RFC number and 731 -- remove this note 732 REVISION "200609121700Z" 733 DESCRIPTION 734 "Initial version of the IETF SIP-COMMON-MIB module. This 735 version published as part of RFC XXXX." 737 -- RFC Ed: replace XXXX with actual RFC number and remove this note 738 ::= { mib-2 XXX2 } 739 -- RFC Ed: replace XXX2 with actual IANA assigned number and 740 -- remove this note 742 -- Top-Level Components of this MIB. 743 sipCommonMIBNotifications OBJECT IDENTIFIER ::= { sipCommonMIB 0 } 744 sipCommonMIBObjects OBJECT IDENTIFIER ::= { sipCommonMIB 1 } 745 sipCommonMIBConformance OBJECT IDENTIFIER ::= { sipCommonMIB 2 } 747 -- 748 -- This MIB contains objects that are common to all SIP entities. 749 -- 751 -- Common basic configuration 752 sipCommonCfgBase OBJECT IDENTIFIER ::= { sipCommonMIBObjects 1 } 754 -- Protocol timer configuration 755 sipCommonCfgTimer OBJECT IDENTIFIER ::= { sipCommonMIBObjects 2 } 757 -- SIP message summary statistics 758 sipCommonSummaryStats OBJECT IDENTIFIER ::= { sipCommonMIBObjects 3 } 760 -- Per method statistics 761 sipCommonMethodStats OBJECT IDENTIFIER ::= { sipCommonMIBObjects 4 } 763 -- Per Status code or status code class statistics 764 sipCommonStatusCode OBJECT IDENTIFIER ::= { sipCommonMIBObjects 5 } 766 -- Transaction statistics 767 sipCommonStatsTrans OBJECT IDENTIFIER ::= { sipCommonMIBObjects 6 } 769 -- Method retry statistics 770 sipCommonStatsRetry OBJECT IDENTIFIER ::= { sipCommonMIBObjects 7 } 772 -- Other statistics 773 sipCommonOtherStats OBJECT IDENTIFIER ::= { sipCommonMIBObjects 8 } 775 -- Accessible-for-notify objects 776 sipCommonNotifObjects OBJECT IDENTIFIER ::= { sipCommonMIBObjects 9 } 778 -- 779 -- Common Configuration Objects 780 -- 781 sipCommonCfgTable OBJECT-TYPE 782 SYNTAX SEQUENCE OF SipCommonCfgEntry 783 MAX-ACCESS not-accessible 784 STATUS current 785 DESCRIPTION 786 "This table contains the common configuration objects applicable 787 to all SIP entities." 788 ::= { sipCommonCfgBase 1 } 790 sipCommonCfgEntry OBJECT-TYPE 791 SYNTAX SipCommonCfgEntry 792 MAX-ACCESS not-accessible 793 STATUS current 794 DESCRIPTION 795 "A row of common configuration. 797 Each row represents objects for a particular SIP entity 798 instance present in this system. applIndex is used to uniquely 799 identify these instances of SIP entities and correlate them 800 through the common framework of the NETWORK-SERVICES-MIB (RFC 801 2788)." 802 INDEX { applIndex } 803 ::= { sipCommonCfgTable 1 } 805 SipCommonCfgEntry ::= SEQUENCE { 806 sipCommonCfgProtocolVersion SnmpAdminString, 807 sipCommonCfgServiceOperStatus INTEGER, 808 sipCommonCfgServiceStartTime TimeTicks, 809 sipCommonCfgServiceLastChange TimeTicks, 810 sipCommonCfgOrganization SnmpAdminString, 811 sipCommonCfgMaxTransactions Unsigned32, 812 sipCommonCfgServiceNotifEnable BITS, 813 sipCommonCfgEntityType SipTCEntityRole 814 } 816 sipCommonCfgProtocolVersion OBJECT-TYPE 817 SYNTAX SnmpAdminString 818 MAX-ACCESS read-only 819 STATUS current 820 DESCRIPTION 821 "This object will reflect the version of SIP supported by this 822 SIP entity. It will follow the same format as SIP version 823 information contained in the SIP messages generated by this SIP 824 entity. For example, entities supporting SIP version 2 will 825 return 'SIP/2.0' as dictated by the standard." 826 REFERENCE 827 "RFC 3261, Section 7.1" 828 ::= { sipCommonCfgEntry 1 } 830 sipCommonCfgServiceOperStatus OBJECT-TYPE 831 SYNTAX INTEGER { 832 unknown(1), 833 up(2), 834 down(3), 835 congested(4), 836 restarting(5), 837 quiescing(6), 838 testing(7) 839 } 840 MAX-ACCESS read-only 841 STATUS current 842 DESCRIPTION 843 "This object contains the current operational state of 844 the SIP application. 846 unknown : The operational status cannot be determined 847 for some reason. 848 up : The application is operating normally, and is 849 processing (receiving and possibly issuing) SIP 850 requests and responses. 851 down : The application is currently unable to process 852 SIP messages. 853 congested : The application is operational but no additional 854 inbound transactions can be accommodated at the 855 moment. 856 restarting : The application is currently unavailable but it 857 is in the process of restarting and will, 858 presumably, soon be able to process SIP messages. 859 quiescing : The application is currently operational 860 but has been administratively put into 861 quiescence mode. Additional inbound 862 transactions MAY be rejected. 863 testing : The application is currently in test mode 864 and MAY not be able to process SIP messages. 866 The operational status values defined for this object are not 867 based on any specific information contained in the SIP 868 standard." 869 ::= { sipCommonCfgEntry 2 } 871 sipCommonCfgServiceStartTime OBJECT-TYPE 872 SYNTAX TimeTicks 873 MAX-ACCESS read-only 874 STATUS current 875 DESCRIPTION 876 "The value of sysUpTime at the time the SIP entity was last 877 started. If started prior to the last re-initialization of the 878 local network management subsystem, then this object contains a 879 zero value." 880 ::= { sipCommonCfgEntry 3 } 882 sipCommonCfgServiceLastChange OBJECT-TYPE 883 SYNTAX TimeTicks 884 MAX-ACCESS read-only 885 STATUS current 886 DESCRIPTION 887 "The value of sysUpTime at the time the SIP entity entered its 888 current operational state. If the current state was entered 889 prior to the last re-initialization of the local network 890 management subsystem, then this object contains a zero value." 891 ::= { sipCommonCfgEntry 4 } 893 sipCommonCfgOrganization OBJECT-TYPE 894 SYNTAX SnmpAdminString 895 MAX-ACCESS read-only 896 STATUS current 897 DESCRIPTION 898 "This object contains the organization name which the SIP entity 899 inserts into Organization headers of SIP messages processed by 900 this system. If the string is empty, no Organization header is 901 to be generated." 902 REFERENCE 903 "RFC 3261, Section 20.25" 904 ::= { sipCommonCfgEntry 5 } 906 sipCommonCfgMaxTransactions OBJECT-TYPE 907 SYNTAX Unsigned32 (1..4294967295) 908 MAX-ACCESS read-only 909 STATUS current 910 DESCRIPTION 911 "This object indicates the maximum number of simultaneous 912 transactions per second that the SIP entity can manage. In 913 general, the value of this object SHOULD reflect a level of 914 transaction processing per second that is considered high 915 enough to impact the system's CPU and/or memory resources to 916 the point of deteriorating SIP call processing but not high 917 enough to cause catastrophic system failure." 918 ::= { sipCommonCfgEntry 6 } 920 sipCommonCfgServiceNotifEnable OBJECT-TYPE 921 SYNTAX BITS { 922 sipCommonServiceColdStart(0), 923 sipCommonServiceWarmStart(1), 924 sipCommonServiceStatusChanged(2) 925 } 926 MAX-ACCESS read-write 927 STATUS current 928 DESCRIPTION 929 "This object specifies which SIP service related notifications 930 are enabled. Each bit represents a specific notification. If 931 a bit has a value 1, the associated notification is enabled and 932 will be generated by the SIP entity at the appropriate time. 934 Support for these notifications is OPTIONAL: either none or all 935 notification values are supported. If an implementation does 936 not support this object, it should return a 'noSuchObject' 937 exception to an SNMP GET operation. If notifications are 938 supported, this object's default value SHOULD reflect 939 sipCommonServiceColdStart and sipCommonServiceWarmStart enabled 940 and sipCommonServiceStatusChanged disabled. 942 This object value SHOULD persist across reboots." 943 DEFVAL { { sipCommonServiceColdStart, 944 sipCommonServiceWarmStart } } 945 ::= { sipCommonCfgEntry 7 } 947 sipCommonCfgEntityType OBJECT-TYPE 948 SYNTAX SipTCEntityRole 949 MAX-ACCESS read-only 950 STATUS current 951 DESCRIPTION 952 "This object identifies the list of SIP entities this row is 953 related to. It is defined as a bit map. Each bit represents a 954 type of SIP entity. If a bit has value 1, the SIP entity 955 represented by this row plays the role of this entity type. If 956 a bit has value 0, the SIP entity represented by this row does 957 not act as this entity type Combinations of bits can be set 958 when the SIP entity plays multiple SIP roles." 959 ::= { sipCommonCfgEntry 8 } 961 -- 962 -- Support for multiple ports 963 -- 964 sipCommonPortTable OBJECT-TYPE 965 SYNTAX SEQUENCE OF SipCommonPortEntry 966 MAX-ACCESS not-accessible 967 STATUS current 968 DESCRIPTION 969 "This table contains the list of ports that each SIP entity in 970 this system is allowed to use. These ports can be advertised 971 using the Contact header in a REGISTER request or response." 972 ::= { sipCommonCfgBase 2 } 974 sipCommonPortEntry OBJECT-TYPE 975 SYNTAX SipCommonPortEntry 976 MAX-ACCESS not-accessible 977 STATUS current 978 DESCRIPTION 979 "Specification of a particular port. 981 Each row represents those objects for a particular SIP entity 982 present in this system. applIndex is used to uniquely identify 983 these instances of SIP entities and correlate them through the 984 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 985 INDEX { applIndex, sipCommonPort } 986 ::= { sipCommonPortTable 1 } 988 SipCommonPortEntry ::= SEQUENCE { 989 sipCommonPort InetPortNumber, 990 sipCommonPortTransportRcv SipTCTransportProtocol 991 } 993 sipCommonPort OBJECT-TYPE 994 SYNTAX InetPortNumber (1..65535) 995 MAX-ACCESS not-accessible 996 STATUS current 997 DESCRIPTION 998 "This object reflects a particular port that can be used by the 999 SIP application." 1000 ::= { sipCommonPortEntry 1 } 1002 sipCommonPortTransportRcv OBJECT-TYPE 1003 SYNTAX SipTCTransportProtocol 1004 MAX-ACCESS read-only 1005 STATUS current 1006 DESCRIPTION 1007 "This object will specify the transport protocol the SIP entity 1008 will use to receive SIP messages. 1010 This object is a bit map. Each bit represents a transport 1011 protocol. If a bit has value 1, then that transport protocol 1012 is currently being used. If a bit has value 0, then that 1013 transport protocol is currently not being used." 1014 ::= { sipCommonPortEntry 2 } 1016 -- 1017 -- Support for SIP option tags (SIP extensions). 1018 -- SIP extensions MAY be supported or required by SIP entities. 1019 -- 1021 sipCommonOptionTagTable OBJECT-TYPE 1022 SYNTAX SEQUENCE OF SipCommonOptionTagEntry 1023 MAX-ACCESS not-accessible 1024 STATUS current 1025 DESCRIPTION 1026 "This table contains a list of the SIP option tags (SIP 1027 extensions) that either required, supported, or unsupported by 1028 the SIP entity. These option tags are used in the Require, 1029 Proxy-Require, Supported and Unsupported header fields. 1031 Example: if a user agent client supports and requires the 1032 server to support reliability of provisional responses (IETF 1033 RFC 3262), this table contains a row with the option tag string 1034 '100rel' in sipCommonOptionTag and the OCTET STRING value of 1035 '1010 0000' or '0xA0' in sipCommonOptionTagHeaderField. 1037 If a server does not support the required feature (indicated in 1038 a Require header to a UAS, or in a Proxy-Require to a Proxy 1039 Server), the server returns a 420 Bad Extension listing the 1040 feature in an Unsupported header. 1042 Normally the list of such features supported by an entity is 1043 static (i.e. will not change over time)." 1044 REFERENCE 1045 "RFC 3261, Sections 19.2, 20.32, 20.29, 20.37, and 20.40" 1046 ::= { sipCommonCfgBase 3 } 1048 sipCommonOptionTagEntry OBJECT-TYPE 1049 SYNTAX SipCommonOptionTagEntry 1050 MAX-ACCESS not-accessible 1051 STATUS current 1052 DESCRIPTION 1053 "A particular SIP option tag (extension) supported or 1054 unsupported by the SIP entity, and which may be supported or 1055 required by a peer. 1057 Each row represents those objects for a particular SIP entity 1058 present in this system. applIndex is used to uniquely identify 1059 these instances of SIP entities and correlate them through the 1060 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 1061 INDEX { applIndex, sipCommonOptionTagIndex } 1062 ::= { sipCommonOptionTagTable 1 } 1064 SipCommonOptionTagEntry ::= SEQUENCE { 1065 sipCommonOptionTagIndex Unsigned32, 1066 sipCommonOptionTag SnmpAdminString, 1067 sipCommonOptionTagHeaderField SipTCOptionTagHeaders 1068 } 1070 sipCommonOptionTagIndex OBJECT-TYPE 1071 SYNTAX Unsigned32 (1..4294967295) 1072 MAX-ACCESS not-accessible 1073 STATUS current 1074 DESCRIPTION 1075 "This object uniquely identifies a conceptual row in the table." 1076 ::= { sipCommonOptionTagEntry 1 } 1078 sipCommonOptionTag OBJECT-TYPE 1079 SYNTAX SnmpAdminString 1080 MAX-ACCESS read-only 1081 STATUS current 1082 DESCRIPTION 1083 "This object indicates the SIP option tag. The option tag names 1084 are registered with IANA and available at http://www.iana.org." 1085 REFERENCE "RFC 3261, Section 27.1" 1086 ::= { sipCommonOptionTagEntry 2 } 1088 sipCommonOptionTagHeaderField OBJECT-TYPE 1089 SYNTAX SipTCOptionTagHeaders 1090 MAX-ACCESS read-only 1091 STATUS current 1092 DESCRIPTION 1093 "This object indicates whether the SIP option tag is supported 1094 (Supported header), unsupported (Unsupported header), required 1095 (Require or Proxy-Require header) by the SIP entity. A SIP 1096 option tag may be both supported and required." 1097 ::= { sipCommonOptionTagEntry 3 } 1099 -- 1100 -- Supported SIP Methods 1101 -- 1102 sipCommonMethodSupportedTable OBJECT-TYPE 1103 SYNTAX SEQUENCE OF SipCommonMethodSupportedEntry 1104 MAX-ACCESS not-accessible 1105 STATUS current 1106 DESCRIPTION 1107 "This table contains a list of methods supported by each SIP 1108 entity in this system (see the standard set of SIP methods in 1109 Section 7.1 of RFC 3261). Any additional methods that may be 1110 incorporated into the SIP protocol can be represented by this 1111 table without any requirement to update this MIB module. 1113 The table is informational in nature; conveying to the NMS 1114 capabilities of the managed system. 1116 From a protocol point of view, the list of methods advertised 1117 by the SIP entity in the Allow header (Section 20.5 of RFC 1118 3261) MUST be consistent with the methods reflected in this 1119 table." 1120 ::= { sipCommonCfgBase 4 } 1122 sipCommonMethodSupportedEntry OBJECT-TYPE 1123 SYNTAX SipCommonMethodSupportedEntry 1124 MAX-ACCESS not-accessible 1125 STATUS current 1126 DESCRIPTION 1127 "A particular method supported by the SIP entity. 1129 Each row represents those objects for a particular SIP entity 1130 present in this system. applIndex is used to uniquely identify 1131 these instances of SIP entities and correlate them through the 1132 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 1133 INDEX { applIndex, sipCommonMethodSupportedIndex } 1134 ::= { sipCommonMethodSupportedTable 1 } 1136 SipCommonMethodSupportedEntry ::= SEQUENCE { 1137 sipCommonMethodSupportedIndex Unsigned32, 1138 sipCommonMethodSupportedName SipTCMethodName 1139 } 1141 sipCommonMethodSupportedIndex OBJECT-TYPE 1142 SYNTAX Unsigned32 (1..4294967295) 1143 MAX-ACCESS not-accessible 1144 STATUS current 1145 DESCRIPTION 1146 "This object uniquely identifies a conceptual row in the table 1147 and reflects an assigned number used to identifier a specific 1148 SIP method. 1150 This identifier is suitable for referencing the associated 1151 method throughout this and other MIBs supported by this managed 1152 system." 1153 ::= { sipCommonMethodSupportedEntry 1 } 1155 sipCommonMethodSupportedName OBJECT-TYPE 1156 SYNTAX SipTCMethodName 1157 MAX-ACCESS read-only 1158 STATUS current 1159 DESCRIPTION 1160 "This object reflects the supported method's name. The method 1161 name MUST be all upper case (e.g, 'INVITE')." 1162 ::= { sipCommonMethodSupportedEntry 2 } 1164 -- 1165 -- SIP Timer Configuration 1166 -- 1167 sipCommonCfgTimerTable OBJECT-TYPE 1168 SYNTAX SEQUENCE OF SipCommonCfgTimerEntry 1169 MAX-ACCESS not-accessible 1170 STATUS current 1171 DESCRIPTION 1172 "This table contains timer configuration objects applicable to 1173 SIP user agent and SIP stateful Proxy Server entities." 1174 ::= { sipCommonCfgTimer 1 } 1176 sipCommonCfgTimerEntry OBJECT-TYPE 1177 SYNTAX SipCommonCfgTimerEntry 1178 MAX-ACCESS not-accessible 1179 STATUS current 1180 DESCRIPTION 1181 "A row of timer configuration. 1183 Each row represents those objects for a particular SIP entity 1184 present in this system. applIndex is used to uniquely identify 1185 these instances of SIP entities and correlate them through the 1186 common framework of the NETWORK-SERVICES-MIB (RFC 2788). The 1187 objects in this table entry SHOULD be non-volatile and their 1188 value SHOULD be kept at reboot." 1189 INDEX { applIndex } 1190 ::= { sipCommonCfgTimerTable 1 } 1192 SipCommonCfgTimerEntry ::= SEQUENCE { 1193 sipCommonCfgTimerA Unsigned32, 1194 sipCommonCfgTimerB Unsigned32, 1195 sipCommonCfgTimerC Unsigned32, 1196 sipCommonCfgTimerD Unsigned32, 1197 sipCommonCfgTimerE Unsigned32, 1198 sipCommonCfgTimerF Unsigned32, 1199 sipCommonCfgTimerG Unsigned32, 1200 sipCommonCfgTimerH Unsigned32, 1201 sipCommonCfgTimerI Unsigned32, 1202 sipCommonCfgTimerJ Unsigned32, 1203 sipCommonCfgTimerK Unsigned32, 1204 sipCommonCfgTimerT1 Unsigned32, 1205 sipCommonCfgTimerT2 Unsigned32, 1206 sipCommonCfgTimerT4 Unsigned32 1207 } 1209 sipCommonCfgTimerA OBJECT-TYPE 1210 SYNTAX Unsigned32 (100..1000) 1211 UNITS "milliseconds" 1212 MAX-ACCESS read-only 1213 STATUS current 1214 DESCRIPTION 1215 "This object reflects the initial value for the retransmit timer 1216 for the INVITE method. The retransmit timer doubles after each 1217 retransmission, ensuring an exponential backoff in network 1218 traffic. This object represents the initial time a SIP entity 1219 will wait to receive a provisional response to an INVITE before 1220 resending the INVITE request." 1221 REFERENCE 1222 "RFC 3261, Section 17.1.1.2" 1223 DEFVAL { 500 } 1224 ::= { sipCommonCfgTimerEntry 1 } 1226 sipCommonCfgTimerB OBJECT-TYPE 1227 SYNTAX Unsigned32 (32000..300000) 1228 UNITS "milliseconds" 1229 MAX-ACCESS read-only 1230 STATUS current 1231 DESCRIPTION 1232 "This object reflects the maximum time a SIP entity will wait to 1233 receive a final response to an INVITE. The timer is started 1234 upon transmission of the initial INVITE request." 1235 REFERENCE 1236 "RFC 3261, Section 17.1.1.2" 1237 DEFVAL { 32000 } 1238 ::= { sipCommonCfgTimerEntry 2 } 1240 sipCommonCfgTimerC OBJECT-TYPE 1241 SYNTAX Unsigned32 (180000..300000) 1242 UNITS "milliseconds" 1243 MAX-ACCESS read-only 1244 STATUS current 1245 DESCRIPTION 1246 "This object reflects the maximum time a SIP Proxy Server will 1247 wait to receive a provisional response to an INVITE. The Timer 1248 C MUST be set for each client transaction when an INVITE 1249 request is proxied." 1250 REFERENCE 1251 "RFC 3261, Section 16.6" 1252 DEFVAL { 180000 } 1253 ::= { sipCommonCfgTimerEntry 3 } 1255 sipCommonCfgTimerD OBJECT-TYPE 1256 SYNTAX Unsigned32 (0..300000) 1257 UNITS "milliseconds" 1258 MAX-ACCESS read-only 1259 STATUS current 1260 DESCRIPTION 1261 "This object reflects the amount of time that the server 1262 transaction can remain in the 'Completed' state when unreliable 1263 transports are used. The default value MUST be equal or greater 1264 than 32000 for UDP transport and its value MUST be 0 for 1265 TCP/SCTP transport." 1267 REFERENCE 1268 "RFC 3261, Section 17.1.1.2" 1269 DEFVAL { 32000 } 1270 ::= { sipCommonCfgTimerEntry 4 } 1272 sipCommonCfgTimerE OBJECT-TYPE 1273 SYNTAX Unsigned32 (100..1000) 1274 UNITS "milliseconds" 1275 MAX-ACCESS read-only 1276 STATUS current 1277 DESCRIPTION 1278 "This object reflects the initial value for the retransmit timer 1279 for a non-INVITE method while in 'Trying State'. The 1280 retransmit timer doubles after each retransmission until it 1281 reaches T2 to ensure an exponential backoff in network traffic. 1282 This object represents the initial time a SIP entity will wait 1283 to receive a provisional response to the request before 1284 resending the non-INVITE request." 1285 REFERENCE 1286 "RFC 3261, Section 17.1.2.2" 1287 DEFVAL { 500 } 1288 ::= { sipCommonCfgTimerEntry 5 } 1290 sipCommonCfgTimerF OBJECT-TYPE 1291 SYNTAX Unsigned32 (32000..300000) 1292 UNITS "milliseconds" 1293 MAX-ACCESS read-only 1294 STATUS current 1295 DESCRIPTION 1296 "This object reflects the maximum time a SIP entity will wait to 1297 receive a final response to a non-INVITE request. The timer is 1298 started upon transmission of the initial request." 1299 REFERENCE 1300 "RFC 3261, Section 17.1.2.2" 1301 DEFVAL { 32000 } 1303 ::= { sipCommonCfgTimerEntry 6 } 1305 sipCommonCfgTimerG OBJECT-TYPE 1306 SYNTAX Unsigned32 (0..1000) 1307 UNITS "milliseconds" 1308 MAX-ACCESS read-only 1309 STATUS current 1310 DESCRIPTION 1311 "This object reflects the initial value for the retransmit timer 1312 for final responses to INVITE requests. If timer G fires, the 1313 response is passed to the transport layer once more for 1314 retransmission, and timer G is set to fire in MIN(2*T1, T2) 1315 seconds. From then on, when timer G fires, the response is 1316 passed to the transport again for transmission, and timer G is 1317 reset with a value that doubles, unless that value exceeds T2, 1318 in which case it is reset with the value of T2. The default 1319 value MUST be T1 for UDP transport and its value MUST be 0 for 1320 reliable transport like TCP/SCTP." 1321 REFERENCE 1322 "RFC 3261, Section 17.2.1" 1323 DEFVAL { 500 } 1324 ::= { sipCommonCfgTimerEntry 7 } 1326 sipCommonCfgTimerH OBJECT-TYPE 1327 SYNTAX Unsigned32 (32000..300000) 1328 UNITS "milliseconds" 1329 MAX-ACCESS read-only 1330 STATUS current 1331 DESCRIPTION 1332 "This object reflects the maximum time a server will wait to 1333 receive an ACK before it abandons retransmitting the response. 1334 The timer is started upon entering the 'Completed' state." 1335 REFERENCE 1336 "RFC 3261, Section 17.2.1" 1337 DEFVAL { 32000 } 1338 ::= { sipCommonCfgTimerEntry 8 } 1340 sipCommonCfgTimerI OBJECT-TYPE 1341 SYNTAX Unsigned32 (0..10000) 1342 UNITS "milliseconds" 1343 MAX-ACCESS read-only 1344 STATUS current 1345 DESCRIPTION 1346 "This object reflects the maximum time a SIP entity will wait to 1347 receive additional ACK message retransmissions. 1349 The timer is started upon entering the 'Confirmed' state. The 1350 default value MUST be T4 for UDP transport and its value MUST 1351 be 0 for reliable transport like TCP/SCTP." 1352 REFERENCE 1353 "RFC 3261, Section 17.2.1" 1354 DEFVAL { 5000 } 1355 ::= { sipCommonCfgTimerEntry 9 } 1357 sipCommonCfgTimerJ OBJECT-TYPE 1358 SYNTAX Unsigned32 (32000..300000) 1359 UNITS "milliseconds" 1360 MAX-ACCESS read-only 1361 STATUS current 1362 DESCRIPTION 1363 "This object reflects the maximum time a SIP server will wait to 1364 receive retransmissions of non-INVITE request. The timer is 1365 started upon entering the 'Completed' state for non-INVITE 1366 transactions. When timer J fires, the server MUST transition to 1367 the 'Terminated' state." 1368 REFERENCE 1369 "RFC 3261, Section 17.2.2" 1370 DEFVAL { 32000 } 1371 ::= { sipCommonCfgTimerEntry 10 } 1373 sipCommonCfgTimerK OBJECT-TYPE 1374 SYNTAX Unsigned32 (0..10000) 1375 UNITS "milliseconds" 1376 MAX-ACCESS read-only 1377 STATUS current 1378 DESCRIPTION 1379 "This object reflects the maximum time a SIP client will wait to 1380 receive retransmissions of responses to non-INVITE requests. 1381 The timer is started upon entering the 'Completed' state for 1382 non-INVITE transactions. When timer K fires, the server MUST 1383 transition to the 'Terminated' state. The default value MUST 1384 be T4 for UDP transport and its value MUST be 0 for reliable 1385 transport like TCP/SCTP." 1386 REFERENCE 1387 "RFC 3261, Section 17.1.2.2" 1388 DEFVAL { 5000 } 1389 ::= { sipCommonCfgTimerEntry 11 } 1391 sipCommonCfgTimerT1 OBJECT-TYPE 1392 SYNTAX Unsigned32 (200..10000) 1393 UNITS "milliseconds" 1394 MAX-ACCESS read-only 1395 STATUS current 1396 DESCRIPTION 1397 "This object reflects the T1 timer for a SIP entity. T1 is an 1398 estimate of the round-trip time (RTT) between the client and 1399 server transactions." 1400 REFERENCE 1401 "RFC 3261, Section 17" 1402 DEFVAL { 500 } 1403 ::= { sipCommonCfgTimerEntry 12 } 1405 sipCommonCfgTimerT2 OBJECT-TYPE 1406 SYNTAX Unsigned32 (200..10000) 1407 UNITS "milliseconds" 1408 MAX-ACCESS read-only 1409 STATUS current 1410 DESCRIPTION 1411 "This object reflects the T2 timer for a SIP entity. T2 is the 1412 maximum retransmit interval for non-INVITE requests and INVITE 1413 responses. It's used in various parts of the protocol to reset 1414 other Timer* objects to this value." 1415 REFERENCE 1416 "RFC 3261, Section 17" 1417 DEFVAL { 4000 } 1418 ::= { sipCommonCfgTimerEntry 13 } 1420 sipCommonCfgTimerT4 OBJECT-TYPE 1421 SYNTAX Unsigned32 (200..10000) 1422 UNITS "milliseconds" 1423 MAX-ACCESS read-only 1424 STATUS current 1425 DESCRIPTION 1426 "This object reflects the T4 timer for a SIP entity. T4 is the 1427 maximum duration a message will remain in the network. It 1428 represents the amount of time the network will take to clear 1429 messages between client and server transactions. It's used in 1430 various parts of the protocol to reset other Timer* objects to 1431 this value." 1432 REFERENCE 1433 "RFC 3261, Section 17" 1434 DEFVAL { 5000 } 1435 ::= { sipCommonCfgTimerEntry 14 } 1437 -- 1438 -- Common Statistics Objects 1439 -- 1441 -- 1442 -- Summary Statistics 1443 -- 1444 sipCommonSummaryStatsTable OBJECT-TYPE 1445 SYNTAX SEQUENCE OF SipCommonSummaryStatsEntry 1446 MAX-ACCESS not-accessible 1447 STATUS current 1448 DESCRIPTION 1449 "This table contains the summary statistics objects applicable 1450 to all SIP entities. Each row represents those objects for a 1451 particular SIP entity present in this system." 1452 ::= { sipCommonSummaryStats 1 } 1454 sipCommonSummaryStatsEntry OBJECT-TYPE 1455 SYNTAX SipCommonSummaryStatsEntry 1456 MAX-ACCESS not-accessible 1457 STATUS current 1458 DESCRIPTION 1459 "A row of summary statistics. 1461 Each row represents those objects for a particular SIP entity 1462 present in this system. applIndex is used to uniquely identify 1463 these instances of SIP entities and correlate them through the 1464 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 1465 INDEX { applIndex } 1466 ::= { sipCommonSummaryStatsTable 1 } 1468 SipCommonSummaryStatsEntry ::= SEQUENCE { 1469 sipCommonSummaryInRequests Counter32, 1470 sipCommonSummaryOutRequests Counter32, 1471 sipCommonSummaryInResponses Counter32, 1472 sipCommonSummaryOutResponses Counter32, 1473 sipCommonSummaryTotalTransactions Counter32, 1474 sipCommonSummaryDisconTime TimeStamp 1475 } 1477 sipCommonSummaryInRequests OBJECT-TYPE 1478 SYNTAX Counter32 1479 MAX-ACCESS read-only 1480 STATUS current 1481 DESCRIPTION 1482 "This object indicates the total number of SIP request messages 1483 received by the SIP entity including retransmissions. 1485 Discontinuities in the value of this counter can occur at 1486 re-initialization of the SIP entity or service. A Management 1487 Station can detect discontinuities in this counter by 1488 monitoring the sipCommonSummaryDisconTime object in the same 1489 row." 1490 ::= { sipCommonSummaryStatsEntry 1 } 1492 sipCommonSummaryOutRequests OBJECT-TYPE 1493 SYNTAX Counter32 1494 MAX-ACCESS read-only 1495 STATUS current 1496 DESCRIPTION 1497 "This object contains the total number of SIP request messages 1498 sent out (originated and relayed) by the SIP entity. Where a 1499 particular message is sent more than once, for example as a 1500 retransmission, or as a result of forking, each transmission is 1501 counted separately. 1503 Discontinuities in the value of this counter can occur at 1504 re-initialization of the SIP entity or service. A Management 1505 Station can detect discontinuities in this counter by 1506 monitoring the sipCommonSummaryDisconTime object in the same 1507 row." 1508 ::= { sipCommonSummaryStatsEntry 2 } 1510 sipCommonSummaryInResponses OBJECT-TYPE 1511 SYNTAX Counter32 1512 MAX-ACCESS read-only 1513 STATUS current 1514 DESCRIPTION 1515 "This object contains the total number of SIP response messages 1516 received by the SIP entity including retransmissions. 1518 Discontinuities in the value of this counter can occur at 1519 re-initialization of the SIP entity or service. A Management 1520 Station can detect discontinuities in this counter by 1521 monitoring the sipCommonSummaryDisconTime object in the same 1522 row." 1523 ::= { sipCommonSummaryStatsEntry 3 } 1525 sipCommonSummaryOutResponses OBJECT-TYPE 1526 SYNTAX Counter32 1527 MAX-ACCESS read-only 1528 STATUS current 1529 DESCRIPTION 1530 "This object contains the total number of SIP response messages 1531 sent (originated and relayed) by the SIP entity including 1532 retransmissions. 1534 Discontinuities in the value of this counter can occur at 1535 re-initialization of the SIP entity or service. A Management 1536 Station can detect discontinuities in this counter by 1537 monitoring the sipCommonSummaryDisconTime object in the same 1538 row." 1539 ::= { sipCommonSummaryStatsEntry 4 } 1541 sipCommonSummaryTotalTransactions OBJECT-TYPE 1542 SYNTAX Counter32 1543 MAX-ACCESS read-only 1544 STATUS current 1545 DESCRIPTION 1546 "This object contains a count of the number of transactions that 1547 are in progress and transactions that have reached the 1548 terminated state. It is not applicable to stateless SIP Proxy 1549 Servers. 1551 A SIP transaction occurs between a client and a server and 1552 comprises all messages from the first request sent from the 1553 client to the server up to a final (non-1xx) response sent from 1554 the server to the client. 1556 If the request is INVITE and the final response is a non-2xx, 1557 the transaction also include an ACK to the response. The ACK 1558 for a 2xx response to an INVITE request is a separate 1559 transaction. 1561 The branch ID parameter in the Via header field values serves 1562 as a transaction identifier. 1564 A transaction is identified by the CSeq sequence number within 1565 a single call leg. The ACK request has the same CSeq number as 1566 the corresponding INVITE request, but comprises a transaction 1567 of its own. 1569 In the case of a forked request, each branch counts as a single 1570 transaction. 1572 For a transaction stateless Proxy Server, this counter is 1573 always 0. 1575 Discontinuities in the value of this counter can occur at 1576 re-initialization of the SIP entity or service. A Management 1577 Station can detect discontinuities in this counter by 1578 monitoring the sipCommonSummaryDisconTime object in the same 1579 row." 1580 ::= { sipCommonSummaryStatsEntry 5 } 1582 sipCommonSummaryDisconTime OBJECT-TYPE 1583 SYNTAX TimeStamp 1584 MAX-ACCESS read-only 1585 STATUS current 1586 DESCRIPTION 1587 "The value of the sysUpTime object when the counters for the 1588 summary statistics objects in this row last experienced a 1589 discontinuity." 1590 ::= { sipCommonSummaryStatsEntry 6 } 1592 -- 1593 -- SIP Method Statistics 1594 -- Total counts for each SIP method. 1595 -- 1596 sipCommonMethodStatsTable OBJECT-TYPE 1597 SYNTAX SEQUENCE OF SipCommonMethodStatsEntry 1598 MAX-ACCESS not-accessible 1599 STATUS current 1600 DESCRIPTION 1601 "This table contains the method statistics objects for SIP 1602 entities. Each row represents those objects for a particular 1603 SIP entity present in this system." 1605 ::= { sipCommonMethodStats 1 } 1607 sipCommonMethodStatsEntry OBJECT-TYPE 1608 SYNTAX SipCommonMethodStatsEntry 1609 MAX-ACCESS not-accessible 1610 STATUS current 1611 DESCRIPTION 1612 "A row of per entity method statistics. 1614 Each row represents those objects for a particular SIP entity 1615 present in this system. applIndex is used to uniquely identify 1616 these instances of SIP entities and correlate them through the 1617 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 1618 INDEX { applIndex, sipCommonMethodStatsName } 1619 ::= { sipCommonMethodStatsTable 1 } 1621 SipCommonMethodStatsEntry ::= SEQUENCE { 1622 sipCommonMethodStatsName SipTCMethodName, 1623 sipCommonMethodStatsOutbounds Counter32, 1624 sipCommonMethodStatsInbounds Counter32, 1625 sipCommonMethodStatsDisconTime TimeStamp 1627 } 1629 sipCommonMethodStatsName OBJECT-TYPE 1630 SYNTAX SipTCMethodName 1631 MAX-ACCESS not-accessible 1632 STATUS current 1633 DESCRIPTION 1634 "This object uniquely identifies the SIP method related to the 1635 objects in a particular row." 1636 ::= { sipCommonMethodStatsEntry 1 } 1638 sipCommonMethodStatsOutbounds OBJECT-TYPE 1639 SYNTAX Counter32 1640 MAX-ACCESS read-only 1641 STATUS current 1642 DESCRIPTION 1643 "This object reflects the total number of requests sent by the 1644 SIP entity, excluding retransmissions. Retransmissions are 1645 counted separately and are not reflected in this counter. A 1646 Management Station can detect discontinuities in this counter 1647 by monitoring the sipCommonMethodStatsDisconTime object in the 1648 same row." 1649 REFERENCE 1650 "RFC 3261, Section 7.1" 1651 ::= { sipCommonMethodStatsEntry 2 } 1653 sipCommonMethodStatsInbounds OBJECT-TYPE 1654 SYNTAX Counter32 1655 MAX-ACCESS read-only 1656 STATUS current 1657 DESCRIPTION 1658 "This object reflects the total number of requests received by 1659 the SIP entity. Retransmissions are counted separately and are 1660 not reflected in this counter. A Management Station can detect 1661 discontinuities in this counter by monitoring the 1662 sipCommonMethodStatsDisconTime object in the same row." 1663 REFERENCE 1664 "RFC 3261, Section 7.1" 1665 ::= { sipCommonMethodStatsEntry 3 } 1667 sipCommonMethodStatsDisconTime OBJECT-TYPE 1668 SYNTAX TimeStamp 1669 MAX-ACCESS read-only 1670 STATUS current 1671 DESCRIPTION 1672 "The value of the sysUpTime object when the counters for the 1673 method statistics objects in this row last experienced a 1674 discontinuity." 1675 ::= { sipCommonMethodStatsEntry 4 } 1677 -- 1678 -- Support for specific status codes 1679 -- 1680 sipCommonStatusCodeTable OBJECT-TYPE 1681 SYNTAX SEQUENCE OF SipCommonStatusCodeEntry 1682 MAX-ACCESS not-accessible 1683 STATUS current 1684 DESCRIPTION 1685 "This table contains the list of SIP status codes which each SIP 1686 entity in this system has been requested to monitor. It is the 1687 mechanism by which specific status codes are monitored. 1688 Entries created in this table must not persist across reboots" 1689 ::= { sipCommonStatusCode 1 } 1691 sipCommonStatusCodeEntry OBJECT-TYPE 1692 SYNTAX SipCommonStatusCodeEntry 1693 MAX-ACCESS not-accessible 1694 STATUS current 1695 DESCRIPTION 1696 "This row contains information on a particular SIP status code 1697 that the SIP entity has been requested to monitor. Entries 1698 created in this table must not persist across reboots. 1700 Each row represents those objects for a particular SIP entity 1701 present in this system. applIndex is used to uniquely identify 1702 these instances of SIP entities and correlate them through the 1703 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 1704 INDEX { applIndex, sipCommonStatusCodeMethod, 1705 sipCommonStatusCodeValue } 1706 ::= { sipCommonStatusCodeTable 1 } 1708 SipCommonStatusCodeEntry ::= SEQUENCE { 1709 sipCommonStatusCodeMethod SipTCMethodName, 1710 sipCommonStatusCodeValue Unsigned32, 1711 sipCommonStatusCodeIns Counter32, 1712 sipCommonStatusCodeOuts Counter32, 1713 sipCommonStatusCodeRowStatus RowStatus, 1714 sipCommonStatusCodeDisconTime TimeStamp 1715 } 1717 sipCommonStatusCodeMethod OBJECT-TYPE 1718 SYNTAX SipTCMethodName 1719 MAX-ACCESS not-accessible 1720 STATUS current 1721 DESCRIPTION 1722 "This object uniquely identifies a conceptual row in the table 1723 and reflects an assigned number used to identify a specific SIP 1724 method." 1725 ::= { sipCommonStatusCodeEntry 1 } 1727 sipCommonStatusCodeValue OBJECT-TYPE 1728 SYNTAX Unsigned32 (100..999) 1729 MAX-ACCESS not-accessible 1730 STATUS current 1731 DESCRIPTION 1732 "This object contains a SIP status code value that the SIP 1733 entity has been requested to monitor. All of the other 1734 information in the row is related to this value." 1735 ::= { sipCommonStatusCodeEntry 2 } 1737 sipCommonStatusCodeIns OBJECT-TYPE 1738 SYNTAX Counter32 1739 MAX-ACCESS read-only 1740 STATUS current 1741 DESCRIPTION 1742 "This object reflects the total number of response messages 1743 received by the SIP entity with the status code value contained 1744 in the sipCommonStatusCodeValue column. 1746 Discontinuities in the value of this counter can occur at 1747 re-initialization of the SIP entity or service, or when the 1748 monitoring of the Status code is temporarily disabled. A 1749 Management Station can detect discontinuities in this counter 1750 by monitoring the sipCommonStatusCodeDisconTime object in the 1751 same row." 1752 ::= { sipCommonStatusCodeEntry 3 } 1754 sipCommonStatusCodeOuts OBJECT-TYPE 1755 SYNTAX Counter32 1756 MAX-ACCESS read-only 1757 STATUS current 1758 DESCRIPTION 1759 "This object reflects the total number of response messages sent 1760 by the SIP entity with the status code value contained in the 1761 sipCommonStatusCodeValue column. 1763 Discontinuities in the value of this counter can occur at 1764 re-initialization of the SIP entity or service, or when the 1765 monitoring of the Status code is temporarily disabled. A 1766 Management Station can detect discontinuities in this counter 1767 by monitoring the sipCommonStatusCodeDisconTime object in the 1768 same row." 1769 ::= { sipCommonStatusCodeEntry 4 } 1771 sipCommonStatusCodeRowStatus OBJECT-TYPE 1772 SYNTAX RowStatus 1773 MAX-ACCESS read-create 1774 STATUS current 1775 DESCRIPTION 1776 "The row augmentation in sipCommonStatusCodeNotifTable will be 1777 governed by the value of this RowStatus. 1779 The values 'createAndGo' and 'destroy' are the only valid 1780 values allowed for this object. If a row exists, it will 1781 reflect a status of 'active' when queried." 1782 ::= { sipCommonStatusCodeEntry 5 } 1784 sipCommonStatusCodeDisconTime OBJECT-TYPE 1785 SYNTAX TimeStamp 1786 MAX-ACCESS read-only 1787 STATUS current 1788 DESCRIPTION 1789 "The value of the sysUpTime object when the counters for the 1790 status code statistic objects in this row last experienced a 1791 discontinuity." 1792 ::= { sipCommonStatusCodeEntry 6 } 1794 -- 1795 -- Support for specific status code notifications 1796 -- 1797 sipCommonStatusCodeNotifTable OBJECT-TYPE 1798 SYNTAX SEQUENCE OF SipCommonStatusCodeNotifEntry 1799 MAX-ACCESS not-accessible 1800 STATUS current 1801 DESCRIPTION 1802 "This table contains objects to control notifications related to 1803 particular status codes each SIP entity in this system has been 1804 requested to monitor. 1806 There is an entry in this table corresponding to each entry in 1807 sipCommonStatusCodeTable. Therefore, this table augments that 1808 table and utilizes the same index methodology. 1810 The objects in this table are not included directly in the 1811 sipCommonStatusCodeTable simply to keep the status code 1812 notification control objects separate from the actual status 1813 code statistics." 1814 ::= { sipCommonStatusCode 2 } 1816 sipCommonStatusCodeNotifEntry OBJECT-TYPE 1817 SYNTAX SipCommonStatusCodeNotifEntry 1818 MAX-ACCESS not-accessible 1819 STATUS current 1820 DESCRIPTION 1821 "This row contains information controlling notifications for a 1822 particular SIP status code that the SIP entity has been 1823 requested to monitor." 1824 AUGMENTS { sipCommonStatusCodeEntry } 1825 ::= { sipCommonStatusCodeNotifTable 1 } 1827 SipCommonStatusCodeNotifEntry ::= SEQUENCE { 1828 sipCommonStatusCodeNotifSend TruthValue, 1829 sipCommonStatusCodeNotifEmitMode INTEGER, 1830 sipCommonStatusCodeNotifThresh Unsigned32, 1831 sipCommonStatusCodeNotifInterval Unsigned32 1832 } 1834 sipCommonStatusCodeNotifSend OBJECT-TYPE 1835 SYNTAX TruthValue 1836 MAX-ACCESS read-write 1837 STATUS current 1838 DESCRIPTION 1839 "This object controls whether a sipCommonStatusCodeNotif is 1840 emitted when the status code value specified in by 1841 sipCommonStatusCodeValue is sent or received. If the value of 1842 this object is 'true', then a notification is sent. If it is 1843 'false', no notification is sent. 1845 Note well, that a notification MAY be emitted for every message 1846 sent or received that contains the particular status code. 1847 Depending on the status code involved, this can cause a 1848 significant number of notification emissions that could be 1849 detrimental to network performance. Managers are forewarned to 1850 be prudent in the use of this object to enable notifications. 1851 Look to sipCommonStatusCodeNotifEmitMode for alternative 1852 controls for sipCommonStatusCodeNotif emissions." 1853 DEFVAL { false } 1854 ::= { sipCommonStatusCodeNotifEntry 1 } 1856 sipCommonStatusCodeNotifEmitMode OBJECT-TYPE 1857 SYNTAX INTEGER { 1858 normal(1), 1859 oneShot(2), 1860 triggered(3) -- read-only 1861 } 1862 MAX-ACCESS read-write 1863 STATUS current 1864 DESCRIPTION 1865 "The object sipCommonStatusCodeNotifSend MUST be set to 'true' 1866 for the values of this object to have any effect. It is 1867 RECOMMENDED that the desired emit mode be established by this 1868 object prior to setting sipCommonStatusCodeNotifSend to 'true'. 1869 This object and the sipCommonStatusCodeNotifSend object can 1870 obviously be set independently, but their respective values 1871 will have a dependency on each other and the resulting 1872 notifications. 1874 This object specifies the mode for emissions of 1875 sipCommonStatusCodeNotif notifications. 1877 normal : sipCommonStatusCodeNotif notifications will be 1878 emitted by the system for each SIP response 1879 messages sent or received that contains the 1880 desired status code. 1882 oneShot : Only one sipCommonStatusCodeNotif notification 1883 will be emitted. It will be the next SIP response 1884 messages sent or received that contains the 1885 desired status code. 1887 No more notifications are emitted until this object 1888 is set to either 'oneShot' again or 'normal'. This 1889 option is provided as a means of quelling the 1890 potential promiscuous behavior that can be 1891 associated with the sipCommonStatusCodeNotif. 1893 triggered : This value is only readable and cannot be set. It 1894 reflects the default value of the object or that 1895 the 'oneShot' case has occurred and indicates the 1896 mode needs to be reset to get further 1897 notifications. The mode is reset by setting this 1898 object to 'oneShot' or 'normal'." 1899 DEFVAL { oneShot } 1900 ::= { sipCommonStatusCodeNotifEntry 2 } 1902 sipCommonStatusCodeNotifThresh OBJECT-TYPE 1903 SYNTAX Unsigned32 1904 MAX-ACCESS read-write 1905 STATUS current 1906 DESCRIPTION 1907 "This object specifies the number of response messages sent or 1908 received by this system that are considered excessive. Based 1909 on crossing that threshold, a 1910 sipCommonStatusCodeThreshExceededInNotif notification or a 1911 sipCommonStatusCodeThreshExceededOutNotif will be sent. The 1912 sipCommonStatusCodeThreshExceededInNotif and 1913 sipCommonStatusCodeThreshExceededOutNotif notifications can be 1914 used as an early warning mechanism in lieu of using 1915 sipCommonStatusCodeNotif. 1917 Note that the configuration applied by this object will be 1918 applied equally to inbound and outbound response messages." 1919 DEFVAL { 500 } 1920 ::= { sipCommonStatusCodeNotifEntry 3 } 1922 sipCommonStatusCodeNotifInterval OBJECT-TYPE 1923 SYNTAX Unsigned32 1924 UNITS "seconds" 1925 MAX-ACCESS read-write 1926 STATUS current 1927 DESCRIPTION 1928 "This object specifies the time interval over which if 1929 sipCommonStatusCodeThresh is exceeded, with respect to sent or 1930 received messages, a sipCommonStatusCodeThreshExceededInNotif 1931 or sipCommonStatusCodeThreshExceededOutNotif notification will 1932 be sent. 1934 Note that the configuration applied by this object will be 1935 applied equally to inbound and outbound response messages." 1936 DEFVAL { 60 } 1937 ::= { sipCommonStatusCodeNotifEntry 4 } 1939 -- 1940 -- Transaction Statistics 1941 -- 1942 sipCommonTransCurrentTable OBJECT-TYPE 1943 SYNTAX SEQUENCE OF SipCommonTransCurrentEntry 1944 MAX-ACCESS not-accessible 1945 STATUS current 1946 DESCRIPTION 1947 "This table contains information on the transactions currently 1948 awaiting definitive responses by each SIP entity in this 1949 system. 1951 This table does not apply to transaction stateless Proxy 1952 Servers." 1953 ::= { sipCommonStatsTrans 1 } 1955 sipCommonTransCurrentEntry OBJECT-TYPE 1956 SYNTAX SipCommonTransCurrentEntry 1957 MAX-ACCESS not-accessible 1958 STATUS current 1959 DESCRIPTION 1960 "Information on a particular SIP entity's current transactions. 1962 Each row represents those objects for a particular SIP entity 1963 present in this system. applIndex is used to uniquely identify 1964 these instances of SIP entities and correlate them through the 1965 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 1966 INDEX { applIndex } 1967 ::= { sipCommonTransCurrentTable 1 } 1969 SipCommonTransCurrentEntry ::= SEQUENCE { 1970 sipCommonTransCurrentactions Gauge32 1971 } 1973 sipCommonTransCurrentactions OBJECT-TYPE 1974 SYNTAX Gauge32 (0..4294967295) 1975 MAX-ACCESS read-only 1976 STATUS current 1977 DESCRIPTION 1978 "This object contains the number of transactions awaiting 1979 definitive (non-1xx) response. In the case of a forked 1980 request, each branch counts as a single transaction 1981 corresponding to the entity identified by applIndex." 1982 ::= { sipCommonTransCurrentEntry 1 } 1984 -- 1985 -- SIP Retry Statistics 1986 -- 1987 -- This group contains various statistic objects about 1988 -- retransmission counts. 1990 -- 1991 sipCommonStatsRetryTable OBJECT-TYPE 1992 SYNTAX SEQUENCE OF SipCommonStatsRetryEntry 1993 MAX-ACCESS not-accessible 1994 STATUS current 1995 DESCRIPTION 1996 "This table contains retry statistics objects applicable to each 1997 SIP entity in this system." 1998 ::= { sipCommonStatsRetry 1 } 2000 sipCommonStatsRetryEntry OBJECT-TYPE 2001 SYNTAX SipCommonStatsRetryEntry 2002 MAX-ACCESS not-accessible 2003 STATUS current 2004 DESCRIPTION 2005 "A row of retry statistics. 2007 Each row represents those objects for a particular SIP entity 2008 present in this system. applIndex is used to uniquely identify 2009 these instances of SIP entities and correlate them through the 2010 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 2011 INDEX { applIndex, sipCommonStatsRetryMethod } 2012 ::= { sipCommonStatsRetryTable 1 } 2014 SipCommonStatsRetryEntry ::= SEQUENCE { 2015 sipCommonStatsRetryMethod SipTCMethodName, 2016 sipCommonStatsRetries Counter32, 2017 sipCommonStatsRetryFinalResponses Counter32, 2018 sipCommonStatsRetryNonFinalResponses Counter32, 2019 sipCommonStatsRetryDisconTime TimeStamp 2020 } 2022 sipCommonStatsRetryMethod OBJECT-TYPE 2023 SYNTAX SipTCMethodName 2024 MAX-ACCESS not-accessible 2025 STATUS current 2026 DESCRIPTION 2027 "This object uniquely identifies the SIP method related to the 2028 objects in a row." 2029 ::= { sipCommonStatsRetryEntry 1 } 2031 sipCommonStatsRetries OBJECT-TYPE 2032 SYNTAX Counter32 2033 MAX-ACCESS read-only 2034 STATUS current 2035 DESCRIPTION 2036 "This object reflects the total number of request 2037 retransmissions that have been sent by the SIP entity. Note 2038 that there could be multiple retransmissions per request. 2040 Discontinuities in the value of this counter can occur at 2041 re-initialization of the SIP entity or service. A Management 2042 Station can detect discontinuities in this counter by 2043 monitoring the sipCommonStatsRetryDisconTime object in the same 2044 row." 2045 ::= { sipCommonStatsRetryEntry 2 } 2047 sipCommonStatsRetryFinalResponses OBJECT-TYPE 2048 SYNTAX Counter32 2049 MAX-ACCESS read-only 2050 STATUS current 2051 DESCRIPTION 2052 "This object reflects the total number of Final Response retries 2053 that have been sent by the SIP entity. Note that there could 2054 be multiple retransmissions per request. 2056 Discontinuities in the value of this counter can occur at 2057 re-initialization of the SIP entity or service. A Management 2058 Station can detect discontinuities in this counter by 2059 monitoring the sipCommonStatsRetryDisconTime object in the same 2060 row." 2061 ::= { sipCommonStatsRetryEntry 3 } 2063 sipCommonStatsRetryNonFinalResponses OBJECT-TYPE 2064 SYNTAX Counter32 2065 MAX-ACCESS read-only 2066 STATUS current 2067 DESCRIPTION 2068 "This object reflects the total number of non-Final RResponse 2069 retries that have been sent by the SIP entity. 2071 Discontinuities in the value of this counter can occur at 2072 re-initialization of the SIP entity or service. A Management 2073 Station can detect discontinuities in this counter by 2074 monitoring the sipCommonStatsRetryDisconTime object in the same 2075 row." 2076 ::= { sipCommonStatsRetryEntry 4 } 2078 sipCommonStatsRetryDisconTime OBJECT-TYPE 2079 SYNTAX TimeStamp 2080 MAX-ACCESS read-only 2081 STATUS current 2082 DESCRIPTION 2083 "The value of the sysUpTime object when the counters for the 2084 retry statistics objects in this row last experienced a 2085 discontinuity." 2087 ::= { sipCommonStatsRetryEntry 5 } 2089 -- 2090 -- Other Common Statistics 2091 -- 2092 sipCommonOtherStatsTable OBJECT-TYPE 2093 SYNTAX SEQUENCE OF SipCommonOtherStatsEntry 2094 MAX-ACCESS not-accessible 2095 STATUS current 2096 DESCRIPTION 2097 "This table contains other common statistics supported by each 2098 SIP entity in this system." 2099 ::= { sipCommonOtherStats 1 } 2101 sipCommonOtherStatsEntry OBJECT-TYPE 2102 SYNTAX SipCommonOtherStatsEntry 2103 MAX-ACCESS not-accessible 2104 STATUS current 2105 DESCRIPTION 2106 "Information on a particular SIP entity's other common 2107 statistics. 2109 Each row represents those objects for a particular SIP entity 2110 present in this system. applIndex is used to uniquely identify 2111 these instances of SIP entities and correlate them through the 2112 common framework of the NETWORK-SERVICES-MIB (RFC 2788)." 2113 INDEX { applIndex } 2114 ::= { sipCommonOtherStatsTable 1 } 2116 SipCommonOtherStatsEntry ::= SEQUENCE { 2117 sipCommonOtherStatsNumUnsupportedUris Counter32, 2118 sipCommonOtherStatsNumUnsupportedMethods Counter32, 2119 sipCommonOtherStatsOtherwiseDiscardedMsgs Counter32, 2120 sipCommonOtherStatsDisconTime TimeStamp 2121 } 2123 sipCommonOtherStatsNumUnsupportedUris OBJECT-TYPE 2124 SYNTAX Counter32 2125 MAX-ACCESS read-only 2126 STATUS current 2127 DESCRIPTION 2128 "Number of RequestURIs received with unsupported scheme. A 2129 server normally responds to such requests with a 400 Bad 2130 Request status code. 2132 Discontinuities in the value of this counter can occur at 2133 re-initialization of the SIP entity or service. A Management 2134 Station can detect discontinuities in this counter by 2135 monitoring the sipCommonOtherStatsDisconTime object in the same 2136 row." 2137 ::= { sipCommonOtherStatsEntry 1 } 2139 sipCommonOtherStatsNumUnsupportedMethods OBJECT-TYPE 2140 SYNTAX Counter32 2141 MAX-ACCESS read-only 2142 STATUS current 2143 DESCRIPTION 2144 "Number of SIP requests received with unsupported methods. A 2145 server normally responds to such requests with a 501 (Not 2146 Implemented) or 405 (Method Not Allowed). 2148 Discontinuities in the value of this counter can occur at 2149 re-initialization of the SIP entity or service. A Management 2150 Station can detect discontinuities in this counter by 2151 monitoring the sipCommonOtherStatsDisconTime object in the same 2152 row." 2153 ::= { sipCommonOtherStatsEntry 2 } 2155 sipCommonOtherStatsOtherwiseDiscardedMsgs OBJECT-TYPE 2156 SYNTAX Counter32 2157 MAX-ACCESS read-only 2158 STATUS current 2159 DESCRIPTION 2160 "Number of SIP messages received that for any number of reasons 2161 was discarded without a response. 2163 Discontinuities in the value of this counter can occur at 2164 re-initialization of the SIP entity or service. A Management 2165 Station can detect discontinuities in this counter by 2166 monitoring the sipCommonOtherStatsDisconTime object in the same 2167 row." 2168 ::= { sipCommonOtherStatsEntry 3 } 2170 sipCommonOtherStatsDisconTime OBJECT-TYPE 2171 SYNTAX TimeStamp 2172 MAX-ACCESS read-only 2173 STATUS current 2174 DESCRIPTION 2175 "The value of the sysUpTime object when the counters for the 2176 statistics objects in this row last experienced a 2177 discontinuity." 2178 ::= { sipCommonOtherStatsEntry 4 } 2180 -- 2181 -- Notification related objects 2182 -- 2183 -- 2184 -- Status code related notification objects. 2185 -- 2186 sipCommonStatusCodeNotifTo OBJECT-TYPE 2187 SYNTAX SnmpAdminString 2188 MAX-ACCESS accessible-for-notify 2189 STATUS current 2190 DESCRIPTION 2191 "This object contains the value of the To header in the message 2192 containing the status code that caused the notification. The 2193 header name will be part of this object value. For example, 2194 'To: Watson '." 2195 ::= { sipCommonNotifObjects 1 } 2197 sipCommonStatusCodeNotifFrom OBJECT-TYPE 2198 SYNTAX SnmpAdminString 2199 MAX-ACCESS accessible-for-notify 2200 STATUS current 2201 DESCRIPTION 2202 "This object contains the value of the From header in the 2203 message containing the status code that caused the 2204 notification. The header name will be part of this object 2205 value. For example, 'From: Watson '." 2206 ::= { sipCommonNotifObjects 2 } 2208 sipCommonStatusCodeNotifCallId OBJECT-TYPE 2209 SYNTAX SnmpAdminString 2210 MAX-ACCESS accessible-for-notify 2211 STATUS current 2212 DESCRIPTION 2213 "This object contains the value of the Call-ID in the message 2214 containing the status code that caused the notification. The 2215 header name will be part of this object value. For example, 2216 'Call-ID: 5551212@example.com'." 2217 ::= { sipCommonNotifObjects 3 } 2219 sipCommonStatusCodeNotifCSeq OBJECT-TYPE 2220 SYNTAX Unsigned32 2221 MAX-ACCESS accessible-for-notify 2222 STATUS current 2223 DESCRIPTION 2224 "This object contains the CSeq value in the message containing 2225 the status code that caused the notification. The header name 2226 will be part of this object value. For example, 'CSeq: 1722 2227 INVITE'." 2228 ::= { sipCommonNotifObjects 4 } 2230 -- 2231 -- General notification related objects. 2232 -- 2233 sipCommonNotifApplIndex OBJECT-TYPE 2234 SYNTAX Unsigned32 (1..2147483647) 2235 MAX-ACCESS accessible-for-notify 2236 STATUS current 2237 DESCRIPTION 2238 "This object contains the applIndex as described in RFC 2788. 2239 This object is created in order to allow a variable binding 2240 containing a value of applIndex in a notification." 2241 ::= { sipCommonNotifObjects 5 } 2243 sipCommonNotifSequenceNumber OBJECT-TYPE 2244 SYNTAX Unsigned32 (1..2147483647) 2245 MAX-ACCESS accessible-for-notify 2246 STATUS current 2247 DESCRIPTION 2248 "This object contains a sequence number for each notification 2249 generated by this SIP entity. Each notification SHOULD have a 2250 unique sequence number. A network manager can use this 2251 information to determine whether notifications from a 2252 particular SIP entity have been missed. The value of this 2253 object MUST start at 1 and increase by one with each generated 2254 notification. If a system restarts, the sequence number MAY 2255 start again from 1." 2256 ::= { sipCommonNotifObjects 6 } 2258 -- 2259 -- Notifications 2260 -- 2261 sipCommonStatusCodeNotif NOTIFICATION-TYPE 2262 OBJECTS { 2263 sipCommonNotifSequenceNumber, 2264 sipCommonNotifApplIndex, 2265 sipCommonStatusCodeNotifTo, 2266 sipCommonStatusCodeNotifFrom, 2267 sipCommonStatusCodeNotifCallId, 2268 sipCommonStatusCodeNotifCSeq, 2269 sipCommonStatusCodeIns, 2270 sipCommonStatusCodeOuts 2271 } 2272 STATUS current 2273 DESCRIPTION 2274 "Signifies that a specific status code has been sent or received 2275 by the system." 2276 ::= { sipCommonMIBNotifications 1 } 2278 sipCommonStatusCodeThreshExceededInNotif NOTIFICATION-TYPE 2279 OBJECTS { 2280 sipCommonNotifSequenceNumber, 2281 sipCommonNotifApplIndex, 2282 sipCommonStatusCodeIns 2283 } 2284 STATUS current 2285 DESCRIPTION 2286 "Signifies that a specific status code was found to have been 2287 received by the system enough to exceed the configured 2288 threshold. This notification can be used as an early warning 2289 mechanism in lieu of using sipCommonStatusCodeNotif." 2290 ::= { sipCommonMIBNotifications 2 } 2292 sipCommonStatusCodeThreshExceededOutNotif NOTIFICATION-TYPE 2293 OBJECTS { 2294 sipCommonNotifSequenceNumber, 2295 sipCommonNotifApplIndex, 2296 sipCommonStatusCodeOuts 2297 } 2298 STATUS current 2299 DESCRIPTION 2300 "Signifies that a specific status code was found to have been 2301 sent by the system enough to exceed the configured threshold. 2302 This notification can be used as an early warning mechanism in 2303 lieu of using sipCommonStatusCodeNotif." 2304 ::= { sipCommonMIBNotifications 3 } 2306 sipCommonServiceColdStart NOTIFICATION-TYPE 2307 OBJECTS { 2308 sipCommonNotifSequenceNumber, 2309 sipCommonNotifApplIndex, 2310 sipCommonCfgServiceStartTime 2311 } 2312 STATUS current 2313 DESCRIPTION 2314 "Signifies that the SIP service has reinitialized itself or 2315 started for the first time. This SHOULD result from a hard 2316 'down' to 'up' administrative status change. The configuration 2317 or behavior of the service MAY be altered." 2318 ::= { sipCommonMIBNotifications 4 } 2320 sipCommonServiceWarmStart NOTIFICATION-TYPE 2321 OBJECTS { 2322 sipCommonNotifSequenceNumber, 2323 sipCommonNotifApplIndex, 2324 sipCommonCfgServiceLastChange 2325 } 2326 STATUS current 2327 DESCRIPTION 2328 "Signifies that the SIP service has reinitialized itself and is 2329 restarting after an administrative 'reset'. The configuration 2330 or behavior of the service MAY be altered." 2331 ::= { sipCommonMIBNotifications 5 } 2333 sipCommonServiceStatusChanged NOTIFICATION-TYPE 2334 OBJECTS { 2335 sipCommonNotifSequenceNumber, 2336 sipCommonNotifApplIndex, 2337 sipCommonCfgServiceLastChange, 2338 sipCommonCfgServiceOperStatus 2339 } 2340 STATUS current 2341 DESCRIPTION 2342 "Signifies that the SIP service operational status has changed." 2343 ::= { sipCommonMIBNotifications 6 } 2345 -- 2346 -- Conformance 2347 -- 2348 sipCommonMIBCompliances 2349 OBJECT IDENTIFIER ::= { sipCommonMIBConformance 1 } 2350 sipCommonMIBGroups 2351 OBJECT IDENTIFIER ::= { sipCommonMIBConformance 2 } 2353 -- 2354 -- Compliance Statements 2355 -- 2356 sipCommonCompliance MODULE-COMPLIANCE 2357 STATUS current 2358 DESCRIPTION 2359 "The compliance statement for SIP entities." 2361 MODULE -- this module 2362 MANDATORY-GROUPS { sipCommonConfigGroup, 2363 sipCommonStatsGroup 2364 } 2366 OBJECT sipCommonStatusCodeRowStatus 2367 SYNTAX RowStatus { active(1) } 2368 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) } 2369 DESCRIPTION 2370 "Support for createAndWait and notInService is not required." 2372 OBJECT sipCommonCfgServiceNotifEnable 2373 MIN-ACCESS not-accessible 2374 DESCRIPTION 2375 "This object is optional and does not need to be supported." 2377 GROUP sipCommonInformationalGroup 2378 DESCRIPTION 2379 "This group is OPTIONAL. A SIP entity can elect to not provide 2380 any support for these objects as they provide optional 2381 information." 2383 GROUP sipCommonConfigTimerGroup 2384 DESCRIPTION 2385 "This group is OPTIONAL. A SIP entity can elect to not provide 2386 any timer configuration." 2388 GROUP sipCommonStatsRetryGroup 2389 DESCRIPTION 2390 "This group is OPTIONAL. A SIP entity can elect to not provide 2391 any retry statistics." 2393 GROUP sipCommonNotifGroup 2394 DESCRIPTION 2395 "This group is OPTIONAL. A SIP entity can elect to not provide 2396 any notifications. If implemented, the 2397 sipCommonStatusCodeNotifGroup and sipCommonNotifObjectsGroup 2398 MUST also be implemented." 2400 GROUP sipCommonStatusCodeNotifGroup 2401 DESCRIPTION 2402 "This group is OPTIONAL. A SIP entity can elect to not provide 2403 any notifications. If implemented, the sipCommonNotifGroup and 2404 sipCommonNotifObjectsGroup MUST also be implemented." 2406 GROUP sipCommonNotifObjectsGroup 2407 DESCRIPTION 2408 "This group is OPTIONAL. A SIP entity can elect to not provide 2409 any notifications. If implemented, the 2410 sipCommonStatusCodeNotifGroup and sipCommonNotifGroup MUST also 2411 be implemented." 2413 ::= { sipCommonMIBCompliances 1 } 2415 -- 2416 -- Units of Conformance 2417 -- 2418 sipCommonConfigGroup OBJECT-GROUP 2419 OBJECTS { 2420 sipCommonCfgProtocolVersion, 2421 sipCommonCfgServiceOperStatus, 2422 sipCommonCfgServiceStartTime, 2423 sipCommonCfgServiceLastChange, 2424 sipCommonPortTransportRcv, 2425 sipCommonOptionTag, 2426 sipCommonOptionTagHeaderField, 2427 sipCommonCfgMaxTransactions, 2428 sipCommonCfgServiceNotifEnable, 2429 sipCommonCfgEntityType, 2430 sipCommonMethodSupportedName 2431 } 2432 STATUS current 2433 DESCRIPTION 2434 "A collection of objects providing configuration common to all 2435 SIP entities." 2436 ::= { sipCommonMIBGroups 1 } 2438 sipCommonInformationalGroup OBJECT-GROUP 2439 OBJECTS { 2440 sipCommonCfgOrganization 2441 } 2442 STATUS current 2443 DESCRIPTION 2444 "A collection of objects providing configuration common to all 2445 SIP entities." 2446 ::= { sipCommonMIBGroups 2 } 2448 sipCommonConfigTimerGroup OBJECT-GROUP 2449 OBJECTS { 2450 sipCommonCfgTimerA, 2451 sipCommonCfgTimerB, 2452 sipCommonCfgTimerC, 2453 sipCommonCfgTimerD, 2454 sipCommonCfgTimerE, 2455 sipCommonCfgTimerF, 2456 sipCommonCfgTimerG, 2457 sipCommonCfgTimerH, 2458 sipCommonCfgTimerI, 2459 sipCommonCfgTimerJ, 2460 sipCommonCfgTimerK, 2461 sipCommonCfgTimerT1, 2462 sipCommonCfgTimerT2, 2463 sipCommonCfgTimerT4 2464 } 2465 STATUS current 2466 DESCRIPTION 2467 "A collection of objects providing timer configuration common to 2468 all SIP entities." 2469 ::= { sipCommonMIBGroups 3 } 2471 sipCommonStatsGroup OBJECT-GROUP 2472 OBJECTS { 2473 sipCommonSummaryInRequests, 2474 sipCommonSummaryOutRequests, 2475 sipCommonSummaryInResponses, 2476 sipCommonSummaryOutResponses, 2477 sipCommonSummaryTotalTransactions, 2478 sipCommonSummaryDisconTime, 2479 sipCommonMethodStatsOutbounds, 2480 sipCommonMethodStatsInbounds, 2481 sipCommonMethodStatsDisconTime, 2482 sipCommonStatusCodeIns, 2483 sipCommonStatusCodeOuts, 2484 sipCommonStatusCodeRowStatus, 2485 sipCommonStatusCodeDisconTime, 2486 sipCommonTransCurrentactions, 2487 sipCommonOtherStatsNumUnsupportedUris, 2488 sipCommonOtherStatsNumUnsupportedMethods, 2489 sipCommonOtherStatsOtherwiseDiscardedMsgs, 2490 sipCommonOtherStatsDisconTime 2491 } 2492 STATUS current 2493 DESCRIPTION 2494 "A collection of objects providing statistics common to all SIP 2495 entities." 2496 ::= { sipCommonMIBGroups 4 } 2498 sipCommonStatsRetryGroup OBJECT-GROUP 2499 OBJECTS { 2500 sipCommonStatsRetries, 2501 sipCommonStatsRetryFinalResponses, 2502 sipCommonStatsRetryNonFinalResponses, 2503 sipCommonStatsRetryDisconTime 2504 } 2505 STATUS current 2506 DESCRIPTION 2507 "A collection of objects providing retry statistics." 2508 ::= { sipCommonMIBGroups 5 } 2510 sipCommonNotifGroup NOTIFICATION-GROUP 2511 NOTIFICATIONS { 2512 sipCommonStatusCodeNotif, 2513 sipCommonStatusCodeThreshExceededInNotif, 2514 sipCommonStatusCodeThreshExceededOutNotif, 2515 sipCommonServiceColdStart, 2516 sipCommonServiceWarmStart, 2517 sipCommonServiceStatusChanged 2518 } 2519 STATUS current 2520 DESCRIPTION 2521 "A collection of notifications common to all SIP entities." 2522 ::= { sipCommonMIBGroups 6 } 2524 sipCommonStatusCodeNotifGroup OBJECT-GROUP 2525 OBJECTS { 2526 sipCommonStatusCodeNotifSend, 2527 sipCommonStatusCodeNotifEmitMode, 2528 sipCommonStatusCodeNotifThresh, 2529 sipCommonStatusCodeNotifInterval 2530 } 2531 STATUS current 2532 DESCRIPTION 2533 "A collection of objects related to controlling and attribution 2534 of notifications common to all SIP entities." 2535 ::= { sipCommonMIBGroups 7 } 2537 sipCommonNotifObjectsGroup OBJECT-GROUP 2538 OBJECTS { 2539 sipCommonStatusCodeNotifTo, 2540 sipCommonStatusCodeNotifFrom, 2541 sipCommonStatusCodeNotifCallId, 2542 sipCommonStatusCodeNotifCSeq, 2543 sipCommonNotifApplIndex, 2544 sipCommonNotifSequenceNumber 2545 } 2546 STATUS current 2547 DESCRIPTION 2548 "A collection of accessible-for-notify objects related to the 2549 notification defined in this MIB module." 2550 ::= { sipCommonMIBGroups 8 } 2552 END 2554 7.3. SIP User Agent MIB Module 2556 SIP-UA-MIB DEFINITIONS ::= BEGIN 2558 IMPORTS 2559 MODULE-IDENTITY, 2560 OBJECT-TYPE, 2561 Unsigned32, 2562 mib-2 2563 FROM SNMPv2-SMI -- RFC 2578 2565 MODULE-COMPLIANCE, 2566 OBJECT-GROUP 2567 FROM SNMPv2-CONF -- RFC 2580 2569 applIndex 2570 FROM NETWORK-SERVICES-MIB -- RFC 2788 2572 InetAddressType, 2573 InetAddress 2574 FROM INET-ADDRESS-MIB -- RFC 4001 2576 SipTCEntityRole 2577 FROM SIP-TC-MIB; 2579 sipUAMIB MODULE-IDENTITY 2580 LAST-UPDATED "200609121700Z" 2581 ORGANIZATION "IETF Session Initiation Protocol Working Group" 2582 CONTACT-INFO 2583 "SIP WG email: sip@ietf.org 2585 Co-editor Kevin Lingle 2586 Cisco Systems, Inc. 2587 postal: 7025 Kit Creek Road 2588 P.O. Box 14987 2589 Research Triangle Park, NC 27709 2590 USA 2591 email: klingle@cisco.com 2592 phone: +1 919 392 2029 2594 Co-editor Joon Maeng 2595 email: jmaeng@austin.rr.com 2597 Co-editor Jean-Francois Mule 2598 CableLabs 2599 postal: 858 Coal Creek Circle 2600 Louisville, CO 80027 2601 USA 2602 email: jf.mule@cablelabs.com 2603 phone: +1 303 661 9100 2605 Co-editor Dave Walker 2606 email: drwalker@rogers.com" 2607 DESCRIPTION 2608 "Session Initiation Protocol (SIP) User Agent (UA) MIB module. 2610 SIP is an application-layer signaling protocol for creating, 2611 modifying and terminating multimedia sessions with one or more 2612 participants. These sessions include Internet multimedia 2613 conferences and Internet telephone calls. SIP is defined in 2614 RFC 3261 (June 2002). 2616 A User Agent is an application that contains both a User Agent 2617 Client (UAC) and a User Agent Server (UAS). A UAC is an 2618 application that initiates a SIP request. A UAS is an 2619 application that contacts the user when a SIP request is 2620 received and that returns a response on behalf of the user. 2621 The response accepts, rejects, or redirects the request. 2623 Copyright (C) The Internet Society (2006). This version of 2624 this MIB module is part of RFC XXXX; see the RFC itself for 2625 full legal notices." 2626 -- RFC Ed: replace XXXX with actual RFC number and remove this note 2627 REVISION "200609121700Z" 2628 DESCRIPTION 2629 "Initial version of the IETF SIP-UA-MIB module. This version 2630 published as part of RFC XXXX." 2631 -- RFC Ed: replace XXXX with actual RFC number and remove this note 2632 ::= { mib-2 XXX3 } 2634 -- RFC Ed: replace XXX3 with actual IANA assigned number 2635 -- RFC Ed: and remove these notes 2637 -- Top-Level Components of this MIB. 2638 sipUAMIBObjects OBJECT IDENTIFIER ::= { sipUAMIB 1 } 2639 sipUAMIBConformance OBJECT IDENTIFIER ::= { sipUAMIB 2 } 2641 -- 2642 -- This MIB contains objects related to SIP User Agents. 2643 -- 2644 sipUACfgServer OBJECT IDENTIFIER ::= { sipUAMIBObjects 1 } 2646 -- 2647 -- SIP Server Configuration 2648 -- 2649 sipUACfgServerTable OBJECT-TYPE 2650 SYNTAX SEQUENCE OF SipUACfgServerEntry 2651 MAX-ACCESS not-accessible 2652 STATUS current 2653 DESCRIPTION 2654 "This table contains SIP server configuration objects applicable 2655 to each SIP user agent in this system." 2656 ::= { sipUACfgServer 1 } 2658 sipUACfgServerEntry OBJECT-TYPE 2659 SYNTAX SipUACfgServerEntry 2660 MAX-ACCESS not-accessible 2661 STATUS current 2662 DESCRIPTION 2663 "A row of server configuration. 2665 Each row represents those objects for a particular SIP user 2666 agent present in this system. applIndex is used to uniquely 2667 identify these instances of SIP user agents and correlate them 2668 through the common framework of the NETWORK-SERVICES-MIB (RFC 2669 2788). The same value of applIndex used in the corresponding 2670 SIP-COMMON-MIB is used here." 2671 INDEX { applIndex, sipUACfgServerIndex } 2672 ::= { sipUACfgServerTable 1 } 2674 SipUACfgServerEntry ::= SEQUENCE { 2675 sipUACfgServerIndex Unsigned32, 2676 sipUACfgServerAddressType InetAddressType, 2677 sipUACfgServerAddress InetAddress, 2678 sipUACfgServerRole SipTCEntityRole 2679 } 2681 sipUACfgServerIndex OBJECT-TYPE 2682 SYNTAX Unsigned32 (1..4294967295) 2683 MAX-ACCESS not-accessible 2684 STATUS current 2685 DESCRIPTION 2686 "A unique identifier of a server address when multiple addresses 2687 are configured by the SIP entity. If one address isn't 2688 reachable, then another can be tried." 2689 ::= { sipUACfgServerEntry 1 } 2691 sipUACfgServerAddressType OBJECT-TYPE 2692 SYNTAX InetAddressType 2693 MAX-ACCESS read-only 2694 STATUS current 2695 DESCRIPTION 2696 "This object reflects the type of address contained in the 2697 associated instance of sipUACfgServerAddress." 2698 REFERENCE 2699 "INET-ADDRESS-MIB (RFC 4001)" 2700 ::= { sipUACfgServerEntry 2 } 2702 sipUACfgServerAddress OBJECT-TYPE 2703 SYNTAX InetAddress 2704 MAX-ACCESS read-only 2705 STATUS current 2706 DESCRIPTION 2707 "This object reflects the address of a SIP server this user 2708 agent will use to proxy/redirect calls. The type of this 2709 address is determined by the value of the 2710 sipUACfgServerAddressType object." 2711 REFERENCE "INET-ADDRESS-MIB (RFC 4001)" 2712 ::= { sipUACfgServerEntry 3 } 2714 sipUACfgServerRole OBJECT-TYPE 2715 SYNTAX SipTCEntityRole 2716 MAX-ACCESS read-only 2717 STATUS current 2718 DESCRIPTION 2719 "This object reflects the function of the SIP server this user 2720 agent should communicate with: registrar, proxy (outbound 2721 proxy), etc." 2722 ::= { sipUACfgServerEntry 4 } 2724 -- 2725 -- Conformance 2726 -- 2727 sipUAMIBCompliances OBJECT IDENTIFIER ::= { sipUAMIBConformance 1 } 2728 sipUAMIBGroups OBJECT IDENTIFIER ::= { sipUAMIBConformance 2 } 2730 -- 2731 -- Compliance Statements 2732 -- 2733 sipUACompliance MODULE-COMPLIANCE 2734 STATUS current 2735 DESCRIPTION 2736 "The compliance statement for SIP entities that implement the 2737 SIP-UA-MIB module." 2738 MODULE -- this module 2739 MANDATORY-GROUPS { sipUAConfigGroup } 2741 ::= { sipUAMIBCompliances 1 } 2743 -- 2744 -- Units of Conformance 2745 -- 2746 sipUAConfigGroup OBJECT-GROUP 2747 OBJECTS { 2748 sipUACfgServerAddressType, 2749 sipUACfgServerAddress, 2750 sipUACfgServerRole 2751 } 2752 STATUS current 2753 DESCRIPTION 2754 "A collection of objects providing information about the 2755 configuration of SIP User Agents." 2756 ::= { sipUAMIBGroups 1 } 2758 END 2760 7.4. SIP Server MIB Module (Proxy, Redirect and Registrar Servers) 2761 SIP-SERVER-MIB DEFINITIONS ::= BEGIN 2763 IMPORTS 2764 MODULE-IDENTITY, 2765 OBJECT-TYPE, 2766 Counter32, 2767 Unsigned32, 2768 Gauge32, 2769 mib-2 2770 FROM SNMPv2-SMI -- RFC 2578 2772 TruthValue, 2773 TimeStamp, DateAndTime 2774 FROM SNMPv2-TC -- RFC 2579 2776 MODULE-COMPLIANCE, 2777 OBJECT-GROUP 2778 FROM SNMPv2-CONF -- RFC 2580 2780 SnmpAdminString 2781 FROM SNMP-FRAMEWORK-MIB -- RFC 3411 2783 applIndex 2784 FROM NETWORK-SERVICES-MIB -- RFC 2788 2786 InetAddressType, 2787 InetAddress 2788 FROM INET-ADDRESS-MIB; -- RFC 4001 2790 sipServerMIB MODULE-IDENTITY 2791 LAST-UPDATED "200609121700Z" 2792 ORGANIZATION "IETF Session Initiation Protocol 2793 Working Group" 2794 CONTACT-INFO 2795 "SIP WG email: sip@ietf.org 2797 Co-editor: Kevin Lingle 2798 Cisco Systems, Inc. 2799 postal: 7025 Kit Creek Road 2800 P.O. Box 14987 2801 Research Triangle Park, NC 27709 2802 USA 2803 email: klingle@cisco.com 2804 phone: +1 919 392 2029 2806 Co-editor: Joon Maeng 2807 email: jmaeng@austin.rr.com 2809 Co-editor: Jean-Francois Mule 2810 CableLabs 2811 postal: 858 Coal Creek Circle 2812 Louisville, CO 80027 2813 USA 2814 email: jf.mule@cablelabs.com 2815 phone: +1 303 661 9100 2817 Co-editor: Dave Walker 2818 email: drwalker@rogers.com 2819 " 2820 DESCRIPTION 2821 "Session Initiation Protocol (SIP) Server MIB module. SIP is an 2822 application-layer signaling protocol for creating, modifying 2823 and terminating multimedia sessions with one or more 2824 participants. These sessions include Internet multimedia 2825 conferences and Internet telephone calls. SIP is defined in 2826 RFC 3261 (June 2002). 2828 This MIB is defined for the management of SIP Proxy, Redirect 2829 and Registrar Servers. 2831 A Proxy Server acts as both a client and a server. It accepts 2832 requests from other clients, either responding to them or 2833 passing them on to other servers, possibly after modification. 2835 A Redirect Server accepts requests from clients and returns 2836 zero or more addresses to that client. Unlike a User Agent 2837 Server it does not accept calls. 2839 A Registrar is a server that accepts REGISTER requests. A 2840 Registrar is typically co-located with a Proxy or Redirect 2841 Server. 2843 Copyright (C) The Internet Society (2006). This version of 2844 this MIB module is part of RFC XXXX; see the RFC itself for 2845 full legal notices." 2846 -- RFC Ed: replace XXXX with actual RFC number and remove this note 2847 REVISION "200609121700Z" 2848 DESCRIPTION 2849 "Initial version of the IETF SIP-SERVER-MIB module. This 2850 version published as part of RFC XXXX." 2851 -- RFC Ed: replace XXXX with actual RFC number and remove this note 2852 ::= { mib-2 XXX4 } 2853 -- RFC Ed: replace XXX4 with actual IANA assigned number 2854 -- and remove this note 2856 -- Top-Level Components of this MIB. 2858 sipServerMIBObjects OBJECT IDENTIFIER ::= { sipServerMIB 1 } 2859 sipServerMIBConformance OBJECT IDENTIFIER ::= { sipServerMIB 2 } 2861 -- 2862 -- These groups contain objects common to all SIP servers. 2863 -- 2864 sipServerCfg OBJECT IDENTIFIER ::= { sipServerMIBObjects 1 } 2866 -- 2867 -- Common Server Configuration Objects 2868 -- 2869 sipServerCfgTable OBJECT-TYPE 2870 SYNTAX SEQUENCE OF SipServerCfgEntry 2871 MAX-ACCESS not-accessible 2872 STATUS current 2873 DESCRIPTION 2874 "This table contains configuration objects applicable to SIP 2875 Redirect and Proxy Servers." 2876 ::= { sipServerCfg 1 } 2878 sipServerCfgEntry OBJECT-TYPE 2879 SYNTAX SipServerCfgEntry 2880 MAX-ACCESS not-accessible 2881 STATUS current 2882 DESCRIPTION 2883 "A row of common configuration. 2885 Each row represents those objects for a particular SIP server 2886 present in this system. applIndex is used to uniquely identify 2887 these instances of SIP servers and correlate them through the 2888 common framework of the NETWORK-SERVICES-MIB (RFC 2788). The 2889 same value of applIndex used in the corresponding 2890 SIP-COMMON-MIB is used here." 2891 INDEX { applIndex } 2892 ::= { sipServerCfgTable 1 } 2894 SipServerCfgEntry ::= 2895 SEQUENCE { 2896 sipServerCfgHostAddressType InetAddressType, 2897 sipServerCfgHostAddress InetAddress 2898 } 2900 sipServerCfgHostAddressType OBJECT-TYPE 2901 SYNTAX InetAddressType 2902 MAX-ACCESS read-only 2904 STATUS current 2905 DESCRIPTION 2906 "The type of Internet address by which the SIP server is 2907 reachable." 2908 REFERENCE 2909 "RFC 3261, Section 19.1.1" 2910 ::= { sipServerCfgEntry 1 } 2912 sipServerCfgHostAddress OBJECT-TYPE 2913 SYNTAX InetAddress 2914 MAX-ACCESS read-only 2915 STATUS current 2916 DESCRIPTION 2917 "This is the host portion of a SIP URI that is assigned to the 2918 SIP server. It MAY contain a fully qualified domain name, or 2919 an IP address. The length of the value will depend on the type 2920 of address specified. The type of address given by this object 2921 is controlled by sipServerCfgHostAddressType." 2922 REFERENCE 2923 "RFC 3261, Section 19.1.1" 2924 ::= { sipServerCfgEntry 2 } 2926 -- 2927 -- This group contains MIB objects 2928 -- related to SIP Proxy Servers. 2929 -- 2930 sipServerProxyCfg OBJECT IDENTIFIER ::= { sipServerMIBObjects 3 } 2931 sipServerProxyStats OBJECT IDENTIFIER ::= { sipServerMIBObjects 4 } 2933 -- 2934 -- Proxy Server Configuration 2935 -- 2936 sipServerProxyCfgTable OBJECT-TYPE 2937 SYNTAX SEQUENCE OF SipServerProxyCfgEntry 2938 MAX-ACCESS not-accessible 2939 STATUS current 2940 DESCRIPTION 2941 "This table contains configuration objects applicable to SIP 2942 Proxy Servers." 2943 ::= { sipServerProxyCfg 1 } 2945 sipServerProxyCfgEntry OBJECT-TYPE 2946 SYNTAX SipServerProxyCfgEntry 2947 MAX-ACCESS not-accessible 2948 STATUS current 2949 DESCRIPTION 2950 "A row of common proxy configuration. 2952 Each row represents those objects for a particular SIP server 2953 present in this system. applIndex is used to uniquely identify 2954 these instances of SIP servers and correlate them through the 2955 common framework of the NETWORK-SERVICES-MIB (RFC 2788). The 2956 same value of applIndex used in the corresponding 2957 SIP-COMMON-MIB is used here." 2958 INDEX { applIndex } 2959 ::= { sipServerProxyCfgTable 1 } 2961 SipServerProxyCfgEntry ::= 2962 SEQUENCE { 2963 sipServerCfgProxyStatefulness INTEGER, 2964 sipServerCfgProxyRecursion TruthValue, 2965 sipServerCfgProxyRecordRoute TruthValue, 2966 sipServerCfgProxyAuthMethod BITS, 2967 sipServerCfgProxyAuthDefaultRealm SnmpAdminString 2968 } 2970 sipServerCfgProxyStatefulness OBJECT-TYPE 2971 SYNTAX INTEGER { 2972 stateless(1), 2973 transactionStateful(2), 2974 callStateful(3) 2975 } 2976 MAX-ACCESS read-only 2977 STATUS current 2978 DESCRIPTION 2979 "This object reflects the default mode of operation for the 2980 Proxy Server entity. 2982 A stateless proxy is a logical entity that does not maintain 2983 the client or server transaction state machines when it 2984 processes requests. A stateless proxy forwards every request it 2985 receives downstream and every response it receives upstream. If 2986 the value of this object is stateless(1), the proxy defaults to 2987 stateless operations. 2989 A transaction stateful proxy, or simply a 'stateful proxy', is 2990 a logical entity that maintains the client and server 2991 transaction state machines during the processing of a request. 2992 A (transaction) stateful proxy is not the same as a call 2993 stateful proxy. If the value if this object is 2994 transactionStateful(2), the proxy is stateful on a transaction 2995 basis. 2997 A call stateful proxy is a logical entity if it retains state 2998 for a dialog from the initiating INVITE to the terminating BYE 2999 request. A call stateful proxy is always transaction stateful, 3000 but the converse is not necessarily true. If the value of this 3001 object is callStateful(3), the proxy is call stateful." 3003 REFERENCE 3004 "RFC 3261, Section 16" 3005 ::= { sipServerProxyCfgEntry 1 } 3007 sipServerCfgProxyRecursion OBJECT-TYPE 3008 SYNTAX TruthValue 3009 MAX-ACCESS read-only 3010 STATUS current 3011 DESCRIPTION 3012 "This object reflects whether or not the Proxy performs 3013 recursive search on the Contacts provided in 3xx redirects. 3015 If the value of this object is 'true', a recursive search is 3016 performed. If the value is 'false', no search is performed, 3017 the 3xx response is sent upstream towards the source of the 3018 request." 3019 REFERENCE 3020 "RFC 3261 Sections 16.5 and 16.6" 3021 ::= { sipServerProxyCfgEntry 2 } 3023 sipServerCfgProxyRecordRoute OBJECT-TYPE 3024 SYNTAX TruthValue 3025 MAX-ACCESS read-only 3026 STATUS current 3027 DESCRIPTION 3028 "This object reflects whether or not the proxy adds itself to 3029 the Record-Route header as a default action. This header is 3030 used to list the proxies that insist on being in the signaling 3031 path for subsequent requests related to the call-leg. 3033 If the value of this object is 'true', the proxy adds itself to 3034 the end of the Record-Route header, creating the header if 3035 required. If the value is 'false', the proxy does not add 3036 itself to the Record-Route header." 3037 REFERENCE 3038 "RFC 3261, Section 20.30" 3039 ::= { sipServerProxyCfgEntry 3 } 3041 -- 3042 -- Security 3043 -- 3044 sipServerCfgProxyAuthMethod OBJECT-TYPE 3045 SYNTAX BITS { 3046 none(0), 3047 tls(1), 3048 digest(2) 3049 } 3050 MAX-ACCESS read-only 3051 STATUS current 3052 DESCRIPTION 3053 "This object reflects the authentication methods that MAY be 3054 used to authenticate request originators. 3056 bit 0 no authentication is performed 3057 bit 1 TLS is used 3058 bit 2 HTTP Digest is used." 3059 REFERENCE 3060 "RFC 3261 Sections 22, 23, 26, 26.2.3" 3061 ::= { sipServerProxyCfgEntry 4 } 3063 sipServerCfgProxyAuthDefaultRealm OBJECT-TYPE 3064 SYNTAX SnmpAdminString 3065 MAX-ACCESS read-only 3066 STATUS current 3067 DESCRIPTION 3068 "This object reflects the default realm value used in 3069 Proxy-Authenticate headers. Note that this MAY need to be 3070 stored per user, in which case, this default value is ignored. 3071 " 3072 REFERENCE 3073 "RFC 3261, Section 22.1" 3074 ::= { sipServerProxyCfgEntry 5 } 3076 -- 3077 -- Proxy Server Statistics 3078 -- 3079 sipServerProxyStatsTable OBJECT-TYPE 3080 SYNTAX SEQUENCE OF SipServerProxyStatsEntry 3081 MAX-ACCESS not-accessible 3083 STATUS current 3084 DESCRIPTION 3085 "This table contains the statistics objects applicable to all 3086 SIP Proxy Servers in this system." 3087 ::= { sipServerProxyStats 1 } 3089 sipServerProxyStatsEntry OBJECT-TYPE 3090 SYNTAX SipServerProxyStatsEntry 3091 MAX-ACCESS not-accessible 3092 STATUS current 3093 DESCRIPTION 3094 "A row of summary statistics. 3096 Each row represents those objects for a particular SIP server 3097 present in this system. applIndex is used to uniquely identify 3098 these instances of SIP servers and correlate them through the 3099 common framework of the NETWORK-SERVICES-MIB (RFC 2788). The 3100 same value of applIndex used in the corresponding 3101 SIP-COMMON-MIB is used here." 3102 INDEX { applIndex } 3103 ::= { sipServerProxyStatsTable 1 } 3105 SipServerProxyStatsEntry ::= 3106 SEQUENCE { 3107 sipServerProxyStatProxyReqFailures Counter32, 3108 sipServerProxyStatsDisconTime TimeStamp 3109 } 3111 sipServerProxyStatProxyReqFailures OBJECT-TYPE 3112 SYNTAX Counter32 3113 MAX-ACCESS read-only 3114 STATUS current 3115 DESCRIPTION 3116 "This object contains the number of occurrences of unsupported 3117 options being specified in received Proxy-Require headers. 3118 Such occurrences result in a 420 Bad Extension status code 3119 being returned. 3121 Discontinuities in the value of this counter can occur at 3122 re-initialization of the SIP entity or service. A Management 3123 Station can detect discontinuities in this counter by 3124 monitoring the sipServerProxyStatsDisconTime object in the same 3125 row." 3126 ::= { sipServerProxyStatsEntry 1 } 3128 sipServerProxyStatsDisconTime OBJECT-TYPE 3129 SYNTAX TimeStamp 3130 MAX-ACCESS read-only 3131 STATUS current 3132 DESCRIPTION 3133 "The value of the sysUpTime object when the counters for the server 3134 statistics objects in this row last experienced a discontinuity." 3135 ::= { sipServerProxyStatsEntry 2 } 3137 -- 3138 -- This group contains MIB objects related to SIP Registrars. 3139 -- 3140 sipServerRegCfg OBJECT IDENTIFIER ::= { sipServerMIBObjects 5 } 3141 sipServerRegStats OBJECT IDENTIFIER ::= { sipServerMIBObjects 6 } 3143 -- 3144 -- Registrar Configuration 3145 -- 3146 sipServerRegCfgTable OBJECT-TYPE 3147 SYNTAX SEQUENCE OF SipServerRegCfgEntry 3148 MAX-ACCESS not-accessible 3149 STATUS current 3150 DESCRIPTION 3151 "This table contains configuration objects applicable SIP 3152 Registrars." 3153 ::= { sipServerRegCfg 1 } 3155 sipServerRegCfgEntry OBJECT-TYPE 3156 SYNTAX SipServerRegCfgEntry 3157 MAX-ACCESS not-accessible 3158 STATUS current 3159 DESCRIPTION 3160 "A row of common Registrar configuration. 3162 Each row represents those objects for a particular SIP server 3163 present in this system. applIndex is used to uniquely identify 3164 these instances of SIP servers and correlate them through the 3165 common framework of the NETWORK-SERVICES-MIB (RFC 2788). The 3166 same value of applIndex used in the corresponding 3167 SIP-COMMON-MIB is used here." 3168 INDEX { applIndex } 3169 ::= { sipServerRegCfgTable 1 } 3171 SipServerRegCfgEntry ::= 3172 SEQUENCE { 3173 sipServerRegMaxContactExpiryDuration Unsigned32, 3174 sipServerRegMaxUsers Unsigned32, 3175 sipServerRegCurrentUsers Gauge32, 3176 sipServerRegDfltRegActiveInterval Unsigned32 3177 } 3179 sipServerRegMaxContactExpiryDuration OBJECT-TYPE 3180 SYNTAX Unsigned32 (0..4294967295) 3181 UNITS "seconds" 3182 MAX-ACCESS read-only 3183 STATUS current 3184 DESCRIPTION 3185 "This object reflects the maximum expiry that may be requested 3186 by a User Agent for a particular Contact. User Agents can 3187 specify expiry using either an Expiry header in a REGISTER 3188 request, or using an Expires parameter in a Contact header in 3189 a REGISTER request. If the value requested by the User Agent 3190 is greater than the value of this object, then the contact 3191 information is given the duration specified by this object, and 3192 that duration is indicated to the User Agent in the response." 3193 ::= { sipServerRegCfgEntry 1 } 3195 sipServerRegMaxUsers OBJECT-TYPE 3196 SYNTAX Unsigned32 (1..4294967295) 3197 MAX-ACCESS read-only 3198 STATUS current 3199 DESCRIPTION 3200 "This object reflects the maximum number of users that the 3201 Registrar supports. The current number of users is reflected 3202 by sipServerRegCurrentUsers." 3203 ::= { sipServerRegCfgEntry 2 } 3205 sipServerRegCurrentUsers OBJECT-TYPE 3206 SYNTAX Gauge32 (0..4294967295) 3207 MAX-ACCESS read-only 3208 STATUS current 3209 DESCRIPTION 3210 "This object reflects the number of users currently registered 3211 with the Registrar." 3212 ::= { sipServerRegCfgEntry 3 } 3214 sipServerRegDfltRegActiveInterval OBJECT-TYPE 3215 SYNTAX Unsigned32 (1..4294967295) 3216 UNITS "seconds" 3217 MAX-ACCESS read-only 3218 STATUS current 3219 DESCRIPTION 3220 "This object reflects the default time interval the Registrar 3221 considers registrations to be active. The value is used to 3222 compute the Expires header in the REGISTER response. If a user 3223 agent requests a time interval shorter than specified by this 3224 object, the Registrar SHOULD honor that request. If a Contact 3225 entry does not have an 'expires' parameter, the value of the 3226 Expires header field is used instead. If a Contact entry has no 3227 'expires' parameter and no the Expires header field is present, 3228 the value of this object is used as the default value." 3229 REFERENCE 3230 "RFC 3261, Section 10.2" 3231 ::= { sipServerRegCfgEntry 4 } 3232 -- 3233 -- Per User Information 3234 -- 3235 sipServerRegUserTable OBJECT-TYPE 3236 SYNTAX SEQUENCE OF SipServerRegUserEntry 3237 MAX-ACCESS not-accessible 3238 STATUS current 3239 DESCRIPTION 3240 "This table contains information on all users registered to each 3241 Registrar in this system." 3242 ::= { sipServerRegCfg 2 } 3244 sipServerRegUserEntry OBJECT-TYPE 3245 SYNTAX SipServerRegUserEntry 3246 MAX-ACCESS not-accessible 3247 STATUS current 3248 DESCRIPTION 3249 "This entry contains information for a single user registered to 3250 this Registrar. 3252 Each row represents those objects for a particular SIP server 3253 present in this system. applIndex is used to uniquely identify 3254 these instances of SIP servers and correlate them through the 3255 common framework of the NETWORK-SERVICES-MIB (RFC 2788). The 3256 same value of applIndex used in the corresponding 3257 SIP-COMMON-MIB is used here." 3258 INDEX { applIndex, sipServerRegUserIndex } 3259 ::= { sipServerRegUserTable 1 } 3261 SipServerRegUserEntry ::= 3262 SEQUENCE { 3263 sipServerRegUserIndex Unsigned32, 3264 sipServerRegUserUri SnmpAdminString, 3265 sipServerRegUserAuthenticationFailures Counter32, 3266 sipServerRegUserDisconTime TimeStamp 3267 } 3269 sipServerRegUserIndex OBJECT-TYPE 3270 SYNTAX Unsigned32 (1..4294967295) 3271 MAX-ACCESS not-accessible 3272 STATUS current 3273 DESCRIPTION 3274 "This object uniquely identifies a conceptual row in the table." 3275 ::= { sipServerRegUserEntry 1 } 3277 sipServerRegUserUri OBJECT-TYPE 3278 SYNTAX SnmpAdminString 3279 MAX-ACCESS read-only 3280 STATUS current 3281 DESCRIPTION 3282 "This object contains the user's address-of-record. It is the 3283 main form by which the Registrar knows the user. The format is 3284 typically 'user@domain'. It is contained in the To header for 3285 all REGISTER requests." 3286 ::= { sipServerRegUserEntry 2 } 3288 sipServerRegUserAuthenticationFailures OBJECT-TYPE 3289 SYNTAX Counter32 3290 MAX-ACCESS read-only 3291 STATUS current 3292 DESCRIPTION 3293 "This object contains a count of the number of times the user 3294 has failed authentication. 3296 Discontinuities in the value of this counter can occur due to 3297 successful user authentications, and at re-initialization of 3298 the SIP entity or service. A Management Station can detect 3299 discontinuities in this counter by monitoring the 3300 sipServerRegUserDisconTime object in the same row." 3301 ::= { sipServerRegUserEntry 3 } 3303 sipServerRegUserDisconTime OBJECT-TYPE 3304 SYNTAX TimeStamp 3305 MAX-ACCESS read-only 3306 STATUS current 3307 DESCRIPTION 3308 "The value of the sysUpTime object when the counters for the 3309 user registration statistic objects in this row last 3310 experienced a discontinuity." 3311 ::= { sipServerRegUserEntry 4 } 3312 -- 3313 -- Per Contact Information 3314 -- 3315 sipServerRegContactTable OBJECT-TYPE 3316 SYNTAX SEQUENCE OF SipServerRegContactEntry 3317 MAX-ACCESS not-accessible 3318 STATUS current 3319 DESCRIPTION 3320 "This table contains information on every location where a 3321 registered user (specified by sipServerRegUserIndex) wishes to 3322 be found (i.e. the user has provided Contact information to 3323 each SIP Registrar in this system)." 3324 ::= { sipServerRegCfg 3 } 3326 sipServerRegContactEntry OBJECT-TYPE 3327 SYNTAX SipServerRegContactEntry 3328 MAX-ACCESS not-accessible 3329 STATUS current 3330 DESCRIPTION 3331 "This entry contains information for a single Contact. Multiple 3332 contacts may exist for a single user. 3334 Each row represents those objects for a particular SIP server 3335 present in this system. applIndex is used to uniquely identify 3336 these instances of SIP servers and correlate them through the 3337 common framework of the NETWORK-SERVICES-MIB (RFC 2788). The 3338 same value of applIndex used in the corresponding 3339 SIP-COMMON-MIB is used here." 3341 INDEX { applIndex, 3342 sipServerRegUserIndex, 3343 sipServerRegContactIndex 3344 } 3345 ::= { sipServerRegContactTable 1 } 3347 SipServerRegContactEntry ::= 3348 SEQUENCE { 3349 sipServerRegContactIndex Unsigned32, 3350 sipServerRegContactDisplayName SnmpAdminString, 3351 sipServerRegContactURI SnmpAdminString, 3352 sipServerRegContactLastUpdated TimeStamp, 3353 sipServerRegContactExpiry DateAndTime, 3354 sipServerRegContactPreference SnmpAdminString 3355 } 3357 sipServerRegContactIndex OBJECT-TYPE 3358 SYNTAX Unsigned32 (1..4294967295) 3359 MAX-ACCESS not-accessible 3360 STATUS current 3361 DESCRIPTION 3362 "Along with the sipServerRegUserIndex, this object uniquely 3363 identifies a conceptual row in the table." 3364 ::= { sipServerRegContactEntry 1 } 3366 sipServerRegContactDisplayName OBJECT-TYPE 3367 SYNTAX SnmpAdminString 3368 MAX-ACCESS read-only 3369 STATUS current 3370 DESCRIPTION 3371 "This object contains the display name for the Contact. For 3372 example, 'Santa at Home', or 'Santa on his Sled', corresponding 3373 to contact URIs of sip:BigGuy@example.com or 3374 sip:sclaus817@example.com, respectively." 3375 ::= { sipServerRegContactEntry 2 } 3377 sipServerRegContactURI OBJECT-TYPE 3378 SYNTAX SnmpAdminString 3379 MAX-ACCESS read-only 3380 STATUS current 3381 DESCRIPTION 3382 "This object contains either a SIP URI where the user can be 3383 contacted. This URI is normally returned to a client from a 3384 Redirect Server, or is used as the RequestURI in a SIP request 3385 line for requests forwarded by a proxy." 3386 ::= { sipServerRegContactEntry 3 } 3388 sipServerRegContactLastUpdated OBJECT-TYPE 3389 SYNTAX TimeStamp 3390 MAX-ACCESS read-only 3391 STATUS current 3392 DESCRIPTION 3393 "This object indicates the time when this contact information 3394 was accepted. If the contact information is updated via a 3395 subsequent REGISTER of the same information, this object is 3396 also updated." 3397 ::= { sipServerRegContactEntry 4 } 3399 sipServerRegContactExpiry OBJECT-TYPE 3400 SYNTAX DateAndTime 3401 MAX-ACCESS read-only 3402 STATUS current 3403 DESCRIPTION 3404 "This object contains the date and time when the contact 3405 information will no longer be valid. Such times may be 3406 specified by the user at registration (Expires header or expiry 3407 parameter in the Contact information), or a system default can 3408 be applied." 3409 ::= { sipServerRegContactEntry 5 } 3411 sipServerRegContactPreference OBJECT-TYPE 3412 SYNTAX SnmpAdminString 3413 MAX-ACCESS read-only 3414 STATUS current 3415 DESCRIPTION 3416 "This object indicates a relative preference for the particular 3417 Contact header field value compared to other bindings for this 3418 address-of-record. A registering user may provide this 3419 preference as a 'qvalue' parameter in the Contact header. 3421 The format of this item is a decimal number between 0 and 1 3422 (for example 0.9). Higher values indicate locations preferred 3423 by the user." 3424 REFERENCE 3425 "RFC 3261, Section 10.2.1.2, 16.6 and 20.10" 3426 ::= { sipServerRegContactEntry 6 } 3428 -- 3429 -- Registrar Statistics 3430 -- 3431 sipServerRegStatsTable OBJECT-TYPE 3432 SYNTAX SEQUENCE OF SipServerRegStatsEntry 3433 MAX-ACCESS not-accessible 3434 STATUS current 3435 DESCRIPTION 3436 "This table contains the summary statistics objects applicable 3437 to all SIP Registrars in this system." 3438 ::= { sipServerRegStats 1 } 3440 sipServerRegStatsEntry OBJECT-TYPE 3441 SYNTAX SipServerRegStatsEntry 3442 MAX-ACCESS not-accessible 3443 STATUS current 3444 DESCRIPTION 3445 "A row of summary statistics. 3447 Each row represents those objects for a particular SIP server 3448 present in this system. applIndex is used to uniquely identify 3449 these instances of SIP servers and correlate them through the 3450 common framework of the NETWORK-SERVICES-MIB (RFC 2788). The 3451 same value of applIndex used in the corresponding 3452 SIP-COMMON-MIB is used here." 3453 INDEX { applIndex } 3454 ::= { sipServerRegStatsTable 1 } 3456 SipServerRegStatsEntry ::= 3457 SEQUENCE { 3458 sipServerRegStatsAcceptedRegs Counter32, 3459 sipServerRegStatsRejectedRegs Counter32, 3460 sipServerRegStatsDisconTime TimeStamp 3461 } 3463 sipServerRegStatsAcceptedRegs OBJECT-TYPE 3464 SYNTAX Counter32 3465 MAX-ACCESS read-only 3466 STATUS current 3467 DESCRIPTION 3468 "This object contains a count of the number of REGISTER requests 3469 that have been accepted (status code 200) by the Registrar. 3470 This includes additions of new contact information, refreshing 3471 contact information, as well as requests for deletion of 3472 contact information. 3474 Discontinuities in the value of this counter can occur at 3475 re-initialization of the SIP entity or service. A Management 3476 Station can detect discontinuities in this counter by 3477 monitoring the sipServerRegStatsDisconTime object in the same 3478 row." 3479 ::= { sipServerRegStatsEntry 1 } 3481 sipServerRegStatsRejectedRegs OBJECT-TYPE 3482 SYNTAX Counter32 3483 MAX-ACCESS read-only 3484 STATUS current 3485 DESCRIPTION 3486 "This object contains a count of the number REGISTER requests 3487 that have been rejected by the Registrar. 3489 Discontinuities in the value of this counter can occur at 3490 re-initialization of the SIP entity or service. A Management 3491 Station can detect discontinuities in this counter by 3492 monitoring the sipServerRegStatsDisconTime object in the same 3493 row." 3494 ::= { sipServerRegStatsEntry 2 } 3496 sipServerRegStatsDisconTime OBJECT-TYPE 3497 SYNTAX TimeStamp 3498 MAX-ACCESS read-only 3499 STATUS current 3500 DESCRIPTION 3501 "The value of the sysUpTime object when the counters for the 3502 registrar statistic objects in this row last experienced a 3503 discontinuity." 3504 ::= { sipServerRegStatsEntry 3 } 3506 -- 3507 -- Conformance 3508 -- 3509 sipServerMIBCompliances 3510 OBJECT IDENTIFIER ::= { sipServerMIBConformance 1 } 3511 sipServerMIBGroups 3512 OBJECT IDENTIFIER ::= { sipServerMIBConformance 2 } 3514 -- 3515 -- Compliance Statements 3516 -- 3517 sipServerProxyServerCompliance MODULE-COMPLIANCE 3518 STATUS current 3519 DESCRIPTION 3520 "The compliance statement for SIP entities acting as Proxy 3521 Servers." 3522 MODULE -- this module 3523 MANDATORY-GROUPS { sipServerConfigGroup, 3524 sipServerProxyConfigGroup, 3525 sipServerProxyStatsGroup 3526 } 3527 ::= { sipServerMIBCompliances 1 } 3529 sipRedirectServerCompliance MODULE-COMPLIANCE 3530 STATUS current 3531 DESCRIPTION 3532 "The compliance statement for SIP entities acting as Redirect 3533 Servers." 3534 MODULE -- this module 3535 MANDATORY-GROUPS { sipServerConfigGroup } 3536 ::= { sipServerMIBCompliances 2 } 3538 sipServerRegistrarServerCompliance MODULE-COMPLIANCE 3539 STATUS current 3540 DESCRIPTION 3541 "The compliance statement for SIP entities acting as 3542 Registrars." 3543 MODULE -- this module 3544 MANDATORY-GROUPS { sipServerConfigGroup, 3545 sipServerRegistrarConfigGroup, 3546 sipServerRegistrarStatsGroup } 3547 GROUP sipServerRegistrarUsersGroup 3548 DESCRIPTION 3549 "This is an optional group." 3550 ::= { sipServerMIBCompliances 3 } 3552 -- 3553 -- Units of Conformance 3554 -- 3555 sipServerConfigGroup OBJECT-GROUP 3556 OBJECTS { 3557 sipServerCfgHostAddressType, 3558 sipServerCfgHostAddress 3559 } 3560 STATUS current 3561 DESCRIPTION 3562 "A collection of objects providing configuration common to SIP 3563 Proxy and Redirect servers." 3564 ::= { sipServerMIBGroups 1 } 3566 sipServerProxyConfigGroup OBJECT-GROUP 3567 OBJECTS { 3568 sipServerCfgProxyStatefulness, 3569 sipServerCfgProxyRecursion, 3570 sipServerCfgProxyRecordRoute, 3571 sipServerCfgProxyAuthMethod, 3572 sipServerCfgProxyAuthDefaultRealm 3573 } 3574 STATUS current 3575 DESCRIPTION 3576 "A collection of objects providing configuration for SIP Proxy 3577 servers." 3578 ::= { sipServerMIBGroups 2 } 3580 sipServerProxyStatsGroup OBJECT-GROUP 3581 OBJECTS { 3582 sipServerProxyStatProxyReqFailures, 3583 sipServerProxyStatsDisconTime 3584 } 3585 STATUS current 3586 DESCRIPTION 3587 "A collection of objects providing statistics for SIP Proxy 3588 servers." 3589 ::= { sipServerMIBGroups 3 } 3591 sipServerRegistrarConfigGroup OBJECT-GROUP 3592 OBJECTS { 3593 sipServerRegMaxContactExpiryDuration, 3594 sipServerRegMaxUsers, 3595 sipServerRegCurrentUsers, 3596 sipServerRegDfltRegActiveInterval 3597 } 3598 STATUS current 3599 DESCRIPTION 3600 "A collection of objects providing configuration for SIP 3601 Registrars." 3602 ::= { sipServerMIBGroups 4 } 3604 sipServerRegistrarStatsGroup OBJECT-GROUP 3605 OBJECTS { 3606 sipServerRegStatsAcceptedRegs, 3607 sipServerRegStatsRejectedRegs, 3608 sipServerRegStatsDisconTime 3609 } 3610 STATUS current 3611 DESCRIPTION 3612 "A collection of objects providing statistics for SIP 3613 Registrars." 3614 ::= { sipServerMIBGroups 5 } 3616 sipServerRegistrarUsersGroup OBJECT-GROUP 3617 OBJECTS { 3618 sipServerRegUserUri, 3619 sipServerRegUserAuthenticationFailures, 3620 sipServerRegUserDisconTime, 3621 sipServerRegContactDisplayName, 3622 sipServerRegContactURI, 3623 sipServerRegContactLastUpdated, 3624 sipServerRegContactExpiry, 3625 sipServerRegContactPreference 3626 } 3627 STATUS current 3628 DESCRIPTION 3629 "A collection of objects related to registered users." 3630 ::= { sipServerMIBGroups 6 } 3632 END 3634 8. IANA Considerations 3636 The MIB modules defined in this document use the following IANA- 3637 assigned OBJECT IDENTIFIER values recorded in the SMI Numbers 3638 registry: 3640 +--------------+-------------------------+ 3641 | Descriptor | OBJECT IDENTIFIER value | 3642 +--------------+-------------------------+ 3643 | sipTC | { mib-2 XXX1 } | 3644 | sipCommonMIB | { mib-2 XXX2 } | 3645 | sipUAMIB | { mib-2 XXX3 } | 3646 | sipServerMIB | { mib-2 XXX4} | 3647 +--------------+-------------------------+ 3649 -- RFC Ed:(note to be removed prior to publication): the IANA is 3650 requested to assign 4 values in the SMI Numbers registry for "XXX1", 3651 "XXX2", "XXX3", and "XXX4", all under the 'mib-2' sub-tree and to 3652 record the assignments in the SMI Numbers registry. When the 3653 assignments have been made, the RFC Editor is asked to replace "XXX1" 3654 through "XXX4" (here and in the 4 MIB modules) with the corresponding 3655 assigned value and to remove this note. 3657 9. Security Considerations 3659 There are a number of management objects defined in the SIP-COMMON- 3660 MIB MIB module with a MAX-ACCESS clause of read-write and/or read- 3661 create. Such objects may be considered sensitive or vulnerable in 3662 some network environments. The support for SET operations in a non- 3663 secure environment without proper protection can have a negative 3664 effect on network operations. 3666 The following read-create object in SIP-COMMON-MIB is used to 3667 configure the status code statistics that will be monitored by the 3668 SIP entity: 3669 sipCommonStatusCodeRowStatus: 3670 if this object is SET maliciously, it may result in an over 3671 allocation of resources in a system for the purpose of 3672 accumulating and maintaining statistics. 3674 The following read-write objects in SIP-COMMON-MIB are used to 3675 configure the behavior of certain SNMP notifications potentially 3676 generated by a SIP entity: 3677 sipCommonStatusCodeNotifSend, sipCommonStatusCodeNotifEmitMode, 3678 sipCommonStatusCodeNotifThresh, sipCommonStatusCodeNotifInterval, 3679 sipCommonCfgServiceNotifEnable: 3680 If these objects are SET maliciously, it may result in a system 3681 and/or network performance impact due to the generation of SNMP 3682 notifications. 3684 Some of the readable objects in the MIB modules (i.e., objects with a 3685 MAX-ACCESS other than not-accessible) may be considered sensitive or 3686 vulnerable in some network environments. It is thus important to 3687 control even GET and/or NOTIFY access to these objects and possibly 3688 to even encrypt the values of these objects when sending them over 3689 the network via SNMP. 3691 The following object values may contain private or confidential 3692 customer information like first name, last name, customer 3693 identification, location, company affiliation, the time the 3694 information was updated, etc. 3695 sipServerRegContactDisplayName, sipServerRegContactURI, 3696 sipServerRegContactLastUpdated and sipCommonCfgOrganization. 3698 The sipCommonCfgTable table contains some objects that may help 3699 attackers gain knowledge about the status and operations of the SIP 3700 service. In particular, the object value of 3701 sipCommonCfgServiceOperStatus may indicate that the SIP entity is in 3702 congested state and may lead attackers to build additional service 3703 attacks to overload the system. 3705 The sipCommonCfgEntityType object indicates the type of SIP entity 3706 and the sipCommonMethodSupportedTable table contains in the SIP- 3707 COMMON-MIB MIB module list of SIP methods supported by each entity in 3708 the system. Gaining access to this information may allow attackers 3709 to build method specific attacks or use unsupported methods to create 3710 denial of service attack scenarios. 3712 In the SIP-UA-MIB MIB module, the sipUACfgServerTable contains the 3713 address of the SIP servers providing services to the UA and obtaining 3714 this information may disclose some private or sensitive information 3715 about the SIP service usage. 3717 In the SIP-SERVER-MIB MIB module, the sipServerCfgProxyAuthMethod 3718 object defines the authentication methods supported by the server and 3719 may be used to build specific denial of service attackers targeted at 3720 the security mechanisms employed by the SIP entity. 3722 SNMP versions prior to SNMPv3 did not include adequate security. 3724 Even if the network itself is secure (for example by using IPsec), 3725 even then, there is no control as to who on the secure network is 3726 allowed to access and GET/SET (read/change/create/delete) the objects 3727 in this set of MIB modules. 3729 It is RECOMMENDED that implementers consider the security features as 3730 provided by the SNMPv3 framework (see RFC 3410 [RFC3410]), including 3731 full support for the SNMPv3 cryptographic mechanisms (for 3732 authentication and privacy). 3734 Further, deployment of SNMP versions prior to SNMPv3 is NOT 3735 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 3736 enable cryptographic security. It is then a customer/operator 3737 responsi when bility to ensure that the SNMP entity giving access to 3738 an instance of this MIB module is properly configured to give access 3739 to the objects only to those principals (users) that have legitimate 3740 rights to indeed GET or SET (change/create/delete) them. 3742 10. Contributor Acknowledgments 3744 We wish to thank the members of the IETF SIP and SIPPING working 3745 groups, and the SIP-MIB Design team for their comments and 3746 suggestions. Detailed comments were provided by Tom Taylor, Kavitha 3747 Patchayappan, Dan Romascanu, Cullen Jennings, Orit Levin, AC 3748 Mahendran, Mary Barnes, Rohan Mahy, Bob Penfield, Charles Eckel and 3749 Dean Willis. Special thanks to Bert Wijnen for his expert reviews 3750 which have greatly improved the SIP MIB modules. 3752 11. Changes from Previous Draft Revisions 3754 -- RFC Ed: this entire section to be removed by RFC Editor before 3755 publication. 3757 Changes from draft-ietf-sip-mib-11. 3759 The changes are due to IESG Review, additional comments from Bert 3760 Wijnen's MIB doctor review and more editorial comments. The list of 3761 changes includes: 3762 o editorial nits included fixing a section number on page 5, table 3763 identing on page 7, etc. 3764 o technical change: in sipCommonCfgServiceNotifEnable, replaced the 3765 error returned to inconsistentValue when this object is not 3766 supported but SET per RFC 3416 and Bert's comments. 3767 o Technical: changed the module name of SIP-TC to SIP-TC-MIB per 3768 RFC4181, appendix C's naming conventions. 3770 o Technical: added discontinuity timestamps for all counter tables 3771 where discontinuity can occur per Bert's recommendation. This 3772 includes: in SIP-COMMON-MIB sipCommonSummaryStatsTable, 3773 sipCommonMethodStatsTable, sipCommonStatusCodeTable, 3774 sipCommonStatsRetryTable, sipCommonOtherStatsTable, and in SIP- 3775 SERVER-MIB, sipServerProxyStatsTable, sipServerRegUserTable, 3776 sipServerRegStatsTable. 3777 o removed the requirements on persistency of objects for non- 3778 writeable objects. 3779 o In section 5.2, changed MUST into SHOULD in the following 3780 sentence: "the applName value for the combined server entity 3781 SHOULD reflect the appropriate combination followed by a unique 3782 application instance identifier". 3783 o renamed all objects in all MIB modules to ensure the object names 3784 start with either SipTC___, sipCommon____, sipServer___, sipUA____ 3785 per Bert Wijnen extensive set of comments and to avoid any to 3786 avoid any possible future name clashes with RFC1694 (MIB module 3787 named sipMIB where numerous objects start with sip___) 3788 o changed naming of sipMethodName to sipCommonMethodSupportedName 3789 because the object `sipMethodName' did differ from the old `SIP- 3790 TC-MIB::SipMethodName' only in case (per Dan Romanescu's 3791 comments). 3792 o changed the size limit of sipMethodName TC due to its use in the 3793 indexing of sipCommonMethodStatsEntry, sipCommonStatusCodeEntry 3794 and sipCommonStatsRetryEntry (per Dan Romanescu's comments). 3795 o in sipCommonCfgServiceNotifEnable, added a requirement that if an 3796 agent does not support his object, it should return a noSuchObject 3797 exception, per Bert's comments and clarified the optionality of 3798 this object by adding an OBJECT statement in the MODULE-COMPLIANCE 3799 section for SIP-COMMON. 3801 Changes from draft-ietf-sip-mib-10. 3803 The changes were mainly due to Last Call comments. The list of 3804 changes includes: 3805 o minor editorial nits including updates of all examples to use the 3806 example.com domain name; 3807 o technical changes and updates to SipTCTransportProtocol to clarify 3808 the use of TLS over TCP and TLS over SCTP; 3809 o changed sipCommonCfgMaxTransactions to reflect that it is max 3810 transactions per second; 3811 o removed sipCommonCfgOrganization from mandatory 3812 sipCommonConfigGroup in MODULE-COMPLIANCE and created a new 3813 (opitonal) object group sipCommonInformationalGroup; 3814 o updated DESCRIPTION of sipServerProxyDefaultAuthRealm to indicate 3815 that this object is the *default* realm value used by the proxy in 3816 Proxy-Authenticate headers and, added a note to say that in case 3817 of per user storage, the default value is ignored by the proxy. 3819 o removed sipServerRegAllowThirdParty because no registrar 3820 implementer seems to track them differently internally (no comment 3821 on the list), and a registrar would have to implement new logic in 3822 order to be able to exercise this part of the mib. 3823 o added a couple of references like RFC 3262 and RFC 4168. 3825 Changes from draft-ietf-sip-mib-09. 3827 The changes were minimal and mostly done to address MIB doctor 3828 comments on SipMethodIdentifier. The list of changes includes: 3829 o removal of SipMethodIdentifier textual convention per MIB doctor 3830 feedback 3831 o updates of normative references (e.g. RFC 3291 --> RFC 4001) 3832 o added a new section to provide a citation to IMPORTed RFCs as they 3833 are norm. references 3835 Changes from draft-ietf-sip-mib-08. 3837 The majority of changes are in response to additional SIP Working 3838 Group comments. 3839 o General 3840 * The IANA Consideration section was updated and a new section 3841 9.2 was added to conform with the Guidelines for Authors and 3842 Reviewers of MIB Documents, 3843 draft-ietf-ops-mib-review-guidelines-03.txt, section 3.7. 3844 * In general the ability to configure SIP entities via read- 3845 create or read-write objects was removed and those objects MAX- 3846 ACCESS constrained to read-only. This change was made based on 3847 general consensus that SNMP should be limited to monitoring 3848 rather than configuring/provisioning. 3849 * The section 5.2 (Relationship to the Network Services MIB) was 3850 updated to allow each instance of a SIP entity to have its own 3851 row in the applTable (a unique application identifier should 3852 now be appended to the "sip_xxx" entity-name). We also lowered 3853 the level of requirement on the naming convention to a SHOULD 3854 instead of a MUST per wg input. 3855 * Updated the ORGANISATION clause of all MIB modules to include 3856 the full SIP working group name. 3857 * Minor other editorial changes were made to the document. 3858 * Updated Security consideration section. 3859 o SIP-COMMON-MIB 3860 * Module description of various SIP entities enhanced. 3861 * sipCommonServiceAdminStatus removed from the MIB due to general 3862 removal of configuration capability. Resulting OID value 3863 changes to succeeding entry objects. 3864 * sipCommonCfgOrganization MAX-ACCESS changed to read-only. 3866 * sipCommonCfgTimerA MAX-ACCESS changed to read-only. 3867 * sipCommonCfgTimerB MAX-ACCESS changed to read-only. 3868 * sipCommonCfgTimerC MAX-ACCESS changed to read-only. 3869 * sipCommonCfgTimerD MAX-ACCESS changed to read-only. 3870 * sipCommonCfgTimerE MAX-ACCESS changed to read-only. 3871 * sipCommonCfgTimerF MAX-ACCESS changed to read-only. 3872 * sipCommonCfgTimerG MAX-ACCESS changed to read-only. 3873 * sipCommonCfgTimerH MAX-ACCESS changed to read-only. 3874 * sipCommonCfgTimerI MAX-ACCESS changed to read-only. 3875 * sipCommonCfgTimerJ MAX-ACCESS changed to read-only. 3876 * sipCommonCfgTimerK MAX-ACCESS changed to read-only. 3877 * sipCommonCfgTimerT1 MAX-ACCESS changed to read-only. 3878 * sipCommonCfgTimerT2 MAX-ACCESS changed to read-only. 3879 * sipCommonCfgTimerT4 MAX-ACCESS changed to read-only. 3880 * sipCommonStatusCodeTable indexing changed to also include 3881 sipCommonStatusCodeMethod. Thusly, introducing 3882 sipCommonStatusCodeMethod as a new not-accessible object in 3883 that table. Resulting OID value changes to succeeding entry 3884 objects. 3885 * sipCommonCfgTimer* OBJECT clauses regarding MIN-ACCESS levels 3886 in the MODULE-COMPLIANCE were no longer needed due to MAX- 3887 ACCESS changes for those objects. 3888 * The description clause of sipCommonMethodStatsInbounds was 3889 changed to state that retransmissions are not counted. 3890 * The description clause of sipCommonStatsRetries was changed to 3891 indicate there could be multiple retries per request (we also 3892 corrected a typo by removing the specific mention to INVITE 3893 requests). 3894 * The description clause of sipCommonStatsRetryFinalResponses was 3895 changed to indicate there could be multiple retries per 3896 response. 3897 o SIP-SERVER-MIB 3898 * Removed sipCommonCfgExpires OID declaration as this object 3899 group no longer exists since draft08. 3900 * sipUserTableRowStatus removed from the MIB due to general 3901 removal of configuration capability. In conjunction, RowStatus 3902 textual convention is no longer imported. 3903 * sipServerCfgHostAddressType MAX-ACCESS changed to read-only. 3904 * sipServerCfgHostAddress MAX-ACCESS changed to read-only. 3905 * sipServerCfgProxyRecursion MAX-ACCESS changed to read-only. 3906 * sipServerCfgProxyRecordRoute MAX-ACCESS changed to read-only. 3907 * sipServerCfgProxyAuthMethod MAX-ACCESS changed to read-only. 3908 * sipServerRegAllowThirdParty MAX-ACCESS changed to read-only. 3909 * sipServerRegMaxContactExpiryDuration MAX-ACCESS changed to 3910 read-only. 3911 * sipServerRegDfltRegActiveInterval MAX-ACCESS changed to read- 3912 only. 3914 * sipServerRegUserUri MAX-ACCESS changed to read-only. 3915 * 'smime' removed as a possible value for 3916 sipServerCfgProxyAuthMethod. 3917 o SIP-UA-MIB 3918 * sipUACfgServerStatus removed from the MIB due to general 3919 removal of configuration capability. In conjunction, RowStatus 3920 textual convention is no longer imported. 3921 * sipUACfgServerAddressType MAX-ACCESS changed to read-only. 3922 * sipUACfgServerAddress MAX-ACCESS changed to read-only. 3923 * sipUACfgServerRole MAX-ACCESS changed to read-only. 3925 Changes from draft-ietf-sip-mib-07. 3927 The vast majority of changes are in response to the Working Group 3928 Last Call and expert review comments. 3929 o General 3930 * IANA requirements section added to specify the need for 3931 registered numbers for all SIP methods. These will be used in 3932 the MIB objects. 3933 * Updated the security consideration section to reflect the 3934 addition and deletion of a number of objects. 3935 o SIP-COMMON-MIB 3936 * Module description of various SIP entities enhanced. 3937 * sipMaxSessions renamed sipCommonCfgMaxTransactions. Workgroup 3938 last call reviewers suggested a change based on some change of 3939 terms in the standard. Transactions seemed the appropriate 3940 term. The object description was also enhanced. 3941 * sipRequestUriHostMatching object removed based on comments from 3942 workgroup last call comments. 3943 * sipCommonCfgEntityType changed from enumerated INTEGER to 3944 SipTCEntityRole textual convention syntax. 3945 * sipCommonServiceAdminStatus enumerated value 'quiesceSessions' 3946 changed to 'quiesceDialogs'. 3947 * sipCommonPortTable was redesigned. sipTransportSnd object was 3948 removed as it did not make much sense. sipCommonPortStatus was 3949 removed to prevent any row creation deletion. The remaining 3950 object, sipCommonPortTransportRcv was made read-only. 3951 * sipUriSupportedTable was removed as it was not deemed useful 3952 anymore. 3953 * sipExtMethodSupportedTable replaced with a general 3954 sipCommonMethodSupportedTable. IANA SIP method identifiers/ 3955 numbers will be used in this new table. The previous concept 3956 of explicitly defining objects per the current well-know 3957 methods and then providing separate, semantically similar, 3958 'extension methods' tables has been eliminated. 3959 * sipCommonCfgTimerExtMethodTable was removed. No more need for 3960 'extension methods' tables. 3962 * sipCommonCfgRetryTable was removed. Limits on retransmissions 3963 are controlled by timers in the SIP standard now rather than by 3964 maximum counts; therefore, these objects were no longer 3965 relevant. sipCommonConfigRetryGroup was likewise removed. 3966 * sipFtrSupportedTable was redesigned as 3967 sipCommonOptionTagsTable. 3968 * sipCommonCfgTimerExtMethodTable was removed. 3969 * sipCommonSummaryTotalTransactions description changed to 3970 reflect that in the case of forked request, _each_ branch 3971 rather than _all_ branches count as a single transaction. 3972 * sipCommonMethodStatsTable was redesigned, taking into account 3973 the new SipMethodIdentifer textual convention. The objects 3974 were generalized to two: sipCommonStatsOutbound and 3975 sipCommonStatsInbound. The indexing object 3976 (sipCommonMethodStats) has syntax SipMethodIdentifier and 3977 thereby identifies the method associated with the instances of 3978 in/out counter objects. 3979 * sipCommonTransCurrentactions description changed to reflect 3980 that in the case of forked request, _each_ branch rather than 3981 _all_ branches count as a single transaction. 3982 * sipCommonStatsRetryTable was redesigned, taking into account 3983 the new SipMethodIdentifer textual convention. A single, 3984 generalize object (sipCommonStatsRetries) replaces several 3985 method-specific objects. The new, additional indexing object 3986 (sipCommonStatsRetryMethod) has syntax SipMethodIdentifier and 3987 thereby identifies the method associated with the instances of 3988 the counter objects in each row. 3989 * sipCommonStatsRetryExtMethodTable was removed. 3990 * sipStatusCodeClassesTable removed. 3991 * sipCommonOtherStatsTable has two new objects added: 3992 sipCommonNumUnsupportedMethods and 3993 sipCommonOtherStatsOtherwiseDiscardedMsgs. 3994 * The following object-groups were removed because their 3995 associated objects were removed: 3996 sipCommonConfigTimerExtMethodGroup, sipCommonConfigRetryGroup, 3997 sipCommonConfigRetryExtMethodGroup, 3998 sipCommonStatsRetryExtMethodsGroup, and 3999 sipCommonConfigExpiresGroup. The references to these object- 4000 groups as optional in the module-compliance was updated 4001 accordingly. 4002 * GROUP clause for sipCommonStatsRetryGroup in module-compliance 4003 was udpated to no longer state any dependency on 4004 sipCommonConfigRetryGroup (now removed). 4005 * New OBJECT clauses were added to the module-compliance to 4006 formalize MIN-ACCESS read-only for objects in 4007 sipCommonCfgTimerTable. 4009 * sipCommonConfigGroup udpated with new objects 4010 (sipCommonOptionTag, sipCommonOptionTagHeaderField, 4011 sipMethodName), removed objects (sipTransportSnd, 4012 sipCommonPortStatus, sipUriSupported, sipFtrSupported, 4013 sipExtMethodName, sipRequestUriHostMatching), and changed 4014 objects (sipCommonCfgMaxTransactions). 4015 * sipCommonStatsGroup updated with new objects 4016 (sipCommonMethodStatsOutbounds, sipCommonMethodStatsInbounds, 4017 sipCommonNumUnsupportedMethods, 4018 sipCommonOtherStatsOtherwiseDiscardedMsgs) and removed objects 4019 (sipCommonStatsInviteIns, sipCommonStatsInviteOuts, 4020 sipCommonStatsAckIns, sipCommonStatsAckOuts, 4021 sipCommonStatsByeIns, sipCommonStatsByeOuts, 4022 sipCommonStatsCancelIns, sipCommonStatsCancelOuts, 4023 sipCommonStatsOptionsIns, sipCommonStatsOptionsOuts, 4024 sipCommonStatsRegisterIns, sipCommonStatsRegisterOuts, 4025 sipCommonStatsExtMethodIns, sipCommonStatsExtMethodOuts, 4026 sipCommonStatsInfoClassIns, sipCommonStatsInfoClassOuts, 4027 sipCommonStatsSuccessClassIns, sipCommonStatsSuccessClassOuts, 4028 sipCommonStatsRedirClassIns, sipCommonStatsRedirClassOuts, 4029 sipCommonStatsReqFailClassIns, sipCommonStatsReqFailClassOuts, 4030 sipCommonStatsServerFailClassIns, 4031 sipCommonStatsServerFailClassOuts, 4032 sipCommonStatsGlobalFailClassIns, 4033 sipCommonStatsGlobalFailClassOuts, 4034 sipCommonOtherStatsClassesIns, sipCommonOtherStatsClassesOuts). 4035 * sipCommonStatsRetryGroup updated with new object 4036 (sipCommonStatsRetries) and removed objects 4037 (sipCommonStatsRetryInvites, sipCommonStatsRetryByes, 4038 sipCommonStatsRetryCancels, sipCommonStatsRetryRegisters, 4039 sipCommonStatsRetryOptions). 4040 o SIP-SERVER-MIB 4041 * Module description of various SIP entities enhanced. 4042 * sipServerStats 'placeholder' IOD removed. No objects were ever 4043 defined under that subtree. 4044 * Removed the following objects from sipServerProxyCfgTable: 4045 sipRequestMaxExpires, sipServerProxySendsCancel, 4046 sipServerProxyForwardAll1xx, sipServerProxyProvideAlternatives, 4047 and sipServerProxyNonceLifeTime. sipServerProxyConfigGroup 4048 updated accordingly. 4049 * sipServerCfgProxyStatefulness MAX-ACCESS changed to read-only. 4050 * DEFVAL removed from sipServerRegMaxContactExpiryDuration. 4051 * sipServerRegContactRetryAfter removed from 4052 sipServerRegContactTable. 4053 * sipUser* and sipServerRegContact* objects were moved from 4054 sipServerRegistrarConfigGroup to a new object-group: 4055 sipServerRegistrarUsersGroup. The new group was made an 4056 optional group in the MODULE-COMPLIANCE. 4058 o SIP-UA-MIB 4059 * SipTCEntityRole imported from SIP-TC-MIB module and used as the 4060 syntax for new object sipUACfgServerRole. 4061 * sipUACfgSipServerTable (and objects therein) have their 4062 descriptors changed to sipUACfgServer* ("Sip" removed). 4063 sipUAConfigGroup updated accordingly. 4064 * sipUACfgServerRole added to sipUACfgServerTable. 4065 * DEFVAL { ipv4 } removed from sipUACfgServerAddressType. 4066 o SIP-TC-MIB 4067 * New textual conventions: SipTCEntityRole, 4068 SipTCOptionTagHeaders, and SipMethodIdentifier added. 4070 Changes from draft-ietf-sip-mib-06 4071 o General 4072 * Minor editorial changes in the Textual Conventions section. 4073 o SIP-COMMON-MIB 4074 * sipCommonStatusCodeValue SYNTAX changed from INTEGER to 4075 Unsigned32. 4076 * Optional sipCommonNotifObjectsGroup explicitly added to MODULE- 4077 COMPLIANCE. 4078 * Removed OBJECT refinement for sipCommonStatusCodeRowStatus 4079 added to compliance in previous revision. SMIC MIB compiler 4080 issues required it to be commented out. Instead, simply 4081 removed it. 4082 o SIP-SERVER-MIB 4083 * Removed OID placeholders: sipRedirCfg, sipRedirStats. 4084 sipServerRegCfg and sipServerRegStats OID values subsequently 4085 changed as a result. 4086 o SIP-UA-MIB 4087 * Removed OBJECT refinement for sipUACfgSipServerStatus added to 4088 compliance in previous revision. SMIC MIB compiler issues 4089 required it to be commented out. Instead, simply removed it. 4091 Changes from draft-ietf-sip-mib-05 4092 o Front paper/Back paper and General changes 4093 * Removed all references and special handling of SIP INFO method 4094 Removed references and objects specific to RFC 2976: INFO will 4095 be treated as any SIP extension method. 4096 * Changed requirements verbs from lowercase to uppercase wherever 4097 appropriate. 4098 * Added RFC Editor notes. 4099 * Updated all REFERENCE clauses and DESCRIPTIONS from RFC 2543 to 4100 RFC 3261. 4101 * Explained the approach taken for extension methods that might 4102 be defined in the future. 4103 * Defined a mapping of sipCommonCfgServiceOperStatus to 4104 applOperStatus. 4106 * Enhanced Security section with details on various objects. 4107 * Added descriptive language to various Entry objects regarding 4108 the expected persistence of data across system restarts. 4109 o SIP-COMMON-MIB 4110 * Removed sipTransactionTable after input from SIP community. 4111 * Made all extension method tables augmentations of 4112 sipExtMethodSupportedTable. This resulted in the removal of 4113 the following objects: sipCfgTimerExtMethodName, 4114 sipCfgRetryExtMethodName, sipCommonStatsExtMethodName, 4115 sipCommonStatsRetryExtMethodName. 4116 * sipCommonStatusCodeNotifEmitMode default value changed to 4117 'triggered'. 4118 * sipCommonStatusCodeThreshExceededNotif was replaced by two 4119 notifications: sipCommonStatusCodeThreshExceededOutNotif and 4120 sipCommonStatusCodeThreshExceededInNotif. 4121 * Re-arranged the enumerated value of 4122 sipCommonCfgServiceOperStatus; making 'unknown' the first 4123 value. Added some words to the DESCRIPTION of that object 4124 stating the values are not based on anything in the SIP 4125 standard. 4126 * Clarified rules for capitalization of sipExtMethodName. 4127 * All counters in the MIB are consistent with respect to 4128 resetting to zero. No counters can be reset to zero. Entries 4129 in sipCommonStatusCodeTable can simply be created or destroyed 4130 - no ability to set to 'notInService' where there was the 4131 question/possibility of resetting the counters to zero. 4132 sipCommonStatsExtMethodTable no longer has its own RowStatus 4133 object, so it too can no longer be set to 'notInService' where 4134 there was the question/possibility of resetting the counters to 4135 zero. sipCommonStatsExtMethodTable rows are augmentations of 4136 sipExtMethodSupportedEntry. 4137 * OBJECT refinement for sipCommonStatusCodeRowStatus added to 4138 compliance. 4139 * Clarified the relationship between 4140 sipCommonStatusCodeNotifEmitMode and 4141 sipCommonStatusCodeNotifSend. 4142 * Explained the existence of sipCommonNotifApplIndex object 4143 better. 4144 * sipCfgExpiresStatusCodeValue syntax changed from INTEGER to 4145 Unsigned32. 4146 * sipCommonCfgEntityType object added to sipCommonCfgTable. 4147 * All accessible-for-notify objects are moved into 4148 sipCommonNotifObjects group. OIDs for actual notifications are 4149 re-assigned as a result. 4150 * sipCommonNotifSequenceNumber accessible-for-notify object added 4151 as a way for managers to gain insight into possible missed 4152 notifications. It is bound to each notification defined in the 4153 MIB. 4155 * New notifications related to SIP service operational status are 4156 added: sipCommonServiceColdStart, sipCommonServiceWarmStart, 4157 and sipCommonCfgServiceLastChange. 4158 * New object sipCommonCfgServiceNotifEnable added to control the 4159 new SIP related notifications. 4160 * Minor object descriptor changes: sipCommonStatusCodeTable 4161 renamed to sipStatusCodeClassesTable SipCommonStatusCodeEntry 4162 renamed to SipStatusCodeClassesEntry sipCommonStatusCodeEntry 4163 renamed to sipStatusCodeClassesEntry sipCommonStatusCodeTable 4164 renamed to sipCommonStatusCodeTable SipCommonStatusCodeEntry 4165 renamed to SipCommonStatusCodeEntry sipCommonStatusCodeEntry 4166 renamed to sipCommonStatusCodeEntry sipCommonStatusCodeValue 4167 renamed to sipCommonStatusCodeValue sipCommonStatusCodeIns 4168 renamed to sipCommonStatusCodeIns sipCommonStatusCodeOuts 4169 renamed to sipCommonStatusCodeOuts sipCommonStatusCodeStatus 4170 renamed to sipCommonStatusCodeRowStatus 4171 sipCommonStatusCodeNotifTable renamed to 4172 sipCommonStatusCodeNotifTable SipCommonStatusCodeNotifEntry 4173 renamed to SipCommonStatusCodeNotifEntry 4174 sipCommonStatusCodeNotifEntry renamed to 4175 sipCommonStatusCodeNotifEntry sipCommonStatusCodeNotifSend 4176 renamed to sipCommonStatusCodeNotifSend 4177 sipCommonStatusCodeNotifEmitMode renamed to 4178 sipCommonStatusCodeNotifEmitMode sipCommonStatusCodeNotifThresh 4179 renamed to sipCommonStatusCodeNotifThresh 4180 sipCommonStatusCodeNotifInterval renamed to 4181 sipCommonStatusCodeNotifInterval 4182 * Removed all INFO method specific objects: sipCfgRetryInfo, 4183 sipCommonStatsInfoIns, sipCommonStatsInfoOuts, and 4184 sipCommonStatsRetryInfos 4185 * Clarifying words added to sipCommonStatusCodeNotifTable 4186 DESCRIPTION to explain why it's a separate table from 4187 sipCommonStatusCodeTable. 4188 o SIP-SERVER-MIB 4189 * Deleted objects related to 'action' parameter. RFC 3261 4190 section 10.2 deprecates the 'action' parameter deleted 3 4191 objects: sipServerContactDfltAction, sipServerRespectUAAction, 4192 sipServerRegContactAction. 4193 * Deleted pgp-related objects. RFC 3261 section 23 deprecates 4194 use of pgp deleted 3 objects: sipServerProxyAuthPgpAlgorithm, 4195 sipPgpPrivateKey, sipPgpVersion. 4196 * Removed sipServerProxyStateTimeout object. Timers G and timer 4197 H have been introduced in RFC 3261 for this purpose (see RFC 4198 3261 section 17.2.1). 4199 * Updated description clause of sipServerCfgProxyStatefulness. 4200 The 3 definitions of stateless/statefulness now match the text 4201 in RFC 3261. 4203 * Changed DEFVAL for object sipServerProxyProvideAlternatives. 4204 Changed DEFVAL to true to align with RFC 3261 that states that 4205 485 responses SHOULD contain a contact header and 303 MAY... 4206 and updated REFERENCE clause to "RFC 3261 Sections 13.2.2.2 and 4207 16.5". 4208 * Removed basic authentication value from 4209 sipServerCfgProxyAuthMethod object Per section 22 of RFC 3261, 4210 deprecated. 4211 * Changed SYNTAX of sipServerProxyNonceLifeTime from Integer32 to 4212 Unsigned32. 4213 * Updated description clause of sipServerRegDfltRegActiveInterval 4214 Per RFC 3261 Section 10.2. 4215 o SIP-UA-MIB 4216 * OBJECT refinement for sipUACfgSipServerStatus added to 4217 compliance. 4218 * Changed the object descriptors of sipUACfgSipServerAddrIndex to 4219 sipUACfgSipServerIndex, and sipUACfgSipServerAddrStatus to 4220 sipUACfgSipServerStatus. 4222 Changes from draft-ietf-sip-mib-04 4223 o Started realignment with SIP RFC3261. 4225 Changes from draft-ietf-sip-mib-03 4226 o Front paper/Back paper and General changes 4227 * Rewrote section on Network Services MIB 4228 * Fixed minor editorial nits 4229 o SIP-COMMON-MIB 4230 * CONTACT-INFO "SIP MIB email" changed to sip@ietf.org 4231 * sipInviteTimeout was removed from the MIB. See below regarding 4232 new sipCommonCfgExpires objects. They provide equivalent 4233 functionality with extensibility beyond INVITE. 4234 * sipCommonCfgExpires OID subtree added. Per method Expires 4235 configuration objects were added there. This new high-level 4236 OID was placed under the existing sipCommonCfgRetry OID and 4237 therefore, caused the OIDs for the subsequent groups to change 4238 (incrementing by one). 4239 * Objects from tables under sipCommonCfgExpires were added to a 4240 new OBJECT-GROUP sipCommonConfigExpiresGroup, and that group 4241 was listed as optional in sipCommonCompliance. 4242 * Minor DESCRIPTION change for sipCommonCfgEntry. No behavior 4243 change. 4244 * sipCommonCfgServiceOperStatus SYNTAX changed. New values 4245 added: congested and quiescing Old values removed: halted The 4246 order of the enumeration was altered as well. 4247 * sipCommonServiceAdminStatus SYNTAX changed. New values added: 4248 noop, up, down, quieseSessions, and quieseApplications Old 4249 values removed: shutdown, restart, stop, rts. These changes 4250 were made based on comments from last call reviewer and general 4251 known ambiguities in the previous design of the object. 4252 * Clarifying changes to the DESCRIPTION of 4253 sipCommonCfgServiceStartTime. 4254 * Clarifying changes to the DESCRIPTION of 4255 sipCommonCfgServiceStartTime. 4256 * Clarification of behavior for sipCommonPortStatus while row is 4257 'active' 4258 * Clarifying changes to the DESCRIPTION of sipUriSupportedTable. 4259 * Clarifying changes to the DESCRIPTIONs of sipFtrSupportedTable, 4260 sipFtrSupportedEntry, and sipFtrSupported. Specifically, IETF 4261 standard features and non-standard features are now represented 4262 by this table. Only non-standard features were mentioned in 4263 prior revisions of the draft. 4264 * Reference to usage of RFC 2788 applIndex moved from 4265 sipCommonCfgTimerExtMethodTable to 4266 sipCommonCfgTimerExtMethodEntry. This was the convention for 4267 other table/entry definitions in the MIB, so these objects were 4268 previously unconventional. 4269 * DEFVAL removed from sipCfgTimerExtMethodTimer. The generic 4270 nature of the "extension" object does not lend itself to being 4271 able to specify a particular default value. 4272 * Since the removal of the DEFVAL clause from 4273 sipCfgTimerExtMethodTimer, a value for that object must be 4274 specified when creating a sipCommonCfgTimerExtMethodEntry. The 4275 description of sipCfgTimerExtMethodStatus was updated to 4276 reflect this. 4277 * sipCommonCfgRetryExtMethodTable is now properly defined under 4278 sipCommonCfgRetry OID space instead of under sipCommonCfgTimer 4279 OID space. 4280 * DEFVAL removed from sipCfgRetryExtMethodRetry. The generic 4281 nature of the "extension" object does not lend itself to being 4282 able to specify a particular default value. 4283 * Since the removal of the DEFVAL clause from 4284 sipCfgRetryExtMethodRetry, a value for that object must be 4285 specified when creating a sipCommonCfgRetryExtMethodEntry. The 4286 description of sipCfgRetryExtMethodStatus was updated to 4287 reflect this. 4288 * Clarifying changes to the DESCRIPTION of 4289 sipCommonSummaryTotalTransactions. Specifically, the object is 4290 not applicable to stateless SIP proxy servers and the object 4291 should always return a value of 0 if implemented by a stateless 4292 proxy. 4293 * Clarifying changes to the DESCRIPTION of 4294 sipCommonStatsExtMethodStatus. 4295 * sipCommonOtherStatsClassesIns and 4296 sipCommonOtherStatsClassesOuts counter objects were added to 4297 sipCommonStatusCodeTable to handle possible future classes of 4298 response status codes. 4300 * Text referring specifically to Redirect Server in 4301 sipCommonStatsRedirClassIns and sipCommonStatsRedirClassOuts 4302 was removed. 4303 * Text defining protocol behavior in 4304 sipCommonStatsServerFailClassIns, 4305 sipCommonStatsServerFailClassOuts, 4306 sipCommonStatsGlobalFailClassIns, and 4307 sipCommonStatsGlobalFailClassOuts was removed. 4308 * sipCommonStatusCodeNotifInterval SYNTAX changed from TimeTicks 4309 to Unsigned32 w/ a UNITS of "seconds" added to the definition. 4310 DEFVAL clause changed accordingly. 4311 * sipCommonStatusCodeNotifTo, sipCommonStatusCodeNotifFrom, 4312 sipCommonStatusCodeNotifCallId, and 4313 sipCommonStatusCodeNotifCSeq all had clarifying changes to 4314 their DESCRIPTIONs. Specifically, the header name will be part 4315 of the object value and example values were given. 4316 * Clarifying changes to the DESCRIPTION of 4317 sipCommonTransCurrentTable and sipTransactionTable. 4318 Specifically, these tables are not applicable to transaction 4319 stateless SIP Proxy Servers. 4320 * Minor grammatical change to the DESCRIPTION of 4321 sipCommonTransCurrentEntry. 4322 * sipTransMethod and sipTransActivityInfo objects were added to 4323 sipTransactionTable while sipTransCallingPartyContentType and 4324 sipTransCalledPartyContentType were removed. 4325 * Clarifying changes to the DESCRIPTION of sipTransState. 4326 Specifically, noting that not all values of the object are 4327 applicable to all transaction types. 4328 * sipTransTo, sipTransFrom, sipTransCallId, and sipTransCSeq all 4329 had clarifying changes to their DESCRIPTIONs. Specifically, 4330 the header name will be part of the object value and example 4331 values were given. 4332 * Minor grammatical change to the DESCRIPTION of 4333 sipCommonOtherStatsEntry. 4334 * sipCommonStatusCodeIns and sipCommonStatusCodeOuts objects were 4335 added to the varbind of sipCommonStatusCodeNotif. 4336 * Appropriate changes were made to sipCommonStatsGroup OBJECT- 4337 GROUP based on objects being added and/or removed from the MIB. 4338 o SIP-SERVER-MIB 4339 * CONTACT-INFO "SIP MIB email" changed to sip@ietf.org 4340 * The statement "Unlike a Proxy server it does not initiate 4341 requests." was removed from where a Redirect Server is defined 4342 in the MIB's DESCRIPTION. 4343 * sipServerMIBNotifs OID removed. No notifications were ever 4344 defined under this subtree. 4345 * Clarifying text added to all of the Table DESCRIPTIONS stating 4346 that the value of applIndex used in this MIB corresponds to the 4347 value of applIndex used in the SIP-COMMON-MIB. 4349 * Clarifying changes to the DESCRIPTION of 4350 sipServerCfgProxyStatefulness. 4351 * sipServerRegContactPreference SYNTAX changed from OCTET STRING 4352 to SnmpAdminString. 4353 o SIP-UA-MIB 4354 * CONTACT-INFO "SIP MIB email" changed to sip@ietf.org 4355 * sipUAMIBNotifs OID removed. No notifications were ever defined 4356 under this subtree. 4357 * sipUAStats OID removed. No notifications were ever defined 4358 under this subtree. 4359 * Clarifying text added to all of the Table DESCRIPTIONS stating 4360 that the value of applIndex used in this MIB corresponds to the 4361 value of applIndex used in the SIP-COMMON-MIB. 4362 o SIP-TC-MIB 4363 * CONTACT-INFO "SIP MIB email" changed to sip@ietf.org 4365 Changes from draft-ietf-sip-mib-02 4366 o General 4367 * Eliminated the SIP-MIB-SMI modules. Each MIB module will now 4368 get it's own IANA OID. 4369 * Top-level OID subtrees restructured in each MIB. 4370 * General cleanup/removal of "placeholder" OID subtrees for 4371 object groups and notifications that never materialized. 4372 o SIP-COMMON-MIB 4373 * Removed sipCfgInitialTimerAck. 4374 * Removed sipCfgRetryAck. 4375 * Removed sipCommonStatsRetryAcks. 4376 * sipCommonStatsRetryExtMethodEntry was missing its INDEX clause. 4377 * sipCommonOtherStatsNumUnsupportedUris OID was "5" when it was 4378 the only object in the table. OID is now "1". 4379 * High-level OID structure of the MIB is now sequential. 4380 * Incorrect object descriptor for sipCfgInitialTimerRsp 4381 inconsistent with reference in compliance section. 4382 * Inconsistencies between sipCommonStatsRetryGroup definition and 4383 SipCommonStatsRetryEntry OBJECT-TYPE corrected. 4384 * sipCommonNotifApplIndex was not in any object group in the 4385 conformance section. 4386 o SIP-SERVER-MIB 4387 * Removed sipInformationTryingInterval. 4388 * Removed sipRxProxyAuthTable. 4389 * Removed sipServerRegRespHasContacts. 4390 * Removed sipServerRegContactDfltExpiryDate. 4391 * Removed sipServerRegContactDfltExpiryDuration. 4392 * Removed sipUserPassword. 4393 * sipRequestMaxExpires DESCRIPTION changed to no longer 4394 specifically mention 400 response. 4396 * sipServerProxyStateful object descriptor changed to 4397 sipServerProxyStatefullness and the SYNTAX changed from 4398 TruthValue to an enumerated INTEGER. 4399 * sipServerProxyStateTimeout DESCRIPTION changed to now reflect 4400 only INVITE. 4401 * Gauge32 was not being IMPORTed. 4402 * sipServerContactDfltAction showed up in conformance and other 4403 object descriptions in an older form. 4404 * sipServerHost replaced with InetAddressType/InetAddress object 4405 pair (sipServerCfgHostAddressType and sipServerCfgHostAddress). 4406 o SIP-UA-MIB 4407 * IMPORTed Unsigned32 to support sipUACfgSipServerAddrIndex. 4408 * sipUACfgSipServerEntry was referencing the wrong auxiliary 4409 object and listing that object in the conformance section. 4410 * sipUACfgSipServerEntry listed sipUACfgSipServerStatus when it 4411 should have been listing sipUACfgSipServerAddrStatus. 4412 * SIP-UA-MIB IMPORTed Counter32, but never used it. Removed the 4413 IMPORT of Counter32. 4415 12. References 4417 12.1. Normative References 4419 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 4420 Requirement Levels", BCP 14, RFC 2119, March 1997. 4422 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 4423 A., Peterson, J., Sparks, R., Handley, M., and E. 4424 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 4425 June 2002. 4427 [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. 4428 Schoenwaelder, Ed., "Structure of Management Information 4429 Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 4431 [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. 4432 Schoenwaelder, Ed., "Textual Conventions for SMIv2", 4433 STD 58, RFC 2579, April 1999. 4435 [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 4436 "Conformance Statements for SMIv2", STD 58, RFC 2580, 4437 April 1999. 4439 [RFC2788] Freed, N. and S. Kille, "Network Services Monitoring MIB", 4440 RFC 2788, March 2000. 4442 [RFC3411] Harrington, D., Presuhn, R., and B. Wijnen, "An 4443 Architecture for Describing Simple Network Management 4444 Protocol (SNMP) Management Frameworks", STD 62, RFC 3411, 4445 December 2002. 4447 [RFC4001] Daniele, M., Haberman, B., Routhier, S., and J. 4448 Schoenwaelder, "Textual Conventions for Internet Network 4449 Addresses", RFC 4001, February 2005. 4451 12.2. Informative References 4453 [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 4454 "Introduction and Applicability Statements for Internet- 4455 Standard Management Framework", RFC 3410, December 2002. 4457 [RFC3262] Rosenberg, J. and H. Schulzrinne, "Reliability of 4458 Provisional Responses in Session Initiation Protocol 4459 (SIP)", RFC 3262, June 2002. 4461 [RFC4168] Rosenberg, J., Schulzrinne, H., and G. Camarillo, "The 4462 Stream Control Transmission Protocol (SCTP) as a Transport 4463 for the Session Initiation Protocol (SIP)", RFC 4168, 4464 October 2005. 4466 Authors' Addresses 4468 Kevin Lingle 4469 Cisco Systems, Inc. 4470 7025 Kit Creek Road 4471 P.O. Box 14987 4472 Research Triangle Park, NC 27709 4473 US 4475 Phone: +1 919 392 2029 4476 Email: klingle@cisco.com 4478 Jean-Francois Mule 4479 CableLabs 4480 858 Coal Creek Circle 4481 Louisville, CO 80027 4482 US 4484 Phone: +1 303 661 9100 4485 Email: jf.mule@cablelabs.com 4486 Joon Maeng 4487 5612 Sedona Drive 4488 Austin, TX 78759 4489 US 4491 Phone: +1 512 418 0590 4492 Email: jmaeng@austin.rr.com 4494 Dave Walker 4496 Email: drwalker@rogers.com 4498 Full Copyright Statement 4500 Copyright (C) The Internet Society (2006). 4502 This document is subject to the rights, licenses and restrictions 4503 contained in BCP 78, and except as set forth therein, the authors 4504 retain all their rights. 4506 This document and the information contained herein are provided on an 4507 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 4508 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 4509 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 4510 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 4511 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 4512 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 4514 Intellectual Property 4516 The IETF takes no position regarding the validity or scope of any 4517 Intellectual Property Rights or other rights that might be claimed to 4518 pertain to the implementation or use of the technology described in 4519 this document or the extent to which any license under such rights 4520 might or might not be available; nor does it represent that it has 4521 made any independent effort to identify any such rights. Information 4522 on the procedures with respect to rights in RFC documents can be 4523 found in BCP 78 and BCP 79. 4525 Copies of IPR disclosures made to the IETF Secretariat and any 4526 assurances of licenses to be made available, or the result of an 4527 attempt made to obtain a general license or permission for the use of 4528 such proprietary rights by implementers or users of this 4529 specification can be obtained from the IETF on-line IPR repository at 4530 http://www.ietf.org/ipr. 4532 The IETF invites any interested party to bring to its attention any 4533 copyrights, patents or patent applications, or other proprietary 4534 rights that may cover technology that may be required to implement 4535 this standard. Please address the information to the IETF at 4536 ietf-ipr@ietf.org. 4538 Acknowledgment 4540 Funding for the RFC Editor function is provided by the IETF 4541 Administrative Support Activity (IASA).