docsIfUpChannelStatus
DOCS-IF-MIB ·
.1.3.6.1.2.1.10.127.1.1.2.1.18
Object
This object is only used for the creation of a temporary
upstream row with the purpose of updating the parameters
of a physical upstream channel entry.
The following restrictions apply to this object:
1. This object is not writable for physical interfaces.
2. Temporary interface entries are only created by a SET
of this object to createandWait(5).
3. ifAdminStatus from the Interface MIB RFC 2863 is used
to take a physical upstream channel offline, to be
consistent with DOCSIS 1.x operation, as indicated in
RFC 2670.
In addition,
o ifAdminStatus 'down' is reflected in this object
as 'notInService'.
o ifOperStatus 'down' while ifAdminStatus 'up' is
reflected in this object as 'notInservice'.
4. Temporary created rows MUST be set to 'active' with
the purpose of validating upstream parameter
consistency prior to transferring the parameters to the
physical interface.
Below is a mandatory procedure for adjusting the values
of a physical interface:
1. Create a temporary interface entry through an SNMP SET
using 'createAndWait'. At this point, the RowStatus
reports 'notReady'.
The Manager entity uses an ifIndex value outside the
operational range of the physical interfaces for the
creation of a temporary interface.
2. Set the docsIfUpChannelCloneFrom object to the ifIndex
value of the physical row to update. Now
docsIfUpChannelStatus reports 'notInService'.
3. Change the upstream parameters to the desired values
in the temporary row.
4. Validate that all parameters are consistent by setting
docsIfUpChannelStatus to 'active'. A failure to set the
RowStatus to 'active' returns the error 'commitFailed',
which means the parameters are not compatible with the
target physical interface.
5. With docsIfUpChannelStatus 'active', transfer the
parameters to the target physical interface by setting
the object docsIfUpChannelUpdate to 'true'.
6. Delete the temporary row by setting
docsIfUpChannelStatus to 'destroy'.
Context
- MIB
- DOCS-IF-MIB
- OID
.1.3.6.1.2.1.10.127.1.1.2.1.18- Type
- column
- Access
- readwrite
- Status
- current
- Parent
- docsIfUpstreamChannelEntry
- Table
- docsIfUpstreamChannelTable
- Siblings
- 18
Values & Constraints
Type Values
1 | active |
2 | notInService |
3 | notReady |
4 | createAndGo |
5 | createAndWait |
6 | destroy |
Related Objects
Sibling Objects
| Object | Type | Syntax | OID |
|---|---|---|---|
| docsIfUpChannelId The CMTS identification of the upstream channel. | column | Integer32 | .1.3.6.1.2.1.10.127.1.1.2.1.1 |
| docsIfUpChannelTxBackoffEnd The final random backoff window to use when retrying
transmissions. Expressed as a power of 2. A value of 16
at the CMTS indicates that a proprietary adaptive retry
mechanism is… | column | Integer32 | .1.3.6.1.2.1.10.127.1.1.2.1.10 |
| docsIfUpChannelScdmaActiveCodes Applicable for SCDMA channel types only.
Number of active codes. Returns zero for
Non-SCDMA channel types. Note that legal
values from 64..128 MUST be non-prime. | column | Unsigned32 | .1.3.6.1.2.1.10.127.1.1.2.1.11 |
| docsIfUpChannelScdmaCodesPerSlot Applicable for SCDMA channel types only.
The number of SCDMA codes per mini-slot.
Returns zero if the value is undefined or unknown or in
case of a TDMA or ATDMA ch… | column | codesperMinislots Integer32 | .1.3.6.1.2.1.10.127.1.1.2.1.12 |
| docsIfUpChannelScdmaFrameSize Applicable for SCDMA channel types only.
SCDMA Frame size in units of spreading intervals.
This value returns zero for non-SCDMA Profiles. | column | spreadIntervals Unsigned32 | .1.3.6.1.2.1.10.127.1.1.2.1.13 |
| docsIfUpChannelScdmaHoppingSeed Applicable for SCDMA channel types only.
15-bit seed used for code hopping sequence initialization.
Returns zero for non-SCDMA channel types.
Setting this value to a value differe… | column | Unsigned32 | .1.3.6.1.2.1.10.127.1.1.2.1.14 |
| docsIfUpChannelType Reflects the Upstream channel type.
This object returns the value of docsIfCmtsModChannelType
for the modulation profile selected in
docsIfUpChannelModulationProfile for this row. | column | DocsisUpstreamType | .1.3.6.1.2.1.10.127.1.1.2.1.15 |
| docsIfUpChannelCloneFrom This object contains the ifIndex value of the physical
interface row entry whose parameters are to be adjusted.
Upon setting this object to the ifIndex value of a
p… | column | IF-MIBInterfaceIndexOrZero | .1.3.6.1.2.1.10.127.1.1.2.1.16 |
| docsIfUpChannelUpdate Used to perform the copy of adjusted parameters from the
temporary interface entry to the physical interface
indicated by the docsIfUpChannelCloneFrom object. The
transfer is ini… | column | SNMPv2-TCTruthValue | .1.3.6.1.2.1.10.127.1.1.2.1.17 |
| docsIfUpChannelPreEqEnable At the CMTS, this object is used to enable or disable
pre-equalization on the upstream channel represented by
this table instance. At the CM, this object is read-only
and reflect… | column | SNMPv2-TCTruthValue | .1.3.6.1.2.1.10.127.1.1.2.1.19 |
| docsIfUpChannelFrequency The center of the frequency band associated with this
upstream interface. This object returns 0 if the frequency
is undefined or unknown. Minimum permitted upstream
frequency is… | column | hertz Integer32 | .1.3.6.1.2.1.10.127.1.1.2.1.2 |
| docsIfUpChannelWidth The bandwidth of this upstream interface. This object
returns 0 if the interface width is undefined or unknown.
Minimum permitted interface width is currently 200,000 Hz.
See the… | column | hertz Integer32 | .1.3.6.1.2.1.10.127.1.1.2.1.3 |
| docsIfUpChannelModulationProfile An entry identical to the docsIfModIndex in the
docsIfCmtsModulationTable that describes this channel.
This channel is further instantiated there by a grouping
of interval usage c… | column | SNMPv2-SMIUnsigned32 | .1.3.6.1.2.1.10.127.1.1.2.1.4 |
| docsIfUpChannelSlotSize Applicable to TDMA and ATDMA channel types only.
The number of 6.25 microsecond ticks in each upstream
mini-slot. Returns zero if the value is undefined or
unknown or in case of … | column | ticks SNMPv2-SMIUnsigned32 | .1.3.6.1.2.1.10.127.1.1.2.1.5 |
| docsIfUpChannelTxTimingOffset At the CM, a measure of the current round trip time
obtained from the ranging offset (initial ranging offset +
ranging offset adjustments).
At the CMTS, the maximum of timing offs… | column | SNMPv2-SMIUnsigned32 | .1.3.6.1.2.1.10.127.1.1.2.1.6 |
| docsIfUpChannelRangingBackoffStart The initial random backoff window to use when retrying
Ranging Requests. Expressed as a power of 2. A value of
16 at the CMTS indicates that a proprietary adaptive retry
mechani… | column | Integer32 | .1.3.6.1.2.1.10.127.1.1.2.1.7 |
| docsIfUpChannelRangingBackoffEnd The final random backoff window to use when retrying
Ranging Requests. Expressed as a power of 2. A value of
16 at the CMTS indicates that a proprietary adaptive retry
mechanism… | column | Integer32 | .1.3.6.1.2.1.10.127.1.1.2.1.8 |
| docsIfUpChannelTxBackoffStart The initial random backoff window to use when retrying
transmissions. Expressed as a power of 2. A value of 16
at the CMTS indicates that a proprietary adaptive retry
mechanism … | column | Integer32 | .1.3.6.1.2.1.10.127.1.1.2.1.9 |