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

This MIB module contains the management objects for the DOCSIS 3.0 CMTS Load Balanding operation. Copyright 1999-2006 Cable Television Laboratories, Inc. All rights reserved.

This attribute when set to 'true' enables Autonomous Load Balancing operation on the CMTS, otherwise Autonomous Load Balancing is disabled. A failure to enable Autonomous Load Balancing operation is registered in the EnableError attribute. When Autonomous Load Balancing is enabled, the CMTS may reject Externally-Directed Load Balancing operations. However, even when Autonomous Load Balancing is disabled, the CMTS is required to assign load balancing parameters to CMs as provisioned in the configuration file and/or RestrictCM object. This attribute value persists after system reinitialization. There might be cases where this attribute reports a failure and Load Balancing is enabled, for example after system reinitialization where Load Balancing was previously set to enabled but there are issues with the CMTS configuration.

This attribute represents a text message that describes a failure to enable load balancing due configuration errors, or other considerations. The zero-length string indicates no errors occurred during the last Autonomous Load Balancing activation.

This attribute represents the MAC address of the cable modem that the CMTS instructs to move to a new downstream and/or upstream channel set.

This attribute represents the initialization technique that the cable modem is instructed to use when performing multiple-channel change-over operation. The value of this attribute applies to all upstream channels in the channel set.

This attribute when set to 'true' indicates that the CMTS forces UCC messages instead of DCC messages. In some cases the CMTS may still use UCC commands even though this attribute value is 'false', for example in an upstream-only change-over operation directed to a CM that the CMTS is aware is only capable of UCC, but the operator is not aware of the CM capabilities. This attribute value is ignored when the target CM for the change-over operation is in MRC mode, or the UsChSet attribute is the zero-length string, or the operation includes changes for downstream channels.

This attribute represents a single-downstream frequency to which the cable modem is instructed to move using a DCC request. The value zero indicates that this attribute is ignored during a commit operation.

This attribute describes the MAC Domain Interface index of the triplet: Mac Domain, RCP-ID and RCC Status Index of the RccStatus object that represents the RCC used in the change-over operation. This MAC Domain Interface Index is also used to provide context for the UsChSet and ServiceFlowInfo attributes.

This attribute describes the RCP-ID of the triplet: Mac Domain, RCP-ID and RCC Status Index of the RccStatus object that represents the RCC used in the change-over operation.

This attribute describes the RCC Status Index of the triplet: Mac Domain, RCP-ID and RCC Status Index of the RccStatus object that represents the RCC used in the change-over operation.

This attribute describes the Channel list (within the context of the MAC domain identified by MdIfIndex) that represents the final TCS expected from the change-over operation. When the operation is intended for an RCC-only, this attribute is set to zero and the attribute InitTech is ignored.

This attribute provides a list of Service Flow ID-Channel Set ID pairs used to control Service Flow assignment in the change-over operation. This is intended as an override to the normal assignment based on SF attributes. This attribute is encoded as a series of 32-bit pairs as follows: - The first four bytes correspond to the value of the Service Flow ID (attribute Id of the ServiceFlow object of the DOCSIS QOS objects. - The last four bytes correspond to the value of the attribute ChSetId of the UsChSet or DsChSet object of the CMTS Bonding Objects. If this attribute does not include tuples for some of the CM's Service Flows, the CMTS determines the respective channels based on SF attributes. Service Flow ID-Channel Set ID pairs matching upstream service flows are ignored if the change-over operation does not affect the TCC of the CM. Similarly, Service Flow ID-Channel Set ID pairs matching downstream service flows are ignored if the change-over operation does not affect the RCC of the CM.

This attribute represents an operator identifier for the change-over operation to be used to correlate logged information in the ChangeOver3 Status object. The CMTS uses this value as the Transaction ID in the DBC-REQ or DCC-REQ message transmitted in association with this operation. If this value is set to zero the CMTS defines its own MAC message Transaction ID value.

This attribute when set to 'true' triggers the change-over operation for Externally-Directed Load Balancing. Setting this attribute to 'true' is known as a commit operation. A commit operation is considered successful if the CMTS considers that the entered information is valid and the transaction can be initiated. It does not imply that the channel-change operation itself (i.e. UCC, DCC, DBC transaction) reports success or completion. A commit operation is considered unsuccessful if the CMTS determines that there are invalid attributes values in the ChangeOver object such that the change-over operation cannot be initiated. After system initialization all ChangeOver object parameters are set to default values. After a successful commit operation all ChangeOver object parameters are set to default values with the exception of this attribute (commit) that is set to 'true'. An unsuccessful commit operation is rejected and this attribute reports false in subsequent value queries. With regard to error checking on a commit operation, the following aspects are defined: - The CMTS rejects the commit operation when the MAC address in MacAddr attribute is not from an existing and operational cable modem in the CMTS. - The CMTS rejects the commit operation when there is already a change-over operation in progress for the CM, i.e. the corresponding attribute value in the -ChangeOverStatus object is one of 'messageSent', 'modemDeparting' or 'waitToSendMessage'. - The CMTS rejects the commit operation when neither of the upstream or downstream attribute parameters of the change-over operation are set. When the CM is in MRC disabled mode, only UCC/DCC commands are valid, therefore: - The CMTS ignores the values of RcpId, RccId, and ServiceFlowInfo in the commit operation. - The CMTS rejects the commit operation if neither of DownFrequency or UsChSet were set to non-default values. - The CMTS rejects the commit operation when the UsChSet indicates more than one upstream channel. - A single-upstream-channel change-over operation (no downstream information) is rejected if the upstream channel information corresponds to a non-existent channel or a channel with operational status down. - The CMTS rejects the commit operation for a downstream frequency that the CMTS can determine to be invalid. For example, the downstream frequency corresponds to a channel that is part of the MD-DS-SG in which the target CM is currently registered, and this Downstream Channel is known to be operationally down, in a test mode, mute state, etc. - To move a MRC/MTC-capable CM to a MRC/MTC enabled MAC Domain, the operator needs to reinitialize the CM via a DCC operation by including the appropriate DownFrequency and an InitTech allowing only the 'reinitialize MAC' initialization technique. When the CM is in MRC enabled mode, DCC and DBC commands are valid, therefore: - The CMTS rejects the commit operation if both the Downstream Frequency (via the DownFrequency attribute) and the RCC (via the RcpId and RccId) are set to non-default values. - The CMTS rejects the commit operation if the MdIfIndex attribute value is invalid, or if the triplet MdIfIndex, RcpId, RccId does not resolve in a valid RCC, or at least one of the indicated downstream channels is know to be operationally down, in a test mode, mute state, etc. - The CMTS rejects the commit operation if it can detect the UsChSet includes one or more channels that are not part of the US-SG of the CM, or any of those channels are in operational status down. - The CMTS rejects the commit operation if a service flow entry in the ServiceFlowInfo attribute includes channels that are not part of the CMs target RCS or TCS. After processing the commit operation the CMTS creates or overwrites (if it already exists) an instance of the ChgOverStatus object for the associated CM. After a successful commit operation, the CMTS initiates the change-over transaction using the most appropriate technique. The potential techniques are: - UCC - For upstream-channel-only changes on CMs not operating in MRC mode. - DCC - For upstream and/or downstream channel changes on CMs not operating in MRC mode. - DCC followed by channel assignment in REG-RSP-MP - For MAC Domain re-assignment on CMs operating in MRC mode. In this case, the change-over command might only include a downstream frequency, or might include an RCC defined in the target MAC domain. The upstream channel set may or may not be provided. The only applicable Initialization Technique for this operation is 'reinitializeMAC'. - DBC - For upstream and/or downstream channel set changes on CMs operating in MRC mode.

The value of sysUpTime when the attribute Commit was last set to true. Zero if never set.

This object reports the status of cable modems instructed to move to a new downstream and/or upstream channel or channel sets when commanded either by an operation in the ChgOver object. An instance in this object is created for each change-over operation committed successfully. If the instance value attribute is not final (the change-over operation is still pending completion), this instance is expected to be updated at some point later to reflect the final state of the change-over operation.

The conceptual row of docsLoadbal3ChgOverStatus.

This key represents a monotonically increasing value for the record that stores the status of the change-over operation. When the ChOverStatus object exceeds the size limit of this object the lowest Id value instances are removed so that the total number of entries no longer exceeds the size limit allowing the CMTS to maintain the most current entries.

This attribute represents the Mac address set in the ChgOver object commit operation.

The initialization technique set in change-over operation.

This attribute represents the new downstream frequency to which the cable modem is instructed to move. The value 0 indicates that the CMTS does not create a TLV for the downstream frequency in the DCC-REQ message. This object has no meaning when executing UCC operations.

This attribute represents the MAC Domain Interface index set in the ChgOver3 object commit operation, or zero.

This attribute represents the RCP-ID set in the MultipleChChgOver object commit operation, or all zeros RCP-ID.

This attribute represents the RCC Status Index set in the ChgOver3 object commit operation, or zero.

This attribute represents the Upstream Channel Set ID in the ChgOver3 object commit operation, or zero.

This attribute represents the list of Service Flow-Channel Set ID pairs set in the ChgOver object commit operation, or zero-length string.

The load balancing MAC Management Message exchange type used by the CMTS for the change-over operation in the ChgOver object commit operation. - 'ucc' indicates the usage of Upstream Channel Change (UCC) messages exchange. - 'dcc' indicates the usage of Dynamic Channel Change (DCC) messages exchange. - 'dbc' indicates the usage of Dynamic Bonding Change (DCC) messages exchange - 'crossMD' although this term does not correspond to a MAC Management Message type, it indicates the movement of a CM to a different MAC Domain that includes a sequence of different MAC Management Messages types (i.e. DCC to move the CM to the correct MAC Domain, followed by channel assignment in REG-RSP-MP). Enumeration: 'crossMD': 4, 'dbc': 3, 'ucc': 1, 'dcc': 2.

This attribute represents the transaction Id value used in the change-over operation.

This attribute represents the status of the specified change-over operation. The enumerations are: Change-over using DCC message exchange: 'modemDeparting' The cable modem has responded with a change-over response of either a DCC-RSP with a confirmation code of depart(180) or a UCC-RSP. 'timeOutT13' Failure due to no DCC-RSP with confirmation code depart(180) received prior to expiration of the T13 timer. 'timeOutT15' T15 timer timed out prior to the arrival of a bandwidth request, RNG-REQ message, or DCC-RSP message with confirmation code of arrive(181) from the cable modem. Change-over using DBC message exchange: 'dbcTimeout' The number of DBC-REQ retries was exceeded and no DBC-RSP was received Change-over CMTS verifications: 'messageSent' The CMTS has sent a DOCSIS MAC message request to instruct the CM to do the change-over operation. 'noOpNeed' A change-over operation was requested in which neither the DS and US channels where the CM is operational changed. 'waitToSendMessage' The specified operation is active and CMTS is waiting to send the channel change message with channel info to the cable modem. 'cmOperationRejected' Channel Change operation was rejected by the cable modem. 'cmtsOperationRejected' Channel Change operation was rejected by the Cable Modem Termination System. 'rejectInit' Operation rejected due to unsupported initialization tech requested. 'success' CMTS received an indication that the CM successfully completed the change-over operation. e.g., If an initialization technique of re-initialize the MAC is used, success in indicated by the receipt of a DCC-RSP message with a confirmation code of depart(180) or DBC confirmation code ok/success. In all other DCC cases, success is indicated by: (1) the CMTS received a DCC-RSP message with confirmation code of arrive(181) or (2) the CMTS internally confirms the presence of the CM on the new channel(s). Enumeration: 'messageSent': 1, 'cmtsOperationRejected': 6, 'success': 10, 'noOpNeeded': 2, 'cmOperationRejected': 5, 'dbcTimeout': 11, 'timeOutT15': 8, 'waitToSendMessage': 4, 'rejectinit': 9, 'modemDeparting': 3, 'timeOutT13': 7.

The value of sysUpTime when the attribute value of this instance was last updated.

This object represents the autonomous load balancing parameters provisioned for cable modem. The CMTS selects the cable modem Load Balancing Group (GrpId attribute of this object) from multiple sources by following the rules and sequence described below: The CMTS selects the assignment of the CM to a Load Balancing Group by determining first if the CM is in a Restricted Load Balancing Group or in its absence to the General Load Balancing group that corresponds to the MD-CM-SG of the CM. The selection of the Restricted Load Balancing group is achieved by first matching the CM in the RestrictCmCfg Object and if no match is found, by selecting the best match within the ResGrpCfg object. The best match within the ResGrpCfg follows the MULPI requirements on precedences of the CM signaled TLVs: ServiceType ID and Load Balancing Group ID (for backward compatibility of provisioned Group IDs).

The conceptual row of docsLoadbal3CmtsCmParams.

This attribute indicates the provisioned Load Balancing Group ID TLV the CM signaled to the CMTS during registration, or zero if not provisioned in the CM.

This attribute references the Load Balancing Group Identifier (Id attribute from the GrpStatus object) associated with the cable modem after the CMTS validates the CM Load Balancing Group ID TLV, Service Type ID TLV and Restricted CM list. The value zero indicates that the Load Balancing Group is invalid, or the General Load Balancing Group is invalid due ambiguous topology resolution.

This attribute indicates the provisioned Service Type ID TLV the CM signaled to the CMTS during registration, or the zero-length string if not provisioned in the CM.

This attribute represents the Service Type ID the CMTS picked from the Restricted Group of Restricted CM list, or the Service Type Id TLV the CM signaled to the CMTS during registration, or the zero-length string if none was used.

This attribute references the Load Balancing Policy ID associated to the cable modem either from the configuration file or from the General or Restricted Load Balancing Groups CMTS configuration.

This attribute references the Load Balancing Priority associated to the cable modem either from the configuration file or from the General or Restricted Load Balancing Groups CMTS configuration.

This attribute represents the default value for the Enable attribute of the GeneralLoadBalGrp object.

This attribute represents the default value for the PolicyId attribute of the GeneralLoadBalGrp object.

This attribute represents the default value for the InitTechnique attribute of the GeneralLoadBalGrp object.

This object provides the parameters for the General Load Balancing Groups of MD-CM-SGs associated with MAC Domain-Fiber Node pairs. This object allows configuration of load balancing parameters for General Load Balancing Groups by way of MAC Domain-Fiber Node pairs. In many deployments, a MAC Domain-Fiber Node pair will equate to an MD-CM-SG (which always equates to a GLBG). In the case where an MD-CM-SG spans multiple Fiber Nodes, there will be multiple instances of this object that represent the General Load Balancing Group (MD-CM-SG). The CMTS MUST enforce that such instances all have the same attribute values. Any time a fiber node is associated to a MAC Domain an instance of this object is defined by the CMTS and populated with default values from the GeneralGrpDefaults object. Similarly when a fiber node is no longer paired with a MAC Domain the corresponding instance is deleted from the object.

The conceptual row of docsLoadbal3GeneralGrpCfg. The CMTS MUST persist all instances of GeneralGrpCfg across reinitializations.

This key represents the fiber node name being associated with a MAC Domain.

This attribute when set to 'true' enables Autonomous Load Balancing for the General Load Balancing Group associated with this instance. When set to 'false' Autonomous Load Balancing is disabled.

This attribute defines the default load balancing policy for the General Load Balancing Group associated with this instance.

This attribute defines the load balancing initialization technique for the General Load Balancing Group associated with this instance.

The conceptual row status of this object.

This object represents the configuration of Restricted Load Balancing Groups.

The conceptual row of docsLoadbal3ResGrpCfg. The CMTS MUST persist all instances of ResGrpCfg across reinitializations.

This key represents a unique index assigned to the Restricted Load Balancing Group by the user for provisioning purposes. This value is unique within a CMTS and is matched with the CM signaled Load Balancing Group ID TLV value when determining the CM Load Balancing Group assignment based on such TLV value.

This attribute represents the MAC domain where the Restricted Load balancing Group applies. The value zero is allowed to indicate that vendor-specific mechanisms are used to define the Restricted Load Balancing Group. For example, to provide Load Balancing Groups across MAC domains.

This attribute contains the list of downstream channels of the Restricted Load Balancing Group.

This attribute contains the list of upstream channels of the Restricted Load Balancing Group.

This attribute when set to 'true' enables Autonomous Load Balancing on this Restricted Load Balancing Group. The value 'false' disables the load balancing operation on this group.

This attribute represents the initialization techniques that the CMTS can use to load balance cable modems in the Load Balancing Group.

This attribute represents the default load balancing policy of this Restricted Load Balancing Group. A policy is described by a set of conditions (rules) that govern the load balancing process for a cable modem. The CMTS assigns this Policy ID value to a cable modem associated with the group ID when the cable modem does not signal a Policy ID during registration. The Policy ID value is intended to be a numeric reference to an instance of the Policy object. However, It is not required to have an existing or active policy instance in which case it indicates no policy is associated with the Load Balancing Group. The Policy ID of value 0 is reserved to indicate no policy is associated with the load balancing group.

This attribute represent a space separated list of ServiceType IDs that will be compared against the cable modem provisioned Service Type ID to determine the most appropriate Restricted Load Balancing Group.

The conceptual row status of this object.

This object represents the status of all General and Restricted Load Balancing Groups in this CMTS. This object summarizes the load balancing parameters that applies to CMTS system wide Load Balancing Groups. The Load Balancing Groups defined in this object include the configured Restricted Load Balancing Groups and the General Load Balancing Groups derived from the GeneralGrpCfg object.

The conceptual row of docsLoadbal3GrpStatus.

This key represents an unique identifier of a Load Balancing Group in the CMTS.

This attribute references the Id attribute of the instance of the ResGrpCfg this instance corresponds to. The value zero indicates that the instance corresponds to a General Load Balancing Group.

This attribute represents the MAC domain where the Load Balancing Group applies. The value zero is allowed to indicate that vendor-specific mechanisms are used in load balancing operations. For example, to provide Load Balancing Groups across MAC domains.

This attribute corresponds to the MD-CM-SG-ID that includes all the upstream and downstream channels of the Load Balancing Group. The value zero indicates that this instance corresponds to a Restricted Load Balancing Group . If there are vendor-specific Load Balancing Groups configuration ( e.g. MdIfIndex set to zero), this attribute value might not be meaningful.

This attribute contains the list of downstream channels of the Load Balancing Group. If there are vendor-specific Load Balancing Groups configuration ( e.g. MdIfIndex set to zero), this attribute value might not be meaningful.

This attribute contains the list of the upstream channels of the Load Balancing Group. If there are vendor-specific Load Balancing Groups configuration ( e.g. MdIfIndex set to zero), this attribute value might not be meaningful.

This attribute when set to 'true' indicates that load balancing is enabled on this group, or disabled if set to 'false'.

This attribute indicates the initialization techniques that the CMTS can use when load balancing cable modems that are associated with the Load Balancing Group.

This attribute indicates the Policy that the CMTS can use when load balancing cable modems that are associated with the Load Balancing Group.

This attribute counts the number of successful Autonomous Load Balancing operations associated with this Load Balancing Group.

This attribute counts the number of failed Autonomous load balancing operations associated with this Load Balancing Group.

This object describes the list of cable modems being statically provisioned at the CMTS to a Restricted Load Balancing Group. When a CM registers it is either assigned to

The conceptual row of docsLoadbal3RestrictCmCfg. The CMTS MUST persist all instances of RestrictCmCfg across reinitializations.

This key represents the unique identifier of an instance in this object. the CMTS maintains an unique instance per MAC Address/MAC Address Mask combination

This attribute represents the Mac Address of the cable modem within the Restricted Load Balancing Group.

This attribute corresponds to a bit mask acting as a wild card to associate a cable modem MAC addresses to a Restricted Load Balancing Group ID referenced by a restricted group Id or a Service Type ID. The cable modem matching criteria is performed by bit-Anded the cable modem MAC address with the MacAddrMAsk attribute and being compared with the bit-ANDed of attributes MacdAddr and MacAddrMask. A cable modem MAC address look up is performed first with instances containing this attribute value not null, if several entries match, the largest consecutive bit match from MSB to LSB is used.

The attribute represents the Restricted Load Balancing Group identifier of this entry associated with the cable modem MAC address - MAC address mask combination. The value zero indicates that the instance is matched only against the ServiceTypeId value.

This attribute represents the Service Type Id associated with this cable modem MAC address - MAC Address mask combination.. The zero-length string indicates that the instance is matched only against the GrpId value, if both GrpId and this attribute are not present the instance is ignored for matching purposes.

Indicates the status of this conceptual object. There is no restriction on setting columns in this table any time.

This object describes the set of load balancing policies. Instances from this object might be referenced by GrpStatus object . All the rules contained in a load balancing policy apply to an Autonomous Load Balancing operations. Load balancing rules are defined within this specification or can be vendor-defined as well.

The conceptual row of docsLoadbal3Policy. The CMTS MUST persist all instances of Policy object across reinitializations.

This key represents the identifier of a load balancing policy.

This key represents a rule contained within a balancing policy.

This attribute represents a reference to an instance in a rule or other policy object like BasicRule object.

The conceptual row status of this object.

This object represents a basic ruleset applicable to a load balancing policy that references it.

The conceptual row of docsLoadbal3BasicRule. The CMTS MUST persist all instances of BasicRule object across reinitializations.

This key represents a unique identifier for balancing ruleset of this object.

This attribute when set to 'enabled' enables Autonomous Load Balancing (independently of the load balancing group enable/disable state), the rule set is disabled if set to 'disabled', or is disabled during a period of time it set to 'disabledPeriod'. Enumeration: 'disabled': 2, 'enabled': 1, 'disabledPeriod': 3.

This attribute disables load balancing from the time stated by this attribute when the attribute Enable is set to 'disablePeriod'. The time is defined in seconds since midnight.

This attribute disables load balancing until the time stated by this attribute when the attribute Enable is set to 'disablePeriod'. The time is defined in seconds of the wall clock since midnight.

The conceptual row status of this object.

The compliance statement for...

Group of objects implemented in