CISCO-WIRELESS-DOCS-IF-MIB

INTEGER (0..60000000) · Integer32 · kHz

The reference center frequency used by the upstream channels in this channel.

INTEGER (0..500000) · Integer32 · kHz

The maximum bandwidth that can be used by any upstream channel. The sum of the bandwidths used by all upstream channels created within this channel cannot exceed this value.

INTEGER (0..60000000) · Integer32 · kHz

The reference center frequency used by the downstream channels in this channel.

INTEGER (0..500000) · Integer32 · kHz

The maximum bandwidth that can be used by any downstream channel. The sum of the bandwidths used by all downstream channels created within this channel cannot exceed this value.

INTEGER (0..102400000) · Integer32 · Microseconds

This object represents a unit of measurement of mini-slots. Upstream mini-slots and bandwidth allocations are done in multiples of this unit of time.

Unsigned32

Reference: Firestorm(P2MP) Sub-Channel Plan Specification - ENG-51192

This object represents the sub-channel plan version number common to both upstream and downstream supported by the hardware.

INTEGER (1..1024) · Integer32

This identifies the sub-channel used by this downstream. The value of this object determines the usability of the other downstream channels.

INTEGER (0..255) · Integer32

The internal (DOCSIS) identification of the downstream channel within this particular MAC interface. If the interface is down, the object returns the last assigned value. If the downstream channel ID is unknown, this object returns a value of 0.

INTEGER (0..60000000) · Integer32 · kHz

The downstream center frequency associated with this channel. The channel settings determine this value.

INTEGER (0..500000) · Integer32 · kHz

The bandwidth of this downstream channel. The channel settings determine this value.

Integer32 (-80..50) · dBm - decibel milliwatts

At the HE, the operational transmit power. At the SU, the received power level. May be set to zero at the SU if power level measurement is not supported. If the interface is down, this object returns the configured value (if at HE), the most current value (if at SU) or zero (if not supported by the implementation).

Unsigned32

An index into cwdIfModulationTable that describes modulation characteristics of this channel. This object returns 0 if the cwdIfModulationTable does not exist, or there is no corresponding row in that table that describes modulation characteristics of this channel.

INTEGER (0..1024) · Integer32

This identifies the sub-channel used by this upstream.

INTEGER (0..255) · Integer32

The internal (DOCSIS) identification of the upstream channel within this particular MAC interface. If the interface is down, the object returns the most current value. If the upstream channel ID is unknown, this object returns a value of 0.

INTEGER (0..60000000) · Integer32 · kHz

The center of the upstream frequency associated with this channel. The channel settings determine this value.

INTEGER (0..500000) · Integer32 · kHz

The bandwidth of this upstream channel. The channel settings determine this value.

Integer32 (-80..50) · dBm - decibel milliwatts

The target receive power of this upstream channel at the headend and the transmit power of the channel at the subscriber end.

Unsigned32

An index into cwdIfModulationTable that describes modulation characteristics of this channel. This object returns 0 if the cwdIfModulationTable does not exist or is empty.

Unsigned32

The number of units of time-slot (measured by cwdIfChannelMiniSlotTimeBaseTick) in each upstream mini-slot. Returns zero if the value is undefined or unknown.

Unsigned32

A measure of the current round trip time at the SU, or the maximum round trip time seen by the HE. Used for timing of SU upstream transmissions to ensure synchronized arrivals at the HE. Units are in terms of (cwdIfChannelMiniSlotTimeBaseTick/64).

INTEGER (0..16) · Integer32

This value determines the initial contention resolution back-off window used by the SU when attempting to transmit an initial ranging request. The SU randomly selects a number within the back-off window defined by this parameter then defers this number of contention transmit opportunities before actually attempting the transmission. Expressed as a power of 2. A value of 16 at the HE indicates that a proprietary adaptive retry mechanism is to be used.

INTEGER (0..16) · Integer32

This value determines the final contention resolution back-off window used by the SU when attempting to transmit an initial ranging request. The SU randomly selects a number within the back-off window defined by this parameter then defers this number of contention transmit opportunities before actually attempting the transmission. Expressed as a power of 2. A value of 16 at the HE indicates that a proprietary adaptive retry mechanism is to be used.

INTEGER (0..16) · Integer32

This value determines the initial contention resolution back-off window used by the SU when attempting to transmit data packets. The SU randomly selects a number within the back-off window defined by this parameter then defers this number of contention transmit opportunities before actually attempting the transmission. Expressed as a power of 2. A value of 16 at the HE indicates that a proprietary adaptive retry mechanism is to be used.

INTEGER (0..16) · Integer32

This value determines the final contention resolution back-off window used by the SU when attempting to transmit data packets. The SU randomly selects a number within the back-off window defined by this parameter then defers this number of contention transmit opportunities before actually attempting the transmission. Expressed as a power of 2. A value of 16 at the HE indicates that a proprietary adaptive retry mechanism is to be used.

INTEGER (1..16383) · Integer32

The index value which uniquely identifies an entry in the cwdIfQosProfileTable. Any arbitrary integer within the range can be used as index to create a row.

INTEGER (0..7) · Integer32

A relative priority assigned to this service when allocating bandwidth. Zero indicates lowest priority. seven highest. Interpretation of priority is device-specific.

INTEGER (0..100000000) · Integer32

The maximum upstream bandwidth, in bits per second, allowed for a service with this service class. Zero if there is no restriction of upstream bandwidth.

INTEGER (0..100000000) · Integer32

Minimum guaranteed upstream bandwidth, in bits per second, allowed for a service with this service class.

INTEGER (0..100000000) · Integer32

The maximum downstream bandwidth, in bits per second, allowed for a service with this service class. Zero if there is no restriction of downstream bandwidth.

Integer32

The maximum number of mini-slots that may be requested for a single upstream transmission. A value of zero means there is no limit.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

Indicates whether Baseline Privacy is enabled for this service class.

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

Controls and reflects the status of rows in this table.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

true(1) if this HE includes contention intervals in the counters in this table. Always false(2) for SUs.

Counter32

Codewords received on this channel without error. This includes all codewords, whether or not they were part of frames destined for this device.

Counter32

Codewords received on this channel with correctable errors. This includes all codewords, whether or not they were part of frames destined for this device.

Counter32

Codewords received on this channel with uncorrectable errors. This includes all codewords, whether or not they were part of frames destined for this device.

CwrdBmThis is a unit of power measurement. It is measured in decibels of milliwatts (dBm). dBm = 10 * log(millwatts of power). (-80..33) · Integer32

Signal to Interference plus Noise ratio as perceived for this channel.

INTEGER (1..2147483647) · Integer32

An index into the Channel Modulation table (cwdIfModulationTable) representing modulation parameters of a channel.

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

Controls and reflects the status of rows in this table.

INTEGER (0..500000) · Integer32 · kHz

The maximum bandwidth that can be used by a channel with using this modulation profile.

INTEGER (0..50000000) · Integer32 · bps

This represents the throughput expected of the identified radio link.

INTEGER1 = veryShort2 = short3 = medium4 = long · Integer32

The duration of the OFDM burst used by the physical layer. This is also the duration of the MAC minislot. Not all the settings will be supported by a particular ODU. Consult the capabilities of the ODU to determine the best burst length setting to use. The exact durations are hardware and implementation dependent.

INTEGER1 = standard2 = high · Integer32

The quantitative level of robustness to multipath (also known as delay spread tolerance). The degree of multipath in the environment will vary with deployment. Consult installation and deployment documentation to determine the best setting to use.

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:

Identifies the HE that controls this MAC domain. At the SU, this will be the source address from SYNC, MAP, and other MAC-layer messages. If the HE is unknown, returns 00-00-00-00-00-00.

BITS

Identifies the capabilities of the MAC implementation at this interface. Note that packet transmission is always supported. Therefore, there is no specific bit required to explicitly indicate this capability.

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

Reference: Data over Cable Radio Frequency Interface specification, Section 7, timer T3

Waiting time for a Ranging Response packet.

INTEGER1 = other2 = notReady3 = notSynchronized4 = phySynchronized5 = usParametersAcquired6 = rangingComplete7 = ipComplete8 = todEstablished9 = securityEstablished10 = paramTransferComplete11 = registrationComplete12 = operational13 = accessDenied · Integer32

Reference: Data over Cable Radio Frequency Interface Specification, Chapter 7.2.

Current Subscriber unit connectivity state, as specified in the RF Interface Specification.

OCTET STRING

Reference: Data over Cable Radio Frequency Interface Specification, Subscriber unit status codes.

Status code for this Subscriber unit as defined in the RF Interface Specification. The status code consists of a single character indicating error groups, followed by a two- or three-digit number indicating the status condition.

Integer32 (-80..50) · dBm - decibel milliwatts

The operational transmit power for the attached upstream channel.

Counter32

Number of times the SU reset or initialized this interface.

Counter32

Number of times the SU lost synchronization with the downstream channel.

Counter32

Number of times the SU received invalid MAP messages.

Counter32

Number of times the SU received invalid UCD messages.

Counter32

Number of times the SU received invalid ranging response messages.

Counter32

Number of times the SU received invalid registration response messages.

Counter32

Number of times counter T1 expired in the SU.

Counter32

Number of times counter T2 expired in the SU.

Counter32

Number of times counter T3 expired in the SU.

Counter32

Number of times counter T4 expired in the SU.

Counter32

Number of times the ranging process was aborted by the HE.

INTEGER (1..16383) · Integer32

Identifies a service queue for upstream bandwidth. The attributes of this service queue are shared between the SU and the HE. The HE allocates upstream bandwidth to this service queue based on requests from the SU and on the class of service associated with this queue.

INTEGER (0..16383) · Integer32

The index in cwdIfQosProfileTable describing the quality of service attributes associated with this particular service. If cwdIfQosProfileTable is not supported or doesn't exist, this object returns the value of zero.

Counter32

The number of upstream mini-slots which have been used to transmit data PDUs in immediate (contention) mode. This includes only those PDUs which are presumed to have arrived at the headend (i.e., those which were explicitly acknowledged.) It does not include retransmission attempts or mini-slots used by requests.

Counter32

The number of upstream mini-slots which have been used to transmit data PDUs in dedicated mode (i.e., as a result of a unicast Data Grant).

Counter32

The data PDUs transmitted directly in contention data slots expects explicit acknowledgement from the Headend. If the acknowledgement is not received the PDUs are transmitted again. This object is the number of attempts to transmit data PDUs which didn't receive acknowledgement.

Counter32

The data PDUs transmitted directly in contention data slots expects explicit acknowledgement from the Headend. If the acknowledgement is not received the PDUs are transmitted again. After excessive retries the data PDUs are dropped. This object represents the number of data PDU transmission failures due to excessive retries without acknowledgment.

Counter32

The number of attempts to transmit bandwidth requests which did not result in acknowledgment.

Counter32

The number of requests for bandwidth which failed due to excessive retries without acknowledgment.

BITS

Identifies the capabilities of the HE MAC implementation at this interface. Note that packet transmission is always supported. Therefore, there is no specific bit required to explicitly indicate this capability.

INTEGER (1..200) · Integer32 · Milliseconds

Reference: Data Over Cable Radio Frequency Interface Specification, Sync Interval.

The interval between HE transmission of successive SYNC messages at this interface.

INTEGER (1..2000) · Integer32 · Milliseconds

Reference: Data Over Cable Radio Frequency Interface Specification, UCD Interval.

The interval between HE transmission of successive Upstream Channel Descriptor messages for each upstream channel at this interface.

INTEGER (1..16383) · Integer32

Reference: Data Over Cable Radio Frequency Interface Specification, Appendix A. Well-Known Addresses. A.2 MAC Service IDs.

The maximum number of service IDs that may be simultaneously active.

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

Reference: Data Over Cable Radio Frequency Interface Specification, Ranging Interval.

The amount of time between each broadcast station maintenance grant. Broadcast station maintenance grants are used to allow new subscriber units to join the network. Zero indicates that a vendor-specific algorithm is used instead of a fixed time. Maximum amount of time permitted by the DOCSIS specification is 2 seconds.

INTEGER (0..1024) · Integer32

The maximum number of attempts to make on invitations for ranging requests. A value of zero means the system should attempt to range forever.

Counter32

This object counts invalid RNG-REQ messages received on this interface.

Counter32

This object counts ranging attempts that were explicitly aborted by the HE.

Counter32

This object counts invalid REG-REQ messages received on this interface.

Counter32

This object counts failed registration attempts, i.e., authentication failures and class of service failures, on this interface.

Counter32

This object counts invalid data request messages received on this interface.

Counter32

Reference: Data Over Cable Radio Frequency Interface Specification, Sync Interval. Appendix B

This object counts the number of times counter T5 expired on this interface. The T5 timer is the 'Wait for Upstream Channel Change Response Timer' on the Head end.

INTEGER (1..2147483647) · Integer32

Index value to uniquely identify an entry in this table. For an individual Subscriber Unit, this index value should not change during HE uptime.

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:

MAC address of this Subscriber Unit. If the Subscriber Unit has multiple MAC addresses, this is the MAC address associated with the Wireless interface. Each SU has only one wireless MAC interface.

IpAddress SIZE (4)

IP address of this Subscriber Unit. If the Subscriber Unit has no IP address assigned, or the IP address is unknown, this object returns a value of 0.0.0.0. If the Subscriber Unit has multiple IP addresses, this object returns the IP address associated with the Wireless interface. Each SU has only one wireless MAC interface.

InterfaceIndexOrZeroThis textual convention is an extension of the InterfaceIndex convention. The latter defines a greater than zero value used to identify an interface or interface sub-layer in the managed system. This extension permits the additional value of zero. the value zero is object-specific and must therefore be defined as part of the description of any object which uses this syntax. Examples of the usage of zero might include situations where interface was unknown, or when none or all interfaces need to be referenced. (0..2147483647) · Integer32 · hint d

IfIndex of the downstream channel this Subscriber Unit is connected to. If the downstream channel is unknown, this object returns a value of zero.

InterfaceIndexOrZeroThis textual convention is an extension of the InterfaceIndex convention. The latter defines a greater than zero value used to identify an interface or interface sub-layer in the managed system. This extension permits the additional value of zero. the value zero is object-specific and must therefore be defined as part of the description of any object which uses this syntax. Examples of the usage of zero might include situations where interface was unknown, or when none or all interfaces need to be referenced. (0..2147483647) · Integer32 · hint d

IfIndex of the upstream channel this Subscriber Unit is connected to. If the upstream channel is unknown, this object returns a value of zero.

Integer32 (-80..33) · dBm Decibel milliwatts

The receive power as perceived for upstream data from this subscriber unit. If the receive power is unknown, this object returns a value of zero.

Unsigned32

A measure of the current round trip time for this SU. Used for timing of SU upstream transmissions to ensure synchronized arrivals at the HE. Units are in terms of (cwdIfUpstreamMiniSlotTimeBaseTick/64). Returns zero if the value is unknown.

INTEGER1 = other2 = ranging3 = rangingAborted4 = rangingComplete5 = ipComplete6 = registrationComplete7 = accessDenied · Integer32

Reference: Data over Cable Radio Frequency Interface Specification, Chapter 7.2.

Current subscriber unit connectivity state, as specified in the RF Interface Specification. Returned status information is the SU status as assumed by the HE, and indicates the following events: other(1) Any state other than below. ranging(2) The HE has received an Initial Ranging Request message from the SU, and the ranging process is not yet complete. rangingAborted(3) The HE has sent a Ranging Abort message to the SU. rangingComplete(4) The HE has sent a Ranging Complete message to the SU. ipComplete(5) The HE has received a DHCP reply message and forwarded it to the SU. registrationComplete(6) The HE has sent a Registration Response message to the SU. accessDenied(7) The HE has sent a Registration Aborted message to the SU. The HE only needs to report states it is able to detect.

InterfaceIndexA 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 remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

The HE MAC interface index (ifType of propDocsWirelessMacLayer(nnn)) that SU connects to.

INTEGER (1..16383) · Integer32

The SU's primary Service ID.

INTEGER (1..16383) · Integer32

Identifies a service queue for upstream bandwidth. The attributes of this service queue are shared between the Subscriber unit and the Head-end System. The HE allocates upstream bandwidth to this service queue based on requests from the SU and on the class of service associated with this queue.

INTEGER (0..2147483647) · Integer32

Pointer to an entry in cwdIfHeSuStatusTable identifying the Subscriber unit using this Service Queue.

INTEGER1 = enabled2 = disabled3 = destroyed · Integer32

Allows a service class for a particular modem to be suppressed, (re-)enabled, or deleted altogether.

INTEGER (0..16383) · Integer32

The index in cwdIfQosProfileTable describing the quality of service attributes associated with this particular service. If cwdIfQosProfileTable is not supported, this object returns the value of zero.

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 when this entry was created.

Counter32

The cumulative number of Packet Data octets received on this Service ID. The count does not include the size of the Wireless MAC header

Counter32

The cumulative number of Packet Data packets received on this Service ID.