DOCS-EQAM-MIB: View SNMP OID List / Download MIB

This MIB module contains the EQAM management requirements.

This attribute represents the address type of the EQAM management IP address.

This attribute represents the EQAM management IP address, or the FQDN if DNS is supported .

This object corresponds to a generic notification used by the EQAM to send events. This notification sends additional information about the as follows. - docsDevEvLevel This attribute represents the event level of the event. Reference: docsDevEvLevel from DOCS-CABLE-DEVICE-MIB. - docsDevEvId This attribute represents the event id of the event. Reference: docsDevEvId from DOCS-CABLE-DEVICE-MIB. - docsDevEvText This attribute represents the event text of the event. Reference: docsDevEvText from DOCS-CABLE-DEVICE-MIB. - docsEqamNotifyMgmtInetAddressType. See definition within this MIB Module - docsEqamNotifyMgmtInetAddress See definition within this MIB Module

This attribute controls the administrative reset of the EQAM device. If set to 'true' the EQAM is reinitialized. This attribute always report the value 'reset'. When the EQAM is instructed to reset itself, it MUST execute the following sequence of events: - Gracefully tear down all sessions if any, i.e., send a session status update to the ERM that will trigger a teardown for each active session to the SRM/ERM. - Shut down all processes/tasks. - Restart.

This attribute indicates the reason for the last reinitialization. Enumeration: 'unknown': 3, 'none': 2, 'nms': 1.

This attribute provides a mechanism to save the current EQAM configuration in the EQAM file system. A set to a non-zero length string representing a valid local file name, the current running configuration us saved into the file name specified. File names including directory paths are optional.

This attribute provides a mechanism to upload the EQAM config file to the configuration server. When set to a URI, the EQAM performs an upload of the current config file being used. TFTP URL is a required URI type. Other URI types maybe supported by the EQAM.

This attribute represents the Master NTP server. This element is not required in case ToD is acquired via DHCP. If DHCP options for ToD are provided and this element is present, the EQAM selects this element.

This attribute represents the backup NTP Server in case the master NTP fails.

This attribute represents the offset value to the local time to arrive at UTC Time. The value has the following format: hh[:mm] The hour (0 <= hh <= 24) is required, minutes (0 < mm <= 59) The mm (minutes) is optional. The hour can be preceded by a minus sign (-).

This attribute indicates when to change to and from daylight saving (or summer) time. The value has the form: date1/time1,date2/time2,offset The first date describes when the change from standard to daylight saving time occurs, and the second date describes when the change back happens. Each time field describes when, in current local time, the change to the other time is made. The format of date is the following: m.w.d The dth day (0 <= d <= 6) of week w of month m of the year (1 <= w <= 5, 1 <= m <= 12, where week 5 means 'the last d day in month m', which may occur in the fourth or fifth week). Week 1 is the first week in which the dth day occurs. Day zero is Sunday. The time format is the following: hh:mm The offset value is the value you must add to the local time to arrive at UTC Time during the daylight saving time. The offset value has the following format: hh[:mm].

This object represents the syslog server's configuration.

The Conceptual row of docsEqamSyslogServerTable

This key represents the unique identifier of an instance in this object.

This attribute indicates the address type of the syslog server IP address. 'dns' support is optional.

This attribute represents the IP address of the syslog server. If DNS is supported, this attribute can contain the FQDN of the syslog server.

Indicates if the syslog server is user for sending syslog messages or is disabled.

The status of this instance.

This object represents the configuration of the ERRP protocol.

The Conceptual row of docsEqamRegistrationTable

This key represents the name of the ERM related to this registration instance. This is an internal reference for associating e.g. QAM channels and input interfaces to an ERM.

This attribute represents the InetAddress of the ERM.

This attribute represents the IP Address of the ERM

This attribute represents the TCP port number used to reach the ERM.

This attribute represents the type of TCP connection that must be supported by the EQAM. The value can be one of the following: 'client' indicates that the EQAM has to initiate the TCP connection with the ERM. 'server' indicates that the EQAM has to wait the TCP connection from the ERM. 'clientAndServer' indicates that both EQAM or either EQAM or ERM can initiate the TCP connection. Enumeration: 'client': 1, 'clientAndServer': 3, 'server': 2.

This attribute represents the number of seconds that the sender proposes for the value of the hold timer. Upon receipt of an OPEN message, the EQAM MUST calculate the value of the Hold Timer by using the smaller of its configured Hold Time and the Hold Time received in the OPEN message. The Hold Time MUST be either zero or at least three seconds. An implementation MAY reject connections on the basis of the Hold Time. The calculated value indicates the maximum number of seconds that may elapse between the receipt of successive KEEPALIVE and/or UPDATE messages by the sender.

This attribute represents the time in seconds for the connect retry timer. The exact value of the connect retry timer is a local matter, but should be sufficiently large to allow TCP initialization.

This attribute represents the address domain number of the next-hop server. The NextHopServer specifies the address to which a manager should use to connect to the component in order to control the resource specified in the reachable route. This parameter is used in the ERRP NextHopServer attribute.

This attribute represents the ERRP NextHopServer attribute. This field contains a string that conforms to the following syntax: CompAddress = host[:port] host = An FQDN, or an IPv4 address using the textual representation defined in Section 2.1 of [RFC1123], or an IPv6 address using the textual representation defined in Section 2.2 of [RFC4291] and enclosed in '[' and ']' characters. port = numerical value (1-65535). If the port is empty or not given, the default port 6069 is assumed.

This attribute represents the Streaming Zone within which the component operates. This parameter is used in the ERRP OPEN message. StreamingZone Name is a mandatory parameter when supporting video applications. The capability is optional when signaling DOCSIS only resources. The value is to be set to the string that represents the StreamingZone Name i.e. <region>. The characters comprising the string are in the set within TEXT defined in section 15.1 of [RFC2326]. Implementations must support minimum string lengths of 64; however the composition of the string used is defined by implementation agreements specified by the service provider.

This attribute represents the unique identifier for the EQAM device within its Streaming Zone. This value may be set to the 4-octet value of an IPv4 address assigned to that device. This ID value is determined on startup and must be the same for all peer connections. This parameter is used in the ERRP OPEN message header.

This attribute represents the static cost for use of this resource.

The name of the component for which the data in the update message applies. This parameter is used in the ERRP OPEN message. Component Name is a mandatory parameter when supporting video applications. The capability is optional when signaling DOCSIS only resources. The value is to be set to the string that represents the Component Name i.e. <region>.<localname> The characters comprising the string are in the set within TEXT defined in section 15.1 of [RFC2326]. Implementations must support minimum string lengths of 64; however the composition of the string used is defined by implementation agreements specified by the service provider.

The status of this instance.

This attribute represents the loss of signal timeout in milliseconds for unicast input streams. See SCTE-154-4 mpegLossOfSignalTimeout.

This attribute represents the loss of signal timeout in milliseconds for the multicast input streams.

This attribute represents the acceptable delay variation in millisecond for incoming streams. The jitter option sets the size of a dejittering buffer that absorbs the input jitter of a session.

This attribute represents the CAT insertion rate expressed in tables/second (See SCTE-154-4 mpegOutputTSCatInsertRate).

This attribute represents the PAT table interval expressed in tables/second (See SCTe-154-4 mpegOutputTSPatInsertRate).

This attribute represents the PMT table interval expressed in tables/second (See SCTE-154-4 mpegOutputTSPatInsertRate).

This object represents reserved ports to be used for non-video applications.

The Conceptual row of docsEqamReservedUdpMapTable

This key represents the unique identifier of an instance in this object.

This attribute represents the port range start value for non-video applications reserved UDP ports.

This attribute represents the number of reserved UDP ports starting from 'StartingPort' attribute value.

The status of this instance.

This object represents reserved PID range to not be used on ERM assignments.

The Conceptual row of docsEqamReservedPidRangeTable

This key represents the unique identifier of an instance in this object.

This attribute represents the PID range starts for other applications reserved PIDs.

This attribute represents the number of reserved PIDs starting from 'StartingPid' attribute value.

This attribute represents the description associated with a PID range configured instance.

The status of this instance.

This attribute indicates the Timeout in seconds the EQAM waits after a QAM channel session is terminated to advertize the QAM channel as idle to the ERM. This attribute is only meaningful for dynamic DEPI session allocation, not for static sessions.

This object represents the configuration of Input Edge parameters.

The Conceptual row of docsEqamEdgeInputTable

This key represents the Input interface name. This name corresponds to the RFC4133, ENTITY-MIB entPhysicalName.

This attribute represents the IP address type of the 'IpAddress' attribute.

This attribute represents the IP address of the Edge interface. If not included, the EQAM should use DHCP to acquire the IP address of the Edge input interface.

The status of this instance.

This object represents the configuration of Edge ERRP parameters.

The Conceptual row of docsEqamInputRegistrationTable

This attribute represents the name of the Edge Input Group associated with this input. This parameter is used in the ERRP Edge Input attribute.

This attribute represents the bandwidth of the edge input to be advertized. If zero or not present, the EQAM advertize the full bandwidth of the edge input.

This attribute represents the ERM where the QAM channel is advertised. If empty, the QAM channel is not advertized.

The status of this instance.

This object represents the configuration of RF ports. The parameters configured in a RF port applies to all the QAM channels within the RF Port, unless explicit EQAM configuration is defined

The Conceptual row of docsEqamRFPortTable

This key represents the RF port identifier. It corresponds to RFC4133, ENTITY-MIB entPhysicalName.

This attribute represents the administrative state of the RF Port. Setting this element to 'disable' results in the RF port being muted. By default this element reports 'disabled'. Enumeration: 'disabled': 2, 'enabled': 1.

This attribute represents the power level for the QAM channels in the containment level.

This attribute represents the first carrier of the configured carriers within the RF port.

This attribute represents the Modulation type for the QAM channels in the containment level.

This attribute represents the Interleave mode for the QAM channels in the containment level.

This attribute represents the interleaver level for FEC coding for the QAM channels in the containment level. Enumeration: 'level1': 1, 'level': 2.

This attribute represents the ITU J.83 Annex mode for the QAM channels in the containment level. Enumeration: 'unknown': 1, 'annexB': 4, 'other': 2, 'annexC': 5, 'annexA': 3.

This attribute represents the QAM Signal Spectrum inversion. A value 'true' indicates channel spectrum is inverted.

This attribute represents the PHY parameters Lock state of the QAM channels n the RF Port containment level for DEPI initiated PHY parameters updates. This parameter is only required for M-CMTS QAMs. Bits: 'j83Annex': 5, 'power': 2, 'mute': 7, 'modulation': 3, 'interleaver': 4, 'bandwidth': 1, 'frequency': 0, 'symbolRate': 6.

This attribute represents the number of QAM channels to configure in the channel block. By default all the channels in the RF port are condigured.

This attribute indicates the total number of QAM channels within the RF.

The status of this instance.

This object represents the list of Fiber Nodes the RF port reaches.

The Conceptual row of docsEqamFiberNodeTable

This attribute represents the Fiber Node Name associated with the RF Port

The status of this instance.

This object represents the configuration of QAM channels.

The Conceptual row of docsEqamChannelTable

This key represents the QAM channel identifier. It corresponds to RFC4133, ENTITY-MIB entPhysicalName.

This attribute represents the RF port identifier of the QAM channel. It corresponds to RFC4133, ENTITY-MIB entPhysicalName.

This attribute represents the administrative state of the QAM channel. Setting this element to 'disable' results in the RF port being muted. By default this element reports 'disabled'. Enumeration: 'disabled': 2, 'enabled': 1.

This attribute represents the power level for the QAM channel

This attribute represents the carrier frequency of the QAM channel.

This attribute represents the Modulation type for the QAM channel.

This attribute represents the Interleave mode of the QAM channel.

This attribute represents the interleaver level for FEC coding of the QAM channel. Enumeration: 'level1': 1, 'level': 2.

This attribute represents the ITU J.83 Annex mode of the QAM channel. Enumeration: 'unknown': 1, 'annexB': 4, 'other': 2, 'annexC': 5, 'annexA': 3.

This attribute represents the QAM Signal Spectrum inversion. A value 'true' indicates channel spectrum is inverted.

This attribute represents the name of the QAM channel. This parameter is used in the ERRP QAM Name attribute.

This attribute represents the address field in the WithdrawnRoute and ReachableRoutes ERRP attributes.

This attribute represents the ERM where the QAM channel is advertised. If empty, the QAM channel is not advertized.

This attribute represents the PHY parameters Lock state of the QAM channels for DEPI initiated PHY parameters updates. This parameter is only required for M-CMTS QAMs. Bits: 'j83Annex': 5, 'power': 2, 'mute': 7, 'modulation': 3, 'interleaver': 4, 'bandwidth': 1, 'frequency': 0, 'symbolRate': 6.

This attribute indicates the mechanisms authorized to reserve and control the QAM channels. The possible values are: 'docsisOnly': the QAM channel can be allocated statically or dynamically to DOCSIS. 'videoOnly' the QAM channel can be allocated statically or dynamically to video. 'any' indicates the he QAM channel can be allocated statically or dynamically to video and/or DOCSIS. Enumeration: 'docsisOnly': 1, 'videoOnly': 2, 'any': 3.

CM This attribute represents the ERRP advertisement state of the QAM channe. If set to 'true' the QAM channel is advertised, otherwise is not advertised. This is primarily useful when configuring QAM channels statically and not desire to make the channel part of the ERM channel list.

This attribute represents the static UDP port assignment for a DEPI UDP tunnel. The value zero indicates there is not static mapping or not applicable.

The status of this instance.

This object represent transport stream configuration parameters for QAM channels.

The Conceptual row of docsEqamTSOutputTable

This attribute represents the TSID of the output transport stream. See SCTE-154-4 mpegOutputTSTSID.

This attribute represents the NIT PID of the outgoing transport stream. See SCTE-154-4 mpegOutputTSNitPid.

This attribute represents the CA PID of the outgoing transport stream. See SCTE-154-4 mpegOutputTSCaPid.

The status of this instance.

This object represent the UDP port ranges used for static video sessions.

The Conceptual row of docsEqamStaticUdpMapTable

This attribute represents the UDP port range start value for static session.

This attribute represents the number of reserved UDP ports starting from 'StartingPort' attribute value.

The status of this instance.

This attribute represents the maximum number of mpeg session entries that the 'SessionLog' can report. Upon a set operation, the lower value between the set value and the supported number of log entries is used.

This attribute represents the current number of mpeg session entries in the 'SessionLog'.

This attribute represents the Aging threshold for the 'SessionLog'. Periodically, a process scans through 'SessionLog' and removes those sessions that have a 'SessionLog::StopTime' greater than this threshold in minutes. A value of 0 means no aging out log entries.

This attribute provides a control to clear the 'Session log'. If set to 'true', all entries from the 'SessionLog' object are removed. Reading this attribute always returns 'false'.

This attribute indicates which type of videos sessions are reported in the 'SessionLog' object. The value 'allSessions' indicates all video sessions are reported in the 'SessionLog' The value 'sessionsWithExceptions' indicates that video sessions are reported when either of the conditions below occur: - The Continuity Errors or Synch Loss Packets of the associated session is greater than zero. - The Dropped packets, FIFO Overflow or FIFO Underflow is greater than zero. Enumeration: 'allSessions': 1, 'sessionsWithExceptions': 2.

This object represent the list of terminated MPEG video sessions. All parameters values reported for a session are determined at the time of the session deletion.

The Conceptual row of docsEqamSessionLogTable

This key represents the unique identifier of an instance in this object. This attribute's behavior consist of an incremental value. If the maximum number of instances is reached the log instance with the lower key value is deleted and the new instance is added.

This attribute identifies the MPEG Session Id of this entry.

This attribute identifies the interface index of the mpeg source stream.

This attribute identifies the interface index of the mpeg output stream.

This attribute indicates the total number of continuity counter errors for the session. See SCTE154-4 mpegInputStatsContinuityErrors for details of the count definition.

This attribute indicates the total number of MPEG packets that had missing sync byte for the session. See SCTE 154-4 mpgInputStatsSyncLossPackets for details of the count definition.

This atribute indicates the total number of MPEG output packets for the session.

This attribute indicates the total number of MPEG output packets dropped for the session.

This attribute indicates the total number of FIFO overflows of the session.

This attribute indicates the total number of FIFO underflows of the session.

This attribute indicates the type of session. See SCTE 154-4 docsQamVideoSessionMode for definitions of the type of sessions. Enumeration: 'multiplexing': 3, 'passThrough': 2, 'other': 1.

This attribute indicates the date and time when the session was setup.

This attribute indicates the date and time when the session was deleted.

This attribute indicates the address type associated with the input transport stream of the session. The value 'unknown' indicates no IP transport associated to the transport stream. The value 'dns' is not used.

This attribute indicates the source address of the IP flow contained in the session. For Multicast it represents the Source Specific Multicast IP Address of the UDP IP flow. For unicast UDP IP flows is either the value 0.0.0.0 if the IP source address is unknown or irrelevant for the origination transport stream.

This attribute indicates the source port of the UDP IP flow of the input transport stream.

This attribute indicates the destination address of the IP flow contained in the session. For multicast it represents the group address of the SSM origination input TS. For unicast UDP IP flows is either the value 0.0.0.0 if the IP destination address is unknown or irrelevant for the origination input stream.

This attribute indicates the UDP destination port of the UDP IP flow of the input transport stream.

The compliance statement for the full implementation of the MIB Module.

The compliance statement for the read-only implementation of the MIB Module.

Group of objects for the full implementation of the MIB module.

Group of objects for the read-only implementation of the MIB module.