Internet-Draft E. Cardona draft-jones-cable-gateway-config-mib-02.txt K. Luehrs Expires: September 2003 CableLabs D. Mazzola Texas Instrument D. Jones YAS BBV March 2003 Cable Gateway Configuration Management Information Base for CableHome(tm) compliant Residential Gateways Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026 [1]. 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 Copyright Notice Copyright (C) The Internet Society (2003). All Rights Reserved. Abstract This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it defines a basic set of managed objects for SNMP- based management of DHCP [22] functionality within a CableHome compliant [21] residential gateway. Cardona, et. al. Expires - September 2003 [Page 1] Internet-Draft CableHome Gateway Configuration MIB March 2003 This memo specifies a MIB module in a manner that is compliant to the SNMP SMIv2 [5][6][7]. The set of objects is consistent with the SNMP framework and existing SNMP standards. Conventions used in this document 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 [2]. Table of Contents 1. The Internet-Standard Management Framework.....................2 2. Glossary.......................................................3 2.1 CableHome Residential Gateway..............................3 2.2 Portal Services............................................3 2.3 LAN IP Device..............................................3 2.4 WAN Management (WAN-Man) Address...........................3 2.5 WAN Data (WAN-Data) Address................................3 2.6 LAN Translated (LAN-Trans) Address.........................3 2.7 LAN Passthrough (LAN-Pass) Address.........................4 2.8 Cable Gateway DHCP Portal (CDP)............................4 3. Overview.......................................................4 3.1 Structure of the MIB.......................................4 3.2 Cable Gateway Configuration System Description.............5 4. MIB Definitions...............................................15 5. Acknowlegements...............................................34 6. Formal Syntax.................................................35 7. Security Considerations.......................................35 8. References....................................................35 9. Intellectual Property.........................................37 10. Author's Addresses...........................................38 11. Full Copyright Statement.....................................38 1. 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 [12]. Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. MIB objects are generally accessed through the Simple Network Management Protocol (SNMP). Objects in the MIB are defined using the mechanisms defined in the Structure of Management Information (SMI). This memo specifies a MIB module that is compliant to the SMIv2, which is described in STD 58, RFC 2578 [7], STD 58, RFC 2579 [8] and STD 58, RFC 2580 [9]. Cardona, et. al. Expires - September 2003 [Page 2] Internet-Draft CableHome Gateway Configuration MIB March 2003 2. Glossary The terms in this document are derived either from normal cable system usage, from normal residential gateway operation, or from the documents associated with the CableHome Specifications [21]. 2.1 CableHome Residential Gateway A CableHome Residential gateway passes data traffic between the cable operator's broadband data network (the Wide Area Network, WAN) and the Local Area Network (LAN) in the cable data service subscriber's residence or business. In addition to passing traffic between the WAN and LAN, the CableHome Residential Gateway provides several services including a DHCP client and a DHCP server (RFC2131) [22], a TFTP server (RFC1350) [23], management services as enabled by SNMPv1/v2c/v3 agent compliant with the RFCs listed in Section 1, and security services including stateful packet inspection firewall functionality and software code image verification using techniques. 2.2 Portal Services A logical element aggregating the set of CableHome-specified functionality in a CableHome compliant cable gateway device. 2.3 LAN IP Device A LAN IP Device is representative of a typical IP device expected to reside on home networks, and is assumed to contain a TCP/IP stack as well as a DHCP client. 2.4 WAN Management (WAN-Man) Address WAN Management Addresses are intended for network management traffic on the cable network between the network management system and the PS element. Typically, these addresses will reside in private IP address space. 2.5 WAN Data (WAN-Data) Address WAN Data Addresses are intended for subscriber application traffic on the cable network and beyond, such as traffic between LAN IP Devices and Internet hosts. Typically, these addresses will reside in public IP address space. 2.6 LAN Translated (LAN-Trans) Address LAN Translated Addresses are intended for subscriber application and management traffic on the home network between LAN IP Devices and the Cardona, et. al. Expires - September 2003 [Page 3] Internet-Draft CableHome Gateway Configuration MIB March 2003 PS element. Typically, these addresses will reside in private IP address space, and can typically be reused across subscribers. 2.7 LAN Passthrough (LAN-Pass) Address LAN Passthrough Addresses are intended for subscriber application traffic, such as traffic between LAN IP Devices and Internet hosts, on the home network, the cable network, and beyond. Typically, these addresses will reside in public IP address space. 2.8 Cable Gateway DHCP Portal (CDP) A logical element residing within the PS that encapsulates DHCP functionality within a Cable Gateway Device. This includes both DHCP client as well as DHCP server capabilities. 3. Overview This MIB provides a set of objects required for the management of DHCP client and server functionality within CableHome compliant Residential Gateways (RG). The specification is derived from the CableHome Specification [21]. The DHCP client within a Cable Gateway will acquire one or more addresses from WAN based DHCP servers. Collectively, these are known as WAN addresses. These addresses are used for both management traffic (WAN management addresses) and data traffic (WAN data addresses) to and from the WAN side of the residential gateway. The DHCP server within a Cable Gateway will provide private addresses to LAN IP Devices. These addresses will be translated to and from one of the WAN IP addresses for traffic that enters or exits the LAN, and are and collectively known as LAN Translated Addresses. There are a number of logical functional elements used to describe Cable Gateway configuration functionality. - The Portal Services (PS) logical element is the functional entity that aggregates all specified Cable Gateway capabilities. - The Cable Gateway DHCP Portal (CDP) logical element is the functional entity that embodies the Cable Gateway DHCP capabilities. 3.1 Structure of the MIB This MIB is structured into three groups: Cardona, et. al. Expires - September 2003 [Page 4] Internet-Draft CableHome Gateway Configuration MIB March 2003 - The cabhCdpBase group provides baseline and information for RG DHCP client and server functionality, including reset information, counts for WAN addresses acquired, and counts for LAN addresses served. - The cabhCdpAddr group provides information about dynamically acquired and served addresses within the RG, and includes the following tables: o cabhCdpLanAddrTable: information and reservations for addresses served to the LAN o cabhCdpWanDataAddrTable: WAN address acquisition information o cabhCdpWanDataAddrServerTable: WAN based DNS server information - The cabhCdpServer group provides information about the RG DHCP service (address pool range, subnet information, RG Based server info, etc). 3.2 Cable Gateway Configuration System Description The functional element that encapsulates DHCP functionality within the Cable Gateway is known as the Cable Gateway DHCP Portal (CDP). The CDP operating assumptions include: - LAN IP Devices implement a DHCP client as defined by [RFC 2131]. - The cable network provisioning system implements a DHCP server as defined by [RFC 2131]. - If the cable network provisioning system's DHCP server supports DHCP Option 61 (client identifier option),the WAN-Man and all WAN- Data IP interfaces can share a common MAC address. - LAN IP Devices may support various DHCP Options and BOOTP Vendor Extensions, allowed by [RFC 2132]. The following design guidelines drive the capabilities defined for the CDP: - CableHome addressing mechanisms will be MSO controlled, and will provide MSO knowledge of and accessibility to CableHome network elements and LAN IP Devices. - CableHome address acquisition and management processes will not require human intervention (assuming that a user/household account has already been established). Cardona, et. al. Expires - September 2003 [Page 5] Internet-Draft CableHome Gateway Configuration MIB March 2003 - CableHome address acquisition and management will be scalable to support the expected increase in the number of LAN IP devices. - It is preferable for LAN IP Device addresses to remain the same after events such as a power cycle or Internet Service Provider switch. - CableHome will provide a mechanism by which the number of LAN IP Devices in the LAN-Trans realm can be monitored and controlled. - In home communication will continue to work as provisioned during periods of Headend address server outage. Addressing support will be provided for newly added LAN IP Devices and address expirations during remote address server outages. - IP addresses will be conserved when possible (both globally routable addresses and private cable network management addresses). 3.2.1 Cable Gateway DHCP Portal (CDP) System Description The Cable Gateway DHCP Portal is the logical entity that is responsible for CableHome addressing activities. The CDP address request and address allocation responsibilities within the CableHome environment include: - IP address assignment, IP address maintenance, and the delivery of configuration parameters (via DHCP) to LAN IP Devices in the LAN- Trans Address Realm. - Acquisition of a WAN-Man and zero or more WAN-Data IP addresses and associated DHCP configuration parameters for the Portal Services (PS) element. - Provide information to the CableHome Name Portal (CNP) in support of LAN IP Device host name services. The PS maintains two hardware addresses, one of which is to be used to acquire an IP address for management purpose, the other could be used for the acquisition of one or more IP address(es) for data. To prevent hardware address spoofing, the PS does not allow either of the two hardware addresses to be modified. The Portal Services element requires an IP Address on the home LAN for its role on the LAN as a router (see Section 8 in [21], Packet Handling and Address Translation), DHCP Server (CDS), and DNS Server). For each of these three Portal Service Element server and router functions, a LAN IP address is saved in the PS database. Each can be accessed via a different MIB object, which are listed below: Cardona, et. al. Expires - September 2003 [Page 6] Internet-Draft CableHome Gateway Configuration MIB March 2003 - Router (default gateway) Address cabhCdpServerRouter - Domain Name Server (DNS) Address cabhCdpServerDnsAddress - Dynamic Host Configuration Server (DHCP) (CDS) Address cabhCdpServerDhcpAddress The default value of cabhCdpServerRouter is 192.168.0.1. The default values of cabhCdpServerDnsAddress and cabhCdpServerDhcpAddress are equal to the value of cabhCdpServerRouter. The CDP capabilities are embodied by two functional elements residing within the CDP: - the Cable Gateway DHCP Server (CDS) - the Cable Gateway DHCP Client (CDC). The CDC exchanges DHCP messages with the DHCP server in the cable network (WAN-Management address realm) to acquire an IP address and DHCP options for the PS, for management purposes. The CDC could also exchange DHCP messages with the DHCP server in the cable network (WAN-Data address realm) to acquire zero or more IP address(es) on behalf of LAN IP Devices in the LAN-Trans realm. The CDS exchanges DHCP messages with LAN IP Devices in the LAN-Trans realm, and assigns private IP addresses, grants leases to, and could provide DHCP options to DHCP clients within those LAN IP Devices. LAN IP Devices in the LAN-Pass realm receive their IP addresses, leases, and DHCP options directly from the DHCP server in the cable network. The CDP simply bridges DHCP messages between the DHCP server in the cable network and LAN IP Devices in the LAN-Pass realm. Figure 1 illustrates these concepts. +---------------------+ | Cable Gateway | | | | /-----------------\ | Wan-Data | | CDP | | Lan-Pass SERVICE Realm | | | | Realm PROVIDER--------*-----------------------------------------LAN IP Dev \ | | | | \ | | /*****\ /*****\ | | \--------- | | | | CABLE | | | CDC | | CDS | | | NETWORK---------------------- | | --------------------LAN IP Dev Wan-Man | | | | | | | | Lan-Trans Realm | | | | | | | | Realm | | \*****/ \*****/ | | | | | | | \-----------------/ | | | +---------------------+ Figure 1 Cardona, et. al. Expires - September 2003 [Page 7] Internet-Draft CableHome Gateway Configuration MIB March 2003 3.2.1.1 Cable Gateway DHCP Server (CDS) System Description The CDS is a standard DHCP server as defined in [RFC 2131], and responsibilities include: - The CDS assigns addresses to and delivers DHCP configuration parameters to LAN IP Devices receiving an address in the LAN-Trans address realm. The CDS learns DHCP options from the NMS system and provides these DHCP options to LAN IP Devices. If DHCP options have not been provided by the NMS system (for example when the PS boots during a cable outage), the CDS relies on built-in default values (DefVals) for required options. - The CDS is able to provide DHCP addressing services to LAN IP Devices, independent of the WAN connectivity state. - The number of addresses supplied by the CDS to LAN IP Devices is controllable by the NMS system. The behavior of the CDS when a cable operator settable limit is exceeded is also configurable via the NMS. Possible CDS actions when the limit is exceeded include (1) assign a LAN-Trans IP address and treat the WAN to LAN interconnection as would normally occur if the limit had not been exceeded and (2) do not assign an address to requesting LAN IP devices. An address threshold setting of 0 indicates the maximum threshold possible for the LAN-Trans IP address pool defined by the pool "start" (cabhCdpLanPoolStart) and "end" (cabhCdpLanPoolEnd) values. - In the absence of time of day information from the Time of Day (ToD) server, the CDS uses the PS default starting time of 0 (January 1, 1970), updates the Expire Time for any active leases in the LAN-Trans realm to re-synchronize with DHCP clients in LAN IP Devices, and maintains leases based on that starting point until the PS synchronizes with the Time of Day server in the cable network. - During the PS Boot process, the CDS remains inactive until activated by the PS. - If the PS Primary Packet-handling mode [21] has been set to Passthrough AND the PS provisioning process has completed, then the CDS is disabled. LAN IP Devices may receive addresses that reside in the LAN-Pass realm. As shown in Figure 7-2 [21], LAN-Pass address requests are served by the WAN addressing infrastructure, not the PS. LAN-Pass addressing processes will occur when the PS is configured to operate in Passthrough Mode or Mixed Bridging/Routing Mode. In these cases, Cardona, et. al. Expires - September 2003 [Page 8] Internet-Draft CableHome Gateway Configuration MIB March 2003 DHCP interactions will take place directly between LAN IP Devices and Headend servers, and CableHome does not specify the process. Throughout this document, the terms Dynamic Allocation and Manual Allocation are used as defined in [RFC 2131]. The CDS Provisioned DHCP Options, cabhCdpServer objects in the CDP MIB, are DHCP Options that can be provisioned by the NMS, and are offered by the CDS to LAN IP devices assigned a LAN-Trans address. CDS Provisioned DHCP Options, cabhCdpServer objects, persist after a PS power cycle and the NMS system can establish, read, write and delete these objects. CDS Provisioned DHCP Options, cabhCdpServer objects, are retained during periods of cable outage and these objects are offered to LAN IP devices assigned a LAN-Trans address during periods of cable outage. The CDC persistent storage of DHCP options is consistent with [RFC 2131] section 2.1. The default values of CDS Provisioned DHCP Options, cabhCdpServer objects, are defined and the NMS can reset the CDS Provisioned DHCP Options, cabhCdpServer objects, to their default values, by writing to the cabhCdpSetToFactory MIB object. The CDS Address Threshold (cabhCdpLanTrans) objects contain the event control parameters used by the CDS to cause a notification to be sent to the Headend management system, when the number of LAN-Trans addresses assigned by the CDS exceeds the preset threshold. The Address Count (cabhCdpLanTransCurCount) object is a value indicating the number of LAN-Trans addresses assigned by the CDS that have active DHCP leases. The Address Threshold (cabhCdpLanTransThreshold) object is a value indicating when a notification is generated to the Headend management system. The notification is generated when the CDS assigns an address to the LAN IP Device that causes the Address Count (cabhCdpLanTransCurCount) to exceed the Address Threshold (cabhCdpLanTransThreshold). The Threshold Exceeded Action (cabhCdpLanTransAction) is the action taken by the CDS while the Address Count (cabhCdpLanTransCurCount) exceeds the Address Threshold (cabhCdpLanTransThreshold). If the Threshold Exceeded Action (cabhCdpLanTransAction) allows address assignments after the count is exceeded, the notification is generated each time an address is assigned. The defined actions are a) assign a LAN-Trans address as normal, and b) do not assign an address to the next requesting LAN IP Device. The Address Count (cabhCdpLanTransCurCount) continues to be updated during periods of cable outage. The CDS MIB also contains the Address Pool Start (cabhCdpLanPoolStart) and Address Pool End (cabhCdpLanPoolEnd) parameters. These parameters indicate the range of addresses in the LAN-Trans realm that can be assigned by the CDS to LAN IP Devices. Cardona, et. al. Expires - September 2003 [Page 9] Internet-Draft CableHome Gateway Configuration MIB March 2003 The CDP LAN Address Table (cabhCdpLanAddrTable) contains the list of parameters associated with addresses allocated to LAN IP Devices with LAN-Trans addresses. These parameters include: - The Client Identifiers [RFC 2132] section 9.14 (cabhCdpLanAddrClientID) - The LAN IP address assigned to the client (cabhCdpLanAddrIp) - An indication that the address was allocated either manually or dynamically (via the CDP)(cabhCdpLanAddrConfig) The CDS stores information about the identification of a LAN IP Device in the object cabhCdpLanAddrClientID. The first priority for the value to be stored in this object is the Client ID value passed by the LAN IP Device in DHCP Option 61, Client Identifier. If no value is passed in Option 61, the CDS stores the value passed in the chaddr field of the DHCP DISCOVER message issued by the LAN IP Device. The CDS creates a CDP Table (cabhCdpLanAddrTable) entry when it allocates an IP address to a LAN IP Device. The CDS can create CDP Table (cabhCdpLanAddrTable) entries during periods of cable outage. The CDP Table (cabhCdpLanAddrTable) maintains a DHCP lease time for each LAN IP Device. NMS-provisioned CDP Table (cabhCdpLanAddrTable) entries are retained during periods of cable outage and persist across a PS power-cycle. 3.2.1.2 Cable Gateway DHCP Client (CDC) System Description The CDC is a standard DHCP client as defined in [RFC 2131], and responsibilities include: - The CDC makes requests to Headend DHCP servers for the acquisition of addresses in the WAN-Man and may make requests to Headend DHCP servers for the acquisition of addresses in the WAN-Data address realms. The CDC also understands and acts upon a number of CableHome DHCP configuration parameters. - The CDC supports acquisition of one WAN-Man IP address and zero or more WAN-Data IP addresses. - The CDC supports the Vendor Class Identifier Option (DHCP option 60), the Vendor Specific Information option (DHCP Option 43), and the Client Identifier Option (DHCP option 61). Cardona, et. al. Expires - September 2003 [Page 10] Internet-Draft CableHome Gateway Configuration MIB March 2003 - In the default case, the CDC will acquire a single IP address for simultaneous use by the WAN-Man and WAN-Data IP interfaces. In order to minimize changes needed to existing Headend DHCP servers, the use of a Client Identifier (DHCP option 61) by the CDC is not required in this default case. The CDP supports various DHCP Options and BOOTP Vendor Extensions, allowed by [RFC 2132]. The Vendor Class Identifier Option (DHCP option 60) defines a CableLabs device class. For CableHome 1.0, the Vendor Class Identifier Option will contain the string "CableHome1.0", to identify a CableHome 1.0 Portal Services (PS) logical element, whenever the CDC requests a WAN-Man or WAN-Data address. The Vendor Specific Information option (DHCP Option 43) further identifies the type of device and its capabilities. It describes the type of component that is making the request (embedded or standalone, CM or PS), the components that are contained in the device (CM, MTA, PS, etc.), the device serial number, and also allows device specific parameters. {add reference to CH spec and the DHCP options table} The WAN-Data IP Address count parameter of the CDP MIB (cabhCdpWanDataIpAddrCount) is the number of IP address leases the CDC is required to attempt to acquire for the WAN side of NAT and NAPT mappings. The default value of cabhCdpWanDataIpAddrCount is zero, which means that, by default, the CDC will acquire only a WAN- Man IP address. 3.2.1.2.1 Cable Gateway DHCP Client Option 61 The CableHome PS element can have one or more WAN IP addresses associated with a one or more link layer (e.g. MAC) interfaces. Therefore, the CDC cannot rely solely on a MAC address as a unique client identifier value. CableHome allows for the use of the Client Identifier Option (DHCP option 61), [RFC 2132] section 9.14, to uniquely identify the logical WAN interface associated with a particular IP address. The PS is required to have two hardware addresses: one to be used to uniquely identify the logical WAN interface associated with the WAN- Man IP address (WAN-Man hardware address) and the other to be used to uniquely identify the logical WAN interface associated with WAN-Data IP addresses (WAN-Data hardware address). Cardona, et. al. Expires - September 2003 [Page 11] Internet-Draft CableHome Gateway Configuration MIB March 2003 3.2.1.2.2 WAN Address Modes In order to enable compatibility with as many cable operator provisioning systems as possible, the CDC will support the following configurable WAN Address Modes: - WAN Address Mode 0: The PS Element makes use of a single WAN IP Address, acquired via DHCP using the WAN-Man hardware address. The PS Element has one WAN-Man IP Interface and zero WAN-Data IP Interfaces. This Address Mode is only applicable when the PS Primary Packet-handling Mode (cabhCapPrimaryMode) is set to Passthrough (refer to [21] Section 8.3.2). The cable operator's Headend DHCP server typically needs no software modifications to support this Address Mode. In WAN Address Mode 0, the value of cabhCdpWanDataIpAddrCount is zero. - WAN Address Mode 1: The PS Element makes use of a single WAN IP Address, acquired via DHCP using the WAN-Man hardware address. The PS Element has one WAN-Man IP Interface and one WAN-Data IP Interface. These two Interfaces share a single, common IP address. This Address Mode is only applicable when the PS Primary Packet- handling Mode (cabhCapPrimaryMode) is set to NAPT. The cable operator's Headend DHCP server typically needs no software modifications to support this Address Mode. In WAN Address Mode 1, the value of cabhCdpWanDataIpAddrCount is zero. - WAN Address Mode 2: The PS Element acquires a WAN-Man IP address using the unique WAN-Man hardware address, and is subsequently configured by the NMS to request one or more unique WAN-Data IP Address(es). The PS Element will have one WAN-Man and one or more WAN-Data IP Interface(s). All WAN-Data IP addresses will share a common hardware address that is unique from the WAN- Man hardware address. The two or more Interfaces (one WAN-Man and one or more WAN-Data) each has its own, unshared IP address. The CDP is configured by the cable operator to operate in WAN Address Mode 2 by writing a nonzero value to cabhCdpWanDataIpAddrCount, via the PS Configuration File or an SNMP set-request. This Address Mode is applicable when the PS Primary Packet-handling Mode (cabhCapPrimaryMode) is set to NAPT or NAT. The cable operator's Headend DHCP server might need software modification to include support for Client IDs (DHCP Option 61) so that it can assign multiple IP addresses to the single WAN-Data hardware address. There are four potential scenarios for WAN-Data IP addresses: 1. The PS is configured to request zero WAN-Data IP addresses. No WAN-Data Client IDs are needed. 2. The PS is configured to request one or more WAN-Data IP addresses and there are no MSO-configured cabhCdpWanDataAddrClientId entries in Cardona, et. al. Expires - September 2003 [Page 12] Internet-Draft CableHome Gateway Configuration MIB March 2003 the CDP MIB. The PS is required to auto-generate as many unique WAN- Data Client IDs as the value of cabhCdpWanDataIpAddrCount. 3. The PS is configured to request one or more WAN-Data IP addresses and there are at least as many MSO configured cabhCdpWanDataAddrClientId entries as the value of cabhCdpWanDataIpAddrCount, i.e., the MSO has provisioned enough WAN- Data Client ID values. The PS does not auto-generate any Client IDs. 4. The PS is configured to request one or more WAN-Data IP addresses and there are fewer MSO-configured cabhCdpWanDataAddrClientId entries than the value of cabhCdpWanDataIpAddrCount, i.e., the MSO has provisioned some but not provisioned enough WAN-Data Client ID values. The PS is required to auto-generate enough additional unique WAN-Data Client IDs to bring the total number of unique WAN-Data Client IDs to the value of cabhCdpWanDataIpAddrCount. If the cable operator desires for the PS to acquire one or more WAN- Data IP addresses, that are distinct from the WAN-Man IP address, the procedure is as follows. For all WAN Address Modes, the PS first requests a WAN-Man IP address using the WAN-Man hardware address. The procedure described below assumes the PS has already acquired a WAN- Man IP address: 1. The cable operator optionally provisions the PS with unique specific Client IDs, by writing values to the cabhCdpWanDataAddrClientId entries of the CDP MIB cabhCdpWanDataAddrTable, via the PS Configuration File or SNMP set- request message(s). 2. The cable operator configures the CDP to operate in WAN Address Mode 2 by writing cabhCdpWanDataIpAddrCount to a nonzero value through the PS Configuration File or SNMP set-request message. 3. After the CDP has been configured to operate in WAN Address Mode 2 as described in step 2), the PS checks to see if Client ID values have been provisioned by the NMS as described in step 1). If a number of Client ID values greater than or equal to the value of cabhCdpWanDataIpAddrCount have been provisioned, the PS uses these values in DHCP Option 61 when requesting the WAN-Data IP address(es). If Client ID values have not been provisioned, i.e., if the cabhCdpWanDataAddrClientId entries do not exist, or if the number of Client ID values provisioned is less than the value of cabhCdpWanDataIpAddrCount, the PS generates a number of unique Client ID values such that, in combination with the provisioned Client IDs, the total number of unique Client IDs equals the value of cabhCdpWanDataIpAddrCount. The PS generates Client ID values by using the WAN-Data hardware address alone for the first requested WAN-Data IP address, and by concatenating the WAN- Data hardware address with Cardona, et. al. Expires - September 2003 [Page 13] Internet-Draft CableHome Gateway Configuration MIB March 2003 a count that is 8 bits in length for the second and all subsequent WAN-Data IP addresses. If no Client IDs have been provisioned by the NMS, the first 8-bit Count value is 0x02 (indicating the second requested WAN-Data IP address), the second count value is 0x03, and so on. The following is an example for the case when no Client IDs have been provisioned by the network management system. Given WAN-Data hardware address 0xCDCDCDCDCDCD: - PS-generated Client ID for the first requested WAN-Data IP address: 0xCDCDCDCDCDCD - PS-generated Client ID for the second requested WAN-Data IP address: 0xCDCDCDCDCDCD02 - PS-generated Client ID for the third requested WAN-Data IP address: 0xCDCDCDCDCDCD03 - PS-generated Client ID for the nth requested WAN-Data IP address: 0xCDCDCDCDCDCDn (n=<0xFF) If some Client IDs have been provisioned by the NMS but the number is less than the value of cabhCdpWanDataIpAddrCount, the PS generates additional Client IDs as needed to bring the total number of Client IDs to the value of cabhCdpWanDataIpAddrCount. The PS will generate these additional Client IDs values by appending an 8-bit count value to the WAN-Data hardware address, starting with 0x02, unless that would duplicate a provisioned Client ID. If the Client IDs provisioned by the NMS follow the same format (hardware address with 8-bit count value), the PS is required to use a unique count value so as to not duplicate a provisioned Client ID. Example for the case when Client IDs have been provisioned by the NMS (three provisioned Client ID values, cabhCdpWanDataIpAddrCount = 5). Given WAN-Data hardware address 0xCDCDCDCDCDCD: - First provisioned Client ID for the first WAN-Data IP address: 0x0A0A0A0A0A1A - Second provisioned Client ID for the second WAN-Data IP address: 0x0A0A0A0A0A2A - Third provisioned Client ID for the third WAN-Data IP address: 0x0A0A0A0A0A3A - First Client ID generated by the PS for the fourth requested WAN- Data IP address: 0xCDCDCDCDCDCD02 - Second Client ID generated by the PS for the fifth requested WAN- Data IP address: 0xCDCDCDCDCDCD03 4. The PS adds the Client ID values it generates as cabhCdpWanDataAddrClientId entries to the end of the cabhCdpWanDataAddrTable. Cardona, et. al. Expires - September 2003 [Page 14] Internet-Draft CableHome Gateway Configuration MIB March 2003 5. The PS (CDC) requests (repeating the DHCP DISCOVER process as needed) as many unique WAN-Data IP addresses as the value of cabhCdpWanDataIpAddrCount specifies, using the WAN-Data hardware address in the chaddr field of the DHCP message and the Client ID value(s) from step 3) in DHCP Option 61, beginning with the first cabhCdpWanDataAddrClientId entry of the cabhCdpWanDataAddrTable. The CDC is not permitted to request more WAN-Data IP addresses than the value of cabhCdpWanDataIpAddrCount, even if the number of provisioned Client IDs is greater than the value of cabhCdpWanDataAddrTable. 4. MIB Definitions CABH-CDP-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Integer32, Unsigned32 FROM SNMPv2-SMI TEXTUAL-CONVENTION, TruthValue, DateAndTime, RowStatus FROM SNMPv2-TC -- RFC2579 OBJECT-GROUP, MODULE-COMPLIANCE FROM SNMPv2-CONF -- RFC2580 InetAddressType, InetAddress FROM INET-ADDRESS-MIB -- RFC3291 SnmpAdminString FROM SNMP-FRAMEWORK-MIB; -- RFC2571 cabhCdpMib MODULE-IDENTITY LAST-UPDATED "200303010000Z" -- March 1, 2003 ORGANIZATION "CableLabs Broadband Access Department" CONTACT-INFO "Kevin Luehrs Postal: Cable Television Laboratories, Inc. 400 Centennial Parkway Louisville, Colorado 80027-1266 U.S.A. Phone: +1 303-661-9100 Fax: +1 303-661-9199 E-mail: k.luehrs@cablelabs.com" DESCRIPTION "This MIB module supplies the basic management objects for the CableHome DHCP Portal (CDP) portion of the PS database." REVISION "200303010000Z" -- March 1, 2003 DESCRIPTION "Initial version, published as RFC xxxx." -- RFC editor to assign xxxx Cardona, et. al. Expires - September 2003 [Page 15] Internet-Draft CableHome Gateway Configuration MIB March 2003 ::= { mib-2 xx } -- xx to be assigned by IANA -- Textual conventions CabhCdpLanTransDhcpClientId::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "LAN-Trans DHCP option61 information." SYNTAX OCTET STRING (SIZE (1..80)) cabhCdpObjects OBJECT IDENTIFIER ::= { cabhCdpMib 1 } cabhCdpBase OBJECT IDENTIFIER ::= { cabhCdpObjects 1 } cabhCdpAddr OBJECT IDENTIFIER ::= { cabhCdpObjects 2 } cabhCdpServer OBJECT IDENTIFIER ::= { cabhCdpObjects 3 } -- -- The following group describes the base objects in the CableHome -- DHCP Portal. The rest of this group deals addresses defined on -- the LAN side. -- cabhCdpSetToFactory OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-write STATUS current DESCRIPTION "Reading this object always returns false(2). When the cabhCdpSetToFactory object is set to true(1), the PS must take the following actions: 1. Clear all cabhCdpLanAddrEntries in the CDP LAN Address Table. 2. The CDS must offer the factory default DHCP options at the next lease renewal time. 3. Reset the following objects to their factory default values: cabhCdpLanTransThreshold, cabhCdpLanTransAction, cabhCdpWanDataIpAddrCount, cabhCdpLanPoolStartType, cabhCdpLanPoolStart, cabhCdpLanPoolEndType, cabhCdpLanPoolEnd, cabhCdpServerNetworkNumberType, cabhCdpServerNetworkNumber, cabhCdpServerSubnetMaskType, cabhCdpServerSubnetMask, cabhCdpServerTimeOffset, cabhCdpServerRouterType, cabhCdpServerRouter, Cardona, et. al. Expires - September 2003 [Page 16] Internet-Draft CableHome Gateway Configuration MIB March 2003 cabhCdpServerDnsAddressType, cabhCdpServerDnsAddress, cabhCdpServerSyslogAddressType, cabhCdpServerSyslogAddress, cabhCdpServerDomainName, cabhCdpServerTTL, cabhCdpServerInterfaceMTU, cabhCdpServerVendorSpecific, cabhCdpServerLeaseTime, cabhCdpServerDhcpAddressType, cabhCdpServerDhcpAddress, cabhCdpServerCommitStatus" ::= { cabhCdpBase 1 } cabhCdpLanTransCurCount OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "The current number of active leases in the cabhCdpLanAddrTable (the number of row entries in the table that have a cabhCdpLanAddrMethod value of reservationActive(2) or dynamicActive (4)). This count does not include expired leases or reservations not associated with a current lease." ::= { cabhCdpBase 2 } cabhCdpLanTransThreshold OBJECT-TYPE SYNTAX INTEGER (0..65533) MAX-ACCESS read-write STATUS current DESCRIPTION "The threshold number of LAN-Trans IP addresses allocated or assigned above which the PS generates an alarm condition. Whenever an attempt is made to allocate a LAN-Trans IP address when cabhCdpLanTransCurCount is greater than or equal to cabhCdpLanTransThreshold, an event is generated. A value of 0 indicates that the CDP sets the threshold at the highest number of addresses in the LAN address pool." DEFVAL { 0 } ::= { cabhCdpBase 3 } cabhCdpLanTransAction OBJECT-TYPE SYNTAX INTEGER { normal (1), noAssignment(2) } Cardona, et. al. Expires - September 2003 [Page 17] Internet-Draft CableHome Gateway Configuration MIB March 2003 MAX-ACCESS read-write STATUS current DESCRIPTION "The action taken when the CDS assigns a LAN-Trans address and the number of LAN-Trans addresses assigned (cabhCdpLanTransCurCount) is greater than the threshold (cabhCdpLanTransThreshold) The actions are as follows: normal - assign a LAN-Trans IP address as would normally occur if the threshold was not exceed. noAssignment - do not assign a LAN-Trans IP address" DEFVAL { normal } ::= { cabhCdpBase 4 } cabhCdpWanDataIpAddrCount OBJECT-TYPE SYNTAX INTEGER ( 0..63 ) MAX-ACCESS read-write STATUS current DESCRIPTION "This is the number of WAN-Data IP addresses the PS's CDC must attempt to acquire via DHCP." DEFVAL { 0 } ::= { cabhCdpBase 5 } -- -- CDP Address Management Tables -- --============================================================== -- -- cabhCdpLanAddrTable (CDP LAN Address Table) -- -- The cabhCdpLanAddrTable contains the DHCP parameters -- for each IP address served to the LAN-Trans realm. -- -- This table contains a list of entries for the LAN side CDP -- parameters. These parameters can be set either by the CDP or -- by the cable operator through the CMP. -- --=================================================================== cabhCdpLanAddrTable OBJECT-TYPE SYNTAX SEQUENCE OF CabhCdpLanAddrEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table is a list of LAN-Trans realm parameters. This table has one row entry for each allocated LAN-Trans IP address. Each row must have at least a valid cabhCdpLanAddrMethod, a cabhCdpLanAddrIpType, Cardona, et. al. Expires - September 2003 [Page 18] Internet-Draft CableHome Gateway Configuration MIB March 2003 a unique cabhCdpLanAddrIp, and a unique cabhCdpLanAddrClientId value. Static/Manual address assignment: To create a new DHCP address reservation, the NMS creates a row with: an index comprised of a new cabhCdpLanAddrIp and its cabhCdpLanAddrIpType, a new unique cabhCdpLanAddrClientID, (an empty LeaseCreateTime and empty LeaseExpireTime,) and a cabhCdpLanDataAddrRowStatus of createAndGo(4). If the syntax and values of the new row - indicating a reservation - are valid, the PS must set cabhCdpLanAddrMethod to reservationInactive(1) and cabhCdpLanDataAddrRowStatus to active(1). When the PS grants a lease for a reserved IP, it must set the cabhCdpLanAddrMethod object for that row to reservationActive(2). When a lease for a reserved IP expires, the PS must set the corresponding row's cabhCdpLanAddrMethod object to reservationInactive(1). For row entries that represent lease reservations - rows in which the cabhCdpLanAddrMethod object has a value of either reservationInactive(1) or reservationActive(2) - the cabhCdpLanAddrIpType, cabhCdpLanAddrIp, cabhCdpLanAddrClientID, cabhCdpLanAddrMethod, and cabhCdpLanAddrHostName object values must persist across PS reboots. Dynamic address assignment: When the PS grants a lease for a non-reserved IP, it must set the cabhCdpLanAddrMethod object for that row to dynamicActive(4). When a lease for a non-reserved IP expires, the PS must set the corresponding row's cabhCdpLanAddrMethod object to dynamicInactive(3). The PS must create new row entries using cabhCdpLanAddrIp values that are unique to this table. If all cabhCdpLanAddrIp values in the range defined by cabhCdpLanPoolStart and cabhCdpLanPoolEnd are in use in this table, the PS may overwrite the cabhCdpLanAddrClientId of a row that has a cabhCdpLanAddrMethod object with a value of dynamicInactive(3) with a new cabhCdpLanAddrClientId value and use that cabhCdpLanAddrIp as part of a new lease. For row entries that represent active leases - rows in which the cabhCdpLanAddrMethod object has a value of dynamicActive(4) - the cabhCdpLanAddrIpType, cabhCdpLanAddrIp, cabhCdpLanAddrClientID, cabhCdpLanAddrMethod, and cabhCdpLanAddrHostName object values must persist across PS reboots." ::= { cabhCdpAddr 1 } Cardona, et. al. Expires - September 2003 [Page 19] Internet-Draft CableHome Gateway Configuration MIB March 2003 cabhCdpLanAddrEntry OBJECT-TYPE SYNTAX CabhCdpLanAddrEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "List of general parameters pertain to LAN-Trans IP address reservations and leases." INDEX { cabhCdpLanAddrIpType, cabhCdpLanAddrIp } ::= { cabhCdpLanAddrTable 1 } CabhCdpLanAddrEntry ::= SEQUENCE { cabhCdpLanAddrIpType InetAddressType, cabhCdpLanAddrIp InetAddress, cabhCdpLanAddrClientID CabhCdpLanTransDhcpClientId, cabhCdpLanAddrLeaseCreateTime DateAndTime, cabhCdpLanAddrLeaseExpireTime DateAndTime, cabhCdpLanAddrMethod INTEGER, cabhCdpLanAddrHostName SnmpAdminString, cabhCdpLanAddrRowStatus RowStatus } cabhCdpLanAddrIpType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS not-accessible STATUS current DESCRIPTION "The type of IP address assigned to the LAN IP Device in the LAN-Trans Realm." ::= { cabhCdpLanAddrEntry 1 } cabhCdpLanAddrIp OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS not-accessible STATUS current DESCRIPTION "The address assigned to the LAN IP Device. This parameter is entered by the CDP when the CDS grants a lease to a LAN IP Device in the LAN-Trans realm and creates a row in this table. Alternatively, this parameter can be entered by the NMS through the CMP, when the NMS creates a new DHCP address reservation. Each cabhCdpLanAddrIp in the table must fall within the range of IPs defined inclusively by cabhCdpLanPoolStart and cabhCdpLanPoolEnd. The PS must return an inconsistentValue error if the NMS attempts Cardona, et. al. Expires - September 2003 [Page 20] Internet-Draft CableHome Gateway Configuration MIB March 2003 to create a row entry with a cabhCdpLanAddrIP value that falls outside of this range or is not unique from all existing cabhCdpLanAddrIP entries in this table." ::= { cabhCdpLanAddrEntry 2 } cabhCdpLanAddrClientID OBJECT-TYPE SYNTAX CabhCdpLanTransDhcpClientId MAX-ACCESS read-create STATUS current DESCRIPTION "The Client ID as indicated in Option 61 of the DHCP Discover. There is a one-to-one relationship between the Client ID and the assigned LAN IP address. This parameter is entered by the CDP when the CDS grants a lease to a LAN IP Device in the LAN-Trans realm and creates a row in this table. Alternatively, this parameter can be entered by the NMS through the CMP, when the NMS creates a new DHCP address reservation. The PS must return an inconsistentValue error if the NMS attempts to create a row entry with a cabhCdpLanAddrClientID that is not unique from all existing cabhCdpLanAddrClientID entries in this table." ::= { cabhCdpLanAddrEntry 3 } cabhCdpLanAddrLeaseCreateTime OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-only STATUS current DESCRIPTION "This is the date and time that the LAN-Trans lease was created (if it has not yet been renewed) or last renewed." ::= { cabhCdpLanAddrEntry 4 } cabhCdpLanAddrLeaseExpireTime OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-only STATUS current DESCRIPTION "This is the date and time that the LAN-trans lease expired or will expire." ::= { cabhCdpLanAddrEntry 5 } cabhCdpLanAddrMethod OBJECT-TYPE SYNTAX INTEGER { reservationInactive (1), reservationActive (2), Cardona, et. al. Expires - September 2003 [Page 21] Internet-Draft CableHome Gateway Configuration MIB March 2003 dynamicInactive (3), dynamicActive (4) } MAX-ACCESS read-only STATUS current DESCRIPTION "The IP allocation method indicated by this row. reservationInactive(1) indicates a reserved IP that has not yet been leased or that has an expired lease. reservationActive(2) indicates a reserved IP that has an active lease. dynamicInactive(3) indicates an IP that was once dynamically assigned to a LAN-Trans device but currently has an expired lease. dynamicActive(4) indicates an IP that was dynamically assigned to a LAN-Trans device that has a current lease." ::= { cabhCdpLanAddrEntry 6 } cabhCdpLanAddrHostName OBJECT-TYPE SYNTAX SnmpAdminString(SIZE(0..80)) MAX-ACCESS read-only STATUS current DESCRIPTION "This is the Host Name of the LAN IP address, based on DCHP option 12." ::= { cabhCdpLanAddrEntry 7 } cabhCdpLanAddrRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The RowStatus interlock for creation and deletion of row entries. The PS must not allow the NMS to set RowStatus to notInService(2). The PS must assign a RowStatus of notInService(2) to any new row entry created with a non-unique, cabhCdpLanAddrClientID value. The PS must assign a RowStatus of notReady(3) to any new row entry created without a cabhCdpLanAddrClientID. The PS will prevent modification of this table's columns and return an inconsistentValue error, if the NMS attempts to make such modifications while the RowStatus is active(1)." ::= { cabhCdpLanAddrEntry 8 } --============================================================== -- Cardona, et. al. Expires - September 2003 [Page 22] Internet-Draft CableHome Gateway Configuration MIB March 2003 -- cabhCdpWanDataAddrTable (CDP WAN-Data Address Table) -- -- The cabhCdpWanDataAddrTable contains the configuration or DHCP -- parameters for each IP address mapping per WAN-Data IP Address. -- --============================================================== cabhCdpWanDataAddrTable OBJECT-TYPE SYNTAX SEQUENCE OF CabhCdpWanDataAddrEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains WAN-Data address realm information." ::= { cabhCdpAddr 2 } cabhCdpWanDataAddrEntry OBJECT-TYPE SYNTAX CabhCdpWanDataAddrEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "List of general parameter for CDP WAN-Data address realm." INDEX { cabhCdpWanDataAddrIndex } ::= { cabhCdpWanDataAddrTable 1 } CabhCdpWanDataAddrEntry ::= SEQUENCE { cabhCdpWanDataAddrIndex INTEGER, cabhCdpWanDataAddrClientId OCTET STRING, cabhCdpWanDataAddrIpType InetAddressType, cabhCdpWanDataAddrIp InetAddress, cabhCdpWanDataAddrRenewalTime Integer32, cabhCdpWanDataAddrRowStatus RowStatus } cabhCdpWanDataAddrIndex OBJECT-TYPE SYNTAX INTEGER (1..65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Index into table." ::= { cabhCdpWanDataAddrEntry 1 } cabhCdpWanDataAddrClientId OBJECT-TYPE SYNTAX OCTET STRING (SIZE (1..80)) MAX-ACCESS read-create STATUS current DESCRIPTION "A unique WAN-Data ClientID used when attempting the acquire a WAN-Data IP Address via DHCP." ::= { cabhCdpWanDataAddrEntry 2 } Cardona, et. al. Expires - September 2003 [Page 23] Internet-Draft CableHome Gateway Configuration MIB March 2003 cabhCdpWanDataAddrIpType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The address type assigned on the WAN-Data side." DEFVAL { ipv4 } ::= { cabhCdpWanDataAddrEntry 3 } cabhCdpWanDataAddrIp OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The address assigned on the WAN-Data side." ::= { cabhCdpWanDataAddrEntry 4 } cabhCdpWanDataAddrRenewalTime OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "This is the time remaining before the lease expires. This is based on DHCP Option 51." ::= { cabhCdpWanDataAddrEntry 5 } cabhCdpWanDataAddrRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The RowStatus interlock for creation and deletion of row entries. Any writable object in a row can be modified at any time while the row is active(1). The PS must assign a RowStatus of notInService(2) to any new row entry created with a cabhCdpWanDataAddrClientId that is not unique within this table." ::= { cabhCdpWanDataAddrEntry 6 } --============================================================== -- -- cabhCdpWanDnsServerTable (CDP WAN DNS Server Table) -- -- The cabhCdpWanDnsServerTable is a table of 3 cable network -- and internet DNS Servers. -- --============================================================== Cardona, et. al. Expires - September 2003 [Page 24] Internet-Draft CableHome Gateway Configuration MIB March 2003 cabhCdpWanDnsServerTable OBJECT-TYPE SYNTAX SEQUENCE OF CabhCdpWanDnsServerEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains the IP addresses of cable network and Internet DNS servers, in the order of preference in which the PS's CNP will Query them, when it cannot resolve a DNS query using local information. Entries in this table are updated with the information contained in DHCP Option 6, received during both the WAN-Man and WAN-Data IP acquisition processes." ::= { cabhCdpAddr 3 } cabhCdpWanDnsServerEntry OBJECT-TYPE SYNTAX CabhCdpWanDnsServerEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "List of cable network and Internet DNS servers." INDEX { cabhCdpWanDnsServerOrder } ::= { cabhCdpWanDnsServerTable 1 } CabhCdpWanDnsServerEntry ::= SEQUENCE { cabhCdpWanDnsServerOrder INTEGER, cabhCdpWanDnsServerIpType InetAddressType, cabhCdpWanDnsServerIp InetAddress } cabhCdpWanDnsServerOrder OBJECT-TYPE SYNTAX INTEGER { primary(1), secondary(2), tertiary(3) } MAX-ACCESS not-accessible STATUS current DESCRIPTION "The order of preference for cable network and Internet DNS servers, as listed in DHCP option 6 (Domain Server). Any time the CDC receives valid IP address information within DHCP Option 6, as part of lease acquisition or renewal of a WAN-Man or WAN-Data IP, it must update this information into this table. As entries in DHCP Option 6 are listed in order of preference the highest priority entry in DHCP Option 6 must correspond to the row with a cabhCdpWanDataAddrDnsOrder equal to 1. If DHCP Option 6 contains 2 valid IP addresses, the PS must update the rows with cabhCdpWanDataAddrDnsOrder values of 1 and 2. Cardona, et. al. Expires - September 2003 [Page 25] Internet-Draft CableHome Gateway Configuration MIB March 2003 If DHCP Option 6 contains 3 valid IP addresses, the PS must update rows with cabhCdpWanDataAddrDnsOrder values of 1, 2, and 3. Any DNS server information included in DHCP Option 6 beyond primary, secondary and tertiary will not be represented in this table." ::= { cabhCdpWanDnsServerEntry 1 } cabhCdpWanDnsServerIpType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "This parameter indicates the IP address of a WAN DNS server." DEFVAL {ipv4} ::= { cabhCdpWanDnsServerEntry 2 } cabhCdpWanDnsServerIp OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "This parameter indicates the IP address of the WAN DNS server." ::= { cabhCdpWanDnsServerEntry 3 } -- -- DHCP Server Side (CDS) Option Values for the LAN-Trans realm -- cabhCdpLanPoolStartType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "The Address type of the start of range LAN Trans IP Addresses." DEFVAL { ipv4 } ::= { cabhCdpServer 1 } cabhCdpLanPoolStart OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write STATUS current DESCRIPTION "The start of range LAN Trans IP Addresses." DEFVAL { 'c0a8000a'h } -- 192.168.0.10 Cardona, et. al. Expires - September 2003 [Page 26] Internet-Draft CableHome Gateway Configuration MIB March 2003 --192.168.0.0 is the network number -- 192.168.0.255 is broadcast -- address and 192.168.0.1 -- is reserved for the router ::= { cabhCdpServer 2 } cabhCdpLanPoolEndType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "The Address type of the end of range LAN Trans IP Addresses." DEFVAL { ipv4 } ::= { cabhCdpServer 3 } cabhCdpLanPoolEnd OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write STATUS current DESCRIPTION "The end of range for LAN-Trans IP Addresses." DEFVAL { 'c0a800fe'h } -- 192.168.0.254 ::= { cabhCdpServer 4 } cabhCdpServerNetworkNumberTypeOBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "The IP address type of the LAN-Trans network number." DEFVAL { ipv4 } ::= { cabhCdpServer 5 } cabhCdpServerNetworkNumber OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write STATUS current DESCRIPTION "The LAN-Trans network number." DEFVAL { 'c0a80000'h } ::= { cabhCdpServer 6 } cabhCdpServerSubnetMaskType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION Cardona, et. al. Expires - September 2003 [Page 27] Internet-Draft CableHome Gateway Configuration MIB March 2003 "Type of LAN-Trans Subnet Mask." DEFVAL { ipv4 } ::= { cabhCdpServer 7 } cabhCdpServerSubnetMask OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 1 - Value of LAN-Trans Subnet Mask." DEFVAL { 'ffffff00'h } -- 255.255.255.0 ::= { cabhCdpServer 8 } cabhCdpServerTimeOffset OBJECT-TYPE SYNTAX Integer32 (-86400..86400) -- 0 to 24 hours(seconds) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 2 - Value of LAN-Trans Time Offset from Universal Coordinated Time (UTC)." DEFVAL { 0 }-- UTC ::= { cabhCdpServer 9 } cabhCdpServerRouterType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "Type of Address, Router for the LAN-Trans address realm." DEFVAL { ipv4 } ::= { cabhCdpServer 10 } cabhCdpServerRouter OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 3 - Router for the LAN-Trans address realm." DEFVAL { 'c0a80001'h } -- 192.168.0.1 ::= { cabhCdpServer 11 } cabhCdpServerDnsAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "The Type of IP Addresses of the LAN-Trans address realm Cardona, et. al. Expires - September 2003 [Page 28] Internet-Draft CableHome Gateway Configuration MIB March 2003 DNS servers." DEFVAL { ipv4 } ::= { cabhCdpServer 12 } cabhCdpServerDnsAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write STATUS current DESCRIPTION "The IP Addresses of the LAN-Trans address realm DNS servers. As a default there is only one DNS server and it is the address specified in Option Value 3 - cabhCdpServerRouter. Only one address is specified." DEFVAL { 'c0a80001'h } -- 192.168.0.1 ::= { cabhCdpServer 13 } cabhCdpServerSyslogAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "The Type of IP Address of the LAN-Trans SYSLOG servers." DEFVAL { ipv4 } ::= { cabhCdpServer 14 } cabhCdpServerSyslogAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write STATUS current DESCRIPTION "The IP Addresses of the LAN-Trans SYSLOG servers. As a default there are no SYSLOG Servers. The factory defaults contains the indication of no Syslog Server value equals (0.0.0.0)." DEFVAL { '00000000'h } -- 0.0.0.0 ::= { cabhCdpServer 15 } cabhCdpServerDomainName OBJECT-TYPE SYNTAX SnmpAdminString(SIZE(0..128)) MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 15 - Domain name of LAN-Trans address realm." DEFVAL {""} ::= { cabhCdpServer 16 } cabhCdpServerTTL OBJECT-TYPE SYNTAX INTEGER (0..255) MAX-ACCESS read-write Cardona, et. al. Expires - September 2003 [Page 29] Internet-Draft CableHome Gateway Configuration MIB March 2003 STATUS current DESCRIPTION "Option value 23 - LAN-Trans Time to Live." DEFVAL { 64 } ::= { cabhCdpServer 17 } cabhCdpServerInterfaceMTU OBJECT-TYPE SYNTAX INTEGER (0| 68..4096) MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 26 - LAN-Trans Interface MTU. if the value of this object is 0, the PS must not include this option in its DHCP offer or DHCP Ack messages to LAN IP devices" DEFVAL {0} ::= { cabhCdpServer 18 } cabhCdpServerVendorSpecificOBJECT-TYPE SYNTAX OCTET STRING (SIZE(0..255)) MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 43 - Vendor Specific Options." DEFVAL { ''h } ::= { cabhCdpServer 19 } cabhCdpServerLeaseTime OBJECT-TYPE SYNTAX Unsigned32 UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 51 -Lease Time for LAN IP Devices in the LAN-Trans realm (seconds)." DEFVAL { 3600 } ::= { cabhCdpServer 20 } cabhCdpServerDhcpAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 54 - Type of LAN-Trans DHCP server IP address." DEFVAL { ipv4 } ::= { cabhCdpServer 21 } cabhCdpServerDhcpAddressOBJECT-TYPE SYNTAX InetAddress Cardona, et. al. Expires - September 2003 [Page 30] Internet-Draft CableHome Gateway Configuration MIB March 2003 MAX-ACCESS read-write STATUS current DESCRIPTION "Option value 54 - LAN-Trans DHCP server IP address. It defaults to the router address as specified in cabhCdpServerRouter. Alternatively a vendor may want to separate CDS address from router address." DEFVAL { 'c0a80001'h } -- 192.168.0.1 ::= { cabhCdpServer 22 } cabhCdpServerControl OBJECT-TYPE SYNTAX INTEGER { restoreConfig(1), commitConfig (2) } MAX-ACCESS read-write STATUS current DESCRIPTION "The control for the CDS (DHCP Server) configuration. All changes to the cabhCdpServer mib objects are reflected when reading the value of the mib objects; however, those changes are NOT applied to the running configuration of the CDS until they are successfully committed via use of the cabhCdpServerControl object. If changes are made to the cabhCdpServer mib objects which are not yet successfully committed to the CDS, the cabhCdpServerControl object can be used to rollback all changes to the last valid CDS configuration and discard all intermediate changes. restoreConfig - Setting cabhCdpServerControl to this value will cause any changes to the cabhCdpServer objects not yet committed be reset to the values from the current running configuration of the CDS. commitConfig - Setting cabhCdpServerControl to this value will cause the CDS to validate and apply the valid cabhCdpServer mib settings to its running configuration. The cabhCdpServerCommitStatus object will detail the status of this operation." DEFVAL { restoreConfig } ::= { cabhCdpServer 23 } cabhCdpServerCommitStatus OBJECT-TYPE SYNTAX INTEGER { commitSucceeded (1), commitNeeded (2), commitFailed (3) Cardona, et. al. Expires - September 2003 [Page 31] Internet-Draft CableHome Gateway Configuration MIB March 2003 } MAX-ACCESS read-only STATUS current DESCRIPTION "Indicates the status of commiting the current cabhCdpServer mib object values to the running configuration of the CDS (DHCP Server). commitSucceeded - indicates the current cabhCdpServer mib object values are valid and have been successfully committed to the running configuration of the CDS. commitNeeded - indicates that the value of one or more objects in cabhCdpServer mib group have been changed but not yet committed to the running configuration of the CDS. commitFailed - indicates the PS was unable to commit the cabhCdpServer mib object values to the running configuration of the CDS due to conflicts in those values." DEFVAL { commitSucceeded } ::= { cabhCdpServer 24 } -- -- notification group is for future extension. -- cabhCdpNotification OBJECT IDENTIFIER ::= { cabhCdpMib 2 } cabhCdpNotifications OBJECT IDENTIFIER ::= { cabhCdpNotification 0 } cabhCdpConformance OBJECT IDENTIFIER ::= { cabhCdpMib 3 } cabhCdpCompliances OBJECT IDENTIFIER ::= { cabhCdpConformance 1 } cabhCdpGroups OBJECT IDENTIFIER ::= { cabhCdpConformance 2 } -- -- Notification Group -- -- compliance statements cabhCdpBasicCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for devices that implement MTA feature." MODULE --cabhCdpMib Cardona, et. al. Expires - September 2003 [Page 32] Internet-Draft CableHome Gateway Configuration MIB March 2003 -- unconditionally mandatory groups MANDATORY-GROUPS { cabhCdpGroup } ::= { cabhCdpCompliances 3 } cabhCdpGroup OBJECT-GROUP OBJECTS { cabhCdpSetToFactory, cabhCdpLanTransCurCount, cabhCdpLanTransThreshold, cabhCdpLanTransAction, cabhCdpWanDataIpAddrCount, cabhCdpLanAddrClientID, cabhCdpLanAddrLeaseCreateTime, cabhCdpLanAddrLeaseExpireTime, cabhCdpLanAddrMethod, cabhCdpLanAddrHostName, cabhCdpLanAddrRowStatus, cabhCdpWanDataAddrClientId, cabhCdpWanDataAddrIpType, cabhCdpWanDataAddrIp, cabhCdpWanDataAddrRenewalTime, cabhCdpWanDataAddrRowStatus, cabhCdpWanDnsServerIpType, cabhCdpWanDnsServerIp, cabhCdpLanPoolStartType, cabhCdpLanPoolStart, cabhCdpLanPoolEndType, cabhCdpLanPoolEnd, cabhCdpServerNetworkNumberType, cabhCdpServerNetworkNumber, cabhCdpServerSubnetMaskType, cabhCdpServerSubnetMask, cabhCdpServerTimeOffset, Cardona, et. al. Expires - September 2003 [Page 33] Internet-Draft CableHome Gateway Configuration MIB March 2003 cabhCdpServerRouterType, cabhCdpServerRouter, cabhCdpServerDnsAddressType, cabhCdpServerDnsAddress, cabhCdpServerSyslogAddressType, cabhCdpServerSyslogAddress, cabhCdpServerDomainName, cabhCdpServerTTL, cabhCdpServerInterfaceMTU, cabhCdpServerVendorSpecific, cabhCdpServerLeaseTime, cabhCdpServerDhcpAddressType, cabhCdpServerDhcpAddress, cabhCdpServerControl, cabhCdpServerCommitStatus } STATUS current DESCRIPTION "Group of objects for CableHome CDB MIB." ::= { cabhCdpGroups 1 } END 5. Acknowlegements Roy Spitzer - Consultant Mike Mannette - Consultant Randy Dunton - Intel Dmitrii Loukianov - Intel Itay Sherman - Texas Instruments Chris Zacker - Broadcom Rick Vetter - Consultant John Bevilacqua - YAS Funding for the RFC Editor function is currently provided by the Internet Society. Cardona, et. al. Expires - September 2003 [Page 34] Internet-Draft CableHome Gateway Configuration MIB March 2003 6. Formal Syntax The following syntax specification uses the augmented Backus-Naur Form (BNF) as described in RFC-2234 [3]. 7. Security Considerations There are a number of management objects defined in this MIB that have 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. It is thus important to control even GET access to these objects and possibly to even encrypt the values of these objects when sending them over the network via SNMP. Not all versions of SNMP provide features for such a secure environment. 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), 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. 8. References 1 Bradner, S., "The Internet Standards Process -- Revision 3", BCP 9, RFC 2026, October 1996. 2 Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997 Cardona, et. al. Expires - September 2003 [Page 35] Internet-Draft CableHome Gateway Configuration MIB March 2003 3 Crocker, D. and Overell, P.(Editors), "Augmented BNF for Syntax Specifications: ABNF", RFC 2234, Internet Mail Consortium and Demon Internet Ltd., November 1997 4 Rose, M. and K. McCloghrie, "Structure and Identification of Management Information for TCP/IP-based Internets", STD 16, RFC 1155, May 1990. 5 Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16, RFC 1212, March 1991. 6 Rose, M., "A Convention for Defining Traps for use with the SNMP", RFC 1215, March 1991. 7 McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Structure of Management Information for Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 8 McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. 9 McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999. 10 Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple Network Management Protocol", STD 15, RFC 1157, May 1990. 11 Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Introduction to Community-based SNMPv2", RFC 1901, January 1996. 12 Case, J., Mundy, R., Partain, D, and B. Stewart, "Introduction and Applicability Statements for Internet Standard Management Framework", RFC 3410, December 2002. 13 Harrington D., Presuhn R. and B. Wijnen, "An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks", RFC 3411, December 2002. 14 Case, J., Harrington D., Presuhn R. and B. Wijnen, "Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)", RFC 3412, December 2002. 15 Levi, D., Meyer, P., and B. Stewart, "Simple Network Management Protocol (SNMP) Applications", RFC 3413, December 2002. Cardona, et. al. Expires - September 2003 [Page 36] Internet-Draft CableHome Gateway Configuration MIB March 2003 16 Blumenthal, U. and B. Wijnen, "User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)", RFC 3414, December 2002. 17 Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)", RFC 3415, December 2002. 18 Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Version 2 of the Protocol Operations for the Simple Network Management Protocol (SNMPv2)", RFC 3416, Decemeber 2002. 19 Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Transport Mappings for the Simple Network Management Protocol (SNMPv2)", RFC 3417, December 2002. 20 Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)", RFC 3418, December 2002. 21 Cable Television Laboratories, "CableHome 1.0 Specification", CH- SP-I02-020920, September 2002, http://www.cablelabs.com/projects/cablehome/specifications. 22 Drums, R., "Dynamic Host Configuration Protocol", RFC 2131, March 1997. 23 Sollins, K., "The TFTP Protocol (Revision 2)", RFC 1350, July 1992. 9. Intellectual Property The IETF takes no position regarding the validity or scope of any intellectual property 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; neither does it represent that it has made any effort to identify any such rights. Information on the IETF's procedures with respect to rights in standards-track and standards-related documentation can be found in BCP-11. Copies of claims of rights made available for publication 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 Secretariat. Cardona, et. al. Expires - September 2003 [Page 37] Internet-Draft CableHome Gateway Configuration MIB March 2003 The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to practice this standard. Please address the information to the IETF Executive Director. 10. Author's Addresses Eduardo Cardona Cable Television Laboratories 400 Centennial Parkway Louisville, CO 80027 Phone: +1 303.661.9100 Email: e.cardona@cablelabs.com Kevin Luehrs Cable Television Laboratories Louisville, CO 80027 Phone: +1 303.661.9100 Email: k.luehrs@cablelabs.com Diego Mazzola Texas Instrument Phone: +1 303.661.3310 Email: d-mazzola1@ti.com Doug Jones YAS Broadband Ventures 300 Brickstone Square Andover, MA 01810 Phone: +1 303.661.3823 Email: doug@yas.com 11. Full Copyright Statement Copyright (C) The Internet Society (2003). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be Cardona, et. al. Expires - September 2003 [Page 38] Internet-Draft CableHome Gateway Configuration MIB March 2003 followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS 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." Cardona, et. al. Expires - September 2003 [Page 39]