DOCS-LOADBALANCING-MIB Table View

The list contains the load balancing attributes
associated with the cable modem.

docsLoadBalCmtsCmStatusEntry row .1.3.6.1.4.1.4491.2.1.2.1.1.4.1

Additional objects for docsIfCmtsCmStatusTable entry
that relate to load balancing

Indexes

No indexes recorded

Column	Syntax	OID
docsLoadBalCmtsCmStatusGroupId The Group ID associated with this cable modem.	SNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.4491.2.1.2.1.1.4.1.1
docsLoadBalCmtsCmStatusPolicyId The Policy ID associated with this cable modem.	SNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.4491.2.1.2.1.1.4.1.2
docsLoadBalCmtsCmStatusPriority The Priority associated with this cable modem.	SNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.4491.2.1.2.1.1.4.1.3

A table of CMTS operation entries to reports the status
of cable modems instructed to move to a new downstream and/or
upstream channel. Using the docsLoadBalChgOverGroup objects.
An entry in this table is created or updated for the entry
with docsIfCmtsCmStatusIndex that correspond to the cable modem
MAC address of the Load Balancing operation.
docsLoadBalChgOverCommit to true(1).

docsLoadBalChgOverStatusEntry row .1.3.6.1.4.1.4491.2.1.2.1.2.2.1

A CMTS operation entry to instruct a cable modem to move to
a new downstream frequency and/or upstream channel.
An operator can use this to initiate an operation
in CMTS to instruct the selected cable modem to move to a…

Indexes

DOCS-IF-MIBdocsIfCmtsCmStatusIndex

Column	Syntax	OID
docsLoadBalChgOverStatusMacAddr The mac address set in docsLoadBalChgOverMacAddress.	SNMPv2-TCMacAddress Type Constraints: range: 6 Description: Represents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires M…	.1.3.6.1.4.1.4491.2.1.2.1.2.2.1.1
docsLoadBalChgOverStatusDownFreq The Downstream frequency set in docsLoadBalChgOverDownFrequency.	hertzInteger32 Constraints: range: 0-1000000000	.1.3.6.1.4.1.4491.2.1.2.1.2.2.1.2
docsLoadBalChgOverStatusUpChnId The upstream channel ID set in docsLoadBalChgOverUpChannelId.	Integer32 Constraints: range: -1-255	.1.3.6.1.4.1.4491.2.1.2.1.2.2.1.3
docsLoadBalChgOverStatusInitTech The initialization technique set in docsLoadBalChgOverInitTech.	ChannelChgInitTechMap Type Values: 0 reinitializeMac 1 broadcastInitRanging 2 unicastInitRanging 3 initRanging 4 direct	.1.3.6.1.4.1.4491.2.1.2.1.2.2.1.4
docsLoadBalChgOverStatusCmd The load balancing command set in docsLoadBalChgOverCmd.	Enumeration Enumerated Values: 1 any 2 dcc 3 ucc	.1.3.6.1.4.1.4491.2.1.2.1.2.2.1.5
docsLoadBalChgOverStatusValue The status of the specified DCC/UCC operation. The enumerations are: messageSent(1): The CMTS has sent change over request message to the cable modem. noOpNeed(2): A operation was requested in which neither…	Enumeration Enumerated Values: 1 messageSent 2 noOpNeeded 3 modemDeparting 4 waitToSendMessage 5 cmOperationRejected 6 cmtsOperationRejected 7 timeOutT13 8 timeOutT15 9 rejectinit 10 success	.1.3.6.1.4.1.4491.2.1.2.1.2.2.1.6
docsLoadBalChgOverStatusUpdate The value of sysUpTime when docsLoadBalChgOverStatusValue was last updated.	SNMPv2-TCTimeStamp Based On: SNMPv2-SMITimeTicks Description: The value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset t…	.1.3.6.1.4.1.4491.2.1.2.1.2.2.1.7

This table contains the attributes of the load balancing
groups present in this CMTS.

docsLoadBalGrpEntry row .1.3.6.1.4.1.4491.2.1.2.1.3.1.1

A set of attributes of load balancing group in the CMTS.
It is index by a docsLoadBalGrpId which is unique
within a CMTS.
Entries in this table persist after CMTS initialization.

Indexes

docsLoadBalGrpId

Column	Syntax	OID
docsLoadBalGrpId A unique index assigned to the load balancing group by the CMTS.	Unsigned32 Constraints: range: 1-4294967295	.1.3.6.1.4.1.4491.2.1.2.1.3.1.1.1
docsLoadBalGrpIsRestricted A value true(1)Indicates type of load balancing group. A Restricted Load Balancing Group is associated to a specific provisioned set of cable modems. Restricted Load Balancing Group is used to accommodate a topology spe…	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.4.1.4491.2.1.2.1.3.1.1.2
docsLoadBalGrpInitTech The initialization techniques that the CMTS can use when load balancing cable modems in the load balancing group. By default this object is initialized with all the defined bits having a value of '1'.	ChannelChgInitTechMapr/w Type Values: 0 reinitializeMac 1 broadcastInitRanging 2 unicastInitRanging 3 initRanging 4 direct	.1.3.6.1.4.1.4491.2.1.2.1.3.1.1.3
docsLoadBalGrpDefaultPolicy Each Load Balancing Group has a default Load Balancing Policy. 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 ca…	Unsigned32r/w Constraints: range: 0-4294967295	.1.3.6.1.4.1.4491.2.1.2.1.3.1.1.4
docsLoadBalGrpEnable Setting this object to true(1) enables internal autonomous load balancing on this group. Setting it to false(2) disables the load balancing operation on this group.	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.4.1.4491.2.1.2.1.3.1.1.5
docsLoadBalGrpChgOverSuccess The number of successful load balancing change over operations initiated within this load balancing group.	SNMPv2-SMICounter32 Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.4491.2.1.2.1.3.1.1.6
docsLoadBalGrpChgOverFails The number of failed load balancing change over operations initiated within this load balancing group.	SNMPv2-SMICounter32 Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.4491.2.1.2.1.3.1.1.7
docsLoadBalGrpStatus Indicates the status of the row in this table. Setting this object to 'destroy' or 'notInService' for a group ID entry already referenced by docsLoadBalChannelEntry, docsLoadBalChnPairsEntry or docsLoadBalRestrictCmEntr…	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.4491.2.1.2.1.3.1.1.8

Lists all upstream and downstream channels associated with
load balancing groups.

docsLoadBalChannelEntry row .1.3.6.1.4.1.4491.2.1.2.1.3.2.1

Lists a specific upstream or downstream, within a
load Balancing group.
An entry in this table exists for each ifEntry with an ifType
of docsCableDownstream(128) and docsCableUpstream(129)
associated with the Load Balan…

Indexes

docsLoadBalGrpId docsLoadBalChannelIfIndex

Column	Syntax	OID
docsLoadBalChannelIfIndex The ifIndex of either the downstream or upstream.	IF-MIBInterfaceIndex Type Constraints: range: 1..2147483647 Description: A unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must …	.1.3.6.1.4.1.4491.2.1.2.1.3.2.1.1
docsLoadBalChannelStatus Indicates the status of the rows in this table. Creating entries in this table requires an existing value for docsLoadBalGrpId in docsLoadBalGrpEntry and an existing value of docsLoadBalChannelIfIndex in ifEntry, otherw…	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.4491.2.1.2.1.3.2.1.2

This table contains pairs of upstream channels
within a Load Balancing Group. Entries in this
table are used to override the initialization techniques
defined for the associated Load Balancing Group.

docsLoadBalChnPairsEntry row .1.3.6.1.4.1.4491.2.1.2.1.3.3.1

An entry in this table describes a channel pair for which an
initialization technique override is needed.
On a CMTS which supports logical upstream channels
(ifType is equal to docsCableUpstreamChannel(205)),
the entrie…

Indexes

docsLoadBalGrpId docsLoadBalChnPairsIfIndexDepart docsLoadBalChnPairsIfIndexArrive

Column	Syntax	OID
docsLoadBalChnPairsIfIndexDepart This index indicates the ifIndex of the upstream channel from which a cable modem would depart in a load balancing channel change operation.	IF-MIBInterfaceIndex Type Constraints: range: 1..2147483647 Description: A unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must …	.1.3.6.1.4.1.4491.2.1.2.1.3.3.1.1
docsLoadBalChnPairsIfIndexArrive This index indicates the ifIndex of the upstream channel on which a cable modem would arrive in a load balancing channel change operation.	IF-MIBInterfaceIndex Type Constraints: range: 1..2147483647 Description: A unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must …	.1.3.6.1.4.1.4491.2.1.2.1.3.3.1.2
docsLoadBalChnPairsOperStatus Operational status of the channel pair. The value operational(1) indicates that ifOperStatus of both channels is up(1). The value notOperational(2) means that ifOperStatus of one or both is not up(1).	Enumeration Enumerated Values: 1 operational 2 notOperational	.1.3.6.1.4.1.4491.2.1.2.1.3.3.1.3
docsLoadBalChnPairsInitTech Specifies initialization technique for load balancing for the Depart/Arrive pair. By default this object's value is the initialization technique configured for the Load Balancing Group indicated by docsLoadBalGrpId.	ChannelChgInitTechMapr/w Type Values: 0 reinitializeMac 1 broadcastInitRanging 2 unicastInitRanging 3 initRanging 4 direct	.1.3.6.1.4.1.4491.2.1.2.1.3.3.1.4
docsLoadBalChnPairsRowStatus The object for conceptual rows creation. An attempt to create a row with values for docsLoadBalChnPairsIfIndexDepart or docsLoadBalChnPairsIfIndexArrive which are not a part of the Load Balancing Group (or for a 2.0 CMT…	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.4491.2.1.2.1.3.3.1.5

Lists all cable modems in each Restricted Load Balancing
Groups.

docsLoadBalRestrictCmEntry row .1.3.6.1.4.1.4491.2.1.2.1.3.4.1

An entry of modem within a restricted load balancing
group type.
An entry represents a cable modem that is associated with the
Restricted Load Balancing Group ID of a Restricted Load
Balancing Group.
Entries in this tab…

Indexes

docsLoadBalGrpId docsLoadBalRestrictCmIndex

Column	Syntax	OID
docsLoadBalRestrictCmIndex The index that uniquely identifies an entry which represents restricted cable modem(s) within each Restricted Load Balancing Group.	Unsigned32 Constraints: range: 1-4294967295	.1.3.6.1.4.1.4491.2.1.2.1.3.4.1.1
docsLoadBalRestrictCmMACAddr Mac Address of the cable modem within the restricted load balancing group.	SNMPv2-TCMacAddressr/w Type Constraints: range: 6 Description: Represents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires M…	.1.3.6.1.4.1.4491.2.1.2.1.3.4.1.2
docsLoadBalRestrictCmMacAddrMask A bit mask acting as a wild card to associate a set of modem MAC addresses to the same Group ID. Cable modem look up is performed first with entries containing this value not null, if several entries match, the largest …	OctetStringr/w Constraints: range: 0-0 range: 6-6	.1.3.6.1.4.1.4491.2.1.2.1.3.4.1.3
docsLoadBalRestrictCmStatus Indicates the status of the rows in this table. The attempt to create an entry associated to a group ID with docsLoadBalGrpIsRestricted equal to false(2) returns an error 'noCreation'. There is no restriction on setting…	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.4491.2.1.2.1.3.4.1.4

This table describes the set of Load Balancing policies.
Rows in this table might be referenced by rows in
docsLoadBalGrpEntry.

docsLoadBalPolicyEntry row .1.3.6.1.4.1.4491.2.1.2.1.4.1.1

Entries containing rules for policies.
When a load balancing policy is defined by multiple
rules, all the rules apply.
Load balancing rules can be created to allow for
specific vendor-defined load balancing actions.
How…

Indexes

docsLoadBalPolicyId docsLoadBalPolicyRuleId

Column	Syntax	OID
docsLoadBalPolicyId An index identifying the Load Balancing Policy.	Unsigned32 Constraints: range: 1-4294967295	.1.3.6.1.4.1.4491.2.1.2.1.4.1.1.1
docsLoadBalPolicyRuleId An index for the rules entries associated within a policy.	Unsigned32 Constraints: range: 1-4294967295	.1.3.6.1.4.1.4491.2.1.2.1.4.1.1.2
docsLoadBalPolicyRulePtr A pointer to an entry in a rule table. E.g., docsLoadBalBasicRuleEnable in docsLoadBalBasicRuleEntry. A value pointing to zeroDotZero, an inactive Row or a non-existing entry is treated as no rule defined for this polic…	SNMPv2-TCRowPointerr/w Description: Represents a pointer to a conceptual row. The value is the name of the instance of the first accessible columnar object in the conceptual row. For example, ifIndex.3 would point to the 3rd row in the ifTable…	.1.3.6.1.4.1.4491.2.1.2.1.4.1.1.3
docsLoadBalPolicyRowStatus The status of this conceptual row. There is no restriction on settings columns in this table when the value of docsLoadBalPolicyRowStatus is active(1). Setting this object to 'destroy' or 'notInService' for a row entry …	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.4491.2.1.2.1.4.1.1.5

DOCSIS defined basic ruleset for load Balancing Policy.
This table enables of disable load balancing for the groups
pointing to this ruleset in the policy group.

docsLoadBalBasicRuleEntry row .1.3.6.1.4.1.4491.2.1.2.1.4.2.1

An entry of DOCSIS defined basic ruleset.
The object docsLoadBalBasicRuleEnable is used for
instantiating an entry in this table via a RowPointer.
Entries in this table persist after CMTS initialization.

Indexes

docsLoadBalBasicRuleId

Column	Syntax	OID
docsLoadBalBasicRuleId The unique index for this row.	Unsigned32 Constraints: range: 1-4294967295	.1.3.6.1.4.1.4491.2.1.2.1.4.2.1.1
docsLoadBalBasicRuleEnable When using this ruleset, load balancing is enabled or disabled by the values enabled(1) and disabled(2) respectively. Additionally, a Load Balancing disabling period is defined in docsLoadBalBasicRuleDisStart and docsLo…	Enumerationr/w Enumerated Values: 1 enabled 2 disabled 3 disabledPeriod	.1.3.6.1.4.1.4491.2.1.2.1.4.2.1.2
docsLoadBalBasicRuleDisStart if object docsLoadBalBasicRuleEnable is disablePeriod(3) Load Balancing is disabled starting at this object value time (seconds from 12 AM). Otherwise, this object has no meaning.	secondsUnsigned32r/w Constraints: range: 0-86400	.1.3.6.1.4.1.4491.2.1.2.1.4.2.1.3
docsLoadBalBasicRuleDisPeriod If object docsLoadBalBasicRuleEnable is disablePeriod(3) Load Balancing is disabled for the period of time defined between docsLoadBalBasicRuleDisStart and docsLoadBalBasicRuleDisStart plus the period of time of docsLoa…	secondsUnsigned32r/w Constraints: range: 0-86400	.1.3.6.1.4.1.4491.2.1.2.1.4.2.1.4
docsLoadBalBasicRuleRowStatus This object is to create or delete rows in this table. There is no restriction for changing this row status or object's values in this table at any time.	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.4491.2.1.2.1.4.2.1.5