-- MIB module extracted from ITU-T J.191 (03/2004)

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, InetAddressIPv4, InetAddressIPv6 FROM INET-ADDRESS-MIB docsDevSwCurrentVers, docsDevEvLevel, docsDevEvId, docsDevEvText, docsDevSwFilename, docsDevSwServer FROM DOCS-CABLE-DEVICE-MIB -- RFC2669 cabhCdpServerDhcpAddress, cabhCdpWanDataAddrClientId, cabhCdpLanTransThreshold FROM CABH-CDP-MIB clabProjCableHome FROM CLAB-DEF-MIB; --============================================================================ -- -- History: -- -- --============================================================================= cabhPsDevMib MODULE-IDENTITY LAST-UPDATED "0209200000Z"-- September 20, 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." ::= { 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 device to reboot. Device code initializes as if starting from a power-on reset. The CMP ensures that MIB object values persist as specified. 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 this PS. This parameter is manufacturer provided and is stored in non-volitile memory." ::= { cabhPsDevBase 3 } cabhPsDevHardwareVersion OBJECT-TYPE SYNTAX SnmpAdminString (SIZE (0..48)) MAX-ACCESS read-only STATUS current DESCRIPTION "The manufacturer's hardware version for this PS. 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 by the CDC 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 NMS and the CMP" ::= { cabhPsDevBase 5 } cabhPsDevWanDataMacAddress OBJECT-TYPE SYNTAX PhysAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The PS WAN-Data MAC address. The PS could have multiple WAN-Data Interfaces, which share the same hardware address. The client identifiers will be unique so that each may be assigned a different, unique 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 } cabhPsDevWanManClientId OBJECT-TYPE SYNTAX OCTET STRING (SIZE (1..80)) MAX-ACCESS read-write STATUS current DESCRIPTION "This is the client ID used for WAN-MAN DHCP requests. The default value is the 6 byte MAC address." ::= { cabhPsDevBase 9 } 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 10 } 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, 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 11 } -- -- 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 value is in minutes. Setting the timer to 0 disables it. The default value for the timer is 5." 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 "Size of the configuration file." ::={ 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 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 } cabhPsDevProvCorrelationId OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION " Random value generated by the PS for use in registration authorization. It is for use only in the PS initialization messages and for PS configuration file download. This value appears in both cabhPsDevProvisioningStatus and cabhPsDevProvisioningEnrollmentReport informs to verify the instance of loading the configuration file." ::= { cabhPsDevProv 11 } 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 12 } 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 13 } -- -- 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. This part of the information is uniform across all PS Traps. " ::= { 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 provisioning process." ::= { cabhPsNotification 2 } cabhPsDevInitRetryTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "An event to report a failure happened during the initialization process and detected in the PS. " ::= { cabhPsNotification 3 } cabhPsDevDHCPFailTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress, cabhCdpServerDhcpAddress } STATUS current DESCRIPTION "An event to report the failure of a DHCP server. The value of cabhCdpServerDhcpAddressis 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. " ::= { 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 server IP address the image is from. " ::= { cabhPsNotification 7 } cabhPsDevSwUpgradeCVCFailTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "An event to report the failure of the verification of code file happened 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 server 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. cabhCdpWanDataAddrClientId indicates the ClientId for which the failure occured. " ::= { 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." ::= { cabhPsNotification 11 } cabhPsDevCspTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "To report an event with the Cable Security Portal." ::= { cabhPsNotification 12 } cabhPsDevCapTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "To report an event with the Cable Address Portal." ::= { cabhPsNotification 13 } cabhPsDevCtpTrap NOTIFICATION-TYPE OBJECTS { docsDevEvLevel, docsDevEvId, docsDevEvText, cabhPsDevWanManMacAddress } STATUS current DESCRIPTION "To report an event with the CableHome Test Portal." ::= { cabhPsNotification 14 } cabhPsDevProvEnrollTrap NOTIFICATION-TYPE OBJECTS { cabhPsDevHardwareVersion, docsDevSwCurrentVers, cabhPsDevTypeIdentifier, cabhPsDevWanManMacAddress, cabhPsDevProvCorrelationId } STATUS current DESCRIPTION "This inform is issued to initiate the CableHome process provisioning ." 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 PS feature." MODULE --cabhPsMib -- unconditionally mandatory groups MANDATORY-GROUPS { cabhPsGroup } ::= { cabhPsCompliances 1} cabhPsGroup OBJECT-GROUP OBJECTS { cabhPsDevDateTime, cabhPsDevResetNow, cabhPsDevSerialNumber, cabhPsDevHardwareVersion, cabhPsDevWanManMacAddress, cabhPsDevWanDataMacAddress, cabhPsDevTypeIdentifier, cabhPsDevSetToFactory, cabhPsDevWanManClientId, cabhPsDevTodSyncStatus, cabhPsDevProvMode, cabhPsDevProvisioningTimer, cabhPsDevProvConfigFile, cabhPsDevProvConfigHash, cabhPsDevProvConfigFileSize, cabhPsDevProvConfigFileStatus, cabhPsDevProvConfigTLVProcessed, cabhPsDevProvConfigTLVRejected, cabhPsDevProvSolicitedKeyTimeout, cabhPsDevProvState, cabhPsDevProvAuthState, cabhPsDevProvCorrelationId, cabhPsDevTimeServerAddrType, cabhPsDevTimeServerAddr } STATUS current DESCRIPTION "Group of objects for PS MIB." ::= { cabhPsGroups 1 } cabhPsNotificationGroup NOTIFICATION-GROUP NOTIFICATIONS { cabhPsDevInitTLVUnknownTrap, cabhPsDevInitTrap, cabhPsDevInitRetryTrap, cabhPsDevDHCPFailTrap, cabhPsDevSwUpgradeInitTrap, cabhPsDevSwUpgradeFailTrap, cabhPsDevSwUpgradeSuccessTrap, cabhPsDevSwUpgradeCVCFailTrap, cabhPsDevTODFailTrap, cabhPsDevCdpWanDataIpTrap, cabhPsDevCdpThresholdTrap, cabhPsDevCspTrap, cabhPsDevCapTrap, cabhPsDevCtpTrap, cabhPsDevProvEnrollTrap } STATUS current DESCRIPTION "These notifications deal with change in status of PS Device." ::= { cabhPsGroups 2 } END