Cisco Cisco Broadband Access Center Telco Wireless 3.8

Page of 267
 
8-3
Cisco Broadband Access Center for Cable Administrator’s Guide
OL-2445-02
Chapter 8      Broadband Access Center for Cable Support Tools and Advanced Concepts
Developing Template Files
Includes
Include files allow for building 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 have been 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 
 and 
 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
DOCSIS and PacketCable configuration files consist of properly encoded option id-value pairs. Two 
forms of options are supported: well 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 the 
 for additional information.
BAC uses well defined options. When specifying one of these well-defined options in a template, it is 
not necessary to specify a value encoding for the value. See the 
, and 
 for additional information on these well defined 
encoding types.
When specifying custom options (e.g. 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.