Cisco Broadband Access Center Administrator Guide 4.0

Configuration Templates Management

This chapter details the templates that Broadband Access Center (BAC) supports for device configuration and device management. This chapter features:

•Template Files-An Overview

•Template Grammar

–SNMP VarBind

–Macro Variables

–SNMP TLVs

–Encoding Types for Defined Options

•Using the Configuration File Utility

Template Files-An Overview

BAC uses templates to help you deploy dynamic PacketCable, DOCSIS, and CableHome files. Using templates, you can create a template file in an easily readable format, and edit it quickly and simply. A template is an ASCII text file that represents the PacketCable, DOCSIS, or CableHome options and values used for generating a valid PacketCable, DOCSIS, or CableHome file. BAC uses the .tmpl extension to identify template files. You must add template files to the RDU as a file using the administrator user interface or the application programming interface (API), before any Class of Service can reference it.

When installing the BAC RDU component, several sample template files are copied to the BPR_HOME/rdu/templates directory.

Although all that you need to create or edit a template is a simple text editor, before attempting to create your own template file, you should thoroughly familiarize yourself with this information:

•BAC provisioning flows

•DOCSIS 1.0, 1.1, 2.0, and 3.0 RFI specifications

•DOCSIS Layer 2 Virtual Private Networks specification

•PacketCable 1.0, 1.1, and 1.5 specifications

•Multimedia Terminal Adapter (MTA) device provisioning specification

•CableHome 1.0 specification

•SNMP MIBs for cable devices (for example, DOCS-CABLE-DEVICE-MIB)

Template Grammar

A template comprises the following types of statements:

•Comments

•Includes

•Options

•Instance Modifier

•OUI Modifier

Comments allow you to document your templates. Includes allow you to create building block templates to be used in other templates. You use options to specify the PacketCable, DOCSIS, or CableHome type length value (TLV) in a descriptive manner. You can use instance modifiers to group compound options into specific individual TLVs. The OUI modifier allows you to include vendor-specific information. Table 5-1 describes the available template grammar options.

Comments

Comments provide information only and are always located between the pound (#) symbol and the end of a line. Example 5-1 shows sample comment usage.

Example 5-1 Sample Comment Usage

#

# Template for gold service

#

option 3 1 # enabling network access

Includes

Include files let you build a hierarchy of similar, but slightly different, templates. This is very useful for defining options that are common across many service classes without having to duplicate the options in several templates.

You can use multiple include statements in a single template, although the location of the include statement in the template is significant: The contents of the include file are included wherever the include statement is found in the template. The included template must be added as a file to the RDU before it can be used. The included file must not contain any location modifiers such as ../.. because the templates are stored without path information in the RDU database. Example 5-2 and Example 5-3 illustrate both correct and incorrect usage of the include option.

Example 5-2 Correct Include Statement Usage

# Valid, including common options

include "common_options.tmpl"

Example 5-3 Incorrect Include Statement Usage

# Invalid, using location modifier

include "../common_options.tmpl"

# Invalid, using incorrect file suffix

include "common_options.common"

# Invalid, not using double quotes

include common_options.tmpl

Options

PacketCable, DOCSIS, and CableHome configuration files consist of properly encoded option ID-value pairs. Two forms of options are supported: defined and custom.

•Well-defined options require the option number and value. The value is encoded based on the encoding type of the option number.

•Custom options require the option number, explicit value encoding type, and the value.

When using compound options, for example, Option 43, you can use the instance modifier to specify the TLV groupings. See Instance Modifier.

When specifying one of these well-defined options in a template, it is not necessary to specify a value encoding for the value. For additional information on these defined encoding types, see Encoding Types for Defined Options, and DOCSIS Option Support, page B-1.

When specifying custom options (for example, Option 43), you must specify the encoding type for the option. The available encoding types are:

•ASCII— ASCII type encodes any given value as an ASCII string without a NULL terminator. If the value contains spaces, they must be enclosed in double quotation marks.

•hex—The value must be valid hexadecimal and there must be exactly 2 characters for each octet. If 01 is specified as the value, then exactly one octet is used in the encoding. If 0001 is specified as the value, then exactly two octets are used in the encoding process.

•IP address—IP address type encodes any given value as 4 octets. For example, the IP address 10.10.10.1 is encoded as 0A0A0A01.

•SNMPVarBind—An SNMP OID string, type, and value. Each of these is comma separated.

Use a comma to separate multivalued options on a given line. Each value is treated separately, so you might have to enclose one of the values in double quotation marks, but not the others. A good example of a multivalued option is Option 11 (SNMP VarBind). See SNMP VarBind, for additional information.

When specifying compound options, there is no need to specify the top-level option (for example Option 4 when specifying Option 4.1). Example 5-4 and Example 5-5 illustrate both correct and incorrect usage of the option statement.

Example 5-4 Correct Option Statement Usage

# Valid, specifying the number for well known option 3 

option 3 1

# Valid, specifying the number for option 4 sub-option 1

option 4.1 1

# Valid, specifying a vendor option as hex

option 43.200 hex 00000C

# Valid, specifying a vendor option as ascii

option 43.201 ascii "enable log"

# Valid, specifying a vendor option as IP

option 43.202 ip 10.4.2.1

Example 5-5 Incorrect Option Statement Usage

# Invalid, using hex with incorrect hex separator

option 43.200 hex 00.00.0C

# Invalid, not using double quotes when needed

option 43.201 ascii enable log

# Invalid, not specifying IP address correctly

option 43.202 ip 10-10-10-1

# Invalid, specifying the description for option "Network Access Control"

option "Network Access Control" 1

# Invalid, specifying top level option

option 4 

Instance Modifier

The instance modifier is used to group compound options into specific individual Type-Length-Values (TLVs). Example 5-6 and Example 5-7 illustrate both correct and incorrect methods of creating separate TLVs. These are required to enable the IOS DOCSIS modem to interpret the IOS commands as two separate commands.

Example 5-6 Correct IOS Command Line Entries

# Valid, each IOS command gets its own TLV

option 43.8 instance 1 00-00-0C

option 43.131 instance 1 ascii "login"

option 43.8 instance 2 00-00-0C

option 43.131 instance 2 ascii "password cable"

Example 5-7 Incorrect IOS Command Line Entries

# Invalid, IOS commands are grouped into one TLV

option 43.8 00-00-0C

option 43.131 ascii "login"

option 43.131 ascii "password cable"

# Invalid, using instance on non-compound options

option 3 instance 1 1

Note The encoding type for Option 43.8 is an organizationally unique identifier (OUI). Unlike that shown in Example 5-4, this type only accepts an 00-00-0C format.

OUI Modifier

The OUI modifier enhances multi-vendor support using Option 43 and its suboptions.

In BAC 4.0, you can use a single template to specify various TLV 43s from many vendors. Example 5-8 specifies the OUI formats as XX-XX-XX, where:

•FF-FF-FF—Identifies the vendor ID to specify encoding for the DOCSIS general extension.

•00-00-0C—Identifies the Cisco vendor ID that specifies the Cisco-specific cable modem Option 43 and its suboptions.

Example 5-8 illustrates BAC support for L2VPN using a cable modem configuration file to classify upstream traffic for L2VPN. Using this template content, you can generate subTLVs:

•43.5.1 and 43.5.2.2 from the DOCSIS general extension encoding, using OUI=FF-FF-FF.

•43.1 from the Cisco-specific Option 43, using OUI=00-00-0C.

However, in order to comply with the DOCSIS specification, you must insert as the first subTLV for TLV 43 either:

•0xFFFFFF when using the DOCSIS extension field to encode general extension information.

•0x00000C when generating Cisco-specific subTLVs.

Example 5-8 Correct OUI Modifier Usage

# Upstream L2VPN Classifier Example

# This example shows how to classify upstream traffic from a specific CPE 

# onto an upstream L2VPN service flow, in which other CPE attached to 

# the cable modem forward to the non-L2VPN forwarder, as depicted below.

# This example also demonstrates that when using the DOCSIS extension 

# field (TLV 43) to encode general extension information (GEI), you do 

# not need to specify oui=FF-FF-FF. You only need to specify the OUI tag when 

# general extension encoding is not used and vendor-specific encoding is used.

# Upstream L2VPN Classifier Cable Modem Config File

# (43) Per-CM L2VPN Encoding

# GEI (43.8) Vendor ID : 0xFFFFFF for GEI

option 43.8 instance 1 ff-ff-ff

# GEI (43.5) for L2VPN Encoding

# GEI (43.5.1) VPNID Subtype

option 43.5.1  instance 1 0234560003

# GEI (43.5) for L2VPN Encoding

# GEI (43.5.2) IEEE 802.1Q Format Subtype

# VLAN ID 25

option 43.5.2.2 instance 1 25

# Cisco Specific Vendor Option Encodings

# (43.8) Vendor ID : 00-00-0C (Cisco Vendor ID)

option 43.8 instance 2 00-00-0C

# Cisco Vendor Specific option (43.1) 

# Static Downstream Frequency 

# Frequency 402750000

option 43.1 instance 2 oui 00-00-0C 402750000

# Cisco Specific Vendor Option Encodings

# (43.8) Vendor ID : 00-00-0C (Cisco Vendor ID)

option 43.8 instance 3 00-00-0C

# Cisco Vendor Specific option (43.3)

# Update Boot Monitor Image

# image name (boot_monitor_image.bin)

option 43.3 instance 3 oui 00-00-0C boot_monitor_image.bin

Example 5-9 and Example 5-10 illustrate incorrect usage of the OUI modifier.

Example 5-9 Incorrect OUI Modifier Usage

# Invalid, OUI tag needs to be present for each 43 suboption if/when general extension 

# encoding is not used and vendor-specific encoding is used.

option 43.8 00-00-0C

option 43.3 boot_monitor_image.bin

Example 5-10 Incorrect OUI Modifier Usage

# Invalid, when both OUI and instance modifier are used in authoring a template, 
# "instance" modifier needs to occur before "oui" modifier.

option 43.8 instance 1 00-00-0C

option 43.3 oui 00-00-0C instance 1 boot_monitor_image.bin

SNMP VarBind

You must use an object identifier (OID) when specifying DOCSIS Option 11, PacketCable Option 64, or CableHome Option 28. The MIB that contains the OID must be in one of the following MIBs loaded by the RDU. You must specify as much of the OID as needed to uniquely identify it. You can use the name or the number of the OID. The RDU automatically loads these MIBs:

•SNMPv2-SMI

•SNMPv2-TC

•CISCO-SMI

•CISCO-TC

•SNMPv2-MIB

•RFC1213-MIB

•IANAifType-MIB

•IF-MIB

DOCSIS MIBs

These DOCSIS MIBs are loaded into the RDU:

•DOCS-IF-MIB

•DOCS-BPI-MIB

•CISCO-CABLE-SPECTRUM-MIB

•CISCO-DOCS-EXT-MIB

•SNMP-FRAMEWORK-MIB

•DOCS-CABLE-DEVICE-MIB

•DOCS-CABLE-DEVICE-MIB-OBSOLETE

•CISCO-CABLE-MODEM-MIB

Two versions of the DOCS-CABLE-DEVICE MIB are loaded into the RDU:

•DOCS-CABLE-DEVICE-MIB-OBSOLETE (experimental branch)

•DOCS-CABLE-DEVICE-MIB (mib2 branch)

A fully qualified MIB OID (.experimental...) always uniquely identifies a MIB OID.

If you use a nonfully qualified MIB OID from DOCS-CABLE-DEVICE-MIB, it will always default to DOCS-CABLE-DEVICE-MIB and not DOCS-CABLE-DEVICE-MIB-OBSOLETE.

Example 5-11 and Example 5-12 illustrate using a fully qualified MIB OID and a nonfully qualified MIB OID.

Example 5-11 Fully Qualified MIB OID

# Valid, uniquely identifying an OID

option 11 .experimental.docsDev.docsDevMIBObjects.docsDevNmAccessTable.docsDevNmAccess 
Entry.docsDevNmAccessStatus.1, Integer, 4

Example 5-12 Nonfully Qualified MIB OID (Defaults to DOCS-CABLE-DEVICE-MIB)

# Valid, NonFully Qualified MIB OID. 

option 11 .docsDevNmAccessStatus.1, Integer, 4

If no DOCSIS CMs in a deployment require DOCS-CABLE-DEVICE-MIB-OBSOLETE, you can always use the shorter form of the MIB OID.

PacketCable MIBs

These PacketCable (North American) MIBs are loaded into the RDU:

•CLAB-DEF-MIB

•PKTC-MTA-MIB

•PKTC-SIG-MIB

•PKTC-EVENT-MIB

CableHome MIBs

These CableHome MIBs are loaded into the RDU:

•CABH-CAP-MIB

•CABH-CDP-MIB

•CABH-CTP-MIB

•CABH-PS-DEV-MIB

•CABH-QOS-MIB

•CABH-SEC-MIB

These additional MIBs are needed but are not part of the BAC product:

•CABH-CTP-MIB needs RMON2-MIB, TOKEN-RING-RMON-MIB

•CABH-SEC-MIB needs DOCS-BPI2-MIB.

Macro Variables

Macro variables are specified as values in templates that let you specify device-specific option values. When a macro variable is encountered in the template, the properties hierarchy is searched for the macro variable name and the value of the variable is then substituted. The variable name is a custom property, which is predefined in the RDU. It must not contain any spaces.

After the custom property is defined, it can be used in this property hierarchy:

•Device properties

•Provisioning Group properties

•Class of Service properties

•DHCP Criteria properties

•Technology defaults, such as PacketCable, DOCSIS, or CableHome

•System defaults

The template parser works bottom up when locating properties in the hierarchy (device first, then the Class of Service, and so on) and converts the template option syntax. The following syntax is supported for macro variables:

•${var-name}—This syntax is a straight substitution. If the variable is not found, the parser will generate an error.

•${var-name, ignore}—This syntax lets the template parser ignore this option if the variable value is not found in the properties hierarchy.

•${var-name, default-value}—This syntax provides a default value if the variable is not found in the properties hierarchy.

Example 5-13 and Example 5-14 illustrate correct and incorrect usage of Option 11.

Example 5-13 Correct Macro Variables Usage

# Valid, using macro variable for max CPE's, straight substitution

option 18 ${MAX_CPES}

# Valid, using macro variable for max CPE's, ignore option if variable not found

# option 18 will not be defined in the DOCSIS configuration file if MAX_CPES

# is not found in the properties hierarchy

option 18 ${MAX_CPES, ignore}

# Valid, using macro variable for max CPE's with a default value

option 18 ${MAX_CPES, 1}

# Valid, using macro variable for vendor option

option 43.200 hex ${MACRO_VAR_HEX}

# Valid, using macro variable for vendor option

option 43.201 ascii ${MACRO_VAR_ASCII}

# Valid, using macro variable for vendor option

option 43.202 ip ${MACRO_VAR_IP}

# Valid, using macro variable in double quotes

option 18 "${MAX_CPES}"

# Valid, using macro variable within a value

option 43.131 ascii "hostname ${HOSTNAME}"

# Valid, using macro variables in multi-valued options

option 11 ${ACCESS_CONTROL_MIB, 
.mib-2.docsDev.docsDevMIBObjects.docsDevNmAccessTable.docsDevNmAccessEntry.docsDevNmAccess
Control.1}, Integer, ${ACCESS_CONTROL_VAL, 3}

# Valid, using macro variable in an include statement

include "${EXTRA_TEMPLATE}"

# Valid, using macro variable in an include statement with a default value

include "${EXTRA_TEMPLATE, modem_reset.tmpl}"

# Valid, using macro variable in an include statement with a default value

include "${EXTRA_TEMPLATE, modem_reset}.tmpl"

# Valid, using macro variable in an include statement with an ignore clause

include "${MY_TEMPLATE, ignore}"

Example 5-14 Incorrect Macro Variables Usage

# Invalid, using macro variable as the option number

option ${MAX_CPES} 1

# Invalid, using macro variable with space in name

option 18 ${MAX CPES}

SNMP TLVs

BAC supports SNMP TLVs in dynamic template files, using Option 11 and 64, for:

•DOCSIS—From Broadband Access Center for Cable (BACC) version 2.0 onwards.

•PacketCable—From BACC version 2.5 onwards.

•CableHome—From BACC version 2.6 onwards.

To validate the syntax of the SNMP TLVs in these template files, BAC requires a MIB file containing the corresponding SNMP OID that is referenced in the SNMP TLV. If a template contains an SNMP TLV with an SNMP OID that cannot be found in a MIB, the SNMP TLV generates a syntax error.

The following sections describe how you can add SNMP TLVs without a MIB or with a vendor-specific MIB.

Adding SNMP TLVs Without a MIB

You can add SNMP TLVs in dynamic configuration files (DOCSIS, PacketCable, CableHome) without requiring the MIB be loaded by the RDU. From within RDU configuration extensions, the functionality can be accessed with the DOCSISOptionFactory interface, using the following method:

public OptionValue createOptionValue(OptionSyntax syntax, String optionNumStr, String[] 
optionValueList) 

The public OptionSyntax.SNMP enumerated value can be used in the above method, in conjunction with the optionValueList containing the tuple: OID, Type, Value.

From RDU dynamic configuration templates, the following syntax is used to specify SNMP TLVs that are not validated against the RDU MIBs:

option option-number snmp OID, Type, Value

Examples:

# DOCS-CABLE-DEVICE-MIB: 

option 11 snmp .docsDevNmAccessIp.1,IPADDRESS,192.168.1.1 

# Arris vendor specific SNMP TLV (OID numbers only, mix names/numbers) 

option 11 snmp .1.3.6.1.4.1.4115.1.3.1.1.2.3.2.0, INTEGER, 6 

option 11 snmp .enterprises.4115.1.3.1.1.2.3.2.0, INTEGER, 6

# NOTE: trailing colon required for single octet 

option 11 snmp .1.3.6.1.2.1.69.1.2.1.6.3, STRING, 'c0:' 

Table 5-2 describes the allowed SNMP variable type names.

For example, to specify an SMI Integer32 type, the following types are accepted (regardless of case sensitivity): Integer32, INTEGER.

For OCTET STRING type, all of the following types are accepted: OCTET STRING, OCTETSTRING, or STRING.

The custom SNMP TLV template option can be used to specify any SNMP TLV, including those that are present in the RDU MIBs. The custom SNMP TLV error checking is less stringent, and does not detect incorrect scalar/columnar references (for example, .0 versus .n in OID names).

Adding SNMP TLVs With Vendor-Specific MIBs

Adding a MIB to the RDU enables templates to use the human-readable SNMP OID while also permitting macro variables to be used with the SNMP TLV value.

BACC 2.6 or earlier

If you have the MIB corresponding to the SNMP OID that you want to use, you can add the MIB file to the BAC RDU. After you add the MIB, any SNMP TLV using an SNMP OID referenced in the new MIB is recognized.

To add a new MIB to the RDU:

Step 1 Copy the new MIB file to the BPR_HOME/rdu/mibs directory.

Step 2 Add the /docsis/mibs/custom/mibList property, whose value contains a comma-separated list of MIB filenames, to the:

a. rdu.properties file, which is used by the RDU and the administrator user interface. This file resides in the BPR_HOME/rdu/conf directory.

b. api.properties file, which the Configuration File Utility (runCfgUtil.sh tool) uses.

Note The api.properties file is not created during the BAC installation process. You must manually create this file for initial use, in any text editor. Ensure that you locate this file in the BPR_HOME/rdu/conf directory.

The api.properties file contains a /docsis/mibs/custom/mibList, which is configured for a set of MIBs that you can use in Arris embedded MTAs (eMTAs).

Step 3 Restart the RDU via the BAC process watchdog, using the /etc/init.d/bprAgent restart rdu command.

The following example describes the addition of ARRIS MIBs for use in templates to configure ARRIS MTAs.

Assume that you want to use an Arris vendor-specific SNMP TLV:

option 11 .ppCfgMtaCountryTemplate.0, INTEGER, 9

and the following MIB files were made available:

•ARRIS-MIB

•ARRIS-CM-CAPABILITY-MIB

•ARRIS-CM-DEVICE-MIB

•ARRIS-MTA-DEVICE-MIB

•PACKETPORT-MIB

You must copy the MIB files to the BPR_HOME/rdu/mibs directory, and insert the following property in the api.properties and rdu.properties files:

/docsis/mibs/custom/mibList=ARRIS-MIB,ARRIS-CM-CAPABILITY-MIB,ARRIS-CM-DEVICE-MIB,ARRIS-MTA-DEVICE-MIB,PACKETPORT-MIB

BACC 2.7 or later

Note The /docsis/mibs/custom/mibList property is renamed /snmp/mibs/mibList from BACC 2.7 onwards.

If you have the MIB corresponding to the SNMP OID that you want to use, you can add the MIB file to the BAC RDU. After you add the MIB, any SNMP TLV using an SNMP OID referenced in the new MIB is recognized.

To add a new MIB to the BAC RDU:

Step 1 Launch the BAC administrator user interface.

Step 2 On the navigation bar, click Configuration > Defaults.

Step 3 On the Configure Defaults page that appears, click the System Defaults link on the left pane.

Step 4 In the MIB List field, paste the content of the new MIB at the end.

Step 5 Click Submit.

Note In version 2.7 and later, the MIB parsing tool has been enhanced; subsequently, the tool sometimes returns errors on MIB versions that parsed without error previously. If you encounter any errors that you are unable to resolve by editing the new MIB, contact the Cisco Technical Assistance Center.

Debugging the MIB Load Order

Typically, vendors provide several MIBs requiring a specific load order to satisfy inter-MIB dependencies. But because the vendor frequently does not provide the correct load order, you must determine the correct load order yourself. This section describes how you can use BAC debugging information to resolve MIB load-order issues.

Note The MIB load order in BAC is set by the order in which the MIBs are listed in the:

•/docsis/mibs/custom/mibList property, if you are using BACC 2.6.x or earlier releases.

•/snmp/mibs/MibList property, if you are using BACC 2.7.x or later releases.

You can use the runCfgUtil.sh tool to determine the correct load order for the property specified in the api.properties file. The runCfgUtil.sh tool resides in the BPR_HOME/rdu/bin directory.

Note This procedure references the /snmp/mibs/MibList property that BACC 2.7.x or later releases use. If you are running 2.6.x or earlier releases, ensure that you use the /docsis/mibs/custom/mibList property.

Step 1 Configure runCfgUtil.sh via the api.properties file using configuration content similar to that described in this step. The api.properties file enables BAC tracing to direct MIB debugging information to the user console.

# 

# Enable logging to the console

#

/server/log/1/level=Info 

/server/log/1/properties=level 

/server/log/1/service=com.cisco.csrc.logging.SystemLogService 

/server/log/1/name=Console 

# 

# Enable trace categories 

#

/server/log/trace/rduserver/enable=enabled 

# 

# The list of MIBs to be added. 

# 

/snmp/mibs/MibList=arrishdr.mib,arris_cm_capability.mib,arris_mta_device.mib,arris_sip.mib
,arris_cm.mib,pp.mib,blp2.mib,dev0.mib,docs_evnt.mib,qos.mib,test.mib,usb.mib,snmpv2_conf.
mib,rfc1493.mib,rfc1907.mib,rfc2011.mib,rfc2013.mib,rfc2233.mib,rfc2571.mib,rfc2572.mib,rf
c2573.mib,rfc2574.mib,rfc2575.mib,rfc2576.mib,rfc2665.mib,rfc2669.mib,rfc2670.mib,rfc2786.
mib,rfc2851.mib,rfc2933.mib,rfc 3083.mib

Step 2 With runCfgUtil.sh so configured, run the tool to encode any template containing an Option 11 or Option 64 (SNMP encoding). The tool attempts to load the MIBs specified within /snmp/mibs/MibList, and directs the complete debugging information, along with any MIB load errors, to the user console.

Step 3 Use the error information to massage the MIB order specified within /snmp/mibs/MibList until the complete set of MIBs loads without error and the file encode succeeds.

Step 4 Once you determine a successful load order, complete the procedure described in this step based on the BACC version you are using:

BACC 2.7 or later

a. From the administrator user interface, click Configuration > Defaults, then the System Defaults link.

b. In the MIB List field, copy the load order information.

The RDU is now configured to encode templates using the vendor-supplied MIBs.

Note You do not need to restart the RDU.

Ensure that you use the /snmp/mibs/mibList string in the api.properties file and the MIB List field.

BACC 2.6 or earlier

a. Copy the load order information to the /docsis/mibs/custom/mibList property in the rdu.properties file. This file resides in the BPR_HOME/rdu/conf directory.

b. Restart the RDU via the BAC process watchdog, using the /etc/init.d/bprAgent restart rdu command.

The RDU is now configured to encode templates using the vendor-supplied MIBs.

Encoding Types for Defined Options

Table 5-3 identifies the options with defined encoding types.

0 

1 

permit 

deny

1 

2

included

excluded

1

2

Read-only

Read-write

0

1

Inactive

Active

0xFE

0xFFFF0000

0

1

000102030405060708

0

1

Disabled

Enabled

0

0

1

Disabled

Enabled

1,10.112.125.111

2,0:0:0:0:0:ffff:8190:3426

10.10.10.1

2001:db8:0:0:8:800:200c:417a

10.112.125.111

0:0:0:0:0:ffff:8190:3426

10.11.12.13,10.11.12.14

2001:db8:0:0:8:800:200c:417a,ff01
:0:0:0:0:0:0:101

00:01:02:03:04:05

00-01-02-03-04-05

00:01:02:03:04:05:06:07:08:09:0A:
0B

00-01-02-03-04-05-06-07-08-09-0A-
0B

null

This is an ASCII string

sysinfo.0

sysinfo.0,1

0

1

On

Off

00-00-0C

0 

4294967295

0

.experimental.docsDev.docsDevMIBO
bjects.docsDevNmAccessTable.docsD
evNmAccessEntry.docsDevNmAccessSt
atus.1, INTEGER, 4

0

12

12,14

10.112.125.111,5678

2001.db8.0.0.8.800.200c.417a,5678

2001:db8:0:0:8:800:200c:417a,5678

14

1244

3455335

3,12324

1,3

1,2,3

0 = verify

1 = don't verify

This is an ASCII string

BITS Value Syntax

When using the BITS type, you must specify either the labels ("interval1 interval2 interval3") or numeric bit location ("0 1 2"). Note that label values are 1-based and bit values are 0-based.

This is the syntax that uses the bit numbers:

option 11 .pktcSigDevR0Cadence.0,STRING,"0 1 2 3 4 5 6 7 8 9 10 11 12 13 14"

This is the syntax for the customer octet string (FFFE000000000000) that uses the labels:

option 11 .pktcSigDevR0Cadence.0,STRING,"interval1 interval2 interval3

interval4 interval5 interval6 interval7 interval8 interval9 interval10

interval11 interval12 interval13 interval14 interval15"

OCTETSTRING Syntax

The OCTETSTRING can be either a string that is converted to hexadecimal notation without a trailing NULL (for example, octet string), or hexadecimal notation contained within single quotation marks (for example, 'aa:bb:cc' ).

Using the Configuration File Utility

You use the configuration file utility to test, validate, and view PacketCable 1.0/1.1/1.5, DOCSIS 1.0/1.1/2.0/3.0, and CableHome template and configuration files. These activities are critical to successfully deploy individualized configuration files. See Template Files-An Overview, for more information on templates.

The configuration file utility is available only when the RDU is installed; the utility is installed in the BPR_HOME/rdu/bin directory.

Both the template file being encoded and the binary file being decoded must reside in the directory from which the configuration file utility is invoked.

All examples in this section assume that the RDU is operating and that these conditions apply:

•The BAC application is installed in the default home directory (/opt/CSCObac).

•The RDU login name is admin.

•The RDU login password is changeme.

Note Some of the examples in this section were trimmed whenever the omitted information is of no consequence to the example of its outcome. Instances where this occurs are identified by an ellipses (...) that precedes the example summary.

This section discusses these topics:

•Running the Configuration File Utility

•Adding a Template to BAC

•Converting a Binary File to a Template File

•Testing Template Processing for a Local Template File

•Testing Template Processing for an External Template File

•Specifying Macro Variables at the Command Line

•Specifying a Device for Macro Variables

•Specifying Output to a Binary File

•Viewing a Local Binary File

•Viewing an External Binary File

•Activating PacketCable Basic Flow

•Generating TLV 43s for Multivendor Support

Running the Configuration File Utility

In subsequent procedures and examples, the phrase "run the configuration file utility" means to enter the runCfgUtil.sh command from the directory specified. To run the configuration file utility, run this command from the BPR_HOME/rdu/bin directory:

runCfgUtil.sh options

The available options include:

•-c secret—Specifies the CMTS shared secret when parsing a DOCSIS template file. To specify the default shared secret, enter -c cisco.

•-cablehome—Identifies the input file as a CableHome portal service configuration file. Do not use this with either the -docsis or -pkt options.

•-d—Decodes the binary input file. Do not use this with the -e option.

•-docsis—Specifies the input file as a DOCSIS configuration file. Do not use this default with the -pkt option.

•-v version—Specifies the DOCSIS version being used. For example, if you are using DOCSIS 1.1, enter -v 1.1. If you do not specify the version number, the command defaults to use DOCSIS 2.0. The values that BAC supports are 1.0, 1.1, 2.0, and 3.0.

•-e—Encodes the template input file. Do not use this default with the -d option.

•-g—Generates a template file from either a DOCSIS, PacketCable, or CableHome binary file.

•-h host:port—Specifies the host and port. The default port number is 49187.

•-i device-id—Identifies the device to use when substituting macro variables during template parsing. For example, if the device MAC address is 1,6,00:00:00:00:00:01, enter -i 1,6,00:00:00:00:00:01, or if the device DUID is 00:03:00:01:00:18:68:52:75:c0, enter -i 00:03:00:01:00:18:68:52:75:c0. When using this option, you must also use the -u and -p options, respectively, to specify the username and password. Do not use this with the -m option.

•-l filename—Identifies the input file as being on the local file system. For example, if your input file is called any_file, enter -l any_file. Do not use this with the -r option.

•-loc—Specifies the PacketCable locale: na (North America) or euro (Europe). The default is na. If the MTA is euro-MTA, then the locale should be set to euro.

•-m macros—Specifies key value pairs for macro variables. The format is key=value. If you require multiple macro variables, use a double comma separator between the key value pairs; for example, key_1=value_1,,key_2=value_2. Do not use this with the -i option.

•-p password—Specifies the password to use when connecting to the RDU. For example, if your password is 123456, enter -p 123456.

•-o filename—Saves a parsed template file as a binary file. For example, if you want the output to be found in a file called op_file, enter -o op_file.

•-pkt—Identifies the input file as a PacketCable MTA configuration file. Do not use this with the -docsis option.

•-r filename—Identifies the input file as a remote file that has been added to the RDU. For example, if your file is called file25, enter -r file25. When using this option you must also use the -u and -p options, to specify the username and password, respectively. Do not use this with the -l option.

•-s—Displays the parsed template or the contents of the binary file in a human-readable format.

•-t—Specifies the PacketCable encoding type: Secure or Basic (the default is Secure).

•-u username—Specifies the username to use when connecting to the RDU. For example, if your username is admin, enter -u admin.

Note The configuration file utility does not include Option 19 (TFTP server timestamp) and Option 20 (TFTP server provisioned modem address) in the template file; the BAC TFTP mixing, however, does. Also, options 6 (CM MIC) and 7 (CMTS MIC) are both automatically inserted into the encoded template file. Therefore, you do not have to specify these message integrity checks (MICs).

Adding a Template to BAC

To use the configuration file utility to test BAC templates:

Step 1 Develop the template as described in Template Files-An Overview. If the template includes other templates, make sure all the referenced templates are in the same directory.

Step 2 Run the configuration file utility on the local file system. You can check the syntax for the template, or have the configuration file utility process the template as CRS would, and return output.

If the template contains macro variables, perform these operations in the order specified:

a. Test with command line substitution.

b. Test with a device that has been added to your RDU.

Step 3 Add the template (and any included templates that are used) to the RDU.

Step 4 Run the configuration file utility to parse a file. See Testing Template Processing for an External Template File.

If the template contains macro variables, perform these operations in the order specified:

a. Test with command-line substitution.

b. Test with a device that has been added to your RDU.

Step 5 After all tests succeed, configure a Class of Service to use the template.

Converting a Binary File to a Template File

Use the runCfgUtil.sh command to convert binary configuration memory files into template files. BAC dynamic configuration generation is based on templates that are created. Automatically converting existing, tested, binary files to template files speeds the process and reduces the possibility of introducing errors.

Syntax Description

runCfgUtil.sh -g -l binary_file -o template_file

•-g—Specifies that a template file needs to be generated from an input binary file

•-l binary_file—Specifies the local input file, including the pathname. In all cases, the input binary filename will have a .cm file extension; bronze.cm for example.

•-o template_file—Specifies the output template file, including the pathname. In all cases, the output template file will have a .tmpl file extension; for example, test.tmpl.

To convert a binary file into a template file:

Step 1 Change directory to /opt/CSCObac/rdu/samples/docsis.

Step 2 Select a template file to use. This example uses an existing binary file called unprov.cm.

Step 3 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -g -l unprov.cm -o test.tmpl -docsis

-docsis—Specifies the input file to be a DOCSIS configuration file.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

################################################################

## Template File Generator

## Generated on Fri Oct 12 16:12:51 EST 2007

################################################################

################################################################

## Each generated option will be represented by the following:

## The first line will represent a description of the

## generated option

## The second line will represent the generated option

## The third line will represent the custom version

## of the generated option

################################################################

# (3) Network Access Control

Option 3  01

# Option 3  hex 01

# (4.1) Class ID

Option 4.1 1

# Option 4.1 hex 01

# (4.2) Maximum Downstream Rate

Option 4.2 128000

# Option 4.2 hex 0001F400

# (4.3) Maximum Upstream Rate

Option 4.3 64000

# Option 4.3 hex 0000FA00

# (4.4) Upstream Channel Priority

Option 4.4 1

# Option 4.4 hex 01

# (4.5) Guaranteed Minimum Upstream Channel Data Rate

Option 4.5 0

# Option 4.5 hex 00000000

# (4.6) Maximum Upstream Channel Transmit Burst

Option 4.6 1600

# Option 4.6 hex 0640

# (4.7) Class-of-Service Privacy Enable

Option 4.7 00

# Option 4.7 hex 00

# (11) SNMP MIB Object

Option 11  
.iso.org.dod.internet.experimental.docsDev.docsDevMIBObjects.docsDevNmAccessTable.docsDevN
mAccessEntry.docsDevNmAccessStatus.1,INTEGER,createAndGo

# Option 11  hex 3082000F060A2B060103530102010701020104

...

# (18) Maximum Number of CPEs

Option 18  1

# Option 18  hex 01

Testing Template Processing for a Local Template File

Use the runCfgUtil.sh command to test processing for template files stored on the local file system.

Syntax Description

runCfgUtil.sh -pkt -l file

•-pkt—Identifies the input file as a PacketCable MTA file.

•-l—Specifies that the input file is on the local file system.

•file—Identifies the input template file being parsed.

To parse a template file that is on the local file system:

Step 1 Change directory to /opt/CSCObac/rdu/samples/packet_cable.

Step 2 Select a template file to use. This example uses an existing template file called unprov_packet_cable.tmpl. The -pkt option is used because this is a PacketCable MTA template.

Step 3 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -pkt -l unprov_packet_cable.tmpl

unprov_packet_cable.tmpl—Identifies the input template file being parsed.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Off

File Bytes

Option

Description

Value

0

FE0101

254

Telephony Config File Start/End

1

3

0B153013060E 
2B06010401A30B
0202010101 
0700020102

11

SNMP MIB Object

.iso.org.dod.internet.
private.enterprises.ca
bleLabs.clabProject.cl
abProjPacketCable.pktc
MtaMib.pktcMtaMibObjec
ts .pktcMtaDevBase. 
pktcMtaDevEnabled.0,IN
TEGER,false(2)

...

0 error(s), 0 warning(s) detected. Parsing of unprov_packet_cable.tmpl was successful.

The file unprov_packet_cable.tmpl was parsed successfully in 434 ms.

The parser initialization time was 92 ms.

The parser parse time was 342 ms.

Testing Template Processing for an External Template File

Use the runCfgUtil.sh command to test processing of external template files.

Syntax Description

runCfgUtil.sh -docsis -r file -u username -p password

•-r—Identifies the input file as a file that has been added to the RDU.

•file—Identifies the input template file being parsed.

•-u username—Specifies the username to use when connecting to the RDU.

•-p password— Specifies the password to use when connecting to the RDU.

•-docsis—Identifies the file as a DOCSIS template.

To parse a template file that has been added to the RDU:

Step 1 Select a template file to use. This example uses an existing template file called unprov.tmpl. The -docsis option is used because a DOCSIS template is being used.

Step 2 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -docsis -r unprov.tmpl -u admin -p changeme

•unprov.tmpl—Identifies the input file.

•admin—Identifies the username.

•changeme—Identifies the password.

After running the utility, results similar to these should appear:

Note The results shown here are for illustration only and have been trimmed for brevity.

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Off

File Bytes

Option

Description

Value

0

030101

3

Network Access Control 

On

3

041F 

4

Class of Service

5

010101

4.1

Class ID

1

8

02040000FA00

4.2

Maximum Downstream Rate 

128000 bits/sec

14

03040000FA00

4.3

Maximum Upstream Rate 

64000 bits/sec

20

040101

4.4

Upstream Channel Priority 

1

...

252

06108506547F

C9152B44DB95

5420843EF6FE

6

CM MIC Configuration Setting

8506547FC9152B44

DB955420843EF6FE

270

0710644B675B

70B7BD3E09AC

210F794A1E8F

7

CMTS MIC Configuration Setting

644B675B70B7BD3E

09AC210F794A1E8F

288

FF

255

End-of-Data Marker

289

00

0

PAD

290

00

0

PAD

291

00

0

PAD

0 error(s), 0 warning(s) detected. Parsing of unprov.tmpl was successful.

The file unprov.tmpl was parsed successfully in 375 ms.

The parser initialization time was 63 ms.

The parser parse time was 312 ms.

Testing Template Processing for a Local Template File and Adding Shared Secret

Use the runCfgUtil.sh command to test processing for a template file and add a shared secret that you specify.

Syntax Description

runCfgUtil.sh -e -docsis -l file -c secret

•-e—Identifies the encode option.

•-docsis—Identifies the input file as a DOCSIS template file.

•-l—Specifies that the input file is on the local file system.

•file—Identifies the input template file being parsed.

•-c—Specifies the CMTS shared secret when parsing a DOCSIS template file.

•secret—Identifies the new shared secret. The default shared secret is cisco.

To parse a locally saved template file, and set a user-specified shared secret:

Step 1 Change directory to /opt/CSCObac/rdu/templates.

Step 2 Select a template file to parse. This example uses an existing template file called unprov.tmpl. The -docsis option is used because this is a DOCSIS template.

Step 3 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -e -docsis -l unprov.tmpl -c shared

•unprov.tmpl—Identifies the input file on the local file system.

•shared—Identifies that new shared secret.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Off 

File Bytes

Option

 Description 

Value

0 

030100 

3 

Network Access Control 

Off

3 

041F 

4 

Class of Service

5 

010101 

4.1 

Class ID 

1

8

02040001F400 

4.2 

Maximum Downstream Rate 

128000 bits/sec

14

03040000FA00 

4.3 

Maximum Upstream Rate 

64000 bits/sec

20

040101 

4.4 

Upstream Channel Priority 

1

...

252 

06108506547F 
C9152B44DB95 
5420843EF6FE

6 

CM MIC Configuration Setting

8506547FC9152B44 
DB955420843EF6FE

270 

0710644B675B 
70B7BD3E09AC 
210F794A1E8F

7

CMTS MIC Configuration Setting

644B675B70B7BD3E 
09AC210F794A1E8F

288 

FF 

255 

End-of-Data Marker

289 

00 

0 

PAD

290 

00 

0 

PAD

291 

00 

0 

PAD

0 error(s), 0 warning(s) detected. Parsing of unprov.tmpl was successful.

The file unprov.tmpl was parsed successfully in 375 ms.

The parser initialization time was 63 ms.

The parser parse time was 312 ms.

Specifying Macro Variables at the Command Line

Use the runCfgUtil.sh command to specify macro variables.

Syntax Description

runCfgUtil.sh -e -l file -m "macros"

•-e—Identifies the encode option.

•-l—Specifies the input file is on the local file system.

•file—Identifies the input template file being parsed.

•-m—Specifies the macro variables to be substituted when parsing a template.

•"macros"—Identifies the desired macros. When multiple macro variables are required, insert a double comma separator between each macro.

To specify values for macro variables at the command line:

Step 1 Change directory to /opt/CSCObac/rdu/templates.

Step 2 Select a template file to use.

Step 3 Identify the macro variables in the template. In this example, the macro variables are macro1 (option 3) and macro11 (option 4.2).

Step 4 Identify the values for the macro variables. The value for macro1 will be set to 1, and the value for macro11 to 64000.

Step 5 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -e -l macro.tmpl -m "macro1=1,,macro11=64000"

•macro.tmpl—Identifies the input file.

•macro1=1,,macro11=64000—Identifies the key value pairs for macro variables. Because multiple macro variables are necessary, a double comma separator is inserted between the key value pairs.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Off

File Bytes

Option

Description

Value

0

030101

3

Network Access Control

On

3

041F

4

Class of Service

5

010101

4.1

Class ID

1

8

02040000FA00

4.2

Maximum Downstream Rate

64000 bits/sec

14

03040000FA00

4.3

Maximum Upstream Rate

64000 bits/sec

20

040101

4.4

Upstream Channel Priority

1

...

0 error(s), 0 warning(s) detected. Parsing of macro.tmpl was successful.

The file macro.tmpl was parsed successfully in 854 ms.

The parser initialization time was 76 ms.

The parser parse time was 778 ms.

Specifying a Device for Macro Variables

Use the runCfgUtil.sh command to specify a device for macro variables.

Syntax Description

runCfgUtil.sh -e -r file -i MAC -u username -p password

•-e—Identifies the encode option.

•-r—Identifies the input file as a file that has been added to the RDU.

•file—Identifies the input template file being parsed.

•-i—Specifies the device to use when parsing macro variables.

•MAC—Identifies the MAC address of the device.

•-u username—Specifies the username to use when connecting to the RDU.

•-p password— Specifies the password to use when connecting to the RDU.

To specify a device to be used for macro variable substitution:

Step 1 Select a template file to use. This example uses the existing template file, macro.tmpl.

Step 2 Identify the macro variables in the template. In this example, the macro variables are macro1 (option 3) and macro11 (option 4.2).

Step 3 Identify the device to use. This example assumes that the device exists in the RDU and has the macro variables set as properties. The value for macro1 will be set to 1, and the value for macro11 to 64000.

Step 4 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -e -r macro.tmpl -i "1,6,00:01:02:03:04:05" -u admin -p changeme

•macro.tmpl—Identifies the input file.

•1,6,00:01:02:03:04:05—Identifies the MAC address of the device. The MAC address used here is for example purposes only.

•admin—Identifies the default username.

•changeme—Identifies the default password.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Off

File Bytes

Option

 Description

Value

0

030101

3

Network Access Control

On

3

041F

4

Class of Service

5

010101

4.1

Class ID

1

8

02040000FA00

4.2

Maximum Downstream Rate

64000 bits/sec

14

03040000FA00

4.3

Maximum Upstream Rate

64000 bits/sec

20

040101

4.4

Upstream Channel Priority

1

...

0 error(s), 0 warning(s) detected. Parsing of macro.tmpl was successful.

The file macro.tmpl was parsed successfully in 159 ms.

The parser initialization time was 42 ms.

The parser parse time was 117 ms.

Specifying Output to a Binary File

Use the runCfgUtil.sh command to specify the output of a parsed template as a binary file.

Syntax Description

runCfgUtil.sh -l input_file -o output_file

•-l—Specifies that the input file is on the local file system.

•input_file—Identifies the input template file being parsed.

•-o—Specifies that the parsed template file is to be saved as a binary file.

•output_file—Identifies the name of the file in which the binary contents of the parsed template file are stored.

To specify the output from parsing a template to a binary file:

Step 1 Change directory to /opt/CSCObac/rdu/templates.

Step 2 Select a template file to use.

Step 3 Identify the name of the output file. This example uses unprov.cm.

Step 4 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -l unprov.tmpl -o unprov.cm

•unprov.tmpl—Identifies the existing template file being parsed into a binary file.

•unprov.cm—Identifies the output filename to be used.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0

0 error(s), 0 warning(s) detected. Parsing of unprov.tmpl was successful.

The file unprov.tmpl was parsed successfully in 595 ms.

The parser initialization time was 262 ms.

The parser parse time was 333 ms.

Viewing a Local Binary File

Use the runCfgUtil.sh command to view a binary file stored in the local system.

Syntax Description

runCfgUtil.sh -d -l file

•-d—Specifies that the command is going to decode a binary input file for viewing.

•-l—Identifies that the input file resides on the local file system.

•file—Identifies the existing binary input file to be viewed.

To view a binary file that is on the local file system:

Step 1 Change directory to /opt/CSCObac/rdu/samples/packet_cable.

Step 2 Select a binary file to view.

Step 3 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -d -l unprov_packet_cable.bin

unprov_packet_cable.bin—Identifies the existing binary input file to be viewed.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Warning: Expecting config file of type docsis, but input file is of type pktc1.0.  
Decoding as pktc1.0

Off

File Bytes

Option

Description

Value

0

FE0101

254

Telephony Config File Start/End

1

      
3

0B153013060E 
2B06010401A30B
02020101010700
020102

11

SNMP MIB Object

.iso.org.dod.internet.
private.enterprises.ca
bleLabs.clabProject.cl
abProjPacketCable.pktc
MtaMib.pktcMtaMibObjec
ts.pktcMtaDevBase.pktc
MtaDevEnabled.0,INTEGE
R,fals e(2)

...

Viewing an External Binary File

Use the runCfgUtil.sh command to view an external binary file.

Syntax Description

runCfgUtil.sh -d -r file -u username -p password

•-d—Specifies that the command is going to decode a binary input file for viewing.

•-r—Identifies the input file as a file that has been added to the RDU.

•file—Identifies the existing binary file in the RDU.

•-u username—Specifies the username to use when connecting to the RDU.

•-p password— Specifies the password to use when connecting to the RDU.

To view a binary file that has been added to the RDU:

Step 1 Select a binary file to view. This example uses the existing binary file unprov.cm, and assumes that the RDU is localhost:49187.

Step 2 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -d -r unprov.cm -u admin -p changeme

•unprov.cm—Identifies the existing binary file in the RDU.

•admin—Identifies the default username.

•changeme—Identifies the default password.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Off

File Bytes

Option

 Description

Value

0

030100

3

Network Access Control 

Off

3

041F

4

Class of Service

5

010101

4.1

Class ID

1

8

02040001F400

4.2

Maximum Downstream Rate

128000 bits/sec

14

03040000FA00

4.3

Maximum Upstream Rate

64000 bits/sec

20

040101

4.4

Upstream Channel Priority 

1

...

252

06108506547F

C9152B44DB95

5420843EF6FE

6

CM MIC Configuration Setting

8506547FC9152B44

DB955420843EF6FE

270

0710644B675B

70B7BD3E09AC

210F794A1E8F

7

CMTS MIC Configuration Setting

644B675B70B7BD3E

09AC210F794A1E8F

288

FF

255

End-of-Data Marker

289

00

0

PAD

290

00

0

PAD

291

00

0

PAD

0 error(s), 0 warning(s) detected. Parsing of unprov.tmpl was successful.

The file unprov.tmpl was parsed successfully in 375 ms.

The parser initialization time was 63 ms.

The parser parse time was 312 ms.

Activating PacketCable Basic Flow

Use the runCfgUtil.sh command to support the generation and insertion of the PacketCable Basic Flow integrity hash into a Basic Flow static configuration file.

Syntax Description

runCfgUtil.sh -t {basic | secure} -pkt -r filename -u username -p password

•basic—Calculates and inserts a PacketCable Basic Flow integrity hash into an MTA static configuration file.

•secure—Stops the insertion of the PacketCable Basic Flow integrity hash into an MTA static configuration file. This is the default setting.

•-r—Identifies the input file as a file that has been added to the RDU.

•filename—Identifies the input file.

•-u username—Specifies the username to use when connecting to the RDU.

•-p password—Specifies the password to use when connecting to the RDU.

•-pkt—Identifies the input file as a PacketCable MTA configuration file.

To support the generation and insertion of the PacketCable Basic Flow integrity hash into a Basic flow static configuration file:

Step 1 Select the Basic Flow static configuration file into which you want to insert the PacketCable Basic Flow integrity hash. This example uses the example_mta_config.tmpl.

Step 2 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -t basic -pkt -r example_mta_config.tmpl -u admin -p changeme

•example_mta_config.tmpl—Identifies the Basic Flow static configuration file.

•admin—Identifies the default username.

•changeme—Identifies the default password.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Off

File Bytes

Option

Description

Value

0

FE0101

254

Telephony Config File Start/End

1

3

0B153013060E

2B06010401A3

0B0202010101

0700020101

11 

SNMP MIB Object

.iso.org.dod.internet.
private.enterprises.ca
bleLabs.clabProject.cl
abProjPacketCable.pktc
MtaMib.pktcMtaMibObjec
ts.pktcMtaDevBase.pktc
MtaDevEnabled.0,INTEGE
R,true(1)

26

0B2530230610

2B06010401A3

0B0202020102

01010109040F

434D532E4950

464F4E49582E

434F4D

11 

SNMP MIB Object

.iso.org.dod.internet.
private.enterprises.ca
bleLabs.clabProject.cl
abProjPacketCable.pktc
SigMib.pktcSigMibObjec
ts.pktcNcsEndPntConfig
Objects.pktcNcsEndPntC
onfigTable.pktcNcsEndP
ntConfigEntry.pktcNcsE
ndPntConfigCallAgentId
.9,STRING,CMS.IPFONIX.
COM

...

371

FE01FF 

254

Telephony Config File Start/End

255

0 error(s), 0 warning(s) detected. Parsing of example_mta_config.tmpl was successful.

The file example_mta_config.tmpl was parsed successfully in 100 ms.

The parser initialization time was 44 ms.

The parser parse time was 56 ms.

A file with a .tmpl extension is assumed to be a dynamic configuration template, for which the Basic hash calculation and insertion occur transparently during template processing; as a result, you can use the same template for provisioning in the Secure and Basic modes.

However, if you want to convert a Secure static binary configuration file to a Basic static configuration file before inserting the hash, follow this procedure:

a. Convert the Secure static file to a template, by using:

# runCfgUtil -l input_static_filename -pkt -g -o output_template_filename

b. Convert the Secure static template into a Basic static configuration file, by using:

# runCfgUtil -t basic -l input_template_name -pkt -o output_Basic_static_filename

This command calculates and inserts the Basic integrity hash into the Basic static configuration file.

Generating TLV 43s for Multivendor Support

Use the runCfgUtil.sh command to generate TLV 43s in order to provide multivendor support.

Syntax Description

runCfgUtil.sh -docsis -r filename -u username -p password

•-docsis—Identifies the input file as a DOCSIS template file.

•filename—Identifies the input template file being parsed.

•-r—Identifies the input file as a file that has been added to the RDU.

•-u username—Specifies the username to use when connecting to the RDU.

•-p password— Specifies the password to use when connecting to the RDU.

To generate TLV 43s using a template file that has been added to the RDU:

Step 1 Select a template file to use. This example uses an existing template file called test.tmpl. The -docsis option is used because a DOCSIS template is being used.

Step 2 Run the configuration file utility using this command:

/opt/CSCObac/rdu/bin# runCfgUtil.sh -docsis -r test.tmpl -u admin -p changeme

•test.tmpl—Identifies the DOCSIS configuration file.

•admin—Identifies the default username.

•changeme—Identifies the default password.

After running the utility, results similar to these should appear:

Broadband Access Center Configuration Utility

Version: 4.0, Revision: 1.26

Off

File Bytes

Option

Description

Value

0

2B14

43

DOCSIS Extension Field

2

0803FFFFFF

43.8

Vendor ID

FF-FF-FF

7

050D

43.5

L2VPN Encoding

9

010502345600

03

43.5.1

VPNID Subtype

0234560003

16

0204 

43.5.2

NSI Encapsulation Subtype

18

02020019

43.5.2.2 

IEEE 802.1Q Format Subtype

25

22

2B0B

43

DOCSIS Extension Field 

24

080300000C

43.8

Vendor ID

00-00-0C (CISCO 

SYSTEMS, INC.)

29

010418017A30

43.1

Static Downstream Frequency

402750000

35

2B1D

43

DOCSIS Extension Field

37

080300000C

43.8

Vendor ID

00-00-0C (CISCO 

SYSTEMS, INC.)

42

0316626F6F74

5F6D6F6E6974

6F725F696D61

67652E62696E 

43.3

Update Boot Monitor Image

boot_monitor_image.bin

66

061071E79068

3DE8B9950536

8936F4C5312F

6

CM MIC Configuration Setting

71E790683DE8B995

05368936F4C5312F

84

0710DB0EED14

B5B3428D2B15

0DA582B41A54

7

CMTS MIC Configuration Setting

DB0EED14B5B3428D

2B150DA582B41A54

102

FF 

255

End-of-Data Marker

103

00

0

PAD

0 error(s), 0 warning(s) detected. Parsing of test.tmpl was successful.

The file test.tmpl was parsed successfully in 250 ms.

The parser initialization time was 109 ms.

The parser parse time was 141 ms.