VendorSoftwareFlowdat3
/
docsis


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
							<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>DOCSIS Configuration File Format</title>

<style type="text/css">
/*<![CDATA[*/
    .mandatory {
        color: red;
        font-weight: bold;
    }
/*]]>*/
</style>
</head>
<body>
<h1>Configuration File Format</h1>
<p>The configuration file format somewhat resembles a C program. It
is designed to be easily readable and easily "parseable".</p>
<p>The general format is the following:<br /></p>
<pre>
Main {
</pre>
<pre style="padding-left: 0.5in;">
Setting;
</pre>
<pre style="padding-left: 0.5in;">
Setting;
</pre>
<pre style="padding-left: 0.5in;">
...
</pre>
<pre style="padding-left: 0.5in;">
AggregateSetting {
</pre>
<pre style="padding-left: 1.0in;">
SubSetting;
</pre>
<pre style="padding-left: 1.0in;">
SubSetting;
</pre>
<pre style="padding-left: 0.5in;">
}
</pre>
<pre>
}
</pre>
<p>A configuration setting is generally a Label and a Value. For
example:</p>
<pre>
NetworkAccess 1
</pre>
<pre>
SnmpMibObject sysDescr.0 String "Misc Cable Modem"
</pre>
<p>Each configuration setting has to be terminated by the ";"
character.</p>
<p>The list of <a href="config-settings.html">DOCSIS Configuration Settings</a>
may also be helpful.</p>
<h2>Examples</h2>
<h3>DOCSIS 1.0</h3>
<p>The parts <span style=
"color: rgb(204, 0, 0); font-weight: bold;">marked</span> are
mandatory.</p>
<pre>
<span class="mandatory">Main
{
        NetworkAccess 1;</span>
        MaxCPE 3;
        <span class="mandatory">ClassOfService
        {
                ClassID 1;</span>
                MaxRateDown 512000;
                MaxRateUp 256000;
                <span class="mandatory">PrivacyEnable 0;
        }</span>
        SnmpMibObject sysDescr.0 String "Misc Cable Modem";
        SnmpWriteControl .1.3.6.1 0;
<span class="mandatory">}</span>
</pre>
<p>In this example, we just allow the cable modem to pass traffic
to the cable network (NetworkAccess 1) and then we give it a basic
class of service with a limit of 512 kbps downstream and 256 kbps
upstream. Baseline Privacy (encryption) is disabled.<br /></p>
<h3>DOCSIS 1.1</h3>
<pre>
Main
{
        NetworkAccess 1;
        MaxCPE 3;
        UsServiceFlow
        {
                UsServiceFlowRef 1;
                QosParamSetType 7;
                TrafficPriority 1;
                MaxRateSustained 256000;
                MaxTrafficBurst 1522;
                RequestOrTxPolicy 0x00000018;
        }
        DsServiceFlow
        {
                DsServiceFlowRef 101;
                QosParamSetType 7;
                TrafficPriority 1;
                MaxRateSustained 512000;
        }
        GlobalPrivacyEnable 0;
        SnmpMibObject sysDescr.0 String "Misc Cable Modem";
        SnmpWriteControl .1.3.6.1 0;
}
</pre>
<p>This file is similar to the one above, except that we have
replaced the ClassOfService with two service flows - one upstream,
one downstream.&nbsp; Also the BaselinePrivacy setting is now a
global configuration setting (and is only recognized by DOCSIS 1.1
cable modems).</p>
<h3>PacketCable Configuration Files</h3>
<p>MTA config files have to start and end with the
MtaConfigDelimiter configuration setting (with values of "1" and
255).</p>
<pre>
Main {
        MtaConfigDelimiter 1;
        SnmpMibObject pktcDevMtaEnabled.0 Integer 1;
        ...
        MtaConfigDelimiter 255;
}
</pre>
<h3>Complex Configuration File</h3>
<p>This configuration file is NOT useable. It is only described
here as a reference and to make the reader more familiar with the
format.</p>
<pre>
Main
{
        DsPacketClass
        {
                ClassifierRef 255;
                ClassifierId 65535;
                ServiceFlowRef 65535;
                ServiceFlowId 2147483647;
                RulePriority 255;
                ActivationState 1;
                IpPacketClassifier
                {
                        IpTos 0x00ffff;
                        IpProto 234;
                        IpSrcAddr 10.1.2.3;
                        IpSrcMask 255.255.0.0;
                        IpDstAddr 10.5.2.5;
                        IpDstMask 255.255.0.0;
                        SrcPortStart 80;
                        SrcPortEnd 81;
                        DstPortStart 500;
                        DstPortEnd 501;
                }
        }
        UsPacketClass
        {
                ClassifierRef 253;
                ClassifierId 65533;
                ServiceFlowRef 65533;
                ServiceFlowId 2147483645;
                RulePriority 255;
                ActivationState 1;
                LLCPacketClassifier
                {
                        DstMacAddress 00:00:de:ad:be:ef/00:00:ff:ff:ff:ff;
                        SrcMacAddress 00:a0:a0:a0:a0:a0;
                        EtherType 0x030303;
                }
        }
        DsServiceFlow
        {
                DsServiceFlowRef 65535;
                DsServiceFlowId 2147483647;
                TrafficPriority 6;
                MaxRateSustained 3421234;
                MaxTrafficBurst 564343;
                MaxDsLatency 7856345;
        }
        UsServiceFlow
        {
                UsServiceFlowRef 65533;
                UsServiceFlowId 2147483645;
                TrafficPriority 6;
                MaxRateSustained 3421234;
                MaxTrafficBurst 564343;
                SchedulingType 3;
                MaxConcatenatedBurst 34534;
                ToleratedGrantJitter 4653512;
        }
        NetworkAccess 1;
        DownstreamFrequency 123000000;
        UpstreamChannelId 1;
        ClassOfService
        {
                ClassID 1;
                MaxRateDown 512000;
                MaxRateUp 64000;
                PriorityUp 3;
                GuaranteedUp 32000;
                MaxBurstUp 254;
        }
        BaselinePrivacy
        {
                AuthTimeout 10;
                ReAuthTimeout 10;
                AuthGraceTime 600;
                OperTimeout 10;
                ReKeyTimeout 10;
                TEKGraceTime 600;
                AuthRejectTimeout 9;
                SAMapWaitTimeout 1;
                SAMapMaxRetries 4;
        }
        DocsisTwoEnable 1;
        GenericTLV TlvCode 16 TlvLength 4 TlvValue 0xc0a8fe43;
        SnmpV3Kickstart
        {
                SnmpV3SecurityName "2adfla6";
        }
        SnmpV3TrapReceiver
        {
                SnmpV3TrapRxIP 10.0.1.253;
                SnmpV3TrapRxPort 56790;
                SnmpV3TrapRxType 2;
                SnmpV3TrapRxTimeout 500;
                SnmpV3TrapRxRetries 3;
                SnmpV3TrapRxSecurityName "2adfla6";
                SnmpV3TrapRxFilterOID .1.3.6.1;
        }
        SnmpWriteControl .1.3.6.1 1 ;
        SnmpMibObject sysContact.0 String "evvolve@users.sourceforge.net" ;
        SnmpMibObject sysName.0 String "DCM105 test" ;
        SnmpMibObject docsDevFilterIpDefault.0 Integer 1; /* discard */
        SnmpMibObject docsDevFilterIpStatus.1 Integer 6; /* destroy */
        SnmpMibObject docsDevFilterIpControl.1 Integer 2; /* accept */
        SnmpMibObject docsDevFilterIpIfIndex.1 Integer 0 ;
        SnmpMibObject docsDevFilterIpDirection.1 Integer 3; /* both */
        SnmpMibObject docsDevFilterIpBroadcast.1 Integer 2; /* false */
        SnmpMibObject docsDevFilterIpSaddr.1 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpSmask.1 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDaddr.1 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDmask.1 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpProtocol.1 Integer 1 ;
        SnmpMibObject docsDevFilterIpStatus.1 Integer 4; /* createAndGo */
        SnmpMibObject docsDevFilterIpStatus.2 Integer 6; /* destroy */
        SnmpMibObject docsDevFilterIpControl.2 Integer 2; /* accept */
        SnmpMibObject docsDevFilterIpIfIndex.2 Integer 0 ;
        SnmpMibObject docsDevFilterIpDirection.2 Integer 3; /* both */
        SnmpMibObject docsDevFilterIpBroadcast.2 Integer 2; /* false */
        SnmpMibObject docsDevFilterIpSaddr.2 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpSmask.2 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDaddr.2 IPAddress 10.1.1.1 ;
        SnmpMibObject docsDevFilterIpDmask.2 IPAddress 255.255.255.255 ;
        SnmpMibObject docsDevFilterIpProtocol.2 Integer 6 ;
        SnmpMibObject docsDevFilterIpStatus.2 Integer 4; /* createAndGo */
        SnmpMibObject docsDevFilterIpStatus.3 Integer 6; /* destroy */
        SnmpMibObject docsDevFilterIpControl.3 Integer 2; /* accept */
        SnmpMibObject docsDevFilterIpIfIndex.3 Integer 0 ;
        SnmpMibObject docsDevFilterIpDirection.3 Integer 3; /* both */
        SnmpMibObject docsDevFilterIpBroadcast.3 Integer 2; /* false */
        SnmpMibObject docsDevFilterIpSaddr.3 IPAddress 10.1.1.1 ;
        SnmpMibObject docsDevFilterIpSmask.3 IPAddress 255.255.255.255 ;
        SnmpMibObject docsDevFilterIpDaddr.3 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDmask.3 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpProtocol.3 Integer 6 ;
        SnmpMibObject docsDevFilterIpStatus.3 Integer 4; /* createAndGo */
        SnmpMibObject docsDevFilterIpStatus.4 Integer 6; /* destroy */
        SnmpMibObject docsDevFilterIpControl.4 Integer 2; /* accept */
        SnmpMibObject docsDevFilterIpIfIndex.4 Integer 0 ;
        SnmpMibObject docsDevFilterIpDirection.4 Integer 3; /* both */
        SnmpMibObject docsDevFilterIpBroadcast.4 Integer 1; /* true */
        SnmpMibObject docsDevFilterIpSaddr.4 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpSmask.4 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDaddr.4 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDmask.4 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpProtocol.4 Integer 17 ;
        SnmpMibObject docsDevFilterIpStatus.4 Integer 4; /* createAndGo */
        SnmpMibObject docsDevFilterIpStatus.5 Integer 6; /* destroy */
        SnmpMibObject docsDevFilterIpControl.5 Integer 2; /* accept */
        SnmpMibObject docsDevFilterIpIfIndex.5 Integer 0 ;
        SnmpMibObject docsDevFilterIpDirection.5 Integer 3; /* both */
        SnmpMibObject docsDevFilterIpBroadcast.5 Integer 2; /* false */
        SnmpMibObject docsDevFilterIpSaddr.5 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpSmask.5 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDaddr.5 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDmask.5 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpProtocol.5 Integer 17 ;
        SnmpMibObject docsDevFilterIpStatus.5 Integer 4; /* createAndGo */
        SnmpMibObject docsDevFilterIpStatus.6 Integer 6; /* destroy */
        SnmpMibObject docsDevFilterIpControl.6 Integer 2; /* accept */
        SnmpMibObject docsDevFilterIpIfIndex.6 Integer 0 ;
        SnmpMibObject docsDevFilterIpDirection.6 Integer 3; /* both */
        SnmpMibObject docsDevFilterIpBroadcast.6 Integer 2; /* false */
        SnmpMibObject docsDevFilterIpSaddr.6 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpSmask.6 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDaddr.6 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpDmask.6 IPAddress 0.0.0.0 ;
        SnmpMibObject docsDevFilterIpProtocol.6 Integer 6 ;
        SnmpMibObject docsDevFilterIpSourcePortLow.6 Integer 53 ;
        SnmpMibObject docsDevFilterIpSourcePortHigh.6 Integer 53 ;
        SnmpMibObject docsDevFilterIpDestPortLow.6 Integer 53 ;
        SnmpMibObject docsDevFilterIpDestPortHigh.6 Integer 53 ;
        SnmpMibObject docsDevFilterIpStatus.6 Integer 4; /* createAndGo */
        SnmpMibObject enterprises.19.20.21.22.23.24 Integer -3 ;
        SnmpMibObject enterprises.19.20.21.22.23.24 Integer -1 ;
        SnmpMibObject enterprises.19.30.31.32.33.34 HexString 0x98ffc00ffc00fffff000000000000000 ;
        SnmpMibObject enterprises.19.30.1.1.25.1.3.5 Gauge32 250000000 ;
        SwUpgradeFilename "example.bin";
        SwUpgradeServer 10.1.1.1;
        CpeMacAddress 00:00:de:ad:be:ef;
        MaxCPE 3;
}
</pre>
</body>
</html>