Cisco Broadband Access Center Administrator Guide, Release 2.7.1

Developing Template Files
Using the Configuration File Utility

Configuration Templates Management

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

•Developing Template Files

–Encoding Types for Defined Options

–DOCSIS Option Support

–PacketCable Option Support

–Non-Secure CableHome Option Support

•Using the Configuration File Utility

Developing Template Files

BAC uses templates to help administrators 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 file extension to identify template files.

You must add template files to the RDU as an external file using either the administrator user interface or the API, before any Class of Service can reference it.

When installing the BAC RDU component, several sample template files are copied to the BAC_home/rdu/samples 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, and 2.0 RFI specifications

•PacketCable 1.0, 1.1, and 1.5 specifications

•Media 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 four types of statements:

•Comments

•Includes

•Options

•Instance 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. Table 8-1 describes the available template grammar options.

Table 8-1 Template Grammar
Option	Description
<comment>	::= #[ascii-string]
<include>	::= include "<filename.tmpl>"
<option-description>	::= option <option-num> [instance <instance-num>] <option-value>
<option-num>	::= <unsigned-byte>[.<unsigned-byte>]*
<option-value>	::= <well-defined-value> \| <custom-value>
<well-defined-value>	::= <option-value-string>[,<option-value-string>]*
<custom-value>	::= <ascii-value> \| <hex-value> \| <ip-value> \| <snmp-value>
<ascii-value>	::= ascii <ascii-string>
<hex-value>	::= hex <hex-string>
<ip-value>	::= ip <ip-string>
<instance-num>	::= <unsigned integer>
<template>	::= <template-statement>*
<template-statement>	::= <comment> \| <include> \| <option-description>
<snmp-value>	::= <snmpvar-oid>,<snmpvar-type>,<snmpvar-value>

Comments

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

Example 8-1 Example 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 an external 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. Examples 8-2 and 8-3 illustrate both correct and incorrect usage of the include option.

Example 8-2 Correct Include Statement Usage

# Valid, including common options

include "common_options.tmpl"

Example 8-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, for additional information.

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

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 double quoted.

•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 multi-valued options on a given line. Each value is treated as such, so you might have to double quote one of the values, but not the others. A good example of a multi-valued 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). Examples 8-4 and 8-5 illustrate both correct and incorrect usage of the option statement.

Example 8-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 8-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 Tag-Length-Values (TLVs). Examples 8-6 and 8-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 8-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 8-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 8-4, this type only accepts an 00-00-0C format.

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.

Examples 8-8 and 8-9 illustrate using a fully-qualified MIB OID and a nonfully qualified MIB OID.

Example 8-8 Fully Qualified MIB OID

# Valid, uniquely identifying an OID

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

Example 8-9 NonFully Qualified MIB OID (Defaults to DOCS-CABLE-DEVICE-MIB)

# Valid, Non-Fully 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:

•System defaults

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

•DHCP criteria properties

•Class of Service properties

•Device properties

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.

Examples 8-10 and 8-11 illustrate both correct and incorrect usage of Option 11.

Example 8-10 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 8-11 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}

Adding 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:'

The allowed SNMP variable type names are:


IETF standard SMI Data Type	SNMP API name
Integer32	INTEGER
Integer (Enumerated)	INTEGER
Unsigned32	UNSIGNED32
Gauge32	GAUGE
Counter32	COUNTER
Counter64	COUNTER64
Timeticks	TIMETICKS
OCTET STRING	STRING
OBJECT IDENTIFIER	OBJID
IpAddress	IPADDRESS
BITS	STRING

For example, to specify a 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 vs. .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 BAC_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 BAC_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 BAC_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 and the administrator user interface 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 BAC_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 Note that the /docsis/mibs/custom/mibList property has been renamed /snmp/mibs/mibList from BACC version 2.7 onwards.

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 error that you are unable to resolve by editing the new MIB, contact the Cisco TAC.

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:

•/snmp/mibs/MibList property, if you are using BACC 2.6.x releases.

•/docsis/mibs/custom/mibList property, if you are using BACC 2.7.x 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 BAC_home/rdu/bin directory.

Note This procedure references the /snmp/mibs/MibList property that BACC 2.7.x 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.mi
b,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,r
fc2573.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 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 later

a. Copy the load order information to the /snmp/mibs/MibList property in the rdu.properties file. This file resides in the BAC_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 8-2 identifies the options with defined encoding types.

Table 8-2 Defined Option Encoding Types
Encoding	Input	Example
Boolean	0 for false and 1 for true.	0
Bytes	A series of hexadecimal octets. Each octet must be 2 characters.	000102030405060708
IP Address	Four unsigned integer 8, dot (.) separated.	10.10.10.1
Multiple IP Addresses	Comma-separated list of IP addresses.	10.11.12.13,10.11.12.14
MAC Address	Six hexadecimal octets, colon (:) or dash (-) separated. Each octet must be exactly 2 characters. Colons and dashes must not be mixed.	00:01:02:03:04:05 or 00-01-02-03-04-05
MAC Address And Mask	Twelve octets colon (:) or dash (-) separated. Each octet must be 2 characters. Colons and dashes must not be mixed. The first six octets represent the MAC address; the last six represent the mask for the MAC address.	00:01:02:03:04:05:06:07:08:09:0 A:0B or 00-01-02-03-04-05-06-07-08-09-0 A-0B
NVTASCII	An ASCII string. The encoded string will not be NULL terminated.	This is an ASCII string
OID	An SNMP OID string.	sysinfo.0
OIDCF	An SNMP OID string and an unsigned integer (0 or 1) comma separated.	sysinfo.0,1
OUI	Three hexadecimal octets colon (:) or dash (-) separated. Each octet must be 2 characters.	00-00-0C
SNMPVarBind	An SNMP OID string, type, and value. Each of these is comma separated. Valid types are: •BITS •Counter •Counter32 •Counter64 •Gauge •Gauge32 •INTEGER •Integer32 •IpAddress •OCTETSTRING •OBJECTIDENTIFIER •Opaque •TimeTicks •Unsigned32 Note The OCTETSTRING can be a string that will be converted to a hexadecimal notation without a trailing NULL, octet string for example, or hexadecimal notation contained in single quotes, 'aa:bb:cc' for example.	.experimental.docsDev.docsDevMI BObjects. docsDevNmAccessTable.docsDevNmA ccessEntry.docsDevNmAccessStatu s.1, INTEGER, 4
Sub Type	One or two comma separated unsigned integer 8.	12 or 12,14
Unsigned integer 8	0 to 255	14
Unsigned integer 16	0 to 65535	1244
Unsigned integer 32	0 to 4294967295	3455335
Unsigned integer 8 and unsigned integer 16	One unsigned integer 8 and one unsigned integer 16, comma separated.	3,12324
Unsigned integer 8 pair	Two unsigned integer 8, comma separated.	1,3
Unsigned integer 8 triplet	Three unsigned integer 8, comma separated.	1,2,3
ZTASCII	An ASCII string. The encoded string will be NULL terminated.	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 quotes, (for example, 'aa:bb:cc' ).

DOCSIS Option Support

Table 8-3 describes DOCSIS options and identifies the specific version support for each option.

Table 8-3 DOCSIS Options and Version Support
Option Number	Description	Encoding	Validation	Multi- valued	DOCSIS Version
Option Number	Description	Encoding	Validation	Multi- valued	1.0	1.1	2.0
0	PAD	No length and no value	N/A	True	P	P	P
1	Downstream Frequency	Unsigned integer 32	Multiples of 62500	False	P	P	P
2	Upstream Channel ID	Unsigned integer 8	None	False	P	P	P
3	Network Access Control	Boolean	None	False	P	P	P
4	Class of Service	Compound	None	False	P	P	P
4.1	Class ID	Unsigned integer 8	Between 1-16 inclusive	False	P	P	P
4.2	Maximum Downstream Rate	Unsigned integer 32	None	False	P	P	P
4.3	Maximum Upstream Rate	Unsigned integer 32	None	False	P	P	P
4.4	Upstream Channel Priority	Unsigned integer 8	Less than 8	False	P	P	P
4.5	Guaranteed Minimum Upstream Channel Data Rate	Unsigned integer 32	None	False	P	P	P
4.6	Maximum Upstream Channel Transmit Burst	Unsigned integer 16	None	False	P	P	P
4.7	Class-of-Service Privacy Enable	Boolean	None	False	P	P	P
6	CM MIC Configuration Setting	Byte 16	None	False	P	P	P
7	CMTS MIC Configuration Setting	Byte 16	None	False	P	P	P
9	Software Upgrade Filename	NVTASCII	None	True	P	P	P
10	SNMP Write-Access Control	OIDCF	None	True	P	P	P
11	SNMP MIB Object	SNMPVarBind	None	True	P	P	P
14	CPE Ethernet MAC Address	MAC Address	None	True	P	P	P
15	Telephony Settings Option	NVTASCII	None	False	P	P	P
15.2	Service Provider Name	NVTASCII	None	False	P	P	P
15.3	Telephone Number (1)	NVTASCII	None	False	P	P	P
15.4	Telephone Number (2)	NVTASCII	None	False	P	P	P
15.5	Telephone Number (3)	NVTASCII	None	False	P	P	P
15.6	Connection Threshold	Unsigned integer 8	None	False	P	P	P
15.7	Login Username	NVTASCII	None	False	P	P	P
15.8	Login Password	NVTASCII	None	False	P	P	P
15.9	DHCP Authentication	Boolean	None	False	P	P	P
15.10	DHCP Server	IP Address	None	False	P	P	P
15.11	RADIUS realm	NVTASCII	None	False	P	P	P
15.12	PPPAuthentication	Unsigned integer 8	None	False	P	P	P
15.13	Demand Dial Inactivity Timer Threshold	Unsigned integer 8	None	False	P	P	P
16	SNMP IP Address (No Longer Used)	IP Address	None	False	P	P	P
17	Baseline Privacy Configuration Setting	Compound	None	False	P	P	P
17.1	Authorize Wait Timeout	Unsigned integer 32	Between 1 and 30 inclusive	False	P	P	P
17.2	Reauthorize Wait Timeout	Unsigned integer 32	Between 1 and 30 inclusive	False	P	P	P
17.3	Authorization Grace Time	Unsigned integer 32	Between 1 and 1800 inclusive	False	P
17.3	Authorization Grace Time	Unsigned integer 32	Between 1 and 6047999 inclusive	False		P	P
17.4	Operational Wait Timeout	Unsigned integer 32	Between 1 and 10 inclusive	False	P	P	P
17.5	Rekey Wait Timeout	Unsigned integer 32	Between 1 and 10 inclusive	False	P	P	P
17.6	TEK Grace Time	Unsigned integer 32	Between 1 and 1800 inclusive	False	P
17.6	TEK Grace Time	Unsigned integer 32	Between 1 and 302399 inclusive	False		P	P
17.7	Authorize Reject Wait Timeout	Unsigned integer 32	Between 1 and 600 inclusive	False	P	P	P
17.8	SA Map Wait Timeout	Unsigned integer 32	Between 1 and 18006 inclusive	False		P	P
17.9	Maximum Clock Drift	Unsigned integer 32	Between 1 and 10 inclusive	False		P	P
18	Maximum Number of CPE	Unsigned integer 32	Greater than 0	False	P	P	P
19	TFTP Server Timestamp	Unsigned integer 32	None	False	P	P	P
20	TFTP Server Provisioned Modem Address	IP Address	None	False	P	P	P
21	Software Upgrade TFTP Server	IP Address N	None	False	P	P	P
22	Upstream Packet Classification Encoding	Compound	None	True		P	P
22.1	Classifier Reference	Unsigned integer 8	Between 1 and 255 inclusive	False		P	P
22.2	Classifier Identifier	Unsigned integer 16	Between 1 and 65535 inclusive	False		P	P
22.3	Service Flow Reference	Unsigned integer 16	Between 1 and 65535 inclusive	False		P	P
22.4	Service Flow Identifier	Unsigned integer 32	Greater than 0	False		P	P
22.5	Rule Priority	Unsigned integer 8	None	False		P	P
22.6	Classifier Activation State	Boolean	None	False		P	P
22.7	Dynamic Service Change Action	Unsigned integer 8	Less than 3	False		P	P
22.8	Classifier Error Encodings	Compound	None	False		P	P
22.8.1	Error Parameter	Sub Type	None	False		P	P
22.8.2	Error Code	Unsigned integer 8	Less than 26	False		P	P
22.8.3	Error Message	ZTAASCII	None	False		P	P
22.9	IP Packet Classification Encodings	Compound	None	False		P	P
22.9.1	IP Type of Service Range and Mask	Unsigned integer 8 triplet	None	False		P	P
22.9.2	IP Protocol	Unsigned integer 16	Less than 258	False		P	P
22.9.3	IP Source Address	IP Address	None	False		P	P
22.9.4	IP Source Mask	IP Address	None	False		P	P
22.9.5	IP Destination Address	IP Address	None	False		P	P
22.9.6	IP Destination Mask	IP Address	None	False		P	P
22.9.7	TCP/UDP Source Port Start	Unsigned integer 16	None	False		P	P
22.9.8	TCP/UDP Source Port End	Unsigned integer 16	None	False		P	P
22.9.9	TCP/UDP Destination Port Start	Unsigned integer 16	None	False		P	P
22.9.10	TCP/UDP Destination Port End	Unsigned integer 16	None	False		P	P
22.10	Ethernet LLC Packet Classification Encodings	Compound	None	False		P	P
22.10.1	Destination MAC Address	MAC Address and Mask	None	False		P	P
22.10.2	Source MAC Address	MAC Address	None	False		P	P
22.10.3	Ethertype/DSAP/MacType	Unsigned integer 8 and unsigned integer 16	None	False		P	P
22.11	IEEE 802.1P/Q Packet Classification Encodings	Compound	None	False		P	P
22.11.1	IEEE 802.1P User_Priority	Unsigned integer 8 pair	Less than 8	False		P	P
22.11.2	IEEE 802.1Q VLAN_ID	Unsigned integer 16	None	False		P	P
22.43	Vendor Specific Classifier Parameters	Compound	None	False		P	P
22.43.8	Vendor ID	OUI	None	False		P	P
23	Downstream Packet Classification Encoding	Compound	None	True		P	P
23.1	Classifier Reference	Unsigned integer 8	Between 1 and 255 inclusive	False		P	P
23.2	Classifier Identifier	Unsigned integer 16		False		P	P
23.3	Service Flow Reference	Unsigned integer 16	Between 1 and 65535	False		P	P
23.4	Service Flow Identifier	Unsigned integer 32	Between 1 and 65535	False		P	P
23.5	Rule Priority	Unsigned integer 8	Greater than 0	False		P	P
23.6	Classifier Activation	Boolean	None	False		P	P
23.7	Dynamic Service Change Action	Unsigned integer 8	Less than 3	False		P	P
23.8	Classifier Error Encodings	Compound	None	False		P	P
23.8.1	Error Parameter	Sub Type	None	False		P	P
23.8.2	Error Code	Unsigned integer 8	Less than 26			P	P
23.8.3	Error Message	ZTASCII	None	False		P	P
23.9	IP Classification Encodings	Compound	None	False		P	P
23.9.1	IP Type of Service Range and Mask	Unsigned integer 8	None	False		P	P
23.9.2	IP Protocol	Unsigned integer 16	Less than 258	False		P	P
23.9.3	IP Source Address	IP Address	None	False		P	P
23.9.4	IP Source Mask	IP Address	None	False		P	P
23.9.5	IP Destination Address	IP Address	None	False		P	P
23.9.6	IP Destination Mask	IP Address	None	False		P	P
23.9.7	TCP/UDP Source Port Start	Unsigned integer 16	None	False		P	P
23.9.8	TCP/UDP Source Port End	Unsigned integer 16	None	False		P	P
23.9.9	TCP/UDP Destination Port Start	Unsigned integer 16	None	False		P	P
23.9.10	TCP/UDP Destination Port End	Unsigned integer 16	None	False		P	P
23.10	Ethernet LLC Packet Classification Encodings	Compound					P
23.10.1	Destination MAC Address	MAC Address and Mask\	None	False		P	P
23.10.2	Source MAC Address	MAC Address	None	False		P	P
23.10.3	Ethertype/DSAP/MacType	Unsigned integer 8 and unsigned integer 16	None	False		P	P
23.11	IEEE 802.1P/Q Packet Classification Encodings	Compound	None	False		P	P
23.11.1	IEEE 802.1P User_Priority	Unsigned integer 8 pair	Less than 8	False		P	P
23.11.2	IEEE 802.1Q VLAN_ID	Unsigned integer 16	None	False		P	P
23.43	Vendor Specific Classifier Parameters	Compound	None	False		P	P
23.43.8	Vendor ID	OUI	None	False		P	P
24	Upstream Service Flow Scheduling	Compound	None	True		P	P
24.1	Service Flow Reference	Unsigned integer 16	Greater than 0	False		P	P
24.3	Service Identifier	Unsigned integer 16	None	False		P	P
24.4	Service Class Name	ZTASCII	None	False		P	P
24.5	Service Flow Error Encodings	Compound	None	True		P	P
24.5.1	Errored Parameter	Unsigned integer 8	None	False		P	P
24.5.2	Error Code	Unsigned integer 8	Less than 26	False		P	P
24.5.3	Error Message	ZTASCII	None	False		P	P
24.6	Quality of Service Parameter Set Type	Unsigned integer 8	Less than 8	False		P	P
24.7	Traffic Priority	Unsigned integer 8	Less than 8	False		P	P
24.8	Upstream Maximum Sustained Traffic Rate	Unsigned integer 32	None	False		P	P
24.9	Maximum Traffic Burst	Unsigned integer 32	None	False		P	P
24.10	Minimum Reserved Traffic Rate	Unsigned integer 32	None	False		P	P
24.11	Assumed Minimum Reserved Rate Packet Size	Unsigned integer 16	None	False		P	P
24.12	Timeout for active QoS Parameters	Unsigned integer 16	None	False		P	P
24.13	Timeout for Admitted QoS Parameters	Unsigned integer 16	None	False		P	P
24.14	Maximum Concatenated Burst	Unsigned integer 16	None	False		P	P
24.15	Service Flow Scheduling Type	Unsigned integer 8	Between 1-6 inclusive	False		P	P
24.16	Request/Transmission Policy	Unsigned integer 32	Less than 512	False		P	P
24.17	Nominal Polling Interval	Unsigned integer 32	None	False		P	P
24.18	Tolerated Poll Jitter	Unsigned integer 32	None	False		P	P
24.19	Unsolicited Grant Size	Unsigned integer 16	None	False		P	P
24.20	Nominal Grant Interval	Unsigned integer 32	None	False		P	P
24.21	Tolerated Grant Jitter	Unsigned integer 32	None	False		P	P
24.22	Grants per Interval	Unsigned integer 8	Less than 128	False		P	P
24.23	IP Type of Service Overwrite	Unsigned integer 8 pair	None	False		P	P
24.24	Unsolicited Grant Time Reference	Unsigned integer 32	None	False		P	P
24.43	Vendor Specific PHS Parameters	Compound	None	False		P	P
24.43.8	Vendor ID	OUI	None	False		P	P
25	Downstream Service Flow Scheduling	Compound	None	True		P	P
25.1	Service Flow Reference	Unsigned integer 16	Greater than 0	False		P	P
25.3	Service Identifier	Unsigned integer 16	None	False		P	P
25.4	Service Class Name	ZTASCII	None	False		P	P
25.5	Service Flow Error Encodings	Compound	None	True		P	P
25.5.1	Errored Parameter	Unsigned integer 8	None	False		P	P
25.5.2	Error Code	Unsigned integer 8	Less than 26	False		P	P
25.5.3	Error Message	ZTASCII	None	False		P	P
25.6	Quality of Service Parameter Set Type	Unsigned integer 8	Less than 8	False		P	P
25.7	Traffic Priority	Unsigned integer 8	Less than 8	False		P	P
25.8	Downstream Maximum Sustained Traffic Rate	Unsigned integer 32	None	False		P	P
25.9	Maximum Traffic Burst	Unsigned integer 32	None	False		P	P
25.10	Minimum Reserved Traffic Rate	Unsigned integer 32	None	False		P	P
25.11	Assumed Minimum Reserved Rate Packet Size	Unsigned integer 16	None	False		P	P
25.12	Timeout for active QoS Parameters	Unsigned integer 16	None	False		P	P
25.13	Timeout for Admitted QoS Parameters	Unsigned integer 16	None	False		P	P
25.14	Maximum Downstream Latency	Unsigned integer 32	None	False		P	P
25.43	Vendor Specific PHS Parameters	Compound	None	False		P	P
25.43.8	Vendor ID	OUI	None	False		P	P
26	Payload Header Suppression	Compound	None	True		P	P
26.1	Classifier Reference	Unsigned integer 8	Greater than 0	False		P	P
26.2	Classifier Identifier	Unsigned integer 16	Greater than 0	False		P	P
26.3	Service Flow Reference	Unsigned integer 16	Greater than 0	False		P	P
26.4	Service Flow Identifier	Unsigned integer 32	Greater than 0	False		P	P
26.5	Dynamic Service Change Action	Unsigned integer 8	Less than 4	False		P	P
26.6	Payload Header Suppression Error Encodings	Compound	None	False		P	P
26.6.1	Errored Parameter	Unsigned integer 8	None	False		P	P
26.6.2	Error Code	Unsigned integer 8	Less than 26	False		P	P
26.6.3	Error Message	ZTASCII	None	False		P	P
26.7	Payload Header Suppression Field (PHSF)	Bytes	None	False		P	P
26.8	Payload Header Suppression Index (PHSI)	Unsigned integer 8	Greater than 0	False		P	P
26.9	Payload Header Suppression Mask (PHSM)	Bytes	None	False		P	P
26.10	Payload Header Suppression Size (PHSS)	Unsigned integer 8	None	False		P	P
26.11	Payload Header Suppression Verification (PHSV)	Boolean	None	False		P	P
26.43	Vendor Specific PHS Parameters	Compound	None	False		P	P
26.43.8	Vendor ID	OUI	None	False		P	P
28	Maximum Number of Classifiers	Unsigned integer 16	None	False		P	P
29	Privacy Enable	Boolean	None	False		P	P
32	Manufacturer CVC	Bytes	None	False		P	P
33	Co-signer CVC	Bytes	None	False		P	P
34	SnmpV3 Kickstart Value	Compound	None	False		P	P
34.1	SnmpV3 Kickstart Security Name	NVTASCII	None	False		P	P
34.2	SnmpV3 Kickstart Manager Public Number	Bytes	None	False		P	P
35	Subscriber Management Control	Bytes	None	False		P	P
36	Subscriber Management CPE IP Table	Multiple IP Addresses	None	False		P	P
37	Subscriber Management Filter Groups	Bytes	None	False		P	P
38	Configuration File Element - docsisV3 Notification Receiver	Compound	None	False		P	P
38.1	IP Address of Trap Receiver	IP address	None	False		P	P
38.2	UDP Port Number of Trap Receiver	unsigned integer 16	None	False		P	P
38.3	Type of Trap Sent by the PS	unsigned integer 8	None	False		P	P
38.4	Timeout	unsigned integer 32	None	False		P	P
38.5	Number of Retries When Sending an Inform After Sending the Inform First	unsigned integer 8	None	False		P	P
38.6	Notification Filtering Parameters	OID	None	False		P	P
38.7	Security Name to Use When Sending SNMP V3 Notification	NVTASCII	None	False		P	P
39	Enable 2.0 Mode	Enable/Disable	None	False			P
40	Enable Test Mode	SubOptions	None	True			P
41	Downstream Channel List	SubOptions	None	True			P
41.1	Single Downstream Channel	SubOptions	None	True			P
41.1.1	Single Downstream Channel Timeout	unsigned integer 16	None	False			P
41.1.2	Single Downstream Channel Frequency	unsigned integer 32	None	False			P
41.2	Downstream Frequency Range	SubOptions		True			P
41.2.1	Downstream Frequency Range Timeout	unsigned integer 16	None	False			P
41.2.2	Downstream Frequency Range Start	unsigned integer 32	Multiples of 62500	False			P
41.2.3	Downstream Frequency Range End	unsigned integer 32	Multiples of 62500	False			P
41.2.4	Downstream Frequency Range Step Size	unsigned integer 32	None	False			P
41.3	Default Scanning	unsigned integer 32	None	True			P
42	Multicast MAC Address	MAC Address	None	True			P
43	Vendor-Specific Information	Compound	None	True	P	P	P
43.1	Static Downstream Frequency	Unsigned integer 32	None	False	P	P	P
43.2	Sync Loss Timeout	Unsigned integer 32	None	False	P	P	P
43.3	Update Boot Monitor Image	NVTASCII	None	False	P	P	P
43.4	Power Backoff	Unsigned integer 16	None	False	P	P	P
43.8	Vendor ID	OUI	None	False	P	P	P
43.9	Update Factory System Image	Boolean	None	False	P	P	P
43.10	Phone Lines	Unsigned integer 8	None	False	P	P	P
43.11	IP Precedence Settings	Compound	None	True	P	P	P
43.11.1	IP Precedence Value	Unsigned integer 8	None	False	P	P	P
43.11.2	Rate Limit	Unsigned integer 32	None	False	P	P	P
43.128	IOS Configuration Filename	NVTASCII	None	False	P	P	P
43.129	IOS Config File Without Console Disable	NVTASCII	None	False	P	P	P
43.131	IOS CLI Command	NVTASCII	None	True	P	P	P
43.132	1.0 Plus Flow Encodings	Compound	None	False	P	P	P
43.132.1	1.0 Plus Flow ID	Unsigned integer 8	None	False	P	P	P
43.132.2	Class ID	Unsigned integer 8	None	False	P	P	P
43.132.3	Unsolicited Grant Size	Unsigned integer 16	Between 1-65535 inclusive	False	P	P	P
43.132.4	Nominal Grant Interval	Unsigned integer 32	Between 1-65535 inclusive	False	P	P	P
43.132.5	Grants Per Interval	Unsigned integer 8	Between 0-127 inclusive	False	P	P	P
43.132.6	Embedded Voice Calls	Unsigned integer 8	Between 0-127 inclusive	False	P	P	P
43.132.7	Hold Queue Length	Unsigned integer 16	Between 0-4096 inclusive	False	P	P	P
43.132.8	Fair Queue	Compound	None	False	P	P	P
43.132.8.1	Congestive Discard Threshold	Unsigned integer 16	Between 1-4096 inclusive	False	P	P	P
43.132.8.2	Number of Dynamic Conversation Queues	Unsigned integer 16	Between 16-4096 inclusive	False	P	P	P
43.132.8.3	Number of Reservable Conversation Queues	Unsigned integer 16	Between 0-1000 inclusive	False	P	P	P
43.132.9	Custom Queue List Length	Unsigned integer 8	Between 1-16 inclusive	False	P	P	P
43.132.10	Random Detection	Boolean	None	False	P	P	P
43.132.11	Priority Group	Unsigned integer 8	Between 1-16 inclusive	False	P	P	P
43.132.12	Service Policy File	NVTASCII	None	False	P	P	P
43.132.13	Inactivity Timer	Unsigned integer 16	Between 1-10080 inclusive	False	P	P	P
43.132.14	COS Tag	NVTASCII	None	False	P	P	P
43.133	Downstream Sub Channel ID	Unsigned integer 8	Between 0-15 inclusive	False	P	P	P
43.134	SU Tag	NVTASCII	None	False	P	P	P
255	End-of-Data Marker	No length and no value	N/A	False	P	P	P

PacketCable Option Support

Table 8-4 identifies the PacketCable 1.0 MTA options that BAC supports.

Table 8-4 PacketCable MTA 1.0 Options
Number	Description	Encoding	Validation	Multi- valued	PacketCable Version
Number	Description	Encoding	Validation	Multi- valued	1.0	1.1
11	SNMP MIB Object	SNMPVarBind with 1 byte length	None	True	P	P
38	SNMPv3 Notification Receiver	SubOptions	None	True	P	P
38.1	SNMPv3 Notification Receiver IP Address	IPAddress	None	False	P	P
38.2	SNMPv3 Notification Receiver UDP Port Number	Unsigned integer 16	None	False	P	P
38.3	SNMPv3 Notification Receiver Trap Type	SNMPTrapType	From 1 to 5	False	P	P
38.4	SNMPv3 Notification Receiver Timeout	Unsigned integer 16	None	False	P	P
38.5	SNMPv3 Notification Receiver Retries	Unsigned integer 16	From 0 to 255	False	P	P
38.6	Notification Receiver Filtering Parameters	OID	None	False	P	P
38.7	Notification Receiver Security Name	NVTASCII	None	False	P	P
43	Vendor-Specific Information	SubOptions	None	True	P	P
43.8	Vendor ID	OUI	None	False	P	P
64	SNMP MIB Object	SNMPVarBind with 2 byte length	None	True	P	P
254	Telephony Config File Start/End	Unsigned integer 8	Must be 1 or 255	False	P	P

Non-Secure CableHome Option Support

Table 8-5 identifies the non-secure CableHome options that BAC supports.

Table 8-5 Non-Secure CableHome Options and Version Support
Option Number	Description	Encoding	Validation	Multi- valued	CableHome Version
Option Number	Description	Encoding	Validation	Multi- valued	1.0
0	PAD	No length and no value	None	True	P
9	Software Upgrade Filename	NVTASCII	None	False	P
10	SNMP Write-Access Control	OIDCF	None	True	P
12	Modem IP Address	IP Address	None	False	P
14	CPE Ethernet MAC Address	MACAddress	None	True	P
21	Software Upgrade TFTP Server	IPAddress	None	False	P
28	SNMP MIB Object	SNMPVarBind	None	True	P
32	Manufacturer CVC	Bytes	None	False	P
33	Co-signer CVC	Bytes	None	True	P
34	SnmpV3 Kickstart Value	SubOptions	None	False	P
34.1	SnmpV3 Kickstart Security Name	NVTASCII	None	False	P
38	SNMPv3 Notification Receiver	SubOptions	None	True	P
38.1	SNMPv3 Notification Receiver IP Address	IPAddress	None	False	P
38.2	SNMPv3 Notification Receiver UDP Port Number	Unsigned integer 16	None	False	P
38.3	SNMPv3 Notification Receiver Trap Type	SNMPTrapType	From 1 to5	False	P
38.4	SNMPv3 Notification Receiver Timeout	Unsigned integer 16	None	False	P
38.5	SNMPv3 Notification Receiver Retries	Unsigned integer 16	None	False	P
38.6	Notification Receiver Filtering Parameters	OID	None	False	P
38.7	Notification Receiver Security Name	NVTASCII	None	False	P
43	Vendor-Specific Information	SubOptions	None	True	P
43.1	Vendor ID	OUI	None	False	P
53	PS MIC. A 20 octet SHA-1 hash of PS config file	Bytes	None	False	P
255	End-of-Data Marker	No length and no value	None	False	P

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, and CableHome template and configuration files. These activities are critical to successful deployment of individualized configuration files. See Developing Template Files, 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/CSCObpr).

•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:

•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

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 BAC_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 is 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, and 2.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—Specifies the device to use when parsing macro variables. For example, if your device is ID is 1,6,00:00:00:00:00:01, enter -i 1,6,00:00:00:00:00:01. 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 parsed template file as a binary file. For example, if you want the output to be found in a file call 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 an external 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 (MIC).

Adding a Template to BAC

To use the configuration file utility to test BAC templates:

Step 1 Develop the template as described in Developing Template Files. 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 IGS 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 an external 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 Into 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/CSCObpr/rdu/samples/.

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:

# ./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: 2.7.1, Revision: 1.26

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

## Template File Generator

## Generated on Fri Jan 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/CSCObpr/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:

# 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:


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. pktcMtaDevEnable d.0,INTEGER,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 -r file -u username -p password -docsis

•-r—Identifies the input file as an external 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 Change directory to /opt/CSCObpr/rdu/samples/docsis.

Step 2 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 3 Run the configuration file utility using this command:

# runCfgUtil.sh -r unprov.tmpl -u admin -p changeme -docsis

•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.


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/CSCObpr/rdu/samples/docsis.

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:

# 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:


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/CSCObpr/rdu/samples/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:

# 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. Since 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:


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 -l file -i MAC -u username -p password

•-e—Identifies the encode option.

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

•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 Change directory to /opt/CSCObpr/rdu/samples/templates.

Step 2 Select a template file to use. This example will use the existing template file, macro.tmpl.

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 device to use. This example will assume 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 5 Run the configuration file utility using this command:

# runCfgUtil.sh -l 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:


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 823 ms. The parser initialization time was 102 ms. The parser parse time was 803 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/CSCObpr/rdu/samples/templates.

Step 2 Select a template file to use.

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

Step 4 Run the configuration file utility using this command:

# 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: 2.7.1
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.

Broadband Access Center Configuration Utility

Version: 2.7.1

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/CSCObpr/rdu/samples/packet_cable.

Step 2 Select a binary file to view.

Step 3 Run the configuration file utility using this command:

# 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:


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. clabProjPacketCa ble.pktcMtaMib.pktcMta MibObjects .pktcMtaDevBase. pktcMtaDevEnable d.0,INTEGER,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 an external file that has been added to the RDU.

•file—Identifies the existing external 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 will use the existing binary file unprov.cm, and assumes that the RDU is localhost:49187.

Step 2 Run the configuration file utility using this command:

# runCfgUtil.sh -d -r unprov.cm -u admin -p changeme

•unprov.cm—Identifies the existing external 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:


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} -r filename -u username -p password -pkt

•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 an external file that has been added to the RDU.

•filename—Identifies the input external 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 Change directory to /opt/CSCObpr/rdu/samples.

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

Step 3 Run the configuration file utility using this command:

# runCfgUtil.sh -t basic -r generic_mta.tmpl -u admin -p changeme -pkt

•generic_mta.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: 2.7.1, 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
241	FE01FF	254	Telephony Config File Start/End	255
...
0 error(s), 0 warning(s) detected. Parsing of generic_mta.tmpl was successful. The file generic_mta.tmpl was parsed successfully in 88 ms. The parser initialization time was 36 ms. The parser parse time was 52 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 -o output_Basic_static_filename -pkt

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

Bias-Free Language

Results

Chapter: Chapter 8 - Configuration Templates Management

Configuration Templates Management

Developing Template Files

Template Grammar

Comments

Includes

Options

Instance Modifier

SNMP VarBind

DOCSIS MIBs

PacketCable MIBs

CableHome MIBs

Macro Variables

Adding SNMP TLVs

Adding SNMP TLVs Without a MIB

Adding SNMP TLVs With Vendor-Specific MIBs

Encoding Types for Defined Options

BITS Value Syntax

OCTETSTRING Syntax

DOCSIS Option Support

PacketCable Option Support

Non-Secure CableHome Option Support

Using the Configuration File Utility

Running the Configuration File Utility

Adding a Template to BAC

Converting a Binary File Into a Template File

Syntax Description

Testing Template Processing for a Local Template File

Syntax Description

Testing Template Processing for an External Template File

Syntax Description

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

Syntax Description

Specifying Macro Variables at the Command Line

Syntax Description

Specifying a Device for Macro Variables

Syntax Description

Specifying Output to a Binary File

Syntax Description

Viewing a Local Binary File

Syntax Description

Viewing an External Binary File

Syntax Description

Activating PacketCable Basic Flow

Syntax Description

Was this Document Helpful?

Contact Cisco