SIP WG K. Lingle Internet-Draft Cisco Systems, Inc. Expires: January 14, 2005 J. Maeng D. Walker July 16, 2004 Management Information Base for Session Initiation Protocol (SIP) draft-ietf-sip-mib-08.txt Status of this Memo By submitting this Internet-Draft, I certify that any applicable patent or other IPR claims of which I am aware have been disclosed, and any of which I become aware will be disclosed, in accordance with RFC 3668. 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 January 14, 2005. Copyright Notice Copyright (C) The Internet Society (2004). 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/Redirect servers and Registrars. Lingle, et al. Expires January 14, 2005 [Page 1] Internet-Draft SIP MIB Modules July 2004 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 . . . . . . . . . . . . . . . . . . . 5 5.2 Relationship to the Network Services MIB . . . . . . . . . 6 6. Accommodating SIP Extension Methods . . . . . . . . . . . . . 9 7. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 9 7.1 SIP Textual Conventions . . . . . . . . . . . . . . . . . 9 7.2 SIP Common MIB Module . . . . . . . . . . . . . . . . . . 13 7.3 SIP User Agent MIB Module . . . . . . . . . . . . . . . . 54 7.4 SIP Server (Registrar & Proxy/Redirect Server) MIB Module . . . . . . . . . . . . . . . . . . . . . . . . . . 59 8. Changes from Previous Draft Revisions . . . . . . . . . . . . 77 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 87 10. Security Considerations . . . . . . . . . . . . . . . . . . 88 11. Contributor Acknowledgments . . . . . . . . . . . . . . . . 91 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 91 12.1 Normative References . . . . . . . . . . . . . . . . . . . . 91 12.2 Informational References . . . . . . . . . . . . . . . . . . 92 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 92 Intellectual Property and Copyright Statements . . . . . . . . 93 Lingle, et al. Expires January 14, 2005 [Page 2] Internet-Draft SIP MIB Modules July 2004 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/Redirect servers and Registrars. The managed objects defined in this document are intended to provide basic SIP protocol management for SIP entities. The management of application-specific or service-specific SIP configuration is out of scope. 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, comprised of RFC 2578 [3], RFC 2579 [4], and 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/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 Lingle, et al. Expires January 14, 2005 [Page 3] Internet-Draft SIP MIB Modules July 2004 objects used in all the SIP entities. SIP-SERVER-MIB contains objects specific to Registrars, Proxies/Redirect Servers, and SIP-UA-MIB includes objects specific to User Agents. SIP-TC defines the textual 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 dialogs an entity can manage, etc. * sipCommonCfgTimer: This object group defines timer configuration objects applicable to SIP user agent and SIP stateful proxy entities. * 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. Retransmissions, where appropriate, are also included in these statistics. * 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. * 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 related 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 Lingle, et al. Expires January 14, 2005 [Page 4] Internet-Draft SIP MIB Modules July 2004 configured threshold. SIP-SERVER-MIB: Groups of objects for Registrars and Proxy/Redirect Servers o sipServerMIBObjects * sipServerCfg: This object group defines common server configuration objects including the SIP server host address. * 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. * sipRegCfg: This object group defines common registrar configuration objects including the ability for a registrar to accept third-party registration, the maximum expiry that may be requested by UAs, the maximum number of users, currently registered users, etc. * sipRegStats: This object group contains the summary statistics objects for Registrar servers, including the number of REGISTER requests that have been accepted or rejected. SIP-UA-MIB: Group of objects for User Agents. o sipUAMIBObjects * sipUACfgServer: This group specifies SIP server configuration objects applicable to SIP user agents including the Internet address of the SIP Server to use to register, 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 types SipTransportProtocol, SipEntityRole, SipOptionTagHeaders, and SipMethodIdentifier are 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 Lingle, et al. Expires January 14, 2005 [Page 5] Internet-Draft SIP MIB Modules July 2004 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 Registrar entity, applName MUST be equal to "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. In order to faciliate consistent agent behavior and management application expectations, the following order of names is RECOMMENDED: * if Proxy exists, list first. * if Proxy & Redirect exists, list Redirect second. * if Registrar exists, always list last. For example "sip_proxy", "sip_proxy_registrar", "sip_proxy_redirect", "sip_proxy_redirect_registrar", or "sip_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: Lingle, et al. Expires January 14, 2005 [Page 6] Internet-Draft SIP MIB Modules July 2004 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. 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 | bob@example.com | | | 2 | 2 | alice@example.com | | | 2 | 3 | jim@example.com | | | 2 | 4 | john@example.com | | +-----------+--------------+-------------------+-----+ Example 2: Lingle, et al. Expires January 14, 2005 [Page 7] Internet-Draft SIP MIB Modules July 2004 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. 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 | bob@example.com | | | 2 | 2 | alice@example.com | | | 2 | 3 | kevin@example.com | | | 2 | 4 | jf@example.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. Lingle, et al. Expires January 14, 2005 [Page 8] Internet-Draft SIP MIB Modules July 2004 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 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 IETF 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, we use a Method Identifier (SipMethodIdentifier textual-convention) to represent all SIP methods registered with IANA. See IANA Consideration section. For example, the sipMethodSupportedTable is the main table for listing all of the SIP methods supported by a system, including the SIP methods defined in RFC 3261 [7] and other SIP methods registered with IANA. The table is informational in nature and populated by the system. Entries cannot be added or deleted by a SNMP manager. 7. Definitions 7.1 SIP Textual Conventions SIP-TC DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, Unsigned32, mib-2 FROM SNMPv2-SMI Lingle, et al. Expires January 14, 2005 [Page 9] Internet-Draft SIP MIB Modules July 2004 TEXTUAL-CONVENTION FROM SNMPv2-TC; sipTC MODULE-IDENTITY LAST-UPDATED "200407160000Z" 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 postal: email: jmaeng@austin.rr.com phone: Co-editor Dave Walker postal: email: drwalker@rogers.com phone: Co-editor Jean-Francois Mule CableLabs postal: 858 Coal Creek Circle 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 (2004). This version of this MIB module is part of RFC XXXX; see the RFC Lingle, et al. Expires January 14, 2005 [Page 10] Internet-Draft SIP MIB Modules July 2004 itself for full legal notices." -- RFC Ed: replace XXXX with actual RFC number and remove this note REVISION "200407160000Z" 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 -- 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" SipEntityRole ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This convention defines the role of a SIP entity. Examples of SIP entities are proxies, user agents, redirect servers, registrars or combinations of the above." SYNTAX BITS { other(0), Lingle, et al. Expires January 14, 2005 [Page 11] Internet-Draft SIP MIB Modules July 2004 userAgent(1), proxyServer(2), redirectServer(3), registrarServer(4) } SipOptionTagHeaders ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This convention defines the header fields that use the option tags per section 19.2 of RFC 3261. These tags are used in Require (Section 20.32), Proxy-Require (Section 20.29), Supported (Section 20.37) and Unsupported (Section 20.40) header fields." SYNTAX BITS { require(0), -- Require header proxyRequire(1), -- Proxy-Require header supported(2), -- Supported header unsupported(3) -- Unsupported header } -- REFERENCE "RFC 3261, Section 19.2" SipMethodIdentifier ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This is an IETF Assigned Numbers Authority (IANA) assigned number that uniquely identifies a SIP method. The scope of uniqueness is the context of all defined SIP methods. Experimental support of extension methods is acceptable and expected. Extention methods are those defined in Internet-Draft documents but not yet allocated an official number by IANA. To support experimental extension methods, any object using this textual convention as syntax MAY return/accept a method identifier value other than those defined by IANA. That system MUST ensure no collisions with officially assigned method identifier values and MUST provide a identifier to method name mapping via a mechanism like sipMethodSupportedTable." SYNTAX Unsigned32 (1..4294967295) END Lingle, et al. Expires January 14, 2005 [Page 12] Internet-Draft SIP MIB Modules July 2004 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, NOTIFICATION-GROUP FROM SNMPv2-CONF SnmpAdminString FROM SNMP-FRAMEWORK-MIB SipTransportProtocol, SipMethodIdentifier, SipEntityRole, SipOptionTagHeaders FROM SIP-TC applIndex FROM NETWORK-SERVICES-MIB InetPortNumber FROM INET-ADDRESS-MIB; sipCommonMIB MODULE-IDENTITY LAST-UPDATED "200407160000Z" 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 Lingle, et al. Expires January 14, 2005 [Page 13] Internet-Draft SIP MIB Modules July 2004 P.O. Box 14987 Research Triangle Park, NC 27709 USA email: klingle@cisco.com phone: +1 919 392 2029 Co-editor Joon Maeng postal: email: jmaeng@austin.rr.com phone: Co-editor Dave Walker postal: email: drwalker@rogers.com phone: Co-editor Jean-Francois Mule CableLabs postal: 858 Coal Creek Circle 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/Redirect Servers, and Registrars. Objects specific to each of these entities MAY be managed using entity specific MIBs defined in other modules. User Agent (UA): A logical entity that can act as both Lingle, et al. Expires January 14, 2005 [Page 14] Internet-Draft SIP MIB Modules July 2004 a user agent client and user agent server. User Agent Client (UAC): A user agent client is a logical entity that creates a new request, and then uses the client transaction state machinery to send it. The role of UAC lasts only for the duration of that transaction. In other words, if a piece of software initiates a request, it acts as a UAC for the duration of that transaction. If it receives a request later, it assumes the role of a user agent server for the processing of that transaction. User Agent Server (UAS): A user agent server is a logical entity that generates a response to a SIP request. The response accepts, rejects, or redirects the request. This role lasts only for the duration of that transaction. In other words, if a piece of software responds to a request, it acts as a UAS for the duration of that transaction. If it generates a request later, it assumes the role of a user agent client for the processing of that transaction. Proxy, Proxy Server: An intermediary entity that acts as both a server and a client for the purpose of making requests on behalf of other clients. A proxy server primarily plays the role of routing, which means its job is to ensure that a request is sent to another entity 'closer' to the targeted user. Proxies are also useful for enforcing policy. A proxy interprets, and, if necessary, rewrites specific parts of a request message before forwarding it. Redirect Server: A redirect server is a user agent server that generates 3xx responses to requests it receives, directing the client to contact an alternate set of URIs. Registrar: A registrar is a server that accepts REGISTER requests and places the information it receives in those requests into the location service for the domain it handles. Copyright (C) The Internet Society (2004). 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 "200407160000Z" 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 Lingle, et al. Expires January 14, 2005 [Page 15] Internet-Draft SIP MIB Modules July 2004 -- 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 } -- Expires header configuration sipCommonCfgExpires OBJECT IDENTIFIER ::= { sipCommonMIBObjects 3 } -- SIP message summary statistics sipCommonStatsSummary OBJECT IDENTIFIER ::= { sipCommonMIBObjects 4 } -- Per method statistics sipCommonStatsMethod OBJECT IDENTIFIER ::= { sipCommonMIBObjects 5 } -- Per Status code or status code class statistics sipCommonStatusCode OBJECT IDENTIFIER ::= { sipCommonMIBObjects 6 } -- Transaction statistics sipCommonStatsTrans OBJECT IDENTIFIER ::= { sipCommonMIBObjects 7 } -- Method retry statistics sipCommonStatsRetry OBJECT IDENTIFIER ::= { sipCommonMIBObjects 8 } -- Other statistics sipCommonStatsOther OBJECT IDENTIFIER ::= { sipCommonMIBObjects 9 } -- Accessible-for-notify objects sipCommonNotifObjects OBJECT IDENTIFIER ::= { sipCommonMIBObjects 10 } -- -- Common Configuration Objects -- sipCommonCfgTable OBJECT-TYPE SYNTAX SEQUENCE OF SipCommonCfgEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the common configuration objects Lingle, et al. Expires January 14, 2005 [Page 16] Internet-Draft SIP MIB Modules July 2004 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, sipMaxTransactions Unsigned32, sipServiceNotifEnable BITS, sipEntityType SipEntityRole } 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 } sipServiceOperStatus OBJECT-TYPE SYNTAX INTEGER { Lingle, et al. Expires January 14, 2005 [Page 17] Internet-Draft SIP MIB Modules July 2004 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), quiesceDialogs(5), quiesceApplication(6) Lingle, et al. Expires January 14, 2005 [Page 18] Internet-Draft SIP MIB Modules July 2004 } 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. quiesceDialogs : Enable quiescence mode. Stop accepting any new SIP dialogs. Stop processing new transactions except for transactions associated with an existing dialog 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 entered prior to the last re-initialization of the local network management subsystem, then this object contains a Lingle, et al. Expires January 14, 2005 [Page 19] Internet-Draft SIP MIB Modules July 2004 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 } sipMaxTransactions OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the maximum number of simultaneous transactions that the SIP entity can manage. In general the value of this object SHOULD reflect a level of transaction processing that is considered high enough to impact the systems CPU and/or memory resources to the point of deteriorating SIP call processing but not high enough to cause catastrophic system failure." ::= { sipCommonCfgEntry 7 } sipServiceNotifEnable OBJECT-TYPE SYNTAX BITS { sipServiceColdStart(0), 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. Lingle, et al. Expires January 14, 2005 [Page 20] Internet-Draft SIP MIB Modules July 2004 If notifications are supported, this object's default value SHOULD reflect sipServiceColdStart and sipServiceWarmStart enabled and sipServiceStatusChanged disabled." ::= { sipCommonCfgEntry 8 } sipEntityType OBJECT-TYPE SYNTAX SipEntityRole MAX-ACCESS read-only STATUS current DESCRIPTION " This object identifies the list of SIP entities this row is related to. It is defined as a bit map. Each bit represents a type of SIP entity. If a bit has value 1, the SIP entity represented by this row plays the role of this entity type. If a bit has value 0, the SIP entity represented by this row does not act as this entity type Combinations of bits can be set when the SIP entity plays multiple SIP roles." ::= { sipCommonCfgEntry 9 } -- -- Support for multiple ports -- sipPortTable OBJECT-TYPE SYNTAX SEQUENCE OF SipPortEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "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 Lingle, et al. Expires January 14, 2005 [Page 21] Internet-Draft SIP MIB Modules July 2004 NETWORK-SERVICES-MIB (RFC 2788)." INDEX { applIndex, sipPort } ::= { sipPortTable 1 } SipPortEntry ::= SEQUENCE { sipPort InetPortNumber, sipTransportRcv SipTransportProtocol } 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-only 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 is currently being used. If a bit has value 0, then that transport protocol is currently not being used." ::= { sipPortEntry 2 } -- -- Support for SIP option tags (SIP extensions). -- SIP extensions MAY be supported or required by SIP entities. -- sipOptionTagTable OBJECT-TYPE SYNTAX SEQUENCE OF SipOptionTagEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains a list of the SIP option tags (SIP extensions) that either required, supported, or unsupported by the SIP entity. These option tags are used in the Require, Proxy-Require, Supported and Unsupported header fields. Lingle, et al. Expires January 14, 2005 [Page 22] Internet-Draft SIP MIB Modules July 2004 Example: if a user agent client supports and requires the server to support reliability of provisional responses, this table contains a row with the string '100rel' in sipOptionTag and the value 0xA0 in sipOptionTagHeaderField. 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, Sections 19.2, 20.32, 20.29, 20.37, and 20.40" ::= { sipCommonCfgBase 3 } sipOptionTagEntry OBJECT-TYPE SYNTAX SipOptionTagEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A particular SIP option tag (extension) supported or unsupported by the SIP entity, and which may be supported or 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, sipOptionTagIndex } ::= { sipOptionTagTable 1 } SipOptionTagEntry ::= SEQUENCE { sipOptionTagIndex Unsigned32, sipOptionTag SnmpAdminString, sipOptionTagHeaderField SipOptionTagHeaders } sipOptionTagIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION Lingle, et al. Expires January 14, 2005 [Page 23] Internet-Draft SIP MIB Modules July 2004 "This object uniquely identifies a conceptual row in the table." ::= { sipOptionTagEntry 1 } sipOptionTag OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the SIP option tag. The option tag names are registered with IANA and available at http://www.iana.org." ::= { sipOptionTagEntry 2 } sipOptionTagHeaderField OBJECT-TYPE SYNTAX SipOptionTagHeaders MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates whether the SIP option tag is supported (Supported header), unsupported (Unsupported header), required (Require or Proxy-Require header) by the SIP entity. A SIP option tag may be both supported and required." ::= { sipOptionTagEntry 3 } -- -- Supported SIP Methods -- sipMethodSupportedTable OBJECT-TYPE SYNTAX SEQUENCE OF SipMethodSupportedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains a list of methods supported by each SIP entity in this system. This MAY include, but is not limited 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 can 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. From a protocol point of view, the list of methods advertised by the SIP entity in the Allow header (Section Lingle, et al. Expires January 14, 2005 [Page 24] Internet-Draft SIP MIB Modules July 2004 20.5 of RFC 3261) MUST be consistent with the methods reflected in this table." ::= { sipCommonCfgBase 4 } sipMethodSupportedEntry OBJECT-TYPE SYNTAX SipMethodSupportedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A particular 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, sipMethodSupportedIndex } ::= { sipMethodSupportedTable 1 } SipMethodSupportedEntry ::= SEQUENCE { sipMethodSupportedIndex SipMethodIdentifier, sipMethodName SnmpAdminString } sipMethodSupportedIndex OBJECT-TYPE SYNTAX SipMethodIdentifier MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object uniquely identifies a conceptual row in the table and reflects an assigned number used to identifier a specific SIP method. This identifier is suitable for referenceing the associated method throughout this and other MIBs supported by this managed system." ::= { sipMethodSupportedEntry 1 } sipMethodName OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the supported method's name. Lingle, et al. Expires January 14, 2005 [Page 25] Internet-Draft SIP MIB Modules July 2004 The method name MUST be all upper case (eg, 'FOO')." ::= { sipMethodSupportedEntry 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, Lingle, et al. Expires January 14, 2005 [Page 26] Internet-Draft SIP MIB Modules July 2004 sipCfgTimerT4 Unsigned32 } 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 } Lingle, et al. Expires January 14, 2005 [Page 27] Internet-Draft SIP MIB Modules July 2004 ::= { sipCommonCfgTimerEntry 3 } 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" Lingle, et al. Expires January 14, 2005 [Page 28] Internet-Draft SIP MIB Modules July 2004 DEFVAL { 32000 } ::= { sipCommonCfgTimerEntry 6 } 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. Lingle, et al. Expires January 14, 2005 [Page 29] Internet-Draft SIP MIB Modules July 2004 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." 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 Lingle, et al. Expires January 14, 2005 [Page 30] Internet-Draft SIP MIB Modules July 2004 "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." 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 } -- -- Common Statistics Objects -- -- Lingle, et al. Expires January 14, 2005 [Page 31] Internet-Draft SIP MIB Modules July 2004 -- 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 "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 Lingle, et al. Expires January 14, 2005 [Page 32] Internet-Draft SIP MIB Modules July 2004 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 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. Lingle, et al. Expires January 14, 2005 [Page 33] Internet-Draft SIP MIB Modules July 2004 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, each branch counts as a single transaction. For a transaction stateless Proxy Server, this counter is always 0." ::= { 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, sipStatsMethod } Lingle, et al. Expires January 14, 2005 [Page 34] Internet-Draft SIP MIB Modules July 2004 ::= { sipMethodStatsTable 1 } SipMethodStatsEntry ::= SEQUENCE { sipStatsMethod SipMethodIdentifier, sipStatsOutbounds Counter32, sipStatsInbounds Counter32 } sipStatsMethod OBJECT-TYPE SYNTAX SipMethodIdentifier MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object uniquely identifies the SIP method related to the objects in a particular row." ::= { sipMethodStatsEntry 1 } sipStatsOutbounds OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of requests sent by the SIP entity, excluding retransmissions. Retransmissions are counted separately and are not reflected in this counter." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 2 } sipStatsInbounds OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of requests received by the SIP entity." REFERENCE "RFC 3261, Section 7.1" ::= { sipMethodStatsEntry 3 } -- -- Support for specific status codes -- sipStatusCodesTable OBJECT-TYPE Lingle, et al. Expires January 14, 2005 [Page 35] Internet-Draft SIP MIB Modules July 2004 SYNTAX SEQUENCE OF SipStatusCodesEntry 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 Lingle, et al. Expires January 14, 2005 [Page 36] Internet-Draft SIP MIB Modules July 2004 DESCRIPTION "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 Lingle, et al. Expires January 14, 2005 [Page 37] Internet-Draft SIP MIB Modules July 2004 table augments that table and utilizes the same index 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 } Lingle, et al. Expires January 14, 2005 [Page 38] Internet-Draft SIP MIB Modules July 2004 ::= { sipStatusCodeNotifEntry 1 } 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'." Lingle, et al. Expires January 14, 2005 [Page 39] Internet-Draft SIP MIB Modules July 2004 DEFVAL { triggered } ::= { sipStatusCodeNotifEntry 2 } 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 Lingle, et al. Expires January 14, 2005 [Page 40] Internet-Draft SIP MIB Modules July 2004 STATUS current DESCRIPTION "This table contains information on the transactions 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, each branch counts as a single transaction corresponding to the entity identified by applIndex." ::= { sipCurrentTransEntry 1 } -- -- SIP Retry Statistics -- -- This group contains various statistic objects about -- retransmission counts. Lingle, et al. Expires January 14, 2005 [Page 41] Internet-Draft SIP MIB Modules July 2004 -- sipCommonStatsRetryTable OBJECT-TYPE 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, sipStatsRetryMethod } ::= { sipCommonStatsRetryTable 1 } SipCommonStatsRetryEntry ::= SEQUENCE { sipStatsRetryMethod SipMethodIdentifier, sipStatsRetries Counter32, sipStatsRetryFinalResponses Counter32, sipStatsRetryNonFinalResponses Counter32 } sipStatsRetryMethod OBJECT-TYPE SYNTAX SipMethodIdentifier MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object uniquely identifies the SIP method related to the objects in a row." ::= { sipCommonStatsRetryEntry 1 } sipStatsRetries OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of INVITE retries Lingle, et al. Expires January 14, 2005 [Page 42] Internet-Draft SIP MIB Modules July 2004 that have been sent by the SIP entity." ::= { sipCommonStatsRetryEntry 2 } sipStatsRetryFinalResponses OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object reflects the total number of Final Response retries that have been sent by the SIP entity." ::= { sipCommonStatsRetryEntry 3 } 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 4 } -- -- Other Common Statistics -- sipOtherStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF SipOtherStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains other common statistics supported by each SIP entity in this system." ::= { sipCommonStatsOther 1 } sipOtherStatsEntry OBJECT-TYPE SYNTAX SipOtherStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Information on a particular SIP entity's other common 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 } Lingle, et al. Expires January 14, 2005 [Page 43] Internet-Draft SIP MIB Modules July 2004 ::= { sipOtherStatsTable 1 } SipOtherStatsEntry ::= SEQUENCE { sipNumUnsupportedUris Counter32, sipNumUnsupportedMethods Counter32, sipOtherwiseDiscardedMsgs Counter32 } sipNumUnsupportedUris OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of RequestURIs received with unsupported scheme. A server normally responds to such requests with a 400 Bad Request status code." ::= { sipOtherStatsEntry 1 } sipNumUnsupportedMethods OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of SIP requests received with unsupported methods. A server normally responds to such requests with a 501 (Not Implemented) or 405 (Method Not Allowed)." ::= { sipOtherStatsEntry 2 } sipOtherwiseDiscardedMsgs OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of SIP messages received that for any number of reasons was discarded without a response." ::= { sipOtherStatsEntry 3 } -- -- Notification related objects -- -- -- Status code related notification objects. -- sipStatusCodeNotifTo OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS accessible-for-notify Lingle, et al. Expires January 14, 2005 [Page 44] Internet-Draft SIP MIB Modules July 2004 STATUS current DESCRIPTION "This object contains the value of the To header in the message containing the status code that caused the notification. The header name will be part of this object value. For example, 'To: Watson ." ::= { sipCommonNotifObjects 1 } sipStatusCodeNotifFrom OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS accessible-for-notify STATUS current DESCRIPTION "This object contains the value of the From header in the message containing the status code that caused the notification. The header name will be part of this object value. For example, 'From: Watson '." ::= { sipCommonNotifObjects 2 } sipStatusCodeNotifCallId OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS accessible-for-notify STATUS current DESCRIPTION "This object contains the value of the CallId in the message containing the status code that caused the notification. The header name will be part of this object value. For example, 'Call-ID: 5551212@information.com'." ::= { sipCommonNotifObjects 3 } sipStatusCodeNotifCSeq OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS accessible-for-notify STATUS current DESCRIPTION "This object contains the CSeq value in the message containing the status code that caused the notification. The header name will be part of this object value. For example, 'CSeq: 1722 INVITE'." ::= { sipCommonNotifObjects 4 } -- -- General notification related objects. -- sipNotifApplIndex OBJECT-TYPE Lingle, et al. Expires January 14, 2005 [Page 45] Internet-Draft SIP MIB Modules July 2004 SYNTAX Unsigned32 (1..2147483647) MAX-ACCESS accessible-for-notify STATUS current DESCRIPTION "This object contains the applIndex as described in RFC 2788. This object is created in order to allow a variable binding containing a value of applIndex in a notification." ::= { sipCommonNotifObjects 5 } sipNotifSequenceNumber OBJECT-TYPE SYNTAX Unsigned32 (1..2147483647) MAX-ACCESS accessible-for-notify STATUS current DESCRIPTION "This object contains a sequence number for each notification generated by this SIP entity. Each notification SHOULD have a unique sequence number. A network manager can use this information to determine whether notifications from a particular SIP entity have been missed. The value of this object MUST start at 1 and increase by one with each generated notification. If a system restarts, the sequence number MAY start again from 1." ::= { sipCommonNotifObjects 6 } -- -- Notifications -- sipStatusCodeNotif NOTIFICATION-TYPE OBJECTS { sipNotifSequenceNumber, sipNotifApplIndex, sipStatusCodeNotifTo, sipStatusCodeNotifFrom, sipStatusCodeNotifCallId, sipStatusCodeNotifCSeq, sipStatusCodeIns, sipStatusCodeOuts } STATUS current DESCRIPTION "Signifies that a specific status code has been sent or received by the system." ::= { sipCommonMIBNotifs 1 } sipStatusCodeThreshExceededInNotif NOTIFICATION-TYPE Lingle, et al. Expires January 14, 2005 [Page 46] Internet-Draft SIP MIB Modules July 2004 OBJECTS { sipNotifSequenceNumber, sipNotifApplIndex, sipStatusCodeIns } STATUS current DESCRIPTION "Signifies that a specific status code was found to have been received by the system enough to exceed the configured threshold. This notification can be used as an early warning mechanism in lieu of using sipStatusCodeNotif." ::= { sipCommonMIBNotifs 2 } sipStatusCodeThreshExceededOutNotif NOTIFICATION-TYPE OBJECTS { sipNotifSequenceNumber, sipNotifApplIndex, sipStatusCodeOuts } STATUS current DESCRIPTION "Signifies that a specific status code was found to have been sent by the system enough to exceed the configured threshold. This notification can be used as an early warning mechanism in lieu of using sipStatusCodeNotif." ::= { sipCommonMIBNotifs 3 } sipServiceColdStart NOTIFICATION-TYPE OBJECTS { sipNotifSequenceNumber, sipNotifApplIndex, sipServiceStartTime } STATUS current DESCRIPTION "Signifies that the SIP service has reinitialized itself or started for the first time. This SHOULD result from a hard 'down' to 'up' administrative status change. The configuration or behavior of the service MAY be altered." ::= { sipCommonMIBNotifs 4 } sipServiceWarmStart NOTIFICATION-TYPE OBJECTS { sipNotifSequenceNumber, Lingle, et al. Expires January 14, 2005 [Page 47] Internet-Draft SIP MIB Modules July 2004 sipNotifApplIndex, sipServiceLastChange } STATUS current DESCRIPTION "Signifies that the SIP service has reinitialized itself and is restarting after an adminstrative 'reset'. The configuration or behavior of the service MAY be altered." ::= { sipCommonMIBNotifs 5 } sipServiceStatusChanged NOTIFICATION-TYPE OBJECTS { sipNotifSequenceNumber, sipNotifApplIndex, sipServiceLastChange, sipServiceOperStatus } STATUS current DESCRIPTION "Signifies that the SIP service operational status has changed." ::= { sipCommonMIBNotifs 6 } -- -- Conformance -- sipCommonMIBCompliances OBJECT IDENTIFIER ::= { sipCommonMIBConform 1 } sipCommonMIBGroups OBJECT IDENTIFIER ::= { sipCommonMIBConform 2 } -- -- Compliance Statements -- sipCommonCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SIP entities." MODULE -- this module MANDATORY-GROUPS { sipCommonConfigGroup, sipCommonStatsGroup } GROUP sipCommonConfigTimerGroup Lingle, et al. Expires January 14, 2005 [Page 48] Internet-Draft SIP MIB Modules July 2004 DESCRIPTION "This group is OPTIONAL. A SIP entity can elect to not provide any timer configuration." GROUP sipCommonStatsRetryGroup DESCRIPTION "This group is OPTIONAL. A SIP entity can elect to not provide any retry statistics." GROUP sipCommonNotifGroup DESCRIPTION "This group is OPTIONAL. A SIP entity can elect to not provide any notifications. If implemented, the sipCommonStatusCodeNotifGroup and sipCommonNotifObjectsGroup MUST also be implemented." GROUP sipCommonStatusCodeNotifGroup DESCRIPTION "This group is OPTIONAL. A SIP entity can elect to not provide any notifications. If implemented, the sipCommonNotifGroup and sipCommonNotifObjectsGroup MUST also be implemented." GROUP sipCommonNotifObjectsGroup DESCRIPTION "This group is OPTIONAL. A SIP entity can elect to not provide any notifications. If implemented, the sipCommonStatusCodeNotifGroup and sipCommonNotifGroup MUST also be implemented." OBJECT sipCfgTimerA MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerB MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerC MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." Lingle, et al. Expires January 14, 2005 [Page 49] Internet-Draft SIP MIB Modules July 2004 OBJECT sipCfgTimerD MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerE MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerF MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerG MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerH MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerI MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerJ MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerK MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." Lingle, et al. Expires January 14, 2005 [Page 50] Internet-Draft SIP MIB Modules July 2004 OBJECT sipCfgTimerT1 MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerT2 MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." OBJECT sipCfgTimerT4 MIN-ACCESS read-only DESCRIPTION "Implementations may not allow the modification of SIP timers; this may be read-only." ::= { sipCommonMIBCompliances 1 } -- -- Units of Conformance -- sipCommonConfigGroup OBJECT-GROUP OBJECTS { sipProtocolVersion, sipServiceOperStatus, sipServiceAdminStatus, sipServiceStartTime, sipServiceLastChange, sipTransportRcv, sipOptionTag, sipOptionTagHeaderField, sipOrganization, sipMaxTransactions, sipServiceNotifEnable, sipEntityType, sipMethodName } STATUS current DESCRIPTION "A collection of objects providing configuration common to all SIP enities." ::= { sipCommonMIBGroups 1 } sipCommonConfigTimerGroup OBJECT-GROUP OBJECTS { sipCfgTimerA, Lingle, et al. Expires January 14, 2005 [Page 51] Internet-Draft SIP MIB Modules July 2004 sipCfgTimerB, sipCfgTimerC, sipCfgTimerD, sipCfgTimerE, sipCfgTimerF, sipCfgTimerG, sipCfgTimerH, sipCfgTimerI, sipCfgTimerJ, sipCfgTimerK, sipCfgTimerT1, sipCfgTimerT2, sipCfgTimerT4 } STATUS current DESCRIPTION "A collection of objects providing timer configuration common to all SIP enities." ::= { sipCommonMIBGroups 2 } sipCommonStatsGroup OBJECT-GROUP OBJECTS { sipSummaryInRequests, sipSummaryOutRequests, sipSummaryInResponses, sipSummaryOutResponses, sipSummaryTotalTransactions, sipStatsOutbounds, sipStatsInbounds, sipStatusCodeIns, sipStatusCodeOuts, sipStatusCodeRowStatus, sipCurrentTransactions, sipNumUnsupportedUris, sipNumUnsupportedMethods, sipOtherwiseDiscardedMsgs } STATUS current DESCRIPTION "A collection of objects providing statistics common to all SIP entities." ::= { sipCommonMIBGroups 3 } sipCommonStatsRetryGroup OBJECT-GROUP OBJECTS { sipStatsRetries, sipStatsRetryFinalResponses, sipStatsRetryNonFinalResponses Lingle, et al. Expires January 14, 2005 [Page 52] Internet-Draft SIP MIB Modules July 2004 } STATUS current DESCRIPTION "A collection of objects providing retry statistics." ::= { sipCommonMIBGroups 4 } sipCommonNotifGroup NOTIFICATION-GROUP NOTIFICATIONS { sipStatusCodeNotif, sipStatusCodeThreshExceededInNotif, sipStatusCodeThreshExceededOutNotif, sipServiceColdStart, sipServiceWarmStart, sipServiceStatusChanged } STATUS current DESCRIPTION "A collection of notifications common to all SIP entities." ::= { sipCommonMIBGroups 5 } sipCommonStatusCodeNotifGroup OBJECT-GROUP OBJECTS { sipStatusCodeNotifSend, sipStatusCodeNotifEmitMode, sipStatusCodeNotifThresh, sipStatusCodeNotifInterval } STATUS current DESCRIPTION "A collection of objects related to controlling and attribution of notifications common to all SIP entities." ::= { sipCommonMIBGroups 6 } sipCommonNotifObjectsGroup OBJECT-GROUP OBJECTS { sipStatusCodeNotifTo, sipStatusCodeNotifFrom, sipStatusCodeNotifCallId, sipStatusCodeNotifCSeq, sipNotifApplIndex, sipNotifSequenceNumber } STATUS current DESCRIPTION "A collection of accessible-for-notify objects related to the notification defined in this MIB module." ::= { sipCommonMIBGroups 7 } Lingle, et al. Expires January 14, 2005 [Page 53] Internet-Draft SIP MIB Modules July 2004 END 7.3 SIP User Agent MIB Module SIP-UA-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Unsigned32, mib-2 FROM SNMPv2-SMI MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF RowStatus FROM SNMPv2-TC applIndex FROM NETWORK-SERVICES-MIB InetAddressType, InetAddress FROM INET-ADDRESS-MIB SipEntityRole FROM SIP-TC; sipUAMIB MODULE-IDENTITY LAST-UPDATED "200407160000Z" 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 Lingle, et al. Expires January 14, 2005 [Page 54] Internet-Draft SIP MIB Modules July 2004 postal: email: jmaeng@austin.rr.com phone: Co-editor Dave Walker postal: email: drwalker@rogers.com phone: Co-editor Jean-Francois Mule CableLabs postal: 858 Coal Creek Circle Louisville, CO 80027 USA email: jf.mule@cablelabs.com phone: +1 303 661 3708 " DESCRIPTION "Session Initiation Protocol (SIP) User Agent (UA) MIB module. 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). 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. Copyright (C) The Internet Society (2004). 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 "200407160000Z" DESCRIPTION "Initial version of the IETF SIP-UA-MIB module. This version published as part of RFC XXXX." Lingle, et al. Expires January 14, 2005 [Page 55] Internet-Draft SIP MIB Modules July 2004 -- RFC Ed: replace XXXX with actual RFC number and remove this note ::= { mib-2 xx } -- RFC Ed: replace xx with actual IANA assigned number -- RFC Ed: and remove these notes -- Top-Level Components of this MIB. sipUAMIBObjects OBJECT IDENTIFIER ::= { sipUAMIB 1 } sipUAMIBConform OBJECT IDENTIFIER ::= { sipUAMIB 2 } -- -- This MIB contains objects related to SIP User Agents. -- sipUACfgServer OBJECT IDENTIFIER ::= { sipUAMIBObjects 1 } -- -- SIP Server Configuration -- sipUACfgServerTable OBJECT-TYPE SYNTAX SEQUENCE OF SipUACfgServerEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains SIP server configuration objects applicable to each SIP user agent in this system." ::= { sipUACfgServer 1 } sipUACfgServerEntry OBJECT-TYPE SYNTAX SipUACfgServerEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of server configuration. Each row represents those objects for a particular SIP user agent present in this system. applIndex is used to uniquely identify these instances of SIP user agents and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The same value of applIndex used in the corresponding SIP-COMMON-MIB is used here. The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex, sipUACfgServerIndex } ::= { sipUACfgServerTable 1 } SipUACfgServerEntry ::= SEQUENCE { sipUACfgServerIndex Unsigned32, Lingle, et al. Expires January 14, 2005 [Page 56] Internet-Draft SIP MIB Modules July 2004 sipUACfgServerAddrType InetAddressType, sipUACfgServerAddr InetAddress, sipUACfgServerFunction SipEntityRole, sipUACfgServerStatus RowStatus } sipUACfgServerIndex OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS not-accessible STATUS current DESCRIPTION "A unique identifier of a server address when multiple addresses are configured by the SIP entity. If one address isn't reachable, then another can be tried." ::= { sipUACfgServerEntry 1 } sipUACfgServerAddrType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-create STATUS current DESCRIPTION "This object specifies the type of address contained in the associated instance of sipUACfgServerAddr." REFERENCE "INET-ADDRESS-MIB (RFC 3291)" ::= { sipUACfgServerEntry 2 } sipUACfgServerAddr OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-create STATUS current DESCRIPTION "This object specifies the address of a SIP server this user agent will use to proxy/redirect calls." REFERENCE "INET-ADDRESS-MIB (RFC 3291)" ::= { sipUACfgServerEntry 3 } sipUACfgServerFunction OBJECT-TYPE SYNTAX SipEntityRole MAX-ACCESS read-create STATUS current DESCRIPTION "This object specifies the function of the SIP server this user agent should communicate with: registrar, proxy (outbound proxy), etc." ::= { sipUACfgServerEntry 4 } sipUACfgServerStatus OBJECT-TYPE Lingle, et al. Expires January 14, 2005 [Page 57] Internet-Draft SIP MIB Modules July 2004 SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "This object is used to control rows in this table. 'active' : the row's information is completely populated and that information is being used by the user agent. 'notInService' : the row's address is not being used by the user agent, but will remain in the table. 'notReady' : key information is missing thus, preventing the row from being made 'active' (eg, no address specified). 'createAndGo' : only allowed if the manager also provides a varbind for sipUACfgServerAddr object in the same set operation. 'createAndWait' : not applicable. 'destroy' : the row's address will no longer be used by the user agent and the row will be removed from the table." ::= { sipUACfgServerEntry 5 } -- -- Conformance -- sipUAMIBCompliances OBJECT IDENTIFIER ::= { sipUAMIBConform 1 } sipUAMIBGroups OBJECT IDENTIFIER ::= { sipUAMIBConform 2 } -- -- Compliance Statements -- sipUACompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SIP entities." MODULE -- this module MANDATORY-GROUPS { sipUAConfigGroup } Lingle, et al. Expires January 14, 2005 [Page 58] Internet-Draft SIP MIB Modules July 2004 ::= { sipUAMIBCompliances 1 } -- -- Units of Conformance -- sipUAConfigGroup OBJECT-GROUP OBJECTS { sipUACfgServerAddrType, sipUACfgServerAddr, sipUACfgServerFunction, sipUACfgServerStatus } STATUS current DESCRIPTION "A collection of objects providing configuration for SIP User Agents." ::= { sipUAMIBGroups 1 } END 7.4 SIP Server (Registrar & Proxy/Redirect Server) MIB Module SIP-SERVER-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Counter32, Unsigned32, Gauge32, mib-2 FROM SNMPv2-SMI RowStatus, TruthValue, TimeStamp, DateAndTime FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF SnmpAdminString FROM SNMP-FRAMEWORK-MIB applIndex FROM NETWORK-SERVICES-MIB Lingle, et al. Expires January 14, 2005 [Page 59] Internet-Draft SIP MIB Modules July 2004 InetAddressType, InetAddress FROM INET-ADDRESS-MIB; sipServerMIB MODULE-IDENTITY LAST-UPDATED "200407160000Z" 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 postal: email: jmaeng@austin.rr.com phone: Co-editor Dave Walker postal: email: drwalker@rogers.com phone: Co-editor Jean-Francois Mule CableLabs postal: 858 Coal Creek Circle Louisville, CO 80027 USA email: jf.mule@cablelabs.com phone: +1 303 661 3708 " DESCRIPTION "Session Initiation Protocol (SIP) Server MIB module. SIP is an application-layer signaling protocol for creating, modifying and terminating multimedia sessions with one or more participants. These sessions Lingle, et al. Expires January 14, 2005 [Page 60] Internet-Draft SIP MIB Modules July 2004 include Internet multimedia conferences and Internet telephone calls. SIP is defined in RFC 3261 (June 2002). This MIB is defined for the management of SIP Proxy/ Redirect and Registrar Servers. 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 User Agent Server it does not accept calls. A Registrar is a server that accepts REGISTER requests. A Registrar is typically co-located with a Proxy or Redirect Server. Copyright (C) The Internet Society (2004). 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 "200407160000Z" DESCRIPTION "Initial version of the IETF SIP-SERVER-MIB module. This version published as part of RFC XXXX." -- RFC Ed: replace XXXX with actual RFC number and remove this note ::= { mib-2 yy } -- RFC Ed: replace yy with actual IANA assigned number and remove this note -- Top-Level Components of this MIB. sipServerMIBObjects OBJECT IDENTIFIER ::= { sipServerMIB 1 } sipServerMIBConform OBJECT IDENTIFIER ::= { sipServerMIB 2 } -- -- These groups contain objects common to all SIP servers. -- sipServerCfg OBJECT IDENTIFIER ::= { sipServerMIBObjects 1 } -- -- Common Server Configuration Objects -- sipServerCfgTable OBJECT-TYPE SYNTAX SEQUENCE OF SipServerCfgEntry MAX-ACCESS not-accessible STATUS current Lingle, et al. Expires January 14, 2005 [Page 61] Internet-Draft SIP MIB Modules July 2004 DESCRIPTION "This table contains configuration objects applicable to SIP Redirect and Proxy Servers." ::= { sipServerCfg 1 } sipServerCfgEntry OBJECT-TYPE SYNTAX SipServerCfgEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of common configuration. Each row represents those objects for a particular SIP server present in this system. applIndex is used to uniquely identify these instances of SIP servers and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The same value of applIndex used in the corresponding SIP-COMMON-MIB is used here. The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex } ::= { sipServerCfgTable 1 } SipServerCfgEntry ::= SEQUENCE { sipServerHostAddrType InetAddressType, sipServerHostAddr InetAddress } sipServerHostAddrType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "The type of Internet address by which the SIP server is reachable." REFERENCE "RFC 3261, Section 19.1.1" ::= { sipServerCfgEntry 1 } sipServerHostAddr OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write STATUS current DESCRIPTION "This is the host portion of a SIP URI that is assigned to the SIP server. It MAY contain a fully qualified Lingle, et al. Expires January 14, 2005 [Page 62] Internet-Draft SIP MIB Modules July 2004 domain name, or an IP address. The length of the value will depend on the type of address specified. sipServerHostAddrType formalizes the type of address given by this object. It is the users responsibility to maintain consistency between this object and the type specified by sipServerHostAddrType." REFERENCE "RFC 3261, Section 19.1.1" ::= { sipServerCfgEntry 2 } -- -- This group contains MIB objects related to SIP Proxy Servers. -- sipProxyCfg OBJECT IDENTIFIER ::= { sipServerMIBObjects 3 } sipProxyStats OBJECT IDENTIFIER ::= { sipServerMIBObjects 4 } -- -- Proxy Server Configuration -- sipProxyCfgTable OBJECT-TYPE SYNTAX SEQUENCE OF SipProxyCfgEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains configuration objects applicable to SIP Proxy Servers." ::= { sipProxyCfg 1 } sipProxyCfgEntry OBJECT-TYPE SYNTAX SipProxyCfgEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of common proxy configuration. Each row represents those objects for a particular SIP server present in this system. applIndex is used to uniquely identify these instances of SIP servers and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The same value of applIndex used in the corresponding SIP-COMMON-MIB is used here. The objects in this table entry SHOULD be non-volatile and their value SHOULD be kept at reboot." INDEX { applIndex } ::= { sipProxyCfgTable 1 } SipProxyCfgEntry ::= Lingle, et al. Expires January 14, 2005 [Page 63] Internet-Draft SIP MIB Modules July 2004 SEQUENCE { sipProxyStatefulness INTEGER, sipProxyRecursion TruthValue, sipProxyRecordRoute TruthValue, sipProxyAuthMethod BITS, sipProxyAuthRealm SnmpAdminString } sipProxyStatefulness OBJECT-TYPE SYNTAX INTEGER { stateless(1), transactionStateful(2), callStateful(3) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the default mode of operation for the Proxy Server entity. A stateless proxy is a logical entity that does not maintain the client or server transaction state machines when it processes requests. A stateless proxy forwards every request it receives downstream and every response it receives upstream. If the value of this object is stateless(1), the proxy defaults to stateless operations. A transaction stateful proxy, or simply a 'stateful proxy', is a logical entity that maintains the client and server transaction state machines during the processing of a request. A (transaction) stateful proxy is not the same as a call stateful proxy. If the value if this object is transactionStateful(2), the proxy is stateful on a transaction basis. A call stateful proxy is a logical entity if it retains state for a dialog from the initiating INVITE to the terminating BYE request. A call stateful proxy is always transaction stateful, but the converse is not necessarily true. If the value of this object is callStateful(3), the proxy is call stateful." REFERENCE "RFC 3261, Section 16" ::= { sipProxyCfgEntry 1 } sipProxyRecursion OBJECT-TYPE SYNTAX TruthValue Lingle, et al. Expires January 14, 2005 [Page 64] Internet-Draft SIP MIB Modules July 2004 MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies whether or not the Proxy performs recursive search on the Contacts provided in 3xx redirects. If the value of this object is 'true', a recursive search is performed. If the value is 'false', no search is performed, the 3xx response is sent upstream towards the source of the request." REFERENCE "RFC 3261 Sections 16.5 and 16.6" ::= { sipProxyCfgEntry 2 } sipProxyRecordRoute OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies whether or not the proxy adds itself to the Record-Route header as a default action. This header is used to list the proxies that insist on being in the signaling path for subsequent requests related to the call-leg. If the value of this object is 'true', the proxy adds itself to the end of the Record-Route header, creating the header if required. If the value is 'false', the proxy does not add itself to the Record-Route header." REFERENCE "RFC 3261, Section 20.30" ::= { sipProxyCfgEntry 3 } -- -- Security -- sipProxyAuthMethod OBJECT-TYPE SYNTAX BITS { none(0), tls(1), digest(2), smime(3) } MAX-ACCESS read-write STATUS current DESCRIPTION Lingle, et al. Expires January 14, 2005 [Page 65] Internet-Draft SIP MIB Modules July 2004 "This object specifies the authentication methods that MAY be used to authenticate request originators. bit 0 no authentication is performed bit 1 TLS is used bit 2 HTTP Digest is used bit 3 S/MIME is used." REFERENCE "RFC 3261 Sections 22, 23, 26, 26.2.3" ::= { sipProxyCfgEntry 4 } sipProxyAuthRealm OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the realm used in Proxy-Authenticate headers. Note that this MAY need to be stored per user." REFERENCE "RFC 3261, Section 22.1" ::= { sipProxyCfgEntry 5 } -- -- Proxy Server Statistics -- sipProxyStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF SipProxyStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the statistics objects applicable to all SIP Proxy Servers in this system." ::= { sipProxyStats 1 } sipProxyStatsEntry OBJECT-TYPE SYNTAX SipProxyStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of summary statistics. Each row represents those objects for a particular SIP server present in this system. applIndex is used to uniquely identify these instances of SIP servers and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The same value of Lingle, et al. Expires January 14, 2005 [Page 66] Internet-Draft SIP MIB Modules July 2004 applIndex used in the corresponding SIP-COMMON-MIB is used here." INDEX { applIndex } ::= { sipProxyStatsTable 1 } SipProxyStatsEntry ::= SEQUENCE { sipNumProxyRequireFailures Counter32 } sipNumProxyRequireFailures OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the number of occurrences of unsupported options being specified in received Proxy- Require headers. Such occurrences result in a 420 Bad Extension status code being returned." ::= { sipProxyStatsEntry 1 } -- -- This group contains MIB objects related to SIP Registrars. -- sipRegCfg OBJECT IDENTIFIER ::= { sipServerMIBObjects 5 } sipRegStats OBJECT IDENTIFIER ::= { sipServerMIBObjects 6 } -- -- Registrar Configuration -- sipRegCfgTable OBJECT-TYPE SYNTAX SEQUENCE OF SipRegCfgEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains configuration objects applicable SIP Registrars." ::= { sipRegCfg 1 } sipRegCfgEntry OBJECT-TYPE SYNTAX SipRegCfgEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of common Registrar configuration. Each row represents those objects for a particular SIP Lingle, et al. Expires January 14, 2005 [Page 67] Internet-Draft SIP MIB Modules July 2004 server present in this system. applIndex is used to uniquely identify these instances of SIP servers and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The same value of applIndex used in the corresponding SIP-COMMON-MIB is used here." INDEX { applIndex } ::= { sipRegCfgTable 1 } SipRegCfgEntry ::= SEQUENCE { sipRegAllowThirdParty TruthValue, sipRegMaxContactExpiryDuration Unsigned32, sipRegMaxUsers Unsigned32, sipRegCurrentUsers Gauge32, sipRegDfltRegActiveInterval Unsigned32 } sipRegAllowThirdParty OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies whether or not the Registrar SHOULD allow third party registrations. In third-party registration, the entity issuing the request (in the From header) is different from the entity being registered (in the To header) to whom the provided Contact information applies. If the value of this object is 'true', the Registrar allows third-party registrations. If the value is 'false', third-party registrations are rejected: a 403 (Forbidden) status code is returned to the requester. This object SHOULD be non-volatile and its value SHOULD be kept at reboot." REFERENCE "RFC 3261, Section 10.2" ::= { sipRegCfgEntry 1 } sipRegMaxContactExpiryDuration OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the maximum expiry that may be requested by a User Agent for a particular Contact. Lingle, et al. Expires January 14, 2005 [Page 68] Internet-Draft SIP MIB Modules July 2004 User Agents can specify expiry using either an Expiry header in a REGISTER request, or using an Expires parameter in a Contact header in a REGISTER request. If the value requested by the User Agent is greater than the value of this object, then the contact information is given the duration specified by this object, and that duration is indicated to the User Agent in the response." ::= { sipRegCfgEntry 2 } sipRegMaxUsers OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the maximum number of users that the Registrar supports. The current number of users is reflected by sipRegCurrentUsers." ::= { sipRegCfgEntry 3 } sipRegCurrentUsers OBJECT-TYPE SYNTAX Gauge32 (0..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the number of users currently registered with the Registrar." ::= { sipRegCfgEntry 4 } sipRegDfltRegActiveInterval OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This object specifies the default time interval the Registrar considers registrations to be active. The value is used to compute the Expires header in the REGISTER response. If a user agent requests a time interval shorter than specified by this object, the Registrar SHOULD honor that request. If a Contact entry does not have an 'expires' parameter, the value of the Expires header field is used instead. If a Contact entry has no 'expires' parameter and no the Expires header field is present, the value of this object is used as the default value. This object SHOULD be non-volatile and its value SHOULD be kept at reboot." REFERENCE "RFC 3261, Section 10.2" Lingle, et al. Expires January 14, 2005 [Page 69] Internet-Draft SIP MIB Modules July 2004 ::= { sipRegCfgEntry 5 } -- -- Per User Information -- sipRegUserTable OBJECT-TYPE SYNTAX SEQUENCE OF SipRegUserEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains information on all users registered to each Registrar in this system." ::= { sipRegCfg 2 } sipRegUserEntry OBJECT-TYPE SYNTAX SipRegUserEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This entry contains information for a single user registered to this Registrar. Each row represents those objects for a particular SIP server present in this system. applIndex is used to uniquely identify these instances of SIP servers and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The same value of applIndex used in the corresponding SIP-COMMON-MIB is used here." INDEX { applIndex, sipUserIndex } ::= { sipRegUserTable 1 } SipRegUserEntry ::= SEQUENCE { sipUserIndex Unsigned32, sipUserUri SnmpAdminString, sipUserAuthenticationFailures Counter32, sipUserTableRowStatus RowStatus } sipUserIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object uniquely identifies a conceptual row in the table." Lingle, et al. Expires January 14, 2005 [Page 70] Internet-Draft SIP MIB Modules July 2004 ::= { sipRegUserEntry 1 } sipUserUri OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-create STATUS current DESCRIPTION "This object contains the user's address-of-record. It is the main form by which the Registrar knows the user. The format is typically 'user@domain'. It is contained in the To header for all REGISTER requests." ::= { sipRegUserEntry 2 } sipUserAuthenticationFailures OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains a count of the number of times the user has failed authentication." ::= { sipRegUserEntry 3 } sipUserTableRowStatus 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 remotely by a manager." ::= { sipRegUserEntry 4 } -- -- Per Contact Information -- sipContactTable OBJECT-TYPE SYNTAX SEQUENCE OF SipContactEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains information on every location where a registered user (specified by sipUserIndex) wishes to be found (i.e. the user has provided Contact information to each SIP Registrar in this system)." ::= { sipRegCfg 3 } sipContactEntry OBJECT-TYPE SYNTAX SipContactEntry MAX-ACCESS not-accessible Lingle, et al. Expires January 14, 2005 [Page 71] Internet-Draft SIP MIB Modules July 2004 STATUS current DESCRIPTION "This entry contains information for a single Contact. Multiple contacts may exist for a single user. Each row represents those objects for a particular SIP server present in this system. applIndex is used to uniquely identify these instances of SIP servers and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The same value of applIndex used in the corresponding SIP-COMMON-MIB is used here." INDEX { applIndex, sipUserIndex, sipContactIndex } ::= { sipContactTable 1 } SipContactEntry ::= SEQUENCE { sipContactIndex Unsigned32, sipContactDisplayName SnmpAdminString, sipContactURI SnmpAdminString, sipContactLastUpdated TimeStamp, sipContactExpiry DateAndTime, sipContactPreference SnmpAdminString } sipContactIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Along with the sipUserIndex, this object uniquely identifies a conceptual row in the table." ::= { sipContactEntry 1 } sipContactDisplayName OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the display name for the Contact. For example, 'Santa at Home', or 'Santa on his Sled', corresponding to contact URIs of sip:BigGuy@sip.northpole.ca or sip:sclaus817@sip.mobile.com, respectively." ::= { sipContactEntry 2 } sipContactURI OBJECT-TYPE SYNTAX SnmpAdminString Lingle, et al. Expires January 14, 2005 [Page 72] Internet-Draft SIP MIB Modules July 2004 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains either a SIP URI where the user can be contacted. This URI is normally returned to a client from a Redirect Server, or is used as the RequestURI in a SIP request line for requests forwarded by a proxy." ::= { sipContactEntry 3 } sipContactLastUpdated OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the time when this contact information was accepted. If the contact information is updated via a subsequent REGISTER of the same information, this object is also updated." ::= { sipContactEntry 4 } sipContactExpiry OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the date and time when the contact information will no longer be valid. Such times may be specified by the user at registration (Expires header or expiry parameter in the Contact information), or a system default can be applied." ::= { sipContactEntry 5 } sipContactPreference OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates a relative preference for the particular Contact header field value compared to other bindings for this address-of-record. A registering user may provide this preference as a 'qvalue'parameter in the Contact header. The format of this item is a decimal number between 0 and 1 (for example 0.9). Higher values indicate locations preferred by the user." REFERENCE Lingle, et al. Expires January 14, 2005 [Page 73] Internet-Draft SIP MIB Modules July 2004 "RFC 3261, Section 10.2.1.2, 16.6 and 20.10" ::= { sipContactEntry 6 } -- -- Registrar Statistics -- sipRegStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF SipRegStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the summary statistics objects applicable to all SIP Registrars in this system." ::= { sipRegStats 1 } sipRegStatsEntry OBJECT-TYPE SYNTAX SipRegStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of summary statistics. Each row represents those objects for a particular SIP server present in this system. applIndex is used to uniquely identify these instances of SIP servers and correlate them through the common framework of the NETWORK-SERVICES-MIB (RFC 2788). The same value of applIndex used in the corresponding SIP-COMMON-MIB is used here." INDEX { applIndex } ::= { sipRegStatsTable 1 } SipRegStatsEntry ::= SEQUENCE { sipRegAcceptedRegistrations Counter32, sipRegRejectedRegistrations Counter32 } sipRegAcceptedRegistrations OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains a count of the number of REGISTER requests that have been accepted (status code 200) by the Registrar. This includes additions of new contact Lingle, et al. Expires January 14, 2005 [Page 74] Internet-Draft SIP MIB Modules July 2004 information, refreshing contact information, as well as requests for deletion of contact information." ::= { sipRegStatsEntry 1 } sipRegRejectedRegistrations OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains a count of the number REGISTER requests that have been rejected by the Registrar." ::= { sipRegStatsEntry 2 } -- -- Conformance -- sipServerMIBCompliances OBJECT IDENTIFIER ::= { sipServerMIBConform 1 } sipServerMIBGroups OBJECT IDENTIFIER ::= { sipServerMIBConform 2 } -- -- Compliance Statements -- sipProxyServerCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SIP entities acting as Proxy Servers." MODULE -- this module MANDATORY-GROUPS { sipServerConfigGroup, sipProxyConfigGroup, sipProxyStatsGroup } ::= { sipServerMIBCompliances 1 } sipRedirectServerCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SIP entities acting as Redirect Servers." MODULE -- this module MANDATORY-GROUPS { sipServerConfigGroup } ::= { sipServerMIBCompliances 2 } sipRegistrarServerCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION Lingle, et al. Expires January 14, 2005 [Page 75] Internet-Draft SIP MIB Modules July 2004 "The compliance statement for SIP entities acting as Registrars." MODULE -- this module MANDATORY-GROUPS { sipServerConfigGroup, sipRegistrarConfigGroup, sipRegistrarStatsGroup } GROUP sipRegistrarUsersGroup DESCRIPTION "This is an optional group." ::= { sipServerMIBCompliances 3 } -- -- Units of Conformance -- sipServerConfigGroup OBJECT-GROUP OBJECTS { sipServerHostAddrType, sipServerHostAddr } STATUS current DESCRIPTION "A collection of objects providing configuration common to SIP Proxy and Redirect servers." ::= { sipServerMIBGroups 1 } sipProxyConfigGroup OBJECT-GROUP OBJECTS { sipProxyStatefulness, sipProxyRecursion, sipProxyRecordRoute, sipProxyAuthMethod, sipProxyAuthRealm } STATUS current DESCRIPTION "A collection of objects providing configuration for SIP Proxy servers." ::= { sipServerMIBGroups 2 } sipProxyStatsGroup OBJECT-GROUP OBJECTS { sipNumProxyRequireFailures } STATUS current DESCRIPTION "A collection of objects providing statistics for SIP Proxy servers." ::= { sipServerMIBGroups 3 } Lingle, et al. Expires January 14, 2005 [Page 76] Internet-Draft SIP MIB Modules July 2004 sipRegistrarConfigGroup OBJECT-GROUP OBJECTS { sipRegAllowThirdParty, sipRegMaxContactExpiryDuration, sipRegMaxUsers, sipRegCurrentUsers, sipRegDfltRegActiveInterval } STATUS current DESCRIPTION "A collection of objects providing configuration for SIP Registrars." ::= { sipServerMIBGroups 4 } sipRegistrarStatsGroup OBJECT-GROUP OBJECTS { sipRegAcceptedRegistrations, sipRegRejectedRegistrations } STATUS current DESCRIPTION "A collection of objects providing statistics for SIP Registrars." ::= { sipServerMIBGroups 5 } sipRegistrarUsersGroup OBJECT-GROUP OBJECTS { sipUserUri, sipUserAuthenticationFailures, sipUserTableRowStatus, sipContactDisplayName, sipContactURI, sipContactLastUpdated, sipContactExpiry, sipContactPreference } STATUS current DESCRIPTION "A collection of objects related to registered users." ::= { sipServerMIBGroups 6 } END 8. Changes from Previous Draft Revisions This section to be removed by RFC Editor before publication. Lingle, et al. Expires January 14, 2005 [Page 77] Internet-Draft SIP MIB Modules July 2004 Changes from draft-ietf-sip-mib-07. The vast majority of changes are in response to the Working Group Last Call & expert review comments. o General * IANA requirements section added to specify the need for registered numbers for all SIP methods. These will be used in the MIB objects. * Updated the security consideration section to reflect the addition and deletion of a number of objects. o SIP-COMMON-MIB * Module description of various SIP entities enhanced. * sipMaxSessions renamed sipMaxTransactions. Workgroup last call reviewers suggested a change based on some change of terms in the standard. Transactions seemed the appropriate term. The object description was also enhanced. * sipRequestUriHostMatching object removed based on comments from workgroup last call comments. * sipEntityType changed from enumerated INTEGER to SipEntityRole textual convention syntax. * sipServiceAdminStatus enumerated value 'quiesceSessions' changed to 'quiesceDialogs'. * sipPortTable was redesigned. sipTransportSnd object was removed as it didn't make much sense. sipPortStatus was removed to prevent any row creation deletion. The remaining object, sipTransportRcv was made read-only. * sipUriSupportedTable was removed as it was not deemed useful anymore. * sipExtMethodSupportedTable replaced with a general sipMethodSupportedTable. IANA SIP method identifiers/numbers will be used in this new table. The previous concept of explicitly defining objects per the current well-know methods and then providing seperate, semantically similar, 'extension methods' tables has been eliminated. * sipCommonCfgTimerExtMethodTable was removed. No more need for 'extension methods' tables. * sipCommonCfgRetryTable was removed. Limits on retransmissions are controlled by timers in the SIP standard now rather than by maximum counts; therefore, these objects were no longer relevant. sipCommonConfigRetryGroup was likewise removed. * sipFtrSupportedTable was redesigned as sipOptionTagsTable. * sipCommonCfgTimerExtMethodTable was removed. * sipSummaryTotalTransactions description changed to reflect that in the case of forked request, _each_ branch rather than _all_ branches count as a single transaction. * sipMethodStatsTable was redesigned, taking into account the new SipMethodIdentifer textual convention. The objects were generalized to two: sipStatsOutbound and sipStatsInbound. The indexing object (sipStatsMethod) has syntax SipMethodIdentifier and thereby identifies the method associated with the instances Lingle, et al. Expires January 14, 2005 [Page 78] Internet-Draft SIP MIB Modules July 2004 of in/out counter objects. * sipCurrentTransactions description changed to reflect that in the case of forked request, _each_ branch rather than _all_ branches count as a single transaction. * sipCommonStatsRetryTable was redesigned, taking into account the new SipMethodIdentifer textual convention. A single, generalize object (sipStatsRetries) replaces several method-specific objects. The new, additional indexing object (sipStatsRetryMethod) has syntax SipMethodIdentifier and thereby identifies the method associated with the instances of the counter objects in each row. * sipCommonStatsRetryExtMethodTable was removed. * sipStatusCodeClassesTable removed. * sipOtherStatsTable has two new objects added: sipNumUnsupportedMethods & sipOtherwiseDiscardedMsgs. * The following object-groups were removed because their associated objects were removed: sipCommonConfigTimerExtMethodGroup, sipCommonConfigRetryGroup, sipCommonConfigRetryExtMethodGroup, sipCommonStatsRetryExtMethodsGroup, and sipCommonConfigExpiresGroup. The references to these object-groups as optional in the module-compliance was updated accordingly. * GROUP clause for sipCommonStatsRetryGroup in module-compliance was udpated to no longer state any dependency on sipCommonConfigRetryGroup (now removed). * New OBJECT clauses were added to the module-compliance to formalize MIN-ACCESS read-only for objects in sipCommonCfgTimerTable. * sipCommonConfigGroup udpated with new objects (sipOptionTag, sipOptionTagHeaderField, sipMethodName), removed objects (sipTransportSnd, sipPortStatus, sipUriSupported, sipFtrSupported, sipExtMethodName, sipRequestUriHostMatching), and changed objects (sipMaxTransactions). * sipCommonStatsGroup updated with new objects (sipStatsOutbounds, sipStatsInbounds, sipNumUnsupportedMethods, sipOtherwiseDiscardedMsgs) and removed objects (sipStatsInviteIns, sipStatsInviteOuts, sipStatsAckIns, sipStatsAckOuts, sipStatsByeIns, sipStatsByeOuts, sipStatsCancelIns, sipStatsCancelOuts, sipStatsOptionsIns, sipStatsOptionsOuts, sipStatsRegisterIns, sipStatsRegisterOuts, sipStatsExtMethodIns, sipStatsExtMethodOuts, sipStatsInfoClassIns, sipStatsInfoClassOuts, sipStatsSuccessClassIns, sipStatsSuccessClassOuts, sipStatsRedirClassIns, sipStatsRedirClassOuts, sipStatsReqFailClassIns, sipStatsReqFailClassOuts, sipStatsServerFailClassIns, sipStatsServerFailClassOuts, sipStatsGlobalFailClassIns, sipStatsGlobalFailClassOuts, Lingle, et al. Expires January 14, 2005 [Page 79] Internet-Draft SIP MIB Modules July 2004 sipStatsOtherClassesIns, sipStatsOtherClassesOuts). * sipCommonStatsRetryGroup updated with new object (sipStatsRetries) and removed objects (sipStatsRetryInvites, sipStatsRetryByes, sipStatsRetryCancels, sipStatsRetryRegisters, sipStatsRetryOptions). o SIP-SERVER-MIB * Module description of various SIP entities enhanced. * sipServerStats 'placeholder' IOD removed. No objects were ever defined under that subtree. * Removed the following objects from sipProxyCfgTable: sipRequestMaxExpires, sipProxySendsCancel, sipProxyForwardAll1xx, sipProxyProvideAlternatives, and sipProxyNonceLifeTime. sipProxyConfigGroup updated accordingly. * sipProxyStatefulness MAX-ACCESS changed to read-only. * DEFVAL removed from sipRegMaxContactExpiryDuration. * sipContactRetryAfter removed from sipContactTable. * sipUser* and sipContact* objects were moved from sipRegistrarConfigGroup to a new object-group: sipRegistrarUsersGroup. The new group was made an optional group in the MODULE-COMPLIANCE. o SIP-UA-MIB * SipEntityRole imported from SIP-TC module and used as the syntax for new object sipUACfgServerFunction. * sipUACfgSipServerTable (and objects therein) have their descriptors changed to sipUACfgServer* ("Sip" removed). sipUAConfigGroup updated accordingly. * sipUACfgServerFunction added to sipUACfgServerTable. * DEFVAL { ipv4 } removed from sipUACfgServerAddrType. o SIP-TC * New textual conventions: SipEntityRole, SipOptionTagHeaders, and SipMethodIdentifier added. o Changes from draft-ietf-sip-mib-06 o General * Minor editorial changes in the Textual Conventions section. o SIP-COMMON-MIB * sipStatusCodeValue SYNTAX changed from INTEGER to Unsigned32. * Optional sipCommonNotifObjectsGroup explicitly added to MODULE-COMPLIANCE. * Removed OBJECT refinement for sipStatusCodeRowStatus added to compliance in previous revision. SMIC MIB compiler issues required it to be commented out. Instead, simply removed it. o SIP-SERVER-MIB * Removed OID placeholders: sipRedirCfg, sipRedirStats. sipRegCfg and sipRegStats OID values subsequently changed as a result. Lingle, et al. Expires January 14, 2005 [Page 80] Internet-Draft SIP MIB Modules July 2004 o SIP-UA-MIB * Removed OBJECT refinement for sipUACfgSipServerStatus added to compliance in previous revision. SMIC MIB compiler issues required it to be commented out. Instead, simply removed it. Changes from draft-ietf-sip-mib-05 o Front paper/Back paper and General changes * Removed all references and special handling of SIP INFO method Removed references and objects specific to RFC 2976: INFO will be treated as any SIP extension method. * Changed requirements verbs from lowercase to uppercase wherever appropriate. * Added RFC Editor notes. * Updated all REFERENCE clauses and DESCRIPTIONS from RFC 2543 to RFC 3261. * Explained the approach taken for extension methods that might be defined in the future. * Defined a mapping of sipServiceOperStatus to applOperStatus. * Enhanced Security section with details on various objects. * Added descriptive language to various Entry objects regarding the expected persistence of data across system restarts. o SIP-COMMON-MIB * Removed sipTransactionTable after input from SIP community. * Made all extension method tables augmentations of sipExtMethodSupportedTable. This resulted in the removal of the following objects: sipCfgTimerExtMethodName, sipCfgRetryExtMethodName, sipStatsExtMethodName, sipStatsRetryExtMethodName. * sipCommonStatusCodeNotifEmitMode default value changed to 'triggered'. * sipStatusCodeThreshExceededNotif was replaced by two notifications: sipStatusCodeThreshExceededOutNotif & sipStatusCodeThreshExceededInNotif. * Re-arranged the enumerated value of sipServiceOperStatus; making 'unknown' the first value. Added some words to the DESCRIPTION of that object stating the values are not based on anything in the SIP standard. * Clarified rules for capitalization of sipExtMethodName. * All counters in the MIB are consistent with respect to resetting to zero. No counters can be reset to zero. Entries in sipStatusCodesTable can simply be created or destroyed - no ability to set to 'notInService' where there was the question/ possibility of resetting the counters to zero. sipStatsExtMethodTable no longer has itÈËs own RowStatus object, so it too can no longer be set to 'notInServiceË where there was the question/possibility of resetting the counters to zero. sipStatsExtMethodTable rows are augmentations of sipExtMethodSupportedEntry. Lingle, et al. Expires January 14, 2005 [Page 81] Internet-Draft SIP MIB Modules July 2004 * OBJECT refinement for sipStatusCodeRowStatus added to compliance. * Clarified the relationship between sipCommonStatusCodeNotifEmitMode and sipCommonStatusCodeNotifSend. * Explained the existence of sipNotifApplIndex object better. * sipCfgExpiresStatusCodeValue syntax changed from INTEGER to Unsigned32. * sipEntityType object added to sipCommonCfgTable. * All accessible-for-notify objects are moved into sipCommonNotifObjects group. OIDs for actual notifications are re-assigned as a result. * sipNotifSequenceNumber accessible-for-notify object added as a way for managers to gain insight into possible missed notifications. It is bound to each notification defined in the MIB. * New notifications related to SIP service operational status are added: sipServiceColdStart, sipServiceWarmStart, & sipServiceLastChanged. * New object sipServiceNotifEnable added to control the new SIP related notifications. * Minor object descriptor changes: sipStatusCodesTable renamed to sipStatusCodeClassesTable SipStatusCodesEntry renamed to SipStatusCodeClassesEntry sipStatusCodesEntry renamed to sipStatusCodeClassesEntry sipCommonStatusCodeTable renamed to sipStatusCodesTable SipCommonStatusCodeEntry renamed to SipStatusCodesEntry sipCommonStatusCodeEntry renamed to sipStatusCodesEntry sipCommonStatusCodeValue renamed to sipStatusCodeValue sipCommonStatusCodeIns renamed to sipStatusCodeIns sipCommonStatusCodeOuts renamed to sipStatusCodeOuts sipCommonStatusCodeStatus renamed to sipStatusCodeRowStatus sipCommonStatusCodeNotifTable renaemd to sipStatusCodeNotifTable SipCommonStatusCodeNotifEntry renamed to SipStatusCodeNotifEntry sipCommonStatusCodeNotifEntry renamed to sipStatusCodeNotifEntry sipCommonStatusCodeNotifSend renamed to sipStatusCodeNotifSend sipCommonStatusCodeNotifEmitMode renamed to sipStatusCodeNotifEmitMode sipCommonStatusCodeNotifThresh renamed to sipStatusCodeNotifThresh sipCommonStatusCodeNotifInterval renamed to sipStatusCodeNotifInterval * Removed all INFO method specific objects: sipCfgRetryInfo, sipStatsInfoIns, sipStatsInfoOuts, & sipStatsRetryInfos * Clarifying words added to sipStatusCodeNotifTable DESCRIPTION to explain why it's a seperate table from sipStatusCodesTable. o SIP-SERVER-MIB * Deleted objects related to 'action' parameter. RFC 3261 section 10.2 deprecates the 'action' parameter deleted 3 Lingle, et al. Expires January 14, 2005 [Page 82] Internet-Draft SIP MIB Modules July 2004 objects: sipServerContactDfltAction, sipServerRespectUAAction, sipContactAction. * Deleted pgp-related objects. RFC 3261 section 23 deprecates use of pgp deleted 3 objects: sipProxyAuthPgpAlgorithm, sipPgpPrivateKey, sipPgpVersion. * Removed sipProxyStateTimeout object. Timers G and timer H have been introduced in RFC 3261 for this purpose (see RFC 3261 section 17.2.1). * Updated description clause of sipProxyStatefulness. The 3 definitions of stateless/statefulness now match the text in RFC 3261. * Changed DEFVAL for object sipProxyProvideAlternatives. Changed DEFVAL to true to align with RFC 3261 that states that 485 responses SHOULD contain a contact header & 303 MAY... and updated REFERENCE clause to "RFC 3261 Sections 13.2.2.2 and 16.5". * Removed basic authentication value from sipProxyAuthMethod object Per section 22 of rfc 3261, deprecated. * Changed SYNTAX of sipProxyNonceLifeTime from Integer32 to Unsigned32. * Updated description clause of sipRegDfltRegActiveInterval Per RFC 3261 Section 10.2. o SIP-UA-MIB * OBJECT refinement for sipUACfgSipServerStatus added to compliance. * Changed the object descriptors of sipUACfgSipServerAddrIndex to sipUACfgSipServerIndex, and sipUACfgSipServerAddrStatus to sipUACfgSipServerStatus. Changes from draft-ietf-sip-mib-04 o Started realignment with SIP RFC3261. Changes from draft-ietf-sip-mib-03 o Front paper/Back paper and General changes * Rewrote section on Network Services MIB * Fixed minor editorial nits o SIP-COMMON-MIB * CONTACT-INFO "SIP MIB email" changed to sip@ietf.org * sipInviteTimeout was removed from the MIB. See below regarding new sipCommonCfgExpires objects. They provide equivalent functionality with extensibility beyond INVITE. * sipCommonCfgExpires OID subtree added. Per method Expires configuration objects were added there. This new high-level OID was placed under the existing sipCommonCfgRetry OID and therefore, caused the OIDs for the subsequent groups to change (incrementing by one). * Objects from tables under sipCommonCfgExpires were added to a new OBJECT-GROUP sipCommonConfigExpiresGroup, and that group Lingle, et al. Expires January 14, 2005 [Page 83] Internet-Draft SIP MIB Modules July 2004 was listed as optional in sipCommonCompliance. * Minor DESCRIPTION change for sipCommonCfgEntry. No behavior change. * sipServiceOperStatus SYNTAX changed. New values added: congested & quiescing Old values removed: halted The order of the enumeration was altered as well. * sipServiceAdminStatus SYNTAX changed. New values added: noop, up, down, quieseSessions, and quieseApplications Old values removed: shutdown, restart, stop, rts. These changes were made based on comments from last call reviewer and general known ambiguities in the previous design of the object. * Clarifying changes to the DESCRIPTION of sipServiceStartTime. * Clarifying changes to the DESCRIPTION of sipServiceStartTime. * Clarification of behavior for sipPortStatus while row is 'active' * Clarifying changes to the DESCRIPTION of sipUriSupportedTable. * Clarifying changes to the DESCRIPTIONs of sipFtrSupportedTable, sipFtrSupportedEntry, and sipFtrSupported. Specifically, IETF standard features and non-standard features are now represented by this table. Only non-standard features were mentioned in prior revisions of the draft. * Reference to usage of RFC 2788 applIndex moved from sipCommonCfgTimerExtMethodTable to sipCommonCfgTimerExtMethodEntry. This was the convention for other table/entry definitions in the MIB, so these objects were previously unconventional. * DEFVAL removed from sipCfgTimerExtMethodTimer. The generic nature of the "extension" object does not lend itself to being able to specify a particular default value. * Since the removal of the DEFVAL clause from sipCfgTimerExtMethodTimer, a value for that object must be specified when creating a sipCommonCfgTimerExtMethodEntry. The description of sipCfgTimerExtMethodStatus was updated to reflect this. * sipCommonCfgRetryExtMethodTable is now properly defined under sipCommonCfgRetry OID space instead of under sipCommonCfgTimer OID space. * DEFVAL removed from sipCfgRetryExtMethodRetry. The generic nature of the "extension" object does not lend itself to being able to specify a particular default value. * Since the removal of the DEFVAL clause from sipCfgRetryExtMethodRetry, a value for that object must be specified when creating a sipCommonCfgRetryExtMethodEntry. The description of sipCfgRetryExtMethodStatus was updated to reflect this. * Clarifying changes to the DESCRIPTION of sipSummaryTotalTransactions. Specifically, the object is not applicable to stateless SIP proxy servers and the object should Lingle, et al. Expires January 14, 2005 [Page 84] Internet-Draft SIP MIB Modules July 2004 always return a value of 0 if implemented by a stateless proxy. * Clarifying changes to the DESCRIPTION of sipStatsExtMethodStatus. * sipStatsOtherClassesIns and sipStatsOtherClassesOuts counter objects were added to sipStatusCodesTable to handle possible future classes of response status codes. * Text referring specifically to Redirect Server in sipStatsRedirClassIns and sipStatsRedirClassOuts was removed. * Text defining protocol behavior in sipStatsServerFailClassIns, sipStatsServerFailClassOuts, sipStatsGlobalFailClassIns, and sipStatsGlobalFailClassOuts was removed. * sipCommonStatusCodeNotifInterval SYNTAX changed from TimeTicks to Unsigned32 w/ a UNITS of "seconds" added to the definition. DEFVAL clause changed accordingly. * sipStatusCodeNotifTo, sipStatusCodeNotifFrom, sipStatusCodeNotifCallId, and sipStatusCodeNotifCSeq all had clarifying changes to their DESCRIPTIONs. Specifically, the header name will be part of the object value and example values were given. * Clarifying changes to the DESCRIPTION of sipCurrentTransTable and sipTransactionTable. Specifically, these tables are not applicable to transaction stateless SIP Proxy Servers. * Minor gramatical change to the DESCRIPTION of sipCurrentTransEntry. * sipTransMethod and sipTransActivityInfo objects were added to sipTransactionTable while sipTransCallingPartyContentType and sipTransCalledPartyContentType were removed. * Clarifying changes to the DESCRIPTION of sipTransState. Specifically, noting that not all values of the object are applicable to all transaction types. * sipTransTo, sipTransFrom, sipTransCallId, and sipTransCSeq all had clarifying changes to their DESCRIPTIONs. Specifically, the header name will be part of the object value and example values were given. * Minor gramatical change to the DESCRIPTION of sipOtherStatsEntry. * sipCommonStatusCodeIns and sipCommonStatusCodeOuts objects were added to the varbind of sipStatusCodeNotif. * Appropriate changes were made to sipCommonStatsGroup OBJECT-GROUP based on objects being added and/or removed from the MIB. o SIP-SERVER-MIB * CONTACT-INFO "SIP MIB email" changed to sip@ietf.org * The statement "Unlike a Proxy server it does not initiate requests." was removed from where a Redirect Server is defined in the MIB's DESCRIPTION. * sipServerMIBNotifs OID removed. No notifications were ever defined under this subtree. Lingle, et al. Expires January 14, 2005 [Page 85] Internet-Draft SIP MIB Modules July 2004 * Clarifying text added to all of the Table DESCRIPTIONS stating that the value of applIndex used in this MIB corresponds to the value of applIndex used in the SIP-COMMON-MIB. * Clarifying changes to the DESCRIPTION of sipProxyStatefulness. * sipContactPreference SYNTAX changed from OCTET STRING to SnmpAdminString. o SIP-UA-MIB * CONTACT-INFO "SIP MIB email" changed to sip@ietf.org * sipUAMIBNotifs OID removed. No notifications were ever defined under this subtree. * sipUAStats OID removed. No notifications were ever defined under this subtree. * Clarifying text added to all of the Table DESCRIPTIONS stating that the value of applIndex used in this MIB corresponds to the value of applIndex used in the SIP-COMMON-MIB. o SIP-TC * CONTACT-INFO "SIP MIB email" changed to sip@ietf.org Changes from draft-ietf-sip-mib-02 o General * Eliminated the SIP-MIB-SMI modules. Each MIB module will now get it's own IANA OID. * Top-level OID subtrees restructured in each MIB. * General cleanup/removal of "placeholder" OID subtrees for object groups and notifications that never materialized. o SIP-COMMON-MIB * Removed sipCfgInitialTimerAck. * Removed sipCfgRetryAck. * Removed sipStatsRetryAcks. * sipCommonStatsRetryExtMethodEntry was missing its INDEX clause. * sipNumUnsupportedUris OID was "5" when it was the only object in the table. OID is now "1". * High-level OID structure of the MIB is now sequential. * Incorrect object descriptor for sipCfgInitialTimerRsp inconsistent with reference in compliance section. * Inconsistencies between sipCommonStatsRetryGroup definition and SipCommonStatsRetryEntry OBJECT-TYPE corrected. * sipNotifApplIndex was not in any object group in the conformance section. o SIP-SERVER-MIB * Removed sipInformationTryingInterval. * Removed sipRxProxyAuthTable. * Removed sipRegRespHasContacts. * Removed sipRegContactDfltExpiryDate. * Removed sipRegContactDfltExpiryDuration. * Removed sipUserPassword. * sipRequestMaxExpires DESCRIPTION changed to no longer specifically mention 400 response. Lingle, et al. Expires January 14, 2005 [Page 86] Internet-Draft SIP MIB Modules July 2004 * sipProxyStateful object descriptor changed to sipProxyStatefullness and the SYNTAX changed from TruthValue to an enumerated INTEGER. * sipProxyStateTimeout DESCRIPTION changed to now reflect only INVITE. * Gauge32 was not being IMPORTed. * sipServerContactDfltAction showed up in conformance and other object descriptions in an older form. * sipServerHost replaced with InetAddressType/InetAddress object pair (sipServerHostAddrType & sipServerHostAddr). o SIP-UA-MIB * IMPORTed Unsigned32 to support sipUACfgSipServerAddrIndex. * sipUACfgSipServerEntry was referencing the wrong auxilliary object and listing that object in the conformance section. * sipUACfgSipServerEntry listed sipUACfgSipServerStatus when it should have been listing sipUACfgSipServerAddrStatus. * SIP-UA-MIB IMPORTed Counter32, but never used it. Removed the IMPORT of Counter32. 9. IANA Considerations The SIP specification RFC 3261 [7] Section 27.4 establishes the Method and Response-Code sub-registries under http://www.iana.org/assignments/sip-parameters. The SIP-COMMON-MIB requires that unique numeric identifiers be assigned by IANA for each Method in the above registry. It is expected that IANA will create those method identifies in the same sub-registry and assign a new method ID for registered methods. For e.g., the mapping of method identifiers to methods will be represented by a table in the MIB: sipSupportedMethodTable. SIP-COMMON-MIB sipCommonCfgTable might be populated as: +-------------------------+------------------------+ | sipMethodSupportedIndex | sipMethodSupportedName | +-------------------------+------------------------+ | 1 | "INVITE" | | 2 | "ACK" | | 3 | "BYE" | | 4 | "CANCEL" | | 5 | "OPTIONS" | | 6 | "CANCEL" | | 7 | "INFO" | | 8 | "SUBSCRIBE" | | 9 | "NOTIFY" | +-------------------------+------------------------+ Lingle, et al. Expires January 14, 2005 [Page 87] Internet-Draft SIP MIB Modules July 2004 etc. The numeric identifiers will also be used in other MIB tables where it is sufficient and/or more effective to refer to a method by a number rather than by a string. 10. Security Considerations There are a number of management objects defined in this MIB module with a MAX-ACCESS clause of read-write and/or read-create. Such objects may be considered sensitive or vulnerable in some network environments. The support for SET operations in a non-secure environment without proper protection can have a negative effect on network operations. These are the tables and objects and their sensitivity/vulnerability: o SIP-COMMON-MIB The following read-write object is used to control the overal SIP service in any SIP entity: sipServiceAdminStatus If this object is SET maliciously, it may result in unwanted operational status, or a failure to obtain SIP services. The following read-write and read-create objects are used to control the behavior of the SIP protocol as exhibited by a SIP entity: sipOrganization, sipCfgTimerA, sipCfgTimerB, sipCfgTimerC, sipCfgTimerD, sipCfgTimerE, sipCfgTimerF, sipCfgTimerG, sipCfgTimerH, sipCfgTimerI, sipCfgTimerJ, sipCfgTimerK, sipCfgTimerT1, sipCfgTimerT2, sipCfgTimerT4. If these objects are SET maliciously, it may result in serious protocol misbehavior or misoperation. In particular, the objects are related to the core SIP protocol stack timers, retries and request expiration values: all of these control how the SIP state machines are executed at runtime. It is therefore possible that the SIP service be affected, stalled or completely stopped if erroneous values are SET maliciously. The following read-create object is used to configure the status code statistics that will be monitored by the SIP entity: sipStatusCodeRowStatus If this object is SET maliciously, it may result in an over allocation of resources in a system for the purpose of accumulating and maintaining statistics. The following read-write objects are used to configure the behavior of certain SNMP notifications potentially generated by a SIP entity: sipStatusCodeNotifSend, sipStatusCodeNotifEmitMode, sipStatusCodeNotifThresh, sipStatusCodeNotifInterval, Lingle, et al. Expires January 14, 2005 [Page 88] Internet-Draft SIP MIB Modules July 2004 sipServiceNotifEnable If these objects are SET maliciously, it may result in a system and/or network performance impact due to the generation of SNMP notifications. o SIP-UA-MIB The following read-create objects are used to configure the Internet address of SIP servers a SIP User Agent will use to proxy/redirect SIP calls: sipUACfgServerAddrType, sipUACfgServerAddr, sipUACfgServerFunction, sipUACfgServerStatus. If these objects are SET maliciously, it may result in unwanted operation, or a failure to obtain SIP services from the user agent prospective or even theft of service. In particular, setting the SipUACfgSipServerStatus object instance to the 'destroy' value may result in service disruption. o SIP-SERVER-MIB The following read-create objects are managed by Registrar Servers and contain sensitive or private information about the address of record of registered users. sipUserUri & sipUserTableRowStatus The sensitivity of these objects depends on the role that Registrar Servers play in the SIP service. In some cases, these objects, if SET maliciously, may allow unregistered users to steal service, or may prevent registered users from accessing the SIP service. The following read-write objects, if SET maliciously will have an immediate serious impact on the service: sipServerHostAddrType & sipServerHostAddr These objects specify the host part of the URI for the server providing the SIP resource and it is widely used by SIP servers in numerous header lines and field. For e.g., the host address may be used with the Request-URI to check if the server is the one resolved by the Request-URI, therefore determining whether to process or forward the request in the case of outbound proxies, or, as an another common example, it is used by Proxy Servers acting as strict routers to rewrite the Request-URI. Setting these objects with improper values may result in serious service interference or failure. sipRequestMaxExpires and sipRegMaxContactExpiryDuration: if set to a zero value and either SIP requests contain an Expires header or Contact header contain an expires parameter, may cause the server to never create bindings associated with an address of record (case of REGISTER request) or may cause server to expire and cancel invitations (case of INVITE request). sipProxyStatefulness: changing the value of this object affects how transaction states are being handled the Proxy Server and may result in call feature or service changes. Lingle, et al. Expires January 14, 2005 [Page 89] Internet-Draft SIP MIB Modules July 2004 sipProxyAuthMethod: this object specifies at a maximum what the authentication methods that may be used by a server. If this object is SET maliciously, it may alter how the level of security used by the server to generate requests and may compromise the network security policies. sipRegAllowThirdParty: depending on the authentication policy associated with registration services, setting this object maliciously to 'true' may allow theft of identity or service. sipProxyAuthRealm: if this object is SET improperly, and if the HTTP Digest authentication method is used, it may result in clients being unable to authenticate and ultimately, in the server denying service. The remaining read-write objects, if SET maliciously may have some effect on the service: sipProxyRecordRoute: setting this object to true may cause additional SIP traffic to cross the proxy server and may result in message avalanches. The threats posed by the following read-write objects can either be mitigated by other configuration settings like read-only objects or they are considered to cause additional server operations without immediate impact on the servive. sipProxyRecursion and sipRegDfltRegActiveInterval Some of the readable objects in the MIB modules (i.e., objects with a MAX-ACCESS other than not-accessible) may be considered sensitive or vulnerable in some network environments. It is thus important to control even GET and/or NOTIFY access to these objects and possibly to even encrypt the values of these objects when sending them over the network via SNMP. The following object values may contain private or confidential customer information like first name, last name, customer identification, location, company affiliation, the time the information was updated, etc. SipContactDisplayName, SipContactURI, and SipContactLastUpdated. The sipMethodSupportedTable table contains the list of SIP methods supported by each entity in the system. Gaining access to this information may allow attackers to build method specific attacks or use unsupported methods to create denial of service attack scenarios. SNMP versions prior to SNMPv3 did not include adequate security. Even if the network itself is secure (for example by using IPSec), even then, there is no control as to who on the secure network is allowed to access and GET/SET (read/change/create/delete) the objects in this MIB module. It is RECOMMENDED that implementers consider the security features as provided by the SNMPv3 framework (see [RFC3410], section 8), Lingle, et al. Expires January 14, 2005 [Page 90] Internet-Draft SIP MIB Modules July 2004 including full support for the SNMPv3 cryptographic mechanisms (for authentication and privacy). Further, deployment of SNMP versions prior to SNMPv3 is NOT RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to enable cryptographic security. It is then a customer/operator responsibility to ensure that the SNMP entity giving access to an instance of this MIB module is properly configured to give access to the objects only to those principals (users) that have legitimate rights to indeed GET or SET (change/create/delete) them. 11. Contributor Acknowledgments We wish to thank the members of the IETF SIP & SIPPING working groups & the SIP-MIB Design team for their comments and suggestions. Detailed comments were provided by Tom Taylor, Kavitha Patchayappan, Dan Romascanu, Cullen Jennins, Orit Levin, AC Mahendran, Mary Barnes and Rohan Mahy. 12. References 12.1 Normative References [1] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [2] Case, J., Mundy, R., Partain, D. and B. Stewart, "Introduction and Applicability Statements for Internet-Standard Management Framework", RFC 3410, December 2002. [3] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. [4] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. [5] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999. [6] Freed, N. and S. Kille, "Network Services Monitoring MIB", RFC 2788, March 2000. [7] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., Peterson, J., Sparks, R., Handley, M. and E. Schooler, "SIP: Session Initiation Protocol", RFC 3261, June 2002. Lingle, et al. Expires January 14, 2005 [Page 91] Internet-Draft SIP MIB Modules July 2004 [8] Daniele, M., Haberman, B., Routhier, S. and J. Schoenwaelder, "Textual Conventions for Internet Network Addresses", RFC 3291, May 2002. 12.2 Informational References [9] Hoffman, P., Masinter, L. and J. Zawinski, "The mailto URL scheme", RFC 2368, July 1998. [10] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform Resource Identifiers (URI): Generic Syntax", RFC 2396, August 1998. Authors' Addresses Kevin Lingle Cisco Systems, Inc. 7025 Kit Creek Road P.O. Box 14987 Research Triangle Park, NC 27709 US Phone: +1 919 392 2029 EMail: klingle@cisco.com Joon Maeng Phone: EMail: jmaeng@ipdialog.com Dave Walker Phone: EMail: drwalker@rogers.com Lingle, et al. Expires January 14, 2005 [Page 92] Internet-Draft SIP MIB Modules July 2004 Intellectual Property Statement The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. Disclaimer of Validity This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Copyright Statement Copyright (C) The Internet Society (2004). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society. Lingle, et al. Expires January 14, 2005 [Page 93]