-- *****************************************************************

-- HARMONIC-CABLEOS-MIB : Harmonic CableEdge CableOs proprietary MIB

--
-- August 2016 Daniel Cohen
--
-- Copyright (c) harmonicInc.
-- All rights reserved.
--
-- *****************************************************************

HARMONIC-CABLEOS-MIB DEFINITIONS ::= BEGIN

IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
NOTIFICATION-TYPE,
Integer32,
Unsigned32,
Counter32,
IpAddress,
Gauge32
FROM SNMPv2-SMI
OBJECT-GROUP,
MODULE-COMPLIANCE,
NOTIFICATION-GROUP
FROM SNMPv2-CONF

TruthValue,
DisplayString,
MacAddress,
TimeStamp,
RowStatus,
TimeInterval,
TEXTUAL-CONVENTION
FROM SNMPv2-TC

ifIndex,
InterfaceIndex
FROM IF-MIB

docsIfCmtsCmStatusIndex,
TenthdBmV,
docsIfCmtsCmMac
FROM DOCS-IF-MIB

ChSetId,
ChannelList
FROM DOCS-IF3-MIB

hrmCableOs,
hrmCENotifDescription,
hrmCENotifPossibleCause,
hrmCENotifRecommendedAction,
hrmCENotifSeverity
FROM HARMONIC-SMI;

hrmCableOsMIB MODULE-IDENTITY
LAST-UPDATED "201607210000Z"
ORGANIZATION "Harmonic Inc"
CONTACT-INFO
" Harmonic Inc.
4300 North First Street
San Jose, CA 95134
U.S.A.
408-542-2500
www.harmonicinc.com"
DESCRIPTION
"The MIB module to describe harmonic cableOs propraietary objects "
REVISION "201607210000Z"
DESCRIPTION
"Revision from 2016-07-21."
::= { hrmCableOs 1 }

--
-- hrmCableOs Objects
--
hrmCableOsMIBObjects OBJECT IDENTIFIER ::= { hrmCableOsMIB 1 }

-- extenstion to ds-rf-port table

hrmDsRfPortObjects OBJECT IDENTIFIER ::= { hrmCableOsMIBObjects 1 }

hrmDsRfPortTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrmDsRfPortEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table describes the attributes of Harmonic CableOs ds-rf-port."
REFERENCE
"Harmonic CableOs CLI"
::= { hrmDsRfPortObjects 1 }

hrmDsRfPortEntry OBJECT-TYPE
SYNTAX HrmDsRfPortEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry provides a list of attributes for a single
CableOs ds-rf-port.
An entry in this table exists for each ifEntry with an
ifType of ds-rf-port as defined in Harmonic Confluence:
http://confluence/display/EDGE/ifIndex."
INDEX { ifIndex }
::= { hrmDsRfPortTable 1 }

HrmDsRfPortEntry ::= SEQUENCE {

hrmDsRfPortCliId DisplayString,
hrmDsRfPortBaseChannelPower TenthdBmV,
hrmDsRfPortMaxOccupiedBw Integer32,
hrmDsRfPortTiltAdjust TenthdBmV,
hrmDsRfPortOfdmExclusionBlock Integer32,
hrmDsRfPortOfdmNcpExclusionBlock Integer32,
hrmDsRfPortRfMute TruthValue
}

hrmDsRfPortCliId OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"ASCII text as displayed in CLI that identify uniquely
ds-rf-port in Harmonic CableOS system"
::= { hrmDsRfPortEntry 1 }

hrmDsRfPortBaseChannelPower OBJECT-TYPE
SYNTAX TenthdBmV
UNITS "dBmV"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"the configured value (CMTS) of the ds-rf-port base channel
transmit power. The min-max range of values permitted are:
Neq = CEILING(hrmDsRfPortMaxOccupiedBw / 6);
max = 60-CEILING(3.6*LOG2(Neq));
min = max -8db"
REFERENCE
"Harmonic CableOs CLI"
::= { hrmDsRfPortEntry 2 }

hrmDsRfPortMaxOccupiedBw OBJECT-TYPE
SYNTAX Integer32 (0..1000000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"the configured value (CMTS) of the ds-rf-port
maximum bandwidth occupied. it is deriving the min-max window
of hrmDsRfPortBaseChannelPower object."
REFERENCE
"Harmonic CableOs CLI"
::= { hrmDsRfPortEntry 3 }

hrmDsRfPortTiltAdjust OBJECT-TYPE
SYNTAX TenthdBmV
UNITS "dBmV"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"the configured value (CMTS) of the ds-rf-port tilt adjust
transmit power."
REFERENCE
"Harmonic CableOs CLI"
::= { hrmDsRfPortEntry 4 }

hrmDsRfPortOfdmExclusionBlock OBJECT-TYPE
SYNTAX Integer32 (0..1000000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"tbd"
REFERENCE
"Harmonic CableOs CLI"
::= { hrmDsRfPortEntry 5 }

hrmDsRfPortOfdmNcpExclusionBlock OBJECT-TYPE
SYNTAX Integer32 (0..1000000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"tbd"
REFERENCE
"Harmonic CableOs CLI"
::= { hrmDsRfPortEntry 6 }

hrmDsRfPortRfMute OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"tbd"
::= { hrmDsRfPortEntry 7 }

--
-- CM partial service mode information.
--
hrmCmtsCmPartialSvcTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrmCmtsCmPartialSvcEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object defines current status information of the CM
on each downstream/upstream channel, as reported by the CMTS."
::= { hrmCableOsMIBObjects 2 }

hrmCmtsCmPartialSvcEntry OBJECT-TYPE
SYNTAX HrmCmtsCmPartialSvcEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The conceptual row of hrmCmtsCmPartialSvcTable.
A separate entry exists for every CM known to CMTS."
INDEX { docsIfCmtsCmStatusIndex }
::= { hrmCmtsCmPartialSvcTable 1 }

HrmCmtsCmPartialSvcEntry ::= SEQUENCE {

hrmCmtsCmPartialSvcMacDomainIfindex InterfaceIndex,
hrmCmtsCmPartialSvcMacAddr MacAddress,
hrmCmtsCmPartialSvcDSChanSetID ChSetId,
hrmCmtsCmPartialSvcUSChanSetID ChSetId,
hrmCmtsCmPartialSvcDSChanImpairList ChannelList,
hrmCmtsCmPartialSvcUSChanImpairList ChannelList,
}

hrmCmtsCmPartialSvcMacDomainIfindex OBJECT-TYPE
SYNTAX InterfaceIndex
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The ifIndex key corresponds to the MAC Domain interface."
::= { hrmCmtsCmPartialSvcEntry 1 }

hrmCmtsCmPartialSvcMacAddr OBJECT-TYPE
SYNTAX MacAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"MAC address of the Cable Modem's Cable interface."
::= { hrmCmtsCmPartialSvcEntry 2 }

hrmCmtsCmPartialSvcDSChanSetID OBJECT-TYPE
SYNTAX ChSetId
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This key defines a reference identifier for the downstream
channel set within the MAC Domain."
::= { hrmCmtsCmPartialSvcEntry 3 }

hrmCmtsCmPartialSvcUSChanSetID OBJECT-TYPE
SYNTAX ChSetId
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This key defines a reference identifier for the upstream
channel set within the MAC Domain. "
::= { hrmCmtsCmPartialSvcEntry 4 }

hrmCmtsCmPartialSvcDSChanImpairList OBJECT-TYPE
SYNTAX ChannelList
MAX-ACCESS read-only
STATUS current
DESCRIPTION
" This attribute defines the list of downstream impaired
channels that comprise the downstream channel set."
::= { hrmCmtsCmPartialSvcEntry 5 }

hrmCmtsCmPartialSvcUSChanImpairList OBJECT-TYPE
SYNTAX ChannelList
MAX-ACCESS read-only
STATUS current
DESCRIPTION
" This attribute defines the list of upstream impaired
channels that comprise the downstream channel set."
::= { hrmCmtsCmPartialSvcEntry 6 }

--
-- SNMP alternative to CableOs CLI cmd 'copy running-config startup-config'.
--
hrmCableOsCLICpRunningToStartupCfg OBJECT-TYPE
SYNTAX INTEGER {
idle(0),
started(1),
running(2)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"hrmCableOsCLICpRunningToStartupCfg purpose is to provide
user ability to invoke over SNMP
saving running configuration to startup configuration file

hrmCableOsCLICpRunningToStartupCfg exploitation
do not assume havy load and huge amount of repeatable
actions.
Correct way to use hrmCableOsCLICpRunningToStartupCfg is
to make all changes over SNMP and then use
hrmCableOsCLICpRunningToStartupCfg to save them.
It's bad practice to use hrmCableOsCLICpRunningToStartupCfg
after each consequtive configuration change, which could
cause hanging and system overload.

Setting this object to true(1) causes the CableOs to

store running configuration to startup configuration.
Reading this object always returns false(2)."
REFERENCE
"Harmonic CableOs CLI"
::= { hrmCableOsMIBObjects 3 }

--
-- hrmCmtsCmOfdmaChannelMerTable
--
hrmCmtsCmOfdmaChannelMerTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrmCmtsCmOfdmaChannelMerEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table provides information about average and minimal MER value
for all registered CM per CM since last SNMP sent."
REFERENCE
"Harmonic CableOs CLI"
::= { hrmCableOsMIBObjects 4 }

hrmCmtsCmOfdmaChannelMerEntry OBJECT-TYPE
SYNTAX HrmCmtsCmOfdmaChannelMerEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This entry provides a list with information about average and minimal MER
value
for all registered CM per CM since last SNMP sent."
INDEX { docsIfCmtsCmMac,
ifIndex,
miniSlotIndex }
::= { hrmCmtsCmOfdmaChannelMerTable 1 }

HrmCmtsCmOfdmaChannelMerEntry ::= SEQUENCE {

docsIfCmtsCmMac MacAddress,
ifIndex InterfaceIndex,
miniSlotIndex Integer32,
hrmOfdmaChannelMerAverage DisplayString,
hrmOfdmaChannelMerMinimal DisplayString
}

miniSlotIndex OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An index of mini-slot"
::= { hrmCmtsCmOfdmaChannelMerEntry 1 }

hrmOfdmaChannelMerAverage OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Average of all subcarriers in this mini-slot current RxMER value:
collected by probe every configurable period"
::= { hrmCmtsCmOfdmaChannelMerEntry 2 }

hrmOfdmaChannelMerMinimal OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Minimal value (over time) of all MER-average samples collected
since the last SNMP read (clear on read)."
::= { hrmCmtsCmOfdmaChannelMerEntry 3 }
--
-- hrmCableOs Modules
--
hrmCableOsMIBModules OBJECT IDENTIFIER ::= { hrmCableOsMIB 2 }

--
-- hrmCableOs Conformance statement
--
hrmCableOsConformance OBJECT IDENTIFIER ::= { hrmCableOsMIB 3 }
hrmCableOsCompliances OBJECT IDENTIFIER ::= { hrmCableOsConformance 1 }
hrmCableOsGroups OBJECT IDENTIFIER ::= { hrmCableOsConformance 2 }

--
-- hrmCableOs Notifications
--
hrmCableOsMIBNotifPrefix OBJECT IDENTIFIER ::= { hrmCableOsMIB 4 }
hrmCableOsMIBNotifs OBJECT IDENTIFIER ::= { hrmCableOsMIBNotifPrefix 0 }

hrmEntityRpdStateChanged NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon RPD change state.
[RPD vc:cs or mac or ip identifier]
[old->new] state transtion
MUST be defined as part of hrmCENotifDescription"
::= { hrmCableOsMIBNotifs 1 }

hrmEntityCoreServerStateChanged NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon CORE-SERVER change state.
[Core-Server hostname]
[old->new] state transtion
MUST be defined as part of hrmCENotifDescription"
::= { hrmCableOsMIBNotifs 2 }

hrmEntityMemoryError NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon memory corruption.
[core-server cli hostname IPMI interface] or [rpd-identifier]
MUST be part of hrmCENotifDescription."
::= { hrmCableOsMIBNotifs 3 }

hrmEntityChassisIntrusion NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon Chassis Intrusion.
[core-server cli hostname IPMI interface] or [rpd-identifier]
MUST be part of hrmCENotifDescription."
::= { hrmCableOsMIBNotifs 4 }

hrmEntityRpdSshSessionOpened NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon new SSH connection to RPD CLI or shell.
hrmCENotifDescription contains SSH session type (CLI/shell),
session id, client username, ip and port, and the RPD identification
information (name, ip and mac)"
::= { hrmCableOsMIBNotifs 5 }

hrmEntityRpdSshSessionClosed NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon closing of SSH connection to RPD CLI or shell.
hrmCENotifDescription contains SSH session type (CLI/shell),
session id, client username, ip and port, and the RPD identification
information (name, ip and mac)"
::= { hrmCableOsMIBNotifs 6 }

hrmEntityRpdConfigChanged NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon RPD configuration change.
[RPD vc:cs or mac or ip identifier]
MUST be defined as part of hrmCENotifDescription"
::= { hrmCableOsMIBNotifs 8 }

hrmEntityRpdDsPortStateChanged NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon RPD DS RF port state change.
[RPD vc:cs or mac or ip identifier]
MUST be defined as part of hrmCENotifDescription"
::= { hrmCableOsMIBNotifs 10 }

hrmEntityRpdDsChannelStateChanged NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon RPD DS SCQAM channel state change.
[RPD vc:cs or mac or ip identifier]
MUST be defined as part of hrmCENotifDescription"
::= { hrmCableOsMIBNotifs 11 }

hrmEntityRpdDsOfdmChannelStateChanged NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon RPD DS OFDM channel state change.
[RPD vc:cs or mac or ip identifier]
MUST be defined as part of hrmCENotifDescription"
::= { hrmCableOsMIBNotifs 12 }

hrmEntityNodeLeft NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon a core server left the cluster.
[core-server cli hostname IPMI interface]
MUST be defined as part of hrmCENotifDescription"
::= { hrmCableOsMIBNotifs 13 }

hrmEntityNodeJoined NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon a core server joined the cluster.
[core-server cli hostname IPMI interface]
MUST be defined as part of hrmCENotifDescription"
::= { hrmCableOsMIBNotifs 14 }

hrmCrcErrorStateChanged NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon RPD port crc error state changed.
hrmCENotifDescription contains identifier of port
generated event and current crc error state
[port crc-error-state]"
::= { hrmCableOsMIBNotifs 15 }

hrmNoTrafficOnChannel NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon channel not receiving traffic in a period of a few
seconds
[RPD vc:cs or mac or ip identifier]
[channel-id]"
::= { hrmCableOsMIBNotifs 16 }

hrmRpdPtpSyncTo NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon RPD PTP lock timeout"
::= { hrmCableOsMIBNotifs 17 }

hrmCoreGmSync NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon Core losing GM sync"
::= { hrmCableOsMIBNotifs 18 }

hrmCoreGmSyncLoss NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon Core acquiring GM sync"
::= { hrmCableOsMIBNotifs 19 }

hrmSystemClockChanged NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon CableOS System Clock changing"
::= { hrmCableOsMIBNotifs 20 }

hrmIpsecEvent NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon CableOS IPSEC tunnel event"
::= { hrmCableOsMIBNotifs 21 }

hrmScepEvent NOTIFICATION-TYPE
OBJECTS { hrmCENotifDescription, hrmCENotifSeverity,
hrmCENotifPossibleCause, hrmCENotifRecommendedAction }
STATUS current
DESCRIPTION
"Notification upon CableOS SCEP event"
::= { hrmCableOsMIBNotifs 22 }

END