Cisco Broadband Access Center Administration Guide 3.10

Adding a Class of Service

To add a specific Class of Service:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Class of Service from the Secondary Navigation bar.

Step 3 Click Add.

The Add Class of Service page appears. This page identifies the various settings for the selected Class of Service.

Step 4 Enter the name of your new class of service.

For example, assume that you want to create a new Class of Service called Gold-Classic for CWMP. You might enter provisioned-cwmp as the Class of Service Name, and choose CWMP from the service type drop-down list.

Step 5 Choose a Configuration Template File. For example, choose sample-cwmp-config.xml from the configuration file template drop-down list.

Step 6 Choose also a Firmware Rule File. For example, choose sample-cwmp-firmware-rules.xml from the firmware rule file drop-down list.

Step 7 Enter a Property Name and Property Value in the appropriate fields. This lets you configure standard or custom properties for this class of service object.

For example, choose as property name /IPDevice/connectionRequestMethod. Choose Discovered from the Property Value drop-down list and then continue with the rest of this procedure.

Note The API constant for /IPDevice/connectionRequestMethod is IPDeviceKeys.CONNECTION_REQUEST_METHOD.

Multiple Property Name:Property Value pairs could appear on this page. You use the Delete button to remove any unwanted pairs from the class of service.

Step 8 Click Add to add the property to the defining Class of Service.

Step 9 Click Submit to finalize the process or Reset to return all fields to their previous setting.

After submitting the Class of Service, the Manage Class of Service page appears to show the newly added Class of Service.

Modifying a Class of Service

You can modify the Classes of Service by selecting the various properties and assigning appropriate property values. When creating a Class of Service for the first time you select all of the appropriate properties and assign values to them.

If you make a mistake, or your business requirements for a certain Class of Service change, you can either change the property value before submitting your previous changes or delete the Property Name:Property Value pair altogether.

Note Changes to the Class of Service object trigger the Instruction Generation Service (IGS) to regenerate instructions for all affected devices and send instructions to the DPEs. IGS does this task as a background job. The status of the IGS can be observed using the View RDU Details page.

To add, delete, or modify Class of Service properties:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Class of Service from the Secondary Navigation bar.

Step 3 Choose the Class of Service to be modified.

Step 4 Click the link corresponding to the correct Class of Service.

The Modify Class of Service page appears; note that the selected Class of Service name and type appear below the page description.

• To add a new property to the selected Class of Service:

– Select the first property that you want assigned to the selected Class of Service, from the Property Name drop-down and then, after choosing the appropriate value for that property, click Add.

– Repeat for any other properties you want to assign to the selected Class of Service.

• To delete a property for the selected Class of Service:

– Locate the unwanted property in the list immediately above the Property Name drop-down.

– Click the Delete button.

• To modify the value currently assigned to a property:

– Delete the appropriate property as described above.

– Add the same property back to the Class of Service while entering the new Property Value.

Note If you delete a property that is required for your business process, you must add it back, and select the appropriate value, before you submit the change.

Step 5 Click Submit to make the modifications to the class of service.

Each property added to a Class of Service, appears when you click Submit. After doing so, a confirmation page appears to regenerate the instructions for the devices with the selected Class of Service.

Step 6 Click OK.

The modified Class of Service will be available in the Manage Class of Service page.

Deleting a Class of Service

You can delete any existing Class of Service but, before you attempt to do so, you must ensure that there are no devices associated with that Class of Service.

Tip Where there are large numbers of devices associated with a Class of Service to be deleted, use the Cisco BAC application programmers interface (API) to write a program to iterate through these devices to reassign another Class of Service to the devices.

To delete a Class of Service:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Class of Service from the Secondary Navigation bar.

Step 3 Click the Delete icon () for the correct Class of Service, and a confirmation dialog box appears.

Note A Class of Service cannot be deleted if devices are associated with it or, if it is designated as the default Class of Service. Therefore, you cannot delete the unprovisioned-cwmp Class of Service object.

Step 4 Click OK to delete the file, or Cancel to return to the Manage Class of Service page. (See Figure 17-1.)

If you try to delete a Class of Service with devices associated with it, this error message is displayed:

The specific Class of Service is specified within the error message. In this example this is represented by sample-COS.

Custom Property for Creating GRID ID for Additional Authentication

A new custom property, FC-GRID-ID-FORMAT, of string type, is available in Cisco BAC to support construction of FC-GRID-ID of the device. The FC-GRID-ID can be used as an additional authentication at the HNB-gateway.

You can edit the value of FC-GRID-ID-FORMAT to support any property, using the below pattern:

You can also include discovered data as property. For example:

If you have configured empty string for FC-GRID-ID-FORMAT, the default value will be:

In this case, the GRID ID of the device will be returned (as FC-GRID-ID property) as part of authentication, by taking the values for only the three properties – FC-ENTERPRISE-ID, FC-SITE-ID, and FC-GROUP-ID.

If you have configured invalid values for FC-GRID-ID-FORMAT, then the FC-GRID-ID value will be empty.

The creation of FC-GRID-ID also requires installation of the corresponding RDU extension, and configuration of the Service Level Extension Point in CWMP Defaults (see New Class for DNPrefix Extension and CWMP Defaults)

Custom Property for Creating DNPrefix

A new custom property, FC-DN-PREFIX-FORMAT, of string type, is available in Cisco BAC to support the construction of FC-DN-PREFIX.
The FC-DN-PREFIX can especially be applied to the fault systems so that all applicable identification information such as the enterprise, site, or chassis IDs are included.

You can edit the value for FC-DN-PREFIX-FORMAT to support any property, using the below pattern:

You can also include discovered data as property. For example:

If you have configured empty string for FC-DN-PREFIX-FORMAT, the default value is applied as follows:

If you have configured invalid values for FC-DN-PREFIX-FORMAT, then the FC-DN-PREFIX value will be empty.

The creation of FC-DN-PREFIX also requires installation of the corresponding RDU extension, and configuration of the Service Level Extension Point in CWMP Defaults (see New Class for DNPrefix Extension and CWMP Defaults).

Setting the Custom Properties for LTE Provisioning

For setting the LTE parameter values on the LTE device, the following custom properties need to be set in the Modify Device page:

• FC-ACTIVATED = true
• FC-CIG-ENABLED = false
• FC-GPS-ENABLED = true

This ensures that, if the GPS location is valid, all the LTE parameters with values specified in the configuration template are set to the LTE device, and the FC-SERVICE-STATUS of the LTE device is Operational.

Setting the Custom Properties for NWL

Cisco BAC helps you to configure the network listen function (NWL) of FAP using the following custom properties:

• FC-DNB-CONFIG-NWL-LIST-COUNT - Use this property (integer) to configure the value of number of neighbors received from FAP based on max power (the top 'n' number of neighbors is sorted based on power). If this property is not configured, the default value of 12 is used.
• FC-DNB-FREQ-MATCH - Set this property to true if you want to compare the neighbor identities using frequency. The default values is false, which compares the neighbor identities using GUID (instead of frequency).

Note The periodic NWL based location check of FAP is performed based on the success or failure of the check. If the location check fails, the custom property FC-NWL-SCAN-INTERVAL is automatically set to 20 minutes, till the location check is successful. Once the location check is successful, this property is automatically set to 1440 minutes (24 hours).

Selecting Configuration Options

The procedure for configuring specific default types is identical. Complete this procedure to access the desired defaults page and then refer to the appropriate section within this chapter for a description of the various page components.

Step 1 Choose Configuration on either the Primary Navigation bar or Main Menu page.

Step 2 Choose Defaults from the Secondary Navigation bar.

The Configure Defaults page appears.

Step 3 Choose the correct default type from the list to the left of the screen.

The appropriate defaults page appears.

CWMP Defaults

The CWMP Defaults page (Figure 17-2) displays a list of CWMP technology configuration settings.

Figure 17-2 Configure CWMP Defaults Page

Table 17-3 describes all fields and buttons appearing in Figure 17-2.

RDU Defaults

When you click the RDU defaults link, the RDU Defaults page (see Figure 17-3) appears. Use this page to configure settings affecting RDU operations.

Figure 17-3 Configure RDU Defaults Page

Table 17-4 describes all fields and buttons appearing in Figure 17-3.

Note See Managing RDU Extensions, for related information on RDU extension points.

System Defaults

When you click the Systems Defaults link, the System Defaults page (see Figure 17-4) appears.

Figure 17-4 System Defaults Page

Table 17-5 describes all fields and buttons appearing in Figure 17-4.

TACACS+ Defaults

When you click the TACACS+ Defaults link, the TACACS+ Defaults page appears.

Figure 17-5 TACACS+ Defaults Page

Table 17-6 describes all fields and buttons appearing in Figure 17-5.

If you remove one TACACS+ server and replace it with another server, the newly added server will have the same priority as the removed server.

To change the order of the TACACS+ servers in the priority list, remove all server addresses and re-enter them in the desired order.

Adding Files

To add an existing file to the RDU database:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Files on the Secondary Navigation bar.

The View Files page appears.

Step 3 Click Add.

Step 4 Choose the File Type.

Note For Firmware file type, two additional fields are provided: Firmware Version and Description, both of which are purely informational. You can enter any string in these fields.

Step 5 Browse for the Source File Name.

By default, file sizes up to 20 MB are supported.

Step 6 Enter the File Name.

Step 7 Click Submit.

The View Files page appears to indicate that the file has been added.

Cisco BAC now extends the http file service so that it can read the firmware file from the DPE file system or DPE cache.

When the firmware image size is very large (say 100 MB), adding the file through RDU may not be efficient. These files can be manually transferred to all the DPEs using tools such as scp, ftp and later when device requests for these files, they can be transferred to the device from the DPE.

Viewing Files

To view the contents of a file:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Files on the Secondary Navigation bar.

The View Files page appears.

Step 3 Search for the required file by using File Type.

Step 4 Click the View Details icon () corresponding to the File Type you had specified for a search.

The View File page appears.

Replacing Files

To replace an existing file:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Files on the Secondary Navigation bar.

Step 3 Select the link that corresponds to the file you want to replace from the search output list.

The Replace File page appears. Note that the selected filename already appears on this page.

Step 4 Browse for the source file to be used as a replacement for the displayed filename.

Step 5 Click Submit.

If you are updating a configuration or firmware template which is associated with a Class of Service, after submitting the replacement file, a confirmation page appears to indicate that Cisco BAC will regenerate instructions for the affected devices.

The Instruction Generation Service automatically regenerates instructions for all devices associated with this template using the Class of Service association and sends new instructions to the appropriate DPEs.

Step 6 Click OK

The View Files page appears.

Exporting Files

You can copy files to your local hard drive by using the export function.

Note The procedure described below assumes that you are using Internet Explorer. This procedure is different if you are using Netscape Navigator.

To export a file:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Files from the Secondary Navigation bar.

Step 3 Identify the file that you want to export.

Step 4 To export

• Binary files, click the Export icon (
) and you are prompted to either open the file or save it.

• XML files, such as templates, clicking the Export icon displays the file content. Therefore, you must right-click the Export icon and select Save Target As.

Step 5 Return to the Cisco BAC administrator user interface.

Deleting Files

Complete this procedure to delete an existing file:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Files on the Secondary Navigation bar.

Step 3 In the Files area, enter the filename of the file that you want to modify.

Step 4 Click Search.

The appropriate file appears in the Files list.

Step 5 Choose the appropriate file or files.

Step 6 Click Delete.

Caution Deleting a template file that is not directly linked to a Class of Service, but is referenced by another template file that is linked to a Class of Service, causes the instruction regeneration service to fail.

---

Note You cannot delete a file associated with a Class of Service. You must remove the Class of Service association before proceeding. See Configuring the Class of Service, for additional information.

Adding and Modifying a License

To add, modify, or upgrade a license:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose License Keys on the Secondary Navigation bar.

Step 3 Obtain your new license key from either your Cisco Systems representative or the Cisco Technical Assistance Center (TAC) website. See the Preface in this guide for TAC contact information.

Step 4 Enter the new license key in the License Key field.

Step 5 Click Add/Upgrade to install the new license key.

• If you enter a permanent license key, it overwrites the corresponding evaluation key (if that key was installed).
• If you enter a license key (permanent or evaluation) for a new technology, it will appear in the technology list.

Writing a New Class for DPE Feature Pack Extensions

This procedure illustrates how to write a new class for DPE feature pack extension. This section also provides details about how to add a new class and integrate it with the DPE.

To write the new class:

Step 1 Create a Java source file for the custom publishing extension, and compile it.

Step 2 Create a manifest file for the JAR file that will contain the extension class.

For detailed information on creating a manifest file and using the command-line JAR tool, see Java documentation.

For example:

Java JAR file manifests contain attributes that are formatted as name-value pairs and support a group of attributes that provide package versioning information.

Note Cisco BAC accepts only those extension JAR files that include a manifest with the Extension-Name attribute in the files.

Step 3 For each new class being subclassed, create a mapping file in the directory META-INF/services.

The name of the mapping file is the same as the new class being subclassed. This mapping file contains the names of the new subclasses of that class.

For example create the mapping file:

This file consists of the following:

Step 4 Create the JAR file for the custom extension point in the directory <BAC_HOME>/dpe/conf/.

For example:

Note You can give the JAR file any name. The name can be descriptive, but do not duplicate another existing JAR filename.

Writing a New Class for RDU

This procedure illustrates the entire custom extension creation process. You can create many different types of extensions; for the purposes of this procedure, a new Publishing Extension Point is used.

To write the new class:

Step 1 Create a Java source file for the custom publishing extension, and compile it.

Step 2 Create a manifest file for the JAR file that will contain the extension class.

For detailed information on creating a manifest file and using the command-line JAR tool, see Java documentation.

For example:

Java JAR file manifests contain attributes that are formatted as name-value pairs and support a group of attributes that provide package versioning information.

While Cisco BAC accepts extension JAR files that do not contain this information, we recommend that you include a manifest with versioning information in the files to track custom RDU extensions.

You can view manifest information from the administrator user interface using the Servers > RDU > View Regional Distribution Unit Details page.

Detailed information on the installed extension JAR files and the loaded extension class files appears after the Device Statistics section. You can view manifest information from the RDU logs also.

Step 3 Create the JAR file for the custom extension point.

For example:

Note You can give the JAR file any name. The name can be descriptive, but do not duplicate another existing JAR filename.

New Class for DNPrefix Extension

For constructing Grid-ID and DNPrefix extension, a new class - FormatValidatorExtension - is included in the jar file, formatvalidatorext.jar, which is available in BAC_3.10_RDU_FORMATVALIDATORExtension.gtar.gz (part of the release bundle). You need to install this.jar file in the RDU to support construction of FC-GRID-ID and FC-DN-PREFIX (see Installing RDU Custom Extensions).

Installing RDU Custom Extensions

After a Jar file is created, use the administrator user interface to install it:

Step 1 To add the new Jar file, see Adding Files.

Use the Browse function to locate the Jar file created in the procedure, Writing a New Class for RDU, and select this file as the Source File; leaving the File Name blank assigns the same filename for both source and external. The filename is what you will see through the administrator user interface.

Step 2 Click Submit.

Step 3 Return to the RDU Defaults page and note that the newly added Jar file appears in the Extension Point Jar File Search Order field.

Step 4 Enter the extension class name in the Publishing Extension Point field.

The RDU returns an error if the class name does not exist within the jar file or if Cisco BAC detects any other errors. This error occurs mostly when replacing a Jar file, if, for example, the class you set up is not found in the replacement Jar file.

Step 5 Click Submit to commit the changes to the RDU database.

Step 6 View the RDU extensions to ensure that the correct extensions are loaded.

Viewing RDU Extensions

You can view the attributes of all RDU extensions directly from the View Regional Distribution Unit Details page. This page displays details on the installed extension Jar files and the loaded extension class files.

Publishing Datastore Changes

To enable or disable a publishing plug-in:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Publishing on the Secondary Navigation bar.

The Manage Publishing page appears. This page displays a list of all available database plug-ins and identifies the current status of each. C

Step 3 Click on the appropriate status indicator to enable or disable the required plug-in. Note that as you click the status, it toggles from enabled to disabled.

Modifying Publishing Plug-In Settings

These settings are a convenient way for plug-in writers to store plug-in settings in the RDU for their respective datastore. To modify the publishing plug-in settings:

Step 1 Choose Configuration on the Primary Navigation bar.

Step 2 Choose Publishing on the Secondary Navigation bar,

The Manage Publishing page appears.

Step 3 Click the link corresponding to the plug-in you want to modify.

The Modify Publishing Plug-Ins page appears.

Table 17-9 identifies the fields shown in the Modify Publishing Plug-Ins page.

Step 4 Enter the required values in the Server, Port, IP Address, User, Password, and Confirm Password fields. These are all required fields and you must supply this information before proceeding.

Click Submit to make the changes to the selected plug-in, or click Reset to clear all fields on this page.

Configuring BAC and the Device for CIG

To configure Cisco BAC and the device for chained intra grid (CIG) in the Admin UI:

Step 1 In the BAC RDU Admin UI, configure the Chained Grid Group Generation configuration extension.
Go to Configuration > Defaults > Configuration Generation Extension Point, and enter the following extension name –
com.cisco.provisioning.cpe.extensions.builtin.generation.ChainedGridGroupGeneration

Step 2 For all the devices in the grid, configure the following custom properties to be available in /IPDevice/properties/available/pg :

• FC-CIG-ENABLED
• FC-ANCHOR-AP-LV-LIST
• FC-CIG-GROUP-TYPE

Step 3 For all the devices in the grid, set the following values for the properties:

• FC-ANCHOR-AP-LV-LIST=GPS
• FC-CIG-GROUP-TYPE= group type

Here group type is the name of the group type that is related to the device. This also supports comma-separated values (multiple group type names), and is helpful if subgroups are used in the configuration.

For the anchor FAP, if the GPS location identified by the property, FC-ANCHOR-AP-LV-LIST, is valid at the first time, this location information is updated at group or subgroup level.
This means, if FC-ANCHOR-AP-LV-LIST=GPS, then the location information is updated at group or subgroup level.

To identify the name of group type to update, the value provided for the property FC-CIG-GROUP-TYPE is used. The corresponding group name is retreived from the DPE, and the anchor FAP details are updated for that group or subgroup.

Later, if the GPS location of the anchor FAP changes, the new location is also updated in each associated device (of the same group or subgroup) using the above properties.

Note After the anchor FAP is identified, if its GPS location is invalid, or if the anchor FAP itself is blocked or it reports benchmark failure, the anchor FAP details are also deleted at group and subgroup level. During the next reboot, another FAP, which has successfully verified the location, becomes the anchor FAP.
If the parent anchor FAP is removed, the parent group is updated with another anchor FAP taken from one of the subgroups.

BAC triggers a group update event whenever a Group/Sub Group in BAC is getting either added or deleted with Anchor AP details.

Example of a sample event

If the property FC-CIG-ENABLED is set to true for a device, it sends a request to know the connected FAP’s DeviceID within the grid. This request is sent only after the GPS, REM 2G, REM 3G, or REM 4G scan is completed for the device.
As a response to this request, if the anchor FAP DeviceId is present in the connected FAP’s DeviceId, then the CIG is successfull.

Configuring BAC and the Device for CIC

To configure Cisco BAC and the device for chained intra chassis (CIC) in Admin UI:

Step 1 Configure the following custom properties related to Chained Intra Chassis location verification in Configuration > Custom Property > Manage BAC Custom Properties, using Add :

• FC-CIC-ENABLED
• FC-CIC-STATUS
• FC-CIC-STATUS-TS
• FC-CIC-ANCHOR-AP-EID
• FC-CHASSIS-ID
• FC-PEER-RAT-ID

Step 2 For all the devices in the chassis, configure the following custom properties to be available in /IPDevice/properties/available/pg :

• FC-CIC-ENABLED
• FC-CIC-STATUS
• FC-CIC-STATUS-TS
• FC-CIC-ANCHOR-AP-EID
• FC-CHASSIS-ID
• FC-PEER-RAT-ID

Note FC-CIC-ENABLED is applicable at Device, CoS, Group, and Provisioning Group levels.

Note After the anchor FAP is identified, if the anchor FAP itself is blocked or it reports benchmark failure or if a shutdown occurs, the anchor FAP details are deleted for all devices on the chassis. During the next reboot, another FAP, which has successfully verified the chassis location, becomes the anchor FAP.

If the property FC-CIC-ENABLED is set to false or removed for a device, then when the device reboot occurs, it checks if it was an anchor FAP previously, and removes the anchor FAP details. The neighbor device or peer device anchor FAP details are removed after reboot.