Using the Broadband Provisioning Registrar Administrator User Interface
This chapter describes the administration activities performed using the Broadband Provisioning Registrar (BPR) administrator user interface. These activities mainly involve monitoring the actions of various BPR 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
Managing users involves adding, modifying, and deleting users who administer BPR. The following procedures include illustrated examples to demonstrate these functions. For example purposes, let us assume that:
Note The adding, modifying, and deleting user functions can only be performed by a user who is logged
in as the Administrator.
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 3-1.)
Figure 3-1 Example Manage Users Page
Step 2 Click Add and the Add User page appears. (See Figure 3-2.)
Figure 3-2 Add User Page
Step 3 Enter the new user's username and a password. In this example, the username is User_2.
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. (See Figure 3-3.)
Figure 3-3 User Successfully Added Page
Step 6 Click the link indicated in Figure 3-3, and the Manage Users page appears with the new user added. (See Figure 3-4.)
Figure 3-4 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.
Modifying Users
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 3-4.)
To modify user properties:
Step 1 Click Users, from either the Main Menu or the Primary Navigation bar, and a Manage User page, similar to that shown in Figure 3-5, appears.
Figure 3-5 Example Manage Users Page
Step 2 Click the link corresponding to the desired user and the Modify User page appears. (See Figure 3-6.)
Figure 3-6 Modify User Page
Step 3 Make the necessary changes to either the password or user's description.
Step 4 Click Submit when complete. Once the modifications are copied into the administrative database, the User properties have been modified page appears. (See Figure 3-7.)
Figure 3-7 User Properties Modified Page
Step 5 Click the link indicated in Figure 3-7, and the Manage Users page appears with the appropriately modified user description. (See Figure 3-8.)
Figure 3-8 Manage Users Page With A Modified User Added
After completing this procedure, you will see that the user description has been changed.
Deleting Users
You can delete any user, except an administrator, that appears in the Manager Users page. To delete a user:
Step 1 Click Users, from either the Main Menu or the Primary Navigation bar, and a Manage User page, similar to that shown in Figure 3-9, appears.
Figure 3-9 Example Manage Users Page
Step 2 Click the Delete icon corresponding to the desired user, and the delete user dialog box appears. (See Figure 3-10.)
Figure 3-10 Delete User Dialog Box
Step 3 Click either OK, to delete the selected user, or Cancel to return to the previous page. The User successfully deleted page (Figure 3-11) appears.
Figure 3-11 User Deleted Page
Step 4 Click the link indicated in Figure 3-11, and the Manage Users page appears without the deleted user. (See Figure 3-12.)
Figure 3-12 Manage Users Page Showing A Deleted User
After completing this procedure, you will see that the user has been deleted.
Searching For and Viewing Device Information
You can search for device information a number of different ways using BPR. 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.
Searching for Information
BPR lets you, through the use of its search function, find a group of similar devices, select a specific device, and view that device's MAC address and related information. You can search for specific devices using these functions:
Note A maximum of 1000 results are returned for any query.
MAC Address Search
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 3-13 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".
Figure 3-13 MAC Address Search Page
Figure 3-13 also illustrates the Page Size field. This is used to control the number of devices that can be displayed at any given time, up to a maximum of 75 devices per page.
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.
Table 3-1 identifies the MAC Address Search page fields and buttons shown in Figure 3-13.
Table 3-1 MAC Address Search Page
Field or Button
Description
MAC Address or MAC Address wildcard
Enter the MAC address in this field using any of these formats:
The full MAC address for any given device. For example:
1,6,00:00:00:00:00:AE
Only the vendor-prefix portion of MAC address. For example:
1,6,00:00:00:*
Note The asterisk wildcard character can be used in place of any MAC address octet.
An asterisk (*) to search for all devices. If you use this input option, a limited number of search results are returned to you. For example:
1,6,*
Note Cisco does not recommend using the last wildcard search ( 1,6,*) in systems that support hundreds of thousands, or more, devices.
Page Size
Specifies the maximum number of search results that will be displayed in the page's content area, after each search.
Search
Click this button to begin searching.
MAC Address list
Identifies all of the devices meeting the MAC address search criteria entered above. Each of the MAC addresses displayed has a link to another page that shows the details for that device.
Owner ID Search
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 3-14 illustrates the results of an Owner ID Search.
Figure 3-14 Devices by Owner ID Search Results Page
Enter the assigned owner ID in this field before clicking the Search button.
Note You can not use wild card characters when entering data to perform an Owner ID search.
Page Size
Specifies the maximum number of search results that will be displayed in the page's content area, after each search.
Search
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.
MAC Address list
Lists all MAC addresses matching the search criteria. Each of the MAC addresses displayed has a link to another page that shows the details for that device.
IP Address Search
Figure 3-15 illustrates the IP Address Search page.
Enter the appropriate IP address in this field. You can use an asterisk (*) as a wildcard character when searching for several IP addresses. Use these formats when using wildcard characters to search:
The full IP address for any given device. For example:
10.10.10.1
Using a wildcard for the fourth in the address. For example:
10.10.10.*
Using a wildcard for the third number in the address. For example:
10.10.*
Using a wildcard for the second number in the address. For example:
10.*
Using a wildcard for the first number in the address. For example:
*
Note Cisco does not recommend using the last wildcard search (*) in systems that support hundreds of thousands, or more, devices.
Page Size
Specifies the number of search results appearing in the content area of each page.
Search
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.
IP Address list
Identifies the IP addresses for devices found by the search. Each of the addresses displayed has a link to another page that shows the details for that device.
FQDN Search
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.
Example:
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 3-16 illustrates the FQDN Search page.
Enter all or part of a FQDN in this field. You can use an asterisk (*) as a wildcard character when searching for several IP addresses. Use these formats when using wildcard characters to search:
modem10.cisco.com
*.cisco.com
*.com
*
Note Cisco does not recommend using the last wildcard search (*) in systems that support hundreds of thousands, or more, devices.
Page Size
Specifies the maximum number of search results that will be displayed in the page's content area, after each search.
Search
Click this button to begin searching for the FQDN criteria entered. The results of this search appear in the content area of this page.
FQDN list
Displays the FQDN that corresponds to the search criteria you entered in the FQDN field. 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. Each of the FQDNs displayed has a link to another page that shows the details for that device.
Viewing Device Details
As mentioned earlier in this chapter, you can view the details of any device identified in the search results. To view any device details:
Step 1 Perform whichever search activity you require.
Step 2 Select the desired device from the search results.
Step 3 Click the appropriate link and a View Device Details page, similar to the one shown in Figure 3-17, appears.
Figure 3-17 Search Results Device Details Page
Note The information contained in the page shown in
Figure 3-17 is largely dependent on the
type of device you select.
Specifies the type of device found by the search. Available types include:
DOCSISModem
DSTB
Computer
DVBModem
MAC Address
Identifies the devices MAC address.
FQDN
Identifies the fully qualified domain name for the selected device.
Behind Device
Identifies the device that this device is behind.
Provisioning Group
Identifies the provisioning group to which the device is assigned.
DHCP Criteria
Identifies the DHCP criteria used.
CPE DHCP Criteria
Identifies the DHCP criteria used for customer premises equipment.
Device Properties
Identifies any properties, other than those displayed on this page, that can be set for this device. These are custom properties.
Device Provisioned State
Identifies whether the device is provisioned or not.
Device Registered State
Identifies whether the device is registered or not.
Relay Agent Circuit Identifier
Identifies the relay agent local identifier used when communicating with a client. This is equivalent to DHCP option 82, sub option 1.
Relay Agent Remote Identifier
Identifies the globally unique device identifier. This could be the devices MAC address and is equivalent to the DHCP option 82, sub option 2.
Client Identifier
Identifies the client identification that the Network Registrar server uses to keep track of the device.
Client Request Host Name
Identifies the host name used by Network Registrar in DNS. This is read when queuing in the request for a DNS update just prior to the update of stable storage.
Class of Service
Identifies the class of service assigned to this device.
Owner Identifier
Identifies the host. This may be a user ID, and account number, or may be left blank.
DHCP Information
DHCP Inform Dictionary
Identifies information that is sent between Network Registrar and it's extensions.
DHCP Request Dictionary
Identifies the data items that can be set in the request dictionary. The data items can be set at any time. The DHCP server reads them at various times.
DHCP Response Dictionary
Identifies the data items that can be set in the response dictionary. The DHCP server reads them at various times.
DHCP Environment Dictionary
Identifies control information that is passed between the DHCP server and Network Registrar extensions.
Lease Information
DHCP Lease Properties
Identifies the lease properties, along with an IP update, that Network Registrar sends to the RDU.
IP Address
Identifies a device's IP address.
Technology Specific Information
CPE DHCP Criteria
Identifies the DHCP criteria used for devices behind this devices, in the promiscuous mode. This only applies to DOCSIS modems.
Class of Service
Describes the class of service assigned to the device.
XGCP Ports
Identifies the ports on which the gateway control protocol is active.
DOCSIS Version
Identifies the DOCSIS version currently in use.
Viewing BPR Servers
This section describes the BPR administrator server pages for:
Identifies the hostname of the system that is running the regional distribution unit.
Version
Specifies the version of RDU software currently in use.
Up Time
Specifies the total amount of time that the RDU has been operational since its last period of down time.
State
Identifies whether or not the RDU is ready to respond to requests.
PACE Statistics
PACE Batches Processed
Identifies how many individual batches have been processed while the PACE engine has been operating.
PACE Batches Succeeded
Identifies how many individual batches have been successfully processed while the PACE engine has been operating.
PACE Batches Dropped
Identifies how many batches have been dropped while the PACE engine has been operating.
PACE Batches Failed
Identifies how many batches have failed processing while the PACE engine has been operating.
PACE Average Processing Time
Identifies the average time, in milliseconds, that it takes to process a transaction.
PACE Average Batch Processing Time
Identifies the average time, in milliseconds, that it takes to process one PACE batch.
Listing Device Provisioning Engines
The List Device Provisioning Engines page (Figure 3-20) lets you monitor the list of all, currently registered DPEs. Each DPE is assigned to one or more provisioning groups.
Identifies all DPEs registered with the BPR database. Each of the DPEs displayed has a link to another page that shows the details for that DPE.
Viewing Device Provisioning Engine Details
Figure 3-21 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 average number of requests being handled and any error state flags.
Complete this procedure to view all BPR details:
Step 1 SelectServers on the Primary Navigation bar.
Step 2 Select DPEs from the Secondary Navigation bar. All connected DPEs appear in the List DPEs page similar to that shown in Figure 3-20.
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 3-21, appears.
Identifies the name of the host on which the DPE is running.
Primary Provisioning Group(s)
Identifies the primary provisioning groups that the selected DPE belongs to.
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.
Properties
Identifies which properties have been assigned to this DPE.
Version
Specifies 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.
State
Identifies whether or not the DPE is ready for operations. If this field reads Offline, these fields will not be displayed:
Version
Uptime
Cache Hits
Cache Version
Cache Files
Cache Configurations
Cache Hits
Identifies the number of cache hits that have occurred since the last time the DPE was started.
Cache Misses
Identifies the number of cache misses that have occurred since the last time the DPE was started.
Cache Files
Identifies the number of cache files that are currently stored in the DPE.
Cache Configurations
Identifies how many device configuration files are saved in cache.
Listing Network Registrar Extension Points
The List Network Registrars page, shown in Figure 3-22, lists the extension points for all Network Registrar servers that have been registered with the RDU, and are configured for use with BPR. Network Registrar servers automatically register with the RDU when they are started.
Figure 3-22 List Cisco Network Registrar Extension Points Page
Table 3-10 List Cisco Network Registrar Extension Points Page
Field or Button
Description
Network Registrar Extension Point
Identifies the Network Registrar extension points. Each of the extension points displayed has a link to another page that shows the details for that point.
Viewing Network Registrar Extension Point Details
Complete this procedure to view the extension point details of any selected Network Registrar server:
Step 1 SelectServers on the Primary Navigation bar.
Step 2 Select NRs from the Secondary Navigation bar. All connected Network Registrar servers appear in the List Cisco Network Registrar page similar to that shown in Figure 3-20.
Step 3 Locate the desired Network Registrar servers 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 server.
Step 4 Click the link to the desired extension point and the details page, similar to that shown in Figure 3-23, appears.
Identifies all provisioning groups. Each of the provisioning group displayed has a link to another page that shows the details for that group.
Viewing Provisioning Group Details
Complete this procedure to view all BPR provisioning group details:
Step 1 Select Servers on the Primary Navigation bar.
Step 2 Select Provisioning Groups from the Secondary Navigation bar. All configured provisioning groups appear in the Provisioning Groups page similar to that shown in Figure 3-24.
Step 3 Locate the desired provisioning group 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 group.
Step 4 Click the link to the desired provisioning group and the details page, similar to that shown in Figure 3-25, appears.
