idnits 2.17.1 draft-ietf-ipcdn-cable-gateway-device-mib-00.txt: -(189): Line appears to be too long, but this could be caused by non-ascii characters in UTF-8 encoding -(1641): Line appears to be too long, but this could be caused by non-ascii characters in UTF-8 encoding -(1647): Line appears to be too long, but this could be caused by non-ascii characters in UTF-8 encoding Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == There are 11 instances of lines with non-ascii characters in the document. == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** The abstract seems to contain references ([21], [5], [6], [7]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. == There are 1 instance of lines with non-RFC2606-compliant FQDNs in the document. == There are 1 instance of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 705 has weird spacing: '...Council www.u...' == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (June 2003) is 7620 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Missing reference section? '1' on line 18 looks like a reference -- Missing reference section? '21' on line 272 looks like a reference -- Missing reference section? '5' on line 48 looks like a reference -- Missing reference section? '6' on line 48 looks like a reference -- Missing reference section? '7' on line 94 looks like a reference -- Missing reference section? '2' on line 56 looks like a reference -- Missing reference section? '12' on line 86 looks like a reference -- Missing reference section? '8' on line 94 looks like a reference -- Missing reference section? '9' on line 94 looks like a reference -- Missing reference section? '22' on line 109 looks like a reference -- Missing reference section? '23' on line 110 looks like a reference -- Missing reference section? '18' on line 267 looks like a reference -- Missing reference section? '13' on line 268 looks like a reference -- Missing reference section? '14' on line 268 looks like a reference -- Missing reference section? '24' on line 271 looks like a reference -- Missing reference section? '3' on line 1533 looks like a reference -- Missing reference section? 'RFC3410' on line 1556 looks like a reference Summary: 3 errors (**), 0 flaws (~~), 7 warnings (==), 19 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet-Draft E. Cardona 3 draft-ietf-ipcdn-cable-gateway-device-mib-00.txt K. Luehrs 4 Expires: December 2003 CableLabs 6 D. Jones 7 YAS BBV 9 June 2003 11 Cable Gateway Device Management Information Base 12 for CableHome compliant Residential Gateways 14 Status of this Memo 16 This document is an Internet-Draft and is subject to all provisions 17 of Section 10 of RFC2026 [1]. 19 Internet-Drafts are working documents of the Internet Engineering 20 Task Force (IETF), its areas, and its working groups. Note that 21 other groups may also distribute working documents as Internet- 22 Drafts. 24 Internet-Drafts are draft documents valid for a maximum of six months 25 and may be updated, replaced, or obsoleted by other documents at any 26 time. It is inappropriate to use Internet-Drafts as reference 27 material or to cite them other than as "work in progress." 29 The list of current Internet-Drafts can be accessed at 30 http://www.ietf.org/ietf/1id-abstracts.txt 32 The list of Internet-Draft Shadow Directories can be accessed at 33 http://www.ietf.org/shadow.html 35 Copyright Notice 37 Copyright (C) The Internet Society (2003). All Rights Reserved. 39 Abstract 41 This memo defines a portion of the Management Information Base (MIB) 42 for use with network management protocols in the Internet community. 43 In particular, it defines a basic set of managed objects for SNMP 44 based management of CableHome [21] compliant WAN Gateway Devices and 45 home routers. 47 This memo specifies a MIB module in a manner that is compliant to the 48 SNMP SMIv2 [5][6][7]. The set of objects is consistent with the SNMP 49 framework and existing SNMP standards. 51 Conventions used in this document 53 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 54 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 55 document are to be interpreted as described in RFC-2119 [2]. 57 Table of Contents 59 1. The Internet-Standard Management Framework.....................2 60 2. Glossary.......................................................3 61 2.1 CableHome Residential Gateway..............................3 62 2.2 Portal Services............................................3 63 2.3 LAN IP Device..............................................3 64 2.4 WAN Management (WAN-Man) Address...........................3 65 2.5 WAN Data (WAN-Data) Address................................3 66 2.6 LAN Translated (LAN-Trans) Address.........................3 67 2.7 LAN Passthrough (LAN-Pass) Address.........................4 68 2.8 Cable Gateway DHCP Portal (CDP)............................4 69 3. Overview.......................................................4 70 3.1 Structure of the MIB.......................................4 71 3.2 Management Requirements....................................5 72 4. MIB Definitions................................................7 73 5. Acknowledgements..............................................32 74 6. Formal Syntax.................................................32 75 7. Security Considerations.......................................32 76 8. Normative References..........................................33 77 9. Informative References........................................35 78 10. Intellectual Property........................................35 79 11. Author's Addresses...........................................36 80 12. Full Copyright Statement.....................................36 82 1. The Internet-Standard Management Framework 84 For a detailed overview of the documents that describe the current 85 Internet-Standard Management Framework, please refer to section 7 of 86 RFC 3410 [12]. 88 Managed objects are accessed via a virtual information store, termed 89 the Management Information Base or MIB. MIB objects are generally 90 accessed through the Simple Network Management Protocol (SNMP). 91 Objects in the MIB are defined using the mechanisms defined in the 92 Structure of Management Information (SMI). This memo specifies a MIB 93 module that is compliant to the SMIv2, which is described in STD 58, 94 RFC 2578 [7], STD 58, RFC 2579 [8] and STD 58, RFC 2580 [9]. 96 2. Glossary 98 The terms in this document are derived either from normal cable 99 system usage, from normal residential gateway operation, or from the 100 documents associated with the CableHome Specifications [21]. 102 2.1 CableHome Residential Gateway 104 A CableHome Residential gateway passes data traffic between the cable 105 operator's broadband data network (the Wide Area Network, WAN) and 106 the Local Area Network (LAN) in the cable data service subscriber's 107 residence or business. In addition to passing traffic between the WAN 108 and LAN, the CableHome Residential Gateway provides several services 109 including a DHCP client and a DHCP server (RFC2131) [22], a TFTP 110 server (RFC1350) [23], management services as enabled by 111 SNMPv1/v2c/v3 agent compliant with the RFCs listed in Section 1, and 112 security services including stateful packet inspection firewall 113 functionality and software code image verification using techniques. 115 2.2 Portal Services 117 A logical element aggregating the set of CableHome-specified 118 functionality in a CableHome compliant cable gateway device. 120 2.3 LAN IP Device 122 A LAN IP Device is representative of a typical IP device expected to 123 reside on home networks, and is assumed to contain a TCP/IP stack as 124 well as a DHCP client. 126 2.4 WAN Management (WAN-Man) Address 128 WAN Management Addresses are intended for network management traffic 129 on the cable network between the network management system and the PS 130 element. Typically, these addresses will reside in private IP address 131 space. 133 2.5 WAN Data (WAN-Data) Address 135 WAN Data Addresses are intended for subscriber application traffic on 136 the cable network and beyond, such as traffic between LAN IP Devices 137 and Internet hosts. Typically, these addresses will reside in public 138 IP address space. 140 2.6 LAN Translated (LAN-Trans) Address 141 LAN Translated Addresses are intended for subscriber application and 142 management traffic on the home network between LAN IP Devices and the 143 PS element. Typically, these addresses will reside in private IP 144 address space, and can typically be reused across subscribers. 146 2.7 LAN Passthrough (LAN-Pass) Address 148 LAN Passthrough Addresses are intended for subscriber application 149 traffic, such as traffic between LAN IP Devices and Internet hosts, 150 on the home network, the cable network, and beyond. Typically, these 151 addresses will reside in public IP address space. 153 2.8 Cable Gateway DHCP Portal (CDP) 155 A logical element residing within the PS that encapsulates DHCP 156 functionality within a Cable Gateway Device. This includes both DHCP 157 client as well as DHCP server capabilities. 159 3. Overview 161 This MIB provides a set of objects required for the management of 162 CableHome compliant residential gateway (RG) devices. The 163 specification is derived from the CableHome Specification [21]. 165 3.1 Structure of the MIB 167 Two MIBs are included in this Internet-Draft. The first, CABH-DEV- 168 MIB, is a stub under which the following CableHome MIBs are grouped: 170 draft-jones-cable-gateway-addressing-mib-01 171 draft-jones-cable-gateway-config-mib-01 172 draft-jones-cable-gateway-device-mib-01 173 draft-jones-cable-gateway-security-mib-01 174 draft-jones-cable-gateway-qos-mib-00 175 draft-jones-cable-gateway-tools-mib-01 177 The second MIB, CABH-PS-DEV-MIB, contains the set of objects to 178 manage a CableHome Residential Gateway Device. This MIB is 179 structured into three groups and is described in the remainder of 180 this section: 182 � The cabhPsDevBase group extends the CableLabs projects-CableHome 183 group with objects needed to implement and configure the CableHome 184 Portal Services set of functions. 186 � The cabhPsDevProv Group provides objects allowing the manager to 187 configure residential gateway device provisioning parameters. 189 � The cabhPsNotification group provides SNMP notification objects for 190 the reporting of Portal Services status and exception conditions. 192 3.2 Management Requirements 194 3.2.1. Portal Services device-specific parameters 196 The PsDevBase group consists largely of read-only parameters 197 providing information specific to the device, primarily for 198 identification purposes. By reading these parameters the device 199 manager can gain unique identification information about the cable 200 gateway device in which the Portal Services set of functions resides. 202 In addition to device-specific identification parameters the 203 PsDevBase group provides device-specific provisioning and operating 204 parameters such as the current date and time and time of day 205 synchronization status indicator. 207 The PsDevBase group also includes manager-controlled parameters 208 enabling the reset of the Portal Services functionality and enabling 209 the reset of cable gateway device MIB objects to their default values 210 without resetting all Portal Services functionality. 212 3.2.2 Portal Services provisioning parameters 214 The second group of OIDs in the Cable Gateway Device MIB, the 215 PsDevProv group, includes parameters required by Portal Services 216 functions that are responsible for provisioning processes, 217 particularly the Portal Services configuration file download 218 processes. 220 The provisioning process, described in Section 13 of [21], is timed 221 so that it does not get stuck waiting for a failed process to 222 complete. The timeout value for the provisioning process is 223 configurable by the manager but has a default value of 5 minutes. 225 When the Portal Services is configured to operate in the DHCP 226 Provisioning mode as described in Section 5.5 and Section 7.1.1 of 227 [21], it is required to download via TFTP a file containing zero or 228 more configuration parameters. The name in URL format and location of 229 this configuration file are passed to the Portal Services in a DHCP 230 Option field. The file name and location are stored in PsDevProv 231 objects for retrieval by the manager using the management messaging 232 interface between the manager's console and the Portal Services 233 element. Also stored are the length of the configuration file and the 234 number of Type-Length-Value (TLV) fields passed in the configuration 235 file, and the number of those TLV fields that were rejected by the 236 configuration file processing function. These parameters allow the 237 manager to verify that configuration parameters he or she passed to 238 the Portal Services element were received and processed correctly. 240 Integrity of the Portal Services configuration file is verified 241 through the use of a SHA-1 hash value. This process is described in 242 Section 7.3.3.3.1 in [21]. The hash value used to verify the 243 integrity of the configuration file is stored and is accessible to 244 the manager via an object of the PsDevProv group. 246 The PsDevProv group also includes status parameters such as an 247 indication about the progress of the provisioning process, the 248 configuration file name and location (URL format), hash value for 249 configuration file integrity checking, and the size of the 250 configuration file. The PsDevProv group also includes statistics for 251 tracking the number of Type-Length-Value (TLV) fields passed in the 252 PS configuration file and whether those TLVs were processed or 253 rejected. This group also contains objects for keeping track of 254 whether the file was authenticated, and an object to store the 255 timeout value for the authentication process key exchange. 257 The location of the Time of Day server, passed from the cable data 258 network DHCP server to the Portal Services element in a DHCP option 259 code, is stored by the Portal Services and accessible to the manager 260 via an object in the PsDevProv group. 262 3.2.3. Portal Services Notification objects 264 The Portal Services element is required to report about exception 265 conditions that occur as well as to report on the status of certain 266 parameters. CableHome specifications defines four ways to report 267 these events: SNMP trap as defined in RFC3416 [18] or SNMP 268 notification described in RFC3411 [13] and RFC3412 [14], reporting to 269 a SYSLOG server, writing to a volatile local log, or writing to a 270 nonvolatile local log. Local log information is accessible to the 271 manager via the DOCSIS device MIB, RFC2669 [24]. The CableHome event 272 reporting process is described in Section 6.5 of [21], and defined 273 events are listed in Appendix II Format and Content for Event, SYSLOG 274 and SNMP Trap, in the same reference. 276 4. MIB Definitions 278 CABH-IETF-PS-DEV-MIB DEFINITIONS ::= BEGIN 280 IMPORTS 281 MODULE-IDENTITY, 282 OBJECT-TYPE, 283 Integer32, 284 NOTIFICATION-TYPE, 285 mib-2 FROM SNMPv2-SMI 287 TruthValue, 288 PhysAddress, 289 DateAndTime, 290 TimeStamp FROM SNMPv2-TC 292 SnmpAdminString FROM SNMP-FRAMEWORK-MIB 294 OBJECT-GROUP, 295 MODULE-COMPLIANCE, 296 NOTIFICATION-GROUP FROM SNMPv2-CONF 298 InetAddressType, 299 InetAddress FROM INET-ADDRESS-MIB 301 IANAifType FROM IANAifType-MIB 303 docsDevSwCurrentVers, 304 docsDevEvLevel, 305 docsDevEvId, 306 docsDevEvText, 307 docsDevSwFilename, 308 docsDevSwServer FROM DOCS-CABLE-DEVICE-MIB -- RFC2669 310 cabhCdpServerDhcpAddress, 311 cabhCdpWanDataAddrClientId, 312 cabhCdpLanTransThreshold, 313 cabhCdpLanTransCurCount FROM CABH-IETF-CDP-MIB 315 ZeroBasedCounter32 FROM RMON2-MIB; 317 cabhPsDevMib MODULE-IDENTITY 318 LAST-UPDATED "200306210000Z" -- Jun 21, 2003 319 ORGANIZATION "IETF IPCDN Working Group" 320 CONTACT-INFO 321 "Kevin Luehrs 322 Postal: Cable Television Laboratories, Inc. 324 400 Centennial Parkway 325 Louisville, Colorado 80027-1266 326 U.S.A. 327 Phone: +1 303-661-9100 328 Fax: +1 303-661-9199 329 E-mail: k.luehrs@cablelabs.com; mibs@cablelabs.com 331 IETF IPCDN Working Group 332 General Discussion: ipcdn@ietf.org 333 Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn 334 Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn 335 Co-chairs: Richard Woundy, 336 Richard_Woundy@cable.comcast.com 337 Jean-Francois Mule, jf.mule@cablelabs.com" 338 DESCRIPTION 339 "This MIB module supplies the basic management objects 340 for the Portal Services logical element of a CableHome 341 compliant Residential Gateway device. The PS device 342 parameters describe general PS Device attributes and 343 behavior characteristics. 344 Most of the PS Device MIB is needed for configuration 345 download. 347 Copyright (C) The Internet Society (2003). This version 348 of this MIB module is part of RFC xxxx; see the RFC 349 itself for full legal notices." 350 REVISION "200306210000Z" -- Jun 21, 2003 351 DESCRIPTION 352 "Initial version, published as RFC xxxx." 353 -- RFC editor to assign xxxx 354 ::= { mib-2 xx } 355 -- xx to be assigned by IANA 357 -- Textual Conventions 359 cabhPsDevMibObjects OBJECT IDENTIFIER ::= { cabhPsDevMib 1 } 360 cabhPsDevBase OBJECT IDENTIFIER ::= { cabhPsDevMibObjects 1 } 361 cabhPsDevProv OBJECT IDENTIFIER ::= { cabhPsDevMibObjects 2 } 362 cabhPsDevAttrib OBJECT IDENTIFIER ::= { cabhPsDevMibObjects 3 } 363 cabhPsDevPsAttrib OBJECT IDENTIFIER ::= { cabhPsDevAttrib 1 } 364 cabhPsDevBpAttrib OBJECT IDENTIFIER ::= { cabhPsDevAttrib 2 } 365 cabhPsDevPsStats OBJECT IDENTIFIER ::= { cabhPsDevMibObjects 4 } 367 -- 368 -- The following group describes the base objects in the PS. 369 -- These are device based parameters. 370 -- 372 cabhPsDevDateTime OBJECT-TYPE 373 SYNTAX DateAndTime 374 MAX-ACCESS read-write 375 STATUS current 376 DESCRIPTION 377 "The date and time, with optional timezone information." 378 ::= { cabhPsDevBase 1 } 380 cabhPsDevResetNow OBJECT-TYPE 381 SYNTAX TruthValue 382 MAX-ACCESS read-write 383 STATUS current 384 DESCRIPTION 385 "Setting this object to true(1) causes the stand-alone or 386 embedded PS device to reboot. Device code initializes as 387 if starting from a power-on reset. The CMP ensures that 388 MIB object values persist as specified in Appendix I of 389 the CableHome 1.0 specification. Reading this object 390 always returns false(2)." 391 ::= { cabhPsDevBase 2 } 393 cabhPsDevSerialNumber OBJECT-TYPE 394 SYNTAX SnmpAdminString (SIZE (0..128)) 395 MAX-ACCESS read-only 396 STATUS current 397 DESCRIPTION 398 "The manufacturer's serial number for this PS. This 399 parameter is manufacturer provided and is stored in 400 non-volatile memory." 401 ::= { cabhPsDevBase 3 } 403 cabhPsDevHardwareVersion OBJECT-TYPE 404 SYNTAX SnmpAdminString (SIZE (0..48)) 405 MAX-ACCESS read-only 406 STATUS current 407 DESCRIPTION 408 "The manufacturer's hardware version for this PS. This 409 parameter is manufacturer provided and is stored in 410 non-volatile memory." 411 ::= { cabhPsDevBase 4 } 413 cabhPsDevWanManMacAddress OBJECT-TYPE 414 SYNTAX PhysAddress (SIZE (0..16)) 415 MAX-ACCESS read-only 416 STATUS current 417 DESCRIPTION 418 "The PS WAN-Man MAC address. This is the PS hardware 419 address to be used by the CDC to uniquely identify the PS 420 to the cable data network DHCP server for the acquisition 421 of an IP address to be used for management messaging 422 between the cable network NMS and the CMP." 424 ::= { cabhPsDevBase 5 } 426 cabhPsDevWanDataMacAddress OBJECT-TYPE 427 SYNTAX PhysAddress (SIZE (0..16)) 428 MAX-ACCESS read-only 429 STATUS current 430 DESCRIPTION 431 "The PS WAN-Data MAC address. The PS could have multiple 432 WAN-Data Interfaces, which share the same hardware 433 address. The client identifiers will be unique so that 434 each may be assigned a different, unique IP address." 435 ::= { cabhPsDevBase 6 } 437 cabhPsDevTypeIdentifier OBJECT-TYPE 438 SYNTAX SnmpAdminString 439 MAX-ACCESS read-only 440 STATUS current 441 DESCRIPTION 442 "This is a copy of the device type identifier used in 443 the DHCP option 60 exchanged between the PS and the DHCP 444 server." 445 REFERENCE 446 "CableHome 1.0 Specification, CH-SP-I04-030411, 447 7.2.3.3 CDC Requirements 448 CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 449 7.3.3.2.3 CDC Function System Description" 450 ::= { cabhPsDevBase 7 } 452 cabhPsDevSetToFactory OBJECT-TYPE 453 SYNTAX TruthValue 454 MAX-ACCESS read-write 455 STATUS current 456 DESCRIPTION 457 "Setting this object to true(1) sets all PsDev MIB 458 objects to the factory default values. Reading this 459 object always returns false(2)." 460 ::= { cabhPsDevBase 8 } 462 cabhPsDevTodSyncStatus OBJECT-TYPE 463 SYNTAX TruthValue 464 MAX-ACCESS read-only 465 STATUS current 466 DESCRIPTION 467 "This object indicates whether the PS was able to 468 successfully synchronize with the Time of Day (ToD)Server 469 in the cable network. The PS sets this object to true(1) 470 if the PS successfully synchronizes its time with the ToD 471 server. The PS sets this object to false(2) if the PS 472 does not successfully synchronize with the ToD server" 473 DEFVAL { false } 474 ::= { cabhPsDevBase 10 } 476 cabhPsDevProvMode OBJECT-TYPE 477 SYNTAX INTEGER 478 { 479 dhcpmode(1), 480 snmpmode(2), 481 dormantCHmode(3) 482 } 483 MAX-ACCESS read-only 484 STATUS current 485 DESCRIPTION 486 "This object indicates the provisioning mode in which the 487 PS is operating. If the PS is operating in DHCP 488 Provisioning Mode as described in the CableHome 1.1 489 specification, the PS sets this object to dhcpmode(1). 490 If the PS is operating in SNMP Provisioning Mode, the PS 491 sets this object to snmpmode(2).If the PS is not 492 configured to operate in either dhcpmode or snmpmode it 493 will fall back to Dormant CableHome Mode and set the 494 value of cabhPsDevProvMode to dormantCHmode(3)." 495 ::={ cabhPsDevBase 11 } 497 cabhPsDevLastSetToFactory OBJECT-TYPE 498 SYNTAX TimeStamp 499 MAX-ACCESS read-only 500 STATUS current 501 DESCRIPTION 502 "The value of sysUpTime when cabhPsDevSetToFactory was last 503 set to true. Zero if never reset." 504 ::= { cabhPsDevBase 12 } 506 -- 507 -- The following group defines Provisioning Specific parameters 508 -- 510 cabhPsDevProvisioningTimer OBJECT-TYPE 511 SYNTAX INTEGER (0..16383) 512 UNITS "minutes" 513 MAX-ACCESS read-write 514 STATUS current 515 DESCRIPTION 516 "This object enables the user to set the duration of the 517 provisioning timeout timer. The value is in minutes. 518 Setting the timer to 0 disables it. The default value for 519 the timer is 5." 520 DEFVAL {5} 521 ::= {cabhPsDevProv 1} 523 cabhPsDevProvConfigFile OBJECT-TYPE 524 SYNTAX SnmpAdminString (SIZE(1..128)) 525 MAX-ACCESS read-write 526 STATUS current 527 DESCRIPTION 528 "The URL of the TFTP host for downloading provisioning and 529 configuration parameters to this device. Returns NULL if the 530 server address is unknown." 531 ::= { cabhPsDevProv 2 } 533 cabhPsDevProvConfigHash OBJECT-TYPE 534 SYNTAX OCTET STRING (SIZE(0|20)) 535 MAX-ACCESS read-write 536 STATUS current 537 DESCRIPTION 538 "Hash of the contents of the config file, which is 539 calculated and sent by the NMS to the PS. For the SHA-1 540 authentication algorithm the hash length is 160 bits. 541 This hash value is encoded in the binary format." 542 DEFVAL {''h} 543 ::= { cabhPsDevProv 3 } 545 cabhPsDevProvConfigFileSize OBJECT-TYPE 546 SYNTAX Integer32 547 UNITS "bytes" 548 MAX-ACCESS read-only 549 STATUS current 550 DESCRIPTION 551 "Size of the configuration file." 552 ::={ cabhPsDevProv 4 } 554 cabhPsDevProvConfigFileStatus OBJECT-TYPE 555 SYNTAX INTEGER 556 { 557 idle(1), 558 busy(2) 559 } 560 MAX-ACCESS read-only 561 STATUS current 562 DESCRIPTION 563 "This object indicates the current status of the 564 configuration file download process. It is provided to 565 indicate to the management entity that the PS will 566 reject PS Configuration File triggers (set request to 567 cabhPsDevProvConfigFile) when busy." 568 ::={ cabhPsDevProv 5 } 570 cabhPsDevProvConfigTLVProcessed OBJECT-TYPE 571 SYNTAX INTEGER (0..16383) 572 MAX-ACCESS read-only 573 STATUS current 574 DESCRIPTION 575 "Number of TLVs processed in config file." 576 ::={ cabhPsDevProv 6 } 578 cabhPsDevProvConfigTLVRejected OBJECT-TYPE 579 SYNTAX INTEGER (0..16383) 580 MAX-ACCESS read-only 581 STATUS current 582 DESCRIPTION 583 "Number of TLVs rejected in config file." 584 ::={ cabhPsDevProv 7 } 586 cabhPsDevProvSolicitedKeyTimeout OBJECT-TYPE 587 SYNTAX Integer32 (15..600) 588 UNITS "seconds" 589 MAX-ACCESS read-write 590 STATUS current 591 DESCRIPTION 592 "This timeout applies only when the Provisioning Server 593 initiated key management (with a Wake Up message) for 594 SNMPv3. It is the period during which the PS will save 595 a number (inside the sequence number field) from the sent 596 out AP Request and wait for the matching AP Reply from 597 the Provisioning Server." 598 DEFVAL { 120 } 599 ::= { cabhPsDevProv 8 } 601 cabhPsDevProvState OBJECT-TYPE 602 SYNTAX INTEGER 603 { 604 pass(1), 605 inProgress(2), 606 fail(3) 607 } 608 MAX-ACCESS read-only 609 STATUS current 610 DESCRIPTION 611 "This object indicates the completion state of the 612 initialization process. Pass or Fail states occur after 613 completion of the initialization flow. InProgress occurs 614 from PS initialization start to PS initialization end." 615 ::= { cabhPsDevProv 9 } 617 cabhPsDevProvAuthState OBJECT-TYPE 618 SYNTAX INTEGER 619 { 620 accepted(1), 621 rejected(2) 622 } 623 MAX-ACCESS read-only 624 STATUS current 625 DESCRIPTION 626 "This object indicates the authentication state of the 627 configuration file." 628 ::= { cabhPsDevProv 10 } 630 cabhPsDevTimeServerAddrType OBJECT-TYPE 631 SYNTAX InetAddressType 632 MAX-ACCESS read-only 633 STATUS current 634 DESCRIPTION 635 "The IP address type of the Time server (RFC-868). 636 IP version 4 is typically used." 637 ::= { cabhPsDevProv 12 } 639 cabhPsDevTimeServerAddr OBJECT-TYPE 640 SYNTAX InetAddress 641 MAX-ACCESS read-only 642 STATUS current 643 DESCRIPTION 644 "The IP address of the Time server (RFC-868). Returns 645 0.0.0.0 if the time server IP address is unknown." 646 ::= { cabhPsDevProv 13 } 648 --============================================================== 649 -- 650 -- PS Device Profile Group 651 -- 652 -- The cabhPsDevPsProfile contains the Residential Gateway's 653 -- device attributes. This set of attributes is analogous to 654 -- some attributes of the BP Device profile. 655 -- 656 --============================================================== 658 cabhPsDevPsDeviceType OBJECT-TYPE 659 SYNTAX SnmpAdminString (SIZE(1..32)) 660 MAX-ACCESS read-only 661 STATUS current 662 DESCRIPTION 663 "The type of device, as defined in the CableHome 664 specifications (Residential Gateway Device or CableHome 665 Host Device), that implements this OID." 666 DEFVAL { "CableHome Residential Gateway" } 667 ::= { cabhPsDevPsAttrib 1 } 669 cabhPsDevPsManufacturerUrl OBJECT-TYPE 670 SYNTAX SnmpAdminString (SIZE(0..32)) 671 MAX-ACCESS read-only 672 STATUS current 673 DESCRIPTION 674 "Universal Resource Locator to the Residential Gateway 675 device manufacturer's web site." 676 REFERENCE 677 "CableHome 1.1 Specification, CH1.1-SP-I01-030418, 678 6.5.3.1.3 Device Profile Description" 679 DEFVAL { "" } 680 ::= { cabhPsDevPsAttrib 3 } 682 cabhPsDevPsModelUrl OBJECT-TYPE 683 SYNTAX SnmpAdminString (SIZE(0..32)) 684 MAX-ACCESS read-only 685 STATUS current 686 DESCRIPTION 687 "Universal Resource Locator to the web site describing 688 this CableHome compliant residential gateway device." 689 REFERENCE 690 "CableHome 1.1 Specification, CH1.1-SP-I01-030418, 691 6.5.3.1.3 Device Profile Description" 692 DEFVAL { "" } 693 ::= { cabhPsDevPsAttrib 7 } 695 cabhPsDevPsModelUpc OBJECT-TYPE 696 SYNTAX SnmpAdminString (SIZE(0..32)) 697 MAX-ACCESS read-only 698 STATUS current 699 DESCRIPTION 700 "Universal Product Code of the CableHome compliant 701 residential gateway device." 702 REFERENCE 703 "CableHome 1.1 Specification, CH1.1-SP-I01-030418, 704 6.5.3.1.3 Device Profile Description. 705 See also: Uniform Code Council www.uc-council.org" 706 DEFVAL { "" } 707 ::= { cabhPsDevPsAttrib 8 } 709 --=================================================================== 710 -- 711 -- CableHome Host/BP Device Profile Table 712 -- 713 -- The cabhPsDevBpProfile contains the list of the CableHome Host 714 -- device attributes provided to the PS by BPs passing their Device 715 -- Profile XML schema via SOAP/HTTP. 716 -- 717 --=================================================================== 719 cabhPsDevBpProfileTable OBJECT-TYPE 720 SYNTAX SEQUENCE OF CabhPsDevBpProfileEntry 721 MAX-ACCESS not-accessible 722 STATUS current 723 DESCRIPTION 724 "This table contains the information for the CableHome 725 Host Device Profiles. Attributes of a device make up a 726 Device Profile." 727 ::= { cabhPsDevBpAttrib 1 } 729 cabhPsDevBpProfileEntry OBJECT-TYPE 730 SYNTAX CabhPsDevBpProfileEntry 731 MAX-ACCESS not-accessible 732 STATUS current 733 DESCRIPTION 734 "The table that describes the CableHome Host Device 735 Profile." 736 INDEX { cabhPsDevBpIndex } 737 ::= { cabhPsDevBpProfileTable 1 } 739 CabhPsDevBpProfileEntry ::= SEQUENCE { 740 cabhPsDevBpIndex INTEGER, 741 cabhPsDevBpDeviceType SnmpAdminString, 742 cabhPsDevBpManufacturer SnmpAdminString, 743 cabhPsDevBpManufacturerUrl SnmpAdminString, 744 cabhPsDevBpSerialNumber SnmpAdminString, 745 cabhPsDevBpHardwareVersion SnmpAdminString, 746 cabhPsDevBpHardwareOptions SnmpAdminString, 747 cabhPsDevBpModelName SnmpAdminString, 748 cabhPsDevBpModelNumber SnmpAdminString, 749 cabhPsDevBpModelUrl SnmpAdminString, 750 cabhPsDevBpModelUpc SnmpAdminString, 751 cabhPsDevBpModelSoftwareOs SnmpAdminString, 752 cabhPsDevBpModelSoftwareVersion SnmpAdminString, 753 cabhPsDevBpLanInterfaceType IANAifType, 754 cabhPsDevBpNumberInterfacePriorities INTEGER, 755 cabhPsDevBpPhysicalLocation SnmpAdminString, 756 cabhPsDevBpPhysicalAddress PhysAddress 757 } 759 cabhPsDevBpIndex OBJECT-TYPE 760 SYNTAX INTEGER (1..65535) 761 MAX-ACCESS not-accessible 762 STATUS current 763 DESCRIPTION 764 "Integer index into the CableHome Host Device Profile 765 Table" 766 ::= { cabhPsDevBpProfileEntry 1 } 768 cabhPsDevBpDeviceType OBJECT-TYPE 769 SYNTAX SnmpAdminString (SIZE(0..32)) 770 MAX-ACCESS read-only 771 STATUS current 772 DESCRIPTION 773 "The type of device, as defined by the CableHome 774 specifications (CableHome Residential Gateway or 775 CableHome 776 Host Device), that passed the Device Profile whose 777 information is made available through this table row." 778 REFERENCE 779 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 780 6.5.3.1.3 Device Profile Description" 781 DEFVAL { "CableHome Host" } 782 ::= { cabhPsDevBpProfileEntry 2 } 784 cabhPsDevBpManufacturer OBJECT-TYPE 785 SYNTAX SnmpAdminString (SIZE(0..32)) 786 MAX-ACCESS read-only 787 STATUS current 788 DESCRIPTION 789 "The name of the CableHome Host Device's manufacturer." 790 REFERENCE 791 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 792 6.5.3.1.3 Device Profile Description" 793 DEFVAL { "" } 794 ::= { cabhPsDevBpProfileEntry 3 } 796 cabhPsDevBpManufacturerUrl OBJECT-TYPE 797 SYNTAX SnmpAdminString (SIZE(0..32)) 798 MAX-ACCESS read-only 799 STATUS current 800 DESCRIPTION 801 "Universal Resource Locator to the CableHome Host device 802 manufacturer's web site." 803 REFERENCE 804 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 805 6.5.3.1.3 Device Profile Description" 806 DEFVAL { "" } 807 ::= { cabhPsDevBpProfileEntry 4 } 809 cabhPsDevBpSerialNumber OBJECT-TYPE 810 SYNTAX SnmpAdminString (SIZE(0..32)) 811 MAX-ACCESS read-only 812 STATUS current 813 DESCRIPTION 814 "The serial number assigned by the manufacturer for this 815 CableHome Host Device." 816 DEFVAL { "" } 817 ::= { cabhPsDevBpProfileEntry 5 } 819 cabhPsDevBpHardwareVersion OBJECT-TYPE 820 SYNTAX SnmpAdminString (SIZE(0..32)) 821 MAX-ACCESS read-only 822 STATUS current 823 DESCRIPTION 824 "The hardware version number assigned by the manufacturer 825 for this CableHome Host Device." 826 REFERENCE 827 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 828 6.5.3.1.3 Device Profile Description" 829 DEFVAL { '00'h } 830 ::= { cabhPsDevBpProfileEntry 6 } 832 cabhPsDevBpHardwareOptions OBJECT-TYPE 833 SYNTAX SnmpAdminString (SIZE(0..32)) 834 MAX-ACCESS read-only 835 STATUS current 836 DESCRIPTION 837 "The hardware options implemented on this CableHome Host 838 Device." 839 REFERENCE 840 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 841 6.5.3.1.3 Device Profile Description" 842 DEFVAL { "" } 843 ::= { cabhPsDevBpProfileEntry 7 } 845 cabhPsDevBpModelName OBJECT-TYPE 846 SYNTAX SnmpAdminString (SIZE(0..32)) 847 MAX-ACCESS read-only 848 STATUS current 849 DESCRIPTION 850 "The model name assigned by the manufacturer for this 851 CableHome Host Device." 852 REFERENCE 853 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 854 6.5.3.1.3 Device Profile Description" 855 DEFVAL { "" } 856 ::= { cabhPsDevBpProfileEntry 8 } 858 cabhPsDevBpModelNumber OBJECT-TYPE 859 SYNTAX SnmpAdminString (SIZE(0..32)) 860 MAX-ACCESS read-only 861 STATUS current 862 DESCRIPTION 863 "The model number assigned by the manufacturer for this 864 CableHome Host Device." 865 REFERENCE 866 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 867 6.5.3.1.3 Device Profile Description" 868 DEFVAL { "" } 869 ::= { cabhPsDevBpProfileEntry 9 } 871 cabhPsDevBpModelUrl OBJECT-TYPE 872 SYNTAX SnmpAdminString (SIZE(0..32)) 873 MAX-ACCESS read-only 874 STATUS current 875 DESCRIPTION 876 "The Universal Resource Locator to the web site 877 describing this CableHome Host Device model." 878 REFERENCE 879 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 880 6.5.3.1.3 Device Profile Description" 881 DEFVAL { "" } 882 ::= { cabhPsDevBpProfileEntry 10 } 884 cabhPsDevBpModelUpc OBJECT-TYPE 885 SYNTAX SnmpAdminString (SIZE(0..32)) 886 MAX-ACCESS read-only 887 STATUS current 888 DESCRIPTION 889 "Universal Product Code of the CableHome Host Device." 890 REFERENCE 891 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 892 6.5.3.1.3 Device Profile Description" 893 DEFVAL { "" } 894 ::= { cabhPsDevBpProfileEntry 11 } 896 cabhPsDevBpModelSoftwareOs OBJECT-TYPE 897 SYNTAX SnmpAdminString (SIZE(0..32)) 898 MAX-ACCESS read-only 899 STATUS current 900 DESCRIPTION 901 "Software operating system implemented on the CableHome 902 Host Device." 903 REFERENCE 904 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 905 6.5.3.1.3 Device Profile Description" 906 DEFVAL { "" } 907 ::= { cabhPsDevBpProfileEntry 12 } 909 cabhPsDevBpModelSoftwareVersion OBJECT-TYPE 910 SYNTAX SnmpAdminString (SIZE(0..32)) 911 MAX-ACCESS read-only 912 STATUS current 913 DESCRIPTION 914 "Version of the operating system implemented on the 915 CableHome Host Device." 917 REFERENCE 918 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 919 6.5.3.1.3 Device Profile Description" 920 DEFVAL { "" } 921 ::= { cabhPsDevBpProfileEntry 13 } 923 cabhPsDevBpLanInterfaceType OBJECT-TYPE 924 SYNTAX IANAifType 925 MAX-ACCESS read-only 926 STATUS current 927 DESCRIPTION 928 "The ifType for the LAN Interface implemented on the 929 CableHome Host Device." 930 REFERENCE 931 "http://www.iana.org/assignments/ianaiftype-mib 932 See also: CableHome 1.1 Specification, 933 CH1.1-SP-I01-030418, 6.5.3.1.3 Device Profile 934 Description." 935 DEFVAL { other } 936 ::= { cabhPsDevBpProfileEntry 14 } 938 cabhPsDevBpNumberInterfacePriorities OBJECT-TYPE 939 SYNTAX INTEGER (1..8) 940 MAX-ACCESS read-only 941 STATUS current 942 DESCRIPTION 943 "Number of QoS priorities supported by the LAN 944 technology (Data Link Layer) implemented in the 945 CableHome Host Device." 946 DEFVAL { 1 } 947 ::= { cabhPsDevBpProfileEntry 15 } 949 cabhPsDevBpPhysicalLocation OBJECT-TYPE 950 SYNTAX SnmpAdminString (SIZE(0..32)) 951 MAX-ACCESS read-only 952 STATUS current 953 DESCRIPTION 954 "Physical location of the CableHome Host Device." 955 REFERENCE 956 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 957 6.5.3.1.3 Device Profile Description" 958 DEFVAL { "" } 959 ::= { cabhPsDevBpProfileEntry 16 } 961 cabhPsDevBpPhysicalAddress OBJECT-TYPE 962 SYNTAX PhysAddress (SIZE (0..16)) 963 MAX-ACCESS read-only 964 STATUS current 965 DESCRIPTION 966 "The CableHome Host Device's hardware address." 968 REFERENCE 969 "CableHome 1.1 Specification, CH 1.1-SP-I01-030418, 970 6.5.3.1.3 Device Profile Description" 971 DEFVAL { ''h } 972 ::= { cabhPsDevBpProfileEntry 17 } 974 --================================================================= 975 -- 976 -- LAN IP Traffic Statistics Table 977 -- 978 -- The cabhPsDevLanIpTrafficTable contains the Traffic Statistics 979 -- for all LAN IP Devices connected to the PS. When the PS learns 980 -- a new LAN IP address an entry is added to this table. 981 -- 982 --================================================================= 984 cabhPsDevLanIpTrafficCountersReset OBJECT-TYPE 985 SYNTAX INTEGER 986 { 987 clearCounters(1), 988 clearTable(2) 989 } 990 MAX-ACCESS read-write 991 STATUS current 992 DESCRIPTION 993 "Setting this object to clearCounters(1) resets all the 994 traffic statistic counter entries to zero in the 995 cabhPsDevLanIpTrafficTable. Setting this object to 996 clearTable(2) removes all entries in the 997 cabhPsDevLanIpTrafficTable. Reading this object always 998 returns clearCounters(1)." 999 DEFVAL { clearCounters } 1000 ::= { cabhPsDevPsStats 1 } 1002 cabhPsDevLanIpTrafficCountersLastReset OBJECT-TYPE 1003 SYNTAX TimeStamp 1004 MAX-ACCESS read-only 1005 STATUS current 1006 DESCRIPTION 1007 "The value of sysUpTime when 1008 cabhPsDevLanIpTrafficCountersReset was last written to. 1009 Zero if never written to." 1010 ::= { cabhPsDevPsStats 2 } 1012 cabhPsDevLanIpTrafficEnabled OBJECT-TYPE 1013 SYNTAX TruthValue 1014 MAX-ACCESS read-write 1015 STATUS current 1016 DESCRIPTION 1017 "Setting this object to true(1) turns on the IP traffic 1018 counters. Setting this object false(2) turns off the IP 1019 traffic counters." 1020 DEFVAL { false } -- IP traffic counters are off by default 1021 ::= { cabhPsDevPsStats 3 } 1023 cabhPsDevLanIpTrafficTable OBJECT-TYPE 1024 SYNTAX SEQUENCE OF CabhPsDevLanIpTrafficEntry 1025 MAX-ACCESS not-accessible 1026 STATUS current 1027 DESCRIPTION 1028 "This table contains IP-layer Traffic Statistics for all 1029 LAN IP Devices connected to the PS." 1030 ::= { cabhPsDevPsStats 4 } 1032 cabhPsDevLanIpTrafficEntry OBJECT-TYPE 1033 SYNTAX CabhPsDevLanIpTrafficEntry 1034 MAX-ACCESS not-accessible 1035 STATUS current 1036 DESCRIPTION 1037 "List of Traffic Statistics for LAN IP Devices." 1038 INDEX { cabhPsDevLanIpTrafficIndex } 1039 ::= { cabhPsDevLanIpTrafficTable 1 } 1041 CabhPsDevLanIpTrafficEntry ::= SEQUENCE { 1042 cabhPsDevLanIpTrafficIndex INTEGER, 1043 cabhPsDevLanIpTrafficInetAddressType InetAddressType, 1044 cabhPsDevLanIpTrafficInetAddress InetAddress, 1045 cabhPsDevLanIpTrafficInOctets ZeroBasedCounter32, 1046 cabhPsDevLanIpTrafficOutOctets ZeroBasedCounter32 1047 } 1049 cabhPsDevLanIpTrafficIndex OBJECT-TYPE 1050 SYNTAX INTEGER (1..65535) 1051 MAX-ACCESS not-accessible 1052 STATUS current 1053 DESCRIPTION 1054 "The Index into the LAN IP Traffic Statistics Table." 1055 ::= { cabhPsDevLanIpTrafficEntry 1 } 1057 cabhPsDevLanIpTrafficInetAddressType OBJECT-TYPE 1058 SYNTAX InetAddressType 1059 MAX-ACCESS read-only 1060 STATUS current 1061 DESCRIPTION 1062 "The type of IP address assigned to the LAN IP device 1063 to which the statistics in this table row apply. IP 1064 version 4 is typically used." 1066 DEFVAL { ipv4 } 1067 ::= { cabhPsDevLanIpTrafficEntry 2 } 1069 cabhPsDevLanIpTrafficInetAddress OBJECT-TYPE 1070 SYNTAX InetAddress 1071 MAX-ACCESS read-only 1072 STATUS current 1073 DESCRIPTION 1074 "The IP address of the LAN IP device to which the 1075 statistics in this table row apply. An IPv4 IP address 1076 is typically used." 1077 ::= { cabhPsDevLanIpTrafficEntry 3 } 1079 cabhPsDevLanIpTrafficInOctets OBJECT-TYPE 1080 SYNTAX ZeroBasedCounter32 1081 MAX-ACCESS read-only 1082 STATUS current 1083 DESCRIPTION 1084 "The total number of octets received from the LAN IP 1085 address." 1086 ::= { cabhPsDevLanIpTrafficEntry 4 } 1088 cabhPsDevLanIpTrafficOutOctets OBJECT-TYPE 1089 SYNTAX ZeroBasedCounter32 1090 MAX-ACCESS read-only 1091 STATUS current 1092 DESCRIPTION 1093 "The total number of octets transmitted to the LAN IP 1094 address." 1095 ::= { cabhPsDevLanIpTrafficEntry 5 } 1097 -- 1099 cabhPsNotification OBJECT IDENTIFIER ::= { cabhPsDevMib 2 } 1100 cabhPsDevNotifications OBJECT IDENTIFIER ::= { cabhPsNotification 2 } 1101 cabhPsConformance OBJECT IDENTIFIER ::= { cabhPsDevMib 3 } 1102 cabhPsCompliances OBJECT IDENTIFIER ::= { cabhPsConformance 1 } 1103 cabhPsGroups OBJECT IDENTIFIER ::= { cabhPsConformance 2 } 1105 -- 1106 -- Notification Group 1107 -- 1109 cabhPsDevInitTLVUnknownTrap NOTIFICATION-TYPE 1110 OBJECTS { 1111 docsDevEvLevel, 1112 docsDevEvId, 1113 docsDevEvText, 1114 cabhPsDevWanManMacAddress 1116 } 1117 STATUS current 1118 DESCRIPTION 1119 "Event due to detection of unknown TLV during the TLV 1120 parsing process. The values of docsDevEvLevel, docsDevId, 1121 and docsDevEvText are from the entry which logs this 1122 event in the docsDevEventTable. The value of 1123 cabhPsDevWanManMacAddress indicates the WAN-Man MAC 1124 address of the PS. This part of the information is 1125 uniform across all PS Traps." 1126 ::= { cabhPsDevNotifications 1 } 1128 cabhPsDevInitTrap NOTIFICATION-TYPE 1129 OBJECTS { 1130 docsDevEvLevel, 1131 docsDevEvId, 1132 docsDevEvText, 1133 cabhPsDevWanManMacAddress, 1134 cabhPsDevProvConfigFile, 1135 cabhPsDevProvConfigTLVProcessed, 1136 cabhPsDevProvConfigTLVRejected 1137 } 1138 STATUS current 1139 DESCRIPTION 1140 "This inform is issued to confirm the successful 1141 completion of the CableHome provisioning process." 1142 ::= { cabhPsDevNotifications 2 } 1144 cabhPsDevInitRetryTrap NOTIFICATION-TYPE 1145 OBJECTS { 1146 docsDevEvLevel, 1147 docsDevEvId, 1148 docsDevEvText, 1149 cabhPsDevWanManMacAddress 1150 } 1151 STATUS current 1152 DESCRIPTION 1153 "An event to report a failure happened during the 1154 initialization process and was detected in the PS." 1155 ::= { cabhPsDevNotifications 3 } 1157 cabhPsDevDHCPFailTrap NOTIFICATION-TYPE 1158 OBJECTS { 1159 docsDevEvLevel, 1160 docsDevEvId, 1161 docsDevEvText, 1162 cabhPsDevWanManMacAddress, 1163 cabhCdpServerDhcpAddress 1164 } 1165 STATUS current 1166 DESCRIPTION 1167 "An event to report the failure of a DHCP server. The 1168 value of cabhCdpServerDhcpAddressis the IP address of 1169 the DHCP server." 1170 ::= { cabhPsDevNotifications 4 } 1172 cabhPsDevSwUpgradeInitTrap NOTIFICATION-TYPE 1173 OBJECTS { 1174 docsDevEvLevel, 1175 docsDevEvId, 1176 docsDevEvText, 1177 cabhPsDevWanManMacAddress, 1178 docsDevSwFilename, 1179 docsDevSwServer 1180 } 1181 STATUS current 1182 DESCRIPTION 1183 "An event to report a software upgrade initiated event. 1184 The values of docsDevSwFilename, and docsDevSwServer 1185 indicate the software image name and the IP address of 1186 the server from which the image was downloaded." 1187 ::= { cabhPsDevNotifications 5 } 1189 cabhPsDevSwUpgradeFailTrap NOTIFICATION-TYPE 1190 OBJECTS { 1191 docsDevEvLevel, 1192 docsDevEvId, 1193 docsDevEvText, 1194 cabhPsDevWanManMacAddress, 1195 docsDevSwFilename, 1196 docsDevSwServer 1197 } 1198 STATUS current 1199 DESCRIPTION 1200 "An event to report the failure of a software upgrade 1201 attempt. The values of docsDevSwFilename, and 1202 docsDevSwServer indicate the software image name and the 1203 IP address of the server from which the image was 1204 downloaded." 1205 ::= { cabhPsDevNotifications 6 } 1207 cabhPsDevSwUpgradeSuccessTrap NOTIFICATION-TYPE 1208 OBJECTS { 1209 docsDevEvLevel, 1210 docsDevEvId, 1211 docsDevEvText, 1212 cabhPsDevWanManMacAddress, 1213 docsDevSwFilename, 1214 docsDevSwServer 1215 } 1216 STATUS current 1217 DESCRIPTION 1218 "An event to report the Software upgrade success event. 1219 The values of docsDevSwFilename, and docsDevSwServer 1220 indicate the software image name and the IP address of 1221 the server from which the image was downloaded." 1222 ::= { cabhPsDevNotifications 7 } 1224 cabhPsDevSwUpgradeCVCFailTrap NOTIFICATION-TYPE 1225 OBJECTS { 1226 docsDevEvLevel, 1227 docsDevEvId, 1228 docsDevEvText, 1229 cabhPsDevWanManMacAddress 1230 } 1231 STATUS current 1232 DESCRIPTION 1233 "An event to report the failure of the verification of 1234 code file happened during a secure software upgrade 1235 attempt." 1236 ::= { cabhPsDevNotifications 8 } 1238 cabhPsDevTODFailTrap NOTIFICATION-TYPE 1239 OBJECTS { 1240 docsDevEvLevel, 1241 docsDevEvId, 1242 docsDevEvText, 1243 cabhPsDevTimeServerAddr, 1244 cabhPsDevWanManMacAddress 1245 } 1246 STATUS current 1247 DESCRIPTION 1248 "An event to report the failure of a time of day server. 1249 The value of cabhPsDevTimeServerAddr indicates the server 1250 IP address." 1251 ::= { cabhPsDevNotifications 9 } 1253 cabhPsDevCdpWanDataIpTrap NOTIFICATION-TYPE 1254 OBJECTS { 1255 docsDevEvLevel, 1256 docsDevEvId, 1257 docsDevEvText, 1258 cabhCdpWanDataAddrClientId, 1259 cabhPsDevWanManMacAddress 1261 } 1262 STATUS current 1263 DESCRIPTION 1264 "An event to report the failure of PS to obtain all 1265 needed WAN-Data Ip Addresses. 1266 cabhCdpWanDataAddrClientId indicates the ClientId for 1267 which the failure occured." 1268 ::= { cabhPsDevNotifications 10 } 1270 cabhPsDevCdpThresholdTrap NOTIFICATION-TYPE 1271 OBJECTS { 1272 docsDevEvLevel, 1273 docsDevEvId, 1274 docsDevEvText, 1275 cabhPsDevWanManMacAddress, 1276 cabhCdpLanTransThreshold 1277 } 1278 STATUS current 1279 DESCRIPTION 1280 "An event to report that the LAN-Trans address assignment 1281 threshold has been exceeded." 1282 ::= { cabhPsDevNotifications 11 } 1284 cabhPsDevCspTrap NOTIFICATION-TYPE 1285 OBJECTS { 1286 docsDevEvLevel, 1287 docsDevEvId, 1288 docsDevEvText, 1289 cabhPsDevWanManMacAddress 1290 } 1291 STATUS current 1292 DESCRIPTION 1293 "To report an event with the CableHome Security Portal." 1294 ::= { cabhPsDevNotifications 12 } 1296 cabhPsDevCapTrap NOTIFICATION-TYPE 1297 OBJECTS { 1298 docsDevEvLevel, 1299 docsDevEvId, 1300 docsDevEvText, 1301 cabhPsDevWanManMacAddress 1302 } 1303 STATUS current 1304 DESCRIPTION 1305 "To report an event with the CableHome Address Portal." 1306 ::= { cabhPsDevNotifications 13 } 1308 cabhPsDevCtpTrap NOTIFICATION-TYPE 1309 OBJECTS { 1310 docsDevEvLevel, 1311 docsDevEvId, 1312 docsDevEvText, 1313 cabhPsDevWanManMacAddress 1314 } 1315 STATUS current 1316 DESCRIPTION 1317 "To report an event with the CableHome Test Portal." 1318 ::= { cabhPsDevNotifications 14 } 1320 cabhPsDevProvEnrollTrap NOTIFICATION-TYPE 1321 OBJECTS { 1322 cabhPsDevHardwareVersion, 1323 docsDevSwCurrentVers, 1324 cabhPsDevTypeIdentifier, 1325 cabhPsDevWanManMacAddress 1326 } 1327 STATUS current 1328 DESCRIPTION 1329 "This inform is issued to initiate the CableHome 1330 provisioning process for SNMP Provisioning Mode." 1331 ::= { cabhPsDevNotifications 15 } 1333 cabhPsDevCdpLanIpPoolTrap NOTIFICATION-TYPE 1334 OBJECTS { 1335 docsDevEvLevel, 1336 docsDevEvId, 1337 docsDevEvText, 1338 cabhPsDevWanManMacAddress, 1339 cabhCdpLanTransCurCount 1340 } 1341 STATUS current 1342 DESCRIPTION 1343 "An event to report that the pool of IP addresses for LAN 1344 clients, as defined by cabh CdpLanPoolStart and 1345 cabhCdpLanPoolEnd, is exhausted." 1346 ::= { cabhPsDevNotifications 16} 1348 -- compliance statements 1350 cabhPsBasicCompliance MODULE-COMPLIANCE 1351 STATUS current 1352 DESCRIPTION 1353 "The compliance statement for devices that implement the 1354 CableHome Portal Services logical element." 1355 MODULE -- cabhPsMib 1357 -- unconditionally mandatory groups 1358 MANDATORY-GROUPS { 1359 cabhPsDevBaseGroup, 1360 cabhPsDevProvGroup, 1361 cabhPsNotificationGroup 1362 } 1364 -- conditionally mandatory group 1365 GROUP cabhPsDevAttribGroup 1366 DESCRIPTION 1367 "This group is implemented only in CableHome 1.1 PS 1368 elements, not CableHome 1.0 PS elements." 1370 -- conditionally mandatory group 1371 GROUP cabhPsDevPsStatsGroup 1372 DESCRIPTION 1373 "This group is implemented only in CableHome 1.1 PS 1374 elements, not CableHome 1.0 PS elements." 1376 OBJECT cabhPsDevTimeServerAddrType 1377 SYNTAX InetAddressType { ipv4(1) } 1378 DESCRIPTION 1379 "An implementation is only required to support IPv4 1380 addresses." 1382 OBJECT cabhPsDevTimeServerAddr 1383 SYNTAX InetAddress (SIZE(4)) 1384 DESCRIPTION 1385 "An implementation is only required to support IPv4 1386 addresses." 1388 OBJECT cabhPsDevLanIpTrafficInetAddressType 1389 SYNTAX InetAddressType { ipv4(1) } 1390 DESCRIPTION 1391 "An implementation is only required to support IPv4 1392 addresses." 1394 OBJECT cabhPsDevLanIpTrafficInetAddress 1395 SYNTAX InetAddress (SIZE(4)) 1396 DESCRIPTION 1397 "An implementation is only required to support IPv4 1398 addresses." 1400 ::= { cabhPsCompliances 1} 1402 cabhPsDevBaseGroup OBJECT-GROUP 1403 OBJECTS { 1404 cabhPsDevDateTime, 1405 cabhPsDevResetNow, 1406 cabhPsDevSerialNumber, 1407 cabhPsDevHardwareVersion, 1408 cabhPsDevWanManMacAddress, 1409 cabhPsDevWanDataMacAddress, 1410 cabhPsDevTypeIdentifier, 1411 cabhPsDevSetToFactory, 1412 cabhPsDevTodSyncStatus, 1413 cabhPsDevProvMode, -- added dormant mode 1414 cabhPsDevLastSetToFactory 1415 } 1416 STATUS current 1417 DESCRIPTION 1418 "A collection of objects for providing device status and 1419 control." 1420 ::= { cabhPsGroups 1 } 1422 cabhPsDevProvGroup OBJECT-GROUP 1423 OBJECTS { 1424 cabhPsDevProvisioningTimer, 1425 cabhPsDevProvConfigFile, 1426 cabhPsDevProvConfigHash, 1427 cabhPsDevProvConfigFileSize, 1428 cabhPsDevProvConfigFileStatus, 1429 cabhPsDevProvConfigTLVProcessed, 1430 cabhPsDevProvConfigTLVRejected, 1431 cabhPsDevProvSolicitedKeyTimeout, 1432 cabhPsDevProvState, 1433 cabhPsDevProvAuthState, 1434 cabhPsDevTimeServerAddrType, 1435 cabhPsDevTimeServerAddr 1436 } 1437 STATUS current 1438 DESCRIPTION 1439 "A collection of objects for controlling and providing 1440 status on provisioning." 1441 ::= { cabhPsGroups 2 } 1443 cabhPsDevAttribGroup OBJECT-GROUP 1444 OBJECTS { 1445 cabhPsDevPsDeviceType, 1446 cabhPsDevPsManufacturerUrl, 1447 cabhPsDevPsModelUrl, 1448 cabhPsDevPsModelUpc, 1449 cabhPsDevBpDeviceType, 1450 cabhPsDevBpManufacturer, 1451 cabhPsDevBpManufacturerUrl, 1452 cabhPsDevBpSerialNumber, 1453 cabhPsDevBpHardwareVersion, 1454 cabhPsDevBpHardwareOptions, 1455 cabhPsDevBpModelName, 1456 cabhPsDevBpModelNumber, 1457 cabhPsDevBpModelUrl, 1458 cabhPsDevBpModelUpc, 1459 cabhPsDevBpModelSoftwareOs, 1460 cabhPsDevBpModelSoftwareVersion, 1461 cabhPsDevBpLanInterfaceType, 1462 cabhPsDevBpNumberInterfacePriorities, 1463 cabhPsDevBpPhysicalLocation, 1464 cabhPsDevBpPhysicalAddress 1465 } 1466 STATUS current 1467 DESCRIPTION 1468 "A collection of objects for providing information on 1469 LAN IP devices known to the PS." 1470 ::= { cabhPsGroups 3 } 1472 cabhPsDevPsStatsGroup OBJECT-GROUP 1473 OBJECTS { 1474 cabhPsDevLanIpTrafficCountersReset, 1475 cabhPsDevLanIpTrafficCountersLastReset, 1476 cabhPsDevLanIpTrafficEnabled, 1477 cabhPsDevLanIpTrafficInetAddressType, 1478 cabhPsDevLanIpTrafficInetAddress, 1479 cabhPsDevLanIpTrafficInOctets, 1480 cabhPsDevLanIpTrafficOutOctets 1481 } 1482 STATUS current 1483 DESCRIPTION 1484 "A collection of objects for providing information on LAN 1485 IP 1486 traffic." 1487 ::= { cabhPsGroups 4 } 1489 cabhPsNotificationGroup NOTIFICATION-GROUP 1490 NOTIFICATIONS { 1491 cabhPsDevInitTLVUnknownTrap, 1492 cabhPsDevInitTrap, 1493 cabhPsDevInitRetryTrap, 1494 cabhPsDevDHCPFailTrap, 1495 cabhPsDevSwUpgradeInitTrap, 1496 cabhPsDevSwUpgradeFailTrap, 1497 cabhPsDevSwUpgradeSuccessTrap, 1498 cabhPsDevSwUpgradeCVCFailTrap, 1499 cabhPsDevTODFailTrap, 1500 cabhPsDevCdpWanDataIpTrap, 1501 cabhPsDevCdpThresholdTrap, 1502 cabhPsDevCspTrap, 1503 cabhPsDevCapTrap, 1504 cabhPsDevCtpTrap, 1505 cabhPsDevProvEnrollTrap, 1506 cabhPsDevCdpLanIpPoolTrap 1507 } 1508 STATUS current 1509 DESCRIPTION 1510 "These notifications indicate change in status of the 1511 Portal Services set of functions in a device complying 1512 with CableLabs CableHome(tm) specifications." 1513 ::= { cabhPsGroups 6 } 1515 END 1517 5. Acknowledgements 1519 James Hinsey - Broadcom 1520 Amol Bhagwat - CableLabs 1521 Roy Spitzer - Consultant 1522 Mike Mannette - Consultant 1523 Itay Sherman - Texas Instruments 1524 Chris Zacker - Broadcom 1525 Rick Vetter - Consultant 1527 Funding for the RFC Editor function is currently provided by the 1528 Internet Society. 1530 6. Formal Syntax 1532 The following syntax specification uses the augmented Backus-Naur 1533 Form (BNF) as described in RFC-2234 [3]. 1535 7. Security Considerations 1537 There are a number of management objects defined in this MIB that 1538 have a MAX-ACCESS clause of read-write and/or read-create. Such 1539 objects may be considered sensitive or vulnerable in some network 1540 environments. The support for SET operations in a non-secure 1541 environment without proper protection can have a negative effect on 1542 network operations. 1544 It is thus important to control even GET access to these objects and 1545 possibly to even encrypt the values of these objects when sending 1546 them over the network via SNMP. Not all versions of SNMP provide 1547 features for such a secure environment. 1549 SNMP versions prior to SNMPv3 did not include adequate security. 1550 Even if the network itself is secure (for example by using IPSec), 1551 even then, there is no control as to who on the secure network is 1552 allowed to access and GET/SET (read/change/create/delete) the objects 1553 in this MIB module. 1555 It is RECOMMENDED that implementers consider the security features as 1556 provided by the SNMPv3 framework (see [RFC3410], section 8), 1557 including full support for the SNMPv3 cryptographic mechanisms (for 1558 authentication and privacy). 1560 Further, deployment of SNMP versions prior to SNMPv3 is NOT 1561 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 1562 enable cryptographic security. It is then a customer/operator 1563 responsibility to ensure that the SNMP entity giving access to an 1564 instance of this MIB module, is properly configured to give access to 1565 the objects only to those principals (users) that have legitimate 1566 rights to indeed GET or SET (change/create/delete) them. 1568 8. Normative References 1570 1 Bradner, S., "The Internet Standards Process -- Revision 3", BCP 1571 9, RFC 2026, October 1996. 1573 2 Bradner, S., "Key words for use in RFCs to Indicate Requirement 1574 Levels", BCP 14, RFC 2119, March 1997 1576 3 Crocker, D. and Overell, P.(Editors), "Augmented BNF for Syntax 1577 Specifications: ABNF", RFC 2234, Internet Mail Consortium and 1578 Demon Internet Ltd., November 1997 1580 4 Rose, M. and K. McCloghrie, "Structure and Identification of 1581 Management Information for TCP/IP-based Internets", STD 16, RFC 1582 1155, May 1990. 1584 5 Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16, RFC 1585 1212, March 1991. 1587 6 Rose, M., "A Convention for Defining Traps for use with the SNMP", 1588 RFC 1215, March 1991. 1590 7 McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Structure of 1591 Management Information for Version 2 (SMIv2)", STD 58, RFC 2578, 1592 April 1999. 1594 8 McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Textual 1595 Conventions for SMIv2", STD 58, RFC 2579, April 1999. 1597 9 McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Conformance 1598 Statements for SMIv2", STD 58, RFC 2580, April 1999. 1600 10 Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple Network 1601 Management Protocol", STD 15, RFC 1157, May 1990. 1603 11 Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, 1604 "Introduction to Community-based SNMPv2", RFC 1901, January 1996. 1606 12 Case, J., Mundy, R., Partain, D, and B. Stewart, "Introduction and 1607 Applicability Statements for Internet Standard Management 1608 Framework", RFC 3410, December 2002. 1610 13 Harrington D., Presuhn R. and B. Wijnen, "An Architecture for 1611 Describing Simple Network Management Protocol (SNMP) Management 1612 Frameworks", RFC 3411, December 2002. 1614 14 Case, J., Harrington D., Presuhn R. and B. Wijnen, "Message 1615 Processing and Dispatching for the Simple Network Management 1616 Protocol (SNMP)", RFC 3412, December 2002. 1618 15 Levi, D., Meyer, P., and B. Stewart, �Simple Network Management 1619 Protocol (SNMP) Applications", RFC 3413, December 2002. 1621 16 Blumenthal, U. and B. Wijnen, "User-based Security Model (USM) for 1622 version 3 of the Simple Network Management Protocol (SNMPv3)", RFC 1623 3414, December 2002. 1625 17 Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access 1626 Control Model (VACM) for the Simple Network Management Protocol 1627 (SNMP)", RFC 3415, December 2002. 1629 18 Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, 1630 "Version 2 of the Protocol Operations for the Simple Network 1631 Management Protocol (SNMPv2)", RFC 3416, Decemeber 2002. 1633 19 Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, 1634 "Transport Mappings for the Simple Network Management Protocol 1635 (SNMPv2)", RFC 3417, December 2002. 1637 20 Presuhn, R., Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, 1638 "Management Information Base (MIB) for the Simple Network 1639 Management Protocol (SNMP)", RFC 3418, December 2002. 1641 21 Cable Television Laboratories, �CableHome 1.0 Specification�, CH- 1642 SP-I02-020920, September 2002, 1643 http://www.cablelabs.com/projects/cablehome/specifications. 1645 9. Informative References 1647 22 Drums, R., �Dynamic Host Configuration Protocol�, RFC 2131, March 1648 1997. 1650 23 Sollins, K., �The TFTP Protocol (Revision 2)�, RFC 1350, July 1651 1992. 1653 24 St. Johns, M., �DOCSIS Cable Device MIB: Cable Device Management 1654 Information Base for DOCSIS compliant Cable Modems and Cable Modem 1655 Termination Systems, RFC 2669, August 1999. 1657 25 Harrington, R., Presuhn, R., and B. Wijnen, �An Architecture for 1658 Describing SNMP Management Frameworks�, RFC 2571, April 1999. 1660 26 Daniele, M., Haberman, B., Routhier, S., and J. Schoenwaelder, 1661 �Textual Contentions for Internet Network Addresses�, May 2002. 1663 10. Intellectual Property 1665 The IETF takes no position regarding the validity or scope of any 1666 intellectual property or other rights that might be claimed to 1667 pertain to the implementation or use of the technology described in 1668 this document or the extent to which any license under such rights 1669 might or might not be available; neither does it represent that it 1670 has made any effort to identify any such rights. Information on the 1671 IETF's procedures with respect to rights in standards-track and 1672 standards-related documentation can be found in BCP-11. Copies of 1673 claims of rights made available for publication and any assurances of 1674 licenses to be made available, or the result of an attempt made to 1675 obtain a general license or permission for the use of such 1676 proprietary rights by implementers or users of this specification can 1677 be obtained from the IETF Secretariat. 1679 The IETF invites any interested party to bring to its attention any 1680 copyrights, patents or patent applications, or other proprietary 1681 rights which may cover technology that may be required to practice 1682 this standard. Please address the information to the IETF Executive 1683 Director. 1685 11. Author's Addresses 1687 Eduardo Cardona 1688 Cable Television Laboratories 1689 400 Centennial Parkway 1690 Louisville, CO 80027 1691 Phone: +1 303.661.9100 1692 Email: e.cardona@cablelabs.com 1694 Kevin Luehrs 1695 Cable Television Laboratories 1696 400 Centennial Parkway 1697 Louisville, CO 80027 1698 Phone: +1 303.661.9100 1699 Email: k.luehrs@cablelabs.com 1701 Doug Jones 1702 YAS Broadband Ventures 1703 300 Brickstone Square 1704 Andover, MA 01810 1705 Phone: +1 303.661.3823 1706 Email: doug@yas.com 1708 12. Full Copyright Statement 1710 Copyright (C) The Internet Society (2003). All Rights Reserved. 1712 This document and translations of it may be copied and furnished to 1713 others, and derivative works that comment on or otherwise explain it 1714 or assist in its implementation may be prepared, copied, published 1715 and distributed, in whole or in part, without restriction of any 1716 kind, provided that the above copyright notice and this paragraph are 1717 included on all such copies and derivative works. However, this 1718 document itself may not be modified in any way, such as by removing 1719 the copyright notice or references to the Internet Society or other 1720 Internet organizations, except as needed for the purpose of 1721 developing Internet standards in which case the procedures for 1722 copyrights defined in the Internet Standards process must be 1723 followed, or as required to translate it into languages other than 1724 English. 1726 The limited permissions granted above are perpetual and will not be 1727 revoked by the Internet Society or its successors or assigns. 1729 This document and the information contained herein is provided on an 1730 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 1731 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 1732 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 1733 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 1734 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE."