DOCSIS config file-Configuration-File-Specific Settings

DOCSIS config file-Configuration-File-Specific Settings

1: End-of-Data Marker

This is a special marker for end of data. It has no length or value fields.
Type
255

2: Pad Configuration Setting

This has no length or value fields and is only used following the end of data marker to pad the file to an integral
number of 32-bit words.
Type
0

3: Software Upgrade Filename

This is the file name of the software upgrade file for the CM. The file name is a fully qualified directory-path name.
The file is expected to reside on a TFTP server identified in a configuration setting option defined in Annex D.1.2.
See also Section 12.1.
Type Length Value
9 N filename

4: SNMP Write-Access Control

This object makes it possible to disable SNMP "Set" access to individual MIB objects. Each instance of this object
controls access to all of the writeable MIB objects whose Object ID (OID) prefix matches. This object may be
repeated to disable access to any number of MIB objects.

Type Length Value
10 N OID prefix plus control flag

Where N is the size of the ASN.1 Basic Encoding Rules [ISO/IEC 8825-1] encoding of the OID prefix plus one
byte for the control flag.

The control flag may take values:
0 - allow write-access
1 - disallow write-access

Any OID prefix may be used. The Null OID 0.0 may be used to control access to all MIB objects. (The OID 1.3.6.1
will have the same effect.)

When multiple instances of this object are present and overlap, the longest (most specific) prefix has precedence.
Thus, one example might be:
someTable: disallow write-access
someTable.1.3: allow write-access
This example disallows access to all objects in someTable except for someTable.1.3.

Enhanced access control for cable modem MIB objects is provided by the SNMPv3 Access View Configuration
encoding ,therefore this object is deprecated.

 If the configuration file does not contain one or more SNMPv3 Access View Configuration encodings, the CM MAY

 silently ignore SNMP Write-Access Control encodings.

If the configuration file contains one or more SNMPv3 Access View Configuration encodings, the CM
MUST silently ignore SNMP Write-Access Control encodings. 447

5: SNMP MIB Object

    This object allows arbitrary SNMP MIB objects to be Set via the TFTP-Registration process.

 Type Length Value
11 N variable binding

    The value is an SNMP VarBind as defined in [RFC 1157]. The VarBind is encoded in ASN.1 Basic Encoding
Rules, just as it would be if part of an SNMP Set request.

    The cable modem MUST treat this object as if it were part of an SNMP Set Request with the following caveats:

• The request is treated as fully authorized (it cannot refuse the request for lack of privilege).
• SNMP Write-Control provisions (see Annex C.1.2.4) do not apply.
• No SNMP response is generated by the CM.

This object may be repeated with different VarBinds to "Set" a number of MIB objects. All such Sets MUST be
treated by the CM as if simultaneous.

Each VarBind must be limited to 255 bytes.

6: CPE Ethernet MAC Address

This object configures the CM with the Ethernet MAC address of a CPE device (see Section 9.1.2.1). This object
may be repeated to configure any number of CPE device addresses.
Type Length Value
14 6 Ethernet MAC Address of CPE

7: Software Upgrade IPv4 TFTP Server

The IPv4 address of the TFTP server on which the software upgrade file for the CM resides. See Section 12.1 and
Annex C.1.2.3.
Type Length Value
21 4 TFTP Server's IPv4 Address

8: Software Upgrade IPv6 TFTP Server

The IPv6 address of the TFTP server on which the software upgrade file for the CM resides. See Section 12.1 and
Annex C.1.2.3.
Type Length Value
58 16 TFTP Server's IPv6 Address

14: SNMPv3 Access View Configuration

This object specifies the SNMPv3 Simplified Access View configuration of the CM. This object does not preclude
using TLV-11 to configure directly SNMPv3 tables. This TLV creates entries in SNMPv3 tables as specified in

[DOCSIS OSSIv3.0].

The CM MUST reject the config file if the SNMPv3 Access View Configuration encoding is present but the
SNMPv3 Access View Name sub-TLV is not present. 

The CM MUST support multiple TLVs with the same SNMPv3 Access View Name TLV.

The CM MUST reject the config file if more than one sub-TLV is included in a TLV.

The CM MUST reject the config file if a CM created entry in a SNMP table is rejected for Syntax conflicts or
reaches the limit in the number of entries the CM support for that table or the mapped SNMPv3 entry already exist.

The CM MUST reject the config file if the TLV has an invalid length, or if any of the sub-TLVs have an invalid
length or value.

Type Length Value
54 N Composite

NOTE: The number of entries a CM can support in SNMPv3 tables is independent of the number of
TLVs the CM must support to be processed as SNMP tables entries.

SNMPv3 Access View Name
This sub-TLV specifies the administrative name of the View defined by this TLV.457
Type Length Value
54.1 1..32 Text

SNMPv3 Access View Subtree
This sub-TLV specifies an ASN.1 formatted object Identifier that represents the filter sub-tree included in the
Access View TLV. The CM MUST accept only encoded values that start with the ASN.1 Universal type 6 (Object
Identifier) byte, then the ASN.1 length field, then the ASN.1 encoded object identifier components. For example the
sub-tree 1.3.6 is encoded as 0x06 0x02 0x2B 0x06. If this sub-TLV is not included in the TLV the CM MUST use
as default the OID sub-tree 1.3.6.
Type Length Value
54.2 N OID

The CM MUST assign default OID value 1.3.6 to SNMPv3 Access View Subtree if TLV 54 is present but sub-TLV
54.2 is not included.

SNMPv3 Access View Mask
This sub-TLV specifies the bit mask to apply to the Access View Subtree of the Access View TLV
Type Length Value
54.3 0..16 Bits

The CM MUST assign a zero-length string to SNMPv3 Access View Mask TLV 54.3 if TLV 54 is present but this
sub-TLV is not included

SNMPv3 Access View Type
This sub-TLV specifies the inclusion or exclusion of the sub-tree indicated by SNMPv3 Access View Subtree sub-
TLV 54.2 in the SNMPv3 Access View Configuration TLV 54. The value 1 indicates the sub-tree of SNMPv3
Access View SubTree is included in the Access View. The value 2 indicates the sub-tree of SNMPv3 Access View
Sub Tree is excluded from the Access View.
Type Length Value
54.4 1 1 included
2 excluded
The CM MUST assign the value included to SNMPv3 Access View Type sub-TLV 54.4 if TLV 54 is present but
this sub-TLV is not included.

15: SNMP CPE Access Control

If the value of this field is a 1, the CM MUST allow SNMP access from any CPE attached to it. If the value of this
field is a 0, the CM MUST NOT allow SNMP Access from any CPE attached to it.
Type Length Value
55 1 0 Disable
1 Enable
The CM MUST disable SNMP access from CPEs connected to the cable modem unless this TLV is present in the
config file with value equal to 1.