Using the Broadband Access Center for Cable Administrator User Interface
This chapter describes the administration activities performed using the Broadband Access Center (BAC) administrator user interface. These activities mainly involve monitoring the actions of various BAC components including:
Note The procedures described in this chapter are presented in a tutorial manner. Wherever possible, examples
are included to illustrate the possible results of each procedure.
Managing users involves adding, modifying, and deleting users who administer BAC. The following procedures include illustrated examples to demonstrate these functions. For example purposes, let us assume that:
Note The adding and deleting of user functions can only be performed by a user who is logged in as the
Adding a New User
Adding a new user is a simple process of entering the user's name and creating a password. To add a new user:
Step 1 Click Users, from either the Main Menu or the Primary Navigation bar, and the Manage Users page appears. (See Figure 4-1.)
Figure 4-1 Example Manage Users Page
Step 2 Click Add and the Add User page appears. (See Figure 4-2.)
Figure 4-2 Add User Page
Step 3 Enter the new user's username and a password. In this example, the username is user_1.
Step 4 Confirm the new user's password and enter a description of the new user.
Tip Use the description field to identify the user's job or position; something that identifies the unique aspects of the new user.
Step 5 Click Submit when complete. Once the new user is added to the administrative database, the User Successfully Added page appears.
Step 6 Click the link indicated on this page and the Manage Users page appears with the new user added. (See Figure 4-3.)
Figure 4-3 Manage Users Page With a New User Added
After completing this procedure you will see that a new user has been added. It should be noted however, that the new user's password must be recorded and stored in a safe place. This helps to prevent the loss or theft of the password and possible unauthorized entry.
You can modify both the password and description of any user entered into the administrative database. Changes to the password and description are the only modifications allowed.
Note Any nonadministrative user that is created in this application cannot be used to modify or delete the
admin user. (See Figure 4-3.)
To modify user properties:
Step 1 From either the Main Menu or the Primary Navigation bar, click Users and a Manage User page, similar to that shown in Figure 4-4, appears.
Figure 4-4 Example Manage Users Page
Step 2 Click the desired user name and the Modify User page appears. (See Figure 4-5.)
Figure 4-5 Modify User Page
Step 3 Make the necessary changes to the password and, if required, the user's description.
Step 4 Click Submit. The User properties have been modified page appears.
Step 5 Click the link indicated on this page and the Manage Users page appears with the appropriately modified user description. (See Figure 4-6.)
Note In the example shown in Figure 4-6, the
description of user_1 has changed from Assistant Administrator to System Admin. Regardless of the
change you want to make to the description, you must enter (and confirm) a password.
Figure 4-6 Manage Users Page With a Modified User Added
You can delete any user, except an administrator, that appears in the Manager Users page. To delete a user:
Step 1 From either the Main menu or the Primary Navigation bar, click Users and a Manage User page, similar to that shown in Figure 4-7, appears.
Figure 4-7 Example Manage Users Page
Note The default user called admin cannot be deleted.
Step 2 Click the Delete icon corresponding to the user you want to delete and the delete user dialog box appears. In this example, you would click the Delete icon corresponding to Ace_Duffy.
Step 3 Click OK to delete the selected user, or click Cancel to return to the previous page. The User successfully deleted page appears.
Step 4 Click the link indicated on this page and the Manage Users page appears without the deleted user. (See Figure 4-8.)
Figure 4-8 Manage Users Page Showing a Deleted User
After completing this procedure, you will see that the user has been deleted.
This section describes how to manage devices, including adding and deleting devices using BAC.
Device management is performed from the Manage Devices page (Figure 4-9). To access this page, click the Devices link on the Main Menu, or click Devices in the Primary Navigation bar.
Figure 4-9 Example Manage Devices Page
Table 4-1 identifies the fields and buttons appearing in the Manage Devices page, as shown in Figure 4-9.
Table 4-1 Manage Devices Page
Field or Button
Displays a drop down list that identifies all available search types. The available search criteria includes:
Class of service
Fully qualified domain name (FQDN)
MAC Address or MAC Address wildcard
Although this field is initially identified as the MAC Address or MAC Address wildcard, this is only the default indication. The title of this field changes depending on the Search Type selected. See the "Search Types" section for supported search criteria and the instructions for their use.
Specifies the maximum number of search results that will be displayed in the page's content area, after each search.
Step 1 From the Devices page, locate the device that you want to delete. You can use one of the search types for this purpose.
Step 2 Click the check box to the left of the desired device.
Step 3 Click Delete. The device record stored in the RDU database is removed.
Regenerating Device Configurations
It is sometimes necessary to change many different class of service or DHCP criteria parameters. When this happens, existing device configurations become stale and require regeneration of the configuration. To eliminate the need to manually regenerate each configuration, and reduce the potential for introducing errors, BAC provides a configuration regeneration service (CRS) that you can use to automatically regenerate all device configurations.
Device configurations are automatically regenerated whenever:
A class of service property is changed.
A DHCP criteria property changes.
An external file is replaced. This applies to files that are dynamic DOCSIS templates and are directly associated with a class of service.
New default classes of service or DHCP criteria are designated.
In addition, some configurations cannot be automatically regenerated, but must rely on manual regeneration using either the generationConfiguration() method or the administrator's user interface. Configurations that must be manually regenerated are those that become necessary whenever:
A technology default is changed.
The system defaults are changed.
A file that is included within another DOCSIS template is changed.
Note Regardless of how configurations are regenerated, they are not propagated to the devices until the device
Searching For and Viewing Device Information
You can search for device information a number of different ways using BAC. Each search result that you generate also carries with it a View Details function. The details that are displayed are identical no matter which search method you use.
To search for a device type, from the Manage Devices page, click the Search Type button and a drop-down list, similar to that shown in Figure 4-11, appears. Subsequent search pages contain screen components that may be unique to the search type selected.
When the number of search results is greater than the selected page size, paging controls appear in the lower-left corner of the page. These let you scroll forward or backward one page at a time, or to select a specific page. Refer to the "Scrolling Backward and Forward" section for additional information.
Figure 4-11 Sample Manage Devices Search Types
Note A maximum of 1000 results are returned for any query with a maximum of 75
results displayed per screen. You can change the default maximum by modifying the
/adminui/maxReturned property, in <BPR_HOME>/rdu/conf/adminui.properties file, and then running
the bprAgent restart jrun command (located in the /etc/init.d/ directory) to restart the BAC JRun
You can search for specific devices using these functions:
Select the desired class of service from this drop down list.
Specifies the maximum number of search results displayed in the page's content area, after each search.
Note This function is also available on all other search criteria pages.
Click this button to begin searching. When the search criteria is broad enough, or the database is large enough, there may be multiple pages showing the results of the search. The number of pages of search results are identified at the lower left corner of the page.
Note This function is also available on all other search criteria pages.
Identifies all devices matching the search criteria. Each of the identifiers displayed has a link to another page from which you can modify the device.
Identifies the device type. This can include:
Identifies whether or not the device is provisioned. A provisioned device is one that has been registered using the application programming interface (API), or the administrative user interface, and has booted on the network.
The fully qualified domain name (FQDN) search is useful when searching for devices that are identified through the FQDN assigned by the DNS Server, especially when the device MAC address is unknown.
The web site www.cisco.com is a fully qualified domain name. In this domain name, www is the host, cisco is the second level domain, and .com is the third level domain. Figure 4-14 illustrates the FQDN Search page.
The MAC address search function is best used when you know the precise MAC address for a specific modem or when all devices with a specific vendor-prefix unambiguously identify the equipment vendor. Therefore, if you perform a MAC address search, you can identify, by the MAC address, the manufacturer and type of device. Figure 4-16 illustrates the MAC Address Search page.
Note The vendor-prefix is the first 3 octets of the MAC address. For example, for
MAC address 1,6,aa:bb:cc:dd:ee:ff, the vendor-prefix is "aa:bb:cc".
The owner ID can identify a device, it could identify the service subscriber's account number, or anything else that uniquely identifies that device. Figure 4-17 illustrates the results of an Owner ID Search.
Note Wildcard searches are not supported in the Owner ID search function.
Figure 4-17 Devices by Owner ID Search Results Page
Identifies all DPEs registered with the BAC database. Each of the DPEs displayed in this screen is a link to another page that shows the details for that DPE. Click this link and the details screen appears.
Viewing Device Provisioning Engine Details
Figure 4-20 illustrates a sample View Device Provisioning Engine Details page. This page displays the current status for the selected DPE server, and includes information, such as the number of requests being handled and any error state flags.
Complete this procedure to view all BAC details:
Step 1 ChooseServers on the Primary Navigation bar.
Step 2 Choose DPEs from the Secondary Navigation bar. All connected DPEs appear in the List DPEs page similar to that shown in Figure 4-19.
Step 3 Locate the desired DPE, if more than one is displayed. You might have to use the scroll buttons, in the lower-left of the page, to find the required DPE.
Step 4 Click the link for the appropriate DPE and the details page, similar to that shown in Figure 4-20, appears.
Identifies the primary provisioning groups that the selected DPE belongs to. This is an active link that, if clicked, displays the Provisioning Group Details page for that provisioning group.
Secondary Provisioning Group(s)
Identifies the secondary provisioning group (provided that this DPE belongs to a secondary provisioning group) that the selected DPE belongs to.
Identifies whether or not the PacketCable voice technology is enabled on this DPE.
Identifies which properties have been assigned to this DPE.
Identifies the version of DPE software currently in use.
Up Time (in seconds)
Specifies the total amount of time that the DPE has been operational since its last period of down time.
Identifies whether or not the DPE is ready for operations.
Note If this field reads Offline, the version, up time and all fields below, are not displayed.
Identifies the number of cache hits that have occurred since the last time the DPE was started.
Identifies the number of cache misses that have occurred since the last time the DPE was started.
Identifies the number of cache files that are currently stored in the DPE.
Identifies how many device configuration files are saved in cache.
Identifies the number of TFTP packets that have been received by the selected DPE.
Identifies the number of TFTP packets that have been dropped due to the DPE being overloaded.
Identifies the number of TFTP packets that have been transmitted successfully.
Identifies the number of TFTP packets that have failed during transmission.
Time of Day Statistics
Identifies the number of Time of Day packets that have been received by the selected DPE.
Identifies the number of Time of Day packets that have been transmitted successfully.
Identifies the number of Time of Day packets that have failed during transmission.
PacketCable SNMP Statistics
SNMP Informs Successful
Identifies the number of inform requests that have been successfully sent.
SNMP Sets Successful
Identifies the number of successful SNMP sets.
Configuration Informs Successful
Identifies the number of SNMP informs received from PacketCable MTAs indicating that they were successfully provisioned.
Configuration Informs Failed
Identifies the number of SNMP informs received from PacketCable MTAs indicating that they failed to be provisioned.
Listing Network Registrar Extension Points
To list the Network Registrar extension points, from the Servers tab, click NRs. The List Network Registrar Extension Points page, similar to that shown in Figure 4-21, appears. This page lists the extension points for all Network Registrar servers that have been registered with the RDU, and are configured for use with BAC. Network Registrar servers automatically register with the RDU when those servers are started.
Figure 4-21 List Cisco Network Registrar Extension Points Page
Table 4-13 View Network Registrar Extension Point Details Page
Field or Button
Network Registrar Extension Point Details
Displays the host name of the system running Network Registrar.
Identifies the IP address of the Network Registrar.
Identifies the provisioning group for this Network Registrar servers. This is an active link that, if clicked, displays the Provisioning Group Details page for that provisioning group.
Identifies whether or not the PacketCable voice technology is enabled.
Identifies the properties that are applied to the selected Network Registrar.
Identifies the extension point version currently in use.
Identifies how long the Network Registrar extension point has been operational. This is indicated in hours, minutes, and seconds.
Identifies whether or not the extension point is operational.
Note If the state indicated is Offline, the Up Time, version, and extension point statistics are not displayed.
Network Registrar Extension Point Statistics
Identifies the number of packets that have been received.
Identifies the number of packets that were ignored.
Identifies the number of packets that were dropped.
Identifies the number of packets that transferred successfully.
Identifies the number of packets that failed to be transferred.
Device Provisioning Engine(s) Details
Identifies the IP address of the device provisioning engine.
Identifies the DPE port number.
Identifies whether this DPE is a primary or secondary DPE.
Identifies whether or not the DPE is operational.
Listing Provisioning Groups
To list provisioning groups, click the Server tab, then click Provisioning Groups. The List Provisioning Groups page, similar to that shown in Figure 4-23, appears. This list identifies all of the provisioning groups within the system.
Identifies the host name of the system that is running the regional distribution unit.
Identifies the RDU listening port number. While the default port number is 49187, the port number displayed in this field is the same as that entered as the Regional Distribution Unit Host/Port screen during installation.
Identifies the IP address assigned to the RDU.
Identifies the RDU properties that are used for server configuration and control.
Specifies the version of RDU software currently in use.
Specifies the total amount of time that the RDU has been operational since its last period of down time.
Identifies whether or not the RDU is ready to respond to requests.
Identifies how many individual batches have been processed while the PACE engine has been operating.
Identifies how many individual batches have been successfully processed while the PACE engine has been operating.
Identifies how many batches have been dropped while the PACE engine has been operating.
Identifies how many batches have failed processing while the PACE engine has been operating.
Average Processing Time
Identifies the average time, in milliseconds, that it takes to process the batch excluding the time it spends in the queue if RDU is too busy.
Average Batch Processing Time
Identifies the average time, in milliseconds, that it takes to process the batch including the time it spends in the queue if RDU is too busy.
Configuration Regeneration Statistics
Identifies whether or not the configuration regeneration service is ready to respond to requests.
Identifies how many configuration regeneration requests have been processed.
Identifies the number of DOCSIS modems are currently identified in the RDU.
Identifies the number of computers are currently identified in the RDU.
ATA 186/ATA 188
Identifies the number and type of ATA devices are currently identified in the RDU.
Packet Cable MTA
Identifies the number of MTAs are currently identified in the RDU.