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

This MIB module contains the management objects for the management of Multicast over DOCSIS to support Multicast DSID forwarding and or bonded multicast. Copyright 1999-2014 Cable Television Laboratories, Inc. All rights reserved.

This object controls the QoS, PHS and encryption settings for downstream forwarding of IP multicast sessions. An IP multicast session is replicated to one or more Downstream Channel Sets (DCSs), where each DCS is either a single downstream channel or a downstream bonding group of multiple channels. The CMTS determines on which DCSs to replicate a multicast session based on IP multicast membership reports ('joins') or other vendor-specific static configuration. The CmtsGrpCfg object allows for the configuration of a range of sessions through the SrcPrefixAddr and GrpPrefixAddr and SrcPrefixLen and GrpPrefixLen attributes. The CmtsGrpCfg object allows for the configuration of QoS, Encryption and PHS for multicast sessions. Cable operators can specify configuration rules for a range of multicast sessions through the tuple of (SrcPrefixAddr,SrcPrefixLen, GrpPrefixAddr, GrpPrefixLen) attributes in an entry. The QosConfigId attribute identifies the QoS rule, the EncryptionConfigId identifies the encryption rule and the PhsConfigId identifies the PHS rule for a particular entry. Even if an entry indicates a range of multicast sessions the Encryption and PHS rules are applied on a per-session basis. That is, a separate DSID is assigned to an individual multicast session from a range of multicast sessions identified by an entry in the CmtsGrpCfg object and a PHS rule (indicated by the PhsCfgId) is applied individually to each session which is identified by the DSID assigned for that session. Similarly, a separate SAID is assigned to individual multicast session from range identified by the CmtsGrpCfg object. The CmtsGrpQosConfigQosCtrl attribute from the CmtsGrpQosCfg object is used to determine if the traffic for a range of multicast sessions identified by an entry in the CmtsGrpCfg object will be transmitted in an 'Aggregate-Session' Group Service Flow or will be transmitted separately for each session using 'Single-Session' Group Service Flows. Even if the range of multicast sessions are transmitted on an 'Aggregate-Session' Group Service Flow, the PHS and Encryption rules are always applied individually to a multicast session on a per-session DSID basis prior to being transmitted on an 'Aggregate-Session' Group Service Flow (GSF). This object supports the creation and deletion of multiple instances. Creation of a new instance of this object requires the following attributes to be set RulePriority PrefixAddrType SrcPrefixAddr SrcPrefixLen GrpPrefixAddr GrpPrefixLen IpDsLow IpDsHigh IpDsMask

The conceptual row of docsMcastCmtsGrpCfg. The CMTS persists all instances of the CmtsGrpConfig object across system reinitializations.

This attribute represents the unique identifier of instances of this object. This attribute is the key that identifies unique instances of the CmtsGrpConfig object.

This attribute indicates the priority of this entry used to resolve which instance of this object apply when a newly replicated multicast session matches multiple entries. Higher values indicate a higher priority. Valid values for this attribute are 0..63 and 192..255 in order to not conflict with CMTS internally-created instances that use the range 64..191.

This attribute identifies the address family for the multicast session (S,G) of the GC which corresponds to the SrcPrefixAddr and GrpPrefixAddr attributes respectively.

This attribute defines the IP source address prefix of the IP multicast session. Source prefix addresses are unicast host addresses.

This attribute identifies the prefix of a range of Source (S) IP multicast group addresses. For Group or ASM based sessions this attribute is set to 0.

This attribute identifies the prefix of a range of destination IP multicast group addresses.

This attribute identifies the prefix of a range of IP multicast group addresses.

This attribute identifies the low value of a range of the TOS byte value to be defined in a packet classifier this GC instantiates in the GCR in order to limit the GCR-matched traffic to a particular set of DSCPs. This applies to the IPv4 TOS byte and the IPv6 Traffic Class byte. The IP TOS octet, as originally defined in RFC 791, has been superseded by the 6-bit Differentiated Services Field and the 2-bit Explicit Congestion Notification Field.

This attribute identifies the high value of a range of the TOS byte value to be defined in a packet classifier this GC instantiates in the GCR in order to limit the GCR-matched traffic to a particular set of DSCPs. This applies to the IPv4 TOS byte and the IPv6 Traffic Class byte. The IP TOS octet, as originally defined in RFC 791, has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168).

This attribute identifies the mask value bitwise ANDed with a TOS byte value to be defined in a packet classifier this GC instantiates in the GCR in order to limit the GCR-matched traffic to a particular set of DSCPs. This applies to the IPv4 TOS byte and the IPv6 Traffic Class byte. The IP TOS octet, as originally defined in RFC 791, has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168).

This attribute identifies an instance in CmtsGrpQosCfg for configuring the QoS for the replication of the sessions matching this CmtsGrpCfg instance. The value 0 indicates that all replications referenced by this CmtsGrpCfg instance will be forwarded to the default GSF.

This attribute identifies an instance in CmtsGrpEncryptionCfg for configuring the encryption of replicationsderived from this GC. The value 0 indicates no encryption for all replications derived from this GC.

This attribute identifies an instance in CmtsGrpPhsCfg that configures DSID-indexed PHS compression for all replications derived from this GC. The value 0 indicates no PHS compression for all replications derived from this GC.

The status of this instance.

This object controls the configuration of the Security Association (SA) and the encryption algorithm used for multicast sessions. This object supports the creation and deletion of instances.

The conceptual row of docsMcastCmtsGrpEncryptCfg. The CMTS persists all instances of the CmtsGrpEncryptionConfig object across system reinitializations.

This attribute specifies the unique identifier of instances of this object

This attribute controls whether the CMTS can select the encryption algorithm or if this can be set manually using the Alg attribute. If this attribute is set to 'cmts', the CMTS can select the encryption algorithm for the Security Association (SA). If this attribute is set to 'mgmt', the Alg attribute is used to define the encryption algorithm for this SA. Enumeration: 'mgmt': 2, 'cmts': 1.

This attribute defines which encryption algorithm will be used for an SA referenced by this object when the Ctrl is set to 'mgmt'.

The status of this instance.

This object controls the configuration of DSID-indexed PHS for multicast sessions. Configuration of PHS Rules via this table must not be based on the configuration of a range of sessions, but must be configured on a single multicast session. Creation of multiple instances of this object require the following attributes to be set: PhsField PhsMask PhsSize

The conceptual row of docsMcastCmtsGrpPhsCfg. The CMTS persists all instances of the CmtsGrpPhsConfig object across system reinitializations.

This attribute identifies the unique identifier of a PHS rule that is referenced by the GrpConfig object.

This attribute defines the bytes of the DOCSIS header which must be suppressed/restored by the sending/receiving device.

This attribute defines the bit mask which is used in combination with the PhsField to define which bytes in header must be suppressed/restored by the sending or receiving device. Each bit of this bit mask corresponds to a byte in the PhsField, with the least significant bit corresponding to the first byte of the PhsField. Each bit of the bit mask specifies whether or not the corresponding byte should be suppressed in the packet. A bit value of '1' indicates that the byte should be suppressed by the sending device and restored by the receiving device. A bit value of '0' indicates that the byte should not be suppressed by the sending device or restored by the receiving device. If the bit mask does not contain a bit for each byte in the PhsField then the bit mask is extended with bit values of '1' to be the necessary length.

This attribute specifies the number of bytes in the header to be suppressed and restored. The value of this object matches the number of bytes the bits indicated in the PhsField attribute.

This attribute specifies the Payload Header Suppression verification value of 'true' the sender must verify PhsField is the same as what is contained in the packet to be suppressed.

The status of this instance.

This object configures the QoS configured for Multicast sessions replicated to any Downstream Channel Set. It does not control which particular DCSs to which the CMTS replicates a multicast session. An instance in this object is called a GQC entry. A GQC entry controls how the CMTS instantiates a Group Classifier Rule (GCR) on the DCS to match packets of the multicast session. A Group Classifier Rule (GCR) uses source and destination IP address and ToS criteria. A GQC entry controls how and with what QoS parameters a Group Service Flow (GSF) is created on a DCS. All downstream multicast packets are scheduled on a GSF. The QoS Type attribute of the GQC entry controls whether the CMTS creates one GSF for each single IP multicast session or whether the CMTS creates one GSF for the aggregate of all sessions that match the GQC criteria. The GQC instance contains a reference to a Service Class from docsIetfQosServiceClassTable. The Service Class defines the list of QoS parameters for the GSF(s) instantiated for the GQC entry. A CMTS identifies one Service Class as the Default Group QoS Service Class. The CMTS instantiates a Default Group Service Flow on each single-channel DCS based on the parameters of the Default Group QoS Service Class. The set of GCRs and GSFs instantiated on a DCS control how QoS is provided to multicast packets replicated to the DCS. For each multicast packet, the CMTS classifies the packet to the highest priority matching GCR on that DCS. The GCR refers to a single GSF, which controls the scheduling of the packets on the DCS. If the multicast packet does not match any GCR on the DCS, the packet is scheduled on the Default Group Service Flow of the DCS. The CMTS replicates unclassified multicast traffic to only DCSs consisting of a single downstream channel. Thus, the Maximum Sustained Traffic Rate QoS parameter of the Default Group Service Class limits the aggregate rate of unclassified multicast traffic on each downstream channel. The CMTS is expected to instantiate GCRs and GSFs controlled by the entries in this table only for the duration of replication of the multicast sessions matching the entry. This object supports the creation of multiple instances. Creation of new instances of this object require the following objects to be set: ServiceClassName QosCtrl AggSessLimit

The conceptual row of docsMcastCmtsGrpQosCfg. The CMTS persists all instances of the CmtsGrpQosConfig object across system reinitialization.

This attribute identifies a unique Group QoS Configuration object instance.

This attribute identifies the Service Class Name reference for the set of QoS parameters for this GQC.

This attribute identifies how Group Classifier Rules (GCRs) and Group Service Flows (GSFs) are instantiated when multiple sessions match the (S,G) criteria of this entry. If 'singleSession', the CMTS creates a unique GCR and a unique GSF for the session. If this object's value is 'aggregateSession', all sessions matching this criterion are aggregated into the same GSF. Enumeration: 'singleSsession': 1, 'aggregateSession': 2.

This attribute identifies the maximum number of sessions that may be aggregated in an aggregated Service Flow. This value is ignored in case of a GQC entry with QosCtrl set to 'singleSession'.

This attribute allows the operator to configure a Cable Operator defined Application Identifier for multicast sessions, e.g., an Application Manager ID and Application Type. This Application Identifier can be used to influence admission control or other policies in the CMTS that are outside of the scope of this specification. This parameter is optional in defining QoS for multicast sessions. If the value of this attribute is different from the value of the AppId in the referenced SCN for this GQC instance, the value of this attribute is used.

The status of this instance.

This object describes the replication of IP Multicast sessions onto the different Downstream Channel Sets of a CMTS. Each DCS may be either a single downstream channel or a bonding group of multiple downstream channels. Each IP Multicast session is identified by a combination of IP source and IP Destination group address '(S,G). The CMTS replicates each IP packet in an (S,G) session onto one or more Downstream Channel Sets (DCSs), each of which is implemented in a MAC Domain. The CMTS assigns each replication a Downstream Service ID (DSID) that is unique per MAC Domain.

The conceptual row of docsMcastCmtsReplSess.

This attribute defines the address type for the GrpPrefix and SrcPrefix addresses.

This attribute defines the group G of a particular (S,G) IP multicast session.

This attribute identifies a specific Multicast Source Address. A Source Address that is all zeros is defined as 'all source addresses (*, G)'.

This attribute defines the MAC Domain Interface index of the channel to which the (S,G) session is replicated.

This attribute provides the reference for the Downstream Channel Set within a MAC Domain that the multicast session (S,G) is replicated to.

This attribute indicates the service flow into which packets are classified for this replication of the multicast session (S,G).

This attribute defines the Downstream Service ID (DSID) label with which the CMTS labels all packets of the (S,G) session on the DCS of a MAC Domain. The DSID value is unique per MAC domain.

This attribute defines the Security Association ID (SAID) of this multicast replication session. The value 0 indicates no SAID associated with this session.

This attribute references an instance of the SNMP table docsIetfQosServiceClassName object. This attribute is used to expand the QoS parameter Set of QoS for multicast sessions that uses a default QoS policy. The CMTS persists all instances of this attribute across reinitializations.

This object reports the set of DSID-Indexed PHS rules that are signaled between the CMTS and CMs as part of the Multicast Sessions setup. The attributes PhsMask, PhsSize and PhsVerify comes from the configuration object CmtsGrpPhsCfg. The value of the PhsField attribute is derived by the CMTS from the CmtsGrpCfg object parameters, and possibly other IP header informaton of the multicast session that the CMTS is capable of knowning prior to the multicast session setup. In cases where the PhsSize is longer than the CMTS knowledge of IP/TCP header fields, the CMTS extends the PhsMask with bits set to 0 until reaching the equivalent PhsSize value.

The conceptual row of docsMcastDsidPhs. The ifIndex key corresponds to the MAC Domain interface where the PHSI-Indexed DSID is configured.

This attribute represents the 20-bit DSID associated with this PHS rule.

This attribute defines the bytes of the header which must be suppressed/restored by the sending/receiving device.

This attribute defines the Payload Header Suppression mask in the header to be suppressed and restored.

This attribute defines the number of bytes in the header to be suppressed and restored.

This attribute, when set to 'true', indicates that the sender must verify that the PHS Field attribute value is the same is the same as what is contained in the packet to be suppressed.

The table contains statistics for the IP multicast session identified by the combination of IP source and IP destination group address (S,G).

The conceptual row of docsMcastStatsTable. The ifIndex key corresponds to the Ethernet interface where the IP Multicast session is configured.

This attribute indicates the address family of the address contained in docsMcastStatsGrpAddr.

This attribute defines 'G' as the group address for a particular (S,G) IP multicast session.

This attribute defines the group address prefix length of a particular (S,G) IP multicast session.

This attribute indicates the address family of the address contained in docsMcastStatsSrcAddr.

This attribute defines 'S' as the source address for a particular (S,G) IP multicast session. For the case of Any Source Multicast (ASM), this attribute uses a value of 0.0.0.0 for IPv4 or 0::/0 for IPv6.

This attribute defines the source address prefix length of a particular (S,G) IP multicast session.

This attribute returns a count of the packets dropped by the CMTS Forwarder process for a particular IP multicast session prior to replication to the outbound interface(s) (e.g., MAC domain interfaces). These packet drops can occur whenever there are no replications for this IP multicast session, or where an IP multicast packet for the specific S,G is not forwarded to the outbound interface(s).

This attribute returns a count of the octets for packets dropped by the CMTS Forwarder process for a particular IP multicast session prior to replication to the outbound interface(s).

The table contains CPE information for the IP multicast session identified by the combination of IP source and IP destination group address (S,G), MAC Domain interface and CM MAC address.

The conceptual row of docsMcastCpeListTable. The ifIndex key corresponds to the MAC Domain interface where the IP Multicast session is configured.

This attribute indicates the address family of the address contained in docsMcastCpeListGrpAddr.

This attribute defines 'G' as the group address for a particular (S,G) IP multicast session.

This attribute defines the group address prefix length of a particular (S,G) IP multicast session.

This attribute indicates the address family of the address contained in docsMcastCpeListSrcAddr.

This attribute defines 'S' as the source address for a particular (S,G) IP multicast session. For the case of Any Source Multicast (ASM), this attribute uses a value of 0.0.0.0 for IPv4 or 0::/0 for IPv6.

This attribute defines the source address prefix length of a particular (S,G) IP multicast session.

This attribute defines the CM MAC address of a particular (S,G) IP multicast session.

This attribute defines the Downstream Service ID (DSID) label with which the CMTS labels all packets of a particular (S,G) IP multicast session.

This attribute returns the CPE MAC address for the (S,G) IP multicast session.

This attribute indicates the address family of the address contained in docsMcastCpeListCpeIpAddr.

This attribute returns the CPE IP address for the (S,G) IP multicast session.

The table contains the admitted aggregate bandwidth of IP Multicast sessions onto the different Downstream Channel Sets or MAC Domain Interfaces of a CMTS.

The conceptual row of docsMcastBandwidthTable. The ifIndex key corresponds to the MAC Domain interface or DCS associated with the bandwidth data. Note that for some vendors this CMTS cable interface will be a cable-mac interface. For others, it will be a DOCSIS Downstream Channel Set. In either case, this CMTS cable interface exists as a row entry in the ifTable (and therefore has an ifIndex which can be used as an index for this table).

This attribute represents the Admitted Multicast Aggregate Bandwidth which is defined as the sum of the Minimum Reserved Traffic Rates of each Group Service Flow that has been admitted on a given CMTS cable interface.

This attribute represents the low watermark threshold for Admitted Multicast Aggregate Bandwidth events.

This attribute represents the high watermark threshold for Admitted Multicast Aggregate Bandwidth events.

The compliance statement for devices that implement the DOCSIS Multicast MIB.

Group of objects implemented in the CMTS.