CISCO-WIRELESS-DOCS-EXT-MIB

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

The admission control status for this upstream entry. When this object is set to 'true', the upstream scheduler will check the virtual reserved bandwidth remaining before giving admission to this new SU. If there is not enough reserved bandwidth to serve the SU's minimum guaranteed bandwidth, the registration request will be rejected. This object is set to 'false' to disable admission control. That is, there will be no checking for bandwidth capacity and the upstream interface scheduler just admits SU registration requests.

Integer32 (10..1000) · percent

Reference: Data-Over-Cable Service Interface Specifications (DOCSIS) Radio Frequency Interface Specification (SP-RFI-I04-980724). section 6.4 and appendix C.

The percentage of upstream maximum reserved bandwidth to the raw bandwidth if the admission control is enabled on this upstream. For example, if the upstream interface has raw bandwidth 1,600,000 bits/second and cwdxQosCtrlUpMaxRsvdBWPercent is 200 percent, then this upstream scheduler will set the maximum of virtual reserved bandwidth capacity to 3,200,000 bits/second (1,600,000 * 2) to serve Subscriber-units with minimum guaranteed upstream bandwidth. The default value is 100 percent (that is, maximum reserved bandwidth is the raw bandwidth.) Whenever the admission control is changed (on to off, off to on), this value will be reset to the default value 100. If the admission control is disabled, the value will be reset to 100 (the default value).

Counter32

The count of SU registration requests rejected on this upstream interface. The rejection is due to insufficient available bandwidth for this SU. The requests are rejected only when cwdxQosCtrlUpAdmissionCtrl is 'true' on this upstream interface.

Integer32 (0..102400000) · bits/second

The current total reserved bandwidth in bits per second of this upstream interface. It is the sum of all SUs' minimum guaranteed bandwidth in bits per second currently supported on this upstream.

Integer32 (0..102400000) · bits/second

The maximum virtual bandwidth capacity of this upstream interface if the admission control is enabled. It is the raw bandwidth in bits per second times the percentage. If the admission control is disabled, then this object will contain the value zero.

INTEGER1 = noRateLimit2 = oneSecBurst3 = carLike4 = wgtExPacketDiscard5 = shaping · Integer32

To ensure fairness, at the upstream, the HE will throttle the rate of bandwidth grants, such that the flow never gets more than its provisioned peak rate in bps. Similarly at the downstream, HE controls the packets sent such that flow never gets more than its provisioned peak rate in bps. There are two directions for every Service Id (Sid) traffic: downstream and upstream. Each direction is called a service flow here and is assigned one token bucket with chosen algorithm. The enumerations for the rate limiting algorithm are: noRateLimit(1): The rate limiting is disabled. No rate limiting. oneSecBurst(2): Bursty 1 second token bucket algorithm. carLike(3) : Average token usage (CAR-like) algorithm wgtExPacketDiscard(4) : Weighted excess packet discard algorithm. shaping(5): token bucket algorithm with shaping Upstream supports all the above except wgtExtPacketDiscard(4). Downstream supports all the above rate-limiting algorithms. Token bucket algorithm with shaping is the default algorithm for upstream. Bursty 1 second token bucket algorithm is the default algorithm for downstream. Each algorithm is described as below: No rate limiting: The rate limiting process is disabled and no checking against the maximum bandwidth allowed. Bursty 1 second token bucket rate limiting algorithm: In this algorithm, at the start of every 1 second interval, a service flow's token usage is reset to 0, and every time the modem for that service flow sends a request (upstream) / packet (downstream) the upstream/downstream bandwidth token usage is incremented by the size of the request/packet sent. As long as the service flow's bandwidth token usage is less than the maximum bandwidth in bits per second (peak rate limit) its QoS service class allows, the request/packets will not be restricted. Once the service flow has sent more than its peak rate in the one second interval, it is prevented from sending more data by rejecting request (upstream) or dropping packets (downstream). This is expected to slow down the higher layer sources. The token usage counter gets reset to 0 after the 1 second interval has elapsed. The modem for that service flow is free to send more data up to the peak rate limit in the new 1 second interval that follows. Average token usage (Cisco CAR like) algorithm: This algorithm maintains a continuous average of the burst token usage of a service flow. There is no sudden refilling of tokens every 1 second interval. Every time a request/packet is to be handled, the scheduler tries to see how much time has elapsed since last transmission, and computes the number of tokens accumulated by this service flow at its QoS class peak rate. If burst usage of the service flow is less than tokens accumulated, the burst usage is reset to 0 and request/packet is forwarded. If the service flow has accumulated fewer tokens than its burst usage, the burst usage shows an outstanding balance usage after decrementing by the tokens accumulated. In such cases, the request/packet is still forwarded, provided the service flow's outstanding usage does not exceed peak rate limit of its QoS class. If outstanding burst usage exceeds the peak rate of the class, the service flow is given some token credit up to a certain maximum credit limit and the request/packet is forwarded. The request/packet is dropped when outstanding usage exceeds peak rate and maximum credit has been used up by this service flow. This algorithm tracks long term average bandwidth usage of the service flow and controls this average usage at the peak rate limit. Weighted excess packet discard algorithm: This rate limiting algorithm is only available as an option for downstream rate limiting. The algorithm is to maintain an weighted exponential moving average of the loss rate of a service flow over time. The loss rate, expressed in packets, represents the number of packets that can be sent from this service flow in a one second interval before a packet will be dropped. At every one second interval, the loss rate gets updated using the ratio between the flow peak rate (in bps) in its QoS profile and the service flow actual usage (in bps). If the service flow begins to send more than its peak rate continuously, the number of packets it can send in an one second interval before experiencing a drop will slowly keep reducing until SU for that service flow slows down as indicated by actual usage less or equal to the peak rate. Token bucket algorithm with shaping: If there is no QoS class peak rate limit, forward the request/packet without delay. If there is a QoS peak rate limit, every time a request/packet is to be handled, the scheduler determines the number of bandwidth tokens that this service flow has accumulated over the elapsed time at its QoS class peak rate and increments the tokens counter of the service flow accordingly. The scheduler limits the token count to the maximum transmit burst (token bucket depth). If token count is greater than the number of tokens required to handle current request/packet, decrement token count by size of request/packet and forwards the request/packet without delay. If token count is less than the size of request/packet, compute the shaping delay time after which the deficit number of tokens would be available. If shaping delay time is less than the maximum shaping delay, decrement tokens count by size of request/packet and forward this request/packet with the shaping delay in the shaping delay queue. When the delay time expires, the request/packet is forwarded. If shaping delay time is greater than the maximum shaping delay that the subsequent shaper can handle, the request/packet is dropped. Users can use cwdxQosIfRateLimitShpMaxDelay to configure the maximum shaping delay and cwdxQosIfRateLimitShpGranularity to configure the shaping granularity.

Integer32 (1..4)

Weight for exponential moving average of loss rate, when using weighted excess packet discard algorithm. The higher values of the weight make the algorithm more sensitive to the recent bandwidth usage by the Sid. The default value is 1. Whenever the rate limiting algorithm is changed to weighted excess packet discard algorithm, this value will be reset to the default 1. If the rate limiting algorithm is not weighted excess packet discard algorithm, the value will be always the default value 1. You will not be able to set it to anything other than 1 when it is not weighted excess packet discard algorithm.

INTEGER1 = na2 = msec1283 = msec2564 = msec5125 = msec1024 · Integer32

The maximum shaping delay in milliseconds. That is, the maximum amount of time for which the HE will allow buffering of any rate exceeded flow. If the max buffering delay is large, then grants/packets of the flow will be buffered for a longer period of time even though the flow is rate exceeded. This means fewer chances of drops for such rate exceeded flow. However, too large a max shaping delay can result in quick drainage of packet buffers at the HE, since several packets will be in the shaping (delay) queue waiting for their proper transmission time. Another important point to note is that delaying a flow's packets (especially TCP flows) for extended periods of time may be counter- productive, since the higher protocol layers may assume a packet loss after a certain amount of time. The maximum shaping delay is only applied to rate limit algorithm: Token bucket algorithm with shaping. If the rate limit algorithm is not Token bucket algorithm with shaping, the value is always na(1) which is not applicable. In this case, you will be allowed to set the value to na(1) only. If the token count is less than the size of request/packet, HE computes the shaping delay time after which the deficit number of tokens would be available. If the shaping delay time is greater than the maximum shaping delay, the request/packet will be dropped. The enumerations for cwdxQosIfRateLimitShpMaxDelay are: na(1): maximum shaping delay is not applied to the current rate limit algorithm msec128(2): maximum shaping delay is 128 milliseconds msec256(3): maximum shaping delay is 256 milliseconds msec512(4): maximum shaping delay is 512 milliseconds msec1024(5): maximum shaping delay is 1024 milliseconds At the downstream, cwdxQosIfRateLimitShpMaxDelay is configurable and the default value is msec128(2). Whenever the downstream rate limit algorithm is changed to Token bucket algorithm with shaping from other rate limit algorithm, the value will be reset to the default value. At the upstream, cwdxQosIfRateLimitShpMaxDelay is not configurable and it is read-only value.

INTEGER1 = na2 = msec13 = msec24 = msec45 = msec86 = msec16 · Integer32

The width in milliseconds of each element in shaping delay queue, that is, the shaping granularity. The shaping granularity is only applied to rate limit algorithm: Token bucket algorithm with shaping. It controls how accurately the algorithm quantizes the shaping delay for a rate exceeded flow. If granularity is large, several shaping delay values will all be quantized to the same element in the queue resulting in less accurate rate shaping for the flows in bits/sec. On the other hand, choosing too small granularity causes more memory to be used for the shaper block, and also can cost a bit more in runtime overhead. If the rate limit algorithm is not Token bucket algorithm with shaping, the value is always na(1) which is not applicable. Setting to any thing other than na(1) will be rejected. The enumerations for shaping granularity are: na(1): shaping granularity is not applied to the current rate limit algorithm msec1(2): shaping granularity in 1 milliseconds msec2(3): shaping granularity in 2 milliseconds msec4(4): shaping granularity in 4 milliseconds msec8(5): shaping granularity in 8 milliseconds msec16(6): shaping granularity in 16 milliseconds At the downstream, this object is configurable and the default value is msec4(4). Whenever the downstream rate limit algorithm is changed to Token bucket algorithm with shaping from other rate limit algorithm, the value will be reset to the default value. When the algorithm is Token bucket algorithm with shaping and set to same algorithm again the value will not be reset to default value. At the upstream, this object is not configurable and it is read-only value.

Counter32

The cumulative number of Packet Data octets sent for this Service ID.

Counter32

The cumulative number of Packet data packets sent for this Service ID.

Counter32

Reference: cwdIfQosProfMaxUpBandwidth object in CISCO-WIRELESS-DOCS-IF-MIB.my.

The number of upstream bandwidth requests which exceeds the maximum upstream bandwidth allowed for a service defined in the Quality of Service profile associated with this Sid. The request which exceeds the maximum upstream bandwidth allowed will be rejected by the upstream's rate limiting process using one of the rate limiting algorithm. Note that the value of this counter cannot be directly used to know the number of upstream packets that got dropped at the SU. A single upstream packet drop of a SU can result in up to 16 increments in this counter, since the SU keeps retrying and keeps getting bandwidth request drops at HE if it has consumed its peak rate.

Counter32

Reference: cwdIfQosProfMaxDownBandwidth object in CISCO-WIRELESS-DOCS-IF-MIB.my.

The number of downstream bandwidth packets which exceeds the maximum downstream bandwidth allowed for a service defined in the Quality of Service profile associated with this Sid. The packet which exceeds the maximum downstream bandwidth allowed will be dropped by the downstream's rate limiting process using one of the rate limiting algorithm.

INTEGER1 = cirQ2 = tbeQ · Integer32

Reference: Data-Over-Cable Service Interface Specifications (DOCSIS) Radio Frequency Interface Specification (SP-RFI-I04-980724), section 6.4 and appendix C.

The name code for the queue. cirQ: CIR queue. The queue is for Committed Information Rate (CIR) type of service which serves Service IDs which have minimum guaranteed rate in its QoS profile. tbeQ: TBE queue. The queue is for TIERED BEST EFFORT type service which serves Service IDs which does not have minimum guaranteed rate in its QoS profile.

Integer32 (0..10)

The relative order of this queue to the other queues within the wireless interface. The smaller number has higher order. That is, 0 is the highest order and 10 is the lowest order. The scheduler will serve the requests in higher order queue up to the number of requests defined in cwdxBWQueueNumServedBeforeYield before serving requests in the next higher order queue. The queues with higher priority will not be serviced (once the QueueNumServedBeforeYield number has been hit) until all remaining queues are processed. If there are n queues on this interface, the queue order will be 0 to n-1 and maximum number of requests defined as cwdxBWQueueNumServedBeforeYield in order 0 queue will be served before the requests in order 1 queue to be served.

Integer32 (0..50)

The maximum number of requests/packets the scheduler can serve before yielding to another queue. The value 0 means all requests must be served before yielding to another queue.

INTEGER1 = unknown2 = other3 = fifo4 = priority · Integer32

The queuing type which decides the position of a request/packet within the queue. unknown : queue type unknown. other : not fifo, and not priority. fifo : first in first out. priority: each bandwidth request has a priority and the position of the request within the queue depends on its priority.

Integer32

The maximum number of requests/packets which the queue can support.

Integer32

The current number of requests/packets in the queue.

Counter32

The number of requests/packets discarded because of queue overflow (queue depth > queue maximum depth).

INTEGER (1..2147483647) · Integer32

Index to an entry in cwdIfHeSuStatusTable identifying status of the SU (which the CPE connects to.)

MacAddressRepresents 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 MAC addresses to be transmitted most significant bit first. SIZE (6) · OCTET STRING · hint 1x:

The Mac address to identify a Customer Premises Equipment.

IpAddress SIZE (4)

Ip address of the Customer Premises Equipment.

DisplayStringRepresents textual information taken from the NVT ASCII character set, as defined in pages 4, 10-11 of RFC 854. To summarize RFC 854, the NVT ASCII repertoire specifies: - the use of character codes 0-127 (decimal) - the graphics characters (32-126) are interpreted as US ASCII - NUL, LF, CR, BEL, BS, HT, VT and FF have the special meanings specified in RFC 854 - the other 25 codes have no standard interpretation - the sequence 'CR LF' means newline - the sequence 'CR NUL' means carriage-return - an 'LF' not preceded by a 'CR' means moving to the same column on the next line. - the sequence 'CR x' for any x other than LF or NUL is illegal. (Note that this also means that a string may end with either 'CR LF' or 'CR NUL', but not with CR.) Any object defined using this syntax may not exceed 255 characters in length. SIZE (0..255) · OCTET STRING · hint 255a

ASCII text to identify the Access Group for a CPE. Access Group is to filter the upstream traffic for that CPE.

INTEGER (1..2147483647) · Integer32

Index to an entry in cwdIfHeSuStatusTable identifying status of the SU.

MacAddressRepresents 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 MAC addresses to be transmitted most significant bit first. SIZE (6) · OCTET STRING · hint 1x:

The Mac address to identify a Subscriber-unit.

INTEGER1 = offline2 = others3 = initRangingRcvd4 = initDhcpReqRcvd5 = onlineNetAccessDisabled6 = onlineKekAssigned7 = onlineTekAssigned8 = rejectBadMic9 = rejectBadCos10 = kekRejected11 = tekRejected12 = online13 = initTftpPacketRcvd14 = initTodRequestRcvd · Integer32

Current Subscriber-unit connectivity state. The object extends states in cwdIfHeSuStatusValue in more detail. The enumerations are: offline(1) : SU considered offline. others(2) : states is in cwdIfHeSuStatusValue. initRangingRcvd(3) : SU sent initial ranging. initDhcpReqRcvd(4) : dhcp request received. onlineNetAccessDisabled(5): SU registered, but network access for the SU is disabled. onlineKekAssigned(6) : SU registered, BPI enabled and KEK assigned. onlineTekAssigned(7) : SU registered, BPI enabled and TEK assigned. rejectBadMic(8) : SU did attempt to register but registration was refused due to bad mic. rejectBadCos(9) : SU did attempt to register but registration was refused due to bad COS. kekRejected(10) : KEK SU key assignment rejected. tekRejected(11) : TEK SU key assignment rejected. online(12) : SU registered, enabled for data. initTftpPacketRcvd(13): tftp packet received and option file transfer started. initTodRquestRcvd(14): Time of the Day (TOD) request received. The ranging, rangingAborted, rangingComplete, and ipComplete states in cwdIfHeSuStatusValue are all represented by the 'others' value in this object. The registrationComplete state in cwdIfHeSuStatusValue could be online, onlineNetAccessDisabled, onlineKekAssigned, or onlineTekAssigned in this object. The accessDenied state in cwdIfHeSuStatusValue could be rejectBadMic, rejectBadCos in this object for the possible reasons of Subscriber-unit registration abort. The HE only reports states it is able to detect.

Counter32

Reference: cwdxHeSuStatusValue object.

The number of times that the SU changes the connectivity state from 'offline' to 'online' over the time period from the SU's first ranging message received by HE until now. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

Integer32 (0..10000)

Reference: cwdxHeSuStatusValue object.

The percentage of time that the SU stays 'online' over the time period from the SU's first ranging message received by HE until now. The value for this object is 100 times bigger than the real percentage value. For example, 32.15% will be value 3215. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

TimeIntervalA period of time, measured in units of 0.01 seconds. (0..2147483647) · Integer32

Reference: cwdxHeSuStatusValue object.

The minimum period of time the SU stayed 'online' over the time period from the SU's first ranging message received by HE until now. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

TimeIntervalA period of time, measured in units of 0.01 seconds. (0..2147483647) · Integer32

Reference: cwdxHeSuStatusValue object.

The average period of time the SU stayed 'online' over the time period from the SU's first ranging message received by HE until now. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

TimeIntervalA period of time, measured in units of 0.01 seconds. (0..2147483647) · Integer32

Reference: cwdxHeSuStatusValue object.

The maximum period of time the SU stayed 'online' over the time period from the SU's first ranging message received by HE until now. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

TimeIntervalA period of time, measured in units of 0.01 seconds. (0..2147483647) · Integer32

Reference: cwdxHeSuStatusValue object.

The minimum period of time SU stayed 'offline' over the time period from the SU's first ranging message received by HE until now. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

TimeIntervalA period of time, measured in units of 0.01 seconds. (0..2147483647) · Integer32

Reference: cwdxHeSuStatusValue object.

The average period of time the SU stayed 'offline' over the time period from the SU's first ranging message received by HE until now. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

TimeIntervalA period of time, measured in units of 0.01 seconds. (0..2147483647) · Integer32

Reference: cwdxHeSuStatusValue object.

The maximum period of time the SU stayed 'offline' over the time period from the SU's first ranging message received by HE until now. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

INTEGER (0..16383) · Integer32

The number of active dynamic sids on this SU.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

An indication of whether the cwdxHeSuOnOffNotification is enabled. The default value is false(2).

Integer32 (0..86400) · seconds

The interval for cwdxHeSuOnOffNotification sent by HE for one online/offline state change if cwdxHeSuOnOffTrapEnable is true. If there are more than one state changes to online/offline for a Subscriber-unit during this interval, only one cwdxHeSuOnOffNotification is sent by HE for the first state change to online and one cwdxHeSuOnOffNotification for the first state changing to offline if cwdxHeSuOnOffTrapEnable is true. This is to avoid too many notifications sent for a SU online/offline state changes during a short period of time. If the value is 0, then cwdxHeSuOnOffNotification will be sent for every state change to online/offline for a SU if cwdxHeSuOnOffTrapEnable is true. This object's value will be retained even if the cwdxHeSuOnOffTrapEnable value changes. Thus disabling notifications will not result in this object's value being reset tot he default value. The default value is 600 seconds.

Integer32 (0..255)

The default maximum number of permitted CPEs per SU in this wireless interface. A SU can override this value by setting the object cwdxHeSuMaxCpeNumber in the cwdxHeSuTable. The value 0 means no maximum limit. The default value for this object is 0. Setting the value will not affect the already connected CPEs to the SUs in this wireless interface.

Integer32 (0..2147483647)

Total number of SUs that successfully registered at least once with this HE. This count will be decremented whenever the SUs are aged out at the HE.

Integer32 (0..2147483647)

Total number of SU's that are offline at this time. The SU is considered as 'online' when the value for cwdxHeSuStatusValue is any of the values: online(5), onlineNetAccessDisabled(6), onlineKekAssigned(7), and onlineTekAssigned(8), and the SU is considered as 'offline' for other values for cwdxHeSuStatusValue.

Integer32 (1..2147483647)

Object which specifies a unique entry in the table. A management station wishing to initiate a channel override operation should use a pseudo-random value for this object when creating or modifying an instance of a cwdxHeSuChOverEntry.

MacAddressRepresents 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 MAC addresses to be transmitted most significant bit first. SIZE (6) · OCTET STRING · hint 1x:

The mac address of the Subscriber-unit that the HE instructs to move to a new downstream and/or upstream channel. This column must be set to a valid Mac address currently in the HE in order for this entry's row status to be set to active successfully.

Integer32 (0..1000000000) · hertz

The new downstream frequency which the Subscriber-unit is instructed to move to. The value 0 is to ask the HE not to override the downstream frequency.

Integer32 (-1..255)

The new channel Id which the Subscriber-unit is instructed to move to. The value -1 is to ask the HE not to override the upstream channel Id.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

Specifies whether or not a cwdxHeSuChOverNotification should be issued on completion of the operation. If such a notification is desired, it is the responsibility of the management entity to ensure that the SNMP administrative model is configured in such a way as to allow the notification to be delivered.

TimeStampThe 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 to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

The value of sysUpTime at which the operation was initiated. Since it is possible to have more than one entry in this table for a Subscriber-unit, this object can help to distinguish the entries for the same Subscriber-unit.

INTEGER1 = messageSent2 = commandNotActive3 = noOpNeeded4 = suNotFound5 = waitToSendMessage6 = timeOut · Integer32

Reference: Data-Over-Cable Service Interface Specifications (DOCSIS) Radio Frequency Interface Specification (SP-RFI-I04-980724), 6.3.2.5.3 Overriding Channels.

The status of the specified channel override operation. The enumerations are: messageSent(1): the HE has sent a RNG-RSP message with channel override to the Subscriber-unit. commandNotActive(2): the command is not in active mode due to this entry's row status is not in active yet. noOpNeeded(3): The downstream frequency and the upstream channel Id in this entry are the same as original ones when this entry's row status is set to active, so HE does not need to do any operation. SuNotFound(4): The SU is not found in the HE at the time when the command becomes active. waitToSendMessage(5): specified the operation is active and HE is waiting to send a RNG-RSP message with channel override to the Subscriber-unit. timeOut(6): specified the operation is timed out. That is, the HE cannot send a RNG-RSP message with channel override to the Subscriber-unit within the time specified in the object of cwdxHeSuChOverTimeExpiration. The possible reason is that the Subscriber-unit does not repeat the initial ranging. The possible state change diagram is as below: [commandNotActive ->] waitToSendMessage -> messageSent or timeOut. [commandNotActive ->] noOpNeeded or SuNotFound.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe 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 [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The status of this table entry. This value for cwdxHeSuChOverMacAddress must be valid Mac address currently in the HE in order for the row status to be set to active successfully. Once the row status becomes active and state becomes waitToSendMessage, the entry cannot not be changed except to delete the entry by setting the row status to destroy(6) and since the operation cannot be stopped, the destroy(6) will just cause the SNMP agent to hide the entry from application and the SNMP agent will delete the entry right after the operation is completed.

Integer32 (-1..255)

The maximum number of permitted CPEs connecting to the SU. The value -1 means to use the default value of maximum hosts per SU in the HE wireless interface which the SU connects to and the value is defined in cwdxHeSuDefaultMaxCpes in the cwdxHeMacExtTable. The value 0 means no maximum limit. The default value is -1. Setting the value will not affect the already connected CPEs to the SU.

INTEGER (0..65535) · Integer32 · milliseconds

Reference: Data over Cable Radio Frequency Interface Specification, SP-RFIv1.1-I02-990731 Appendix M.1.2

The value of this parameter specifies the interval between successive data grant opportunities for a service flow. This object is required for Unsolicited Grant and Unsolicited Grant with Activity Detection Service Flows. This object is optional for Real-Time Polling Service Flows.

INTEGER (0..65535) · Integer32 · bytes

Reference: Data over Cable Radio Frequency Interface Specification, SP-RFIv1.1-I02-990731 Appendix M.1.2

This parameter specifies the unsolicited grant size.

DisplayStringRepresents textual information taken from the NVT ASCII character set, as defined in pages 4, 10-11 of RFC 854. To summarize RFC 854, the NVT ASCII repertoire specifies: - the use of character codes 0-127 (decimal) - the graphics characters (32-126) are interpreted as US ASCII - NUL, LF, CR, BEL, BS, HT, VT and FF have the special meanings specified in RFC 854 - the other 25 codes have no standard interpretation - the sequence 'CR LF' means newline - the sequence 'CR NUL' means carriage-return - an 'LF' not preceded by a 'CR' means moving to the same column on the next line. - the sequence 'CR x' for any x other than LF or NUL is illegal. (Note that this also means that a string may end with either 'CR LF' or 'CR NUL', but not with CR.) Any object defined using this syntax may not exceed 255 characters in length. SIZE (0..64) · OCTET STRING · hint 255a

This object is a string used to describe this Qos Profile. It has informational significance only.

INTEGER (0..255) · Integer32

This object is the bit mask (8 bit wide) for tos-overwrite feature. The cwdxQosProfTosOverwriteValue is written where the mark bits are set to 1. Tos-overwrite allows the HE to mark egress IP packets (from the HE) with a specific TOS value. This relieves the subscriber unit from marking upstream packets with a specific TOS and is most useful when a subscriber unit is supplied by a third party vendor who may not have the option of applying a TOS to an IP packet. Each packet received from an SU that matches this QoS profile will be tagged with the TOS-overwrite value at the cwdxQosProfTosOverwriteMask and sent to the network.

INTEGER (0..255) · Integer32

This object is the byte value for tos-overwrite. The cwdxQosProfTosOverwriteValue is written where the mark bits are set to 1. Each packet received from an SU that matches this QoS profile will be tagged with the cwdxQosProfTosOverwriteValue value at the cwdxQosProfTosOverwriteMask and sent to the network.

INTEGER (1..8) · Integer32

The index value along with the primary index of cwdIfQosProfIndex which uniquely identifies an entry in the cwdxQosIpTosRatelimitEntry.

INTEGER (0..100000000) · Integer32 · bps

Maximum downstream rate that can be allowed with this IP precedence.