Cablemodem/docsis/custom_mibs/Ht-EmtaMgmt.mib

HITRON-EMTA-MGMT-MIB DEFINITIONS ::= BEGIN
IMPORTS
        MODULE-IDENTITY,
        OBJECT-TYPE,
        Counter32,
        Integer32,
        Unsigned32,
        IpAddress,
        experimental,
        private,
        enterprises,
        transmission
            FROM SNMPv2-SMI
        SnmpAdminString
            FROM HITRON-CABLE-MODEM-MIB
        TruthValue, 
        DateAndTime
	      FROM SNMPv2-TC;

-- Textual Conventions

		hitronMib					OBJECT IDENTIFIER ::= {  enterprises 8595  }
-- Textual Conventions

    eMTAType MODULE-IDENTITY
    LAST-UPDATED "200912170100Z" --  Dec 17, 2009
    ORGANIZATION "Hitron Technologies, Inc."
    CONTACT-INFO
        " Chang Qing
        Postal: Hitron Technologies, Inc.
            No. 1-8, Lihsin 1st Rd., Hsinchu Science Park,
            Hsinchu,
            Taiwan, R.O.C.
            Phone: +886 3 578 6658 ext. 3613
            E-mail: changqing@sz.hitrontech.com"
    DESCRIPTION
        "The MIB module to describe the Hitron eMTA private management functions."

    REVISION      "200912170100Z" --  Dec 17, 2009
    DESCRIPTION
        "Add the the OID htEmtaConfigeQOSEnable to control the enable/disable of the eMTA's QOS.
        Add the OID htEmtaProvisioningFlow to control the provisioning flow.
        Add the german country profile."          

    REVISION "0906100000Z"
    DESCRIPTION
        "Add RTCP info.Edit by YuLin@Hitron"

    REVISION "0906100000Z"
    DESCRIPTION
        "Add country profile in hitronEmtaMgmtBase"
        
    REVISION      "200911050100Z" --  Nov 5, 2009
    DESCRIPTION
        "Add the latvia,belarus and ukraine country items in the OID of hitronEmtaConfigeCountryCode"          
        
    REVISION      "200911170100Z" --  Nov 17, 2009
    DESCRIPTION
        "Add the date/time for start/end of call, direction of the call and increase the statistic table to 32 for
        hitronEmtaSummCallPackStatTable"
        
    REVISION      "200911260100Z" --  Nov 26, 2009
    DESCRIPTION
        "Add the GR909 test OID"       
        
    REVISION "0807140000Z"
    DESCRIPTION
        "Initial Compilable Version."
    ::= { hitronMib 3653 }
    
    hitronemtaMgmt OBJECT IDENTIFIER ::= {  eMTAType 1  }
    
hitronEmtaMgmtBase             OBJECT IDENTIFIER   
	--DEFAULT set-function-async    EmtaMgmtBase_set
	--DEFAULT get-function-async    EmtaMgmtBase_get
	--DEFAULT test-function-async   EmtaMgmtBase_test
	--DEFAULT next-function-async   std_next_async
	--DEFAULT cookie        		(char *)0
 ::= { hitronemtaMgmt 1 }
hitronEmtaMgmtMaintenance      OBJECT IDENTIFIER   
	--DEFAULT set-function-async    EmtaMgmtMaintenance_set
	--DEFAULT get-function-async    EmtaMgmtMaintenance_get
	--DEFAULT test-function-async   EmtaMgmtMaintenance_test
	--DEFAULT next-function-async   std_next_async
	--DEFAULT cookie        		(char *)0
 ::= { hitronemtaMgmt 2 }
hitronEmtaSummCallPackStatTable OBJECT-TYPE
  SYNTAX     SEQUENCE OF HitronEmtaSummCallPackStatEntry
  MAX-ACCESS not-accessible
  STATUS     current
  DESCRIPTION
  "A list of Call entries"
    ::= { hitronemtaMgmt 3 } 
 --
-- emtaMgmtBase - objects for general-purpose eMTA control
--

hitronEmtaInhibitSwDownloadDuringCall OBJECT-TYPE
    SYNTAX      TruthValue
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object controls the processing logic of software downloading requests when
        there are specific telephony related EMTA activities. If this object has a value
        of true(1), DOCSIS software download by way of the docsDevSwAdminStatus MIB object
        will be inhibited if the value of esafeDevServiceIntImpact for the eMTA entry has
        a value of significant(1), indicating a call in progress.  If docsDevSwAdminStatus
        is set to upgradeFromMgt(1) under these conditions,  an error code of
        resourceUnavailable(13) will be returned and an appropriate event logged to the CM
        event log."
    DEFVAL {false}
    ::= { hitronEmtaMgmtBase 1 }

hitronEmtaEnable OBJECT-TYPE
    SYNTAX      TruthValue
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object controls the functioning of the EMTA. When this is set to False,
        the EMTA will be completely disabled. For online configuration of phone-lines,
        please use ifTable on the EMTA IP address. For SIP versions, sipDeviceControl
        is preferred. This is settable only in the configuration file."
    ::= { hitronEmtaMgmtBase 2 }

hitronEmtaCommunityRead OBJECT-TYPE
    SYNTAX	OCTET STRING (SIZE(0..32))
    MAX-ACCESS	read-write
    STATUS	current
    DESCRIPTION
	"This object controls the value of the default read community string. By default
        this has the value public."
    DEFVAL {"public"}
    ::= { hitronEmtaMgmtBase 3 }

hitronEmtaCommunityWrite OBJECT-TYPE
    SYNTAX	OCTET STRING (SIZE(0..32))
    MAX-ACCESS	read-write
    STATUS	current
    DESCRIPTION
	"This object controls the value of the defalt write community string. By default
	this has the value private for SIP versions, and public for MGCP versions."
    DEFVAL {"private"}
    ::= { hitronEmtaMgmtBase 4 }

hitronEmtaConfigeCountryCode OBJECT-TYPE
    SYNTAX      INTEGER {
                etsi(1), 
                austria(2),
                belgium(3),
                czech(4),
                france(5),
                hungary(6),
                ireland(7),
                netherlands(8),
                poland(9),
                romania(10),
                slovakia(11),
                slovenia(12),
                switzerland(13),
                denmark(14),
                latvia(15),
                belarus(16),
                ukraine(17),
                german(18)
    }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "Restricts the telepnony profile set based on country requirements.
        Set country specific telephone line parameters.
        Note: 
        Equivalent of VSIF 118.
        This object can be set via the docsis configuration file ONLY."
    DEFVAL { etsi }
    ::= { hitronEmtaMgmtBase 5 }

hitronEmtaEuroPacketCableEnable OBJECT-TYPE
    SYNTAX      TruthValue
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object controls the EuroPacketCable operation of the EMTA. When this is set to False,
        the EMTA will be run under PacketCable mode. When this is set to ture,
        the EMTA will be run under EuroPacketCable mode."
    DEFVAL { true }
    ::= { hitronEmtaMgmtBase 6 }

hitronEmtaGR909Enable OBJECT-TYPE
    SYNTAX      TruthValue
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "Controls the enable/disable of GR909 tests.  If set to true(1),
         the GR909 tests could be performed. Also, this OID would be used to enable/disable
         the display of GR909 test page in the GUI interface. This value would be stored in the NVRAM."
    DEFVAL { false }
    ::= { hitronEmtaMgmtBase 7 }    

hitronEmtaGR909TestLine OBJECT-TYPE
     SYNTAX      Integer32(1..2)
     MAX-ACCESS  read-write
     STATUS      current
     DESCRIPTION
         "The line number.  1 means line1.  2 means line2."
    DEFVAL { 1 }
    ::= { hitronEmtaMgmtBase 8 }

hitronEmtaGR909TestType OBJECT-TYPE
    SYNTAX      INTEGER {
                disabled(0),
                line-voltage-test(1),
                receiver-off-hook-test(2),
                ringer-equivalence-number-test(3),
                resistive-fault-test(4),
                other-basic-tests(5),
                loopback-test(6),
                dc-feed-self-test(7),
                dc-voltage-self-test(8),
                ringing-self-test(9),
                on-off-hook-self-test(10)
    }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
          "The type of GR909 test. The readback value of this OID would always be 0,disabled. If users want
          to perform a particular test item, the type needs to be selected first and applied. The test result would be updated
          to the hitronEmtaGR909TestResult OID and kept until the other test or disabled is applied. This OID value and the
          result OID values would not be stored in the NVRAM. If the hitronEmtaGR909Enable is set to false, no test here would
          be effective."
    DEFVAL { 0 }
    ::= { hitronEmtaMgmtBase 9 }

hitronEmtaGR909TestResult OBJECT-TYPE
    SYNTAX     INTEGER {
                none(0),
                pass(1),
                fail(2),
                on-hook(3),
                off-hook(4),
                non-support(99)
    }
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
          "The test result of the GR909 test. If some test is performed, its result would be displayed as pass/fail or non-supported.
          If the hitronEmtaGR909TestType is set to receiver-off-hook-test(2),its result would be displayed as on-hook/off-hook or fail.
          If the disabled type is select in the test type, the return value of this OID would be none. Also, If the device is 
          power-cycled and no test performed after that, the test result would always be none. If the hitronEmtaGR909Enable 
          is set to false, the readback value of this OID would always be none.This test need some time to perform.Suggest to config 
          the mib browser timeout time more than 8s."
    DEFVAL { 0 }
    ::= { hitronEmtaMgmtBase 10 } 

htEmtaProvisioningFlow OBJECT-TYPE
    SYNTAX   BITS {
            security(0),
            hybrid(1),
            basic(2)
      }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "Control the PACM_CONFIG_PROVISION_FLOWS_SUPPORT value. 0x80 would support only security flow. 0xe0 would support basic, hybrid
         and security flow. The default value for SIP code is 0x20 and 0x80 is for MGCP code. In the cli,0x1=security; 0x2=hybrid; 0x4=basic."

    ::= { hitronEmtaMgmtBase 11 }  

htEmtaConfigeQOSEnable OBJECT-TYPE
    SYNTAX      TruthValue
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "Control the enable/disable of the eMTA's QOS. Default value for SIP code is true and false for MGCP code."

    ::= { hitronEmtaMgmtBase 12 }  
    

--
-- hitronEmtaMgmtMaintenance - objects allowing specification and control of a
-- maintenance window during which time IP outages are expected and error
-- conditions may be handled differently
--

hitronEmtaMaintenanceWindowBegin OBJECT-TYPE
    SYNTAX      DateAndTime
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object identifies the start of an eMTA maintenance window. A maintenance
         window is a period of time during which the ISP may perform network
         maintenance operations and network outages or software resets may
         occur. During a maintenance window, the eMTA will maintain the line
         voltage of an MTA regardless of CM resets, MTA resets, or RF losses.
         If any of these conditions occurs or persists outside of the scheduled
         maintenance window then the line voltage will be dropped unless the
         corresponding bit for the condition in question is set in the
         emtaMaintenanceControlMask MIB. If this object has never been set,
         it will have the value of midnight, January 1, 1970. Note that the
         time value used here is the local time as known by the device, as
         opposed to UTC. Also note that the value of this object will persist
         across a system reboot."
    ::= { hitronEmtaMgmtMaintenance 1 }

hitronEmtaMaintenanceWindowDuration OBJECT-TYPE
    SYNTAX      Unsigned32
    UNITS       "seconds"
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object identifies the duration, in seconds, of an eMTA maintenance window.
         Setting the value of this object to the default value of zero will
         cancel the maintenance window. Note that the value of this object
         will persist across a system reboot."
    ::= { hitronEmtaMgmtMaintenance 2 }

hitronEmtaMaintenanceControlMask OBJECT-TYPE
    SYNTAX   BITS {
            maintenanceOnCmReset(0),
            maintenanceOnRFLoss(1),
            maintenanceOnMtaReset(2),
            maintenanceOnCMSLoss(3)
      }
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object identifies the bit mask to control the line voltage behavior of the eMTA in
         various scenarios:
         maintenanceOnCmReset(0) -  if this bit is set to 1 it requires the line
         voltage be maintained in the case when the CM has been reset, regardless
         of the reason (reset after downloading a new firmware, or hard reboot, or
         SNMP induced CM reset), and regardless of whether the MTA is in a valid
         maintenance window maintenanceOnRFLoss(1) - if this bit is set to 1 it
         requires the line voltage be maintained in the case when RF communication
         is lost, regardless of the reason, and regardless of whether the MTA is
         in a valid maintenance window maintenanceOnMtaReset(2) - if this bit is
         set to 1 it requires the line voltage be maintained in the case when the
         eMTA is being reset, regardless of the reason (e.g. SNMP induced eMTA reset,
         etc), and regardless of whether the MTA is in a valid maintenance window
         maintenanceOnCMSLoss(3) - if this bit is set to 1 it requires the line
         voltage be maintained in the case when communication is lost with the CMS,
         regardless of the reason (e.g. endpoint disconnected, etc), and regardless
         of whether the duration of the communication loss has exceeded the value
         in the MIB emtaMaintenanceQuarantineTimeout and/or emtaMaintenanceDisconnectedTimeout

         The default value of this object may change based on build specific options.
         However, it's highly recommended that the default value in the image submitted
         for (E)PC 1.x Certification be chosen in such a way that it will correspond
         to the functionality compliant with the PacketCable requirements and will
         preserve the backward compatibility with the previously certified behaviour.
         Note that to satisfy the latter, 'maintenanceOnCMSLoss(3)' bit should be set
         by default."
    ::= { hitronEmtaMgmtMaintenance 3 }

hitronEmtaMaintenanceQuarantineTimeout OBJECT-TYPE
    SYNTAX      Unsigned32
    UNITS       "seconds"
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object identifies the length of time, in seconds, that the MTA should maintain the
         line voltage after any of the endpoints enters the quarantine state. If any
         of the endpoints remains in the quarantine state for longer than this period
         the line voltage is dropped unless the maintenanceOnCMSLoss bit
         is set in the emtaMaintenanceControlMask MIB. Note that the value
         of this object will persist across a system reboot."
    DEFVAL {120}
    ::= { hitronEmtaMgmtMaintenance 4 }

hitronEmtaMaintenanceDisconnectedTimeout OBJECT-TYPE
    SYNTAX      Unsigned32
    UNITS       "seconds"
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object identifies the length of time, in seconds, that the MTA should maintain the
         line voltage after any of the endpoints is disconnected. If any of the endpoints
         remains disconnected for longer than this period the line voltage is dropped
         unless the maintenanceOnCMSLoss bit is set in the emtaMaintenanceControlMask MIB.
         Note that the value of this object will persist across a system reboot."
    DEFVAL {120}
    ::= { hitronEmtaMgmtMaintenance 5 }

hitronEmtaMaintenanceRFDisconnectTimeout OBJECT-TYPE
    SYNTAX      Unsigned32 (0..3600)
    UNITS       "seconds"
    MAX-ACCESS  read-write
    STATUS      current
    DESCRIPTION
        "This object identifies the length of time, in seconds, that the MTA should maintain the 
         line voltage after the RF lock with the CMTS is lost. If the MTA remains disconnected
         from the CMTS for longer than this period the line voltage is dropped unless the
         maintenanceOnRFLoss bit is set in the emtaMaintenanceControlMask MIB. 
         Note that the value of this object will persist across a system reboot."
    DEFVAL {300}
::= { hitronEmtaMgmtMaintenance 6 }
    
hitronEmtaSummCallPackStatEntry OBJECT-TYPE
  SYNTAX     HitronEmtaSummCallPackStatEntry
  MAX-ACCESS not-accessible
  STATUS     current
  DESCRIPTION
  "parameters for Call."
  INDEX   { hitronEmtaSummCallPackStatIndex }
	--DEFAULT test-function-async   	null_test_async
	--DEFAULT set-function-async    	null_set_async
	--DEFAULT get-function-async    	hitronEmtaSummCallPackStatEntry_get
	--DEFAULT next-function-async   	hitronEmtaSummCallPackStatEntry_next
	--DEFAULT cookie        		    (char *)0            
  ::= { hitronEmtaSummCallPackStatTable 1 }
  
HitronEmtaSummCallPackStatEntry ::=
        SEQUENCE {
                  hitronEmtaSummCallPackStatIndex
                            Integer32,
                  hitronEmtaDirecOfCall
                            Integer32,
                  hitronEmtaAverageDelay
                            Integer32,
                  hitronEmtaInterarrivalJitter
                    				Integer32,
                  hitronEmtaReceivedOctets
                    				Counter32,
                  hitronEmtaSentOctets
                    				Counter32,
                  hitronEmtaSentPackets
                            Counter32,
                  hitronEmtaReceivedPackets
                            Counter32,
                  hitronEmtaLostPackets
                            Counter32,
                  hitronEmtaRemoteSentOctets
                            Counter32,
                  hitronEmtaRemoteSentPackets
                            Counter32,
                  hitronEmtaRemoteLostPackets
                            Counter32,
                  hitronEmtaRemotejitter
                            Counter32,
                  hitronEmtaMosLQ
                            Counter32,
                  hitronEmtaMosCQ
                            Counter32,
                  hitronEmtaCallStartTime
                            SnmpAdminString,
                  hitronEmtaCallEndTime
                            SnmpAdminString,
                  hitronEmtaCallDurTime
                            Counter32
                      }
    
hitronEmtaSummCallPackStatIndex OBJECT-TYPE
  SYNTAX     Integer32 (1..32)
  MAX-ACCESS not-accessible
  STATUS     current
  DESCRIPTION
  "The current call index."
  ::= { hitronEmtaSummCallPackStatEntry 1 } 

hitronEmtaDirecOfCall	OBJECT-TYPE
	SYNTAX         Integer32 (0..1)
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the direction of the call:incoming(0)/outgoing(1)."
	::= { hitronEmtaSummCallPackStatEntry 2 }

hitronEmtaAverageDelay	OBJECT-TYPE
	SYNTAX         Integer32
	UNITS          "ms"
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the average network latency across the call."
	::= { hitronEmtaSummCallPackStatEntry 3 }

hitronEmtaInterarrivalJitter 	OBJECT-TYPE
	SYNTAX         Integer32
	UNITS          "ms"
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the estimate of the statistical variance of the RTP data
	packet interarrival time over all the lines"
	::= { hitronEmtaSummCallPackStatEntry 4 }

hitronEmtaReceivedOctets	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the total number of RTP octets that our device received"
	::= { hitronEmtaSummCallPackStatEntry 5 }

hitronEmtaSentOctets	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the total number of RTP octets that our device sent"
	::= { hitronEmtaSummCallPackStatEntry 6 }

hitronEmtaSentPackets	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the total number of RTP packets that our device sent"
	::= { hitronEmtaSummCallPackStatEntry 7 }

hitronEmtaReceivedPackets	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the total number of RTP packets that our device received"
	::= { hitronEmtaSummCallPackStatEntry 8 }

hitronEmtaLostPackets	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the total number of RTP packets that our device lost"
	::= { hitronEmtaSummCallPackStatEntry 9 }

hitronEmtaRemoteSentOctets	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the total number of RTP octets that the remote device sent(remote device:
    the one who make a call with our device)"
	::= { hitronEmtaSummCallPackStatEntry 10 }

hitronEmtaRemoteSentPackets	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the total number of RTP packets that the remote device sent"
	::= { hitronEmtaSummCallPackStatEntry 11 }

hitronEmtaRemoteLostPackets	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the total number of RTP packets that the remote device lost"
	::= { hitronEmtaSummCallPackStatEntry 12 }

hitronEmtaRemotejitter	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the remote device's mean jitter"
	::= { hitronEmtaSummCallPackStatEntry 13 }

hitronEmtaMosLQ	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the listen MOS(downstream) score."
	::= { hitronEmtaSummCallPackStatEntry 14 }

hitronEmtaMosCQ	OBJECT-TYPE
	SYNTAX         Counter32
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the call MOS(upstream) score."
	::= { hitronEmtaSummCallPackStatEntry 15 }    
  
hitronEmtaCallStartTime	OBJECT-TYPE
	SYNTAX         SnmpAdminString
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the call start time."
	::= { hitronEmtaSummCallPackStatEntry 16 } 
	
hitronEmtaCallEndTime	OBJECT-TYPE
	SYNTAX         SnmpAdminString
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the call end time."
	::= { hitronEmtaSummCallPackStatEntry 17 } 

hitronEmtaCallDurTime	OBJECT-TYPE
	SYNTAX         Counter32
	UNITS          "sec"
	MAX-ACCESS     read-only
	STATUS         current
	DESCRIPTION
	"This is the call duration time"
	::= { hitronEmtaSummCallPackStatEntry 18 } 
END