-- extracted from draft-jones-cable-gateway-device-mib-00.txt -- at Sat Nov 2 06:10:56 2002 CABH-PS-DEV-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Integer32, NOTIFICATION-TYPE FROM SNMPv2-SMI TruthValue, PhysAddress, DateAndTime, TEXTUAL-CONVENTION FROM SNMPv2-TC SnmpAdminString FROM SNMP-FRAMEWORK-MIB OBJECT-GROUP, MODULE-COMPLIANCE, NOTIFICATION-GROUP FROM SNMPv2-CONF InetAddressType, InetAddress FROM INET-ADDRESS-MIB docsDevSwCurrentVers, docsDevEvLevel, docsDevEvId, docsDevEvText, docsDevSwFilename, docsDevSwServer FROM DOCS-CABLE-DEVICE-MIB -- RFC2669 cabhCdpServerDhcpAddress, cabhCdpWanDataAddrClientId, cabhCdpLanTransThreshold, cabhCdpLanTransCurCount FROM CABH-CDP-MIB clabProjCableHome FROM CLAB-DEF-MIB; --============================================================================ -- -- History: -- -- Date Modified by Reason -- 04/05/02 Issued I01 -- 09/20/02 Issued I02 -- 10/25/02 IETF I-D revisions -- --============================================================================= cabhPsDevMib MODULE-IDENTITY LAST-UPDATED "200210250000Z" -- October 25, 2002 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 PS Device. The PS device parameter describe general PS Device attributes and behavior characteristics. Most the PS Device MIB is need for configuration download. Acknowledgements: Roy Spitzer - Consultant to CableLabs Mike Mannette - Consultant to CableLabs Itay Sherman - Texas Instruments Chris Zacker - Broadcom Rick Vetter - Consultant to CableLabs " ::= { clabProjCableHome 1 } -- Textual conventions X509Certificate ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "An X509 digital certificate encoded as an ASN.1 DER object." SYNTAX OCTET STRING (SIZE (0..4096)) cabhPsDevMibObjects OBJECT IDENTIFIER ::= { cabhPsDevMib 1 } cabhPsDevBase OBJECT IDENTIFIER ::= { cabhPsDevMibObjects 1 } cabhPsDevProv OBJECT IDENTIFIER ::= { cabhPsDevMibObjects 2 } -- -- The following group describes the base objects in the PS. -- These are device based parameters. -- cabhPsDevDateTime OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-write STATUS current DESCRIPTION "The date and time, with optional timezone information." ::= { cabhPsDevBase 1 } cabhPsDevResetNow OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-write STATUS current DESCRIPTION "Setting this object to true(1) causes the stand-alone or embedded PS functions to reboot. Device code initializes as if starting from a power-on reset. MIB object values persist as specified in Appendix I of the CableHome 1.0 specification. Reading this object always returns false(2)." ::= { cabhPsDevBase 2 } cabhPsDevSerialNumber OBJECT-TYPE SYNTAX SnmpAdminString (SIZE (0..128)) MAX-ACCESS read-only STATUS current DESCRIPTION "The manufacturer's serial number for the Cable Gateway device implementing this Portal Services element. This parameter is manufacturer provided and is stored in non- volatile memory." ::= { cabhPsDevBase 3 } cabhPsDevHardwareVersion OBJECT-TYPE SYNTAX SnmpAdminString (SIZE (0..48)) MAX-ACCESS read-only STATUS current DESCRIPTION "The manufacturer's hardware version for the Cable Gateway device implementing this Portal Services elemenet. This parameter is manufacturer provided and is stored in non- volatile memory." ::= { cabhPsDevBase 4 } cabhPsDevWanManMacAddress OBJECT-TYPE SYNTAX PhysAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The PS WAN-Man MAC address. This is the PS hardware address to be used to uniquely identify the PS to the cable data network DHCP server for the acquisition of an IP address to be used for management messaging between the cable network management entity and the Portal Services element." ::= { cabhPsDevBase 5 } cabhPsDevWanDataMacAddress OBJECT-TYPE SYNTAX PhysAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The PS WAN-Data hardware address. The CableHome Portal Services supports acquisition of zero or more globally- routable IP addresses to map to private IP addresses in the data service subscriber's LAN. The Portal Services could have multiple WAN-Data Interfaces, which share the same hardware address. In the case of two or more WAN-Data Interfaces, the client identifiers provided in DHCP Option Code 61 of the DHCP OFFER message issued by the PS will be unique so that each WAN-Data Interface may be assigned a unique WAN-Data IP address." ::= { cabhPsDevBase 6 } cabhPsDevTypeIdentifier OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This is a copy of the device type identifier used in the DHCP option 60 exchanged between the PS and the DHCP server." ::= { cabhPsDevBase 7 } cabhPsDevSetToFactory OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-write STATUS current DESCRIPTION "Setting this object to true(1) sets all PsDev MIB objects to the factory default values. Reading this object always returns false(2)." ::= { cabhPsDevBase 8 } cabhPsDevTodSyncStatus OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates whether the PS was able to successfully synchronize with the Time of Day (ToD) Server in the cable network. The PS sets this object to true(1) if the PS successfully synchronizes its time with the ToD server. The PS sets this object to false(2) if the PS does not successfully synchronize with the ToD server" DEFVAL { false } ::= { cabhPsDevBase 9 } cabhPsDevProvMode OBJECT-TYPE SYNTAX INTEGER { dhcpmode(1), snmpmode(2) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the provisioning mode in which the PS is operating. If the PS is operating in DHCP Provisioning Mode as described in the CableHome 1.0 specification, the PS sets this object to dhcpmode(1). If the PS is operating in SNMP Provisioning Mode, the PS sets this object to snmpmode(2)." ::={ cabhPsDevBase 10 } -- -- The following group defines Provisioning Specific parameters -- cabhPsDevProvisioningTimer OBJECT-TYPE SYNTAX INTEGER (0..16383) UNITS "minutes" MAX-ACCESS read-write STATUS current DESCRIPTION "This object enables the user to set the duration of the provisioning timeout timer. The provisioning timeout timer is intended to act as a watchdog timer for the PS provisioning process. If it expires before the PS provisioning process completes, the PS is required to repeat its initialization process. Setting the timer to 0 disables the provisioning timeout timer." DEFVAL {5} ::= {cabhPsDevProv 1} cabhPsDevProvConfigFile OBJECT-TYPE SYNTAX SnmpAdminString (SIZE(1..128)) MAX-ACCESS read-write STATUS current DESCRIPTION "The URL of the TFTP host for downloading provisioning and configuration parameters to this device. Returns NULL if the server address is unknown." ::= { cabhPsDevProv 2 } cabhPsDevProvConfigHash OBJECT-TYPE SYNTAX OCTET STRING (SIZE(20)) MAX-ACCESS read-write STATUS current DESCRIPTION "Hash of the contents of the config file, calculated and sent to the PS prior to sending the config file. For the SHA-1 authentication algorithm the hash length is 160 bits." ::= { cabhPsDevProv 3 } cabhPsDevProvConfigFileSize OBJECT-TYPE SYNTAX Integer32 UNITS "bytes" MAX-ACCESS read-only STATUS current DESCRIPTION "The length of the configuration file in bytes, including the end of file marker." ::={ cabhPsDevProv 4 } cabhPsDevProvConfigFileStatus OBJECT-TYPE SYNTAX INTEGER { idle (1), busy (2) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the current status of the configuration file download process. It is provided to indicate to the management entity that the PS will reject PS Configuration File triggers (set request to cabhPsDevProvConfigFile) when busy." ::={ cabhPsDevProv 5 } cabhPsDevProvConfigTLVProcessed OBJECT-TYPE SYNTAX INTEGER (0..16383) MAX-ACCESS read-only STATUS current DESCRIPTION "Number of TLVs processed in config file." ::={ cabhPsDevProv 6 } cabhPsDevProvConfigTLVRejected OBJECT-TYPE SYNTAX INTEGER (0..16383) MAX-ACCESS read-only STATUS current DESCRIPTION "Number of TLVs rejected in config file." ::={ cabhPsDevProv 7 } cabhPsDevProvSolicitedKeyTimeout OBJECT-TYPE SYNTAX Integer32 (15..600) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "This timeout applies only when the Provisioning Server initiated key management (with a Wake Up message) for SNMPv3. It is the period during which the PS will save a number (inside the sequence number field) from the sent out AP Request and wait for the matching AP Reply from the Provisioning Server." DEFVAL { 120 } ::= { cabhPsDevProv 8 } cabhPsDevProvState OBJECT-TYPE SYNTAX INTEGER { pass (1), inProgress (2), fail (3) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the completion state of the PS initialization process. Pass or Fail states occur after completion of the initialization flow. InProgress occurs from PS initialization start to PS initialization end." ::= { cabhPsDevProv 9 } cabhPsDevProvAuthState OBJECT-TYPE SYNTAX INTEGER { accepted (1), rejected (2) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the authentication state of the configuration file." ::= { cabhPsDevProv 10 } cabhPsDevTimeServerAddrType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The IP address type of the Time server (RFC-868). IP version 4 is typically used." ::= { cabhPsDevProv 11 } cabhPsDevTimeServerAddr OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The IP address of the Time server (RFC-868). Returns 0.0.0.0 if the time server IP address is unknown." ::= { cabhPsDevProv 12 } -- -- notification group is for future extension. -- cabhPsNotification OBJECT IDENTIFIER ::= { cabhPsDevMib 2 0 } cabhPsConformance OBJECT IDENTIFIER ::= { cabhPsDevMib 3 } cabhPsCompliances OBJECT IDENTIFIER ::= { cabhPsConformance 1 } cabhPsGroups OBJECT IDENTIFIER ::= { cabhPsConformance 2 } -- -- Notification Group -- cabhPsDevInitTLVUnknownTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "Event due to detection of unknown TLV during the TLV parsing process. The values of docsDevEvLevel, docsDevId, and docsDevEvText are from the entry which logs this event in the docsDevEventTable. The value of cabhPsDevWanManMacAddress indicates the WAN-Man MAC address of the PS. " ::= { cabhPsNotification 1 } cabhPsDevInitTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress, cabhPsDevProvConfigFile, cabhPsDevProvConfigTLVProcessed, cabhPsDevProvConfigTLVRejected } STATUS current DESCRIPTION "This inform is issued to confirm the successful completion of the CableHome provisioning process. " ::= { cabhPsNotification 2 } cabhPsDevInitRetryTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "An event to report a failure during the PS initialization process. " ::= { cabhPsNotification 3 } cabhPsDevDHCPFailTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress, cabhCdpServerDhcpAddress } STATUS current DESCRIPTION "An event to report the failure of the PS to successfully complete message exchange with a DHCP server on its WAN-Man interface. The value of cabhCdpServerDhcpAddress is the IP address of the DHCP server. " ::= { cabhPsNotification 4 } cabhPsDevSwUpgradeInitTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress, docsDevSwFilename, docsDevSwServer } STATUS current DESCRIPTION "An event to report a software upgrade initiated event. The values of docsDevSwFilename, and docsDevSwServer indicate the software image name and the server IP address the image is from. This trap is only issued by a PS if the PS is not embedded with a cable modem. Software upgrade for a PS embedded with a cable modem is initiated and controlled by the cable modem software. " ::= { cabhPsNotification 5 } cabhPsDevSwUpgradeFailTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress, docsDevSwFilename, docsDevSwServer } STATUS current DESCRIPTION "An event to report the failure of a software upgrade attempt. The values of docsDevSwFilename, and docsDevSwServer indicate the software image name and the server IP address the image is from. " ::= { cabhPsNotification 6 } cabhPsDevSwUpgradeSuccessTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress, docsDevSwFilename, docsDevSwServer } STATUS current DESCRIPTION "An event to report the Software upgrade success event. The values of docsDevSwFilename, and docsDevSwServer indicate the software image name and the IP address of the TFTP server on which the software image is stored. " ::= { cabhPsNotification 7 } cabhPsDevSwUpgradeCVCFailTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "An event to report the failure of the software image verification during a secure software upgrade attempt. " ::= { cabhPsNotification 8 } cabhPsDevTODFailTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevTimeServerAddr, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "An event to report the failure of a time of day server. The value of cabhPsDevTimeServerAddr indicates the time server's IP address. " ::= { cabhPsNotification 9 } cabhPsDevCdpWanDataIpTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhCdpWanDataAddrClientId, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "An event to report the failure of PS to obtain all needed WAN-Data IP addresses. The PS is configured by the manager for the number of WAN-Data IP address leases it is required to acquire. If the PS is unable to acquire the configured number of leases it reports the error using this trap. The object cabhCdpWanDataAddrClientId indicates the ClientId for which the failure occurred. " ::= { cabhPsNotification 10 } cabhPsDevCdpThresholdTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress, cabhCdpLanTransThreshold } STATUS current DESCRIPTION "An event to report that the LAN-Trans threshold has been exceeded. The LAN-Trans threshold is a parameter defined in the Cable Gateway Configuration MIB that enables the manager to manage the Cable Gateway address configuration. " ::= { cabhPsNotification 11 } cabhPsDevCspTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "To report an event with the CableHome Security Portal. This includes reporting on firewall hacker attacks, changes in firewall parameters, and problems with transferring the firewall policy file via TFTP. " ::= { cabhPsNotification 12 } cabhPsDevCapTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "To report an event with the CableHome Address Portal (CAP). CAP events include reporting on problems with creating network address mappings. " ::= { cabhPsNotification 13 } cabhPsDevCtpTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "To report an event with the CableHome Test Portal (CTP). CTP events include status of remote diagnostic tests executed by the PS at the direction of the manager. " ::= { cabhPsNotification 14 } cabhPsDevProvEnrollTrap NOTIFICATION-TYPE OBJECTS { cabhPsDevHardwareVersion, docsDevSwCurrentVers, cabhPsDevTypeIdentifier, cabhPsDevWanManMacAddress, cabhPsDevProvCorrelationId } STATUS current DESCRIPTION "This inform is issued to enroll the PS with the SNMPv3 management entity in the cable operator's network. " REFERENCE "Inform as defined in RFC 1902" ::= { cabhPsNotification 15 } cabhPsDevCdpLanIpPoolTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress, cabhCdpLanTransCurCount } STATUS current DESCRIPTION "An event to report that the pool of IP addresses for LAN clients, as defined by cabh CdpLanPoolStart and cabhCdpLanPoolEnd, is exhausted. " ::= { cabhPsNotification 16} -- compliance statements cabhPsBasicCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for devices that implement the CableHome Portal Services functionality. " MODULE --cabhPsMib -- unconditionally mandatory groups MANDATORY-GROUPS { cabhPsGroup } ::= { cabhPsCompliances 1} cabhPsGroup OBJECT-GROUP OBJECTS { cabhPsDevDateTime, cabhPsDevResetNow, cabhPsDevSerialNumber, cabhPsDevHardwareVersion, cabhPsDevWanManMacAddress, cabhPsDevWanDataMacAddress, cabhPsDevTypeIdentifier, cabhPsDevSetToFactory, cabhPsDevTodSyncStatus, cabhPsDevProvMode, cabhPsDevProvisioningTimer, cabhPsDevProvConfigFile, cabhPsDevProvConfigHash, cabhPsDevProvConfigFileSize, cabhPsDevProvConfigFileStatus, cabhPsDevProvConfigTLVProcessed, cabhPsDevProvConfigTLVRejected, cabhPsDevProvSolicitedKeyTimeout, cabhPsDevProvState, cabhPsDevProvAuthState, cabhPsDevTimeServerAddrType, cabhPsDevTimeServerAddr } STATUS current DESCRIPTION "Group of objects for the Cable Gateway Device MIB." ::= { cabhPsGroups 1 } cabhPsNotificationGroup NOTIFICATION-GROUP NOTIFICATIONS { cabhPsDevInitTLVUnknownTrap, cabhPsDevInitTrap, cabhPsDevInitRetryTrap, cabhPsDevDHCPFailTrap, cabhPsDevSwUpgradeInitTrap, cabhPsDevSwUpgradeFailTrap, cabhPsDevSwUpgradeSuccessTrap, cabhPsDevSwUpgradeCVCFailTrap, cabhPsDevTODFailTrap, cabhPsDevCdpWanDataIpTrap, cabhPsDevCdpThresholdTrap, cabhPsDevCspTrap, cabhPsDevCapTrap, cabhPsDevCtpTrap, cabhPsDevProvEnrollTrap, cabhPsDevCdpLanIpPoolTrap } STATUS current DESCRIPTION "These notifications indicate change in status of the Portal Services set of functions in a device complying with CableLabs CableHome(tm) specifications." ::= { cabhPsGroups 2 } END -- -- Copyright (C) The Internet Society (1999). 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 -- 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. -- --