|
|
Table Of Contents
Configuration Templates Management
Authoring Configuration Templates
Using the Configuration Utility
Running the Configuration Utility
Validating XML Syntax for a Local Template File
Validating XML Syntax for a Template Stored in BAC
Testing Template Processing for a Local Template File
Testing Template Processing for a Template Stored in BAC
Testing Template Processing for a BAC Template File and a Device
Configuration Templates Management
This chapter details the templates that Broadband Access Center (BAC) supports for device configuration and device management. This chapter features:
•
Overview
•
•
Overview
BAC 3.0 provides an extensible template-based mechanism to assign configurations for devices that are compliant with the CPE WAN Management Protocol (CWMP). This template-processing mechanism simplifies configuration management, enabling customized configurations for millions of customer premises equipment (CPE) by using a small number of templates. The result of processing a template is an instruction, which is forwarded to the DPEs in a device's provisioning group. This instruction contains all the necessary information for the DPE to configure the device.
Before attempting to create your own template file, familiarize yourself with information on:
•
•
By using BAC templates, you can create a template file in an easily readable format, and edit it quickly and simply. You must add template files to the RDU by using the administrator user interface or the API, before any Class of Service can reference it.
BAC templates are XML documents written according to a published schema. When instructions are generated for a given device at the RDU for distribution to DPEs, a common template processor retrieves a template by using the device's Class of Service object. It then evaluates the template values, such as Includes and Conditionals, and substitutes template variables with their values. The resulting output is an XML object which represents a processed template.
The syntax and content of the processed configuration template is validated when it is added to the BAC system, ensuring that the XML template is well-formed. This validation also ensures that parameter names and values are consistent with definitions in the parameter dictionary, an XML file that defines the supported objects and parameters. (See Parameter Dictionaries.)
Note
BAC uses the XML schemas that are defined in various files to generate instructions for device configurations. Table 5-1 lists these files and their locations.
You can manage template files, configuration and firmware rules, by using the administrator user interface. For more information, see Managing Files, page 17-11.
Features of BAC Templates
A configuration template is a collection of Objects and Parameters. In a TR-069 device, InternetGatewayDevice is the root object, while in TR-106, Device is the root object.
Figure 5-1 illustrates the schema of a TR-069 device Configuration. Each element featured in the schema is described in subsequent sections.
Figure 5-1 Configuration Schema
A configuration template comprises the following components:
•
An object may include other objects and parameters, both of which, in turn, may include other elements in line with the TR-069 specification.
A CPE object may contain:
–
–
–
–
•
•
–
–
See Figure 5-3 for a graphical representation of the prerequisite schema. For detailed information on using the prerequisite option, see Prerequisites.
Note
•
•
•
•
Parameters
This section describes the schema associated with parameter objects in the configuration templates (see Figure 5-2).
Figure 5-2 Parameter Schema
The CPE parameter contains a name-value pair:
The name identifies the parameter, and has a hierarchical structure similar to files in a directory, with each level separated by a dot (.). Each level corresponds to an object instance: Some objects have a single instance or singletons, other objects have multiple instances. The parameter lists for both object instances are described in subsequent sections.
The value of a parameter may be one of several data types defined in the TR-069 specification. These data types are string, int, unsignedInt, boolean, dateTime, and base64, each of which is validated by a parameter dictionary (see Table 7-1 for data type definitions).
Example 5-1 illustrates how you can configure values for a parameter:
Example 5-1 Configuring Parameter Values
<tc:Templatexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:tc="urn:com:cisco:bac:common-template"xmlns="urn:com:cisco:bac:cwmp-template"xsi:schemaLocation="urn:com:cisco:bac:common-template CommonTemplateConstructs.xsd"><Configuration><ParameterDictionaries><ParameterDictionary>tr069-cwmp-dictionary.xml</ParameterDictionary></ParameterDictionaries><ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><Parameter><Name>PeriodicInformEnable</Name><Value>true</Value></Parameter><Parameter><Name>PeriodicInformInterval</Name><Value>86400</Value></Parameter></ObjectInstance></ObjectInstance></Configuration></tc:Template>Parameter List for Single Instance Object
This is an example of a single instance, or singleton:
InternetGatewayDevice.UserInterface.The parameters of a singleton can be represented as:
InternetGatewayDevice.UserInterface.PasswordRequired = trueInternetGatewayDevice.UserInterface.ISPName = SBCParameter List for Multiple Instance Objects
The TR-069 specification defines some objects that can have multiple instances, with each instance assigned a number. You use the parameter dictionary to define the objects that can have multiple instances.
For example,
InternetGatewayDevice.Layer3Forwarding.Forwardingis a multiple instance object.Two instances of that object can be represented as described:
InternetGatewayDevice.Layer3Forwarding.Forwarding.1.Enable = trueInternetGatewayDevice.Layer3Forwarding.Forwarding.2.Enable = false
Note
{i}to represent the objects which can have multiple instances. Configuration templates must use the actual instance number to indicate the object which is being modified, such asInternetGatewayDevice.WANDevice.1. WANConnectionNumberOfEntries.Notification
By using the BAC Notification attribute, a device can notify the DPE of parameter value changes. Notifications, by default, are turned off.
If Notification is enabled, it specifies that a device should include the changed values of a particular parameter in the device Inform message to the DPE, and that the device must initiate a session to the DPE whenever the value of that particular parameter is changed.
BAC supports the following values for the Notification attribute as defined in the TR-069 specification:
•
Off—Notification set to off.The device need not inform BAC of a change to the specified parameter(s).
•
Passive—Notification set to Passive.Whenever the specified parameter value changes, the device must include the new value in the ParameterList in the Inform message that is sent the next time that BAC establishes a session.
•
Active—Notification set to Active.Whenever the specified parameter value changes, the device must initiate a session with BAC, and include the new value in the ParameterList in the associated Inform message. Whenever a parameter change is sent in the Inform message due to a nonzero Notification setting, the Event code
4 VALUE CHANGEmust be included in the list of Events.
Note
notification request rejectederror if an attempt is made to set Notification on a parameter deemed inappropriate; for example, a continuously varying statistic.Configuring Notification
The following example illustrates how you configure the Notification attribute.
In this example, a configuration file is defined and generated for a
UserInterfaceobject, with Notification set toActivefor all parameters. TheISPNameparameter overrides this Notification and sets it toPassive.<!--Set Notification of object InternetGatewayDevice.UserInterface.--><ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="UserInterface"><Notification>Active</Notification> <!-- applies to all parameters under thisobject --><Parameter><Name>PasswordRequired</Name><Value>true</Value></Parameter><Parameter><Name>WarrantyDate</Name><Value>2001-02-23T09:45:30+04:30</Value></Parameter><Parameter><Name>ISPName</Name><Value>SBC</Value><Notification>Passive</Notification> <!--applies to only this parameter--></Parameter><Parameter><Name>ISPHomePage</Name><Value>www.sbc.com</Value></Parameter></ObjectInstance></ObjectInstance>Access Control
Access control in BAC is enabled through the AccessControl attribute of the CPE that you can control by using configuration templates. CPE parameters can be changed via LAN autoconfiguration protocol if access control is set to allow such access. For instance, if the AccessControl attribute is set to
Subscriber, then the subscriber on the LAN can change the parameter value.The value of the AccessControl attribute is an array of zero or more entities for which
writeaccess to a specific parameter is granted. If no entries are present, only updates to the parameter value are allowed from BAC. BAC defines only one entity in this list, in line with the TR-069 specification: Subscriber. This enableswriteaccess by the subscriber on the LAN, such as via the LAN-side DSL CPE Configuration protocol or via the UPnP protocol.Configuring Access Control
The following example illustrates how to set access control in BAC by using configuration templates:
<ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><AccessControl> <!--Allow LAN-side updates of this object and parameters under it --><Entity>Subscriber</Entity></AccessControl><Parameter><Name>PeriodicInformEnable</Name><Value>true</Value></Parameter><Parameter><Name>PeriodicInformEnable</Name><AccessControl/> <!-- Allow updates only from ACS (BAC) --></Parameter></ObjectInstance></ObjectInstance>Prerequisites
BAC templates include a prerequisites option, which indicates what conditions must be met before configuring the device. For example, a prerequisite may specify that the device to which you apply a configuration must meet the requirement of a specific hardware or software version.
Prerequisite rules are embedded into an instruction, which is sent to the DPE. The DPE then interrogates the device as necessary to determine if the prerequisites match.
Figure 5-3 illustrates the schema of the prerequisites option:
Figure 5-3 Prerequisite Schema
You use prerequisites to manipulate configuration generation through:
•
•
Expressions
Expressions are conditionals that use information from device properties. They may use Parameters, InformParameters or rpcArguments. Expressions are used within prerequisites and firmware rules and are processed when a device contacts BAC to retrieve its configuration. If the expression(s) that you specify evaluates to true, the condition(s) is met, and the corresponding configuration or firmware rule is applied to the device. For detailed information, see Using Conditionals.
The Prerequisites tag may contain zero or more expressions.
MaintenanceWindow
Use the MaintenanceWindow setting to specify the time window within which you want to apply a particular configuration to a specific CPE. This evaluation is performed at the DPE on device contact; as such, the DPE local time is used.
Note
MaintenanceWindow comprises:
•
•
•
You can use these elements to specify the time window when this rule can run, thus providing the ability to limit configuration upgrades to late in the night when subscribers are most likely sleeping.
The Prerequisites tag may contain zero or one MaintenanceWindow.
Example 5-2 Configuring MaintenanceWindow
In the following example, the values of the StartTime, Duration, and DayOfWeek tags define the period when this rule is in effect. This template takes effect at 1 a.m. for a period of 5 hours, on every Monday, Tuesday, and Friday.
<Prerequisites><MaintenanceWindow><StartTime>01:00:00</StartTime><Duration>05:00</Duration><DayOfWeek>Monday</DayOfWeek><DayOfWeek>Tuesday</DayOfWeek><DayOfWeek>Friday</DayOfWeek></MaintenanceWindow><Prerequisites>Device Contact During MaintenanceWindow
A key concept in MaintenanceWindow is ensuring that devices contact BAC during the window.
You can configure the devices to contact the DPE at a given date and time, by setting a value for the PeriodicInformTime variable in the configuration template. Also, set the RandomDateTimeInRange tag to designate a time range when the device can contact BAC.
See Example 5-3 for how to configure a device to contact BAC during a MaintenanceWindow.
Example 5-3 Configuring Device to Contact BAC During MaintenanceWindow
In the following example, the device contacts BAC for the first time on January 1, 2007, between 3 a.m. and 4 a.m. After the initial contact, the device continues to contact BAC every 30 minutes.
•
PeriodicInformEnableis set to true to indicate that the device must periodically send device information to BAC using the Inform method call.•
PeriodicInformIntervalis set to 30 minutes (1800 seconds), requesting the device to attempt to contact BAC every 30 minutes. This duration is the interval within which the device attempts to connect with BAC ifPeriodicInformEnableis true.•
PeriodicInformTimeis set to a date and time when the device should initiate contact with BAC.<ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><Parameter><Name>PeriodicInformEnable</Name><Value>true</Value></Parameter><Parameter><Name>PeriodicInformInterval</Name><Value>1800</Value></Parameter><Parameter><Name>PeriodicInformTime</Name><ComplexValue><RandomDateTimeInRange><StartDateTime>2006-01-27T01:00:00Z+03:00</StartDateTime>RandomizationIntervalMinutes>60</RandomizationIntervalMinutes></RandomDateTimeInRange></ComplexValue></Parameter></ObjectInstance></ObjectInstance>For detailed information on PeriodicInformInterval, refer to the DSL Forum's Technical Report on TR-069.
Note
Configuring Prerequisites
This section illustrates how to configure the prerequisite option.
Example 5-4 Configuring Prerequisites
In this example, the prerequisite indicates that this template will come into effect at 1 a.m. for a duration of 5 hours. During this time, this template can be applied to any device that contacts BAC and has an
EventCodeof 1 BOOT and the manufacturer as Acme, Inc.<Prerequisites><MaintenanceWindow><StartTime>01:00:00</StartTime><Duration>5:00</Duration></MaintenanceWindow><Expression><InformParameterName>InternetGatewayDevice.DeviceInfo.EventCode</ InformParameterName><Value>1 BOOT</Value><Operator>match</Operator></Expression><Expression><ParameterName>InternetGatewayDevice.DeviceInfo.Manufacturer</ParameterName><Value>Acme, Inc</Value><Operator>matchIgnoreCase</Operator></Expression></Prerequisites>Authoring Configuration Templates
You can use BAC to generate instructions for customized configurations for many devices from a single template by using template constructs. Parameter substitution and conditional inclusion or exclusion of template content, controlled by values from the BAC property hierarchy, create a custom configuration from a template. A template may include other templates, providing a mechanism to reuse common configurations.
You must add template files to the RDU by using the administrator user interface or the API, before any Class of Service can reference it.
Note
•
•
A configuration template, with
Configurationas the root element, must follow a structure similar to Example 5-5.Example 5-5 Sample Configuration Template
<tc:Templatexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:tc="urn:com:cisco:bac:common-template"xmlns="urn:com:cisco:bac:cwmp-template"xsi:schemaLocation="urn:com:cisco:bac:common-template CommonTemplateConstructs.xsd"><Prerequisites><MaintenanceWindow><StartTime>01:00:00</StartTime><Duration>2:30</Duration></MaintenanceWindow><Expression><ParameterName>InternetGatewayDevice.DeviceInfo.Manufacturer</ParameterName><Value>Acme, Inc</Value><Operator>matchIgnoreCase</Operator></Expression></Prerequisites><Configuration><ParameterDictionaries><ParameterDictionary>tr069-cwmp-dictionary.xml</ParameterDictionary></ParameterDictionaries><ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><Parameter><Name>PeriodicInformEnable</Name><Value>true</Value></Parameter><Parameter><Name>PeriodicInformInterval</Name><Value>86400</Value></Parameter></ObjectInstance></ObjectInstance></Configuration></tc:Template>Configuration templates support:
•
VAR()construct. (For details, see Using Parameter Substitution).•
•
Custom Properties
BAC properties provide access to data that is stored in BAC via the API. Via the API, you can use the properties of corresponding objects to retrieve preprovisioned, discovered, and status data. You can use properties to configure BAC at the appropriate level of granularity (from system level to device group and to individual device). See Property Hierarchy for details.
You can use custom properties to define additional customizable device information to be stored in the RDU database. You typically use these properties to substitute parameter values in configuration templates and firmware rule templates. The template parser works bottom up when locating properties in the hierarchy (device first, followed by provisioning group, then the Class of Service, device type, and system defaults) and converts the template option syntax. For details on substituting template parameters using the
VAR()construct, see the subsequent section.Example 5-6 Retrieving Username or Password from Device
The following example illustrates how you can use templates to retrieve properties from different levels; for instance, username and password credentials from a device.
<tc:Template><Configuration><ParameterDictionaries><ParameterDictionary>tr069-cwmp-dictionary.xml</ParameterDictionary></ParameterDictionaries><ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><Parameter><Name>PeriodicInformEnable</Name><Value>true</Value></Parameter><Parameter><Name>PeriodicInformInterval</Name><Value>20</Value><Notification>Active</Notification></Parameter><Parameter><Name>ConnectionRequestUsername</Name><Value>VAR(name=/dt/username, defaultValue="User")</Value></Parameter><Parameter><Name>ConnectionRequestURL</Name><Value>VAR(name=/dt/pk, defaultValue="http://testURL")</Value></Parameter></ObjectInstance></ObjectInstance></Configuration></tc:Template>To configure custom properties from the administrator user interface, choose the Configuration > Custom Property tabs. Use the Add Custom Property page to add or delete custom properties. For details, see Configuring Custom Properties, page 17-5.
Caution
Using Parameter Substitution
Values from the BAC property hierarchy are substituted into a template by using the
VAR()construct, to produce a custom configuration from a configuration template. TheVAR()construct can appear in an XML element value or element attribute. You can also use it to substitute full or partial values.The following list describes the constructs that BAC supports for parameter substitution:
•
•
•
•
•
Syntax Description
VAR(token=someChar, name=someProperty, defaultValue=someValue)•
Note
VAR()construct by specifying a token character. This token must not appear in the default value. Also, ensure that the token character precedes theVARend bracket.•
•
Example 5-7 Setting a Value to a BAC Custom Property
<Value>VAR(name=/cpe/version, defaultValue=4)</Value>Example 5-8 Referencing Standard Device Property
<Value>VAR(name=/IPDevice/connectionRequestPath, defaultValue="http://test")</Value>
Note
IPDeviceKeys.CONNECTION_REQUEST_PATH.Example 5-9 Using a
defaultValueWith a Comma<Value>VAR(token=;;name=/cpe/usrStr; defaultValue=4,5;)</Value>Example 5-10 Creating a String Value based on a BAC Property
<Value>CWMP_VAR(name=/cpe/version, defaultValue=4).bin</Value>If
cpe/versionis1-08then the Value will beCWMP_1-08.bin.Using Includes
Include files let you build a set of reusable template snippets. These files are useful for defining options that are common across many service classes without having to duplicate the options in several templates.
You can include the content of a particular file into a template by using the
tc:include construct. After inserting the content of included files into the host template, the parameter dictionary that is specified in the host template validates the content of the resulting template.
Note
The tc:Include element specifies the href attribute, where href identifies the name of the BAC template file that is included in the host template. Use double quotation marks (") when using an include directive in template.
Note
Example 5-11 Include Files
The following example displays the content of a host template, and an included template.
Included Template: informInterval.xml
<!-- enable and set Periodic Inform value --><tc:Template :xsi="http://www.w3.org/2001/XMLSchema-instance" :tc="urn:com:cisco:bac:common-template" ="urn:com:cisco:bac:cwmp-template" :schemaLocation="urn:com:cisco:bac:common-template CommonTemplateConstructs.xsd"><Configuration><ParameterDictionaries><ParameterDictionary>tr069-cwmp-dictionary.xml</ParameterDictionary></ParameterDictionaries><ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><Parameter><Name>PeriodicInformEnable</Name><Value>true</Value></Parameter><Parameter><Name>PeriodicInformInterval</Name><Value>30</Value></Parameter></ObjectInstance></ObjectInstance></Configuration></tc:Template>Host Template: cwmp-config.xml
<!-- set Periodic Inform value based on content of informInterval-cwmp.xml --><!-- set ManagmentServer.URL --><tc:Template :xsi="http://www.w3.org/2001/XMLSchema-instance" :tc="urn:com:cisco:bac:common-template" ="urn:com:cisco:bac:cwmp-template" :schemaLocation="urn:com:cisco:bac:common-template CommonTemplateConstructs.xsd"><Configuration><ParameterDictionaries><ParameterDictionary>tr069-cwmp-dictionary.xml</ParameterDictionary></ParameterDictionaries><tc:include href="informInterval.xml"/><ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><Parameter><Name>URL</Name><Value>http://10.44.64.200:9595/acs</Value></Parameter></ObjectInstance></ObjectInstance></Configuration></tc:Template>Template After Inserting Included File: informInterval.xml
<!-- set ManagmentServer.URL --><tc:Template :xsi="http://www.w3.org/2001/XMLSchema-instance" :tc="urn:com:cisco:bac:common-template" ="urn:com:cisco:bac:cwmp-template" :schemaLocation="urn:com:cisco:bac:common-template CommonTemplateConstructs.xsd"><Configuration><ParameterDictionaries><ParameterDictionary>tr069-cwmp-dictionary.xml</ParameterDictionary></ParameterDictionaries><ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><Parameter><Name>PeriodicInformEnable</Name><Value>true</Value></Parameter><Parameter><Name>PeriodicInformInterval</Name><Value>30</Value></Parameter></ObjectInstance></ObjectInstance><ObjectInstance name="InternetGatewayDevice"><ObjectInstance name="ManagementServer"><Parameter><Name>URL</Name><Value>http:// 10.44.64.200:9595/acs</Value></Parameter></ObjectInstance></ObjectInstance></Configuration></tc:Template>Using Conditionals
BAC supports powerful conditional expressions in template constructs to provide ultimate configuration customization.
You can use conditional expression constructs to include or exclude blocks of text within a template. These construct elements are tc:if, tc:choose, and tc:when. You use the tc:if construct for simple single conditionals. You use a combination of tc:choose, tc:when, and tc:otherwise for a logical if...else if...else construct. The tc:if and the tc:when constructs require a test attribute. A test attribute is an expression that can be evaluated, and the resulting object can be converted to a Boolean operator (true or false).
The tc:choose element selects one from a number of possible alternatives. This element contains a sequence of tc:when elements, followed by an optional tc:otherwise element. Each tc:when element has a single attribute, test, which specifies an expression.
The content of the tc:when and the tc:otherwise elements is a valid template segment. When a tc:choose element is processed, each of the tc:when elements is tested in turn, by evaluating the expression and converting the resulting object to a Boolean operator. The content of the first—and only the first—tc:when element whose test is true is instantiated. If no tc:when is true, the content of the tc:otherwise element is instantiated. If no tc:when element is true and no tc:otherwise element is present, nothing is created.
Note
Table 5-2 lists the conditional template constructs that this BAC release supports.
XML does not support the left angle bracket (<) and the ampersand (&). Instead, use the predefined entities (described in Table 5-3) for these characters.
The following examples illustrate various conditional expressions:
Example 5-12 Numerical Test Condition
Using 100 as a number:
<tc:if test="VAR(name=/cpe/version, defaultValue=20) > 100"><Parameter><Name>Enable </Name><Value>false</Value></Parameter></tc:if>Example 5-13 String Test Condition
Using 100 as string:
<tc:if test="VAR(name=/cpe/version, defaultValue=20) > '100'"><Parameter><Name>Enable </Name><Value>false</Value></Parameter></tc:if>
Note
Example 5-14 Looking for Text in a BAC Property
Using text
cwmp:<tc:if test="contains(VAR(name=/cpe/UsrStr, defaultValue=linksys), 'cwmp')"><Parameter><Name>Enable </Name><Value>false</Value></Parameter></tc:if>Example 5-15 Looking for Text in Single Quotes
Using
cwmp's test:<tc:if test="contains(VAR(name=/cpe/UsrStr, defaultValue=linksys), "cwmp's test")"><Parameter><Name>Enable</Name><Value>false</Value></Parameter></tc:if>Example 5-16 Looking for Text in Double Quotes
Using
cwmptest:<tc:if test="contains(VAR(name=/cpe/UsrStr, defaultValue=linksys), 'cwmp "test"')"><Parameter><Name>Enable </Name><Value>false</Value></Parameter></tc:if>The text blocks that you can enclose within the conditional statements are limited to
ParameterandObjectelements.Example 5-17 Choosing from Alternatives
The following example describes the syntax when using tc:choose and tc:when:
<tc:choose><tc:when test="VAR(name=/cpe/version,defaultValue=11) > 12"><Parameter><Name>UpgradeAvailable</Name><Value>true</Value></Parameter></tc:when><tc:when test="VAR(name=/db/version,defaultValue=15) > 14"><Parameter><Name>UpgradeAvailable</Name><Value>true</Value></Parameter></tc:when><tc:otherwise><Parameter><Name>UpgradeAvailable</Name><Value>false</Value></Parameter></tc:otherwise></tc:choose>Using the Configuration Utility
You use the configuration utility to test, validate, and view TR-069 template files: configuration and firmware rules. These activities are critical to successful deployment of instructions for individualized configuration files. (See Authoring Configuration Templates, for more information on templates.)
The configuration utility is available only when the RDU is installed, and it is installed in the BPR_HOME/rdu/bin directory.
All examples in this section assume that the RDU is operating and that these conditions apply:
•
•
•
Note
This section discusses:
•
•
•
•
•
•
Running the Configuration Utility
In subsequent procedures and examples, the phrase running the configuration utility means to enter the runCfgUtil.sh command from the directory specified. To run the configuration utility, run this command from the BPR_HOME/rdu/bin directory:
runCfgUtil.sh optionsThe available options include:
•
•
–
–
•
Note
•
•
•
•
•
•
Adding a Template to BAC
To use the configuration utility to test BAC templates:
Step 1
Step 2
If the processed template uses
VAR()constructs to reference a device property, the resulting output will contain the defaultValues for thoseVAR()constructs.Step 3
If the template uses
VAR()constructs to reference a device property, use the device option to generate a sample template.Step 4
Validating XML Syntax for a Local Template File
Use the runCfgUtil.sh command to validate template files stored on the local file system.
Syntax Description
runCfgUtil.sh -cwmp -a sc -l file•
•
•
•
To use a template file that is on the local file system:
Step 1
Step 2
Note
Step 3
/opt/CSCObac/rdu/bin/runCfgUtil.sh -cwmp -a sc -l sample-cwmp-config.xml•
•
•
After running the utility, results similar to these should appear:
Broadband Access Center Configuration UtilityVersion: 3.0, Revision: 1.26validating configuration template sample-cwmp-config.xml...>sample-cwmp-config.xml is valid.Validating XML Syntax for a Template Stored in BAC
Use the runCfgUtil.sh command to validate template files that are in the RDU database.
Syntax Description
runCfgUtil.sh -cwmp -a sc -r file -u username -p password•
•
•
•
•
To validate a template file that has been added to the RDU:
Step 1
Step 2
Note
Step 3
./runCfgUtil.sh -cwmp -a sc -r sample-cwmp-config.xml -u admin -p changeme•
•
•
•
After running the utility, results similar to these should appear:
Broadband Access Center Configuration UtilityVersion: 3.0, Revision: 1.26validating configuration template sample-cwmp-config.xml...>sample-cwmp-config.xml is valid.Testing Template Processing for a Local Template File
Use the runCfgUtil.sh command to test template processing for a local template file.
Syntax Description
runCfgUtil.sh -cwmp -a gc -l file -o file•
•
•
•
To test template processing for a local template file:
Step 1
Step 2
Step 3
./opt/CSCObac/rdu/bin/runCfgUtil.sh -cwmp -a gc -l sample-cwmp-config.xml -o output.xml•
•
After running the utility, results similar to these should appear:
Broadband Access Center Configuration UtilityVersion: 3.0, Revision: 1.26generating configuration from sample-cwmp-config.xml...output.xml generated successfully.You can view the configuration from the output.xml file.
Testing Template Processing for a Template Stored in BAC
Use the runCfgUtil.sh command to test the template processing for a template in the RDU database.
Syntax Description
runCfgUtil.sh -cwmp -a gc -r file -o file -u username -p password•
•
•
•
•
•
To test the template processing for a template stored in BAC:
Step 1
Step 2
Step 3
./runCfgUtil.sh -cwmp -a sc -r sample-cwmp-config.xml -o output.xml -u admin -p changeme•
•
After running the utility, results similar to these should appear:
Broadband Access Center Configuration UtilityVersion: 3.0, Revision: 1.26generating configuration from sample-cwmp-config.xml...output.xml generated successfully.You can view the configuration from the output.xml file.
Testing Template Processing for a BAC Template File and a Device
Use the runCfgUtil.sh command to test the template processing for a file stored in the RDU database and associated with a device.
Syntax Description
runCfgUtil.sh -cwmp -a gc -r file -o file -i deviceID -u username -p password•
•
•
•
•
•
•
To test the template processing for a file stored in the RDU and associated with a device:
Step 1
Note
IPDeviceKeys.CONNECTION_REQUEST_USERNAME.Step 2
Step 3
Step 4
Step 5
./runCfgUtil.sh -cwmp -a gc -r sample-cwmp-var-config.xml -i OUI-1234 -o output.xml -u admin -p changeme•
•
•
•
•
After running the utility, results similar to these should appear:
Broadband Access Center Configuration UtilityVersion: 3.0, Revision: 1.26generating configuration from sample-cwmp-var-config.xml...output.xml generated successfully.
Note
VAR(name=/IPDevice/connectionRequestUsername, defaultValue=test)statement will be replaced with testUser.
Posted: Fri Sep 1 00:11:48 PDT 2006
All contents are Copyright © 1992--2006 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
