SIP WG K. Lingle Internet-Draft Cisco Systems, Inc. Expires: December 30, 2003 J. Maeng ipDialog, Inc. J-F. Mule CableLabs D. Walker SS8 Networks, Inc. July 2003 Management Information Base for Session Initiation Protocol (SIP) draft-ietf-sip-mib-07.txt Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http:// www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire on December 30, 2003. Copyright Notice Copyright (C) The Internet Society (2003). All Rights Reserved. Abstract This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it describes a set of managed objects that are used to manage Session Initiation Protocol (SIP) entities, which include User Agents, Proxy servers, Redirect servers and Registrars. Lingle, et al. Expires December 30, 2003 [Page 1] Internet-Draft SIP MIB Modules July 2003 Table of Contents 1. Conventions . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 3. The Internet-Standard Management Framework . . . . . . . . . 3 4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 3 5. Structure of SIP MIB . . . . . . . . . . . . . . . . . . . . 3 5.1 Textual Conventions . . . . . . . . . . . . . . . . . . . . 6 5.2 Relationship to the Network Services MIB . . . . . . . . . . 6 6. Accommodating SIP Extension Methods . . . . . . . . . . . . 10 7. Definitions . . . . . . . . . . . . . . . . . . . . . . . . 10 7.1 SIP Textual Conventions . . . . . . . . . . . . . . . . . . 10 7.2 SIP Common MIB Module . . . . . . . . . . . . . . . . . . . 12 7.3 SIP User Agent MIB Module . . . . . . . . . . . . . . . . . 73 7.4 SIP Server (Registrar, Redirect & Proxy Server) MIB Module . 78 8. Changes from Previous Draft Revisions . . . . . . . . . . . 98 9. Security Considerations . . . . . . . . . . . . . . . . . . 108 10. Contributor Acknowledgments . . . . . . . . . . . . . . . . 112 Normative References . . . . . . . . . . . . . . . . . . . . 112 Informational References . . . . . . . . . . . . . . . . . . 113 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 113 Intellectual Property and Copyright Statements . . . . . . . 115 Lingle, et al. Expires December 30, 2003 [Page 2] Internet-Draft SIP MIB Modules July 2003 1. Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [1]. 2. Introduction This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it describes a set of managed objects that are used to manage Session Initiation Protocol (SIP) entities, which include User Agents, Proxy servers, Redirect servers and Registrars. 3. The Internet-Standard Management Framework For a detailed overview of the documents that describe the current Internet-Standard Management Framework, please refer to section 7 of RFC 3410 [2]. Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. MIB objects are generally accessed through the Simple Network Management Protocol (SNMP). Objects in the MIB are defined using the mechanisms defined in the Structure of Management Information (SMI). This memo specifies a MIB module that is compliant to the SMIv2, which is described in STD 58, RFC 2578 [3], STD 58, RFC 2579 [4] and STD 58, RFC 2580 [5]. 4. Overview The Session Initiation Protocol (SIP) RFC 3261 [7] is an application- layer control (signaling) protocol for creating, modifying, and terminating sessions with one or more participants. These sessions include Internet telephone calls, multimedia distribution, and multimedia conferences. This MIB provides some managed objects for SIP entities defined in RFC 3261 - User Agent, Proxy Server, Redirect Server and Registrar. It is provided as a base for the work within the working group to define a MIB. This MIB is intended to provide management of the basic SIP entities. It provides for monitoring of status and protocol statistics, as well as for configuration of SIP entities. 5. Structure of SIP MIB This memo specifies four MIB modules. They are SIP-COMMON-MIB, SIP- SERVER-MIB, SIP-UA-MIB and SIP-TC. SIP-COMMON-MIB contains common objects used in all the SIP entities. SIP-SERVER-MIB contains objects specific to Registrars, Proxies and Redirect Servers, and SIP-UA-MIB includes objects specific to User Agents. SIP-TC defines the textual Lingle, et al. Expires December 30, 2003 [Page 3] Internet-Draft SIP MIB Modules July 2003 conventions used throughout MIB modules. The MIB Modules contain following groups of objects: SIP-COMMON-MIB: Common to all the SIP entities o sipCommonMIBObjects * sipCommonCfgBase: This object group defines configuration objects common to all SIP entities including SIP protocol version, operational and administrative status, SIP organization name, max number of SIP sessions an entity can manage, etc. * sipCommonCfgTimer: This object group defines timer configuration objects applicable to SIP user agent and SIP stateful proxy entities. * sipCommonCfgRetry: This object group defines retry counter configuration objects applicable to SIP user agent and SIP stateful proxy entities. * sipCommonCfgExpires: This object group defines Expires header value configuration objects applicable to SIP user agent and SIP stateful proxies * sipCommonStatsSummary: This object group defines a table containing the summary statistics objects applicable to all SIP entities, including the total number of SIP requests & responses in/out, total number of transactions, etc. * sipCommonStatsMethod: This object group defines a table containing the per method statistics objects applicable to all SIP entities, including the total number of SIP requests for the Invite, Ack, Bye, Cancel, Options and /Register methods. * sipCommonStatusCode: This object group defines a table indicating the number of SIP responses in/out per class of response (1xx, 2xx, etc.) * sipCommonStatsTrans: This object group defines a table containing a gauge reflecting the number of transactions currently awaiting definitive responses by the managed SIP entity. * sipCommonStatsRetry: This object group defines statistic objects indicating the number of retries sent on a per method basis. Lingle, et al. Expires December 30, 2003 [Page 4] Internet-Draft SIP MIB Modules July 2003 * sipCommonStatsOther: This object group defines additional statistic objects including a counter of the number of SIP requests received with unsupported URIs. * sipCommonNotifObjects: This object group defines accessible-for-notify objects that are relate to the SNMP notifications defined in this MIB module. The SIP-COMMON-MIB also contains notifications, including: o sipStatusCodeNotif: indicates that a specific status code has been sent or received by the system. o sipStatusCodeThreshExceededNotif: indicates that a specific status code has been sent or received by the system enough to exceed the configured threshold. SIP-SERVER-MIB: Groups of objects for Registrars, Proxy and Redirect Servers o sipServerMIBObjects * sipServerCfg: This object group defines common server configuration objects including the SIP server host address. * sipServerStats: This object group is currently empty and is created for future extensions of the SIP MIB. * sipProxyCfg: This object group defines Proxy Server configuration objects including the maximum duration in the Expires header, the proxy mode of operation (stateless, stateful, call stateful), the cancellation of outstanding branch requests * sipProxyStats: This object group defines a table containing the statistics objects applicable to all SIP Proxy Servers. It includes the number of occurrences of unsupported options being specified in received Proxy-Require headers. * sipRedirCfg: This object group is currently empty and is created for future extensions of the SIP MIB. * sipRedirStats: This object group is currently empty and is created for future extensions of the SIP MIB. * sipRegCfg: This object group is currently empty and is created for future extensions of the SIP MIB. Lingle, et al. Expires December 30, 2003 [Page 5] Internet-Draft SIP MIB Modules July 2003 * sipRegStats: This object group is currently empty and is created for future extensions of the SIP MIB. SIP-UA-MIB: Group of objects for User Agents. o sipUAMIBObjects * sipUACfgSipServer: This group specifies SIP server configuration objects applicable to SIP user agents including the Internet address of the SIP Server to use to proxy or redirect calls. To conform with this specification, an SNMP agent MUST implement SIP-TC, plus the SIP-COMMON-MIB and one of the SIP entity-type- specific MIB modules (SIP-SERVER-MIB or SIP-UA-MIB) as applicable for each instance of a SIP entity being managed. If a device has more than one SIP entity or multiple instances of the same entity, type it MUST implement multiple SIP modules. Section 4.2 describes handling of multiple instances in detail. 5.1 Textual Conventions The data type SipTransportProtocol is used as Textual Conventions in this document. These Textual Conventions have NO effect on either the syntax or the semantics of any managed object. Objects defined using these conventions are always encoded by means of the rules that define their primitive type. Hence, no changes to the SMI or the SNMP are necessary to accommodate these Textual Conventions. They are adopted merely for the convenience of readers. 5.2 Relationship to the Network Services MIB There is a requirement to be able to support multiple instances of various SIP MIB modules in the context of a single system having a single SNMP agent. This requirement is solved by using the framework provided by the NETWORK-SERVICES-MIB, RFC 2788 [6]. A device implementing the SIP MIB MUST support the NETWORK-SERVICES-MIB and, at a minimum, it MUST support the applIndex and applName objects in applTable. The following applName conventions will be adopted: o for a SIP Proxy entity, applName MUST be equal to "sip_proxy" o for a SIP Redirect entity, applName MUST be equal to "sip_redirect" o for a SIP Registrar entity, applName MUST be equal to Lingle, et al. Expires December 30, 2003 [Page 6] Internet-Draft SIP MIB Modules July 2003 "sip_registrar" o for a SIP User Agent entity, applName MUST be equal to "sip_ua" o for any combination of Proxy, Registrar, or Redirect Server being managed as a single aggregate entity, the applName for the combined server entity MUST reflect the appropriate combination. For example, "sip_proxy_redirect" or "sip_proxy_registrar". The SNMP agent MAY support any combination of the other attributes in applTable. If the following objects are supported, the object values SHOULD be populated as follows: o applVersion: version of the SIP application. o applUptime: value MUST be identical to sipServiceStartTime defined in the SIP-COMMON-MIB module, o applOperStatus: value SHOULD reflect the operational status defined in sipServiceOperStatus, at least by means of a mapping, o applLastChange: value MUST be identical to sipServiceLastChange defined in the SIP-COMMON module. Note: There are a number of other objects in the applTable. They are not included for the sake of brevity and for the fact that they do not enhance the concept being presented. Example 1: The tables below illustrate how a system acting as both Proxy and Registrar server might be configured to maintain separate SIP- COMMON-MIB instances. The NETWORK-SERVICES-MIB applTable might be populated as follows: +-----------+-----------------+----------------------+ | applIndex | applName | applDescription | +-----------+-----------------+----------------------+ | 1 | "sip_proxy" | "ACME SIP Proxy" | | 2 | "sip_registrar" | "ACME SIP Registrar" | +-----------+-----------------+----------------------+ The SIP-COMMON-MIB sipCommonCfgTable would have two rows: one for the proxy (applIndex=1) and one for the registrar (applIndex=2). The SIP-SERVER-MIB tables would, however, only be populated with one row indexed by applIndex=1 and applIndex=2 respectively if the server provides either proxy or registrar. Lingle, et al. Expires December 30, 2003 [Page 7] Internet-Draft SIP MIB Modules July 2003 SIP-COMMON-MIB sipCommonCfgTable might be populated as: +-----------+---------------------+----------------------+-----+ | applIndex | sipProtocolVerfsion | sipServiceOperStatus | ... | +-----------+---------------------+----------------------+-----+ | 1 | "SIP/2.0" | up(1) | | | 2 | "SIP/2.0" | restarting(4) | | +-----------+---------------------+----------------------+-----+ while sipProxyCfgTable in SIP-SERVER-MIB might be populated as: +-----------+----------------------+----------------------+-----+ | applIndex | sipRequestMaxExpires | sipProxyStatefulness | ... | +-----------+----------------------+----------------------+-----+ | 1 | 3600 | stateless(1) | | +-----------+----------------------+----------------------+-----+ and sipRegUserTable in SIP-SERVER-MIB might be populated as: +-----------+--------------+---------------------+-----+ | applIndex | sipUserIndex | sipUserUri | ... | +-----------+--------------+---------------------+-----+ | 2 | 1 | drwalker@ss8.com | | | 2 | 2 | jmaeng@ipdialog.com | | | 2 | 3 | klingle@cisco.com | | | 2 | 4 | jfm@cablelabs.com | | +-----------+--------------+---------------------+-----+ Example 2: This example illustrates how to represent a system acting as both Proxy and Registrar server, where the two entities share a single instance of SIP-COMMON-MIB. The NETWORK-SERVICES-MIB applTable might be populated as follows: +-----------+-----------------------+------------------------------+ | applIndex | applName | applDescription | +-----------+-----------------------+------------------------------+ | 1 | "sip_proxy_registrar" | "ACME SIP Proxy & Registrar" | +-----------+-----------------------+------------------------------+ The SIP-COMMON-MIB sipCommonCfgTable would have only one row to cover both the proxy and the registrar. Lingle, et al. Expires December 30, 2003 [Page 8] Internet-Draft SIP MIB Modules July 2003 SIP-COMMON-MIB sipCommonCfgTable might be populated as: +-----------+--------------------+----------------------+ | applIndex | sipProtocolVersion | sipServiceOperStatus | +-----------+--------------------+----------------------+ | 1 | "SIP/2.0" | up(1) | +-----------+--------------------+----------------------+ while sipProxyCfgTable in SIP-SERVER-MIB is populated as: +-----------+----------------------+----------------------+ | applIndex | sipMaxRequestExpires | sipProxyStatefulness | +-----------+----------------------+----------------------+ | 1 | 3600 | stateless(1) | +-----------+----------------------+----------------------+ and sipRegUserTable in SIP-SERVER-MIB might be populated as: +-----------+--------------+---------------------+-----+ | applIndex | sipUserIndex | sipUserUri | ... | +-----------+--------------+---------------------+-----+ | 2 | 1 | drwalker@ss8.com | | | 2 | 2 | jmaeng@ipdialog.com | | | 2 | 3 | klingle@cisco.com | | | 2 | 4 | jfm@cablelabs.com | | +-----------+--------------+---------------------+-----+ The NETWORK-SERVICES-MIB assocTable is not considered a requirement for SIP systems. It is not a mandatory group for NETWORK-SERVICES- MIB compliance. The relationship between the value of applOperStatus and sipServiceOperStatus is as follows: +----------------------+-----------------------+-------------------+ | sipServiceOperStatus | -- corresponds to --> | applOperstatus | +----------------------+-----------------------+-------------------+ | up | --> | up | | down | --> | down | | congested | --> | congested | | restarting | --> | restarting | | quiescing | --> | quiescing | | testing | --> | up | | unknown | --> | --indeterminate-- | +----------------------+-----------------------+-------------------+ If the sipOperStatus is 'unknown' there is no corresponding value of applOperStatus. Therefore, the last known value of applOperStatus Lingle, et al. Expires December 30, 2003 [Page 9] Internet-Draft SIP MIB Modules July 2003 SHOULD be maintained until the sipOperStatus transitions to a value that can be mapped appropriately. 6. Accommodating SIP Extension Methods The core set of SIP methods is defined in RFC 3261 [7]. Other Internet- Draft documents and RFCs define additional methods. In the future more methods may be defined. In order to avoid having to update the SIP-COMMON-MIB module to accommodate these extension methods, there are various extension method tables throughout the MIB module. There are no per method objects defined in the other MIB modules. The sipExtMethodSupportedTable is the main table for listing all of the extension methods supported by a system. The table is informational in nature and populated by the system. Entries cannot be added or deleted by a SNMP manager. The other extension method tables in the MIB are augmentations of this table. The other extension method tables defined in the SIP-COMMON-MIB are: sipCommonCfgTimerExtMethodTable, sipCommonCfgRetryExtMethodTable, sipStatsExtMethodTable, and sipCommonStatsRetryExtMethodTable. 7. Definitions 7.1 SIP Textual Conventions SIP-TC DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, mib-2 FROM SNMPv2-SMI TEXTUAL-CONVENTION FROM SNMPv2-TC; sipTC MODULE-IDENTITY LAST-UPDATED "200307300000Z" ORGANIZATION "IETF SIP Working Group, SIP MIB Team" CONTACT-INFO "SIP WG email: sip@ietf.org Co-editor Kevin Lingle Cisco Systems, Inc. postal: 7025 Kit Creek Road P.O. Box 14987 Research Triangle Park, NC 27709 Lingle, et al. Expires December 30, 2003 [Page 10] Internet-Draft SIP MIB Modules July 2003 USA email: klingle@cisco.com phone: +1 919 392 2029 Co-editor Joon Maeng ipDialog, Inc. postal: 7701 N. Lamar Blvd., Suite 304 Austin, TX 78752-1023 USA email: jmaeng@ipdialog.com phone: +1 512 371 1770 Co-editor Dave Walker SS8 Networks, Inc. postal: 495 March Road Kanata, ON K2K 3G1 Canada email: drwalker@ss8.com phone: +1 613 592 2100 Co-editor Jean-Francois Mule CableLabs postal: 400 Centennial Parkway Louisville, CO 80027 USA email: jf.mule@cablelabs.com phone: +1 303 661 3708 " DESCRIPTION "Session Initiation Protocol (SIP) MIB Textual Conventions module used by other SIP-related MIB Modules. Copyright (C) The Internet Society (2003). This version of this MIB module is part of RFC XXXX; see the RFC itself for full legal notices." -- RFC Ed: replace XXXX with actual RFC number and remove this note REVISION "200307300000Z" DESCRIPTION "Initial version of the IETF SIP-TC module. This version published as part of RFC XXXX." -- RFC Ed: replace XXXX with actual RFC number and remove this note ::= { mib-2 xx } -- RFC Ed: replace xx with actual IANA assigned number and remove this note -- -- Textual Conventions -- Lingle, et al. Expires December 30, 2003 [Page 11] Internet-Draft SIP MIB Modules July 2003 SipTransportProtocol ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This convention is a bit map. Each bit represents a transport protocol. If a bit has value 1, then that selected transport protocol is in some way dependent on the context of the object using this convention. If a bit has value 0, then that transport protocol is not selected. Combinations of bits can be set when multiple transport protocols are selected. bit 0 : a protocol other than those defined here. bit 1 : User Datagram Protocol. bit 2 : Transmission Control Protocol. bit 3 : Stream Control Transmission Protocol. bit 4 : Transport Layer Security Protocol." SYNTAX BITS { other(0), -- none of the following udp(1), tcp(2), sctp(3), tls(4) } -- REFERENCE "RFC 3261, Section 18" END 7.2 SIP Common MIB Module SIP-COMMON-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, Counter32, Gauge32, TimeTicks, Unsigned32, mib-2 FROM SNMPv2-SMI RowStatus, TruthValue FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP, Lingle, et al. Expires December 30, 2003 [Page 12] Internet-Draft SIP MIB Modules July 2003 NOTIFICATION-GROUP FROM SNMPv2-CONF SnmpAdminString FROM SNMP-FRAMEWORK-MIB SipTransportProtocol FROM SIP-TC applIndex FROM NETWORK-SERVICES-MIB InetPortNumber FROM INET-ADDRESS-MIB; sipCommonMIB MODULE-IDENTITY LAST-UPDATED "200307300000Z" ORGANIZATION "IETF SIP Working Group, SIP MIB Team" CONTACT-INFO "SIP WG email: sip@ietf.org Co-editor Kevin Lingle Cisco Systems, Inc. postal: 7025 Kit Creek Road P.O. Box 14987 Research Triangle Park, NC 27709 USA email: klingle@cisco.com phone: +1 919 392 2029 Co-editor Joon Maeng ipDialog, Inc. postal: 7701 N. Lamar Blvd., Suite 304 Austin, TX 78752-1023 USA email: jmaeng@ipdialog.com phone: +1 512 371 1770 Co-editor Dave Walker SS8 Networks, Inc. postal: 495 March Road Kanata, ON K2K 3G1 Canada email: drwalker@ss8.com phone: +1 613 592 2100 Co-editor Jean-Francois Mule CableLabs Lingle, et al. Expires December 30, 2003 [Page 13] Internet-Draft SIP MIB Modules July 2003 postal: 400 Centennial Parkway Louisville, CO 80027 USA email: jf.mule@cablelabs.com phone: +1 303 661 3708 " DESCRIPTION "Session Initiation Protocol (SIP) Common MIB module. This module defines objects which MAY be common to all SIP entities. SIP is an application-layer signalling protocol for creating, modifying and terminating multimedia sessions with one or more participants. These sessions include Internet multimedia conferences and Internet telephone calls. SIP is defined in RFC 3261 (June 2002). This MIB is defined for managing objects which are common to SIP User Agents (UAs), Proxy and Redirect Servers, and Registrars. Objects specific to each of these entities MAY be managed using entity specific MIBs defined in other modules. A User Agent is an application that contains both a User Agent Client (UAC) and a User Agent Server (UAS). A UAC is an application that initiates a SIP request. A UAS is an application that contacts the user when a SIP request is received and that returns a response on behalf of the user. The response accepts, rejects, or redirects the request. A Proxy Server acts as both a client and a server. It accepts requests from other clients, either responding to them or passing them on to other servers, possibly after modification. A Redirect Server accepts requests from clients and returns zero or more addresses to that client. Unlike a Proxy Server it does not initiate requests. Unlike a User Agent Server it does not accept calls. A Registrar Server accepts REGISTER requests. A Registrar Server is typically co-located with a Proxy or Redirect Server. Copyright (C) The Internet Society (2003). This version of this MIB module is part of RFC XXXX; see the RFC itself for full legal notices." Lingle, et al. Expires December 30, 2003 [Page 14] Internet-Draft SIP MIB Modules July 2003 -- RFC Ed: replace XXXX with actual RFC number and remove this note REVISION "200307300000Z" DESCRIPTION "Initial version of the IETF SIP-COMMON-MIB module. This version published as part of RFC XXXX." -- RFC Ed: replace XXXX with actual RFC number and remove this note ::= { mib-2 xx } -- RFC Ed: replace xx with actual IANA assigned number and remove this note -- Top-Level Components of this MIB. sipCommonMIBNotifs OBJECT IDENTIFIER ::= { sipCommonMIB 0 } sipCommonMIBObjects OBJECT IDENTIFIER ::= { sipCommonMIB 1 } sipCommonMIBConform OBJECT IDENTIFIER ::= { sipCommonMIB 2 } -- -- This MIB contains objects that are common to all SIP entities. -- -- Common basic configuration sipCommonCfgBase OBJECT IDENTIFIER ::= { sipCommonMIBObjects 1 } -- Protocol timer configuration sipCommonCfgTimer OBJECT IDENTIFIER ::= { sipCommonMIBObjects 2 } -- Method retry configuration sipCommonCfgRetry OBJECT IDENTIFIER ::= { sipCommonMIBObjects 3 } -- Expires header configuration sipCommonCfgExpires OBJECT IDENTIFIER ::= { sipCommonMIBObjects 4 } -- SIP message summary statistics sipCommonStatsSummary OBJECT IDENTIFIER ::= { sipCommonMIBObjects 5 } -- Per method statistics sipCommonStatsMethod OBJECT IDENTIFIER ::= { sipCommonMIBObjects 6 } -- Per Status code or status code class statistics sipCommonStatusCode OBJECT IDENTIFIER ::= { sipCommonMIBObjects 7 } -- Transaction statistics sipCommonStatsTrans OBJECT IDENTIFIER ::= { sipCommonMIBObjects 8 } -- Method retry statistics sipCommonStatsRetry OBJECT IDENTIFIER ::= { sipCommonMIBObjects 9 } -- Other statistics sipCommonStatsOther OBJECT IDENTIFIER ::= { sipCommonMIBObjects 10 } -- Accessible-for-notify objects sipCommonNotifObjects OBJECT IDENTIFIER ::= { sipCommonMIBObjects 11 } -- -- Common Configuration Objects -- sipCommonCfgTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonCfgEntry MAX-ACCESS not-accessible STATUS current Lingle, et al. Expires December 30, 2003 [Page 15] Internet-Draft SIP MIB Modules July 2003 DESCRIPTION "This table contains the common configuration objects applicable to all SIP entities." ::= { sipCommonCfgBase 1 } sipCommonCfgEntry OBJECT-TYPE SYNTAX SipCommonCfgEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of common configuration. Each row represents objects for a particular SIP entity instance present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex } ::= { sipCommonCfgTable 1 } SipCommonCfgEntry ::= SEQUENCE { sipProtocolVersion SnmpAdminString, sipServiceOperStatus INTEGER, sipServiceAdminStatus INTEGER, sipServiceStartTime TimeTicks, sipServiceLastChange TimeTicks, sipOrganization SnmpAdminString, sipMaxSessions Unsigned32, sipRequestUriHostMatching TruthValue, sipServiceNotifEnable BITS, sipEntityType INTEGER } sipProtocolVersion OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This object will reflect the version of SIP supported by this SIP entity. It will follow the same format as SIP version information contained in the SIP messages generated by this SIP entity. For example, entities supporting SIP version 2 will return 'SIP/2.0' as dictated by the standard." REFERENCE "RFC 3261, Section 7.1" ::= { sipCommonCfgEntry 1 } Lingle, et al. Expires December 30, 2003 [Page 16] Internet-Draft SIP MIB Modules July 2003 sipServiceOperStatus OBJECT-TYPE SYNTAX INTEGER { unknown(1), up(2), down(3), congested(4), restarting(5), quiescing(6), testing(7) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the current operational state of the SIP application. unknown : The operational status cannot be determined for some reason. up : The application is operating normally, and is processing (receiving and possibly issuing) SIP requests and responses. down : The application is currently unable to process SIP messages. congested : The application is operational but no additional inbound transactions can be accommodated at the moment. restarting : The application is currently unavailable but it is in the process of restarting and will, presumably, soon be able to process SIP messages. quiescing : The application is currently operational but has been administratively put into quiesce mode. Additional inbound transactions MAY be rejected. testing : The application is currently in test mode and MAY not be able to process SIP messages. The operational status values defined for this object are not based on any specific information contained in the SIP standard." ::= { sipCommonCfgEntry 2 } sipServiceAdminStatus OBJECT-TYPE SYNTAX INTEGER { noop(1), up(2), down(3), reset(4), Lingle, et al. Expires December 30, 2003 [Page 17] Internet-Draft SIP MIB Modules July 2003 quiesceSessions(5), quiesceApplication(6) } MAX-ACCESS read-write STATUS current DESCRIPTION "This object is used to affect the overall operational state of the SIP application. When read, this object always return a value of noop(1) since sipServiceOperStatus reflects the actual operational status. noop : Setting this object to a noop value has no effect; when read, this value is always returned. up : Enable the application. down : Abrupt shutdown. Immediately terminate. reset : Restart application, reinitialize data. quiesceSessions : Enable quiescence mode. Stop accepting any new SIP sessions. Stop processing new transactions except for transactions associated with an existing session or call. quiesceApplications : Enable quiescence mode. Stop processing new SIP transactions except for transactions associated with existing applications. The exact application behavior SHOULD be specified by the implementation." ::= { sipCommonCfgEntry 3 } sipServiceStartTime OBJECT-TYPE SYNTAX TimeTicks MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime at the time the SIP entity was last started. If started prior to the last re-initialization of the local network management subsystem, then this object contains a zero value." ::= { sipCommonCfgEntry 4 } sipServiceLastChange OBJECT-TYPE SYNTAX TimeTicks MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime at the time the SIP entity entered its current operational state. If the current state was Lingle, et al. Expires December 30, 2003 [Page 18] Internet-Draft SIP MIB Modules July 2003 entered prior to the last re-initialization of the local network management subsystem, then this object contains a zero value." ::= { sipCommonCfgEntry 5 } sipOrganization OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-write STATUS current DESCRIPTION "This object contains the organization name which the SIP entity inserts into Organization headers of SIP messages processed by this system. If the string is empty, no Organization header is to be generated." REFERENCE "RFC 3261, Section 20.25" ::= { sipCommonCfgEntry 6 } sipMaxSessions OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the maximum number of simultaneous sessions that the SIP entity can manage." ::= { sipCommonCfgEntry 7 } sipRequestUriHostMatching OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies whether or not the host in RequestURI MUST match server's host name. If the value of this object is 'true', then the server requires a match, and if the RequestURI doesn't match the server's host name, a Location Service MAY be used to obtain information about a callee's possible location(s) or a 404 Not Found status code is returned by the server. If the value is 'false', then no match is required." REFERENCE "RFC 3261, Section 8.1.1.1" ::= { sipCommonCfgEntry 8 } sipServiceNotifEnable OBJECT-TYPE SYNTAX BITS { sipServiceColdStart(0), Lingle, et al. Expires December 30, 2003 [Page 19] Internet-Draft SIP MIB Modules July 2003 sipServiceWarmStart(1), sipServiceStatusChanged(2) } MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies which SIP service related notifications are enabled. Each bit represents a specific notification. If a bit has a value 1, the associated notification is enabled and will be generated by the SIP entity at the approriate time. The notifications are OPTIONAL, and if they are not implemented this object's value has no meaning and MUST be 0. Setting this object in that circumstance SHOULD result in a badValue error. If notifications are supported, this object's default value SHOULD reflect sipServiceColdStart and sipServiceWarmStart enabled and sipServiceStatusChanged disabled." ::= { sipCommonCfgEntry 9 } sipEntityType OBJECT-TYPE SYNTAX INTEGER { unknown(1), userAgent(2), proxyServer(3), redirectServer(4), proxyRedirectServer(5), registrar(6) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the type of SIP entity this row if related to." ::= { sipCommonCfgEntry 10 } -- -- Support for multiple ports -- sipPortTable OBJECT-TYPE SYNTAX SEQUENCE OF SipPortEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION Lingle, et al. Expires December 30, 2003 [Page 20] Internet-Draft SIP MIB Modules July 2003 "This table contains the list of ports that each SIP entity in this system is allowed to use. These ports can be advertised using the Contact header in a REGISTER request or response." ::= { sipCommonCfgBase 2 } sipPortEntry OBJECT-TYPE SYNTAX SipPortEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Specification of a particular port. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex, sipPort } ::= { sipPortTable 1 } SipPortEntry ::= SEQUENCE { sipPort InetPortNumber, sipTransportRcv SipTransportProtocol, sipTransportSnd SipTransportProtocol, sipPortStatus RowStatus } sipPort OBJECT-TYPE SYNTAX InetPortNumber MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object reflects a particular port that can be used by the SIP application." ::= { sipPortEntry 1 } sipTransportRcv OBJECT-TYPE SYNTAX SipTransportProtocol MAX-ACCESS read-create STATUS current DESCRIPTION "This object will specify the transport protocol the SIP entity will use to receive SIP messages. This object is a bit map. Each bit represents a transport protocol. If a bit has value 1, then that transport protocol Lingle, et al. Expires December 30, 2003 [Page 21] Internet-Draft SIP MIB Modules July 2003 is currently being used. If a bit has value 0, then that transport protocol is currently not being used." ::= { sipPortEntry 2 } sipTransportSnd OBJECT-TYPE SYNTAX SipTransportProtocol MAX-ACCESS read-create STATUS current DESCRIPTION "This object will specify the transport protocol the SIP entity will use to send SIP messages. This object is a bit map. Each bit represents a transport protocol. If a bit has value 1, then that transport protocol is currently being used. If a bit has value 0, then that transport protocol is currently not being used." ::= { sipPortEntry 3 } sipPortStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The row status of the entry. This object is REQUIRED to create or delete rows by a manager. The row associated with port 5060 need not be created and cannot be deleted. It is always present in the table. It is implementation specific as to whether objects in this table can be set while a row is 'active'." ::= { sipPortEntry 4 } -- -- Support for multiple non-SIP URI schemes -- sipUriSupportedTable OBJECT-TYPE SYNTAX SEQUENCE OF SipUriSupportedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains a list of URI schemes supported by each SIP entity in this system. These are in addition to the SIP URI which MUST necessarily be supported. Normally the list of URI schemes supported by an entity is static (i.e. will not change over time). Lingle, et al. Expires December 30, 2003 [Page 22] Internet-Draft SIP MIB Modules July 2003 A URI is a Uniform Resource Identifier (as defined in RFC 2396). URI schemes could, for example, contain URLs for phones, fax, or irc (if they were defined) or a mailto: (RFC 2368) URL." REFERENCE "RFC 3261, Section 20.10" ::= { sipCommonCfgBase 3 } sipUriSupportedEntry OBJECT-TYPE SYNTAX SipUriSupportedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A particular non-SIP URI supported by the SIP entity. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex, sipUriSupportedIndex } ::= { sipUriSupportedTable 1 } SipUriSupportedEntry ::= SEQUENCE { sipUriSupportedIndex Unsigned32, sipUriSupported SnmpAdminString } sipUriSupportedIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object uniquely identifies a conceptual row in the table." ::= { sipUriSupportedEntry 1 } sipUriSupported OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates a particular non-SIP URI scheme supported by the SIP entity. Only the scheme itself Lingle, et al. Expires December 30, 2003 [Page 23] Internet-Draft SIP MIB Modules July 2003 (as described in RFC 2396) is indicated. For example, if the mailto: URLs are supported, then the table entry contains 'mailto' without the colon." REFERENCE "RFC 2396 section 3" ::= { sipUriSupportedEntry 2 } -- -- Support for features which MAY be requested in Proxy-Require -- and Require headers -- sipFtrSupportedTable OBJECT-TYPE SYNTAX SEQUENCE OF SipFtrSupportedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains a list of the features supported by each SIP entity in this system, and which MAY be REQUIRED by a peer. Definition of non-standard features is outside the scope of SIP, which only provides mechanisms whereby support for specific features MAY be signalled or requested. As and example of a non-standard feature, a user agent client MAY require that a server support the 'com.example.billing' feature, which it would indicate in a Require header. Such a client would have a row in its sipFtrSupportedTable containing the string 'com.example.billing'. Similarly, a server which is capable of handling requests for such features would list the string in its sipFtrSupportedTable. If a server does not support the required feature (indicated in a Require header to a UAS, or in a Proxy- Require to a Proxy Server), the server returns a 420 Bad Extension listing the feature in an Unsupported header. Normally the list of such features supported by an entity is static (i.e. will not change over time)." REFERENCE "RFC 3261, Section 19.2" ::= { sipCommonCfgBase 4 } sipFtrSupportedEntry OBJECT-TYPE SYNTAX SipFtrSupportedEntry MAX-ACCESS not-accessible STATUS current Lingle, et al. Expires December 30, 2003 [Page 24] Internet-Draft SIP MIB Modules July 2003 DESCRIPTION "A particular feature supported by the SIP entity, and which MAY be REQUIRED by a peer. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex, sipFtrSupportedIndex } ::= { sipFtrSupportedTable 1 } SipFtrSupportedEntry ::= SEQUENCE { sipFtrSupportedIndex Unsigned32, sipFtrSupported SnmpAdminString } sipFtrSupportedIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object uniquely identifies a conceptual row in the table." ::= { sipFtrSupportedEntry 1 } sipFtrSupported OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates a particular feature which is supported by the SIP entity." ::= { sipFtrSupportedEntry 2 } -- -- Support for extension methods -- sipExtMethodSupportedTable OBJECT-TYPE SYNTAX SEQUENCE OF SipExtMethodSupportedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains a list of extension methods supported Lingle, et al. Expires December 30, 2003 [Page 25] Internet-Draft SIP MIB Modules July 2003 by each SIP entity in this system. These are in addition to the standard set of SIP methods discussed in Section 7.1 of RFC 3261. Any additional methods that MAY be incorporated into the SIP protocol SHOULD be represented by this table without any requirement to update this MIB. The table is informational in nature; conveying to the NMS capabilities of the managed system." ::= { sipCommonCfgBase 5 } sipExtMethodSupportedEntry OBJECT-TYPE SYNTAX SipExtMethodSupportedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A particular extension method supported by the SIP entity. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex, sipExtMethodSupportedIndex } ::= { sipExtMethodSupportedTable 1 } SipExtMethodSupportedEntry ::= SEQUENCE { sipExtMethodSupportedIndex Unsigned32, sipExtMethodName SnmpAdminString } sipExtMethodSupportedIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object uniquely identifies a conceptual row in the table." ::= { sipExtMethodSupportedEntry 1 } sipExtMethodName OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the supported extension method's name. The method name MUST be all upper case (eg, 'FOO')." Lingle, et al. Expires December 30, 2003 [Page 26] Internet-Draft SIP MIB Modules July 2003 ::= { sipExtMethodSupportedEntry 2 } -- -- SIP Timer Configuration -- sipCommonCfgTimerTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonCfgTimerEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains timer configuration objects applicable to SIP user agent and SIP stateful Proxy Server entities." ::= { sipCommonCfgTimer 1 } sipCommonCfgTimerEntry OBJECT-TYPE SYNTAX SipCommonCfgTimerEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of timer configuration. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex } ::= { sipCommonCfgTimerTable 1 } SipCommonCfgTimerEntry ::= SEQUENCE { sipCfgTimerA Unsigned32, sipCfgTimerB Unsigned32, sipCfgTimerC Unsigned32, sipCfgTimerD Unsigned32, sipCfgTimerE Unsigned32, sipCfgTimerF Unsigned32, sipCfgTimerG Unsigned32, sipCfgTimerH Unsigned32, sipCfgTimerI Unsigned32, sipCfgTimerJ Unsigned32, sipCfgTimerK Unsigned32, sipCfgTimerT1 Unsigned32, sipCfgTimerT2 Unsigned32, sipCfgTimerT4 Unsigned32 Lingle, et al. Expires December 30, 2003 [Page 27] Internet-Draft SIP MIB Modules July 2003 } sipCfgTimerA OBJECT-TYPE SYNTAX Unsigned32 (100..1000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the initial value for the retransmit timer for the INVITE method. The retransmit timer doubles after each retransmission, ensuring an exponential backoff in network traffic. This object represents the initial time a SIP entity will wait to receive a provisional response to an INVITE before resending the INVITE request." REFERENCE "RFC 3261, Section 17.1.1.2" DEFVAL { 500 } ::= { sipCommonCfgTimerEntry 1 } sipCfgTimerB OBJECT-TYPE SYNTAX Unsigned32 (32000..300000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the maximum time a SIP entity will wait to receive a final response to an INVITE. The timer is started upon transmission of the initial INVITE request." REFERENCE "RFC 3261, Section 17.1.1.2" DEFVAL { 32000 } ::= { sipCommonCfgTimerEntry 2 } sipCfgTimerC OBJECT-TYPE SYNTAX Unsigned32 (180000..300000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the maximum time a SIP Proxy Server will wait to receive a provisional response to an INVITE. The Timer C MUST be set for each client transaction when an INVITE request is proxied." REFERENCE "RFC 3261, Section 16.6" DEFVAL { 180000 } ::= { sipCommonCfgTimerEntry 3 } Lingle, et al. Expires December 30, 2003 [Page 28] Internet-Draft SIP MIB Modules July 2003 sipCfgTimerD OBJECT-TYPE SYNTAX Unsigned32 (0..300000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the amount of time that the server transaction can remain in the 'Completed' state when unreliable transports are used. The default value MUST be greater than 32000 for UDP transport and its value MUST be 0 for TCP/SCTP transport." REFERENCE "RFC 3261, Section 17.1.1.2" DEFVAL { 32000 } ::= { sipCommonCfgTimerEntry 4 } sipCfgTimerE OBJECT-TYPE SYNTAX Unsigned32 (100..1000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the initial value for the retransmit timer for a non-INVITE method while in 'Trying State'. The retransmit timer doubles after each retransmission until it reaches T2 to ensure an exponential backoff in network traffic. This object represents the initial time a SIP entity will wait to receive a provisional response to the request before resending the non-INVITE request." REFERENCE "RFC 3261, Section 17.1.2.2" DEFVAL { 500 } ::= { sipCommonCfgTimerEntry 5 } sipCfgTimerF OBJECT-TYPE SYNTAX Unsigned32 (32000..300000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the maximum time a SIP entity will wait to receive a final response to a non-INVITE request. The timer is started upon transmission of the initial request." REFERENCE "RFC 3261, Section 17.1.2.2" DEFVAL { 32000 } ::= { sipCommonCfgTimerEntry 6 } Lingle, et al. Expires December 30, 2003 [Page 29] Internet-Draft SIP MIB Modules July 2003 sipCfgTimerG OBJECT-TYPE SYNTAX Unsigned32 (0..1000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the initial value for the retransmit timer for final responses to INVITE requests. If timer G fires, the response is passed to the transport layer once more for retransmission, and timer G is set to fire in MIN(2*T1, T2) seconds. From then on, when timer G fires, the response is passed to the transport again for transmission, and timer G is reset with a value that doubles, unless that value exceeds T2, in which case it is reset with the value of T2. The default value MUST be T1 for UDP transport and its value MUST be 0 for reliable transport like TCP/SCTP." REFERENCE "RFC 3261, Section 17.2.1" DEFVAL { 500 } ::= { sipCommonCfgTimerEntry 7 } sipCfgTimerH OBJECT-TYPE SYNTAX Unsigned32 (32000..300000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the maximum time a server will wait to receive an ACK before it abandons retransmitting the response. The timer is started upon entering the 'Completed' state." REFERENCE "RFC 3261, Section 17.2.1" DEFVAL { 32000 } ::= { sipCommonCfgTimerEntry 8 } sipCfgTimerI OBJECT-TYPE SYNTAX Unsigned32 (0..10000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the maximum time a SIP entity will wait to receive additional ACK message retransmissions. The timer is started upon entering the 'Confirmed' state. The default value MUST be T4 for UDP transport and its value MUST be 0 for reliable transport like TCP/SCTP." Lingle, et al. Expires December 30, 2003 [Page 30] Internet-Draft SIP MIB Modules July 2003 REFERENCE "RFC 3261, Section 17.2.1" DEFVAL { 5000 } ::= { sipCommonCfgTimerEntry 9 } sipCfgTimerJ OBJECT-TYPE SYNTAX Unsigned32 (32000..300000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the maximum time a SIP server will wait to receive retransmissions of non-INVITE request. The timer is started upon entering the 'Completed' state for non-INVITE transactions. When timer J fires, the server MUST transition to the 'Terminated' state." REFERENCE "RFC 3261, Section 17.2.2" DEFVAL { 32000 } ::= { sipCommonCfgTimerEntry 10 } sipCfgTimerK OBJECT-TYPE SYNTAX Unsigned32 (0..10000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the maximum time a SIP client will wait to receive retransmissions of responses to non-INVITE requests. The timer is started upon entering the 'Completed' state for non-INVITE transactions. When timer K fires, the server MUST transition to the 'Terminated' state. The default value MUST be T4 for UDP transport and its value MUST be 0 for reliable transport like TCP/SCTP." REFERENCE "RFC 3261, Section 17.1.2.2" DEFVAL { 5000 } ::= { sipCommonCfgTimerEntry 11 } sipCfgTimerT1 OBJECT-TYPE SYNTAX Unsigned32 (200..10000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the T1 timer for a SIP entity. T1 is an estimate of the round-trip time (RTT) between the client and server transactions." Lingle, et al. Expires December 30, 2003 [Page 31] Internet-Draft SIP MIB Modules July 2003 REFERENCE "RFC 3261, Section 17" DEFVAL { 500 } ::= { sipCommonCfgTimerEntry 12 } sipCfgTimerT2 OBJECT-TYPE SYNTAX Unsigned32 (200..10000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the T2 timer for a SIP entity. T2 is the maximum retransmit interval for non-INVITE requests and INVITE responses. It's used in various parts of the protocol to reset other Timer* objects to this value." REFERENCE "RFC 3261, Section 17" DEFVAL { 4000 } ::= { sipCommonCfgTimerEntry 13 } sipCfgTimerT4 OBJECT-TYPE SYNTAX Unsigned32 (200..10000) UNITS "milliseconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the T4 timer for a SIP entity. T4 is the maximum duration a message will remain in the network. It represents the amount of time the network will take to clear messages between client and server transactions. It's used in various parts of the protocol to reset other Timer* objects to this value." REFERENCE "RFC 3261, Section 17" DEFVAL { 5000 } ::= { sipCommonCfgTimerEntry 14 } -- -- Initial Timers Extensions: support for extension methods -- sipCommonCfgTimerExtMethodTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonCfgTimerExtMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION Lingle, et al. Expires December 30, 2003 [Page 32] Internet-Draft SIP MIB Modules July 2003 "This table contains retransmit timers for each SIP extension method this entity supports. The applicable T2 timer value for timers configured in this table is that of the sipCfgTimerT2 object with the same applIndex value." ::= { sipCommonCfgTimer 2 } sipCommonCfgTimerExtMethodEntry OBJECT-TYPE SYNTAX SipCommonCfgTimerExtMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This row contains timer value information for a particular extension method. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." AUGMENTS { sipExtMethodSupportedEntry } ::= { sipCommonCfgTimerExtMethodTable 1 } SipCommonCfgTimerExtMethodEntry ::= SEQUENCE { sipCfgTimerExtMethodTimer Unsigned32 } sipCfgTimerExtMethodTimer OBJECT-TYPE SYNTAX Unsigned32 UNITS "milliseconds" MAX-ACCESS read-create STATUS current DESCRIPTION "This object specifies the time a SIP entity will wait for a response to the extension method request before retransmitting. The retransmit timer doubles after each retransmission, ensuring an exponential backoff in network traffic." ::= { sipCommonCfgTimerExtMethodEntry 1 } -- -- SIP Retry Configuration -- Lingle, et al. Expires December 30, 2003 [Page 33] Internet-Draft SIP MIB Modules July 2003 sipCommonCfgRetryTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonCfgRetryEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains retry configuration objects applicable to SIP user agent and SIP proxies." ::= { sipCommonCfgRetry 1 } sipCommonCfgRetryEntry OBJECT-TYPE SYNTAX SipCommonCfgRetryEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of retry configuration. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex } ::= { sipCommonCfgRetryTable 1 } SipCommonCfgRetryEntry ::= SEQUENCE { sipCfgRetryInvite Unsigned32, sipCfgRetryBye Unsigned32, sipCfgRetryCancel Unsigned32, sipCfgRetryRegister Unsigned32, sipCfgRetryOptions Unsigned32, sipCfgRetryFinalResponse Unsigned32, sipCfgRetryNonFinalResponse Unsigned32 } sipCfgRetryInvite OBJECT-TYPE SYNTAX Unsigned32 (1..10) MAX-ACCESS read-write STATUS current DESCRIPTION "This object will specify the number of times a SIP entity will retry sending an INVITE request." DEFVAL { 6 } ::= { sipCommonCfgRetryEntry 1 } sipCfgRetryBye OBJECT-TYPE Lingle, et al. Expires December 30, 2003 [Page 34] Internet-Draft SIP MIB Modules July 2003 SYNTAX Unsigned32 (1..10) MAX-ACCESS read-write STATUS current DESCRIPTION "This object will specify the number of times a SIP entity will retry sending a BYE request." DEFVAL { 6 } ::= { sipCommonCfgRetryEntry 2 } sipCfgRetryCancel OBJECT-TYPE SYNTAX Unsigned32 (1..10) MAX-ACCESS read-write STATUS current DESCRIPTION "This object will specify the number of times a SIP entity will retry sending a CANCEL request." DEFVAL { 6 } ::= { sipCommonCfgRetryEntry 3 } sipCfgRetryRegister OBJECT-TYPE SYNTAX Unsigned32 (1..10) MAX-ACCESS read-write STATUS current DESCRIPTION "This object will specify the number of times a SIP entity will retry sending a REGISTER request." DEFVAL { 6 } ::= { sipCommonCfgRetryEntry 4 } sipCfgRetryOptions OBJECT-TYPE SYNTAX Unsigned32 (1..10) MAX-ACCESS read-write STATUS current DESCRIPTION "This object will specify the number of times a SIP entity will retry sending an OPTIONS request." DEFVAL { 6 } ::= { sipCommonCfgRetryEntry 5 } sipCfgRetryFinalResponse OBJECT-TYPE SYNTAX Unsigned32 (1..10) MAX-ACCESS read-write STATUS current DESCRIPTION "This object will specify the number of times a SIP entity will retry sending a final response and expecting an ACK." DEFVAL { 6 } ::= { sipCommonCfgRetryEntry 6 } Lingle, et al. Expires December 30, 2003 [Page 35] Internet-Draft SIP MIB Modules July 2003 sipCfgRetryNonFinalResponse OBJECT-TYPE SYNTAX Unsigned32 (1..10) MAX-ACCESS read-write STATUS current DESCRIPTION "This object will specify the number of times a SIP entity will retry sending a non-final response." DEFVAL { 6 } ::= { sipCommonCfgRetryEntry 7 } -- -- Retry Extensions: support for extension methods -- sipCommonCfgRetryExtMethodTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonCfgRetryExtMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains retry configuration for each SIP extension method this entity supports." ::= { sipCommonCfgRetry 2 } sipCommonCfgRetryExtMethodEntry OBJECT-TYPE SYNTAX SipCommonCfgRetryExtMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This row contains retry configuration information for a particular extension method. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." AUGMENTS { sipExtMethodSupportedEntry } ::= { sipCommonCfgRetryExtMethodTable 1 } SipCommonCfgRetryExtMethodEntry ::= SEQUENCE { sipCfgRetryExtMethodRetry Unsigned32 } sipCfgRetryExtMethodRetry OBJECT-TYPE SYNTAX Unsigned32 Lingle, et al. Expires December 30, 2003 [Page 36] Internet-Draft SIP MIB Modules July 2003 MAX-ACCESS read-create STATUS current DESCRIPTION "This object specifies the number of times a SIP entity will retry sending its request for this particular extension method." ::= { sipCommonCfgRetryExtMethodEntry 1 } -- -- Per Method Expires Configuration -- sipCommonCfgExpiresMethodTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonCfgExpiresMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains Expires header value configuration objects applicable to SIP user agent and SIP stateful Proxy Server entities." ::= { sipCommonCfgExpires 1 } sipCommonCfgExpiresMethodEntry OBJECT-TYPE SYNTAX SipCommonCfgExpiresMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of Expires header configuration for SIP Methods. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex } ::= { sipCommonCfgExpiresMethodTable 1 } SipCommonCfgExpiresMethodEntry ::= SEQUENCE { sipCfgExpiresInvite Unsigned32, sipCfgExpiresRegister Unsigned32, sipCfgExpiresHeaderMethod BITS } sipCfgExpiresInvite OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) Lingle, et al. Expires December 30, 2003 [Page 37] Internet-Draft SIP MIB Modules July 2003 UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "For user agent clients, this value is inserted into the Expires header. For Proxy Servers, if a received request contained an Expires header, then the value in the header takes precedence." ::= { sipCommonCfgExpiresMethodEntry 1 } sipCfgExpiresRegister OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "For user agent clients, this value is inserted into the Expires header. For Registrar Servers, if a received request contained an Expires header, then the value in the header takes precedence." ::= { sipCommonCfgExpiresMethodEntry 2 } sipCfgExpiresHeaderMethod OBJECT-TYPE SYNTAX BITS { invite(0), register(1) } MAX-ACCESS read-write STATUS current DESCRIPTION "This convention is a bit map. Each bit represents a SIP method where the Expires header SHOULD be included. If a bit has value 1, then the requests corresponding to that SIP method MUST include an Expires header line. If a bit has value 0, then the Expires header line will not be added. Combinations of bits can be set when the Expires header line is REQUIRED in multiple SIP methods. bit 0 : INVITE method. bit 1 : REGISTER Method." ::= { sipCommonCfgExpiresMethodEntry 3 } sipCommonCfgExpiresStatusCodeTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonCfgExpiresStatusCodeEntry Lingle, et al. Expires December 30, 2003 [Page 38] Internet-Draft SIP MIB Modules July 2003 MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the Expires header configuration objects for the SIP responses." ::= { sipCommonCfgExpires 2 } sipCommonCfgExpiresStatusCodeEntry OBJECT-TYPE SYNTAX SipCommonCfgExpiresStatusCodeEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This row contains information on the configuration of the Expires header value for a particular SIP status code. Examples of SIP responses that MAY include an Expires header are 302 and 504. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex, sipCfgExpiresStatusCodeValue } ::= { sipCommonCfgExpiresStatusCodeTable 1 } SipCommonCfgExpiresStatusCodeEntry ::= SEQUENCE { sipCfgExpiresStatusCodeValue Unsigned32, sipCfgExpiresHeaderValue Unsigned32, sipCfgExpiresStatusCodeStatus RowStatus } sipCfgExpiresStatusCodeValue OBJECT-TYPE SYNTAX Unsigned32 (100..999) MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object contains a SIP status code value for which the Expires header value is configured. All of the other information in the row is related to this value." ::= { sipCommonCfgExpiresStatusCodeEntry 1 } sipCfgExpiresHeaderValue OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) UNITS "seconds" MAX-ACCESS read-create Lingle, et al. Expires December 30, 2003 [Page 39] Internet-Draft SIP MIB Modules July 2003 STATUS current DESCRIPTION "This value is inserted into the Expires header for the specific status code." ::= { sipCommonCfgExpiresStatusCodeEntry 2 } sipCfgExpiresStatusCodeStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "This object is REQUIRED to create or delete rows by a manager. A value for sipCfgExpiresHeaderValue MUST be specified when creating rows by setting this row status to 'createAndGo'. The row will automatically transition to 'active'. The configuration specified by an entry will be made active when this object is set to 'active'." ::= { sipCommonCfgExpiresStatusCodeEntry 3 } -- -- Common Statistics Objects -- -- -- Summary Statistics -- sipSummaryStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF SipSummaryStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the summary statistics objects applicable to all SIP entities. Each row represents those objects for a particular SIP entity present in this system." ::= { sipCommonStatsSummary 1 } sipSummaryStatsEntry OBJECT-TYPE SYNTAX SipSummaryStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION Lingle, et al. Expires December 30, 2003 [Page 40] Internet-Draft SIP MIB Modules July 2003 "A row of summary statistics. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex } ::= { sipSummaryStatsTable 1 } SipSummaryStatsEntry ::= SEQUENCE { sipSummaryInRequests Counter32, sipSummaryOutRequests Counter32, sipSummaryInResponses Counter32, sipSummaryOutResponses Counter32, sipSummaryTotalTransactions Counter32 } sipSummaryInRequests OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the total number of SIP request messages received by the SIP entity including retransmissions." ::= { sipSummaryStatsEntry 1 } sipSummaryOutRequests OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the total number of SIP request messages sent out (originated and relayed) by the SIP entity. Where a particular message is sent more than once, for example as a retransmission, or as a result of forking, each transmission is counted separately." ::= { sipSummaryStatsEntry 2 } sipSummaryInResponses OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the total number of SIP response messages received by the SIP entity including Lingle, et al. Expires December 30, 2003 [Page 41] Internet-Draft SIP MIB Modules July 2003 retransmissions." ::= { sipSummaryStatsEntry 3 } sipSummaryOutResponses OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the total number of SIP response messages sent (originated and relayed) by the SIP entity including retransmissions." ::= { sipSummaryStatsEntry 4 } sipSummaryTotalTransactions OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains a count of the number of transactions that are in progress and transactions that have reached the terminated state. It is not applicable to stateless SIP Proxy Servers. A SIP transaction occurs between a client and a server and comprises all messages from the first request sent from the client to the server up to a final (non-1xx) response sent from the server to the client. If the request is INVITE and the final response is a non-2xx, the transaction also include an ACK to the response. The ACK for a 2xx response to an INVITE request is a separate transaction. The branch ID parameter in the Via header field values serves as a transaction identifier. A transaction is identified by the CSeq sequence number within a single call leg. The ACK request has the same CSeq number as the corresponding INVITE request, but comprises a transaction of its own. In the case of a forked request, all branches count as a single transaction. For a transaction stateless Proxy Server, this counter is always 0." Lingle, et al. Expires December 30, 2003 [Page 42] Internet-Draft SIP MIB Modules July 2003 ::= { sipSummaryStatsEntry 5 } -- -- SIP Method Statistics -- Total counts for each SIP method. -- sipMethodStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF SipMethodStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the method statistics objects for SIP entities. Each row represents those objects for a particular SIP entity present in this system." ::= { sipCommonStatsMethod 1 } sipMethodStatsEntry OBJECT-TYPE SYNTAX SipMethodStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of per entity method statistics. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex } ::= { sipMethodStatsTable 1 } SipMethodStatsEntry ::= SEQUENCE { sipStatsInviteIns Counter32, sipStatsInviteOuts Counter32, sipStatsAckIns Counter32, sipStatsAckOuts Counter32, sipStatsByeIns Counter32, sipStatsByeOuts Counter32, sipStatsCancelIns Counter32, sipStatsCancelOuts Counter32, sipStatsOptionsIns Counter32, sipStatsOptionsOuts Counter32, sipStatsRegisterIns Counter32, sipStatsRegisterOuts Counter32 } Lingle, et al. Expires December 30, 2003 [Page 43] Internet-Draft SIP MIB Modules July 2003 sipStatsInviteIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of INVITE requests received by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 1 } sipStatsInviteOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of INVITE requests sent by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 2 } sipStatsAckIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of ACK requests received by the SIP entity." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 3 } sipStatsAckOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of ACK requests sent by the SIP entity." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 4 } sipStatsByeIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only Lingle, et al. Expires December 30, 2003 [Page 44] Internet-Draft SIP MIB Modules July 2003 STATUS current DESCRIPTION "This object reflects the total number of BYE requests received by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 5 } sipStatsByeOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of BYE requests sent by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 6 } sipStatsCancelIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of CANCEL requests received by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 7 } sipStatsCancelOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of CANCEL requests sent by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 8 } sipStatsOptionsIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of OPTIONS requests received by the SIP entity including retransmissions." Lingle, et al. Expires December 30, 2003 [Page 45] Internet-Draft SIP MIB Modules July 2003 REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 9 } sipStatsOptionsOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of OPTIONS requests sent by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 10 } sipStatsRegisterIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of REGISTER requests received by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 11 } sipStatsRegisterOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of REGISTER requests sent by the SIP entity including retransmissions." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 12 } -- -- support for extension methods -- sipStatsExtMethodTable OBJECT-TYPE SYNTAX SEQUENCE OF SipStatsExtMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the list of extension methods which Lingle, et al. Expires December 30, 2003 [Page 46] Internet-Draft SIP MIB Modules July 2003 each SIP entity in this system has been requested to monitor." ::= { sipCommonStatsMethod 2 } sipStatsExtMethodEntry OBJECT-TYPE SYNTAX SipStatsExtMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This row contains information on a particular extension method that the SIP entity has been requested to monitor. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." AUGMENTS { sipExtMethodSupportedEntry } ::= { sipStatsExtMethodTable 1 } SipStatsExtMethodEntry ::= SEQUENCE { sipStatsExtMethodIns Counter32, sipStatsExtMethodOuts Counter32 } sipStatsExtMethodIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of requests received by the SIP entity which requested the method contained in the sipStatsExtMethodName column including retransmissions if appropriate for the method." ::= { sipStatsExtMethodEntry 1 } sipStatsExtMethodOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of requests sent by the SIP entity which requested the method contained in the sipStatsExtMethodName column including retransmissions if appropriate for the method." ::= { sipStatsExtMethodEntry 2 } Lingle, et al. Expires December 30, 2003 [Page 47] Internet-Draft SIP MIB Modules July 2003 -- -- SIP Response Status Codes -- sipStatusCodeClassesTable OBJECT-TYPE SYNTAX SEQUENCE OF SipStatusCodeClassesEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains statistics on response status code classes for each SIP entity in this system." ::= { sipCommonStatusCode 1 } sipStatusCodeClassesEntry OBJECT-TYPE SYNTAX SipStatusCodeClassesEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This row contains statistics on response status codes. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex } ::= { sipStatusCodeClassesTable 1 } SipStatusCodeClassesEntry ::= SEQUENCE { sipStatsInfoClassIns Counter32, sipStatsInfoClassOuts Counter32, sipStatsSuccessClassIns Counter32, sipStatsSuccessClassOuts Counter32, sipStatsRedirClassIns Counter32, sipStatsRedirClassOuts Counter32, sipStatsReqFailClassIns Counter32, sipStatsReqFailClassOuts Counter32, sipStatsServerFailClassIns Counter32, sipStatsServerFailClassOuts Counter32, sipStatsGlobalFailClassIns Counter32, sipStatsGlobalFailClassOuts Counter32, sipStatsOtherClassesIns Counter32, sipStatsOtherClassesOuts Counter32 } sipStatsInfoClassIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only Lingle, et al. Expires December 30, 2003 [Page 48] Internet-Draft SIP MIB Modules July 2003 STATUS current DESCRIPTION "This object reflects the number of 1xx class SIP responses received by the SIP entity. This class of responses relates to providing some information concerning the progress of processing a SIP request." REFERENCE "RFC 3261, Section 21.1" ::= { sipStatusCodeClassesEntry 1 } sipStatsInfoClassOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 1xx class SIP responses sent by the SIP entity. This class of responses relates to providing some information concerning the progress of processing a SIP request." REFERENCE "RFC 3261, Section 21.1" ::= { sipStatusCodeClassesEntry 2 } sipStatsSuccessClassIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 2xx class SIP responses received by the SIP entity. This class of responses relate to successful completion of a SIP request." REFERENCE "RFC 3261, Section 21.2" ::= { sipStatusCodeClassesEntry 3 } sipStatsSuccessClassOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 2xx class SIP responses sent by the SIP entity. This class of responses relate to successful completion of a SIP request." REFERENCE Lingle, et al. Expires December 30, 2003 [Page 49] Internet-Draft SIP MIB Modules July 2003 "RFC 3261, Section 21.2" ::= { sipStatusCodeClassesEntry 4 } sipStatsRedirClassIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 3xx class SIP responses received by the SIP entity. This class of responses relate to redirections to addresses where the callee might be reachable." REFERENCE "RFC 3261, Section 21.3" ::= { sipStatusCodeClassesEntry 5 } sipStatsRedirClassOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 3xx class SIP responses sent by the SIP entity. This class of responses relate to redirections to addresses where the callee might be reachable." REFERENCE "RFC 3261, Section 21.3" ::= { sipStatusCodeClassesEntry 6 } sipStatsReqFailClassIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 4xx class SIP responses received by the SIP entity. This class of responses reflect request failure by a SIP entity providing a client function." REFERENCE "RFC 3261, Section 21.4" ::= { sipStatusCodeClassesEntry 7 } sipStatsReqFailClassOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 4xx class SIP Lingle, et al. Expires December 30, 2003 [Page 50] Internet-Draft SIP MIB Modules July 2003 responses sent by the SIP entity. This class of responses reflect request failure by a SIP entity providing a server function." REFERENCE "RFC 3261, Section 21.4" ::= { sipStatusCodeClassesEntry 8 } sipStatsServerFailClassIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 5xx class SIP responses received by the SIP entity. This class of responses reflect failure responses received by a SIP entity providing a client function." REFERENCE "RFC 3261, Section 21.5" ::= { sipStatusCodeClassesEntry 9 } sipStatsServerFailClassOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 5xx class SIP responses sent by the SIP entity. This class of responses reflect failure responses sent by a SIP entity providing a server function." REFERENCE "RFC 3261, Section 21.5" ::= { sipStatusCodeClassesEntry 10 } sipStatsGlobalFailClassIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 6xx class SIP responses received by the SIP entity. This class of responses reflect failure responses received by a SIP entity providing a client function. The responses generally indicate that a server has definitive information about a particular called party, not just the particular instance indicated in the Request-URI." REFERENCE Lingle, et al. Expires December 30, 2003 [Page 51] Internet-Draft SIP MIB Modules July 2003 "RFC 3261, Section 21.6" ::= { sipStatusCodeClassesEntry 11 } sipStatsGlobalFailClassOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of 6xx class SIP responses sent by the SIP entity. This class of responses reflect failure responses sent by a SIP entity providing a server function. The responses generally indicate that a server has definitive information about a particular called party, not just the particular instance indicated in the Request-URI." REFERENCE "RFC 3261, Section 21.6" ::= { sipStatusCodeClassesEntry 12 } sipStatsOtherClassesIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of SIP responses received by the SIP entity for status code response classes other than 1xx, 2xx, 3xx, 4xx, 5xx, or 6xx." ::= { sipStatusCodeClassesEntry 13 } sipStatsOtherClassesOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the number of SIP responses sent by the SIP entity for status code response classes other than 1xx, 2xx, 3xx, 4xx, 5xx, or 6xx." ::= { sipStatusCodeClassesEntry 14 } -- -- Support for specific status codes -- sipStatusCodesTable OBJECT-TYPE SYNTAX SEQUENCE OF SipStatusCodesEntry Lingle, et al. Expires December 30, 2003 [Page 52] Internet-Draft SIP MIB Modules July 2003 MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the list of SIP status codes which each SIP entity in this system has been requested to monitor. It is the mechanism by which specific status codes are monitored." ::= { sipCommonStatusCode 2 } sipStatusCodesEntry OBJECT-TYPE SYNTAX SipStatusCodesEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This row contains information on a particular SIP status code that the SIP entity has been requested to monitor. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex, sipStatusCodeValue } ::= { sipStatusCodesTable 1 } SipStatusCodesEntry ::= SEQUENCE { sipStatusCodeValue Unsigned32, sipStatusCodeIns Counter32, sipStatusCodeOuts Counter32, sipStatusCodeRowStatus RowStatus } sipStatusCodeValue OBJECT-TYPE SYNTAX Unsigned32 (100..999) MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object contains a SIP status code value that the SIP entity has been requested to monitor. All of the other information in the row is related to this value." ::= { sipStatusCodesEntry 1 } sipStatusCodeIns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION Lingle, et al. Expires December 30, 2003 [Page 53] Internet-Draft SIP MIB Modules July 2003 "This object reflects the total number of response messages received by the SIP entity with the status code value contained in the sipStatusCodeValue column." ::= { sipStatusCodesEntry 2 } sipStatusCodeOuts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of response messages sent by the SIP entity with the status code value contained in the sipStatusCodeValue column." ::= { sipStatusCodesEntry 3 } sipStatusCodeRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The row augmentation in sipStatusCodeNotifTable will be governed by the value of this RowStatus. This object is REQUIRED to create or delete rows by a manager. The values 'createAndGo' and 'destroy' are the only valid values allowed for this object. If a row exists, it will reflect a status of 'active' when queried." ::= { sipStatusCodesEntry 4 } -- -- support for specific status code notifications -- sipStatusCodeNotifTable OBJECT-TYPE SYNTAX SEQUENCE OF SipStatusCodeNotifEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains objects to control notifications related to particular status codes each SIP entity in this system has been requested to monitor. There is an entry in this table corresponding to each entry in sipStatusCodesTable. Therefore, this table augments that table and utilizes the same index Lingle, et al. Expires December 30, 2003 [Page 54] Internet-Draft SIP MIB Modules July 2003 methodology. The objects in this table are not included directly in the sipStatusCodesTable simply to keep the status code notification control objects seperate from the actual status code statistics." ::= { sipCommonStatusCode 3 } sipStatusCodeNotifEntry OBJECT-TYPE SYNTAX SipStatusCodeNotifEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This row contains information controlling notifications for a particular SIP status code that the SIP entity has been requested to monitor." AUGMENTS { sipStatusCodesEntry } ::= { sipStatusCodeNotifTable 1 } SipStatusCodeNotifEntry ::= SEQUENCE { sipStatusCodeNotifSend TruthValue, sipStatusCodeNotifEmitMode INTEGER, sipStatusCodeNotifThresh Unsigned32, sipStatusCodeNotifInterval Unsigned32 } sipStatusCodeNotifSend OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-write STATUS current DESCRIPTION "This object controls whether a sipStatusCodeNotif is emitted when the status code value specified in by sipStatusCodeValue is sent or received. If the value of this object is 'true', then a notification is sent. If it is 'false', no notification is sent. Note well, that a notification MAY be emitted for every message sent or received that contains the particular status code. Depending on the status code involved, this can cause a significant number of notification emissions that could be detrimental to network performance. Managers are forewarned to be prudent in the use of this object to enable notifications. Look to sipStatusCodeNotifEmitMode for alternative controls for sipStatusCodeNotif emissions." DEFVAL { false } ::= { sipStatusCodeNotifEntry 1 } Lingle, et al. Expires December 30, 2003 [Page 55] Internet-Draft SIP MIB Modules July 2003 sipStatusCodeNotifEmitMode OBJECT-TYPE SYNTAX INTEGER { normal(1), oneShot(2), triggered(3) -- read-only } MAX-ACCESS read-write STATUS current DESCRIPTION "The object sipStatusCodeNotifSend MUST be set to 'true' for the values of this object to have any effect. It is RECOMMENDED that the desired emit mode be established by this object prior to setting sipStatusCodeNotifSend to 'true'. This object and the sipStatusCodeNotifSend object can obviously be set independently, but their respective values will have a dependency on each other and the resulting notifications. This object specifies the mode for emissions of sipStatusCodeNotif notifications. normal : sipStatusCodeNotif notifications will be emitted by the system for each SIP response messages sent or received that contains the desired status code. oneShot : Only one sipStatusCodeNotif notification will be emitted. It will be the next SIP response messages sent or received that contains the desired status code. No more notifications are emitted until this object is set to either 'oneShot' again or 'normal'. This option is provided as a means of quelling the potential promiscuous behavior that can be associated with the sipStatusCodeNotif. triggered : This value is only readable and cannot be set. It reflects the default value of the object or that the 'oneShot' case has occurred and indicates the mode needs to be reset to get further notifications. The mode is reset by setting this object to 'oneShot' or 'normal'." DEFVAL { triggered } ::= { sipStatusCodeNotifEntry 2 } Lingle, et al. Expires December 30, 2003 [Page 56] Internet-Draft SIP MIB Modules July 2003 sipStatusCodeNotifThresh OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the number of response messages sent or received by this system that are considered excessive. Based on crossing that threshold, a sipStatusCodeThreshExceededInNotif notification or a sipStatusCodeThreshExceededOutNotif will be sent. The sipStatusCodeThreshExceededIn/OutNotif can be used as an early warning mechanism in lieu of using sipStatusCodeNotif. Note that the configuration applied by this object will be applied equally to inbound and outbound response messages." DEFVAL { 500 } ::= { sipStatusCodeNotifEntry 3 } sipStatusCodeNotifInterval OBJECT-TYPE SYNTAX Unsigned32 UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the time interval over which if sipCommonStatusCodeThresh is exceeded, with respect to sent or received messages, a sipStatusCodeThreshExceededIn/Out notification will be sent. Note that the configuration applied by this object will be applied equally to inbound and outbound response messages." DEFVAL { 60 } ::= { sipStatusCodeNotifEntry 4 } -- -- Transaction Statistics -- sipCurrentTransTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCurrentTransEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains information on the transactions Lingle, et al. Expires December 30, 2003 [Page 57] Internet-Draft SIP MIB Modules July 2003 currently awaiting definitive responses by each SIP entity in this system. This table does not apply to transaction stateless Proxy Servers." ::= { sipCommonStatsTrans 1 } sipCurrentTransEntry OBJECT-TYPE SYNTAX SipCurrentTransEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Information on a particular SIP entity's current transactions. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex } ::= { sipCurrentTransTable 1 } SipCurrentTransEntry ::= SEQUENCE { sipCurrentTransactions Gauge32 } sipCurrentTransactions OBJECT-TYPE SYNTAX Gauge32 (0..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the number of transactions awaiting definitive (non-1xx) response. In the case of a forked request, all branches count as a single transaction corresponding to the entity identified by applIndex." ::= { sipCurrentTransEntry 1 } -- -- SIP Retry Statistics -- -- The counter objects in this group correspond directly to the -- retry timers supported in sipCommonCfgRetry group. applIndex can -- be used to correlate the two groups. -- sipCommonStatsRetryTable OBJECT-TYPE Lingle, et al. Expires December 30, 2003 [Page 58] Internet-Draft SIP MIB Modules July 2003 SYNTAX SEQUENCE OF SipCommonStatsRetryEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains retry statistics objects applicable to each SIP entity in this system." ::= { sipCommonStatsRetry 1 } sipCommonStatsRetryEntry OBJECT-TYPE SYNTAX SipCommonStatsRetryEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of retry statistics. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex } ::= { sipCommonStatsRetryTable 1 } SipCommonStatsRetryEntry ::= SEQUENCE { sipStatsRetryInvites Counter32, sipStatsRetryByes Counter32, sipStatsRetryCancels Counter32, sipStatsRetryRegisters Counter32, sipStatsRetryOptions Counter32, sipStatsRetryFinalResponses Counter32, sipStatsRetryNonFinalResponses Counter32 } sipStatsRetryInvites OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of INVITE retries that have been sent by the SIP entity. If the number of 'first attempt' INVITES is of interest, subtract the value of this object from sipStatsInviteOuts." ::= { sipCommonStatsRetryEntry 1 } sipStatsRetryByes OBJECT-TYPE Lingle, et al. Expires December 30, 2003 [Page 59] Internet-Draft SIP MIB Modules July 2003 SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of BYE retries that have been sent by the SIP entity. If the number of 'first attempt' BYEs is of interest, subtract the value of this object from sipStatsByeOuts." ::= { sipCommonStatsRetryEntry 2 } sipStatsRetryCancels OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of CANCEL retries that have been sent by the SIP entity. If the number of 'first attempt' CANCELs is of interest, subtract the value of this object from sipStatsCancelOuts." ::= { sipCommonStatsRetryEntry 3 } sipStatsRetryRegisters OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of REGISTER retries that have been sent by the SIP entity. If the number of 'first attempt' REGISTERSs is of interest, subtract the value of this object from sipStatsRegisterOuts." ::= { sipCommonStatsRetryEntry 4 } sipStatsRetryOptions OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of OPTIONS retries that have been sent by the SIP entity. If the number of 'first attempt' OPTIONS is of interest, subtract the value of this object from sipStatsOptionsOuts." ::= { sipCommonStatsRetryEntry 5 } sipStatsRetryFinalResponses OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION Lingle, et al. Expires December 30, 2003 [Page 60] Internet-Draft SIP MIB Modules July 2003 "This object reflects the total number of Final Response retries that have been sent by the SIP entity." ::= { sipCommonStatsRetryEntry 6 } sipStatsRetryNonFinalResponses OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of non-Final Response retries that have been sent by the SIP entity." ::= { sipCommonStatsRetryEntry 7 } -- -- Retry Extensions Stats: support for extension methods -- sipCommonStatsRetryExtMethodTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonStatsRetryExtMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains retry statistics for each SIP extension method this entity supports." ::= { sipCommonStatsRetry 2 } sipCommonStatsRetryExtMethodEntry OBJECT-TYPE SYNTAX SipCommonStatsRetryExtMethodEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This row contains retry statistics for a particular extension method. Each row represents those objects for a particular SIP entity present in this system. applIndex is used to uniquely identify these instances of SIP entities and correlate them t